blob: 8864baa5c27fb3c9ae80bc6f564d9c4b4e6a26ce [file] [log] [blame]
Bill Wendling0310d762009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Chris Lattner6cde3e62010-03-09 00:39:24 +000013
Devang Patele4b27562009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling0310d762009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner74e41f92010-04-05 05:24:55 +000016#include "DIE.h"
Eric Christopher09ac3d82011-11-07 09:24:32 +000017#include "DwarfAccelTable.h"
Devang Patel8b9df622011-04-12 17:40:32 +000018#include "DwarfCompileUnit.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000019#include "llvm/ADT/STLExtras.h"
20#include "llvm/ADT/Statistic.h"
21#include "llvm/ADT/StringExtras.h"
22#include "llvm/ADT/Triple.h"
David Greeneb2c66fc2009-08-19 21:52:55 +000023#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling0310d762009-05-15 09:23:25 +000024#include "llvm/CodeGen/MachineModuleInfo.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000025#include "llvm/DIBuilder.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000026#include "llvm/DebugInfo.h"
Chandler Carruth0b8c9a82013-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 Lattnerb7db7332010-03-09 01:58:53 +000031#include "llvm/MC/MCAsmInfo.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000032#include "llvm/MC/MCSection.h"
Chris Lattner6c2f9e12009-08-19 05:49:37 +000033#include "llvm/MC/MCStreamer.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000034#include "llvm/MC/MCSymbol.h"
Devang Pateleac9c072010-04-27 19:46:33 +000035#include "llvm/Support/CommandLine.h"
Daniel Dunbar6e4bdfc2009-10-13 06:47:08 +000036#include "llvm/Support/Debug.h"
37#include "llvm/Support/ErrorHandling.h"
Chris Lattner0ad9c912010-01-22 22:09:00 +000038#include "llvm/Support/FormattedStream.h"
Michael J. Spencer1f6efa32010-11-29 18:16:10 +000039#include "llvm/Support/Path.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000040#include "llvm/Support/Timer.h"
41#include "llvm/Support/ValueHandle.h"
42#include "llvm/Target/TargetFrameLowering.h"
43#include "llvm/Target/TargetLoweringObjectFile.h"
44#include "llvm/Target/TargetMachine.h"
45#include "llvm/Target/TargetOptions.h"
46#include "llvm/Target/TargetRegisterInfo.h"
Bill Wendling0310d762009-05-15 09:23:25 +000047using namespace llvm;
48
Jim Grosbach1e20b962010-07-21 21:21:52 +000049static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel61409622010-07-07 20:12:52 +000050 cl::Hidden,
Devang Pateleac9c072010-04-27 19:46:33 +000051 cl::desc("Disable debug info printing"));
52
Dan Gohman281d65d2010-05-07 01:08:53 +000053static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
Chris Lattner7a2bdde2011-04-15 05:18:47 +000054 cl::desc("Make an absence of debug location information explicit."),
Dan Gohman281d65d2010-05-07 01:08:53 +000055 cl::init(false));
56
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +000057static cl::opt<bool> GenerateDwarfPubNamesSection("generate-dwarf-pubnames",
Eric Christopher3dcb5382013-04-03 05:26:07 +000058 cl::Hidden, cl::init(false),
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +000059 cl::desc("Generate DWARF pubnames section"));
60
Eric Christopher20f47ab2012-08-23 22:36:40 +000061namespace {
62 enum DefaultOnOff {
63 Default, Enable, Disable
64 };
65}
Eric Christopher09ac3d82011-11-07 09:24:32 +000066
Eric Christopher20f47ab2012-08-23 22:36:40 +000067static cl::opt<DefaultOnOff> DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
68 cl::desc("Output prototype dwarf accelerator tables."),
69 cl::values(
70 clEnumVal(Default, "Default for platform"),
71 clEnumVal(Enable, "Enabled"),
72 clEnumVal(Disable, "Disabled"),
73 clEnumValEnd),
74 cl::init(Default));
75
76static cl::opt<DefaultOnOff> DarwinGDBCompat("darwin-gdb-compat", cl::Hidden,
Eric Christopher10cb7442012-08-23 07:10:46 +000077 cl::desc("Compatibility with Darwin gdb."),
Eric Christopher20f47ab2012-08-23 22:36:40 +000078 cl::values(
79 clEnumVal(Default, "Default for platform"),
80 clEnumVal(Enable, "Enabled"),
81 clEnumVal(Disable, "Disabled"),
82 clEnumValEnd),
83 cl::init(Default));
Eric Christopher10cb7442012-08-23 07:10:46 +000084
Eric Christopher4daaed12012-12-10 19:51:21 +000085static cl::opt<DefaultOnOff> SplitDwarf("split-dwarf", cl::Hidden,
86 cl::desc("Output prototype dwarf split debug info."),
Eric Christopherf5b6dcd2012-11-12 22:22:20 +000087 cl::values(
88 clEnumVal(Default, "Default for platform"),
89 clEnumVal(Enable, "Enabled"),
90 clEnumVal(Disable, "Disabled"),
91 clEnumValEnd),
92 cl::init(Default));
93
Bill Wendling5f017e82010-04-07 09:28:04 +000094namespace {
95 const char *DWARFGroupName = "DWARF Emission";
96 const char *DbgTimerName = "DWARF Debug Writer";
David Blaikied2e0f7e2013-05-06 23:33:07 +000097
98 struct CompareFirst {
99 template <typename T> bool operator()(const T &lhs, const T &rhs) const {
100 return lhs.first < rhs.first;
101 }
102 };
Bill Wendling5f017e82010-04-07 09:28:04 +0000103} // end anonymous namespace
104
Bill Wendling0310d762009-05-15 09:23:25 +0000105//===----------------------------------------------------------------------===//
106
Eric Christopherb6dc8652012-11-27 22:43:45 +0000107// Configuration values for initial hash set sizes (log2).
108//
Bill Wendling0310d762009-05-15 09:23:25 +0000109static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling0310d762009-05-15 09:23:25 +0000110
111namespace llvm {
112
Nick Lewycky3bbb6f72011-07-29 03:49:23 +0000113DIType DbgVariable::getType() const {
Devang Patel3cbee302011-04-12 22:53:02 +0000114 DIType Ty = Var.getType();
115 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
116 // addresses instead.
117 if (Var.isBlockByrefVariable()) {
118 /* Byref variables, in Blocks, are declared by the programmer as
119 "SomeType VarName;", but the compiler creates a
120 __Block_byref_x_VarName struct, and gives the variable VarName
121 either the struct, or a pointer to the struct, as its type. This
122 is necessary for various behind-the-scenes things the compiler
123 needs to do with by-reference variables in blocks.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000124
Devang Patel3cbee302011-04-12 22:53:02 +0000125 However, as far as the original *programmer* is concerned, the
126 variable should still have type 'SomeType', as originally declared.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000127
Devang Patel3cbee302011-04-12 22:53:02 +0000128 The following function dives into the __Block_byref_x_VarName
129 struct to find the original type of the variable. This will be
130 passed back to the code generating the type for the Debug
131 Information Entry for the variable 'VarName'. 'VarName' will then
132 have the original type 'SomeType' in its debug information.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000133
Devang Patel3cbee302011-04-12 22:53:02 +0000134 The original type 'SomeType' will be the type of the field named
135 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000136
Devang Patel3cbee302011-04-12 22:53:02 +0000137 NOTE: In order for this to not completely fail on the debugger
138 side, the Debug Information Entry for the variable VarName needs to
139 have a DW_AT_location that tells the debugger how to unwind through
140 the pointers and __Block_byref_x_VarName struct to find the actual
141 value of the variable. The function addBlockByrefType does this. */
142 DIType subType = Ty;
143 unsigned tag = Ty.getTag();
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000144
Devang Patel3cbee302011-04-12 22:53:02 +0000145 if (tag == dwarf::DW_TAG_pointer_type) {
146 DIDerivedType DTy = DIDerivedType(Ty);
147 subType = DTy.getTypeDerivedFrom();
148 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000149
Devang Patel3cbee302011-04-12 22:53:02 +0000150 DICompositeType blockStruct = DICompositeType(subType);
151 DIArray Elements = blockStruct.getTypeArray();
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000152
Devang Patel3cbee302011-04-12 22:53:02 +0000153 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
154 DIDescriptor Element = Elements.getElement(i);
155 DIDerivedType DT = DIDerivedType(Element);
156 if (getName() == DT.getName())
157 return (DT.getTypeDerivedFrom());
Devang Patel8bd11de2010-08-09 21:01:39 +0000158 }
Devang Patel8bd11de2010-08-09 21:01:39 +0000159 }
Devang Patel3cbee302011-04-12 22:53:02 +0000160 return Ty;
161}
Bill Wendling0310d762009-05-15 09:23:25 +0000162
Chris Lattnerea761862010-04-05 04:09:20 +0000163} // end llvm namespace
Bill Wendling0310d762009-05-15 09:23:25 +0000164
Chris Lattner49cd6642010-04-05 05:11:15 +0000165DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Eric Christopher28bd25a2012-12-10 19:51:13 +0000166 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbach1e20b962010-07-21 21:21:52 +0000167 AbbreviationsSet(InitAbbreviationsSetSize),
Eric Christopherb6714222013-01-08 22:22:06 +0000168 SourceIdMap(DIEValueAllocator),
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000169 PrevLabel(NULL), GlobalCUIndexCount(0),
Eric Christopherb6714222013-01-08 22:22:06 +0000170 InfoHolder(A, &AbbreviationsSet, &Abbreviations, "info_string",
171 DIEValueAllocator),
Eric Christopher6eebe472012-12-19 22:02:53 +0000172 SkeletonAbbrevSet(InitAbbreviationsSetSize),
Eric Christopherb6714222013-01-08 22:22:06 +0000173 SkeletonHolder(A, &SkeletonAbbrevSet, &SkeletonAbbrevs, "skel_string",
174 DIEValueAllocator) {
Jim Grosbach1e20b962010-07-21 21:21:52 +0000175
Rafael Espindolaf2b04232011-05-06 14:56:22 +0000176 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattner4ad1efe2010-04-04 23:10:38 +0000177 DwarfStrSectionSym = TextSectionSym = 0;
Eric Christopher7a0103c2013-02-07 21:19:50 +0000178 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
Eric Christopher9a9e73b2013-04-07 03:43:09 +0000179 DwarfAddrSectionSym = 0;
Eric Christopher64f824c2012-12-27 02:14:01 +0000180 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
Devang Patelc3f5f782010-05-25 23:40:22 +0000181 FunctionBeginSym = FunctionEndSym = 0;
Eric Christopher60777d82012-04-02 17:58:52 +0000182
Eric Christopher10cb7442012-08-23 07:10:46 +0000183 // Turn on accelerator tables and older gdb compatibility
184 // for Darwin.
Eric Christopher00297ba2013-04-27 01:07:52 +0000185 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
Eric Christopher20f47ab2012-08-23 22:36:40 +0000186 if (DarwinGDBCompat == Default) {
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000187 if (IsDarwin)
188 IsDarwinGDBCompat = true;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000189 else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000190 IsDarwinGDBCompat = false;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000191 } else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000192 IsDarwinGDBCompat = DarwinGDBCompat == Enable ? true : false;
Eric Christopherc1610fa2012-08-23 22:36:36 +0000193
Eric Christopher20f47ab2012-08-23 22:36:40 +0000194 if (DwarfAccelTables == Default) {
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000195 if (IsDarwin)
196 HasDwarfAccelTables = true;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000197 else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000198 HasDwarfAccelTables = false;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000199 } else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000200 HasDwarfAccelTables = DwarfAccelTables == Enable ? true : false;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000201
Eric Christopher4daaed12012-12-10 19:51:21 +0000202 if (SplitDwarf == Default)
203 HasSplitDwarf = false;
Eric Christopherf5b6dcd2012-11-12 22:22:20 +0000204 else
Eric Christopher4daaed12012-12-10 19:51:21 +0000205 HasSplitDwarf = SplitDwarf == Enable ? true : false;
Eric Christopherf5b6dcd2012-11-12 22:22:20 +0000206
Dan Gohman03c3dc72010-06-18 15:56:31 +0000207 {
208 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopherc4639d62012-11-19 22:42:15 +0000209 beginModule();
Torok Edwin9c421072010-04-07 10:44:46 +0000210 }
Bill Wendling0310d762009-05-15 09:23:25 +0000211}
212DwarfDebug::~DwarfDebug() {
Bill Wendling0310d762009-05-15 09:23:25 +0000213}
214
Eric Christopherb6dc8652012-11-27 22:43:45 +0000215// Switch to the specified MCSection and emit an assembler
216// temporary label to it if SymbolStem is specified.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000217static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christopherd8a87522011-11-07 09:18:38 +0000218 const char *SymbolStem = 0) {
219 Asm->OutStreamer.SwitchSection(Section);
220 if (!SymbolStem) return 0;
221
222 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
223 Asm->OutStreamer.EmitLabel(TmpSym);
224 return TmpSym;
225}
226
Eric Christopher2e5d8702012-12-20 21:58:36 +0000227MCSymbol *DwarfUnits::getStringPoolSym() {
Eric Christopher64f824c2012-12-27 02:14:01 +0000228 return Asm->GetTempSymbol(StringPref);
Nick Lewycky390c40d2011-10-27 06:44:11 +0000229}
230
Eric Christopher2e5d8702012-12-20 21:58:36 +0000231MCSymbol *DwarfUnits::getStringPoolEntry(StringRef Str) {
232 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopherb6714222013-01-08 22:22:06 +0000233 StringPool.GetOrCreateValue(Str).getValue();
Chris Lattnerbc733f52010-03-13 02:17:42 +0000234 if (Entry.first) return Entry.first;
235
236 Entry.second = NextStringPoolNumber++;
Eric Christopher64f824c2012-12-27 02:14:01 +0000237 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
Chris Lattnerbc733f52010-03-13 02:17:42 +0000238}
239
Eric Christopherdd8e9f32013-01-07 19:32:41 +0000240unsigned DwarfUnits::getStringPoolIndex(StringRef Str) {
241 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopherb6714222013-01-08 22:22:06 +0000242 StringPool.GetOrCreateValue(Str).getValue();
Eric Christopherdd8e9f32013-01-07 19:32:41 +0000243 if (Entry.first) return Entry.second;
244
245 Entry.second = NextStringPoolNumber++;
246 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
247 return Entry.second;
248}
249
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000250unsigned DwarfUnits::getAddrPoolIndex(MCSymbol *Sym) {
251 std::pair<MCSymbol*, unsigned> &Entry = AddressPool[Sym];
252 if (Entry.first) return Entry.second;
253
254 Entry.second = NextAddrPoolNumber++;
255 Entry.first = Sym;
256 return Entry.second;
257}
258
Eric Christopherb6dc8652012-11-27 22:43:45 +0000259// Define a unique number for the abbreviation.
260//
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000261void DwarfUnits::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling0310d762009-05-15 09:23:25 +0000262 // Profile the node so that we can make it unique.
263 FoldingSetNodeID ID;
264 Abbrev.Profile(ID);
265
266 // Check the set for priors.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000267 DIEAbbrev *InSet = AbbreviationsSet->GetOrInsertNode(&Abbrev);
Bill Wendling0310d762009-05-15 09:23:25 +0000268
269 // If it's newly added.
270 if (InSet == &Abbrev) {
271 // Add to abbreviation list.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000272 Abbreviations->push_back(&Abbrev);
Bill Wendling0310d762009-05-15 09:23:25 +0000273
274 // Assign the vector position + 1 as its number.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000275 Abbrev.setNumber(Abbreviations->size());
Bill Wendling0310d762009-05-15 09:23:25 +0000276 } else {
277 // Assign existing abbreviation number.
278 Abbrev.setNumber(InSet->getNumber());
279 }
280}
281
Eric Christopherb6dc8652012-11-27 22:43:45 +0000282// If special LLVM prefix that is used to inform the asm
283// printer to not emit usual symbol prefix before the symbol name is used then
284// return linkage name after skipping this special LLVM prefix.
Devang Patel351ca332010-01-05 01:46:14 +0000285static StringRef getRealLinkageName(StringRef LinkageName) {
286 char One = '\1';
287 if (LinkageName.startswith(StringRef(&One, 1)))
288 return LinkageName.substr(1);
289 return LinkageName;
290}
291
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000292static bool isObjCClass(StringRef Name) {
293 return Name.startswith("+") || Name.startswith("-");
294}
295
296static bool hasObjCCategory(StringRef Name) {
297 if (!isObjCClass(Name)) return false;
298
299 size_t pos = Name.find(')');
300 if (pos != std::string::npos) {
301 if (Name[pos+1] != ' ') return false;
302 return true;
303 }
304 return false;
305}
306
307static void getObjCClassCategory(StringRef In, StringRef &Class,
308 StringRef &Category) {
309 if (!hasObjCCategory(In)) {
310 Class = In.slice(In.find('[') + 1, In.find(' '));
311 Category = "";
312 return;
313 }
314
315 Class = In.slice(In.find('[') + 1, In.find('('));
316 Category = In.slice(In.find('[') + 1, In.find(' '));
317 return;
318}
319
320static StringRef getObjCMethodName(StringRef In) {
321 return In.slice(In.find(' ') + 1, In.find(']'));
322}
323
324// Add the various names to the Dwarf accelerator table names.
325static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
326 DIE* Die) {
327 if (!SP.isDefinition()) return;
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000328
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000329 TheCU->addAccelName(SP.getName(), Die);
330
331 // If the linkage name is different than the name, go ahead and output
332 // that as well into the name table.
333 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
334 TheCU->addAccelName(SP.getLinkageName(), Die);
335
336 // If this is an Objective-C selector name add it to the ObjC accelerator
337 // too.
338 if (isObjCClass(SP.getName())) {
339 StringRef Class, Category;
340 getObjCClassCategory(SP.getName(), Class, Category);
341 TheCU->addAccelObjC(Class, Die);
342 if (Category != "")
343 TheCU->addAccelObjC(Category, Die);
344 // Also add the base method name to the name table.
345 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
346 }
347}
348
Eric Christopherb6dc8652012-11-27 22:43:45 +0000349// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
350// and DW_AT_high_pc attributes. If there are global variables in this
351// scope then create and insert DIEs for these variables.
Devang Pateld3024342011-08-15 22:24:32 +0000352DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
353 const MDNode *SPNode) {
Devang Patel163a9f72010-05-10 22:49:55 +0000354 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patel8aa61472010-07-07 22:20:57 +0000355
Chris Lattnerd38fee82010-04-05 00:13:49 +0000356 assert(SPDie && "Unable to find subprogram DIE!");
357 DISubprogram SP(SPNode);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000358
Bill Wendling168c1902012-11-07 05:19:04 +0000359 // If we're updating an abstract DIE, then we will be adding the children and
360 // object pointer later on. But what we don't want to do is process the
361 // concrete DIE twice.
Manman Renbc3e96f2013-03-12 18:27:15 +0000362 DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode);
363 if (AbsSPDIE) {
364 bool InSameCU = (AbsSPDIE->getCompileUnit() == SPCU->getCUDie());
Bill Wendling168c1902012-11-07 05:19:04 +0000365 // Pick up abstract subprogram DIE.
Devang Patel8aa61472010-07-07 22:20:57 +0000366 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Manman Renbc3e96f2013-03-12 18:27:15 +0000367 // If AbsSPDIE belongs to a different CU, use DW_FORM_ref_addr instead of
368 // DW_FORM_ref4.
Devang Patel3cbee302011-04-12 22:53:02 +0000369 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
Manman Renbc3e96f2013-03-12 18:27:15 +0000370 InSameCU ? dwarf::DW_FORM_ref4 : dwarf::DW_FORM_ref_addr,
371 AbsSPDIE);
Devang Patel8aa61472010-07-07 22:20:57 +0000372 SPCU->addDie(SPDie);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000373 } else {
374 DISubprogram SPDecl = SP.getFunctionDeclaration();
375 if (!SPDecl.isSubprogram()) {
376 // There is not any need to generate specification DIE for a function
377 // defined at compile unit level. If a function is defined inside another
378 // function then gdb prefers the definition at top level and but does not
379 // expect specification DIE in parent function. So avoid creating
380 // specification DIE for a function defined inside a function.
381 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
382 !SP.getContext().isFile() &&
383 !isSubprogramContext(SP.getContext())) {
384 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
385
386 // Add arguments.
387 DICompositeType SPTy = SP.getType();
388 DIArray Args = SPTy.getTypeArray();
389 unsigned SPTag = SPTy.getTag();
390 if (SPTag == dwarf::DW_TAG_subroutine_type)
391 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
392 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
393 DIType ATy = DIType(Args.getElement(i));
394 SPCU->addType(Arg, ATy);
395 if (ATy.isArtificial())
396 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
397 if (ATy.isObjectPointer())
398 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer,
399 dwarf::DW_FORM_ref4, Arg);
400 SPDie->addChild(Arg);
401 }
402 DIE *SPDeclDie = SPDie;
403 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000404 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification,
405 dwarf::DW_FORM_ref4, SPDeclDie);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000406 SPCU->addDie(SPDie);
407 }
408 }
Devang Patel8aa61472010-07-07 22:20:57 +0000409 }
410
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000411 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc,
412 Asm->GetTempSymbol("func_begin",
413 Asm->getFunctionNumber()));
414 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
415 Asm->GetTempSymbol("func_end",
416 Asm->getFunctionNumber()));
Chris Lattnerd38fee82010-04-05 00:13:49 +0000417 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
418 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patel3cbee302011-04-12 22:53:02 +0000419 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +0000420
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000421 // Add name to the name table, we do this here because we're guaranteed
422 // to have concrete versions of our DW_TAG_subprogram nodes.
423 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000424
Chris Lattnerd38fee82010-04-05 00:13:49 +0000425 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +0000426}
427
Eric Christopherb6dc8652012-11-27 22:43:45 +0000428// Construct new DW_TAG_lexical_block for this scope and attach
429// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000430DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld3024342011-08-15 22:24:32 +0000431 LexicalScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +0000432 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
433 if (Scope->isAbstractScope())
434 return ScopeDIE;
435
Devang Patelbf47fdb2011-08-10 20:55:27 +0000436 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
Devang Pateleac9c072010-04-27 19:46:33 +0000437 if (Ranges.empty())
438 return 0;
439
Devang Patelbf47fdb2011-08-10 20:55:27 +0000440 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
Devang Pateleac9c072010-04-27 19:46:33 +0000441 if (Ranges.size() > 1) {
442 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbach1e20b962010-07-21 21:21:52 +0000443 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Pateleac9c072010-04-27 19:46:33 +0000444 // DW_AT_ranges appropriately.
Devang Patel3cbee302011-04-12 22:53:02 +0000445 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000446 DebugRangeSymbols.size()
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000447 * Asm->getDataLayout().getPointerSize());
Devang Patelbf47fdb2011-08-10 20:55:27 +0000448 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +0000449 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +0000450 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
451 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +0000452 }
453 DebugRangeSymbols.push_back(NULL);
454 DebugRangeSymbols.push_back(NULL);
455 return ScopeDIE;
456 }
457
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000458 MCSymbol *Start = getLabelBeforeInsn(RI->first);
459 MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +0000460
Devang Patelc3f5f782010-05-25 23:40:22 +0000461 if (End == 0) return 0;
Devang Patel53bb5c92009-11-10 23:06:00 +0000462
Chris Lattnerb7db7332010-03-09 01:58:53 +0000463 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
464 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbach1e20b962010-07-21 21:21:52 +0000465
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000466 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
467 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patel53bb5c92009-11-10 23:06:00 +0000468
469 return ScopeDIE;
470}
471
Eric Christopherb6dc8652012-11-27 22:43:45 +0000472// This scope represents inlined body of a function. Construct DIE to
473// represent this concrete inlined copy of the function.
Devang Pateld3024342011-08-15 22:24:32 +0000474DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
475 LexicalScope *Scope) {
Devang Patelbf47fdb2011-08-10 20:55:27 +0000476 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
Nick Lewycky746cb672011-10-26 22:55:33 +0000477 assert(Ranges.empty() == false &&
478 "LexicalScope does not have instruction markers!");
Devang Pateleac9c072010-04-27 19:46:33 +0000479
Devang Patel26a92002011-07-27 00:34:13 +0000480 if (!Scope->getScopeNode())
481 return NULL;
482 DIScope DS(Scope->getScopeNode());
483 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel26a92002011-07-27 00:34:13 +0000484 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
485 if (!OriginDIE) {
Bill Wendlinge0aae5b2012-10-30 17:51:02 +0000486 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patel26a92002011-07-27 00:34:13 +0000487 return NULL;
488 }
489
Devang Patelbf47fdb2011-08-10 20:55:27 +0000490 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000491 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
492 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +0000493
Devang Patel0afbf232010-07-08 22:39:20 +0000494 if (StartLabel == 0 || EndLabel == 0) {
Bill Wendlinge0aae5b2012-10-30 17:51:02 +0000495 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
Devang Pateleac9c072010-04-27 19:46:33 +0000496 }
Chris Lattnerb7db7332010-03-09 01:58:53 +0000497 assert(StartLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +0000498 "Invalid starting label for an inlined scope!");
Chris Lattnerb7db7332010-03-09 01:58:53 +0000499 assert(EndLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +0000500 "Invalid end label for an inlined scope!");
Devang Pateleac9c072010-04-27 19:46:33 +0000501
Devang Pateld96efb82011-05-05 17:54:26 +0000502 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Devang Patel3cbee302011-04-12 22:53:02 +0000503 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
504 dwarf::DW_FORM_ref4, OriginDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +0000505
Devang Patel26a92002011-07-27 00:34:13 +0000506 if (Ranges.size() > 1) {
507 // .debug_range section has not been laid out yet. Emit offset in
508 // .debug_range as a uint, size 4, for now. emitDIE will handle
509 // DW_AT_ranges appropriately.
510 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000511 DebugRangeSymbols.size()
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000512 * Asm->getDataLayout().getPointerSize());
Devang Patelbf47fdb2011-08-10 20:55:27 +0000513 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patel26a92002011-07-27 00:34:13 +0000514 RE = Ranges.end(); RI != RE; ++RI) {
515 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
516 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
517 }
518 DebugRangeSymbols.push_back(NULL);
519 DebugRangeSymbols.push_back(NULL);
520 } else {
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000521 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
522 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patel26a92002011-07-27 00:34:13 +0000523 }
Devang Patel53bb5c92009-11-10 23:06:00 +0000524
525 InlinedSubprogramDIEs.insert(OriginDIE);
526
527 // Track the start label for this inlined function.
Devang Patel26a92002011-07-27 00:34:13 +0000528 //.debug_inlined section specification does not clearly state how
529 // to emit inlined scope that is split into multiple instruction ranges.
530 // For now, use first instruction range and emit low_pc/high_pc pair and
531 // corresponding .debug_inlined section entry for this pair.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000532 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patel2db49d72010-05-07 18:11:54 +0000533 I = InlineInfo.find(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +0000534
535 if (I == InlineInfo.end()) {
Nick Lewycky746cb672011-10-26 22:55:33 +0000536 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patel2db49d72010-05-07 18:11:54 +0000537 InlinedSPNodes.push_back(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +0000538 } else
Chris Lattner6ed0f902010-03-09 00:31:02 +0000539 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patel53bb5c92009-11-10 23:06:00 +0000540
Devang Patel53bb5c92009-11-10 23:06:00 +0000541 DILocation DL(Scope->getInlinedAt());
Eric Christopher08212002012-03-26 21:38:38 +0000542 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0,
Manman Ren3de61b42013-03-07 01:42:00 +0000543 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
544 TheCU->getUniqueID()));
Devang Patel3cbee302011-04-12 22:53:02 +0000545 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +0000546
Eric Christopher309bedd2011-12-04 06:02:38 +0000547 // Add name to the name table, we do this here because we're guaranteed
548 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
549 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000550
Devang Patel53bb5c92009-11-10 23:06:00 +0000551 return ScopeDIE;
552}
553
Eric Christopherb6dc8652012-11-27 22:43:45 +0000554// Construct a DIE for this scope.
Devang Pateld0b5a5e2011-08-15 22:04:40 +0000555DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
Devang Patel3c91b052010-03-08 20:52:55 +0000556 if (!Scope || !Scope->getScopeNode())
557 return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000558
Manman Ren8b15d742013-01-31 20:05:14 +0000559 DIScope DS(Scope->getScopeNode());
560 // Early return to avoid creating dangling variable|scope DIEs.
561 if (!Scope->getInlinedAt() && DS.isSubprogram() && Scope->isAbstractScope() &&
562 !TheCU->getDIE(DS))
563 return NULL;
564
Nick Lewycky746cb672011-10-26 22:55:33 +0000565 SmallVector<DIE *, 8> Children;
Eric Christophere5212782012-09-12 23:36:19 +0000566 DIE *ObjectPointer = NULL;
Devang Patel0478c152011-03-01 22:58:55 +0000567
568 // Collect arguments for current function.
Devang Patelbf47fdb2011-08-10 20:55:27 +0000569 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +0000570 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
571 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000572 if (DIE *Arg =
Eric Christophere5212782012-09-12 23:36:19 +0000573 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel0478c152011-03-01 22:58:55 +0000574 Children.push_back(Arg);
Eric Christophere5212782012-09-12 23:36:19 +0000575 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
576 }
Devang Patel0478c152011-03-01 22:58:55 +0000577
Eric Christopher1aeb7ac2011-10-03 15:49:16 +0000578 // Collect lexical scope children first.
Devang Patelbf47fdb2011-08-10 20:55:27 +0000579 const SmallVector<DbgVariable *, 8> &Variables = ScopeVariables.lookup(Scope);
Devang Patel5bc9fec2011-02-19 01:31:27 +0000580 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000581 if (DIE *Variable =
Eric Christopher7b451cf2012-09-21 22:18:52 +0000582 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5bc9fec2011-02-19 01:31:27 +0000583 Children.push_back(Variable);
Eric Christopher7b451cf2012-09-21 22:18:52 +0000584 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
585 }
Devang Patelbf47fdb2011-08-10 20:55:27 +0000586 const SmallVector<LexicalScope *, 4> &Scopes = Scope->getChildren();
Devang Patel5bc9fec2011-02-19 01:31:27 +0000587 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Pateld0b5a5e2011-08-15 22:04:40 +0000588 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5bc9fec2011-02-19 01:31:27 +0000589 Children.push_back(Nested);
Devang Patel3c91b052010-03-08 20:52:55 +0000590 DIE *ScopeDIE = NULL;
591 if (Scope->getInlinedAt())
Devang Pateld3024342011-08-15 22:24:32 +0000592 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3c91b052010-03-08 20:52:55 +0000593 else if (DS.isSubprogram()) {
Devang Patel0dd45582010-06-28 20:53:04 +0000594 ProcessedSPNodes.insert(DS);
Devang Patel8aa61472010-07-07 22:20:57 +0000595 if (Scope->isAbstractScope()) {
Devang Pateld3024342011-08-15 22:24:32 +0000596 ScopeDIE = TheCU->getDIE(DS);
Devang Patel8aa61472010-07-07 22:20:57 +0000597 // Note down abstract DIE.
598 if (ScopeDIE)
599 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
600 }
Devang Patel3c91b052010-03-08 20:52:55 +0000601 else
Devang Pateld3024342011-08-15 22:24:32 +0000602 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3c91b052010-03-08 20:52:55 +0000603 }
Devang Patel5bc9fec2011-02-19 01:31:27 +0000604 else {
605 // There is no need to emit empty lexical block DIE.
David Blaikied2e0f7e2013-05-06 23:33:07 +0000606 std::pair<ImportedEntityMap::const_iterator,
607 ImportedEntityMap::const_iterator> Range = std::equal_range(
608 ScopesWithImportedEntities.begin(), ScopesWithImportedEntities.end(),
Timur Iskhodzhanov664fbee2013-05-07 07:47:47 +0000609 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode*)0),
610 CompareFirst());
David Blaikied2e0f7e2013-05-06 23:33:07 +0000611 if (Children.empty() && Range.first == Range.second)
Devang Patel5bc9fec2011-02-19 01:31:27 +0000612 return NULL;
Devang Pateld3024342011-08-15 22:24:32 +0000613 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
David Blaikied2e0f7e2013-05-06 23:33:07 +0000614 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second; ++i)
615 constructImportedModuleDIE(TheCU, i->second, ScopeDIE);
Devang Patel5bc9fec2011-02-19 01:31:27 +0000616 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000617
Devang Patelaead63c2010-03-29 22:59:58 +0000618 if (!ScopeDIE) return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000619
Devang Patel5bc9fec2011-02-19 01:31:27 +0000620 // Add children
621 for (SmallVector<DIE *, 8>::iterator I = Children.begin(),
622 E = Children.end(); I != E; ++I)
623 ScopeDIE->addChild(*I);
Devang Patel193f7202009-11-24 01:14:22 +0000624
Eric Christophere5212782012-09-12 23:36:19 +0000625 if (DS.isSubprogram() && ObjectPointer != NULL)
626 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer,
627 dwarf::DW_FORM_ref4, ObjectPointer);
628
Jim Grosbach1e20b962010-07-21 21:21:52 +0000629 if (DS.isSubprogram())
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000630 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbach1e20b962010-07-21 21:21:52 +0000631
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000632 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +0000633}
634
Eric Christopherb6dc8652012-11-27 22:43:45 +0000635// Look up the source id with the given directory and source file names.
636// If none currently exists, create a new id and insert it in the
637// SourceIds map. This can update DirectoryNames and SourceFileNames maps
638// as well.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000639unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Manman Ren3de61b42013-03-07 01:42:00 +0000640 StringRef DirName, unsigned CUID) {
641 // If we use .loc in assembly, we can't separate .file entries according to
642 // compile units. Thus all files will belong to the default compile unit.
643 if (Asm->TM.hasMCUseLoc() &&
644 Asm->OutStreamer.getKind() == MCStreamer::SK_AsmStreamer)
645 CUID = 0;
646
Devang Patel1905a182010-09-16 20:57:49 +0000647 // If FE did not provide a file name, then assume stdin.
648 if (FileName.empty())
Manman Ren3de61b42013-03-07 01:42:00 +0000649 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patel23670e52011-03-24 20:30:50 +0000650
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000651 // TODO: this might not belong here. See if we can factor this better.
652 if (DirName == CompilationDir)
653 DirName = "";
654
Manman Ren3de61b42013-03-07 01:42:00 +0000655 // FileIDCUMap stores the current ID for the given compile unit.
656 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel1905a182010-09-16 20:57:49 +0000657
Manman Ren3de61b42013-03-07 01:42:00 +0000658 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer74612c22012-03-11 14:56:26 +0000659 SmallString<128> NamePair;
Manman Ren5044a932013-04-06 01:02:38 +0000660 NamePair += utostr(CUID);
Manman Ren3de61b42013-03-07 01:42:00 +0000661 NamePair += '\0';
Benjamin Kramer74612c22012-03-11 14:56:26 +0000662 NamePair += DirName;
663 NamePair += '\0'; // Zero bytes are not allowed in paths.
664 NamePair += FileName;
665
666 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
667 if (Ent.getValue() != SrcId)
668 return Ent.getValue();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000669
Manman Ren3de61b42013-03-07 01:42:00 +0000670 FileIDCUMap[CUID] = SrcId;
Rafael Espindola5c055632010-11-18 02:04:25 +0000671 // Print out a .file directive to specify files for .loc directives.
Manman Ren3de61b42013-03-07 01:42:00 +0000672 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000673
674 return SrcId;
675}
676
Eric Christopher72c16552012-12-20 21:58:40 +0000677// Create new CompileUnit for the given metadata node with tag
678// DW_TAG_compile_unit.
Devang Patel94c7ddb2011-08-16 22:09:43 +0000679CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +0000680 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +0000681 StringRef FN = DIUnit.getFilename();
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000682 CompilationDir = DIUnit.getDirectory();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000683
684 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyd4a05e02012-12-03 18:45:45 +0000685 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
Eric Christopher9c57ad22013-05-08 00:58:51 +0000686 DIUnit.getLanguage(), Die, N, Asm,
Eric Christopher2e5d8702012-12-20 21:58:36 +0000687 this, &InfoHolder);
Manman Ren3de61b42013-03-07 01:42:00 +0000688
689 FileIDCUMap[NewCU->getUniqueID()] = 0;
690 // Call this to emit a .file directive if it wasn't emitted for the source
691 // file this CU comes from yet.
692 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
693
Nick Lewycky390c40d2011-10-27 06:44:11 +0000694 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patel3cbee302011-04-12 22:53:02 +0000695 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
696 DIUnit.getLanguage());
Nick Lewycky390c40d2011-10-27 06:44:11 +0000697 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christophere0828ec2013-04-09 19:23:15 +0000698
Eric Christopher6635cad2012-08-01 18:19:01 +0000699 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christophere0828ec2013-04-09 19:23:15 +0000700 // into an entity. We're using 0 (or a NULL label) for this. For
701 // split dwarf it's in the skeleton CU so omit it here.
702 if (!useSplitDwarf())
703 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
Manman Ren43213cf2013-02-05 21:52:47 +0000704
705 // Define start line table label for each Compile Unit.
706 MCSymbol *LineTableStartSym = Asm->GetTempSymbol("line_table_start",
707 NewCU->getUniqueID());
708 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
709 NewCU->getUniqueID());
710
Devang Patel4a602ca2010-03-22 23:11:36 +0000711 // DW_AT_stmt_list is a offset of line number information for this
Eric Christophere0828ec2013-04-09 19:23:15 +0000712 // compile unit in debug_line section. For split dwarf this is
713 // left in the skeleton CU and so not included.
Manman Renf2d89ff2013-02-09 00:41:44 +0000714 // The line table entries are not always emitted in assembly, so it
715 // is not okay to use line_table_start here.
Eric Christophere0828ec2013-04-09 19:23:15 +0000716 if (!useSplitDwarf()) {
717 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
718 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
719 NewCU->getUniqueID() == 0 ?
720 Asm->GetTempSymbol("section_line") : LineTableStartSym);
721 else if (NewCU->getUniqueID() == 0)
722 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
723 else
724 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
725 LineTableStartSym, DwarfLineSectionSym);
726 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000727
Eric Christophere0828ec2013-04-09 19:23:15 +0000728 // If we're using split dwarf the compilation dir is going to be in the
729 // skeleton CU and so we don't need to duplicate it here.
730 if (!useSplitDwarf() && !CompilationDir.empty())
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000731 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000732 if (DIUnit.isOptimized())
Eric Christopher873cf0a2012-08-24 01:14:27 +0000733 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000734
Devang Patel65dbc902009-11-25 17:36:49 +0000735 StringRef Flags = DIUnit.getFlags();
736 if (!Flags.empty())
Nick Lewycky390c40d2011-10-27 06:44:11 +0000737 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000738
Nick Lewyckyd5d52132011-10-17 23:27:36 +0000739 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patel3cbee302011-04-12 22:53:02 +0000740 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000741 dwarf::DW_FORM_data1, RVer);
742
Devang Patel163a9f72010-05-10 22:49:55 +0000743 if (!FirstCU)
744 FirstCU = NewCU;
Eric Christopher208cc6f2013-02-05 07:31:55 +0000745
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000746 InfoHolder.addUnit(NewCU);
747
Devang Patel163a9f72010-05-10 22:49:55 +0000748 CUMap.insert(std::make_pair(N, NewCU));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000749 return NewCU;
Devang Patel163a9f72010-05-10 22:49:55 +0000750}
751
Eric Christopherb6dc8652012-11-27 22:43:45 +0000752// Construct subprogram DIE.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000753void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
Devang Patel3655a212011-08-15 23:36:40 +0000754 const MDNode *N) {
Rafael Espindolab0527282011-11-04 19:00:29 +0000755 CompileUnit *&CURef = SPMap[N];
756 if (CURef)
757 return;
758 CURef = TheCU;
759
Devang Patele4b27562009-08-28 23:24:31 +0000760 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000761 if (!SP.isDefinition())
762 // This is a method declaration which will be handled while constructing
763 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +0000764 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000765
Devang Pateldbc64af2011-08-15 17:24:54 +0000766 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings639336e2010-04-06 21:38:29 +0000767
768 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +0000769 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000770
771 // Add to context owner.
Devang Patel3cbee302011-04-12 22:53:02 +0000772 TheCU->addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +0000773
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +0000774 // Expose as global, if requested.
775 if (GenerateDwarfPubNamesSection)
776 TheCU->addGlobalName(SP.getName(), SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000777}
778
David Blaikie20d9e412013-05-07 21:35:53 +0000779void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikiec462db62013-04-22 06:12:31 +0000780 const MDNode *N) {
David Blaikie20d9e412013-05-07 21:35:53 +0000781 DIImportedEntity Module(N);
David Blaikiec462db62013-04-22 06:12:31 +0000782 if (!Module.Verify())
783 return;
David Blaikied2e0f7e2013-05-06 23:33:07 +0000784 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
785 constructImportedModuleDIE(TheCU, Module, D);
786}
787
788void DwarfDebug::constructImportedModuleDIE(CompileUnit *TheCU, const MDNode *N,
789 DIE *Context) {
David Blaikie20d9e412013-05-07 21:35:53 +0000790 DIImportedEntity Module(N);
David Blaikied2e0f7e2013-05-06 23:33:07 +0000791 if (!Module.Verify())
792 return;
793 return constructImportedModuleDIE(TheCU, Module, Context);
794}
795
796void DwarfDebug::constructImportedModuleDIE(CompileUnit *TheCU,
David Blaikie20d9e412013-05-07 21:35:53 +0000797 const DIImportedEntity &Module,
David Blaikied2e0f7e2013-05-06 23:33:07 +0000798 DIE *Context) {
799 assert(Module.Verify() &&
800 "Use one of the MDNode * overloads to handle invalid metadata");
801 assert(Context && "Should always have a context for an imported_module");
David Blaikie20d9e412013-05-07 21:35:53 +0000802 DIE *IMDie = new DIE(Module.getTag());
David Blaikiec462db62013-04-22 06:12:31 +0000803 TheCU->insertDIE(Module, IMDie);
David Blaikie20d9e412013-05-07 21:35:53 +0000804 DIE *EntityDie;
805 DIDescriptor Entity = Module.getEntity();
806 if (Entity.isNameSpace())
807 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
808 else if (Entity.isSubprogram())
809 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
810 else
811 return;
David Blaikiec462db62013-04-22 06:12:31 +0000812 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
813 Module.getContext().getDirectory(),
814 TheCU->getUniqueID());
815 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, 0, FileID);
816 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, 0, Module.getLineNumber());
David Blaikie20d9e412013-05-07 21:35:53 +0000817 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, dwarf::DW_FORM_ref4, EntityDie);
David Blaikied2e0f7e2013-05-06 23:33:07 +0000818 Context->addChild(IMDie);
David Blaikiec462db62013-04-22 06:12:31 +0000819}
820
Eric Christopherb6dc8652012-11-27 22:43:45 +0000821// Emit all Dwarf sections that should come prior to the content. Create
822// global DIEs and emit initial debug info sections. This is invoked by
823// the target AsmPrinter.
Eric Christopherc4639d62012-11-19 22:42:15 +0000824void DwarfDebug::beginModule() {
Devang Pateleac9c072010-04-27 19:46:33 +0000825 if (DisableDebugInfoPrinting)
826 return;
827
Eric Christopherc4639d62012-11-19 22:42:15 +0000828 const Module *M = MMI->getModule();
829
Nick Lewycky3bbb6f72011-07-29 03:49:23 +0000830 // If module has named metadata anchors then use them, otherwise scan the
831 // module using debug info finder to collect debug info.
Devang Patel30692ab2011-05-03 16:45:22 +0000832 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
David Blaikiec0ec8a42013-03-11 23:39:23 +0000833 if (!CU_Nodes)
Devang Patel02e603f2011-08-15 23:47:24 +0000834 return;
Devang Patel30692ab2011-05-03 16:45:22 +0000835
David Blaikiec0ec8a42013-03-11 23:39:23 +0000836 // Emit initial sections so we can reference labels later.
837 emitSectionLabels();
838
839 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
840 DICompileUnit CUNode(CU_Nodes->getOperand(i));
841 CompileUnit *CU = constructCompileUnit(CUNode);
David Blaikie20d9e412013-05-07 21:35:53 +0000842 DIArray ImportedEntities = CUNode.getImportedEntities();
843 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
David Blaikied2e0f7e2013-05-06 23:33:07 +0000844 ScopesWithImportedEntities.push_back(std::make_pair(
David Blaikie20d9e412013-05-07 21:35:53 +0000845 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
846 ImportedEntities.getElement(i)));
David Blaikied2e0f7e2013-05-06 23:33:07 +0000847 std::sort(ScopesWithImportedEntities.begin(),
848 ScopesWithImportedEntities.end(), CompareFirst());
David Blaikiec0ec8a42013-03-11 23:39:23 +0000849 DIArray GVs = CUNode.getGlobalVariables();
850 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
851 CU->createGlobalVariableDIE(GVs.getElement(i));
852 DIArray SPs = CUNode.getSubprograms();
853 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
854 constructSubprogramDIE(CU, SPs.getElement(i));
855 DIArray EnumTypes = CUNode.getEnumTypes();
856 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
857 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
858 DIArray RetainedTypes = CUNode.getRetainedTypes();
859 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
860 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
David Blaikiec462db62013-04-22 06:12:31 +0000861 // Emit imported_modules last so that the relevant context is already
862 // available.
David Blaikie20d9e412013-05-07 21:35:53 +0000863 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
864 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
Eric Christopherc126c322013-03-29 20:23:02 +0000865 // If we're splitting the dwarf out now that we've got the entire
866 // CU then construct a skeleton CU based upon it.
867 if (useSplitDwarf()) {
Eric Christopher13367122013-04-24 12:56:18 +0000868 // This should be a unique identifier when we want to build .dwp files.
Eric Christopher1b0cd2f2013-04-22 07:51:08 +0000869 CU->addUInt(CU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
870 dwarf::DW_FORM_data8, 0);
Eric Christopherc126c322013-03-29 20:23:02 +0000871 // Now construct the skeleton CU associated.
872 constructSkeletonCU(CUNode);
873 }
David Blaikiec0ec8a42013-03-11 23:39:23 +0000874 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000875
Chris Lattnerd850ac72010-04-05 02:19:28 +0000876 // Tell MMI that we have debug info.
877 MMI->setDebugInfoAvailability(true);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000878
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000879 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +0000880 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000881}
882
Eric Christopher4117bec2012-11-22 00:59:49 +0000883// Attach DW_AT_inline attribute with inlined subprogram DIEs.
884void DwarfDebug::computeInlinedDIEs() {
Devang Patel53bb5c92009-11-10 23:06:00 +0000885 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
886 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000887 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patel53bb5c92009-11-10 23:06:00 +0000888 DIE *ISP = *AI;
Devang Patel3cbee302011-04-12 22:53:02 +0000889 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +0000890 }
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000891 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000892 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000893 DIE *ISP = AI->second;
894 if (InlinedSubprogramDIEs.count(ISP))
895 continue;
896 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
897 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000898}
899
900// Collect info for variables that were optimized out.
901void DwarfDebug::collectDeadVariables() {
902 const Module *M = MMI->getModule();
903 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
904
905 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
906 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
907 DICompileUnit TheCU(CU_Nodes->getOperand(i));
908 DIArray Subprograms = TheCU.getSubprograms();
909 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopherbdab8002012-11-27 00:13:51 +0000910 DISubprogram SP(Subprograms.getElement(i));
911 if (ProcessedSPNodes.count(SP) != 0) continue;
912 if (!SP.Verify()) continue;
913 if (!SP.isDefinition()) continue;
914 DIArray Variables = SP.getVariables();
915 if (Variables.getNumElements() == 0) continue;
Eric Christopher4117bec2012-11-22 00:59:49 +0000916
Eric Christopherbdab8002012-11-27 00:13:51 +0000917 LexicalScope *Scope =
918 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
919 DeadFnScopeMap[SP] = Scope;
Eric Christopher4117bec2012-11-22 00:59:49 +0000920
Eric Christopherbdab8002012-11-27 00:13:51 +0000921 // Construct subprogram DIE and add variables DIEs.
922 CompileUnit *SPCU = CUMap.lookup(TheCU);
923 assert(SPCU && "Unable to find Compile Unit!");
924 constructSubprogramDIE(SPCU, SP);
925 DIE *ScopeDIE = SPCU->getDIE(SP);
926 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
927 DIVariable DV(Variables.getElement(vi));
928 if (!DV.Verify()) continue;
929 DbgVariable *NewVar = new DbgVariable(DV, NULL);
930 if (DIE *VariableDIE =
931 SPCU->constructVariableDIE(NewVar, Scope->isAbstractScope()))
932 ScopeDIE->addChild(VariableDIE);
933 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000934 }
935 }
936 }
937 DeleteContainerSeconds(DeadFnScopeMap);
938}
939
940void DwarfDebug::finalizeModuleInfo() {
941 // Collect info for variables that were optimized out.
942 collectDeadVariables();
943
944 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
945 computeInlinedDIEs();
Devang Patel53bb5c92009-11-10 23:06:00 +0000946
Eric Christopher6635cad2012-08-01 18:19:01 +0000947 // Emit DW_AT_containing_type attribute to connect types with their
948 // vtable holding type.
Devang Pateldbc64af2011-08-15 17:24:54 +0000949 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000950 CUE = CUMap.end(); CUI != CUE; ++CUI) {
Devang Pateldbc64af2011-08-15 17:24:54 +0000951 CompileUnit *TheCU = CUI->second;
952 TheCU->constructContainingTypeDIEs();
Devang Patel5d11eb02009-12-03 19:11:07 +0000953 }
954
Eric Christopher4117bec2012-11-22 00:59:49 +0000955 // Compute DIE offsets and sizes.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000956 InfoHolder.computeSizeAndOffsets();
957 if (useSplitDwarf())
958 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher4117bec2012-11-22 00:59:49 +0000959}
960
961void DwarfDebug::endSections() {
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000962 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +0000963 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +0000964 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +0000965 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +0000966 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000967
968 // End text sections.
Benjamin Kramerb4c9d9c2012-10-31 13:45:49 +0000969 for (unsigned I = 0, E = SectionMap.size(); I != E; ++I) {
970 Asm->OutStreamer.SwitchSection(SectionMap[I]);
971 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", I+1));
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000972 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000973}
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000974
Eric Christopherb6dc8652012-11-27 22:43:45 +0000975// Emit all Dwarf sections that should come after the content.
Eric Christopher4117bec2012-11-22 00:59:49 +0000976void DwarfDebug::endModule() {
977
978 if (!FirstCU) return;
979
980 // End any existing sections.
981 // TODO: Does this need to happen?
982 endSections();
983
984 // Finalize the debug info for the module.
985 finalizeModuleInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000986
Eric Christopher4daaed12012-12-10 19:51:21 +0000987 if (!useSplitDwarf()) {
Eric Christopher42885022012-11-27 22:43:42 +0000988 // Emit all the DIEs into a debug info section.
989 emitDebugInfo();
Eric Christopher74802f72012-11-27 00:41:54 +0000990
Eric Christopher42885022012-11-27 22:43:42 +0000991 // Corresponding abbreviations into a abbrev section.
992 emitAbbreviations();
993
994 // Emit info into a debug loc section.
995 emitDebugLoc();
996
997 // Emit info into a debug aranges section.
998 emitDebugARanges();
999
1000 // Emit info into a debug ranges section.
1001 emitDebugRanges();
1002
1003 // Emit info into a debug macinfo section.
1004 emitDebugMacInfo();
1005
1006 // Emit inline info.
1007 // TODO: When we don't need the option anymore we
1008 // can remove all of the code that this section
1009 // depends upon.
1010 if (useDarwinGDBCompat())
1011 emitDebugInlineInfo();
1012 } else {
Eric Christopher0b944ee2012-12-11 19:42:09 +00001013 // TODO: Fill this in for separated debug sections and separate
Eric Christopher42885022012-11-27 22:43:42 +00001014 // out information into new sections.
1015
Eric Christopher98e237f2012-11-30 23:59:06 +00001016 // Emit the debug info section and compile units.
Eric Christopher42885022012-11-27 22:43:42 +00001017 emitDebugInfo();
Eric Christopher98e237f2012-11-30 23:59:06 +00001018 emitDebugInfoDWO();
Eric Christopher42885022012-11-27 22:43:42 +00001019
1020 // Corresponding abbreviations into a abbrev section.
1021 emitAbbreviations();
Eric Christopher6eebe472012-12-19 22:02:53 +00001022 emitDebugAbbrevDWO();
Eric Christopher42885022012-11-27 22:43:42 +00001023
1024 // Emit info into a debug loc section.
1025 emitDebugLoc();
1026
1027 // Emit info into a debug aranges section.
1028 emitDebugARanges();
1029
1030 // Emit info into a debug ranges section.
1031 emitDebugRanges();
1032
1033 // Emit info into a debug macinfo section.
1034 emitDebugMacInfo();
1035
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001036 // Emit DWO addresses.
1037 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1038
Eric Christopher42885022012-11-27 22:43:42 +00001039 // Emit inline info.
1040 // TODO: When we don't need the option anymore we
1041 // can remove all of the code that this section
1042 // depends upon.
1043 if (useDarwinGDBCompat())
1044 emitDebugInlineInfo();
1045 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001046
Eric Christopher9d9f5a52012-08-23 07:32:06 +00001047 // Emit info into the dwarf accelerator table sections.
Eric Christopher20f47ab2012-08-23 22:36:40 +00001048 if (useDwarfAccelTables()) {
Eric Christopher09ac3d82011-11-07 09:24:32 +00001049 emitAccelNames();
1050 emitAccelObjC();
1051 emitAccelNamespaces();
1052 emitAccelTypes();
1053 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001054
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00001055 // Emit info into a debug pubnames section, if requested.
1056 if (GenerateDwarfPubNamesSection)
1057 emitDebugPubnames();
1058
Devang Patel193f7202009-11-24 01:14:22 +00001059 // Emit info into a debug pubtypes section.
Eric Christopher360f0062012-08-23 07:10:56 +00001060 // TODO: When we don't need the option anymore we can
1061 // remove all of the code that adds to the table.
Eric Christopher20f47ab2012-08-23 22:36:40 +00001062 if (useDarwinGDBCompat())
Eric Christopher360f0062012-08-23 07:10:56 +00001063 emitDebugPubTypes();
Devang Patel193f7202009-11-24 01:14:22 +00001064
Eric Christopher42885022012-11-27 22:43:42 +00001065 // Finally emit string information into a string table.
Eric Christopherfcdbecb2012-11-27 06:49:23 +00001066 emitDebugStr();
Eric Christopher64f824c2012-12-27 02:14:01 +00001067 if (useSplitDwarf())
1068 emitDebugStrDWO();
Eric Christopherfcdbecb2012-11-27 06:49:23 +00001069
Devang Patele9a1cca2010-08-02 17:32:15 +00001070 // clean up.
Devang Patel94c7ddb2011-08-16 22:09:43 +00001071 SPMap.clear();
Devang Patel163a9f72010-05-10 22:49:55 +00001072 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1073 E = CUMap.end(); I != E; ++I)
1074 delete I->second;
Eric Christopher9ec87b32012-12-10 19:51:18 +00001075
Eric Christopher01776a52013-02-06 21:53:56 +00001076 for (SmallVector<CompileUnit *, 1>::iterator I = SkeletonCUs.begin(),
1077 E = SkeletonCUs.end(); I != E; ++I)
1078 delete *I;
Eric Christopher9ec87b32012-12-10 19:51:18 +00001079
Eric Christopher98e237f2012-11-30 23:59:06 +00001080 // Reset these for the next Module if we have one.
1081 FirstCU = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001082}
1083
Eric Christopherb6dc8652012-11-27 22:43:45 +00001084// Find abstract variable, if any, associated with Var.
Devang Patelb549bcf2011-08-10 21:50:54 +00001085DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattnerde4845c2010-04-02 19:42:39 +00001086 DebugLoc ScopeLoc) {
Devang Patelb549bcf2011-08-10 21:50:54 +00001087 LLVMContext &Ctx = DV->getContext();
1088 // More then one inlined variable corresponds to one abstract variable.
1089 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patel2db49d72010-05-07 18:11:54 +00001090 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00001091 if (AbsDbgVariable)
1092 return AbsDbgVariable;
1093
Devang Patelbf47fdb2011-08-10 20:55:27 +00001094 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00001095 if (!Scope)
1096 return NULL;
1097
Devang Patel5a1a67c2011-08-15 19:01:20 +00001098 AbsDbgVariable = new DbgVariable(Var, NULL);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001099 addScopeVariable(Scope, AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00001100 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00001101 return AbsDbgVariable;
1102}
1103
Eric Christopherb6dc8652012-11-27 22:43:45 +00001104// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel0478c152011-03-01 22:58:55 +00001105bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patelbf47fdb2011-08-10 20:55:27 +00001106 DbgVariable *Var, LexicalScope *Scope) {
1107 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +00001108 return false;
1109 DIVariable DV = Var->getVariable();
1110 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1111 return false;
1112 unsigned ArgNo = DV.getArgNumber();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001113 if (ArgNo == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001114 return false;
1115
Devang Patelcb3a6572011-03-03 20:02:02 +00001116 size_t Size = CurrentFnArguments.size();
1117 if (Size == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001118 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patelbbd0f452011-03-03 21:49:41 +00001119 // llvm::Function argument size is not good indicator of how many
Devang Patel6f676be2011-03-03 20:08:10 +00001120 // arguments does the function have at source level.
1121 if (ArgNo > Size)
Devang Patelcb3a6572011-03-03 20:02:02 +00001122 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel0478c152011-03-01 22:58:55 +00001123 CurrentFnArguments[ArgNo - 1] = Var;
1124 return true;
1125}
1126
Eric Christopherb6dc8652012-11-27 22:43:45 +00001127// Collect variable information from side table maintained by MMI.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001128void
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001129DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patelee432862010-05-20 19:57:06 +00001130 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patele717faa2009-10-06 01:26:37 +00001131 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1132 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1133 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00001134 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00001135 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00001136 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00001137 DIVariable DV(Var);
1138 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00001139
Devang Patelbf47fdb2011-08-10 20:55:27 +00001140 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001141
Devang Patelfb0ee432009-11-10 23:20:04 +00001142 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00001143 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00001144 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00001145
Devang Patel26c1e562010-05-20 16:36:41 +00001146 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001147 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable);
Devang Patelff9dd0a2011-08-15 21:24:36 +00001148 RegVar->setFrameIndex(VP.first);
Devang Patel0478c152011-03-01 22:58:55 +00001149 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001150 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001151 if (AbsDbgVariable)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001152 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patele717faa2009-10-06 01:26:37 +00001153 }
Devang Patelee432862010-05-20 19:57:06 +00001154}
Devang Patel90a48ad2010-03-15 18:33:46 +00001155
Eric Christopherb6dc8652012-11-27 22:43:45 +00001156// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1157// defined reg.
Devang Patelc3f5f782010-05-25 23:40:22 +00001158static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001159 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001160 return MI->getNumOperands() == 3 &&
1161 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
Adrian Prantl86a87d92013-04-30 22:35:14 +00001162 MI->getOperand(1).isImm() && MI->getOperand(1).getImm() == 0;
Devang Patelc3f5f782010-05-25 23:40:22 +00001163}
1164
Eric Christopherb6dc8652012-11-27 22:43:45 +00001165// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001166static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1167 const MCSymbol *FLabel,
Devang Patel90b40412011-07-08 17:09:57 +00001168 const MCSymbol *SLabel,
1169 const MachineInstr *MI) {
1170 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1171
1172 if (MI->getNumOperands() != 3) {
1173 MachineLocation MLoc = Asm->getDebugValueLocation(MI);
1174 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1175 }
Adrian Prantl86a87d92013-04-30 22:35:14 +00001176 if (MI->getOperand(0).isReg() && MI->getOperand(1).isImm()) {
Devang Patel90b40412011-07-08 17:09:57 +00001177 MachineLocation MLoc;
Adrian Prantl86a87d92013-04-30 22:35:14 +00001178 // TODO: Currently an offset of 0 in a DBG_VALUE means
1179 // we need to generate a direct register value.
1180 // There is no way to specify an indirect value with offset 0.
1181 if (MI->getOperand(1).getImm() == 0)
Adrian Prantl13131e62013-04-26 21:57:17 +00001182 MLoc.set(MI->getOperand(0).getReg());
1183 else
1184 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel90b40412011-07-08 17:09:57 +00001185 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1186 }
1187 if (MI->getOperand(0).isImm())
1188 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1189 if (MI->getOperand(0).isFPImm())
1190 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1191 if (MI->getOperand(0).isCImm())
1192 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1193
Craig Topper5e25ee82012-02-05 08:31:47 +00001194 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel90b40412011-07-08 17:09:57 +00001195}
1196
Eric Christopherb6dc8652012-11-27 22:43:45 +00001197// Find variables for each lexical scope.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001198void
Devang Patel78e127d2010-06-25 22:07:34 +00001199DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1200 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00001201
Eric Christopherb6dc8652012-11-27 22:43:45 +00001202 // collection info from MMI table.
Devang Patelee432862010-05-20 19:57:06 +00001203 collectVariableInfoFromMMITable(MF, Processed);
1204
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001205 for (SmallVectorImpl<const MDNode*>::const_iterator
1206 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1207 ++UVI) {
1208 const MDNode *Var = *UVI;
1209 if (Processed.count(Var))
Devang Patelee432862010-05-20 19:57:06 +00001210 continue;
1211
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001212 // History contains relevant DBG_VALUE instructions for Var and instructions
1213 // clobbering it.
1214 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1215 if (History.empty())
1216 continue;
1217 const MachineInstr *MInsn = History.front();
Devang Patelc3f5f782010-05-25 23:40:22 +00001218
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001219 DIVariable DV(Var);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001220 LexicalScope *Scope = NULL;
Devang Pateld8720f42010-05-27 20:25:04 +00001221 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1222 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001223 Scope = LScopes.getCurrentFunctionScope();
David Blaikiec0ec8a42013-03-11 23:39:23 +00001224 else if (MDNode *IA = DV.getInlinedAt())
1225 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1226 else
1227 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patelee432862010-05-20 19:57:06 +00001228 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00001229 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00001230 continue;
1231
1232 Processed.insert(DV);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001233 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel5a1a67c2011-08-15 19:01:20 +00001234 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
1235 DbgVariable *RegVar = new DbgVariable(DV, AbsVar);
Devang Patel0478c152011-03-01 22:58:55 +00001236 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001237 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001238 if (AbsVar)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001239 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001240
Eric Christopherc56e3f02012-10-08 20:48:54 +00001241 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001242 if (History.size() <= 1 || (History.size() == 2 &&
1243 MInsn->isIdenticalTo(History.back()))) {
Devang Patelff9dd0a2011-08-15 21:24:36 +00001244 RegVar->setMInsn(MInsn);
Devang Patelc3f5f782010-05-25 23:40:22 +00001245 continue;
1246 }
1247
Eric Christopher498703b2013-01-28 17:33:26 +00001248 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001249 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001250
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001251 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1252 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1253 const MachineInstr *Begin = *HI;
1254 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesene17232e2011-03-22 00:21:41 +00001255
Devang Patel4ada1d72011-06-01 23:00:17 +00001256 // Check if DBG_VALUE is truncating a range.
1257 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1258 && !Begin->getOperand(0).getReg())
1259 continue;
1260
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001261 // Compute the range for a register location.
1262 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1263 const MCSymbol *SLabel = 0;
1264
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001265 if (HI + 1 == HE)
1266 // If Begin is the last instruction in History then its value is valid
Chris Lattner7a2bdde2011-04-15 05:18:47 +00001267 // until the end of the function.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001268 SLabel = FunctionEndSym;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001269 else {
1270 const MachineInstr *End = HI[1];
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001271 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel476df5f2011-07-07 21:44:42 +00001272 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001273 if (End->isDebugValue())
1274 SLabel = getLabelBeforeInsn(End);
1275 else {
1276 // End is a normal instruction clobbering the range.
1277 SLabel = getLabelAfterInsn(End);
1278 assert(SLabel && "Forgot label after clobber instruction");
1279 ++HI;
1280 }
1281 }
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001282
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001283 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopherabbb2002011-12-16 23:42:31 +00001284 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1285 Begin));
Devang Patelc3f5f782010-05-25 23:40:22 +00001286 }
1287 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00001288 }
Devang Patel98e1cac2010-05-14 21:01:35 +00001289
1290 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001291 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1292 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1293 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1294 DIVariable DV(Variables.getElement(i));
1295 if (!DV || !DV.Verify() || !Processed.insert(DV))
1296 continue;
1297 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1298 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel98e1cac2010-05-14 21:01:35 +00001299 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001300}
Devang Patel98e1cac2010-05-14 21:01:35 +00001301
Eric Christopherb6dc8652012-11-27 22:43:45 +00001302// Return Label preceding the instruction.
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001303MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001304 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1305 assert(Label && "Didn't insert label before instruction");
1306 return Label;
Devang Patelc3f5f782010-05-25 23:40:22 +00001307}
1308
Eric Christopherb6dc8652012-11-27 22:43:45 +00001309// Return Label immediately following the instruction.
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001310MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001311 return LabelsAfterInsn.lookup(MI);
Devang Patele717faa2009-10-06 01:26:37 +00001312}
1313
Eric Christopherb6dc8652012-11-27 22:43:45 +00001314// Process beginning of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001315void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001316 // Check if source location changes, but ignore DBG_VALUE locations.
1317 if (!MI->isDebugValue()) {
1318 DebugLoc DL = MI->getDebugLoc();
1319 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopher60b35f42012-04-05 20:39:05 +00001320 unsigned Flags = 0;
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001321 PrevInstLoc = DL;
Devang Patel4243e672011-05-11 19:22:19 +00001322 if (DL == PrologEndLoc) {
1323 Flags |= DWARF2_FLAG_PROLOGUE_END;
1324 PrologEndLoc = DebugLoc();
1325 }
Eric Christopher60b35f42012-04-05 20:39:05 +00001326 if (PrologEndLoc.isUnknown())
1327 Flags |= DWARF2_FLAG_IS_STMT;
1328
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001329 if (!DL.isUnknown()) {
1330 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel4243e672011-05-11 19:22:19 +00001331 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001332 } else
Devang Patel4243e672011-05-11 19:22:19 +00001333 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001334 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001335 }
Devang Patelaead63c2010-03-29 22:59:58 +00001336
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001337 // Insert labels where requested.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001338 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1339 LabelsBeforeInsn.find(MI);
1340
1341 // No label needed.
1342 if (I == LabelsBeforeInsn.end())
1343 return;
1344
1345 // Label already assigned.
1346 if (I->second)
Devang Patelb2b31a62010-05-26 19:37:24 +00001347 return;
Devang Patel553881b2010-03-29 17:20:31 +00001348
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001349 if (!PrevLabel) {
Devang Patel77051f52010-05-26 21:23:46 +00001350 PrevLabel = MMI->getContext().CreateTempSymbol();
1351 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00001352 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001353 I->second = PrevLabel;
Devang Patel0d20ac82009-10-06 01:50:42 +00001354}
1355
Eric Christopherb6dc8652012-11-27 22:43:45 +00001356// Process end of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001357void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001358 // Don't create a new label after DBG_VALUE instructions.
1359 // They don't generate code.
1360 if (!MI->isDebugValue())
1361 PrevLabel = 0;
1362
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001363 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1364 LabelsAfterInsn.find(MI);
1365
1366 // No label needed.
1367 if (I == LabelsAfterInsn.end())
1368 return;
1369
1370 // Label already assigned.
1371 if (I->second)
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001372 return;
1373
1374 // We need a label after this instruction.
1375 if (!PrevLabel) {
1376 PrevLabel = MMI->getContext().CreateTempSymbol();
1377 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel1c246352010-04-08 16:50:29 +00001378 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001379 I->second = PrevLabel;
Devang Patel53bb5c92009-11-10 23:06:00 +00001380}
1381
Eric Christopherb6dc8652012-11-27 22:43:45 +00001382// Each LexicalScope has first instruction and last instruction to mark
1383// beginning and end of a scope respectively. Create an inverse map that list
1384// scopes starts (and ends) with an instruction. One instruction may start (or
1385// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00001386void DwarfDebug::identifyScopeMarkers() {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001387 SmallVector<LexicalScope *, 4> WorkList;
1388 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel42aafd72010-01-20 02:05:23 +00001389 while (!WorkList.empty()) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001390 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001391
Devang Patelbf47fdb2011-08-10 20:55:27 +00001392 const SmallVector<LexicalScope *, 4> &Children = S->getChildren();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001393 if (!Children.empty())
Devang Patelbf47fdb2011-08-10 20:55:27 +00001394 for (SmallVector<LexicalScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00001395 SE = Children.end(); SI != SE; ++SI)
1396 WorkList.push_back(*SI);
1397
Devang Patel53bb5c92009-11-10 23:06:00 +00001398 if (S->isAbstractScope())
1399 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001400
Devang Patelbf47fdb2011-08-10 20:55:27 +00001401 const SmallVector<InsnRange, 4> &Ranges = S->getRanges();
Devang Pateleac9c072010-04-27 19:46:33 +00001402 if (Ranges.empty())
1403 continue;
Devang Patelbf47fdb2011-08-10 20:55:27 +00001404 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +00001405 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001406 assert(RI->first && "InsnRange does not have first instruction!");
1407 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001408 requestLabelBeforeInsn(RI->first);
1409 requestLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001410 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001411 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001412}
1413
Eric Christopherb6dc8652012-11-27 22:43:45 +00001414// Get MDNode for DebugLoc's scope.
Devang Patela3f48672011-05-09 22:14:49 +00001415static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1416 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1417 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1418 return DL.getScope(Ctx);
1419}
1420
Eric Christopherb6dc8652012-11-27 22:43:45 +00001421// Walk up the scope chain of given debug loc and find line number info
1422// for the function.
Devang Patel4243e672011-05-11 19:22:19 +00001423static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1424 const MDNode *Scope = getScopeNode(DL, Ctx);
1425 DISubprogram SP = getDISubprogram(Scope);
Eric Christopher6126a1e2012-04-03 00:43:49 +00001426 if (SP.Verify()) {
1427 // Check for number of operands since the compatibility is
1428 // cheap here.
Eric Christopherfa5b0502012-04-03 17:55:42 +00001429 if (SP->getNumOperands() > 19)
Eric Christopher6126a1e2012-04-03 00:43:49 +00001430 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1431 else
1432 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1433 }
1434
Devang Patel4243e672011-05-11 19:22:19 +00001435 return DebugLoc();
1436}
1437
Eric Christopherb6dc8652012-11-27 22:43:45 +00001438// Gather pre-function debug information. Assumes being called immediately
1439// after the function entry point has been emitted.
Chris Lattnereec791a2010-01-26 23:18:02 +00001440void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00001441 if (!MMI->hasDebugInfo()) return;
Devang Patelbf47fdb2011-08-10 20:55:27 +00001442 LScopes.initialize(*MF);
1443 if (LScopes.empty()) return;
1444 identifyScopeMarkers();
Devang Patel60b35bd2009-10-06 18:37:31 +00001445
Manman Ren43213cf2013-02-05 21:52:47 +00001446 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1447 // belongs to.
1448 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1449 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1450 assert(TheCU && "Unable to find compile unit!");
1451 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
1452
Devang Pateleac9c072010-04-27 19:46:33 +00001453 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1454 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001455 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00001456 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001457
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001458 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1459
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001460 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopherb6dc8652012-11-27 22:43:45 +00001461 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001462 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1463
Devang Patelb2b31a62010-05-26 19:37:24 +00001464 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001465 I != E; ++I) {
1466 bool AtBlockEntry = true;
Devang Patelb2b31a62010-05-26 19:37:24 +00001467 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1468 II != IE; ++II) {
1469 const MachineInstr *MI = II;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001470
Devang Patelb2b31a62010-05-26 19:37:24 +00001471 if (MI->isDebugValue()) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001472 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001473
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001474 // Keep track of user variables.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001475 const MDNode *Var =
1476 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001477
1478 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001479 if (isDbgValueInDefinedReg(MI))
1480 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1481
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001482 // Check the history of this variable.
1483 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1484 if (History.empty()) {
1485 UserVariables.push_back(Var);
1486 // The first mention of a function argument gets the FunctionBeginSym
1487 // label, so arguments are visible when breaking at function entry.
1488 DIVariable DV(Var);
1489 if (DV.Verify() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1490 DISubprogram(getDISubprogram(DV.getContext()))
1491 .describes(MF->getFunction()))
1492 LabelsBeforeInsn[MI] = FunctionBeginSym;
1493 } else {
1494 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1495 const MachineInstr *Prev = History.back();
1496 if (Prev->isDebugValue()) {
1497 // Coalesce identical entries at the end of History.
1498 if (History.size() >= 2 &&
Devang Patel79862892011-07-07 00:14:27 +00001499 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher02c1a642012-10-08 20:48:49 +00001500 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001501 << "\t" << *Prev
Devang Patel79862892011-07-07 00:14:27 +00001502 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001503 History.pop_back();
Devang Patel79862892011-07-07 00:14:27 +00001504 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001505
1506 // Terminate old register assignments that don't reach MI;
1507 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1508 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1509 isDbgValueInDefinedReg(Prev)) {
1510 // Previous register assignment needs to terminate at the end of
1511 // its basic block.
1512 MachineBasicBlock::const_iterator LastMI =
1513 PrevMBB->getLastNonDebugInstr();
Devang Patel79862892011-07-07 00:14:27 +00001514 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001515 // Drop DBG_VALUE for empty range.
Eric Christopher02c1a642012-10-08 20:48:49 +00001516 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patel79862892011-07-07 00:14:27 +00001517 << "\t" << *Prev << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001518 History.pop_back();
Devang Patel79862892011-07-07 00:14:27 +00001519 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001520 else {
1521 // Terminate after LastMI.
1522 History.push_back(LastMI);
1523 }
1524 }
1525 }
1526 }
1527 History.push_back(MI);
Devang Patelb2b31a62010-05-26 19:37:24 +00001528 } else {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001529 // Not a DBG_VALUE instruction.
1530 if (!MI->isLabel())
1531 AtBlockEntry = false;
1532
Eric Christopher0313ced2012-10-04 20:46:14 +00001533 // First known non-DBG_VALUE and non-frame setup location marks
1534 // the beginning of the function body.
1535 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1536 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel4243e672011-05-11 19:22:19 +00001537 PrologEndLoc = MI->getDebugLoc();
1538
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001539 // Check if the instruction clobbers any registers with debug vars.
1540 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1541 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1542 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1543 continue;
Jakob Stoklund Olesen396618b2012-06-01 23:28:30 +00001544 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1545 AI.isValid(); ++AI) {
1546 unsigned Reg = *AI;
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001547 const MDNode *Var = LiveUserVar[Reg];
1548 if (!Var)
1549 continue;
1550 // Reg is now clobbered.
1551 LiveUserVar[Reg] = 0;
1552
1553 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001554 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1555 if (HistI == DbgValues.end())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001556 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001557 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1558 if (History.empty())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001559 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001560 const MachineInstr *Prev = History.back();
1561 // Sanity-check: Register assignments are terminated at the end of
1562 // their block.
1563 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1564 continue;
1565 // Is the variable still in Reg?
1566 if (!isDbgValueInDefinedReg(Prev) ||
1567 Prev->getOperand(0).getReg() != Reg)
1568 continue;
1569 // Var is clobbered. Make sure the next instruction gets a label.
1570 History.push_back(MI);
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001571 }
1572 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001573 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001574 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001575 }
1576
1577 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1578 I != E; ++I) {
1579 SmallVectorImpl<const MachineInstr*> &History = I->second;
1580 if (History.empty())
1581 continue;
1582
1583 // Make sure the final register assignments are terminated.
1584 const MachineInstr *Prev = History.back();
1585 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1586 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001587 MachineBasicBlock::const_iterator LastMI =
Devang Patel5bc942c2011-08-10 23:58:09 +00001588 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001589 if (LastMI == PrevMBB->end())
1590 // Drop DBG_VALUE for empty range.
1591 History.pop_back();
1592 else {
1593 // Terminate after LastMI.
1594 History.push_back(LastMI);
1595 }
1596 }
1597 // Request labels for the full history.
1598 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1599 const MachineInstr *MI = History[i];
1600 if (MI->isDebugValue())
1601 requestLabelBeforeInsn(MI);
1602 else
1603 requestLabelAfterInsn(MI);
1604 }
1605 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001606
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001607 PrevInstLoc = DebugLoc();
Devang Patelb2b31a62010-05-26 19:37:24 +00001608 PrevLabel = FunctionBeginSym;
Devang Patel4243e672011-05-11 19:22:19 +00001609
1610 // Record beginning of function.
1611 if (!PrologEndLoc.isUnknown()) {
1612 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1613 MF->getFunction()->getContext());
1614 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1615 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie836cfc42012-12-04 22:02:33 +00001616 // We'd like to list the prologue as "not statements" but GDB behaves
1617 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikieb36c5312012-12-04 21:05:36 +00001618 DWARF2_FLAG_IS_STMT);
Devang Patel4243e672011-05-11 19:22:19 +00001619 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001620}
1621
Devang Patelbf47fdb2011-08-10 20:55:27 +00001622void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1623// SmallVector<DbgVariable *, 8> &Vars = ScopeVariables.lookup(LS);
1624 ScopeVariables[LS].push_back(Var);
1625// Vars.push_back(Var);
1626}
1627
Eric Christopherb6dc8652012-11-27 22:43:45 +00001628// Gather and emit post-function debug information.
Chris Lattnereec791a2010-01-26 23:18:02 +00001629void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001630 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00001631
Devang Patelbf47fdb2011-08-10 20:55:27 +00001632 // Define end label for subprogram.
1633 FunctionEndSym = Asm->GetTempSymbol("func_end",
1634 Asm->getFunctionNumber());
1635 // Assumes in correct section after the entry point.
1636 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Manman Ren43213cf2013-02-05 21:52:47 +00001637 // Set DwarfCompileUnitID in MCContext to default value.
1638 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001639
Devang Patelbf47fdb2011-08-10 20:55:27 +00001640 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1641 collectVariableInfo(MF, ProcessedVars);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001642
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001643 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Patel94c7ddb2011-08-16 22:09:43 +00001644 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky746cb672011-10-26 22:55:33 +00001645 assert(TheCU && "Unable to find compile unit!");
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001646
Devang Patelbf47fdb2011-08-10 20:55:27 +00001647 // Construct abstract scopes.
Devang Patelcd9f6c52011-08-12 18:10:19 +00001648 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1649 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1650 LexicalScope *AScope = AList[i];
1651 DISubprogram SP(AScope->getScopeNode());
Devang Patelbf47fdb2011-08-10 20:55:27 +00001652 if (SP.Verify()) {
1653 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001654 DIArray Variables = SP.getVariables();
1655 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1656 DIVariable DV(Variables.getElement(i));
1657 if (!DV || !DV.Verify() || !ProcessedVars.insert(DV))
1658 continue;
Alexey Samsonovb67bd332012-07-06 08:45:08 +00001659 // Check that DbgVariable for DV wasn't created earlier, when
1660 // findAbstractVariable() was called for inlined instance of DV.
1661 LLVMContext &Ctx = DV->getContext();
1662 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1663 if (AbstractVariables.lookup(CleanDV))
1664 continue;
Devang Patel93d39be2011-08-19 23:28:12 +00001665 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1666 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel78e127d2010-06-25 22:07:34 +00001667 }
1668 }
Devang Patelcd9f6c52011-08-12 18:10:19 +00001669 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001670 constructScopeDIE(TheCU, AScope);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001671 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001672
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001673 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001674
Nick Lewycky8a8d4792011-12-02 22:16:29 +00001675 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopher873cf0a2012-08-24 01:14:27 +00001676 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001677
Devang Patelbf47fdb2011-08-10 20:55:27 +00001678 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
1679 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001680
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001681 // Clear debug info
Devang Patelbf47fdb2011-08-10 20:55:27 +00001682 for (DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >::iterator
1683 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1684 DeleteContainerPointers(I->second);
1685 ScopeVariables.clear();
Devang Pateleac0c9d2011-04-22 18:09:57 +00001686 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001687 UserVariables.clear();
1688 DbgValues.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001689 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00001690 LabelsBeforeInsn.clear();
1691 LabelsAfterInsn.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00001692 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001693}
1694
Eric Christopherb6dc8652012-11-27 22:43:45 +00001695// Register a source line with debug info. Returns the unique label that was
1696// emitted and which provides correspondence to the source line list.
Devang Patel4243e672011-05-11 19:22:19 +00001697void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1698 unsigned Flags) {
Devang Patel65dbc902009-11-25 17:36:49 +00001699 StringRef Fn;
Devang Patel23670e52011-03-24 20:30:50 +00001700 StringRef Dir;
Dan Gohman1cc0d622010-05-05 23:41:32 +00001701 unsigned Src = 1;
1702 if (S) {
1703 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00001704
Dan Gohman1cc0d622010-05-05 23:41:32 +00001705 if (Scope.isCompileUnit()) {
1706 DICompileUnit CU(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001707 Fn = CU.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001708 Dir = CU.getDirectory();
Devang Patel3cabc9d2010-10-28 17:30:52 +00001709 } else if (Scope.isFile()) {
1710 DIFile F(S);
Devang Patel3cabc9d2010-10-28 17:30:52 +00001711 Fn = F.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001712 Dir = F.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001713 } else if (Scope.isSubprogram()) {
1714 DISubprogram SP(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001715 Fn = SP.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001716 Dir = SP.getDirectory();
Eric Christopher6618a242011-10-11 22:59:11 +00001717 } else if (Scope.isLexicalBlockFile()) {
1718 DILexicalBlockFile DBF(S);
1719 Fn = DBF.getFilename();
1720 Dir = DBF.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001721 } else if (Scope.isLexicalBlock()) {
1722 DILexicalBlock DB(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001723 Fn = DB.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001724 Dir = DB.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001725 } else
Craig Topper5e25ee82012-02-05 08:31:47 +00001726 llvm_unreachable("Unexpected scope info");
Dan Gohman1cc0d622010-05-05 23:41:32 +00001727
Manman Ren3de61b42013-03-07 01:42:00 +00001728 Src = getOrCreateSourceID(Fn, Dir,
1729 Asm->OutStreamer.getContext().getDwarfCompileUnitID());
Dan Gohman1cc0d622010-05-05 23:41:32 +00001730 }
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001731 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001732}
1733
Bill Wendling829e67b2009-05-20 23:22:40 +00001734//===----------------------------------------------------------------------===//
1735// Emit Methods
1736//===----------------------------------------------------------------------===//
1737
Eric Christopherb6dc8652012-11-27 22:43:45 +00001738// Compute the size and offset of a DIE.
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001739unsigned
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001740DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001741 // Get the children.
1742 const std::vector<DIE *> &Children = Die->getChildren();
1743
Bill Wendling94d04b82009-05-20 23:21:38 +00001744 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001745 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00001746
1747 // Get the abbreviation for this DIE.
1748 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001749 const DIEAbbrev *Abbrev = Abbreviations->at(AbbrevNumber - 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00001750
1751 // Set DIE offset
1752 Die->setOffset(Offset);
1753
1754 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00001755 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001756
Eric Christopherf7cef702013-03-29 23:34:06 +00001757 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1758 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling94d04b82009-05-20 23:21:38 +00001759
1760 // Size the DIE attribute values.
1761 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1762 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00001763 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00001764
1765 // Size the DIE children if any.
1766 if (!Children.empty()) {
1767 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1768 "Children flag not set");
1769
1770 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopherfbd19752012-11-20 22:14:13 +00001771 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling94d04b82009-05-20 23:21:38 +00001772
1773 // End of children marker.
1774 Offset += sizeof(int8_t);
1775 }
1776
1777 Die->setSize(Offset - Die->getOffset());
1778 return Offset;
1779}
1780
Eric Christopherb6dc8652012-11-27 22:43:45 +00001781// Compute the size and offset of all the DIEs.
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001782void DwarfUnits::computeSizeAndOffsets() {
Manman Renbc3e96f2013-03-12 18:27:15 +00001783 // Offset from the beginning of debug info section.
1784 unsigned AccuOffset = 0;
Eric Christopherf7cef702013-03-29 23:34:06 +00001785 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001786 E = CUs.end(); I != E; ++I) {
Manman Renbc3e96f2013-03-12 18:27:15 +00001787 (*I)->setDebugInfoOffset(AccuOffset);
Eric Christopher98e237f2012-11-30 23:59:06 +00001788 unsigned Offset =
1789 sizeof(int32_t) + // Length of Compilation Unit Info
1790 sizeof(int16_t) + // DWARF version number
1791 sizeof(int32_t) + // Offset Into Abbrev. Section
1792 sizeof(int8_t); // Pointer Size (in bytes)
1793
Manman Renbc3e96f2013-03-12 18:27:15 +00001794 unsigned EndOffset = computeSizeAndOffset((*I)->getCUDie(), Offset);
1795 AccuOffset += EndOffset;
Devang Patel163a9f72010-05-10 22:49:55 +00001796 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001797}
1798
Eric Christopherb6dc8652012-11-27 22:43:45 +00001799// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001800void DwarfDebug::emitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001801 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001802
Bill Wendling94d04b82009-05-20 23:21:38 +00001803 // Dwarf sections base addresses.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001804 DwarfInfoSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001805 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00001806 DwarfAbbrevSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001807 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher6eebe472012-12-19 22:02:53 +00001808 if (useSplitDwarf())
1809 DwarfAbbrevDWOSectionSym =
1810 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1811 "section_abbrev_dwo");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001812 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001813
Chris Lattner9c69e285532010-04-04 22:59:04 +00001814 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001815 emitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00001816
Eric Christopher7a0103c2013-02-07 21:19:50 +00001817 DwarfLineSectionSym =
1818 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001819 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00001820 if (GenerateDwarfPubNamesSection)
1821 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001822 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001823 DwarfStrSectionSym =
Eric Christopher64f824c2012-12-27 02:14:01 +00001824 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher9a9e73b2013-04-07 03:43:09 +00001825 if (useSplitDwarf()) {
Eric Christopher64f824c2012-12-27 02:14:01 +00001826 DwarfStrDWOSectionSym =
1827 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher9a9e73b2013-04-07 03:43:09 +00001828 DwarfAddrSectionSym =
1829 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
1830 }
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001831 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patelf2548ca2010-04-16 23:33:45 +00001832 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00001833
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001834 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patelc3f5f782010-05-25 23:40:22 +00001835 "section_debug_loc");
1836
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001837 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
1838 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00001839}
1840
Eric Christopherb6dc8652012-11-27 22:43:45 +00001841// Recursively emits a debug information entry.
Eric Christopher6eebe472012-12-19 22:02:53 +00001842void DwarfDebug::emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001843 // Get the abbreviation for this DIE.
1844 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher6eebe472012-12-19 22:02:53 +00001845 const DIEAbbrev *Abbrev = Abbrevs->at(AbbrevNumber - 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00001846
Bill Wendling94d04b82009-05-20 23:21:38 +00001847 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00001848 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00001849 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
1850 Twine::utohexstr(Die->getOffset()) + ":0x" +
1851 Twine::utohexstr(Die->getSize()) + " " +
1852 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00001853 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001854
Eric Christopherf7cef702013-03-29 23:34:06 +00001855 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1856 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling94d04b82009-05-20 23:21:38 +00001857
1858 // Emit the DIE attribute values.
1859 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1860 unsigned Attr = AbbrevData[i].getAttribute();
1861 unsigned Form = AbbrevData[i].getForm();
1862 assert(Form && "Too many attributes for DIE (check abbreviation)");
1863
Chris Lattner3f53c832010-04-04 18:52:31 +00001864 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00001865 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001866
Bill Wendling94d04b82009-05-20 23:21:38 +00001867 switch (Attr) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001868 case dwarf::DW_AT_abstract_origin: {
1869 DIEEntry *E = cast<DIEEntry>(Values[i]);
1870 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00001871 unsigned Addr = Origin->getOffset();
Manman Renbc3e96f2013-03-12 18:27:15 +00001872 if (Form == dwarf::DW_FORM_ref_addr) {
1873 // For DW_FORM_ref_addr, output the offset from beginning of debug info
1874 // section. Origin->getOffset() returns the offset from start of the
1875 // compile unit.
1876 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
1877 Addr += Holder.getCUOffset(Origin->getCompileUnit());
1878 }
Manman Ren624a93e2013-04-04 23:13:11 +00001879 Asm->EmitInt32(Addr);
Bill Wendling94d04b82009-05-20 23:21:38 +00001880 break;
1881 }
Devang Patelf2548ca2010-04-16 23:33:45 +00001882 case dwarf::DW_AT_ranges: {
1883 // DW_AT_range Value encodes offset in debug_range section.
1884 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelb1fcfbe2010-09-02 16:43:44 +00001885
Nick Lewyckyffccd922012-06-22 01:25:12 +00001886 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelb1fcfbe2010-09-02 16:43:44 +00001887 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
1888 V->getValue(),
1889 4);
1890 } else {
1891 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
1892 V->getValue(),
1893 DwarfDebugRangeSectionSym,
1894 4);
1895 }
Devang Patelf2548ca2010-04-16 23:33:45 +00001896 break;
1897 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001898 case dwarf::DW_AT_location: {
Nick Lewyckyffccd922012-06-22 01:25:12 +00001899 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
1900 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
1901 Asm->EmitLabelReference(L->getValue(), 4);
1902 else
1903 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
1904 } else {
Devang Patelc3f5f782010-05-25 23:40:22 +00001905 Values[i]->EmitValue(Asm, Form);
Nick Lewyckyffccd922012-06-22 01:25:12 +00001906 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001907 break;
1908 }
Devang Patel2a361602010-09-29 19:08:08 +00001909 case dwarf::DW_AT_accessibility: {
1910 if (Asm->isVerbose()) {
1911 DIEInteger *V = cast<DIEInteger>(Values[i]);
1912 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
1913 }
1914 Values[i]->EmitValue(Asm, Form);
1915 break;
1916 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001917 default:
1918 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001919 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00001920 break;
1921 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001922 }
1923
1924 // Emit the DIE children if any.
1925 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
1926 const std::vector<DIE *> &Children = Die->getChildren();
1927
1928 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher6eebe472012-12-19 22:02:53 +00001929 emitDIE(Children[j], Abbrevs);
Bill Wendling94d04b82009-05-20 23:21:38 +00001930
Chris Lattner3f53c832010-04-04 18:52:31 +00001931 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00001932 Asm->OutStreamer.AddComment("End Of Children Mark");
1933 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00001934 }
1935}
1936
Eric Christopherb1e66d02012-12-15 00:04:07 +00001937// Emit the various dwarf units to the unit section USection with
1938// the abbreviations going into ASection.
1939void DwarfUnits::emitUnits(DwarfDebug *DD,
1940 const MCSection *USection,
1941 const MCSection *ASection,
1942 const MCSymbol *ASectionSym) {
1943 Asm->OutStreamer.SwitchSection(USection);
Eric Christopherf7cef702013-03-29 23:34:06 +00001944 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopherb1e66d02012-12-15 00:04:07 +00001945 E = CUs.end(); I != E; ++I) {
1946 CompileUnit *TheCU = *I;
Devang Patel163a9f72010-05-10 22:49:55 +00001947 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001948
Devang Patel163a9f72010-05-10 22:49:55 +00001949 // Emit the compile units header.
Eric Christopherb1e66d02012-12-15 00:04:07 +00001950 Asm->OutStreamer
1951 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
1952 TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001953
Devang Patel163a9f72010-05-10 22:49:55 +00001954 // Emit size of content not including length itself
1955 unsigned ContentSize = Die->getSize() +
1956 sizeof(int16_t) + // DWARF version number
1957 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patel65705d52011-04-13 19:41:17 +00001958 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbach1e20b962010-07-21 21:21:52 +00001959
Devang Patel163a9f72010-05-10 22:49:55 +00001960 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
1961 Asm->EmitInt32(ContentSize);
1962 Asm->OutStreamer.AddComment("DWARF version number");
1963 Asm->EmitInt16(dwarf::DWARF_VERSION);
1964 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
Eric Christopherb1e66d02012-12-15 00:04:07 +00001965 Asm->EmitSectionOffset(Asm->GetTempSymbol(ASection->getLabelBeginName()),
1966 ASectionSym);
Devang Patel163a9f72010-05-10 22:49:55 +00001967 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00001968 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001969
Eric Christopher6eebe472012-12-19 22:02:53 +00001970 DD->emitDIE(Die, Abbreviations);
Eric Christopherb1e66d02012-12-15 00:04:07 +00001971 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00001972 TheCU->getUniqueID()));
Devang Patel163a9f72010-05-10 22:49:55 +00001973 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001974}
1975
Manman Renbc3e96f2013-03-12 18:27:15 +00001976/// For a given compile unit DIE, returns offset from beginning of debug info.
1977unsigned DwarfUnits::getCUOffset(DIE *Die) {
Manman Ren4c6f8952013-03-13 18:41:27 +00001978 assert(Die->getTag() == dwarf::DW_TAG_compile_unit &&
1979 "Input DIE should be compile unit in getCUOffset.");
Eric Christopherf7cef702013-03-29 23:34:06 +00001980 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Manman Renbc3e96f2013-03-12 18:27:15 +00001981 E = CUs.end(); I != E; ++I) {
1982 CompileUnit *TheCU = *I;
1983 if (TheCU->getCUDie() == Die)
1984 return TheCU->getDebugInfoOffset();
1985 }
Manman Ren4c6f8952013-03-13 18:41:27 +00001986 llvm_unreachable("The compile unit DIE should belong to CUs in DwarfUnits.");
Manman Renbc3e96f2013-03-12 18:27:15 +00001987}
1988
Eric Christopher98e237f2012-11-30 23:59:06 +00001989// Emit the debug info section.
1990void DwarfDebug::emitDebugInfo() {
Eric Christopherb1e66d02012-12-15 00:04:07 +00001991 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
1992
1993 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
1994 Asm->getObjFileLowering().getDwarfAbbrevSection(),
1995 DwarfAbbrevSectionSym);
Eric Christopher98e237f2012-11-30 23:59:06 +00001996}
1997
Eric Christopherb6dc8652012-11-27 22:43:45 +00001998// Emit the abbreviation section.
Eric Christopher7dc68db2012-11-20 23:30:11 +00001999void DwarfDebug::emitAbbreviations() {
Eric Christopher6eebe472012-12-19 22:02:53 +00002000 if (!useSplitDwarf())
2001 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
2002 &Abbreviations);
2003 else
2004 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2005}
Bill Wendling94d04b82009-05-20 23:21:38 +00002006
Eric Christopher6eebe472012-12-19 22:02:53 +00002007void DwarfDebug::emitAbbrevs(const MCSection *Section,
2008 std::vector<DIEAbbrev *> *Abbrevs) {
2009 // Check to see if it is worth the effort.
2010 if (!Abbrevs->empty()) {
2011 // Start the debug abbrev section.
2012 Asm->OutStreamer.SwitchSection(Section);
2013
2014 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
Eric Christopher44fedba2012-12-13 03:00:38 +00002015 Asm->OutStreamer.EmitLabel(Begin);
Bill Wendling94d04b82009-05-20 23:21:38 +00002016
2017 // For each abbrevation.
Eric Christopher6eebe472012-12-19 22:02:53 +00002018 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002019 // Get abbreviation data
Eric Christopher6eebe472012-12-19 22:02:53 +00002020 const DIEAbbrev *Abbrev = Abbrevs->at(i);
Bill Wendling94d04b82009-05-20 23:21:38 +00002021
2022 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002023 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00002024
2025 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002026 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00002027 }
2028
2029 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002030 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00002031
Eric Christopher6eebe472012-12-19 22:02:53 +00002032 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
Eric Christopher44fedba2012-12-13 03:00:38 +00002033 Asm->OutStreamer.EmitLabel(End);
Bill Wendling94d04b82009-05-20 23:21:38 +00002034 }
2035}
2036
Eric Christopherb6dc8652012-11-27 22:43:45 +00002037// Emit the last address of the section and the end of the line matrix.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002038void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002039 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00002040 Asm->OutStreamer.AddComment("Extended Op");
2041 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002042
Chris Lattner233f52b2010-03-09 23:52:58 +00002043 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002044 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00002045 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2046 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2047
2048 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00002049
Chris Lattnerc0215722010-04-04 19:25:43 +00002050 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Eric Christopherca1dd052013-01-09 01:35:34 +00002051 Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002052
2053 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00002054 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2055 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00002056 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00002057 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00002058}
2059
Eric Christopherb6dc8652012-11-27 22:43:45 +00002060// Emit visible names into a hashed accelerator table section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002061void DwarfDebug::emitAccelNames() {
2062 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2063 dwarf::DW_FORM_data4));
2064 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2065 E = CUMap.end(); I != E; ++I) {
2066 CompileUnit *TheCU = I->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00002067 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2068 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002069 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2070 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00002071 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00002072 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2073 DE = Entities.end(); DI != DE; ++DI)
2074 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00002075 }
2076 }
2077
2078 AT.FinalizeTable(Asm, "Names");
2079 Asm->OutStreamer.SwitchSection(
2080 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2081 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2082 Asm->OutStreamer.EmitLabel(SectionBegin);
2083
2084 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002085 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002086}
2087
Eric Christopher72c16552012-12-20 21:58:40 +00002088// Emit objective C classes and categories into a hashed accelerator table
2089// section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002090void DwarfDebug::emitAccelObjC() {
2091 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2092 dwarf::DW_FORM_data4));
2093 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2094 E = CUMap.end(); I != E; ++I) {
2095 CompileUnit *TheCU = I->second;
2096 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2097 for (StringMap<std::vector<DIE*> >::const_iterator
2098 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2099 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00002100 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher09ac3d82011-11-07 09:24:32 +00002101 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2102 DE = Entities.end(); DI != DE; ++DI)
2103 AT.AddName(Name, (*DI));
2104 }
2105 }
2106
2107 AT.FinalizeTable(Asm, "ObjC");
2108 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2109 .getDwarfAccelObjCSection());
2110 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2111 Asm->OutStreamer.EmitLabel(SectionBegin);
2112
2113 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002114 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002115}
2116
Eric Christopherb6dc8652012-11-27 22:43:45 +00002117// Emit namespace dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002118void DwarfDebug::emitAccelNamespaces() {
2119 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2120 dwarf::DW_FORM_data4));
2121 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2122 E = CUMap.end(); I != E; ++I) {
2123 CompileUnit *TheCU = I->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00002124 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2125 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002126 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2127 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00002128 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00002129 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2130 DE = Entities.end(); DI != DE; ++DI)
2131 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00002132 }
2133 }
2134
2135 AT.FinalizeTable(Asm, "namespac");
2136 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2137 .getDwarfAccelNamespaceSection());
2138 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2139 Asm->OutStreamer.EmitLabel(SectionBegin);
2140
2141 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002142 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002143}
2144
Eric Christopherb6dc8652012-11-27 22:43:45 +00002145// Emit type dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002146void DwarfDebug::emitAccelTypes() {
Eric Christopherc36145f2012-01-06 04:35:23 +00002147 std::vector<DwarfAccelTable::Atom> Atoms;
2148 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2149 dwarf::DW_FORM_data4));
2150 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTag,
2151 dwarf::DW_FORM_data2));
2152 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTypeFlags,
2153 dwarf::DW_FORM_data1));
2154 DwarfAccelTable AT(Atoms);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002155 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2156 E = CUMap.end(); I != E; ++I) {
2157 CompileUnit *TheCU = I->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002158 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2159 = TheCU->getAccelTypes();
2160 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002161 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2162 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00002163 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002164 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2165 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2166 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002167 }
2168 }
2169
2170 AT.FinalizeTable(Asm, "types");
2171 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2172 .getDwarfAccelTypesSection());
2173 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2174 Asm->OutStreamer.EmitLabel(SectionBegin);
2175
2176 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002177 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002178}
2179
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002180/// emitDebugPubnames - Emit visible names into a debug pubnames section.
2181///
2182void DwarfDebug::emitDebugPubnames() {
2183 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2184
2185 typedef DenseMap<const MDNode*, CompileUnit*> CUMapType;
2186 for (CUMapType::iterator I = CUMap.begin(), E = CUMap.end(); I != E; ++I) {
2187 CompileUnit *TheCU = I->second;
2188 unsigned ID = TheCU->getUniqueID();
2189
2190 if (TheCU->getGlobalNames().empty())
2191 continue;
2192
2193 // Start the dwarf pubnames section.
2194 Asm->OutStreamer.SwitchSection(
2195 Asm->getObjFileLowering().getDwarfPubNamesSection());
2196
2197 Asm->OutStreamer.AddComment("Length of Public Names Info");
2198 Asm->EmitLabelDifference(Asm->GetTempSymbol("pubnames_end", ID),
2199 Asm->GetTempSymbol("pubnames_begin", ID), 4);
2200
2201 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin", ID));
2202
2203 Asm->OutStreamer.AddComment("DWARF Version");
2204 Asm->EmitInt16(dwarf::DWARF_VERSION);
2205
2206 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2207 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2208 DwarfInfoSectionSym);
2209
2210 Asm->OutStreamer.AddComment("Compilation Unit Length");
2211 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(), ID),
2212 Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2213 4);
2214
2215 const StringMap<DIE*> &Globals = TheCU->getGlobalNames();
2216 for (StringMap<DIE*>::const_iterator
2217 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2218 const char *Name = GI->getKeyData();
2219 const DIE *Entity = GI->second;
2220
2221 Asm->OutStreamer.AddComment("DIE offset");
2222 Asm->EmitInt32(Entity->getOffset());
2223
2224 if (Asm->isVerbose())
2225 Asm->OutStreamer.AddComment("External Name");
2226 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
2227 }
2228
2229 Asm->OutStreamer.AddComment("End Mark");
2230 Asm->EmitInt32(0);
2231 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end", ID));
2232 }
2233}
2234
Devang Patel193f7202009-11-24 01:14:22 +00002235void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00002236 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2237 E = CUMap.end(); I != E; ++I) {
2238 CompileUnit *TheCU = I->second;
Eric Christopher63701182011-11-07 09:18:35 +00002239 // Start the dwarf pubtypes section.
Devang Patel163a9f72010-05-10 22:49:55 +00002240 Asm->OutStreamer.SwitchSection(
2241 Asm->getObjFileLowering().getDwarfPubTypesSection());
2242 Asm->OutStreamer.AddComment("Length of Public Types Info");
2243 Asm->EmitLabelDifference(
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002244 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2245 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002246
Devang Patel163a9f72010-05-10 22:49:55 +00002247 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002248 TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002249
Devang Patel163a9f72010-05-10 22:49:55 +00002250 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
2251 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002252
Devang Patel163a9f72010-05-10 22:49:55 +00002253 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eric Christophercf6b8ad2012-12-15 00:04:04 +00002254 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2255 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002256 TheCU->getUniqueID()),
Devang Patel163a9f72010-05-10 22:49:55 +00002257 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002258
Devang Patel163a9f72010-05-10 22:49:55 +00002259 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eric Christophercf6b8ad2012-12-15 00:04:04 +00002260 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002261 TheCU->getUniqueID()),
Eric Christophercf6b8ad2012-12-15 00:04:04 +00002262 Asm->GetTempSymbol(ISec->getLabelBeginName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002263 TheCU->getUniqueID()),
Devang Patel163a9f72010-05-10 22:49:55 +00002264 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002265
Devang Patel163a9f72010-05-10 22:49:55 +00002266 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
2267 for (StringMap<DIE*>::const_iterator
2268 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2269 const char *Name = GI->getKeyData();
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00002270 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002271
Devang Patel163a9f72010-05-10 22:49:55 +00002272 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
2273 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002274
Devang Patel163a9f72010-05-10 22:49:55 +00002275 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
Benjamin Kramer983c4572011-11-09 18:16:11 +00002276 // Emit the name with a terminating null byte.
Eric Christopher68ca5622013-01-09 01:57:54 +00002277 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Devang Patel163a9f72010-05-10 22:49:55 +00002278 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002279
Devang Patel163a9f72010-05-10 22:49:55 +00002280 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00002281 Asm->EmitInt32(0);
Devang Patel163a9f72010-05-10 22:49:55 +00002282 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002283 TheCU->getUniqueID()));
Devang Patel193f7202009-11-24 01:14:22 +00002284 }
Devang Patel193f7202009-11-24 01:14:22 +00002285}
2286
Eric Christopher64f824c2012-12-27 02:14:01 +00002287// Emit strings into a string section.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002288void DwarfUnits::emitStrings(const MCSection *StrSection,
2289 const MCSection *OffsetSection = NULL,
2290 const MCSymbol *StrSecSym = NULL) {
Eric Christopher64f824c2012-12-27 02:14:01 +00002291
Eric Christopherb6714222013-01-08 22:22:06 +00002292 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002293
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002294 // Start the dwarf str section.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002295 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling94d04b82009-05-20 23:21:38 +00002296
Chris Lattnerbc733f52010-03-13 02:17:42 +00002297 // Get all of the string pool entries and put them in an array by their ID so
2298 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002299 SmallVector<std::pair<unsigned,
Eric Christopherff348452013-01-07 22:40:45 +00002300 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002301
Chris Lattnerbc733f52010-03-13 02:17:42 +00002302 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
Eric Christopherb6714222013-01-08 22:22:06 +00002303 I = StringPool.begin(), E = StringPool.end();
Eric Christopher72c16552012-12-20 21:58:40 +00002304 I != E; ++I)
Chris Lattnerbc733f52010-03-13 02:17:42 +00002305 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002306
Chris Lattnerbc733f52010-03-13 02:17:42 +00002307 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002308
Chris Lattnerbc733f52010-03-13 02:17:42 +00002309 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002310 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00002311 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002312
Benjamin Kramer983c4572011-11-09 18:16:11 +00002313 // Emit the string itself with a terminating null byte.
Benjamin Kramer0c45f7d2011-11-09 12:12:04 +00002314 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
Eric Christopherca1dd052013-01-09 01:35:34 +00002315 Entries[i].second->getKeyLength()+1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002316 }
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002317
2318 // If we've got an offset section go ahead and emit that now as well.
2319 if (OffsetSection) {
2320 Asm->OutStreamer.SwitchSection(OffsetSection);
2321 unsigned offset = 0;
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002322 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002323 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopher1ced2082013-01-09 03:52:05 +00002324 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002325 offset += Entries[i].second->getKeyLength() + 1;
2326 }
2327 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002328}
2329
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002330// Emit strings into a string section.
2331void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2332
2333 if (AddressPool.empty()) return;
2334
2335 // Start the dwarf addr section.
2336 Asm->OutStreamer.SwitchSection(AddrSection);
2337
2338 // Get all of the string pool entries and put them in an array by their ID so
2339 // we can sort them.
2340 SmallVector<std::pair<unsigned,
2341 std::pair<MCSymbol*, unsigned>* >, 64> Entries;
2342
2343 for (DenseMap<MCSymbol*, std::pair<MCSymbol*, unsigned> >::iterator
2344 I = AddressPool.begin(), E = AddressPool.end();
2345 I != E; ++I)
2346 Entries.push_back(std::make_pair(I->second.second, &(I->second)));
2347
2348 array_pod_sort(Entries.begin(), Entries.end());
2349
2350 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
2351 // Emit a label for reference from debug information entries.
2352 MCSymbol *Sym = Entries[i].second->first;
2353 if (Sym)
2354 Asm->EmitLabelReference(Entries[i].second->first,
2355 Asm->getDataLayout().getPointerSize());
2356 else
2357 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2358 }
2359
2360}
2361
Eric Christopher64f824c2012-12-27 02:14:01 +00002362// Emit visible names into a debug str section.
2363void DwarfDebug::emitDebugStr() {
2364 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2365 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2366}
2367
Eric Christopherb6dc8652012-11-27 22:43:45 +00002368// Emit visible names into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002369void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00002370 if (DotDebugLocEntries.empty())
2371 return;
2372
Eric Christopherf7cef702013-03-29 23:34:06 +00002373 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Devang Patel6c3ea902011-02-04 22:57:18 +00002374 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2375 I != E; ++I) {
2376 DotDebugLocEntry &Entry = *I;
2377 if (I + 1 != DotDebugLocEntries.end())
2378 Entry.Merge(I+1);
2379 }
2380
Daniel Dunbar83320a02011-03-16 22:16:39 +00002381 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002382 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00002383 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002384 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00002385 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2386 unsigned index = 1;
Eric Christopherf7cef702013-03-29 23:34:06 +00002387 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00002388 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00002389 I != E; ++I, ++index) {
Devang Patel6c3ea902011-02-04 22:57:18 +00002390 DotDebugLocEntry &Entry = *I;
2391 if (Entry.isMerged()) continue;
Devang Patelc3f5f782010-05-25 23:40:22 +00002392 if (Entry.isEmpty()) {
Eric Christopherca1dd052013-01-09 01:35:34 +00002393 Asm->OutStreamer.EmitIntValue(0, Size);
2394 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel80250682010-05-26 23:55:23 +00002395 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00002396 } else {
Eric Christopher1ced2082013-01-09 03:52:05 +00002397 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size);
2398 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size);
Devang Patelc26f5442011-04-28 02:22:40 +00002399 DIVariable DV(Entry.Variable);
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002400 Asm->OutStreamer.AddComment("Loc expr size");
2401 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2402 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2403 Asm->EmitLabelDifference(end, begin, 2);
2404 Asm->OutStreamer.EmitLabel(begin);
Devang Patel80efd4e2011-07-08 16:49:43 +00002405 if (Entry.isInt()) {
Devang Patelc4329072011-06-01 22:03:25 +00002406 DIBasicType BTy(DV.getType());
2407 if (BTy.Verify() &&
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002408 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patelc4329072011-06-01 22:03:25 +00002409 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2410 Asm->OutStreamer.AddComment("DW_OP_consts");
2411 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Patel80efd4e2011-07-08 16:49:43 +00002412 Asm->EmitSLEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002413 } else {
2414 Asm->OutStreamer.AddComment("DW_OP_constu");
2415 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Patel80efd4e2011-07-08 16:49:43 +00002416 Asm->EmitULEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002417 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002418 } else if (Entry.isLocation()) {
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002419 if (!DV.hasComplexAddress())
Devang Patel80efd4e2011-07-08 16:49:43 +00002420 // Regular entry.
Devang Patelc26f5442011-04-28 02:22:40 +00002421 Asm->EmitDwarfRegOp(Entry.Loc);
Devang Patel80efd4e2011-07-08 16:49:43 +00002422 else {
2423 // Complex address entry.
2424 unsigned N = DV.getNumAddrElements();
2425 unsigned i = 0;
2426 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
2427 if (Entry.Loc.getOffset()) {
2428 i = 2;
2429 Asm->EmitDwarfRegOp(Entry.Loc);
2430 Asm->OutStreamer.AddComment("DW_OP_deref");
2431 Asm->EmitInt8(dwarf::DW_OP_deref);
2432 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2433 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2434 Asm->EmitSLEB128(DV.getAddrElement(1));
2435 } else {
2436 // If first address element is OpPlus then emit
2437 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
2438 MachineLocation Loc(Entry.Loc.getReg(), DV.getAddrElement(1));
2439 Asm->EmitDwarfRegOp(Loc);
2440 i = 2;
2441 }
2442 } else {
2443 Asm->EmitDwarfRegOp(Entry.Loc);
2444 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002445
Devang Patel80efd4e2011-07-08 16:49:43 +00002446 // Emit remaining complex address elements.
2447 for (; i < N; ++i) {
2448 uint64_t Element = DV.getAddrElement(i);
2449 if (Element == DIBuilder::OpPlus) {
2450 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2451 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher50120762012-05-08 18:56:00 +00002452 } else if (Element == DIBuilder::OpDeref) {
Eric Christophera80f2d12012-05-08 21:24:39 +00002453 if (!Entry.Loc.isReg())
Eric Christopher50120762012-05-08 18:56:00 +00002454 Asm->EmitInt8(dwarf::DW_OP_deref);
2455 } else
2456 llvm_unreachable("unknown Opcode found in complex address");
Devang Patel80efd4e2011-07-08 16:49:43 +00002457 }
Devang Patelc26f5442011-04-28 02:22:40 +00002458 }
Devang Patelc26f5442011-04-28 02:22:40 +00002459 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002460 // else ... ignore constant fp. There is not any good way to
2461 // to represent them here in dwarf.
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002462 Asm->OutStreamer.EmitLabel(end);
Devang Patelc3f5f782010-05-25 23:40:22 +00002463 }
2464 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002465}
2466
Eric Christopherb6dc8652012-11-27 22:43:45 +00002467// Emit visible names into a debug aranges section.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002468void DwarfDebug::emitDebugARanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002469 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002470 Asm->OutStreamer.SwitchSection(
2471 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002472}
2473
Eric Christopherb6dc8652012-11-27 22:43:45 +00002474// Emit visible names into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002475void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002476 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002477 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00002478 Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002479 unsigned char Size = Asm->getDataLayout().getPointerSize();
Eric Christopherf7cef702013-03-29 23:34:06 +00002480 for (SmallVectorImpl<const MCSymbol *>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00002481 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00002482 I != E; ++I) {
2483 if (*I)
Eric Christopher1ced2082013-01-09 03:52:05 +00002484 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
Devang Patelf2548ca2010-04-16 23:33:45 +00002485 else
Eric Christopherca1dd052013-01-09 01:35:34 +00002486 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patelf2548ca2010-04-16 23:33:45 +00002487 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002488}
2489
Eric Christopherb6dc8652012-11-27 22:43:45 +00002490// Emit visible names into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002491void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002492 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00002493 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002494 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002495 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002496 }
2497}
2498
Eric Christopherb6dc8652012-11-27 22:43:45 +00002499// Emit inline info using following format.
2500// Section Header:
2501// 1. length of section
2502// 2. Dwarf version number
2503// 3. address size.
2504//
2505// Entries (one "entry" for each function that was inlined):
2506//
2507// 1. offset into __debug_str section for MIPS linkage name, if exists;
2508// otherwise offset into __debug_str for regular function name.
2509// 2. offset into __debug_str section for regular function name.
2510// 3. an unsigned LEB128 number indicating the number of distinct inlining
2511// instances for the function.
2512//
2513// The rest of the entry consists of a {die_offset, low_pc} pair for each
2514// inlined instance; the die_offset points to the inlined_subroutine die in the
2515// __debug_info section, and the low_pc is the starting address for the
2516// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002517void DwarfDebug::emitDebugInlineInfo() {
Eric Christopherb83e2bb2012-03-02 02:11:47 +00002518 if (!Asm->MAI->doesDwarfUseInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002519 return;
2520
Devang Patel163a9f72010-05-10 22:49:55 +00002521 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00002522 return;
2523
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002524 Asm->OutStreamer.SwitchSection(
2525 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00002526
Chris Lattner233f52b2010-03-09 23:52:58 +00002527 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00002528 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
2529 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00002530
Chris Lattnerc0215722010-04-04 19:25:43 +00002531 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002532
Chris Lattner233f52b2010-03-09 23:52:58 +00002533 Asm->OutStreamer.AddComment("Dwarf Version");
2534 Asm->EmitInt16(dwarf::DWARF_VERSION);
2535 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002536 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002537
Eric Christopherf7cef702013-03-29 23:34:06 +00002538 for (SmallVectorImpl<const MDNode *>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00002539 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002540
Devang Patele9f8f5e2010-05-07 20:54:48 +00002541 const MDNode *Node = *I;
2542 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002543 = InlineInfo.find(Node);
Eric Christopherf7cef702013-03-29 23:34:06 +00002544 SmallVectorImpl<InlineInfoLabels> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00002545 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00002546 StringRef LName = SP.getLinkageName();
2547 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00002548
Chris Lattner233f52b2010-03-09 23:52:58 +00002549 Asm->OutStreamer.AddComment("MIPS linkage name");
Eric Christopher50e26612012-03-02 01:57:52 +00002550 if (LName.empty())
Eric Christopher2e5d8702012-12-20 21:58:36 +00002551 Asm->EmitSectionOffset(InfoHolder.getStringPoolEntry(Name),
2552 DwarfStrSectionSym);
Eric Christopher50e26612012-03-02 01:57:52 +00002553 else
Eric Christopher2e5d8702012-12-20 21:58:36 +00002554 Asm->EmitSectionOffset(InfoHolder
2555 .getStringPoolEntry(getRealLinkageName(LName)),
Chris Lattner6189ed12010-04-04 23:25:33 +00002556 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00002557
Chris Lattner233f52b2010-03-09 23:52:58 +00002558 Asm->OutStreamer.AddComment("Function name");
Eric Christopher2e5d8702012-12-20 21:58:36 +00002559 Asm->EmitSectionOffset(InfoHolder.getStringPoolEntry(Name),
2560 DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002561 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00002562
Eric Christopherf7cef702013-03-29 23:34:06 +00002563 for (SmallVectorImpl<InlineInfoLabels>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00002564 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00002565 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00002566 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00002567
Chris Lattner3f53c832010-04-04 18:52:31 +00002568 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00002569 Asm->OutStreamer.EmitSymbolValue(LI->first,
Eric Christopher1ced2082013-01-09 03:52:05 +00002570 Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002571 }
2572 }
2573
Chris Lattnerc0215722010-04-04 19:25:43 +00002574 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002575}
Eric Christopher98e237f2012-11-30 23:59:06 +00002576
Eric Christopher0b944ee2012-12-11 19:42:09 +00002577// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher98e237f2012-11-30 23:59:06 +00002578
2579// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2580// DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2581// DW_AT_ranges_base, DW_AT_addr_base. If DW_AT_ranges is present,
2582// DW_AT_low_pc and DW_AT_high_pc are not used, and vice versa.
Eric Christopher4daaed12012-12-10 19:51:21 +00002583CompileUnit *DwarfDebug::constructSkeletonCU(const MDNode *N) {
Eric Christopher98e237f2012-11-30 23:59:06 +00002584 DICompileUnit DIUnit(N);
Eric Christopher98e237f2012-11-30 23:59:06 +00002585 CompilationDir = DIUnit.getDirectory();
Eric Christopher98e237f2012-11-30 23:59:06 +00002586
2587 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002588 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
Eric Christopher9c57ad22013-05-08 00:58:51 +00002589 DIUnit.getLanguage(), Die, N, Asm,
Eric Christopher64f824c2012-12-27 02:14:01 +00002590 this, &SkeletonHolder);
Eric Christopher446b88f2013-01-17 03:00:04 +00002591
Eric Christopher3ce51a92013-02-22 23:50:08 +00002592 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
2593 DIUnit.getSplitDebugFilename());
Eric Christopher98e237f2012-11-30 23:59:06 +00002594
Eric Christopher208cc6f2013-02-05 07:31:55 +00002595 // This should be a unique identifier when we want to build .dwp files.
2596 NewCU->addUInt(Die, dwarf::DW_AT_GNU_dwo_id, dwarf::DW_FORM_data8, 0);
Eric Christopherd96c72a2013-01-17 02:59:59 +00002597
Eric Christopher1b0cd2f2013-04-22 07:51:08 +00002598 // Relocate to the beginning of the addr_base section, else 0 for the
2599 // beginning of the one for this compile unit.
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002600 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2601 NewCU->addLabel(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2602 DwarfAddrSectionSym);
2603 else
Eric Christopher1b0cd2f2013-04-22 07:51:08 +00002604 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base,
2605 dwarf::DW_FORM_sec_offset, 0);
Eric Christopher98e237f2012-11-30 23:59:06 +00002606
2607 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002608 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher98e237f2012-11-30 23:59:06 +00002609 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002610
Eric Christopher98e237f2012-11-30 23:59:06 +00002611 // DW_AT_stmt_list is a offset of line number information for this
2612 // compile unit in debug_line section.
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002613 // FIXME: Should handle multiple compile units.
Eric Christopher98e237f2012-11-30 23:59:06 +00002614 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher446b88f2013-01-17 03:00:04 +00002615 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher7a0103c2013-02-07 21:19:50 +00002616 DwarfLineSectionSym);
Eric Christopher98e237f2012-11-30 23:59:06 +00002617 else
Eric Christopher446b88f2013-01-17 03:00:04 +00002618 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher98e237f2012-11-30 23:59:06 +00002619
2620 if (!CompilationDir.empty())
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002621 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher98e237f2012-11-30 23:59:06 +00002622
Eric Christopher0e3e9b72012-12-10 23:34:43 +00002623 SkeletonHolder.addUnit(NewCU);
Eric Christopher01776a52013-02-06 21:53:56 +00002624 SkeletonCUs.push_back(NewCU);
Eric Christopher0e3e9b72012-12-10 23:34:43 +00002625
Eric Christopher98e237f2012-11-30 23:59:06 +00002626 return NewCU;
2627}
2628
Eric Christopher6eebe472012-12-19 22:02:53 +00002629void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
2630 assert(useSplitDwarf() && "No split dwarf debug info?");
2631 emitAbbrevs(Section, &SkeletonAbbrevs);
Eric Christopher98e237f2012-11-30 23:59:06 +00002632}
2633
Eric Christopher0b944ee2012-12-11 19:42:09 +00002634// Emit the .debug_info.dwo section for separated dwarf. This contains the
2635// compile units that would normally be in debug_info.
Eric Christopher98e237f2012-11-30 23:59:06 +00002636void DwarfDebug::emitDebugInfoDWO() {
Eric Christopher4daaed12012-12-10 19:51:21 +00002637 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christopherb1e66d02012-12-15 00:04:07 +00002638 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
Eric Christopher6eebe472012-12-19 22:02:53 +00002639 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2640 DwarfAbbrevDWOSectionSym);
2641}
2642
2643// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2644// abbreviations for the .debug_info.dwo section.
2645void DwarfDebug::emitDebugAbbrevDWO() {
2646 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopher72c16552012-12-20 21:58:40 +00002647 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2648 &Abbreviations);
Eric Christopher98e237f2012-11-30 23:59:06 +00002649}
Eric Christopher64f824c2012-12-27 02:14:01 +00002650
2651// Emit the .debug_str.dwo section for separated dwarf. This contains the
2652// string section and is identical in format to traditional .debug_str
2653// sections.
2654void DwarfDebug::emitDebugStrDWO() {
2655 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherff348452013-01-07 22:40:45 +00002656 const MCSection *OffSec = Asm->getObjFileLowering()
2657 .getDwarfStrOffDWOSection();
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002658 const MCSymbol *StrSym = DwarfStrSectionSym;
2659 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
2660 OffSec, StrSym);
Eric Christopher64f824c2012-12-27 02:14:01 +00002661}