blob: 5d19a8d765e3751a84907afec1e8aed3b0e06be3 [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/DIBuilder.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000026#include "llvm/DebugInfo.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000027#include "llvm/IR/Constants.h"
28#include "llvm/IR/DataLayout.h"
29#include "llvm/IR/Instructions.h"
30#include "llvm/IR/Module.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000031#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000032#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000033#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000034#include "llvm/MC/MCSymbol.h"
Devang Patel6c74a872010-04-27 19:46:33 +000035#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000036#include "llvm/Support/Debug.h"
37#include "llvm/Support/ErrorHandling.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000038#include "llvm/Support/FormattedStream.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000039#include "llvm/Support/Path.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000040#include "llvm/Support/Timer.h"
41#include "llvm/Support/ValueHandle.h"
42#include "llvm/Target/TargetFrameLowering.h"
43#include "llvm/Target/TargetLoweringObjectFile.h"
44#include "llvm/Target/TargetMachine.h"
45#include "llvm/Target/TargetOptions.h"
46#include "llvm/Target/TargetRegisterInfo.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000047using namespace llvm;
48
Jim Grosbacha8683bb2010-07-21 21:21:52 +000049static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel30265c42010-07-07 20:12:52 +000050 cl::Hidden,
Devang Patel6c74a872010-04-27 19:46:33 +000051 cl::desc("Disable debug info printing"));
52
Dan Gohman7421ae42010-05-07 01:08:53 +000053static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
Chris Lattner0ab5e2c2011-04-15 05:18:47 +000054 cl::desc("Make an absence of debug location information explicit."),
Dan Gohman7421ae42010-05-07 01:08:53 +000055 cl::init(false));
56
Eric Christopher20b76a72012-08-23 22:36:40 +000057namespace {
58 enum DefaultOnOff {
59 Default, Enable, Disable
60 };
61}
Eric Christopher4996c702011-11-07 09:24:32 +000062
Eric Christopher20b76a72012-08-23 22:36:40 +000063static cl::opt<DefaultOnOff> DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
64 cl::desc("Output prototype dwarf accelerator tables."),
65 cl::values(
66 clEnumVal(Default, "Default for platform"),
67 clEnumVal(Enable, "Enabled"),
68 clEnumVal(Disable, "Disabled"),
69 clEnumValEnd),
70 cl::init(Default));
71
72static cl::opt<DefaultOnOff> DarwinGDBCompat("darwin-gdb-compat", cl::Hidden,
Eric Christopher978fbff2012-08-23 07:10:46 +000073 cl::desc("Compatibility with Darwin gdb."),
Eric Christopher20b76a72012-08-23 22:36:40 +000074 cl::values(
75 clEnumVal(Default, "Default for platform"),
76 clEnumVal(Enable, "Enabled"),
77 clEnumVal(Disable, "Disabled"),
78 clEnumValEnd),
79 cl::init(Default));
Eric Christopher978fbff2012-08-23 07:10:46 +000080
Eric Christophercdf218d2012-12-10 19:51:21 +000081static cl::opt<DefaultOnOff> SplitDwarf("split-dwarf", cl::Hidden,
82 cl::desc("Output prototype dwarf split debug info."),
Eric Christopher29424312012-11-12 22:22:20 +000083 cl::values(
84 clEnumVal(Default, "Default for platform"),
85 clEnumVal(Enable, "Enabled"),
86 clEnumVal(Disable, "Disabled"),
87 clEnumValEnd),
88 cl::init(Default));
89
Bill Wendlingfcc14142010-04-07 09:28:04 +000090namespace {
91 const char *DWARFGroupName = "DWARF Emission";
92 const char *DbgTimerName = "DWARF Debug Writer";
93} // end anonymous namespace
94
Bill Wendling2f921f82009-05-15 09:23:25 +000095//===----------------------------------------------------------------------===//
96
Eric Christopheracdcbdb2012-11-27 22:43:45 +000097// Configuration values for initial hash set sizes (log2).
98//
Bill Wendling2f921f82009-05-15 09:23:25 +000099static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +0000100
101namespace llvm {
102
Nick Lewycky019d2552011-07-29 03:49:23 +0000103DIType DbgVariable::getType() const {
Devang Patelf20c4f72011-04-12 22:53:02 +0000104 DIType Ty = Var.getType();
105 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
106 // addresses instead.
107 if (Var.isBlockByrefVariable()) {
108 /* Byref variables, in Blocks, are declared by the programmer as
109 "SomeType VarName;", but the compiler creates a
110 __Block_byref_x_VarName struct, and gives the variable VarName
111 either the struct, or a pointer to the struct, as its type. This
112 is necessary for various behind-the-scenes things the compiler
113 needs to do with by-reference variables in blocks.
Eric Christopher6a841382012-11-19 22:42:10 +0000114
Devang Patelf20c4f72011-04-12 22:53:02 +0000115 However, as far as the original *programmer* is concerned, the
116 variable should still have type 'SomeType', as originally declared.
Eric Christopher6a841382012-11-19 22:42:10 +0000117
Devang Patelf20c4f72011-04-12 22:53:02 +0000118 The following function dives into the __Block_byref_x_VarName
119 struct to find the original type of the variable. This will be
120 passed back to the code generating the type for the Debug
121 Information Entry for the variable 'VarName'. 'VarName' will then
122 have the original type 'SomeType' in its debug information.
Eric Christopher6a841382012-11-19 22:42:10 +0000123
Devang Patelf20c4f72011-04-12 22:53:02 +0000124 The original type 'SomeType' will be the type of the field named
125 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher6a841382012-11-19 22:42:10 +0000126
Devang Patelf20c4f72011-04-12 22:53:02 +0000127 NOTE: In order for this to not completely fail on the debugger
128 side, the Debug Information Entry for the variable VarName needs to
129 have a DW_AT_location that tells the debugger how to unwind through
130 the pointers and __Block_byref_x_VarName struct to find the actual
131 value of the variable. The function addBlockByrefType does this. */
132 DIType subType = Ty;
133 unsigned tag = Ty.getTag();
Eric Christopher6a841382012-11-19 22:42:10 +0000134
Devang Patelf20c4f72011-04-12 22:53:02 +0000135 if (tag == dwarf::DW_TAG_pointer_type) {
136 DIDerivedType DTy = DIDerivedType(Ty);
137 subType = DTy.getTypeDerivedFrom();
138 }
Eric Christopher6a841382012-11-19 22:42:10 +0000139
Devang Patelf20c4f72011-04-12 22:53:02 +0000140 DICompositeType blockStruct = DICompositeType(subType);
141 DIArray Elements = blockStruct.getTypeArray();
Eric Christopher6a841382012-11-19 22:42:10 +0000142
Devang Patelf20c4f72011-04-12 22:53:02 +0000143 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
144 DIDescriptor Element = Elements.getElement(i);
145 DIDerivedType DT = DIDerivedType(Element);
146 if (getName() == DT.getName())
147 return (DT.getTypeDerivedFrom());
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000148 }
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000149 }
Devang Patelf20c4f72011-04-12 22:53:02 +0000150 return Ty;
151}
Bill Wendling2f921f82009-05-15 09:23:25 +0000152
Chris Lattnerf5d06362010-04-05 04:09:20 +0000153} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000154
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000155DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Eric Christopherd79f5482012-12-10 19:51:13 +0000156 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000157 AbbreviationsSet(InitAbbreviationsSetSize),
Eric Christopher27614582013-01-08 22:22:06 +0000158 SourceIdMap(DIEValueAllocator),
Eric Christopherc8a310e2012-12-10 23:34:43 +0000159 PrevLabel(NULL), GlobalCUIndexCount(0),
Eric Christopher27614582013-01-08 22:22:06 +0000160 InfoHolder(A, &AbbreviationsSet, &Abbreviations, "info_string",
161 DIEValueAllocator),
Eric Christopher3c5a1912012-12-19 22:02:53 +0000162 SkeletonAbbrevSet(InitAbbreviationsSetSize),
Eric Christopher27614582013-01-08 22:22:06 +0000163 SkeletonHolder(A, &SkeletonAbbrevSet, &SkeletonAbbrevs, "skel_string",
164 DIEValueAllocator) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000165
Rafael Espindolaa7160962011-05-06 14:56:22 +0000166 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattnere58b5472010-04-04 23:10:38 +0000167 DwarfStrSectionSym = TextSectionSym = 0;
Eric Christopher74804332013-02-07 21:19:50 +0000168 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000169 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000170 FunctionBeginSym = FunctionEndSym = 0;
Eric Christopherad9fe892012-04-02 17:58:52 +0000171
Eric Christopher978fbff2012-08-23 07:10:46 +0000172 // Turn on accelerator tables and older gdb compatibility
173 // for Darwin.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000174 bool IsDarwin = Triple(M->getTargetTriple()).isOSDarwin();
Eric Christopher20b76a72012-08-23 22:36:40 +0000175 if (DarwinGDBCompat == Default) {
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000176 if (IsDarwin)
177 IsDarwinGDBCompat = true;
Eric Christopher20b76a72012-08-23 22:36:40 +0000178 else
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000179 IsDarwinGDBCompat = false;
Eric Christopher20b76a72012-08-23 22:36:40 +0000180 } else
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000181 IsDarwinGDBCompat = DarwinGDBCompat == Enable ? true : false;
Eric Christopher4977f212012-08-23 22:36:36 +0000182
Eric Christopher20b76a72012-08-23 22:36:40 +0000183 if (DwarfAccelTables == Default) {
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000184 if (IsDarwin)
185 HasDwarfAccelTables = true;
Eric Christopher20b76a72012-08-23 22:36:40 +0000186 else
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000187 HasDwarfAccelTables = false;
Eric Christopher20b76a72012-08-23 22:36:40 +0000188 } else
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000189 HasDwarfAccelTables = DwarfAccelTables == Enable ? true : false;
Eric Christopher20b76a72012-08-23 22:36:40 +0000190
Eric Christophercdf218d2012-12-10 19:51:21 +0000191 if (SplitDwarf == Default)
192 HasSplitDwarf = false;
Eric Christopher29424312012-11-12 22:22:20 +0000193 else
Eric Christophercdf218d2012-12-10 19:51:21 +0000194 HasSplitDwarf = SplitDwarf == Enable ? true : false;
Eric Christopher29424312012-11-12 22:22:20 +0000195
Dan Gohman6e681a52010-06-18 15:56:31 +0000196 {
197 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopher58f41952012-11-19 22:42:15 +0000198 beginModule();
Torok Edwinf8dba242010-04-07 10:44:46 +0000199 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000200}
201DwarfDebug::~DwarfDebug() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000202}
203
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000204// Switch to the specified MCSection and emit an assembler
205// temporary label to it if SymbolStem is specified.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000206static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christophera7b61892011-11-07 09:18:38 +0000207 const char *SymbolStem = 0) {
208 Asm->OutStreamer.SwitchSection(Section);
209 if (!SymbolStem) return 0;
210
211 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
212 Asm->OutStreamer.EmitLabel(TmpSym);
213 return TmpSym;
214}
215
Eric Christophere698f532012-12-20 21:58:36 +0000216MCSymbol *DwarfUnits::getStringPoolSym() {
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000217 return Asm->GetTempSymbol(StringPref);
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000218}
219
Eric Christophere698f532012-12-20 21:58:36 +0000220MCSymbol *DwarfUnits::getStringPoolEntry(StringRef Str) {
221 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopher27614582013-01-08 22:22:06 +0000222 StringPool.GetOrCreateValue(Str).getValue();
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000223 if (Entry.first) return Entry.first;
224
225 Entry.second = NextStringPoolNumber++;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000226 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000227}
228
Eric Christopher2cbd5762013-01-07 19:32:41 +0000229unsigned DwarfUnits::getStringPoolIndex(StringRef Str) {
230 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopher27614582013-01-08 22:22:06 +0000231 StringPool.GetOrCreateValue(Str).getValue();
Eric Christopher2cbd5762013-01-07 19:32:41 +0000232 if (Entry.first) return Entry.second;
233
234 Entry.second = NextStringPoolNumber++;
235 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
236 return Entry.second;
237}
238
Eric Christopher962c9082013-01-15 23:56:56 +0000239unsigned DwarfUnits::getAddrPoolIndex(MCSymbol *Sym) {
240 std::pair<MCSymbol*, unsigned> &Entry = AddressPool[Sym];
241 if (Entry.first) return Entry.second;
242
243 Entry.second = NextAddrPoolNumber++;
244 Entry.first = Sym;
245 return Entry.second;
246}
247
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000248// Define a unique number for the abbreviation.
249//
Eric Christopherc8a310e2012-12-10 23:34:43 +0000250void DwarfUnits::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000251 // Profile the node so that we can make it unique.
252 FoldingSetNodeID ID;
253 Abbrev.Profile(ID);
254
255 // Check the set for priors.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000256 DIEAbbrev *InSet = AbbreviationsSet->GetOrInsertNode(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000257
258 // If it's newly added.
259 if (InSet == &Abbrev) {
260 // Add to abbreviation list.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000261 Abbreviations->push_back(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000262
263 // Assign the vector position + 1 as its number.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000264 Abbrev.setNumber(Abbreviations->size());
Bill Wendling2f921f82009-05-15 09:23:25 +0000265 } else {
266 // Assign existing abbreviation number.
267 Abbrev.setNumber(InSet->getNumber());
268 }
269}
270
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000271// If special LLVM prefix that is used to inform the asm
272// printer to not emit usual symbol prefix before the symbol name is used then
273// return linkage name after skipping this special LLVM prefix.
Devang Patel43ef34d2010-01-05 01:46:14 +0000274static StringRef getRealLinkageName(StringRef LinkageName) {
275 char One = '\1';
276 if (LinkageName.startswith(StringRef(&One, 1)))
277 return LinkageName.substr(1);
278 return LinkageName;
279}
280
Eric Christopherd9843b32011-11-10 19:25:34 +0000281static bool isObjCClass(StringRef Name) {
282 return Name.startswith("+") || Name.startswith("-");
283}
284
285static bool hasObjCCategory(StringRef Name) {
286 if (!isObjCClass(Name)) return false;
287
288 size_t pos = Name.find(')');
289 if (pos != std::string::npos) {
290 if (Name[pos+1] != ' ') return false;
291 return true;
292 }
293 return false;
294}
295
296static void getObjCClassCategory(StringRef In, StringRef &Class,
297 StringRef &Category) {
298 if (!hasObjCCategory(In)) {
299 Class = In.slice(In.find('[') + 1, In.find(' '));
300 Category = "";
301 return;
302 }
303
304 Class = In.slice(In.find('[') + 1, In.find('('));
305 Category = In.slice(In.find('[') + 1, In.find(' '));
306 return;
307}
308
309static StringRef getObjCMethodName(StringRef In) {
310 return In.slice(In.find(' ') + 1, In.find(']'));
311}
312
313// Add the various names to the Dwarf accelerator table names.
314static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
315 DIE* Die) {
316 if (!SP.isDefinition()) return;
Eric Christopher6a841382012-11-19 22:42:10 +0000317
Eric Christopherd9843b32011-11-10 19:25:34 +0000318 TheCU->addAccelName(SP.getName(), Die);
319
320 // If the linkage name is different than the name, go ahead and output
321 // that as well into the name table.
322 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
323 TheCU->addAccelName(SP.getLinkageName(), Die);
324
325 // If this is an Objective-C selector name add it to the ObjC accelerator
326 // too.
327 if (isObjCClass(SP.getName())) {
328 StringRef Class, Category;
329 getObjCClassCategory(SP.getName(), Class, Category);
330 TheCU->addAccelObjC(Class, Die);
331 if (Category != "")
332 TheCU->addAccelObjC(Category, Die);
333 // Also add the base method name to the name table.
334 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
335 }
336}
337
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000338// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
339// and DW_AT_high_pc attributes. If there are global variables in this
340// scope then create and insert DIEs for these variables.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000341DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
342 const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000343 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +0000344
Chris Lattner3a383cb2010-04-05 00:13:49 +0000345 assert(SPDie && "Unable to find subprogram DIE!");
346 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000347
Bill Wendlingf720bf62012-11-07 05:19:04 +0000348 // If we're updating an abstract DIE, then we will be adding the children and
349 // object pointer later on. But what we don't want to do is process the
350 // concrete DIE twice.
Devang Patela37a95e2010-07-07 22:20:57 +0000351 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
Bill Wendlingf720bf62012-11-07 05:19:04 +0000352 // Pick up abstract subprogram DIE.
Devang Patela37a95e2010-07-07 22:20:57 +0000353 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf20c4f72011-04-12 22:53:02 +0000354 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
355 dwarf::DW_FORM_ref4, AbsSPDIE);
Devang Patela37a95e2010-07-07 22:20:57 +0000356 SPCU->addDie(SPDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000357 } else {
358 DISubprogram SPDecl = SP.getFunctionDeclaration();
359 if (!SPDecl.isSubprogram()) {
360 // There is not any need to generate specification DIE for a function
361 // defined at compile unit level. If a function is defined inside another
362 // function then gdb prefers the definition at top level and but does not
363 // expect specification DIE in parent function. So avoid creating
364 // specification DIE for a function defined inside a function.
365 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
366 !SP.getContext().isFile() &&
367 !isSubprogramContext(SP.getContext())) {
368 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
369
370 // Add arguments.
371 DICompositeType SPTy = SP.getType();
372 DIArray Args = SPTy.getTypeArray();
373 unsigned SPTag = SPTy.getTag();
374 if (SPTag == dwarf::DW_TAG_subroutine_type)
375 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
376 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
377 DIType ATy = DIType(Args.getElement(i));
378 SPCU->addType(Arg, ATy);
379 if (ATy.isArtificial())
380 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
381 if (ATy.isObjectPointer())
382 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer,
383 dwarf::DW_FORM_ref4, Arg);
384 SPDie->addChild(Arg);
385 }
386 DIE *SPDeclDie = SPDie;
387 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Eric Christopher6a841382012-11-19 22:42:10 +0000388 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification,
389 dwarf::DW_FORM_ref4, SPDeclDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000390 SPCU->addDie(SPDie);
391 }
392 }
Devang Patela37a95e2010-07-07 22:20:57 +0000393 }
394
Eric Christopher962c9082013-01-15 23:56:56 +0000395 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc,
396 Asm->GetTempSymbol("func_begin",
397 Asm->getFunctionNumber()));
398 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
399 Asm->GetTempSymbol("func_end",
400 Asm->getFunctionNumber()));
Chris Lattner3a383cb2010-04-05 00:13:49 +0000401 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
402 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000403 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000404
Eric Christopherd9843b32011-11-10 19:25:34 +0000405 // Add name to the name table, we do this here because we're guaranteed
406 // to have concrete versions of our DW_TAG_subprogram nodes.
407 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher6a841382012-11-19 22:42:10 +0000408
Chris Lattner3a383cb2010-04-05 00:13:49 +0000409 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000410}
411
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000412// Construct new DW_TAG_lexical_block for this scope and attach
413// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher6a841382012-11-19 22:42:10 +0000414DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000415 LexicalScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +0000416 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
417 if (Scope->isAbstractScope())
418 return ScopeDIE;
419
Devang Patel7e623022011-08-10 20:55:27 +0000420 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +0000421 if (Ranges.empty())
422 return 0;
423
Devang Patel7e623022011-08-10 20:55:27 +0000424 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel6c74a872010-04-27 19:46:33 +0000425 if (Ranges.size() > 1) {
426 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000427 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +0000428 // DW_AT_ranges appropriately.
Devang Patelf20c4f72011-04-12 22:53:02 +0000429 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000430 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000431 * Asm->getDataLayout().getPointerSize());
Devang Patel7e623022011-08-10 20:55:27 +0000432 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +0000433 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +0000434 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
435 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +0000436 }
437 DebugRangeSymbols.push_back(NULL);
438 DebugRangeSymbols.push_back(NULL);
439 return ScopeDIE;
440 }
441
Eric Christopher962c9082013-01-15 23:56:56 +0000442 MCSymbol *Start = getLabelBeforeInsn(RI->first);
443 MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +0000444
Devang Patel9fc11702010-05-25 23:40:22 +0000445 if (End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000446
Chris Lattnere13c3722010-03-09 01:58:53 +0000447 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
448 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000449
Eric Christopher962c9082013-01-15 23:56:56 +0000450 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
451 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000452
453 return ScopeDIE;
454}
455
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000456// This scope represents inlined body of a function. Construct DIE to
457// represent this concrete inlined copy of the function.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000458DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
459 LexicalScope *Scope) {
Devang Patel7e623022011-08-10 20:55:27 +0000460 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000461 assert(Ranges.empty() == false &&
462 "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000463
Devang Patelf098ce22011-07-27 00:34:13 +0000464 if (!Scope->getScopeNode())
465 return NULL;
466 DIScope DS(Scope->getScopeNode());
467 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patelf098ce22011-07-27 00:34:13 +0000468 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
469 if (!OriginDIE) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000470 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patelf098ce22011-07-27 00:34:13 +0000471 return NULL;
472 }
473
Devang Patel7e623022011-08-10 20:55:27 +0000474 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
Eric Christopher962c9082013-01-15 23:56:56 +0000475 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
476 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +0000477
Devang Patel4c6bd662010-07-08 22:39:20 +0000478 if (StartLabel == 0 || EndLabel == 0) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000479 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +0000480 }
Chris Lattnere13c3722010-03-09 01:58:53 +0000481 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +0000482 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +0000483 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +0000484 "Invalid end label for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +0000485
Devang Patel73bc1722011-05-05 17:54:26 +0000486 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Devang Patelf20c4f72011-04-12 22:53:02 +0000487 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
488 dwarf::DW_FORM_ref4, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000489
Devang Patelf098ce22011-07-27 00:34:13 +0000490 if (Ranges.size() > 1) {
491 // .debug_range section has not been laid out yet. Emit offset in
492 // .debug_range as a uint, size 4, for now. emitDIE will handle
493 // DW_AT_ranges appropriately.
494 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000495 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000496 * Asm->getDataLayout().getPointerSize());
Devang Patel7e623022011-08-10 20:55:27 +0000497 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patelf098ce22011-07-27 00:34:13 +0000498 RE = Ranges.end(); RI != RE; ++RI) {
499 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
500 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
501 }
502 DebugRangeSymbols.push_back(NULL);
503 DebugRangeSymbols.push_back(NULL);
504 } else {
Eric Christopher962c9082013-01-15 23:56:56 +0000505 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
506 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patelf098ce22011-07-27 00:34:13 +0000507 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000508
509 InlinedSubprogramDIEs.insert(OriginDIE);
510
511 // Track the start label for this inlined function.
Devang Patelf098ce22011-07-27 00:34:13 +0000512 //.debug_inlined section specification does not clearly state how
513 // to emit inlined scope that is split into multiple instruction ranges.
514 // For now, use first instruction range and emit low_pc/high_pc pair and
515 // corresponding .debug_inlined section entry for this pair.
Devang Patel32cc43c2010-05-07 20:54:48 +0000516 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000517 I = InlineInfo.find(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000518
519 if (I == InlineInfo.end()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000520 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000521 InlinedSPNodes.push_back(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000522 } else
Chris Lattner085b6522010-03-09 00:31:02 +0000523 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000524
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000525 DILocation DL(Scope->getInlinedAt());
Eric Christopher0925c622012-03-26 21:38:38 +0000526 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0,
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000527 getOrCreateSourceID(DL.getFilename(), DL.getDirectory()));
Devang Patelf20c4f72011-04-12 22:53:02 +0000528 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000529
Eric Christopher8dda5d02011-12-04 06:02:38 +0000530 // Add name to the name table, we do this here because we're guaranteed
531 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
532 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher6a841382012-11-19 22:42:10 +0000533
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000534 return ScopeDIE;
535}
536
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000537// Construct a DIE for this scope.
Devang Patel3acc70e2011-08-15 22:04:40 +0000538DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000539 if (!Scope || !Scope->getScopeNode())
540 return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000541
Manman Ren53f3f9f2013-01-31 20:05:14 +0000542 DIScope DS(Scope->getScopeNode());
543 // Early return to avoid creating dangling variable|scope DIEs.
544 if (!Scope->getInlinedAt() && DS.isSubprogram() && Scope->isAbstractScope() &&
545 !TheCU->getDIE(DS))
546 return NULL;
547
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000548 SmallVector<DIE *, 8> Children;
Eric Christophere3417762012-09-12 23:36:19 +0000549 DIE *ObjectPointer = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +0000550
551 // Collect arguments for current function.
Devang Patel7e623022011-08-10 20:55:27 +0000552 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000553 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
554 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher6a841382012-11-19 22:42:10 +0000555 if (DIE *Arg =
Eric Christophere3417762012-09-12 23:36:19 +0000556 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel6c622ef2011-03-01 22:58:55 +0000557 Children.push_back(Arg);
Eric Christophere3417762012-09-12 23:36:19 +0000558 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
559 }
Devang Patel6c622ef2011-03-01 22:58:55 +0000560
Eric Christopherf84354b2011-10-03 15:49:16 +0000561 // Collect lexical scope children first.
Devang Patel7e623022011-08-10 20:55:27 +0000562 const SmallVector<DbgVariable *, 8> &Variables = ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000563 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher6a841382012-11-19 22:42:10 +0000564 if (DIE *Variable =
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000565 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000566 Children.push_back(Variable);
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000567 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
568 }
Devang Patel7e623022011-08-10 20:55:27 +0000569 const SmallVector<LexicalScope *, 4> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000570 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Patel3acc70e2011-08-15 22:04:40 +0000571 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000572 Children.push_back(Nested);
Devang Patel3b548aa2010-03-08 20:52:55 +0000573 DIE *ScopeDIE = NULL;
574 if (Scope->getInlinedAt())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000575 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3b548aa2010-03-08 20:52:55 +0000576 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000577 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000578 if (Scope->isAbstractScope()) {
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000579 ScopeDIE = TheCU->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000580 // Note down abstract DIE.
581 if (ScopeDIE)
582 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
583 }
Devang Patel3b548aa2010-03-08 20:52:55 +0000584 else
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000585 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3b548aa2010-03-08 20:52:55 +0000586 }
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000587 else {
588 // There is no need to emit empty lexical block DIE.
589 if (Children.empty())
590 return NULL;
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000591 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000592 }
Eric Christopher6a841382012-11-19 22:42:10 +0000593
Devang Patel23b2ae62010-03-29 22:59:58 +0000594 if (!ScopeDIE) return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000595
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000596 // Add children
597 for (SmallVector<DIE *, 8>::iterator I = Children.begin(),
598 E = Children.end(); I != E; ++I)
599 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000600
Eric Christophere3417762012-09-12 23:36:19 +0000601 if (DS.isSubprogram() && ObjectPointer != NULL)
602 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer,
603 dwarf::DW_FORM_ref4, ObjectPointer);
604
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000605 if (DS.isSubprogram())
Eric Christopherd9843b32011-11-10 19:25:34 +0000606 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000607
Eric Christopherd9843b32011-11-10 19:25:34 +0000608 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000609}
610
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000611// Look up the source id with the given directory and source file names.
612// If none currently exists, create a new id and insert it in the
613// SourceIds map. This can update DirectoryNames and SourceFileNames maps
614// as well.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000615unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Devang Patele01b75c2011-03-24 20:30:50 +0000616 StringRef DirName) {
Devang Patel871d0b12010-09-16 20:57:49 +0000617 // If FE did not provide a file name, then assume stdin.
618 if (FileName.empty())
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000619 return getOrCreateSourceID("<stdin>", StringRef());
Devang Patele01b75c2011-03-24 20:30:50 +0000620
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000621 // TODO: this might not belong here. See if we can factor this better.
622 if (DirName == CompilationDir)
623 DirName = "";
624
Nick Lewycky40f8f2f2011-10-17 23:05:28 +0000625 unsigned SrcId = SourceIdMap.size()+1;
Devang Patel871d0b12010-09-16 20:57:49 +0000626
Benjamin Kramer71b19732012-03-11 14:56:26 +0000627 // We look up the file/dir pair by concatenating them with a zero byte.
628 SmallString<128> NamePair;
629 NamePair += DirName;
630 NamePair += '\0'; // Zero bytes are not allowed in paths.
631 NamePair += FileName;
632
633 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
634 if (Ent.getValue() != SrcId)
635 return Ent.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +0000636
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000637 // Print out a .file directive to specify files for .loc directives.
Benjamin Kramer71b19732012-03-11 14:56:26 +0000638 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName);
Bill Wendling2b128d72009-05-20 23:19:06 +0000639
640 return SrcId;
641}
642
Eric Christopher48fef592012-12-20 21:58:40 +0000643// Create new CompileUnit for the given metadata node with tag
644// DW_TAG_compile_unit.
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000645CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +0000646 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +0000647 StringRef FN = DIUnit.getFilename();
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000648 CompilationDir = DIUnit.getDirectory();
Eli Benderskyb42d1462012-12-03 18:45:45 +0000649 // Call this to emit a .file directive if it wasn't emitted for the source
650 // file this CU comes from yet.
651 getOrCreateSourceID(FN, CompilationDir);
Bill Wendling2b128d72009-05-20 23:19:06 +0000652
653 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyb42d1462012-12-03 18:45:45 +0000654 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
Eric Christophere698f532012-12-20 21:58:36 +0000655 DIUnit.getLanguage(), Die, Asm,
656 this, &InfoHolder);
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000657 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patelf20c4f72011-04-12 22:53:02 +0000658 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
659 DIUnit.getLanguage());
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000660 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christopherb1b94512012-08-01 18:19:01 +0000661 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher962c9082013-01-15 23:56:56 +0000662 // into an entity. We're using 0 (or a NULL label) for this.
663 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
Manman Ren4e042a62013-02-05 21:52:47 +0000664
665 // Define start line table label for each Compile Unit.
666 MCSymbol *LineTableStartSym = Asm->GetTempSymbol("line_table_start",
667 NewCU->getUniqueID());
668 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
669 NewCU->getUniqueID());
670
Devang Pateld22ed622010-03-22 23:11:36 +0000671 // DW_AT_stmt_list is a offset of line number information for this
Devang Patel4a213872010-08-24 00:06:12 +0000672 // compile unit in debug_line section.
Rafael Espindolad7bdaf52012-06-22 13:24:07 +0000673 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Rafael Espindolaa7558912011-05-04 17:44:06 +0000674 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Manman Ren4e042a62013-02-05 21:52:47 +0000675 LineTableStartSym);
Manman Rend2c38d62013-02-06 00:59:41 +0000676 else if (NewCU->getUniqueID() == 0)
677 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Devang Patelea636392010-08-31 23:50:19 +0000678 else
Manman Ren4e042a62013-02-05 21:52:47 +0000679 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Eric Christopher74804332013-02-07 21:19:50 +0000680 LineTableStartSym, DwarfLineSectionSym);
Bill Wendling2b128d72009-05-20 23:19:06 +0000681
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000682 if (!CompilationDir.empty())
683 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Bill Wendling2b128d72009-05-20 23:19:06 +0000684 if (DIUnit.isOptimized())
Eric Christopherbb69a272012-08-24 01:14:27 +0000685 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendling2b128d72009-05-20 23:19:06 +0000686
Devang Patel2d9caf92009-11-25 17:36:49 +0000687 StringRef Flags = DIUnit.getFlags();
688 if (!Flags.empty())
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000689 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher6a841382012-11-19 22:42:10 +0000690
Nick Lewycky479a8fe2011-10-17 23:27:36 +0000691 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patelf20c4f72011-04-12 22:53:02 +0000692 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +0000693 dwarf::DW_FORM_data1, RVer);
694
Devang Patel1a0df9a2010-05-10 22:49:55 +0000695 if (!FirstCU)
696 FirstCU = NewCU;
Eric Christopher7a2cdf72013-02-05 07:31:55 +0000697
Eric Christopher411e6742013-02-05 07:32:03 +0000698 if (useSplitDwarf()) {
699 // This should be a unique identifier when we want to build .dwp files.
Eric Christopher7a2cdf72013-02-05 07:31:55 +0000700 NewCU->addUInt(Die, dwarf::DW_AT_GNU_dwo_id, dwarf::DW_FORM_data8, 0);
Eric Christopher411e6742013-02-05 07:32:03 +0000701 // Now construct the skeleton CU associated.
702 constructSkeletonCU(N);
703 }
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000704
Eric Christopherc8a310e2012-12-10 23:34:43 +0000705 InfoHolder.addUnit(NewCU);
706
Devang Patel1a0df9a2010-05-10 22:49:55 +0000707 CUMap.insert(std::make_pair(N, NewCU));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000708 return NewCU;
Devang Patel1a0df9a2010-05-10 22:49:55 +0000709}
710
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000711// Construct subprogram DIE.
Eric Christopher6a841382012-11-19 22:42:10 +0000712void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
Devang Patel1f4f98d2011-08-15 23:36:40 +0000713 const MDNode *N) {
Rafael Espindola6cf4e832011-11-04 19:00:29 +0000714 CompileUnit *&CURef = SPMap[N];
715 if (CURef)
716 return;
717 CURef = TheCU;
718
Devang Patel80ae3492009-08-28 23:24:31 +0000719 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000720 if (!SP.isDefinition())
721 // This is a method declaration which will be handled while constructing
722 // class type.
Devang Patel0751a282009-06-26 01:49:18 +0000723 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000724
Devang Patel89543712011-08-15 17:24:54 +0000725 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000726
727 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000728 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +0000729
730 // Add to context owner.
Devang Patelf20c4f72011-04-12 22:53:02 +0000731 TheCU->addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +0000732
Devang Patel0751a282009-06-26 01:49:18 +0000733 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000734}
735
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000736// Collect debug info from named mdnodes such as llvm.dbg.enum and llvm.dbg.ty.
Eric Christopher58f41952012-11-19 22:42:15 +0000737void DwarfDebug::collectInfoFromNamedMDNodes(const Module *M) {
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000738 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.sp"))
739 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
740 const MDNode *N = NMD->getOperand(i);
741 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
742 constructSubprogramDIE(CU, N);
743 }
Eric Christopher6a841382012-11-19 22:42:10 +0000744
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000745 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.gv"))
746 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
747 const MDNode *N = NMD->getOperand(i);
748 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
Devang Patel0ecbcbd2011-08-18 23:17:55 +0000749 CU->createGlobalVariableDIE(N);
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000750 }
Eric Christopher6a841382012-11-19 22:42:10 +0000751
Devang Patel07bb9ee2011-08-15 23:47:24 +0000752 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
753 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
754 DIType Ty(NMD->getOperand(i));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000755 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
756 CU->getOrCreateTypeDIE(Ty);
Devang Patel07bb9ee2011-08-15 23:47:24 +0000757 }
Eric Christopher6a841382012-11-19 22:42:10 +0000758
Devang Patel07bb9ee2011-08-15 23:47:24 +0000759 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
760 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
761 DIType Ty(NMD->getOperand(i));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000762 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
763 CU->getOrCreateTypeDIE(Ty);
Devang Patel07bb9ee2011-08-15 23:47:24 +0000764 }
765}
766
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000767// Collect debug info using DebugInfoFinder.
768// FIXME - Remove this when dragonegg switches to DIBuilder.
Eric Christopher58f41952012-11-19 22:42:15 +0000769bool DwarfDebug::collectLegacyDebugInfo(const Module *M) {
Devang Patel07bb9ee2011-08-15 23:47:24 +0000770 DebugInfoFinder DbgFinder;
771 DbgFinder.processModule(*M);
Eric Christopher6a841382012-11-19 22:42:10 +0000772
Devang Patel07bb9ee2011-08-15 23:47:24 +0000773 bool HasDebugInfo = false;
774 // Scan all the compile-units to see if there are any marked as the main
775 // unit. If not, we do not generate debug info.
776 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
777 E = DbgFinder.compile_unit_end(); I != E; ++I) {
778 if (DICompileUnit(*I).isMain()) {
779 HasDebugInfo = true;
780 break;
781 }
782 }
783 if (!HasDebugInfo) return false;
Eric Christopher6a841382012-11-19 22:42:10 +0000784
Eric Christopher74804332013-02-07 21:19:50 +0000785 // Emit initial sections so we can refer to them later.
786 emitSectionLabels();
787
Devang Patel07bb9ee2011-08-15 23:47:24 +0000788 // Create all the compile unit DIEs.
789 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
790 E = DbgFinder.compile_unit_end(); I != E; ++I)
791 constructCompileUnit(*I);
Eric Christopher6a841382012-11-19 22:42:10 +0000792
Devang Patel07bb9ee2011-08-15 23:47:24 +0000793 // Create DIEs for each global variable.
794 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
795 E = DbgFinder.global_variable_end(); I != E; ++I) {
796 const MDNode *N = *I;
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000797 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
Devang Patel0ecbcbd2011-08-18 23:17:55 +0000798 CU->createGlobalVariableDIE(N);
Devang Patel07bb9ee2011-08-15 23:47:24 +0000799 }
Eric Christopher6a841382012-11-19 22:42:10 +0000800
Devang Patel07bb9ee2011-08-15 23:47:24 +0000801 // Create DIEs for each subprogram.
802 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
803 E = DbgFinder.subprogram_end(); I != E; ++I) {
804 const MDNode *N = *I;
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000805 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
806 constructSubprogramDIE(CU, N);
Devang Patel07bb9ee2011-08-15 23:47:24 +0000807 }
808
809 return HasDebugInfo;
810}
811
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000812// Emit all Dwarf sections that should come prior to the content. Create
813// global DIEs and emit initial debug info sections. This is invoked by
814// the target AsmPrinter.
Eric Christopher58f41952012-11-19 22:42:15 +0000815void DwarfDebug::beginModule() {
Devang Patel6c74a872010-04-27 19:46:33 +0000816 if (DisableDebugInfoPrinting)
817 return;
818
Eric Christopher58f41952012-11-19 22:42:15 +0000819 const Module *M = MMI->getModule();
820
Nick Lewycky019d2552011-07-29 03:49:23 +0000821 // If module has named metadata anchors then use them, otherwise scan the
822 // module using debug info finder to collect debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000823 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
824 if (CU_Nodes) {
Eric Christopher74804332013-02-07 21:19:50 +0000825 // Emit initial sections so we can reference labels later.
826 emitSectionLabels();
827
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000828 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
829 DICompileUnit CUNode(CU_Nodes->getOperand(i));
830 CompileUnit *CU = constructCompileUnit(CUNode);
831 DIArray GVs = CUNode.getGlobalVariables();
832 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
Devang Patel0ecbcbd2011-08-18 23:17:55 +0000833 CU->createGlobalVariableDIE(GVs.getElement(i));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000834 DIArray SPs = CUNode.getSubprograms();
835 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
836 constructSubprogramDIE(CU, SPs.getElement(i));
837 DIArray EnumTypes = CUNode.getEnumTypes();
838 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
839 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
840 DIArray RetainedTypes = CUNode.getRetainedTypes();
841 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
842 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
843 }
Devang Patel07bb9ee2011-08-15 23:47:24 +0000844 } else if (!collectLegacyDebugInfo(M))
845 return;
Devang Patele02e5852011-05-03 16:45:22 +0000846
Devang Patel07bb9ee2011-08-15 23:47:24 +0000847 collectInfoFromNamedMDNodes(M);
Eric Christopher6a841382012-11-19 22:42:10 +0000848
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000849 // Tell MMI that we have debug info.
850 MMI->setDebugInfoAvailability(true);
Eric Christopher6a841382012-11-19 22:42:10 +0000851
Bill Wendling2b128d72009-05-20 23:19:06 +0000852 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +0000853 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +0000854}
855
Eric Christopher960ac372012-11-22 00:59:49 +0000856// Attach DW_AT_inline attribute with inlined subprogram DIEs.
857void DwarfDebug::computeInlinedDIEs() {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000858 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
859 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000860 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000861 DIE *ISP = *AI;
Devang Patelf20c4f72011-04-12 22:53:02 +0000862 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000863 }
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000864 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000865 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000866 DIE *ISP = AI->second;
867 if (InlinedSubprogramDIEs.count(ISP))
868 continue;
869 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
870 }
Eric Christopher960ac372012-11-22 00:59:49 +0000871}
872
873// Collect info for variables that were optimized out.
874void DwarfDebug::collectDeadVariables() {
875 const Module *M = MMI->getModule();
876 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
877
878 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
879 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
880 DICompileUnit TheCU(CU_Nodes->getOperand(i));
881 DIArray Subprograms = TheCU.getSubprograms();
882 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopher735401c2012-11-27 00:13:51 +0000883 DISubprogram SP(Subprograms.getElement(i));
884 if (ProcessedSPNodes.count(SP) != 0) continue;
885 if (!SP.Verify()) continue;
886 if (!SP.isDefinition()) continue;
887 DIArray Variables = SP.getVariables();
888 if (Variables.getNumElements() == 0) continue;
Eric Christopher960ac372012-11-22 00:59:49 +0000889
Eric Christopher735401c2012-11-27 00:13:51 +0000890 LexicalScope *Scope =
891 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
892 DeadFnScopeMap[SP] = Scope;
Eric Christopher960ac372012-11-22 00:59:49 +0000893
Eric Christopher735401c2012-11-27 00:13:51 +0000894 // Construct subprogram DIE and add variables DIEs.
895 CompileUnit *SPCU = CUMap.lookup(TheCU);
896 assert(SPCU && "Unable to find Compile Unit!");
897 constructSubprogramDIE(SPCU, SP);
898 DIE *ScopeDIE = SPCU->getDIE(SP);
899 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
900 DIVariable DV(Variables.getElement(vi));
901 if (!DV.Verify()) continue;
902 DbgVariable *NewVar = new DbgVariable(DV, NULL);
903 if (DIE *VariableDIE =
904 SPCU->constructVariableDIE(NewVar, Scope->isAbstractScope()))
905 ScopeDIE->addChild(VariableDIE);
906 }
Eric Christopher960ac372012-11-22 00:59:49 +0000907 }
908 }
909 }
910 DeleteContainerSeconds(DeadFnScopeMap);
911}
912
913void DwarfDebug::finalizeModuleInfo() {
914 // Collect info for variables that were optimized out.
915 collectDeadVariables();
916
917 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
918 computeInlinedDIEs();
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000919
Eric Christopherb1b94512012-08-01 18:19:01 +0000920 // Emit DW_AT_containing_type attribute to connect types with their
921 // vtable holding type.
Devang Patel89543712011-08-15 17:24:54 +0000922 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000923 CUE = CUMap.end(); CUI != CUE; ++CUI) {
Devang Patel89543712011-08-15 17:24:54 +0000924 CompileUnit *TheCU = CUI->second;
925 TheCU->constructContainingTypeDIEs();
Devang Pateleb57c592009-12-03 19:11:07 +0000926 }
927
Eric Christopher960ac372012-11-22 00:59:49 +0000928 // Compute DIE offsets and sizes.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000929 InfoHolder.computeSizeAndOffsets();
930 if (useSplitDwarf())
931 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher960ac372012-11-22 00:59:49 +0000932}
933
934void DwarfDebug::endSections() {
Bill Wendling2b128d72009-05-20 23:19:06 +0000935 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +0000936 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnera179b522010-04-04 19:25:43 +0000937 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +0000938 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnera179b522010-04-04 19:25:43 +0000939 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +0000940
941 // End text sections.
Benjamin Kramer15591272012-10-31 13:45:49 +0000942 for (unsigned I = 0, E = SectionMap.size(); I != E; ++I) {
943 Asm->OutStreamer.SwitchSection(SectionMap[I]);
944 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", I+1));
Bill Wendling2b128d72009-05-20 23:19:06 +0000945 }
Eric Christopher960ac372012-11-22 00:59:49 +0000946}
Bill Wendling2b128d72009-05-20 23:19:06 +0000947
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000948// Emit all Dwarf sections that should come after the content.
Eric Christopher960ac372012-11-22 00:59:49 +0000949void DwarfDebug::endModule() {
950
951 if (!FirstCU) return;
952
953 // End any existing sections.
954 // TODO: Does this need to happen?
955 endSections();
956
957 // Finalize the debug info for the module.
958 finalizeModuleInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +0000959
Eric Christophercdf218d2012-12-10 19:51:21 +0000960 if (!useSplitDwarf()) {
Eric Christopher95198f502012-11-27 22:43:42 +0000961 // Emit all the DIEs into a debug info section.
962 emitDebugInfo();
Eric Christopher4c9b1192012-11-27 00:41:54 +0000963
Eric Christopher95198f502012-11-27 22:43:42 +0000964 // Corresponding abbreviations into a abbrev section.
965 emitAbbreviations();
966
967 // Emit info into a debug loc section.
968 emitDebugLoc();
969
970 // Emit info into a debug aranges section.
971 emitDebugARanges();
972
973 // Emit info into a debug ranges section.
974 emitDebugRanges();
975
976 // Emit info into a debug macinfo section.
977 emitDebugMacInfo();
978
979 // Emit inline info.
980 // TODO: When we don't need the option anymore we
981 // can remove all of the code that this section
982 // depends upon.
983 if (useDarwinGDBCompat())
984 emitDebugInlineInfo();
985 } else {
Eric Christopherd692c1d2012-12-11 19:42:09 +0000986 // TODO: Fill this in for separated debug sections and separate
Eric Christopher95198f502012-11-27 22:43:42 +0000987 // out information into new sections.
988
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000989 // Emit the debug info section and compile units.
Eric Christopher95198f502012-11-27 22:43:42 +0000990 emitDebugInfo();
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000991 emitDebugInfoDWO();
Eric Christopher95198f502012-11-27 22:43:42 +0000992
993 // Corresponding abbreviations into a abbrev section.
994 emitAbbreviations();
Eric Christopher3c5a1912012-12-19 22:02:53 +0000995 emitDebugAbbrevDWO();
Eric Christopher95198f502012-11-27 22:43:42 +0000996
997 // Emit info into a debug loc section.
998 emitDebugLoc();
999
1000 // Emit info into a debug aranges section.
1001 emitDebugARanges();
1002
1003 // Emit info into a debug ranges section.
1004 emitDebugRanges();
1005
1006 // Emit info into a debug macinfo section.
1007 emitDebugMacInfo();
1008
Eric Christopher962c9082013-01-15 23:56:56 +00001009 // Emit DWO addresses.
1010 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1011
Eric Christopher95198f502012-11-27 22:43:42 +00001012 // Emit inline info.
1013 // TODO: When we don't need the option anymore we
1014 // can remove all of the code that this section
1015 // depends upon.
1016 if (useDarwinGDBCompat())
1017 emitDebugInlineInfo();
1018 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001019
Eric Christophera876b822012-08-23 07:32:06 +00001020 // Emit info into the dwarf accelerator table sections.
Eric Christopher20b76a72012-08-23 22:36:40 +00001021 if (useDwarfAccelTables()) {
Eric Christopher4996c702011-11-07 09:24:32 +00001022 emitAccelNames();
1023 emitAccelObjC();
1024 emitAccelNamespaces();
1025 emitAccelTypes();
1026 }
Eric Christopher6a841382012-11-19 22:42:10 +00001027
Devang Patel04d2f2d2009-11-24 01:14:22 +00001028 // Emit info into a debug pubtypes section.
Eric Christopher77826182012-08-23 07:10:56 +00001029 // TODO: When we don't need the option anymore we can
1030 // remove all of the code that adds to the table.
Eric Christopher20b76a72012-08-23 22:36:40 +00001031 if (useDarwinGDBCompat())
Eric Christopher77826182012-08-23 07:10:56 +00001032 emitDebugPubTypes();
Devang Patel04d2f2d2009-11-24 01:14:22 +00001033
Eric Christopher95198f502012-11-27 22:43:42 +00001034 // Finally emit string information into a string table.
Eric Christopher6e20a162012-11-27 06:49:23 +00001035 emitDebugStr();
Eric Christopher3bf29fd2012-12-27 02:14:01 +00001036 if (useSplitDwarf())
1037 emitDebugStrDWO();
Eric Christopher6e20a162012-11-27 06:49:23 +00001038
Devang Pateld0701282010-08-02 17:32:15 +00001039 // clean up.
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001040 SPMap.clear();
Devang Patel1a0df9a2010-05-10 22:49:55 +00001041 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1042 E = CUMap.end(); I != E; ++I)
1043 delete I->second;
Eric Christopher8afd7b62012-12-10 19:51:18 +00001044
Eric Christopher5b33b3c2013-02-06 21:53:56 +00001045 for (SmallVector<CompileUnit *, 1>::iterator I = SkeletonCUs.begin(),
1046 E = SkeletonCUs.end(); I != E; ++I)
1047 delete *I;
Eric Christopher8afd7b62012-12-10 19:51:18 +00001048
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001049 // Reset these for the next Module if we have one.
1050 FirstCU = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001051}
1052
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001053// Find abstract variable, if any, associated with Var.
Devang Patelbb23a4a2011-08-10 21:50:54 +00001054DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattner915c5f92010-04-02 19:42:39 +00001055 DebugLoc ScopeLoc) {
Devang Patelbb23a4a2011-08-10 21:50:54 +00001056 LLVMContext &Ctx = DV->getContext();
1057 // More then one inlined variable corresponds to one abstract variable.
1058 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001059 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001060 if (AbsDbgVariable)
1061 return AbsDbgVariable;
1062
Devang Patel7e623022011-08-10 20:55:27 +00001063 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001064 if (!Scope)
1065 return NULL;
1066
Devang Patel99819b52011-08-15 19:01:20 +00001067 AbsDbgVariable = new DbgVariable(Var, NULL);
Devang Patel7e623022011-08-10 20:55:27 +00001068 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001069 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001070 return AbsDbgVariable;
1071}
1072
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001073// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel6c622ef2011-03-01 22:58:55 +00001074bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patel7e623022011-08-10 20:55:27 +00001075 DbgVariable *Var, LexicalScope *Scope) {
1076 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +00001077 return false;
1078 DIVariable DV = Var->getVariable();
1079 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1080 return false;
1081 unsigned ArgNo = DV.getArgNumber();
Eric Christopher6a841382012-11-19 22:42:10 +00001082 if (ArgNo == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001083 return false;
1084
Devang Patel4ab660b2011-03-03 20:02:02 +00001085 size_t Size = CurrentFnArguments.size();
1086 if (Size == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001087 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001088 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001089 // arguments does the function have at source level.
1090 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001091 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001092 CurrentFnArguments[ArgNo - 1] = Var;
1093 return true;
1094}
1095
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001096// Collect variable information from side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001097void
Nick Lewycky019d2552011-07-29 03:49:23 +00001098DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patel490c8ab2010-05-20 19:57:06 +00001099 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001100 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1101 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1102 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001103 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001104 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001105 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001106 DIVariable DV(Var);
1107 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001108
Devang Patel7e623022011-08-10 20:55:27 +00001109 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001110
Devang Patelcdb7d442009-11-10 23:20:04 +00001111 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001112 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001113 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001114
Devang Patele1c53f22010-05-20 16:36:41 +00001115 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Devang Patel99819b52011-08-15 19:01:20 +00001116 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable);
Devang Patel3e4a9652011-08-15 21:24:36 +00001117 RegVar->setFrameIndex(VP.first);
Devang Patel6c622ef2011-03-01 22:58:55 +00001118 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001119 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001120 if (AbsDbgVariable)
Devang Patel3e4a9652011-08-15 21:24:36 +00001121 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patel475d32a2009-10-06 01:26:37 +00001122 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001123}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001124
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001125// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1126// defined reg.
Devang Patel9fc11702010-05-25 23:40:22 +00001127static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001128 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001129 return MI->getNumOperands() == 3 &&
1130 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
1131 MI->getOperand(1).isImm() && MI->getOperand(1).getImm() == 0;
Devang Patel9fc11702010-05-25 23:40:22 +00001132}
1133
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001134// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher6a841382012-11-19 22:42:10 +00001135static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1136 const MCSymbol *FLabel,
Devang Patel2442a892011-07-08 17:09:57 +00001137 const MCSymbol *SLabel,
1138 const MachineInstr *MI) {
1139 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1140
1141 if (MI->getNumOperands() != 3) {
1142 MachineLocation MLoc = Asm->getDebugValueLocation(MI);
1143 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1144 }
1145 if (MI->getOperand(0).isReg() && MI->getOperand(1).isImm()) {
1146 MachineLocation MLoc;
1147 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
1148 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1149 }
1150 if (MI->getOperand(0).isImm())
1151 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1152 if (MI->getOperand(0).isFPImm())
1153 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1154 if (MI->getOperand(0).isCImm())
1155 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1156
Craig Topperee4dab52012-02-05 08:31:47 +00001157 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel2442a892011-07-08 17:09:57 +00001158}
1159
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001160// Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001161void
Devang Patel5c0f85c2010-06-25 22:07:34 +00001162DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1163 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001164
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001165 // collection info from MMI table.
Devang Patel490c8ab2010-05-20 19:57:06 +00001166 collectVariableInfoFromMMITable(MF, Processed);
1167
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001168 for (SmallVectorImpl<const MDNode*>::const_iterator
1169 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1170 ++UVI) {
1171 const MDNode *Var = *UVI;
1172 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001173 continue;
1174
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001175 // History contains relevant DBG_VALUE instructions for Var and instructions
1176 // clobbering it.
1177 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1178 if (History.empty())
1179 continue;
1180 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001181
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001182 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001183 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001184 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1185 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +00001186 Scope = LScopes.getCurrentFunctionScope();
Devang Patel8fb9fd62011-07-20 22:18:50 +00001187 else {
1188 if (DV.getVersion() <= LLVMDebugVersion9)
Devang Patel7e623022011-08-10 20:55:27 +00001189 Scope = LScopes.findLexicalScope(MInsn->getDebugLoc());
Devang Patel8fb9fd62011-07-20 22:18:50 +00001190 else {
1191 if (MDNode *IA = DV.getInlinedAt())
Devang Patel7e623022011-08-10 20:55:27 +00001192 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
Devang Patel8fb9fd62011-07-20 22:18:50 +00001193 else
Devang Patel7e623022011-08-10 20:55:27 +00001194 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel8fb9fd62011-07-20 22:18:50 +00001195 }
1196 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001197 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001198 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001199 continue;
1200
1201 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001202 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel99819b52011-08-15 19:01:20 +00001203 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
1204 DbgVariable *RegVar = new DbgVariable(DV, AbsVar);
Devang Patel6c622ef2011-03-01 22:58:55 +00001205 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001206 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001207 if (AbsVar)
Devang Patel3e4a9652011-08-15 21:24:36 +00001208 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001209
Eric Christophercc10d202012-10-08 20:48:54 +00001210 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001211 if (History.size() <= 1 || (History.size() == 2 &&
1212 MInsn->isIdenticalTo(History.back()))) {
Devang Patel3e4a9652011-08-15 21:24:36 +00001213 RegVar->setMInsn(MInsn);
Devang Patel9fc11702010-05-25 23:40:22 +00001214 continue;
1215 }
1216
Eric Christopher59cc0712013-01-28 17:33:26 +00001217 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001218 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001219
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001220 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1221 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1222 const MachineInstr *Begin = *HI;
1223 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001224
Devang Patele7181b52011-06-01 23:00:17 +00001225 // Check if DBG_VALUE is truncating a range.
1226 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1227 && !Begin->getOperand(0).getReg())
1228 continue;
1229
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001230 // Compute the range for a register location.
1231 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1232 const MCSymbol *SLabel = 0;
1233
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001234 if (HI + 1 == HE)
1235 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001236 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001237 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001238 else {
1239 const MachineInstr *End = HI[1];
Eric Christopher6a841382012-11-19 22:42:10 +00001240 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel53b050a2011-07-07 21:44:42 +00001241 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001242 if (End->isDebugValue())
1243 SLabel = getLabelBeforeInsn(End);
1244 else {
1245 // End is a normal instruction clobbering the range.
1246 SLabel = getLabelAfterInsn(End);
1247 assert(SLabel && "Forgot label after clobber instruction");
1248 ++HI;
1249 }
1250 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001251
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001252 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopher365d0832011-12-16 23:42:31 +00001253 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1254 Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001255 }
1256 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001257 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001258
1259 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001260 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1261 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1262 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1263 DIVariable DV(Variables.getElement(i));
1264 if (!DV || !DV.Verify() || !Processed.insert(DV))
1265 continue;
1266 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1267 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patele0a94bf2010-05-14 21:01:35 +00001268 }
Devang Patel9fc11702010-05-25 23:40:22 +00001269}
Devang Patele0a94bf2010-05-14 21:01:35 +00001270
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001271// Return Label preceding the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001272MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001273 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1274 assert(Label && "Didn't insert label before instruction");
1275 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001276}
1277
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001278// Return Label immediately following the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001279MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001280 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001281}
1282
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001283// Process beginning of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001284void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001285 // Check if source location changes, but ignore DBG_VALUE locations.
1286 if (!MI->isDebugValue()) {
1287 DebugLoc DL = MI->getDebugLoc();
1288 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopheraec8a822012-04-05 20:39:05 +00001289 unsigned Flags = 0;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001290 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001291 if (DL == PrologEndLoc) {
1292 Flags |= DWARF2_FLAG_PROLOGUE_END;
1293 PrologEndLoc = DebugLoc();
1294 }
Eric Christopheraec8a822012-04-05 20:39:05 +00001295 if (PrologEndLoc.isUnknown())
1296 Flags |= DWARF2_FLAG_IS_STMT;
1297
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001298 if (!DL.isUnknown()) {
1299 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001300 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001301 } else
Devang Patel34a66202011-05-11 19:22:19 +00001302 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001303 }
Devang Patel9fc11702010-05-25 23:40:22 +00001304 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001305
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001306 // Insert labels where requested.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001307 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1308 LabelsBeforeInsn.find(MI);
1309
1310 // No label needed.
1311 if (I == LabelsBeforeInsn.end())
1312 return;
1313
1314 // Label already assigned.
1315 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001316 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001317
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001318 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001319 PrevLabel = MMI->getContext().CreateTempSymbol();
1320 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001321 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001322 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001323}
1324
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001325// Process end of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001326void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001327 // Don't create a new label after DBG_VALUE instructions.
1328 // They don't generate code.
1329 if (!MI->isDebugValue())
1330 PrevLabel = 0;
1331
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001332 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1333 LabelsAfterInsn.find(MI);
1334
1335 // No label needed.
1336 if (I == LabelsAfterInsn.end())
1337 return;
1338
1339 // Label already assigned.
1340 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001341 return;
1342
1343 // We need a label after this instruction.
1344 if (!PrevLabel) {
1345 PrevLabel = MMI->getContext().CreateTempSymbol();
1346 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001347 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001348 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001349}
1350
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001351// Each LexicalScope has first instruction and last instruction to mark
1352// beginning and end of a scope respectively. Create an inverse map that list
1353// scopes starts (and ends) with an instruction. One instruction may start (or
1354// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001355void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001356 SmallVector<LexicalScope *, 4> WorkList;
1357 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001358 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001359 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001360
Devang Patel7e623022011-08-10 20:55:27 +00001361 const SmallVector<LexicalScope *, 4> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001362 if (!Children.empty())
Devang Patel7e623022011-08-10 20:55:27 +00001363 for (SmallVector<LexicalScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00001364 SE = Children.end(); SI != SE; ++SI)
1365 WorkList.push_back(*SI);
1366
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001367 if (S->isAbstractScope())
1368 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001369
Devang Patel7e623022011-08-10 20:55:27 +00001370 const SmallVector<InsnRange, 4> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001371 if (Ranges.empty())
1372 continue;
Devang Patel7e623022011-08-10 20:55:27 +00001373 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +00001374 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001375 assert(RI->first && "InsnRange does not have first instruction!");
1376 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001377 requestLabelBeforeInsn(RI->first);
1378 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001379 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001380 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001381}
1382
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001383// Get MDNode for DebugLoc's scope.
Devang Patel589845d2011-05-09 22:14:49 +00001384static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1385 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1386 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1387 return DL.getScope(Ctx);
1388}
1389
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001390// Walk up the scope chain of given debug loc and find line number info
1391// for the function.
Devang Patel34a66202011-05-11 19:22:19 +00001392static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1393 const MDNode *Scope = getScopeNode(DL, Ctx);
1394 DISubprogram SP = getDISubprogram(Scope);
Eric Christopher34164192012-04-03 00:43:49 +00001395 if (SP.Verify()) {
1396 // Check for number of operands since the compatibility is
1397 // cheap here.
Eric Christopherb81e2b42012-04-03 17:55:42 +00001398 if (SP->getNumOperands() > 19)
Eric Christopher34164192012-04-03 00:43:49 +00001399 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1400 else
1401 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1402 }
1403
Devang Patel34a66202011-05-11 19:22:19 +00001404 return DebugLoc();
1405}
1406
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001407// Gather pre-function debug information. Assumes being called immediately
1408// after the function entry point has been emitted.
Chris Lattner76555b52010-01-26 23:18:02 +00001409void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00001410 if (!MMI->hasDebugInfo()) return;
Devang Patel7e623022011-08-10 20:55:27 +00001411 LScopes.initialize(*MF);
1412 if (LScopes.empty()) return;
1413 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001414
Manman Ren4e042a62013-02-05 21:52:47 +00001415 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1416 // belongs to.
1417 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1418 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1419 assert(TheCU && "Unable to find compile unit!");
1420 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
1421
Devang Patel6c74a872010-04-27 19:46:33 +00001422 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1423 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001424 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001425 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001426
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001427 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1428
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001429 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001430 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001431 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1432
Devang Patel002d54d2010-05-26 19:37:24 +00001433 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001434 I != E; ++I) {
1435 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001436 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1437 II != IE; ++II) {
1438 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001439
Devang Patel002d54d2010-05-26 19:37:24 +00001440 if (MI->isDebugValue()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001441 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001442
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001443 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001444 const MDNode *Var =
1445 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001446
1447 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001448 if (isDbgValueInDefinedReg(MI))
1449 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1450
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001451 // Check the history of this variable.
1452 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1453 if (History.empty()) {
1454 UserVariables.push_back(Var);
1455 // The first mention of a function argument gets the FunctionBeginSym
1456 // label, so arguments are visible when breaking at function entry.
1457 DIVariable DV(Var);
1458 if (DV.Verify() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1459 DISubprogram(getDISubprogram(DV.getContext()))
1460 .describes(MF->getFunction()))
1461 LabelsBeforeInsn[MI] = FunctionBeginSym;
1462 } else {
1463 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1464 const MachineInstr *Prev = History.back();
1465 if (Prev->isDebugValue()) {
1466 // Coalesce identical entries at the end of History.
1467 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001468 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher85a495e2012-10-08 20:48:49 +00001469 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher6a841382012-11-19 22:42:10 +00001470 << "\t" << *Prev
Devang Patelb7a328e2011-07-07 00:14:27 +00001471 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001472 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001473 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001474
1475 // Terminate old register assignments that don't reach MI;
1476 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1477 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1478 isDbgValueInDefinedReg(Prev)) {
1479 // Previous register assignment needs to terminate at the end of
1480 // its basic block.
1481 MachineBasicBlock::const_iterator LastMI =
1482 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001483 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001484 // Drop DBG_VALUE for empty range.
Eric Christopher85a495e2012-10-08 20:48:49 +00001485 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patelb7a328e2011-07-07 00:14:27 +00001486 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001487 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001488 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001489 else {
1490 // Terminate after LastMI.
1491 History.push_back(LastMI);
1492 }
1493 }
1494 }
1495 }
1496 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001497 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001498 // Not a DBG_VALUE instruction.
1499 if (!MI->isLabel())
1500 AtBlockEntry = false;
1501
Eric Christopher133195782012-10-04 20:46:14 +00001502 // First known non-DBG_VALUE and non-frame setup location marks
1503 // the beginning of the function body.
1504 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1505 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel34a66202011-05-11 19:22:19 +00001506 PrologEndLoc = MI->getDebugLoc();
1507
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001508 // Check if the instruction clobbers any registers with debug vars.
1509 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1510 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1511 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1512 continue;
Jakob Stoklund Olesen54038d72012-06-01 23:28:30 +00001513 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1514 AI.isValid(); ++AI) {
1515 unsigned Reg = *AI;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001516 const MDNode *Var = LiveUserVar[Reg];
1517 if (!Var)
1518 continue;
1519 // Reg is now clobbered.
1520 LiveUserVar[Reg] = 0;
1521
1522 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001523 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1524 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001525 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001526 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1527 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001528 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001529 const MachineInstr *Prev = History.back();
1530 // Sanity-check: Register assignments are terminated at the end of
1531 // their block.
1532 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1533 continue;
1534 // Is the variable still in Reg?
1535 if (!isDbgValueInDefinedReg(Prev) ||
1536 Prev->getOperand(0).getReg() != Reg)
1537 continue;
1538 // Var is clobbered. Make sure the next instruction gets a label.
1539 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001540 }
1541 }
Devang Patel002d54d2010-05-26 19:37:24 +00001542 }
Devang Patel002d54d2010-05-26 19:37:24 +00001543 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001544 }
1545
1546 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1547 I != E; ++I) {
1548 SmallVectorImpl<const MachineInstr*> &History = I->second;
1549 if (History.empty())
1550 continue;
1551
1552 // Make sure the final register assignments are terminated.
1553 const MachineInstr *Prev = History.back();
1554 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1555 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher6a841382012-11-19 22:42:10 +00001556 MachineBasicBlock::const_iterator LastMI =
Devang Patel784077e2011-08-10 23:58:09 +00001557 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001558 if (LastMI == PrevMBB->end())
1559 // Drop DBG_VALUE for empty range.
1560 History.pop_back();
1561 else {
1562 // Terminate after LastMI.
1563 History.push_back(LastMI);
1564 }
1565 }
1566 // Request labels for the full history.
1567 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1568 const MachineInstr *MI = History[i];
1569 if (MI->isDebugValue())
1570 requestLabelBeforeInsn(MI);
1571 else
1572 requestLabelAfterInsn(MI);
1573 }
1574 }
Devang Patel002d54d2010-05-26 19:37:24 +00001575
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001576 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001577 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001578
1579 // Record beginning of function.
1580 if (!PrologEndLoc.isUnknown()) {
1581 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1582 MF->getFunction()->getContext());
1583 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1584 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie67cb31e2012-12-04 22:02:33 +00001585 // We'd like to list the prologue as "not statements" but GDB behaves
1586 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikie5a773bb2012-12-04 21:05:36 +00001587 DWARF2_FLAG_IS_STMT);
Devang Patel34a66202011-05-11 19:22:19 +00001588 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001589}
1590
Devang Patel7e623022011-08-10 20:55:27 +00001591void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1592// SmallVector<DbgVariable *, 8> &Vars = ScopeVariables.lookup(LS);
1593 ScopeVariables[LS].push_back(Var);
1594// Vars.push_back(Var);
1595}
1596
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001597// Gather and emit post-function debug information.
Chris Lattner76555b52010-01-26 23:18:02 +00001598void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patel7e623022011-08-10 20:55:27 +00001599 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00001600
Devang Patel7e623022011-08-10 20:55:27 +00001601 // Define end label for subprogram.
1602 FunctionEndSym = Asm->GetTempSymbol("func_end",
1603 Asm->getFunctionNumber());
1604 // Assumes in correct section after the entry point.
1605 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Manman Ren4e042a62013-02-05 21:52:47 +00001606 // Set DwarfCompileUnitID in MCContext to default value.
1607 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher6a841382012-11-19 22:42:10 +00001608
Devang Patel7e623022011-08-10 20:55:27 +00001609 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1610 collectVariableInfo(MF, ProcessedVars);
Eric Christopher6a841382012-11-19 22:42:10 +00001611
Devang Patel3acc70e2011-08-15 22:04:40 +00001612 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001613 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001614 assert(TheCU && "Unable to find compile unit!");
Devang Patel3acc70e2011-08-15 22:04:40 +00001615
Devang Patel7e623022011-08-10 20:55:27 +00001616 // Construct abstract scopes.
Devang Patel44403472011-08-12 18:10:19 +00001617 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1618 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1619 LexicalScope *AScope = AList[i];
1620 DISubprogram SP(AScope->getScopeNode());
Devang Patel7e623022011-08-10 20:55:27 +00001621 if (SP.Verify()) {
1622 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001623 DIArray Variables = SP.getVariables();
1624 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1625 DIVariable DV(Variables.getElement(i));
1626 if (!DV || !DV.Verify() || !ProcessedVars.insert(DV))
1627 continue;
Alexey Samsonov39602782012-07-06 08:45:08 +00001628 // Check that DbgVariable for DV wasn't created earlier, when
1629 // findAbstractVariable() was called for inlined instance of DV.
1630 LLVMContext &Ctx = DV->getContext();
1631 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1632 if (AbstractVariables.lookup(CleanDV))
1633 continue;
Devang Patel59e27c52011-08-19 23:28:12 +00001634 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1635 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001636 }
1637 }
Devang Patel44403472011-08-12 18:10:19 +00001638 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Devang Patel3acc70e2011-08-15 22:04:40 +00001639 constructScopeDIE(TheCU, AScope);
Bill Wendling2b128d72009-05-20 23:19:06 +00001640 }
Eric Christopher6a841382012-11-19 22:42:10 +00001641
Devang Patel3acc70e2011-08-15 22:04:40 +00001642 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher6a841382012-11-19 22:42:10 +00001643
Nick Lewycky50f02cb2011-12-02 22:16:29 +00001644 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopherbb69a272012-08-24 01:14:27 +00001645 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Patel3acc70e2011-08-15 22:04:40 +00001646
Devang Patel7e623022011-08-10 20:55:27 +00001647 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
1648 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00001649
Bill Wendling2b128d72009-05-20 23:19:06 +00001650 // Clear debug info
Devang Patel7e623022011-08-10 20:55:27 +00001651 for (DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >::iterator
1652 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1653 DeleteContainerPointers(I->second);
1654 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001655 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001656 UserVariables.clear();
1657 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001658 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001659 LabelsBeforeInsn.clear();
1660 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001661 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001662}
1663
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001664// Register a source line with debug info. Returns the unique label that was
1665// emitted and which provides correspondence to the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00001666void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1667 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00001668 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00001669 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00001670 unsigned Src = 1;
1671 if (S) {
1672 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00001673
Dan Gohman50849c62010-05-05 23:41:32 +00001674 if (Scope.isCompileUnit()) {
1675 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001676 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001677 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00001678 } else if (Scope.isFile()) {
1679 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00001680 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001681 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001682 } else if (Scope.isSubprogram()) {
1683 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001684 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001685 Dir = SP.getDirectory();
Eric Christopher6647b832011-10-11 22:59:11 +00001686 } else if (Scope.isLexicalBlockFile()) {
1687 DILexicalBlockFile DBF(S);
1688 Fn = DBF.getFilename();
1689 Dir = DBF.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001690 } else if (Scope.isLexicalBlock()) {
1691 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001692 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001693 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001694 } else
Craig Topperee4dab52012-02-05 08:31:47 +00001695 llvm_unreachable("Unexpected scope info");
Dan Gohman50849c62010-05-05 23:41:32 +00001696
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001697 Src = getOrCreateSourceID(Fn, Dir);
Dan Gohman50849c62010-05-05 23:41:32 +00001698 }
Nick Lewycky019d2552011-07-29 03:49:23 +00001699 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00001700}
1701
Bill Wendling806535f2009-05-20 23:22:40 +00001702//===----------------------------------------------------------------------===//
1703// Emit Methods
1704//===----------------------------------------------------------------------===//
1705
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001706// Compute the size and offset of a DIE.
Jim Grosbach00e9c612009-11-22 19:20:36 +00001707unsigned
Eric Christopherc8a310e2012-12-10 23:34:43 +00001708DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling480ff322009-05-20 23:21:38 +00001709 // Get the children.
1710 const std::vector<DIE *> &Children = Die->getChildren();
1711
Bill Wendling480ff322009-05-20 23:21:38 +00001712 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00001713 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00001714
1715 // Get the abbreviation for this DIE.
1716 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopherc8a310e2012-12-10 23:34:43 +00001717 const DIEAbbrev *Abbrev = Abbreviations->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00001718
1719 // Set DIE offset
1720 Die->setOffset(Offset);
1721
1722 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00001723 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001724
1725 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
1726 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1727
1728 // Size the DIE attribute values.
1729 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1730 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001731 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001732
1733 // Size the DIE children if any.
1734 if (!Children.empty()) {
1735 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1736 "Children flag not set");
1737
1738 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001739 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling480ff322009-05-20 23:21:38 +00001740
1741 // End of children marker.
1742 Offset += sizeof(int8_t);
1743 }
1744
1745 Die->setSize(Offset - Die->getOffset());
1746 return Offset;
1747}
1748
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001749// Compute the size and offset of all the DIEs.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001750void DwarfUnits::computeSizeAndOffsets() {
1751 for (SmallVector<CompileUnit *, 1>::iterator I = CUs.begin(),
1752 E = CUs.end(); I != E; ++I) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001753 unsigned Offset =
1754 sizeof(int32_t) + // Length of Compilation Unit Info
1755 sizeof(int16_t) + // DWARF version number
1756 sizeof(int32_t) + // Offset Into Abbrev. Section
1757 sizeof(int8_t); // Pointer Size (in bytes)
1758
Eric Christopherc8a310e2012-12-10 23:34:43 +00001759 computeSizeAndOffset((*I)->getCUDie(), Offset);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001760 }
Bill Wendling480ff322009-05-20 23:21:38 +00001761}
1762
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001763// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001764void DwarfDebug::emitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001765 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001766
Bill Wendling480ff322009-05-20 23:21:38 +00001767 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001768 DwarfInfoSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001769 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001770 DwarfAbbrevSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001771 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher3c5a1912012-12-19 22:02:53 +00001772 if (useSplitDwarf())
1773 DwarfAbbrevDWOSectionSym =
1774 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1775 "section_abbrev_dwo");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001776 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001777
Chris Lattner6629ca92010-04-04 22:59:04 +00001778 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001779 emitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00001780
Eric Christopher74804332013-02-07 21:19:50 +00001781 DwarfLineSectionSym =
1782 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001783 emitSectionSym(Asm, TLOF.getDwarfLocSection());
1784 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001785 DwarfStrSectionSym =
Eric Christopher3bf29fd2012-12-27 02:14:01 +00001786 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
1787 if (useSplitDwarf())
1788 DwarfStrDWOSectionSym =
1789 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001790 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patel12563b32010-04-16 23:33:45 +00001791 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00001792
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001793 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patel9fc11702010-05-25 23:40:22 +00001794 "section_debug_loc");
1795
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001796 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
1797 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00001798}
1799
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001800// Recursively emits a debug information entry.
Eric Christopher3c5a1912012-12-19 22:02:53 +00001801void DwarfDebug::emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs) {
Bill Wendling480ff322009-05-20 23:21:38 +00001802 // Get the abbreviation for this DIE.
1803 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher3c5a1912012-12-19 22:02:53 +00001804 const DIEAbbrev *Abbrev = Abbrevs->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00001805
Bill Wendling480ff322009-05-20 23:21:38 +00001806 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00001807 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00001808 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
1809 Twine::utohexstr(Die->getOffset()) + ":0x" +
1810 Twine::utohexstr(Die->getSize()) + " " +
1811 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00001812 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001813
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00001814 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00001815 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1816
1817 // Emit the DIE attribute values.
1818 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1819 unsigned Attr = AbbrevData[i].getAttribute();
1820 unsigned Form = AbbrevData[i].getForm();
1821 assert(Form && "Too many attributes for DIE (check abbreviation)");
1822
Chris Lattner7bde8c02010-04-04 18:52:31 +00001823 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00001824 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001825
Bill Wendling480ff322009-05-20 23:21:38 +00001826 switch (Attr) {
Bill Wendling480ff322009-05-20 23:21:38 +00001827 case dwarf::DW_AT_abstract_origin: {
1828 DIEEntry *E = cast<DIEEntry>(Values[i]);
1829 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001830 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00001831 Asm->EmitInt32(Addr);
1832 break;
1833 }
Devang Patel12563b32010-04-16 23:33:45 +00001834 case dwarf::DW_AT_ranges: {
1835 // DW_AT_range Value encodes offset in debug_range section.
1836 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00001837
Nick Lewycky33da3362012-06-22 01:25:12 +00001838 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelda3ef852010-09-02 16:43:44 +00001839 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
1840 V->getValue(),
1841 4);
1842 } else {
1843 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
1844 V->getValue(),
1845 DwarfDebugRangeSectionSym,
1846 4);
1847 }
Devang Patel12563b32010-04-16 23:33:45 +00001848 break;
1849 }
Devang Patel9fc11702010-05-25 23:40:22 +00001850 case dwarf::DW_AT_location: {
Nick Lewycky33da3362012-06-22 01:25:12 +00001851 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
1852 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
1853 Asm->EmitLabelReference(L->getValue(), 4);
1854 else
1855 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
1856 } else {
Devang Patel9fc11702010-05-25 23:40:22 +00001857 Values[i]->EmitValue(Asm, Form);
Nick Lewycky33da3362012-06-22 01:25:12 +00001858 }
Devang Patel9fc11702010-05-25 23:40:22 +00001859 break;
1860 }
Devang Patela1bd5a12010-09-29 19:08:08 +00001861 case dwarf::DW_AT_accessibility: {
1862 if (Asm->isVerbose()) {
1863 DIEInteger *V = cast<DIEInteger>(Values[i]);
1864 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
1865 }
1866 Values[i]->EmitValue(Asm, Form);
1867 break;
1868 }
Bill Wendling480ff322009-05-20 23:21:38 +00001869 default:
1870 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001871 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00001872 break;
1873 }
Bill Wendling480ff322009-05-20 23:21:38 +00001874 }
1875
1876 // Emit the DIE children if any.
1877 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
1878 const std::vector<DIE *> &Children = Die->getChildren();
1879
1880 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher3c5a1912012-12-19 22:02:53 +00001881 emitDIE(Children[j], Abbrevs);
Bill Wendling480ff322009-05-20 23:21:38 +00001882
Chris Lattner7bde8c02010-04-04 18:52:31 +00001883 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00001884 Asm->OutStreamer.AddComment("End Of Children Mark");
1885 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00001886 }
1887}
1888
Eric Christophera2de8262012-12-15 00:04:07 +00001889// Emit the various dwarf units to the unit section USection with
1890// the abbreviations going into ASection.
1891void DwarfUnits::emitUnits(DwarfDebug *DD,
1892 const MCSection *USection,
1893 const MCSection *ASection,
1894 const MCSymbol *ASectionSym) {
1895 Asm->OutStreamer.SwitchSection(USection);
1896 for (SmallVector<CompileUnit *, 1>::iterator I = CUs.begin(),
1897 E = CUs.end(); I != E; ++I) {
1898 CompileUnit *TheCU = *I;
Devang Patel1a0df9a2010-05-10 22:49:55 +00001899 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001900
Devang Patel1a0df9a2010-05-10 22:49:55 +00001901 // Emit the compile units header.
Eric Christophera2de8262012-12-15 00:04:07 +00001902 Asm->OutStreamer
1903 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
1904 TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001905
Devang Patel1a0df9a2010-05-10 22:49:55 +00001906 // Emit size of content not including length itself
1907 unsigned ContentSize = Die->getSize() +
1908 sizeof(int16_t) + // DWARF version number
1909 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patele141234942011-04-13 19:41:17 +00001910 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001911
Devang Patel1a0df9a2010-05-10 22:49:55 +00001912 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
1913 Asm->EmitInt32(ContentSize);
1914 Asm->OutStreamer.AddComment("DWARF version number");
1915 Asm->EmitInt16(dwarf::DWARF_VERSION);
1916 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
Eric Christophera2de8262012-12-15 00:04:07 +00001917 Asm->EmitSectionOffset(Asm->GetTempSymbol(ASection->getLabelBeginName()),
1918 ASectionSym);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001919 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth5da3f052012-11-01 09:14:31 +00001920 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001921
Eric Christopher3c5a1912012-12-19 22:02:53 +00001922 DD->emitDIE(Die, Abbreviations);
Eric Christophera2de8262012-12-15 00:04:07 +00001923 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
Eli Benderskyb42d1462012-12-03 18:45:45 +00001924 TheCU->getUniqueID()));
Devang Patel1a0df9a2010-05-10 22:49:55 +00001925 }
Bill Wendling480ff322009-05-20 23:21:38 +00001926}
1927
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001928// Emit the debug info section.
1929void DwarfDebug::emitDebugInfo() {
Eric Christophera2de8262012-12-15 00:04:07 +00001930 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
1931
1932 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
1933 Asm->getObjFileLowering().getDwarfAbbrevSection(),
1934 DwarfAbbrevSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001935}
1936
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001937// Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +00001938void DwarfDebug::emitAbbreviations() {
Eric Christopher3c5a1912012-12-19 22:02:53 +00001939 if (!useSplitDwarf())
1940 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
1941 &Abbreviations);
1942 else
1943 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
1944}
Bill Wendling480ff322009-05-20 23:21:38 +00001945
Eric Christopher3c5a1912012-12-19 22:02:53 +00001946void DwarfDebug::emitAbbrevs(const MCSection *Section,
1947 std::vector<DIEAbbrev *> *Abbrevs) {
1948 // Check to see if it is worth the effort.
1949 if (!Abbrevs->empty()) {
1950 // Start the debug abbrev section.
1951 Asm->OutStreamer.SwitchSection(Section);
1952
1953 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
Eric Christopher996b2b72012-12-13 03:00:38 +00001954 Asm->OutStreamer.EmitLabel(Begin);
Bill Wendling480ff322009-05-20 23:21:38 +00001955
1956 // For each abbrevation.
Eric Christopher3c5a1912012-12-19 22:02:53 +00001957 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
Bill Wendling480ff322009-05-20 23:21:38 +00001958 // Get abbreviation data
Eric Christopher3c5a1912012-12-19 22:02:53 +00001959 const DIEAbbrev *Abbrev = Abbrevs->at(i);
Bill Wendling480ff322009-05-20 23:21:38 +00001960
1961 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00001962 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00001963
1964 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001965 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00001966 }
1967
1968 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00001969 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00001970
Eric Christopher3c5a1912012-12-19 22:02:53 +00001971 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
Eric Christopher996b2b72012-12-13 03:00:38 +00001972 Asm->OutStreamer.EmitLabel(End);
Bill Wendling480ff322009-05-20 23:21:38 +00001973 }
1974}
1975
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001976// Emit the last address of the section and the end of the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +00001977void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00001978 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00001979 Asm->OutStreamer.AddComment("Extended Op");
1980 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001981
Chris Lattner566cae92010-03-09 23:52:58 +00001982 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth5da3f052012-11-01 09:14:31 +00001983 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00001984 Asm->OutStreamer.AddComment("DW_LNE_set_address");
1985 Asm->EmitInt8(dwarf::DW_LNE_set_address);
1986
1987 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00001988
Chris Lattnera179b522010-04-04 19:25:43 +00001989 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Eric Christopherce0cfce2013-01-09 01:35:34 +00001990 Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00001991
1992 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00001993 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
1994 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00001995 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00001996 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00001997}
1998
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001999// Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00002000void DwarfDebug::emitAccelNames() {
2001 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2002 dwarf::DW_FORM_data4));
2003 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2004 E = CUMap.end(); I != E; ++I) {
2005 CompileUnit *TheCU = I->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00002006 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2007 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002008 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2009 const char *Name = GI->getKeyData();
Eric Christopher090fcc12012-01-06 23:03:34 +00002010 const std::vector<DIE *> &Entities = GI->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00002011 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2012 DE = Entities.end(); DI != DE; ++DI)
2013 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00002014 }
2015 }
2016
2017 AT.FinalizeTable(Asm, "Names");
2018 Asm->OutStreamer.SwitchSection(
2019 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2020 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2021 Asm->OutStreamer.EmitLabel(SectionBegin);
2022
2023 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002024 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002025}
2026
Eric Christopher48fef592012-12-20 21:58:40 +00002027// Emit objective C classes and categories into a hashed accelerator table
2028// section.
Eric Christopher4996c702011-11-07 09:24:32 +00002029void DwarfDebug::emitAccelObjC() {
2030 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2031 dwarf::DW_FORM_data4));
2032 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2033 E = CUMap.end(); I != E; ++I) {
2034 CompileUnit *TheCU = I->second;
2035 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2036 for (StringMap<std::vector<DIE*> >::const_iterator
2037 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2038 const char *Name = GI->getKeyData();
Eric Christopher090fcc12012-01-06 23:03:34 +00002039 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher4996c702011-11-07 09:24:32 +00002040 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2041 DE = Entities.end(); DI != DE; ++DI)
2042 AT.AddName(Name, (*DI));
2043 }
2044 }
2045
2046 AT.FinalizeTable(Asm, "ObjC");
2047 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2048 .getDwarfAccelObjCSection());
2049 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2050 Asm->OutStreamer.EmitLabel(SectionBegin);
2051
2052 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002053 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002054}
2055
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002056// Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002057void DwarfDebug::emitAccelNamespaces() {
2058 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2059 dwarf::DW_FORM_data4));
2060 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2061 E = CUMap.end(); I != E; ++I) {
2062 CompileUnit *TheCU = I->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00002063 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2064 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002065 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2066 const char *Name = GI->getKeyData();
Eric Christopher090fcc12012-01-06 23:03:34 +00002067 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00002068 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2069 DE = Entities.end(); DI != DE; ++DI)
2070 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00002071 }
2072 }
2073
2074 AT.FinalizeTable(Asm, "namespac");
2075 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2076 .getDwarfAccelNamespaceSection());
2077 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2078 Asm->OutStreamer.EmitLabel(SectionBegin);
2079
2080 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002081 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002082}
2083
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002084// Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002085void DwarfDebug::emitAccelTypes() {
Eric Christopher21bde872012-01-06 04:35:23 +00002086 std::vector<DwarfAccelTable::Atom> Atoms;
2087 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2088 dwarf::DW_FORM_data4));
2089 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTag,
2090 dwarf::DW_FORM_data2));
2091 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTypeFlags,
2092 dwarf::DW_FORM_data1));
2093 DwarfAccelTable AT(Atoms);
Eric Christopher4996c702011-11-07 09:24:32 +00002094 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2095 E = CUMap.end(); I != E; ++I) {
2096 CompileUnit *TheCU = I->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002097 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2098 = TheCU->getAccelTypes();
2099 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002100 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2101 const char *Name = GI->getKeyData();
Eric Christopher090fcc12012-01-06 23:03:34 +00002102 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002103 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2104 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2105 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher4996c702011-11-07 09:24:32 +00002106 }
2107 }
2108
2109 AT.FinalizeTable(Asm, "types");
2110 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2111 .getDwarfAccelTypesSection());
2112 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2113 Asm->OutStreamer.EmitLabel(SectionBegin);
2114
2115 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002116 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002117}
2118
Devang Patel04d2f2d2009-11-24 01:14:22 +00002119void DwarfDebug::emitDebugPubTypes() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002120 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2121 E = CUMap.end(); I != E; ++I) {
2122 CompileUnit *TheCU = I->second;
Eric Christopher6abc9c52011-11-07 09:18:35 +00002123 // Start the dwarf pubtypes section.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002124 Asm->OutStreamer.SwitchSection(
2125 Asm->getObjFileLowering().getDwarfPubTypesSection());
2126 Asm->OutStreamer.AddComment("Length of Public Types Info");
2127 Asm->EmitLabelDifference(
Eli Benderskyb42d1462012-12-03 18:45:45 +00002128 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2129 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002130
Devang Patel1a0df9a2010-05-10 22:49:55 +00002131 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
Eli Benderskyb42d1462012-12-03 18:45:45 +00002132 TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002133
Devang Patel1a0df9a2010-05-10 22:49:55 +00002134 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
2135 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002136
Devang Patel1a0df9a2010-05-10 22:49:55 +00002137 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eric Christopher16485a52012-12-15 00:04:04 +00002138 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2139 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(),
Eli Benderskyb42d1462012-12-03 18:45:45 +00002140 TheCU->getUniqueID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00002141 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002142
Devang Patel1a0df9a2010-05-10 22:49:55 +00002143 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eric Christopher16485a52012-12-15 00:04:04 +00002144 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(),
Eli Benderskyb42d1462012-12-03 18:45:45 +00002145 TheCU->getUniqueID()),
Eric Christopher16485a52012-12-15 00:04:04 +00002146 Asm->GetTempSymbol(ISec->getLabelBeginName(),
Eli Benderskyb42d1462012-12-03 18:45:45 +00002147 TheCU->getUniqueID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00002148 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002149
Devang Patel1a0df9a2010-05-10 22:49:55 +00002150 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
2151 for (StringMap<DIE*>::const_iterator
2152 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2153 const char *Name = GI->getKeyData();
Nick Lewycky019d2552011-07-29 03:49:23 +00002154 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002155
Devang Patel1a0df9a2010-05-10 22:49:55 +00002156 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
2157 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002158
Devang Patel1a0df9a2010-05-10 22:49:55 +00002159 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002160 // Emit the name with a terminating null byte.
Eric Christophere3ab3d02013-01-09 01:57:54 +00002161 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002162 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002163
Devang Patel1a0df9a2010-05-10 22:49:55 +00002164 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002165 Asm->EmitInt32(0);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002166 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
Eli Benderskyb42d1462012-12-03 18:45:45 +00002167 TheCU->getUniqueID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00002168 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002169}
2170
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002171// Emit strings into a string section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002172void DwarfUnits::emitStrings(const MCSection *StrSection,
2173 const MCSection *OffsetSection = NULL,
2174 const MCSymbol *StrSecSym = NULL) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002175
Eric Christopher27614582013-01-08 22:22:06 +00002176 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002177
Chris Lattner3d72a672010-03-09 23:38:23 +00002178 // Start the dwarf str section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002179 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling480ff322009-05-20 23:21:38 +00002180
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002181 // Get all of the string pool entries and put them in an array by their ID so
2182 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002183 SmallVector<std::pair<unsigned,
Eric Christopherb800ff72013-01-07 22:40:45 +00002184 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002185
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002186 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
Eric Christopher27614582013-01-08 22:22:06 +00002187 I = StringPool.begin(), E = StringPool.end();
Eric Christopher48fef592012-12-20 21:58:40 +00002188 I != E; ++I)
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002189 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002190
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002191 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002192
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002193 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002194 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002195 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002196
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002197 // Emit the string itself with a terminating null byte.
Benjamin Kramer148db362011-11-09 12:12:04 +00002198 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
Eric Christopherce0cfce2013-01-09 01:35:34 +00002199 Entries[i].second->getKeyLength()+1));
Bill Wendling480ff322009-05-20 23:21:38 +00002200 }
Eric Christopher2cbd5762013-01-07 19:32:41 +00002201
2202 // If we've got an offset section go ahead and emit that now as well.
2203 if (OffsetSection) {
2204 Asm->OutStreamer.SwitchSection(OffsetSection);
2205 unsigned offset = 0;
Eric Christopher962c9082013-01-15 23:56:56 +00002206 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002207 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopherbf7bc492013-01-09 03:52:05 +00002208 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopher2cbd5762013-01-07 19:32:41 +00002209 offset += Entries[i].second->getKeyLength() + 1;
2210 }
2211 }
Bill Wendling480ff322009-05-20 23:21:38 +00002212}
2213
Eric Christopher962c9082013-01-15 23:56:56 +00002214// Emit strings into a string section.
2215void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2216
2217 if (AddressPool.empty()) return;
2218
2219 // Start the dwarf addr section.
2220 Asm->OutStreamer.SwitchSection(AddrSection);
2221
2222 // Get all of the string pool entries and put them in an array by their ID so
2223 // we can sort them.
2224 SmallVector<std::pair<unsigned,
2225 std::pair<MCSymbol*, unsigned>* >, 64> Entries;
2226
2227 for (DenseMap<MCSymbol*, std::pair<MCSymbol*, unsigned> >::iterator
2228 I = AddressPool.begin(), E = AddressPool.end();
2229 I != E; ++I)
2230 Entries.push_back(std::make_pair(I->second.second, &(I->second)));
2231
2232 array_pod_sort(Entries.begin(), Entries.end());
2233
2234 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
2235 // Emit a label for reference from debug information entries.
2236 MCSymbol *Sym = Entries[i].second->first;
2237 if (Sym)
2238 Asm->EmitLabelReference(Entries[i].second->first,
2239 Asm->getDataLayout().getPointerSize());
2240 else
2241 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2242 }
2243
2244}
2245
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002246// Emit visible names into a debug str section.
2247void DwarfDebug::emitDebugStr() {
2248 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2249 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2250}
2251
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002252// Emit visible names into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002253void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002254 if (DotDebugLocEntries.empty())
2255 return;
2256
Devang Patel116a9d72011-02-04 22:57:18 +00002257 for (SmallVector<DotDebugLocEntry, 4>::iterator
2258 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2259 I != E; ++I) {
2260 DotDebugLocEntry &Entry = *I;
2261 if (I + 1 != DotDebugLocEntries.end())
2262 Entry.Merge(I+1);
2263 }
2264
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002265 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002266 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00002267 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002268 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002269 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2270 unsigned index = 1;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002271 for (SmallVector<DotDebugLocEntry, 4>::iterator
2272 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002273 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002274 DotDebugLocEntry &Entry = *I;
2275 if (Entry.isMerged()) continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002276 if (Entry.isEmpty()) {
Eric Christopherce0cfce2013-01-09 01:35:34 +00002277 Asm->OutStreamer.EmitIntValue(0, Size);
2278 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002279 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002280 } else {
Eric Christopherbf7bc492013-01-09 03:52:05 +00002281 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size);
2282 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size);
Devang Patel3e021532011-04-28 02:22:40 +00002283 DIVariable DV(Entry.Variable);
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002284 Asm->OutStreamer.AddComment("Loc expr size");
2285 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2286 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2287 Asm->EmitLabelDifference(end, begin, 2);
2288 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002289 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002290 DIBasicType BTy(DV.getType());
2291 if (BTy.Verify() &&
Eric Christopher6a841382012-11-19 22:42:10 +00002292 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patel324f8432011-06-01 22:03:25 +00002293 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2294 Asm->OutStreamer.AddComment("DW_OP_consts");
2295 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002296 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002297 } else {
2298 Asm->OutStreamer.AddComment("DW_OP_constu");
2299 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002300 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002301 }
Devang Pateled9fd452011-07-08 16:49:43 +00002302 } else if (Entry.isLocation()) {
Eric Christopher6a841382012-11-19 22:42:10 +00002303 if (!DV.hasComplexAddress())
Devang Pateled9fd452011-07-08 16:49:43 +00002304 // Regular entry.
Devang Patel3e021532011-04-28 02:22:40 +00002305 Asm->EmitDwarfRegOp(Entry.Loc);
Devang Pateled9fd452011-07-08 16:49:43 +00002306 else {
2307 // Complex address entry.
2308 unsigned N = DV.getNumAddrElements();
2309 unsigned i = 0;
2310 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
2311 if (Entry.Loc.getOffset()) {
2312 i = 2;
2313 Asm->EmitDwarfRegOp(Entry.Loc);
2314 Asm->OutStreamer.AddComment("DW_OP_deref");
2315 Asm->EmitInt8(dwarf::DW_OP_deref);
2316 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2317 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2318 Asm->EmitSLEB128(DV.getAddrElement(1));
2319 } else {
2320 // If first address element is OpPlus then emit
2321 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
2322 MachineLocation Loc(Entry.Loc.getReg(), DV.getAddrElement(1));
2323 Asm->EmitDwarfRegOp(Loc);
2324 i = 2;
2325 }
2326 } else {
2327 Asm->EmitDwarfRegOp(Entry.Loc);
2328 }
Eric Christopher6a841382012-11-19 22:42:10 +00002329
Devang Pateled9fd452011-07-08 16:49:43 +00002330 // Emit remaining complex address elements.
2331 for (; i < N; ++i) {
2332 uint64_t Element = DV.getAddrElement(i);
2333 if (Element == DIBuilder::OpPlus) {
2334 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2335 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher4d250522012-05-08 18:56:00 +00002336 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher8d2a77d2012-05-08 21:24:39 +00002337 if (!Entry.Loc.isReg())
Eric Christopher4d250522012-05-08 18:56:00 +00002338 Asm->EmitInt8(dwarf::DW_OP_deref);
2339 } else
2340 llvm_unreachable("unknown Opcode found in complex address");
Devang Pateled9fd452011-07-08 16:49:43 +00002341 }
Devang Patel3e021532011-04-28 02:22:40 +00002342 }
Devang Patel3e021532011-04-28 02:22:40 +00002343 }
Devang Pateled9fd452011-07-08 16:49:43 +00002344 // else ... ignore constant fp. There is not any good way to
2345 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002346 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002347 }
2348 }
Bill Wendling480ff322009-05-20 23:21:38 +00002349}
2350
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002351// Emit visible names into a debug aranges section.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002352void DwarfDebug::emitDebugARanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002353 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002354 Asm->OutStreamer.SwitchSection(
2355 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002356}
2357
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002358// Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002359void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002360 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002361 Asm->OutStreamer.SwitchSection(
Devang Patel12563b32010-04-16 23:33:45 +00002362 Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002363 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6c74a872010-04-27 19:46:33 +00002364 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002365 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00002366 I != E; ++I) {
2367 if (*I)
Eric Christopherbf7bc492013-01-09 03:52:05 +00002368 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
Devang Patel12563b32010-04-16 23:33:45 +00002369 else
Eric Christopherce0cfce2013-01-09 01:35:34 +00002370 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel12563b32010-04-16 23:33:45 +00002371 }
Bill Wendling480ff322009-05-20 23:21:38 +00002372}
2373
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002374// Emit visible names into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002375void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002376 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00002377 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00002378 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002379 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00002380 }
2381}
2382
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002383// Emit inline info using following format.
2384// Section Header:
2385// 1. length of section
2386// 2. Dwarf version number
2387// 3. address size.
2388//
2389// Entries (one "entry" for each function that was inlined):
2390//
2391// 1. offset into __debug_str section for MIPS linkage name, if exists;
2392// otherwise offset into __debug_str for regular function name.
2393// 2. offset into __debug_str section for regular function name.
2394// 3. an unsigned LEB128 number indicating the number of distinct inlining
2395// instances for the function.
2396//
2397// The rest of the entry consists of a {die_offset, low_pc} pair for each
2398// inlined instance; the die_offset points to the inlined_subroutine die in the
2399// __debug_info section, and the low_pc is the starting address for the
2400// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00002401void DwarfDebug::emitDebugInlineInfo() {
Eric Christopher1df94bf2012-03-02 02:11:47 +00002402 if (!Asm->MAI->doesDwarfUseInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00002403 return;
2404
Devang Patel1a0df9a2010-05-10 22:49:55 +00002405 if (!FirstCU)
Bill Wendling480ff322009-05-20 23:21:38 +00002406 return;
2407
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002408 Asm->OutStreamer.SwitchSection(
2409 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002410
Chris Lattner566cae92010-03-09 23:52:58 +00002411 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00002412 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
2413 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00002414
Chris Lattnera179b522010-04-04 19:25:43 +00002415 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00002416
Chris Lattner566cae92010-03-09 23:52:58 +00002417 Asm->OutStreamer.AddComment("Dwarf Version");
2418 Asm->EmitInt16(dwarf::DWARF_VERSION);
2419 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002420 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002421
Devang Patel32cc43c2010-05-07 20:54:48 +00002422 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002423 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00002424
Devang Patel32cc43c2010-05-07 20:54:48 +00002425 const MDNode *Node = *I;
2426 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00002427 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002428 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00002429 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00002430 StringRef LName = SP.getLinkageName();
2431 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00002432
Chris Lattner566cae92010-03-09 23:52:58 +00002433 Asm->OutStreamer.AddComment("MIPS linkage name");
Eric Christopher77725312012-03-02 01:57:52 +00002434 if (LName.empty())
Eric Christophere698f532012-12-20 21:58:36 +00002435 Asm->EmitSectionOffset(InfoHolder.getStringPoolEntry(Name),
2436 DwarfStrSectionSym);
Eric Christopher77725312012-03-02 01:57:52 +00002437 else
Eric Christophere698f532012-12-20 21:58:36 +00002438 Asm->EmitSectionOffset(InfoHolder
2439 .getStringPoolEntry(getRealLinkageName(LName)),
Chris Lattner70a4fce2010-04-04 23:25:33 +00002440 DwarfStrSectionSym);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002441
Chris Lattner566cae92010-03-09 23:52:58 +00002442 Asm->OutStreamer.AddComment("Function name");
Eric Christophere698f532012-12-20 21:58:36 +00002443 Asm->EmitSectionOffset(InfoHolder.getStringPoolEntry(Name),
2444 DwarfStrSectionSym);
Chris Lattner9efd1182010-04-04 19:09:29 +00002445 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00002446
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002447 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00002448 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner7bde8c02010-04-04 18:52:31 +00002449 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner085b6522010-03-09 00:31:02 +00002450 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00002451
Chris Lattner7bde8c02010-04-04 18:52:31 +00002452 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattner3a383cb2010-04-05 00:13:49 +00002453 Asm->OutStreamer.EmitSymbolValue(LI->first,
Eric Christopherbf7bc492013-01-09 03:52:05 +00002454 Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002455 }
2456 }
2457
Chris Lattnera179b522010-04-04 19:25:43 +00002458 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00002459}
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002460
Eric Christopherd692c1d2012-12-11 19:42:09 +00002461// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002462
2463// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2464// DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2465// DW_AT_ranges_base, DW_AT_addr_base. If DW_AT_ranges is present,
2466// DW_AT_low_pc and DW_AT_high_pc are not used, and vice versa.
Eric Christophercdf218d2012-12-10 19:51:21 +00002467CompileUnit *DwarfDebug::constructSkeletonCU(const MDNode *N) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002468 DICompileUnit DIUnit(N);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002469 CompilationDir = DIUnit.getDirectory();
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002470
2471 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyb42d1462012-12-03 18:45:45 +00002472 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
Eric Christophere698f532012-12-20 21:58:36 +00002473 DIUnit.getLanguage(), Die, Asm,
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002474 this, &SkeletonHolder);
Eric Christopher4c7765f2013-01-17 03:00:04 +00002475
2476 SmallString<16> T(DIUnit.getFilename());
2477 sys::path::replace_extension(T, ".dwo");
2478 StringRef FN = sys::path::filename(T);
Eric Christopher2cbd5762013-01-07 19:32:41 +00002479 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name, FN);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002480
Eric Christopher7a2cdf72013-02-05 07:31:55 +00002481 // This should be a unique identifier when we want to build .dwp files.
2482 NewCU->addUInt(Die, dwarf::DW_AT_GNU_dwo_id, dwarf::DW_FORM_data8, 0);
Eric Christopher18266172013-01-17 02:59:59 +00002483
2484 // FIXME: The addr base should be relative for each compile unit, however,
2485 // this one is going to be 0 anyhow.
2486 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002487
2488 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher962c9082013-01-15 23:56:56 +00002489 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002490 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher962c9082013-01-15 23:56:56 +00002491
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002492 // DW_AT_stmt_list is a offset of line number information for this
2493 // compile unit in debug_line section.
2494 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher4c7765f2013-01-17 03:00:04 +00002495 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher74804332013-02-07 21:19:50 +00002496 DwarfLineSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002497 else
Eric Christopher4c7765f2013-01-17 03:00:04 +00002498 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002499
2500 if (!CompilationDir.empty())
Eric Christopher2cbd5762013-01-07 19:32:41 +00002501 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002502
Eric Christopherc8a310e2012-12-10 23:34:43 +00002503 SkeletonHolder.addUnit(NewCU);
Eric Christopher5b33b3c2013-02-06 21:53:56 +00002504 SkeletonCUs.push_back(NewCU);
Eric Christopherc8a310e2012-12-10 23:34:43 +00002505
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002506 return NewCU;
2507}
2508
Eric Christopher3c5a1912012-12-19 22:02:53 +00002509void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
2510 assert(useSplitDwarf() && "No split dwarf debug info?");
2511 emitAbbrevs(Section, &SkeletonAbbrevs);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002512}
2513
Eric Christopherd692c1d2012-12-11 19:42:09 +00002514// Emit the .debug_info.dwo section for separated dwarf. This contains the
2515// compile units that would normally be in debug_info.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002516void DwarfDebug::emitDebugInfoDWO() {
Eric Christophercdf218d2012-12-10 19:51:21 +00002517 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christophera2de8262012-12-15 00:04:07 +00002518 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
Eric Christopher3c5a1912012-12-19 22:02:53 +00002519 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2520 DwarfAbbrevDWOSectionSym);
2521}
2522
2523// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2524// abbreviations for the .debug_info.dwo section.
2525void DwarfDebug::emitDebugAbbrevDWO() {
2526 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopher48fef592012-12-20 21:58:40 +00002527 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2528 &Abbreviations);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002529}
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002530
2531// Emit the .debug_str.dwo section for separated dwarf. This contains the
2532// string section and is identical in format to traditional .debug_str
2533// sections.
2534void DwarfDebug::emitDebugStrDWO() {
2535 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherb800ff72013-01-07 22:40:45 +00002536 const MCSection *OffSec = Asm->getObjFileLowering()
2537 .getDwarfStrOffDWOSection();
Eric Christopher2cbd5762013-01-07 19:32:41 +00002538 const MCSymbol *StrSym = DwarfStrSectionSym;
2539 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
2540 OffSec, StrSym);
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002541}