blob: dd2bcf2daedbfb9d099913e2e1b2a43aa93db6c7 [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"
David Majnemerd7d43dc2013-08-21 06:13:34 +000038#include "llvm/Support/Dwarf.h"
Daniel Dunbar6e4bdfc2009-10-13 06:47:08 +000039#include "llvm/Support/ErrorHandling.h"
Chris Lattner0ad9c912010-01-22 22:09:00 +000040#include "llvm/Support/FormattedStream.h"
Eric Christopher3dee5752013-07-26 17:02:41 +000041#include "llvm/Support/MD5.h"
Michael J. Spencer1f6efa32010-11-29 18:16:10 +000042#include "llvm/Support/Path.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000043#include "llvm/Support/Timer.h"
44#include "llvm/Support/ValueHandle.h"
45#include "llvm/Target/TargetFrameLowering.h"
46#include "llvm/Target/TargetLoweringObjectFile.h"
47#include "llvm/Target/TargetMachine.h"
48#include "llvm/Target/TargetOptions.h"
49#include "llvm/Target/TargetRegisterInfo.h"
Bill Wendling0310d762009-05-15 09:23:25 +000050using namespace llvm;
51
Eric Christopher6e61e0b2013-07-23 22:16:41 +000052static cl::opt<bool>
53DisableDebugInfoPrinting("disable-debug-info-print", cl::Hidden,
54 cl::desc("Disable debug info printing"));
Devang Pateleac9c072010-04-27 19:46:33 +000055
Eric Christopher6e61e0b2013-07-23 22:16:41 +000056static cl::opt<bool> UnknownLocations(
57 "use-unknown-locations", cl::Hidden,
58 cl::desc("Make an absence of debug location information explicit."),
59 cl::init(false));
Dan Gohman281d65d2010-05-07 01:08:53 +000060
Eric Christopher6e61e0b2013-07-23 22:16:41 +000061static cl::opt<bool>
Eric Christopher3dee5752013-07-26 17:02:41 +000062GenerateODRHash("generate-odr-hash", cl::Hidden,
63 cl::desc("Add an ODR hash to external type DIEs."),
64 cl::init(false));
65
Eric Christopher0710bfa2013-08-13 01:21:55 +000066static cl::opt<bool>
67GenerateCUHash("generate-cu-hash", cl::Hidden,
68 cl::desc("Add the CU hash as the dwo_id."),
69 cl::init(false));
70
Eric Christopher8f1a9292013-09-13 00:35:05 +000071static cl::opt<bool>
72GenerateGnuPubSections("generate-gnu-dwarf-pub-sections", cl::Hidden,
73 cl::desc("Generate GNU-style pubnames and pubtypes"),
74 cl::init(false));
75
Eric Christopher20f47ab2012-08-23 22:36:40 +000076namespace {
Eric Christopher6e61e0b2013-07-23 22:16:41 +000077enum DefaultOnOff {
78 Default,
79 Enable,
80 Disable
81};
Eric Christopher20f47ab2012-08-23 22:36:40 +000082}
Eric Christopher09ac3d82011-11-07 09:24:32 +000083
Eric Christopher6e61e0b2013-07-23 22:16:41 +000084static cl::opt<DefaultOnOff>
85DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
86 cl::desc("Output prototype dwarf accelerator tables."),
87 cl::values(clEnumVal(Default, "Default for platform"),
88 clEnumVal(Enable, "Enabled"),
89 clEnumVal(Disable, "Disabled"), clEnumValEnd),
90 cl::init(Default));
Eric Christopher20f47ab2012-08-23 22:36:40 +000091
Eric Christopher6e61e0b2013-07-23 22:16:41 +000092static cl::opt<DefaultOnOff>
Eric Christopher6e61e0b2013-07-23 22:16:41 +000093SplitDwarf("split-dwarf", cl::Hidden,
94 cl::desc("Output prototype dwarf split debug info."),
95 cl::values(clEnumVal(Default, "Default for platform"),
96 clEnumVal(Enable, "Enabled"),
97 clEnumVal(Disable, "Disabled"), clEnumValEnd),
98 cl::init(Default));
Eric Christopherf5b6dcd2012-11-12 22:22:20 +000099
Eric Christopherf04e4ef2013-08-19 21:07:38 +0000100static cl::opt<DefaultOnOff>
Eric Christopher63ae7c92013-08-26 23:24:35 +0000101DwarfPubSections("generate-dwarf-pub-sections", cl::Hidden,
102 cl::desc("Generate DWARF pubnames and pubtypes sections"),
103 cl::values(clEnumVal(Default, "Default for platform"),
104 clEnumVal(Enable, "Enabled"),
105 clEnumVal(Disable, "Disabled"), clEnumValEnd),
106 cl::init(Default));
Eric Christopherf04e4ef2013-08-19 21:07:38 +0000107
Benjamin Kramer0b6962f2013-08-24 12:54:27 +0000108static const char *const DWARFGroupName = "DWARF Emission";
109static const char *const DbgTimerName = "DWARF Debug Writer";
Bill Wendling5f017e82010-04-07 09:28:04 +0000110
Bill Wendling0310d762009-05-15 09:23:25 +0000111//===----------------------------------------------------------------------===//
112
Eric Christopherb6dc8652012-11-27 22:43:45 +0000113// Configuration values for initial hash set sizes (log2).
114//
Bill Wendling0310d762009-05-15 09:23:25 +0000115static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling0310d762009-05-15 09:23:25 +0000116
117namespace llvm {
118
Manman Ren8199f0b2013-10-08 19:07:44 +0000119/// resolve - Look in the DwarfDebug map for the MDNode that
120/// corresponds to the reference.
121template <typename T>
122T DbgVariable::resolve(DIRef<T> Ref) const {
123 return DD->resolve(Ref);
124}
125
Nick Lewycky3bbb6f72011-07-29 03:49:23 +0000126DIType DbgVariable::getType() const {
Devang Patel3cbee302011-04-12 22:53:02 +0000127 DIType Ty = Var.getType();
128 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
129 // addresses instead.
130 if (Var.isBlockByrefVariable()) {
131 /* Byref variables, in Blocks, are declared by the programmer as
132 "SomeType VarName;", but the compiler creates a
133 __Block_byref_x_VarName struct, and gives the variable VarName
134 either the struct, or a pointer to the struct, as its type. This
135 is necessary for various behind-the-scenes things the compiler
136 needs to do with by-reference variables in blocks.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000137
Devang Patel3cbee302011-04-12 22:53:02 +0000138 However, as far as the original *programmer* is concerned, the
139 variable should still have type 'SomeType', as originally declared.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000140
Devang Patel3cbee302011-04-12 22:53:02 +0000141 The following function dives into the __Block_byref_x_VarName
142 struct to find the original type of the variable. This will be
143 passed back to the code generating the type for the Debug
144 Information Entry for the variable 'VarName'. 'VarName' will then
145 have the original type 'SomeType' in its debug information.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000146
Devang Patel3cbee302011-04-12 22:53:02 +0000147 The original type 'SomeType' will be the type of the field named
148 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000149
Devang Patel3cbee302011-04-12 22:53:02 +0000150 NOTE: In order for this to not completely fail on the debugger
151 side, the Debug Information Entry for the variable VarName needs to
152 have a DW_AT_location that tells the debugger how to unwind through
153 the pointers and __Block_byref_x_VarName struct to find the actual
154 value of the variable. The function addBlockByrefType does this. */
155 DIType subType = Ty;
Eric Christopher31667622013-08-08 01:41:00 +0000156 uint16_t tag = Ty.getTag();
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000157
Eric Christopher4dc211a2013-09-04 19:53:21 +0000158 if (tag == dwarf::DW_TAG_pointer_type)
Manman Ren8199f0b2013-10-08 19:07:44 +0000159 subType = resolve(DIDerivedType(Ty).getTypeDerivedFrom());
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000160
Eric Christopher4dc211a2013-09-04 19:53:21 +0000161 DIArray Elements = DICompositeType(subType).getTypeArray();
Devang Patel3cbee302011-04-12 22:53:02 +0000162 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
Eric Christopher4dc211a2013-09-04 19:53:21 +0000163 DIDerivedType DT = DIDerivedType(Elements.getElement(i));
Devang Patel3cbee302011-04-12 22:53:02 +0000164 if (getName() == DT.getName())
Manman Ren8199f0b2013-10-08 19:07:44 +0000165 return (resolve(DT.getTypeDerivedFrom()));
Devang Patel8bd11de2010-08-09 21:01:39 +0000166 }
Devang Patel8bd11de2010-08-09 21:01:39 +0000167 }
Devang Patel3cbee302011-04-12 22:53:02 +0000168 return Ty;
169}
Bill Wendling0310d762009-05-15 09:23:25 +0000170
Chris Lattnerea761862010-04-05 04:09:20 +0000171} // end llvm namespace
Bill Wendling0310d762009-05-15 09:23:25 +0000172
Manman Ren0e6783f2013-07-02 23:40:10 +0000173/// Return Dwarf Version by checking module flags.
174static unsigned getDwarfVersionFromModule(const Module *M) {
Manman Renc8cfaa12013-07-16 23:21:16 +0000175 Value *Val = M->getModuleFlag("Dwarf Version");
176 if (!Val)
Eric Christopherefc47ec2013-09-04 22:21:24 +0000177 return dwarf::DWARF_VERSION;
Manman Renc8cfaa12013-07-16 23:21:16 +0000178 return cast<ConstantInt>(Val)->getZExtValue();
Manman Ren0e6783f2013-07-02 23:40:10 +0000179}
180
Chris Lattner49cd6642010-04-05 05:11:15 +0000181DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Eric Christopher28bd25a2012-12-10 19:51:13 +0000182 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbach1e20b962010-07-21 21:21:52 +0000183 AbbreviationsSet(InitAbbreviationsSetSize),
Eric Christopherb6714222013-01-08 22:22:06 +0000184 SourceIdMap(DIEValueAllocator),
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000185 PrevLabel(NULL), GlobalCUIndexCount(0),
Eric Christopherb6714222013-01-08 22:22:06 +0000186 InfoHolder(A, &AbbreviationsSet, &Abbreviations, "info_string",
187 DIEValueAllocator),
Eric Christopher6eebe472012-12-19 22:02:53 +0000188 SkeletonAbbrevSet(InitAbbreviationsSetSize),
Eric Christopherb6714222013-01-08 22:22:06 +0000189 SkeletonHolder(A, &SkeletonAbbrevSet, &SkeletonAbbrevs, "skel_string",
190 DIEValueAllocator) {
Jim Grosbach1e20b962010-07-21 21:21:52 +0000191
Rafael Espindolaf2b04232011-05-06 14:56:22 +0000192 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattner4ad1efe2010-04-04 23:10:38 +0000193 DwarfStrSectionSym = TextSectionSym = 0;
Eric Christopher7a0103c2013-02-07 21:19:50 +0000194 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
Eric Christopher9a9e73b2013-04-07 03:43:09 +0000195 DwarfAddrSectionSym = 0;
Eric Christopher64f824c2012-12-27 02:14:01 +0000196 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
Devang Patelc3f5f782010-05-25 23:40:22 +0000197 FunctionBeginSym = FunctionEndSym = 0;
Eric Christopher60777d82012-04-02 17:58:52 +0000198
Adrian Prantl73df4b92013-10-15 20:26:37 +0000199 // Turn on accelerator tables for Darwin by default, pubnames by
200 // default for non-Darwin, and handle split dwarf.
Eric Christopher00297ba2013-04-27 01:07:52 +0000201 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
Eric Christopherc1610fa2012-08-23 22:36:36 +0000202
Eric Christopher05bae3b2013-08-19 21:41:38 +0000203 if (DwarfAccelTables == Default)
204 HasDwarfAccelTables = IsDarwin;
205 else
Eric Christopher03be5e52013-08-26 20:58:35 +0000206 HasDwarfAccelTables = DwarfAccelTables == Enable;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000207
Eric Christopher4daaed12012-12-10 19:51:21 +0000208 if (SplitDwarf == Default)
209 HasSplitDwarf = false;
Eric Christopherf5b6dcd2012-11-12 22:22:20 +0000210 else
Eric Christopher05bae3b2013-08-19 21:41:38 +0000211 HasSplitDwarf = SplitDwarf == Enable;
Eric Christopherf5b6dcd2012-11-12 22:22:20 +0000212
Eric Christopher63ae7c92013-08-26 23:24:35 +0000213 if (DwarfPubSections == Default)
214 HasDwarfPubSections = !IsDarwin;
Eric Christopher05bae3b2013-08-19 21:41:38 +0000215 else
Eric Christopher63ae7c92013-08-26 23:24:35 +0000216 HasDwarfPubSections = DwarfPubSections == Enable;
Eric Christopherf04e4ef2013-08-19 21:07:38 +0000217
Manman Ren0e6783f2013-07-02 23:40:10 +0000218 DwarfVersion = getDwarfVersionFromModule(MMI->getModule());
219
Dan Gohman03c3dc72010-06-18 15:56:31 +0000220 {
221 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopherc4639d62012-11-19 22:42:15 +0000222 beginModule();
Torok Edwin9c421072010-04-07 10:44:46 +0000223 }
Bill Wendling0310d762009-05-15 09:23:25 +0000224}
Bill Wendling0310d762009-05-15 09:23:25 +0000225
Eric Christopherb6dc8652012-11-27 22:43:45 +0000226// Switch to the specified MCSection and emit an assembler
227// temporary label to it if SymbolStem is specified.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000228static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christopherd8a87522011-11-07 09:18:38 +0000229 const char *SymbolStem = 0) {
230 Asm->OutStreamer.SwitchSection(Section);
231 if (!SymbolStem) return 0;
232
233 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
234 Asm->OutStreamer.EmitLabel(TmpSym);
235 return TmpSym;
236}
237
Eric Christopher2e5d8702012-12-20 21:58:36 +0000238MCSymbol *DwarfUnits::getStringPoolSym() {
Eric Christopher64f824c2012-12-27 02:14:01 +0000239 return Asm->GetTempSymbol(StringPref);
Nick Lewycky390c40d2011-10-27 06:44:11 +0000240}
241
Eric Christopher2e5d8702012-12-20 21:58:36 +0000242MCSymbol *DwarfUnits::getStringPoolEntry(StringRef Str) {
243 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopherb6714222013-01-08 22:22:06 +0000244 StringPool.GetOrCreateValue(Str).getValue();
Chris Lattnerbc733f52010-03-13 02:17:42 +0000245 if (Entry.first) return Entry.first;
246
247 Entry.second = NextStringPoolNumber++;
Eric Christopher64f824c2012-12-27 02:14:01 +0000248 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
Chris Lattnerbc733f52010-03-13 02:17:42 +0000249}
250
Eric Christopherdd8e9f32013-01-07 19:32:41 +0000251unsigned DwarfUnits::getStringPoolIndex(StringRef Str) {
252 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopherb6714222013-01-08 22:22:06 +0000253 StringPool.GetOrCreateValue(Str).getValue();
Eric Christopherdd8e9f32013-01-07 19:32:41 +0000254 if (Entry.first) return Entry.second;
255
256 Entry.second = NextStringPoolNumber++;
257 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
258 return Entry.second;
259}
260
David Blaikie321d83b2013-06-28 18:47:14 +0000261unsigned DwarfUnits::getAddrPoolIndex(const MCSymbol *Sym) {
David Blaikie8fed05e2013-07-01 23:55:52 +0000262 return getAddrPoolIndex(MCSymbolRefExpr::Create(Sym, Asm->OutContext));
263}
264
Ulrich Weigand18dbe502013-07-02 18:46:46 +0000265unsigned DwarfUnits::getAddrPoolIndex(const MCExpr *Sym) {
266 std::pair<DenseMap<const MCExpr *, unsigned>::iterator, bool> P =
David Blaikie1c736322013-06-28 18:47:19 +0000267 AddressPool.insert(std::make_pair(Sym, NextAddrPoolNumber));
David Blaikie1ca79902013-06-28 18:55:13 +0000268 if (P.second)
269 ++NextAddrPoolNumber;
David Blaikie1c736322013-06-28 18:47:19 +0000270 return P.first->second;
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000271}
272
Eric Christopherb6dc8652012-11-27 22:43:45 +0000273// Define a unique number for the abbreviation.
274//
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000275void DwarfUnits::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling0310d762009-05-15 09:23:25 +0000276 // Check the set for priors.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000277 DIEAbbrev *InSet = AbbreviationsSet->GetOrInsertNode(&Abbrev);
Bill Wendling0310d762009-05-15 09:23:25 +0000278
279 // If it's newly added.
280 if (InSet == &Abbrev) {
281 // Add to abbreviation list.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000282 Abbreviations->push_back(&Abbrev);
Bill Wendling0310d762009-05-15 09:23:25 +0000283
284 // Assign the vector position + 1 as its number.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000285 Abbrev.setNumber(Abbreviations->size());
Bill Wendling0310d762009-05-15 09:23:25 +0000286 } else {
287 // Assign existing abbreviation number.
288 Abbrev.setNumber(InSet->getNumber());
289 }
290}
291
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000292static bool isObjCClass(StringRef Name) {
293 return Name.startswith("+") || Name.startswith("-");
294}
295
296static bool hasObjCCategory(StringRef Name) {
297 if (!isObjCClass(Name)) return false;
298
Benjamin Kramer4321d4e2013-08-24 12:15:54 +0000299 return Name.find(") ") != StringRef::npos;
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000300}
301
302static void getObjCClassCategory(StringRef In, StringRef &Class,
303 StringRef &Category) {
304 if (!hasObjCCategory(In)) {
305 Class = In.slice(In.find('[') + 1, In.find(' '));
306 Category = "";
307 return;
308 }
309
310 Class = In.slice(In.find('[') + 1, In.find('('));
311 Category = In.slice(In.find('[') + 1, In.find(' '));
312 return;
313}
314
315static StringRef getObjCMethodName(StringRef In) {
316 return In.slice(In.find(' ') + 1, In.find(']'));
317}
318
Richard Mitton7c9659a2013-10-03 22:07:08 +0000319// Helper for sorting sections into a stable output order.
320static bool SectionSort(const MCSection *A, const MCSection *B) {
321 std::string LA = (A ? A->getLabelBeginName() : "");
322 std::string LB = (B ? B->getLabelBeginName() : "");
323 return LA < LB;
324}
325
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000326// Add the various names to the Dwarf accelerator table names.
Eric Christopher9e0b08d2013-09-20 23:22:52 +0000327// TODO: Determine whether or not we should add names for programs
328// that do not have a DW_AT_name or DW_AT_linkage_name field - this
329// is only slightly different than the lookup of non-standard ObjC names.
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000330static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
331 DIE* Die) {
332 if (!SP.isDefinition()) return;
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000333 TheCU->addAccelName(SP.getName(), Die);
334
335 // If the linkage name is different than the name, go ahead and output
336 // that as well into the name table.
337 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
338 TheCU->addAccelName(SP.getLinkageName(), Die);
339
340 // If this is an Objective-C selector name add it to the ObjC accelerator
341 // too.
342 if (isObjCClass(SP.getName())) {
343 StringRef Class, Category;
344 getObjCClassCategory(SP.getName(), Class, Category);
345 TheCU->addAccelObjC(Class, Die);
346 if (Category != "")
347 TheCU->addAccelObjC(Category, Die);
348 // Also add the base method name to the name table.
349 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
350 }
351}
352
Manman Ren02d29672013-09-09 19:05:21 +0000353/// isSubprogramContext - Return true if Context is either a subprogram
354/// or another context nested inside a subprogram.
355bool DwarfDebug::isSubprogramContext(const MDNode *Context) {
356 if (!Context)
357 return false;
358 DIDescriptor D(Context);
359 if (D.isSubprogram())
360 return true;
361 if (D.isType())
Manman Ren2c9905a2013-09-09 19:47:11 +0000362 return isSubprogramContext(resolve(DIType(Context).getContext()));
Manman Ren02d29672013-09-09 19:05:21 +0000363 return false;
364}
365
Eric Christopherb6dc8652012-11-27 22:43:45 +0000366// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
367// and DW_AT_high_pc attributes. If there are global variables in this
368// scope then create and insert DIEs for these variables.
Devang Pateld3024342011-08-15 22:24:32 +0000369DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
370 const MDNode *SPNode) {
Eric Christopher3f045002013-10-04 17:08:38 +0000371 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patel8aa61472010-07-07 22:20:57 +0000372
Chris Lattnerd38fee82010-04-05 00:13:49 +0000373 assert(SPDie && "Unable to find subprogram DIE!");
374 DISubprogram SP(SPNode);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000375
Bill Wendling168c1902012-11-07 05:19:04 +0000376 // If we're updating an abstract DIE, then we will be adding the children and
377 // object pointer later on. But what we don't want to do is process the
378 // concrete DIE twice.
Eric Christophere7099f62013-10-04 19:40:33 +0000379 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
Bill Wendling168c1902012-11-07 05:19:04 +0000380 // Pick up abstract subprogram DIE.
Devang Patel8aa61472010-07-07 22:20:57 +0000381 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Manman Ren87b110a2013-10-11 23:58:05 +0000382 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin, AbsSPDIE);
Devang Patel8aa61472010-07-07 22:20:57 +0000383 SPCU->addDie(SPDie);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000384 } else {
385 DISubprogram SPDecl = SP.getFunctionDeclaration();
386 if (!SPDecl.isSubprogram()) {
387 // There is not any need to generate specification DIE for a function
388 // defined at compile unit level. If a function is defined inside another
389 // function then gdb prefers the definition at top level and but does not
390 // expect specification DIE in parent function. So avoid creating
391 // specification DIE for a function defined inside a function.
Manman Renb8e48a62013-10-10 18:40:01 +0000392 DIScope SPContext = resolve(SP.getContext());
393 if (SP.isDefinition() && !SPContext.isCompileUnit() &&
394 !SPContext.isFile() &&
395 !isSubprogramContext(SPContext)) {
Bill Wendlinga4c76932012-11-07 04:42:18 +0000396 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
397
398 // Add arguments.
399 DICompositeType SPTy = SP.getType();
400 DIArray Args = SPTy.getTypeArray();
Eric Christopher31667622013-08-08 01:41:00 +0000401 uint16_t SPTag = SPTy.getTag();
Bill Wendlinga4c76932012-11-07 04:42:18 +0000402 if (SPTag == dwarf::DW_TAG_subroutine_type)
403 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
404 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
405 DIType ATy = DIType(Args.getElement(i));
406 SPCU->addType(Arg, ATy);
407 if (ATy.isArtificial())
408 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
409 if (ATy.isObjectPointer())
Manman Ren87b110a2013-10-11 23:58:05 +0000410 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer, Arg);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000411 SPDie->addChild(Arg);
412 }
413 DIE *SPDeclDie = SPDie;
414 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Manman Ren87b110a2013-10-11 23:58:05 +0000415 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, SPDeclDie);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000416 SPCU->addDie(SPDie);
417 }
418 }
Devang Patel8aa61472010-07-07 22:20:57 +0000419 }
420
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000421 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc,
422 Asm->GetTempSymbol("func_begin",
423 Asm->getFunctionNumber()));
424 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
425 Asm->GetTempSymbol("func_end",
426 Asm->getFunctionNumber()));
Chris Lattnerd38fee82010-04-05 00:13:49 +0000427 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
428 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patel3cbee302011-04-12 22:53:02 +0000429 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +0000430
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000431 // Add name to the name table, we do this here because we're guaranteed
432 // to have concrete versions of our DW_TAG_subprogram nodes.
433 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000434
Chris Lattnerd38fee82010-04-05 00:13:49 +0000435 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +0000436}
437
Manman Ren995de6c2013-09-11 19:40:28 +0000438/// Check whether we should create a DIE for the given Scope, return true
439/// if we don't create a DIE (the corresponding DIE is null).
Manman Renfd2210a2013-09-10 18:40:41 +0000440bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
441 if (Scope->isAbstractScope())
442 return false;
443
Manman Ren995de6c2013-09-11 19:40:28 +0000444 // We don't create a DIE if there is no Range.
Manman Renfd2210a2013-09-10 18:40:41 +0000445 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
446 if (Ranges.empty())
447 return true;
448
449 if (Ranges.size() > 1)
450 return false;
451
Manman Ren995de6c2013-09-11 19:40:28 +0000452 // We don't create a DIE if we have a single Range and the end label
453 // is null.
Manman Renfd2210a2013-09-10 18:40:41 +0000454 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
455 MCSymbol *End = getLabelAfterInsn(RI->second);
456 return !End;
457}
458
Eric Christopherb6dc8652012-11-27 22:43:45 +0000459// Construct new DW_TAG_lexical_block for this scope and attach
460// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000461DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld3024342011-08-15 22:24:32 +0000462 LexicalScope *Scope) {
Manman Renfd2210a2013-09-10 18:40:41 +0000463 if (isLexicalScopeDIENull(Scope))
464 return 0;
465
Devang Pateleac9c072010-04-27 19:46:33 +0000466 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
467 if (Scope->isAbstractScope())
468 return ScopeDIE;
469
Craig Topper9f43ac62013-07-03 04:24:43 +0000470 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Eric Christopherf53d6432013-07-03 01:57:28 +0000471 // If we have multiple ranges, emit them into the range section.
Devang Pateleac9c072010-04-27 19:46:33 +0000472 if (Ranges.size() > 1) {
473 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbach1e20b962010-07-21 21:21:52 +0000474 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Pateleac9c072010-04-27 19:46:33 +0000475 // DW_AT_ranges appropriately.
Devang Patel3cbee302011-04-12 22:53:02 +0000476 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000477 DebugRangeSymbols.size()
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000478 * Asm->getDataLayout().getPointerSize());
Craig Topper2d785db2013-07-03 04:17:25 +0000479 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +0000480 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +0000481 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
482 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +0000483 }
Eric Christopherda965de2013-07-03 01:22:29 +0000484
485 // Terminate the range list.
Devang Pateleac9c072010-04-27 19:46:33 +0000486 DebugRangeSymbols.push_back(NULL);
487 DebugRangeSymbols.push_back(NULL);
488 return ScopeDIE;
489 }
490
Eric Christopherf53d6432013-07-03 01:57:28 +0000491 // Construct the address range for this DIE.
Craig Topper2d785db2013-07-03 04:17:25 +0000492 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000493 MCSymbol *Start = getLabelBeforeInsn(RI->first);
494 MCSymbol *End = getLabelAfterInsn(RI->second);
Manman Renfd2210a2013-09-10 18:40:41 +0000495 assert(End && "End label should not be null!");
Devang Patel53bb5c92009-11-10 23:06:00 +0000496
Chris Lattnerb7db7332010-03-09 01:58:53 +0000497 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
498 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbach1e20b962010-07-21 21:21:52 +0000499
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000500 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
501 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patel53bb5c92009-11-10 23:06:00 +0000502
503 return ScopeDIE;
504}
505
Eric Christopherb6dc8652012-11-27 22:43:45 +0000506// This scope represents inlined body of a function. Construct DIE to
507// represent this concrete inlined copy of the function.
Devang Pateld3024342011-08-15 22:24:32 +0000508DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
509 LexicalScope *Scope) {
Craig Topper9f43ac62013-07-03 04:24:43 +0000510 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Nick Lewycky746cb672011-10-26 22:55:33 +0000511 assert(Ranges.empty() == false &&
512 "LexicalScope does not have instruction markers!");
Devang Pateleac9c072010-04-27 19:46:33 +0000513
Devang Patel26a92002011-07-27 00:34:13 +0000514 if (!Scope->getScopeNode())
515 return NULL;
516 DIScope DS(Scope->getScopeNode());
517 DISubprogram InlinedSP = getDISubprogram(DS);
Eric Christopher3f045002013-10-04 17:08:38 +0000518 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patel26a92002011-07-27 00:34:13 +0000519 if (!OriginDIE) {
Bill Wendlinge0aae5b2012-10-30 17:51:02 +0000520 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patel26a92002011-07-27 00:34:13 +0000521 return NULL;
522 }
523
Devang Pateld96efb82011-05-05 17:54:26 +0000524 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Manman Ren87b110a2013-10-11 23:58:05 +0000525 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin, OriginDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +0000526
Devang Patel26a92002011-07-27 00:34:13 +0000527 if (Ranges.size() > 1) {
528 // .debug_range section has not been laid out yet. Emit offset in
529 // .debug_range as a uint, size 4, for now. emitDIE will handle
530 // DW_AT_ranges appropriately.
531 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000532 DebugRangeSymbols.size()
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000533 * Asm->getDataLayout().getPointerSize());
Craig Topper2d785db2013-07-03 04:17:25 +0000534 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel26a92002011-07-27 00:34:13 +0000535 RE = Ranges.end(); RI != RE; ++RI) {
536 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
537 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
538 }
539 DebugRangeSymbols.push_back(NULL);
540 DebugRangeSymbols.push_back(NULL);
541 } else {
Craig Topper2d785db2013-07-03 04:17:25 +0000542 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christophere7177132013-07-03 02:23:53 +0000543 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
544 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
545
546 if (StartLabel == 0 || EndLabel == 0)
547 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
548
549 assert(StartLabel->isDefined() &&
550 "Invalid starting label for an inlined scope!");
551 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
552
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000553 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
554 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patel26a92002011-07-27 00:34:13 +0000555 }
Devang Patel53bb5c92009-11-10 23:06:00 +0000556
557 InlinedSubprogramDIEs.insert(OriginDIE);
558
Eric Christophere7177132013-07-03 02:23:53 +0000559 // Add the call site information to the DIE.
Devang Patel53bb5c92009-11-10 23:06:00 +0000560 DILocation DL(Scope->getInlinedAt());
David Blaikie770530b2013-10-21 17:28:37 +0000561 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, None,
Manman Ren3de61b42013-03-07 01:42:00 +0000562 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
563 TheCU->getUniqueID()));
David Blaikie770530b2013-10-21 17:28:37 +0000564 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, None, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +0000565
Eric Christopher309bedd2011-12-04 06:02:38 +0000566 // Add name to the name table, we do this here because we're guaranteed
567 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
568 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000569
Devang Patel53bb5c92009-11-10 23:06:00 +0000570 return ScopeDIE;
571}
572
Manman Renfd2210a2013-09-10 18:40:41 +0000573DIE *DwarfDebug::createScopeChildrenDIE(CompileUnit *TheCU, LexicalScope *Scope,
574 SmallVectorImpl<DIE*> &Children) {
575 DIE *ObjectPointer = NULL;
Devang Patel0478c152011-03-01 22:58:55 +0000576
577 // Collect arguments for current function.
Devang Patelbf47fdb2011-08-10 20:55:27 +0000578 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +0000579 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
580 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000581 if (DIE *Arg =
Eric Christophere5212782012-09-12 23:36:19 +0000582 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel0478c152011-03-01 22:58:55 +0000583 Children.push_back(Arg);
Eric Christophere5212782012-09-12 23:36:19 +0000584 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
585 }
Devang Patel0478c152011-03-01 22:58:55 +0000586
Eric Christopher1aeb7ac2011-10-03 15:49:16 +0000587 // Collect lexical scope children first.
Craig Topper9f43ac62013-07-03 04:24:43 +0000588 const SmallVectorImpl<DbgVariable *> &Variables =ScopeVariables.lookup(Scope);
Devang Patel5bc9fec2011-02-19 01:31:27 +0000589 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000590 if (DIE *Variable =
Eric Christopher7b451cf2012-09-21 22:18:52 +0000591 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5bc9fec2011-02-19 01:31:27 +0000592 Children.push_back(Variable);
Eric Christopher7b451cf2012-09-21 22:18:52 +0000593 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
594 }
Craig Topper9f43ac62013-07-03 04:24:43 +0000595 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5bc9fec2011-02-19 01:31:27 +0000596 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Pateld0b5a5e2011-08-15 22:04:40 +0000597 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5bc9fec2011-02-19 01:31:27 +0000598 Children.push_back(Nested);
Manman Renfd2210a2013-09-10 18:40:41 +0000599 return ObjectPointer;
600}
601
602// Construct a DIE for this scope.
603DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
604 if (!Scope || !Scope->getScopeNode())
605 return NULL;
606
607 DIScope DS(Scope->getScopeNode());
608
609 SmallVector<DIE *, 8> Children;
610 DIE *ObjectPointer = NULL;
611 bool ChildrenCreated = false;
612
Manman Ren995de6c2013-09-11 19:40:28 +0000613 // We try to create the scope DIE first, then the children DIEs. This will
614 // avoid creating un-used children then removing them later when we find out
615 // the scope DIE is null.
Devang Patel3c91b052010-03-08 20:52:55 +0000616 DIE *ScopeDIE = NULL;
617 if (Scope->getInlinedAt())
Devang Pateld3024342011-08-15 22:24:32 +0000618 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3c91b052010-03-08 20:52:55 +0000619 else if (DS.isSubprogram()) {
Devang Patel0dd45582010-06-28 20:53:04 +0000620 ProcessedSPNodes.insert(DS);
Devang Patel8aa61472010-07-07 22:20:57 +0000621 if (Scope->isAbstractScope()) {
Eric Christopher3f045002013-10-04 17:08:38 +0000622 ScopeDIE = TheCU->getDIE(DS);
Devang Patel8aa61472010-07-07 22:20:57 +0000623 // Note down abstract DIE.
624 if (ScopeDIE)
625 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
626 }
Devang Patel3c91b052010-03-08 20:52:55 +0000627 else
Devang Pateld3024342011-08-15 22:24:32 +0000628 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3c91b052010-03-08 20:52:55 +0000629 }
Devang Patel5bc9fec2011-02-19 01:31:27 +0000630 else {
Manman Ren995de6c2013-09-11 19:40:28 +0000631 // Early exit when we know the scope DIE is going to be null.
Manman Renfd2210a2013-09-10 18:40:41 +0000632 if (isLexicalScopeDIENull(Scope))
633 return NULL;
Manman Ren995de6c2013-09-11 19:40:28 +0000634
635 // We create children here when we know the scope DIE is not going to be
636 // null and the children will be added to the scope DIE.
Manman Renfd2210a2013-09-10 18:40:41 +0000637 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
638 ChildrenCreated = true;
Manman Ren995de6c2013-09-11 19:40:28 +0000639
Devang Patel5bc9fec2011-02-19 01:31:27 +0000640 // There is no need to emit empty lexical block DIE.
David Blaikied2e0f7e2013-05-06 23:33:07 +0000641 std::pair<ImportedEntityMap::const_iterator,
642 ImportedEntityMap::const_iterator> Range = std::equal_range(
643 ScopesWithImportedEntities.begin(), ScopesWithImportedEntities.end(),
Timur Iskhodzhanov664fbee2013-05-07 07:47:47 +0000644 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode*)0),
Benjamin Kramer0b6962f2013-08-24 12:54:27 +0000645 less_first());
David Blaikied2e0f7e2013-05-06 23:33:07 +0000646 if (Children.empty() && Range.first == Range.second)
Devang Patel5bc9fec2011-02-19 01:31:27 +0000647 return NULL;
Devang Pateld3024342011-08-15 22:24:32 +0000648 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Manman Renfd2210a2013-09-10 18:40:41 +0000649 assert(ScopeDIE && "Scope DIE should not be null.");
Eric Christopherfdfc81f2013-06-24 23:20:02 +0000650 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
651 ++i)
David Blaikied1221e32013-05-08 06:01:38 +0000652 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5bc9fec2011-02-19 01:31:27 +0000653 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000654
Benjamin Kramer6bee6312013-08-24 11:55:49 +0000655 if (!ScopeDIE) {
Manman Renfd2210a2013-09-10 18:40:41 +0000656 assert(Children.empty() &&
657 "We create children only when the scope DIE is not null.");
Benjamin Kramer6bee6312013-08-24 11:55:49 +0000658 return NULL;
659 }
Manman Renfd2210a2013-09-10 18:40:41 +0000660 if (!ChildrenCreated)
Manman Ren995de6c2013-09-11 19:40:28 +0000661 // We create children when the scope DIE is not null.
Manman Renfd2210a2013-09-10 18:40:41 +0000662 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000663
Devang Patel5bc9fec2011-02-19 01:31:27 +0000664 // Add children
Craig Topper2d785db2013-07-03 04:17:25 +0000665 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Devang Patel5bc9fec2011-02-19 01:31:27 +0000666 E = Children.end(); I != E; ++I)
667 ScopeDIE->addChild(*I);
Devang Patel193f7202009-11-24 01:14:22 +0000668
Eric Christophere5212782012-09-12 23:36:19 +0000669 if (DS.isSubprogram() && ObjectPointer != NULL)
Manman Ren87b110a2013-10-11 23:58:05 +0000670 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, ObjectPointer);
Eric Christophere5212782012-09-12 23:36:19 +0000671
Jim Grosbach1e20b962010-07-21 21:21:52 +0000672 if (DS.isSubprogram())
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000673 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbach1e20b962010-07-21 21:21:52 +0000674
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000675 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +0000676}
677
Eric Christopherb6dc8652012-11-27 22:43:45 +0000678// Look up the source id with the given directory and source file names.
679// If none currently exists, create a new id and insert it in the
680// SourceIds map. This can update DirectoryNames and SourceFileNames maps
681// as well.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000682unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Manman Ren3de61b42013-03-07 01:42:00 +0000683 StringRef DirName, unsigned CUID) {
684 // If we use .loc in assembly, we can't separate .file entries according to
685 // compile units. Thus all files will belong to the default compile unit.
Rafael Espindola5e195a42013-10-05 16:42:21 +0000686
687 // FIXME: add a better feature test than hasRawTextSupport. Even better,
688 // extend .file to support this.
689 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren3de61b42013-03-07 01:42:00 +0000690 CUID = 0;
691
Devang Patel1905a182010-09-16 20:57:49 +0000692 // If FE did not provide a file name, then assume stdin.
693 if (FileName.empty())
Manman Ren3de61b42013-03-07 01:42:00 +0000694 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patel23670e52011-03-24 20:30:50 +0000695
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000696 // TODO: this might not belong here. See if we can factor this better.
697 if (DirName == CompilationDir)
698 DirName = "";
699
Manman Ren3de61b42013-03-07 01:42:00 +0000700 // FileIDCUMap stores the current ID for the given compile unit.
701 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel1905a182010-09-16 20:57:49 +0000702
Manman Ren3de61b42013-03-07 01:42:00 +0000703 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer74612c22012-03-11 14:56:26 +0000704 SmallString<128> NamePair;
Manman Ren5044a932013-04-06 01:02:38 +0000705 NamePair += utostr(CUID);
Manman Ren3de61b42013-03-07 01:42:00 +0000706 NamePair += '\0';
Benjamin Kramer74612c22012-03-11 14:56:26 +0000707 NamePair += DirName;
708 NamePair += '\0'; // Zero bytes are not allowed in paths.
709 NamePair += FileName;
710
711 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
712 if (Ent.getValue() != SrcId)
713 return Ent.getValue();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000714
Manman Ren3de61b42013-03-07 01:42:00 +0000715 FileIDCUMap[CUID] = SrcId;
Rafael Espindola5c055632010-11-18 02:04:25 +0000716 // Print out a .file directive to specify files for .loc directives.
Manman Ren3de61b42013-03-07 01:42:00 +0000717 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000718
719 return SrcId;
720}
721
Eric Christopher72c16552012-12-20 21:58:40 +0000722// Create new CompileUnit for the given metadata node with tag
723// DW_TAG_compile_unit.
Devang Patel94c7ddb2011-08-16 22:09:43 +0000724CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +0000725 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +0000726 StringRef FN = DIUnit.getFilename();
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000727 CompilationDir = DIUnit.getDirectory();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000728
729 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher7b878952013-08-26 23:50:38 +0000730 CompileUnit *NewCU =
731 new CompileUnit(GlobalCUIndexCount++, Die, N, Asm, this, &InfoHolder);
Manman Ren3de61b42013-03-07 01:42:00 +0000732
733 FileIDCUMap[NewCU->getUniqueID()] = 0;
734 // Call this to emit a .file directive if it wasn't emitted for the source
735 // file this CU comes from yet.
736 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
737
Nick Lewycky390c40d2011-10-27 06:44:11 +0000738 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patel3cbee302011-04-12 22:53:02 +0000739 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
740 DIUnit.getLanguage());
Nick Lewycky390c40d2011-10-27 06:44:11 +0000741 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christophere0828ec2013-04-09 19:23:15 +0000742
Eric Christopher6635cad2012-08-01 18:19:01 +0000743 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christophere0828ec2013-04-09 19:23:15 +0000744 // into an entity. We're using 0 (or a NULL label) for this. For
745 // split dwarf it's in the skeleton CU so omit it here.
746 if (!useSplitDwarf())
747 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
Manman Ren43213cf2013-02-05 21:52:47 +0000748
749 // Define start line table label for each Compile Unit.
750 MCSymbol *LineTableStartSym = Asm->GetTempSymbol("line_table_start",
751 NewCU->getUniqueID());
752 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
753 NewCU->getUniqueID());
754
Manman Ren01cb18e2013-05-21 00:57:22 +0000755 // Use a single line table if we are using .loc and generating assembly.
756 bool UseTheFirstCU =
Rafael Espindola5e195a42013-10-05 16:42:21 +0000757 (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport()) ||
758 (NewCU->getUniqueID() == 0);
Manman Ren01cb18e2013-05-21 00:57:22 +0000759
Eric Christophere0828ec2013-04-09 19:23:15 +0000760 if (!useSplitDwarf()) {
Eric Christopher0b15e982013-09-27 22:50:48 +0000761 // DW_AT_stmt_list is a offset of line number information for this
762 // compile unit in debug_line section. For split dwarf this is
763 // left in the skeleton CU and so not included.
764 // The line table entries are not always emitted in assembly, so it
765 // is not okay to use line_table_start here.
Eric Christophere0828ec2013-04-09 19:23:15 +0000766 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Carlo Kok46f0b6f2013-08-13 17:46:57 +0000767 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher0b15e982013-09-27 22:50:48 +0000768 UseTheFirstCU ? Asm->GetTempSymbol("section_line")
769 : LineTableStartSym);
Manman Ren01cb18e2013-05-21 00:57:22 +0000770 else if (UseTheFirstCU)
Eric Christophere0828ec2013-04-09 19:23:15 +0000771 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
772 else
773 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
774 LineTableStartSym, DwarfLineSectionSym);
Eric Christopher0b15e982013-09-27 22:50:48 +0000775
776 // If we're using split dwarf the compilation dir is going to be in the
777 // skeleton CU and so we don't need to duplicate it here.
778 if (!CompilationDir.empty())
779 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
780
Eric Christopher08bd9232013-10-01 00:43:31 +0000781 // Flags to let the linker know we have emitted new style pubnames. Only
Eric Christopher0b15e982013-09-27 22:50:48 +0000782 // emit it here if we don't have a skeleton CU for split dwarf.
Eric Christophera6d84152013-09-30 23:14:16 +0000783 if (GenerateGnuPubSections) {
784 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
785 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames,
786 dwarf::DW_FORM_sec_offset,
787 Asm->GetTempSymbol("gnu_pubnames",
788 NewCU->getUniqueID()));
789 else
790 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
791 Asm->GetTempSymbol("gnu_pubnames",
792 NewCU->getUniqueID()),
793 DwarfGnuPubNamesSectionSym);
794
795 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
796 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes,
797 dwarf::DW_FORM_sec_offset,
798 Asm->GetTempSymbol("gnu_pubtypes",
799 NewCU->getUniqueID()));
800 else
801 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopher7c9fc902013-10-03 17:41:16 +0000802 Asm->GetTempSymbol("gnu_pubtypes",
Eric Christophera6d84152013-09-30 23:14:16 +0000803 NewCU->getUniqueID()),
804 DwarfGnuPubTypesSectionSym);
805 }
Eric Christophere0828ec2013-04-09 19:23:15 +0000806 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000807
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000808 if (DIUnit.isOptimized())
Eric Christopher873cf0a2012-08-24 01:14:27 +0000809 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000810
Devang Patel65dbc902009-11-25 17:36:49 +0000811 StringRef Flags = DIUnit.getFlags();
812 if (!Flags.empty())
Nick Lewycky390c40d2011-10-27 06:44:11 +0000813 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000814
Nick Lewyckyd5d52132011-10-17 23:27:36 +0000815 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patel3cbee302011-04-12 22:53:02 +0000816 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000817 dwarf::DW_FORM_data1, RVer);
818
Devang Patel163a9f72010-05-10 22:49:55 +0000819 if (!FirstCU)
820 FirstCU = NewCU;
Eric Christopher208cc6f2013-02-05 07:31:55 +0000821
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000822 InfoHolder.addUnit(NewCU);
823
Devang Patel163a9f72010-05-10 22:49:55 +0000824 CUMap.insert(std::make_pair(N, NewCU));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000825 return NewCU;
Devang Patel163a9f72010-05-10 22:49:55 +0000826}
827
Eric Christopherb6dc8652012-11-27 22:43:45 +0000828// Construct subprogram DIE.
Eric Christopherc6228242013-10-15 23:31:38 +0000829void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU, const MDNode *N) {
Eric Christopher1c165b82013-10-18 01:57:30 +0000830 // FIXME: We should only call this routine once, however, during LTO if a
831 // program is defined in multiple CUs we could end up calling it out of
832 // beginModule as we walk the CUs.
833
834 CompileUnit *&CURef = SPMap[N];
835 if (CURef)
836 return;
837 CURef = TheCU;
Rafael Espindolab0527282011-11-04 19:00:29 +0000838
Devang Patele4b27562009-08-28 23:24:31 +0000839 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000840 if (!SP.isDefinition())
841 // This is a method declaration which will be handled while constructing
842 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +0000843 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000844
Devang Pateldbc64af2011-08-15 17:24:54 +0000845 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings639336e2010-04-06 21:38:29 +0000846
Eric Christopher28b020d2013-09-09 20:03:20 +0000847 // Expose as a global name.
Eric Christopher91986572013-10-17 02:06:06 +0000848 TheCU->addGlobalName(SP.getName(), SubprogramDie, resolve(SP.getContext()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000849}
850
David Blaikie20d9e412013-05-07 21:35:53 +0000851void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikiec462db62013-04-22 06:12:31 +0000852 const MDNode *N) {
David Blaikie20d9e412013-05-07 21:35:53 +0000853 DIImportedEntity Module(N);
David Blaikiec462db62013-04-22 06:12:31 +0000854 if (!Module.Verify())
855 return;
David Blaikied2e0f7e2013-05-06 23:33:07 +0000856 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
David Blaikied1221e32013-05-08 06:01:38 +0000857 constructImportedEntityDIE(TheCU, Module, D);
David Blaikied2e0f7e2013-05-06 23:33:07 +0000858}
859
David Blaikied1221e32013-05-08 06:01:38 +0000860void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
David Blaikied2e0f7e2013-05-06 23:33:07 +0000861 DIE *Context) {
David Blaikie20d9e412013-05-07 21:35:53 +0000862 DIImportedEntity Module(N);
David Blaikied2e0f7e2013-05-06 23:33:07 +0000863 if (!Module.Verify())
864 return;
David Blaikied1221e32013-05-08 06:01:38 +0000865 return constructImportedEntityDIE(TheCU, Module, Context);
David Blaikied2e0f7e2013-05-06 23:33:07 +0000866}
867
David Blaikied1221e32013-05-08 06:01:38 +0000868void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikie20d9e412013-05-07 21:35:53 +0000869 const DIImportedEntity &Module,
David Blaikied2e0f7e2013-05-06 23:33:07 +0000870 DIE *Context) {
871 assert(Module.Verify() &&
872 "Use one of the MDNode * overloads to handle invalid metadata");
873 assert(Context && "Should always have a context for an imported_module");
David Blaikie20d9e412013-05-07 21:35:53 +0000874 DIE *IMDie = new DIE(Module.getTag());
David Blaikiec462db62013-04-22 06:12:31 +0000875 TheCU->insertDIE(Module, IMDie);
David Blaikie20d9e412013-05-07 21:35:53 +0000876 DIE *EntityDie;
877 DIDescriptor Entity = Module.getEntity();
878 if (Entity.isNameSpace())
879 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
880 else if (Entity.isSubprogram())
881 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
David Blaikieaa76a932013-05-08 06:01:41 +0000882 else if (Entity.isType())
883 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
David Blaikie20d9e412013-05-07 21:35:53 +0000884 else
David Blaikieaa76a932013-05-08 06:01:41 +0000885 EntityDie = TheCU->getDIE(Entity);
David Blaikiec462db62013-04-22 06:12:31 +0000886 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
887 Module.getContext().getDirectory(),
888 TheCU->getUniqueID());
David Blaikie770530b2013-10-21 17:28:37 +0000889 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, None, FileID);
890 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, None, Module.getLineNumber());
Manman Ren87b110a2013-10-11 23:58:05 +0000891 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, EntityDie);
David Blaikie7b72cc72013-05-20 22:50:35 +0000892 StringRef Name = Module.getName();
893 if (!Name.empty())
894 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
David Blaikied2e0f7e2013-05-06 23:33:07 +0000895 Context->addChild(IMDie);
David Blaikiec462db62013-04-22 06:12:31 +0000896}
897
Eric Christopherb6dc8652012-11-27 22:43:45 +0000898// Emit all Dwarf sections that should come prior to the content. Create
899// global DIEs and emit initial debug info sections. This is invoked by
900// the target AsmPrinter.
Eric Christopherc4639d62012-11-19 22:42:15 +0000901void DwarfDebug::beginModule() {
Devang Pateleac9c072010-04-27 19:46:33 +0000902 if (DisableDebugInfoPrinting)
903 return;
904
Eric Christopherc4639d62012-11-19 22:42:15 +0000905 const Module *M = MMI->getModule();
906
Nick Lewycky3bbb6f72011-07-29 03:49:23 +0000907 // If module has named metadata anchors then use them, otherwise scan the
908 // module using debug info finder to collect debug info.
Devang Patel30692ab2011-05-03 16:45:22 +0000909 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
David Blaikiec0ec8a42013-03-11 23:39:23 +0000910 if (!CU_Nodes)
Devang Patel02e603f2011-08-15 23:47:24 +0000911 return;
Manman Renbc660712013-09-05 18:48:31 +0000912 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
Devang Patel30692ab2011-05-03 16:45:22 +0000913
David Blaikiec0ec8a42013-03-11 23:39:23 +0000914 // Emit initial sections so we can reference labels later.
915 emitSectionLabels();
916
917 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
918 DICompileUnit CUNode(CU_Nodes->getOperand(i));
919 CompileUnit *CU = constructCompileUnit(CUNode);
David Blaikie20d9e412013-05-07 21:35:53 +0000920 DIArray ImportedEntities = CUNode.getImportedEntities();
921 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
David Blaikied2e0f7e2013-05-06 23:33:07 +0000922 ScopesWithImportedEntities.push_back(std::make_pair(
David Blaikie20d9e412013-05-07 21:35:53 +0000923 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
924 ImportedEntities.getElement(i)));
David Blaikied2e0f7e2013-05-06 23:33:07 +0000925 std::sort(ScopesWithImportedEntities.begin(),
Benjamin Kramer0b6962f2013-08-24 12:54:27 +0000926 ScopesWithImportedEntities.end(), less_first());
David Blaikiec0ec8a42013-03-11 23:39:23 +0000927 DIArray GVs = CUNode.getGlobalVariables();
928 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
929 CU->createGlobalVariableDIE(GVs.getElement(i));
930 DIArray SPs = CUNode.getSubprograms();
931 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
932 constructSubprogramDIE(CU, SPs.getElement(i));
933 DIArray EnumTypes = CUNode.getEnumTypes();
934 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
935 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
936 DIArray RetainedTypes = CUNode.getRetainedTypes();
937 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
938 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
David Blaikiec462db62013-04-22 06:12:31 +0000939 // Emit imported_modules last so that the relevant context is already
940 // available.
David Blaikie20d9e412013-05-07 21:35:53 +0000941 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
942 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
David Blaikiec0ec8a42013-03-11 23:39:23 +0000943 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000944
Chris Lattnerd850ac72010-04-05 02:19:28 +0000945 // Tell MMI that we have debug info.
946 MMI->setDebugInfoAvailability(true);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000947
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000948 // Prime section data.
Richard Mitton5cc319a2013-09-19 23:21:01 +0000949 SectionMap[Asm->getObjFileLowering().getTextSection()];
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000950}
951
Eric Christopher4117bec2012-11-22 00:59:49 +0000952// Attach DW_AT_inline attribute with inlined subprogram DIEs.
953void DwarfDebug::computeInlinedDIEs() {
Devang Patel53bb5c92009-11-10 23:06:00 +0000954 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
955 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000956 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patel53bb5c92009-11-10 23:06:00 +0000957 DIE *ISP = *AI;
David Blaikie770530b2013-10-21 17:28:37 +0000958 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +0000959 }
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000960 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000961 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000962 DIE *ISP = AI->second;
963 if (InlinedSubprogramDIEs.count(ISP))
964 continue;
David Blaikie770530b2013-10-21 17:28:37 +0000965 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000966 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000967}
968
969// Collect info for variables that were optimized out.
970void DwarfDebug::collectDeadVariables() {
971 const Module *M = MMI->getModule();
Eric Christopher4117bec2012-11-22 00:59:49 +0000972
973 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
974 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
975 DICompileUnit TheCU(CU_Nodes->getOperand(i));
976 DIArray Subprograms = TheCU.getSubprograms();
977 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopherbdab8002012-11-27 00:13:51 +0000978 DISubprogram SP(Subprograms.getElement(i));
Eric Christopherc6228242013-10-15 23:31:38 +0000979 if (ProcessedSPNodes.count(SP) != 0)
980 continue;
981 if (!SP.isSubprogram())
982 continue;
983 if (!SP.isDefinition())
984 continue;
Eric Christopherbdab8002012-11-27 00:13:51 +0000985 DIArray Variables = SP.getVariables();
Eric Christopherc6228242013-10-15 23:31:38 +0000986 if (Variables.getNumElements() == 0)
987 continue;
Eric Christopher4117bec2012-11-22 00:59:49 +0000988
Eric Christopherbdab8002012-11-27 00:13:51 +0000989 // Construct subprogram DIE and add variables DIEs.
990 CompileUnit *SPCU = CUMap.lookup(TheCU);
991 assert(SPCU && "Unable to find Compile Unit!");
Eric Christopher8348b7d2013-10-22 00:22:39 +0000992 // FIXME: See the comment in constructSubprogramDIE about duplicate
993 // subprogram DIEs.
994 constructSubprogramDIE(SPCU, SP);
995 DIE *SPDIE = SPCU->getDIE(SP);
Eric Christopherbdab8002012-11-27 00:13:51 +0000996 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
997 DIVariable DV(Variables.getElement(vi));
Eric Christopherc6228242013-10-15 23:31:38 +0000998 if (!DV.isVariable())
999 continue;
Manman Renc664d762013-10-05 01:43:03 +00001000 DbgVariable NewVar(DV, NULL, this);
Eric Christopherbdab8002012-11-27 00:13:51 +00001001 if (DIE *VariableDIE =
Manman Rend56c9db2013-10-22 20:59:19 +00001002 SPCU->constructVariableDIE(&NewVar, false))
Eric Christopherc6228242013-10-15 23:31:38 +00001003 SPDIE->addChild(VariableDIE);
Eric Christopherbdab8002012-11-27 00:13:51 +00001004 }
Eric Christopher4117bec2012-11-22 00:59:49 +00001005 }
1006 }
1007 }
Eric Christopher4117bec2012-11-22 00:59:49 +00001008}
1009
Eric Christopher0d27ca12013-08-08 23:45:55 +00001010// Type Signature [7.27] and ODR Hash code.
Eric Christopher3dee5752013-07-26 17:02:41 +00001011
1012/// \brief Grabs the string in whichever attribute is passed in and returns
Eric Christopherb7669132013-08-07 01:18:33 +00001013/// a reference to it. Returns "" if the attribute doesn't exist.
Eric Christopher3dee5752013-07-26 17:02:41 +00001014static StringRef getDIEStringAttr(DIE *Die, unsigned Attr) {
Eric Christopherb7669132013-08-07 01:18:33 +00001015 DIEValue *V = Die->findAttribute(Attr);
Eric Christopher3dee5752013-07-26 17:02:41 +00001016
Eric Christopherb7669132013-08-07 01:18:33 +00001017 if (DIEString *S = dyn_cast_or_null<DIEString>(V))
1018 return S->getString();
1019
Eric Christopher3dee5752013-07-26 17:02:41 +00001020 return StringRef("");
1021}
1022
Eric Christopher3dee5752013-07-26 17:02:41 +00001023/// Return true if the current DIE is contained within an anonymous namespace.
1024static bool isContainedInAnonNamespace(DIE *Die) {
1025 DIE *Parent = Die->getParent();
1026
1027 while (Parent) {
Eric Christopher86aa03d2013-07-29 23:53:08 +00001028 if (Parent->getTag() == dwarf::DW_TAG_namespace &&
1029 getDIEStringAttr(Parent, dwarf::DW_AT_name) == "")
Eric Christopher3dee5752013-07-26 17:02:41 +00001030 return true;
1031 Parent = Parent->getParent();
1032 }
1033
1034 return false;
1035}
1036
Eric Christopher028f3472013-08-07 01:18:24 +00001037/// Test if the current CU language is C++ and that we have
1038/// a named type that is not contained in an anonymous namespace.
1039static bool shouldAddODRHash(CompileUnit *CU, DIE *Die) {
Eric Christopherf76e1182013-08-07 08:35:10 +00001040 return CU->getLanguage() == dwarf::DW_LANG_C_plus_plus &&
1041 getDIEStringAttr(Die, dwarf::DW_AT_name) != "" &&
1042 !isContainedInAnonNamespace(Die);
Eric Christopher0d27ca12013-08-08 23:45:55 +00001043}
Eric Christopher028f3472013-08-07 01:18:24 +00001044
Eric Christopher4117bec2012-11-22 00:59:49 +00001045void DwarfDebug::finalizeModuleInfo() {
1046 // Collect info for variables that were optimized out.
1047 collectDeadVariables();
1048
1049 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1050 computeInlinedDIEs();
Devang Patel53bb5c92009-11-10 23:06:00 +00001051
Eric Christopherbe482042013-07-29 22:24:32 +00001052 // Split out type units and conditionally add an ODR tag to the split
1053 // out type.
Eric Christopher3dee5752013-07-26 17:02:41 +00001054 // FIXME: Do type splitting.
1055 for (unsigned i = 0, e = TypeUnits.size(); i != e; ++i) {
Eric Christopher3dee5752013-07-26 17:02:41 +00001056 DIE *Die = TypeUnits[i];
Eric Christopher0d27ca12013-08-08 23:45:55 +00001057 DIEHash Hash;
Eric Christopher028f3472013-08-07 01:18:24 +00001058 // If we've requested ODR hashes and it's applicable for an ODR hash then
1059 // add the ODR signature now.
Eric Christopher0d27ca12013-08-08 23:45:55 +00001060 // FIXME: This should be added onto the type unit, not the type, but this
1061 // works as an intermediate stage.
Eric Christopher028f3472013-08-07 01:18:24 +00001062 if (GenerateODRHash && shouldAddODRHash(CUMap.begin()->second, Die))
Eric Christopher0d27ca12013-08-08 23:45:55 +00001063 CUMap.begin()->second->addUInt(Die, dwarf::DW_AT_GNU_odr_signature,
1064 dwarf::DW_FORM_data8,
David Blaikie377e8322013-10-24 18:29:03 +00001065 Hash.computeDIEODRSignature(*Die));
Eric Christopher3dee5752013-07-26 17:02:41 +00001066 }
1067
Eric Christopherf962c022013-08-12 20:27:48 +00001068 // Handle anything that needs to be done on a per-cu basis.
1069 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
1070 CUE = CUMap.end();
1071 CUI != CUE; ++CUI) {
1072 CompileUnit *TheCU = CUI->second;
1073 // Emit DW_AT_containing_type attribute to connect types with their
1074 // vtable holding type.
1075 TheCU->constructContainingTypeDIEs();
1076
1077 // If we're splitting the dwarf out now that we've got the entire
1078 // CU then construct a skeleton CU based upon it.
1079 if (useSplitDwarf()) {
Eric Christopher0710bfa2013-08-13 01:21:55 +00001080 uint64_t ID = 0;
1081 if (GenerateCUHash) {
1082 DIEHash CUHash;
David Blaikie377e8322013-10-24 18:29:03 +00001083 ID = CUHash.computeCUSignature(*TheCU->getCUDie());
Eric Christopher0710bfa2013-08-13 01:21:55 +00001084 }
Eric Christopherf962c022013-08-12 20:27:48 +00001085 // This should be a unique identifier when we want to build .dwp files.
1086 TheCU->addUInt(TheCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopher0710bfa2013-08-13 01:21:55 +00001087 dwarf::DW_FORM_data8, ID);
Eric Christopherf962c022013-08-12 20:27:48 +00001088 // Now construct the skeleton CU associated.
Eric Christophera9b2c792013-08-26 23:50:43 +00001089 CompileUnit *SkCU = constructSkeletonCU(TheCU);
Eric Christopherf962c022013-08-12 20:27:48 +00001090 // This should be a unique identifier when we want to build .dwp files.
1091 SkCU->addUInt(SkCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopher0710bfa2013-08-13 01:21:55 +00001092 dwarf::DW_FORM_data8, ID);
Eric Christopherf962c022013-08-12 20:27:48 +00001093 }
1094 }
1095
1096 // Compute DIE offsets and sizes.
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001097 InfoHolder.computeSizeAndOffsets();
1098 if (useSplitDwarf())
1099 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher4117bec2012-11-22 00:59:49 +00001100}
1101
1102void DwarfDebug::endSections() {
Richard Mitton5cc319a2013-09-19 23:21:01 +00001103 // Filter labels by section.
Alexey Samsonov9d08d692013-10-03 08:54:43 +00001104 for (size_t n = 0; n < ArangeLabels.size(); n++) {
1105 const SymbolCU &SCU = ArangeLabels[n];
Richard Mitton5cc319a2013-09-19 23:21:01 +00001106 if (SCU.Sym->isInSection()) {
1107 // Make a note of this symbol and it's section.
1108 const MCSection *Section = &SCU.Sym->getSection();
1109 if (!Section->getKind().isMetadata())
1110 SectionMap[Section].push_back(SCU);
1111 } else {
1112 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1113 // appear in the output. This sucks as we rely on sections to build
1114 // arange spans. We can do it without, but it's icky.
1115 SectionMap[NULL].push_back(SCU);
1116 }
1117 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001118
Richard Mitton7c9659a2013-10-03 22:07:08 +00001119 // Build a list of sections used.
1120 std::vector<const MCSection *> Sections;
Richard Mitton5cc319a2013-09-19 23:21:01 +00001121 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1122 it++) {
1123 const MCSection *Section = it->first;
Richard Mitton7c9659a2013-10-03 22:07:08 +00001124 Sections.push_back(Section);
1125 }
1126
1127 // Sort the sections into order.
1128 // This is only done to ensure consistent output order across different runs.
1129 std::sort(Sections.begin(), Sections.end(), SectionSort);
1130
1131 // Add terminating symbols for each section.
1132 for (unsigned ID=0;ID<Sections.size();ID++) {
1133 const MCSection *Section = Sections[ID];
Richard Mitton5cc319a2013-09-19 23:21:01 +00001134 MCSymbol *Sym = NULL;
1135
1136 if (Section) {
Richard Mitton7c9659a2013-10-03 22:07:08 +00001137 // We can't call MCSection::getLabelEndName, as it's only safe to do so
1138 // if we know the section name up-front. For user-created sections, the resulting
1139 // label may not be valid to use as a label. (section names can use a greater
1140 // set of characters on some systems)
1141 Sym = Asm->GetTempSymbol("debug_end", ID);
Richard Mitton5cc319a2013-09-19 23:21:01 +00001142 Asm->OutStreamer.SwitchSection(Section);
1143 Asm->OutStreamer.EmitLabel(Sym);
1144 }
1145
1146 // Insert a final terminator.
Alexey Samsonov9d08d692013-10-03 08:54:43 +00001147 SectionMap[Section].push_back(SymbolCU(NULL, Sym));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001148 }
Eric Christopher4117bec2012-11-22 00:59:49 +00001149}
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001150
Eric Christopherb6dc8652012-11-27 22:43:45 +00001151// Emit all Dwarf sections that should come after the content.
Eric Christopher4117bec2012-11-22 00:59:49 +00001152void DwarfDebug::endModule() {
1153
1154 if (!FirstCU) return;
1155
1156 // End any existing sections.
1157 // TODO: Does this need to happen?
1158 endSections();
1159
1160 // Finalize the debug info for the module.
1161 finalizeModuleInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001162
Eric Christopher4daaed12012-12-10 19:51:21 +00001163 if (!useSplitDwarf()) {
Eric Christopher9e0b08d2013-09-20 23:22:52 +00001164 emitDebugStr();
1165
Eric Christopher42885022012-11-27 22:43:42 +00001166 // Emit all the DIEs into a debug info section.
1167 emitDebugInfo();
Eric Christopher74802f72012-11-27 00:41:54 +00001168
Eric Christopher42885022012-11-27 22:43:42 +00001169 // Corresponding abbreviations into a abbrev section.
1170 emitAbbreviations();
1171
1172 // Emit info into a debug loc section.
1173 emitDebugLoc();
1174
1175 // Emit info into a debug aranges section.
1176 emitDebugARanges();
1177
1178 // Emit info into a debug ranges section.
1179 emitDebugRanges();
1180
1181 // Emit info into a debug macinfo section.
1182 emitDebugMacInfo();
1183
Eric Christopher42885022012-11-27 22:43:42 +00001184 } else {
Eric Christopher0b944ee2012-12-11 19:42:09 +00001185 // TODO: Fill this in for separated debug sections and separate
Eric Christopher42885022012-11-27 22:43:42 +00001186 // out information into new sections.
Eric Christopher9e0b08d2013-09-20 23:22:52 +00001187 emitDebugStr();
1188 if (useSplitDwarf())
1189 emitDebugStrDWO();
Eric Christopher42885022012-11-27 22:43:42 +00001190
Eric Christopher98e237f2012-11-30 23:59:06 +00001191 // Emit the debug info section and compile units.
Eric Christopher42885022012-11-27 22:43:42 +00001192 emitDebugInfo();
Eric Christopher98e237f2012-11-30 23:59:06 +00001193 emitDebugInfoDWO();
Eric Christopher42885022012-11-27 22:43:42 +00001194
1195 // Corresponding abbreviations into a abbrev section.
1196 emitAbbreviations();
Eric Christopher6eebe472012-12-19 22:02:53 +00001197 emitDebugAbbrevDWO();
Eric Christopher42885022012-11-27 22:43:42 +00001198
1199 // Emit info into a debug loc section.
1200 emitDebugLoc();
1201
1202 // Emit info into a debug aranges section.
1203 emitDebugARanges();
1204
1205 // Emit info into a debug ranges section.
1206 emitDebugRanges();
1207
1208 // Emit info into a debug macinfo section.
1209 emitDebugMacInfo();
1210
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001211 // Emit DWO addresses.
1212 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1213
Eric Christopher42885022012-11-27 22:43:42 +00001214 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001215
Eric Christopher9d9f5a52012-08-23 07:32:06 +00001216 // Emit info into the dwarf accelerator table sections.
Eric Christopher20f47ab2012-08-23 22:36:40 +00001217 if (useDwarfAccelTables()) {
Eric Christopher09ac3d82011-11-07 09:24:32 +00001218 emitAccelNames();
1219 emitAccelObjC();
1220 emitAccelNamespaces();
1221 emitAccelTypes();
1222 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001223
Eric Christopher26123542013-08-30 00:40:17 +00001224 // Emit the pubnames and pubtypes sections if requested.
1225 if (HasDwarfPubSections) {
David Blaikiee56a4d92013-09-19 17:33:35 +00001226 emitDebugPubNames(GenerateGnuPubSections);
1227 emitDebugPubTypes(GenerateGnuPubSections);
Eric Christopher26123542013-08-30 00:40:17 +00001228 }
Devang Patel193f7202009-11-24 01:14:22 +00001229
Devang Patele9a1cca2010-08-02 17:32:15 +00001230 // clean up.
Devang Patel94c7ddb2011-08-16 22:09:43 +00001231 SPMap.clear();
Devang Patel163a9f72010-05-10 22:49:55 +00001232 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1233 E = CUMap.end(); I != E; ++I)
1234 delete I->second;
Eric Christopher9ec87b32012-12-10 19:51:18 +00001235
Craig Topper2d785db2013-07-03 04:17:25 +00001236 for (SmallVectorImpl<CompileUnit *>::iterator I = SkeletonCUs.begin(),
Eric Christopher01776a52013-02-06 21:53:56 +00001237 E = SkeletonCUs.end(); I != E; ++I)
1238 delete *I;
Eric Christopher9ec87b32012-12-10 19:51:18 +00001239
Eric Christopher98e237f2012-11-30 23:59:06 +00001240 // Reset these for the next Module if we have one.
1241 FirstCU = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001242}
1243
Eric Christopherb6dc8652012-11-27 22:43:45 +00001244// Find abstract variable, if any, associated with Var.
Devang Patelb549bcf2011-08-10 21:50:54 +00001245DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattnerde4845c2010-04-02 19:42:39 +00001246 DebugLoc ScopeLoc) {
Devang Patelb549bcf2011-08-10 21:50:54 +00001247 LLVMContext &Ctx = DV->getContext();
1248 // More then one inlined variable corresponds to one abstract variable.
1249 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patel2db49d72010-05-07 18:11:54 +00001250 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00001251 if (AbsDbgVariable)
1252 return AbsDbgVariable;
1253
Devang Patelbf47fdb2011-08-10 20:55:27 +00001254 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00001255 if (!Scope)
1256 return NULL;
1257
Manman Renc664d762013-10-05 01:43:03 +00001258 AbsDbgVariable = new DbgVariable(Var, NULL, this);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001259 addScopeVariable(Scope, AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00001260 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00001261 return AbsDbgVariable;
1262}
1263
Eric Christopherb6dc8652012-11-27 22:43:45 +00001264// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel0478c152011-03-01 22:58:55 +00001265bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patelbf47fdb2011-08-10 20:55:27 +00001266 DbgVariable *Var, LexicalScope *Scope) {
1267 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +00001268 return false;
1269 DIVariable DV = Var->getVariable();
1270 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1271 return false;
1272 unsigned ArgNo = DV.getArgNumber();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001273 if (ArgNo == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001274 return false;
1275
Devang Patelcb3a6572011-03-03 20:02:02 +00001276 size_t Size = CurrentFnArguments.size();
1277 if (Size == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001278 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patelbbd0f452011-03-03 21:49:41 +00001279 // llvm::Function argument size is not good indicator of how many
Devang Patel6f676be2011-03-03 20:08:10 +00001280 // arguments does the function have at source level.
1281 if (ArgNo > Size)
Devang Patelcb3a6572011-03-03 20:02:02 +00001282 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel0478c152011-03-01 22:58:55 +00001283 CurrentFnArguments[ArgNo - 1] = Var;
1284 return true;
1285}
1286
Eric Christopherb6dc8652012-11-27 22:43:45 +00001287// Collect variable information from side table maintained by MMI.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001288void
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001289DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patelee432862010-05-20 19:57:06 +00001290 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patele717faa2009-10-06 01:26:37 +00001291 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1292 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1293 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00001294 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00001295 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00001296 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00001297 DIVariable DV(Var);
1298 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00001299
Devang Patelbf47fdb2011-08-10 20:55:27 +00001300 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001301
Devang Patelfb0ee432009-11-10 23:20:04 +00001302 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00001303 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00001304 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00001305
Devang Patel26c1e562010-05-20 16:36:41 +00001306 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Manman Renc664d762013-10-05 01:43:03 +00001307 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
Devang Patelff9dd0a2011-08-15 21:24:36 +00001308 RegVar->setFrameIndex(VP.first);
Devang Patel0478c152011-03-01 22:58:55 +00001309 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001310 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001311 if (AbsDbgVariable)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001312 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patele717faa2009-10-06 01:26:37 +00001313 }
Devang Patelee432862010-05-20 19:57:06 +00001314}
Devang Patel90a48ad2010-03-15 18:33:46 +00001315
Eric Christopherb6dc8652012-11-27 22:43:45 +00001316// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1317// defined reg.
Devang Patelc3f5f782010-05-25 23:40:22 +00001318static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001319 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001320 return MI->getNumOperands() == 3 &&
1321 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
Adrian Prantl35176402013-07-09 20:28:37 +00001322 (MI->getOperand(1).isImm() ||
1323 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
Devang Patelc3f5f782010-05-25 23:40:22 +00001324}
1325
Eric Christopherb6dc8652012-11-27 22:43:45 +00001326// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001327static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1328 const MCSymbol *FLabel,
Devang Patel90b40412011-07-08 17:09:57 +00001329 const MCSymbol *SLabel,
1330 const MachineInstr *MI) {
1331 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1332
David Blaikie6d9dbd52013-06-16 20:34:15 +00001333 assert(MI->getNumOperands() == 3);
Adrian Prantl35176402013-07-09 20:28:37 +00001334 if (MI->getOperand(0).isReg()) {
Devang Patel90b40412011-07-08 17:09:57 +00001335 MachineLocation MLoc;
Adrian Prantl35176402013-07-09 20:28:37 +00001336 // If the second operand is an immediate, this is a
1337 // register-indirect address.
1338 if (!MI->getOperand(1).isImm())
Adrian Prantl13131e62013-04-26 21:57:17 +00001339 MLoc.set(MI->getOperand(0).getReg());
1340 else
1341 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel90b40412011-07-08 17:09:57 +00001342 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1343 }
1344 if (MI->getOperand(0).isImm())
1345 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1346 if (MI->getOperand(0).isFPImm())
1347 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1348 if (MI->getOperand(0).isCImm())
1349 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1350
Craig Topper5e25ee82012-02-05 08:31:47 +00001351 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel90b40412011-07-08 17:09:57 +00001352}
1353
Eric Christopherb6dc8652012-11-27 22:43:45 +00001354// Find variables for each lexical scope.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001355void
Devang Patel78e127d2010-06-25 22:07:34 +00001356DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1357 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00001358
Eric Christopher4e976452013-07-03 21:37:03 +00001359 // Grab the variable info that was squirreled away in the MMI side-table.
Devang Patelee432862010-05-20 19:57:06 +00001360 collectVariableInfoFromMMITable(MF, Processed);
1361
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001362 for (SmallVectorImpl<const MDNode*>::const_iterator
1363 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1364 ++UVI) {
1365 const MDNode *Var = *UVI;
1366 if (Processed.count(Var))
Devang Patelee432862010-05-20 19:57:06 +00001367 continue;
1368
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001369 // History contains relevant DBG_VALUE instructions for Var and instructions
1370 // clobbering it.
1371 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1372 if (History.empty())
1373 continue;
1374 const MachineInstr *MInsn = History.front();
Devang Patelc3f5f782010-05-25 23:40:22 +00001375
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001376 DIVariable DV(Var);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001377 LexicalScope *Scope = NULL;
Devang Pateld8720f42010-05-27 20:25:04 +00001378 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1379 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001380 Scope = LScopes.getCurrentFunctionScope();
David Blaikiec0ec8a42013-03-11 23:39:23 +00001381 else if (MDNode *IA = DV.getInlinedAt())
1382 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1383 else
1384 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patelee432862010-05-20 19:57:06 +00001385 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00001386 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00001387 continue;
1388
1389 Processed.insert(DV);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001390 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel5a1a67c2011-08-15 19:01:20 +00001391 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
Manman Renc664d762013-10-05 01:43:03 +00001392 DbgVariable *RegVar = new DbgVariable(DV, AbsVar, this);
Devang Patel0478c152011-03-01 22:58:55 +00001393 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001394 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001395 if (AbsVar)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001396 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001397
Eric Christopherc56e3f02012-10-08 20:48:54 +00001398 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001399 if (History.size() <= 1 || (History.size() == 2 &&
1400 MInsn->isIdenticalTo(History.back()))) {
Devang Patelff9dd0a2011-08-15 21:24:36 +00001401 RegVar->setMInsn(MInsn);
Devang Patelc3f5f782010-05-25 23:40:22 +00001402 continue;
1403 }
1404
Eric Christopher498703b2013-01-28 17:33:26 +00001405 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001406 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001407
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001408 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1409 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1410 const MachineInstr *Begin = *HI;
1411 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesene17232e2011-03-22 00:21:41 +00001412
Devang Patel4ada1d72011-06-01 23:00:17 +00001413 // Check if DBG_VALUE is truncating a range.
1414 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1415 && !Begin->getOperand(0).getReg())
1416 continue;
1417
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001418 // Compute the range for a register location.
1419 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1420 const MCSymbol *SLabel = 0;
1421
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001422 if (HI + 1 == HE)
1423 // If Begin is the last instruction in History then its value is valid
Chris Lattner7a2bdde2011-04-15 05:18:47 +00001424 // until the end of the function.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001425 SLabel = FunctionEndSym;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001426 else {
1427 const MachineInstr *End = HI[1];
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001428 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel476df5f2011-07-07 21:44:42 +00001429 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001430 if (End->isDebugValue())
1431 SLabel = getLabelBeforeInsn(End);
1432 else {
1433 // End is a normal instruction clobbering the range.
1434 SLabel = getLabelAfterInsn(End);
1435 assert(SLabel && "Forgot label after clobber instruction");
1436 ++HI;
1437 }
1438 }
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001439
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001440 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopherabbb2002011-12-16 23:42:31 +00001441 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1442 Begin));
Devang Patelc3f5f782010-05-25 23:40:22 +00001443 }
1444 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00001445 }
Devang Patel98e1cac2010-05-14 21:01:35 +00001446
1447 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001448 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1449 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1450 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1451 DIVariable DV(Variables.getElement(i));
Manman Rend03d2b22013-07-08 18:33:29 +00001452 if (!DV || !DV.isVariable() || !Processed.insert(DV))
Devang Patel93d39be2011-08-19 23:28:12 +00001453 continue;
1454 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
Manman Renc664d762013-10-05 01:43:03 +00001455 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patel98e1cac2010-05-14 21:01:35 +00001456 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001457}
Devang Patel98e1cac2010-05-14 21:01:35 +00001458
Eric Christopherb6dc8652012-11-27 22:43:45 +00001459// Return Label preceding the instruction.
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001460MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001461 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1462 assert(Label && "Didn't insert label before instruction");
1463 return Label;
Devang Patelc3f5f782010-05-25 23:40:22 +00001464}
1465
Eric Christopherb6dc8652012-11-27 22:43:45 +00001466// Return Label immediately following the instruction.
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001467MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001468 return LabelsAfterInsn.lookup(MI);
Devang Patele717faa2009-10-06 01:26:37 +00001469}
1470
Eric Christopherb6dc8652012-11-27 22:43:45 +00001471// Process beginning of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001472void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001473 // Check if source location changes, but ignore DBG_VALUE locations.
1474 if (!MI->isDebugValue()) {
1475 DebugLoc DL = MI->getDebugLoc();
1476 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopher60b35f42012-04-05 20:39:05 +00001477 unsigned Flags = 0;
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001478 PrevInstLoc = DL;
Devang Patel4243e672011-05-11 19:22:19 +00001479 if (DL == PrologEndLoc) {
1480 Flags |= DWARF2_FLAG_PROLOGUE_END;
1481 PrologEndLoc = DebugLoc();
1482 }
Eric Christopher60b35f42012-04-05 20:39:05 +00001483 if (PrologEndLoc.isUnknown())
1484 Flags |= DWARF2_FLAG_IS_STMT;
1485
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001486 if (!DL.isUnknown()) {
1487 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel4243e672011-05-11 19:22:19 +00001488 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001489 } else
Devang Patel4243e672011-05-11 19:22:19 +00001490 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001491 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001492 }
Devang Patelaead63c2010-03-29 22:59:58 +00001493
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001494 // Insert labels where requested.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001495 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1496 LabelsBeforeInsn.find(MI);
1497
1498 // No label needed.
1499 if (I == LabelsBeforeInsn.end())
1500 return;
1501
1502 // Label already assigned.
1503 if (I->second)
Devang Patelb2b31a62010-05-26 19:37:24 +00001504 return;
Devang Patel553881b2010-03-29 17:20:31 +00001505
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001506 if (!PrevLabel) {
Devang Patel77051f52010-05-26 21:23:46 +00001507 PrevLabel = MMI->getContext().CreateTempSymbol();
1508 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00001509 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001510 I->second = PrevLabel;
Devang Patel0d20ac82009-10-06 01:50:42 +00001511}
1512
Eric Christopherb6dc8652012-11-27 22:43:45 +00001513// Process end of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001514void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001515 // Don't create a new label after DBG_VALUE instructions.
1516 // They don't generate code.
1517 if (!MI->isDebugValue())
1518 PrevLabel = 0;
1519
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001520 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1521 LabelsAfterInsn.find(MI);
1522
1523 // No label needed.
1524 if (I == LabelsAfterInsn.end())
1525 return;
1526
1527 // Label already assigned.
1528 if (I->second)
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001529 return;
1530
1531 // We need a label after this instruction.
1532 if (!PrevLabel) {
1533 PrevLabel = MMI->getContext().CreateTempSymbol();
1534 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel1c246352010-04-08 16:50:29 +00001535 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001536 I->second = PrevLabel;
Devang Patel53bb5c92009-11-10 23:06:00 +00001537}
1538
Eric Christopherb6dc8652012-11-27 22:43:45 +00001539// Each LexicalScope has first instruction and last instruction to mark
1540// beginning and end of a scope respectively. Create an inverse map that list
1541// scopes starts (and ends) with an instruction. One instruction may start (or
1542// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00001543void DwarfDebug::identifyScopeMarkers() {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001544 SmallVector<LexicalScope *, 4> WorkList;
1545 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel42aafd72010-01-20 02:05:23 +00001546 while (!WorkList.empty()) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001547 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001548
Craig Topper9f43ac62013-07-03 04:24:43 +00001549 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001550 if (!Children.empty())
Craig Topper2d785db2013-07-03 04:17:25 +00001551 for (SmallVectorImpl<LexicalScope *>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00001552 SE = Children.end(); SI != SE; ++SI)
1553 WorkList.push_back(*SI);
1554
Devang Patel53bb5c92009-11-10 23:06:00 +00001555 if (S->isAbstractScope())
1556 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001557
Craig Topper9f43ac62013-07-03 04:24:43 +00001558 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
Devang Pateleac9c072010-04-27 19:46:33 +00001559 if (Ranges.empty())
1560 continue;
Craig Topper2d785db2013-07-03 04:17:25 +00001561 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +00001562 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001563 assert(RI->first && "InsnRange does not have first instruction!");
1564 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001565 requestLabelBeforeInsn(RI->first);
1566 requestLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001567 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001568 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001569}
1570
Eric Christopherb6dc8652012-11-27 22:43:45 +00001571// Get MDNode for DebugLoc's scope.
Devang Patela3f48672011-05-09 22:14:49 +00001572static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1573 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1574 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1575 return DL.getScope(Ctx);
1576}
1577
Eric Christopherb6dc8652012-11-27 22:43:45 +00001578// Walk up the scope chain of given debug loc and find line number info
1579// for the function.
Devang Patel4243e672011-05-11 19:22:19 +00001580static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1581 const MDNode *Scope = getScopeNode(DL, Ctx);
1582 DISubprogram SP = getDISubprogram(Scope);
Manman Rend03d2b22013-07-08 18:33:29 +00001583 if (SP.isSubprogram()) {
Eric Christopher6126a1e2012-04-03 00:43:49 +00001584 // Check for number of operands since the compatibility is
1585 // cheap here.
Eric Christopherfa5b0502012-04-03 17:55:42 +00001586 if (SP->getNumOperands() > 19)
Eric Christopher6126a1e2012-04-03 00:43:49 +00001587 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1588 else
1589 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1590 }
1591
Devang Patel4243e672011-05-11 19:22:19 +00001592 return DebugLoc();
1593}
1594
Eric Christopherb6dc8652012-11-27 22:43:45 +00001595// Gather pre-function debug information. Assumes being called immediately
1596// after the function entry point has been emitted.
Chris Lattnereec791a2010-01-26 23:18:02 +00001597void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00001598 if (!MMI->hasDebugInfo()) return;
Devang Patelbf47fdb2011-08-10 20:55:27 +00001599 LScopes.initialize(*MF);
1600 if (LScopes.empty()) return;
1601 identifyScopeMarkers();
Devang Patel60b35bd2009-10-06 18:37:31 +00001602
Manman Ren43213cf2013-02-05 21:52:47 +00001603 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1604 // belongs to.
1605 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1606 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1607 assert(TheCU && "Unable to find compile unit!");
Rafael Espindola5e195a42013-10-05 16:42:21 +00001608 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren01cb18e2013-05-21 00:57:22 +00001609 // Use a single line table if we are using .loc and generating assembly.
1610 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1611 else
1612 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
Manman Ren43213cf2013-02-05 21:52:47 +00001613
Devang Pateleac9c072010-04-27 19:46:33 +00001614 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1615 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001616 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00001617 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001618
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001619 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1620
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001621 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopherb6dc8652012-11-27 22:43:45 +00001622 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001623 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1624
Devang Patelb2b31a62010-05-26 19:37:24 +00001625 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001626 I != E; ++I) {
1627 bool AtBlockEntry = true;
Devang Patelb2b31a62010-05-26 19:37:24 +00001628 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1629 II != IE; ++II) {
1630 const MachineInstr *MI = II;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001631
Devang Patelb2b31a62010-05-26 19:37:24 +00001632 if (MI->isDebugValue()) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001633 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001634
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001635 // Keep track of user variables.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001636 const MDNode *Var =
1637 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001638
1639 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001640 if (isDbgValueInDefinedReg(MI))
1641 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1642
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001643 // Check the history of this variable.
1644 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1645 if (History.empty()) {
1646 UserVariables.push_back(Var);
1647 // The first mention of a function argument gets the FunctionBeginSym
1648 // label, so arguments are visible when breaking at function entry.
1649 DIVariable DV(Var);
Manman Rend03d2b22013-07-08 18:33:29 +00001650 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001651 DISubprogram(getDISubprogram(DV.getContext()))
1652 .describes(MF->getFunction()))
1653 LabelsBeforeInsn[MI] = FunctionBeginSym;
1654 } else {
1655 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1656 const MachineInstr *Prev = History.back();
1657 if (Prev->isDebugValue()) {
1658 // Coalesce identical entries at the end of History.
1659 if (History.size() >= 2 &&
Devang Patel79862892011-07-07 00:14:27 +00001660 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher02c1a642012-10-08 20:48:49 +00001661 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001662 << "\t" << *Prev
Devang Patel79862892011-07-07 00:14:27 +00001663 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001664 History.pop_back();
Devang Patel79862892011-07-07 00:14:27 +00001665 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001666
1667 // Terminate old register assignments that don't reach MI;
1668 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1669 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1670 isDbgValueInDefinedReg(Prev)) {
1671 // Previous register assignment needs to terminate at the end of
1672 // its basic block.
1673 MachineBasicBlock::const_iterator LastMI =
1674 PrevMBB->getLastNonDebugInstr();
Devang Patel79862892011-07-07 00:14:27 +00001675 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001676 // Drop DBG_VALUE for empty range.
Eric Christopher02c1a642012-10-08 20:48:49 +00001677 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patel79862892011-07-07 00:14:27 +00001678 << "\t" << *Prev << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001679 History.pop_back();
David Blaikie4532c282013-06-20 00:25:24 +00001680 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001681 // Terminate after LastMI.
1682 History.push_back(LastMI);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001683 }
1684 }
1685 }
1686 History.push_back(MI);
Devang Patelb2b31a62010-05-26 19:37:24 +00001687 } else {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001688 // Not a DBG_VALUE instruction.
1689 if (!MI->isLabel())
1690 AtBlockEntry = false;
1691
Eric Christopher0313ced2012-10-04 20:46:14 +00001692 // First known non-DBG_VALUE and non-frame setup location marks
1693 // the beginning of the function body.
1694 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1695 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel4243e672011-05-11 19:22:19 +00001696 PrologEndLoc = MI->getDebugLoc();
1697
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001698 // Check if the instruction clobbers any registers with debug vars.
1699 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1700 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1701 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1702 continue;
Jakob Stoklund Olesen396618b2012-06-01 23:28:30 +00001703 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1704 AI.isValid(); ++AI) {
1705 unsigned Reg = *AI;
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001706 const MDNode *Var = LiveUserVar[Reg];
1707 if (!Var)
1708 continue;
1709 // Reg is now clobbered.
1710 LiveUserVar[Reg] = 0;
1711
1712 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001713 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1714 if (HistI == DbgValues.end())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001715 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001716 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1717 if (History.empty())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001718 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001719 const MachineInstr *Prev = History.back();
1720 // Sanity-check: Register assignments are terminated at the end of
1721 // their block.
1722 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1723 continue;
1724 // Is the variable still in Reg?
1725 if (!isDbgValueInDefinedReg(Prev) ||
1726 Prev->getOperand(0).getReg() != Reg)
1727 continue;
1728 // Var is clobbered. Make sure the next instruction gets a label.
1729 History.push_back(MI);
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001730 }
1731 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001732 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001733 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001734 }
1735
1736 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1737 I != E; ++I) {
1738 SmallVectorImpl<const MachineInstr*> &History = I->second;
1739 if (History.empty())
1740 continue;
1741
1742 // Make sure the final register assignments are terminated.
1743 const MachineInstr *Prev = History.back();
1744 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1745 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001746 MachineBasicBlock::const_iterator LastMI =
Devang Patel5bc942c2011-08-10 23:58:09 +00001747 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001748 if (LastMI == PrevMBB->end())
1749 // Drop DBG_VALUE for empty range.
1750 History.pop_back();
David Blaikie4532c282013-06-20 00:25:24 +00001751 else if (PrevMBB != &PrevMBB->getParent()->back()) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001752 // Terminate after LastMI.
1753 History.push_back(LastMI);
1754 }
1755 }
1756 // Request labels for the full history.
1757 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1758 const MachineInstr *MI = History[i];
1759 if (MI->isDebugValue())
1760 requestLabelBeforeInsn(MI);
1761 else
1762 requestLabelAfterInsn(MI);
1763 }
1764 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001765
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001766 PrevInstLoc = DebugLoc();
Devang Patelb2b31a62010-05-26 19:37:24 +00001767 PrevLabel = FunctionBeginSym;
Devang Patel4243e672011-05-11 19:22:19 +00001768
1769 // Record beginning of function.
1770 if (!PrologEndLoc.isUnknown()) {
1771 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1772 MF->getFunction()->getContext());
1773 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1774 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie836cfc42012-12-04 22:02:33 +00001775 // We'd like to list the prologue as "not statements" but GDB behaves
1776 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikieb36c5312012-12-04 21:05:36 +00001777 DWARF2_FLAG_IS_STMT);
Devang Patel4243e672011-05-11 19:22:19 +00001778 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001779}
1780
Devang Patelbf47fdb2011-08-10 20:55:27 +00001781void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
David Blaikie032d6242013-06-05 05:39:59 +00001782 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1783 DIVariable DV = Var->getVariable();
David Blaikieb20fdff2013-06-06 21:04:51 +00001784 // Variables with positive arg numbers are parameters.
1785 if (unsigned ArgNum = DV.getArgNumber()) {
1786 // Keep all parameters in order at the start of the variable list to ensure
1787 // function types are correct (no out-of-order parameters)
1788 //
1789 // This could be improved by only doing it for optimized builds (unoptimized
1790 // builds have the right order to begin with), searching from the back (this
1791 // would catch the unoptimized case quickly), or doing a binary search
1792 // rather than linear search.
1793 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1794 while (I != Vars.end()) {
1795 unsigned CurNum = (*I)->getVariable().getArgNumber();
1796 // A local (non-parameter) variable has been found, insert immediately
1797 // before it.
1798 if (CurNum == 0)
1799 break;
1800 // A later indexed parameter has been found, insert immediately before it.
David Blaikiebabfebb2013-06-06 22:28:26 +00001801 if (CurNum > ArgNum)
David Blaikieb20fdff2013-06-06 21:04:51 +00001802 break;
David Blaikiebabfebb2013-06-06 22:28:26 +00001803 ++I;
David Blaikie032d6242013-06-05 05:39:59 +00001804 }
David Blaikieb20fdff2013-06-06 21:04:51 +00001805 Vars.insert(I, Var);
1806 return;
David Blaikie032d6242013-06-05 05:39:59 +00001807 }
1808
1809 Vars.push_back(Var);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001810}
1811
Eric Christopherb6dc8652012-11-27 22:43:45 +00001812// Gather and emit post-function debug information.
Chris Lattnereec791a2010-01-26 23:18:02 +00001813void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001814 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00001815
Devang Patelbf47fdb2011-08-10 20:55:27 +00001816 // Define end label for subprogram.
1817 FunctionEndSym = Asm->GetTempSymbol("func_end",
1818 Asm->getFunctionNumber());
1819 // Assumes in correct section after the entry point.
1820 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Manman Ren43213cf2013-02-05 21:52:47 +00001821 // Set DwarfCompileUnitID in MCContext to default value.
1822 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001823
Devang Patelbf47fdb2011-08-10 20:55:27 +00001824 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1825 collectVariableInfo(MF, ProcessedVars);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001826
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001827 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Patel94c7ddb2011-08-16 22:09:43 +00001828 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky746cb672011-10-26 22:55:33 +00001829 assert(TheCU && "Unable to find compile unit!");
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001830
Devang Patelbf47fdb2011-08-10 20:55:27 +00001831 // Construct abstract scopes.
Devang Patelcd9f6c52011-08-12 18:10:19 +00001832 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1833 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1834 LexicalScope *AScope = AList[i];
1835 DISubprogram SP(AScope->getScopeNode());
Manman Rend03d2b22013-07-08 18:33:29 +00001836 if (SP.isSubprogram()) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001837 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001838 DIArray Variables = SP.getVariables();
1839 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1840 DIVariable DV(Variables.getElement(i));
Manman Rend03d2b22013-07-08 18:33:29 +00001841 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
Devang Patel93d39be2011-08-19 23:28:12 +00001842 continue;
Alexey Samsonovb67bd332012-07-06 08:45:08 +00001843 // Check that DbgVariable for DV wasn't created earlier, when
1844 // findAbstractVariable() was called for inlined instance of DV.
1845 LLVMContext &Ctx = DV->getContext();
1846 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1847 if (AbstractVariables.lookup(CleanDV))
1848 continue;
Devang Patel93d39be2011-08-19 23:28:12 +00001849 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
Manman Renc664d762013-10-05 01:43:03 +00001850 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patel78e127d2010-06-25 22:07:34 +00001851 }
1852 }
Devang Patelcd9f6c52011-08-12 18:10:19 +00001853 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Manman Ren742671b2013-05-29 17:16:59 +00001854 constructScopeDIE(TheCU, AScope);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001855 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001856
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001857 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001858
Nick Lewycky8a8d4792011-12-02 22:16:29 +00001859 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopher873cf0a2012-08-24 01:14:27 +00001860 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001861
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001862 // Clear debug info
Craig Topper01eb99a2013-07-03 04:40:27 +00001863 for (ScopeVariablesMap::iterator
Devang Patelbf47fdb2011-08-10 20:55:27 +00001864 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1865 DeleteContainerPointers(I->second);
1866 ScopeVariables.clear();
Devang Pateleac0c9d2011-04-22 18:09:57 +00001867 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001868 UserVariables.clear();
1869 DbgValues.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001870 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00001871 LabelsBeforeInsn.clear();
1872 LabelsAfterInsn.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00001873 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001874}
1875
Eric Christopherb6dc8652012-11-27 22:43:45 +00001876// Register a source line with debug info. Returns the unique label that was
1877// emitted and which provides correspondence to the source line list.
Devang Patel4243e672011-05-11 19:22:19 +00001878void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1879 unsigned Flags) {
Devang Patel65dbc902009-11-25 17:36:49 +00001880 StringRef Fn;
Devang Patel23670e52011-03-24 20:30:50 +00001881 StringRef Dir;
Dan Gohman1cc0d622010-05-05 23:41:32 +00001882 unsigned Src = 1;
1883 if (S) {
1884 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00001885
Dan Gohman1cc0d622010-05-05 23:41:32 +00001886 if (Scope.isCompileUnit()) {
1887 DICompileUnit CU(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001888 Fn = CU.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001889 Dir = CU.getDirectory();
Devang Patel3cabc9d2010-10-28 17:30:52 +00001890 } else if (Scope.isFile()) {
1891 DIFile F(S);
Devang Patel3cabc9d2010-10-28 17:30:52 +00001892 Fn = F.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001893 Dir = F.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001894 } else if (Scope.isSubprogram()) {
1895 DISubprogram SP(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001896 Fn = SP.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001897 Dir = SP.getDirectory();
Eric Christopher6618a242011-10-11 22:59:11 +00001898 } else if (Scope.isLexicalBlockFile()) {
1899 DILexicalBlockFile DBF(S);
1900 Fn = DBF.getFilename();
1901 Dir = DBF.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001902 } else if (Scope.isLexicalBlock()) {
1903 DILexicalBlock DB(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001904 Fn = DB.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001905 Dir = DB.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001906 } else
Craig Topper5e25ee82012-02-05 08:31:47 +00001907 llvm_unreachable("Unexpected scope info");
Dan Gohman1cc0d622010-05-05 23:41:32 +00001908
Manman Ren3de61b42013-03-07 01:42:00 +00001909 Src = getOrCreateSourceID(Fn, Dir,
1910 Asm->OutStreamer.getContext().getDwarfCompileUnitID());
Dan Gohman1cc0d622010-05-05 23:41:32 +00001911 }
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001912 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001913}
1914
Bill Wendling829e67b2009-05-20 23:22:40 +00001915//===----------------------------------------------------------------------===//
1916// Emit Methods
1917//===----------------------------------------------------------------------===//
1918
Eric Christopherb6dc8652012-11-27 22:43:45 +00001919// Compute the size and offset of a DIE.
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001920unsigned
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001921DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001922 // Get the children.
1923 const std::vector<DIE *> &Children = Die->getChildren();
1924
Bill Wendling94d04b82009-05-20 23:21:38 +00001925 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001926 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00001927
1928 // Get the abbreviation for this DIE.
1929 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001930 const DIEAbbrev *Abbrev = Abbreviations->at(AbbrevNumber - 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00001931
1932 // Set DIE offset
1933 Die->setOffset(Offset);
1934
1935 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00001936 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001937
Eric Christopherf7cef702013-03-29 23:34:06 +00001938 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1939 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling94d04b82009-05-20 23:21:38 +00001940
1941 // Size the DIE attribute values.
1942 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1943 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00001944 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00001945
1946 // Size the DIE children if any.
1947 if (!Children.empty()) {
1948 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1949 "Children flag not set");
1950
1951 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopherfbd19752012-11-20 22:14:13 +00001952 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling94d04b82009-05-20 23:21:38 +00001953
1954 // End of children marker.
1955 Offset += sizeof(int8_t);
1956 }
1957
1958 Die->setSize(Offset - Die->getOffset());
1959 return Offset;
1960}
1961
Eric Christopher39cd7d42013-10-24 21:05:08 +00001962// Compute the size and offset for each DIE.
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001963void DwarfUnits::computeSizeAndOffsets() {
Eric Christopher39cd7d42013-10-24 21:05:08 +00001964 // Iterate over each compile unit and set the size and offsets for each
1965 // DIE within each compile unit. All offsets are CU relative.
Eric Christopherf7cef702013-03-29 23:34:06 +00001966 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001967 E = CUs.end(); I != E; ++I) {
Eric Christopher98e237f2012-11-30 23:59:06 +00001968 unsigned Offset =
1969 sizeof(int32_t) + // Length of Compilation Unit Info
1970 sizeof(int16_t) + // DWARF version number
1971 sizeof(int32_t) + // Offset Into Abbrev. Section
1972 sizeof(int8_t); // Pointer Size (in bytes)
Eric Christophere7099f62013-10-04 19:40:33 +00001973 computeSizeAndOffset((*I)->getCUDie(), Offset);
Devang Patel163a9f72010-05-10 22:49:55 +00001974 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001975}
1976
Eric Christopherb6dc8652012-11-27 22:43:45 +00001977// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001978void DwarfDebug::emitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001979 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001980
Bill Wendling94d04b82009-05-20 23:21:38 +00001981 // Dwarf sections base addresses.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001982 DwarfInfoSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001983 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00001984 DwarfAbbrevSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001985 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher6eebe472012-12-19 22:02:53 +00001986 if (useSplitDwarf())
1987 DwarfAbbrevDWOSectionSym =
1988 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1989 "section_abbrev_dwo");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001990 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001991
Chris Lattner9c69e285532010-04-04 22:59:04 +00001992 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001993 emitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00001994
Eric Christopher7a0103c2013-02-07 21:19:50 +00001995 DwarfLineSectionSym =
1996 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001997 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Eric Christophercdeaae42013-09-23 20:55:35 +00001998 if (GenerateGnuPubSections) {
Eric Christophera6d84152013-09-30 23:14:16 +00001999 DwarfGnuPubNamesSectionSym =
2000 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
2001 DwarfGnuPubTypesSectionSym =
2002 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
Eric Christophercdeaae42013-09-23 20:55:35 +00002003 } else if (HasDwarfPubSections) {
2004 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2005 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Michael Gottesmandc42d032013-09-04 04:39:38 +00002006 }
Eric Christopher8f1a9292013-09-13 00:35:05 +00002007
Jim Grosbach1e20b962010-07-21 21:21:52 +00002008 DwarfStrSectionSym =
Eric Christopher64f824c2012-12-27 02:14:01 +00002009 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002010 if (useSplitDwarf()) {
Eric Christopher64f824c2012-12-27 02:14:01 +00002011 DwarfStrDWOSectionSym =
2012 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002013 DwarfAddrSectionSym =
2014 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
2015 }
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002016 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patelf2548ca2010-04-16 23:33:45 +00002017 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00002018
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002019 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patelc3f5f782010-05-25 23:40:22 +00002020 "section_debug_loc");
2021
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002022 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
2023 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002024}
2025
Eric Christopherb6dc8652012-11-27 22:43:45 +00002026// Recursively emits a debug information entry.
Eric Christopher6eebe472012-12-19 22:02:53 +00002027void DwarfDebug::emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002028 // Get the abbreviation for this DIE.
2029 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher6eebe472012-12-19 22:02:53 +00002030 const DIEAbbrev *Abbrev = Abbrevs->at(AbbrevNumber - 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00002031
Bill Wendling94d04b82009-05-20 23:21:38 +00002032 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00002033 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00002034 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2035 Twine::utohexstr(Die->getOffset()) + ":0x" +
2036 Twine::utohexstr(Die->getSize()) + " " +
2037 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002038 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00002039
Eric Christopherf7cef702013-03-29 23:34:06 +00002040 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
2041 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling94d04b82009-05-20 23:21:38 +00002042
2043 // Emit the DIE attribute values.
2044 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
David Blaikie770530b2013-10-21 17:28:37 +00002045 dwarf::Attribute Attr = AbbrevData[i].getAttribute();
2046 dwarf::Form Form = AbbrevData[i].getForm();
Bill Wendling94d04b82009-05-20 23:21:38 +00002047 assert(Form && "Too many attributes for DIE (check abbreviation)");
2048
Chris Lattner3f53c832010-04-04 18:52:31 +00002049 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00002050 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002051
Bill Wendling94d04b82009-05-20 23:21:38 +00002052 switch (Attr) {
Devang Patelf2548ca2010-04-16 23:33:45 +00002053 case dwarf::DW_AT_ranges: {
2054 // DW_AT_range Value encodes offset in debug_range section.
2055 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelb1fcfbe2010-09-02 16:43:44 +00002056
Nick Lewyckyffccd922012-06-22 01:25:12 +00002057 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelb1fcfbe2010-09-02 16:43:44 +00002058 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
2059 V->getValue(),
2060 4);
2061 } else {
2062 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
2063 V->getValue(),
2064 DwarfDebugRangeSectionSym,
2065 4);
2066 }
Devang Patelf2548ca2010-04-16 23:33:45 +00002067 break;
2068 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002069 case dwarf::DW_AT_location: {
Nick Lewyckyffccd922012-06-22 01:25:12 +00002070 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2071 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Ulrich Weigand1f8aacd2013-07-02 18:46:26 +00002072 Asm->EmitLabelReference(L->getValue(), 4);
Nick Lewyckyffccd922012-06-22 01:25:12 +00002073 else
Ulrich Weigand1f8aacd2013-07-02 18:46:26 +00002074 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewyckyffccd922012-06-22 01:25:12 +00002075 } else {
Devang Patelc3f5f782010-05-25 23:40:22 +00002076 Values[i]->EmitValue(Asm, Form);
Nick Lewyckyffccd922012-06-22 01:25:12 +00002077 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002078 break;
2079 }
Devang Patel2a361602010-09-29 19:08:08 +00002080 case dwarf::DW_AT_accessibility: {
2081 if (Asm->isVerbose()) {
2082 DIEInteger *V = cast<DIEInteger>(Values[i]);
2083 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2084 }
2085 Values[i]->EmitValue(Asm, Form);
2086 break;
2087 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002088 default:
2089 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002090 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00002091 break;
2092 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002093 }
2094
2095 // Emit the DIE children if any.
2096 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2097 const std::vector<DIE *> &Children = Die->getChildren();
2098
2099 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher6eebe472012-12-19 22:02:53 +00002100 emitDIE(Children[j], Abbrevs);
Bill Wendling94d04b82009-05-20 23:21:38 +00002101
Chris Lattner3f53c832010-04-04 18:52:31 +00002102 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00002103 Asm->OutStreamer.AddComment("End Of Children Mark");
2104 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00002105 }
2106}
2107
Eric Christopherb1e66d02012-12-15 00:04:07 +00002108// Emit the various dwarf units to the unit section USection with
2109// the abbreviations going into ASection.
2110void DwarfUnits::emitUnits(DwarfDebug *DD,
2111 const MCSection *USection,
2112 const MCSection *ASection,
2113 const MCSymbol *ASectionSym) {
2114 Asm->OutStreamer.SwitchSection(USection);
Eric Christopherf7cef702013-03-29 23:34:06 +00002115 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopherb1e66d02012-12-15 00:04:07 +00002116 E = CUs.end(); I != E; ++I) {
2117 CompileUnit *TheCU = *I;
Devang Patel163a9f72010-05-10 22:49:55 +00002118 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002119
Devang Patel163a9f72010-05-10 22:49:55 +00002120 // Emit the compile units header.
Eric Christopherb1e66d02012-12-15 00:04:07 +00002121 Asm->OutStreamer
2122 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
2123 TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002124
Devang Patel163a9f72010-05-10 22:49:55 +00002125 // Emit size of content not including length itself
2126 unsigned ContentSize = Die->getSize() +
2127 sizeof(int16_t) + // DWARF version number
2128 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patel65705d52011-04-13 19:41:17 +00002129 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbach1e20b962010-07-21 21:21:52 +00002130
Devang Patel163a9f72010-05-10 22:49:55 +00002131 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2132 Asm->EmitInt32(ContentSize);
2133 Asm->OutStreamer.AddComment("DWARF version number");
Manman Ren0e6783f2013-07-02 23:40:10 +00002134 Asm->EmitInt16(DD->getDwarfVersion());
Devang Patel163a9f72010-05-10 22:49:55 +00002135 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
Eric Christopherb1e66d02012-12-15 00:04:07 +00002136 Asm->EmitSectionOffset(Asm->GetTempSymbol(ASection->getLabelBeginName()),
2137 ASectionSym);
Devang Patel163a9f72010-05-10 22:49:55 +00002138 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002139 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002140
Eric Christopher6eebe472012-12-19 22:02:53 +00002141 DD->emitDIE(Die, Abbreviations);
Eric Christopherb1e66d02012-12-15 00:04:07 +00002142 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002143 TheCU->getUniqueID()));
Devang Patel163a9f72010-05-10 22:49:55 +00002144 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002145}
2146
Eric Christopher98e237f2012-11-30 23:59:06 +00002147// Emit the debug info section.
2148void DwarfDebug::emitDebugInfo() {
Eric Christopherb1e66d02012-12-15 00:04:07 +00002149 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2150
2151 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
2152 Asm->getObjFileLowering().getDwarfAbbrevSection(),
2153 DwarfAbbrevSectionSym);
Eric Christopher98e237f2012-11-30 23:59:06 +00002154}
2155
Eric Christopherb6dc8652012-11-27 22:43:45 +00002156// Emit the abbreviation section.
Eric Christopher7dc68db2012-11-20 23:30:11 +00002157void DwarfDebug::emitAbbreviations() {
Eric Christopher6eebe472012-12-19 22:02:53 +00002158 if (!useSplitDwarf())
2159 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
2160 &Abbreviations);
2161 else
2162 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2163}
Bill Wendling94d04b82009-05-20 23:21:38 +00002164
Eric Christopher6eebe472012-12-19 22:02:53 +00002165void DwarfDebug::emitAbbrevs(const MCSection *Section,
2166 std::vector<DIEAbbrev *> *Abbrevs) {
2167 // Check to see if it is worth the effort.
2168 if (!Abbrevs->empty()) {
2169 // Start the debug abbrev section.
2170 Asm->OutStreamer.SwitchSection(Section);
2171
2172 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
Eric Christopher44fedba2012-12-13 03:00:38 +00002173 Asm->OutStreamer.EmitLabel(Begin);
Bill Wendling94d04b82009-05-20 23:21:38 +00002174
2175 // For each abbrevation.
Eric Christopher6eebe472012-12-19 22:02:53 +00002176 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002177 // Get abbreviation data
Eric Christopher6eebe472012-12-19 22:02:53 +00002178 const DIEAbbrev *Abbrev = Abbrevs->at(i);
Bill Wendling94d04b82009-05-20 23:21:38 +00002179
2180 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002181 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00002182
2183 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002184 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00002185 }
2186
2187 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002188 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00002189
Eric Christopher6eebe472012-12-19 22:02:53 +00002190 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
Eric Christopher44fedba2012-12-13 03:00:38 +00002191 Asm->OutStreamer.EmitLabel(End);
Bill Wendling94d04b82009-05-20 23:21:38 +00002192 }
2193}
2194
Eric Christopherb6dc8652012-11-27 22:43:45 +00002195// Emit the last address of the section and the end of the line matrix.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002196void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002197 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00002198 Asm->OutStreamer.AddComment("Extended Op");
2199 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002200
Chris Lattner233f52b2010-03-09 23:52:58 +00002201 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002202 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00002203 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2204 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2205
2206 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00002207
Chris Lattnerc0215722010-04-04 19:25:43 +00002208 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Eric Christopherca1dd052013-01-09 01:35:34 +00002209 Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002210
2211 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00002212 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2213 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00002214 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00002215 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00002216}
2217
Eric Christopherb6dc8652012-11-27 22:43:45 +00002218// Emit visible names into a hashed accelerator table section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002219void DwarfDebug::emitAccelNames() {
Eric Christopher577056f2013-09-05 18:20:16 +00002220 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher09ac3d82011-11-07 09:24:32 +00002221 dwarf::DW_FORM_data4));
2222 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2223 E = CUMap.end(); I != E; ++I) {
2224 CompileUnit *TheCU = I->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00002225 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2226 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002227 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002228 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002229 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00002230 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2231 DE = Entities.end(); DI != DE; ++DI)
2232 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00002233 }
2234 }
2235
2236 AT.FinalizeTable(Asm, "Names");
2237 Asm->OutStreamer.SwitchSection(
2238 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2239 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2240 Asm->OutStreamer.EmitLabel(SectionBegin);
2241
2242 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002243 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002244}
2245
Eric Christopher72c16552012-12-20 21:58:40 +00002246// Emit objective C classes and categories into a hashed accelerator table
2247// section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002248void DwarfDebug::emitAccelObjC() {
Eric Christopher577056f2013-09-05 18:20:16 +00002249 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher09ac3d82011-11-07 09:24:32 +00002250 dwarf::DW_FORM_data4));
2251 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2252 E = CUMap.end(); I != E; ++I) {
2253 CompileUnit *TheCU = I->second;
2254 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2255 for (StringMap<std::vector<DIE*> >::const_iterator
2256 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002257 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002258 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher09ac3d82011-11-07 09:24:32 +00002259 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2260 DE = Entities.end(); DI != DE; ++DI)
2261 AT.AddName(Name, (*DI));
2262 }
2263 }
2264
2265 AT.FinalizeTable(Asm, "ObjC");
2266 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2267 .getDwarfAccelObjCSection());
2268 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2269 Asm->OutStreamer.EmitLabel(SectionBegin);
2270
2271 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002272 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002273}
2274
Eric Christopherb6dc8652012-11-27 22:43:45 +00002275// Emit namespace dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002276void DwarfDebug::emitAccelNamespaces() {
Eric Christopher577056f2013-09-05 18:20:16 +00002277 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher09ac3d82011-11-07 09:24:32 +00002278 dwarf::DW_FORM_data4));
2279 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2280 E = CUMap.end(); I != E; ++I) {
2281 CompileUnit *TheCU = I->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00002282 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2283 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002284 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002285 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002286 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00002287 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2288 DE = Entities.end(); DI != DE; ++DI)
2289 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00002290 }
2291 }
2292
2293 AT.FinalizeTable(Asm, "namespac");
2294 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2295 .getDwarfAccelNamespaceSection());
2296 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2297 Asm->OutStreamer.EmitLabel(SectionBegin);
2298
2299 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002300 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002301}
2302
Eric Christopherb6dc8652012-11-27 22:43:45 +00002303// Emit type dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002304void DwarfDebug::emitAccelTypes() {
Eric Christopherc36145f2012-01-06 04:35:23 +00002305 std::vector<DwarfAccelTable::Atom> Atoms;
Eric Christopher577056f2013-09-05 18:20:16 +00002306 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopherc36145f2012-01-06 04:35:23 +00002307 dwarf::DW_FORM_data4));
Eric Christopher577056f2013-09-05 18:20:16 +00002308 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag,
Eric Christopherc36145f2012-01-06 04:35:23 +00002309 dwarf::DW_FORM_data2));
Eric Christopher577056f2013-09-05 18:20:16 +00002310 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags,
Eric Christopherc36145f2012-01-06 04:35:23 +00002311 dwarf::DW_FORM_data1));
2312 DwarfAccelTable AT(Atoms);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002313 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2314 E = CUMap.end(); I != E; ++I) {
2315 CompileUnit *TheCU = I->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002316 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2317 = TheCU->getAccelTypes();
2318 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002319 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002320 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002321 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002322 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2323 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2324 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002325 }
2326 }
2327
2328 AT.FinalizeTable(Asm, "types");
2329 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2330 .getDwarfAccelTypesSection());
2331 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2332 Asm->OutStreamer.EmitLabel(SectionBegin);
2333
2334 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002335 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002336}
2337
Eric Christopher8f1a9292013-09-13 00:35:05 +00002338// Public name handling.
2339// The format for the various pubnames:
2340//
2341// dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2342// for the DIE that is named.
2343//
2344// gnu pubnames - offset/index value/name tuples where the offset is the offset
2345// into the CU and the index value is computed according to the type of value
2346// for the DIE that is named.
2347//
2348// For type units the offset is the offset of the skeleton DIE. For split dwarf
2349// it's the offset within the debug_info/debug_types dwo section, however, the
2350// reference in the pubname header doesn't change.
2351
2352/// computeIndexValue - Compute the gdb index value for the DIE and CU.
David Blaikie9599f512013-09-19 20:40:26 +00002353static dwarf::PubIndexEntryDescriptor computeIndexValue(CompileUnit *CU,
2354 DIE *Die) {
Eric Christophera486f552013-10-16 01:37:49 +00002355 dwarf::GDBIndexEntryLinkage Linkage = dwarf::GIEL_STATIC;
2356
2357 // We could have a specification DIE that has our most of our knowledge,
2358 // look for that now.
2359 DIEValue *SpecVal = Die->findAttribute(dwarf::DW_AT_specification);
2360 if (SpecVal) {
2361 DIE *SpecDIE = cast<DIEEntry>(SpecVal)->getEntry();
2362 if (SpecDIE->findAttribute(dwarf::DW_AT_external))
2363 Linkage = dwarf::GIEL_EXTERNAL;
2364 } else if (Die->findAttribute(dwarf::DW_AT_external))
2365 Linkage = dwarf::GIEL_EXTERNAL;
Eric Christopher8f1a9292013-09-13 00:35:05 +00002366
2367 switch (Die->getTag()) {
2368 case dwarf::DW_TAG_class_type:
2369 case dwarf::DW_TAG_structure_type:
2370 case dwarf::DW_TAG_union_type:
2371 case dwarf::DW_TAG_enumeration_type:
Eric Christophercdeaae42013-09-23 20:55:35 +00002372 return dwarf::PubIndexEntryDescriptor(
2373 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2374 ? dwarf::GIEL_STATIC
2375 : dwarf::GIEL_EXTERNAL);
Eric Christopher8f1a9292013-09-13 00:35:05 +00002376 case dwarf::DW_TAG_typedef:
2377 case dwarf::DW_TAG_base_type:
2378 case dwarf::DW_TAG_subrange_type:
David Blaikie9599f512013-09-19 20:40:26 +00002379 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
Eric Christopher8f1a9292013-09-13 00:35:05 +00002380 case dwarf::DW_TAG_namespace:
David Blaikie9599f512013-09-19 20:40:26 +00002381 return dwarf::GIEK_TYPE;
Eric Christopher8f1a9292013-09-13 00:35:05 +00002382 case dwarf::DW_TAG_subprogram:
Eric Christophera31a9752013-09-23 22:59:14 +00002383 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
Eric Christopher8f1a9292013-09-13 00:35:05 +00002384 case dwarf::DW_TAG_constant:
2385 case dwarf::DW_TAG_variable:
Eric Christophera31a9752013-09-23 22:59:14 +00002386 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
Eric Christopher8f1a9292013-09-13 00:35:05 +00002387 case dwarf::DW_TAG_enumerator:
David Blaikie9599f512013-09-19 20:40:26 +00002388 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2389 dwarf::GIEL_STATIC);
Eric Christopher8f1a9292013-09-13 00:35:05 +00002390 default:
David Blaikie9599f512013-09-19 20:40:26 +00002391 return dwarf::GIEK_NONE;
Eric Christopher8f1a9292013-09-13 00:35:05 +00002392 }
Eric Christopher8f1a9292013-09-13 00:35:05 +00002393}
2394
Eric Christopher57479322013-09-09 20:03:17 +00002395/// emitDebugPubNames - Emit visible names into a debug pubnames section.
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002396///
Eric Christopher8f1a9292013-09-13 00:35:05 +00002397void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002398 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christopher8f1a9292013-09-13 00:35:05 +00002399 const MCSection *PSec =
2400 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2401 : Asm->getObjFileLowering().getDwarfPubNamesSection();
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002402
2403 typedef DenseMap<const MDNode*, CompileUnit*> CUMapType;
2404 for (CUMapType::iterator I = CUMap.begin(), E = CUMap.end(); I != E; ++I) {
2405 CompileUnit *TheCU = I->second;
2406 unsigned ID = TheCU->getUniqueID();
2407
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002408 // Start the dwarf pubnames section.
Eric Christopher21a6a502013-09-10 21:49:37 +00002409 Asm->OutStreamer.SwitchSection(PSec);
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002410
Eric Christophera6d84152013-09-30 23:14:16 +00002411 // Emit a label so we can reference the beginning of this pubname section.
2412 if (GnuStyle)
2413 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames",
2414 TheCU->getUniqueID()));
2415
Eric Christopher8f1a9292013-09-13 00:35:05 +00002416 // Emit the header.
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002417 Asm->OutStreamer.AddComment("Length of Public Names Info");
2418 Asm->EmitLabelDifference(Asm->GetTempSymbol("pubnames_end", ID),
2419 Asm->GetTempSymbol("pubnames_begin", ID), 4);
2420
2421 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin", ID));
2422
2423 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemerd7d43dc2013-08-21 06:13:34 +00002424 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002425
2426 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2427 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2428 DwarfInfoSectionSym);
2429
2430 Asm->OutStreamer.AddComment("Compilation Unit Length");
2431 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(), ID),
2432 Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2433 4);
2434
Eric Christopher8f1a9292013-09-13 00:35:05 +00002435 // Emit the pubnames for this compilation unit.
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002436 const StringMap<DIE*> &Globals = TheCU->getGlobalNames();
2437 for (StringMap<DIE*>::const_iterator
2438 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2439 const char *Name = GI->getKeyData();
Eric Christopher8f1a9292013-09-13 00:35:05 +00002440 DIE *Entity = GI->second;
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002441
2442 Asm->OutStreamer.AddComment("DIE offset");
2443 Asm->EmitInt32(Entity->getOffset());
2444
Eric Christopher8f1a9292013-09-13 00:35:05 +00002445 if (GnuStyle) {
David Blaikie18a6ade2013-09-19 22:19:37 +00002446 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2447 Asm->OutStreamer.AddComment(
David Blaikieac3f0162013-09-20 00:33:15 +00002448 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie994c37f2013-09-19 23:01:29 +00002449 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikie18a6ade2013-09-19 22:19:37 +00002450 Asm->EmitInt8(Desc.toBits());
Eric Christopher8f1a9292013-09-13 00:35:05 +00002451 }
2452
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002453 if (Asm->isVerbose())
2454 Asm->OutStreamer.AddComment("External Name");
Rafael Espindolaa3863ea2013-07-02 15:49:13 +00002455 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002456 }
2457
2458 Asm->OutStreamer.AddComment("End Mark");
2459 Asm->EmitInt32(0);
2460 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end", ID));
2461 }
2462}
2463
Eric Christopher8f1a9292013-09-13 00:35:05 +00002464void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
Eric Christopher5704d642013-09-13 00:34:58 +00002465 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christophercdeaae42013-09-23 20:55:35 +00002466 const MCSection *PSec =
2467 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2468 : Asm->getObjFileLowering().getDwarfPubTypesSection();
Eric Christopher5704d642013-09-13 00:34:58 +00002469
Devang Patel163a9f72010-05-10 22:49:55 +00002470 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
Eric Christopher5704d642013-09-13 00:34:58 +00002471 E = CUMap.end();
2472 I != E; ++I) {
Devang Patel163a9f72010-05-10 22:49:55 +00002473 CompileUnit *TheCU = I->second;
Eric Christopher63701182011-11-07 09:18:35 +00002474 // Start the dwarf pubtypes section.
Eric Christopher5704d642013-09-13 00:34:58 +00002475 Asm->OutStreamer.SwitchSection(PSec);
Eric Christophera6d84152013-09-30 23:14:16 +00002476
2477 // Emit a label so we can reference the beginning of this pubtype section.
2478 if (GnuStyle)
2479 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes",
2480 TheCU->getUniqueID()));
2481
2482 // Emit the header.
Devang Patel163a9f72010-05-10 22:49:55 +00002483 Asm->OutStreamer.AddComment("Length of Public Types Info");
2484 Asm->EmitLabelDifference(
Eric Christopher5704d642013-09-13 00:34:58 +00002485 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2486 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002487
Eric Christopher5704d642013-09-13 00:34:58 +00002488 Asm->OutStreamer.EmitLabel(
2489 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002490
Eric Christopher5704d642013-09-13 00:34:58 +00002491 if (Asm->isVerbose())
2492 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemerd7d43dc2013-08-21 06:13:34 +00002493 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002494
Devang Patel163a9f72010-05-10 22:49:55 +00002495 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eric Christopher5704d642013-09-13 00:34:58 +00002496 Asm->EmitSectionOffset(
2497 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()),
2498 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002499
Devang Patel163a9f72010-05-10 22:49:55 +00002500 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eric Christopher5704d642013-09-13 00:34:58 +00002501 Asm->EmitLabelDifference(
2502 Asm->GetTempSymbol(ISec->getLabelEndName(), TheCU->getUniqueID()),
2503 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002504
Eric Christophera6d84152013-09-30 23:14:16 +00002505 // Emit the pubtypes.
Eric Christopher5704d642013-09-13 00:34:58 +00002506 const StringMap<DIE *> &Globals = TheCU->getGlobalTypes();
2507 for (StringMap<DIE *>::const_iterator GI = Globals.begin(),
2508 GE = Globals.end();
2509 GI != GE; ++GI) {
Devang Patel163a9f72010-05-10 22:49:55 +00002510 const char *Name = GI->getKeyData();
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00002511 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002512
Eric Christopher5704d642013-09-13 00:34:58 +00002513 if (Asm->isVerbose())
2514 Asm->OutStreamer.AddComment("DIE offset");
Devang Patel163a9f72010-05-10 22:49:55 +00002515 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002516
Eric Christopher8f1a9292013-09-13 00:35:05 +00002517 if (GnuStyle) {
David Blaikie18a6ade2013-09-19 22:19:37 +00002518 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2519 Asm->OutStreamer.AddComment(
David Blaikieac3f0162013-09-20 00:33:15 +00002520 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie994c37f2013-09-19 23:01:29 +00002521 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikie18a6ade2013-09-19 22:19:37 +00002522 Asm->EmitInt8(Desc.toBits());
Eric Christopher8f1a9292013-09-13 00:35:05 +00002523 }
2524
Eric Christopher5704d642013-09-13 00:34:58 +00002525 if (Asm->isVerbose())
2526 Asm->OutStreamer.AddComment("External Name");
2527
Benjamin Kramer983c4572011-11-09 18:16:11 +00002528 // Emit the name with a terminating null byte.
Eric Christopher5704d642013-09-13 00:34:58 +00002529 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Devang Patel163a9f72010-05-10 22:49:55 +00002530 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002531
Devang Patel163a9f72010-05-10 22:49:55 +00002532 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00002533 Asm->EmitInt32(0);
Eric Christopher5704d642013-09-13 00:34:58 +00002534 Asm->OutStreamer.EmitLabel(
2535 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()));
Devang Patel193f7202009-11-24 01:14:22 +00002536 }
Devang Patel193f7202009-11-24 01:14:22 +00002537}
2538
Eric Christopher64f824c2012-12-27 02:14:01 +00002539// Emit strings into a string section.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002540void DwarfUnits::emitStrings(const MCSection *StrSection,
2541 const MCSection *OffsetSection = NULL,
2542 const MCSymbol *StrSecSym = NULL) {
Eric Christopher64f824c2012-12-27 02:14:01 +00002543
Eric Christopherb6714222013-01-08 22:22:06 +00002544 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002545
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002546 // Start the dwarf str section.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002547 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling94d04b82009-05-20 23:21:38 +00002548
Chris Lattnerbc733f52010-03-13 02:17:42 +00002549 // Get all of the string pool entries and put them in an array by their ID so
2550 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002551 SmallVector<std::pair<unsigned,
Eric Christopherff348452013-01-07 22:40:45 +00002552 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002553
Chris Lattnerbc733f52010-03-13 02:17:42 +00002554 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
Eric Christopherb6714222013-01-08 22:22:06 +00002555 I = StringPool.begin(), E = StringPool.end();
Eric Christopher72c16552012-12-20 21:58:40 +00002556 I != E; ++I)
Chris Lattnerbc733f52010-03-13 02:17:42 +00002557 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002558
Chris Lattnerbc733f52010-03-13 02:17:42 +00002559 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002560
Chris Lattnerbc733f52010-03-13 02:17:42 +00002561 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002562 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00002563 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002564
Benjamin Kramer983c4572011-11-09 18:16:11 +00002565 // Emit the string itself with a terminating null byte.
Benjamin Kramer0c45f7d2011-11-09 12:12:04 +00002566 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
Eric Christopherca1dd052013-01-09 01:35:34 +00002567 Entries[i].second->getKeyLength()+1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002568 }
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002569
2570 // If we've got an offset section go ahead and emit that now as well.
2571 if (OffsetSection) {
2572 Asm->OutStreamer.SwitchSection(OffsetSection);
2573 unsigned offset = 0;
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002574 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002575 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopher1ced2082013-01-09 03:52:05 +00002576 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002577 offset += Entries[i].second->getKeyLength() + 1;
2578 }
2579 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002580}
2581
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002582// Emit strings into a string section.
2583void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2584
2585 if (AddressPool.empty()) return;
2586
2587 // Start the dwarf addr section.
2588 Asm->OutStreamer.SwitchSection(AddrSection);
2589
David Blaikie66f464e2013-07-08 17:51:28 +00002590 // Order the address pool entries by ID
David Blaikie5ce40912013-07-08 17:33:10 +00002591 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002592
David Blaikie66f464e2013-07-08 17:51:28 +00002593 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2594 E = AddressPool.end();
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002595 I != E; ++I)
David Blaikie5ce40912013-07-08 17:33:10 +00002596 Entries[I->second] = I->first;
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002597
2598 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Ulrich Weigand18dbe502013-07-02 18:46:46 +00002599 // Emit an expression for reference from debug information entries.
David Blaikie5ce40912013-07-08 17:33:10 +00002600 if (const MCExpr *Expr = Entries[i])
Ulrich Weigand18dbe502013-07-02 18:46:46 +00002601 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002602 else
2603 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2604 }
2605
2606}
2607
Eric Christopher64f824c2012-12-27 02:14:01 +00002608// Emit visible names into a debug str section.
2609void DwarfDebug::emitDebugStr() {
2610 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2611 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2612}
2613
Eric Christopherd3b98532013-07-02 21:36:07 +00002614// Emit locations into the debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002615void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00002616 if (DotDebugLocEntries.empty())
2617 return;
2618
Eric Christopherf7cef702013-03-29 23:34:06 +00002619 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Devang Patel6c3ea902011-02-04 22:57:18 +00002620 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2621 I != E; ++I) {
2622 DotDebugLocEntry &Entry = *I;
2623 if (I + 1 != DotDebugLocEntries.end())
2624 Entry.Merge(I+1);
2625 }
2626
Daniel Dunbar83320a02011-03-16 22:16:39 +00002627 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002628 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00002629 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002630 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00002631 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2632 unsigned index = 1;
Eric Christopherf7cef702013-03-29 23:34:06 +00002633 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00002634 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00002635 I != E; ++I, ++index) {
Devang Patel6c3ea902011-02-04 22:57:18 +00002636 DotDebugLocEntry &Entry = *I;
2637 if (Entry.isMerged()) continue;
Devang Patelc3f5f782010-05-25 23:40:22 +00002638 if (Entry.isEmpty()) {
Eric Christopherca1dd052013-01-09 01:35:34 +00002639 Asm->OutStreamer.EmitIntValue(0, Size);
2640 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel80250682010-05-26 23:55:23 +00002641 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00002642 } else {
Eric Christopher0d0782a2013-07-03 22:40:18 +00002643 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2644 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2645 DIVariable DV(Entry.getVariable());
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002646 Asm->OutStreamer.AddComment("Loc expr size");
2647 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2648 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2649 Asm->EmitLabelDifference(end, begin, 2);
2650 Asm->OutStreamer.EmitLabel(begin);
Devang Patel80efd4e2011-07-08 16:49:43 +00002651 if (Entry.isInt()) {
Devang Patelc4329072011-06-01 22:03:25 +00002652 DIBasicType BTy(DV.getType());
2653 if (BTy.Verify() &&
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002654 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patelc4329072011-06-01 22:03:25 +00002655 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2656 Asm->OutStreamer.AddComment("DW_OP_consts");
2657 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Patel80efd4e2011-07-08 16:49:43 +00002658 Asm->EmitSLEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002659 } else {
2660 Asm->OutStreamer.AddComment("DW_OP_constu");
2661 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Patel80efd4e2011-07-08 16:49:43 +00002662 Asm->EmitULEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002663 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002664 } else if (Entry.isLocation()) {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002665 MachineLocation Loc = Entry.getLoc();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002666 if (!DV.hasComplexAddress())
Devang Patel80efd4e2011-07-08 16:49:43 +00002667 // Regular entry.
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002668 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002669 else {
2670 // Complex address entry.
2671 unsigned N = DV.getNumAddrElements();
2672 unsigned i = 0;
2673 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002674 if (Loc.getOffset()) {
Devang Patel80efd4e2011-07-08 16:49:43 +00002675 i = 2;
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002676 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002677 Asm->OutStreamer.AddComment("DW_OP_deref");
2678 Asm->EmitInt8(dwarf::DW_OP_deref);
2679 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2680 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2681 Asm->EmitSLEB128(DV.getAddrElement(1));
2682 } else {
2683 // If first address element is OpPlus then emit
2684 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002685 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2686 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002687 i = 2;
2688 }
2689 } else {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002690 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002691 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002692
Devang Patel80efd4e2011-07-08 16:49:43 +00002693 // Emit remaining complex address elements.
2694 for (; i < N; ++i) {
2695 uint64_t Element = DV.getAddrElement(i);
2696 if (Element == DIBuilder::OpPlus) {
2697 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2698 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher50120762012-05-08 18:56:00 +00002699 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002700 if (!Loc.isReg())
Eric Christopher50120762012-05-08 18:56:00 +00002701 Asm->EmitInt8(dwarf::DW_OP_deref);
2702 } else
2703 llvm_unreachable("unknown Opcode found in complex address");
Devang Patel80efd4e2011-07-08 16:49:43 +00002704 }
Devang Patelc26f5442011-04-28 02:22:40 +00002705 }
Devang Patelc26f5442011-04-28 02:22:40 +00002706 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002707 // else ... ignore constant fp. There is not any good way to
2708 // to represent them here in dwarf.
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002709 Asm->OutStreamer.EmitLabel(end);
Devang Patelc3f5f782010-05-25 23:40:22 +00002710 }
2711 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002712}
2713
Richard Mitton5cc319a2013-09-19 23:21:01 +00002714struct SymbolCUSorter {
2715 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2716 const MCStreamer &Streamer;
2717
2718 bool operator() (const SymbolCU &A, const SymbolCU &B) {
2719 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2720 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2721
2722 // Symbols with no order assigned should be placed at the end.
2723 // (e.g. section end labels)
2724 if (IA == 0)
2725 IA = (unsigned)(-1);
2726 if (IB == 0)
2727 IB = (unsigned)(-1);
2728 return IA < IB;
2729 }
2730};
2731
Richard Mitton5cc319a2013-09-19 23:21:01 +00002732static bool CUSort(const CompileUnit *A, const CompileUnit *B) {
2733 return (A->getUniqueID() < B->getUniqueID());
2734}
2735
2736struct ArangeSpan {
2737 const MCSymbol *Start, *End;
2738};
2739
2740// Emit a debug aranges section, containing a CU lookup for any
2741// address we can tie back to a CU.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002742void DwarfDebug::emitDebugARanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002743 // Start the dwarf aranges section.
Eric Christopherab6cd832013-08-30 00:39:57 +00002744 Asm->OutStreamer
2745 .SwitchSection(Asm->getObjFileLowering().getDwarfARangesSection());
Richard Mitton5cc319a2013-09-19 23:21:01 +00002746
2747 typedef DenseMap<CompileUnit *, std::vector<ArangeSpan> > SpansType;
2748
2749 SpansType Spans;
2750
2751 // Build a list of sections used.
2752 std::vector<const MCSection *> Sections;
2753 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2754 it++) {
2755 const MCSection *Section = it->first;
2756 Sections.push_back(Section);
2757 }
2758
2759 // Sort the sections into order.
2760 // This is only done to ensure consistent output order across different runs.
2761 std::sort(Sections.begin(), Sections.end(), SectionSort);
2762
2763 // Build a set of address spans, sorted by CU.
2764 for (size_t SecIdx=0;SecIdx<Sections.size();SecIdx++) {
2765 const MCSection *Section = Sections[SecIdx];
2766 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2767 if (List.size() < 2)
2768 continue;
2769
2770 // Sort the symbols by offset within the section.
2771 SymbolCUSorter sorter(Asm->OutStreamer);
2772 std::sort(List.begin(), List.end(), sorter);
2773
2774 // If we have no section (e.g. common), just write out
2775 // individual spans for each symbol.
2776 if (Section == NULL) {
2777 for (size_t n = 0; n < List.size(); n++) {
2778 const SymbolCU &Cur = List[n];
2779
2780 ArangeSpan Span;
2781 Span.Start = Cur.Sym;
2782 Span.End = NULL;
2783 if (Cur.CU)
2784 Spans[Cur.CU].push_back(Span);
2785 }
2786 } else {
2787 // Build spans between each label.
2788 const MCSymbol *StartSym = List[0].Sym;
2789 for (size_t n = 1; n < List.size(); n++) {
2790 const SymbolCU &Prev = List[n - 1];
2791 const SymbolCU &Cur = List[n];
2792
2793 // Try and build the longest span we can within the same CU.
2794 if (Cur.CU != Prev.CU) {
2795 ArangeSpan Span;
2796 Span.Start = StartSym;
2797 Span.End = Cur.Sym;
2798 Spans[Prev.CU].push_back(Span);
2799 StartSym = Cur.Sym;
2800 }
2801 }
2802 }
2803 }
2804
2805 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2806 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2807
2808 // Build a list of CUs used.
2809 std::vector<CompileUnit *> CUs;
2810 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
2811 CompileUnit *CU = it->first;
2812 CUs.push_back(CU);
2813 }
2814
2815 // Sort the CU list (again, to ensure consistent output order).
2816 std::sort(CUs.begin(), CUs.end(), CUSort);
2817
2818 // Emit an arange table for each CU we used.
2819 for (size_t CUIdx=0;CUIdx<CUs.size();CUIdx++) {
2820 CompileUnit *CU = CUs[CUIdx];
2821 std::vector<ArangeSpan> &List = Spans[CU];
2822
2823 // Emit size of content not including length itself.
2824 unsigned ContentSize
2825 = sizeof(int16_t) // DWARF ARange version number
2826 + sizeof(int32_t) // Offset of CU in the .debug_info section
2827 + sizeof(int8_t) // Pointer Size (in bytes)
2828 + sizeof(int8_t); // Segment Size (in bytes)
2829
2830 unsigned TupleSize = PtrSize * 2;
2831
2832 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2833 unsigned Padding = 0;
2834 while (((sizeof(int32_t) + ContentSize + Padding) % TupleSize) != 0)
2835 Padding++;
2836
2837 ContentSize += Padding;
2838 ContentSize += (List.size() + 1) * TupleSize;
2839
2840 // For each compile unit, write the list of spans it covers.
2841 Asm->OutStreamer.AddComment("Length of ARange Set");
2842 Asm->EmitInt32(ContentSize);
2843 Asm->OutStreamer.AddComment("DWARF Arange version number");
2844 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2845 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
2846 Asm->EmitSectionOffset(
2847 Asm->GetTempSymbol(ISec->getLabelBeginName(), CU->getUniqueID()),
2848 DwarfInfoSectionSym);
2849 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2850 Asm->EmitInt8(PtrSize);
2851 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2852 Asm->EmitInt8(0);
2853
2854 for (unsigned n = 0; n < Padding; n++)
2855 Asm->EmitInt8(0xff);
2856
2857 for (unsigned n = 0; n < List.size(); n++) {
2858 const ArangeSpan &Span = List[n];
2859 Asm->EmitLabelReference(Span.Start, PtrSize);
2860
2861 // Calculate the size as being from the span start to it's end.
Richard Mittoneb46def2013-09-23 17:56:20 +00002862 if (Span.End) {
Richard Mitton5cc319a2013-09-19 23:21:01 +00002863 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
Richard Mittoneb46def2013-09-23 17:56:20 +00002864 } else {
2865 // For symbols without an end marker (e.g. common), we
2866 // write a single arange entry containing just that one symbol.
2867 uint64_t Size = SymSize[Span.Start];
2868 if (Size == 0)
2869 Size = 1;
2870
2871 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2872 }
Richard Mitton5cc319a2013-09-19 23:21:01 +00002873 }
2874
2875 Asm->OutStreamer.AddComment("ARange terminator");
2876 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2877 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2878 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002879}
2880
Eric Christopherb6dc8652012-11-27 22:43:45 +00002881// Emit visible names into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002882void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002883 // Start the dwarf ranges section.
Eric Christopherab6cd832013-08-30 00:39:57 +00002884 Asm->OutStreamer
2885 .SwitchSection(Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002886 unsigned char Size = Asm->getDataLayout().getPointerSize();
Eric Christopherf7cef702013-03-29 23:34:06 +00002887 for (SmallVectorImpl<const MCSymbol *>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00002888 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00002889 I != E; ++I) {
2890 if (*I)
Eric Christopher1ced2082013-01-09 03:52:05 +00002891 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
Devang Patelf2548ca2010-04-16 23:33:45 +00002892 else
Eric Christopherca1dd052013-01-09 01:35:34 +00002893 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patelf2548ca2010-04-16 23:33:45 +00002894 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002895}
2896
Eric Christopherb6dc8652012-11-27 22:43:45 +00002897// Emit visible names into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002898void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002899 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00002900 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002901 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002902 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002903 }
2904}
2905
Eric Christopher0b944ee2012-12-11 19:42:09 +00002906// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher98e237f2012-11-30 23:59:06 +00002907
2908// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2909// DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
Eric Christopher451c71d2013-10-01 00:43:36 +00002910// DW_AT_ranges_base, DW_AT_addr_base.
Eric Christophera9b2c792013-08-26 23:50:43 +00002911CompileUnit *DwarfDebug::constructSkeletonCU(const CompileUnit *CU) {
Eric Christopher98e237f2012-11-30 23:59:06 +00002912
2913 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christophera9b2c792013-08-26 23:50:43 +00002914 CompileUnit *NewCU = new CompileUnit(CU->getUniqueID(), Die, CU->getNode(),
2915 Asm, this, &SkeletonHolder);
Eric Christopher446b88f2013-01-17 03:00:04 +00002916
Eric Christopher3ce51a92013-02-22 23:50:08 +00002917 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
Eric Christopher30410d52013-08-26 23:57:03 +00002918 DICompileUnit(CU->getNode()).getSplitDebugFilename());
Eric Christopher98e237f2012-11-30 23:59:06 +00002919
Eric Christopher1b0cd2f2013-04-22 07:51:08 +00002920 // Relocate to the beginning of the addr_base section, else 0 for the
2921 // beginning of the one for this compile unit.
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002922 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2923 NewCU->addLabel(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2924 DwarfAddrSectionSym);
2925 else
Eric Christopher1b0cd2f2013-04-22 07:51:08 +00002926 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base,
2927 dwarf::DW_FORM_sec_offset, 0);
Eric Christopher98e237f2012-11-30 23:59:06 +00002928
2929 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002930 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher98e237f2012-11-30 23:59:06 +00002931 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002932
Eric Christopher98e237f2012-11-30 23:59:06 +00002933 // DW_AT_stmt_list is a offset of line number information for this
2934 // compile unit in debug_line section.
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002935 // FIXME: Should handle multiple compile units.
Eric Christopher98e237f2012-11-30 23:59:06 +00002936 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher446b88f2013-01-17 03:00:04 +00002937 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher7a0103c2013-02-07 21:19:50 +00002938 DwarfLineSectionSym);
Eric Christopher98e237f2012-11-30 23:59:06 +00002939 else
Eric Christopher446b88f2013-01-17 03:00:04 +00002940 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher98e237f2012-11-30 23:59:06 +00002941
2942 if (!CompilationDir.empty())
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002943 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher98e237f2012-11-30 23:59:06 +00002944
Eric Christopher08bd9232013-10-01 00:43:31 +00002945 // Flags to let the linker know we have emitted new style pubnames.
Eric Christophera6d84152013-09-30 23:14:16 +00002946 if (GenerateGnuPubSections) {
2947 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2948 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_sec_offset,
2949 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()));
2950 else
2951 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
2952 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()),
2953 DwarfGnuPubNamesSectionSym);
2954
2955 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2956 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_sec_offset,
2957 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()));
2958 else
2959 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopher7c9fc902013-10-03 17:41:16 +00002960 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()),
Eric Christophera6d84152013-09-30 23:14:16 +00002961 DwarfGnuPubTypesSectionSym);
2962 }
Eric Christopher8f1a9292013-09-13 00:35:05 +00002963
Eric Christopher451c71d2013-10-01 00:43:36 +00002964 // Flag if we've emitted any ranges and their location for the compile unit.
2965 if (DebugRangeSymbols.size()) {
2966 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2967 NewCU->addLabel(Die, dwarf::DW_AT_GNU_ranges_base,
2968 dwarf::DW_FORM_sec_offset, DwarfDebugRangeSectionSym);
2969 else
2970 NewCU->addUInt(Die, dwarf::DW_AT_GNU_ranges_base, dwarf::DW_FORM_data4,
2971 0);
2972 }
2973
Eric Christopher0e3e9b72012-12-10 23:34:43 +00002974 SkeletonHolder.addUnit(NewCU);
Eric Christopher01776a52013-02-06 21:53:56 +00002975 SkeletonCUs.push_back(NewCU);
Eric Christopher0e3e9b72012-12-10 23:34:43 +00002976
Eric Christopher98e237f2012-11-30 23:59:06 +00002977 return NewCU;
2978}
2979
Eric Christopher6eebe472012-12-19 22:02:53 +00002980void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
2981 assert(useSplitDwarf() && "No split dwarf debug info?");
2982 emitAbbrevs(Section, &SkeletonAbbrevs);
Eric Christopher98e237f2012-11-30 23:59:06 +00002983}
2984
Eric Christopher0b944ee2012-12-11 19:42:09 +00002985// Emit the .debug_info.dwo section for separated dwarf. This contains the
2986// compile units that would normally be in debug_info.
Eric Christopher98e237f2012-11-30 23:59:06 +00002987void DwarfDebug::emitDebugInfoDWO() {
Eric Christopher4daaed12012-12-10 19:51:21 +00002988 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christopherb1e66d02012-12-15 00:04:07 +00002989 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
Eric Christopher6eebe472012-12-19 22:02:53 +00002990 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2991 DwarfAbbrevDWOSectionSym);
2992}
2993
2994// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2995// abbreviations for the .debug_info.dwo section.
2996void DwarfDebug::emitDebugAbbrevDWO() {
2997 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopher72c16552012-12-20 21:58:40 +00002998 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2999 &Abbreviations);
Eric Christopher98e237f2012-11-30 23:59:06 +00003000}
Eric Christopher64f824c2012-12-27 02:14:01 +00003001
3002// Emit the .debug_str.dwo section for separated dwarf. This contains the
3003// string section and is identical in format to traditional .debug_str
3004// sections.
3005void DwarfDebug::emitDebugStrDWO() {
3006 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherff348452013-01-07 22:40:45 +00003007 const MCSection *OffSec = Asm->getObjFileLowering()
3008 .getDwarfStrOffDWOSection();
Eric Christopherdd8e9f32013-01-07 19:32:41 +00003009 const MCSymbol *StrSym = DwarfStrSectionSym;
3010 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
3011 OffSec, StrSym);
Eric Christopher64f824c2012-12-27 02:14:01 +00003012}