blob: 3276575842908c0c9fd1838106f032f249d3dfcd [file] [log] [blame]
Bill Wendling0310d762009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Chris Lattner6cde3e62010-03-09 00:39:24 +000013
Devang Patele4b27562009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling0310d762009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner74e41f92010-04-05 05:24:55 +000016#include "DIE.h"
Eric Christopher09ac3d82011-11-07 09:24:32 +000017#include "DwarfAccelTable.h"
Devang Patel8b9df622011-04-12 17:40:32 +000018#include "DwarfCompileUnit.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000019#include "llvm/ADT/STLExtras.h"
20#include "llvm/ADT/Statistic.h"
21#include "llvm/ADT/StringExtras.h"
22#include "llvm/ADT/Triple.h"
David Greeneb2c66fc2009-08-19 21:52:55 +000023#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling0310d762009-05-15 09:23:25 +000024#include "llvm/CodeGen/MachineModuleInfo.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000025#include "llvm/Constants.h"
26#include "llvm/DIBuilder.h"
27#include "llvm/DataLayout.h"
28#include "llvm/DebugInfo.h"
29#include "llvm/Instructions.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000030#include "llvm/MC/MCAsmInfo.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000031#include "llvm/MC/MCSection.h"
Chris Lattner6c2f9e12009-08-19 05:49:37 +000032#include "llvm/MC/MCStreamer.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000033#include "llvm/MC/MCSymbol.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000034#include "llvm/Module.h"
Devang Pateleac9c072010-04-27 19:46:33 +000035#include "llvm/Support/CommandLine.h"
Daniel Dunbar6e4bdfc2009-10-13 06:47:08 +000036#include "llvm/Support/Debug.h"
37#include "llvm/Support/ErrorHandling.h"
Chris Lattner0ad9c912010-01-22 22:09:00 +000038#include "llvm/Support/FormattedStream.h"
Michael J. Spencer1f6efa32010-11-29 18:16:10 +000039#include "llvm/Support/Path.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000040#include "llvm/Support/Timer.h"
41#include "llvm/Support/ValueHandle.h"
42#include "llvm/Target/TargetFrameLowering.h"
43#include "llvm/Target/TargetLoweringObjectFile.h"
44#include "llvm/Target/TargetMachine.h"
45#include "llvm/Target/TargetOptions.h"
46#include "llvm/Target/TargetRegisterInfo.h"
Bill Wendling0310d762009-05-15 09:23:25 +000047using namespace llvm;
48
Jim Grosbach1e20b962010-07-21 21:21:52 +000049static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel61409622010-07-07 20:12:52 +000050 cl::Hidden,
Devang Pateleac9c072010-04-27 19:46:33 +000051 cl::desc("Disable debug info printing"));
52
Dan Gohman281d65d2010-05-07 01:08:53 +000053static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
Chris Lattner7a2bdde2011-04-15 05:18:47 +000054 cl::desc("Make an absence of debug location information explicit."),
Dan Gohman281d65d2010-05-07 01:08:53 +000055 cl::init(false));
56
Eric Christopher20f47ab2012-08-23 22:36:40 +000057namespace {
58 enum DefaultOnOff {
59 Default, Enable, Disable
60 };
61}
Eric Christopher09ac3d82011-11-07 09:24:32 +000062
Eric Christopher20f47ab2012-08-23 22:36:40 +000063static cl::opt<DefaultOnOff> DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
64 cl::desc("Output prototype dwarf accelerator tables."),
65 cl::values(
66 clEnumVal(Default, "Default for platform"),
67 clEnumVal(Enable, "Enabled"),
68 clEnumVal(Disable, "Disabled"),
69 clEnumValEnd),
70 cl::init(Default));
71
72static cl::opt<DefaultOnOff> DarwinGDBCompat("darwin-gdb-compat", cl::Hidden,
Eric Christopher10cb7442012-08-23 07:10:46 +000073 cl::desc("Compatibility with Darwin gdb."),
Eric Christopher20f47ab2012-08-23 22:36:40 +000074 cl::values(
75 clEnumVal(Default, "Default for platform"),
76 clEnumVal(Enable, "Enabled"),
77 clEnumVal(Disable, "Disabled"),
78 clEnumValEnd),
79 cl::init(Default));
Eric Christopher10cb7442012-08-23 07:10:46 +000080
Eric Christopherf5b6dcd2012-11-12 22:22:20 +000081static cl::opt<DefaultOnOff> DwarfFission("dwarf-fission", cl::Hidden,
82 cl::desc("Output prototype dwarf fission."),
83 cl::values(
84 clEnumVal(Default, "Default for platform"),
85 clEnumVal(Enable, "Enabled"),
86 clEnumVal(Disable, "Disabled"),
87 clEnumValEnd),
88 cl::init(Default));
89
Bill Wendling5f017e82010-04-07 09:28:04 +000090namespace {
91 const char *DWARFGroupName = "DWARF Emission";
92 const char *DbgTimerName = "DWARF Debug Writer";
93} // end anonymous namespace
94
Bill Wendling0310d762009-05-15 09:23:25 +000095//===----------------------------------------------------------------------===//
96
Eric Christopherb6dc8652012-11-27 22:43:45 +000097// Configuration values for initial hash set sizes (log2).
98//
Bill Wendling0310d762009-05-15 09:23:25 +000099static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling0310d762009-05-15 09:23:25 +0000100
101namespace llvm {
102
Nick Lewycky3bbb6f72011-07-29 03:49:23 +0000103DIType DbgVariable::getType() const {
Devang Patel3cbee302011-04-12 22:53:02 +0000104 DIType Ty = Var.getType();
105 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
106 // addresses instead.
107 if (Var.isBlockByrefVariable()) {
108 /* Byref variables, in Blocks, are declared by the programmer as
109 "SomeType VarName;", but the compiler creates a
110 __Block_byref_x_VarName struct, and gives the variable VarName
111 either the struct, or a pointer to the struct, as its type. This
112 is necessary for various behind-the-scenes things the compiler
113 needs to do with by-reference variables in blocks.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000114
Devang Patel3cbee302011-04-12 22:53:02 +0000115 However, as far as the original *programmer* is concerned, the
116 variable should still have type 'SomeType', as originally declared.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000117
Devang Patel3cbee302011-04-12 22:53:02 +0000118 The following function dives into the __Block_byref_x_VarName
119 struct to find the original type of the variable. This will be
120 passed back to the code generating the type for the Debug
121 Information Entry for the variable 'VarName'. 'VarName' will then
122 have the original type 'SomeType' in its debug information.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000123
Devang Patel3cbee302011-04-12 22:53:02 +0000124 The original type 'SomeType' will be the type of the field named
125 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000126
Devang Patel3cbee302011-04-12 22:53:02 +0000127 NOTE: In order for this to not completely fail on the debugger
128 side, the Debug Information Entry for the variable VarName needs to
129 have a DW_AT_location that tells the debugger how to unwind through
130 the pointers and __Block_byref_x_VarName struct to find the actual
131 value of the variable. The function addBlockByrefType does this. */
132 DIType subType = Ty;
133 unsigned tag = Ty.getTag();
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000134
Devang Patel3cbee302011-04-12 22:53:02 +0000135 if (tag == dwarf::DW_TAG_pointer_type) {
136 DIDerivedType DTy = DIDerivedType(Ty);
137 subType = DTy.getTypeDerivedFrom();
138 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000139
Devang Patel3cbee302011-04-12 22:53:02 +0000140 DICompositeType blockStruct = DICompositeType(subType);
141 DIArray Elements = blockStruct.getTypeArray();
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000142
Devang Patel3cbee302011-04-12 22:53:02 +0000143 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
144 DIDescriptor Element = Elements.getElement(i);
145 DIDerivedType DT = DIDerivedType(Element);
146 if (getName() == DT.getName())
147 return (DT.getTypeDerivedFrom());
Devang Patel8bd11de2010-08-09 21:01:39 +0000148 }
Devang Patel8bd11de2010-08-09 21:01:39 +0000149 }
Devang Patel3cbee302011-04-12 22:53:02 +0000150 return Ty;
151}
Bill Wendling0310d762009-05-15 09:23:25 +0000152
Chris Lattnerea761862010-04-05 04:09:20 +0000153} // end llvm namespace
Bill Wendling0310d762009-05-15 09:23:25 +0000154
Chris Lattner49cd6642010-04-05 05:11:15 +0000155DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Eric Christopher98e237f2012-11-30 23:59:06 +0000156 : Asm(A), MMI(Asm->MMI), FirstCU(0), FissionCU(0),
Jim Grosbach1e20b962010-07-21 21:21:52 +0000157 AbbreviationsSet(InitAbbreviationsSetSize),
Benjamin Kramerf33a79c2012-06-09 10:34:15 +0000158 SourceIdMap(DIEValueAllocator), StringPool(DIEValueAllocator),
Eli Benderskyd4a05e02012-12-03 18:45:45 +0000159 PrevLabel(NULL), GlobalCUIndexCount(0) {
Chris Lattnerbc733f52010-03-13 02:17:42 +0000160 NextStringPoolNumber = 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000161
Rafael Espindolaf2b04232011-05-06 14:56:22 +0000162 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattner4ad1efe2010-04-04 23:10:38 +0000163 DwarfStrSectionSym = TextSectionSym = 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000164 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
Devang Patelc3f5f782010-05-25 23:40:22 +0000165 FunctionBeginSym = FunctionEndSym = 0;
Eric Christopher60777d82012-04-02 17:58:52 +0000166
Eric Christopher10cb7442012-08-23 07:10:46 +0000167 // Turn on accelerator tables and older gdb compatibility
168 // for Darwin.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000169 bool IsDarwin = Triple(M->getTargetTriple()).isOSDarwin();
Eric Christopher20f47ab2012-08-23 22:36:40 +0000170 if (DarwinGDBCompat == Default) {
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000171 if (IsDarwin)
172 IsDarwinGDBCompat = true;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000173 else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000174 IsDarwinGDBCompat = false;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000175 } else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000176 IsDarwinGDBCompat = DarwinGDBCompat == Enable ? true : false;
Eric Christopherc1610fa2012-08-23 22:36:36 +0000177
Eric Christopher20f47ab2012-08-23 22:36:40 +0000178 if (DwarfAccelTables == Default) {
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000179 if (IsDarwin)
180 HasDwarfAccelTables = true;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000181 else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000182 HasDwarfAccelTables = false;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000183 } else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000184 HasDwarfAccelTables = DwarfAccelTables == Enable ? true : false;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000185
Eric Christopherf5b6dcd2012-11-12 22:22:20 +0000186 if (DwarfFission == Default)
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000187 HasDwarfFission = false;
Eric Christopherf5b6dcd2012-11-12 22:22:20 +0000188 else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000189 HasDwarfFission = DwarfFission == Enable ? true : false;
Eric Christopherf5b6dcd2012-11-12 22:22:20 +0000190
Dan Gohman03c3dc72010-06-18 15:56:31 +0000191 {
192 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopherc4639d62012-11-19 22:42:15 +0000193 beginModule();
Torok Edwin9c421072010-04-07 10:44:46 +0000194 }
Bill Wendling0310d762009-05-15 09:23:25 +0000195}
196DwarfDebug::~DwarfDebug() {
Bill Wendling0310d762009-05-15 09:23:25 +0000197}
198
Eric Christopherb6dc8652012-11-27 22:43:45 +0000199// Switch to the specified MCSection and emit an assembler
200// temporary label to it if SymbolStem is specified.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000201static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christopherd8a87522011-11-07 09:18:38 +0000202 const char *SymbolStem = 0) {
203 Asm->OutStreamer.SwitchSection(Section);
204 if (!SymbolStem) return 0;
205
206 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
207 Asm->OutStreamer.EmitLabel(TmpSym);
208 return TmpSym;
209}
210
Nick Lewycky390c40d2011-10-27 06:44:11 +0000211MCSymbol *DwarfDebug::getStringPool() {
212 return Asm->GetTempSymbol("section_str");
213}
214
Chris Lattnerbc733f52010-03-13 02:17:42 +0000215MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
216 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
217 if (Entry.first) return Entry.first;
218
219 Entry.second = NextStringPoolNumber++;
Chris Lattnerc0215722010-04-04 19:25:43 +0000220 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerbc733f52010-03-13 02:17:42 +0000221}
222
Eric Christopherb6dc8652012-11-27 22:43:45 +0000223// Define a unique number for the abbreviation.
224//
Devang Patel2c4ceb12009-11-21 02:48:08 +0000225void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling0310d762009-05-15 09:23:25 +0000226 // Profile the node so that we can make it unique.
227 FoldingSetNodeID ID;
228 Abbrev.Profile(ID);
229
230 // Check the set for priors.
231 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
232
233 // If it's newly added.
234 if (InSet == &Abbrev) {
235 // Add to abbreviation list.
236 Abbreviations.push_back(&Abbrev);
237
238 // Assign the vector position + 1 as its number.
239 Abbrev.setNumber(Abbreviations.size());
240 } else {
241 // Assign existing abbreviation number.
242 Abbrev.setNumber(InSet->getNumber());
243 }
244}
245
Eric Christopherb6dc8652012-11-27 22:43:45 +0000246// If special LLVM prefix that is used to inform the asm
247// printer to not emit usual symbol prefix before the symbol name is used then
248// return linkage name after skipping this special LLVM prefix.
Devang Patel351ca332010-01-05 01:46:14 +0000249static StringRef getRealLinkageName(StringRef LinkageName) {
250 char One = '\1';
251 if (LinkageName.startswith(StringRef(&One, 1)))
252 return LinkageName.substr(1);
253 return LinkageName;
254}
255
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000256static bool isObjCClass(StringRef Name) {
257 return Name.startswith("+") || Name.startswith("-");
258}
259
260static bool hasObjCCategory(StringRef Name) {
261 if (!isObjCClass(Name)) return false;
262
263 size_t pos = Name.find(')');
264 if (pos != std::string::npos) {
265 if (Name[pos+1] != ' ') return false;
266 return true;
267 }
268 return false;
269}
270
271static void getObjCClassCategory(StringRef In, StringRef &Class,
272 StringRef &Category) {
273 if (!hasObjCCategory(In)) {
274 Class = In.slice(In.find('[') + 1, In.find(' '));
275 Category = "";
276 return;
277 }
278
279 Class = In.slice(In.find('[') + 1, In.find('('));
280 Category = In.slice(In.find('[') + 1, In.find(' '));
281 return;
282}
283
284static StringRef getObjCMethodName(StringRef In) {
285 return In.slice(In.find(' ') + 1, In.find(']'));
286}
287
288// Add the various names to the Dwarf accelerator table names.
289static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
290 DIE* Die) {
291 if (!SP.isDefinition()) return;
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000292
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000293 TheCU->addAccelName(SP.getName(), Die);
294
295 // If the linkage name is different than the name, go ahead and output
296 // that as well into the name table.
297 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
298 TheCU->addAccelName(SP.getLinkageName(), Die);
299
300 // If this is an Objective-C selector name add it to the ObjC accelerator
301 // too.
302 if (isObjCClass(SP.getName())) {
303 StringRef Class, Category;
304 getObjCClassCategory(SP.getName(), Class, Category);
305 TheCU->addAccelObjC(Class, Die);
306 if (Category != "")
307 TheCU->addAccelObjC(Category, Die);
308 // Also add the base method name to the name table.
309 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
310 }
311}
312
Eric Christopherb6dc8652012-11-27 22:43:45 +0000313// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
314// and DW_AT_high_pc attributes. If there are global variables in this
315// scope then create and insert DIEs for these variables.
Devang Pateld3024342011-08-15 22:24:32 +0000316DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
317 const MDNode *SPNode) {
Devang Patel163a9f72010-05-10 22:49:55 +0000318 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patel8aa61472010-07-07 22:20:57 +0000319
Chris Lattnerd38fee82010-04-05 00:13:49 +0000320 assert(SPDie && "Unable to find subprogram DIE!");
321 DISubprogram SP(SPNode);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000322
Bill Wendling168c1902012-11-07 05:19:04 +0000323 // If we're updating an abstract DIE, then we will be adding the children and
324 // object pointer later on. But what we don't want to do is process the
325 // concrete DIE twice.
Devang Patel8aa61472010-07-07 22:20:57 +0000326 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
Bill Wendling168c1902012-11-07 05:19:04 +0000327 // Pick up abstract subprogram DIE.
Devang Patel8aa61472010-07-07 22:20:57 +0000328 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel3cbee302011-04-12 22:53:02 +0000329 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
330 dwarf::DW_FORM_ref4, AbsSPDIE);
Devang Patel8aa61472010-07-07 22:20:57 +0000331 SPCU->addDie(SPDie);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000332 } else {
333 DISubprogram SPDecl = SP.getFunctionDeclaration();
334 if (!SPDecl.isSubprogram()) {
335 // There is not any need to generate specification DIE for a function
336 // defined at compile unit level. If a function is defined inside another
337 // function then gdb prefers the definition at top level and but does not
338 // expect specification DIE in parent function. So avoid creating
339 // specification DIE for a function defined inside a function.
340 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
341 !SP.getContext().isFile() &&
342 !isSubprogramContext(SP.getContext())) {
343 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
344
345 // Add arguments.
346 DICompositeType SPTy = SP.getType();
347 DIArray Args = SPTy.getTypeArray();
348 unsigned SPTag = SPTy.getTag();
349 if (SPTag == dwarf::DW_TAG_subroutine_type)
350 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
351 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
352 DIType ATy = DIType(Args.getElement(i));
353 SPCU->addType(Arg, ATy);
354 if (ATy.isArtificial())
355 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
356 if (ATy.isObjectPointer())
357 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer,
358 dwarf::DW_FORM_ref4, Arg);
359 SPDie->addChild(Arg);
360 }
361 DIE *SPDeclDie = SPDie;
362 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000363 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification,
364 dwarf::DW_FORM_ref4, SPDeclDie);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000365 SPCU->addDie(SPDie);
366 }
367 }
Devang Patel8aa61472010-07-07 22:20:57 +0000368 }
369
Devang Patel3cbee302011-04-12 22:53:02 +0000370 SPCU->addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
371 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
372 SPCU->addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
373 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
Chris Lattnerd38fee82010-04-05 00:13:49 +0000374 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
375 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patel3cbee302011-04-12 22:53:02 +0000376 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +0000377
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000378 // Add name to the name table, we do this here because we're guaranteed
379 // to have concrete versions of our DW_TAG_subprogram nodes.
380 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000381
Chris Lattnerd38fee82010-04-05 00:13:49 +0000382 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +0000383}
384
Eric Christopherb6dc8652012-11-27 22:43:45 +0000385// Construct new DW_TAG_lexical_block for this scope and attach
386// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000387DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld3024342011-08-15 22:24:32 +0000388 LexicalScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +0000389 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
390 if (Scope->isAbstractScope())
391 return ScopeDIE;
392
Devang Patelbf47fdb2011-08-10 20:55:27 +0000393 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
Devang Pateleac9c072010-04-27 19:46:33 +0000394 if (Ranges.empty())
395 return 0;
396
Devang Patelbf47fdb2011-08-10 20:55:27 +0000397 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
Devang Pateleac9c072010-04-27 19:46:33 +0000398 if (Ranges.size() > 1) {
399 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbach1e20b962010-07-21 21:21:52 +0000400 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Pateleac9c072010-04-27 19:46:33 +0000401 // DW_AT_ranges appropriately.
Devang Patel3cbee302011-04-12 22:53:02 +0000402 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000403 DebugRangeSymbols.size()
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000404 * Asm->getDataLayout().getPointerSize());
Devang Patelbf47fdb2011-08-10 20:55:27 +0000405 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +0000406 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +0000407 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
408 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +0000409 }
410 DebugRangeSymbols.push_back(NULL);
411 DebugRangeSymbols.push_back(NULL);
412 return ScopeDIE;
413 }
414
Devang Patelc3f5f782010-05-25 23:40:22 +0000415 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
416 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +0000417
Devang Patelc3f5f782010-05-25 23:40:22 +0000418 if (End == 0) return 0;
Devang Patel53bb5c92009-11-10 23:06:00 +0000419
Chris Lattnerb7db7332010-03-09 01:58:53 +0000420 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
421 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbach1e20b962010-07-21 21:21:52 +0000422
Devang Patel3cbee302011-04-12 22:53:02 +0000423 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
424 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patel53bb5c92009-11-10 23:06:00 +0000425
426 return ScopeDIE;
427}
428
Eric Christopherb6dc8652012-11-27 22:43:45 +0000429// This scope represents inlined body of a function. Construct DIE to
430// represent this concrete inlined copy of the function.
Devang Pateld3024342011-08-15 22:24:32 +0000431DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
432 LexicalScope *Scope) {
Devang Patelbf47fdb2011-08-10 20:55:27 +0000433 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
Nick Lewycky746cb672011-10-26 22:55:33 +0000434 assert(Ranges.empty() == false &&
435 "LexicalScope does not have instruction markers!");
Devang Pateleac9c072010-04-27 19:46:33 +0000436
Devang Patel26a92002011-07-27 00:34:13 +0000437 if (!Scope->getScopeNode())
438 return NULL;
439 DIScope DS(Scope->getScopeNode());
440 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel26a92002011-07-27 00:34:13 +0000441 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
442 if (!OriginDIE) {
Bill Wendlinge0aae5b2012-10-30 17:51:02 +0000443 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patel26a92002011-07-27 00:34:13 +0000444 return NULL;
445 }
446
Devang Patelbf47fdb2011-08-10 20:55:27 +0000447 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
Devang Patelc3f5f782010-05-25 23:40:22 +0000448 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
449 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +0000450
Devang Patel0afbf232010-07-08 22:39:20 +0000451 if (StartLabel == 0 || EndLabel == 0) {
Bill Wendlinge0aae5b2012-10-30 17:51:02 +0000452 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
Devang Pateleac9c072010-04-27 19:46:33 +0000453 }
Chris Lattnerb7db7332010-03-09 01:58:53 +0000454 assert(StartLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +0000455 "Invalid starting label for an inlined scope!");
Chris Lattnerb7db7332010-03-09 01:58:53 +0000456 assert(EndLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +0000457 "Invalid end label for an inlined scope!");
Devang Pateleac9c072010-04-27 19:46:33 +0000458
Devang Pateld96efb82011-05-05 17:54:26 +0000459 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Devang Patel3cbee302011-04-12 22:53:02 +0000460 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
461 dwarf::DW_FORM_ref4, OriginDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +0000462
Devang Patel26a92002011-07-27 00:34:13 +0000463 if (Ranges.size() > 1) {
464 // .debug_range section has not been laid out yet. Emit offset in
465 // .debug_range as a uint, size 4, for now. emitDIE will handle
466 // DW_AT_ranges appropriately.
467 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000468 DebugRangeSymbols.size()
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000469 * Asm->getDataLayout().getPointerSize());
Devang Patelbf47fdb2011-08-10 20:55:27 +0000470 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patel26a92002011-07-27 00:34:13 +0000471 RE = Ranges.end(); RI != RE; ++RI) {
472 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
473 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
474 }
475 DebugRangeSymbols.push_back(NULL);
476 DebugRangeSymbols.push_back(NULL);
477 } else {
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000478 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Devang Patel5bc942c2011-08-10 23:58:09 +0000479 StartLabel);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000480 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Devang Patel5bc942c2011-08-10 23:58:09 +0000481 EndLabel);
Devang Patel26a92002011-07-27 00:34:13 +0000482 }
Devang Patel53bb5c92009-11-10 23:06:00 +0000483
484 InlinedSubprogramDIEs.insert(OriginDIE);
485
486 // Track the start label for this inlined function.
Devang Patel26a92002011-07-27 00:34:13 +0000487 //.debug_inlined section specification does not clearly state how
488 // to emit inlined scope that is split into multiple instruction ranges.
489 // For now, use first instruction range and emit low_pc/high_pc pair and
490 // corresponding .debug_inlined section entry for this pair.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000491 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patel2db49d72010-05-07 18:11:54 +0000492 I = InlineInfo.find(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +0000493
494 if (I == InlineInfo.end()) {
Nick Lewycky746cb672011-10-26 22:55:33 +0000495 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patel2db49d72010-05-07 18:11:54 +0000496 InlinedSPNodes.push_back(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +0000497 } else
Chris Lattner6ed0f902010-03-09 00:31:02 +0000498 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patel53bb5c92009-11-10 23:06:00 +0000499
Devang Patel53bb5c92009-11-10 23:06:00 +0000500 DILocation DL(Scope->getInlinedAt());
Eric Christopher08212002012-03-26 21:38:38 +0000501 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0,
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000502 getOrCreateSourceID(DL.getFilename(), DL.getDirectory()));
Devang Patel3cbee302011-04-12 22:53:02 +0000503 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +0000504
Eric Christopher309bedd2011-12-04 06:02:38 +0000505 // Add name to the name table, we do this here because we're guaranteed
506 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
507 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000508
Devang Patel53bb5c92009-11-10 23:06:00 +0000509 return ScopeDIE;
510}
511
Eric Christopherb6dc8652012-11-27 22:43:45 +0000512// Construct a DIE for this scope.
Devang Pateld0b5a5e2011-08-15 22:04:40 +0000513DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
Devang Patel3c91b052010-03-08 20:52:55 +0000514 if (!Scope || !Scope->getScopeNode())
515 return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000516
Nick Lewycky746cb672011-10-26 22:55:33 +0000517 SmallVector<DIE *, 8> Children;
Eric Christophere5212782012-09-12 23:36:19 +0000518 DIE *ObjectPointer = NULL;
Devang Patel0478c152011-03-01 22:58:55 +0000519
520 // Collect arguments for current function.
Devang Patelbf47fdb2011-08-10 20:55:27 +0000521 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +0000522 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
523 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000524 if (DIE *Arg =
Eric Christophere5212782012-09-12 23:36:19 +0000525 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel0478c152011-03-01 22:58:55 +0000526 Children.push_back(Arg);
Eric Christophere5212782012-09-12 23:36:19 +0000527 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
528 }
Devang Patel0478c152011-03-01 22:58:55 +0000529
Eric Christopher1aeb7ac2011-10-03 15:49:16 +0000530 // Collect lexical scope children first.
Devang Patelbf47fdb2011-08-10 20:55:27 +0000531 const SmallVector<DbgVariable *, 8> &Variables = ScopeVariables.lookup(Scope);
Devang Patel5bc9fec2011-02-19 01:31:27 +0000532 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000533 if (DIE *Variable =
Eric Christopher7b451cf2012-09-21 22:18:52 +0000534 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5bc9fec2011-02-19 01:31:27 +0000535 Children.push_back(Variable);
Eric Christopher7b451cf2012-09-21 22:18:52 +0000536 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
537 }
Devang Patelbf47fdb2011-08-10 20:55:27 +0000538 const SmallVector<LexicalScope *, 4> &Scopes = Scope->getChildren();
Devang Patel5bc9fec2011-02-19 01:31:27 +0000539 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Pateld0b5a5e2011-08-15 22:04:40 +0000540 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5bc9fec2011-02-19 01:31:27 +0000541 Children.push_back(Nested);
Devang Patel3c91b052010-03-08 20:52:55 +0000542 DIScope DS(Scope->getScopeNode());
543 DIE *ScopeDIE = NULL;
544 if (Scope->getInlinedAt())
Devang Pateld3024342011-08-15 22:24:32 +0000545 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3c91b052010-03-08 20:52:55 +0000546 else if (DS.isSubprogram()) {
Devang Patel0dd45582010-06-28 20:53:04 +0000547 ProcessedSPNodes.insert(DS);
Devang Patel8aa61472010-07-07 22:20:57 +0000548 if (Scope->isAbstractScope()) {
Devang Pateld3024342011-08-15 22:24:32 +0000549 ScopeDIE = TheCU->getDIE(DS);
Devang Patel8aa61472010-07-07 22:20:57 +0000550 // Note down abstract DIE.
551 if (ScopeDIE)
552 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
553 }
Devang Patel3c91b052010-03-08 20:52:55 +0000554 else
Devang Pateld3024342011-08-15 22:24:32 +0000555 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3c91b052010-03-08 20:52:55 +0000556 }
Devang Patel5bc9fec2011-02-19 01:31:27 +0000557 else {
558 // There is no need to emit empty lexical block DIE.
559 if (Children.empty())
560 return NULL;
Devang Pateld3024342011-08-15 22:24:32 +0000561 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Devang Patel5bc9fec2011-02-19 01:31:27 +0000562 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000563
Devang Patelaead63c2010-03-29 22:59:58 +0000564 if (!ScopeDIE) return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000565
Devang Patel5bc9fec2011-02-19 01:31:27 +0000566 // Add children
567 for (SmallVector<DIE *, 8>::iterator I = Children.begin(),
568 E = Children.end(); I != E; ++I)
569 ScopeDIE->addChild(*I);
Devang Patel193f7202009-11-24 01:14:22 +0000570
Eric Christophere5212782012-09-12 23:36:19 +0000571 if (DS.isSubprogram() && ObjectPointer != NULL)
572 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer,
573 dwarf::DW_FORM_ref4, ObjectPointer);
574
Jim Grosbach1e20b962010-07-21 21:21:52 +0000575 if (DS.isSubprogram())
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000576 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbach1e20b962010-07-21 21:21:52 +0000577
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000578 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +0000579}
580
Eric Christopherb6dc8652012-11-27 22:43:45 +0000581// Look up the source id with the given directory and source file names.
582// If none currently exists, create a new id and insert it in the
583// SourceIds map. This can update DirectoryNames and SourceFileNames maps
584// as well.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000585unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Devang Patel23670e52011-03-24 20:30:50 +0000586 StringRef DirName) {
Devang Patel1905a182010-09-16 20:57:49 +0000587 // If FE did not provide a file name, then assume stdin.
588 if (FileName.empty())
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000589 return getOrCreateSourceID("<stdin>", StringRef());
Devang Patel23670e52011-03-24 20:30:50 +0000590
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000591 // TODO: this might not belong here. See if we can factor this better.
592 if (DirName == CompilationDir)
593 DirName = "";
594
Nick Lewycky44d798d2011-10-17 23:05:28 +0000595 unsigned SrcId = SourceIdMap.size()+1;
Devang Patel1905a182010-09-16 20:57:49 +0000596
Benjamin Kramer74612c22012-03-11 14:56:26 +0000597 // We look up the file/dir pair by concatenating them with a zero byte.
598 SmallString<128> NamePair;
599 NamePair += DirName;
600 NamePair += '\0'; // Zero bytes are not allowed in paths.
601 NamePair += FileName;
602
603 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
604 if (Ent.getValue() != SrcId)
605 return Ent.getValue();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000606
Rafael Espindola5c055632010-11-18 02:04:25 +0000607 // Print out a .file directive to specify files for .loc directives.
Benjamin Kramer74612c22012-03-11 14:56:26 +0000608 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000609
610 return SrcId;
611}
612
Eric Christopherb6dc8652012-11-27 22:43:45 +0000613// Create new CompileUnit for the given metadata node with tag DW_TAG_compile_unit.
Devang Patel94c7ddb2011-08-16 22:09:43 +0000614CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +0000615 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +0000616 StringRef FN = DIUnit.getFilename();
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000617 CompilationDir = DIUnit.getDirectory();
Eli Benderskyd4a05e02012-12-03 18:45:45 +0000618 // Call this to emit a .file directive if it wasn't emitted for the source
619 // file this CU comes from yet.
620 getOrCreateSourceID(FN, CompilationDir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000621
622 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyd4a05e02012-12-03 18:45:45 +0000623 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
624 DIUnit.getLanguage(), Die, Asm, this);
Nick Lewycky390c40d2011-10-27 06:44:11 +0000625 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patel3cbee302011-04-12 22:53:02 +0000626 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
627 DIUnit.getLanguage());
Nick Lewycky390c40d2011-10-27 06:44:11 +0000628 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christopher6635cad2012-08-01 18:19:01 +0000629 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
630 // into an entity.
631 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Devang Patel4a602ca2010-03-22 23:11:36 +0000632 // DW_AT_stmt_list is a offset of line number information for this
Devang Patelaf608bd2010-08-24 00:06:12 +0000633 // compile unit in debug_line section.
Rafael Espindola2241e512012-06-22 13:24:07 +0000634 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Rafael Espindola597a7662011-05-04 17:44:06 +0000635 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Devang Patel3cbee302011-04-12 22:53:02 +0000636 Asm->GetTempSymbol("section_line"));
Devang Patelae84d5b2010-08-31 23:50:19 +0000637 else
Devang Patel3cbee302011-04-12 22:53:02 +0000638 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000639
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000640 if (!CompilationDir.empty())
641 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000642 if (DIUnit.isOptimized())
Eric Christopher873cf0a2012-08-24 01:14:27 +0000643 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000644
Devang Patel65dbc902009-11-25 17:36:49 +0000645 StringRef Flags = DIUnit.getFlags();
646 if (!Flags.empty())
Nick Lewycky390c40d2011-10-27 06:44:11 +0000647 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000648
Nick Lewyckyd5d52132011-10-17 23:27:36 +0000649 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patel3cbee302011-04-12 22:53:02 +0000650 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000651 dwarf::DW_FORM_data1, RVer);
652
Devang Patel163a9f72010-05-10 22:49:55 +0000653 if (!FirstCU)
654 FirstCU = NewCU;
Eric Christopher98e237f2012-11-30 23:59:06 +0000655 if (useDwarfFission() && !FissionCU)
656 FissionCU = constructFissionCU(N);
657
Devang Patel163a9f72010-05-10 22:49:55 +0000658 CUMap.insert(std::make_pair(N, NewCU));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000659 return NewCU;
Devang Patel163a9f72010-05-10 22:49:55 +0000660}
661
Eric Christopherb6dc8652012-11-27 22:43:45 +0000662// Construct subprogram DIE.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000663void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
Devang Patel3655a212011-08-15 23:36:40 +0000664 const MDNode *N) {
Rafael Espindolab0527282011-11-04 19:00:29 +0000665 CompileUnit *&CURef = SPMap[N];
666 if (CURef)
667 return;
668 CURef = TheCU;
669
Devang Patele4b27562009-08-28 23:24:31 +0000670 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000671 if (!SP.isDefinition())
672 // This is a method declaration which will be handled while constructing
673 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +0000674 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000675
Devang Pateldbc64af2011-08-15 17:24:54 +0000676 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings639336e2010-04-06 21:38:29 +0000677
678 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +0000679 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000680
681 // Add to context owner.
Devang Patel3cbee302011-04-12 22:53:02 +0000682 TheCU->addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +0000683
Devang Patel13e16b62009-06-26 01:49:18 +0000684 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000685}
686
Eric Christopherb6dc8652012-11-27 22:43:45 +0000687// Collect debug info from named mdnodes such as llvm.dbg.enum and llvm.dbg.ty.
Eric Christopherc4639d62012-11-19 22:42:15 +0000688void DwarfDebug::collectInfoFromNamedMDNodes(const Module *M) {
Devang Patel94c7ddb2011-08-16 22:09:43 +0000689 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.sp"))
690 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
691 const MDNode *N = NMD->getOperand(i);
692 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
693 constructSubprogramDIE(CU, N);
694 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000695
Devang Patel94c7ddb2011-08-16 22:09:43 +0000696 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.gv"))
697 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
698 const MDNode *N = NMD->getOperand(i);
699 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
Devang Patel28bea082011-08-18 23:17:55 +0000700 CU->createGlobalVariableDIE(N);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000701 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000702
Devang Patel02e603f2011-08-15 23:47:24 +0000703 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
704 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
705 DIType Ty(NMD->getOperand(i));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000706 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
707 CU->getOrCreateTypeDIE(Ty);
Devang Patel02e603f2011-08-15 23:47:24 +0000708 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000709
Devang Patel02e603f2011-08-15 23:47:24 +0000710 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
711 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
712 DIType Ty(NMD->getOperand(i));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000713 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
714 CU->getOrCreateTypeDIE(Ty);
Devang Patel02e603f2011-08-15 23:47:24 +0000715 }
716}
717
Eric Christopherb6dc8652012-11-27 22:43:45 +0000718// Collect debug info using DebugInfoFinder.
719// FIXME - Remove this when dragonegg switches to DIBuilder.
Eric Christopherc4639d62012-11-19 22:42:15 +0000720bool DwarfDebug::collectLegacyDebugInfo(const Module *M) {
Devang Patel02e603f2011-08-15 23:47:24 +0000721 DebugInfoFinder DbgFinder;
722 DbgFinder.processModule(*M);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000723
Devang Patel02e603f2011-08-15 23:47:24 +0000724 bool HasDebugInfo = false;
725 // Scan all the compile-units to see if there are any marked as the main
726 // unit. If not, we do not generate debug info.
727 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
728 E = DbgFinder.compile_unit_end(); I != E; ++I) {
729 if (DICompileUnit(*I).isMain()) {
730 HasDebugInfo = true;
731 break;
732 }
733 }
734 if (!HasDebugInfo) return false;
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000735
Devang Patel02e603f2011-08-15 23:47:24 +0000736 // Create all the compile unit DIEs.
737 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
738 E = DbgFinder.compile_unit_end(); I != E; ++I)
739 constructCompileUnit(*I);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000740
Devang Patel02e603f2011-08-15 23:47:24 +0000741 // Create DIEs for each global variable.
742 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
743 E = DbgFinder.global_variable_end(); I != E; ++I) {
744 const MDNode *N = *I;
Devang Patel94c7ddb2011-08-16 22:09:43 +0000745 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
Devang Patel28bea082011-08-18 23:17:55 +0000746 CU->createGlobalVariableDIE(N);
Devang Patel02e603f2011-08-15 23:47:24 +0000747 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000748
Devang Patel02e603f2011-08-15 23:47:24 +0000749 // Create DIEs for each subprogram.
750 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
751 E = DbgFinder.subprogram_end(); I != E; ++I) {
752 const MDNode *N = *I;
Devang Patel94c7ddb2011-08-16 22:09:43 +0000753 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
754 constructSubprogramDIE(CU, N);
Devang Patel02e603f2011-08-15 23:47:24 +0000755 }
756
757 return HasDebugInfo;
758}
759
Eric Christopherb6dc8652012-11-27 22:43:45 +0000760// Emit all Dwarf sections that should come prior to the content. Create
761// global DIEs and emit initial debug info sections. This is invoked by
762// the target AsmPrinter.
Eric Christopherc4639d62012-11-19 22:42:15 +0000763void DwarfDebug::beginModule() {
Devang Pateleac9c072010-04-27 19:46:33 +0000764 if (DisableDebugInfoPrinting)
765 return;
766
Eric Christopherc4639d62012-11-19 22:42:15 +0000767 const Module *M = MMI->getModule();
768
Nick Lewycky3bbb6f72011-07-29 03:49:23 +0000769 // If module has named metadata anchors then use them, otherwise scan the
770 // module using debug info finder to collect debug info.
Devang Patel30692ab2011-05-03 16:45:22 +0000771 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
772 if (CU_Nodes) {
Devang Patel94c7ddb2011-08-16 22:09:43 +0000773 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
774 DICompileUnit CUNode(CU_Nodes->getOperand(i));
775 CompileUnit *CU = constructCompileUnit(CUNode);
776 DIArray GVs = CUNode.getGlobalVariables();
777 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
Devang Patel28bea082011-08-18 23:17:55 +0000778 CU->createGlobalVariableDIE(GVs.getElement(i));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000779 DIArray SPs = CUNode.getSubprograms();
780 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
781 constructSubprogramDIE(CU, SPs.getElement(i));
782 DIArray EnumTypes = CUNode.getEnumTypes();
783 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
784 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
785 DIArray RetainedTypes = CUNode.getRetainedTypes();
786 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
787 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
788 }
Devang Patel02e603f2011-08-15 23:47:24 +0000789 } else if (!collectLegacyDebugInfo(M))
790 return;
Devang Patel30692ab2011-05-03 16:45:22 +0000791
Devang Patel02e603f2011-08-15 23:47:24 +0000792 collectInfoFromNamedMDNodes(M);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000793
Chris Lattnerd850ac72010-04-05 02:19:28 +0000794 // Tell MMI that we have debug info.
795 MMI->setDebugInfoAvailability(true);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000796
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000797 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +0000798 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000799}
800
Eric Christopher4117bec2012-11-22 00:59:49 +0000801// Attach DW_AT_inline attribute with inlined subprogram DIEs.
802void DwarfDebug::computeInlinedDIEs() {
Devang Patel53bb5c92009-11-10 23:06:00 +0000803 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
804 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000805 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patel53bb5c92009-11-10 23:06:00 +0000806 DIE *ISP = *AI;
Devang Patel3cbee302011-04-12 22:53:02 +0000807 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +0000808 }
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000809 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000810 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000811 DIE *ISP = AI->second;
812 if (InlinedSubprogramDIEs.count(ISP))
813 continue;
814 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
815 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000816}
817
818// Collect info for variables that were optimized out.
819void DwarfDebug::collectDeadVariables() {
820 const Module *M = MMI->getModule();
821 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
822
823 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
824 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
825 DICompileUnit TheCU(CU_Nodes->getOperand(i));
826 DIArray Subprograms = TheCU.getSubprograms();
827 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopherbdab8002012-11-27 00:13:51 +0000828 DISubprogram SP(Subprograms.getElement(i));
829 if (ProcessedSPNodes.count(SP) != 0) continue;
830 if (!SP.Verify()) continue;
831 if (!SP.isDefinition()) continue;
832 DIArray Variables = SP.getVariables();
833 if (Variables.getNumElements() == 0) continue;
Eric Christopher4117bec2012-11-22 00:59:49 +0000834
Eric Christopherbdab8002012-11-27 00:13:51 +0000835 LexicalScope *Scope =
836 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
837 DeadFnScopeMap[SP] = Scope;
Eric Christopher4117bec2012-11-22 00:59:49 +0000838
Eric Christopherbdab8002012-11-27 00:13:51 +0000839 // Construct subprogram DIE and add variables DIEs.
840 CompileUnit *SPCU = CUMap.lookup(TheCU);
841 assert(SPCU && "Unable to find Compile Unit!");
842 constructSubprogramDIE(SPCU, SP);
843 DIE *ScopeDIE = SPCU->getDIE(SP);
844 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
845 DIVariable DV(Variables.getElement(vi));
846 if (!DV.Verify()) continue;
847 DbgVariable *NewVar = new DbgVariable(DV, NULL);
848 if (DIE *VariableDIE =
849 SPCU->constructVariableDIE(NewVar, Scope->isAbstractScope()))
850 ScopeDIE->addChild(VariableDIE);
851 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000852 }
853 }
854 }
855 DeleteContainerSeconds(DeadFnScopeMap);
856}
857
858void DwarfDebug::finalizeModuleInfo() {
859 // Collect info for variables that were optimized out.
860 collectDeadVariables();
861
862 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
863 computeInlinedDIEs();
Devang Patel53bb5c92009-11-10 23:06:00 +0000864
Eric Christopher6635cad2012-08-01 18:19:01 +0000865 // Emit DW_AT_containing_type attribute to connect types with their
866 // vtable holding type.
Devang Pateldbc64af2011-08-15 17:24:54 +0000867 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000868 CUE = CUMap.end(); CUI != CUE; ++CUI) {
Devang Pateldbc64af2011-08-15 17:24:54 +0000869 CompileUnit *TheCU = CUI->second;
870 TheCU->constructContainingTypeDIEs();
Devang Patel5d11eb02009-12-03 19:11:07 +0000871 }
872
Eric Christopher4117bec2012-11-22 00:59:49 +0000873 // Compute DIE offsets and sizes.
874 computeSizeAndOffsets();
875}
876
877void DwarfDebug::endSections() {
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000878 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +0000879 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +0000880 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +0000881 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +0000882 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000883
884 // End text sections.
Benjamin Kramerb4c9d9c2012-10-31 13:45:49 +0000885 for (unsigned I = 0, E = SectionMap.size(); I != E; ++I) {
886 Asm->OutStreamer.SwitchSection(SectionMap[I]);
887 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", I+1));
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000888 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000889}
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000890
Eric Christopherb6dc8652012-11-27 22:43:45 +0000891// Emit all Dwarf sections that should come after the content.
Eric Christopher4117bec2012-11-22 00:59:49 +0000892void DwarfDebug::endModule() {
893
894 if (!FirstCU) return;
895
896 // End any existing sections.
897 // TODO: Does this need to happen?
898 endSections();
899
900 // Finalize the debug info for the module.
901 finalizeModuleInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000902
Eric Christopher97c34722012-11-19 19:43:59 +0000903 // Emit initial sections.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000904 emitSectionLabels();
Eric Christopher97c34722012-11-19 19:43:59 +0000905
Eric Christopher42885022012-11-27 22:43:42 +0000906 if (!useDwarfFission()) {
907 // Emit all the DIEs into a debug info section.
908 emitDebugInfo();
Eric Christopher74802f72012-11-27 00:41:54 +0000909
Eric Christopher42885022012-11-27 22:43:42 +0000910 // Corresponding abbreviations into a abbrev section.
911 emitAbbreviations();
912
913 // Emit info into a debug loc section.
914 emitDebugLoc();
915
916 // Emit info into a debug aranges section.
917 emitDebugARanges();
918
919 // Emit info into a debug ranges section.
920 emitDebugRanges();
921
922 // Emit info into a debug macinfo section.
923 emitDebugMacInfo();
924
925 // Emit inline info.
926 // TODO: When we don't need the option anymore we
927 // can remove all of the code that this section
928 // depends upon.
929 if (useDarwinGDBCompat())
930 emitDebugInlineInfo();
931 } else {
932 // TODO: Fill this in for Fission sections and separate
933 // out information into new sections.
934
Eric Christopher98e237f2012-11-30 23:59:06 +0000935 // Emit the debug info section and compile units.
Eric Christopher42885022012-11-27 22:43:42 +0000936 emitDebugInfo();
Eric Christopher98e237f2012-11-30 23:59:06 +0000937 emitDebugInfoDWO();
Eric Christopher42885022012-11-27 22:43:42 +0000938
939 // Corresponding abbreviations into a abbrev section.
940 emitAbbreviations();
941
942 // Emit info into a debug loc section.
943 emitDebugLoc();
944
945 // Emit info into a debug aranges section.
946 emitDebugARanges();
947
948 // Emit info into a debug ranges section.
949 emitDebugRanges();
950
951 // Emit info into a debug macinfo section.
952 emitDebugMacInfo();
953
954 // Emit inline info.
955 // TODO: When we don't need the option anymore we
956 // can remove all of the code that this section
957 // depends upon.
958 if (useDarwinGDBCompat())
959 emitDebugInlineInfo();
960 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000961
Eric Christopher9d9f5a52012-08-23 07:32:06 +0000962 // Emit info into the dwarf accelerator table sections.
Eric Christopher20f47ab2012-08-23 22:36:40 +0000963 if (useDwarfAccelTables()) {
Eric Christopher09ac3d82011-11-07 09:24:32 +0000964 emitAccelNames();
965 emitAccelObjC();
966 emitAccelNamespaces();
967 emitAccelTypes();
968 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000969
Devang Patel193f7202009-11-24 01:14:22 +0000970 // Emit info into a debug pubtypes section.
Eric Christopher360f0062012-08-23 07:10:56 +0000971 // TODO: When we don't need the option anymore we can
972 // remove all of the code that adds to the table.
Eric Christopher20f47ab2012-08-23 22:36:40 +0000973 if (useDarwinGDBCompat())
Eric Christopher360f0062012-08-23 07:10:56 +0000974 emitDebugPubTypes();
Devang Patel193f7202009-11-24 01:14:22 +0000975
Eric Christopher42885022012-11-27 22:43:42 +0000976 // Finally emit string information into a string table.
Eric Christopherfcdbecb2012-11-27 06:49:23 +0000977 emitDebugStr();
978
Devang Patele9a1cca2010-08-02 17:32:15 +0000979 // clean up.
Devang Patel94c7ddb2011-08-16 22:09:43 +0000980 SPMap.clear();
Devang Patel163a9f72010-05-10 22:49:55 +0000981 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
982 E = CUMap.end(); I != E; ++I)
983 delete I->second;
Eric Christopher98e237f2012-11-30 23:59:06 +0000984 // Reset these for the next Module if we have one.
985 FirstCU = NULL;
986 FissionCU = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000987}
988
Eric Christopherb6dc8652012-11-27 22:43:45 +0000989// Find abstract variable, if any, associated with Var.
Devang Patelb549bcf2011-08-10 21:50:54 +0000990DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattnerde4845c2010-04-02 19:42:39 +0000991 DebugLoc ScopeLoc) {
Devang Patelb549bcf2011-08-10 21:50:54 +0000992 LLVMContext &Ctx = DV->getContext();
993 // More then one inlined variable corresponds to one abstract variable.
994 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patel2db49d72010-05-07 18:11:54 +0000995 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +0000996 if (AbsDbgVariable)
997 return AbsDbgVariable;
998
Devang Patelbf47fdb2011-08-10 20:55:27 +0000999 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00001000 if (!Scope)
1001 return NULL;
1002
Devang Patel5a1a67c2011-08-15 19:01:20 +00001003 AbsDbgVariable = new DbgVariable(Var, NULL);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001004 addScopeVariable(Scope, AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00001005 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00001006 return AbsDbgVariable;
1007}
1008
Eric Christopherb6dc8652012-11-27 22:43:45 +00001009// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel0478c152011-03-01 22:58:55 +00001010bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patelbf47fdb2011-08-10 20:55:27 +00001011 DbgVariable *Var, LexicalScope *Scope) {
1012 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +00001013 return false;
1014 DIVariable DV = Var->getVariable();
1015 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1016 return false;
1017 unsigned ArgNo = DV.getArgNumber();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001018 if (ArgNo == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001019 return false;
1020
Devang Patelcb3a6572011-03-03 20:02:02 +00001021 size_t Size = CurrentFnArguments.size();
1022 if (Size == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001023 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patelbbd0f452011-03-03 21:49:41 +00001024 // llvm::Function argument size is not good indicator of how many
Devang Patel6f676be2011-03-03 20:08:10 +00001025 // arguments does the function have at source level.
1026 if (ArgNo > Size)
Devang Patelcb3a6572011-03-03 20:02:02 +00001027 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel0478c152011-03-01 22:58:55 +00001028 CurrentFnArguments[ArgNo - 1] = Var;
1029 return true;
1030}
1031
Eric Christopherb6dc8652012-11-27 22:43:45 +00001032// Collect variable information from side table maintained by MMI.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001033void
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001034DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patelee432862010-05-20 19:57:06 +00001035 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patele717faa2009-10-06 01:26:37 +00001036 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1037 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1038 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00001039 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00001040 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00001041 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00001042 DIVariable DV(Var);
1043 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00001044
Devang Patelbf47fdb2011-08-10 20:55:27 +00001045 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001046
Devang Patelfb0ee432009-11-10 23:20:04 +00001047 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00001048 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00001049 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00001050
Devang Patel26c1e562010-05-20 16:36:41 +00001051 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001052 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable);
Devang Patelff9dd0a2011-08-15 21:24:36 +00001053 RegVar->setFrameIndex(VP.first);
Devang Patel0478c152011-03-01 22:58:55 +00001054 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001055 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001056 if (AbsDbgVariable)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001057 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patele717faa2009-10-06 01:26:37 +00001058 }
Devang Patelee432862010-05-20 19:57:06 +00001059}
Devang Patel90a48ad2010-03-15 18:33:46 +00001060
Eric Christopherb6dc8652012-11-27 22:43:45 +00001061// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1062// defined reg.
Devang Patelc3f5f782010-05-25 23:40:22 +00001063static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001064 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001065 return MI->getNumOperands() == 3 &&
1066 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
1067 MI->getOperand(1).isImm() && MI->getOperand(1).getImm() == 0;
Devang Patelc3f5f782010-05-25 23:40:22 +00001068}
1069
Eric Christopherb6dc8652012-11-27 22:43:45 +00001070// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001071static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1072 const MCSymbol *FLabel,
Devang Patel90b40412011-07-08 17:09:57 +00001073 const MCSymbol *SLabel,
1074 const MachineInstr *MI) {
1075 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1076
1077 if (MI->getNumOperands() != 3) {
1078 MachineLocation MLoc = Asm->getDebugValueLocation(MI);
1079 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1080 }
1081 if (MI->getOperand(0).isReg() && MI->getOperand(1).isImm()) {
1082 MachineLocation MLoc;
1083 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
1084 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1085 }
1086 if (MI->getOperand(0).isImm())
1087 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1088 if (MI->getOperand(0).isFPImm())
1089 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1090 if (MI->getOperand(0).isCImm())
1091 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1092
Craig Topper5e25ee82012-02-05 08:31:47 +00001093 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel90b40412011-07-08 17:09:57 +00001094}
1095
Eric Christopherb6dc8652012-11-27 22:43:45 +00001096// Find variables for each lexical scope.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001097void
Devang Patel78e127d2010-06-25 22:07:34 +00001098DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1099 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00001100
Eric Christopherb6dc8652012-11-27 22:43:45 +00001101 // collection info from MMI table.
Devang Patelee432862010-05-20 19:57:06 +00001102 collectVariableInfoFromMMITable(MF, Processed);
1103
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001104 for (SmallVectorImpl<const MDNode*>::const_iterator
1105 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1106 ++UVI) {
1107 const MDNode *Var = *UVI;
1108 if (Processed.count(Var))
Devang Patelee432862010-05-20 19:57:06 +00001109 continue;
1110
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001111 // History contains relevant DBG_VALUE instructions for Var and instructions
1112 // clobbering it.
1113 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1114 if (History.empty())
1115 continue;
1116 const MachineInstr *MInsn = History.front();
Devang Patelc3f5f782010-05-25 23:40:22 +00001117
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001118 DIVariable DV(Var);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001119 LexicalScope *Scope = NULL;
Devang Pateld8720f42010-05-27 20:25:04 +00001120 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1121 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001122 Scope = LScopes.getCurrentFunctionScope();
Devang Patel40c7e412011-07-20 22:18:50 +00001123 else {
1124 if (DV.getVersion() <= LLVMDebugVersion9)
Devang Patelbf47fdb2011-08-10 20:55:27 +00001125 Scope = LScopes.findLexicalScope(MInsn->getDebugLoc());
Devang Patel40c7e412011-07-20 22:18:50 +00001126 else {
1127 if (MDNode *IA = DV.getInlinedAt())
Devang Patelbf47fdb2011-08-10 20:55:27 +00001128 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
Devang Patel40c7e412011-07-20 22:18:50 +00001129 else
Devang Patelbf47fdb2011-08-10 20:55:27 +00001130 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel40c7e412011-07-20 22:18:50 +00001131 }
1132 }
Devang Patelee432862010-05-20 19:57:06 +00001133 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00001134 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00001135 continue;
1136
1137 Processed.insert(DV);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001138 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel5a1a67c2011-08-15 19:01:20 +00001139 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
1140 DbgVariable *RegVar = new DbgVariable(DV, AbsVar);
Devang Patel0478c152011-03-01 22:58:55 +00001141 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001142 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001143 if (AbsVar)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001144 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001145
Eric Christopherc56e3f02012-10-08 20:48:54 +00001146 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001147 if (History.size() <= 1 || (History.size() == 2 &&
1148 MInsn->isIdenticalTo(History.back()))) {
Devang Patelff9dd0a2011-08-15 21:24:36 +00001149 RegVar->setMInsn(MInsn);
Devang Patelc3f5f782010-05-25 23:40:22 +00001150 continue;
1151 }
1152
1153 // handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001154 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001155
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001156 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1157 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1158 const MachineInstr *Begin = *HI;
1159 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesene17232e2011-03-22 00:21:41 +00001160
Devang Patel4ada1d72011-06-01 23:00:17 +00001161 // Check if DBG_VALUE is truncating a range.
1162 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1163 && !Begin->getOperand(0).getReg())
1164 continue;
1165
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001166 // Compute the range for a register location.
1167 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1168 const MCSymbol *SLabel = 0;
1169
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001170 if (HI + 1 == HE)
1171 // If Begin is the last instruction in History then its value is valid
Chris Lattner7a2bdde2011-04-15 05:18:47 +00001172 // until the end of the function.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001173 SLabel = FunctionEndSym;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001174 else {
1175 const MachineInstr *End = HI[1];
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001176 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel476df5f2011-07-07 21:44:42 +00001177 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001178 if (End->isDebugValue())
1179 SLabel = getLabelBeforeInsn(End);
1180 else {
1181 // End is a normal instruction clobbering the range.
1182 SLabel = getLabelAfterInsn(End);
1183 assert(SLabel && "Forgot label after clobber instruction");
1184 ++HI;
1185 }
1186 }
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001187
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001188 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopherabbb2002011-12-16 23:42:31 +00001189 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1190 Begin));
Devang Patelc3f5f782010-05-25 23:40:22 +00001191 }
1192 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00001193 }
Devang Patel98e1cac2010-05-14 21:01:35 +00001194
1195 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001196 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1197 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1198 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1199 DIVariable DV(Variables.getElement(i));
1200 if (!DV || !DV.Verify() || !Processed.insert(DV))
1201 continue;
1202 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1203 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel98e1cac2010-05-14 21:01:35 +00001204 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001205}
Devang Patel98e1cac2010-05-14 21:01:35 +00001206
Eric Christopherb6dc8652012-11-27 22:43:45 +00001207// Return Label preceding the instruction.
Devang Patelc3f5f782010-05-25 23:40:22 +00001208const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001209 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1210 assert(Label && "Didn't insert label before instruction");
1211 return Label;
Devang Patelc3f5f782010-05-25 23:40:22 +00001212}
1213
Eric Christopherb6dc8652012-11-27 22:43:45 +00001214// Return Label immediately following the instruction.
Devang Patelc3f5f782010-05-25 23:40:22 +00001215const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001216 return LabelsAfterInsn.lookup(MI);
Devang Patele717faa2009-10-06 01:26:37 +00001217}
1218
Eric Christopherb6dc8652012-11-27 22:43:45 +00001219// Process beginning of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001220void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001221 // Check if source location changes, but ignore DBG_VALUE locations.
1222 if (!MI->isDebugValue()) {
1223 DebugLoc DL = MI->getDebugLoc();
1224 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopher60b35f42012-04-05 20:39:05 +00001225 unsigned Flags = 0;
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001226 PrevInstLoc = DL;
Devang Patel4243e672011-05-11 19:22:19 +00001227 if (DL == PrologEndLoc) {
1228 Flags |= DWARF2_FLAG_PROLOGUE_END;
1229 PrologEndLoc = DebugLoc();
1230 }
Eric Christopher60b35f42012-04-05 20:39:05 +00001231 if (PrologEndLoc.isUnknown())
1232 Flags |= DWARF2_FLAG_IS_STMT;
1233
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001234 if (!DL.isUnknown()) {
1235 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel4243e672011-05-11 19:22:19 +00001236 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001237 } else
Devang Patel4243e672011-05-11 19:22:19 +00001238 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001239 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001240 }
Devang Patelaead63c2010-03-29 22:59:58 +00001241
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001242 // Insert labels where requested.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001243 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1244 LabelsBeforeInsn.find(MI);
1245
1246 // No label needed.
1247 if (I == LabelsBeforeInsn.end())
1248 return;
1249
1250 // Label already assigned.
1251 if (I->second)
Devang Patelb2b31a62010-05-26 19:37:24 +00001252 return;
Devang Patel553881b2010-03-29 17:20:31 +00001253
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001254 if (!PrevLabel) {
Devang Patel77051f52010-05-26 21:23:46 +00001255 PrevLabel = MMI->getContext().CreateTempSymbol();
1256 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00001257 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001258 I->second = PrevLabel;
Devang Patel0d20ac82009-10-06 01:50:42 +00001259}
1260
Eric Christopherb6dc8652012-11-27 22:43:45 +00001261// Process end of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001262void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001263 // Don't create a new label after DBG_VALUE instructions.
1264 // They don't generate code.
1265 if (!MI->isDebugValue())
1266 PrevLabel = 0;
1267
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001268 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1269 LabelsAfterInsn.find(MI);
1270
1271 // No label needed.
1272 if (I == LabelsAfterInsn.end())
1273 return;
1274
1275 // Label already assigned.
1276 if (I->second)
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001277 return;
1278
1279 // We need a label after this instruction.
1280 if (!PrevLabel) {
1281 PrevLabel = MMI->getContext().CreateTempSymbol();
1282 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel1c246352010-04-08 16:50:29 +00001283 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001284 I->second = PrevLabel;
Devang Patel53bb5c92009-11-10 23:06:00 +00001285}
1286
Eric Christopherb6dc8652012-11-27 22:43:45 +00001287// Each LexicalScope has first instruction and last instruction to mark
1288// beginning and end of a scope respectively. Create an inverse map that list
1289// scopes starts (and ends) with an instruction. One instruction may start (or
1290// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00001291void DwarfDebug::identifyScopeMarkers() {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001292 SmallVector<LexicalScope *, 4> WorkList;
1293 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel42aafd72010-01-20 02:05:23 +00001294 while (!WorkList.empty()) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001295 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001296
Devang Patelbf47fdb2011-08-10 20:55:27 +00001297 const SmallVector<LexicalScope *, 4> &Children = S->getChildren();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001298 if (!Children.empty())
Devang Patelbf47fdb2011-08-10 20:55:27 +00001299 for (SmallVector<LexicalScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00001300 SE = Children.end(); SI != SE; ++SI)
1301 WorkList.push_back(*SI);
1302
Devang Patel53bb5c92009-11-10 23:06:00 +00001303 if (S->isAbstractScope())
1304 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001305
Devang Patelbf47fdb2011-08-10 20:55:27 +00001306 const SmallVector<InsnRange, 4> &Ranges = S->getRanges();
Devang Pateleac9c072010-04-27 19:46:33 +00001307 if (Ranges.empty())
1308 continue;
Devang Patelbf47fdb2011-08-10 20:55:27 +00001309 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +00001310 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001311 assert(RI->first && "InsnRange does not have first instruction!");
1312 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001313 requestLabelBeforeInsn(RI->first);
1314 requestLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001315 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001316 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001317}
1318
Eric Christopherb6dc8652012-11-27 22:43:45 +00001319// Get MDNode for DebugLoc's scope.
Devang Patela3f48672011-05-09 22:14:49 +00001320static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1321 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1322 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1323 return DL.getScope(Ctx);
1324}
1325
Eric Christopherb6dc8652012-11-27 22:43:45 +00001326// Walk up the scope chain of given debug loc and find line number info
1327// for the function.
Devang Patel4243e672011-05-11 19:22:19 +00001328static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1329 const MDNode *Scope = getScopeNode(DL, Ctx);
1330 DISubprogram SP = getDISubprogram(Scope);
Eric Christopher6126a1e2012-04-03 00:43:49 +00001331 if (SP.Verify()) {
1332 // Check for number of operands since the compatibility is
1333 // cheap here.
Eric Christopherfa5b0502012-04-03 17:55:42 +00001334 if (SP->getNumOperands() > 19)
Eric Christopher6126a1e2012-04-03 00:43:49 +00001335 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1336 else
1337 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1338 }
1339
Devang Patel4243e672011-05-11 19:22:19 +00001340 return DebugLoc();
1341}
1342
Eric Christopherb6dc8652012-11-27 22:43:45 +00001343// Gather pre-function debug information. Assumes being called immediately
1344// after the function entry point has been emitted.
Chris Lattnereec791a2010-01-26 23:18:02 +00001345void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00001346 if (!MMI->hasDebugInfo()) return;
Devang Patelbf47fdb2011-08-10 20:55:27 +00001347 LScopes.initialize(*MF);
1348 if (LScopes.empty()) return;
1349 identifyScopeMarkers();
Devang Patel60b35bd2009-10-06 18:37:31 +00001350
Devang Pateleac9c072010-04-27 19:46:33 +00001351 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1352 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001353 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00001354 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001355
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001356 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1357
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001358 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopherb6dc8652012-11-27 22:43:45 +00001359 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001360 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1361
Devang Patelb2b31a62010-05-26 19:37:24 +00001362 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001363 I != E; ++I) {
1364 bool AtBlockEntry = true;
Devang Patelb2b31a62010-05-26 19:37:24 +00001365 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1366 II != IE; ++II) {
1367 const MachineInstr *MI = II;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001368
Devang Patelb2b31a62010-05-26 19:37:24 +00001369 if (MI->isDebugValue()) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001370 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001371
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001372 // Keep track of user variables.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001373 const MDNode *Var =
1374 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001375
1376 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001377 if (isDbgValueInDefinedReg(MI))
1378 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1379
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001380 // Check the history of this variable.
1381 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1382 if (History.empty()) {
1383 UserVariables.push_back(Var);
1384 // The first mention of a function argument gets the FunctionBeginSym
1385 // label, so arguments are visible when breaking at function entry.
1386 DIVariable DV(Var);
1387 if (DV.Verify() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1388 DISubprogram(getDISubprogram(DV.getContext()))
1389 .describes(MF->getFunction()))
1390 LabelsBeforeInsn[MI] = FunctionBeginSym;
1391 } else {
1392 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1393 const MachineInstr *Prev = History.back();
1394 if (Prev->isDebugValue()) {
1395 // Coalesce identical entries at the end of History.
1396 if (History.size() >= 2 &&
Devang Patel79862892011-07-07 00:14:27 +00001397 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher02c1a642012-10-08 20:48:49 +00001398 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001399 << "\t" << *Prev
Devang Patel79862892011-07-07 00:14:27 +00001400 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001401 History.pop_back();
Devang Patel79862892011-07-07 00:14:27 +00001402 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001403
1404 // Terminate old register assignments that don't reach MI;
1405 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1406 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1407 isDbgValueInDefinedReg(Prev)) {
1408 // Previous register assignment needs to terminate at the end of
1409 // its basic block.
1410 MachineBasicBlock::const_iterator LastMI =
1411 PrevMBB->getLastNonDebugInstr();
Devang Patel79862892011-07-07 00:14:27 +00001412 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001413 // Drop DBG_VALUE for empty range.
Eric Christopher02c1a642012-10-08 20:48:49 +00001414 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patel79862892011-07-07 00:14:27 +00001415 << "\t" << *Prev << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001416 History.pop_back();
Devang Patel79862892011-07-07 00:14:27 +00001417 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001418 else {
1419 // Terminate after LastMI.
1420 History.push_back(LastMI);
1421 }
1422 }
1423 }
1424 }
1425 History.push_back(MI);
Devang Patelb2b31a62010-05-26 19:37:24 +00001426 } else {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001427 // Not a DBG_VALUE instruction.
1428 if (!MI->isLabel())
1429 AtBlockEntry = false;
1430
Eric Christopher0313ced2012-10-04 20:46:14 +00001431 // First known non-DBG_VALUE and non-frame setup location marks
1432 // the beginning of the function body.
1433 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1434 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel4243e672011-05-11 19:22:19 +00001435 PrologEndLoc = MI->getDebugLoc();
1436
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001437 // Check if the instruction clobbers any registers with debug vars.
1438 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1439 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1440 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1441 continue;
Jakob Stoklund Olesen396618b2012-06-01 23:28:30 +00001442 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1443 AI.isValid(); ++AI) {
1444 unsigned Reg = *AI;
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001445 const MDNode *Var = LiveUserVar[Reg];
1446 if (!Var)
1447 continue;
1448 // Reg is now clobbered.
1449 LiveUserVar[Reg] = 0;
1450
1451 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001452 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1453 if (HistI == DbgValues.end())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001454 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001455 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1456 if (History.empty())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001457 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001458 const MachineInstr *Prev = History.back();
1459 // Sanity-check: Register assignments are terminated at the end of
1460 // their block.
1461 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1462 continue;
1463 // Is the variable still in Reg?
1464 if (!isDbgValueInDefinedReg(Prev) ||
1465 Prev->getOperand(0).getReg() != Reg)
1466 continue;
1467 // Var is clobbered. Make sure the next instruction gets a label.
1468 History.push_back(MI);
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001469 }
1470 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001471 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001472 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001473 }
1474
1475 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1476 I != E; ++I) {
1477 SmallVectorImpl<const MachineInstr*> &History = I->second;
1478 if (History.empty())
1479 continue;
1480
1481 // Make sure the final register assignments are terminated.
1482 const MachineInstr *Prev = History.back();
1483 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1484 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001485 MachineBasicBlock::const_iterator LastMI =
Devang Patel5bc942c2011-08-10 23:58:09 +00001486 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001487 if (LastMI == PrevMBB->end())
1488 // Drop DBG_VALUE for empty range.
1489 History.pop_back();
1490 else {
1491 // Terminate after LastMI.
1492 History.push_back(LastMI);
1493 }
1494 }
1495 // Request labels for the full history.
1496 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1497 const MachineInstr *MI = History[i];
1498 if (MI->isDebugValue())
1499 requestLabelBeforeInsn(MI);
1500 else
1501 requestLabelAfterInsn(MI);
1502 }
1503 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001504
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001505 PrevInstLoc = DebugLoc();
Devang Patelb2b31a62010-05-26 19:37:24 +00001506 PrevLabel = FunctionBeginSym;
Devang Patel4243e672011-05-11 19:22:19 +00001507
1508 // Record beginning of function.
1509 if (!PrologEndLoc.isUnknown()) {
1510 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1511 MF->getFunction()->getContext());
1512 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1513 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikieb36c5312012-12-04 21:05:36 +00001514 DWARF2_FLAG_IS_STMT);
Devang Patel4243e672011-05-11 19:22:19 +00001515 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001516}
1517
Devang Patelbf47fdb2011-08-10 20:55:27 +00001518void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1519// SmallVector<DbgVariable *, 8> &Vars = ScopeVariables.lookup(LS);
1520 ScopeVariables[LS].push_back(Var);
1521// Vars.push_back(Var);
1522}
1523
Eric Christopherb6dc8652012-11-27 22:43:45 +00001524// Gather and emit post-function debug information.
Chris Lattnereec791a2010-01-26 23:18:02 +00001525void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001526 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00001527
Devang Patelbf47fdb2011-08-10 20:55:27 +00001528 // Define end label for subprogram.
1529 FunctionEndSym = Asm->GetTempSymbol("func_end",
1530 Asm->getFunctionNumber());
1531 // Assumes in correct section after the entry point.
1532 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001533
Devang Patelbf47fdb2011-08-10 20:55:27 +00001534 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1535 collectVariableInfo(MF, ProcessedVars);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001536
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001537 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Patel94c7ddb2011-08-16 22:09:43 +00001538 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky746cb672011-10-26 22:55:33 +00001539 assert(TheCU && "Unable to find compile unit!");
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001540
Devang Patelbf47fdb2011-08-10 20:55:27 +00001541 // Construct abstract scopes.
Devang Patelcd9f6c52011-08-12 18:10:19 +00001542 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1543 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1544 LexicalScope *AScope = AList[i];
1545 DISubprogram SP(AScope->getScopeNode());
Devang Patelbf47fdb2011-08-10 20:55:27 +00001546 if (SP.Verify()) {
1547 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001548 DIArray Variables = SP.getVariables();
1549 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1550 DIVariable DV(Variables.getElement(i));
1551 if (!DV || !DV.Verify() || !ProcessedVars.insert(DV))
1552 continue;
Alexey Samsonovb67bd332012-07-06 08:45:08 +00001553 // Check that DbgVariable for DV wasn't created earlier, when
1554 // findAbstractVariable() was called for inlined instance of DV.
1555 LLVMContext &Ctx = DV->getContext();
1556 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1557 if (AbstractVariables.lookup(CleanDV))
1558 continue;
Devang Patel93d39be2011-08-19 23:28:12 +00001559 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1560 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel78e127d2010-06-25 22:07:34 +00001561 }
1562 }
Devang Patelcd9f6c52011-08-12 18:10:19 +00001563 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001564 constructScopeDIE(TheCU, AScope);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001565 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001566
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001567 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001568
Nick Lewycky8a8d4792011-12-02 22:16:29 +00001569 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopher873cf0a2012-08-24 01:14:27 +00001570 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001571
Devang Patelbf47fdb2011-08-10 20:55:27 +00001572 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
1573 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001574
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001575 // Clear debug info
Devang Patelbf47fdb2011-08-10 20:55:27 +00001576 for (DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >::iterator
1577 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1578 DeleteContainerPointers(I->second);
1579 ScopeVariables.clear();
Devang Pateleac0c9d2011-04-22 18:09:57 +00001580 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001581 UserVariables.clear();
1582 DbgValues.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001583 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00001584 LabelsBeforeInsn.clear();
1585 LabelsAfterInsn.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00001586 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001587}
1588
Eric Christopherb6dc8652012-11-27 22:43:45 +00001589// Register a source line with debug info. Returns the unique label that was
1590// emitted and which provides correspondence to the source line list.
Devang Patel4243e672011-05-11 19:22:19 +00001591void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1592 unsigned Flags) {
Devang Patel65dbc902009-11-25 17:36:49 +00001593 StringRef Fn;
Devang Patel23670e52011-03-24 20:30:50 +00001594 StringRef Dir;
Dan Gohman1cc0d622010-05-05 23:41:32 +00001595 unsigned Src = 1;
1596 if (S) {
1597 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00001598
Dan Gohman1cc0d622010-05-05 23:41:32 +00001599 if (Scope.isCompileUnit()) {
1600 DICompileUnit CU(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001601 Fn = CU.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001602 Dir = CU.getDirectory();
Devang Patel3cabc9d2010-10-28 17:30:52 +00001603 } else if (Scope.isFile()) {
1604 DIFile F(S);
Devang Patel3cabc9d2010-10-28 17:30:52 +00001605 Fn = F.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001606 Dir = F.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001607 } else if (Scope.isSubprogram()) {
1608 DISubprogram SP(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001609 Fn = SP.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001610 Dir = SP.getDirectory();
Eric Christopher6618a242011-10-11 22:59:11 +00001611 } else if (Scope.isLexicalBlockFile()) {
1612 DILexicalBlockFile DBF(S);
1613 Fn = DBF.getFilename();
1614 Dir = DBF.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001615 } else if (Scope.isLexicalBlock()) {
1616 DILexicalBlock DB(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001617 Fn = DB.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001618 Dir = DB.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001619 } else
Craig Topper5e25ee82012-02-05 08:31:47 +00001620 llvm_unreachable("Unexpected scope info");
Dan Gohman1cc0d622010-05-05 23:41:32 +00001621
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001622 Src = getOrCreateSourceID(Fn, Dir);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001623 }
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001624 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001625}
1626
Bill Wendling829e67b2009-05-20 23:22:40 +00001627//===----------------------------------------------------------------------===//
1628// Emit Methods
1629//===----------------------------------------------------------------------===//
1630
Eric Christopherb6dc8652012-11-27 22:43:45 +00001631// Compute the size and offset of a DIE.
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001632unsigned
Eric Christopherfbd19752012-11-20 22:14:13 +00001633DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001634 // Get the children.
1635 const std::vector<DIE *> &Children = Die->getChildren();
1636
Bill Wendling94d04b82009-05-20 23:21:38 +00001637 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001638 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00001639
1640 // Get the abbreviation for this DIE.
1641 unsigned AbbrevNumber = Die->getAbbrevNumber();
1642 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1643
1644 // Set DIE offset
1645 Die->setOffset(Offset);
1646
1647 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00001648 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001649
1650 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
1651 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1652
1653 // Size the DIE attribute values.
1654 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1655 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00001656 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00001657
1658 // Size the DIE children if any.
1659 if (!Children.empty()) {
1660 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1661 "Children flag not set");
1662
1663 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopherfbd19752012-11-20 22:14:13 +00001664 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling94d04b82009-05-20 23:21:38 +00001665
1666 // End of children marker.
1667 Offset += sizeof(int8_t);
1668 }
1669
1670 Die->setSize(Offset - Die->getOffset());
1671 return Offset;
1672}
1673
Eric Christopherb6dc8652012-11-27 22:43:45 +00001674// Compute the size and offset of all the DIEs.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001675void DwarfDebug::computeSizeAndOffsets() {
Eric Christopher98e237f2012-11-30 23:59:06 +00001676 if (FissionCU) {
1677 unsigned Offset =
1678 sizeof(int32_t) + // Length of Compilation Unit Info
1679 sizeof(int16_t) + // DWARF version number
1680 sizeof(int32_t) + // Offset Into Abbrev. Section
1681 sizeof(int8_t); // Pointer Size (in bytes)
1682
1683 computeSizeAndOffset(FissionCU->getCUDie(), Offset);
1684 }
Devang Patel163a9f72010-05-10 22:49:55 +00001685 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1686 E = CUMap.end(); I != E; ++I) {
1687 // Compute size of compile unit header.
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001688 unsigned Offset =
Devang Patel163a9f72010-05-10 22:49:55 +00001689 sizeof(int32_t) + // Length of Compilation Unit Info
1690 sizeof(int16_t) + // DWARF version number
1691 sizeof(int32_t) + // Offset Into Abbrev. Section
1692 sizeof(int8_t); // Pointer Size (in bytes)
Eric Christopherfbd19752012-11-20 22:14:13 +00001693 computeSizeAndOffset(I->second->getCUDie(), Offset);
Devang Patel163a9f72010-05-10 22:49:55 +00001694 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001695}
1696
Eric Christopherb6dc8652012-11-27 22:43:45 +00001697// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001698void DwarfDebug::emitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001699 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001700
Bill Wendling94d04b82009-05-20 23:21:38 +00001701 // Dwarf sections base addresses.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001702 DwarfInfoSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001703 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00001704 DwarfAbbrevSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001705 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
1706 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001707
Chris Lattner9c69e285532010-04-04 22:59:04 +00001708 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001709 emitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00001710
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001711 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
1712 emitSectionSym(Asm, TLOF.getDwarfLocSection());
1713 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001714 DwarfStrSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001715 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
1716 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patelf2548ca2010-04-16 23:33:45 +00001717 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00001718
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001719 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patelc3f5f782010-05-25 23:40:22 +00001720 "section_debug_loc");
1721
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001722 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
1723 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00001724}
1725
Eric Christopherb6dc8652012-11-27 22:43:45 +00001726// Recursively emits a debug information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001727void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001728 // Get the abbreviation for this DIE.
1729 unsigned AbbrevNumber = Die->getAbbrevNumber();
1730 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1731
Bill Wendling94d04b82009-05-20 23:21:38 +00001732 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00001733 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00001734 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
1735 Twine::utohexstr(Die->getOffset()) + ":0x" +
1736 Twine::utohexstr(Die->getSize()) + " " +
1737 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00001738 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001739
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00001740 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling94d04b82009-05-20 23:21:38 +00001741 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1742
1743 // Emit the DIE attribute values.
1744 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1745 unsigned Attr = AbbrevData[i].getAttribute();
1746 unsigned Form = AbbrevData[i].getForm();
1747 assert(Form && "Too many attributes for DIE (check abbreviation)");
1748
Chris Lattner3f53c832010-04-04 18:52:31 +00001749 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00001750 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001751
Bill Wendling94d04b82009-05-20 23:21:38 +00001752 switch (Attr) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001753 case dwarf::DW_AT_abstract_origin: {
1754 DIEEntry *E = cast<DIEEntry>(Values[i]);
1755 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00001756 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00001757 Asm->EmitInt32(Addr);
1758 break;
1759 }
Devang Patelf2548ca2010-04-16 23:33:45 +00001760 case dwarf::DW_AT_ranges: {
1761 // DW_AT_range Value encodes offset in debug_range section.
1762 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelb1fcfbe2010-09-02 16:43:44 +00001763
Nick Lewyckyffccd922012-06-22 01:25:12 +00001764 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelb1fcfbe2010-09-02 16:43:44 +00001765 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
1766 V->getValue(),
1767 4);
1768 } else {
1769 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
1770 V->getValue(),
1771 DwarfDebugRangeSectionSym,
1772 4);
1773 }
Devang Patelf2548ca2010-04-16 23:33:45 +00001774 break;
1775 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001776 case dwarf::DW_AT_location: {
Nick Lewyckyffccd922012-06-22 01:25:12 +00001777 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
1778 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
1779 Asm->EmitLabelReference(L->getValue(), 4);
1780 else
1781 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
1782 } else {
Devang Patelc3f5f782010-05-25 23:40:22 +00001783 Values[i]->EmitValue(Asm, Form);
Nick Lewyckyffccd922012-06-22 01:25:12 +00001784 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001785 break;
1786 }
Devang Patel2a361602010-09-29 19:08:08 +00001787 case dwarf::DW_AT_accessibility: {
1788 if (Asm->isVerbose()) {
1789 DIEInteger *V = cast<DIEInteger>(Values[i]);
1790 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
1791 }
1792 Values[i]->EmitValue(Asm, Form);
1793 break;
1794 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001795 default:
1796 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001797 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00001798 break;
1799 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001800 }
1801
1802 // Emit the DIE children if any.
1803 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
1804 const std::vector<DIE *> &Children = Die->getChildren();
1805
1806 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001807 emitDIE(Children[j]);
Bill Wendling94d04b82009-05-20 23:21:38 +00001808
Chris Lattner3f53c832010-04-04 18:52:31 +00001809 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00001810 Asm->OutStreamer.AddComment("End Of Children Mark");
1811 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00001812 }
1813}
1814
Eric Christopher98e237f2012-11-30 23:59:06 +00001815void DwarfDebug::emitCompileUnits(const MCSection *Section) {
1816 Asm->OutStreamer.SwitchSection(Section);
Devang Patel163a9f72010-05-10 22:49:55 +00001817 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1818 E = CUMap.end(); I != E; ++I) {
1819 CompileUnit *TheCU = I->second;
1820 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001821
Devang Patel163a9f72010-05-10 22:49:55 +00001822 // Emit the compile units header.
1823 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
Eli Benderskyd4a05e02012-12-03 18:45:45 +00001824 TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001825
Devang Patel163a9f72010-05-10 22:49:55 +00001826 // Emit size of content not including length itself
1827 unsigned ContentSize = Die->getSize() +
1828 sizeof(int16_t) + // DWARF version number
1829 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patel65705d52011-04-13 19:41:17 +00001830 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbach1e20b962010-07-21 21:21:52 +00001831
Devang Patel163a9f72010-05-10 22:49:55 +00001832 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
1833 Asm->EmitInt32(ContentSize);
1834 Asm->OutStreamer.AddComment("DWARF version number");
1835 Asm->EmitInt16(dwarf::DWARF_VERSION);
1836 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
1837 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
1838 DwarfAbbrevSectionSym);
1839 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00001840 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001841
Devang Patel163a9f72010-05-10 22:49:55 +00001842 emitDIE(Die);
Eli Benderskyd4a05e02012-12-03 18:45:45 +00001843 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end",
1844 TheCU->getUniqueID()));
Devang Patel163a9f72010-05-10 22:49:55 +00001845 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001846}
1847
Eric Christopher98e237f2012-11-30 23:59:06 +00001848// Emit the debug info section.
1849void DwarfDebug::emitDebugInfo() {
1850 if (!useDwarfFission())
1851 emitCompileUnits(Asm->getObjFileLowering().getDwarfInfoSection());
1852 else
1853 emitFissionSkeletonCU(Asm->getObjFileLowering().getDwarfInfoSection());
1854}
1855
Eric Christopherb6dc8652012-11-27 22:43:45 +00001856// Emit the abbreviation section.
Eric Christopher7dc68db2012-11-20 23:30:11 +00001857void DwarfDebug::emitAbbreviations() {
Bill Wendling94d04b82009-05-20 23:21:38 +00001858 // Check to see if it is worth the effort.
1859 if (!Abbreviations.empty()) {
1860 // Start the debug abbrev section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001861 Asm->OutStreamer.SwitchSection(
1862 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00001863
Chris Lattnerc0215722010-04-04 19:25:43 +00001864 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00001865
1866 // For each abbrevation.
1867 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
1868 // Get abbreviation data
1869 const DIEAbbrev *Abbrev = Abbreviations[i];
1870
1871 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00001872 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00001873
1874 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001875 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00001876 }
1877
1878 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00001879 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00001880
Chris Lattnerc0215722010-04-04 19:25:43 +00001881 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00001882 }
1883}
1884
Eric Christopherb6dc8652012-11-27 22:43:45 +00001885// Emit the last address of the section and the end of the line matrix.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001886void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001887 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00001888 Asm->OutStreamer.AddComment("Extended Op");
1889 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001890
Chris Lattner233f52b2010-03-09 23:52:58 +00001891 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00001892 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00001893 Asm->OutStreamer.AddComment("DW_LNE_set_address");
1894 Asm->EmitInt8(dwarf::DW_LNE_set_address);
1895
1896 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00001897
Chris Lattnerc0215722010-04-04 19:25:43 +00001898 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chandler Carruth426c2bf2012-11-01 09:14:31 +00001899 Asm->getDataLayout().getPointerSize(),
Chris Lattnerd38fee82010-04-05 00:13:49 +00001900 0/*AddrSpace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00001901
1902 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00001903 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
1904 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00001905 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00001906 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00001907}
1908
Eric Christopherb6dc8652012-11-27 22:43:45 +00001909// Emit visible names into a hashed accelerator table section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00001910void DwarfDebug::emitAccelNames() {
1911 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1912 dwarf::DW_FORM_data4));
1913 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1914 E = CUMap.end(); I != E; ++I) {
1915 CompileUnit *TheCU = I->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00001916 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
1917 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00001918 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1919 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00001920 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00001921 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1922 DE = Entities.end(); DI != DE; ++DI)
1923 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00001924 }
1925 }
1926
1927 AT.FinalizeTable(Asm, "Names");
1928 Asm->OutStreamer.SwitchSection(
1929 Asm->getObjFileLowering().getDwarfAccelNamesSection());
1930 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
1931 Asm->OutStreamer.EmitLabel(SectionBegin);
1932
1933 // Emit the full data.
1934 AT.Emit(Asm, SectionBegin, this);
1935}
1936
Eric Christopherb6dc8652012-11-27 22:43:45 +00001937// Emit objective C classes and categories into a hashed accelerator table section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00001938void DwarfDebug::emitAccelObjC() {
1939 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1940 dwarf::DW_FORM_data4));
1941 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1942 E = CUMap.end(); I != E; ++I) {
1943 CompileUnit *TheCU = I->second;
1944 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
1945 for (StringMap<std::vector<DIE*> >::const_iterator
1946 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1947 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00001948 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher09ac3d82011-11-07 09:24:32 +00001949 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1950 DE = Entities.end(); DI != DE; ++DI)
1951 AT.AddName(Name, (*DI));
1952 }
1953 }
1954
1955 AT.FinalizeTable(Asm, "ObjC");
1956 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
1957 .getDwarfAccelObjCSection());
1958 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
1959 Asm->OutStreamer.EmitLabel(SectionBegin);
1960
1961 // Emit the full data.
1962 AT.Emit(Asm, SectionBegin, this);
1963}
1964
Eric Christopherb6dc8652012-11-27 22:43:45 +00001965// Emit namespace dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00001966void DwarfDebug::emitAccelNamespaces() {
1967 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1968 dwarf::DW_FORM_data4));
1969 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1970 E = CUMap.end(); I != E; ++I) {
1971 CompileUnit *TheCU = I->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00001972 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
1973 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00001974 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1975 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00001976 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00001977 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1978 DE = Entities.end(); DI != DE; ++DI)
1979 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00001980 }
1981 }
1982
1983 AT.FinalizeTable(Asm, "namespac");
1984 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
1985 .getDwarfAccelNamespaceSection());
1986 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
1987 Asm->OutStreamer.EmitLabel(SectionBegin);
1988
1989 // Emit the full data.
1990 AT.Emit(Asm, SectionBegin, this);
1991}
1992
Eric Christopherb6dc8652012-11-27 22:43:45 +00001993// Emit type dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00001994void DwarfDebug::emitAccelTypes() {
Eric Christopherc36145f2012-01-06 04:35:23 +00001995 std::vector<DwarfAccelTable::Atom> Atoms;
1996 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1997 dwarf::DW_FORM_data4));
1998 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTag,
1999 dwarf::DW_FORM_data2));
2000 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTypeFlags,
2001 dwarf::DW_FORM_data1));
2002 DwarfAccelTable AT(Atoms);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002003 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2004 E = CUMap.end(); I != E; ++I) {
2005 CompileUnit *TheCU = I->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002006 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2007 = TheCU->getAccelTypes();
2008 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002009 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2010 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00002011 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002012 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2013 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2014 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002015 }
2016 }
2017
2018 AT.FinalizeTable(Asm, "types");
2019 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2020 .getDwarfAccelTypesSection());
2021 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2022 Asm->OutStreamer.EmitLabel(SectionBegin);
2023
2024 // Emit the full data.
2025 AT.Emit(Asm, SectionBegin, this);
2026}
2027
Devang Patel193f7202009-11-24 01:14:22 +00002028void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00002029 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2030 E = CUMap.end(); I != E; ++I) {
2031 CompileUnit *TheCU = I->second;
Eric Christopher63701182011-11-07 09:18:35 +00002032 // Start the dwarf pubtypes section.
Devang Patel163a9f72010-05-10 22:49:55 +00002033 Asm->OutStreamer.SwitchSection(
2034 Asm->getObjFileLowering().getDwarfPubTypesSection());
2035 Asm->OutStreamer.AddComment("Length of Public Types Info");
2036 Asm->EmitLabelDifference(
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002037 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2038 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002039
Devang Patel163a9f72010-05-10 22:49:55 +00002040 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002041 TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002042
Devang Patel163a9f72010-05-10 22:49:55 +00002043 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
2044 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002045
Devang Patel163a9f72010-05-10 22:49:55 +00002046 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002047 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin",
2048 TheCU->getUniqueID()),
Devang Patel163a9f72010-05-10 22:49:55 +00002049 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002050
Devang Patel163a9f72010-05-10 22:49:55 +00002051 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002052 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end",
2053 TheCU->getUniqueID()),
2054 Asm->GetTempSymbol("info_begin",
2055 TheCU->getUniqueID()),
Devang Patel163a9f72010-05-10 22:49:55 +00002056 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002057
Devang Patel163a9f72010-05-10 22:49:55 +00002058 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
2059 for (StringMap<DIE*>::const_iterator
2060 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2061 const char *Name = GI->getKeyData();
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00002062 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002063
Devang Patel163a9f72010-05-10 22:49:55 +00002064 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
2065 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002066
Devang Patel163a9f72010-05-10 22:49:55 +00002067 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
Benjamin Kramer983c4572011-11-09 18:16:11 +00002068 // Emit the name with a terminating null byte.
Devang Patel163a9f72010-05-10 22:49:55 +00002069 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
2070 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002071
Devang Patel163a9f72010-05-10 22:49:55 +00002072 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00002073 Asm->EmitInt32(0);
Devang Patel163a9f72010-05-10 22:49:55 +00002074 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002075 TheCU->getUniqueID()));
Devang Patel193f7202009-11-24 01:14:22 +00002076 }
Devang Patel193f7202009-11-24 01:14:22 +00002077}
2078
Eric Christopherb6dc8652012-11-27 22:43:45 +00002079// Emit visible names into a debug str section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002080void DwarfDebug::emitDebugStr() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002081 // Check to see if it is worth the effort.
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002082 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002083
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002084 // Start the dwarf str section.
2085 Asm->OutStreamer.SwitchSection(
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002086 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002087
Chris Lattnerbc733f52010-03-13 02:17:42 +00002088 // Get all of the string pool entries and put them in an array by their ID so
2089 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002090 SmallVector<std::pair<unsigned,
Chris Lattnerbc733f52010-03-13 02:17:42 +00002091 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002092
Chris Lattnerbc733f52010-03-13 02:17:42 +00002093 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
2094 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
2095 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002096
Chris Lattnerbc733f52010-03-13 02:17:42 +00002097 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002098
Chris Lattnerbc733f52010-03-13 02:17:42 +00002099 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002100 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00002101 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002102
Benjamin Kramer983c4572011-11-09 18:16:11 +00002103 // Emit the string itself with a terminating null byte.
Benjamin Kramer0c45f7d2011-11-09 12:12:04 +00002104 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
2105 Entries[i].second->getKeyLength()+1),
2106 0/*addrspace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00002107 }
2108}
2109
Eric Christopherb6dc8652012-11-27 22:43:45 +00002110// Emit visible names into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002111void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00002112 if (DotDebugLocEntries.empty())
2113 return;
2114
Devang Patel6c3ea902011-02-04 22:57:18 +00002115 for (SmallVector<DotDebugLocEntry, 4>::iterator
2116 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2117 I != E; ++I) {
2118 DotDebugLocEntry &Entry = *I;
2119 if (I + 1 != DotDebugLocEntries.end())
2120 Entry.Merge(I+1);
2121 }
2122
Daniel Dunbar83320a02011-03-16 22:16:39 +00002123 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002124 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00002125 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002126 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00002127 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2128 unsigned index = 1;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002129 for (SmallVector<DotDebugLocEntry, 4>::iterator
2130 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00002131 I != E; ++I, ++index) {
Devang Patel6c3ea902011-02-04 22:57:18 +00002132 DotDebugLocEntry &Entry = *I;
2133 if (Entry.isMerged()) continue;
Devang Patelc3f5f782010-05-25 23:40:22 +00002134 if (Entry.isEmpty()) {
2135 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
2136 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel80250682010-05-26 23:55:23 +00002137 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00002138 } else {
2139 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
2140 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
Devang Patelc26f5442011-04-28 02:22:40 +00002141 DIVariable DV(Entry.Variable);
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002142 Asm->OutStreamer.AddComment("Loc expr size");
2143 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2144 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2145 Asm->EmitLabelDifference(end, begin, 2);
2146 Asm->OutStreamer.EmitLabel(begin);
Devang Patel80efd4e2011-07-08 16:49:43 +00002147 if (Entry.isInt()) {
Devang Patelc4329072011-06-01 22:03:25 +00002148 DIBasicType BTy(DV.getType());
2149 if (BTy.Verify() &&
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002150 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patelc4329072011-06-01 22:03:25 +00002151 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2152 Asm->OutStreamer.AddComment("DW_OP_consts");
2153 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Patel80efd4e2011-07-08 16:49:43 +00002154 Asm->EmitSLEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002155 } else {
2156 Asm->OutStreamer.AddComment("DW_OP_constu");
2157 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Patel80efd4e2011-07-08 16:49:43 +00002158 Asm->EmitULEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002159 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002160 } else if (Entry.isLocation()) {
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002161 if (!DV.hasComplexAddress())
Devang Patel80efd4e2011-07-08 16:49:43 +00002162 // Regular entry.
Devang Patelc26f5442011-04-28 02:22:40 +00002163 Asm->EmitDwarfRegOp(Entry.Loc);
Devang Patel80efd4e2011-07-08 16:49:43 +00002164 else {
2165 // Complex address entry.
2166 unsigned N = DV.getNumAddrElements();
2167 unsigned i = 0;
2168 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
2169 if (Entry.Loc.getOffset()) {
2170 i = 2;
2171 Asm->EmitDwarfRegOp(Entry.Loc);
2172 Asm->OutStreamer.AddComment("DW_OP_deref");
2173 Asm->EmitInt8(dwarf::DW_OP_deref);
2174 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2175 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2176 Asm->EmitSLEB128(DV.getAddrElement(1));
2177 } else {
2178 // If first address element is OpPlus then emit
2179 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
2180 MachineLocation Loc(Entry.Loc.getReg(), DV.getAddrElement(1));
2181 Asm->EmitDwarfRegOp(Loc);
2182 i = 2;
2183 }
2184 } else {
2185 Asm->EmitDwarfRegOp(Entry.Loc);
2186 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002187
Devang Patel80efd4e2011-07-08 16:49:43 +00002188 // Emit remaining complex address elements.
2189 for (; i < N; ++i) {
2190 uint64_t Element = DV.getAddrElement(i);
2191 if (Element == DIBuilder::OpPlus) {
2192 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2193 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher50120762012-05-08 18:56:00 +00002194 } else if (Element == DIBuilder::OpDeref) {
Eric Christophera80f2d12012-05-08 21:24:39 +00002195 if (!Entry.Loc.isReg())
Eric Christopher50120762012-05-08 18:56:00 +00002196 Asm->EmitInt8(dwarf::DW_OP_deref);
2197 } else
2198 llvm_unreachable("unknown Opcode found in complex address");
Devang Patel80efd4e2011-07-08 16:49:43 +00002199 }
Devang Patelc26f5442011-04-28 02:22:40 +00002200 }
Devang Patelc26f5442011-04-28 02:22:40 +00002201 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002202 // else ... ignore constant fp. There is not any good way to
2203 // to represent them here in dwarf.
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002204 Asm->OutStreamer.EmitLabel(end);
Devang Patelc3f5f782010-05-25 23:40:22 +00002205 }
2206 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002207}
2208
Eric Christopherb6dc8652012-11-27 22:43:45 +00002209// Emit visible names into a debug aranges section.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002210void DwarfDebug::emitDebugARanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002211 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002212 Asm->OutStreamer.SwitchSection(
2213 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002214}
2215
Eric Christopherb6dc8652012-11-27 22:43:45 +00002216// Emit visible names into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002217void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002218 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002219 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00002220 Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002221 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Pateleac9c072010-04-27 19:46:33 +00002222 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00002223 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00002224 I != E; ++I) {
2225 if (*I)
2226 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patelf2548ca2010-04-16 23:33:45 +00002227 else
Devang Pateleac9c072010-04-27 19:46:33 +00002228 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patelf2548ca2010-04-16 23:33:45 +00002229 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002230}
2231
Eric Christopherb6dc8652012-11-27 22:43:45 +00002232// Emit visible names into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002233void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002234 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00002235 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002236 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002237 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002238 }
2239}
2240
Eric Christopherb6dc8652012-11-27 22:43:45 +00002241// Emit inline info using following format.
2242// Section Header:
2243// 1. length of section
2244// 2. Dwarf version number
2245// 3. address size.
2246//
2247// Entries (one "entry" for each function that was inlined):
2248//
2249// 1. offset into __debug_str section for MIPS linkage name, if exists;
2250// otherwise offset into __debug_str for regular function name.
2251// 2. offset into __debug_str section for regular function name.
2252// 3. an unsigned LEB128 number indicating the number of distinct inlining
2253// instances for the function.
2254//
2255// The rest of the entry consists of a {die_offset, low_pc} pair for each
2256// inlined instance; the die_offset points to the inlined_subroutine die in the
2257// __debug_info section, and the low_pc is the starting address for the
2258// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002259void DwarfDebug::emitDebugInlineInfo() {
Eric Christopherb83e2bb2012-03-02 02:11:47 +00002260 if (!Asm->MAI->doesDwarfUseInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002261 return;
2262
Devang Patel163a9f72010-05-10 22:49:55 +00002263 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00002264 return;
2265
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002266 Asm->OutStreamer.SwitchSection(
2267 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00002268
Chris Lattner233f52b2010-03-09 23:52:58 +00002269 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00002270 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
2271 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00002272
Chris Lattnerc0215722010-04-04 19:25:43 +00002273 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002274
Chris Lattner233f52b2010-03-09 23:52:58 +00002275 Asm->OutStreamer.AddComment("Dwarf Version");
2276 Asm->EmitInt16(dwarf::DWARF_VERSION);
2277 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002278 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002279
Devang Patele9f8f5e2010-05-07 20:54:48 +00002280 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00002281 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002282
Devang Patele9f8f5e2010-05-07 20:54:48 +00002283 const MDNode *Node = *I;
2284 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002285 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00002286 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00002287 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00002288 StringRef LName = SP.getLinkageName();
2289 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00002290
Chris Lattner233f52b2010-03-09 23:52:58 +00002291 Asm->OutStreamer.AddComment("MIPS linkage name");
Eric Christopher50e26612012-03-02 01:57:52 +00002292 if (LName.empty())
2293 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
2294 else
Chris Lattner6189ed12010-04-04 23:25:33 +00002295 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
2296 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00002297
Chris Lattner233f52b2010-03-09 23:52:58 +00002298 Asm->OutStreamer.AddComment("Function name");
Chris Lattner6189ed12010-04-04 23:25:33 +00002299 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002300 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00002301
Devang Patel53bb5c92009-11-10 23:06:00 +00002302 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00002303 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00002304 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00002305 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00002306
Chris Lattner3f53c832010-04-04 18:52:31 +00002307 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00002308 Asm->OutStreamer.EmitSymbolValue(LI->first,
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002309 Asm->getDataLayout().getPointerSize(),0);
Bill Wendling94d04b82009-05-20 23:21:38 +00002310 }
2311 }
2312
Chris Lattnerc0215722010-04-04 19:25:43 +00002313 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002314}
Eric Christopher98e237f2012-11-30 23:59:06 +00002315
2316// DWARF5 Experimental Fission emitters.
2317
2318// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2319// DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2320// DW_AT_ranges_base, DW_AT_addr_base. If DW_AT_ranges is present,
2321// DW_AT_low_pc and DW_AT_high_pc are not used, and vice versa.
2322CompileUnit *DwarfDebug::constructFissionCU(const MDNode *N) {
2323 DICompileUnit DIUnit(N);
2324 StringRef FN = DIUnit.getFilename();
2325 CompilationDir = DIUnit.getDirectory();
Eric Christopher98e237f2012-11-30 23:59:06 +00002326
2327 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002328 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
2329 DIUnit.getLanguage(), Die, Asm, this);
Eric Christopher98e237f2012-11-30 23:59:06 +00002330 // FIXME: This should be the .dwo file.
2331 NewCU->addString(Die, dwarf::DW_AT_GNU_dwo_name, FN);
2332
2333 // FIXME: We also need DW_AT_addr_base and DW_AT_dwo_id.
2334
2335 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
2336 // into an entity.
2337 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
2338 // DW_AT_stmt_list is a offset of line number information for this
2339 // compile unit in debug_line section.
2340 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2341 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
2342 Asm->GetTempSymbol("section_line"));
2343 else
2344 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
2345
2346 if (!CompilationDir.empty())
2347 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
2348
2349 return NewCU;
2350}
2351
2352void DwarfDebug::emitFissionSkeletonCU(const MCSection *Section) {
2353 Asm->OutStreamer.SwitchSection(Section);
2354 DIE *Die = FissionCU->getCUDie();
2355
2356 // Emit the compile units header.
2357 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("skel_info_begin",
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002358 FissionCU->getUniqueID()));
Eric Christopher98e237f2012-11-30 23:59:06 +00002359
2360 // Emit size of content not including length itself
2361 unsigned ContentSize = Die->getSize() +
2362 sizeof(int16_t) + // DWARF version number
2363 sizeof(int32_t) + // Offset Into Abbrev. Section
2364 sizeof(int8_t); // Pointer Size (in bytes)
2365
2366 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2367 Asm->EmitInt32(ContentSize);
2368 Asm->OutStreamer.AddComment("DWARF version number");
2369 Asm->EmitInt16(dwarf::DWARF_VERSION);
2370 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
2371 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
2372 DwarfAbbrevSectionSym);
2373 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2374 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
2375
2376 emitDIE(Die);
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002377 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("skel_info_end",
2378 FissionCU->getUniqueID()));
Eric Christopher98e237f2012-11-30 23:59:06 +00002379
2380
2381}
2382
2383// Emit the .debug_info.dwo section for fission. This contains the compile
2384// units that would normally be in debug_info.
2385void DwarfDebug::emitDebugInfoDWO() {
2386 assert(useDwarfFission() && "Got fission?");
2387 emitCompileUnits(Asm->getObjFileLowering().getDwarfInfoDWOSection());
2388}