blob: c4c9d3f2b3784e3ddb98dfd4224b3cce5e8dd121 [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"
Bill Wendling57fbba42010-04-05 22:59:21 +000019#include "llvm/Constants.h"
Bill Wendling0bcbd1d2012-06-28 00:05:13 +000020#include "llvm/DebugInfo.h"
Bill Wendling16eeb6f2012-06-29 08:32:07 +000021#include "llvm/DIBuilder.h"
Bill Wendling0310d762009-05-15 09:23:25 +000022#include "llvm/Module.h"
Devang Patele449d1f2011-01-20 00:02:16 +000023#include "llvm/Instructions.h"
David Greeneb2c66fc2009-08-19 21:52:55 +000024#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling0310d762009-05-15 09:23:25 +000025#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000026#include "llvm/MC/MCAsmInfo.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000027#include "llvm/MC/MCSection.h"
Chris Lattner6c2f9e12009-08-19 05:49:37 +000028#include "llvm/MC/MCStreamer.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000029#include "llvm/MC/MCSymbol.h"
Micah Villmow3574eca2012-10-08 16:38:25 +000030#include "llvm/DataLayout.h"
Anton Korobeynikov16c29b52011-01-10 12:39:04 +000031#include "llvm/Target/TargetFrameLowering.h"
Chris Lattnerf0144122009-07-28 03:13:23 +000032#include "llvm/Target/TargetLoweringObjectFile.h"
Chris Lattner9d1c1ad2010-04-04 18:06:11 +000033#include "llvm/Target/TargetMachine.h"
Chris Lattnerf0144122009-07-28 03:13:23 +000034#include "llvm/Target/TargetRegisterInfo.h"
Devang Patel2a4a3b72010-04-19 19:14:02 +000035#include "llvm/Target/TargetOptions.h"
Devang Patel9a31f0f2010-10-25 20:45:32 +000036#include "llvm/ADT/Statistic.h"
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +000037#include "llvm/ADT/STLExtras.h"
Chris Lattner23132b12009-08-24 03:52:50 +000038#include "llvm/ADT/StringExtras.h"
Bill Wendling16eeb6f2012-06-29 08:32:07 +000039#include "llvm/ADT/Triple.h"
Devang Pateleac9c072010-04-27 19:46:33 +000040#include "llvm/Support/CommandLine.h"
Daniel Dunbar6e4bdfc2009-10-13 06:47:08 +000041#include "llvm/Support/Debug.h"
42#include "llvm/Support/ErrorHandling.h"
Devang Patel3139fcf2010-01-26 21:39:14 +000043#include "llvm/Support/ValueHandle.h"
Chris Lattner0ad9c912010-01-22 22:09:00 +000044#include "llvm/Support/FormattedStream.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000045#include "llvm/Support/Timer.h"
Michael J. Spencer1f6efa32010-11-29 18:16:10 +000046#include "llvm/Support/Path.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),
Eric Christopher6635cad2012-08-01 18:19:01 +0000159 PrevLabel(NULL) {
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();
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000618 unsigned ID = getOrCreateSourceID(FN, CompilationDir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000619
620 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopheredf8bc82012-09-10 23:34:00 +0000621 CompileUnit *NewCU = new CompileUnit(ID, DIUnit.getLanguage(), Die,
622 Asm, this);
Nick Lewycky390c40d2011-10-27 06:44:11 +0000623 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patel3cbee302011-04-12 22:53:02 +0000624 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
625 DIUnit.getLanguage());
Nick Lewycky390c40d2011-10-27 06:44:11 +0000626 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christopher6635cad2012-08-01 18:19:01 +0000627 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
628 // into an entity.
629 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Devang Patel4a602ca2010-03-22 23:11:36 +0000630 // DW_AT_stmt_list is a offset of line number information for this
Devang Patelaf608bd2010-08-24 00:06:12 +0000631 // compile unit in debug_line section.
Rafael Espindola2241e512012-06-22 13:24:07 +0000632 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Rafael Espindola597a7662011-05-04 17:44:06 +0000633 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Devang Patel3cbee302011-04-12 22:53:02 +0000634 Asm->GetTempSymbol("section_line"));
Devang Patelae84d5b2010-08-31 23:50:19 +0000635 else
Devang Patel3cbee302011-04-12 22:53:02 +0000636 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000637
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000638 if (!CompilationDir.empty())
639 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000640 if (DIUnit.isOptimized())
Eric Christopher873cf0a2012-08-24 01:14:27 +0000641 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000642
Devang Patel65dbc902009-11-25 17:36:49 +0000643 StringRef Flags = DIUnit.getFlags();
644 if (!Flags.empty())
Nick Lewycky390c40d2011-10-27 06:44:11 +0000645 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000646
Nick Lewyckyd5d52132011-10-17 23:27:36 +0000647 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patel3cbee302011-04-12 22:53:02 +0000648 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000649 dwarf::DW_FORM_data1, RVer);
650
Devang Patel163a9f72010-05-10 22:49:55 +0000651 if (!FirstCU)
652 FirstCU = NewCU;
Eric Christopher98e237f2012-11-30 23:59:06 +0000653 if (useDwarfFission() && !FissionCU)
654 FissionCU = constructFissionCU(N);
655
Devang Patel163a9f72010-05-10 22:49:55 +0000656 CUMap.insert(std::make_pair(N, NewCU));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000657 return NewCU;
Devang Patel163a9f72010-05-10 22:49:55 +0000658}
659
Eric Christopherb6dc8652012-11-27 22:43:45 +0000660// Construct subprogram DIE.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000661void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
Devang Patel3655a212011-08-15 23:36:40 +0000662 const MDNode *N) {
Rafael Espindolab0527282011-11-04 19:00:29 +0000663 CompileUnit *&CURef = SPMap[N];
664 if (CURef)
665 return;
666 CURef = TheCU;
667
Devang Patele4b27562009-08-28 23:24:31 +0000668 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000669 if (!SP.isDefinition())
670 // This is a method declaration which will be handled while constructing
671 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +0000672 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000673
Devang Pateldbc64af2011-08-15 17:24:54 +0000674 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings639336e2010-04-06 21:38:29 +0000675
676 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +0000677 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000678
679 // Add to context owner.
Devang Patel3cbee302011-04-12 22:53:02 +0000680 TheCU->addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +0000681
Devang Patel13e16b62009-06-26 01:49:18 +0000682 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000683}
684
Eric Christopherb6dc8652012-11-27 22:43:45 +0000685// Collect debug info from named mdnodes such as llvm.dbg.enum and llvm.dbg.ty.
Eric Christopherc4639d62012-11-19 22:42:15 +0000686void DwarfDebug::collectInfoFromNamedMDNodes(const Module *M) {
Devang Patel94c7ddb2011-08-16 22:09:43 +0000687 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.sp"))
688 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
689 const MDNode *N = NMD->getOperand(i);
690 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
691 constructSubprogramDIE(CU, N);
692 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000693
Devang Patel94c7ddb2011-08-16 22:09:43 +0000694 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.gv"))
695 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
696 const MDNode *N = NMD->getOperand(i);
697 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
Devang Patel28bea082011-08-18 23:17:55 +0000698 CU->createGlobalVariableDIE(N);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000699 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000700
Devang Patel02e603f2011-08-15 23:47:24 +0000701 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
702 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
703 DIType Ty(NMD->getOperand(i));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000704 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
705 CU->getOrCreateTypeDIE(Ty);
Devang Patel02e603f2011-08-15 23:47:24 +0000706 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000707
Devang Patel02e603f2011-08-15 23:47:24 +0000708 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
709 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
710 DIType Ty(NMD->getOperand(i));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000711 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
712 CU->getOrCreateTypeDIE(Ty);
Devang Patel02e603f2011-08-15 23:47:24 +0000713 }
714}
715
Eric Christopherb6dc8652012-11-27 22:43:45 +0000716// Collect debug info using DebugInfoFinder.
717// FIXME - Remove this when dragonegg switches to DIBuilder.
Eric Christopherc4639d62012-11-19 22:42:15 +0000718bool DwarfDebug::collectLegacyDebugInfo(const Module *M) {
Devang Patel02e603f2011-08-15 23:47:24 +0000719 DebugInfoFinder DbgFinder;
720 DbgFinder.processModule(*M);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000721
Devang Patel02e603f2011-08-15 23:47:24 +0000722 bool HasDebugInfo = false;
723 // Scan all the compile-units to see if there are any marked as the main
724 // unit. If not, we do not generate debug info.
725 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
726 E = DbgFinder.compile_unit_end(); I != E; ++I) {
727 if (DICompileUnit(*I).isMain()) {
728 HasDebugInfo = true;
729 break;
730 }
731 }
732 if (!HasDebugInfo) return false;
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000733
Devang Patel02e603f2011-08-15 23:47:24 +0000734 // Create all the compile unit DIEs.
735 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
736 E = DbgFinder.compile_unit_end(); I != E; ++I)
737 constructCompileUnit(*I);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000738
Devang Patel02e603f2011-08-15 23:47:24 +0000739 // Create DIEs for each global variable.
740 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
741 E = DbgFinder.global_variable_end(); I != E; ++I) {
742 const MDNode *N = *I;
Devang Patel94c7ddb2011-08-16 22:09:43 +0000743 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
Devang Patel28bea082011-08-18 23:17:55 +0000744 CU->createGlobalVariableDIE(N);
Devang Patel02e603f2011-08-15 23:47:24 +0000745 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000746
Devang Patel02e603f2011-08-15 23:47:24 +0000747 // Create DIEs for each subprogram.
748 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
749 E = DbgFinder.subprogram_end(); I != E; ++I) {
750 const MDNode *N = *I;
Devang Patel94c7ddb2011-08-16 22:09:43 +0000751 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
752 constructSubprogramDIE(CU, N);
Devang Patel02e603f2011-08-15 23:47:24 +0000753 }
754
755 return HasDebugInfo;
756}
757
Eric Christopherb6dc8652012-11-27 22:43:45 +0000758// Emit all Dwarf sections that should come prior to the content. Create
759// global DIEs and emit initial debug info sections. This is invoked by
760// the target AsmPrinter.
Eric Christopherc4639d62012-11-19 22:42:15 +0000761void DwarfDebug::beginModule() {
Devang Pateleac9c072010-04-27 19:46:33 +0000762 if (DisableDebugInfoPrinting)
763 return;
764
Eric Christopherc4639d62012-11-19 22:42:15 +0000765 const Module *M = MMI->getModule();
766
Nick Lewycky3bbb6f72011-07-29 03:49:23 +0000767 // If module has named metadata anchors then use them, otherwise scan the
768 // module using debug info finder to collect debug info.
Devang Patel30692ab2011-05-03 16:45:22 +0000769 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
770 if (CU_Nodes) {
Devang Patel94c7ddb2011-08-16 22:09:43 +0000771 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
772 DICompileUnit CUNode(CU_Nodes->getOperand(i));
773 CompileUnit *CU = constructCompileUnit(CUNode);
774 DIArray GVs = CUNode.getGlobalVariables();
775 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
Devang Patel28bea082011-08-18 23:17:55 +0000776 CU->createGlobalVariableDIE(GVs.getElement(i));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000777 DIArray SPs = CUNode.getSubprograms();
778 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
779 constructSubprogramDIE(CU, SPs.getElement(i));
780 DIArray EnumTypes = CUNode.getEnumTypes();
781 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
782 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
783 DIArray RetainedTypes = CUNode.getRetainedTypes();
784 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
785 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
786 }
Devang Patel02e603f2011-08-15 23:47:24 +0000787 } else if (!collectLegacyDebugInfo(M))
788 return;
Devang Patel30692ab2011-05-03 16:45:22 +0000789
Devang Patel02e603f2011-08-15 23:47:24 +0000790 collectInfoFromNamedMDNodes(M);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000791
Chris Lattnerd850ac72010-04-05 02:19:28 +0000792 // Tell MMI that we have debug info.
793 MMI->setDebugInfoAvailability(true);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000794
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000795 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +0000796 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000797}
798
Eric Christopher4117bec2012-11-22 00:59:49 +0000799// Attach DW_AT_inline attribute with inlined subprogram DIEs.
800void DwarfDebug::computeInlinedDIEs() {
Devang Patel53bb5c92009-11-10 23:06:00 +0000801 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
802 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000803 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patel53bb5c92009-11-10 23:06:00 +0000804 DIE *ISP = *AI;
Devang Patel3cbee302011-04-12 22:53:02 +0000805 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +0000806 }
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000807 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000808 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000809 DIE *ISP = AI->second;
810 if (InlinedSubprogramDIEs.count(ISP))
811 continue;
812 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
813 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000814}
815
816// Collect info for variables that were optimized out.
817void DwarfDebug::collectDeadVariables() {
818 const Module *M = MMI->getModule();
819 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
820
821 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
822 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
823 DICompileUnit TheCU(CU_Nodes->getOperand(i));
824 DIArray Subprograms = TheCU.getSubprograms();
825 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopherbdab8002012-11-27 00:13:51 +0000826 DISubprogram SP(Subprograms.getElement(i));
827 if (ProcessedSPNodes.count(SP) != 0) continue;
828 if (!SP.Verify()) continue;
829 if (!SP.isDefinition()) continue;
830 DIArray Variables = SP.getVariables();
831 if (Variables.getNumElements() == 0) continue;
Eric Christopher4117bec2012-11-22 00:59:49 +0000832
Eric Christopherbdab8002012-11-27 00:13:51 +0000833 LexicalScope *Scope =
834 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
835 DeadFnScopeMap[SP] = Scope;
Eric Christopher4117bec2012-11-22 00:59:49 +0000836
Eric Christopherbdab8002012-11-27 00:13:51 +0000837 // Construct subprogram DIE and add variables DIEs.
838 CompileUnit *SPCU = CUMap.lookup(TheCU);
839 assert(SPCU && "Unable to find Compile Unit!");
840 constructSubprogramDIE(SPCU, SP);
841 DIE *ScopeDIE = SPCU->getDIE(SP);
842 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
843 DIVariable DV(Variables.getElement(vi));
844 if (!DV.Verify()) continue;
845 DbgVariable *NewVar = new DbgVariable(DV, NULL);
846 if (DIE *VariableDIE =
847 SPCU->constructVariableDIE(NewVar, Scope->isAbstractScope()))
848 ScopeDIE->addChild(VariableDIE);
849 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000850 }
851 }
852 }
853 DeleteContainerSeconds(DeadFnScopeMap);
854}
855
856void DwarfDebug::finalizeModuleInfo() {
857 // Collect info for variables that were optimized out.
858 collectDeadVariables();
859
860 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
861 computeInlinedDIEs();
Devang Patel53bb5c92009-11-10 23:06:00 +0000862
Eric Christopher6635cad2012-08-01 18:19:01 +0000863 // Emit DW_AT_containing_type attribute to connect types with their
864 // vtable holding type.
Devang Pateldbc64af2011-08-15 17:24:54 +0000865 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000866 CUE = CUMap.end(); CUI != CUE; ++CUI) {
Devang Pateldbc64af2011-08-15 17:24:54 +0000867 CompileUnit *TheCU = CUI->second;
868 TheCU->constructContainingTypeDIEs();
Devang Patel5d11eb02009-12-03 19:11:07 +0000869 }
870
Eric Christopher4117bec2012-11-22 00:59:49 +0000871 // Compute DIE offsets and sizes.
872 computeSizeAndOffsets();
873}
874
875void DwarfDebug::endSections() {
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000876 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +0000877 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +0000878 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +0000879 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +0000880 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000881
882 // End text sections.
Benjamin Kramerb4c9d9c2012-10-31 13:45:49 +0000883 for (unsigned I = 0, E = SectionMap.size(); I != E; ++I) {
884 Asm->OutStreamer.SwitchSection(SectionMap[I]);
885 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", I+1));
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000886 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000887}
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000888
Eric Christopherb6dc8652012-11-27 22:43:45 +0000889// Emit all Dwarf sections that should come after the content.
Eric Christopher4117bec2012-11-22 00:59:49 +0000890void DwarfDebug::endModule() {
891
892 if (!FirstCU) return;
893
894 // End any existing sections.
895 // TODO: Does this need to happen?
896 endSections();
897
898 // Finalize the debug info for the module.
899 finalizeModuleInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000900
Eric Christopher97c34722012-11-19 19:43:59 +0000901 // Emit initial sections.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000902 emitSectionLabels();
Eric Christopher97c34722012-11-19 19:43:59 +0000903
Eric Christopher42885022012-11-27 22:43:42 +0000904 if (!useDwarfFission()) {
905 // Emit all the DIEs into a debug info section.
906 emitDebugInfo();
Eric Christopher74802f72012-11-27 00:41:54 +0000907
Eric Christopher42885022012-11-27 22:43:42 +0000908 // Corresponding abbreviations into a abbrev section.
909 emitAbbreviations();
910
911 // Emit info into a debug loc section.
912 emitDebugLoc();
913
914 // Emit info into a debug aranges section.
915 emitDebugARanges();
916
917 // Emit info into a debug ranges section.
918 emitDebugRanges();
919
920 // Emit info into a debug macinfo section.
921 emitDebugMacInfo();
922
923 // Emit inline info.
924 // TODO: When we don't need the option anymore we
925 // can remove all of the code that this section
926 // depends upon.
927 if (useDarwinGDBCompat())
928 emitDebugInlineInfo();
929 } else {
930 // TODO: Fill this in for Fission sections and separate
931 // out information into new sections.
932
Eric Christopher98e237f2012-11-30 23:59:06 +0000933 // Emit the debug info section and compile units.
Eric Christopher42885022012-11-27 22:43:42 +0000934 emitDebugInfo();
Eric Christopher98e237f2012-11-30 23:59:06 +0000935 emitDebugInfoDWO();
Eric Christopher42885022012-11-27 22:43:42 +0000936
937 // Corresponding abbreviations into a abbrev section.
938 emitAbbreviations();
939
940 // Emit info into a debug loc section.
941 emitDebugLoc();
942
943 // Emit info into a debug aranges section.
944 emitDebugARanges();
945
946 // Emit info into a debug ranges section.
947 emitDebugRanges();
948
949 // Emit info into a debug macinfo section.
950 emitDebugMacInfo();
951
952 // Emit inline info.
953 // TODO: When we don't need the option anymore we
954 // can remove all of the code that this section
955 // depends upon.
956 if (useDarwinGDBCompat())
957 emitDebugInlineInfo();
958 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000959
Eric Christopher9d9f5a52012-08-23 07:32:06 +0000960 // Emit info into the dwarf accelerator table sections.
Eric Christopher20f47ab2012-08-23 22:36:40 +0000961 if (useDwarfAccelTables()) {
Eric Christopher09ac3d82011-11-07 09:24:32 +0000962 emitAccelNames();
963 emitAccelObjC();
964 emitAccelNamespaces();
965 emitAccelTypes();
966 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000967
Devang Patel193f7202009-11-24 01:14:22 +0000968 // Emit info into a debug pubtypes section.
Eric Christopher360f0062012-08-23 07:10:56 +0000969 // TODO: When we don't need the option anymore we can
970 // remove all of the code that adds to the table.
Eric Christopher20f47ab2012-08-23 22:36:40 +0000971 if (useDarwinGDBCompat())
Eric Christopher360f0062012-08-23 07:10:56 +0000972 emitDebugPubTypes();
Devang Patel193f7202009-11-24 01:14:22 +0000973
Eric Christopher42885022012-11-27 22:43:42 +0000974 // Finally emit string information into a string table.
Eric Christopherfcdbecb2012-11-27 06:49:23 +0000975 emitDebugStr();
976
Devang Patele9a1cca2010-08-02 17:32:15 +0000977 // clean up.
Devang Patel94c7ddb2011-08-16 22:09:43 +0000978 SPMap.clear();
Devang Patel163a9f72010-05-10 22:49:55 +0000979 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
980 E = CUMap.end(); I != E; ++I)
981 delete I->second;
Eric Christopher98e237f2012-11-30 23:59:06 +0000982 // Reset these for the next Module if we have one.
983 FirstCU = NULL;
984 FissionCU = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000985}
986
Eric Christopherb6dc8652012-11-27 22:43:45 +0000987// Find abstract variable, if any, associated with Var.
Devang Patelb549bcf2011-08-10 21:50:54 +0000988DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattnerde4845c2010-04-02 19:42:39 +0000989 DebugLoc ScopeLoc) {
Devang Patelb549bcf2011-08-10 21:50:54 +0000990 LLVMContext &Ctx = DV->getContext();
991 // More then one inlined variable corresponds to one abstract variable.
992 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patel2db49d72010-05-07 18:11:54 +0000993 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +0000994 if (AbsDbgVariable)
995 return AbsDbgVariable;
996
Devang Patelbf47fdb2011-08-10 20:55:27 +0000997 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +0000998 if (!Scope)
999 return NULL;
1000
Devang Patel5a1a67c2011-08-15 19:01:20 +00001001 AbsDbgVariable = new DbgVariable(Var, NULL);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001002 addScopeVariable(Scope, AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00001003 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00001004 return AbsDbgVariable;
1005}
1006
Eric Christopherb6dc8652012-11-27 22:43:45 +00001007// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel0478c152011-03-01 22:58:55 +00001008bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patelbf47fdb2011-08-10 20:55:27 +00001009 DbgVariable *Var, LexicalScope *Scope) {
1010 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +00001011 return false;
1012 DIVariable DV = Var->getVariable();
1013 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1014 return false;
1015 unsigned ArgNo = DV.getArgNumber();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001016 if (ArgNo == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001017 return false;
1018
Devang Patelcb3a6572011-03-03 20:02:02 +00001019 size_t Size = CurrentFnArguments.size();
1020 if (Size == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001021 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patelbbd0f452011-03-03 21:49:41 +00001022 // llvm::Function argument size is not good indicator of how many
Devang Patel6f676be2011-03-03 20:08:10 +00001023 // arguments does the function have at source level.
1024 if (ArgNo > Size)
Devang Patelcb3a6572011-03-03 20:02:02 +00001025 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel0478c152011-03-01 22:58:55 +00001026 CurrentFnArguments[ArgNo - 1] = Var;
1027 return true;
1028}
1029
Eric Christopherb6dc8652012-11-27 22:43:45 +00001030// Collect variable information from side table maintained by MMI.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001031void
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001032DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patelee432862010-05-20 19:57:06 +00001033 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patele717faa2009-10-06 01:26:37 +00001034 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1035 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1036 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00001037 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00001038 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00001039 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00001040 DIVariable DV(Var);
1041 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00001042
Devang Patelbf47fdb2011-08-10 20:55:27 +00001043 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001044
Devang Patelfb0ee432009-11-10 23:20:04 +00001045 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00001046 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00001047 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00001048
Devang Patel26c1e562010-05-20 16:36:41 +00001049 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001050 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable);
Devang Patelff9dd0a2011-08-15 21:24:36 +00001051 RegVar->setFrameIndex(VP.first);
Devang Patel0478c152011-03-01 22:58:55 +00001052 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001053 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001054 if (AbsDbgVariable)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001055 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patele717faa2009-10-06 01:26:37 +00001056 }
Devang Patelee432862010-05-20 19:57:06 +00001057}
Devang Patel90a48ad2010-03-15 18:33:46 +00001058
Eric Christopherb6dc8652012-11-27 22:43:45 +00001059// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1060// defined reg.
Devang Patelc3f5f782010-05-25 23:40:22 +00001061static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001062 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001063 return MI->getNumOperands() == 3 &&
1064 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
1065 MI->getOperand(1).isImm() && MI->getOperand(1).getImm() == 0;
Devang Patelc3f5f782010-05-25 23:40:22 +00001066}
1067
Eric Christopherb6dc8652012-11-27 22:43:45 +00001068// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001069static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1070 const MCSymbol *FLabel,
Devang Patel90b40412011-07-08 17:09:57 +00001071 const MCSymbol *SLabel,
1072 const MachineInstr *MI) {
1073 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1074
1075 if (MI->getNumOperands() != 3) {
1076 MachineLocation MLoc = Asm->getDebugValueLocation(MI);
1077 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1078 }
1079 if (MI->getOperand(0).isReg() && MI->getOperand(1).isImm()) {
1080 MachineLocation MLoc;
1081 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
1082 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1083 }
1084 if (MI->getOperand(0).isImm())
1085 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1086 if (MI->getOperand(0).isFPImm())
1087 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1088 if (MI->getOperand(0).isCImm())
1089 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1090
Craig Topper5e25ee82012-02-05 08:31:47 +00001091 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel90b40412011-07-08 17:09:57 +00001092}
1093
Eric Christopherb6dc8652012-11-27 22:43:45 +00001094// Find variables for each lexical scope.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001095void
Devang Patel78e127d2010-06-25 22:07:34 +00001096DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1097 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00001098
Eric Christopherb6dc8652012-11-27 22:43:45 +00001099 // collection info from MMI table.
Devang Patelee432862010-05-20 19:57:06 +00001100 collectVariableInfoFromMMITable(MF, Processed);
1101
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001102 for (SmallVectorImpl<const MDNode*>::const_iterator
1103 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1104 ++UVI) {
1105 const MDNode *Var = *UVI;
1106 if (Processed.count(Var))
Devang Patelee432862010-05-20 19:57:06 +00001107 continue;
1108
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001109 // History contains relevant DBG_VALUE instructions for Var and instructions
1110 // clobbering it.
1111 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1112 if (History.empty())
1113 continue;
1114 const MachineInstr *MInsn = History.front();
Devang Patelc3f5f782010-05-25 23:40:22 +00001115
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001116 DIVariable DV(Var);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001117 LexicalScope *Scope = NULL;
Devang Pateld8720f42010-05-27 20:25:04 +00001118 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1119 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001120 Scope = LScopes.getCurrentFunctionScope();
Devang Patel40c7e412011-07-20 22:18:50 +00001121 else {
1122 if (DV.getVersion() <= LLVMDebugVersion9)
Devang Patelbf47fdb2011-08-10 20:55:27 +00001123 Scope = LScopes.findLexicalScope(MInsn->getDebugLoc());
Devang Patel40c7e412011-07-20 22:18:50 +00001124 else {
1125 if (MDNode *IA = DV.getInlinedAt())
Devang Patelbf47fdb2011-08-10 20:55:27 +00001126 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
Devang Patel40c7e412011-07-20 22:18:50 +00001127 else
Devang Patelbf47fdb2011-08-10 20:55:27 +00001128 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel40c7e412011-07-20 22:18:50 +00001129 }
1130 }
Devang Patelee432862010-05-20 19:57:06 +00001131 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00001132 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00001133 continue;
1134
1135 Processed.insert(DV);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001136 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel5a1a67c2011-08-15 19:01:20 +00001137 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
1138 DbgVariable *RegVar = new DbgVariable(DV, AbsVar);
Devang Patel0478c152011-03-01 22:58:55 +00001139 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001140 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001141 if (AbsVar)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001142 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001143
Eric Christopherc56e3f02012-10-08 20:48:54 +00001144 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001145 if (History.size() <= 1 || (History.size() == 2 &&
1146 MInsn->isIdenticalTo(History.back()))) {
Devang Patelff9dd0a2011-08-15 21:24:36 +00001147 RegVar->setMInsn(MInsn);
Devang Patelc3f5f782010-05-25 23:40:22 +00001148 continue;
1149 }
1150
1151 // handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001152 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001153
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001154 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1155 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1156 const MachineInstr *Begin = *HI;
1157 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesene17232e2011-03-22 00:21:41 +00001158
Devang Patel4ada1d72011-06-01 23:00:17 +00001159 // Check if DBG_VALUE is truncating a range.
1160 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1161 && !Begin->getOperand(0).getReg())
1162 continue;
1163
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001164 // Compute the range for a register location.
1165 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1166 const MCSymbol *SLabel = 0;
1167
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001168 if (HI + 1 == HE)
1169 // If Begin is the last instruction in History then its value is valid
Chris Lattner7a2bdde2011-04-15 05:18:47 +00001170 // until the end of the function.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001171 SLabel = FunctionEndSym;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001172 else {
1173 const MachineInstr *End = HI[1];
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001174 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel476df5f2011-07-07 21:44:42 +00001175 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001176 if (End->isDebugValue())
1177 SLabel = getLabelBeforeInsn(End);
1178 else {
1179 // End is a normal instruction clobbering the range.
1180 SLabel = getLabelAfterInsn(End);
1181 assert(SLabel && "Forgot label after clobber instruction");
1182 ++HI;
1183 }
1184 }
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001185
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001186 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopherabbb2002011-12-16 23:42:31 +00001187 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1188 Begin));
Devang Patelc3f5f782010-05-25 23:40:22 +00001189 }
1190 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00001191 }
Devang Patel98e1cac2010-05-14 21:01:35 +00001192
1193 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001194 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1195 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1196 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1197 DIVariable DV(Variables.getElement(i));
1198 if (!DV || !DV.Verify() || !Processed.insert(DV))
1199 continue;
1200 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1201 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel98e1cac2010-05-14 21:01:35 +00001202 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001203}
Devang Patel98e1cac2010-05-14 21:01:35 +00001204
Eric Christopherb6dc8652012-11-27 22:43:45 +00001205// Return Label preceding the instruction.
Devang Patelc3f5f782010-05-25 23:40:22 +00001206const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001207 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1208 assert(Label && "Didn't insert label before instruction");
1209 return Label;
Devang Patelc3f5f782010-05-25 23:40:22 +00001210}
1211
Eric Christopherb6dc8652012-11-27 22:43:45 +00001212// Return Label immediately following the instruction.
Devang Patelc3f5f782010-05-25 23:40:22 +00001213const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001214 return LabelsAfterInsn.lookup(MI);
Devang Patele717faa2009-10-06 01:26:37 +00001215}
1216
Eric Christopherb6dc8652012-11-27 22:43:45 +00001217// Process beginning of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001218void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001219 // Check if source location changes, but ignore DBG_VALUE locations.
1220 if (!MI->isDebugValue()) {
1221 DebugLoc DL = MI->getDebugLoc();
1222 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopher60b35f42012-04-05 20:39:05 +00001223 unsigned Flags = 0;
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001224 PrevInstLoc = DL;
Devang Patel4243e672011-05-11 19:22:19 +00001225 if (DL == PrologEndLoc) {
1226 Flags |= DWARF2_FLAG_PROLOGUE_END;
1227 PrologEndLoc = DebugLoc();
1228 }
Eric Christopher60b35f42012-04-05 20:39:05 +00001229 if (PrologEndLoc.isUnknown())
1230 Flags |= DWARF2_FLAG_IS_STMT;
1231
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001232 if (!DL.isUnknown()) {
1233 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel4243e672011-05-11 19:22:19 +00001234 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001235 } else
Devang Patel4243e672011-05-11 19:22:19 +00001236 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001237 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001238 }
Devang Patelaead63c2010-03-29 22:59:58 +00001239
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001240 // Insert labels where requested.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001241 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1242 LabelsBeforeInsn.find(MI);
1243
1244 // No label needed.
1245 if (I == LabelsBeforeInsn.end())
1246 return;
1247
1248 // Label already assigned.
1249 if (I->second)
Devang Patelb2b31a62010-05-26 19:37:24 +00001250 return;
Devang Patel553881b2010-03-29 17:20:31 +00001251
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001252 if (!PrevLabel) {
Devang Patel77051f52010-05-26 21:23:46 +00001253 PrevLabel = MMI->getContext().CreateTempSymbol();
1254 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00001255 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001256 I->second = PrevLabel;
Devang Patel0d20ac82009-10-06 01:50:42 +00001257}
1258
Eric Christopherb6dc8652012-11-27 22:43:45 +00001259// Process end of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001260void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001261 // Don't create a new label after DBG_VALUE instructions.
1262 // They don't generate code.
1263 if (!MI->isDebugValue())
1264 PrevLabel = 0;
1265
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001266 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1267 LabelsAfterInsn.find(MI);
1268
1269 // No label needed.
1270 if (I == LabelsAfterInsn.end())
1271 return;
1272
1273 // Label already assigned.
1274 if (I->second)
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001275 return;
1276
1277 // We need a label after this instruction.
1278 if (!PrevLabel) {
1279 PrevLabel = MMI->getContext().CreateTempSymbol();
1280 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel1c246352010-04-08 16:50:29 +00001281 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001282 I->second = PrevLabel;
Devang Patel53bb5c92009-11-10 23:06:00 +00001283}
1284
Eric Christopherb6dc8652012-11-27 22:43:45 +00001285// Each LexicalScope has first instruction and last instruction to mark
1286// beginning and end of a scope respectively. Create an inverse map that list
1287// scopes starts (and ends) with an instruction. One instruction may start (or
1288// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00001289void DwarfDebug::identifyScopeMarkers() {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001290 SmallVector<LexicalScope *, 4> WorkList;
1291 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel42aafd72010-01-20 02:05:23 +00001292 while (!WorkList.empty()) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001293 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001294
Devang Patelbf47fdb2011-08-10 20:55:27 +00001295 const SmallVector<LexicalScope *, 4> &Children = S->getChildren();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001296 if (!Children.empty())
Devang Patelbf47fdb2011-08-10 20:55:27 +00001297 for (SmallVector<LexicalScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00001298 SE = Children.end(); SI != SE; ++SI)
1299 WorkList.push_back(*SI);
1300
Devang Patel53bb5c92009-11-10 23:06:00 +00001301 if (S->isAbstractScope())
1302 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001303
Devang Patelbf47fdb2011-08-10 20:55:27 +00001304 const SmallVector<InsnRange, 4> &Ranges = S->getRanges();
Devang Pateleac9c072010-04-27 19:46:33 +00001305 if (Ranges.empty())
1306 continue;
Devang Patelbf47fdb2011-08-10 20:55:27 +00001307 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +00001308 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001309 assert(RI->first && "InsnRange does not have first instruction!");
1310 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001311 requestLabelBeforeInsn(RI->first);
1312 requestLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001313 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001314 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001315}
1316
Eric Christopherb6dc8652012-11-27 22:43:45 +00001317// Get MDNode for DebugLoc's scope.
Devang Patela3f48672011-05-09 22:14:49 +00001318static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1319 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1320 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1321 return DL.getScope(Ctx);
1322}
1323
Eric Christopherb6dc8652012-11-27 22:43:45 +00001324// Walk up the scope chain of given debug loc and find line number info
1325// for the function.
Devang Patel4243e672011-05-11 19:22:19 +00001326static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1327 const MDNode *Scope = getScopeNode(DL, Ctx);
1328 DISubprogram SP = getDISubprogram(Scope);
Eric Christopher6126a1e2012-04-03 00:43:49 +00001329 if (SP.Verify()) {
1330 // Check for number of operands since the compatibility is
1331 // cheap here.
Eric Christopherfa5b0502012-04-03 17:55:42 +00001332 if (SP->getNumOperands() > 19)
Eric Christopher6126a1e2012-04-03 00:43:49 +00001333 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1334 else
1335 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1336 }
1337
Devang Patel4243e672011-05-11 19:22:19 +00001338 return DebugLoc();
1339}
1340
Eric Christopherb6dc8652012-11-27 22:43:45 +00001341// Gather pre-function debug information. Assumes being called immediately
1342// after the function entry point has been emitted.
Chris Lattnereec791a2010-01-26 23:18:02 +00001343void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00001344 if (!MMI->hasDebugInfo()) return;
Devang Patelbf47fdb2011-08-10 20:55:27 +00001345 LScopes.initialize(*MF);
1346 if (LScopes.empty()) return;
1347 identifyScopeMarkers();
Devang Patel60b35bd2009-10-06 18:37:31 +00001348
Devang Pateleac9c072010-04-27 19:46:33 +00001349 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1350 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001351 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00001352 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001353
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001354 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1355
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001356 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopherb6dc8652012-11-27 22:43:45 +00001357 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001358 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1359
Devang Patelb2b31a62010-05-26 19:37:24 +00001360 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001361 I != E; ++I) {
1362 bool AtBlockEntry = true;
Devang Patelb2b31a62010-05-26 19:37:24 +00001363 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1364 II != IE; ++II) {
1365 const MachineInstr *MI = II;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001366
Devang Patelb2b31a62010-05-26 19:37:24 +00001367 if (MI->isDebugValue()) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001368 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001369
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001370 // Keep track of user variables.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001371 const MDNode *Var =
1372 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001373
1374 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001375 if (isDbgValueInDefinedReg(MI))
1376 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1377
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001378 // Check the history of this variable.
1379 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1380 if (History.empty()) {
1381 UserVariables.push_back(Var);
1382 // The first mention of a function argument gets the FunctionBeginSym
1383 // label, so arguments are visible when breaking at function entry.
1384 DIVariable DV(Var);
1385 if (DV.Verify() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1386 DISubprogram(getDISubprogram(DV.getContext()))
1387 .describes(MF->getFunction()))
1388 LabelsBeforeInsn[MI] = FunctionBeginSym;
1389 } else {
1390 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1391 const MachineInstr *Prev = History.back();
1392 if (Prev->isDebugValue()) {
1393 // Coalesce identical entries at the end of History.
1394 if (History.size() >= 2 &&
Devang Patel79862892011-07-07 00:14:27 +00001395 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher02c1a642012-10-08 20:48:49 +00001396 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001397 << "\t" << *Prev
Devang Patel79862892011-07-07 00:14:27 +00001398 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001399 History.pop_back();
Devang Patel79862892011-07-07 00:14:27 +00001400 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001401
1402 // Terminate old register assignments that don't reach MI;
1403 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1404 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1405 isDbgValueInDefinedReg(Prev)) {
1406 // Previous register assignment needs to terminate at the end of
1407 // its basic block.
1408 MachineBasicBlock::const_iterator LastMI =
1409 PrevMBB->getLastNonDebugInstr();
Devang Patel79862892011-07-07 00:14:27 +00001410 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001411 // Drop DBG_VALUE for empty range.
Eric Christopher02c1a642012-10-08 20:48:49 +00001412 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patel79862892011-07-07 00:14:27 +00001413 << "\t" << *Prev << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001414 History.pop_back();
Devang Patel79862892011-07-07 00:14:27 +00001415 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001416 else {
1417 // Terminate after LastMI.
1418 History.push_back(LastMI);
1419 }
1420 }
1421 }
1422 }
1423 History.push_back(MI);
Devang Patelb2b31a62010-05-26 19:37:24 +00001424 } else {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001425 // Not a DBG_VALUE instruction.
1426 if (!MI->isLabel())
1427 AtBlockEntry = false;
1428
Eric Christopher0313ced2012-10-04 20:46:14 +00001429 // First known non-DBG_VALUE and non-frame setup location marks
1430 // the beginning of the function body.
1431 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1432 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel4243e672011-05-11 19:22:19 +00001433 PrologEndLoc = MI->getDebugLoc();
1434
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001435 // Check if the instruction clobbers any registers with debug vars.
1436 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1437 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1438 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1439 continue;
Jakob Stoklund Olesen396618b2012-06-01 23:28:30 +00001440 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1441 AI.isValid(); ++AI) {
1442 unsigned Reg = *AI;
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001443 const MDNode *Var = LiveUserVar[Reg];
1444 if (!Var)
1445 continue;
1446 // Reg is now clobbered.
1447 LiveUserVar[Reg] = 0;
1448
1449 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001450 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1451 if (HistI == DbgValues.end())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001452 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001453 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1454 if (History.empty())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001455 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001456 const MachineInstr *Prev = History.back();
1457 // Sanity-check: Register assignments are terminated at the end of
1458 // their block.
1459 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1460 continue;
1461 // Is the variable still in Reg?
1462 if (!isDbgValueInDefinedReg(Prev) ||
1463 Prev->getOperand(0).getReg() != Reg)
1464 continue;
1465 // Var is clobbered. Make sure the next instruction gets a label.
1466 History.push_back(MI);
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001467 }
1468 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001469 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001470 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001471 }
1472
1473 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1474 I != E; ++I) {
1475 SmallVectorImpl<const MachineInstr*> &History = I->second;
1476 if (History.empty())
1477 continue;
1478
1479 // Make sure the final register assignments are terminated.
1480 const MachineInstr *Prev = History.back();
1481 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1482 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001483 MachineBasicBlock::const_iterator LastMI =
Devang Patel5bc942c2011-08-10 23:58:09 +00001484 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001485 if (LastMI == PrevMBB->end())
1486 // Drop DBG_VALUE for empty range.
1487 History.pop_back();
1488 else {
1489 // Terminate after LastMI.
1490 History.push_back(LastMI);
1491 }
1492 }
1493 // Request labels for the full history.
1494 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1495 const MachineInstr *MI = History[i];
1496 if (MI->isDebugValue())
1497 requestLabelBeforeInsn(MI);
1498 else
1499 requestLabelAfterInsn(MI);
1500 }
1501 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001502
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001503 PrevInstLoc = DebugLoc();
Devang Patelb2b31a62010-05-26 19:37:24 +00001504 PrevLabel = FunctionBeginSym;
Devang Patel4243e672011-05-11 19:22:19 +00001505
1506 // Record beginning of function.
1507 if (!PrologEndLoc.isUnknown()) {
1508 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1509 MF->getFunction()->getContext());
1510 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1511 FnStartDL.getScope(MF->getFunction()->getContext()),
Eric Christopher09e47502012-09-10 23:34:06 +00001512 0);
Devang Patel4243e672011-05-11 19:22:19 +00001513 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001514}
1515
Devang Patelbf47fdb2011-08-10 20:55:27 +00001516void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1517// SmallVector<DbgVariable *, 8> &Vars = ScopeVariables.lookup(LS);
1518 ScopeVariables[LS].push_back(Var);
1519// Vars.push_back(Var);
1520}
1521
Eric Christopherb6dc8652012-11-27 22:43:45 +00001522// Gather and emit post-function debug information.
Chris Lattnereec791a2010-01-26 23:18:02 +00001523void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001524 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00001525
Devang Patelbf47fdb2011-08-10 20:55:27 +00001526 // Define end label for subprogram.
1527 FunctionEndSym = Asm->GetTempSymbol("func_end",
1528 Asm->getFunctionNumber());
1529 // Assumes in correct section after the entry point.
1530 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001531
Devang Patelbf47fdb2011-08-10 20:55:27 +00001532 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1533 collectVariableInfo(MF, ProcessedVars);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001534
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001535 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Patel94c7ddb2011-08-16 22:09:43 +00001536 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky746cb672011-10-26 22:55:33 +00001537 assert(TheCU && "Unable to find compile unit!");
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001538
Devang Patelbf47fdb2011-08-10 20:55:27 +00001539 // Construct abstract scopes.
Devang Patelcd9f6c52011-08-12 18:10:19 +00001540 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1541 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1542 LexicalScope *AScope = AList[i];
1543 DISubprogram SP(AScope->getScopeNode());
Devang Patelbf47fdb2011-08-10 20:55:27 +00001544 if (SP.Verify()) {
1545 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001546 DIArray Variables = SP.getVariables();
1547 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1548 DIVariable DV(Variables.getElement(i));
1549 if (!DV || !DV.Verify() || !ProcessedVars.insert(DV))
1550 continue;
Alexey Samsonovb67bd332012-07-06 08:45:08 +00001551 // Check that DbgVariable for DV wasn't created earlier, when
1552 // findAbstractVariable() was called for inlined instance of DV.
1553 LLVMContext &Ctx = DV->getContext();
1554 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1555 if (AbstractVariables.lookup(CleanDV))
1556 continue;
Devang Patel93d39be2011-08-19 23:28:12 +00001557 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1558 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel78e127d2010-06-25 22:07:34 +00001559 }
1560 }
Devang Patelcd9f6c52011-08-12 18:10:19 +00001561 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001562 constructScopeDIE(TheCU, AScope);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001563 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001564
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001565 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001566
Nick Lewycky8a8d4792011-12-02 22:16:29 +00001567 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopher873cf0a2012-08-24 01:14:27 +00001568 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001569
Devang Patelbf47fdb2011-08-10 20:55:27 +00001570 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
1571 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001572
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001573 // Clear debug info
Devang Patelbf47fdb2011-08-10 20:55:27 +00001574 for (DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >::iterator
1575 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1576 DeleteContainerPointers(I->second);
1577 ScopeVariables.clear();
Devang Pateleac0c9d2011-04-22 18:09:57 +00001578 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001579 UserVariables.clear();
1580 DbgValues.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001581 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00001582 LabelsBeforeInsn.clear();
1583 LabelsAfterInsn.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00001584 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001585}
1586
Eric Christopherb6dc8652012-11-27 22:43:45 +00001587// Register a source line with debug info. Returns the unique label that was
1588// emitted and which provides correspondence to the source line list.
Devang Patel4243e672011-05-11 19:22:19 +00001589void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1590 unsigned Flags) {
Devang Patel65dbc902009-11-25 17:36:49 +00001591 StringRef Fn;
Devang Patel23670e52011-03-24 20:30:50 +00001592 StringRef Dir;
Dan Gohman1cc0d622010-05-05 23:41:32 +00001593 unsigned Src = 1;
1594 if (S) {
1595 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00001596
Dan Gohman1cc0d622010-05-05 23:41:32 +00001597 if (Scope.isCompileUnit()) {
1598 DICompileUnit CU(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001599 Fn = CU.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001600 Dir = CU.getDirectory();
Devang Patel3cabc9d2010-10-28 17:30:52 +00001601 } else if (Scope.isFile()) {
1602 DIFile F(S);
Devang Patel3cabc9d2010-10-28 17:30:52 +00001603 Fn = F.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001604 Dir = F.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001605 } else if (Scope.isSubprogram()) {
1606 DISubprogram SP(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001607 Fn = SP.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001608 Dir = SP.getDirectory();
Eric Christopher6618a242011-10-11 22:59:11 +00001609 } else if (Scope.isLexicalBlockFile()) {
1610 DILexicalBlockFile DBF(S);
1611 Fn = DBF.getFilename();
1612 Dir = DBF.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001613 } else if (Scope.isLexicalBlock()) {
1614 DILexicalBlock DB(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001615 Fn = DB.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001616 Dir = DB.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001617 } else
Craig Topper5e25ee82012-02-05 08:31:47 +00001618 llvm_unreachable("Unexpected scope info");
Dan Gohman1cc0d622010-05-05 23:41:32 +00001619
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001620 Src = getOrCreateSourceID(Fn, Dir);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001621 }
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001622 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001623}
1624
Bill Wendling829e67b2009-05-20 23:22:40 +00001625//===----------------------------------------------------------------------===//
1626// Emit Methods
1627//===----------------------------------------------------------------------===//
1628
Eric Christopherb6dc8652012-11-27 22:43:45 +00001629// Compute the size and offset of a DIE.
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001630unsigned
Eric Christopherfbd19752012-11-20 22:14:13 +00001631DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001632 // Get the children.
1633 const std::vector<DIE *> &Children = Die->getChildren();
1634
Bill Wendling94d04b82009-05-20 23:21:38 +00001635 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001636 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00001637
1638 // Get the abbreviation for this DIE.
1639 unsigned AbbrevNumber = Die->getAbbrevNumber();
1640 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1641
1642 // Set DIE offset
1643 Die->setOffset(Offset);
1644
1645 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00001646 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001647
1648 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
1649 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1650
1651 // Size the DIE attribute values.
1652 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1653 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00001654 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00001655
1656 // Size the DIE children if any.
1657 if (!Children.empty()) {
1658 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1659 "Children flag not set");
1660
1661 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopherfbd19752012-11-20 22:14:13 +00001662 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling94d04b82009-05-20 23:21:38 +00001663
1664 // End of children marker.
1665 Offset += sizeof(int8_t);
1666 }
1667
1668 Die->setSize(Offset - Die->getOffset());
1669 return Offset;
1670}
1671
Eric Christopherb6dc8652012-11-27 22:43:45 +00001672// Compute the size and offset of all the DIEs.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001673void DwarfDebug::computeSizeAndOffsets() {
Eric Christopher98e237f2012-11-30 23:59:06 +00001674 if (FissionCU) {
1675 unsigned Offset =
1676 sizeof(int32_t) + // Length of Compilation Unit Info
1677 sizeof(int16_t) + // DWARF version number
1678 sizeof(int32_t) + // Offset Into Abbrev. Section
1679 sizeof(int8_t); // Pointer Size (in bytes)
1680
1681 computeSizeAndOffset(FissionCU->getCUDie(), Offset);
1682 }
Devang Patel163a9f72010-05-10 22:49:55 +00001683 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1684 E = CUMap.end(); I != E; ++I) {
1685 // Compute size of compile unit header.
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001686 unsigned Offset =
Devang Patel163a9f72010-05-10 22:49:55 +00001687 sizeof(int32_t) + // Length of Compilation Unit Info
1688 sizeof(int16_t) + // DWARF version number
1689 sizeof(int32_t) + // Offset Into Abbrev. Section
1690 sizeof(int8_t); // Pointer Size (in bytes)
Eric Christopherfbd19752012-11-20 22:14:13 +00001691 computeSizeAndOffset(I->second->getCUDie(), Offset);
Devang Patel163a9f72010-05-10 22:49:55 +00001692 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001693}
1694
Eric Christopherb6dc8652012-11-27 22:43:45 +00001695// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001696void DwarfDebug::emitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001697 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001698
Bill Wendling94d04b82009-05-20 23:21:38 +00001699 // Dwarf sections base addresses.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001700 DwarfInfoSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001701 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00001702 DwarfAbbrevSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001703 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
1704 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001705
Chris Lattner9c69e285532010-04-04 22:59:04 +00001706 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001707 emitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00001708
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001709 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
1710 emitSectionSym(Asm, TLOF.getDwarfLocSection());
1711 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001712 DwarfStrSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001713 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
1714 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patelf2548ca2010-04-16 23:33:45 +00001715 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00001716
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001717 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patelc3f5f782010-05-25 23:40:22 +00001718 "section_debug_loc");
1719
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001720 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
1721 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00001722}
1723
Eric Christopherb6dc8652012-11-27 22:43:45 +00001724// Recursively emits a debug information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001725void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001726 // Get the abbreviation for this DIE.
1727 unsigned AbbrevNumber = Die->getAbbrevNumber();
1728 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1729
Bill Wendling94d04b82009-05-20 23:21:38 +00001730 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00001731 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00001732 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
1733 Twine::utohexstr(Die->getOffset()) + ":0x" +
1734 Twine::utohexstr(Die->getSize()) + " " +
1735 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00001736 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001737
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00001738 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling94d04b82009-05-20 23:21:38 +00001739 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1740
1741 // Emit the DIE attribute values.
1742 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1743 unsigned Attr = AbbrevData[i].getAttribute();
1744 unsigned Form = AbbrevData[i].getForm();
1745 assert(Form && "Too many attributes for DIE (check abbreviation)");
1746
Chris Lattner3f53c832010-04-04 18:52:31 +00001747 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00001748 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001749
Bill Wendling94d04b82009-05-20 23:21:38 +00001750 switch (Attr) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001751 case dwarf::DW_AT_abstract_origin: {
1752 DIEEntry *E = cast<DIEEntry>(Values[i]);
1753 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00001754 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00001755 Asm->EmitInt32(Addr);
1756 break;
1757 }
Devang Patelf2548ca2010-04-16 23:33:45 +00001758 case dwarf::DW_AT_ranges: {
1759 // DW_AT_range Value encodes offset in debug_range section.
1760 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelb1fcfbe2010-09-02 16:43:44 +00001761
Nick Lewyckyffccd922012-06-22 01:25:12 +00001762 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelb1fcfbe2010-09-02 16:43:44 +00001763 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
1764 V->getValue(),
1765 4);
1766 } else {
1767 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
1768 V->getValue(),
1769 DwarfDebugRangeSectionSym,
1770 4);
1771 }
Devang Patelf2548ca2010-04-16 23:33:45 +00001772 break;
1773 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001774 case dwarf::DW_AT_location: {
Nick Lewyckyffccd922012-06-22 01:25:12 +00001775 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
1776 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
1777 Asm->EmitLabelReference(L->getValue(), 4);
1778 else
1779 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
1780 } else {
Devang Patelc3f5f782010-05-25 23:40:22 +00001781 Values[i]->EmitValue(Asm, Form);
Nick Lewyckyffccd922012-06-22 01:25:12 +00001782 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001783 break;
1784 }
Devang Patel2a361602010-09-29 19:08:08 +00001785 case dwarf::DW_AT_accessibility: {
1786 if (Asm->isVerbose()) {
1787 DIEInteger *V = cast<DIEInteger>(Values[i]);
1788 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
1789 }
1790 Values[i]->EmitValue(Asm, Form);
1791 break;
1792 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001793 default:
1794 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001795 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00001796 break;
1797 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001798 }
1799
1800 // Emit the DIE children if any.
1801 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
1802 const std::vector<DIE *> &Children = Die->getChildren();
1803
1804 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001805 emitDIE(Children[j]);
Bill Wendling94d04b82009-05-20 23:21:38 +00001806
Chris Lattner3f53c832010-04-04 18:52:31 +00001807 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00001808 Asm->OutStreamer.AddComment("End Of Children Mark");
1809 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00001810 }
1811}
1812
Eric Christopher98e237f2012-11-30 23:59:06 +00001813void DwarfDebug::emitCompileUnits(const MCSection *Section) {
1814 Asm->OutStreamer.SwitchSection(Section);
Devang Patel163a9f72010-05-10 22:49:55 +00001815 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1816 E = CUMap.end(); I != E; ++I) {
1817 CompileUnit *TheCU = I->second;
1818 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001819
Devang Patel163a9f72010-05-10 22:49:55 +00001820 // Emit the compile units header.
1821 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
1822 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001823
Devang Patel163a9f72010-05-10 22:49:55 +00001824 // Emit size of content not including length itself
1825 unsigned ContentSize = Die->getSize() +
1826 sizeof(int16_t) + // DWARF version number
1827 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patel65705d52011-04-13 19:41:17 +00001828 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbach1e20b962010-07-21 21:21:52 +00001829
Devang Patel163a9f72010-05-10 22:49:55 +00001830 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
1831 Asm->EmitInt32(ContentSize);
1832 Asm->OutStreamer.AddComment("DWARF version number");
1833 Asm->EmitInt16(dwarf::DWARF_VERSION);
1834 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
1835 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
1836 DwarfAbbrevSectionSym);
1837 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00001838 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001839
Devang Patel163a9f72010-05-10 22:49:55 +00001840 emitDIE(Die);
Devang Patel163a9f72010-05-10 22:49:55 +00001841 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
1842 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001843}
1844
Eric Christopher98e237f2012-11-30 23:59:06 +00001845// Emit the debug info section.
1846void DwarfDebug::emitDebugInfo() {
1847 if (!useDwarfFission())
1848 emitCompileUnits(Asm->getObjFileLowering().getDwarfInfoSection());
1849 else
1850 emitFissionSkeletonCU(Asm->getObjFileLowering().getDwarfInfoSection());
1851}
1852
Eric Christopherb6dc8652012-11-27 22:43:45 +00001853// Emit the abbreviation section.
Eric Christopher7dc68db2012-11-20 23:30:11 +00001854void DwarfDebug::emitAbbreviations() {
Bill Wendling94d04b82009-05-20 23:21:38 +00001855 // Check to see if it is worth the effort.
1856 if (!Abbreviations.empty()) {
1857 // Start the debug abbrev section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001858 Asm->OutStreamer.SwitchSection(
1859 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00001860
Chris Lattnerc0215722010-04-04 19:25:43 +00001861 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00001862
1863 // For each abbrevation.
1864 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
1865 // Get abbreviation data
1866 const DIEAbbrev *Abbrev = Abbreviations[i];
1867
1868 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00001869 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00001870
1871 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001872 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00001873 }
1874
1875 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00001876 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00001877
Chris Lattnerc0215722010-04-04 19:25:43 +00001878 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00001879 }
1880}
1881
Eric Christopherb6dc8652012-11-27 22:43:45 +00001882// Emit the last address of the section and the end of the line matrix.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001883void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001884 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00001885 Asm->OutStreamer.AddComment("Extended Op");
1886 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001887
Chris Lattner233f52b2010-03-09 23:52:58 +00001888 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00001889 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00001890 Asm->OutStreamer.AddComment("DW_LNE_set_address");
1891 Asm->EmitInt8(dwarf::DW_LNE_set_address);
1892
1893 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00001894
Chris Lattnerc0215722010-04-04 19:25:43 +00001895 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chandler Carruth426c2bf2012-11-01 09:14:31 +00001896 Asm->getDataLayout().getPointerSize(),
Chris Lattnerd38fee82010-04-05 00:13:49 +00001897 0/*AddrSpace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00001898
1899 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00001900 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
1901 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00001902 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00001903 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00001904}
1905
Eric Christopherb6dc8652012-11-27 22:43:45 +00001906// Emit visible names into a hashed accelerator table section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00001907void DwarfDebug::emitAccelNames() {
1908 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1909 dwarf::DW_FORM_data4));
1910 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1911 E = CUMap.end(); I != E; ++I) {
1912 CompileUnit *TheCU = I->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00001913 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
1914 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00001915 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1916 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00001917 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00001918 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1919 DE = Entities.end(); DI != DE; ++DI)
1920 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00001921 }
1922 }
1923
1924 AT.FinalizeTable(Asm, "Names");
1925 Asm->OutStreamer.SwitchSection(
1926 Asm->getObjFileLowering().getDwarfAccelNamesSection());
1927 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
1928 Asm->OutStreamer.EmitLabel(SectionBegin);
1929
1930 // Emit the full data.
1931 AT.Emit(Asm, SectionBegin, this);
1932}
1933
Eric Christopherb6dc8652012-11-27 22:43:45 +00001934// Emit objective C classes and categories into a hashed accelerator table section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00001935void DwarfDebug::emitAccelObjC() {
1936 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1937 dwarf::DW_FORM_data4));
1938 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1939 E = CUMap.end(); I != E; ++I) {
1940 CompileUnit *TheCU = I->second;
1941 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
1942 for (StringMap<std::vector<DIE*> >::const_iterator
1943 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1944 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00001945 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher09ac3d82011-11-07 09:24:32 +00001946 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1947 DE = Entities.end(); DI != DE; ++DI)
1948 AT.AddName(Name, (*DI));
1949 }
1950 }
1951
1952 AT.FinalizeTable(Asm, "ObjC");
1953 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
1954 .getDwarfAccelObjCSection());
1955 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
1956 Asm->OutStreamer.EmitLabel(SectionBegin);
1957
1958 // Emit the full data.
1959 AT.Emit(Asm, SectionBegin, this);
1960}
1961
Eric Christopherb6dc8652012-11-27 22:43:45 +00001962// Emit namespace dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00001963void DwarfDebug::emitAccelNamespaces() {
1964 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1965 dwarf::DW_FORM_data4));
1966 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1967 E = CUMap.end(); I != E; ++I) {
1968 CompileUnit *TheCU = I->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00001969 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
1970 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00001971 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1972 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00001973 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00001974 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1975 DE = Entities.end(); DI != DE; ++DI)
1976 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00001977 }
1978 }
1979
1980 AT.FinalizeTable(Asm, "namespac");
1981 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
1982 .getDwarfAccelNamespaceSection());
1983 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
1984 Asm->OutStreamer.EmitLabel(SectionBegin);
1985
1986 // Emit the full data.
1987 AT.Emit(Asm, SectionBegin, this);
1988}
1989
Eric Christopherb6dc8652012-11-27 22:43:45 +00001990// Emit type dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00001991void DwarfDebug::emitAccelTypes() {
Eric Christopherc36145f2012-01-06 04:35:23 +00001992 std::vector<DwarfAccelTable::Atom> Atoms;
1993 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1994 dwarf::DW_FORM_data4));
1995 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTag,
1996 dwarf::DW_FORM_data2));
1997 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTypeFlags,
1998 dwarf::DW_FORM_data1));
1999 DwarfAccelTable AT(Atoms);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002000 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2001 E = CUMap.end(); I != E; ++I) {
2002 CompileUnit *TheCU = I->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002003 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2004 = TheCU->getAccelTypes();
2005 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002006 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2007 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00002008 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002009 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2010 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2011 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002012 }
2013 }
2014
2015 AT.FinalizeTable(Asm, "types");
2016 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2017 .getDwarfAccelTypesSection());
2018 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2019 Asm->OutStreamer.EmitLabel(SectionBegin);
2020
2021 // Emit the full data.
2022 AT.Emit(Asm, SectionBegin, this);
2023}
2024
Devang Patel193f7202009-11-24 01:14:22 +00002025void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00002026 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2027 E = CUMap.end(); I != E; ++I) {
2028 CompileUnit *TheCU = I->second;
Eric Christopher63701182011-11-07 09:18:35 +00002029 // Start the dwarf pubtypes section.
Devang Patel163a9f72010-05-10 22:49:55 +00002030 Asm->OutStreamer.SwitchSection(
2031 Asm->getObjFileLowering().getDwarfPubTypesSection());
2032 Asm->OutStreamer.AddComment("Length of Public Types Info");
2033 Asm->EmitLabelDifference(
2034 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
2035 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002036
Devang Patel163a9f72010-05-10 22:49:55 +00002037 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
2038 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002039
Devang Patel163a9f72010-05-10 22:49:55 +00002040 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
2041 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002042
Devang Patel163a9f72010-05-10 22:49:55 +00002043 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2044 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
2045 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002046
Devang Patel163a9f72010-05-10 22:49:55 +00002047 Asm->OutStreamer.AddComment("Compilation Unit Length");
2048 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
2049 Asm->GetTempSymbol("info_begin", TheCU->getID()),
2050 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002051
Devang Patel163a9f72010-05-10 22:49:55 +00002052 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
2053 for (StringMap<DIE*>::const_iterator
2054 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2055 const char *Name = GI->getKeyData();
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00002056 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002057
Devang Patel163a9f72010-05-10 22:49:55 +00002058 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
2059 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002060
Devang Patel163a9f72010-05-10 22:49:55 +00002061 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
Benjamin Kramer983c4572011-11-09 18:16:11 +00002062 // Emit the name with a terminating null byte.
Devang Patel163a9f72010-05-10 22:49:55 +00002063 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
2064 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002065
Devang Patel163a9f72010-05-10 22:49:55 +00002066 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00002067 Asm->EmitInt32(0);
Devang Patel163a9f72010-05-10 22:49:55 +00002068 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
2069 TheCU->getID()));
Devang Patel193f7202009-11-24 01:14:22 +00002070 }
Devang Patel193f7202009-11-24 01:14:22 +00002071}
2072
Eric Christopherb6dc8652012-11-27 22:43:45 +00002073// Emit visible names into a debug str section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002074void DwarfDebug::emitDebugStr() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002075 // Check to see if it is worth the effort.
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002076 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002077
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002078 // Start the dwarf str section.
2079 Asm->OutStreamer.SwitchSection(
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002080 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002081
Chris Lattnerbc733f52010-03-13 02:17:42 +00002082 // Get all of the string pool entries and put them in an array by their ID so
2083 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002084 SmallVector<std::pair<unsigned,
Chris Lattnerbc733f52010-03-13 02:17:42 +00002085 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002086
Chris Lattnerbc733f52010-03-13 02:17:42 +00002087 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
2088 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
2089 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002090
Chris Lattnerbc733f52010-03-13 02:17:42 +00002091 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002092
Chris Lattnerbc733f52010-03-13 02:17:42 +00002093 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002094 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00002095 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002096
Benjamin Kramer983c4572011-11-09 18:16:11 +00002097 // Emit the string itself with a terminating null byte.
Benjamin Kramer0c45f7d2011-11-09 12:12:04 +00002098 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
2099 Entries[i].second->getKeyLength()+1),
2100 0/*addrspace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00002101 }
2102}
2103
Eric Christopherb6dc8652012-11-27 22:43:45 +00002104// Emit visible names into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002105void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00002106 if (DotDebugLocEntries.empty())
2107 return;
2108
Devang Patel6c3ea902011-02-04 22:57:18 +00002109 for (SmallVector<DotDebugLocEntry, 4>::iterator
2110 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2111 I != E; ++I) {
2112 DotDebugLocEntry &Entry = *I;
2113 if (I + 1 != DotDebugLocEntries.end())
2114 Entry.Merge(I+1);
2115 }
2116
Daniel Dunbar83320a02011-03-16 22:16:39 +00002117 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002118 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00002119 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002120 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00002121 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2122 unsigned index = 1;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002123 for (SmallVector<DotDebugLocEntry, 4>::iterator
2124 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00002125 I != E; ++I, ++index) {
Devang Patel6c3ea902011-02-04 22:57:18 +00002126 DotDebugLocEntry &Entry = *I;
2127 if (Entry.isMerged()) continue;
Devang Patelc3f5f782010-05-25 23:40:22 +00002128 if (Entry.isEmpty()) {
2129 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
2130 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel80250682010-05-26 23:55:23 +00002131 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00002132 } else {
2133 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
2134 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
Devang Patelc26f5442011-04-28 02:22:40 +00002135 DIVariable DV(Entry.Variable);
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002136 Asm->OutStreamer.AddComment("Loc expr size");
2137 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2138 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2139 Asm->EmitLabelDifference(end, begin, 2);
2140 Asm->OutStreamer.EmitLabel(begin);
Devang Patel80efd4e2011-07-08 16:49:43 +00002141 if (Entry.isInt()) {
Devang Patelc4329072011-06-01 22:03:25 +00002142 DIBasicType BTy(DV.getType());
2143 if (BTy.Verify() &&
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002144 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patelc4329072011-06-01 22:03:25 +00002145 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2146 Asm->OutStreamer.AddComment("DW_OP_consts");
2147 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Patel80efd4e2011-07-08 16:49:43 +00002148 Asm->EmitSLEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002149 } else {
2150 Asm->OutStreamer.AddComment("DW_OP_constu");
2151 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Patel80efd4e2011-07-08 16:49:43 +00002152 Asm->EmitULEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002153 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002154 } else if (Entry.isLocation()) {
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002155 if (!DV.hasComplexAddress())
Devang Patel80efd4e2011-07-08 16:49:43 +00002156 // Regular entry.
Devang Patelc26f5442011-04-28 02:22:40 +00002157 Asm->EmitDwarfRegOp(Entry.Loc);
Devang Patel80efd4e2011-07-08 16:49:43 +00002158 else {
2159 // Complex address entry.
2160 unsigned N = DV.getNumAddrElements();
2161 unsigned i = 0;
2162 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
2163 if (Entry.Loc.getOffset()) {
2164 i = 2;
2165 Asm->EmitDwarfRegOp(Entry.Loc);
2166 Asm->OutStreamer.AddComment("DW_OP_deref");
2167 Asm->EmitInt8(dwarf::DW_OP_deref);
2168 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2169 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2170 Asm->EmitSLEB128(DV.getAddrElement(1));
2171 } else {
2172 // If first address element is OpPlus then emit
2173 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
2174 MachineLocation Loc(Entry.Loc.getReg(), DV.getAddrElement(1));
2175 Asm->EmitDwarfRegOp(Loc);
2176 i = 2;
2177 }
2178 } else {
2179 Asm->EmitDwarfRegOp(Entry.Loc);
2180 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002181
Devang Patel80efd4e2011-07-08 16:49:43 +00002182 // Emit remaining complex address elements.
2183 for (; i < N; ++i) {
2184 uint64_t Element = DV.getAddrElement(i);
2185 if (Element == DIBuilder::OpPlus) {
2186 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2187 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher50120762012-05-08 18:56:00 +00002188 } else if (Element == DIBuilder::OpDeref) {
Eric Christophera80f2d12012-05-08 21:24:39 +00002189 if (!Entry.Loc.isReg())
Eric Christopher50120762012-05-08 18:56:00 +00002190 Asm->EmitInt8(dwarf::DW_OP_deref);
2191 } else
2192 llvm_unreachable("unknown Opcode found in complex address");
Devang Patel80efd4e2011-07-08 16:49:43 +00002193 }
Devang Patelc26f5442011-04-28 02:22:40 +00002194 }
Devang Patelc26f5442011-04-28 02:22:40 +00002195 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002196 // else ... ignore constant fp. There is not any good way to
2197 // to represent them here in dwarf.
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002198 Asm->OutStreamer.EmitLabel(end);
Devang Patelc3f5f782010-05-25 23:40:22 +00002199 }
2200 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002201}
2202
Eric Christopherb6dc8652012-11-27 22:43:45 +00002203// Emit visible names into a debug aranges section.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002204void DwarfDebug::emitDebugARanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002205 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002206 Asm->OutStreamer.SwitchSection(
2207 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002208}
2209
Eric Christopherb6dc8652012-11-27 22:43:45 +00002210// Emit visible names into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002211void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002212 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002213 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00002214 Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002215 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Pateleac9c072010-04-27 19:46:33 +00002216 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00002217 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00002218 I != E; ++I) {
2219 if (*I)
2220 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patelf2548ca2010-04-16 23:33:45 +00002221 else
Devang Pateleac9c072010-04-27 19:46:33 +00002222 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patelf2548ca2010-04-16 23:33:45 +00002223 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002224}
2225
Eric Christopherb6dc8652012-11-27 22:43:45 +00002226// Emit visible names into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002227void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002228 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00002229 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002230 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002231 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002232 }
2233}
2234
Eric Christopherb6dc8652012-11-27 22:43:45 +00002235// Emit inline info using following format.
2236// Section Header:
2237// 1. length of section
2238// 2. Dwarf version number
2239// 3. address size.
2240//
2241// Entries (one "entry" for each function that was inlined):
2242//
2243// 1. offset into __debug_str section for MIPS linkage name, if exists;
2244// otherwise offset into __debug_str for regular function name.
2245// 2. offset into __debug_str section for regular function name.
2246// 3. an unsigned LEB128 number indicating the number of distinct inlining
2247// instances for the function.
2248//
2249// The rest of the entry consists of a {die_offset, low_pc} pair for each
2250// inlined instance; the die_offset points to the inlined_subroutine die in the
2251// __debug_info section, and the low_pc is the starting address for the
2252// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002253void DwarfDebug::emitDebugInlineInfo() {
Eric Christopherb83e2bb2012-03-02 02:11:47 +00002254 if (!Asm->MAI->doesDwarfUseInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002255 return;
2256
Devang Patel163a9f72010-05-10 22:49:55 +00002257 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00002258 return;
2259
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002260 Asm->OutStreamer.SwitchSection(
2261 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00002262
Chris Lattner233f52b2010-03-09 23:52:58 +00002263 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00002264 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
2265 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00002266
Chris Lattnerc0215722010-04-04 19:25:43 +00002267 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002268
Chris Lattner233f52b2010-03-09 23:52:58 +00002269 Asm->OutStreamer.AddComment("Dwarf Version");
2270 Asm->EmitInt16(dwarf::DWARF_VERSION);
2271 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002272 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002273
Devang Patele9f8f5e2010-05-07 20:54:48 +00002274 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00002275 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002276
Devang Patele9f8f5e2010-05-07 20:54:48 +00002277 const MDNode *Node = *I;
2278 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002279 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00002280 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00002281 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00002282 StringRef LName = SP.getLinkageName();
2283 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00002284
Chris Lattner233f52b2010-03-09 23:52:58 +00002285 Asm->OutStreamer.AddComment("MIPS linkage name");
Eric Christopher50e26612012-03-02 01:57:52 +00002286 if (LName.empty())
2287 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
2288 else
Chris Lattner6189ed12010-04-04 23:25:33 +00002289 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
2290 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00002291
Chris Lattner233f52b2010-03-09 23:52:58 +00002292 Asm->OutStreamer.AddComment("Function name");
Chris Lattner6189ed12010-04-04 23:25:33 +00002293 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002294 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00002295
Devang Patel53bb5c92009-11-10 23:06:00 +00002296 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00002297 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00002298 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00002299 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00002300
Chris Lattner3f53c832010-04-04 18:52:31 +00002301 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00002302 Asm->OutStreamer.EmitSymbolValue(LI->first,
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002303 Asm->getDataLayout().getPointerSize(),0);
Bill Wendling94d04b82009-05-20 23:21:38 +00002304 }
2305 }
2306
Chris Lattnerc0215722010-04-04 19:25:43 +00002307 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002308}
Eric Christopher98e237f2012-11-30 23:59:06 +00002309
2310// DWARF5 Experimental Fission emitters.
2311
2312// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2313// DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2314// DW_AT_ranges_base, DW_AT_addr_base. If DW_AT_ranges is present,
2315// DW_AT_low_pc and DW_AT_high_pc are not used, and vice versa.
2316CompileUnit *DwarfDebug::constructFissionCU(const MDNode *N) {
2317 DICompileUnit DIUnit(N);
2318 StringRef FN = DIUnit.getFilename();
2319 CompilationDir = DIUnit.getDirectory();
2320 unsigned ID = getOrCreateSourceID(FN, CompilationDir);
2321
2322 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
2323 CompileUnit *NewCU = new CompileUnit(ID, DIUnit.getLanguage(), Die,
2324 Asm, this);
2325 // FIXME: This should be the .dwo file.
2326 NewCU->addString(Die, dwarf::DW_AT_GNU_dwo_name, FN);
2327
2328 // FIXME: We also need DW_AT_addr_base and DW_AT_dwo_id.
2329
2330 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
2331 // into an entity.
2332 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
2333 // DW_AT_stmt_list is a offset of line number information for this
2334 // compile unit in debug_line section.
2335 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2336 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
2337 Asm->GetTempSymbol("section_line"));
2338 else
2339 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
2340
2341 if (!CompilationDir.empty())
2342 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
2343
2344 return NewCU;
2345}
2346
2347void DwarfDebug::emitFissionSkeletonCU(const MCSection *Section) {
2348 Asm->OutStreamer.SwitchSection(Section);
2349 DIE *Die = FissionCU->getCUDie();
2350
2351 // Emit the compile units header.
2352 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("skel_info_begin",
2353 FissionCU->getID()));
2354
2355 // Emit size of content not including length itself
2356 unsigned ContentSize = Die->getSize() +
2357 sizeof(int16_t) + // DWARF version number
2358 sizeof(int32_t) + // Offset Into Abbrev. Section
2359 sizeof(int8_t); // Pointer Size (in bytes)
2360
2361 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2362 Asm->EmitInt32(ContentSize);
2363 Asm->OutStreamer.AddComment("DWARF version number");
2364 Asm->EmitInt16(dwarf::DWARF_VERSION);
2365 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
2366 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
2367 DwarfAbbrevSectionSym);
2368 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2369 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
2370
2371 emitDIE(Die);
2372 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("skel_info_end", FissionCU->getID()));
2373
2374
2375}
2376
2377// Emit the .debug_info.dwo section for fission. This contains the compile
2378// units that would normally be in debug_info.
2379void DwarfDebug::emitDebugInfoDWO() {
2380 assert(useDwarfFission() && "Got fission?");
2381 emitCompileUnits(Asm->getObjFileLowering().getDwarfInfoDWOSection());
2382}