blob: 574474c118e7581c802745b9a5ffe864999e657b [file] [log] [blame]
Bill Wendling2f921f82009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Chris Lattnerb14490d2010-03-09 00:39:24 +000013
Devang Patel80ae3492009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling2f921f82009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000016#include "DIE.h"
Eric Christopher4996c702011-11-07 09:24:32 +000017#include "DwarfAccelTable.h"
Devang Patel5eb43192011-04-12 17:40:32 +000018#include "DwarfCompileUnit.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000019#include "llvm/ADT/STLExtras.h"
20#include "llvm/ADT/Statistic.h"
21#include "llvm/ADT/StringExtras.h"
22#include "llvm/ADT/Triple.h"
David Greene829b3e82009-08-19 21:52:55 +000023#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000024#include "llvm/CodeGen/MachineModuleInfo.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000025#include "llvm/Constants.h"
26#include "llvm/DIBuilder.h"
27#include "llvm/DataLayout.h"
28#include "llvm/DebugInfo.h"
29#include "llvm/Instructions.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000030#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000031#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000032#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000033#include "llvm/MC/MCSymbol.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000034#include "llvm/Module.h"
Devang Patel6c74a872010-04-27 19:46:33 +000035#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000036#include "llvm/Support/Debug.h"
37#include "llvm/Support/ErrorHandling.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000038#include "llvm/Support/FormattedStream.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000039#include "llvm/Support/Path.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000040#include "llvm/Support/Timer.h"
41#include "llvm/Support/ValueHandle.h"
42#include "llvm/Target/TargetFrameLowering.h"
43#include "llvm/Target/TargetLoweringObjectFile.h"
44#include "llvm/Target/TargetMachine.h"
45#include "llvm/Target/TargetOptions.h"
46#include "llvm/Target/TargetRegisterInfo.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000047using namespace llvm;
48
Jim Grosbacha8683bb2010-07-21 21:21:52 +000049static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel30265c42010-07-07 20:12:52 +000050 cl::Hidden,
Devang Patel6c74a872010-04-27 19:46:33 +000051 cl::desc("Disable debug info printing"));
52
Dan Gohman7421ae42010-05-07 01:08:53 +000053static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
Chris Lattner0ab5e2c2011-04-15 05:18:47 +000054 cl::desc("Make an absence of debug location information explicit."),
Dan Gohman7421ae42010-05-07 01:08:53 +000055 cl::init(false));
56
Eric Christopher20b76a72012-08-23 22:36:40 +000057namespace {
58 enum DefaultOnOff {
59 Default, Enable, Disable
60 };
61}
Eric Christopher4996c702011-11-07 09:24:32 +000062
Eric Christopher20b76a72012-08-23 22:36:40 +000063static cl::opt<DefaultOnOff> DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
64 cl::desc("Output prototype dwarf accelerator tables."),
65 cl::values(
66 clEnumVal(Default, "Default for platform"),
67 clEnumVal(Enable, "Enabled"),
68 clEnumVal(Disable, "Disabled"),
69 clEnumValEnd),
70 cl::init(Default));
71
72static cl::opt<DefaultOnOff> DarwinGDBCompat("darwin-gdb-compat", cl::Hidden,
Eric Christopher978fbff2012-08-23 07:10:46 +000073 cl::desc("Compatibility with Darwin gdb."),
Eric Christopher20b76a72012-08-23 22:36:40 +000074 cl::values(
75 clEnumVal(Default, "Default for platform"),
76 clEnumVal(Enable, "Enabled"),
77 clEnumVal(Disable, "Disabled"),
78 clEnumValEnd),
79 cl::init(Default));
Eric Christopher978fbff2012-08-23 07:10:46 +000080
Eric Christopher29424312012-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 Wendlingfcc14142010-04-07 09:28:04 +000090namespace {
91 const char *DWARFGroupName = "DWARF Emission";
92 const char *DbgTimerName = "DWARF Debug Writer";
93} // end anonymous namespace
94
Bill Wendling2f921f82009-05-15 09:23:25 +000095//===----------------------------------------------------------------------===//
96
Eric Christopheracdcbdb2012-11-27 22:43:45 +000097// Configuration values for initial hash set sizes (log2).
98//
Bill Wendling2f921f82009-05-15 09:23:25 +000099static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +0000100
101namespace llvm {
102
Nick Lewycky019d2552011-07-29 03:49:23 +0000103DIType DbgVariable::getType() const {
Devang Patelf20c4f72011-04-12 22:53:02 +0000104 DIType Ty = Var.getType();
105 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
106 // addresses instead.
107 if (Var.isBlockByrefVariable()) {
108 /* Byref variables, in Blocks, are declared by the programmer as
109 "SomeType VarName;", but the compiler creates a
110 __Block_byref_x_VarName struct, and gives the variable VarName
111 either the struct, or a pointer to the struct, as its type. This
112 is necessary for various behind-the-scenes things the compiler
113 needs to do with by-reference variables in blocks.
Eric Christopher6a841382012-11-19 22:42:10 +0000114
Devang Patelf20c4f72011-04-12 22:53:02 +0000115 However, as far as the original *programmer* is concerned, the
116 variable should still have type 'SomeType', as originally declared.
Eric Christopher6a841382012-11-19 22:42:10 +0000117
Devang Patelf20c4f72011-04-12 22:53:02 +0000118 The following function dives into the __Block_byref_x_VarName
119 struct to find the original type of the variable. This will be
120 passed back to the code generating the type for the Debug
121 Information Entry for the variable 'VarName'. 'VarName' will then
122 have the original type 'SomeType' in its debug information.
Eric Christopher6a841382012-11-19 22:42:10 +0000123
Devang Patelf20c4f72011-04-12 22:53:02 +0000124 The original type 'SomeType' will be the type of the field named
125 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher6a841382012-11-19 22:42:10 +0000126
Devang Patelf20c4f72011-04-12 22:53:02 +0000127 NOTE: In order for this to not completely fail on the debugger
128 side, the Debug Information Entry for the variable VarName needs to
129 have a DW_AT_location that tells the debugger how to unwind through
130 the pointers and __Block_byref_x_VarName struct to find the actual
131 value of the variable. The function addBlockByrefType does this. */
132 DIType subType = Ty;
133 unsigned tag = Ty.getTag();
Eric Christopher6a841382012-11-19 22:42:10 +0000134
Devang Patelf20c4f72011-04-12 22:53:02 +0000135 if (tag == dwarf::DW_TAG_pointer_type) {
136 DIDerivedType DTy = DIDerivedType(Ty);
137 subType = DTy.getTypeDerivedFrom();
138 }
Eric Christopher6a841382012-11-19 22:42:10 +0000139
Devang Patelf20c4f72011-04-12 22:53:02 +0000140 DICompositeType blockStruct = DICompositeType(subType);
141 DIArray Elements = blockStruct.getTypeArray();
Eric Christopher6a841382012-11-19 22:42:10 +0000142
Devang Patelf20c4f72011-04-12 22:53:02 +0000143 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
144 DIDescriptor Element = Elements.getElement(i);
145 DIDerivedType DT = DIDerivedType(Element);
146 if (getName() == DT.getName())
147 return (DT.getTypeDerivedFrom());
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000148 }
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000149 }
Devang Patelf20c4f72011-04-12 22:53:02 +0000150 return Ty;
151}
Bill Wendling2f921f82009-05-15 09:23:25 +0000152
Chris Lattnerf5d06362010-04-05 04:09:20 +0000153} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000154
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000155DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Eric Christopherd79f5482012-12-10 19:51:13 +0000156 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000157 AbbreviationsSet(InitAbbreviationsSetSize),
Benjamin Kramer07480082012-06-09 10:34:15 +0000158 SourceIdMap(DIEValueAllocator), StringPool(DIEValueAllocator),
Eric Christopherd79f5482012-12-10 19:51:13 +0000159 PrevLabel(NULL), GlobalCUIndexCount(0), FissionCU(0) {
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000160 NextStringPoolNumber = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000161
Rafael Espindolaa7160962011-05-06 14:56:22 +0000162 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattnere58b5472010-04-04 23:10:38 +0000163 DwarfStrSectionSym = TextSectionSym = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000164 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000165 FunctionBeginSym = FunctionEndSym = 0;
Eric Christopherad9fe892012-04-02 17:58:52 +0000166
Eric Christopher978fbff2012-08-23 07:10:46 +0000167 // Turn on accelerator tables and older gdb compatibility
168 // for Darwin.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000169 bool IsDarwin = Triple(M->getTargetTriple()).isOSDarwin();
Eric Christopher20b76a72012-08-23 22:36:40 +0000170 if (DarwinGDBCompat == Default) {
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000171 if (IsDarwin)
172 IsDarwinGDBCompat = true;
Eric Christopher20b76a72012-08-23 22:36:40 +0000173 else
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000174 IsDarwinGDBCompat = false;
Eric Christopher20b76a72012-08-23 22:36:40 +0000175 } else
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000176 IsDarwinGDBCompat = DarwinGDBCompat == Enable ? true : false;
Eric Christopher4977f212012-08-23 22:36:36 +0000177
Eric Christopher20b76a72012-08-23 22:36:40 +0000178 if (DwarfAccelTables == Default) {
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000179 if (IsDarwin)
180 HasDwarfAccelTables = true;
Eric Christopher20b76a72012-08-23 22:36:40 +0000181 else
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000182 HasDwarfAccelTables = false;
Eric Christopher20b76a72012-08-23 22:36:40 +0000183 } else
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000184 HasDwarfAccelTables = DwarfAccelTables == Enable ? true : false;
Eric Christopher20b76a72012-08-23 22:36:40 +0000185
Eric Christopher29424312012-11-12 22:22:20 +0000186 if (DwarfFission == Default)
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000187 HasDwarfFission = false;
Eric Christopher29424312012-11-12 22:22:20 +0000188 else
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000189 HasDwarfFission = DwarfFission == Enable ? true : false;
Eric Christopher29424312012-11-12 22:22:20 +0000190
Dan Gohman6e681a52010-06-18 15:56:31 +0000191 {
192 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopher58f41952012-11-19 22:42:15 +0000193 beginModule();
Torok Edwinf8dba242010-04-07 10:44:46 +0000194 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000195}
196DwarfDebug::~DwarfDebug() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000197}
198
Eric Christopheracdcbdb2012-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 Christopher7b30f2e42012-11-21 00:34:35 +0000201static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christophera7b61892011-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 Lewyckyd59c0ca2011-10-27 06:44:11 +0000211MCSymbol *DwarfDebug::getStringPool() {
212 return Asm->GetTempSymbol("section_str");
213}
214
Chris Lattnerb7aa9522010-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 Lattnera179b522010-04-04 19:25:43 +0000220 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000221}
222
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000223// Define a unique number for the abbreviation.
224//
Devang Patel930143b2009-11-21 02:48:08 +0000225void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-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 Christopheracdcbdb2012-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 Patel43ef34d2010-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 Christopherd9843b32011-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 Christopher6a841382012-11-19 22:42:10 +0000292
Eric Christopherd9843b32011-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 Christopheracdcbdb2012-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 Pateld2dfc5e2011-08-15 22:24:32 +0000316DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
317 const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000318 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +0000319
Chris Lattner3a383cb2010-04-05 00:13:49 +0000320 assert(SPDie && "Unable to find subprogram DIE!");
321 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000322
Bill Wendlingf720bf62012-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 Patela37a95e2010-07-07 22:20:57 +0000326 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
Bill Wendlingf720bf62012-11-07 05:19:04 +0000327 // Pick up abstract subprogram DIE.
Devang Patela37a95e2010-07-07 22:20:57 +0000328 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf20c4f72011-04-12 22:53:02 +0000329 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
330 dwarf::DW_FORM_ref4, AbsSPDIE);
Devang Patela37a95e2010-07-07 22:20:57 +0000331 SPCU->addDie(SPDie);
Bill Wendlingd9bb9b62012-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 Christopher6a841382012-11-19 22:42:10 +0000363 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification,
364 dwarf::DW_FORM_ref4, SPDeclDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000365 SPCU->addDie(SPDie);
366 }
367 }
Devang Patela37a95e2010-07-07 22:20:57 +0000368 }
369
Devang Patelf20c4f72011-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 Lattner3a383cb2010-04-05 00:13:49 +0000374 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
375 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000376 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000377
Eric Christopherd9843b32011-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 Christopher6a841382012-11-19 22:42:10 +0000381
Chris Lattner3a383cb2010-04-05 00:13:49 +0000382 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000383}
384
Eric Christopheracdcbdb2012-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 Christopher6a841382012-11-19 22:42:10 +0000387DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000388 LexicalScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +0000389 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
390 if (Scope->isAbstractScope())
391 return ScopeDIE;
392
Devang Patel7e623022011-08-10 20:55:27 +0000393 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +0000394 if (Ranges.empty())
395 return 0;
396
Devang Patel7e623022011-08-10 20:55:27 +0000397 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel6c74a872010-04-27 19:46:33 +0000398 if (Ranges.size() > 1) {
399 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000400 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +0000401 // DW_AT_ranges appropriately.
Devang Patelf20c4f72011-04-12 22:53:02 +0000402 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000403 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000404 * Asm->getDataLayout().getPointerSize());
Devang Patel7e623022011-08-10 20:55:27 +0000405 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +0000406 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +0000407 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
408 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +0000409 }
410 DebugRangeSymbols.push_back(NULL);
411 DebugRangeSymbols.push_back(NULL);
412 return ScopeDIE;
413 }
414
Devang Patel9fc11702010-05-25 23:40:22 +0000415 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
416 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +0000417
Devang Patel9fc11702010-05-25 23:40:22 +0000418 if (End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000419
Chris Lattnere13c3722010-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 Grosbacha8683bb2010-07-21 21:21:52 +0000422
Devang Patelf20c4f72011-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 Patelf6eeaeb2009-11-10 23:06:00 +0000425
426 return ScopeDIE;
427}
428
Eric Christopheracdcbdb2012-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 Pateld2dfc5e2011-08-15 22:24:32 +0000431DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
432 LexicalScope *Scope) {
Devang Patel7e623022011-08-10 20:55:27 +0000433 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000434 assert(Ranges.empty() == false &&
435 "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000436
Devang Patelf098ce22011-07-27 00:34:13 +0000437 if (!Scope->getScopeNode())
438 return NULL;
439 DIScope DS(Scope->getScopeNode());
440 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patelf098ce22011-07-27 00:34:13 +0000441 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
442 if (!OriginDIE) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000443 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patelf098ce22011-07-27 00:34:13 +0000444 return NULL;
445 }
446
Devang Patel7e623022011-08-10 20:55:27 +0000447 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel9fc11702010-05-25 23:40:22 +0000448 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
449 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +0000450
Devang Patel4c6bd662010-07-08 22:39:20 +0000451 if (StartLabel == 0 || EndLabel == 0) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000452 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +0000453 }
Chris Lattnere13c3722010-03-09 01:58:53 +0000454 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +0000455 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +0000456 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +0000457 "Invalid end label for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +0000458
Devang Patel73bc1722011-05-05 17:54:26 +0000459 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Devang Patelf20c4f72011-04-12 22:53:02 +0000460 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
461 dwarf::DW_FORM_ref4, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000462
Devang Patelf098ce22011-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 Christopher6a841382012-11-19 22:42:10 +0000468 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000469 * Asm->getDataLayout().getPointerSize());
Devang Patel7e623022011-08-10 20:55:27 +0000470 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patelf098ce22011-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 Christopher6a841382012-11-19 22:42:10 +0000478 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Devang Patel784077e2011-08-10 23:58:09 +0000479 StartLabel);
Eric Christopher6a841382012-11-19 22:42:10 +0000480 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Devang Patel784077e2011-08-10 23:58:09 +0000481 EndLabel);
Devang Patelf098ce22011-07-27 00:34:13 +0000482 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000483
484 InlinedSubprogramDIEs.insert(OriginDIE);
485
486 // Track the start label for this inlined function.
Devang Patelf098ce22011-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 Patel32cc43c2010-05-07 20:54:48 +0000491 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000492 I = InlineInfo.find(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000493
494 if (I == InlineInfo.end()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000495 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000496 InlinedSPNodes.push_back(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000497 } else
Chris Lattner085b6522010-03-09 00:31:02 +0000498 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000499
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000500 DILocation DL(Scope->getInlinedAt());
Eric Christopher0925c622012-03-26 21:38:38 +0000501 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0,
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000502 getOrCreateSourceID(DL.getFilename(), DL.getDirectory()));
Devang Patelf20c4f72011-04-12 22:53:02 +0000503 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000504
Eric Christopher8dda5d02011-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 Christopher6a841382012-11-19 22:42:10 +0000508
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000509 return ScopeDIE;
510}
511
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000512// Construct a DIE for this scope.
Devang Patel3acc70e2011-08-15 22:04:40 +0000513DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000514 if (!Scope || !Scope->getScopeNode())
515 return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000516
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000517 SmallVector<DIE *, 8> Children;
Eric Christophere3417762012-09-12 23:36:19 +0000518 DIE *ObjectPointer = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +0000519
520 // Collect arguments for current function.
Devang Patel7e623022011-08-10 20:55:27 +0000521 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000522 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
523 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher6a841382012-11-19 22:42:10 +0000524 if (DIE *Arg =
Eric Christophere3417762012-09-12 23:36:19 +0000525 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel6c622ef2011-03-01 22:58:55 +0000526 Children.push_back(Arg);
Eric Christophere3417762012-09-12 23:36:19 +0000527 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
528 }
Devang Patel6c622ef2011-03-01 22:58:55 +0000529
Eric Christopherf84354b2011-10-03 15:49:16 +0000530 // Collect lexical scope children first.
Devang Patel7e623022011-08-10 20:55:27 +0000531 const SmallVector<DbgVariable *, 8> &Variables = ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000532 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher6a841382012-11-19 22:42:10 +0000533 if (DIE *Variable =
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000534 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000535 Children.push_back(Variable);
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000536 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
537 }
Devang Patel7e623022011-08-10 20:55:27 +0000538 const SmallVector<LexicalScope *, 4> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000539 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Patel3acc70e2011-08-15 22:04:40 +0000540 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000541 Children.push_back(Nested);
Devang Patel3b548aa2010-03-08 20:52:55 +0000542 DIScope DS(Scope->getScopeNode());
543 DIE *ScopeDIE = NULL;
544 if (Scope->getInlinedAt())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000545 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3b548aa2010-03-08 20:52:55 +0000546 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000547 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000548 if (Scope->isAbstractScope()) {
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000549 ScopeDIE = TheCU->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000550 // Note down abstract DIE.
551 if (ScopeDIE)
552 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
553 }
Devang Patel3b548aa2010-03-08 20:52:55 +0000554 else
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000555 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3b548aa2010-03-08 20:52:55 +0000556 }
Devang Patel5f1b4cd2011-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 Pateld2dfc5e2011-08-15 22:24:32 +0000561 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000562 }
Eric Christopher6a841382012-11-19 22:42:10 +0000563
Devang Patel23b2ae62010-03-29 22:59:58 +0000564 if (!ScopeDIE) return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000565
Devang Patel5f1b4cd2011-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 Patel04d2f2d2009-11-24 01:14:22 +0000570
Eric Christophere3417762012-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 Grosbacha8683bb2010-07-21 21:21:52 +0000575 if (DS.isSubprogram())
Eric Christopherd9843b32011-11-10 19:25:34 +0000576 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000577
Eric Christopherd9843b32011-11-10 19:25:34 +0000578 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000579}
580
Eric Christopheracdcbdb2012-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 Christopher7b30f2e42012-11-21 00:34:35 +0000585unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Devang Patele01b75c2011-03-24 20:30:50 +0000586 StringRef DirName) {
Devang Patel871d0b12010-09-16 20:57:49 +0000587 // If FE did not provide a file name, then assume stdin.
588 if (FileName.empty())
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000589 return getOrCreateSourceID("<stdin>", StringRef());
Devang Patele01b75c2011-03-24 20:30:50 +0000590
Nick Lewyckyd1ee7f82011-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 Lewycky40f8f2f2011-10-17 23:05:28 +0000595 unsigned SrcId = SourceIdMap.size()+1;
Devang Patel871d0b12010-09-16 20:57:49 +0000596
Benjamin Kramer71b19732012-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 Wendling2b128d72009-05-20 23:19:06 +0000606
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000607 // Print out a .file directive to specify files for .loc directives.
Benjamin Kramer71b19732012-03-11 14:56:26 +0000608 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName);
Bill Wendling2b128d72009-05-20 23:19:06 +0000609
610 return SrcId;
611}
612
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000613// Create new CompileUnit for the given metadata node with tag DW_TAG_compile_unit.
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000614CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +0000615 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +0000616 StringRef FN = DIUnit.getFilename();
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000617 CompilationDir = DIUnit.getDirectory();
Eli Benderskyb42d1462012-12-03 18:45:45 +0000618 // Call this to emit a .file directive if it wasn't emitted for the source
619 // file this CU comes from yet.
620 getOrCreateSourceID(FN, CompilationDir);
Bill Wendling2b128d72009-05-20 23:19:06 +0000621
622 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyb42d1462012-12-03 18:45:45 +0000623 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
624 DIUnit.getLanguage(), Die, Asm, this);
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000625 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patelf20c4f72011-04-12 22:53:02 +0000626 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
627 DIUnit.getLanguage());
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000628 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christopherb1b94512012-08-01 18:19:01 +0000629 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
630 // into an entity.
631 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Devang Pateld22ed622010-03-22 23:11:36 +0000632 // DW_AT_stmt_list is a offset of line number information for this
Devang Patel4a213872010-08-24 00:06:12 +0000633 // compile unit in debug_line section.
Rafael Espindolad7bdaf52012-06-22 13:24:07 +0000634 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Rafael Espindolaa7558912011-05-04 17:44:06 +0000635 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Devang Patelf20c4f72011-04-12 22:53:02 +0000636 Asm->GetTempSymbol("section_line"));
Devang Patelea636392010-08-31 23:50:19 +0000637 else
Devang Patelf20c4f72011-04-12 22:53:02 +0000638 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +0000639
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000640 if (!CompilationDir.empty())
641 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Bill Wendling2b128d72009-05-20 23:19:06 +0000642 if (DIUnit.isOptimized())
Eric Christopherbb69a272012-08-24 01:14:27 +0000643 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendling2b128d72009-05-20 23:19:06 +0000644
Devang Patel2d9caf92009-11-25 17:36:49 +0000645 StringRef Flags = DIUnit.getFlags();
646 if (!Flags.empty())
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000647 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher6a841382012-11-19 22:42:10 +0000648
Nick Lewycky479a8fe2011-10-17 23:27:36 +0000649 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patelf20c4f72011-04-12 22:53:02 +0000650 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +0000651 dwarf::DW_FORM_data1, RVer);
652
Devang Patel1a0df9a2010-05-10 22:49:55 +0000653 if (!FirstCU)
654 FirstCU = NewCU;
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000655 if (useDwarfFission() && !FissionCU)
656 FissionCU = constructFissionCU(N);
657
Devang Patel1a0df9a2010-05-10 22:49:55 +0000658 CUMap.insert(std::make_pair(N, NewCU));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000659 return NewCU;
Devang Patel1a0df9a2010-05-10 22:49:55 +0000660}
661
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000662// Construct subprogram DIE.
Eric Christopher6a841382012-11-19 22:42:10 +0000663void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
Devang Patel1f4f98d2011-08-15 23:36:40 +0000664 const MDNode *N) {
Rafael Espindola6cf4e832011-11-04 19:00:29 +0000665 CompileUnit *&CURef = SPMap[N];
666 if (CURef)
667 return;
668 CURef = TheCU;
669
Devang Patel80ae3492009-08-28 23:24:31 +0000670 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000671 if (!SP.isDefinition())
672 // This is a method declaration which will be handled while constructing
673 // class type.
Devang Patel0751a282009-06-26 01:49:18 +0000674 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000675
Devang Patel89543712011-08-15 17:24:54 +0000676 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000677
678 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000679 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +0000680
681 // Add to context owner.
Devang Patelf20c4f72011-04-12 22:53:02 +0000682 TheCU->addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +0000683
Devang Patel0751a282009-06-26 01:49:18 +0000684 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000685}
686
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000687// Collect debug info from named mdnodes such as llvm.dbg.enum and llvm.dbg.ty.
Eric Christopher58f41952012-11-19 22:42:15 +0000688void DwarfDebug::collectInfoFromNamedMDNodes(const Module *M) {
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000689 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.sp"))
690 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
691 const MDNode *N = NMD->getOperand(i);
692 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
693 constructSubprogramDIE(CU, N);
694 }
Eric Christopher6a841382012-11-19 22:42:10 +0000695
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000696 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.gv"))
697 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
698 const MDNode *N = NMD->getOperand(i);
699 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
Devang Patel0ecbcbd2011-08-18 23:17:55 +0000700 CU->createGlobalVariableDIE(N);
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000701 }
Eric Christopher6a841382012-11-19 22:42:10 +0000702
Devang Patel07bb9ee2011-08-15 23:47:24 +0000703 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
704 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
705 DIType Ty(NMD->getOperand(i));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000706 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
707 CU->getOrCreateTypeDIE(Ty);
Devang Patel07bb9ee2011-08-15 23:47:24 +0000708 }
Eric Christopher6a841382012-11-19 22:42:10 +0000709
Devang Patel07bb9ee2011-08-15 23:47:24 +0000710 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
711 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
712 DIType Ty(NMD->getOperand(i));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000713 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
714 CU->getOrCreateTypeDIE(Ty);
Devang Patel07bb9ee2011-08-15 23:47:24 +0000715 }
716}
717
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000718// Collect debug info using DebugInfoFinder.
719// FIXME - Remove this when dragonegg switches to DIBuilder.
Eric Christopher58f41952012-11-19 22:42:15 +0000720bool DwarfDebug::collectLegacyDebugInfo(const Module *M) {
Devang Patel07bb9ee2011-08-15 23:47:24 +0000721 DebugInfoFinder DbgFinder;
722 DbgFinder.processModule(*M);
Eric Christopher6a841382012-11-19 22:42:10 +0000723
Devang Patel07bb9ee2011-08-15 23:47:24 +0000724 bool HasDebugInfo = false;
725 // Scan all the compile-units to see if there are any marked as the main
726 // unit. If not, we do not generate debug info.
727 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
728 E = DbgFinder.compile_unit_end(); I != E; ++I) {
729 if (DICompileUnit(*I).isMain()) {
730 HasDebugInfo = true;
731 break;
732 }
733 }
734 if (!HasDebugInfo) return false;
Eric Christopher6a841382012-11-19 22:42:10 +0000735
Devang Patel07bb9ee2011-08-15 23:47:24 +0000736 // Create all the compile unit DIEs.
737 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
738 E = DbgFinder.compile_unit_end(); I != E; ++I)
739 constructCompileUnit(*I);
Eric Christopher6a841382012-11-19 22:42:10 +0000740
Devang Patel07bb9ee2011-08-15 23:47:24 +0000741 // Create DIEs for each global variable.
742 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
743 E = DbgFinder.global_variable_end(); I != E; ++I) {
744 const MDNode *N = *I;
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000745 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
Devang Patel0ecbcbd2011-08-18 23:17:55 +0000746 CU->createGlobalVariableDIE(N);
Devang Patel07bb9ee2011-08-15 23:47:24 +0000747 }
Eric Christopher6a841382012-11-19 22:42:10 +0000748
Devang Patel07bb9ee2011-08-15 23:47:24 +0000749 // Create DIEs for each subprogram.
750 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
751 E = DbgFinder.subprogram_end(); I != E; ++I) {
752 const MDNode *N = *I;
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000753 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
754 constructSubprogramDIE(CU, N);
Devang Patel07bb9ee2011-08-15 23:47:24 +0000755 }
756
757 return HasDebugInfo;
758}
759
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000760// Emit all Dwarf sections that should come prior to the content. Create
761// global DIEs and emit initial debug info sections. This is invoked by
762// the target AsmPrinter.
Eric Christopher58f41952012-11-19 22:42:15 +0000763void DwarfDebug::beginModule() {
Devang Patel6c74a872010-04-27 19:46:33 +0000764 if (DisableDebugInfoPrinting)
765 return;
766
Eric Christopher58f41952012-11-19 22:42:15 +0000767 const Module *M = MMI->getModule();
768
Nick Lewycky019d2552011-07-29 03:49:23 +0000769 // If module has named metadata anchors then use them, otherwise scan the
770 // module using debug info finder to collect debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000771 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
772 if (CU_Nodes) {
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000773 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
774 DICompileUnit CUNode(CU_Nodes->getOperand(i));
775 CompileUnit *CU = constructCompileUnit(CUNode);
776 DIArray GVs = CUNode.getGlobalVariables();
777 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
Devang Patel0ecbcbd2011-08-18 23:17:55 +0000778 CU->createGlobalVariableDIE(GVs.getElement(i));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000779 DIArray SPs = CUNode.getSubprograms();
780 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
781 constructSubprogramDIE(CU, SPs.getElement(i));
782 DIArray EnumTypes = CUNode.getEnumTypes();
783 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
784 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
785 DIArray RetainedTypes = CUNode.getRetainedTypes();
786 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
787 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
788 }
Devang Patel07bb9ee2011-08-15 23:47:24 +0000789 } else if (!collectLegacyDebugInfo(M))
790 return;
Devang Patele02e5852011-05-03 16:45:22 +0000791
Devang Patel07bb9ee2011-08-15 23:47:24 +0000792 collectInfoFromNamedMDNodes(M);
Eric Christopher6a841382012-11-19 22:42:10 +0000793
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000794 // Tell MMI that we have debug info.
795 MMI->setDebugInfoAvailability(true);
Eric Christopher6a841382012-11-19 22:42:10 +0000796
Bill Wendling2b128d72009-05-20 23:19:06 +0000797 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +0000798 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +0000799}
800
Eric Christopher960ac372012-11-22 00:59:49 +0000801// Attach DW_AT_inline attribute with inlined subprogram DIEs.
802void DwarfDebug::computeInlinedDIEs() {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000803 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
804 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000805 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000806 DIE *ISP = *AI;
Devang Patelf20c4f72011-04-12 22:53:02 +0000807 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000808 }
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000809 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000810 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000811 DIE *ISP = AI->second;
812 if (InlinedSubprogramDIEs.count(ISP))
813 continue;
814 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
815 }
Eric Christopher960ac372012-11-22 00:59:49 +0000816}
817
818// Collect info for variables that were optimized out.
819void DwarfDebug::collectDeadVariables() {
820 const Module *M = MMI->getModule();
821 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
822
823 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
824 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
825 DICompileUnit TheCU(CU_Nodes->getOperand(i));
826 DIArray Subprograms = TheCU.getSubprograms();
827 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopher735401c2012-11-27 00:13:51 +0000828 DISubprogram SP(Subprograms.getElement(i));
829 if (ProcessedSPNodes.count(SP) != 0) continue;
830 if (!SP.Verify()) continue;
831 if (!SP.isDefinition()) continue;
832 DIArray Variables = SP.getVariables();
833 if (Variables.getNumElements() == 0) continue;
Eric Christopher960ac372012-11-22 00:59:49 +0000834
Eric Christopher735401c2012-11-27 00:13:51 +0000835 LexicalScope *Scope =
836 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
837 DeadFnScopeMap[SP] = Scope;
Eric Christopher960ac372012-11-22 00:59:49 +0000838
Eric Christopher735401c2012-11-27 00:13:51 +0000839 // Construct subprogram DIE and add variables DIEs.
840 CompileUnit *SPCU = CUMap.lookup(TheCU);
841 assert(SPCU && "Unable to find Compile Unit!");
842 constructSubprogramDIE(SPCU, SP);
843 DIE *ScopeDIE = SPCU->getDIE(SP);
844 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
845 DIVariable DV(Variables.getElement(vi));
846 if (!DV.Verify()) continue;
847 DbgVariable *NewVar = new DbgVariable(DV, NULL);
848 if (DIE *VariableDIE =
849 SPCU->constructVariableDIE(NewVar, Scope->isAbstractScope()))
850 ScopeDIE->addChild(VariableDIE);
851 }
Eric Christopher960ac372012-11-22 00:59:49 +0000852 }
853 }
854 }
855 DeleteContainerSeconds(DeadFnScopeMap);
856}
857
858void DwarfDebug::finalizeModuleInfo() {
859 // Collect info for variables that were optimized out.
860 collectDeadVariables();
861
862 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
863 computeInlinedDIEs();
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000864
Eric Christopherb1b94512012-08-01 18:19:01 +0000865 // Emit DW_AT_containing_type attribute to connect types with their
866 // vtable holding type.
Devang Patel89543712011-08-15 17:24:54 +0000867 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000868 CUE = CUMap.end(); CUI != CUE; ++CUI) {
Devang Patel89543712011-08-15 17:24:54 +0000869 CompileUnit *TheCU = CUI->second;
870 TheCU->constructContainingTypeDIEs();
Devang Pateleb57c592009-12-03 19:11:07 +0000871 }
872
Eric Christopher960ac372012-11-22 00:59:49 +0000873 // Compute DIE offsets and sizes.
874 computeSizeAndOffsets();
875}
876
877void DwarfDebug::endSections() {
Bill Wendling2b128d72009-05-20 23:19:06 +0000878 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +0000879 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnera179b522010-04-04 19:25:43 +0000880 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +0000881 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnera179b522010-04-04 19:25:43 +0000882 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +0000883
884 // End text sections.
Benjamin Kramer15591272012-10-31 13:45:49 +0000885 for (unsigned I = 0, E = SectionMap.size(); I != E; ++I) {
886 Asm->OutStreamer.SwitchSection(SectionMap[I]);
887 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", I+1));
Bill Wendling2b128d72009-05-20 23:19:06 +0000888 }
Eric Christopher960ac372012-11-22 00:59:49 +0000889}
Bill Wendling2b128d72009-05-20 23:19:06 +0000890
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000891// Emit all Dwarf sections that should come after the content.
Eric Christopher960ac372012-11-22 00:59:49 +0000892void DwarfDebug::endModule() {
893
894 if (!FirstCU) return;
895
896 // End any existing sections.
897 // TODO: Does this need to happen?
898 endSections();
899
900 // Finalize the debug info for the module.
901 finalizeModuleInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +0000902
Eric Christophercebb0ec2012-11-19 19:43:59 +0000903 // Emit initial sections.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000904 emitSectionLabels();
Eric Christophercebb0ec2012-11-19 19:43:59 +0000905
Eric Christopher95198f502012-11-27 22:43:42 +0000906 if (!useDwarfFission()) {
907 // Emit all the DIEs into a debug info section.
908 emitDebugInfo();
Eric Christopher4c9b1192012-11-27 00:41:54 +0000909
Eric Christopher95198f502012-11-27 22:43:42 +0000910 // Corresponding abbreviations into a abbrev section.
911 emitAbbreviations();
912
913 // Emit info into a debug loc section.
914 emitDebugLoc();
915
916 // Emit info into a debug aranges section.
917 emitDebugARanges();
918
919 // Emit info into a debug ranges section.
920 emitDebugRanges();
921
922 // Emit info into a debug macinfo section.
923 emitDebugMacInfo();
924
925 // Emit inline info.
926 // TODO: When we don't need the option anymore we
927 // can remove all of the code that this section
928 // depends upon.
929 if (useDarwinGDBCompat())
930 emitDebugInlineInfo();
931 } else {
932 // TODO: Fill this in for Fission sections and separate
933 // out information into new sections.
934
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000935 // Emit the debug info section and compile units.
Eric Christopher95198f502012-11-27 22:43:42 +0000936 emitDebugInfo();
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000937 emitDebugInfoDWO();
Eric Christopher95198f502012-11-27 22:43:42 +0000938
939 // Corresponding abbreviations into a abbrev section.
940 emitAbbreviations();
941
942 // Emit info into a debug loc section.
943 emitDebugLoc();
944
945 // Emit info into a debug aranges section.
946 emitDebugARanges();
947
948 // Emit info into a debug ranges section.
949 emitDebugRanges();
950
951 // Emit info into a debug macinfo section.
952 emitDebugMacInfo();
953
954 // Emit inline info.
955 // TODO: When we don't need the option anymore we
956 // can remove all of the code that this section
957 // depends upon.
958 if (useDarwinGDBCompat())
959 emitDebugInlineInfo();
960 }
Bill Wendling2b128d72009-05-20 23:19:06 +0000961
Eric Christophera876b822012-08-23 07:32:06 +0000962 // Emit info into the dwarf accelerator table sections.
Eric Christopher20b76a72012-08-23 22:36:40 +0000963 if (useDwarfAccelTables()) {
Eric Christopher4996c702011-11-07 09:24:32 +0000964 emitAccelNames();
965 emitAccelObjC();
966 emitAccelNamespaces();
967 emitAccelTypes();
968 }
Eric Christopher6a841382012-11-19 22:42:10 +0000969
Devang Patel04d2f2d2009-11-24 01:14:22 +0000970 // Emit info into a debug pubtypes section.
Eric Christopher77826182012-08-23 07:10:56 +0000971 // TODO: When we don't need the option anymore we can
972 // remove all of the code that adds to the table.
Eric Christopher20b76a72012-08-23 22:36:40 +0000973 if (useDarwinGDBCompat())
Eric Christopher77826182012-08-23 07:10:56 +0000974 emitDebugPubTypes();
Devang Patel04d2f2d2009-11-24 01:14:22 +0000975
Eric Christopher95198f502012-11-27 22:43:42 +0000976 // Finally emit string information into a string table.
Eric Christopher6e20a162012-11-27 06:49:23 +0000977 emitDebugStr();
978
Devang Pateld0701282010-08-02 17:32:15 +0000979 // clean up.
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000980 SPMap.clear();
Devang Patel1a0df9a2010-05-10 22:49:55 +0000981 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
982 E = CUMap.end(); I != E; ++I)
983 delete I->second;
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000984 // Reset these for the next Module if we have one.
985 FirstCU = NULL;
986 FissionCU = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +0000987}
988
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000989// Find abstract variable, if any, associated with Var.
Devang Patelbb23a4a2011-08-10 21:50:54 +0000990DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattner915c5f92010-04-02 19:42:39 +0000991 DebugLoc ScopeLoc) {
Devang Patelbb23a4a2011-08-10 21:50:54 +0000992 LLVMContext &Ctx = DV->getContext();
993 // More then one inlined variable corresponds to one abstract variable.
994 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000995 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000996 if (AbsDbgVariable)
997 return AbsDbgVariable;
998
Devang Patel7e623022011-08-10 20:55:27 +0000999 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001000 if (!Scope)
1001 return NULL;
1002
Devang Patel99819b52011-08-15 19:01:20 +00001003 AbsDbgVariable = new DbgVariable(Var, NULL);
Devang Patel7e623022011-08-10 20:55:27 +00001004 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001005 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001006 return AbsDbgVariable;
1007}
1008
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001009// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel6c622ef2011-03-01 22:58:55 +00001010bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patel7e623022011-08-10 20:55:27 +00001011 DbgVariable *Var, LexicalScope *Scope) {
1012 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +00001013 return false;
1014 DIVariable DV = Var->getVariable();
1015 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1016 return false;
1017 unsigned ArgNo = DV.getArgNumber();
Eric Christopher6a841382012-11-19 22:42:10 +00001018 if (ArgNo == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001019 return false;
1020
Devang Patel4ab660b2011-03-03 20:02:02 +00001021 size_t Size = CurrentFnArguments.size();
1022 if (Size == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001023 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001024 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001025 // arguments does the function have at source level.
1026 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001027 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001028 CurrentFnArguments[ArgNo - 1] = Var;
1029 return true;
1030}
1031
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001032// Collect variable information from side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001033void
Nick Lewycky019d2552011-07-29 03:49:23 +00001034DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patel490c8ab2010-05-20 19:57:06 +00001035 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001036 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1037 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1038 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001039 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001040 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001041 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001042 DIVariable DV(Var);
1043 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001044
Devang Patel7e623022011-08-10 20:55:27 +00001045 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001046
Devang Patelcdb7d442009-11-10 23:20:04 +00001047 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001048 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001049 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001050
Devang Patele1c53f22010-05-20 16:36:41 +00001051 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Devang Patel99819b52011-08-15 19:01:20 +00001052 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable);
Devang Patel3e4a9652011-08-15 21:24:36 +00001053 RegVar->setFrameIndex(VP.first);
Devang Patel6c622ef2011-03-01 22:58:55 +00001054 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001055 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001056 if (AbsDbgVariable)
Devang Patel3e4a9652011-08-15 21:24:36 +00001057 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patel475d32a2009-10-06 01:26:37 +00001058 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001059}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001060
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001061// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1062// defined reg.
Devang Patel9fc11702010-05-25 23:40:22 +00001063static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001064 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001065 return MI->getNumOperands() == 3 &&
1066 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
1067 MI->getOperand(1).isImm() && MI->getOperand(1).getImm() == 0;
Devang Patel9fc11702010-05-25 23:40:22 +00001068}
1069
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001070// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher6a841382012-11-19 22:42:10 +00001071static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1072 const MCSymbol *FLabel,
Devang Patel2442a892011-07-08 17:09:57 +00001073 const MCSymbol *SLabel,
1074 const MachineInstr *MI) {
1075 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1076
1077 if (MI->getNumOperands() != 3) {
1078 MachineLocation MLoc = Asm->getDebugValueLocation(MI);
1079 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1080 }
1081 if (MI->getOperand(0).isReg() && MI->getOperand(1).isImm()) {
1082 MachineLocation MLoc;
1083 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
1084 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1085 }
1086 if (MI->getOperand(0).isImm())
1087 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1088 if (MI->getOperand(0).isFPImm())
1089 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1090 if (MI->getOperand(0).isCImm())
1091 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1092
Craig Topperee4dab52012-02-05 08:31:47 +00001093 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel2442a892011-07-08 17:09:57 +00001094}
1095
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001096// Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001097void
Devang Patel5c0f85c2010-06-25 22:07:34 +00001098DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1099 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001100
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001101 // collection info from MMI table.
Devang Patel490c8ab2010-05-20 19:57:06 +00001102 collectVariableInfoFromMMITable(MF, Processed);
1103
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001104 for (SmallVectorImpl<const MDNode*>::const_iterator
1105 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1106 ++UVI) {
1107 const MDNode *Var = *UVI;
1108 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001109 continue;
1110
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001111 // History contains relevant DBG_VALUE instructions for Var and instructions
1112 // clobbering it.
1113 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1114 if (History.empty())
1115 continue;
1116 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001117
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001118 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001119 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001120 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1121 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +00001122 Scope = LScopes.getCurrentFunctionScope();
Devang Patel8fb9fd62011-07-20 22:18:50 +00001123 else {
1124 if (DV.getVersion() <= LLVMDebugVersion9)
Devang Patel7e623022011-08-10 20:55:27 +00001125 Scope = LScopes.findLexicalScope(MInsn->getDebugLoc());
Devang Patel8fb9fd62011-07-20 22:18:50 +00001126 else {
1127 if (MDNode *IA = DV.getInlinedAt())
Devang Patel7e623022011-08-10 20:55:27 +00001128 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
Devang Patel8fb9fd62011-07-20 22:18:50 +00001129 else
Devang Patel7e623022011-08-10 20:55:27 +00001130 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel8fb9fd62011-07-20 22:18:50 +00001131 }
1132 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001133 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001134 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001135 continue;
1136
1137 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001138 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel99819b52011-08-15 19:01:20 +00001139 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
1140 DbgVariable *RegVar = new DbgVariable(DV, AbsVar);
Devang Patel6c622ef2011-03-01 22:58:55 +00001141 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001142 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001143 if (AbsVar)
Devang Patel3e4a9652011-08-15 21:24:36 +00001144 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001145
Eric Christophercc10d202012-10-08 20:48:54 +00001146 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001147 if (History.size() <= 1 || (History.size() == 2 &&
1148 MInsn->isIdenticalTo(History.back()))) {
Devang Patel3e4a9652011-08-15 21:24:36 +00001149 RegVar->setMInsn(MInsn);
Devang Patel9fc11702010-05-25 23:40:22 +00001150 continue;
1151 }
1152
1153 // handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001154 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001155
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001156 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1157 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1158 const MachineInstr *Begin = *HI;
1159 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001160
Devang Patele7181b52011-06-01 23:00:17 +00001161 // Check if DBG_VALUE is truncating a range.
1162 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1163 && !Begin->getOperand(0).getReg())
1164 continue;
1165
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001166 // Compute the range for a register location.
1167 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1168 const MCSymbol *SLabel = 0;
1169
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001170 if (HI + 1 == HE)
1171 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001172 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001173 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001174 else {
1175 const MachineInstr *End = HI[1];
Eric Christopher6a841382012-11-19 22:42:10 +00001176 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel53b050a2011-07-07 21:44:42 +00001177 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001178 if (End->isDebugValue())
1179 SLabel = getLabelBeforeInsn(End);
1180 else {
1181 // End is a normal instruction clobbering the range.
1182 SLabel = getLabelAfterInsn(End);
1183 assert(SLabel && "Forgot label after clobber instruction");
1184 ++HI;
1185 }
1186 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001187
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001188 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopher365d0832011-12-16 23:42:31 +00001189 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1190 Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001191 }
1192 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001193 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001194
1195 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001196 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1197 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1198 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1199 DIVariable DV(Variables.getElement(i));
1200 if (!DV || !DV.Verify() || !Processed.insert(DV))
1201 continue;
1202 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1203 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patele0a94bf2010-05-14 21:01:35 +00001204 }
Devang Patel9fc11702010-05-25 23:40:22 +00001205}
Devang Patele0a94bf2010-05-14 21:01:35 +00001206
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001207// Return Label preceding the instruction.
Devang Patel9fc11702010-05-25 23:40:22 +00001208const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001209 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1210 assert(Label && "Didn't insert label before instruction");
1211 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001212}
1213
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001214// Return Label immediately following the instruction.
Devang Patel9fc11702010-05-25 23:40:22 +00001215const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001216 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001217}
1218
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001219// Process beginning of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001220void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001221 // Check if source location changes, but ignore DBG_VALUE locations.
1222 if (!MI->isDebugValue()) {
1223 DebugLoc DL = MI->getDebugLoc();
1224 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopheraec8a822012-04-05 20:39:05 +00001225 unsigned Flags = 0;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001226 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001227 if (DL == PrologEndLoc) {
1228 Flags |= DWARF2_FLAG_PROLOGUE_END;
1229 PrologEndLoc = DebugLoc();
1230 }
Eric Christopheraec8a822012-04-05 20:39:05 +00001231 if (PrologEndLoc.isUnknown())
1232 Flags |= DWARF2_FLAG_IS_STMT;
1233
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001234 if (!DL.isUnknown()) {
1235 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001236 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001237 } else
Devang Patel34a66202011-05-11 19:22:19 +00001238 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001239 }
Devang Patel9fc11702010-05-25 23:40:22 +00001240 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001241
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001242 // Insert labels where requested.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001243 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1244 LabelsBeforeInsn.find(MI);
1245
1246 // No label needed.
1247 if (I == LabelsBeforeInsn.end())
1248 return;
1249
1250 // Label already assigned.
1251 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001252 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001253
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001254 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001255 PrevLabel = MMI->getContext().CreateTempSymbol();
1256 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001257 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001258 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001259}
1260
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001261// Process end of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001262void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001263 // Don't create a new label after DBG_VALUE instructions.
1264 // They don't generate code.
1265 if (!MI->isDebugValue())
1266 PrevLabel = 0;
1267
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001268 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1269 LabelsAfterInsn.find(MI);
1270
1271 // No label needed.
1272 if (I == LabelsAfterInsn.end())
1273 return;
1274
1275 // Label already assigned.
1276 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001277 return;
1278
1279 // We need a label after this instruction.
1280 if (!PrevLabel) {
1281 PrevLabel = MMI->getContext().CreateTempSymbol();
1282 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001283 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001284 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001285}
1286
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001287// Each LexicalScope has first instruction and last instruction to mark
1288// beginning and end of a scope respectively. Create an inverse map that list
1289// scopes starts (and ends) with an instruction. One instruction may start (or
1290// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001291void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001292 SmallVector<LexicalScope *, 4> WorkList;
1293 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001294 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001295 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001296
Devang Patel7e623022011-08-10 20:55:27 +00001297 const SmallVector<LexicalScope *, 4> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001298 if (!Children.empty())
Devang Patel7e623022011-08-10 20:55:27 +00001299 for (SmallVector<LexicalScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00001300 SE = Children.end(); SI != SE; ++SI)
1301 WorkList.push_back(*SI);
1302
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001303 if (S->isAbstractScope())
1304 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001305
Devang Patel7e623022011-08-10 20:55:27 +00001306 const SmallVector<InsnRange, 4> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001307 if (Ranges.empty())
1308 continue;
Devang Patel7e623022011-08-10 20:55:27 +00001309 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +00001310 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001311 assert(RI->first && "InsnRange does not have first instruction!");
1312 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001313 requestLabelBeforeInsn(RI->first);
1314 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001315 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001316 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001317}
1318
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001319// Get MDNode for DebugLoc's scope.
Devang Patel589845d2011-05-09 22:14:49 +00001320static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1321 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1322 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1323 return DL.getScope(Ctx);
1324}
1325
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001326// Walk up the scope chain of given debug loc and find line number info
1327// for the function.
Devang Patel34a66202011-05-11 19:22:19 +00001328static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1329 const MDNode *Scope = getScopeNode(DL, Ctx);
1330 DISubprogram SP = getDISubprogram(Scope);
Eric Christopher34164192012-04-03 00:43:49 +00001331 if (SP.Verify()) {
1332 // Check for number of operands since the compatibility is
1333 // cheap here.
Eric Christopherb81e2b42012-04-03 17:55:42 +00001334 if (SP->getNumOperands() > 19)
Eric Christopher34164192012-04-03 00:43:49 +00001335 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1336 else
1337 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1338 }
1339
Devang Patel34a66202011-05-11 19:22:19 +00001340 return DebugLoc();
1341}
1342
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001343// Gather pre-function debug information. Assumes being called immediately
1344// after the function entry point has been emitted.
Chris Lattner76555b52010-01-26 23:18:02 +00001345void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00001346 if (!MMI->hasDebugInfo()) return;
Devang Patel7e623022011-08-10 20:55:27 +00001347 LScopes.initialize(*MF);
1348 if (LScopes.empty()) return;
1349 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001350
Devang Patel6c74a872010-04-27 19:46:33 +00001351 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1352 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001353 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001354 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001355
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001356 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1357
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001358 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001359 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001360 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1361
Devang Patel002d54d2010-05-26 19:37:24 +00001362 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001363 I != E; ++I) {
1364 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001365 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1366 II != IE; ++II) {
1367 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001368
Devang Patel002d54d2010-05-26 19:37:24 +00001369 if (MI->isDebugValue()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001370 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001371
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001372 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001373 const MDNode *Var =
1374 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001375
1376 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001377 if (isDbgValueInDefinedReg(MI))
1378 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1379
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001380 // Check the history of this variable.
1381 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1382 if (History.empty()) {
1383 UserVariables.push_back(Var);
1384 // The first mention of a function argument gets the FunctionBeginSym
1385 // label, so arguments are visible when breaking at function entry.
1386 DIVariable DV(Var);
1387 if (DV.Verify() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1388 DISubprogram(getDISubprogram(DV.getContext()))
1389 .describes(MF->getFunction()))
1390 LabelsBeforeInsn[MI] = FunctionBeginSym;
1391 } else {
1392 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1393 const MachineInstr *Prev = History.back();
1394 if (Prev->isDebugValue()) {
1395 // Coalesce identical entries at the end of History.
1396 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001397 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher85a495e2012-10-08 20:48:49 +00001398 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher6a841382012-11-19 22:42:10 +00001399 << "\t" << *Prev
Devang Patelb7a328e2011-07-07 00:14:27 +00001400 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001401 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001402 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001403
1404 // Terminate old register assignments that don't reach MI;
1405 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1406 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1407 isDbgValueInDefinedReg(Prev)) {
1408 // Previous register assignment needs to terminate at the end of
1409 // its basic block.
1410 MachineBasicBlock::const_iterator LastMI =
1411 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001412 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001413 // Drop DBG_VALUE for empty range.
Eric Christopher85a495e2012-10-08 20:48:49 +00001414 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patelb7a328e2011-07-07 00:14:27 +00001415 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001416 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001417 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001418 else {
1419 // Terminate after LastMI.
1420 History.push_back(LastMI);
1421 }
1422 }
1423 }
1424 }
1425 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001426 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001427 // Not a DBG_VALUE instruction.
1428 if (!MI->isLabel())
1429 AtBlockEntry = false;
1430
Eric Christopher133195782012-10-04 20:46:14 +00001431 // First known non-DBG_VALUE and non-frame setup location marks
1432 // the beginning of the function body.
1433 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1434 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel34a66202011-05-11 19:22:19 +00001435 PrologEndLoc = MI->getDebugLoc();
1436
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001437 // Check if the instruction clobbers any registers with debug vars.
1438 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1439 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1440 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1441 continue;
Jakob Stoklund Olesen54038d72012-06-01 23:28:30 +00001442 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1443 AI.isValid(); ++AI) {
1444 unsigned Reg = *AI;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001445 const MDNode *Var = LiveUserVar[Reg];
1446 if (!Var)
1447 continue;
1448 // Reg is now clobbered.
1449 LiveUserVar[Reg] = 0;
1450
1451 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001452 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1453 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001454 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001455 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1456 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001457 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001458 const MachineInstr *Prev = History.back();
1459 // Sanity-check: Register assignments are terminated at the end of
1460 // their block.
1461 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1462 continue;
1463 // Is the variable still in Reg?
1464 if (!isDbgValueInDefinedReg(Prev) ||
1465 Prev->getOperand(0).getReg() != Reg)
1466 continue;
1467 // Var is clobbered. Make sure the next instruction gets a label.
1468 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001469 }
1470 }
Devang Patel002d54d2010-05-26 19:37:24 +00001471 }
Devang Patel002d54d2010-05-26 19:37:24 +00001472 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001473 }
1474
1475 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1476 I != E; ++I) {
1477 SmallVectorImpl<const MachineInstr*> &History = I->second;
1478 if (History.empty())
1479 continue;
1480
1481 // Make sure the final register assignments are terminated.
1482 const MachineInstr *Prev = History.back();
1483 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1484 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher6a841382012-11-19 22:42:10 +00001485 MachineBasicBlock::const_iterator LastMI =
Devang Patel784077e2011-08-10 23:58:09 +00001486 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001487 if (LastMI == PrevMBB->end())
1488 // Drop DBG_VALUE for empty range.
1489 History.pop_back();
1490 else {
1491 // Terminate after LastMI.
1492 History.push_back(LastMI);
1493 }
1494 }
1495 // Request labels for the full history.
1496 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1497 const MachineInstr *MI = History[i];
1498 if (MI->isDebugValue())
1499 requestLabelBeforeInsn(MI);
1500 else
1501 requestLabelAfterInsn(MI);
1502 }
1503 }
Devang Patel002d54d2010-05-26 19:37:24 +00001504
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001505 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001506 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001507
1508 // Record beginning of function.
1509 if (!PrologEndLoc.isUnknown()) {
1510 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1511 MF->getFunction()->getContext());
1512 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1513 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie67cb31e2012-12-04 22:02:33 +00001514 // We'd like to list the prologue as "not statements" but GDB behaves
1515 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikie5a773bb2012-12-04 21:05:36 +00001516 DWARF2_FLAG_IS_STMT);
Devang Patel34a66202011-05-11 19:22:19 +00001517 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001518}
1519
Devang Patel7e623022011-08-10 20:55:27 +00001520void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1521// SmallVector<DbgVariable *, 8> &Vars = ScopeVariables.lookup(LS);
1522 ScopeVariables[LS].push_back(Var);
1523// Vars.push_back(Var);
1524}
1525
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001526// Gather and emit post-function debug information.
Chris Lattner76555b52010-01-26 23:18:02 +00001527void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patel7e623022011-08-10 20:55:27 +00001528 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00001529
Devang Patel7e623022011-08-10 20:55:27 +00001530 // Define end label for subprogram.
1531 FunctionEndSym = Asm->GetTempSymbol("func_end",
1532 Asm->getFunctionNumber());
1533 // Assumes in correct section after the entry point.
1534 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Eric Christopher6a841382012-11-19 22:42:10 +00001535
Devang Patel7e623022011-08-10 20:55:27 +00001536 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1537 collectVariableInfo(MF, ProcessedVars);
Eric Christopher6a841382012-11-19 22:42:10 +00001538
Devang Patel3acc70e2011-08-15 22:04:40 +00001539 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001540 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001541 assert(TheCU && "Unable to find compile unit!");
Devang Patel3acc70e2011-08-15 22:04:40 +00001542
Devang Patel7e623022011-08-10 20:55:27 +00001543 // Construct abstract scopes.
Devang Patel44403472011-08-12 18:10:19 +00001544 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1545 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1546 LexicalScope *AScope = AList[i];
1547 DISubprogram SP(AScope->getScopeNode());
Devang Patel7e623022011-08-10 20:55:27 +00001548 if (SP.Verify()) {
1549 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001550 DIArray Variables = SP.getVariables();
1551 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1552 DIVariable DV(Variables.getElement(i));
1553 if (!DV || !DV.Verify() || !ProcessedVars.insert(DV))
1554 continue;
Alexey Samsonov39602782012-07-06 08:45:08 +00001555 // Check that DbgVariable for DV wasn't created earlier, when
1556 // findAbstractVariable() was called for inlined instance of DV.
1557 LLVMContext &Ctx = DV->getContext();
1558 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1559 if (AbstractVariables.lookup(CleanDV))
1560 continue;
Devang Patel59e27c52011-08-19 23:28:12 +00001561 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1562 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001563 }
1564 }
Devang Patel44403472011-08-12 18:10:19 +00001565 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Devang Patel3acc70e2011-08-15 22:04:40 +00001566 constructScopeDIE(TheCU, AScope);
Bill Wendling2b128d72009-05-20 23:19:06 +00001567 }
Eric Christopher6a841382012-11-19 22:42:10 +00001568
Devang Patel3acc70e2011-08-15 22:04:40 +00001569 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher6a841382012-11-19 22:42:10 +00001570
Nick Lewycky50f02cb2011-12-02 22:16:29 +00001571 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopherbb69a272012-08-24 01:14:27 +00001572 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Patel3acc70e2011-08-15 22:04:40 +00001573
Devang Patel7e623022011-08-10 20:55:27 +00001574 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
1575 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00001576
Bill Wendling2b128d72009-05-20 23:19:06 +00001577 // Clear debug info
Devang Patel7e623022011-08-10 20:55:27 +00001578 for (DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >::iterator
1579 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1580 DeleteContainerPointers(I->second);
1581 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001582 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001583 UserVariables.clear();
1584 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001585 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001586 LabelsBeforeInsn.clear();
1587 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001588 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001589}
1590
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001591// Register a source line with debug info. Returns the unique label that was
1592// emitted and which provides correspondence to the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00001593void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1594 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00001595 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00001596 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00001597 unsigned Src = 1;
1598 if (S) {
1599 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00001600
Dan Gohman50849c62010-05-05 23:41:32 +00001601 if (Scope.isCompileUnit()) {
1602 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001603 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001604 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00001605 } else if (Scope.isFile()) {
1606 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00001607 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001608 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001609 } else if (Scope.isSubprogram()) {
1610 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001611 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001612 Dir = SP.getDirectory();
Eric Christopher6647b832011-10-11 22:59:11 +00001613 } else if (Scope.isLexicalBlockFile()) {
1614 DILexicalBlockFile DBF(S);
1615 Fn = DBF.getFilename();
1616 Dir = DBF.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001617 } else if (Scope.isLexicalBlock()) {
1618 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001619 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001620 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001621 } else
Craig Topperee4dab52012-02-05 08:31:47 +00001622 llvm_unreachable("Unexpected scope info");
Dan Gohman50849c62010-05-05 23:41:32 +00001623
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001624 Src = getOrCreateSourceID(Fn, Dir);
Dan Gohman50849c62010-05-05 23:41:32 +00001625 }
Nick Lewycky019d2552011-07-29 03:49:23 +00001626 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00001627}
1628
Bill Wendling806535f2009-05-20 23:22:40 +00001629//===----------------------------------------------------------------------===//
1630// Emit Methods
1631//===----------------------------------------------------------------------===//
1632
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001633// Compute the size and offset of a DIE.
Jim Grosbach00e9c612009-11-22 19:20:36 +00001634unsigned
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001635DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling480ff322009-05-20 23:21:38 +00001636 // Get the children.
1637 const std::vector<DIE *> &Children = Die->getChildren();
1638
Bill Wendling480ff322009-05-20 23:21:38 +00001639 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00001640 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00001641
1642 // Get the abbreviation for this DIE.
1643 unsigned AbbrevNumber = Die->getAbbrevNumber();
1644 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1645
1646 // Set DIE offset
1647 Die->setOffset(Offset);
1648
1649 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00001650 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001651
1652 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
1653 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1654
1655 // Size the DIE attribute values.
1656 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1657 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001658 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001659
1660 // Size the DIE children if any.
1661 if (!Children.empty()) {
1662 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1663 "Children flag not set");
1664
1665 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001666 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling480ff322009-05-20 23:21:38 +00001667
1668 // End of children marker.
1669 Offset += sizeof(int8_t);
1670 }
1671
1672 Die->setSize(Offset - Die->getOffset());
1673 return Offset;
1674}
1675
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001676// Compute the size and offset of all the DIEs.
Devang Patel930143b2009-11-21 02:48:08 +00001677void DwarfDebug::computeSizeAndOffsets() {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001678 if (FissionCU) {
1679 unsigned Offset =
1680 sizeof(int32_t) + // Length of Compilation Unit Info
1681 sizeof(int16_t) + // DWARF version number
1682 sizeof(int32_t) + // Offset Into Abbrev. Section
1683 sizeof(int8_t); // Pointer Size (in bytes)
1684
1685 computeSizeAndOffset(FissionCU->getCUDie(), Offset);
1686 }
Devang Patel1a0df9a2010-05-10 22:49:55 +00001687 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1688 E = CUMap.end(); I != E; ++I) {
1689 // Compute size of compile unit header.
Eric Christopher6a841382012-11-19 22:42:10 +00001690 unsigned Offset =
Devang Patel1a0df9a2010-05-10 22:49:55 +00001691 sizeof(int32_t) + // Length of Compilation Unit Info
1692 sizeof(int16_t) + // DWARF version number
1693 sizeof(int32_t) + // Offset Into Abbrev. Section
1694 sizeof(int8_t); // Pointer Size (in bytes)
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001695 computeSizeAndOffset(I->second->getCUDie(), Offset);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001696 }
Bill Wendling480ff322009-05-20 23:21:38 +00001697}
1698
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001699// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001700void DwarfDebug::emitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001701 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001702
Bill Wendling480ff322009-05-20 23:21:38 +00001703 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001704 DwarfInfoSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001705 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001706 DwarfAbbrevSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001707 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
1708 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001709
Chris Lattner6629ca92010-04-04 22:59:04 +00001710 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001711 emitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00001712
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001713 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
1714 emitSectionSym(Asm, TLOF.getDwarfLocSection());
1715 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001716 DwarfStrSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001717 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
1718 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patel12563b32010-04-16 23:33:45 +00001719 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00001720
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001721 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patel9fc11702010-05-25 23:40:22 +00001722 "section_debug_loc");
1723
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001724 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
1725 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00001726}
1727
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001728// Recursively emits a debug information entry.
Devang Patel930143b2009-11-21 02:48:08 +00001729void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00001730 // Get the abbreviation for this DIE.
1731 unsigned AbbrevNumber = Die->getAbbrevNumber();
1732 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1733
Bill Wendling480ff322009-05-20 23:21:38 +00001734 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00001735 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00001736 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
1737 Twine::utohexstr(Die->getOffset()) + ":0x" +
1738 Twine::utohexstr(Die->getSize()) + " " +
1739 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00001740 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001741
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00001742 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00001743 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1744
1745 // Emit the DIE attribute values.
1746 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1747 unsigned Attr = AbbrevData[i].getAttribute();
1748 unsigned Form = AbbrevData[i].getForm();
1749 assert(Form && "Too many attributes for DIE (check abbreviation)");
1750
Chris Lattner7bde8c02010-04-04 18:52:31 +00001751 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00001752 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001753
Bill Wendling480ff322009-05-20 23:21:38 +00001754 switch (Attr) {
Bill Wendling480ff322009-05-20 23:21:38 +00001755 case dwarf::DW_AT_abstract_origin: {
1756 DIEEntry *E = cast<DIEEntry>(Values[i]);
1757 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001758 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00001759 Asm->EmitInt32(Addr);
1760 break;
1761 }
Devang Patel12563b32010-04-16 23:33:45 +00001762 case dwarf::DW_AT_ranges: {
1763 // DW_AT_range Value encodes offset in debug_range section.
1764 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00001765
Nick Lewycky33da3362012-06-22 01:25:12 +00001766 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelda3ef852010-09-02 16:43:44 +00001767 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
1768 V->getValue(),
1769 4);
1770 } else {
1771 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
1772 V->getValue(),
1773 DwarfDebugRangeSectionSym,
1774 4);
1775 }
Devang Patel12563b32010-04-16 23:33:45 +00001776 break;
1777 }
Devang Patel9fc11702010-05-25 23:40:22 +00001778 case dwarf::DW_AT_location: {
Nick Lewycky33da3362012-06-22 01:25:12 +00001779 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
1780 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
1781 Asm->EmitLabelReference(L->getValue(), 4);
1782 else
1783 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
1784 } else {
Devang Patel9fc11702010-05-25 23:40:22 +00001785 Values[i]->EmitValue(Asm, Form);
Nick Lewycky33da3362012-06-22 01:25:12 +00001786 }
Devang Patel9fc11702010-05-25 23:40:22 +00001787 break;
1788 }
Devang Patela1bd5a12010-09-29 19:08:08 +00001789 case dwarf::DW_AT_accessibility: {
1790 if (Asm->isVerbose()) {
1791 DIEInteger *V = cast<DIEInteger>(Values[i]);
1792 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
1793 }
1794 Values[i]->EmitValue(Asm, Form);
1795 break;
1796 }
Bill Wendling480ff322009-05-20 23:21:38 +00001797 default:
1798 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001799 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00001800 break;
1801 }
Bill Wendling480ff322009-05-20 23:21:38 +00001802 }
1803
1804 // Emit the DIE children if any.
1805 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
1806 const std::vector<DIE *> &Children = Die->getChildren();
1807
1808 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00001809 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00001810
Chris Lattner7bde8c02010-04-04 18:52:31 +00001811 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00001812 Asm->OutStreamer.AddComment("End Of Children Mark");
1813 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00001814 }
1815}
1816
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001817void DwarfDebug::emitCompileUnits(const MCSection *Section) {
1818 Asm->OutStreamer.SwitchSection(Section);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001819 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1820 E = CUMap.end(); I != E; ++I) {
1821 CompileUnit *TheCU = I->second;
1822 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001823
Devang Patel1a0df9a2010-05-10 22:49:55 +00001824 // Emit the compile units header.
1825 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
Eli Benderskyb42d1462012-12-03 18:45:45 +00001826 TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001827
Devang Patel1a0df9a2010-05-10 22:49:55 +00001828 // Emit size of content not including length itself
1829 unsigned ContentSize = Die->getSize() +
1830 sizeof(int16_t) + // DWARF version number
1831 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patele141234942011-04-13 19:41:17 +00001832 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001833
Devang Patel1a0df9a2010-05-10 22:49:55 +00001834 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
1835 Asm->EmitInt32(ContentSize);
1836 Asm->OutStreamer.AddComment("DWARF version number");
1837 Asm->EmitInt16(dwarf::DWARF_VERSION);
1838 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
1839 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
1840 DwarfAbbrevSectionSym);
1841 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth5da3f052012-11-01 09:14:31 +00001842 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001843
Devang Patel1a0df9a2010-05-10 22:49:55 +00001844 emitDIE(Die);
Eli Benderskyb42d1462012-12-03 18:45:45 +00001845 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end",
1846 TheCU->getUniqueID()));
Devang Patel1a0df9a2010-05-10 22:49:55 +00001847 }
Bill Wendling480ff322009-05-20 23:21:38 +00001848}
1849
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001850// Emit the debug info section.
1851void DwarfDebug::emitDebugInfo() {
1852 if (!useDwarfFission())
1853 emitCompileUnits(Asm->getObjFileLowering().getDwarfInfoSection());
1854 else
1855 emitFissionSkeletonCU(Asm->getObjFileLowering().getDwarfInfoSection());
1856}
1857
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001858// Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +00001859void DwarfDebug::emitAbbreviations() {
Bill Wendling480ff322009-05-20 23:21:38 +00001860 // Check to see if it is worth the effort.
1861 if (!Abbreviations.empty()) {
1862 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001863 Asm->OutStreamer.SwitchSection(
1864 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00001865
Chris Lattnera179b522010-04-04 19:25:43 +00001866 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00001867
1868 // For each abbrevation.
1869 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
1870 // Get abbreviation data
1871 const DIEAbbrev *Abbrev = Abbreviations[i];
1872
1873 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00001874 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00001875
1876 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001877 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00001878 }
1879
1880 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00001881 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00001882
Chris Lattnera179b522010-04-04 19:25:43 +00001883 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00001884 }
1885}
1886
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001887// Emit the last address of the section and the end of the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +00001888void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00001889 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00001890 Asm->OutStreamer.AddComment("Extended Op");
1891 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001892
Chris Lattner566cae92010-03-09 23:52:58 +00001893 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth5da3f052012-11-01 09:14:31 +00001894 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00001895 Asm->OutStreamer.AddComment("DW_LNE_set_address");
1896 Asm->EmitInt8(dwarf::DW_LNE_set_address);
1897
1898 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00001899
Chris Lattnera179b522010-04-04 19:25:43 +00001900 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chandler Carruth5da3f052012-11-01 09:14:31 +00001901 Asm->getDataLayout().getPointerSize(),
Chris Lattner3a383cb2010-04-05 00:13:49 +00001902 0/*AddrSpace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00001903
1904 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00001905 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
1906 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00001907 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00001908 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00001909}
1910
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001911// Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00001912void DwarfDebug::emitAccelNames() {
1913 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1914 dwarf::DW_FORM_data4));
1915 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1916 E = CUMap.end(); I != E; ++I) {
1917 CompileUnit *TheCU = I->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00001918 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
1919 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00001920 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1921 const char *Name = GI->getKeyData();
Eric Christopher090fcc12012-01-06 23:03:34 +00001922 const std::vector<DIE *> &Entities = GI->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00001923 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1924 DE = Entities.end(); DI != DE; ++DI)
1925 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00001926 }
1927 }
1928
1929 AT.FinalizeTable(Asm, "Names");
1930 Asm->OutStreamer.SwitchSection(
1931 Asm->getObjFileLowering().getDwarfAccelNamesSection());
1932 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
1933 Asm->OutStreamer.EmitLabel(SectionBegin);
1934
1935 // Emit the full data.
1936 AT.Emit(Asm, SectionBegin, this);
1937}
1938
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001939// Emit objective C classes and categories into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00001940void DwarfDebug::emitAccelObjC() {
1941 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1942 dwarf::DW_FORM_data4));
1943 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1944 E = CUMap.end(); I != E; ++I) {
1945 CompileUnit *TheCU = I->second;
1946 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
1947 for (StringMap<std::vector<DIE*> >::const_iterator
1948 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1949 const char *Name = GI->getKeyData();
Eric Christopher090fcc12012-01-06 23:03:34 +00001950 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher4996c702011-11-07 09:24:32 +00001951 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1952 DE = Entities.end(); DI != DE; ++DI)
1953 AT.AddName(Name, (*DI));
1954 }
1955 }
1956
1957 AT.FinalizeTable(Asm, "ObjC");
1958 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
1959 .getDwarfAccelObjCSection());
1960 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
1961 Asm->OutStreamer.EmitLabel(SectionBegin);
1962
1963 // Emit the full data.
1964 AT.Emit(Asm, SectionBegin, this);
1965}
1966
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001967// Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00001968void DwarfDebug::emitAccelNamespaces() {
1969 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1970 dwarf::DW_FORM_data4));
1971 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1972 E = CUMap.end(); I != E; ++I) {
1973 CompileUnit *TheCU = I->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00001974 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
1975 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00001976 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1977 const char *Name = GI->getKeyData();
Eric Christopher090fcc12012-01-06 23:03:34 +00001978 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00001979 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1980 DE = Entities.end(); DI != DE; ++DI)
1981 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00001982 }
1983 }
1984
1985 AT.FinalizeTable(Asm, "namespac");
1986 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
1987 .getDwarfAccelNamespaceSection());
1988 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
1989 Asm->OutStreamer.EmitLabel(SectionBegin);
1990
1991 // Emit the full data.
1992 AT.Emit(Asm, SectionBegin, this);
1993}
1994
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001995// Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00001996void DwarfDebug::emitAccelTypes() {
Eric Christopher21bde872012-01-06 04:35:23 +00001997 std::vector<DwarfAccelTable::Atom> Atoms;
1998 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1999 dwarf::DW_FORM_data4));
2000 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTag,
2001 dwarf::DW_FORM_data2));
2002 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTypeFlags,
2003 dwarf::DW_FORM_data1));
2004 DwarfAccelTable AT(Atoms);
Eric Christopher4996c702011-11-07 09:24:32 +00002005 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2006 E = CUMap.end(); I != E; ++I) {
2007 CompileUnit *TheCU = I->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002008 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2009 = TheCU->getAccelTypes();
2010 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002011 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2012 const char *Name = GI->getKeyData();
Eric Christopher090fcc12012-01-06 23:03:34 +00002013 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002014 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2015 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2016 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher4996c702011-11-07 09:24:32 +00002017 }
2018 }
2019
2020 AT.FinalizeTable(Asm, "types");
2021 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2022 .getDwarfAccelTypesSection());
2023 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2024 Asm->OutStreamer.EmitLabel(SectionBegin);
2025
2026 // Emit the full data.
2027 AT.Emit(Asm, SectionBegin, this);
2028}
2029
Devang Patel04d2f2d2009-11-24 01:14:22 +00002030void DwarfDebug::emitDebugPubTypes() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002031 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2032 E = CUMap.end(); I != E; ++I) {
2033 CompileUnit *TheCU = I->second;
Eric Christopher6abc9c52011-11-07 09:18:35 +00002034 // Start the dwarf pubtypes section.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002035 Asm->OutStreamer.SwitchSection(
2036 Asm->getObjFileLowering().getDwarfPubTypesSection());
2037 Asm->OutStreamer.AddComment("Length of Public Types Info");
2038 Asm->EmitLabelDifference(
Eli Benderskyb42d1462012-12-03 18:45:45 +00002039 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2040 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002041
Devang Patel1a0df9a2010-05-10 22:49:55 +00002042 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
Eli Benderskyb42d1462012-12-03 18:45:45 +00002043 TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002044
Devang Patel1a0df9a2010-05-10 22:49:55 +00002045 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
2046 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002047
Devang Patel1a0df9a2010-05-10 22:49:55 +00002048 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eli Benderskyb42d1462012-12-03 18:45:45 +00002049 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin",
2050 TheCU->getUniqueID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00002051 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002052
Devang Patel1a0df9a2010-05-10 22:49:55 +00002053 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eli Benderskyb42d1462012-12-03 18:45:45 +00002054 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end",
2055 TheCU->getUniqueID()),
2056 Asm->GetTempSymbol("info_begin",
2057 TheCU->getUniqueID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00002058 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002059
Devang Patel1a0df9a2010-05-10 22:49:55 +00002060 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
2061 for (StringMap<DIE*>::const_iterator
2062 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2063 const char *Name = GI->getKeyData();
Nick Lewycky019d2552011-07-29 03:49:23 +00002064 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002065
Devang Patel1a0df9a2010-05-10 22:49:55 +00002066 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
2067 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002068
Devang Patel1a0df9a2010-05-10 22:49:55 +00002069 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002070 // Emit the name with a terminating null byte.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002071 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
2072 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002073
Devang Patel1a0df9a2010-05-10 22:49:55 +00002074 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002075 Asm->EmitInt32(0);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002076 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
Eli Benderskyb42d1462012-12-03 18:45:45 +00002077 TheCU->getUniqueID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00002078 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002079}
2080
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002081// Emit visible names into a debug str section.
Devang Patel930143b2009-11-21 02:48:08 +00002082void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00002083 // Check to see if it is worth the effort.
Chris Lattner3d72a672010-03-09 23:38:23 +00002084 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002085
Chris Lattner3d72a672010-03-09 23:38:23 +00002086 // Start the dwarf str section.
2087 Asm->OutStreamer.SwitchSection(
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002088 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002089
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002090 // Get all of the string pool entries and put them in an array by their ID so
2091 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002092 SmallVector<std::pair<unsigned,
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002093 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002094
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002095 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
2096 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
2097 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002098
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002099 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002100
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002101 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002102 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002103 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002104
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002105 // Emit the string itself with a terminating null byte.
Benjamin Kramer148db362011-11-09 12:12:04 +00002106 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
2107 Entries[i].second->getKeyLength()+1),
2108 0/*addrspace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00002109 }
2110}
2111
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002112// Emit visible names into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002113void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002114 if (DotDebugLocEntries.empty())
2115 return;
2116
Devang Patel116a9d72011-02-04 22:57:18 +00002117 for (SmallVector<DotDebugLocEntry, 4>::iterator
2118 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2119 I != E; ++I) {
2120 DotDebugLocEntry &Entry = *I;
2121 if (I + 1 != DotDebugLocEntries.end())
2122 Entry.Merge(I+1);
2123 }
2124
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002125 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002126 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00002127 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002128 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002129 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2130 unsigned index = 1;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002131 for (SmallVector<DotDebugLocEntry, 4>::iterator
2132 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002133 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002134 DotDebugLocEntry &Entry = *I;
2135 if (Entry.isMerged()) continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002136 if (Entry.isEmpty()) {
2137 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
2138 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002139 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002140 } else {
2141 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
2142 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
Devang Patel3e021532011-04-28 02:22:40 +00002143 DIVariable DV(Entry.Variable);
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002144 Asm->OutStreamer.AddComment("Loc expr size");
2145 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2146 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2147 Asm->EmitLabelDifference(end, begin, 2);
2148 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002149 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002150 DIBasicType BTy(DV.getType());
2151 if (BTy.Verify() &&
Eric Christopher6a841382012-11-19 22:42:10 +00002152 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patel324f8432011-06-01 22:03:25 +00002153 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2154 Asm->OutStreamer.AddComment("DW_OP_consts");
2155 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002156 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002157 } else {
2158 Asm->OutStreamer.AddComment("DW_OP_constu");
2159 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002160 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002161 }
Devang Pateled9fd452011-07-08 16:49:43 +00002162 } else if (Entry.isLocation()) {
Eric Christopher6a841382012-11-19 22:42:10 +00002163 if (!DV.hasComplexAddress())
Devang Pateled9fd452011-07-08 16:49:43 +00002164 // Regular entry.
Devang Patel3e021532011-04-28 02:22:40 +00002165 Asm->EmitDwarfRegOp(Entry.Loc);
Devang Pateled9fd452011-07-08 16:49:43 +00002166 else {
2167 // Complex address entry.
2168 unsigned N = DV.getNumAddrElements();
2169 unsigned i = 0;
2170 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
2171 if (Entry.Loc.getOffset()) {
2172 i = 2;
2173 Asm->EmitDwarfRegOp(Entry.Loc);
2174 Asm->OutStreamer.AddComment("DW_OP_deref");
2175 Asm->EmitInt8(dwarf::DW_OP_deref);
2176 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2177 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2178 Asm->EmitSLEB128(DV.getAddrElement(1));
2179 } else {
2180 // If first address element is OpPlus then emit
2181 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
2182 MachineLocation Loc(Entry.Loc.getReg(), DV.getAddrElement(1));
2183 Asm->EmitDwarfRegOp(Loc);
2184 i = 2;
2185 }
2186 } else {
2187 Asm->EmitDwarfRegOp(Entry.Loc);
2188 }
Eric Christopher6a841382012-11-19 22:42:10 +00002189
Devang Pateled9fd452011-07-08 16:49:43 +00002190 // Emit remaining complex address elements.
2191 for (; i < N; ++i) {
2192 uint64_t Element = DV.getAddrElement(i);
2193 if (Element == DIBuilder::OpPlus) {
2194 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2195 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher4d250522012-05-08 18:56:00 +00002196 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher8d2a77d2012-05-08 21:24:39 +00002197 if (!Entry.Loc.isReg())
Eric Christopher4d250522012-05-08 18:56:00 +00002198 Asm->EmitInt8(dwarf::DW_OP_deref);
2199 } else
2200 llvm_unreachable("unknown Opcode found in complex address");
Devang Pateled9fd452011-07-08 16:49:43 +00002201 }
Devang Patel3e021532011-04-28 02:22:40 +00002202 }
Devang Patel3e021532011-04-28 02:22:40 +00002203 }
Devang Pateled9fd452011-07-08 16:49:43 +00002204 // else ... ignore constant fp. There is not any good way to
2205 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002206 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002207 }
2208 }
Bill Wendling480ff322009-05-20 23:21:38 +00002209}
2210
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002211// Emit visible names into a debug aranges section.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002212void DwarfDebug::emitDebugARanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002213 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002214 Asm->OutStreamer.SwitchSection(
2215 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002216}
2217
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002218// Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002219void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002220 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002221 Asm->OutStreamer.SwitchSection(
Devang Patel12563b32010-04-16 23:33:45 +00002222 Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002223 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6c74a872010-04-27 19:46:33 +00002224 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002225 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00002226 I != E; ++I) {
2227 if (*I)
2228 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patel12563b32010-04-16 23:33:45 +00002229 else
Devang Patel6c74a872010-04-27 19:46:33 +00002230 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel12563b32010-04-16 23:33:45 +00002231 }
Bill Wendling480ff322009-05-20 23:21:38 +00002232}
2233
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002234// Emit visible names into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002235void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002236 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00002237 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00002238 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002239 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00002240 }
2241}
2242
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002243// Emit inline info using following format.
2244// Section Header:
2245// 1. length of section
2246// 2. Dwarf version number
2247// 3. address size.
2248//
2249// Entries (one "entry" for each function that was inlined):
2250//
2251// 1. offset into __debug_str section for MIPS linkage name, if exists;
2252// otherwise offset into __debug_str for regular function name.
2253// 2. offset into __debug_str section for regular function name.
2254// 3. an unsigned LEB128 number indicating the number of distinct inlining
2255// instances for the function.
2256//
2257// The rest of the entry consists of a {die_offset, low_pc} pair for each
2258// inlined instance; the die_offset points to the inlined_subroutine die in the
2259// __debug_info section, and the low_pc is the starting address for the
2260// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00002261void DwarfDebug::emitDebugInlineInfo() {
Eric Christopher1df94bf2012-03-02 02:11:47 +00002262 if (!Asm->MAI->doesDwarfUseInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00002263 return;
2264
Devang Patel1a0df9a2010-05-10 22:49:55 +00002265 if (!FirstCU)
Bill Wendling480ff322009-05-20 23:21:38 +00002266 return;
2267
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002268 Asm->OutStreamer.SwitchSection(
2269 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002270
Chris Lattner566cae92010-03-09 23:52:58 +00002271 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00002272 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
2273 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00002274
Chris Lattnera179b522010-04-04 19:25:43 +00002275 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00002276
Chris Lattner566cae92010-03-09 23:52:58 +00002277 Asm->OutStreamer.AddComment("Dwarf Version");
2278 Asm->EmitInt16(dwarf::DWARF_VERSION);
2279 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002280 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002281
Devang Patel32cc43c2010-05-07 20:54:48 +00002282 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002283 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00002284
Devang Patel32cc43c2010-05-07 20:54:48 +00002285 const MDNode *Node = *I;
2286 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00002287 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002288 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00002289 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00002290 StringRef LName = SP.getLinkageName();
2291 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00002292
Chris Lattner566cae92010-03-09 23:52:58 +00002293 Asm->OutStreamer.AddComment("MIPS linkage name");
Eric Christopher77725312012-03-02 01:57:52 +00002294 if (LName.empty())
2295 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
2296 else
Chris Lattner70a4fce2010-04-04 23:25:33 +00002297 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
2298 DwarfStrSectionSym);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002299
Chris Lattner566cae92010-03-09 23:52:58 +00002300 Asm->OutStreamer.AddComment("Function name");
Chris Lattner70a4fce2010-04-04 23:25:33 +00002301 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner9efd1182010-04-04 19:09:29 +00002302 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00002303
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002304 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00002305 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner7bde8c02010-04-04 18:52:31 +00002306 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner085b6522010-03-09 00:31:02 +00002307 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00002308
Chris Lattner7bde8c02010-04-04 18:52:31 +00002309 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattner3a383cb2010-04-05 00:13:49 +00002310 Asm->OutStreamer.EmitSymbolValue(LI->first,
Chandler Carruth5da3f052012-11-01 09:14:31 +00002311 Asm->getDataLayout().getPointerSize(),0);
Bill Wendling480ff322009-05-20 23:21:38 +00002312 }
2313 }
2314
Chris Lattnera179b522010-04-04 19:25:43 +00002315 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00002316}
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002317
2318// DWARF5 Experimental Fission emitters.
2319
2320// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2321// DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2322// DW_AT_ranges_base, DW_AT_addr_base. If DW_AT_ranges is present,
2323// DW_AT_low_pc and DW_AT_high_pc are not used, and vice versa.
2324CompileUnit *DwarfDebug::constructFissionCU(const MDNode *N) {
2325 DICompileUnit DIUnit(N);
2326 StringRef FN = DIUnit.getFilename();
2327 CompilationDir = DIUnit.getDirectory();
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002328
2329 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyb42d1462012-12-03 18:45:45 +00002330 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
2331 DIUnit.getLanguage(), Die, Asm, this);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002332 // FIXME: This should be the .dwo file.
2333 NewCU->addString(Die, dwarf::DW_AT_GNU_dwo_name, FN);
2334
2335 // FIXME: We also need DW_AT_addr_base and DW_AT_dwo_id.
2336
2337 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
2338 // into an entity.
2339 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
2340 // DW_AT_stmt_list is a offset of line number information for this
2341 // compile unit in debug_line section.
2342 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2343 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
2344 Asm->GetTempSymbol("section_line"));
2345 else
2346 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
2347
2348 if (!CompilationDir.empty())
2349 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
2350
2351 return NewCU;
2352}
2353
2354void DwarfDebug::emitFissionSkeletonCU(const MCSection *Section) {
2355 Asm->OutStreamer.SwitchSection(Section);
2356 DIE *Die = FissionCU->getCUDie();
2357
2358 // Emit the compile units header.
2359 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("skel_info_begin",
Eli Benderskyb42d1462012-12-03 18:45:45 +00002360 FissionCU->getUniqueID()));
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002361
2362 // Emit size of content not including length itself
2363 unsigned ContentSize = Die->getSize() +
2364 sizeof(int16_t) + // DWARF version number
2365 sizeof(int32_t) + // Offset Into Abbrev. Section
2366 sizeof(int8_t); // Pointer Size (in bytes)
2367
2368 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2369 Asm->EmitInt32(ContentSize);
2370 Asm->OutStreamer.AddComment("DWARF version number");
2371 Asm->EmitInt16(dwarf::DWARF_VERSION);
2372 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
2373 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
2374 DwarfAbbrevSectionSym);
2375 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2376 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
2377
2378 emitDIE(Die);
Eli Benderskyb42d1462012-12-03 18:45:45 +00002379 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("skel_info_end",
2380 FissionCU->getUniqueID()));
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002381
2382
2383}
2384
2385// Emit the .debug_info.dwo section for fission. This contains the compile
2386// units that would normally be in debug_info.
2387void DwarfDebug::emitDebugInfoDWO() {
2388 assert(useDwarfFission() && "Got fission?");
2389 emitCompileUnits(Asm->getObjFileLowering().getDwarfInfoDWOSection());
2390}