blob: 1de4fca0fb9d483bd793beeb9bc5a5078883145d [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 Christopher0d27ca12013-08-08 23:45:55 +000017#include "DIEHash.h"
Eric Christopher09ac3d82011-11-07 09:24:32 +000018#include "DwarfAccelTable.h"
Devang Patel8b9df622011-04-12 17:40:32 +000019#include "DwarfCompileUnit.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000020#include "llvm/ADT/STLExtras.h"
21#include "llvm/ADT/Statistic.h"
22#include "llvm/ADT/StringExtras.h"
23#include "llvm/ADT/Triple.h"
David Greeneb2c66fc2009-08-19 21:52:55 +000024#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling0310d762009-05-15 09:23:25 +000025#include "llvm/CodeGen/MachineModuleInfo.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000026#include "llvm/DIBuilder.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000027#include "llvm/DebugInfo.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000028#include "llvm/IR/Constants.h"
29#include "llvm/IR/DataLayout.h"
30#include "llvm/IR/Instructions.h"
31#include "llvm/IR/Module.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000032#include "llvm/MC/MCAsmInfo.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000033#include "llvm/MC/MCSection.h"
Chris Lattner6c2f9e12009-08-19 05:49:37 +000034#include "llvm/MC/MCStreamer.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000035#include "llvm/MC/MCSymbol.h"
Devang Pateleac9c072010-04-27 19:46:33 +000036#include "llvm/Support/CommandLine.h"
Daniel Dunbar6e4bdfc2009-10-13 06:47:08 +000037#include "llvm/Support/Debug.h"
38#include "llvm/Support/ErrorHandling.h"
Chris Lattner0ad9c912010-01-22 22:09:00 +000039#include "llvm/Support/FormattedStream.h"
Eric Christopher3dee5752013-07-26 17:02:41 +000040#include "llvm/Support/MD5.h"
Michael J. Spencer1f6efa32010-11-29 18:16:10 +000041#include "llvm/Support/Path.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000042#include "llvm/Support/Timer.h"
43#include "llvm/Support/ValueHandle.h"
44#include "llvm/Target/TargetFrameLowering.h"
45#include "llvm/Target/TargetLoweringObjectFile.h"
46#include "llvm/Target/TargetMachine.h"
47#include "llvm/Target/TargetOptions.h"
48#include "llvm/Target/TargetRegisterInfo.h"
Bill Wendling0310d762009-05-15 09:23:25 +000049using namespace llvm;
50
Eric Christopher6e61e0b2013-07-23 22:16:41 +000051static cl::opt<bool>
52DisableDebugInfoPrinting("disable-debug-info-print", cl::Hidden,
53 cl::desc("Disable debug info printing"));
Devang Pateleac9c072010-04-27 19:46:33 +000054
Eric Christopher6e61e0b2013-07-23 22:16:41 +000055static cl::opt<bool> UnknownLocations(
56 "use-unknown-locations", cl::Hidden,
57 cl::desc("Make an absence of debug location information explicit."),
58 cl::init(false));
Dan Gohman281d65d2010-05-07 01:08:53 +000059
Eric Christopher6e61e0b2013-07-23 22:16:41 +000060static cl::opt<bool>
Eric Christopher3dee5752013-07-26 17:02:41 +000061GenerateODRHash("generate-odr-hash", cl::Hidden,
62 cl::desc("Add an ODR hash to external type DIEs."),
63 cl::init(false));
64
Eric Christopher0710bfa2013-08-13 01:21:55 +000065static cl::opt<bool>
66GenerateCUHash("generate-cu-hash", cl::Hidden,
67 cl::desc("Add the CU hash as the dwo_id."),
68 cl::init(false));
69
Eric Christopher20f47ab2012-08-23 22:36:40 +000070namespace {
Eric Christopher6e61e0b2013-07-23 22:16:41 +000071enum DefaultOnOff {
72 Default,
73 Enable,
74 Disable
75};
Eric Christopher20f47ab2012-08-23 22:36:40 +000076}
Eric Christopher09ac3d82011-11-07 09:24:32 +000077
Eric Christopher6e61e0b2013-07-23 22:16:41 +000078static cl::opt<DefaultOnOff>
79DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
80 cl::desc("Output prototype dwarf accelerator tables."),
81 cl::values(clEnumVal(Default, "Default for platform"),
82 clEnumVal(Enable, "Enabled"),
83 clEnumVal(Disable, "Disabled"), clEnumValEnd),
84 cl::init(Default));
Eric Christopher20f47ab2012-08-23 22:36:40 +000085
Eric Christopher6e61e0b2013-07-23 22:16:41 +000086static cl::opt<DefaultOnOff>
87DarwinGDBCompat("darwin-gdb-compat", cl::Hidden,
88 cl::desc("Compatibility with Darwin gdb."),
89 cl::values(clEnumVal(Default, "Default for platform"),
90 clEnumVal(Enable, "Enabled"),
91 clEnumVal(Disable, "Disabled"), clEnumValEnd),
92 cl::init(Default));
Eric Christopher10cb7442012-08-23 07:10:46 +000093
Eric Christopher6e61e0b2013-07-23 22:16:41 +000094static cl::opt<DefaultOnOff>
95SplitDwarf("split-dwarf", cl::Hidden,
96 cl::desc("Output prototype dwarf split debug info."),
97 cl::values(clEnumVal(Default, "Default for platform"),
98 clEnumVal(Enable, "Enabled"),
99 clEnumVal(Disable, "Disabled"), clEnumValEnd),
100 cl::init(Default));
Eric Christopherf5b6dcd2012-11-12 22:22:20 +0000101
Eric Christopherf04e4ef2013-08-19 21:07:38 +0000102static cl::opt<DefaultOnOff>
103DwarfPubNames("generate-dwarf-pubnames", cl::Hidden,
104 cl::desc("Generate DWARF pubnames section"),
105 cl::values(clEnumVal(Default, "Default for platform"),
106 clEnumVal(Enable, "Enabled"),
107 clEnumVal(Disable, "Disabled"), clEnumValEnd),
108 cl::init(Default));
109
Bill Wendling5f017e82010-04-07 09:28:04 +0000110namespace {
Craig Topper4172a8a2013-07-16 01:17:10 +0000111 const char *const DWARFGroupName = "DWARF Emission";
112 const char *const DbgTimerName = "DWARF Debug Writer";
David Blaikied2e0f7e2013-05-06 23:33:07 +0000113
114 struct CompareFirst {
115 template <typename T> bool operator()(const T &lhs, const T &rhs) const {
116 return lhs.first < rhs.first;
117 }
118 };
Bill Wendling5f017e82010-04-07 09:28:04 +0000119} // end anonymous namespace
120
Bill Wendling0310d762009-05-15 09:23:25 +0000121//===----------------------------------------------------------------------===//
122
Eric Christopherb6dc8652012-11-27 22:43:45 +0000123// Configuration values for initial hash set sizes (log2).
124//
Bill Wendling0310d762009-05-15 09:23:25 +0000125static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling0310d762009-05-15 09:23:25 +0000126
127namespace llvm {
128
Nick Lewycky3bbb6f72011-07-29 03:49:23 +0000129DIType DbgVariable::getType() const {
Devang Patel3cbee302011-04-12 22:53:02 +0000130 DIType Ty = Var.getType();
131 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
132 // addresses instead.
133 if (Var.isBlockByrefVariable()) {
134 /* Byref variables, in Blocks, are declared by the programmer as
135 "SomeType VarName;", but the compiler creates a
136 __Block_byref_x_VarName struct, and gives the variable VarName
137 either the struct, or a pointer to the struct, as its type. This
138 is necessary for various behind-the-scenes things the compiler
139 needs to do with by-reference variables in blocks.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000140
Devang Patel3cbee302011-04-12 22:53:02 +0000141 However, as far as the original *programmer* is concerned, the
142 variable should still have type 'SomeType', as originally declared.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000143
Devang Patel3cbee302011-04-12 22:53:02 +0000144 The following function dives into the __Block_byref_x_VarName
145 struct to find the original type of the variable. This will be
146 passed back to the code generating the type for the Debug
147 Information Entry for the variable 'VarName'. 'VarName' will then
148 have the original type 'SomeType' in its debug information.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000149
Devang Patel3cbee302011-04-12 22:53:02 +0000150 The original type 'SomeType' will be the type of the field named
151 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000152
Devang Patel3cbee302011-04-12 22:53:02 +0000153 NOTE: In order for this to not completely fail on the debugger
154 side, the Debug Information Entry for the variable VarName needs to
155 have a DW_AT_location that tells the debugger how to unwind through
156 the pointers and __Block_byref_x_VarName struct to find the actual
157 value of the variable. The function addBlockByrefType does this. */
158 DIType subType = Ty;
Eric Christopher31667622013-08-08 01:41:00 +0000159 uint16_t tag = Ty.getTag();
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000160
Devang Patel3cbee302011-04-12 22:53:02 +0000161 if (tag == dwarf::DW_TAG_pointer_type) {
162 DIDerivedType DTy = DIDerivedType(Ty);
163 subType = DTy.getTypeDerivedFrom();
164 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000165
Devang Patel3cbee302011-04-12 22:53:02 +0000166 DICompositeType blockStruct = DICompositeType(subType);
167 DIArray Elements = blockStruct.getTypeArray();
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000168
Devang Patel3cbee302011-04-12 22:53:02 +0000169 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
170 DIDescriptor Element = Elements.getElement(i);
171 DIDerivedType DT = DIDerivedType(Element);
172 if (getName() == DT.getName())
173 return (DT.getTypeDerivedFrom());
Devang Patel8bd11de2010-08-09 21:01:39 +0000174 }
Devang Patel8bd11de2010-08-09 21:01:39 +0000175 }
Devang Patel3cbee302011-04-12 22:53:02 +0000176 return Ty;
177}
Bill Wendling0310d762009-05-15 09:23:25 +0000178
Chris Lattnerea761862010-04-05 04:09:20 +0000179} // end llvm namespace
Bill Wendling0310d762009-05-15 09:23:25 +0000180
Manman Ren0e6783f2013-07-02 23:40:10 +0000181/// Return Dwarf Version by checking module flags.
182static unsigned getDwarfVersionFromModule(const Module *M) {
Manman Renc8cfaa12013-07-16 23:21:16 +0000183 Value *Val = M->getModuleFlag("Dwarf Version");
184 if (!Val)
185 return dwarf::DWARF_VERSION;
186 return cast<ConstantInt>(Val)->getZExtValue();
Manman Ren0e6783f2013-07-02 23:40:10 +0000187}
188
Chris Lattner49cd6642010-04-05 05:11:15 +0000189DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Eric Christopher28bd25a2012-12-10 19:51:13 +0000190 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbach1e20b962010-07-21 21:21:52 +0000191 AbbreviationsSet(InitAbbreviationsSetSize),
Eric Christopherb6714222013-01-08 22:22:06 +0000192 SourceIdMap(DIEValueAllocator),
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000193 PrevLabel(NULL), GlobalCUIndexCount(0),
Eric Christopherb6714222013-01-08 22:22:06 +0000194 InfoHolder(A, &AbbreviationsSet, &Abbreviations, "info_string",
195 DIEValueAllocator),
Eric Christopher6eebe472012-12-19 22:02:53 +0000196 SkeletonAbbrevSet(InitAbbreviationsSetSize),
Eric Christopherb6714222013-01-08 22:22:06 +0000197 SkeletonHolder(A, &SkeletonAbbrevSet, &SkeletonAbbrevs, "skel_string",
198 DIEValueAllocator) {
Jim Grosbach1e20b962010-07-21 21:21:52 +0000199
Rafael Espindolaf2b04232011-05-06 14:56:22 +0000200 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattner4ad1efe2010-04-04 23:10:38 +0000201 DwarfStrSectionSym = TextSectionSym = 0;
Eric Christopher7a0103c2013-02-07 21:19:50 +0000202 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
Eric Christopher9a9e73b2013-04-07 03:43:09 +0000203 DwarfAddrSectionSym = 0;
Eric Christopher64f824c2012-12-27 02:14:01 +0000204 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
Devang Patelc3f5f782010-05-25 23:40:22 +0000205 FunctionBeginSym = FunctionEndSym = 0;
Eric Christopher60777d82012-04-02 17:58:52 +0000206
Eric Christopher10cb7442012-08-23 07:10:46 +0000207 // Turn on accelerator tables and older gdb compatibility
208 // for Darwin.
Eric Christopher00297ba2013-04-27 01:07:52 +0000209 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
Eric Christopher20f47ab2012-08-23 22:36:40 +0000210 if (DarwinGDBCompat == Default) {
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000211 if (IsDarwin)
212 IsDarwinGDBCompat = true;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000213 else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000214 IsDarwinGDBCompat = false;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000215 } else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000216 IsDarwinGDBCompat = DarwinGDBCompat == Enable ? true : false;
Eric Christopherc1610fa2012-08-23 22:36:36 +0000217
Eric Christopher20f47ab2012-08-23 22:36:40 +0000218 if (DwarfAccelTables == Default) {
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000219 if (IsDarwin)
220 HasDwarfAccelTables = true;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000221 else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000222 HasDwarfAccelTables = false;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000223 } else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000224 HasDwarfAccelTables = DwarfAccelTables == Enable ? true : false;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000225
Eric Christopher4daaed12012-12-10 19:51:21 +0000226 if (SplitDwarf == Default)
227 HasSplitDwarf = false;
Eric Christopherf5b6dcd2012-11-12 22:22:20 +0000228 else
Eric Christopher4daaed12012-12-10 19:51:21 +0000229 HasSplitDwarf = SplitDwarf == Enable ? true : false;
Eric Christopherf5b6dcd2012-11-12 22:22:20 +0000230
Eric Christopherf04e4ef2013-08-19 21:07:38 +0000231 if (DwarfPubNames == Default) {
232 if (IsDarwin)
233 HasDwarfPubNames = false;
234 else
235 HasDwarfPubNames = true;
236 } else
237 HasDwarfPubNames = DwarfPubNames == Enable ? true : false;
238
Manman Ren0e6783f2013-07-02 23:40:10 +0000239 DwarfVersion = getDwarfVersionFromModule(MMI->getModule());
240
Dan Gohman03c3dc72010-06-18 15:56:31 +0000241 {
242 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopherc4639d62012-11-19 22:42:15 +0000243 beginModule();
Torok Edwin9c421072010-04-07 10:44:46 +0000244 }
Bill Wendling0310d762009-05-15 09:23:25 +0000245}
246DwarfDebug::~DwarfDebug() {
Bill Wendling0310d762009-05-15 09:23:25 +0000247}
248
Eric Christopherb6dc8652012-11-27 22:43:45 +0000249// Switch to the specified MCSection and emit an assembler
250// temporary label to it if SymbolStem is specified.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000251static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christopherd8a87522011-11-07 09:18:38 +0000252 const char *SymbolStem = 0) {
253 Asm->OutStreamer.SwitchSection(Section);
254 if (!SymbolStem) return 0;
255
256 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
257 Asm->OutStreamer.EmitLabel(TmpSym);
258 return TmpSym;
259}
260
Eric Christopher2e5d8702012-12-20 21:58:36 +0000261MCSymbol *DwarfUnits::getStringPoolSym() {
Eric Christopher64f824c2012-12-27 02:14:01 +0000262 return Asm->GetTempSymbol(StringPref);
Nick Lewycky390c40d2011-10-27 06:44:11 +0000263}
264
Eric Christopher2e5d8702012-12-20 21:58:36 +0000265MCSymbol *DwarfUnits::getStringPoolEntry(StringRef Str) {
266 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopherb6714222013-01-08 22:22:06 +0000267 StringPool.GetOrCreateValue(Str).getValue();
Chris Lattnerbc733f52010-03-13 02:17:42 +0000268 if (Entry.first) return Entry.first;
269
270 Entry.second = NextStringPoolNumber++;
Eric Christopher64f824c2012-12-27 02:14:01 +0000271 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
Chris Lattnerbc733f52010-03-13 02:17:42 +0000272}
273
Eric Christopherdd8e9f32013-01-07 19:32:41 +0000274unsigned DwarfUnits::getStringPoolIndex(StringRef Str) {
275 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopherb6714222013-01-08 22:22:06 +0000276 StringPool.GetOrCreateValue(Str).getValue();
Eric Christopherdd8e9f32013-01-07 19:32:41 +0000277 if (Entry.first) return Entry.second;
278
279 Entry.second = NextStringPoolNumber++;
280 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
281 return Entry.second;
282}
283
David Blaikie321d83b2013-06-28 18:47:14 +0000284unsigned DwarfUnits::getAddrPoolIndex(const MCSymbol *Sym) {
David Blaikie8fed05e2013-07-01 23:55:52 +0000285 return getAddrPoolIndex(MCSymbolRefExpr::Create(Sym, Asm->OutContext));
286}
287
Ulrich Weigand18dbe502013-07-02 18:46:46 +0000288unsigned DwarfUnits::getAddrPoolIndex(const MCExpr *Sym) {
289 std::pair<DenseMap<const MCExpr *, unsigned>::iterator, bool> P =
David Blaikie1c736322013-06-28 18:47:19 +0000290 AddressPool.insert(std::make_pair(Sym, NextAddrPoolNumber));
David Blaikie1ca79902013-06-28 18:55:13 +0000291 if (P.second)
292 ++NextAddrPoolNumber;
David Blaikie1c736322013-06-28 18:47:19 +0000293 return P.first->second;
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000294}
295
Eric Christopherb6dc8652012-11-27 22:43:45 +0000296// Define a unique number for the abbreviation.
297//
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000298void DwarfUnits::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling0310d762009-05-15 09:23:25 +0000299 // Check the set for priors.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000300 DIEAbbrev *InSet = AbbreviationsSet->GetOrInsertNode(&Abbrev);
Bill Wendling0310d762009-05-15 09:23:25 +0000301
302 // If it's newly added.
303 if (InSet == &Abbrev) {
304 // Add to abbreviation list.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000305 Abbreviations->push_back(&Abbrev);
Bill Wendling0310d762009-05-15 09:23:25 +0000306
307 // Assign the vector position + 1 as its number.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000308 Abbrev.setNumber(Abbreviations->size());
Bill Wendling0310d762009-05-15 09:23:25 +0000309 } else {
310 // Assign existing abbreviation number.
311 Abbrev.setNumber(InSet->getNumber());
312 }
313}
314
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000315static bool isObjCClass(StringRef Name) {
316 return Name.startswith("+") || Name.startswith("-");
317}
318
319static bool hasObjCCategory(StringRef Name) {
320 if (!isObjCClass(Name)) return false;
321
322 size_t pos = Name.find(')');
323 if (pos != std::string::npos) {
324 if (Name[pos+1] != ' ') return false;
325 return true;
326 }
327 return false;
328}
329
330static void getObjCClassCategory(StringRef In, StringRef &Class,
331 StringRef &Category) {
332 if (!hasObjCCategory(In)) {
333 Class = In.slice(In.find('[') + 1, In.find(' '));
334 Category = "";
335 return;
336 }
337
338 Class = In.slice(In.find('[') + 1, In.find('('));
339 Category = In.slice(In.find('[') + 1, In.find(' '));
340 return;
341}
342
343static StringRef getObjCMethodName(StringRef In) {
344 return In.slice(In.find(' ') + 1, In.find(']'));
345}
346
347// Add the various names to the Dwarf accelerator table names.
348static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
349 DIE* Die) {
350 if (!SP.isDefinition()) return;
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000351
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000352 TheCU->addAccelName(SP.getName(), Die);
353
354 // If the linkage name is different than the name, go ahead and output
355 // that as well into the name table.
356 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
357 TheCU->addAccelName(SP.getLinkageName(), Die);
358
359 // If this is an Objective-C selector name add it to the ObjC accelerator
360 // too.
361 if (isObjCClass(SP.getName())) {
362 StringRef Class, Category;
363 getObjCClassCategory(SP.getName(), Class, Category);
364 TheCU->addAccelObjC(Class, Die);
365 if (Category != "")
366 TheCU->addAccelObjC(Category, Die);
367 // Also add the base method name to the name table.
368 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
369 }
370}
371
Eric Christopherb6dc8652012-11-27 22:43:45 +0000372// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
373// and DW_AT_high_pc attributes. If there are global variables in this
374// scope then create and insert DIEs for these variables.
Devang Pateld3024342011-08-15 22:24:32 +0000375DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
376 const MDNode *SPNode) {
Devang Patel163a9f72010-05-10 22:49:55 +0000377 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patel8aa61472010-07-07 22:20:57 +0000378
Chris Lattnerd38fee82010-04-05 00:13:49 +0000379 assert(SPDie && "Unable to find subprogram DIE!");
380 DISubprogram SP(SPNode);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000381
Bill Wendling168c1902012-11-07 05:19:04 +0000382 // If we're updating an abstract DIE, then we will be adding the children and
383 // object pointer later on. But what we don't want to do is process the
384 // concrete DIE twice.
Manman Renbc3e96f2013-03-12 18:27:15 +0000385 DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode);
386 if (AbsSPDIE) {
387 bool InSameCU = (AbsSPDIE->getCompileUnit() == SPCU->getCUDie());
Bill Wendling168c1902012-11-07 05:19:04 +0000388 // Pick up abstract subprogram DIE.
Devang Patel8aa61472010-07-07 22:20:57 +0000389 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Manman Renbc3e96f2013-03-12 18:27:15 +0000390 // If AbsSPDIE belongs to a different CU, use DW_FORM_ref_addr instead of
391 // DW_FORM_ref4.
Devang Patel3cbee302011-04-12 22:53:02 +0000392 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
Manman Renbc3e96f2013-03-12 18:27:15 +0000393 InSameCU ? dwarf::DW_FORM_ref4 : dwarf::DW_FORM_ref_addr,
394 AbsSPDIE);
Devang Patel8aa61472010-07-07 22:20:57 +0000395 SPCU->addDie(SPDie);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000396 } else {
397 DISubprogram SPDecl = SP.getFunctionDeclaration();
398 if (!SPDecl.isSubprogram()) {
399 // There is not any need to generate specification DIE for a function
400 // defined at compile unit level. If a function is defined inside another
401 // function then gdb prefers the definition at top level and but does not
402 // expect specification DIE in parent function. So avoid creating
403 // specification DIE for a function defined inside a function.
404 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
405 !SP.getContext().isFile() &&
406 !isSubprogramContext(SP.getContext())) {
407 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
408
409 // Add arguments.
410 DICompositeType SPTy = SP.getType();
411 DIArray Args = SPTy.getTypeArray();
Eric Christopher31667622013-08-08 01:41:00 +0000412 uint16_t SPTag = SPTy.getTag();
Bill Wendlinga4c76932012-11-07 04:42:18 +0000413 if (SPTag == dwarf::DW_TAG_subroutine_type)
414 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
415 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
416 DIType ATy = DIType(Args.getElement(i));
417 SPCU->addType(Arg, ATy);
418 if (ATy.isArtificial())
419 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
420 if (ATy.isObjectPointer())
421 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer,
422 dwarf::DW_FORM_ref4, Arg);
423 SPDie->addChild(Arg);
424 }
425 DIE *SPDeclDie = SPDie;
426 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000427 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification,
428 dwarf::DW_FORM_ref4, SPDeclDie);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000429 SPCU->addDie(SPDie);
430 }
431 }
Devang Patel8aa61472010-07-07 22:20:57 +0000432 }
433
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000434 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc,
435 Asm->GetTempSymbol("func_begin",
436 Asm->getFunctionNumber()));
437 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
438 Asm->GetTempSymbol("func_end",
439 Asm->getFunctionNumber()));
Chris Lattnerd38fee82010-04-05 00:13:49 +0000440 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
441 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patel3cbee302011-04-12 22:53:02 +0000442 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +0000443
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000444 // Add name to the name table, we do this here because we're guaranteed
445 // to have concrete versions of our DW_TAG_subprogram nodes.
446 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000447
Chris Lattnerd38fee82010-04-05 00:13:49 +0000448 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +0000449}
450
Eric Christopherb6dc8652012-11-27 22:43:45 +0000451// Construct new DW_TAG_lexical_block for this scope and attach
452// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000453DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld3024342011-08-15 22:24:32 +0000454 LexicalScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +0000455 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
456 if (Scope->isAbstractScope())
457 return ScopeDIE;
458
Craig Topper9f43ac62013-07-03 04:24:43 +0000459 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Devang Pateleac9c072010-04-27 19:46:33 +0000460 if (Ranges.empty())
461 return 0;
462
Eric Christopherf53d6432013-07-03 01:57:28 +0000463 // If we have multiple ranges, emit them into the range section.
Devang Pateleac9c072010-04-27 19:46:33 +0000464 if (Ranges.size() > 1) {
465 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbach1e20b962010-07-21 21:21:52 +0000466 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Pateleac9c072010-04-27 19:46:33 +0000467 // DW_AT_ranges appropriately.
Devang Patel3cbee302011-04-12 22:53:02 +0000468 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000469 DebugRangeSymbols.size()
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000470 * Asm->getDataLayout().getPointerSize());
Craig Topper2d785db2013-07-03 04:17:25 +0000471 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +0000472 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +0000473 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
474 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +0000475 }
Eric Christopherda965de2013-07-03 01:22:29 +0000476
477 // Terminate the range list.
Devang Pateleac9c072010-04-27 19:46:33 +0000478 DebugRangeSymbols.push_back(NULL);
479 DebugRangeSymbols.push_back(NULL);
480 return ScopeDIE;
481 }
482
Eric Christopherf53d6432013-07-03 01:57:28 +0000483 // Construct the address range for this DIE.
Craig Topper2d785db2013-07-03 04:17:25 +0000484 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000485 MCSymbol *Start = getLabelBeforeInsn(RI->first);
486 MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +0000487
Devang Patelc3f5f782010-05-25 23:40:22 +0000488 if (End == 0) return 0;
Devang Patel53bb5c92009-11-10 23:06:00 +0000489
Chris Lattnerb7db7332010-03-09 01:58:53 +0000490 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
491 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbach1e20b962010-07-21 21:21:52 +0000492
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000493 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
494 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patel53bb5c92009-11-10 23:06:00 +0000495
496 return ScopeDIE;
497}
498
Eric Christopherb6dc8652012-11-27 22:43:45 +0000499// This scope represents inlined body of a function. Construct DIE to
500// represent this concrete inlined copy of the function.
Devang Pateld3024342011-08-15 22:24:32 +0000501DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
502 LexicalScope *Scope) {
Craig Topper9f43ac62013-07-03 04:24:43 +0000503 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Nick Lewycky746cb672011-10-26 22:55:33 +0000504 assert(Ranges.empty() == false &&
505 "LexicalScope does not have instruction markers!");
Devang Pateleac9c072010-04-27 19:46:33 +0000506
Devang Patel26a92002011-07-27 00:34:13 +0000507 if (!Scope->getScopeNode())
508 return NULL;
509 DIScope DS(Scope->getScopeNode());
510 DISubprogram InlinedSP = getDISubprogram(DS);
Manman Ren742671b2013-05-29 17:16:59 +0000511 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patel26a92002011-07-27 00:34:13 +0000512 if (!OriginDIE) {
Bill Wendlinge0aae5b2012-10-30 17:51:02 +0000513 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patel26a92002011-07-27 00:34:13 +0000514 return NULL;
515 }
516
Devang Pateld96efb82011-05-05 17:54:26 +0000517 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Devang Patel3cbee302011-04-12 22:53:02 +0000518 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Manman Ren742671b2013-05-29 17:16:59 +0000519 dwarf::DW_FORM_ref4, OriginDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +0000520
Devang Patel26a92002011-07-27 00:34:13 +0000521 if (Ranges.size() > 1) {
522 // .debug_range section has not been laid out yet. Emit offset in
523 // .debug_range as a uint, size 4, for now. emitDIE will handle
524 // DW_AT_ranges appropriately.
525 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000526 DebugRangeSymbols.size()
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000527 * Asm->getDataLayout().getPointerSize());
Craig Topper2d785db2013-07-03 04:17:25 +0000528 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel26a92002011-07-27 00:34:13 +0000529 RE = Ranges.end(); RI != RE; ++RI) {
530 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
531 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
532 }
533 DebugRangeSymbols.push_back(NULL);
534 DebugRangeSymbols.push_back(NULL);
535 } else {
Craig Topper2d785db2013-07-03 04:17:25 +0000536 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christophere7177132013-07-03 02:23:53 +0000537 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
538 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
539
540 if (StartLabel == 0 || EndLabel == 0)
541 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
542
543 assert(StartLabel->isDefined() &&
544 "Invalid starting label for an inlined scope!");
545 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
546
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000547 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
548 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patel26a92002011-07-27 00:34:13 +0000549 }
Devang Patel53bb5c92009-11-10 23:06:00 +0000550
551 InlinedSubprogramDIEs.insert(OriginDIE);
552
Eric Christophere7177132013-07-03 02:23:53 +0000553 // Add the call site information to the DIE.
Devang Patel53bb5c92009-11-10 23:06:00 +0000554 DILocation DL(Scope->getInlinedAt());
Eric Christopher08212002012-03-26 21:38:38 +0000555 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0,
Manman Ren3de61b42013-03-07 01:42:00 +0000556 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
557 TheCU->getUniqueID()));
Devang Patel3cbee302011-04-12 22:53:02 +0000558 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +0000559
Eric Christophere7177132013-07-03 02:23:53 +0000560 // Track the start label for this inlined function.
561 //.debug_inlined section specification does not clearly state how
562 // to emit inlined scopes that are split into multiple instruction ranges.
563 // For now, use the first instruction range and emit low_pc/high_pc pair and
564 // corresponding the .debug_inlined section entry for this pair.
565 if (Asm->MAI->doesDwarfUseInlineInfoSection()) {
566 MCSymbol *StartLabel = getLabelBeforeInsn(Ranges.begin()->first);
Craig Topper01eb99a2013-07-03 04:40:27 +0000567 InlineInfoMap::iterator I = InlineInfo.find(InlinedSP);
Eric Christophere7177132013-07-03 02:23:53 +0000568
569 if (I == InlineInfo.end()) {
570 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel, ScopeDIE));
571 InlinedSPNodes.push_back(InlinedSP);
572 } else
573 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
574 }
575
Eric Christopher309bedd2011-12-04 06:02:38 +0000576 // Add name to the name table, we do this here because we're guaranteed
577 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
578 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000579
Devang Patel53bb5c92009-11-10 23:06:00 +0000580 return ScopeDIE;
581}
582
Eric Christopherb6dc8652012-11-27 22:43:45 +0000583// Construct a DIE for this scope.
Devang Pateld0b5a5e2011-08-15 22:04:40 +0000584DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
Devang Patel3c91b052010-03-08 20:52:55 +0000585 if (!Scope || !Scope->getScopeNode())
586 return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000587
Manman Ren8b15d742013-01-31 20:05:14 +0000588 DIScope DS(Scope->getScopeNode());
589 // Early return to avoid creating dangling variable|scope DIEs.
Manman Ren742671b2013-05-29 17:16:59 +0000590 if (!Scope->getInlinedAt() && DS.isSubprogram() && Scope->isAbstractScope() &&
591 !TheCU->getDIE(DS))
592 return NULL;
Manman Ren8b15d742013-01-31 20:05:14 +0000593
Nick Lewycky746cb672011-10-26 22:55:33 +0000594 SmallVector<DIE *, 8> Children;
Eric Christophere5212782012-09-12 23:36:19 +0000595 DIE *ObjectPointer = NULL;
Devang Patel0478c152011-03-01 22:58:55 +0000596
597 // Collect arguments for current function.
Devang Patelbf47fdb2011-08-10 20:55:27 +0000598 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +0000599 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
600 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000601 if (DIE *Arg =
Eric Christophere5212782012-09-12 23:36:19 +0000602 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel0478c152011-03-01 22:58:55 +0000603 Children.push_back(Arg);
Eric Christophere5212782012-09-12 23:36:19 +0000604 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
605 }
Devang Patel0478c152011-03-01 22:58:55 +0000606
Eric Christopher1aeb7ac2011-10-03 15:49:16 +0000607 // Collect lexical scope children first.
Craig Topper9f43ac62013-07-03 04:24:43 +0000608 const SmallVectorImpl<DbgVariable *> &Variables =ScopeVariables.lookup(Scope);
Devang Patel5bc9fec2011-02-19 01:31:27 +0000609 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000610 if (DIE *Variable =
Eric Christopher7b451cf2012-09-21 22:18:52 +0000611 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5bc9fec2011-02-19 01:31:27 +0000612 Children.push_back(Variable);
Eric Christopher7b451cf2012-09-21 22:18:52 +0000613 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
614 }
Craig Topper9f43ac62013-07-03 04:24:43 +0000615 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5bc9fec2011-02-19 01:31:27 +0000616 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Pateld0b5a5e2011-08-15 22:04:40 +0000617 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5bc9fec2011-02-19 01:31:27 +0000618 Children.push_back(Nested);
Devang Patel3c91b052010-03-08 20:52:55 +0000619 DIE *ScopeDIE = NULL;
620 if (Scope->getInlinedAt())
Devang Pateld3024342011-08-15 22:24:32 +0000621 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3c91b052010-03-08 20:52:55 +0000622 else if (DS.isSubprogram()) {
Devang Patel0dd45582010-06-28 20:53:04 +0000623 ProcessedSPNodes.insert(DS);
Devang Patel8aa61472010-07-07 22:20:57 +0000624 if (Scope->isAbstractScope()) {
Manman Ren742671b2013-05-29 17:16:59 +0000625 ScopeDIE = TheCU->getDIE(DS);
Devang Patel8aa61472010-07-07 22:20:57 +0000626 // Note down abstract DIE.
627 if (ScopeDIE)
628 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
629 }
Devang Patel3c91b052010-03-08 20:52:55 +0000630 else
Devang Pateld3024342011-08-15 22:24:32 +0000631 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3c91b052010-03-08 20:52:55 +0000632 }
Devang Patel5bc9fec2011-02-19 01:31:27 +0000633 else {
634 // There is no need to emit empty lexical block DIE.
David Blaikied2e0f7e2013-05-06 23:33:07 +0000635 std::pair<ImportedEntityMap::const_iterator,
636 ImportedEntityMap::const_iterator> Range = std::equal_range(
637 ScopesWithImportedEntities.begin(), ScopesWithImportedEntities.end(),
Timur Iskhodzhanov664fbee2013-05-07 07:47:47 +0000638 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode*)0),
639 CompareFirst());
David Blaikied2e0f7e2013-05-06 23:33:07 +0000640 if (Children.empty() && Range.first == Range.second)
Devang Patel5bc9fec2011-02-19 01:31:27 +0000641 return NULL;
Devang Pateld3024342011-08-15 22:24:32 +0000642 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Eric Christopherfdfc81f2013-06-24 23:20:02 +0000643 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
644 ++i)
David Blaikied1221e32013-05-08 06:01:38 +0000645 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5bc9fec2011-02-19 01:31:27 +0000646 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000647
Devang Patelaead63c2010-03-29 22:59:58 +0000648 if (!ScopeDIE) return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000649
Devang Patel5bc9fec2011-02-19 01:31:27 +0000650 // Add children
Craig Topper2d785db2013-07-03 04:17:25 +0000651 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Devang Patel5bc9fec2011-02-19 01:31:27 +0000652 E = Children.end(); I != E; ++I)
653 ScopeDIE->addChild(*I);
Devang Patel193f7202009-11-24 01:14:22 +0000654
Eric Christophere5212782012-09-12 23:36:19 +0000655 if (DS.isSubprogram() && ObjectPointer != NULL)
656 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer,
657 dwarf::DW_FORM_ref4, ObjectPointer);
658
Jim Grosbach1e20b962010-07-21 21:21:52 +0000659 if (DS.isSubprogram())
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000660 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbach1e20b962010-07-21 21:21:52 +0000661
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000662 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +0000663}
664
Eric Christopherb6dc8652012-11-27 22:43:45 +0000665// Look up the source id with the given directory and source file names.
666// If none currently exists, create a new id and insert it in the
667// SourceIds map. This can update DirectoryNames and SourceFileNames maps
668// as well.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000669unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Manman Ren3de61b42013-03-07 01:42:00 +0000670 StringRef DirName, unsigned CUID) {
671 // If we use .loc in assembly, we can't separate .file entries according to
672 // compile units. Thus all files will belong to the default compile unit.
673 if (Asm->TM.hasMCUseLoc() &&
674 Asm->OutStreamer.getKind() == MCStreamer::SK_AsmStreamer)
675 CUID = 0;
676
Devang Patel1905a182010-09-16 20:57:49 +0000677 // If FE did not provide a file name, then assume stdin.
678 if (FileName.empty())
Manman Ren3de61b42013-03-07 01:42:00 +0000679 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patel23670e52011-03-24 20:30:50 +0000680
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000681 // TODO: this might not belong here. See if we can factor this better.
682 if (DirName == CompilationDir)
683 DirName = "";
684
Manman Ren3de61b42013-03-07 01:42:00 +0000685 // FileIDCUMap stores the current ID for the given compile unit.
686 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel1905a182010-09-16 20:57:49 +0000687
Manman Ren3de61b42013-03-07 01:42:00 +0000688 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer74612c22012-03-11 14:56:26 +0000689 SmallString<128> NamePair;
Manman Ren5044a932013-04-06 01:02:38 +0000690 NamePair += utostr(CUID);
Manman Ren3de61b42013-03-07 01:42:00 +0000691 NamePair += '\0';
Benjamin Kramer74612c22012-03-11 14:56:26 +0000692 NamePair += DirName;
693 NamePair += '\0'; // Zero bytes are not allowed in paths.
694 NamePair += FileName;
695
696 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
697 if (Ent.getValue() != SrcId)
698 return Ent.getValue();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000699
Manman Ren3de61b42013-03-07 01:42:00 +0000700 FileIDCUMap[CUID] = SrcId;
Rafael Espindola5c055632010-11-18 02:04:25 +0000701 // Print out a .file directive to specify files for .loc directives.
Manman Ren3de61b42013-03-07 01:42:00 +0000702 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000703
704 return SrcId;
705}
706
Eric Christopher72c16552012-12-20 21:58:40 +0000707// Create new CompileUnit for the given metadata node with tag
708// DW_TAG_compile_unit.
Devang Patel94c7ddb2011-08-16 22:09:43 +0000709CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +0000710 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +0000711 StringRef FN = DIUnit.getFilename();
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000712 CompilationDir = DIUnit.getDirectory();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000713
714 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyd4a05e02012-12-03 18:45:45 +0000715 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
Eric Christopher9c57ad22013-05-08 00:58:51 +0000716 DIUnit.getLanguage(), Die, N, Asm,
Eric Christopher2e5d8702012-12-20 21:58:36 +0000717 this, &InfoHolder);
Manman Ren3de61b42013-03-07 01:42:00 +0000718
719 FileIDCUMap[NewCU->getUniqueID()] = 0;
720 // Call this to emit a .file directive if it wasn't emitted for the source
721 // file this CU comes from yet.
722 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
723
Nick Lewycky390c40d2011-10-27 06:44:11 +0000724 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patel3cbee302011-04-12 22:53:02 +0000725 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
726 DIUnit.getLanguage());
Nick Lewycky390c40d2011-10-27 06:44:11 +0000727 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christophere0828ec2013-04-09 19:23:15 +0000728
Eric Christopher6635cad2012-08-01 18:19:01 +0000729 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christophere0828ec2013-04-09 19:23:15 +0000730 // into an entity. We're using 0 (or a NULL label) for this. For
731 // split dwarf it's in the skeleton CU so omit it here.
732 if (!useSplitDwarf())
733 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
Manman Ren43213cf2013-02-05 21:52:47 +0000734
735 // Define start line table label for each Compile Unit.
736 MCSymbol *LineTableStartSym = Asm->GetTempSymbol("line_table_start",
737 NewCU->getUniqueID());
738 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
739 NewCU->getUniqueID());
740
Manman Ren01cb18e2013-05-21 00:57:22 +0000741 // Use a single line table if we are using .loc and generating assembly.
742 bool UseTheFirstCU =
743 (Asm->TM.hasMCUseLoc() &&
744 Asm->OutStreamer.getKind() == MCStreamer::SK_AsmStreamer) ||
745 (NewCU->getUniqueID() == 0);
746
Devang Patel4a602ca2010-03-22 23:11:36 +0000747 // DW_AT_stmt_list is a offset of line number information for this
Eric Christophere0828ec2013-04-09 19:23:15 +0000748 // compile unit in debug_line section. For split dwarf this is
749 // left in the skeleton CU and so not included.
Manman Renf2d89ff2013-02-09 00:41:44 +0000750 // The line table entries are not always emitted in assembly, so it
751 // is not okay to use line_table_start here.
Eric Christophere0828ec2013-04-09 19:23:15 +0000752 if (!useSplitDwarf()) {
753 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Carlo Kok46f0b6f2013-08-13 17:46:57 +0000754 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Manman Ren01cb18e2013-05-21 00:57:22 +0000755 UseTheFirstCU ?
Eric Christophere0828ec2013-04-09 19:23:15 +0000756 Asm->GetTempSymbol("section_line") : LineTableStartSym);
Manman Ren01cb18e2013-05-21 00:57:22 +0000757 else if (UseTheFirstCU)
Eric Christophere0828ec2013-04-09 19:23:15 +0000758 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
759 else
760 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
761 LineTableStartSym, DwarfLineSectionSym);
762 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000763
Eric Christophere0828ec2013-04-09 19:23:15 +0000764 // If we're using split dwarf the compilation dir is going to be in the
765 // skeleton CU and so we don't need to duplicate it here.
766 if (!useSplitDwarf() && !CompilationDir.empty())
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000767 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000768 if (DIUnit.isOptimized())
Eric Christopher873cf0a2012-08-24 01:14:27 +0000769 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000770
Devang Patel65dbc902009-11-25 17:36:49 +0000771 StringRef Flags = DIUnit.getFlags();
772 if (!Flags.empty())
Nick Lewycky390c40d2011-10-27 06:44:11 +0000773 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000774
Nick Lewyckyd5d52132011-10-17 23:27:36 +0000775 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patel3cbee302011-04-12 22:53:02 +0000776 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000777 dwarf::DW_FORM_data1, RVer);
778
Devang Patel163a9f72010-05-10 22:49:55 +0000779 if (!FirstCU)
780 FirstCU = NewCU;
Eric Christopher208cc6f2013-02-05 07:31:55 +0000781
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000782 InfoHolder.addUnit(NewCU);
783
Devang Patel163a9f72010-05-10 22:49:55 +0000784 CUMap.insert(std::make_pair(N, NewCU));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000785 return NewCU;
Devang Patel163a9f72010-05-10 22:49:55 +0000786}
787
Eric Christopherb6dc8652012-11-27 22:43:45 +0000788// Construct subprogram DIE.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000789void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
Devang Patel3655a212011-08-15 23:36:40 +0000790 const MDNode *N) {
Rafael Espindolab0527282011-11-04 19:00:29 +0000791 CompileUnit *&CURef = SPMap[N];
792 if (CURef)
793 return;
794 CURef = TheCU;
795
Devang Patele4b27562009-08-28 23:24:31 +0000796 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000797 if (!SP.isDefinition())
798 // This is a method declaration which will be handled while constructing
799 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +0000800 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000801
Devang Pateldbc64af2011-08-15 17:24:54 +0000802 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings639336e2010-04-06 21:38:29 +0000803
804 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +0000805 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000806
807 // Add to context owner.
Devang Patel3cbee302011-04-12 22:53:02 +0000808 TheCU->addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +0000809
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +0000810 // Expose as global, if requested.
Eric Christopherf04e4ef2013-08-19 21:07:38 +0000811 if (HasDwarfPubNames)
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +0000812 TheCU->addGlobalName(SP.getName(), SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000813}
814
David Blaikie20d9e412013-05-07 21:35:53 +0000815void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikiec462db62013-04-22 06:12:31 +0000816 const MDNode *N) {
David Blaikie20d9e412013-05-07 21:35:53 +0000817 DIImportedEntity Module(N);
David Blaikiec462db62013-04-22 06:12:31 +0000818 if (!Module.Verify())
819 return;
David Blaikied2e0f7e2013-05-06 23:33:07 +0000820 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
David Blaikied1221e32013-05-08 06:01:38 +0000821 constructImportedEntityDIE(TheCU, Module, D);
David Blaikied2e0f7e2013-05-06 23:33:07 +0000822}
823
David Blaikied1221e32013-05-08 06:01:38 +0000824void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
David Blaikied2e0f7e2013-05-06 23:33:07 +0000825 DIE *Context) {
David Blaikie20d9e412013-05-07 21:35:53 +0000826 DIImportedEntity Module(N);
David Blaikied2e0f7e2013-05-06 23:33:07 +0000827 if (!Module.Verify())
828 return;
David Blaikied1221e32013-05-08 06:01:38 +0000829 return constructImportedEntityDIE(TheCU, Module, Context);
David Blaikied2e0f7e2013-05-06 23:33:07 +0000830}
831
David Blaikied1221e32013-05-08 06:01:38 +0000832void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikie20d9e412013-05-07 21:35:53 +0000833 const DIImportedEntity &Module,
David Blaikied2e0f7e2013-05-06 23:33:07 +0000834 DIE *Context) {
835 assert(Module.Verify() &&
836 "Use one of the MDNode * overloads to handle invalid metadata");
837 assert(Context && "Should always have a context for an imported_module");
David Blaikie20d9e412013-05-07 21:35:53 +0000838 DIE *IMDie = new DIE(Module.getTag());
David Blaikiec462db62013-04-22 06:12:31 +0000839 TheCU->insertDIE(Module, IMDie);
David Blaikie20d9e412013-05-07 21:35:53 +0000840 DIE *EntityDie;
841 DIDescriptor Entity = Module.getEntity();
842 if (Entity.isNameSpace())
843 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
844 else if (Entity.isSubprogram())
845 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
David Blaikieaa76a932013-05-08 06:01:41 +0000846 else if (Entity.isType())
847 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
David Blaikie20d9e412013-05-07 21:35:53 +0000848 else
David Blaikieaa76a932013-05-08 06:01:41 +0000849 EntityDie = TheCU->getDIE(Entity);
David Blaikiec462db62013-04-22 06:12:31 +0000850 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
851 Module.getContext().getDirectory(),
852 TheCU->getUniqueID());
853 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, 0, FileID);
854 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, 0, Module.getLineNumber());
Eric Christopherfdfc81f2013-06-24 23:20:02 +0000855 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, dwarf::DW_FORM_ref4,
856 EntityDie);
David Blaikie7b72cc72013-05-20 22:50:35 +0000857 StringRef Name = Module.getName();
858 if (!Name.empty())
859 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
David Blaikied2e0f7e2013-05-06 23:33:07 +0000860 Context->addChild(IMDie);
David Blaikiec462db62013-04-22 06:12:31 +0000861}
862
Eric Christopherb6dc8652012-11-27 22:43:45 +0000863// Emit all Dwarf sections that should come prior to the content. Create
864// global DIEs and emit initial debug info sections. This is invoked by
865// the target AsmPrinter.
Eric Christopherc4639d62012-11-19 22:42:15 +0000866void DwarfDebug::beginModule() {
Devang Pateleac9c072010-04-27 19:46:33 +0000867 if (DisableDebugInfoPrinting)
868 return;
869
Eric Christopherc4639d62012-11-19 22:42:15 +0000870 const Module *M = MMI->getModule();
871
Nick Lewycky3bbb6f72011-07-29 03:49:23 +0000872 // If module has named metadata anchors then use them, otherwise scan the
873 // module using debug info finder to collect debug info.
Devang Patel30692ab2011-05-03 16:45:22 +0000874 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
David Blaikiec0ec8a42013-03-11 23:39:23 +0000875 if (!CU_Nodes)
Devang Patel02e603f2011-08-15 23:47:24 +0000876 return;
Devang Patel30692ab2011-05-03 16:45:22 +0000877
David Blaikiec0ec8a42013-03-11 23:39:23 +0000878 // Emit initial sections so we can reference labels later.
879 emitSectionLabels();
880
881 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
882 DICompileUnit CUNode(CU_Nodes->getOperand(i));
883 CompileUnit *CU = constructCompileUnit(CUNode);
David Blaikie20d9e412013-05-07 21:35:53 +0000884 DIArray ImportedEntities = CUNode.getImportedEntities();
885 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
David Blaikied2e0f7e2013-05-06 23:33:07 +0000886 ScopesWithImportedEntities.push_back(std::make_pair(
David Blaikie20d9e412013-05-07 21:35:53 +0000887 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
888 ImportedEntities.getElement(i)));
David Blaikied2e0f7e2013-05-06 23:33:07 +0000889 std::sort(ScopesWithImportedEntities.begin(),
890 ScopesWithImportedEntities.end(), CompareFirst());
David Blaikiec0ec8a42013-03-11 23:39:23 +0000891 DIArray GVs = CUNode.getGlobalVariables();
892 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
893 CU->createGlobalVariableDIE(GVs.getElement(i));
894 DIArray SPs = CUNode.getSubprograms();
895 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
896 constructSubprogramDIE(CU, SPs.getElement(i));
897 DIArray EnumTypes = CUNode.getEnumTypes();
898 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
899 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
900 DIArray RetainedTypes = CUNode.getRetainedTypes();
901 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
902 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
David Blaikiec462db62013-04-22 06:12:31 +0000903 // Emit imported_modules last so that the relevant context is already
904 // available.
David Blaikie20d9e412013-05-07 21:35:53 +0000905 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
906 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
David Blaikiec0ec8a42013-03-11 23:39:23 +0000907 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000908
Chris Lattnerd850ac72010-04-05 02:19:28 +0000909 // Tell MMI that we have debug info.
910 MMI->setDebugInfoAvailability(true);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000911
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000912 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +0000913 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000914}
915
Eric Christopher4117bec2012-11-22 00:59:49 +0000916// Attach DW_AT_inline attribute with inlined subprogram DIEs.
917void DwarfDebug::computeInlinedDIEs() {
Devang Patel53bb5c92009-11-10 23:06:00 +0000918 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
919 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000920 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patel53bb5c92009-11-10 23:06:00 +0000921 DIE *ISP = *AI;
Devang Patel3cbee302011-04-12 22:53:02 +0000922 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +0000923 }
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000924 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000925 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000926 DIE *ISP = AI->second;
927 if (InlinedSubprogramDIEs.count(ISP))
928 continue;
929 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
930 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000931}
932
933// Collect info for variables that were optimized out.
934void DwarfDebug::collectDeadVariables() {
935 const Module *M = MMI->getModule();
936 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
937
938 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
939 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
940 DICompileUnit TheCU(CU_Nodes->getOperand(i));
941 DIArray Subprograms = TheCU.getSubprograms();
942 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopherbdab8002012-11-27 00:13:51 +0000943 DISubprogram SP(Subprograms.getElement(i));
944 if (ProcessedSPNodes.count(SP) != 0) continue;
Manman Rend03d2b22013-07-08 18:33:29 +0000945 if (!SP.isSubprogram()) continue;
Eric Christopherbdab8002012-11-27 00:13:51 +0000946 if (!SP.isDefinition()) continue;
947 DIArray Variables = SP.getVariables();
948 if (Variables.getNumElements() == 0) continue;
Eric Christopher4117bec2012-11-22 00:59:49 +0000949
Eric Christopherbdab8002012-11-27 00:13:51 +0000950 LexicalScope *Scope =
951 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
952 DeadFnScopeMap[SP] = Scope;
Eric Christopher4117bec2012-11-22 00:59:49 +0000953
Eric Christopherbdab8002012-11-27 00:13:51 +0000954 // Construct subprogram DIE and add variables DIEs.
955 CompileUnit *SPCU = CUMap.lookup(TheCU);
956 assert(SPCU && "Unable to find Compile Unit!");
957 constructSubprogramDIE(SPCU, SP);
958 DIE *ScopeDIE = SPCU->getDIE(SP);
959 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
960 DIVariable DV(Variables.getElement(vi));
Manman Rend03d2b22013-07-08 18:33:29 +0000961 if (!DV.isVariable()) continue;
Chandler Carruth05497cc2013-07-27 11:09:58 +0000962 DbgVariable NewVar(DV, NULL);
Eric Christopherbdab8002012-11-27 00:13:51 +0000963 if (DIE *VariableDIE =
Chandler Carruth05497cc2013-07-27 11:09:58 +0000964 SPCU->constructVariableDIE(&NewVar, Scope->isAbstractScope()))
Eric Christopherbdab8002012-11-27 00:13:51 +0000965 ScopeDIE->addChild(VariableDIE);
966 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000967 }
968 }
969 }
970 DeleteContainerSeconds(DeadFnScopeMap);
971}
972
Eric Christopher0d27ca12013-08-08 23:45:55 +0000973// Type Signature [7.27] and ODR Hash code.
Eric Christopher3dee5752013-07-26 17:02:41 +0000974
975/// \brief Grabs the string in whichever attribute is passed in and returns
Eric Christopherb7669132013-08-07 01:18:33 +0000976/// a reference to it. Returns "" if the attribute doesn't exist.
Eric Christopher3dee5752013-07-26 17:02:41 +0000977static StringRef getDIEStringAttr(DIE *Die, unsigned Attr) {
Eric Christopherb7669132013-08-07 01:18:33 +0000978 DIEValue *V = Die->findAttribute(Attr);
Eric Christopher3dee5752013-07-26 17:02:41 +0000979
Eric Christopherb7669132013-08-07 01:18:33 +0000980 if (DIEString *S = dyn_cast_or_null<DIEString>(V))
981 return S->getString();
982
Eric Christopher3dee5752013-07-26 17:02:41 +0000983 return StringRef("");
984}
985
Eric Christopher3dee5752013-07-26 17:02:41 +0000986/// Return true if the current DIE is contained within an anonymous namespace.
987static bool isContainedInAnonNamespace(DIE *Die) {
988 DIE *Parent = Die->getParent();
989
990 while (Parent) {
Eric Christopher86aa03d2013-07-29 23:53:08 +0000991 if (Parent->getTag() == dwarf::DW_TAG_namespace &&
992 getDIEStringAttr(Parent, dwarf::DW_AT_name) == "")
Eric Christopher3dee5752013-07-26 17:02:41 +0000993 return true;
994 Parent = Parent->getParent();
995 }
996
997 return false;
998}
999
Eric Christopher028f3472013-08-07 01:18:24 +00001000/// Test if the current CU language is C++ and that we have
1001/// a named type that is not contained in an anonymous namespace.
1002static bool shouldAddODRHash(CompileUnit *CU, DIE *Die) {
Eric Christopherf76e1182013-08-07 08:35:10 +00001003 return CU->getLanguage() == dwarf::DW_LANG_C_plus_plus &&
1004 getDIEStringAttr(Die, dwarf::DW_AT_name) != "" &&
1005 !isContainedInAnonNamespace(Die);
Eric Christopher0d27ca12013-08-08 23:45:55 +00001006}
Eric Christopher028f3472013-08-07 01:18:24 +00001007
Eric Christopher4117bec2012-11-22 00:59:49 +00001008void DwarfDebug::finalizeModuleInfo() {
1009 // Collect info for variables that were optimized out.
1010 collectDeadVariables();
1011
1012 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1013 computeInlinedDIEs();
Devang Patel53bb5c92009-11-10 23:06:00 +00001014
Eric Christopherbe482042013-07-29 22:24:32 +00001015 // Split out type units and conditionally add an ODR tag to the split
1016 // out type.
Eric Christopher3dee5752013-07-26 17:02:41 +00001017 // FIXME: Do type splitting.
1018 for (unsigned i = 0, e = TypeUnits.size(); i != e; ++i) {
Eric Christopher3dee5752013-07-26 17:02:41 +00001019 DIE *Die = TypeUnits[i];
Eric Christopher0d27ca12013-08-08 23:45:55 +00001020 DIEHash Hash;
Eric Christopher028f3472013-08-07 01:18:24 +00001021 // If we've requested ODR hashes and it's applicable for an ODR hash then
1022 // add the ODR signature now.
Eric Christopher0d27ca12013-08-08 23:45:55 +00001023 // FIXME: This should be added onto the type unit, not the type, but this
1024 // works as an intermediate stage.
Eric Christopher028f3472013-08-07 01:18:24 +00001025 if (GenerateODRHash && shouldAddODRHash(CUMap.begin()->second, Die))
Eric Christopher0d27ca12013-08-08 23:45:55 +00001026 CUMap.begin()->second->addUInt(Die, dwarf::DW_AT_GNU_odr_signature,
1027 dwarf::DW_FORM_data8,
1028 Hash.computeDIEODRSignature(Die));
Eric Christopher3dee5752013-07-26 17:02:41 +00001029 }
1030
Eric Christopherf962c022013-08-12 20:27:48 +00001031 // Handle anything that needs to be done on a per-cu basis.
1032 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
1033 CUE = CUMap.end();
1034 CUI != CUE; ++CUI) {
1035 CompileUnit *TheCU = CUI->second;
1036 // Emit DW_AT_containing_type attribute to connect types with their
1037 // vtable holding type.
1038 TheCU->constructContainingTypeDIEs();
1039
1040 // If we're splitting the dwarf out now that we've got the entire
1041 // CU then construct a skeleton CU based upon it.
1042 if (useSplitDwarf()) {
Eric Christopher0710bfa2013-08-13 01:21:55 +00001043 uint64_t ID = 0;
1044 if (GenerateCUHash) {
1045 DIEHash CUHash;
1046 ID = CUHash.computeCUSignature(TheCU->getCUDie());
1047 }
Eric Christopherf962c022013-08-12 20:27:48 +00001048 // This should be a unique identifier when we want to build .dwp files.
1049 TheCU->addUInt(TheCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopher0710bfa2013-08-13 01:21:55 +00001050 dwarf::DW_FORM_data8, ID);
Eric Christopherf962c022013-08-12 20:27:48 +00001051 // Now construct the skeleton CU associated.
1052 CompileUnit *SkCU = constructSkeletonCU(CUI->first);
1053 // This should be a unique identifier when we want to build .dwp files.
1054 SkCU->addUInt(SkCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopher0710bfa2013-08-13 01:21:55 +00001055 dwarf::DW_FORM_data8, ID);
Eric Christopherf962c022013-08-12 20:27:48 +00001056 }
1057 }
1058
1059 // Compute DIE offsets and sizes.
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001060 InfoHolder.computeSizeAndOffsets();
1061 if (useSplitDwarf())
1062 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher4117bec2012-11-22 00:59:49 +00001063}
1064
1065void DwarfDebug::endSections() {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001066 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001067 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00001068 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001069 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00001070 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001071
1072 // End text sections.
Benjamin Kramerb4c9d9c2012-10-31 13:45:49 +00001073 for (unsigned I = 0, E = SectionMap.size(); I != E; ++I) {
1074 Asm->OutStreamer.SwitchSection(SectionMap[I]);
1075 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", I+1));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001076 }
Eric Christopher4117bec2012-11-22 00:59:49 +00001077}
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001078
Eric Christopherb6dc8652012-11-27 22:43:45 +00001079// Emit all Dwarf sections that should come after the content.
Eric Christopher4117bec2012-11-22 00:59:49 +00001080void DwarfDebug::endModule() {
1081
1082 if (!FirstCU) return;
1083
1084 // End any existing sections.
1085 // TODO: Does this need to happen?
1086 endSections();
1087
1088 // Finalize the debug info for the module.
1089 finalizeModuleInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001090
Eric Christopher4daaed12012-12-10 19:51:21 +00001091 if (!useSplitDwarf()) {
Eric Christopher42885022012-11-27 22:43:42 +00001092 // Emit all the DIEs into a debug info section.
1093 emitDebugInfo();
Eric Christopher74802f72012-11-27 00:41:54 +00001094
Eric Christopher42885022012-11-27 22:43:42 +00001095 // Corresponding abbreviations into a abbrev section.
1096 emitAbbreviations();
1097
1098 // Emit info into a debug loc section.
1099 emitDebugLoc();
1100
1101 // Emit info into a debug aranges section.
1102 emitDebugARanges();
1103
1104 // Emit info into a debug ranges section.
1105 emitDebugRanges();
1106
1107 // Emit info into a debug macinfo section.
1108 emitDebugMacInfo();
1109
1110 // Emit inline info.
1111 // TODO: When we don't need the option anymore we
1112 // can remove all of the code that this section
1113 // depends upon.
1114 if (useDarwinGDBCompat())
1115 emitDebugInlineInfo();
1116 } else {
Eric Christopher0b944ee2012-12-11 19:42:09 +00001117 // TODO: Fill this in for separated debug sections and separate
Eric Christopher42885022012-11-27 22:43:42 +00001118 // out information into new sections.
1119
Eric Christopher98e237f2012-11-30 23:59:06 +00001120 // Emit the debug info section and compile units.
Eric Christopher42885022012-11-27 22:43:42 +00001121 emitDebugInfo();
Eric Christopher98e237f2012-11-30 23:59:06 +00001122 emitDebugInfoDWO();
Eric Christopher42885022012-11-27 22:43:42 +00001123
1124 // Corresponding abbreviations into a abbrev section.
1125 emitAbbreviations();
Eric Christopher6eebe472012-12-19 22:02:53 +00001126 emitDebugAbbrevDWO();
Eric Christopher42885022012-11-27 22:43:42 +00001127
1128 // Emit info into a debug loc section.
1129 emitDebugLoc();
1130
1131 // Emit info into a debug aranges section.
1132 emitDebugARanges();
1133
1134 // Emit info into a debug ranges section.
1135 emitDebugRanges();
1136
1137 // Emit info into a debug macinfo section.
1138 emitDebugMacInfo();
1139
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001140 // Emit DWO addresses.
1141 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1142
Eric Christopher42885022012-11-27 22:43:42 +00001143 // Emit inline info.
1144 // TODO: When we don't need the option anymore we
1145 // can remove all of the code that this section
1146 // depends upon.
1147 if (useDarwinGDBCompat())
1148 emitDebugInlineInfo();
1149 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001150
Eric Christopher9d9f5a52012-08-23 07:32:06 +00001151 // Emit info into the dwarf accelerator table sections.
Eric Christopher20f47ab2012-08-23 22:36:40 +00001152 if (useDwarfAccelTables()) {
Eric Christopher09ac3d82011-11-07 09:24:32 +00001153 emitAccelNames();
1154 emitAccelObjC();
1155 emitAccelNamespaces();
1156 emitAccelTypes();
1157 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001158
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00001159 // Emit info into a debug pubnames section, if requested.
Eric Christopherf04e4ef2013-08-19 21:07:38 +00001160 if (HasDwarfPubNames)
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00001161 emitDebugPubnames();
1162
Devang Patel193f7202009-11-24 01:14:22 +00001163 // Emit info into a debug pubtypes section.
Eric Christopher360f0062012-08-23 07:10:56 +00001164 // TODO: When we don't need the option anymore we can
1165 // remove all of the code that adds to the table.
Eric Christopher20f47ab2012-08-23 22:36:40 +00001166 if (useDarwinGDBCompat())
Eric Christopher360f0062012-08-23 07:10:56 +00001167 emitDebugPubTypes();
Devang Patel193f7202009-11-24 01:14:22 +00001168
Eric Christopher42885022012-11-27 22:43:42 +00001169 // Finally emit string information into a string table.
Eric Christopherfcdbecb2012-11-27 06:49:23 +00001170 emitDebugStr();
Eric Christopher64f824c2012-12-27 02:14:01 +00001171 if (useSplitDwarf())
1172 emitDebugStrDWO();
Eric Christopherfcdbecb2012-11-27 06:49:23 +00001173
Devang Patele9a1cca2010-08-02 17:32:15 +00001174 // clean up.
Devang Patel94c7ddb2011-08-16 22:09:43 +00001175 SPMap.clear();
Devang Patel163a9f72010-05-10 22:49:55 +00001176 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1177 E = CUMap.end(); I != E; ++I)
1178 delete I->second;
Eric Christopher9ec87b32012-12-10 19:51:18 +00001179
Craig Topper2d785db2013-07-03 04:17:25 +00001180 for (SmallVectorImpl<CompileUnit *>::iterator I = SkeletonCUs.begin(),
Eric Christopher01776a52013-02-06 21:53:56 +00001181 E = SkeletonCUs.end(); I != E; ++I)
1182 delete *I;
Eric Christopher9ec87b32012-12-10 19:51:18 +00001183
Eric Christopher98e237f2012-11-30 23:59:06 +00001184 // Reset these for the next Module if we have one.
1185 FirstCU = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001186}
1187
Eric Christopherb6dc8652012-11-27 22:43:45 +00001188// Find abstract variable, if any, associated with Var.
Devang Patelb549bcf2011-08-10 21:50:54 +00001189DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattnerde4845c2010-04-02 19:42:39 +00001190 DebugLoc ScopeLoc) {
Devang Patelb549bcf2011-08-10 21:50:54 +00001191 LLVMContext &Ctx = DV->getContext();
1192 // More then one inlined variable corresponds to one abstract variable.
1193 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patel2db49d72010-05-07 18:11:54 +00001194 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00001195 if (AbsDbgVariable)
1196 return AbsDbgVariable;
1197
Devang Patelbf47fdb2011-08-10 20:55:27 +00001198 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00001199 if (!Scope)
1200 return NULL;
1201
Devang Patel5a1a67c2011-08-15 19:01:20 +00001202 AbsDbgVariable = new DbgVariable(Var, NULL);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001203 addScopeVariable(Scope, AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00001204 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00001205 return AbsDbgVariable;
1206}
1207
Eric Christopherb6dc8652012-11-27 22:43:45 +00001208// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel0478c152011-03-01 22:58:55 +00001209bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patelbf47fdb2011-08-10 20:55:27 +00001210 DbgVariable *Var, LexicalScope *Scope) {
1211 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +00001212 return false;
1213 DIVariable DV = Var->getVariable();
1214 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1215 return false;
1216 unsigned ArgNo = DV.getArgNumber();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001217 if (ArgNo == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001218 return false;
1219
Devang Patelcb3a6572011-03-03 20:02:02 +00001220 size_t Size = CurrentFnArguments.size();
1221 if (Size == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001222 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patelbbd0f452011-03-03 21:49:41 +00001223 // llvm::Function argument size is not good indicator of how many
Devang Patel6f676be2011-03-03 20:08:10 +00001224 // arguments does the function have at source level.
1225 if (ArgNo > Size)
Devang Patelcb3a6572011-03-03 20:02:02 +00001226 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel0478c152011-03-01 22:58:55 +00001227 CurrentFnArguments[ArgNo - 1] = Var;
1228 return true;
1229}
1230
Eric Christopherb6dc8652012-11-27 22:43:45 +00001231// Collect variable information from side table maintained by MMI.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001232void
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001233DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patelee432862010-05-20 19:57:06 +00001234 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patele717faa2009-10-06 01:26:37 +00001235 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1236 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1237 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00001238 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00001239 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00001240 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00001241 DIVariable DV(Var);
1242 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00001243
Devang Patelbf47fdb2011-08-10 20:55:27 +00001244 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001245
Devang Patelfb0ee432009-11-10 23:20:04 +00001246 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00001247 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00001248 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00001249
Devang Patel26c1e562010-05-20 16:36:41 +00001250 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001251 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable);
Devang Patelff9dd0a2011-08-15 21:24:36 +00001252 RegVar->setFrameIndex(VP.first);
Devang Patel0478c152011-03-01 22:58:55 +00001253 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001254 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001255 if (AbsDbgVariable)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001256 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patele717faa2009-10-06 01:26:37 +00001257 }
Devang Patelee432862010-05-20 19:57:06 +00001258}
Devang Patel90a48ad2010-03-15 18:33:46 +00001259
Eric Christopherb6dc8652012-11-27 22:43:45 +00001260// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1261// defined reg.
Devang Patelc3f5f782010-05-25 23:40:22 +00001262static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001263 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001264 return MI->getNumOperands() == 3 &&
1265 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
Adrian Prantl35176402013-07-09 20:28:37 +00001266 (MI->getOperand(1).isImm() ||
1267 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
Devang Patelc3f5f782010-05-25 23:40:22 +00001268}
1269
Eric Christopherb6dc8652012-11-27 22:43:45 +00001270// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001271static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1272 const MCSymbol *FLabel,
Devang Patel90b40412011-07-08 17:09:57 +00001273 const MCSymbol *SLabel,
1274 const MachineInstr *MI) {
1275 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1276
David Blaikie6d9dbd52013-06-16 20:34:15 +00001277 assert(MI->getNumOperands() == 3);
Adrian Prantl35176402013-07-09 20:28:37 +00001278 if (MI->getOperand(0).isReg()) {
Devang Patel90b40412011-07-08 17:09:57 +00001279 MachineLocation MLoc;
Adrian Prantl35176402013-07-09 20:28:37 +00001280 // If the second operand is an immediate, this is a
1281 // register-indirect address.
1282 if (!MI->getOperand(1).isImm())
Adrian Prantl13131e62013-04-26 21:57:17 +00001283 MLoc.set(MI->getOperand(0).getReg());
1284 else
1285 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel90b40412011-07-08 17:09:57 +00001286 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1287 }
1288 if (MI->getOperand(0).isImm())
1289 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1290 if (MI->getOperand(0).isFPImm())
1291 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1292 if (MI->getOperand(0).isCImm())
1293 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1294
Craig Topper5e25ee82012-02-05 08:31:47 +00001295 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel90b40412011-07-08 17:09:57 +00001296}
1297
Eric Christopherb6dc8652012-11-27 22:43:45 +00001298// Find variables for each lexical scope.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001299void
Devang Patel78e127d2010-06-25 22:07:34 +00001300DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1301 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00001302
Eric Christopher4e976452013-07-03 21:37:03 +00001303 // Grab the variable info that was squirreled away in the MMI side-table.
Devang Patelee432862010-05-20 19:57:06 +00001304 collectVariableInfoFromMMITable(MF, Processed);
1305
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001306 for (SmallVectorImpl<const MDNode*>::const_iterator
1307 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1308 ++UVI) {
1309 const MDNode *Var = *UVI;
1310 if (Processed.count(Var))
Devang Patelee432862010-05-20 19:57:06 +00001311 continue;
1312
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001313 // History contains relevant DBG_VALUE instructions for Var and instructions
1314 // clobbering it.
1315 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1316 if (History.empty())
1317 continue;
1318 const MachineInstr *MInsn = History.front();
Devang Patelc3f5f782010-05-25 23:40:22 +00001319
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001320 DIVariable DV(Var);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001321 LexicalScope *Scope = NULL;
Devang Pateld8720f42010-05-27 20:25:04 +00001322 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1323 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001324 Scope = LScopes.getCurrentFunctionScope();
David Blaikiec0ec8a42013-03-11 23:39:23 +00001325 else if (MDNode *IA = DV.getInlinedAt())
1326 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1327 else
1328 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patelee432862010-05-20 19:57:06 +00001329 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00001330 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00001331 continue;
1332
1333 Processed.insert(DV);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001334 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel5a1a67c2011-08-15 19:01:20 +00001335 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
1336 DbgVariable *RegVar = new DbgVariable(DV, AbsVar);
Devang Patel0478c152011-03-01 22:58:55 +00001337 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001338 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001339 if (AbsVar)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001340 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001341
Eric Christopherc56e3f02012-10-08 20:48:54 +00001342 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001343 if (History.size() <= 1 || (History.size() == 2 &&
1344 MInsn->isIdenticalTo(History.back()))) {
Devang Patelff9dd0a2011-08-15 21:24:36 +00001345 RegVar->setMInsn(MInsn);
Devang Patelc3f5f782010-05-25 23:40:22 +00001346 continue;
1347 }
1348
Eric Christopher498703b2013-01-28 17:33:26 +00001349 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001350 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001351
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001352 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1353 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1354 const MachineInstr *Begin = *HI;
1355 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesene17232e2011-03-22 00:21:41 +00001356
Devang Patel4ada1d72011-06-01 23:00:17 +00001357 // Check if DBG_VALUE is truncating a range.
1358 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1359 && !Begin->getOperand(0).getReg())
1360 continue;
1361
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001362 // Compute the range for a register location.
1363 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1364 const MCSymbol *SLabel = 0;
1365
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001366 if (HI + 1 == HE)
1367 // If Begin is the last instruction in History then its value is valid
Chris Lattner7a2bdde2011-04-15 05:18:47 +00001368 // until the end of the function.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001369 SLabel = FunctionEndSym;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001370 else {
1371 const MachineInstr *End = HI[1];
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001372 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel476df5f2011-07-07 21:44:42 +00001373 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001374 if (End->isDebugValue())
1375 SLabel = getLabelBeforeInsn(End);
1376 else {
1377 // End is a normal instruction clobbering the range.
1378 SLabel = getLabelAfterInsn(End);
1379 assert(SLabel && "Forgot label after clobber instruction");
1380 ++HI;
1381 }
1382 }
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001383
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001384 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopherabbb2002011-12-16 23:42:31 +00001385 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1386 Begin));
Devang Patelc3f5f782010-05-25 23:40:22 +00001387 }
1388 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00001389 }
Devang Patel98e1cac2010-05-14 21:01:35 +00001390
1391 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001392 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1393 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1394 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1395 DIVariable DV(Variables.getElement(i));
Manman Rend03d2b22013-07-08 18:33:29 +00001396 if (!DV || !DV.isVariable() || !Processed.insert(DV))
Devang Patel93d39be2011-08-19 23:28:12 +00001397 continue;
1398 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1399 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel98e1cac2010-05-14 21:01:35 +00001400 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001401}
Devang Patel98e1cac2010-05-14 21:01:35 +00001402
Eric Christopherb6dc8652012-11-27 22:43:45 +00001403// Return Label preceding the instruction.
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001404MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001405 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1406 assert(Label && "Didn't insert label before instruction");
1407 return Label;
Devang Patelc3f5f782010-05-25 23:40:22 +00001408}
1409
Eric Christopherb6dc8652012-11-27 22:43:45 +00001410// Return Label immediately following the instruction.
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001411MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001412 return LabelsAfterInsn.lookup(MI);
Devang Patele717faa2009-10-06 01:26:37 +00001413}
1414
Eric Christopherb6dc8652012-11-27 22:43:45 +00001415// Process beginning of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001416void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001417 // Check if source location changes, but ignore DBG_VALUE locations.
1418 if (!MI->isDebugValue()) {
1419 DebugLoc DL = MI->getDebugLoc();
1420 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopher60b35f42012-04-05 20:39:05 +00001421 unsigned Flags = 0;
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001422 PrevInstLoc = DL;
Devang Patel4243e672011-05-11 19:22:19 +00001423 if (DL == PrologEndLoc) {
1424 Flags |= DWARF2_FLAG_PROLOGUE_END;
1425 PrologEndLoc = DebugLoc();
1426 }
Eric Christopher60b35f42012-04-05 20:39:05 +00001427 if (PrologEndLoc.isUnknown())
1428 Flags |= DWARF2_FLAG_IS_STMT;
1429
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001430 if (!DL.isUnknown()) {
1431 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel4243e672011-05-11 19:22:19 +00001432 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001433 } else
Devang Patel4243e672011-05-11 19:22:19 +00001434 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001435 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001436 }
Devang Patelaead63c2010-03-29 22:59:58 +00001437
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001438 // Insert labels where requested.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001439 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1440 LabelsBeforeInsn.find(MI);
1441
1442 // No label needed.
1443 if (I == LabelsBeforeInsn.end())
1444 return;
1445
1446 // Label already assigned.
1447 if (I->second)
Devang Patelb2b31a62010-05-26 19:37:24 +00001448 return;
Devang Patel553881b2010-03-29 17:20:31 +00001449
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001450 if (!PrevLabel) {
Devang Patel77051f52010-05-26 21:23:46 +00001451 PrevLabel = MMI->getContext().CreateTempSymbol();
1452 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00001453 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001454 I->second = PrevLabel;
Devang Patel0d20ac82009-10-06 01:50:42 +00001455}
1456
Eric Christopherb6dc8652012-11-27 22:43:45 +00001457// Process end of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001458void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001459 // Don't create a new label after DBG_VALUE instructions.
1460 // They don't generate code.
1461 if (!MI->isDebugValue())
1462 PrevLabel = 0;
1463
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001464 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1465 LabelsAfterInsn.find(MI);
1466
1467 // No label needed.
1468 if (I == LabelsAfterInsn.end())
1469 return;
1470
1471 // Label already assigned.
1472 if (I->second)
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001473 return;
1474
1475 // We need a label after this instruction.
1476 if (!PrevLabel) {
1477 PrevLabel = MMI->getContext().CreateTempSymbol();
1478 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel1c246352010-04-08 16:50:29 +00001479 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001480 I->second = PrevLabel;
Devang Patel53bb5c92009-11-10 23:06:00 +00001481}
1482
Eric Christopherb6dc8652012-11-27 22:43:45 +00001483// Each LexicalScope has first instruction and last instruction to mark
1484// beginning and end of a scope respectively. Create an inverse map that list
1485// scopes starts (and ends) with an instruction. One instruction may start (or
1486// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00001487void DwarfDebug::identifyScopeMarkers() {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001488 SmallVector<LexicalScope *, 4> WorkList;
1489 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel42aafd72010-01-20 02:05:23 +00001490 while (!WorkList.empty()) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001491 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001492
Craig Topper9f43ac62013-07-03 04:24:43 +00001493 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001494 if (!Children.empty())
Craig Topper2d785db2013-07-03 04:17:25 +00001495 for (SmallVectorImpl<LexicalScope *>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00001496 SE = Children.end(); SI != SE; ++SI)
1497 WorkList.push_back(*SI);
1498
Devang Patel53bb5c92009-11-10 23:06:00 +00001499 if (S->isAbstractScope())
1500 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001501
Craig Topper9f43ac62013-07-03 04:24:43 +00001502 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
Devang Pateleac9c072010-04-27 19:46:33 +00001503 if (Ranges.empty())
1504 continue;
Craig Topper2d785db2013-07-03 04:17:25 +00001505 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +00001506 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001507 assert(RI->first && "InsnRange does not have first instruction!");
1508 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001509 requestLabelBeforeInsn(RI->first);
1510 requestLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001511 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001512 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001513}
1514
Eric Christopherb6dc8652012-11-27 22:43:45 +00001515// Get MDNode for DebugLoc's scope.
Devang Patela3f48672011-05-09 22:14:49 +00001516static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1517 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1518 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1519 return DL.getScope(Ctx);
1520}
1521
Eric Christopherb6dc8652012-11-27 22:43:45 +00001522// Walk up the scope chain of given debug loc and find line number info
1523// for the function.
Devang Patel4243e672011-05-11 19:22:19 +00001524static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1525 const MDNode *Scope = getScopeNode(DL, Ctx);
1526 DISubprogram SP = getDISubprogram(Scope);
Manman Rend03d2b22013-07-08 18:33:29 +00001527 if (SP.isSubprogram()) {
Eric Christopher6126a1e2012-04-03 00:43:49 +00001528 // Check for number of operands since the compatibility is
1529 // cheap here.
Eric Christopherfa5b0502012-04-03 17:55:42 +00001530 if (SP->getNumOperands() > 19)
Eric Christopher6126a1e2012-04-03 00:43:49 +00001531 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1532 else
1533 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1534 }
1535
Devang Patel4243e672011-05-11 19:22:19 +00001536 return DebugLoc();
1537}
1538
Eric Christopherb6dc8652012-11-27 22:43:45 +00001539// Gather pre-function debug information. Assumes being called immediately
1540// after the function entry point has been emitted.
Chris Lattnereec791a2010-01-26 23:18:02 +00001541void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00001542 if (!MMI->hasDebugInfo()) return;
Devang Patelbf47fdb2011-08-10 20:55:27 +00001543 LScopes.initialize(*MF);
1544 if (LScopes.empty()) return;
1545 identifyScopeMarkers();
Devang Patel60b35bd2009-10-06 18:37:31 +00001546
Manman Ren43213cf2013-02-05 21:52:47 +00001547 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1548 // belongs to.
1549 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1550 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1551 assert(TheCU && "Unable to find compile unit!");
Manman Ren01cb18e2013-05-21 00:57:22 +00001552 if (Asm->TM.hasMCUseLoc() &&
1553 Asm->OutStreamer.getKind() == MCStreamer::SK_AsmStreamer)
1554 // Use a single line table if we are using .loc and generating assembly.
1555 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1556 else
1557 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
Manman Ren43213cf2013-02-05 21:52:47 +00001558
Devang Pateleac9c072010-04-27 19:46:33 +00001559 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1560 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001561 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00001562 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001563
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001564 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1565
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001566 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopherb6dc8652012-11-27 22:43:45 +00001567 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001568 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1569
Devang Patelb2b31a62010-05-26 19:37:24 +00001570 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001571 I != E; ++I) {
1572 bool AtBlockEntry = true;
Devang Patelb2b31a62010-05-26 19:37:24 +00001573 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1574 II != IE; ++II) {
1575 const MachineInstr *MI = II;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001576
Devang Patelb2b31a62010-05-26 19:37:24 +00001577 if (MI->isDebugValue()) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001578 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001579
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001580 // Keep track of user variables.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001581 const MDNode *Var =
1582 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001583
1584 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001585 if (isDbgValueInDefinedReg(MI))
1586 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1587
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001588 // Check the history of this variable.
1589 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1590 if (History.empty()) {
1591 UserVariables.push_back(Var);
1592 // The first mention of a function argument gets the FunctionBeginSym
1593 // label, so arguments are visible when breaking at function entry.
1594 DIVariable DV(Var);
Manman Rend03d2b22013-07-08 18:33:29 +00001595 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001596 DISubprogram(getDISubprogram(DV.getContext()))
1597 .describes(MF->getFunction()))
1598 LabelsBeforeInsn[MI] = FunctionBeginSym;
1599 } else {
1600 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1601 const MachineInstr *Prev = History.back();
1602 if (Prev->isDebugValue()) {
1603 // Coalesce identical entries at the end of History.
1604 if (History.size() >= 2 &&
Devang Patel79862892011-07-07 00:14:27 +00001605 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher02c1a642012-10-08 20:48:49 +00001606 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001607 << "\t" << *Prev
Devang Patel79862892011-07-07 00:14:27 +00001608 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001609 History.pop_back();
Devang Patel79862892011-07-07 00:14:27 +00001610 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001611
1612 // Terminate old register assignments that don't reach MI;
1613 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1614 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1615 isDbgValueInDefinedReg(Prev)) {
1616 // Previous register assignment needs to terminate at the end of
1617 // its basic block.
1618 MachineBasicBlock::const_iterator LastMI =
1619 PrevMBB->getLastNonDebugInstr();
Devang Patel79862892011-07-07 00:14:27 +00001620 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001621 // Drop DBG_VALUE for empty range.
Eric Christopher02c1a642012-10-08 20:48:49 +00001622 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patel79862892011-07-07 00:14:27 +00001623 << "\t" << *Prev << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001624 History.pop_back();
David Blaikie4532c282013-06-20 00:25:24 +00001625 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001626 // Terminate after LastMI.
1627 History.push_back(LastMI);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001628 }
1629 }
1630 }
1631 History.push_back(MI);
Devang Patelb2b31a62010-05-26 19:37:24 +00001632 } else {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001633 // Not a DBG_VALUE instruction.
1634 if (!MI->isLabel())
1635 AtBlockEntry = false;
1636
Eric Christopher0313ced2012-10-04 20:46:14 +00001637 // First known non-DBG_VALUE and non-frame setup location marks
1638 // the beginning of the function body.
1639 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1640 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel4243e672011-05-11 19:22:19 +00001641 PrologEndLoc = MI->getDebugLoc();
1642
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001643 // Check if the instruction clobbers any registers with debug vars.
1644 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1645 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1646 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1647 continue;
Jakob Stoklund Olesen396618b2012-06-01 23:28:30 +00001648 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1649 AI.isValid(); ++AI) {
1650 unsigned Reg = *AI;
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001651 const MDNode *Var = LiveUserVar[Reg];
1652 if (!Var)
1653 continue;
1654 // Reg is now clobbered.
1655 LiveUserVar[Reg] = 0;
1656
1657 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001658 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1659 if (HistI == DbgValues.end())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001660 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001661 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1662 if (History.empty())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001663 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001664 const MachineInstr *Prev = History.back();
1665 // Sanity-check: Register assignments are terminated at the end of
1666 // their block.
1667 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1668 continue;
1669 // Is the variable still in Reg?
1670 if (!isDbgValueInDefinedReg(Prev) ||
1671 Prev->getOperand(0).getReg() != Reg)
1672 continue;
1673 // Var is clobbered. Make sure the next instruction gets a label.
1674 History.push_back(MI);
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001675 }
1676 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001677 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001678 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001679 }
1680
1681 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1682 I != E; ++I) {
1683 SmallVectorImpl<const MachineInstr*> &History = I->second;
1684 if (History.empty())
1685 continue;
1686
1687 // Make sure the final register assignments are terminated.
1688 const MachineInstr *Prev = History.back();
1689 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1690 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001691 MachineBasicBlock::const_iterator LastMI =
Devang Patel5bc942c2011-08-10 23:58:09 +00001692 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001693 if (LastMI == PrevMBB->end())
1694 // Drop DBG_VALUE for empty range.
1695 History.pop_back();
David Blaikie4532c282013-06-20 00:25:24 +00001696 else if (PrevMBB != &PrevMBB->getParent()->back()) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001697 // Terminate after LastMI.
1698 History.push_back(LastMI);
1699 }
1700 }
1701 // Request labels for the full history.
1702 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1703 const MachineInstr *MI = History[i];
1704 if (MI->isDebugValue())
1705 requestLabelBeforeInsn(MI);
1706 else
1707 requestLabelAfterInsn(MI);
1708 }
1709 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001710
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001711 PrevInstLoc = DebugLoc();
Devang Patelb2b31a62010-05-26 19:37:24 +00001712 PrevLabel = FunctionBeginSym;
Devang Patel4243e672011-05-11 19:22:19 +00001713
1714 // Record beginning of function.
1715 if (!PrologEndLoc.isUnknown()) {
1716 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1717 MF->getFunction()->getContext());
1718 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1719 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie836cfc42012-12-04 22:02:33 +00001720 // We'd like to list the prologue as "not statements" but GDB behaves
1721 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikieb36c5312012-12-04 21:05:36 +00001722 DWARF2_FLAG_IS_STMT);
Devang Patel4243e672011-05-11 19:22:19 +00001723 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001724}
1725
Devang Patelbf47fdb2011-08-10 20:55:27 +00001726void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
David Blaikie032d6242013-06-05 05:39:59 +00001727 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1728 DIVariable DV = Var->getVariable();
David Blaikieb20fdff2013-06-06 21:04:51 +00001729 // Variables with positive arg numbers are parameters.
1730 if (unsigned ArgNum = DV.getArgNumber()) {
1731 // Keep all parameters in order at the start of the variable list to ensure
1732 // function types are correct (no out-of-order parameters)
1733 //
1734 // This could be improved by only doing it for optimized builds (unoptimized
1735 // builds have the right order to begin with), searching from the back (this
1736 // would catch the unoptimized case quickly), or doing a binary search
1737 // rather than linear search.
1738 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1739 while (I != Vars.end()) {
1740 unsigned CurNum = (*I)->getVariable().getArgNumber();
1741 // A local (non-parameter) variable has been found, insert immediately
1742 // before it.
1743 if (CurNum == 0)
1744 break;
1745 // A later indexed parameter has been found, insert immediately before it.
David Blaikiebabfebb2013-06-06 22:28:26 +00001746 if (CurNum > ArgNum)
David Blaikieb20fdff2013-06-06 21:04:51 +00001747 break;
David Blaikiebabfebb2013-06-06 22:28:26 +00001748 ++I;
David Blaikie032d6242013-06-05 05:39:59 +00001749 }
David Blaikieb20fdff2013-06-06 21:04:51 +00001750 Vars.insert(I, Var);
1751 return;
David Blaikie032d6242013-06-05 05:39:59 +00001752 }
1753
1754 Vars.push_back(Var);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001755}
1756
Eric Christopherb6dc8652012-11-27 22:43:45 +00001757// Gather and emit post-function debug information.
Chris Lattnereec791a2010-01-26 23:18:02 +00001758void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001759 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00001760
Devang Patelbf47fdb2011-08-10 20:55:27 +00001761 // Define end label for subprogram.
1762 FunctionEndSym = Asm->GetTempSymbol("func_end",
1763 Asm->getFunctionNumber());
1764 // Assumes in correct section after the entry point.
1765 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Manman Ren43213cf2013-02-05 21:52:47 +00001766 // Set DwarfCompileUnitID in MCContext to default value.
1767 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001768
Devang Patelbf47fdb2011-08-10 20:55:27 +00001769 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1770 collectVariableInfo(MF, ProcessedVars);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001771
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001772 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Patel94c7ddb2011-08-16 22:09:43 +00001773 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky746cb672011-10-26 22:55:33 +00001774 assert(TheCU && "Unable to find compile unit!");
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001775
Devang Patelbf47fdb2011-08-10 20:55:27 +00001776 // Construct abstract scopes.
Devang Patelcd9f6c52011-08-12 18:10:19 +00001777 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1778 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1779 LexicalScope *AScope = AList[i];
1780 DISubprogram SP(AScope->getScopeNode());
Manman Rend03d2b22013-07-08 18:33:29 +00001781 if (SP.isSubprogram()) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001782 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001783 DIArray Variables = SP.getVariables();
1784 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1785 DIVariable DV(Variables.getElement(i));
Manman Rend03d2b22013-07-08 18:33:29 +00001786 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
Devang Patel93d39be2011-08-19 23:28:12 +00001787 continue;
Alexey Samsonovb67bd332012-07-06 08:45:08 +00001788 // Check that DbgVariable for DV wasn't created earlier, when
1789 // findAbstractVariable() was called for inlined instance of DV.
1790 LLVMContext &Ctx = DV->getContext();
1791 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1792 if (AbstractVariables.lookup(CleanDV))
1793 continue;
Devang Patel93d39be2011-08-19 23:28:12 +00001794 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1795 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel78e127d2010-06-25 22:07:34 +00001796 }
1797 }
Devang Patelcd9f6c52011-08-12 18:10:19 +00001798 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Manman Ren742671b2013-05-29 17:16:59 +00001799 constructScopeDIE(TheCU, AScope);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001800 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001801
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001802 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001803
Nick Lewycky8a8d4792011-12-02 22:16:29 +00001804 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopher873cf0a2012-08-24 01:14:27 +00001805 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001806
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001807 // Clear debug info
Craig Topper01eb99a2013-07-03 04:40:27 +00001808 for (ScopeVariablesMap::iterator
Devang Patelbf47fdb2011-08-10 20:55:27 +00001809 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1810 DeleteContainerPointers(I->second);
1811 ScopeVariables.clear();
Devang Pateleac0c9d2011-04-22 18:09:57 +00001812 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001813 UserVariables.clear();
1814 DbgValues.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001815 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00001816 LabelsBeforeInsn.clear();
1817 LabelsAfterInsn.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00001818 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001819}
1820
Eric Christopherb6dc8652012-11-27 22:43:45 +00001821// Register a source line with debug info. Returns the unique label that was
1822// emitted and which provides correspondence to the source line list.
Devang Patel4243e672011-05-11 19:22:19 +00001823void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1824 unsigned Flags) {
Devang Patel65dbc902009-11-25 17:36:49 +00001825 StringRef Fn;
Devang Patel23670e52011-03-24 20:30:50 +00001826 StringRef Dir;
Dan Gohman1cc0d622010-05-05 23:41:32 +00001827 unsigned Src = 1;
1828 if (S) {
1829 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00001830
Dan Gohman1cc0d622010-05-05 23:41:32 +00001831 if (Scope.isCompileUnit()) {
1832 DICompileUnit CU(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001833 Fn = CU.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001834 Dir = CU.getDirectory();
Devang Patel3cabc9d2010-10-28 17:30:52 +00001835 } else if (Scope.isFile()) {
1836 DIFile F(S);
Devang Patel3cabc9d2010-10-28 17:30:52 +00001837 Fn = F.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001838 Dir = F.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001839 } else if (Scope.isSubprogram()) {
1840 DISubprogram SP(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001841 Fn = SP.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001842 Dir = SP.getDirectory();
Eric Christopher6618a242011-10-11 22:59:11 +00001843 } else if (Scope.isLexicalBlockFile()) {
1844 DILexicalBlockFile DBF(S);
1845 Fn = DBF.getFilename();
1846 Dir = DBF.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001847 } else if (Scope.isLexicalBlock()) {
1848 DILexicalBlock DB(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001849 Fn = DB.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001850 Dir = DB.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001851 } else
Craig Topper5e25ee82012-02-05 08:31:47 +00001852 llvm_unreachable("Unexpected scope info");
Dan Gohman1cc0d622010-05-05 23:41:32 +00001853
Manman Ren3de61b42013-03-07 01:42:00 +00001854 Src = getOrCreateSourceID(Fn, Dir,
1855 Asm->OutStreamer.getContext().getDwarfCompileUnitID());
Dan Gohman1cc0d622010-05-05 23:41:32 +00001856 }
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001857 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001858}
1859
Bill Wendling829e67b2009-05-20 23:22:40 +00001860//===----------------------------------------------------------------------===//
1861// Emit Methods
1862//===----------------------------------------------------------------------===//
1863
Eric Christopherb6dc8652012-11-27 22:43:45 +00001864// Compute the size and offset of a DIE.
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001865unsigned
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001866DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001867 // Get the children.
1868 const std::vector<DIE *> &Children = Die->getChildren();
1869
Bill Wendling94d04b82009-05-20 23:21:38 +00001870 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001871 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00001872
1873 // Get the abbreviation for this DIE.
1874 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001875 const DIEAbbrev *Abbrev = Abbreviations->at(AbbrevNumber - 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00001876
1877 // Set DIE offset
1878 Die->setOffset(Offset);
1879
1880 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00001881 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001882
Eric Christopherf7cef702013-03-29 23:34:06 +00001883 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1884 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling94d04b82009-05-20 23:21:38 +00001885
1886 // Size the DIE attribute values.
1887 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1888 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00001889 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00001890
1891 // Size the DIE children if any.
1892 if (!Children.empty()) {
1893 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1894 "Children flag not set");
1895
1896 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopherfbd19752012-11-20 22:14:13 +00001897 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling94d04b82009-05-20 23:21:38 +00001898
1899 // End of children marker.
1900 Offset += sizeof(int8_t);
1901 }
1902
1903 Die->setSize(Offset - Die->getOffset());
1904 return Offset;
1905}
1906
Eric Christopherb6dc8652012-11-27 22:43:45 +00001907// Compute the size and offset of all the DIEs.
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001908void DwarfUnits::computeSizeAndOffsets() {
Manman Renbc3e96f2013-03-12 18:27:15 +00001909 // Offset from the beginning of debug info section.
Eric Christopherd2df98f2013-05-30 00:43:35 +00001910 unsigned SecOffset = 0;
Eric Christopherf7cef702013-03-29 23:34:06 +00001911 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001912 E = CUs.end(); I != E; ++I) {
Eric Christopherd2df98f2013-05-30 00:43:35 +00001913 (*I)->setDebugInfoOffset(SecOffset);
Eric Christopher98e237f2012-11-30 23:59:06 +00001914 unsigned Offset =
1915 sizeof(int32_t) + // Length of Compilation Unit Info
1916 sizeof(int16_t) + // DWARF version number
1917 sizeof(int32_t) + // Offset Into Abbrev. Section
1918 sizeof(int8_t); // Pointer Size (in bytes)
1919
Manman Renbc3e96f2013-03-12 18:27:15 +00001920 unsigned EndOffset = computeSizeAndOffset((*I)->getCUDie(), Offset);
Eric Christopherd2df98f2013-05-30 00:43:35 +00001921 SecOffset += EndOffset;
Devang Patel163a9f72010-05-10 22:49:55 +00001922 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001923}
1924
Eric Christopherb6dc8652012-11-27 22:43:45 +00001925// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001926void DwarfDebug::emitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001927 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001928
Bill Wendling94d04b82009-05-20 23:21:38 +00001929 // Dwarf sections base addresses.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001930 DwarfInfoSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001931 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00001932 DwarfAbbrevSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001933 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher6eebe472012-12-19 22:02:53 +00001934 if (useSplitDwarf())
1935 DwarfAbbrevDWOSectionSym =
1936 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1937 "section_abbrev_dwo");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001938 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001939
Chris Lattner9c69e285532010-04-04 22:59:04 +00001940 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001941 emitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00001942
Eric Christopher7a0103c2013-02-07 21:19:50 +00001943 DwarfLineSectionSym =
1944 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001945 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Eric Christopherf04e4ef2013-08-19 21:07:38 +00001946 if (HasDwarfPubNames)
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00001947 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001948 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001949 DwarfStrSectionSym =
Eric Christopher64f824c2012-12-27 02:14:01 +00001950 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher9a9e73b2013-04-07 03:43:09 +00001951 if (useSplitDwarf()) {
Eric Christopher64f824c2012-12-27 02:14:01 +00001952 DwarfStrDWOSectionSym =
1953 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher9a9e73b2013-04-07 03:43:09 +00001954 DwarfAddrSectionSym =
1955 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
1956 }
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001957 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patelf2548ca2010-04-16 23:33:45 +00001958 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00001959
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001960 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patelc3f5f782010-05-25 23:40:22 +00001961 "section_debug_loc");
1962
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001963 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
1964 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00001965}
1966
Eric Christopherb6dc8652012-11-27 22:43:45 +00001967// Recursively emits a debug information entry.
Eric Christopher6eebe472012-12-19 22:02:53 +00001968void DwarfDebug::emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001969 // Get the abbreviation for this DIE.
1970 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher6eebe472012-12-19 22:02:53 +00001971 const DIEAbbrev *Abbrev = Abbrevs->at(AbbrevNumber - 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00001972
Bill Wendling94d04b82009-05-20 23:21:38 +00001973 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00001974 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00001975 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
1976 Twine::utohexstr(Die->getOffset()) + ":0x" +
1977 Twine::utohexstr(Die->getSize()) + " " +
1978 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00001979 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001980
Eric Christopherf7cef702013-03-29 23:34:06 +00001981 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1982 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling94d04b82009-05-20 23:21:38 +00001983
1984 // Emit the DIE attribute values.
1985 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1986 unsigned Attr = AbbrevData[i].getAttribute();
1987 unsigned Form = AbbrevData[i].getForm();
1988 assert(Form && "Too many attributes for DIE (check abbreviation)");
1989
Chris Lattner3f53c832010-04-04 18:52:31 +00001990 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00001991 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001992
Bill Wendling94d04b82009-05-20 23:21:38 +00001993 switch (Attr) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001994 case dwarf::DW_AT_abstract_origin: {
1995 DIEEntry *E = cast<DIEEntry>(Values[i]);
1996 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00001997 unsigned Addr = Origin->getOffset();
Manman Renbc3e96f2013-03-12 18:27:15 +00001998 if (Form == dwarf::DW_FORM_ref_addr) {
1999 // For DW_FORM_ref_addr, output the offset from beginning of debug info
2000 // section. Origin->getOffset() returns the offset from start of the
2001 // compile unit.
2002 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2003 Addr += Holder.getCUOffset(Origin->getCompileUnit());
2004 }
Manman Ren0e6783f2013-07-02 23:40:10 +00002005 Asm->OutStreamer.EmitIntValue(Addr,
2006 Form == dwarf::DW_FORM_ref_addr ? DIEEntry::getRefAddrSize(Asm) : 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00002007 break;
2008 }
Devang Patelf2548ca2010-04-16 23:33:45 +00002009 case dwarf::DW_AT_ranges: {
2010 // DW_AT_range Value encodes offset in debug_range section.
2011 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelb1fcfbe2010-09-02 16:43:44 +00002012
Nick Lewyckyffccd922012-06-22 01:25:12 +00002013 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelb1fcfbe2010-09-02 16:43:44 +00002014 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
2015 V->getValue(),
2016 4);
2017 } else {
2018 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
2019 V->getValue(),
2020 DwarfDebugRangeSectionSym,
2021 4);
2022 }
Devang Patelf2548ca2010-04-16 23:33:45 +00002023 break;
2024 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002025 case dwarf::DW_AT_location: {
Nick Lewyckyffccd922012-06-22 01:25:12 +00002026 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2027 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Ulrich Weigand1f8aacd2013-07-02 18:46:26 +00002028 Asm->EmitLabelReference(L->getValue(), 4);
Nick Lewyckyffccd922012-06-22 01:25:12 +00002029 else
Ulrich Weigand1f8aacd2013-07-02 18:46:26 +00002030 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewyckyffccd922012-06-22 01:25:12 +00002031 } else {
Devang Patelc3f5f782010-05-25 23:40:22 +00002032 Values[i]->EmitValue(Asm, Form);
Nick Lewyckyffccd922012-06-22 01:25:12 +00002033 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002034 break;
2035 }
Devang Patel2a361602010-09-29 19:08:08 +00002036 case dwarf::DW_AT_accessibility: {
2037 if (Asm->isVerbose()) {
2038 DIEInteger *V = cast<DIEInteger>(Values[i]);
2039 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2040 }
2041 Values[i]->EmitValue(Asm, Form);
2042 break;
2043 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002044 default:
2045 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002046 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00002047 break;
2048 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002049 }
2050
2051 // Emit the DIE children if any.
2052 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2053 const std::vector<DIE *> &Children = Die->getChildren();
2054
2055 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher6eebe472012-12-19 22:02:53 +00002056 emitDIE(Children[j], Abbrevs);
Bill Wendling94d04b82009-05-20 23:21:38 +00002057
Chris Lattner3f53c832010-04-04 18:52:31 +00002058 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00002059 Asm->OutStreamer.AddComment("End Of Children Mark");
2060 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00002061 }
2062}
2063
Eric Christopherb1e66d02012-12-15 00:04:07 +00002064// Emit the various dwarf units to the unit section USection with
2065// the abbreviations going into ASection.
2066void DwarfUnits::emitUnits(DwarfDebug *DD,
2067 const MCSection *USection,
2068 const MCSection *ASection,
2069 const MCSymbol *ASectionSym) {
2070 Asm->OutStreamer.SwitchSection(USection);
Eric Christopherf7cef702013-03-29 23:34:06 +00002071 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopherb1e66d02012-12-15 00:04:07 +00002072 E = CUs.end(); I != E; ++I) {
2073 CompileUnit *TheCU = *I;
Devang Patel163a9f72010-05-10 22:49:55 +00002074 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002075
Devang Patel163a9f72010-05-10 22:49:55 +00002076 // Emit the compile units header.
Eric Christopherb1e66d02012-12-15 00:04:07 +00002077 Asm->OutStreamer
2078 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
2079 TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002080
Devang Patel163a9f72010-05-10 22:49:55 +00002081 // Emit size of content not including length itself
2082 unsigned ContentSize = Die->getSize() +
2083 sizeof(int16_t) + // DWARF version number
2084 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patel65705d52011-04-13 19:41:17 +00002085 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbach1e20b962010-07-21 21:21:52 +00002086
Devang Patel163a9f72010-05-10 22:49:55 +00002087 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2088 Asm->EmitInt32(ContentSize);
2089 Asm->OutStreamer.AddComment("DWARF version number");
Manman Ren0e6783f2013-07-02 23:40:10 +00002090 Asm->EmitInt16(DD->getDwarfVersion());
Devang Patel163a9f72010-05-10 22:49:55 +00002091 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
Eric Christopherb1e66d02012-12-15 00:04:07 +00002092 Asm->EmitSectionOffset(Asm->GetTempSymbol(ASection->getLabelBeginName()),
2093 ASectionSym);
Devang Patel163a9f72010-05-10 22:49:55 +00002094 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002095 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002096
Eric Christopher6eebe472012-12-19 22:02:53 +00002097 DD->emitDIE(Die, Abbreviations);
Eric Christopherb1e66d02012-12-15 00:04:07 +00002098 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002099 TheCU->getUniqueID()));
Devang Patel163a9f72010-05-10 22:49:55 +00002100 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002101}
2102
Manman Renbc3e96f2013-03-12 18:27:15 +00002103/// For a given compile unit DIE, returns offset from beginning of debug info.
2104unsigned DwarfUnits::getCUOffset(DIE *Die) {
Manman Ren4c6f8952013-03-13 18:41:27 +00002105 assert(Die->getTag() == dwarf::DW_TAG_compile_unit &&
2106 "Input DIE should be compile unit in getCUOffset.");
Eric Christophera1eacd02013-08-08 01:41:05 +00002107 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(), E = CUs.end();
2108 I != E; ++I) {
Manman Renbc3e96f2013-03-12 18:27:15 +00002109 CompileUnit *TheCU = *I;
2110 if (TheCU->getCUDie() == Die)
2111 return TheCU->getDebugInfoOffset();
2112 }
Manman Ren4c6f8952013-03-13 18:41:27 +00002113 llvm_unreachable("The compile unit DIE should belong to CUs in DwarfUnits.");
Manman Renbc3e96f2013-03-12 18:27:15 +00002114}
2115
Eric Christopher98e237f2012-11-30 23:59:06 +00002116// Emit the debug info section.
2117void DwarfDebug::emitDebugInfo() {
Eric Christopherb1e66d02012-12-15 00:04:07 +00002118 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2119
2120 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
2121 Asm->getObjFileLowering().getDwarfAbbrevSection(),
2122 DwarfAbbrevSectionSym);
Eric Christopher98e237f2012-11-30 23:59:06 +00002123}
2124
Eric Christopherb6dc8652012-11-27 22:43:45 +00002125// Emit the abbreviation section.
Eric Christopher7dc68db2012-11-20 23:30:11 +00002126void DwarfDebug::emitAbbreviations() {
Eric Christopher6eebe472012-12-19 22:02:53 +00002127 if (!useSplitDwarf())
2128 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
2129 &Abbreviations);
2130 else
2131 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2132}
Bill Wendling94d04b82009-05-20 23:21:38 +00002133
Eric Christopher6eebe472012-12-19 22:02:53 +00002134void DwarfDebug::emitAbbrevs(const MCSection *Section,
2135 std::vector<DIEAbbrev *> *Abbrevs) {
2136 // Check to see if it is worth the effort.
2137 if (!Abbrevs->empty()) {
2138 // Start the debug abbrev section.
2139 Asm->OutStreamer.SwitchSection(Section);
2140
2141 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
Eric Christopher44fedba2012-12-13 03:00:38 +00002142 Asm->OutStreamer.EmitLabel(Begin);
Bill Wendling94d04b82009-05-20 23:21:38 +00002143
2144 // For each abbrevation.
Eric Christopher6eebe472012-12-19 22:02:53 +00002145 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002146 // Get abbreviation data
Eric Christopher6eebe472012-12-19 22:02:53 +00002147 const DIEAbbrev *Abbrev = Abbrevs->at(i);
Bill Wendling94d04b82009-05-20 23:21:38 +00002148
2149 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002150 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00002151
2152 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002153 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00002154 }
2155
2156 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002157 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00002158
Eric Christopher6eebe472012-12-19 22:02:53 +00002159 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
Eric Christopher44fedba2012-12-13 03:00:38 +00002160 Asm->OutStreamer.EmitLabel(End);
Bill Wendling94d04b82009-05-20 23:21:38 +00002161 }
2162}
2163
Eric Christopherb6dc8652012-11-27 22:43:45 +00002164// Emit the last address of the section and the end of the line matrix.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002165void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002166 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00002167 Asm->OutStreamer.AddComment("Extended Op");
2168 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002169
Chris Lattner233f52b2010-03-09 23:52:58 +00002170 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002171 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00002172 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2173 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2174
2175 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00002176
Chris Lattnerc0215722010-04-04 19:25:43 +00002177 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Eric Christopherca1dd052013-01-09 01:35:34 +00002178 Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002179
2180 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00002181 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2182 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00002183 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00002184 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00002185}
2186
Eric Christopherb6dc8652012-11-27 22:43:45 +00002187// Emit visible names into a hashed accelerator table section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002188void DwarfDebug::emitAccelNames() {
2189 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2190 dwarf::DW_FORM_data4));
2191 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2192 E = CUMap.end(); I != E; ++I) {
2193 CompileUnit *TheCU = I->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00002194 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2195 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002196 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002197 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002198 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00002199 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2200 DE = Entities.end(); DI != DE; ++DI)
2201 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00002202 }
2203 }
2204
2205 AT.FinalizeTable(Asm, "Names");
2206 Asm->OutStreamer.SwitchSection(
2207 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2208 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2209 Asm->OutStreamer.EmitLabel(SectionBegin);
2210
2211 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002212 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002213}
2214
Eric Christopher72c16552012-12-20 21:58:40 +00002215// Emit objective C classes and categories into a hashed accelerator table
2216// section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002217void DwarfDebug::emitAccelObjC() {
2218 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2219 dwarf::DW_FORM_data4));
2220 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2221 E = CUMap.end(); I != E; ++I) {
2222 CompileUnit *TheCU = I->second;
2223 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2224 for (StringMap<std::vector<DIE*> >::const_iterator
2225 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002226 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002227 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher09ac3d82011-11-07 09:24:32 +00002228 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2229 DE = Entities.end(); DI != DE; ++DI)
2230 AT.AddName(Name, (*DI));
2231 }
2232 }
2233
2234 AT.FinalizeTable(Asm, "ObjC");
2235 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2236 .getDwarfAccelObjCSection());
2237 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2238 Asm->OutStreamer.EmitLabel(SectionBegin);
2239
2240 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002241 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002242}
2243
Eric Christopherb6dc8652012-11-27 22:43:45 +00002244// Emit namespace dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002245void DwarfDebug::emitAccelNamespaces() {
2246 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2247 dwarf::DW_FORM_data4));
2248 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2249 E = CUMap.end(); I != E; ++I) {
2250 CompileUnit *TheCU = I->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00002251 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2252 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002253 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002254 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002255 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00002256 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2257 DE = Entities.end(); DI != DE; ++DI)
2258 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00002259 }
2260 }
2261
2262 AT.FinalizeTable(Asm, "namespac");
2263 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2264 .getDwarfAccelNamespaceSection());
2265 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2266 Asm->OutStreamer.EmitLabel(SectionBegin);
2267
2268 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002269 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002270}
2271
Eric Christopherb6dc8652012-11-27 22:43:45 +00002272// Emit type dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002273void DwarfDebug::emitAccelTypes() {
Eric Christopherc36145f2012-01-06 04:35:23 +00002274 std::vector<DwarfAccelTable::Atom> Atoms;
2275 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2276 dwarf::DW_FORM_data4));
2277 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTag,
2278 dwarf::DW_FORM_data2));
2279 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTypeFlags,
2280 dwarf::DW_FORM_data1));
2281 DwarfAccelTable AT(Atoms);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002282 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2283 E = CUMap.end(); I != E; ++I) {
2284 CompileUnit *TheCU = I->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002285 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2286 = TheCU->getAccelTypes();
2287 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002288 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002289 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002290 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002291 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2292 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2293 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002294 }
2295 }
2296
2297 AT.FinalizeTable(Asm, "types");
2298 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2299 .getDwarfAccelTypesSection());
2300 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2301 Asm->OutStreamer.EmitLabel(SectionBegin);
2302
2303 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002304 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002305}
2306
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002307/// emitDebugPubnames - Emit visible names into a debug pubnames section.
2308///
2309void DwarfDebug::emitDebugPubnames() {
2310 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2311
2312 typedef DenseMap<const MDNode*, CompileUnit*> CUMapType;
2313 for (CUMapType::iterator I = CUMap.begin(), E = CUMap.end(); I != E; ++I) {
2314 CompileUnit *TheCU = I->second;
2315 unsigned ID = TheCU->getUniqueID();
2316
2317 if (TheCU->getGlobalNames().empty())
2318 continue;
2319
2320 // Start the dwarf pubnames section.
Eric Christopherf04e4ef2013-08-19 21:07:38 +00002321 Asm->OutStreamer
2322 .SwitchSection(Asm->getObjFileLowering().getDwarfPubNamesSection());
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002323
2324 Asm->OutStreamer.AddComment("Length of Public Names Info");
2325 Asm->EmitLabelDifference(Asm->GetTempSymbol("pubnames_end", ID),
2326 Asm->GetTempSymbol("pubnames_begin", ID), 4);
2327
2328 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin", ID));
2329
2330 Asm->OutStreamer.AddComment("DWARF Version");
Manman Ren0e6783f2013-07-02 23:40:10 +00002331 Asm->EmitInt16(DwarfVersion);
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002332
2333 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2334 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2335 DwarfInfoSectionSym);
2336
2337 Asm->OutStreamer.AddComment("Compilation Unit Length");
2338 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(), ID),
2339 Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2340 4);
2341
2342 const StringMap<DIE*> &Globals = TheCU->getGlobalNames();
2343 for (StringMap<DIE*>::const_iterator
2344 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2345 const char *Name = GI->getKeyData();
2346 const DIE *Entity = GI->second;
2347
2348 Asm->OutStreamer.AddComment("DIE offset");
2349 Asm->EmitInt32(Entity->getOffset());
2350
2351 if (Asm->isVerbose())
2352 Asm->OutStreamer.AddComment("External Name");
Rafael Espindolaa3863ea2013-07-02 15:49:13 +00002353 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002354 }
2355
2356 Asm->OutStreamer.AddComment("End Mark");
2357 Asm->EmitInt32(0);
2358 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end", ID));
2359 }
2360}
2361
Devang Patel193f7202009-11-24 01:14:22 +00002362void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00002363 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2364 E = CUMap.end(); I != E; ++I) {
2365 CompileUnit *TheCU = I->second;
Eric Christopher63701182011-11-07 09:18:35 +00002366 // Start the dwarf pubtypes section.
Devang Patel163a9f72010-05-10 22:49:55 +00002367 Asm->OutStreamer.SwitchSection(
2368 Asm->getObjFileLowering().getDwarfPubTypesSection());
2369 Asm->OutStreamer.AddComment("Length of Public Types Info");
2370 Asm->EmitLabelDifference(
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002371 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2372 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002373
Devang Patel163a9f72010-05-10 22:49:55 +00002374 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002375 TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002376
Devang Patel163a9f72010-05-10 22:49:55 +00002377 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
Manman Ren0e6783f2013-07-02 23:40:10 +00002378 Asm->EmitInt16(DwarfVersion);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002379
Devang Patel163a9f72010-05-10 22:49:55 +00002380 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eric Christophercf6b8ad2012-12-15 00:04:04 +00002381 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2382 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002383 TheCU->getUniqueID()),
Devang Patel163a9f72010-05-10 22:49:55 +00002384 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002385
Devang Patel163a9f72010-05-10 22:49:55 +00002386 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eric Christophercf6b8ad2012-12-15 00:04:04 +00002387 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002388 TheCU->getUniqueID()),
Eric Christophercf6b8ad2012-12-15 00:04:04 +00002389 Asm->GetTempSymbol(ISec->getLabelBeginName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002390 TheCU->getUniqueID()),
Devang Patel163a9f72010-05-10 22:49:55 +00002391 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002392
Devang Patel163a9f72010-05-10 22:49:55 +00002393 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
2394 for (StringMap<DIE*>::const_iterator
2395 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2396 const char *Name = GI->getKeyData();
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00002397 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002398
Devang Patel163a9f72010-05-10 22:49:55 +00002399 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
2400 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002401
Devang Patel163a9f72010-05-10 22:49:55 +00002402 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
Benjamin Kramer983c4572011-11-09 18:16:11 +00002403 // Emit the name with a terminating null byte.
Eric Christopher68ca5622013-01-09 01:57:54 +00002404 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Devang Patel163a9f72010-05-10 22:49:55 +00002405 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002406
Devang Patel163a9f72010-05-10 22:49:55 +00002407 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00002408 Asm->EmitInt32(0);
Devang Patel163a9f72010-05-10 22:49:55 +00002409 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002410 TheCU->getUniqueID()));
Devang Patel193f7202009-11-24 01:14:22 +00002411 }
Devang Patel193f7202009-11-24 01:14:22 +00002412}
2413
Eric Christopher64f824c2012-12-27 02:14:01 +00002414// Emit strings into a string section.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002415void DwarfUnits::emitStrings(const MCSection *StrSection,
2416 const MCSection *OffsetSection = NULL,
2417 const MCSymbol *StrSecSym = NULL) {
Eric Christopher64f824c2012-12-27 02:14:01 +00002418
Eric Christopherb6714222013-01-08 22:22:06 +00002419 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002420
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002421 // Start the dwarf str section.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002422 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling94d04b82009-05-20 23:21:38 +00002423
Chris Lattnerbc733f52010-03-13 02:17:42 +00002424 // Get all of the string pool entries and put them in an array by their ID so
2425 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002426 SmallVector<std::pair<unsigned,
Eric Christopherff348452013-01-07 22:40:45 +00002427 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002428
Chris Lattnerbc733f52010-03-13 02:17:42 +00002429 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
Eric Christopherb6714222013-01-08 22:22:06 +00002430 I = StringPool.begin(), E = StringPool.end();
Eric Christopher72c16552012-12-20 21:58:40 +00002431 I != E; ++I)
Chris Lattnerbc733f52010-03-13 02:17:42 +00002432 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002433
Chris Lattnerbc733f52010-03-13 02:17:42 +00002434 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002435
Chris Lattnerbc733f52010-03-13 02:17:42 +00002436 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002437 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00002438 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002439
Benjamin Kramer983c4572011-11-09 18:16:11 +00002440 // Emit the string itself with a terminating null byte.
Benjamin Kramer0c45f7d2011-11-09 12:12:04 +00002441 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
Eric Christopherca1dd052013-01-09 01:35:34 +00002442 Entries[i].second->getKeyLength()+1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002443 }
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002444
2445 // If we've got an offset section go ahead and emit that now as well.
2446 if (OffsetSection) {
2447 Asm->OutStreamer.SwitchSection(OffsetSection);
2448 unsigned offset = 0;
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002449 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002450 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopher1ced2082013-01-09 03:52:05 +00002451 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002452 offset += Entries[i].second->getKeyLength() + 1;
2453 }
2454 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002455}
2456
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002457// Emit strings into a string section.
2458void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2459
2460 if (AddressPool.empty()) return;
2461
2462 // Start the dwarf addr section.
2463 Asm->OutStreamer.SwitchSection(AddrSection);
2464
David Blaikie66f464e2013-07-08 17:51:28 +00002465 // Order the address pool entries by ID
David Blaikie5ce40912013-07-08 17:33:10 +00002466 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002467
David Blaikie66f464e2013-07-08 17:51:28 +00002468 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2469 E = AddressPool.end();
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002470 I != E; ++I)
David Blaikie5ce40912013-07-08 17:33:10 +00002471 Entries[I->second] = I->first;
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002472
2473 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Ulrich Weigand18dbe502013-07-02 18:46:46 +00002474 // Emit an expression for reference from debug information entries.
David Blaikie5ce40912013-07-08 17:33:10 +00002475 if (const MCExpr *Expr = Entries[i])
Ulrich Weigand18dbe502013-07-02 18:46:46 +00002476 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002477 else
2478 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2479 }
2480
2481}
2482
Eric Christopher64f824c2012-12-27 02:14:01 +00002483// Emit visible names into a debug str section.
2484void DwarfDebug::emitDebugStr() {
2485 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2486 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2487}
2488
Eric Christopherd3b98532013-07-02 21:36:07 +00002489// Emit locations into the debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002490void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00002491 if (DotDebugLocEntries.empty())
2492 return;
2493
Eric Christopherf7cef702013-03-29 23:34:06 +00002494 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Devang Patel6c3ea902011-02-04 22:57:18 +00002495 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2496 I != E; ++I) {
2497 DotDebugLocEntry &Entry = *I;
2498 if (I + 1 != DotDebugLocEntries.end())
2499 Entry.Merge(I+1);
2500 }
2501
Daniel Dunbar83320a02011-03-16 22:16:39 +00002502 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002503 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00002504 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002505 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00002506 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2507 unsigned index = 1;
Eric Christopherf7cef702013-03-29 23:34:06 +00002508 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00002509 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00002510 I != E; ++I, ++index) {
Devang Patel6c3ea902011-02-04 22:57:18 +00002511 DotDebugLocEntry &Entry = *I;
2512 if (Entry.isMerged()) continue;
Devang Patelc3f5f782010-05-25 23:40:22 +00002513 if (Entry.isEmpty()) {
Eric Christopherca1dd052013-01-09 01:35:34 +00002514 Asm->OutStreamer.EmitIntValue(0, Size);
2515 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel80250682010-05-26 23:55:23 +00002516 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00002517 } else {
Eric Christopher0d0782a2013-07-03 22:40:18 +00002518 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2519 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2520 DIVariable DV(Entry.getVariable());
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002521 Asm->OutStreamer.AddComment("Loc expr size");
2522 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2523 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2524 Asm->EmitLabelDifference(end, begin, 2);
2525 Asm->OutStreamer.EmitLabel(begin);
Devang Patel80efd4e2011-07-08 16:49:43 +00002526 if (Entry.isInt()) {
Devang Patelc4329072011-06-01 22:03:25 +00002527 DIBasicType BTy(DV.getType());
2528 if (BTy.Verify() &&
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002529 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patelc4329072011-06-01 22:03:25 +00002530 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2531 Asm->OutStreamer.AddComment("DW_OP_consts");
2532 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Patel80efd4e2011-07-08 16:49:43 +00002533 Asm->EmitSLEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002534 } else {
2535 Asm->OutStreamer.AddComment("DW_OP_constu");
2536 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Patel80efd4e2011-07-08 16:49:43 +00002537 Asm->EmitULEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002538 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002539 } else if (Entry.isLocation()) {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002540 MachineLocation Loc = Entry.getLoc();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002541 if (!DV.hasComplexAddress())
Devang Patel80efd4e2011-07-08 16:49:43 +00002542 // Regular entry.
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002543 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002544 else {
2545 // Complex address entry.
2546 unsigned N = DV.getNumAddrElements();
2547 unsigned i = 0;
2548 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002549 if (Loc.getOffset()) {
Devang Patel80efd4e2011-07-08 16:49:43 +00002550 i = 2;
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002551 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002552 Asm->OutStreamer.AddComment("DW_OP_deref");
2553 Asm->EmitInt8(dwarf::DW_OP_deref);
2554 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2555 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2556 Asm->EmitSLEB128(DV.getAddrElement(1));
2557 } else {
2558 // If first address element is OpPlus then emit
2559 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002560 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2561 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002562 i = 2;
2563 }
2564 } else {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002565 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002566 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002567
Devang Patel80efd4e2011-07-08 16:49:43 +00002568 // Emit remaining complex address elements.
2569 for (; i < N; ++i) {
2570 uint64_t Element = DV.getAddrElement(i);
2571 if (Element == DIBuilder::OpPlus) {
2572 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2573 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher50120762012-05-08 18:56:00 +00002574 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002575 if (!Loc.isReg())
Eric Christopher50120762012-05-08 18:56:00 +00002576 Asm->EmitInt8(dwarf::DW_OP_deref);
2577 } else
2578 llvm_unreachable("unknown Opcode found in complex address");
Devang Patel80efd4e2011-07-08 16:49:43 +00002579 }
Devang Patelc26f5442011-04-28 02:22:40 +00002580 }
Devang Patelc26f5442011-04-28 02:22:40 +00002581 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002582 // else ... ignore constant fp. There is not any good way to
2583 // to represent them here in dwarf.
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002584 Asm->OutStreamer.EmitLabel(end);
Devang Patelc3f5f782010-05-25 23:40:22 +00002585 }
2586 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002587}
2588
Eric Christopherb6dc8652012-11-27 22:43:45 +00002589// Emit visible names into a debug aranges section.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002590void DwarfDebug::emitDebugARanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002591 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002592 Asm->OutStreamer.SwitchSection(
2593 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002594}
2595
Eric Christopherb6dc8652012-11-27 22:43:45 +00002596// Emit visible names into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002597void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002598 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002599 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00002600 Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002601 unsigned char Size = Asm->getDataLayout().getPointerSize();
Eric Christopherf7cef702013-03-29 23:34:06 +00002602 for (SmallVectorImpl<const MCSymbol *>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00002603 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00002604 I != E; ++I) {
2605 if (*I)
Eric Christopher1ced2082013-01-09 03:52:05 +00002606 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
Devang Patelf2548ca2010-04-16 23:33:45 +00002607 else
Eric Christopherca1dd052013-01-09 01:35:34 +00002608 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patelf2548ca2010-04-16 23:33:45 +00002609 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002610}
2611
Eric Christopherb6dc8652012-11-27 22:43:45 +00002612// Emit visible names into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002613void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002614 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00002615 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002616 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002617 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002618 }
2619}
2620
Eric Christopherb6dc8652012-11-27 22:43:45 +00002621// Emit inline info using following format.
2622// Section Header:
2623// 1. length of section
2624// 2. Dwarf version number
2625// 3. address size.
2626//
2627// Entries (one "entry" for each function that was inlined):
2628//
2629// 1. offset into __debug_str section for MIPS linkage name, if exists;
2630// otherwise offset into __debug_str for regular function name.
2631// 2. offset into __debug_str section for regular function name.
2632// 3. an unsigned LEB128 number indicating the number of distinct inlining
2633// instances for the function.
2634//
2635// The rest of the entry consists of a {die_offset, low_pc} pair for each
2636// inlined instance; the die_offset points to the inlined_subroutine die in the
2637// __debug_info section, and the low_pc is the starting address for the
2638// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002639void DwarfDebug::emitDebugInlineInfo() {
Eric Christopherb83e2bb2012-03-02 02:11:47 +00002640 if (!Asm->MAI->doesDwarfUseInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002641 return;
2642
Devang Patel163a9f72010-05-10 22:49:55 +00002643 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00002644 return;
2645
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002646 Asm->OutStreamer.SwitchSection(
2647 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00002648
Chris Lattner233f52b2010-03-09 23:52:58 +00002649 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00002650 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
2651 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00002652
Chris Lattnerc0215722010-04-04 19:25:43 +00002653 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002654
Chris Lattner233f52b2010-03-09 23:52:58 +00002655 Asm->OutStreamer.AddComment("Dwarf Version");
Manman Ren0e6783f2013-07-02 23:40:10 +00002656 Asm->EmitInt16(DwarfVersion);
Chris Lattner233f52b2010-03-09 23:52:58 +00002657 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002658 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002659
Eric Christopherf7cef702013-03-29 23:34:06 +00002660 for (SmallVectorImpl<const MDNode *>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00002661 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002662
Devang Patele9f8f5e2010-05-07 20:54:48 +00002663 const MDNode *Node = *I;
Craig Topper01eb99a2013-07-03 04:40:27 +00002664 InlineInfoMap::iterator II = InlineInfo.find(Node);
Eric Christopherf7cef702013-03-29 23:34:06 +00002665 SmallVectorImpl<InlineInfoLabels> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00002666 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00002667 StringRef LName = SP.getLinkageName();
2668 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00002669
Chris Lattner233f52b2010-03-09 23:52:58 +00002670 Asm->OutStreamer.AddComment("MIPS linkage name");
Eric Christopher50e26612012-03-02 01:57:52 +00002671 if (LName.empty())
Eric Christopher2e5d8702012-12-20 21:58:36 +00002672 Asm->EmitSectionOffset(InfoHolder.getStringPoolEntry(Name),
2673 DwarfStrSectionSym);
Eric Christopher50e26612012-03-02 01:57:52 +00002674 else
Benjamin Kramer7c2b4be2013-06-01 17:51:14 +00002675 Asm->EmitSectionOffset(
2676 InfoHolder.getStringPoolEntry(Function::getRealLinkageName(LName)),
2677 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00002678
Chris Lattner233f52b2010-03-09 23:52:58 +00002679 Asm->OutStreamer.AddComment("Function name");
Eric Christopher2e5d8702012-12-20 21:58:36 +00002680 Asm->EmitSectionOffset(InfoHolder.getStringPoolEntry(Name),
2681 DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002682 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00002683
Eric Christopherf7cef702013-03-29 23:34:06 +00002684 for (SmallVectorImpl<InlineInfoLabels>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00002685 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00002686 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00002687 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00002688
Chris Lattner3f53c832010-04-04 18:52:31 +00002689 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00002690 Asm->OutStreamer.EmitSymbolValue(LI->first,
Eric Christopher1ced2082013-01-09 03:52:05 +00002691 Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002692 }
2693 }
2694
Chris Lattnerc0215722010-04-04 19:25:43 +00002695 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002696}
Eric Christopher98e237f2012-11-30 23:59:06 +00002697
Eric Christopher0b944ee2012-12-11 19:42:09 +00002698// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher98e237f2012-11-30 23:59:06 +00002699
2700// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2701// DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2702// DW_AT_ranges_base, DW_AT_addr_base. If DW_AT_ranges is present,
2703// DW_AT_low_pc and DW_AT_high_pc are not used, and vice versa.
Eric Christopher4daaed12012-12-10 19:51:21 +00002704CompileUnit *DwarfDebug::constructSkeletonCU(const MDNode *N) {
Eric Christopher98e237f2012-11-30 23:59:06 +00002705 DICompileUnit DIUnit(N);
Eric Christopher98e237f2012-11-30 23:59:06 +00002706 CompilationDir = DIUnit.getDirectory();
Eric Christopher98e237f2012-11-30 23:59:06 +00002707
2708 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002709 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
Eric Christopher9c57ad22013-05-08 00:58:51 +00002710 DIUnit.getLanguage(), Die, N, Asm,
Eric Christopher64f824c2012-12-27 02:14:01 +00002711 this, &SkeletonHolder);
Eric Christopher446b88f2013-01-17 03:00:04 +00002712
Eric Christopher3ce51a92013-02-22 23:50:08 +00002713 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
2714 DIUnit.getSplitDebugFilename());
Eric Christopher98e237f2012-11-30 23:59:06 +00002715
Eric Christopher1b0cd2f2013-04-22 07:51:08 +00002716 // Relocate to the beginning of the addr_base section, else 0 for the
2717 // beginning of the one for this compile unit.
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002718 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2719 NewCU->addLabel(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2720 DwarfAddrSectionSym);
2721 else
Eric Christopher1b0cd2f2013-04-22 07:51:08 +00002722 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base,
2723 dwarf::DW_FORM_sec_offset, 0);
Eric Christopher98e237f2012-11-30 23:59:06 +00002724
2725 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002726 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher98e237f2012-11-30 23:59:06 +00002727 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002728
Eric Christopher98e237f2012-11-30 23:59:06 +00002729 // DW_AT_stmt_list is a offset of line number information for this
2730 // compile unit in debug_line section.
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002731 // FIXME: Should handle multiple compile units.
Eric Christopher98e237f2012-11-30 23:59:06 +00002732 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher446b88f2013-01-17 03:00:04 +00002733 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher7a0103c2013-02-07 21:19:50 +00002734 DwarfLineSectionSym);
Eric Christopher98e237f2012-11-30 23:59:06 +00002735 else
Eric Christopher446b88f2013-01-17 03:00:04 +00002736 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher98e237f2012-11-30 23:59:06 +00002737
2738 if (!CompilationDir.empty())
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002739 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher98e237f2012-11-30 23:59:06 +00002740
Eric Christopher0e3e9b72012-12-10 23:34:43 +00002741 SkeletonHolder.addUnit(NewCU);
Eric Christopher01776a52013-02-06 21:53:56 +00002742 SkeletonCUs.push_back(NewCU);
Eric Christopher0e3e9b72012-12-10 23:34:43 +00002743
Eric Christopher98e237f2012-11-30 23:59:06 +00002744 return NewCU;
2745}
2746
Eric Christopher6eebe472012-12-19 22:02:53 +00002747void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
2748 assert(useSplitDwarf() && "No split dwarf debug info?");
2749 emitAbbrevs(Section, &SkeletonAbbrevs);
Eric Christopher98e237f2012-11-30 23:59:06 +00002750}
2751
Eric Christopher0b944ee2012-12-11 19:42:09 +00002752// Emit the .debug_info.dwo section for separated dwarf. This contains the
2753// compile units that would normally be in debug_info.
Eric Christopher98e237f2012-11-30 23:59:06 +00002754void DwarfDebug::emitDebugInfoDWO() {
Eric Christopher4daaed12012-12-10 19:51:21 +00002755 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christopherb1e66d02012-12-15 00:04:07 +00002756 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
Eric Christopher6eebe472012-12-19 22:02:53 +00002757 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2758 DwarfAbbrevDWOSectionSym);
2759}
2760
2761// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2762// abbreviations for the .debug_info.dwo section.
2763void DwarfDebug::emitDebugAbbrevDWO() {
2764 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopher72c16552012-12-20 21:58:40 +00002765 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2766 &Abbreviations);
Eric Christopher98e237f2012-11-30 23:59:06 +00002767}
Eric Christopher64f824c2012-12-27 02:14:01 +00002768
2769// Emit the .debug_str.dwo section for separated dwarf. This contains the
2770// string section and is identical in format to traditional .debug_str
2771// sections.
2772void DwarfDebug::emitDebugStrDWO() {
2773 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherff348452013-01-07 22:40:45 +00002774 const MCSection *OffSec = Asm->getObjFileLowering()
2775 .getDwarfStrOffDWOSection();
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002776 const MCSymbol *StrSym = DwarfStrSectionSym;
2777 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
2778 OffSec, StrSym);
Eric Christopher64f824c2012-12-27 02:14:01 +00002779}