blob: ad1802455900a8045b66b2a387855f62d7a8b953 [file] [log] [blame]
Bill Wendling2f921f82009-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 Lattnerb14490d2010-03-09 00:39:24 +000013
Devang Patel80ae3492009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling2f921f82009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000016#include "DIE.h"
Eric Christopher4996c702011-11-07 09:24:32 +000017#include "DwarfAccelTable.h"
Devang Patel5eb43192011-04-12 17:40:32 +000018#include "DwarfCompileUnit.h"
Chandler Carruthed0881b2012-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 Greene829b3e82009-08-19 21:52:55 +000023#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000024#include "llvm/CodeGen/MachineModuleInfo.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000025#include "llvm/Constants.h"
26#include "llvm/DIBuilder.h"
27#include "llvm/DataLayout.h"
28#include "llvm/DebugInfo.h"
29#include "llvm/Instructions.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000030#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000031#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000032#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000033#include "llvm/MC/MCSymbol.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000034#include "llvm/Module.h"
Devang Patel6c74a872010-04-27 19:46:33 +000035#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000036#include "llvm/Support/Debug.h"
37#include "llvm/Support/ErrorHandling.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000038#include "llvm/Support/FormattedStream.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000039#include "llvm/Support/Path.h"
Chandler Carruthed0881b2012-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 Wendling2f921f82009-05-15 09:23:25 +000047using namespace llvm;
48
Jim Grosbacha8683bb2010-07-21 21:21:52 +000049static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel30265c42010-07-07 20:12:52 +000050 cl::Hidden,
Devang Patel6c74a872010-04-27 19:46:33 +000051 cl::desc("Disable debug info printing"));
52
Dan Gohman7421ae42010-05-07 01:08:53 +000053static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
Chris Lattner0ab5e2c2011-04-15 05:18:47 +000054 cl::desc("Make an absence of debug location information explicit."),
Dan Gohman7421ae42010-05-07 01:08:53 +000055 cl::init(false));
56
Eric Christopher20b76a72012-08-23 22:36:40 +000057namespace {
58 enum DefaultOnOff {
59 Default, Enable, Disable
60 };
61}
Eric Christopher4996c702011-11-07 09:24:32 +000062
Eric Christopher20b76a72012-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 Christopher978fbff2012-08-23 07:10:46 +000073 cl::desc("Compatibility with Darwin gdb."),
Eric Christopher20b76a72012-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 Christopher978fbff2012-08-23 07:10:46 +000080
Eric Christophercdf218d2012-12-10 19:51:21 +000081static cl::opt<DefaultOnOff> SplitDwarf("split-dwarf", cl::Hidden,
82 cl::desc("Output prototype dwarf split debug info."),
Eric Christopher29424312012-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 Wendlingfcc14142010-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 Wendling2f921f82009-05-15 09:23:25 +000095//===----------------------------------------------------------------------===//
96
Eric Christopheracdcbdb2012-11-27 22:43:45 +000097// Configuration values for initial hash set sizes (log2).
98//
Bill Wendling2f921f82009-05-15 09:23:25 +000099static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +0000100
101namespace llvm {
102
Nick Lewycky019d2552011-07-29 03:49:23 +0000103DIType DbgVariable::getType() const {
Devang Patelf20c4f72011-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 Christopher6a841382012-11-19 22:42:10 +0000114
Devang Patelf20c4f72011-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 Christopher6a841382012-11-19 22:42:10 +0000117
Devang Patelf20c4f72011-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 Christopher6a841382012-11-19 22:42:10 +0000123
Devang Patelf20c4f72011-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 Christopher6a841382012-11-19 22:42:10 +0000126
Devang Patelf20c4f72011-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 Christopher6a841382012-11-19 22:42:10 +0000134
Devang Patelf20c4f72011-04-12 22:53:02 +0000135 if (tag == dwarf::DW_TAG_pointer_type) {
136 DIDerivedType DTy = DIDerivedType(Ty);
137 subType = DTy.getTypeDerivedFrom();
138 }
Eric Christopher6a841382012-11-19 22:42:10 +0000139
Devang Patelf20c4f72011-04-12 22:53:02 +0000140 DICompositeType blockStruct = DICompositeType(subType);
141 DIArray Elements = blockStruct.getTypeArray();
Eric Christopher6a841382012-11-19 22:42:10 +0000142
Devang Patelf20c4f72011-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 Patel6d9f9fe2010-08-09 21:01:39 +0000148 }
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000149 }
Devang Patelf20c4f72011-04-12 22:53:02 +0000150 return Ty;
151}
Bill Wendling2f921f82009-05-15 09:23:25 +0000152
Chris Lattnerf5d06362010-04-05 04:09:20 +0000153} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000154
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000155DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Eric Christopherd79f5482012-12-10 19:51:13 +0000156 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000157 AbbreviationsSet(InitAbbreviationsSetSize),
Benjamin Kramer07480082012-06-09 10:34:15 +0000158 SourceIdMap(DIEValueAllocator), StringPool(DIEValueAllocator),
Eric Christopherc8a310e2012-12-10 23:34:43 +0000159 PrevLabel(NULL), GlobalCUIndexCount(0),
160 InfoHolder(A, &AbbreviationsSet, &Abbreviations),
161 SkeletonCU(0), SkeletonHolder(A, &AbbreviationsSet, &Abbreviations) {
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000162 NextStringPoolNumber = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000163
Rafael Espindolaa7160962011-05-06 14:56:22 +0000164 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattnere58b5472010-04-04 23:10:38 +0000165 DwarfStrSectionSym = TextSectionSym = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000166 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000167 FunctionBeginSym = FunctionEndSym = 0;
Eric Christopherad9fe892012-04-02 17:58:52 +0000168
Eric Christopher978fbff2012-08-23 07:10:46 +0000169 // Turn on accelerator tables and older gdb compatibility
170 // for Darwin.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000171 bool IsDarwin = Triple(M->getTargetTriple()).isOSDarwin();
Eric Christopher20b76a72012-08-23 22:36:40 +0000172 if (DarwinGDBCompat == Default) {
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000173 if (IsDarwin)
174 IsDarwinGDBCompat = true;
Eric Christopher20b76a72012-08-23 22:36:40 +0000175 else
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000176 IsDarwinGDBCompat = false;
Eric Christopher20b76a72012-08-23 22:36:40 +0000177 } else
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000178 IsDarwinGDBCompat = DarwinGDBCompat == Enable ? true : false;
Eric Christopher4977f212012-08-23 22:36:36 +0000179
Eric Christopher20b76a72012-08-23 22:36:40 +0000180 if (DwarfAccelTables == Default) {
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000181 if (IsDarwin)
182 HasDwarfAccelTables = true;
Eric Christopher20b76a72012-08-23 22:36:40 +0000183 else
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000184 HasDwarfAccelTables = false;
Eric Christopher20b76a72012-08-23 22:36:40 +0000185 } else
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000186 HasDwarfAccelTables = DwarfAccelTables == Enable ? true : false;
Eric Christopher20b76a72012-08-23 22:36:40 +0000187
Eric Christophercdf218d2012-12-10 19:51:21 +0000188 if (SplitDwarf == Default)
189 HasSplitDwarf = false;
Eric Christopher29424312012-11-12 22:22:20 +0000190 else
Eric Christophercdf218d2012-12-10 19:51:21 +0000191 HasSplitDwarf = SplitDwarf == Enable ? true : false;
Eric Christopher29424312012-11-12 22:22:20 +0000192
Dan Gohman6e681a52010-06-18 15:56:31 +0000193 {
194 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopher58f41952012-11-19 22:42:15 +0000195 beginModule();
Torok Edwinf8dba242010-04-07 10:44:46 +0000196 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000197}
198DwarfDebug::~DwarfDebug() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000199}
200
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000201// Switch to the specified MCSection and emit an assembler
202// temporary label to it if SymbolStem is specified.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000203static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christophera7b61892011-11-07 09:18:38 +0000204 const char *SymbolStem = 0) {
205 Asm->OutStreamer.SwitchSection(Section);
206 if (!SymbolStem) return 0;
207
208 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
209 Asm->OutStreamer.EmitLabel(TmpSym);
210 return TmpSym;
211}
212
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000213MCSymbol *DwarfDebug::getStringPool() {
214 return Asm->GetTempSymbol("section_str");
215}
216
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000217MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
218 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
219 if (Entry.first) return Entry.first;
220
221 Entry.second = NextStringPoolNumber++;
Chris Lattnera179b522010-04-04 19:25:43 +0000222 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000223}
224
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000225// Define a unique number for the abbreviation.
226//
Eric Christopherc8a310e2012-12-10 23:34:43 +0000227void DwarfUnits::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000228 // Profile the node so that we can make it unique.
229 FoldingSetNodeID ID;
230 Abbrev.Profile(ID);
231
232 // Check the set for priors.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000233 DIEAbbrev *InSet = AbbreviationsSet->GetOrInsertNode(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000234
235 // If it's newly added.
236 if (InSet == &Abbrev) {
237 // Add to abbreviation list.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000238 Abbreviations->push_back(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000239
240 // Assign the vector position + 1 as its number.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000241 Abbrev.setNumber(Abbreviations->size());
Bill Wendling2f921f82009-05-15 09:23:25 +0000242 } else {
243 // Assign existing abbreviation number.
244 Abbrev.setNumber(InSet->getNumber());
245 }
246}
247
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000248// If special LLVM prefix that is used to inform the asm
249// printer to not emit usual symbol prefix before the symbol name is used then
250// return linkage name after skipping this special LLVM prefix.
Devang Patel43ef34d2010-01-05 01:46:14 +0000251static StringRef getRealLinkageName(StringRef LinkageName) {
252 char One = '\1';
253 if (LinkageName.startswith(StringRef(&One, 1)))
254 return LinkageName.substr(1);
255 return LinkageName;
256}
257
Eric Christopherd9843b32011-11-10 19:25:34 +0000258static bool isObjCClass(StringRef Name) {
259 return Name.startswith("+") || Name.startswith("-");
260}
261
262static bool hasObjCCategory(StringRef Name) {
263 if (!isObjCClass(Name)) return false;
264
265 size_t pos = Name.find(')');
266 if (pos != std::string::npos) {
267 if (Name[pos+1] != ' ') return false;
268 return true;
269 }
270 return false;
271}
272
273static void getObjCClassCategory(StringRef In, StringRef &Class,
274 StringRef &Category) {
275 if (!hasObjCCategory(In)) {
276 Class = In.slice(In.find('[') + 1, In.find(' '));
277 Category = "";
278 return;
279 }
280
281 Class = In.slice(In.find('[') + 1, In.find('('));
282 Category = In.slice(In.find('[') + 1, In.find(' '));
283 return;
284}
285
286static StringRef getObjCMethodName(StringRef In) {
287 return In.slice(In.find(' ') + 1, In.find(']'));
288}
289
290// Add the various names to the Dwarf accelerator table names.
291static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
292 DIE* Die) {
293 if (!SP.isDefinition()) return;
Eric Christopher6a841382012-11-19 22:42:10 +0000294
Eric Christopherd9843b32011-11-10 19:25:34 +0000295 TheCU->addAccelName(SP.getName(), Die);
296
297 // If the linkage name is different than the name, go ahead and output
298 // that as well into the name table.
299 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
300 TheCU->addAccelName(SP.getLinkageName(), Die);
301
302 // If this is an Objective-C selector name add it to the ObjC accelerator
303 // too.
304 if (isObjCClass(SP.getName())) {
305 StringRef Class, Category;
306 getObjCClassCategory(SP.getName(), Class, Category);
307 TheCU->addAccelObjC(Class, Die);
308 if (Category != "")
309 TheCU->addAccelObjC(Category, Die);
310 // Also add the base method name to the name table.
311 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
312 }
313}
314
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000315// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
316// and DW_AT_high_pc attributes. If there are global variables in this
317// scope then create and insert DIEs for these variables.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000318DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
319 const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000320 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +0000321
Chris Lattner3a383cb2010-04-05 00:13:49 +0000322 assert(SPDie && "Unable to find subprogram DIE!");
323 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000324
Bill Wendlingf720bf62012-11-07 05:19:04 +0000325 // If we're updating an abstract DIE, then we will be adding the children and
326 // object pointer later on. But what we don't want to do is process the
327 // concrete DIE twice.
Devang Patela37a95e2010-07-07 22:20:57 +0000328 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
Bill Wendlingf720bf62012-11-07 05:19:04 +0000329 // Pick up abstract subprogram DIE.
Devang Patela37a95e2010-07-07 22:20:57 +0000330 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf20c4f72011-04-12 22:53:02 +0000331 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
332 dwarf::DW_FORM_ref4, AbsSPDIE);
Devang Patela37a95e2010-07-07 22:20:57 +0000333 SPCU->addDie(SPDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000334 } else {
335 DISubprogram SPDecl = SP.getFunctionDeclaration();
336 if (!SPDecl.isSubprogram()) {
337 // There is not any need to generate specification DIE for a function
338 // defined at compile unit level. If a function is defined inside another
339 // function then gdb prefers the definition at top level and but does not
340 // expect specification DIE in parent function. So avoid creating
341 // specification DIE for a function defined inside a function.
342 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
343 !SP.getContext().isFile() &&
344 !isSubprogramContext(SP.getContext())) {
345 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
346
347 // Add arguments.
348 DICompositeType SPTy = SP.getType();
349 DIArray Args = SPTy.getTypeArray();
350 unsigned SPTag = SPTy.getTag();
351 if (SPTag == dwarf::DW_TAG_subroutine_type)
352 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
353 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
354 DIType ATy = DIType(Args.getElement(i));
355 SPCU->addType(Arg, ATy);
356 if (ATy.isArtificial())
357 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
358 if (ATy.isObjectPointer())
359 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer,
360 dwarf::DW_FORM_ref4, Arg);
361 SPDie->addChild(Arg);
362 }
363 DIE *SPDeclDie = SPDie;
364 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Eric Christopher6a841382012-11-19 22:42:10 +0000365 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification,
366 dwarf::DW_FORM_ref4, SPDeclDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000367 SPCU->addDie(SPDie);
368 }
369 }
Devang Patela37a95e2010-07-07 22:20:57 +0000370 }
371
Devang Patelf20c4f72011-04-12 22:53:02 +0000372 SPCU->addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
373 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
374 SPCU->addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
375 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
Chris Lattner3a383cb2010-04-05 00:13:49 +0000376 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
377 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000378 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000379
Eric Christopherd9843b32011-11-10 19:25:34 +0000380 // Add name to the name table, we do this here because we're guaranteed
381 // to have concrete versions of our DW_TAG_subprogram nodes.
382 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher6a841382012-11-19 22:42:10 +0000383
Chris Lattner3a383cb2010-04-05 00:13:49 +0000384 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000385}
386
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000387// Construct new DW_TAG_lexical_block for this scope and attach
388// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher6a841382012-11-19 22:42:10 +0000389DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000390 LexicalScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +0000391 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
392 if (Scope->isAbstractScope())
393 return ScopeDIE;
394
Devang Patel7e623022011-08-10 20:55:27 +0000395 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +0000396 if (Ranges.empty())
397 return 0;
398
Devang Patel7e623022011-08-10 20:55:27 +0000399 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel6c74a872010-04-27 19:46:33 +0000400 if (Ranges.size() > 1) {
401 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000402 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +0000403 // DW_AT_ranges appropriately.
Devang Patelf20c4f72011-04-12 22:53:02 +0000404 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000405 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000406 * Asm->getDataLayout().getPointerSize());
Devang Patel7e623022011-08-10 20:55:27 +0000407 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +0000408 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +0000409 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
410 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +0000411 }
412 DebugRangeSymbols.push_back(NULL);
413 DebugRangeSymbols.push_back(NULL);
414 return ScopeDIE;
415 }
416
Devang Patel9fc11702010-05-25 23:40:22 +0000417 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
418 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +0000419
Devang Patel9fc11702010-05-25 23:40:22 +0000420 if (End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000421
Chris Lattnere13c3722010-03-09 01:58:53 +0000422 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
423 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000424
Devang Patelf20c4f72011-04-12 22:53:02 +0000425 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
426 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000427
428 return ScopeDIE;
429}
430
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000431// This scope represents inlined body of a function. Construct DIE to
432// represent this concrete inlined copy of the function.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000433DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
434 LexicalScope *Scope) {
Devang Patel7e623022011-08-10 20:55:27 +0000435 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000436 assert(Ranges.empty() == false &&
437 "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000438
Devang Patelf098ce22011-07-27 00:34:13 +0000439 if (!Scope->getScopeNode())
440 return NULL;
441 DIScope DS(Scope->getScopeNode());
442 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patelf098ce22011-07-27 00:34:13 +0000443 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
444 if (!OriginDIE) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000445 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patelf098ce22011-07-27 00:34:13 +0000446 return NULL;
447 }
448
Devang Patel7e623022011-08-10 20:55:27 +0000449 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel9fc11702010-05-25 23:40:22 +0000450 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
451 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +0000452
Devang Patel4c6bd662010-07-08 22:39:20 +0000453 if (StartLabel == 0 || EndLabel == 0) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000454 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +0000455 }
Chris Lattnere13c3722010-03-09 01:58:53 +0000456 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +0000457 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +0000458 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +0000459 "Invalid end label for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +0000460
Devang Patel73bc1722011-05-05 17:54:26 +0000461 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Devang Patelf20c4f72011-04-12 22:53:02 +0000462 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
463 dwarf::DW_FORM_ref4, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000464
Devang Patelf098ce22011-07-27 00:34:13 +0000465 if (Ranges.size() > 1) {
466 // .debug_range section has not been laid out yet. Emit offset in
467 // .debug_range as a uint, size 4, for now. emitDIE will handle
468 // DW_AT_ranges appropriately.
469 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000470 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000471 * Asm->getDataLayout().getPointerSize());
Devang Patel7e623022011-08-10 20:55:27 +0000472 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patelf098ce22011-07-27 00:34:13 +0000473 RE = Ranges.end(); RI != RE; ++RI) {
474 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
475 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
476 }
477 DebugRangeSymbols.push_back(NULL);
478 DebugRangeSymbols.push_back(NULL);
479 } else {
Eric Christopher6a841382012-11-19 22:42:10 +0000480 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Devang Patel784077e2011-08-10 23:58:09 +0000481 StartLabel);
Eric Christopher6a841382012-11-19 22:42:10 +0000482 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Devang Patel784077e2011-08-10 23:58:09 +0000483 EndLabel);
Devang Patelf098ce22011-07-27 00:34:13 +0000484 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000485
486 InlinedSubprogramDIEs.insert(OriginDIE);
487
488 // Track the start label for this inlined function.
Devang Patelf098ce22011-07-27 00:34:13 +0000489 //.debug_inlined section specification does not clearly state how
490 // to emit inlined scope that is split into multiple instruction ranges.
491 // For now, use first instruction range and emit low_pc/high_pc pair and
492 // corresponding .debug_inlined section entry for this pair.
Devang Patel32cc43c2010-05-07 20:54:48 +0000493 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000494 I = InlineInfo.find(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000495
496 if (I == InlineInfo.end()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000497 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000498 InlinedSPNodes.push_back(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000499 } else
Chris Lattner085b6522010-03-09 00:31:02 +0000500 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000501
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000502 DILocation DL(Scope->getInlinedAt());
Eric Christopher0925c622012-03-26 21:38:38 +0000503 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0,
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000504 getOrCreateSourceID(DL.getFilename(), DL.getDirectory()));
Devang Patelf20c4f72011-04-12 22:53:02 +0000505 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000506
Eric Christopher8dda5d02011-12-04 06:02:38 +0000507 // Add name to the name table, we do this here because we're guaranteed
508 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
509 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher6a841382012-11-19 22:42:10 +0000510
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000511 return ScopeDIE;
512}
513
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000514// Construct a DIE for this scope.
Devang Patel3acc70e2011-08-15 22:04:40 +0000515DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000516 if (!Scope || !Scope->getScopeNode())
517 return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000518
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000519 SmallVector<DIE *, 8> Children;
Eric Christophere3417762012-09-12 23:36:19 +0000520 DIE *ObjectPointer = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +0000521
522 // Collect arguments for current function.
Devang Patel7e623022011-08-10 20:55:27 +0000523 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000524 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
525 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher6a841382012-11-19 22:42:10 +0000526 if (DIE *Arg =
Eric Christophere3417762012-09-12 23:36:19 +0000527 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel6c622ef2011-03-01 22:58:55 +0000528 Children.push_back(Arg);
Eric Christophere3417762012-09-12 23:36:19 +0000529 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
530 }
Devang Patel6c622ef2011-03-01 22:58:55 +0000531
Eric Christopherf84354b2011-10-03 15:49:16 +0000532 // Collect lexical scope children first.
Devang Patel7e623022011-08-10 20:55:27 +0000533 const SmallVector<DbgVariable *, 8> &Variables = ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000534 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher6a841382012-11-19 22:42:10 +0000535 if (DIE *Variable =
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000536 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000537 Children.push_back(Variable);
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000538 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
539 }
Devang Patel7e623022011-08-10 20:55:27 +0000540 const SmallVector<LexicalScope *, 4> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000541 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Patel3acc70e2011-08-15 22:04:40 +0000542 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000543 Children.push_back(Nested);
Devang Patel3b548aa2010-03-08 20:52:55 +0000544 DIScope DS(Scope->getScopeNode());
545 DIE *ScopeDIE = NULL;
546 if (Scope->getInlinedAt())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000547 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3b548aa2010-03-08 20:52:55 +0000548 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000549 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000550 if (Scope->isAbstractScope()) {
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000551 ScopeDIE = TheCU->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000552 // Note down abstract DIE.
553 if (ScopeDIE)
554 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
555 }
Devang Patel3b548aa2010-03-08 20:52:55 +0000556 else
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000557 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3b548aa2010-03-08 20:52:55 +0000558 }
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000559 else {
560 // There is no need to emit empty lexical block DIE.
561 if (Children.empty())
562 return NULL;
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000563 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000564 }
Eric Christopher6a841382012-11-19 22:42:10 +0000565
Devang Patel23b2ae62010-03-29 22:59:58 +0000566 if (!ScopeDIE) return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000567
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000568 // Add children
569 for (SmallVector<DIE *, 8>::iterator I = Children.begin(),
570 E = Children.end(); I != E; ++I)
571 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000572
Eric Christophere3417762012-09-12 23:36:19 +0000573 if (DS.isSubprogram() && ObjectPointer != NULL)
574 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer,
575 dwarf::DW_FORM_ref4, ObjectPointer);
576
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000577 if (DS.isSubprogram())
Eric Christopherd9843b32011-11-10 19:25:34 +0000578 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000579
Eric Christopherd9843b32011-11-10 19:25:34 +0000580 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000581}
582
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000583// Look up the source id with the given directory and source file names.
584// If none currently exists, create a new id and insert it in the
585// SourceIds map. This can update DirectoryNames and SourceFileNames maps
586// as well.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000587unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Devang Patele01b75c2011-03-24 20:30:50 +0000588 StringRef DirName) {
Devang Patel871d0b12010-09-16 20:57:49 +0000589 // If FE did not provide a file name, then assume stdin.
590 if (FileName.empty())
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000591 return getOrCreateSourceID("<stdin>", StringRef());
Devang Patele01b75c2011-03-24 20:30:50 +0000592
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000593 // TODO: this might not belong here. See if we can factor this better.
594 if (DirName == CompilationDir)
595 DirName = "";
596
Nick Lewycky40f8f2f2011-10-17 23:05:28 +0000597 unsigned SrcId = SourceIdMap.size()+1;
Devang Patel871d0b12010-09-16 20:57:49 +0000598
Benjamin Kramer71b19732012-03-11 14:56:26 +0000599 // We look up the file/dir pair by concatenating them with a zero byte.
600 SmallString<128> NamePair;
601 NamePair += DirName;
602 NamePair += '\0'; // Zero bytes are not allowed in paths.
603 NamePair += FileName;
604
605 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
606 if (Ent.getValue() != SrcId)
607 return Ent.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +0000608
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000609 // Print out a .file directive to specify files for .loc directives.
Benjamin Kramer71b19732012-03-11 14:56:26 +0000610 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName);
Bill Wendling2b128d72009-05-20 23:19:06 +0000611
612 return SrcId;
613}
614
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000615// Create new CompileUnit for the given metadata node with tag DW_TAG_compile_unit.
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000616CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +0000617 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +0000618 StringRef FN = DIUnit.getFilename();
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000619 CompilationDir = DIUnit.getDirectory();
Eli Benderskyb42d1462012-12-03 18:45:45 +0000620 // Call this to emit a .file directive if it wasn't emitted for the source
621 // file this CU comes from yet.
622 getOrCreateSourceID(FN, CompilationDir);
Bill Wendling2b128d72009-05-20 23:19:06 +0000623
624 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyb42d1462012-12-03 18:45:45 +0000625 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
626 DIUnit.getLanguage(), Die, Asm, this);
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000627 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patelf20c4f72011-04-12 22:53:02 +0000628 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
629 DIUnit.getLanguage());
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000630 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christopherb1b94512012-08-01 18:19:01 +0000631 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
632 // into an entity.
633 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Devang Pateld22ed622010-03-22 23:11:36 +0000634 // DW_AT_stmt_list is a offset of line number information for this
Devang Patel4a213872010-08-24 00:06:12 +0000635 // compile unit in debug_line section.
Rafael Espindolad7bdaf52012-06-22 13:24:07 +0000636 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Rafael Espindolaa7558912011-05-04 17:44:06 +0000637 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Devang Patelf20c4f72011-04-12 22:53:02 +0000638 Asm->GetTempSymbol("section_line"));
Devang Patelea636392010-08-31 23:50:19 +0000639 else
Devang Patelf20c4f72011-04-12 22:53:02 +0000640 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +0000641
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000642 if (!CompilationDir.empty())
643 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Bill Wendling2b128d72009-05-20 23:19:06 +0000644 if (DIUnit.isOptimized())
Eric Christopherbb69a272012-08-24 01:14:27 +0000645 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendling2b128d72009-05-20 23:19:06 +0000646
Devang Patel2d9caf92009-11-25 17:36:49 +0000647 StringRef Flags = DIUnit.getFlags();
648 if (!Flags.empty())
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000649 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher6a841382012-11-19 22:42:10 +0000650
Nick Lewycky479a8fe2011-10-17 23:27:36 +0000651 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patelf20c4f72011-04-12 22:53:02 +0000652 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +0000653 dwarf::DW_FORM_data1, RVer);
654
Devang Patel1a0df9a2010-05-10 22:49:55 +0000655 if (!FirstCU)
656 FirstCU = NewCU;
Eric Christophercdf218d2012-12-10 19:51:21 +0000657 if (useSplitDwarf() && !SkeletonCU)
658 SkeletonCU = constructSkeletonCU(N);
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000659
Eric Christopherc8a310e2012-12-10 23:34:43 +0000660 InfoHolder.addUnit(NewCU);
661
Devang Patel1a0df9a2010-05-10 22:49:55 +0000662 CUMap.insert(std::make_pair(N, NewCU));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000663 return NewCU;
Devang Patel1a0df9a2010-05-10 22:49:55 +0000664}
665
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000666// Construct subprogram DIE.
Eric Christopher6a841382012-11-19 22:42:10 +0000667void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
Devang Patel1f4f98d2011-08-15 23:36:40 +0000668 const MDNode *N) {
Rafael Espindola6cf4e832011-11-04 19:00:29 +0000669 CompileUnit *&CURef = SPMap[N];
670 if (CURef)
671 return;
672 CURef = TheCU;
673
Devang Patel80ae3492009-08-28 23:24:31 +0000674 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000675 if (!SP.isDefinition())
676 // This is a method declaration which will be handled while constructing
677 // class type.
Devang Patel0751a282009-06-26 01:49:18 +0000678 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000679
Devang Patel89543712011-08-15 17:24:54 +0000680 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000681
682 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000683 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +0000684
685 // Add to context owner.
Devang Patelf20c4f72011-04-12 22:53:02 +0000686 TheCU->addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +0000687
Devang Patel0751a282009-06-26 01:49:18 +0000688 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000689}
690
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000691// Collect debug info from named mdnodes such as llvm.dbg.enum and llvm.dbg.ty.
Eric Christopher58f41952012-11-19 22:42:15 +0000692void DwarfDebug::collectInfoFromNamedMDNodes(const Module *M) {
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000693 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.sp"))
694 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
695 const MDNode *N = NMD->getOperand(i);
696 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
697 constructSubprogramDIE(CU, N);
698 }
Eric Christopher6a841382012-11-19 22:42:10 +0000699
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000700 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.gv"))
701 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
702 const MDNode *N = NMD->getOperand(i);
703 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
Devang Patel0ecbcbd2011-08-18 23:17:55 +0000704 CU->createGlobalVariableDIE(N);
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000705 }
Eric Christopher6a841382012-11-19 22:42:10 +0000706
Devang Patel07bb9ee2011-08-15 23:47:24 +0000707 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
708 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
709 DIType Ty(NMD->getOperand(i));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000710 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
711 CU->getOrCreateTypeDIE(Ty);
Devang Patel07bb9ee2011-08-15 23:47:24 +0000712 }
Eric Christopher6a841382012-11-19 22:42:10 +0000713
Devang Patel07bb9ee2011-08-15 23:47:24 +0000714 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
715 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
716 DIType Ty(NMD->getOperand(i));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000717 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
718 CU->getOrCreateTypeDIE(Ty);
Devang Patel07bb9ee2011-08-15 23:47:24 +0000719 }
720}
721
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000722// Collect debug info using DebugInfoFinder.
723// FIXME - Remove this when dragonegg switches to DIBuilder.
Eric Christopher58f41952012-11-19 22:42:15 +0000724bool DwarfDebug::collectLegacyDebugInfo(const Module *M) {
Devang Patel07bb9ee2011-08-15 23:47:24 +0000725 DebugInfoFinder DbgFinder;
726 DbgFinder.processModule(*M);
Eric Christopher6a841382012-11-19 22:42:10 +0000727
Devang Patel07bb9ee2011-08-15 23:47:24 +0000728 bool HasDebugInfo = false;
729 // Scan all the compile-units to see if there are any marked as the main
730 // unit. If not, we do not generate debug info.
731 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
732 E = DbgFinder.compile_unit_end(); I != E; ++I) {
733 if (DICompileUnit(*I).isMain()) {
734 HasDebugInfo = true;
735 break;
736 }
737 }
738 if (!HasDebugInfo) return false;
Eric Christopher6a841382012-11-19 22:42:10 +0000739
Devang Patel07bb9ee2011-08-15 23:47:24 +0000740 // Create all the compile unit DIEs.
741 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
742 E = DbgFinder.compile_unit_end(); I != E; ++I)
743 constructCompileUnit(*I);
Eric Christopher6a841382012-11-19 22:42:10 +0000744
Devang Patel07bb9ee2011-08-15 23:47:24 +0000745 // Create DIEs for each global variable.
746 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
747 E = DbgFinder.global_variable_end(); I != E; ++I) {
748 const MDNode *N = *I;
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000749 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
Devang Patel0ecbcbd2011-08-18 23:17:55 +0000750 CU->createGlobalVariableDIE(N);
Devang Patel07bb9ee2011-08-15 23:47:24 +0000751 }
Eric Christopher6a841382012-11-19 22:42:10 +0000752
Devang Patel07bb9ee2011-08-15 23:47:24 +0000753 // Create DIEs for each subprogram.
754 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
755 E = DbgFinder.subprogram_end(); I != E; ++I) {
756 const MDNode *N = *I;
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000757 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
758 constructSubprogramDIE(CU, N);
Devang Patel07bb9ee2011-08-15 23:47:24 +0000759 }
760
761 return HasDebugInfo;
762}
763
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000764// Emit all Dwarf sections that should come prior to the content. Create
765// global DIEs and emit initial debug info sections. This is invoked by
766// the target AsmPrinter.
Eric Christopher58f41952012-11-19 22:42:15 +0000767void DwarfDebug::beginModule() {
Devang Patel6c74a872010-04-27 19:46:33 +0000768 if (DisableDebugInfoPrinting)
769 return;
770
Eric Christopher58f41952012-11-19 22:42:15 +0000771 const Module *M = MMI->getModule();
772
Nick Lewycky019d2552011-07-29 03:49:23 +0000773 // If module has named metadata anchors then use them, otherwise scan the
774 // module using debug info finder to collect debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000775 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
776 if (CU_Nodes) {
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000777 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
778 DICompileUnit CUNode(CU_Nodes->getOperand(i));
779 CompileUnit *CU = constructCompileUnit(CUNode);
780 DIArray GVs = CUNode.getGlobalVariables();
781 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
Devang Patel0ecbcbd2011-08-18 23:17:55 +0000782 CU->createGlobalVariableDIE(GVs.getElement(i));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000783 DIArray SPs = CUNode.getSubprograms();
784 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
785 constructSubprogramDIE(CU, SPs.getElement(i));
786 DIArray EnumTypes = CUNode.getEnumTypes();
787 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
788 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
789 DIArray RetainedTypes = CUNode.getRetainedTypes();
790 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
791 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
792 }
Devang Patel07bb9ee2011-08-15 23:47:24 +0000793 } else if (!collectLegacyDebugInfo(M))
794 return;
Devang Patele02e5852011-05-03 16:45:22 +0000795
Devang Patel07bb9ee2011-08-15 23:47:24 +0000796 collectInfoFromNamedMDNodes(M);
Eric Christopher6a841382012-11-19 22:42:10 +0000797
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000798 // Tell MMI that we have debug info.
799 MMI->setDebugInfoAvailability(true);
Eric Christopher6a841382012-11-19 22:42:10 +0000800
Bill Wendling2b128d72009-05-20 23:19:06 +0000801 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +0000802 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +0000803}
804
Eric Christopher960ac372012-11-22 00:59:49 +0000805// Attach DW_AT_inline attribute with inlined subprogram DIEs.
806void DwarfDebug::computeInlinedDIEs() {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000807 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
808 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000809 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000810 DIE *ISP = *AI;
Devang Patelf20c4f72011-04-12 22:53:02 +0000811 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000812 }
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000813 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000814 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000815 DIE *ISP = AI->second;
816 if (InlinedSubprogramDIEs.count(ISP))
817 continue;
818 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
819 }
Eric Christopher960ac372012-11-22 00:59:49 +0000820}
821
822// Collect info for variables that were optimized out.
823void DwarfDebug::collectDeadVariables() {
824 const Module *M = MMI->getModule();
825 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
826
827 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
828 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
829 DICompileUnit TheCU(CU_Nodes->getOperand(i));
830 DIArray Subprograms = TheCU.getSubprograms();
831 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopher735401c2012-11-27 00:13:51 +0000832 DISubprogram SP(Subprograms.getElement(i));
833 if (ProcessedSPNodes.count(SP) != 0) continue;
834 if (!SP.Verify()) continue;
835 if (!SP.isDefinition()) continue;
836 DIArray Variables = SP.getVariables();
837 if (Variables.getNumElements() == 0) continue;
Eric Christopher960ac372012-11-22 00:59:49 +0000838
Eric Christopher735401c2012-11-27 00:13:51 +0000839 LexicalScope *Scope =
840 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
841 DeadFnScopeMap[SP] = Scope;
Eric Christopher960ac372012-11-22 00:59:49 +0000842
Eric Christopher735401c2012-11-27 00:13:51 +0000843 // Construct subprogram DIE and add variables DIEs.
844 CompileUnit *SPCU = CUMap.lookup(TheCU);
845 assert(SPCU && "Unable to find Compile Unit!");
846 constructSubprogramDIE(SPCU, SP);
847 DIE *ScopeDIE = SPCU->getDIE(SP);
848 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
849 DIVariable DV(Variables.getElement(vi));
850 if (!DV.Verify()) continue;
851 DbgVariable *NewVar = new DbgVariable(DV, NULL);
852 if (DIE *VariableDIE =
853 SPCU->constructVariableDIE(NewVar, Scope->isAbstractScope()))
854 ScopeDIE->addChild(VariableDIE);
855 }
Eric Christopher960ac372012-11-22 00:59:49 +0000856 }
857 }
858 }
859 DeleteContainerSeconds(DeadFnScopeMap);
860}
861
862void DwarfDebug::finalizeModuleInfo() {
863 // Collect info for variables that were optimized out.
864 collectDeadVariables();
865
866 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
867 computeInlinedDIEs();
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000868
Eric Christopherb1b94512012-08-01 18:19:01 +0000869 // Emit DW_AT_containing_type attribute to connect types with their
870 // vtable holding type.
Devang Patel89543712011-08-15 17:24:54 +0000871 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000872 CUE = CUMap.end(); CUI != CUE; ++CUI) {
Devang Patel89543712011-08-15 17:24:54 +0000873 CompileUnit *TheCU = CUI->second;
874 TheCU->constructContainingTypeDIEs();
Devang Pateleb57c592009-12-03 19:11:07 +0000875 }
876
Eric Christopher960ac372012-11-22 00:59:49 +0000877 // Compute DIE offsets and sizes.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000878 InfoHolder.computeSizeAndOffsets();
879 if (useSplitDwarf())
880 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher960ac372012-11-22 00:59:49 +0000881}
882
883void DwarfDebug::endSections() {
Bill Wendling2b128d72009-05-20 23:19:06 +0000884 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +0000885 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnera179b522010-04-04 19:25:43 +0000886 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +0000887 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnera179b522010-04-04 19:25:43 +0000888 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +0000889
890 // End text sections.
Benjamin Kramer15591272012-10-31 13:45:49 +0000891 for (unsigned I = 0, E = SectionMap.size(); I != E; ++I) {
892 Asm->OutStreamer.SwitchSection(SectionMap[I]);
893 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", I+1));
Bill Wendling2b128d72009-05-20 23:19:06 +0000894 }
Eric Christopher960ac372012-11-22 00:59:49 +0000895}
Bill Wendling2b128d72009-05-20 23:19:06 +0000896
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000897// Emit all Dwarf sections that should come after the content.
Eric Christopher960ac372012-11-22 00:59:49 +0000898void DwarfDebug::endModule() {
899
900 if (!FirstCU) return;
901
902 // End any existing sections.
903 // TODO: Does this need to happen?
904 endSections();
905
906 // Finalize the debug info for the module.
907 finalizeModuleInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +0000908
Eric Christophercebb0ec2012-11-19 19:43:59 +0000909 // Emit initial sections.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000910 emitSectionLabels();
Eric Christophercebb0ec2012-11-19 19:43:59 +0000911
Eric Christophercdf218d2012-12-10 19:51:21 +0000912 if (!useSplitDwarf()) {
Eric Christopher95198f502012-11-27 22:43:42 +0000913 // Emit all the DIEs into a debug info section.
914 emitDebugInfo();
Eric Christopher4c9b1192012-11-27 00:41:54 +0000915
Eric Christopher95198f502012-11-27 22:43:42 +0000916 // Corresponding abbreviations into a abbrev section.
917 emitAbbreviations();
918
919 // Emit info into a debug loc section.
920 emitDebugLoc();
921
922 // Emit info into a debug aranges section.
923 emitDebugARanges();
924
925 // Emit info into a debug ranges section.
926 emitDebugRanges();
927
928 // Emit info into a debug macinfo section.
929 emitDebugMacInfo();
930
931 // Emit inline info.
932 // TODO: When we don't need the option anymore we
933 // can remove all of the code that this section
934 // depends upon.
935 if (useDarwinGDBCompat())
936 emitDebugInlineInfo();
937 } else {
938 // TODO: Fill this in for Fission sections and separate
939 // out information into new sections.
940
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000941 // Emit the debug info section and compile units.
Eric Christopher95198f502012-11-27 22:43:42 +0000942 emitDebugInfo();
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000943 emitDebugInfoDWO();
Eric Christopher95198f502012-11-27 22:43:42 +0000944
945 // Corresponding abbreviations into a abbrev section.
946 emitAbbreviations();
947
948 // Emit info into a debug loc section.
949 emitDebugLoc();
950
951 // Emit info into a debug aranges section.
952 emitDebugARanges();
953
954 // Emit info into a debug ranges section.
955 emitDebugRanges();
956
957 // Emit info into a debug macinfo section.
958 emitDebugMacInfo();
959
960 // Emit inline info.
961 // TODO: When we don't need the option anymore we
962 // can remove all of the code that this section
963 // depends upon.
964 if (useDarwinGDBCompat())
965 emitDebugInlineInfo();
966 }
Bill Wendling2b128d72009-05-20 23:19:06 +0000967
Eric Christophera876b822012-08-23 07:32:06 +0000968 // Emit info into the dwarf accelerator table sections.
Eric Christopher20b76a72012-08-23 22:36:40 +0000969 if (useDwarfAccelTables()) {
Eric Christopher4996c702011-11-07 09:24:32 +0000970 emitAccelNames();
971 emitAccelObjC();
972 emitAccelNamespaces();
973 emitAccelTypes();
974 }
Eric Christopher6a841382012-11-19 22:42:10 +0000975
Devang Patel04d2f2d2009-11-24 01:14:22 +0000976 // Emit info into a debug pubtypes section.
Eric Christopher77826182012-08-23 07:10:56 +0000977 // TODO: When we don't need the option anymore we can
978 // remove all of the code that adds to the table.
Eric Christopher20b76a72012-08-23 22:36:40 +0000979 if (useDarwinGDBCompat())
Eric Christopher77826182012-08-23 07:10:56 +0000980 emitDebugPubTypes();
Devang Patel04d2f2d2009-11-24 01:14:22 +0000981
Eric Christopher95198f502012-11-27 22:43:42 +0000982 // Finally emit string information into a string table.
Eric Christopher6e20a162012-11-27 06:49:23 +0000983 emitDebugStr();
984
Devang Pateld0701282010-08-02 17:32:15 +0000985 // clean up.
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000986 SPMap.clear();
Devang Patel1a0df9a2010-05-10 22:49:55 +0000987 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
988 E = CUMap.end(); I != E; ++I)
989 delete I->second;
Eric Christopher8afd7b62012-12-10 19:51:18 +0000990
Eric Christophercdf218d2012-12-10 19:51:21 +0000991 delete SkeletonCU;
Eric Christopher8afd7b62012-12-10 19:51:18 +0000992
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000993 // Reset these for the next Module if we have one.
994 FirstCU = NULL;
Eric Christophercdf218d2012-12-10 19:51:21 +0000995 SkeletonCU = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +0000996}
997
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000998// Find abstract variable, if any, associated with Var.
Devang Patelbb23a4a2011-08-10 21:50:54 +0000999DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattner915c5f92010-04-02 19:42:39 +00001000 DebugLoc ScopeLoc) {
Devang Patelbb23a4a2011-08-10 21:50:54 +00001001 LLVMContext &Ctx = DV->getContext();
1002 // More then one inlined variable corresponds to one abstract variable.
1003 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001004 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001005 if (AbsDbgVariable)
1006 return AbsDbgVariable;
1007
Devang Patel7e623022011-08-10 20:55:27 +00001008 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001009 if (!Scope)
1010 return NULL;
1011
Devang Patel99819b52011-08-15 19:01:20 +00001012 AbsDbgVariable = new DbgVariable(Var, NULL);
Devang Patel7e623022011-08-10 20:55:27 +00001013 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001014 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001015 return AbsDbgVariable;
1016}
1017
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001018// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel6c622ef2011-03-01 22:58:55 +00001019bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patel7e623022011-08-10 20:55:27 +00001020 DbgVariable *Var, LexicalScope *Scope) {
1021 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +00001022 return false;
1023 DIVariable DV = Var->getVariable();
1024 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1025 return false;
1026 unsigned ArgNo = DV.getArgNumber();
Eric Christopher6a841382012-11-19 22:42:10 +00001027 if (ArgNo == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001028 return false;
1029
Devang Patel4ab660b2011-03-03 20:02:02 +00001030 size_t Size = CurrentFnArguments.size();
1031 if (Size == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001032 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001033 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001034 // arguments does the function have at source level.
1035 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001036 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001037 CurrentFnArguments[ArgNo - 1] = Var;
1038 return true;
1039}
1040
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001041// Collect variable information from side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001042void
Nick Lewycky019d2552011-07-29 03:49:23 +00001043DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patel490c8ab2010-05-20 19:57:06 +00001044 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001045 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1046 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1047 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001048 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001049 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001050 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001051 DIVariable DV(Var);
1052 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001053
Devang Patel7e623022011-08-10 20:55:27 +00001054 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001055
Devang Patelcdb7d442009-11-10 23:20:04 +00001056 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001057 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001058 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001059
Devang Patele1c53f22010-05-20 16:36:41 +00001060 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Devang Patel99819b52011-08-15 19:01:20 +00001061 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable);
Devang Patel3e4a9652011-08-15 21:24:36 +00001062 RegVar->setFrameIndex(VP.first);
Devang Patel6c622ef2011-03-01 22:58:55 +00001063 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001064 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001065 if (AbsDbgVariable)
Devang Patel3e4a9652011-08-15 21:24:36 +00001066 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patel475d32a2009-10-06 01:26:37 +00001067 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001068}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001069
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001070// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1071// defined reg.
Devang Patel9fc11702010-05-25 23:40:22 +00001072static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001073 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001074 return MI->getNumOperands() == 3 &&
1075 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
1076 MI->getOperand(1).isImm() && MI->getOperand(1).getImm() == 0;
Devang Patel9fc11702010-05-25 23:40:22 +00001077}
1078
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001079// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher6a841382012-11-19 22:42:10 +00001080static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1081 const MCSymbol *FLabel,
Devang Patel2442a892011-07-08 17:09:57 +00001082 const MCSymbol *SLabel,
1083 const MachineInstr *MI) {
1084 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1085
1086 if (MI->getNumOperands() != 3) {
1087 MachineLocation MLoc = Asm->getDebugValueLocation(MI);
1088 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1089 }
1090 if (MI->getOperand(0).isReg() && MI->getOperand(1).isImm()) {
1091 MachineLocation MLoc;
1092 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
1093 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1094 }
1095 if (MI->getOperand(0).isImm())
1096 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1097 if (MI->getOperand(0).isFPImm())
1098 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1099 if (MI->getOperand(0).isCImm())
1100 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1101
Craig Topperee4dab52012-02-05 08:31:47 +00001102 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel2442a892011-07-08 17:09:57 +00001103}
1104
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001105// Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001106void
Devang Patel5c0f85c2010-06-25 22:07:34 +00001107DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1108 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001109
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001110 // collection info from MMI table.
Devang Patel490c8ab2010-05-20 19:57:06 +00001111 collectVariableInfoFromMMITable(MF, Processed);
1112
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001113 for (SmallVectorImpl<const MDNode*>::const_iterator
1114 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1115 ++UVI) {
1116 const MDNode *Var = *UVI;
1117 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001118 continue;
1119
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001120 // History contains relevant DBG_VALUE instructions for Var and instructions
1121 // clobbering it.
1122 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1123 if (History.empty())
1124 continue;
1125 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001126
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001127 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001128 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001129 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1130 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +00001131 Scope = LScopes.getCurrentFunctionScope();
Devang Patel8fb9fd62011-07-20 22:18:50 +00001132 else {
1133 if (DV.getVersion() <= LLVMDebugVersion9)
Devang Patel7e623022011-08-10 20:55:27 +00001134 Scope = LScopes.findLexicalScope(MInsn->getDebugLoc());
Devang Patel8fb9fd62011-07-20 22:18:50 +00001135 else {
1136 if (MDNode *IA = DV.getInlinedAt())
Devang Patel7e623022011-08-10 20:55:27 +00001137 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
Devang Patel8fb9fd62011-07-20 22:18:50 +00001138 else
Devang Patel7e623022011-08-10 20:55:27 +00001139 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel8fb9fd62011-07-20 22:18:50 +00001140 }
1141 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001142 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001143 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001144 continue;
1145
1146 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001147 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel99819b52011-08-15 19:01:20 +00001148 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
1149 DbgVariable *RegVar = new DbgVariable(DV, AbsVar);
Devang Patel6c622ef2011-03-01 22:58:55 +00001150 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001151 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001152 if (AbsVar)
Devang Patel3e4a9652011-08-15 21:24:36 +00001153 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001154
Eric Christophercc10d202012-10-08 20:48:54 +00001155 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001156 if (History.size() <= 1 || (History.size() == 2 &&
1157 MInsn->isIdenticalTo(History.back()))) {
Devang Patel3e4a9652011-08-15 21:24:36 +00001158 RegVar->setMInsn(MInsn);
Devang Patel9fc11702010-05-25 23:40:22 +00001159 continue;
1160 }
1161
1162 // handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001163 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001164
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001165 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1166 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1167 const MachineInstr *Begin = *HI;
1168 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001169
Devang Patele7181b52011-06-01 23:00:17 +00001170 // Check if DBG_VALUE is truncating a range.
1171 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1172 && !Begin->getOperand(0).getReg())
1173 continue;
1174
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001175 // Compute the range for a register location.
1176 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1177 const MCSymbol *SLabel = 0;
1178
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001179 if (HI + 1 == HE)
1180 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001181 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001182 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001183 else {
1184 const MachineInstr *End = HI[1];
Eric Christopher6a841382012-11-19 22:42:10 +00001185 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel53b050a2011-07-07 21:44:42 +00001186 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001187 if (End->isDebugValue())
1188 SLabel = getLabelBeforeInsn(End);
1189 else {
1190 // End is a normal instruction clobbering the range.
1191 SLabel = getLabelAfterInsn(End);
1192 assert(SLabel && "Forgot label after clobber instruction");
1193 ++HI;
1194 }
1195 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001196
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001197 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopher365d0832011-12-16 23:42:31 +00001198 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1199 Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001200 }
1201 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001202 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001203
1204 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001205 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1206 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1207 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1208 DIVariable DV(Variables.getElement(i));
1209 if (!DV || !DV.Verify() || !Processed.insert(DV))
1210 continue;
1211 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1212 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patele0a94bf2010-05-14 21:01:35 +00001213 }
Devang Patel9fc11702010-05-25 23:40:22 +00001214}
Devang Patele0a94bf2010-05-14 21:01:35 +00001215
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001216// Return Label preceding the instruction.
Devang Patel9fc11702010-05-25 23:40:22 +00001217const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001218 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1219 assert(Label && "Didn't insert label before instruction");
1220 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001221}
1222
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001223// Return Label immediately following the instruction.
Devang Patel9fc11702010-05-25 23:40:22 +00001224const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001225 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001226}
1227
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001228// Process beginning of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001229void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001230 // Check if source location changes, but ignore DBG_VALUE locations.
1231 if (!MI->isDebugValue()) {
1232 DebugLoc DL = MI->getDebugLoc();
1233 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopheraec8a822012-04-05 20:39:05 +00001234 unsigned Flags = 0;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001235 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001236 if (DL == PrologEndLoc) {
1237 Flags |= DWARF2_FLAG_PROLOGUE_END;
1238 PrologEndLoc = DebugLoc();
1239 }
Eric Christopheraec8a822012-04-05 20:39:05 +00001240 if (PrologEndLoc.isUnknown())
1241 Flags |= DWARF2_FLAG_IS_STMT;
1242
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001243 if (!DL.isUnknown()) {
1244 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001245 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001246 } else
Devang Patel34a66202011-05-11 19:22:19 +00001247 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001248 }
Devang Patel9fc11702010-05-25 23:40:22 +00001249 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001250
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001251 // Insert labels where requested.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001252 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1253 LabelsBeforeInsn.find(MI);
1254
1255 // No label needed.
1256 if (I == LabelsBeforeInsn.end())
1257 return;
1258
1259 // Label already assigned.
1260 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001261 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001262
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001263 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001264 PrevLabel = MMI->getContext().CreateTempSymbol();
1265 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001266 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001267 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001268}
1269
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001270// Process end of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001271void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001272 // Don't create a new label after DBG_VALUE instructions.
1273 // They don't generate code.
1274 if (!MI->isDebugValue())
1275 PrevLabel = 0;
1276
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001277 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1278 LabelsAfterInsn.find(MI);
1279
1280 // No label needed.
1281 if (I == LabelsAfterInsn.end())
1282 return;
1283
1284 // Label already assigned.
1285 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001286 return;
1287
1288 // We need a label after this instruction.
1289 if (!PrevLabel) {
1290 PrevLabel = MMI->getContext().CreateTempSymbol();
1291 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001292 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001293 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001294}
1295
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001296// Each LexicalScope has first instruction and last instruction to mark
1297// beginning and end of a scope respectively. Create an inverse map that list
1298// scopes starts (and ends) with an instruction. One instruction may start (or
1299// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001300void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001301 SmallVector<LexicalScope *, 4> WorkList;
1302 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001303 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001304 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001305
Devang Patel7e623022011-08-10 20:55:27 +00001306 const SmallVector<LexicalScope *, 4> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001307 if (!Children.empty())
Devang Patel7e623022011-08-10 20:55:27 +00001308 for (SmallVector<LexicalScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00001309 SE = Children.end(); SI != SE; ++SI)
1310 WorkList.push_back(*SI);
1311
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001312 if (S->isAbstractScope())
1313 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001314
Devang Patel7e623022011-08-10 20:55:27 +00001315 const SmallVector<InsnRange, 4> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001316 if (Ranges.empty())
1317 continue;
Devang Patel7e623022011-08-10 20:55:27 +00001318 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +00001319 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001320 assert(RI->first && "InsnRange does not have first instruction!");
1321 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001322 requestLabelBeforeInsn(RI->first);
1323 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001324 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001325 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001326}
1327
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001328// Get MDNode for DebugLoc's scope.
Devang Patel589845d2011-05-09 22:14:49 +00001329static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1330 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1331 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1332 return DL.getScope(Ctx);
1333}
1334
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001335// Walk up the scope chain of given debug loc and find line number info
1336// for the function.
Devang Patel34a66202011-05-11 19:22:19 +00001337static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1338 const MDNode *Scope = getScopeNode(DL, Ctx);
1339 DISubprogram SP = getDISubprogram(Scope);
Eric Christopher34164192012-04-03 00:43:49 +00001340 if (SP.Verify()) {
1341 // Check for number of operands since the compatibility is
1342 // cheap here.
Eric Christopherb81e2b42012-04-03 17:55:42 +00001343 if (SP->getNumOperands() > 19)
Eric Christopher34164192012-04-03 00:43:49 +00001344 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1345 else
1346 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1347 }
1348
Devang Patel34a66202011-05-11 19:22:19 +00001349 return DebugLoc();
1350}
1351
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001352// Gather pre-function debug information. Assumes being called immediately
1353// after the function entry point has been emitted.
Chris Lattner76555b52010-01-26 23:18:02 +00001354void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00001355 if (!MMI->hasDebugInfo()) return;
Devang Patel7e623022011-08-10 20:55:27 +00001356 LScopes.initialize(*MF);
1357 if (LScopes.empty()) return;
1358 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001359
Devang Patel6c74a872010-04-27 19:46:33 +00001360 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1361 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001362 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001363 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001364
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001365 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1366
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001367 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001368 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001369 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1370
Devang Patel002d54d2010-05-26 19:37:24 +00001371 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001372 I != E; ++I) {
1373 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001374 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1375 II != IE; ++II) {
1376 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001377
Devang Patel002d54d2010-05-26 19:37:24 +00001378 if (MI->isDebugValue()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001379 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001380
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001381 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001382 const MDNode *Var =
1383 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001384
1385 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001386 if (isDbgValueInDefinedReg(MI))
1387 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1388
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001389 // Check the history of this variable.
1390 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1391 if (History.empty()) {
1392 UserVariables.push_back(Var);
1393 // The first mention of a function argument gets the FunctionBeginSym
1394 // label, so arguments are visible when breaking at function entry.
1395 DIVariable DV(Var);
1396 if (DV.Verify() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1397 DISubprogram(getDISubprogram(DV.getContext()))
1398 .describes(MF->getFunction()))
1399 LabelsBeforeInsn[MI] = FunctionBeginSym;
1400 } else {
1401 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1402 const MachineInstr *Prev = History.back();
1403 if (Prev->isDebugValue()) {
1404 // Coalesce identical entries at the end of History.
1405 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001406 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher85a495e2012-10-08 20:48:49 +00001407 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher6a841382012-11-19 22:42:10 +00001408 << "\t" << *Prev
Devang Patelb7a328e2011-07-07 00:14:27 +00001409 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001410 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001411 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001412
1413 // Terminate old register assignments that don't reach MI;
1414 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1415 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1416 isDbgValueInDefinedReg(Prev)) {
1417 // Previous register assignment needs to terminate at the end of
1418 // its basic block.
1419 MachineBasicBlock::const_iterator LastMI =
1420 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001421 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001422 // Drop DBG_VALUE for empty range.
Eric Christopher85a495e2012-10-08 20:48:49 +00001423 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patelb7a328e2011-07-07 00:14:27 +00001424 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001425 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001426 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001427 else {
1428 // Terminate after LastMI.
1429 History.push_back(LastMI);
1430 }
1431 }
1432 }
1433 }
1434 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001435 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001436 // Not a DBG_VALUE instruction.
1437 if (!MI->isLabel())
1438 AtBlockEntry = false;
1439
Eric Christopher133195782012-10-04 20:46:14 +00001440 // First known non-DBG_VALUE and non-frame setup location marks
1441 // the beginning of the function body.
1442 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1443 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel34a66202011-05-11 19:22:19 +00001444 PrologEndLoc = MI->getDebugLoc();
1445
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001446 // Check if the instruction clobbers any registers with debug vars.
1447 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1448 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1449 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1450 continue;
Jakob Stoklund Olesen54038d72012-06-01 23:28:30 +00001451 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1452 AI.isValid(); ++AI) {
1453 unsigned Reg = *AI;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001454 const MDNode *Var = LiveUserVar[Reg];
1455 if (!Var)
1456 continue;
1457 // Reg is now clobbered.
1458 LiveUserVar[Reg] = 0;
1459
1460 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001461 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1462 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001463 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001464 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1465 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001466 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001467 const MachineInstr *Prev = History.back();
1468 // Sanity-check: Register assignments are terminated at the end of
1469 // their block.
1470 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1471 continue;
1472 // Is the variable still in Reg?
1473 if (!isDbgValueInDefinedReg(Prev) ||
1474 Prev->getOperand(0).getReg() != Reg)
1475 continue;
1476 // Var is clobbered. Make sure the next instruction gets a label.
1477 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001478 }
1479 }
Devang Patel002d54d2010-05-26 19:37:24 +00001480 }
Devang Patel002d54d2010-05-26 19:37:24 +00001481 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001482 }
1483
1484 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1485 I != E; ++I) {
1486 SmallVectorImpl<const MachineInstr*> &History = I->second;
1487 if (History.empty())
1488 continue;
1489
1490 // Make sure the final register assignments are terminated.
1491 const MachineInstr *Prev = History.back();
1492 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1493 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher6a841382012-11-19 22:42:10 +00001494 MachineBasicBlock::const_iterator LastMI =
Devang Patel784077e2011-08-10 23:58:09 +00001495 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001496 if (LastMI == PrevMBB->end())
1497 // Drop DBG_VALUE for empty range.
1498 History.pop_back();
1499 else {
1500 // Terminate after LastMI.
1501 History.push_back(LastMI);
1502 }
1503 }
1504 // Request labels for the full history.
1505 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1506 const MachineInstr *MI = History[i];
1507 if (MI->isDebugValue())
1508 requestLabelBeforeInsn(MI);
1509 else
1510 requestLabelAfterInsn(MI);
1511 }
1512 }
Devang Patel002d54d2010-05-26 19:37:24 +00001513
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001514 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001515 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001516
1517 // Record beginning of function.
1518 if (!PrologEndLoc.isUnknown()) {
1519 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1520 MF->getFunction()->getContext());
1521 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1522 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie67cb31e2012-12-04 22:02:33 +00001523 // We'd like to list the prologue as "not statements" but GDB behaves
1524 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikie5a773bb2012-12-04 21:05:36 +00001525 DWARF2_FLAG_IS_STMT);
Devang Patel34a66202011-05-11 19:22:19 +00001526 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001527}
1528
Devang Patel7e623022011-08-10 20:55:27 +00001529void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1530// SmallVector<DbgVariable *, 8> &Vars = ScopeVariables.lookup(LS);
1531 ScopeVariables[LS].push_back(Var);
1532// Vars.push_back(Var);
1533}
1534
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001535// Gather and emit post-function debug information.
Chris Lattner76555b52010-01-26 23:18:02 +00001536void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patel7e623022011-08-10 20:55:27 +00001537 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00001538
Devang Patel7e623022011-08-10 20:55:27 +00001539 // Define end label for subprogram.
1540 FunctionEndSym = Asm->GetTempSymbol("func_end",
1541 Asm->getFunctionNumber());
1542 // Assumes in correct section after the entry point.
1543 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Eric Christopher6a841382012-11-19 22:42:10 +00001544
Devang Patel7e623022011-08-10 20:55:27 +00001545 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1546 collectVariableInfo(MF, ProcessedVars);
Eric Christopher6a841382012-11-19 22:42:10 +00001547
Devang Patel3acc70e2011-08-15 22:04:40 +00001548 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001549 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001550 assert(TheCU && "Unable to find compile unit!");
Devang Patel3acc70e2011-08-15 22:04:40 +00001551
Devang Patel7e623022011-08-10 20:55:27 +00001552 // Construct abstract scopes.
Devang Patel44403472011-08-12 18:10:19 +00001553 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1554 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1555 LexicalScope *AScope = AList[i];
1556 DISubprogram SP(AScope->getScopeNode());
Devang Patel7e623022011-08-10 20:55:27 +00001557 if (SP.Verify()) {
1558 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001559 DIArray Variables = SP.getVariables();
1560 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1561 DIVariable DV(Variables.getElement(i));
1562 if (!DV || !DV.Verify() || !ProcessedVars.insert(DV))
1563 continue;
Alexey Samsonov39602782012-07-06 08:45:08 +00001564 // Check that DbgVariable for DV wasn't created earlier, when
1565 // findAbstractVariable() was called for inlined instance of DV.
1566 LLVMContext &Ctx = DV->getContext();
1567 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1568 if (AbstractVariables.lookup(CleanDV))
1569 continue;
Devang Patel59e27c52011-08-19 23:28:12 +00001570 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1571 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001572 }
1573 }
Devang Patel44403472011-08-12 18:10:19 +00001574 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Devang Patel3acc70e2011-08-15 22:04:40 +00001575 constructScopeDIE(TheCU, AScope);
Bill Wendling2b128d72009-05-20 23:19:06 +00001576 }
Eric Christopher6a841382012-11-19 22:42:10 +00001577
Devang Patel3acc70e2011-08-15 22:04:40 +00001578 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher6a841382012-11-19 22:42:10 +00001579
Nick Lewycky50f02cb2011-12-02 22:16:29 +00001580 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopherbb69a272012-08-24 01:14:27 +00001581 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Patel3acc70e2011-08-15 22:04:40 +00001582
Devang Patel7e623022011-08-10 20:55:27 +00001583 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
1584 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00001585
Bill Wendling2b128d72009-05-20 23:19:06 +00001586 // Clear debug info
Devang Patel7e623022011-08-10 20:55:27 +00001587 for (DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >::iterator
1588 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1589 DeleteContainerPointers(I->second);
1590 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001591 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001592 UserVariables.clear();
1593 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001594 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001595 LabelsBeforeInsn.clear();
1596 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001597 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001598}
1599
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001600// Register a source line with debug info. Returns the unique label that was
1601// emitted and which provides correspondence to the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00001602void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1603 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00001604 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00001605 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00001606 unsigned Src = 1;
1607 if (S) {
1608 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00001609
Dan Gohman50849c62010-05-05 23:41:32 +00001610 if (Scope.isCompileUnit()) {
1611 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001612 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001613 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00001614 } else if (Scope.isFile()) {
1615 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00001616 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001617 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001618 } else if (Scope.isSubprogram()) {
1619 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001620 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001621 Dir = SP.getDirectory();
Eric Christopher6647b832011-10-11 22:59:11 +00001622 } else if (Scope.isLexicalBlockFile()) {
1623 DILexicalBlockFile DBF(S);
1624 Fn = DBF.getFilename();
1625 Dir = DBF.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001626 } else if (Scope.isLexicalBlock()) {
1627 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001628 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001629 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001630 } else
Craig Topperee4dab52012-02-05 08:31:47 +00001631 llvm_unreachable("Unexpected scope info");
Dan Gohman50849c62010-05-05 23:41:32 +00001632
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001633 Src = getOrCreateSourceID(Fn, Dir);
Dan Gohman50849c62010-05-05 23:41:32 +00001634 }
Nick Lewycky019d2552011-07-29 03:49:23 +00001635 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00001636}
1637
Bill Wendling806535f2009-05-20 23:22:40 +00001638//===----------------------------------------------------------------------===//
1639// Emit Methods
1640//===----------------------------------------------------------------------===//
1641
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001642// Compute the size and offset of a DIE.
Jim Grosbach00e9c612009-11-22 19:20:36 +00001643unsigned
Eric Christopherc8a310e2012-12-10 23:34:43 +00001644DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling480ff322009-05-20 23:21:38 +00001645 // Get the children.
1646 const std::vector<DIE *> &Children = Die->getChildren();
1647
Bill Wendling480ff322009-05-20 23:21:38 +00001648 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00001649 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00001650
1651 // Get the abbreviation for this DIE.
1652 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopherc8a310e2012-12-10 23:34:43 +00001653 const DIEAbbrev *Abbrev = Abbreviations->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00001654
1655 // Set DIE offset
1656 Die->setOffset(Offset);
1657
1658 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00001659 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001660
1661 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
1662 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1663
1664 // Size the DIE attribute values.
1665 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1666 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001667 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001668
1669 // Size the DIE children if any.
1670 if (!Children.empty()) {
1671 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1672 "Children flag not set");
1673
1674 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001675 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling480ff322009-05-20 23:21:38 +00001676
1677 // End of children marker.
1678 Offset += sizeof(int8_t);
1679 }
1680
1681 Die->setSize(Offset - Die->getOffset());
1682 return Offset;
1683}
1684
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001685// Compute the size and offset of all the DIEs.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001686void DwarfUnits::computeSizeAndOffsets() {
1687 for (SmallVector<CompileUnit *, 1>::iterator I = CUs.begin(),
1688 E = CUs.end(); I != E; ++I) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001689 unsigned Offset =
1690 sizeof(int32_t) + // Length of Compilation Unit Info
1691 sizeof(int16_t) + // DWARF version number
1692 sizeof(int32_t) + // Offset Into Abbrev. Section
1693 sizeof(int8_t); // Pointer Size (in bytes)
1694
Eric Christopherc8a310e2012-12-10 23:34:43 +00001695 computeSizeAndOffset((*I)->getCUDie(), Offset);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001696 }
Bill Wendling480ff322009-05-20 23:21:38 +00001697}
1698
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001699// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001700void DwarfDebug::emitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001701 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001702
Bill Wendling480ff322009-05-20 23:21:38 +00001703 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001704 DwarfInfoSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001705 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001706 DwarfAbbrevSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001707 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
1708 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001709
Chris Lattner6629ca92010-04-04 22:59:04 +00001710 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001711 emitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00001712
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001713 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
1714 emitSectionSym(Asm, TLOF.getDwarfLocSection());
1715 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001716 DwarfStrSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001717 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
1718 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patel12563b32010-04-16 23:33:45 +00001719 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00001720
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001721 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patel9fc11702010-05-25 23:40:22 +00001722 "section_debug_loc");
1723
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001724 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
1725 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00001726}
1727
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001728// Recursively emits a debug information entry.
Devang Patel930143b2009-11-21 02:48:08 +00001729void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00001730 // Get the abbreviation for this DIE.
1731 unsigned AbbrevNumber = Die->getAbbrevNumber();
1732 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1733
Bill Wendling480ff322009-05-20 23:21:38 +00001734 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00001735 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00001736 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
1737 Twine::utohexstr(Die->getOffset()) + ":0x" +
1738 Twine::utohexstr(Die->getSize()) + " " +
1739 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00001740 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001741
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00001742 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00001743 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1744
1745 // Emit the DIE attribute values.
1746 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1747 unsigned Attr = AbbrevData[i].getAttribute();
1748 unsigned Form = AbbrevData[i].getForm();
1749 assert(Form && "Too many attributes for DIE (check abbreviation)");
1750
Chris Lattner7bde8c02010-04-04 18:52:31 +00001751 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00001752 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001753
Bill Wendling480ff322009-05-20 23:21:38 +00001754 switch (Attr) {
Bill Wendling480ff322009-05-20 23:21:38 +00001755 case dwarf::DW_AT_abstract_origin: {
1756 DIEEntry *E = cast<DIEEntry>(Values[i]);
1757 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001758 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00001759 Asm->EmitInt32(Addr);
1760 break;
1761 }
Devang Patel12563b32010-04-16 23:33:45 +00001762 case dwarf::DW_AT_ranges: {
1763 // DW_AT_range Value encodes offset in debug_range section.
1764 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00001765
Nick Lewycky33da3362012-06-22 01:25:12 +00001766 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelda3ef852010-09-02 16:43:44 +00001767 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
1768 V->getValue(),
1769 4);
1770 } else {
1771 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
1772 V->getValue(),
1773 DwarfDebugRangeSectionSym,
1774 4);
1775 }
Devang Patel12563b32010-04-16 23:33:45 +00001776 break;
1777 }
Devang Patel9fc11702010-05-25 23:40:22 +00001778 case dwarf::DW_AT_location: {
Nick Lewycky33da3362012-06-22 01:25:12 +00001779 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
1780 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
1781 Asm->EmitLabelReference(L->getValue(), 4);
1782 else
1783 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
1784 } else {
Devang Patel9fc11702010-05-25 23:40:22 +00001785 Values[i]->EmitValue(Asm, Form);
Nick Lewycky33da3362012-06-22 01:25:12 +00001786 }
Devang Patel9fc11702010-05-25 23:40:22 +00001787 break;
1788 }
Devang Patela1bd5a12010-09-29 19:08:08 +00001789 case dwarf::DW_AT_accessibility: {
1790 if (Asm->isVerbose()) {
1791 DIEInteger *V = cast<DIEInteger>(Values[i]);
1792 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
1793 }
1794 Values[i]->EmitValue(Asm, Form);
1795 break;
1796 }
Bill Wendling480ff322009-05-20 23:21:38 +00001797 default:
1798 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001799 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00001800 break;
1801 }
Bill Wendling480ff322009-05-20 23:21:38 +00001802 }
1803
1804 // Emit the DIE children if any.
1805 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
1806 const std::vector<DIE *> &Children = Die->getChildren();
1807
1808 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00001809 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00001810
Chris Lattner7bde8c02010-04-04 18:52:31 +00001811 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00001812 Asm->OutStreamer.AddComment("End Of Children Mark");
1813 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00001814 }
1815}
1816
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001817void DwarfDebug::emitCompileUnits(const MCSection *Section) {
1818 Asm->OutStreamer.SwitchSection(Section);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001819 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1820 E = CUMap.end(); I != E; ++I) {
1821 CompileUnit *TheCU = I->second;
1822 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001823
Devang Patel1a0df9a2010-05-10 22:49:55 +00001824 // Emit the compile units header.
1825 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
Eli Benderskyb42d1462012-12-03 18:45:45 +00001826 TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001827
Devang Patel1a0df9a2010-05-10 22:49:55 +00001828 // Emit size of content not including length itself
1829 unsigned ContentSize = Die->getSize() +
1830 sizeof(int16_t) + // DWARF version number
1831 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patele141234942011-04-13 19:41:17 +00001832 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001833
Devang Patel1a0df9a2010-05-10 22:49:55 +00001834 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
1835 Asm->EmitInt32(ContentSize);
1836 Asm->OutStreamer.AddComment("DWARF version number");
1837 Asm->EmitInt16(dwarf::DWARF_VERSION);
1838 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
1839 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
1840 DwarfAbbrevSectionSym);
1841 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth5da3f052012-11-01 09:14:31 +00001842 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001843
Devang Patel1a0df9a2010-05-10 22:49:55 +00001844 emitDIE(Die);
Eli Benderskyb42d1462012-12-03 18:45:45 +00001845 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end",
1846 TheCU->getUniqueID()));
Devang Patel1a0df9a2010-05-10 22:49:55 +00001847 }
Bill Wendling480ff322009-05-20 23:21:38 +00001848}
1849
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001850// Emit the debug info section.
1851void DwarfDebug::emitDebugInfo() {
Eric Christophercdf218d2012-12-10 19:51:21 +00001852 if (!useSplitDwarf())
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001853 emitCompileUnits(Asm->getObjFileLowering().getDwarfInfoSection());
1854 else
Eric Christophercdf218d2012-12-10 19:51:21 +00001855 emitSkeletonCU(Asm->getObjFileLowering().getDwarfInfoSection());
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001856}
1857
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001858// Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +00001859void DwarfDebug::emitAbbreviations() {
Bill Wendling480ff322009-05-20 23:21:38 +00001860 // Check to see if it is worth the effort.
1861 if (!Abbreviations.empty()) {
1862 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001863 Asm->OutStreamer.SwitchSection(
1864 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00001865
Chris Lattnera179b522010-04-04 19:25:43 +00001866 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00001867
1868 // For each abbrevation.
1869 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
1870 // Get abbreviation data
1871 const DIEAbbrev *Abbrev = Abbreviations[i];
1872
1873 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00001874 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00001875
1876 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001877 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00001878 }
1879
1880 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00001881 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00001882
Chris Lattnera179b522010-04-04 19:25:43 +00001883 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00001884 }
1885}
1886
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001887// Emit the last address of the section and the end of the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +00001888void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00001889 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00001890 Asm->OutStreamer.AddComment("Extended Op");
1891 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001892
Chris Lattner566cae92010-03-09 23:52:58 +00001893 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth5da3f052012-11-01 09:14:31 +00001894 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00001895 Asm->OutStreamer.AddComment("DW_LNE_set_address");
1896 Asm->EmitInt8(dwarf::DW_LNE_set_address);
1897
1898 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00001899
Chris Lattnera179b522010-04-04 19:25:43 +00001900 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chandler Carruth5da3f052012-11-01 09:14:31 +00001901 Asm->getDataLayout().getPointerSize(),
Chris Lattner3a383cb2010-04-05 00:13:49 +00001902 0/*AddrSpace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00001903
1904 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00001905 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
1906 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00001907 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00001908 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00001909}
1910
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001911// Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00001912void DwarfDebug::emitAccelNames() {
1913 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1914 dwarf::DW_FORM_data4));
1915 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1916 E = CUMap.end(); I != E; ++I) {
1917 CompileUnit *TheCU = I->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00001918 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
1919 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00001920 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1921 const char *Name = GI->getKeyData();
Eric Christopher090fcc12012-01-06 23:03:34 +00001922 const std::vector<DIE *> &Entities = GI->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00001923 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1924 DE = Entities.end(); DI != DE; ++DI)
1925 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00001926 }
1927 }
1928
1929 AT.FinalizeTable(Asm, "Names");
1930 Asm->OutStreamer.SwitchSection(
1931 Asm->getObjFileLowering().getDwarfAccelNamesSection());
1932 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
1933 Asm->OutStreamer.EmitLabel(SectionBegin);
1934
1935 // Emit the full data.
1936 AT.Emit(Asm, SectionBegin, this);
1937}
1938
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001939// Emit objective C classes and categories into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00001940void DwarfDebug::emitAccelObjC() {
1941 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1942 dwarf::DW_FORM_data4));
1943 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1944 E = CUMap.end(); I != E; ++I) {
1945 CompileUnit *TheCU = I->second;
1946 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
1947 for (StringMap<std::vector<DIE*> >::const_iterator
1948 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1949 const char *Name = GI->getKeyData();
Eric Christopher090fcc12012-01-06 23:03:34 +00001950 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher4996c702011-11-07 09:24:32 +00001951 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1952 DE = Entities.end(); DI != DE; ++DI)
1953 AT.AddName(Name, (*DI));
1954 }
1955 }
1956
1957 AT.FinalizeTable(Asm, "ObjC");
1958 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
1959 .getDwarfAccelObjCSection());
1960 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
1961 Asm->OutStreamer.EmitLabel(SectionBegin);
1962
1963 // Emit the full data.
1964 AT.Emit(Asm, SectionBegin, this);
1965}
1966
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001967// Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00001968void DwarfDebug::emitAccelNamespaces() {
1969 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1970 dwarf::DW_FORM_data4));
1971 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1972 E = CUMap.end(); I != E; ++I) {
1973 CompileUnit *TheCU = I->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00001974 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
1975 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00001976 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1977 const char *Name = GI->getKeyData();
Eric Christopher090fcc12012-01-06 23:03:34 +00001978 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00001979 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1980 DE = Entities.end(); DI != DE; ++DI)
1981 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00001982 }
1983 }
1984
1985 AT.FinalizeTable(Asm, "namespac");
1986 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
1987 .getDwarfAccelNamespaceSection());
1988 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
1989 Asm->OutStreamer.EmitLabel(SectionBegin);
1990
1991 // Emit the full data.
1992 AT.Emit(Asm, SectionBegin, this);
1993}
1994
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001995// Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00001996void DwarfDebug::emitAccelTypes() {
Eric Christopher21bde872012-01-06 04:35:23 +00001997 std::vector<DwarfAccelTable::Atom> Atoms;
1998 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1999 dwarf::DW_FORM_data4));
2000 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTag,
2001 dwarf::DW_FORM_data2));
2002 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTypeFlags,
2003 dwarf::DW_FORM_data1));
2004 DwarfAccelTable AT(Atoms);
Eric Christopher4996c702011-11-07 09:24:32 +00002005 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2006 E = CUMap.end(); I != E; ++I) {
2007 CompileUnit *TheCU = I->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002008 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2009 = TheCU->getAccelTypes();
2010 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002011 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2012 const char *Name = GI->getKeyData();
Eric Christopher090fcc12012-01-06 23:03:34 +00002013 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002014 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2015 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2016 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher4996c702011-11-07 09:24:32 +00002017 }
2018 }
2019
2020 AT.FinalizeTable(Asm, "types");
2021 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2022 .getDwarfAccelTypesSection());
2023 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2024 Asm->OutStreamer.EmitLabel(SectionBegin);
2025
2026 // Emit the full data.
2027 AT.Emit(Asm, SectionBegin, this);
2028}
2029
Devang Patel04d2f2d2009-11-24 01:14:22 +00002030void DwarfDebug::emitDebugPubTypes() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002031 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2032 E = CUMap.end(); I != E; ++I) {
2033 CompileUnit *TheCU = I->second;
Eric Christopher6abc9c52011-11-07 09:18:35 +00002034 // Start the dwarf pubtypes section.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002035 Asm->OutStreamer.SwitchSection(
2036 Asm->getObjFileLowering().getDwarfPubTypesSection());
2037 Asm->OutStreamer.AddComment("Length of Public Types Info");
2038 Asm->EmitLabelDifference(
Eli Benderskyb42d1462012-12-03 18:45:45 +00002039 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2040 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002041
Devang Patel1a0df9a2010-05-10 22:49:55 +00002042 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
Eli Benderskyb42d1462012-12-03 18:45:45 +00002043 TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002044
Devang Patel1a0df9a2010-05-10 22:49:55 +00002045 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
2046 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002047
Devang Patel1a0df9a2010-05-10 22:49:55 +00002048 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eli Benderskyb42d1462012-12-03 18:45:45 +00002049 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin",
2050 TheCU->getUniqueID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00002051 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002052
Devang Patel1a0df9a2010-05-10 22:49:55 +00002053 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eli Benderskyb42d1462012-12-03 18:45:45 +00002054 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end",
2055 TheCU->getUniqueID()),
2056 Asm->GetTempSymbol("info_begin",
2057 TheCU->getUniqueID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00002058 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002059
Devang Patel1a0df9a2010-05-10 22:49:55 +00002060 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
2061 for (StringMap<DIE*>::const_iterator
2062 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2063 const char *Name = GI->getKeyData();
Nick Lewycky019d2552011-07-29 03:49:23 +00002064 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002065
Devang Patel1a0df9a2010-05-10 22:49:55 +00002066 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
2067 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002068
Devang Patel1a0df9a2010-05-10 22:49:55 +00002069 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002070 // Emit the name with a terminating null byte.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002071 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
2072 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002073
Devang Patel1a0df9a2010-05-10 22:49:55 +00002074 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002075 Asm->EmitInt32(0);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002076 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
Eli Benderskyb42d1462012-12-03 18:45:45 +00002077 TheCU->getUniqueID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00002078 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002079}
2080
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002081// Emit visible names into a debug str section.
Devang Patel930143b2009-11-21 02:48:08 +00002082void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00002083 // Check to see if it is worth the effort.
Chris Lattner3d72a672010-03-09 23:38:23 +00002084 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002085
Chris Lattner3d72a672010-03-09 23:38:23 +00002086 // Start the dwarf str section.
2087 Asm->OutStreamer.SwitchSection(
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002088 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002089
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002090 // Get all of the string pool entries and put them in an array by their ID so
2091 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002092 SmallVector<std::pair<unsigned,
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002093 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002094
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002095 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
2096 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
2097 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002098
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002099 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002100
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002101 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002102 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002103 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002104
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002105 // Emit the string itself with a terminating null byte.
Benjamin Kramer148db362011-11-09 12:12:04 +00002106 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
2107 Entries[i].second->getKeyLength()+1),
2108 0/*addrspace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00002109 }
2110}
2111
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002112// Emit visible names into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002113void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002114 if (DotDebugLocEntries.empty())
2115 return;
2116
Devang Patel116a9d72011-02-04 22:57:18 +00002117 for (SmallVector<DotDebugLocEntry, 4>::iterator
2118 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2119 I != E; ++I) {
2120 DotDebugLocEntry &Entry = *I;
2121 if (I + 1 != DotDebugLocEntries.end())
2122 Entry.Merge(I+1);
2123 }
2124
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002125 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002126 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00002127 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002128 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002129 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2130 unsigned index = 1;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002131 for (SmallVector<DotDebugLocEntry, 4>::iterator
2132 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002133 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002134 DotDebugLocEntry &Entry = *I;
2135 if (Entry.isMerged()) continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002136 if (Entry.isEmpty()) {
2137 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
2138 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002139 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002140 } else {
2141 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
2142 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
Devang Patel3e021532011-04-28 02:22:40 +00002143 DIVariable DV(Entry.Variable);
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002144 Asm->OutStreamer.AddComment("Loc expr size");
2145 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2146 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2147 Asm->EmitLabelDifference(end, begin, 2);
2148 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002149 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002150 DIBasicType BTy(DV.getType());
2151 if (BTy.Verify() &&
Eric Christopher6a841382012-11-19 22:42:10 +00002152 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patel324f8432011-06-01 22:03:25 +00002153 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2154 Asm->OutStreamer.AddComment("DW_OP_consts");
2155 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002156 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002157 } else {
2158 Asm->OutStreamer.AddComment("DW_OP_constu");
2159 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002160 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002161 }
Devang Pateled9fd452011-07-08 16:49:43 +00002162 } else if (Entry.isLocation()) {
Eric Christopher6a841382012-11-19 22:42:10 +00002163 if (!DV.hasComplexAddress())
Devang Pateled9fd452011-07-08 16:49:43 +00002164 // Regular entry.
Devang Patel3e021532011-04-28 02:22:40 +00002165 Asm->EmitDwarfRegOp(Entry.Loc);
Devang Pateled9fd452011-07-08 16:49:43 +00002166 else {
2167 // Complex address entry.
2168 unsigned N = DV.getNumAddrElements();
2169 unsigned i = 0;
2170 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
2171 if (Entry.Loc.getOffset()) {
2172 i = 2;
2173 Asm->EmitDwarfRegOp(Entry.Loc);
2174 Asm->OutStreamer.AddComment("DW_OP_deref");
2175 Asm->EmitInt8(dwarf::DW_OP_deref);
2176 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2177 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2178 Asm->EmitSLEB128(DV.getAddrElement(1));
2179 } else {
2180 // If first address element is OpPlus then emit
2181 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
2182 MachineLocation Loc(Entry.Loc.getReg(), DV.getAddrElement(1));
2183 Asm->EmitDwarfRegOp(Loc);
2184 i = 2;
2185 }
2186 } else {
2187 Asm->EmitDwarfRegOp(Entry.Loc);
2188 }
Eric Christopher6a841382012-11-19 22:42:10 +00002189
Devang Pateled9fd452011-07-08 16:49:43 +00002190 // Emit remaining complex address elements.
2191 for (; i < N; ++i) {
2192 uint64_t Element = DV.getAddrElement(i);
2193 if (Element == DIBuilder::OpPlus) {
2194 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2195 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher4d250522012-05-08 18:56:00 +00002196 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher8d2a77d2012-05-08 21:24:39 +00002197 if (!Entry.Loc.isReg())
Eric Christopher4d250522012-05-08 18:56:00 +00002198 Asm->EmitInt8(dwarf::DW_OP_deref);
2199 } else
2200 llvm_unreachable("unknown Opcode found in complex address");
Devang Pateled9fd452011-07-08 16:49:43 +00002201 }
Devang Patel3e021532011-04-28 02:22:40 +00002202 }
Devang Patel3e021532011-04-28 02:22:40 +00002203 }
Devang Pateled9fd452011-07-08 16:49:43 +00002204 // else ... ignore constant fp. There is not any good way to
2205 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002206 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002207 }
2208 }
Bill Wendling480ff322009-05-20 23:21:38 +00002209}
2210
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002211// Emit visible names into a debug aranges section.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002212void DwarfDebug::emitDebugARanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002213 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002214 Asm->OutStreamer.SwitchSection(
2215 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002216}
2217
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002218// Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002219void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002220 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002221 Asm->OutStreamer.SwitchSection(
Devang Patel12563b32010-04-16 23:33:45 +00002222 Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002223 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6c74a872010-04-27 19:46:33 +00002224 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002225 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00002226 I != E; ++I) {
2227 if (*I)
2228 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patel12563b32010-04-16 23:33:45 +00002229 else
Devang Patel6c74a872010-04-27 19:46:33 +00002230 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel12563b32010-04-16 23:33:45 +00002231 }
Bill Wendling480ff322009-05-20 23:21:38 +00002232}
2233
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002234// Emit visible names into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002235void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002236 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00002237 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00002238 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002239 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00002240 }
2241}
2242
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002243// Emit inline info using following format.
2244// Section Header:
2245// 1. length of section
2246// 2. Dwarf version number
2247// 3. address size.
2248//
2249// Entries (one "entry" for each function that was inlined):
2250//
2251// 1. offset into __debug_str section for MIPS linkage name, if exists;
2252// otherwise offset into __debug_str for regular function name.
2253// 2. offset into __debug_str section for regular function name.
2254// 3. an unsigned LEB128 number indicating the number of distinct inlining
2255// instances for the function.
2256//
2257// The rest of the entry consists of a {die_offset, low_pc} pair for each
2258// inlined instance; the die_offset points to the inlined_subroutine die in the
2259// __debug_info section, and the low_pc is the starting address for the
2260// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00002261void DwarfDebug::emitDebugInlineInfo() {
Eric Christopher1df94bf2012-03-02 02:11:47 +00002262 if (!Asm->MAI->doesDwarfUseInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00002263 return;
2264
Devang Patel1a0df9a2010-05-10 22:49:55 +00002265 if (!FirstCU)
Bill Wendling480ff322009-05-20 23:21:38 +00002266 return;
2267
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002268 Asm->OutStreamer.SwitchSection(
2269 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002270
Chris Lattner566cae92010-03-09 23:52:58 +00002271 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00002272 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
2273 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00002274
Chris Lattnera179b522010-04-04 19:25:43 +00002275 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00002276
Chris Lattner566cae92010-03-09 23:52:58 +00002277 Asm->OutStreamer.AddComment("Dwarf Version");
2278 Asm->EmitInt16(dwarf::DWARF_VERSION);
2279 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002280 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002281
Devang Patel32cc43c2010-05-07 20:54:48 +00002282 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002283 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00002284
Devang Patel32cc43c2010-05-07 20:54:48 +00002285 const MDNode *Node = *I;
2286 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00002287 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002288 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00002289 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00002290 StringRef LName = SP.getLinkageName();
2291 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00002292
Chris Lattner566cae92010-03-09 23:52:58 +00002293 Asm->OutStreamer.AddComment("MIPS linkage name");
Eric Christopher77725312012-03-02 01:57:52 +00002294 if (LName.empty())
2295 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
2296 else
Chris Lattner70a4fce2010-04-04 23:25:33 +00002297 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
2298 DwarfStrSectionSym);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002299
Chris Lattner566cae92010-03-09 23:52:58 +00002300 Asm->OutStreamer.AddComment("Function name");
Chris Lattner70a4fce2010-04-04 23:25:33 +00002301 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner9efd1182010-04-04 19:09:29 +00002302 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00002303
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002304 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00002305 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner7bde8c02010-04-04 18:52:31 +00002306 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner085b6522010-03-09 00:31:02 +00002307 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00002308
Chris Lattner7bde8c02010-04-04 18:52:31 +00002309 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattner3a383cb2010-04-05 00:13:49 +00002310 Asm->OutStreamer.EmitSymbolValue(LI->first,
Chandler Carruth5da3f052012-11-01 09:14:31 +00002311 Asm->getDataLayout().getPointerSize(),0);
Bill Wendling480ff322009-05-20 23:21:38 +00002312 }
2313 }
2314
Chris Lattnera179b522010-04-04 19:25:43 +00002315 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00002316}
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002317
2318// DWARF5 Experimental Fission emitters.
2319
2320// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2321// DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2322// DW_AT_ranges_base, DW_AT_addr_base. If DW_AT_ranges is present,
2323// DW_AT_low_pc and DW_AT_high_pc are not used, and vice versa.
Eric Christophercdf218d2012-12-10 19:51:21 +00002324CompileUnit *DwarfDebug::constructSkeletonCU(const MDNode *N) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002325 DICompileUnit DIUnit(N);
2326 StringRef FN = DIUnit.getFilename();
2327 CompilationDir = DIUnit.getDirectory();
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002328
2329 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyb42d1462012-12-03 18:45:45 +00002330 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
2331 DIUnit.getLanguage(), Die, Asm, this);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002332 // FIXME: This should be the .dwo file.
2333 NewCU->addString(Die, dwarf::DW_AT_GNU_dwo_name, FN);
2334
2335 // FIXME: We also need DW_AT_addr_base and DW_AT_dwo_id.
2336
2337 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
2338 // into an entity.
2339 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
2340 // DW_AT_stmt_list is a offset of line number information for this
2341 // compile unit in debug_line section.
2342 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2343 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
2344 Asm->GetTempSymbol("section_line"));
2345 else
2346 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
2347
2348 if (!CompilationDir.empty())
2349 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
2350
Eric Christopherc8a310e2012-12-10 23:34:43 +00002351 SkeletonHolder.addUnit(NewCU);
2352
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002353 return NewCU;
2354}
2355
Eric Christophercdf218d2012-12-10 19:51:21 +00002356void DwarfDebug::emitSkeletonCU(const MCSection *Section) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002357 Asm->OutStreamer.SwitchSection(Section);
Eric Christophercdf218d2012-12-10 19:51:21 +00002358 DIE *Die = SkeletonCU->getCUDie();
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002359
2360 // Emit the compile units header.
2361 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("skel_info_begin",
Eric Christophercdf218d2012-12-10 19:51:21 +00002362 SkeletonCU->getUniqueID()));
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002363
2364 // Emit size of content not including length itself
2365 unsigned ContentSize = Die->getSize() +
2366 sizeof(int16_t) + // DWARF version number
2367 sizeof(int32_t) + // Offset Into Abbrev. Section
2368 sizeof(int8_t); // Pointer Size (in bytes)
2369
2370 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2371 Asm->EmitInt32(ContentSize);
2372 Asm->OutStreamer.AddComment("DWARF version number");
2373 Asm->EmitInt16(dwarf::DWARF_VERSION);
2374 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
2375 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
2376 DwarfAbbrevSectionSym);
2377 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2378 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
2379
2380 emitDIE(Die);
Eli Benderskyb42d1462012-12-03 18:45:45 +00002381 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("skel_info_end",
Eric Christophercdf218d2012-12-10 19:51:21 +00002382 SkeletonCU->getUniqueID()));
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002383
2384
2385}
2386
2387// Emit the .debug_info.dwo section for fission. This contains the compile
2388// units that would normally be in debug_info.
2389void DwarfDebug::emitDebugInfoDWO() {
Eric Christophercdf218d2012-12-10 19:51:21 +00002390 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002391 emitCompileUnits(Asm->getObjFileLowering().getDwarfInfoDWOSection());
2392}