blob: 771cb3215a326c027a6bdc3c8214694bc80b981d [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),
David Blaikie8e8e6dc2013-10-30 17:14:24 +0000186 InfoHolder(A, &AbbreviationsSet, Abbreviations, "info_string",
Eric Christopherb6714222013-01-08 22:22:06 +0000187 DIEValueAllocator),
Eric Christopher6eebe472012-12-19 22:02:53 +0000188 SkeletonAbbrevSet(InitAbbreviationsSetSize),
David Blaikie8e8e6dc2013-10-30 17:14:24 +0000189 SkeletonHolder(A, &SkeletonAbbrevSet, SkeletonAbbrevs, "skel_string",
Eric Christopherb6714222013-01-08 22:22:06 +0000190 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.
David Blaikie8e8e6dc2013-10-30 17:14:24 +0000282 Abbreviations.push_back(&Abbrev);
Bill Wendling0310d762009-05-15 09:23:25 +0000283
284 // Assign the vector position + 1 as its number.
David Blaikie8e8e6dc2013-10-30 17:14:24 +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.
Manman Ren8ef9ceb2013-10-29 01:03:01 +0000381 SPDie = SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram, *SPCU->getCUDie());
Manman Ren87b110a2013-10-11 23:58:05 +0000382 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin, AbsSPDIE);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000383 } else {
384 DISubprogram SPDecl = SP.getFunctionDeclaration();
385 if (!SPDecl.isSubprogram()) {
386 // There is not any need to generate specification DIE for a function
387 // defined at compile unit level. If a function is defined inside another
388 // function then gdb prefers the definition at top level and but does not
389 // expect specification DIE in parent function. So avoid creating
390 // specification DIE for a function defined inside a function.
Manman Renb8e48a62013-10-10 18:40:01 +0000391 DIScope SPContext = resolve(SP.getContext());
392 if (SP.isDefinition() && !SPContext.isCompileUnit() &&
393 !SPContext.isFile() &&
394 !isSubprogramContext(SPContext)) {
Bill Wendlinga4c76932012-11-07 04:42:18 +0000395 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
396
397 // Add arguments.
398 DICompositeType SPTy = SP.getType();
399 DIArray Args = SPTy.getTypeArray();
Eric Christopher31667622013-08-08 01:41:00 +0000400 uint16_t SPTag = SPTy.getTag();
Bill Wendlinga4c76932012-11-07 04:42:18 +0000401 if (SPTag == dwarf::DW_TAG_subroutine_type)
402 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
Manman Ren8ef9ceb2013-10-29 01:03:01 +0000403 DIE *Arg =
404 SPCU->createAndAddDIE(dwarf::DW_TAG_formal_parameter, *SPDie);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000405 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 }
412 DIE *SPDeclDie = SPDie;
Manman Ren8ef9ceb2013-10-29 01:03:01 +0000413 SPDie =
414 SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram, *SPCU->getCUDie());
Manman Ren87b110a2013-10-11 23:58:05 +0000415 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, SPDeclDie);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000416 }
417 }
Devang Patel8aa61472010-07-07 22:20:57 +0000418 }
419
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000420 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc,
421 Asm->GetTempSymbol("func_begin",
422 Asm->getFunctionNumber()));
423 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
424 Asm->GetTempSymbol("func_end",
425 Asm->getFunctionNumber()));
Chris Lattnerd38fee82010-04-05 00:13:49 +0000426 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
427 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patel3cbee302011-04-12 22:53:02 +0000428 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +0000429
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000430 // Add name to the name table, we do this here because we're guaranteed
431 // to have concrete versions of our DW_TAG_subprogram nodes.
432 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000433
Chris Lattnerd38fee82010-04-05 00:13:49 +0000434 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +0000435}
436
Manman Ren995de6c2013-09-11 19:40:28 +0000437/// Check whether we should create a DIE for the given Scope, return true
438/// if we don't create a DIE (the corresponding DIE is null).
Manman Renfd2210a2013-09-10 18:40:41 +0000439bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
440 if (Scope->isAbstractScope())
441 return false;
442
Manman Ren995de6c2013-09-11 19:40:28 +0000443 // We don't create a DIE if there is no Range.
Manman Renfd2210a2013-09-10 18:40:41 +0000444 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
445 if (Ranges.empty())
446 return true;
447
448 if (Ranges.size() > 1)
449 return false;
450
Manman Ren995de6c2013-09-11 19:40:28 +0000451 // We don't create a DIE if we have a single Range and the end label
452 // is null.
Manman Renfd2210a2013-09-10 18:40:41 +0000453 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
454 MCSymbol *End = getLabelAfterInsn(RI->second);
455 return !End;
456}
457
Eric Christopherb6dc8652012-11-27 22:43:45 +0000458// Construct new DW_TAG_lexical_block for this scope and attach
459// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000460DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld3024342011-08-15 22:24:32 +0000461 LexicalScope *Scope) {
Manman Renfd2210a2013-09-10 18:40:41 +0000462 if (isLexicalScopeDIENull(Scope))
463 return 0;
464
Devang Pateleac9c072010-04-27 19:46:33 +0000465 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
466 if (Scope->isAbstractScope())
467 return ScopeDIE;
468
Craig Topper9f43ac62013-07-03 04:24:43 +0000469 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Eric Christopherf53d6432013-07-03 01:57:28 +0000470 // If we have multiple ranges, emit them into the range section.
Devang Pateleac9c072010-04-27 19:46:33 +0000471 if (Ranges.size() > 1) {
472 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbach1e20b962010-07-21 21:21:52 +0000473 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Pateleac9c072010-04-27 19:46:33 +0000474 // DW_AT_ranges appropriately.
Devang Patel3cbee302011-04-12 22:53:02 +0000475 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000476 DebugRangeSymbols.size()
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000477 * Asm->getDataLayout().getPointerSize());
Craig Topper2d785db2013-07-03 04:17:25 +0000478 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +0000479 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +0000480 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
481 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +0000482 }
Eric Christopherda965de2013-07-03 01:22:29 +0000483
484 // Terminate the range list.
Devang Pateleac9c072010-04-27 19:46:33 +0000485 DebugRangeSymbols.push_back(NULL);
486 DebugRangeSymbols.push_back(NULL);
487 return ScopeDIE;
488 }
489
Eric Christopherf53d6432013-07-03 01:57:28 +0000490 // Construct the address range for this DIE.
Craig Topper2d785db2013-07-03 04:17:25 +0000491 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000492 MCSymbol *Start = getLabelBeforeInsn(RI->first);
493 MCSymbol *End = getLabelAfterInsn(RI->second);
Manman Renfd2210a2013-09-10 18:40:41 +0000494 assert(End && "End label should not be null!");
Devang Patel53bb5c92009-11-10 23:06:00 +0000495
Chris Lattnerb7db7332010-03-09 01:58:53 +0000496 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
497 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbach1e20b962010-07-21 21:21:52 +0000498
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000499 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
500 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patel53bb5c92009-11-10 23:06:00 +0000501
502 return ScopeDIE;
503}
504
Eric Christopherb6dc8652012-11-27 22:43:45 +0000505// This scope represents inlined body of a function. Construct DIE to
506// represent this concrete inlined copy of the function.
Devang Pateld3024342011-08-15 22:24:32 +0000507DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
508 LexicalScope *Scope) {
Craig Topper9f43ac62013-07-03 04:24:43 +0000509 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Nick Lewycky746cb672011-10-26 22:55:33 +0000510 assert(Ranges.empty() == false &&
511 "LexicalScope does not have instruction markers!");
Devang Pateleac9c072010-04-27 19:46:33 +0000512
Devang Patel26a92002011-07-27 00:34:13 +0000513 if (!Scope->getScopeNode())
514 return NULL;
515 DIScope DS(Scope->getScopeNode());
516 DISubprogram InlinedSP = getDISubprogram(DS);
Eric Christopher3f045002013-10-04 17:08:38 +0000517 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patel26a92002011-07-27 00:34:13 +0000518 if (!OriginDIE) {
Bill Wendlinge0aae5b2012-10-30 17:51:02 +0000519 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patel26a92002011-07-27 00:34:13 +0000520 return NULL;
521 }
522
Devang Pateld96efb82011-05-05 17:54:26 +0000523 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Manman Ren87b110a2013-10-11 23:58:05 +0000524 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin, OriginDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +0000525
Devang Patel26a92002011-07-27 00:34:13 +0000526 if (Ranges.size() > 1) {
527 // .debug_range section has not been laid out yet. Emit offset in
528 // .debug_range as a uint, size 4, for now. emitDIE will handle
529 // DW_AT_ranges appropriately.
530 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000531 DebugRangeSymbols.size()
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000532 * Asm->getDataLayout().getPointerSize());
Craig Topper2d785db2013-07-03 04:17:25 +0000533 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel26a92002011-07-27 00:34:13 +0000534 RE = Ranges.end(); RI != RE; ++RI) {
535 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
536 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
537 }
538 DebugRangeSymbols.push_back(NULL);
539 DebugRangeSymbols.push_back(NULL);
540 } else {
Craig Topper2d785db2013-07-03 04:17:25 +0000541 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christophere7177132013-07-03 02:23:53 +0000542 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
543 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
544
545 if (StartLabel == 0 || EndLabel == 0)
546 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
547
548 assert(StartLabel->isDefined() &&
549 "Invalid starting label for an inlined scope!");
550 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
551
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000552 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
553 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patel26a92002011-07-27 00:34:13 +0000554 }
Devang Patel53bb5c92009-11-10 23:06:00 +0000555
556 InlinedSubprogramDIEs.insert(OriginDIE);
557
Eric Christophere7177132013-07-03 02:23:53 +0000558 // Add the call site information to the DIE.
Devang Patel53bb5c92009-11-10 23:06:00 +0000559 DILocation DL(Scope->getInlinedAt());
David Blaikie770530b2013-10-21 17:28:37 +0000560 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, None,
Manman Ren3de61b42013-03-07 01:42:00 +0000561 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
562 TheCU->getUniqueID()));
David Blaikie770530b2013-10-21 17:28:37 +0000563 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, None, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +0000564
Eric Christopher309bedd2011-12-04 06:02:38 +0000565 // Add name to the name table, we do this here because we're guaranteed
566 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
567 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000568
Devang Patel53bb5c92009-11-10 23:06:00 +0000569 return ScopeDIE;
570}
571
Manman Renfd2210a2013-09-10 18:40:41 +0000572DIE *DwarfDebug::createScopeChildrenDIE(CompileUnit *TheCU, LexicalScope *Scope,
573 SmallVectorImpl<DIE*> &Children) {
574 DIE *ObjectPointer = NULL;
Devang Patel0478c152011-03-01 22:58:55 +0000575
576 // Collect arguments for current function.
Devang Patelbf47fdb2011-08-10 20:55:27 +0000577 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +0000578 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
579 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000580 if (DIE *Arg =
Eric Christophere5212782012-09-12 23:36:19 +0000581 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel0478c152011-03-01 22:58:55 +0000582 Children.push_back(Arg);
Eric Christophere5212782012-09-12 23:36:19 +0000583 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
584 }
Devang Patel0478c152011-03-01 22:58:55 +0000585
Eric Christopher1aeb7ac2011-10-03 15:49:16 +0000586 // Collect lexical scope children first.
Craig Topper9f43ac62013-07-03 04:24:43 +0000587 const SmallVectorImpl<DbgVariable *> &Variables =ScopeVariables.lookup(Scope);
Devang Patel5bc9fec2011-02-19 01:31:27 +0000588 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000589 if (DIE *Variable =
Eric Christopher7b451cf2012-09-21 22:18:52 +0000590 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5bc9fec2011-02-19 01:31:27 +0000591 Children.push_back(Variable);
Eric Christopher7b451cf2012-09-21 22:18:52 +0000592 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
593 }
Craig Topper9f43ac62013-07-03 04:24:43 +0000594 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5bc9fec2011-02-19 01:31:27 +0000595 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Pateld0b5a5e2011-08-15 22:04:40 +0000596 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5bc9fec2011-02-19 01:31:27 +0000597 Children.push_back(Nested);
Manman Renfd2210a2013-09-10 18:40:41 +0000598 return ObjectPointer;
599}
600
601// Construct a DIE for this scope.
602DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
603 if (!Scope || !Scope->getScopeNode())
604 return NULL;
605
606 DIScope DS(Scope->getScopeNode());
607
608 SmallVector<DIE *, 8> Children;
609 DIE *ObjectPointer = NULL;
610 bool ChildrenCreated = false;
611
Manman Ren995de6c2013-09-11 19:40:28 +0000612 // We try to create the scope DIE first, then the children DIEs. This will
613 // avoid creating un-used children then removing them later when we find out
614 // the scope DIE is null.
Devang Patel3c91b052010-03-08 20:52:55 +0000615 DIE *ScopeDIE = NULL;
616 if (Scope->getInlinedAt())
Devang Pateld3024342011-08-15 22:24:32 +0000617 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3c91b052010-03-08 20:52:55 +0000618 else if (DS.isSubprogram()) {
Devang Patel0dd45582010-06-28 20:53:04 +0000619 ProcessedSPNodes.insert(DS);
Devang Patel8aa61472010-07-07 22:20:57 +0000620 if (Scope->isAbstractScope()) {
Eric Christopher3f045002013-10-04 17:08:38 +0000621 ScopeDIE = TheCU->getDIE(DS);
Devang Patel8aa61472010-07-07 22:20:57 +0000622 // Note down abstract DIE.
623 if (ScopeDIE)
624 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
625 }
Devang Patel3c91b052010-03-08 20:52:55 +0000626 else
Devang Pateld3024342011-08-15 22:24:32 +0000627 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3c91b052010-03-08 20:52:55 +0000628 }
Devang Patel5bc9fec2011-02-19 01:31:27 +0000629 else {
Manman Ren995de6c2013-09-11 19:40:28 +0000630 // Early exit when we know the scope DIE is going to be null.
Manman Renfd2210a2013-09-10 18:40:41 +0000631 if (isLexicalScopeDIENull(Scope))
632 return NULL;
Manman Ren995de6c2013-09-11 19:40:28 +0000633
634 // We create children here when we know the scope DIE is not going to be
635 // null and the children will be added to the scope DIE.
Manman Renfd2210a2013-09-10 18:40:41 +0000636 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
637 ChildrenCreated = true;
Manman Ren995de6c2013-09-11 19:40:28 +0000638
Devang Patel5bc9fec2011-02-19 01:31:27 +0000639 // There is no need to emit empty lexical block DIE.
David Blaikied2e0f7e2013-05-06 23:33:07 +0000640 std::pair<ImportedEntityMap::const_iterator,
641 ImportedEntityMap::const_iterator> Range = std::equal_range(
642 ScopesWithImportedEntities.begin(), ScopesWithImportedEntities.end(),
Timur Iskhodzhanov664fbee2013-05-07 07:47:47 +0000643 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode*)0),
Benjamin Kramer0b6962f2013-08-24 12:54:27 +0000644 less_first());
David Blaikied2e0f7e2013-05-06 23:33:07 +0000645 if (Children.empty() && Range.first == Range.second)
Devang Patel5bc9fec2011-02-19 01:31:27 +0000646 return NULL;
Devang Pateld3024342011-08-15 22:24:32 +0000647 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Manman Renfd2210a2013-09-10 18:40:41 +0000648 assert(ScopeDIE && "Scope DIE should not be null.");
Eric Christopherfdfc81f2013-06-24 23:20:02 +0000649 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
650 ++i)
David Blaikied1221e32013-05-08 06:01:38 +0000651 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5bc9fec2011-02-19 01:31:27 +0000652 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000653
Benjamin Kramer6bee6312013-08-24 11:55:49 +0000654 if (!ScopeDIE) {
Manman Renfd2210a2013-09-10 18:40:41 +0000655 assert(Children.empty() &&
656 "We create children only when the scope DIE is not null.");
Benjamin Kramer6bee6312013-08-24 11:55:49 +0000657 return NULL;
658 }
Manman Renfd2210a2013-09-10 18:40:41 +0000659 if (!ChildrenCreated)
Manman Ren995de6c2013-09-11 19:40:28 +0000660 // We create children when the scope DIE is not null.
Manman Renfd2210a2013-09-10 18:40:41 +0000661 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000662
Devang Patel5bc9fec2011-02-19 01:31:27 +0000663 // Add children
Craig Topper2d785db2013-07-03 04:17:25 +0000664 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Devang Patel5bc9fec2011-02-19 01:31:27 +0000665 E = Children.end(); I != E; ++I)
666 ScopeDIE->addChild(*I);
Devang Patel193f7202009-11-24 01:14:22 +0000667
Eric Christophere5212782012-09-12 23:36:19 +0000668 if (DS.isSubprogram() && ObjectPointer != NULL)
Manman Ren87b110a2013-10-11 23:58:05 +0000669 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, ObjectPointer);
Eric Christophere5212782012-09-12 23:36:19 +0000670
Jim Grosbach1e20b962010-07-21 21:21:52 +0000671 if (DS.isSubprogram())
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000672 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbach1e20b962010-07-21 21:21:52 +0000673
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000674 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +0000675}
676
Eric Christopherb6dc8652012-11-27 22:43:45 +0000677// Look up the source id with the given directory and source file names.
678// If none currently exists, create a new id and insert it in the
679// SourceIds map. This can update DirectoryNames and SourceFileNames maps
680// as well.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000681unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Manman Ren3de61b42013-03-07 01:42:00 +0000682 StringRef DirName, unsigned CUID) {
683 // If we use .loc in assembly, we can't separate .file entries according to
684 // compile units. Thus all files will belong to the default compile unit.
Rafael Espindola5e195a42013-10-05 16:42:21 +0000685
686 // FIXME: add a better feature test than hasRawTextSupport. Even better,
687 // extend .file to support this.
688 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren3de61b42013-03-07 01:42:00 +0000689 CUID = 0;
690
Devang Patel1905a182010-09-16 20:57:49 +0000691 // If FE did not provide a file name, then assume stdin.
692 if (FileName.empty())
Manman Ren3de61b42013-03-07 01:42:00 +0000693 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patel23670e52011-03-24 20:30:50 +0000694
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000695 // TODO: this might not belong here. See if we can factor this better.
696 if (DirName == CompilationDir)
697 DirName = "";
698
Manman Ren3de61b42013-03-07 01:42:00 +0000699 // FileIDCUMap stores the current ID for the given compile unit.
700 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel1905a182010-09-16 20:57:49 +0000701
Manman Ren3de61b42013-03-07 01:42:00 +0000702 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer74612c22012-03-11 14:56:26 +0000703 SmallString<128> NamePair;
Manman Ren5044a932013-04-06 01:02:38 +0000704 NamePair += utostr(CUID);
Manman Ren3de61b42013-03-07 01:42:00 +0000705 NamePair += '\0';
Benjamin Kramer74612c22012-03-11 14:56:26 +0000706 NamePair += DirName;
707 NamePair += '\0'; // Zero bytes are not allowed in paths.
708 NamePair += FileName;
709
710 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
711 if (Ent.getValue() != SrcId)
712 return Ent.getValue();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000713
Manman Ren3de61b42013-03-07 01:42:00 +0000714 FileIDCUMap[CUID] = SrcId;
Rafael Espindola5c055632010-11-18 02:04:25 +0000715 // Print out a .file directive to specify files for .loc directives.
Manman Ren3de61b42013-03-07 01:42:00 +0000716 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000717
718 return SrcId;
719}
720
Eric Christopher72c16552012-12-20 21:58:40 +0000721// Create new CompileUnit for the given metadata node with tag
722// DW_TAG_compile_unit.
Devang Patel94c7ddb2011-08-16 22:09:43 +0000723CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +0000724 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +0000725 StringRef FN = DIUnit.getFilename();
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000726 CompilationDir = DIUnit.getDirectory();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000727
728 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher7b878952013-08-26 23:50:38 +0000729 CompileUnit *NewCU =
730 new CompileUnit(GlobalCUIndexCount++, Die, N, Asm, this, &InfoHolder);
Manman Ren3de61b42013-03-07 01:42:00 +0000731
732 FileIDCUMap[NewCU->getUniqueID()] = 0;
733 // Call this to emit a .file directive if it wasn't emitted for the source
734 // file this CU comes from yet.
735 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
736
Nick Lewycky390c40d2011-10-27 06:44:11 +0000737 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patel3cbee302011-04-12 22:53:02 +0000738 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
739 DIUnit.getLanguage());
Nick Lewycky390c40d2011-10-27 06:44:11 +0000740 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christophere0828ec2013-04-09 19:23:15 +0000741
Eric Christopher6635cad2012-08-01 18:19:01 +0000742 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christophere0828ec2013-04-09 19:23:15 +0000743 // into an entity. We're using 0 (or a NULL label) for this. For
744 // split dwarf it's in the skeleton CU so omit it here.
745 if (!useSplitDwarf())
746 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
Manman Ren43213cf2013-02-05 21:52:47 +0000747
748 // Define start line table label for each Compile Unit.
749 MCSymbol *LineTableStartSym = Asm->GetTempSymbol("line_table_start",
750 NewCU->getUniqueID());
751 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
752 NewCU->getUniqueID());
753
Manman Ren01cb18e2013-05-21 00:57:22 +0000754 // Use a single line table if we are using .loc and generating assembly.
755 bool UseTheFirstCU =
Rafael Espindola5e195a42013-10-05 16:42:21 +0000756 (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport()) ||
757 (NewCU->getUniqueID() == 0);
Manman Ren01cb18e2013-05-21 00:57:22 +0000758
Eric Christophere0828ec2013-04-09 19:23:15 +0000759 if (!useSplitDwarf()) {
Eric Christopher0b15e982013-09-27 22:50:48 +0000760 // DW_AT_stmt_list is a offset of line number information for this
761 // compile unit in debug_line section. For split dwarf this is
762 // left in the skeleton CU and so not included.
763 // The line table entries are not always emitted in assembly, so it
764 // is not okay to use line_table_start here.
Eric Christophere0828ec2013-04-09 19:23:15 +0000765 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Carlo Kok46f0b6f2013-08-13 17:46:57 +0000766 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher0b15e982013-09-27 22:50:48 +0000767 UseTheFirstCU ? Asm->GetTempSymbol("section_line")
768 : LineTableStartSym);
Manman Ren01cb18e2013-05-21 00:57:22 +0000769 else if (UseTheFirstCU)
Eric Christophere0828ec2013-04-09 19:23:15 +0000770 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
771 else
772 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
773 LineTableStartSym, DwarfLineSectionSym);
Eric Christopher0b15e982013-09-27 22:50:48 +0000774
775 // If we're using split dwarf the compilation dir is going to be in the
776 // skeleton CU and so we don't need to duplicate it here.
777 if (!CompilationDir.empty())
778 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
779
Eric Christopher08bd9232013-10-01 00:43:31 +0000780 // Flags to let the linker know we have emitted new style pubnames. Only
Eric Christopher0b15e982013-09-27 22:50:48 +0000781 // emit it here if we don't have a skeleton CU for split dwarf.
Eric Christophera6d84152013-09-30 23:14:16 +0000782 if (GenerateGnuPubSections) {
783 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
784 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames,
785 dwarf::DW_FORM_sec_offset,
786 Asm->GetTempSymbol("gnu_pubnames",
787 NewCU->getUniqueID()));
788 else
789 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
790 Asm->GetTempSymbol("gnu_pubnames",
791 NewCU->getUniqueID()),
792 DwarfGnuPubNamesSectionSym);
793
794 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
795 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes,
796 dwarf::DW_FORM_sec_offset,
797 Asm->GetTempSymbol("gnu_pubtypes",
798 NewCU->getUniqueID()));
799 else
800 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopher7c9fc902013-10-03 17:41:16 +0000801 Asm->GetTempSymbol("gnu_pubtypes",
Eric Christophera6d84152013-09-30 23:14:16 +0000802 NewCU->getUniqueID()),
803 DwarfGnuPubTypesSectionSym);
804 }
Eric Christophere0828ec2013-04-09 19:23:15 +0000805 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000806
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000807 if (DIUnit.isOptimized())
Eric Christopher873cf0a2012-08-24 01:14:27 +0000808 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000809
Devang Patel65dbc902009-11-25 17:36:49 +0000810 StringRef Flags = DIUnit.getFlags();
811 if (!Flags.empty())
Nick Lewycky390c40d2011-10-27 06:44:11 +0000812 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000813
Nick Lewyckyd5d52132011-10-17 23:27:36 +0000814 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patel3cbee302011-04-12 22:53:02 +0000815 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000816 dwarf::DW_FORM_data1, RVer);
817
Devang Patel163a9f72010-05-10 22:49:55 +0000818 if (!FirstCU)
819 FirstCU = NewCU;
Eric Christopher208cc6f2013-02-05 07:31:55 +0000820
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000821 InfoHolder.addUnit(NewCU);
822
Devang Patel163a9f72010-05-10 22:49:55 +0000823 CUMap.insert(std::make_pair(N, NewCU));
Manman Ren3eabc2a2013-10-29 22:57:10 +0000824 CUDieMap.insert(std::make_pair(Die, 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
Manman Ren3eabc2a2013-10-29 22:57:10 +00001919// Compute the size and offset of a DIE. The offset is relative to start of the
1920// CU. It returns the offset after laying out the DIE.
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001921unsigned
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001922DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001923 // Get the children.
1924 const std::vector<DIE *> &Children = Die->getChildren();
1925
Bill Wendling94d04b82009-05-20 23:21:38 +00001926 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001927 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00001928
1929 // Get the abbreviation for this DIE.
1930 unsigned AbbrevNumber = Die->getAbbrevNumber();
David Blaikie8e8e6dc2013-10-30 17:14:24 +00001931 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
Bill Wendling94d04b82009-05-20 23:21:38 +00001932
1933 // Set DIE offset
1934 Die->setOffset(Offset);
1935
1936 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00001937 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001938
Eric Christopherf7cef702013-03-29 23:34:06 +00001939 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1940 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling94d04b82009-05-20 23:21:38 +00001941
1942 // Size the DIE attribute values.
1943 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1944 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00001945 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00001946
1947 // Size the DIE children if any.
1948 if (!Children.empty()) {
1949 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1950 "Children flag not set");
1951
1952 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopherfbd19752012-11-20 22:14:13 +00001953 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling94d04b82009-05-20 23:21:38 +00001954
1955 // End of children marker.
1956 Offset += sizeof(int8_t);
1957 }
1958
1959 Die->setSize(Offset - Die->getOffset());
1960 return Offset;
1961}
1962
Eric Christopher39cd7d42013-10-24 21:05:08 +00001963// Compute the size and offset for each DIE.
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001964void DwarfUnits::computeSizeAndOffsets() {
Manman Ren3eabc2a2013-10-29 22:57:10 +00001965 // Offset from the first CU in the debug info section is 0 initially.
1966 unsigned SecOffset = 0;
1967
Eric Christopher39cd7d42013-10-24 21:05:08 +00001968 // Iterate over each compile unit and set the size and offsets for each
1969 // DIE within each compile unit. All offsets are CU relative.
Eric Christopherf7cef702013-03-29 23:34:06 +00001970 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001971 E = CUs.end(); I != E; ++I) {
Manman Ren3eabc2a2013-10-29 22:57:10 +00001972 (*I)->setDebugInfoOffset(SecOffset);
1973
1974 // CU-relative offset is reset to 0 here.
David Blaikie1d361132013-10-30 20:42:41 +00001975 unsigned Offset = sizeof(int32_t) + // Length of Unit Info
1976 (*I)->getHeaderSize(); // Unit-specific headers
Manman Ren3eabc2a2013-10-29 22:57:10 +00001977
1978 // EndOffset here is CU-relative, after laying out
1979 // all of the CU DIE.
1980 unsigned EndOffset = computeSizeAndOffset((*I)->getCUDie(), Offset);
1981 SecOffset += EndOffset;
Devang Patel163a9f72010-05-10 22:49:55 +00001982 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001983}
1984
Eric Christopherb6dc8652012-11-27 22:43:45 +00001985// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001986void DwarfDebug::emitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001987 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001988
Bill Wendling94d04b82009-05-20 23:21:38 +00001989 // Dwarf sections base addresses.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001990 DwarfInfoSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001991 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00001992 DwarfAbbrevSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001993 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher6eebe472012-12-19 22:02:53 +00001994 if (useSplitDwarf())
1995 DwarfAbbrevDWOSectionSym =
1996 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1997 "section_abbrev_dwo");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001998 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001999
Chris Lattner9c69e285532010-04-04 22:59:04 +00002000 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002001 emitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002002
Eric Christopher7a0103c2013-02-07 21:19:50 +00002003 DwarfLineSectionSym =
2004 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002005 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Eric Christophercdeaae42013-09-23 20:55:35 +00002006 if (GenerateGnuPubSections) {
Eric Christophera6d84152013-09-30 23:14:16 +00002007 DwarfGnuPubNamesSectionSym =
2008 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
2009 DwarfGnuPubTypesSectionSym =
2010 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
Eric Christophercdeaae42013-09-23 20:55:35 +00002011 } else if (HasDwarfPubSections) {
2012 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2013 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Michael Gottesmandc42d032013-09-04 04:39:38 +00002014 }
Eric Christopher8f1a9292013-09-13 00:35:05 +00002015
Jim Grosbach1e20b962010-07-21 21:21:52 +00002016 DwarfStrSectionSym =
Eric Christopher64f824c2012-12-27 02:14:01 +00002017 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002018 if (useSplitDwarf()) {
Eric Christopher64f824c2012-12-27 02:14:01 +00002019 DwarfStrDWOSectionSym =
2020 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002021 DwarfAddrSectionSym =
2022 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
2023 }
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002024 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patelf2548ca2010-04-16 23:33:45 +00002025 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00002026
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002027 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patelc3f5f782010-05-25 23:40:22 +00002028 "section_debug_loc");
2029
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002030 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
2031 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002032}
2033
Eric Christopherb6dc8652012-11-27 22:43:45 +00002034// Recursively emits a debug information entry.
David Blaikie8e8e6dc2013-10-30 17:14:24 +00002035void DwarfDebug::emitDIE(DIE *Die, ArrayRef<DIEAbbrev *> Abbrevs) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002036 // Get the abbreviation for this DIE.
2037 unsigned AbbrevNumber = Die->getAbbrevNumber();
David Blaikie8e8e6dc2013-10-30 17:14:24 +00002038 const DIEAbbrev *Abbrev = Abbrevs[AbbrevNumber - 1];
Bill Wendling94d04b82009-05-20 23:21:38 +00002039
Bill Wendling94d04b82009-05-20 23:21:38 +00002040 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00002041 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00002042 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2043 Twine::utohexstr(Die->getOffset()) + ":0x" +
2044 Twine::utohexstr(Die->getSize()) + " " +
2045 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002046 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00002047
Eric Christopherf7cef702013-03-29 23:34:06 +00002048 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
2049 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling94d04b82009-05-20 23:21:38 +00002050
2051 // Emit the DIE attribute values.
2052 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
David Blaikie770530b2013-10-21 17:28:37 +00002053 dwarf::Attribute Attr = AbbrevData[i].getAttribute();
2054 dwarf::Form Form = AbbrevData[i].getForm();
Bill Wendling94d04b82009-05-20 23:21:38 +00002055 assert(Form && "Too many attributes for DIE (check abbreviation)");
2056
Chris Lattner3f53c832010-04-04 18:52:31 +00002057 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00002058 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002059
Bill Wendling94d04b82009-05-20 23:21:38 +00002060 switch (Attr) {
Manman Ren3eabc2a2013-10-29 22:57:10 +00002061 case dwarf::DW_AT_abstract_origin:
2062 case dwarf::DW_AT_type:
2063 case dwarf::DW_AT_friend:
2064 case dwarf::DW_AT_specification:
2065 case dwarf::DW_AT_import:
2066 case dwarf::DW_AT_containing_type: {
2067 DIEEntry *E = cast<DIEEntry>(Values[i]);
2068 DIE *Origin = E->getEntry();
2069 unsigned Addr = Origin->getOffset();
2070 if (Form == dwarf::DW_FORM_ref_addr) {
2071 assert(!useSplitDwarf() && "TODO: dwo files can't have relocations.");
2072 // For DW_FORM_ref_addr, output the offset from beginning of debug info
2073 // section. Origin->getOffset() returns the offset from start of the
2074 // compile unit.
2075 CompileUnit *CU = CUDieMap.lookup(Origin->getCompileUnit());
2076 assert(CU && "CUDie should belong to a CU.");
2077 Addr += CU->getDebugInfoOffset();
2078 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2079 Asm->EmitLabelPlusOffset(DwarfInfoSectionSym, Addr,
2080 DIEEntry::getRefAddrSize(Asm));
2081 else
Manman Ren38856f82013-10-29 23:14:15 +00002082 Asm->EmitLabelOffsetDifference(DwarfInfoSectionSym, Addr,
2083 DwarfInfoSectionSym,
2084 DIEEntry::getRefAddrSize(Asm));
Manman Ren3eabc2a2013-10-29 22:57:10 +00002085 } else {
2086 Asm->EmitInt32(Addr);
2087 }
2088 break;
2089 }
Devang Patelf2548ca2010-04-16 23:33:45 +00002090 case dwarf::DW_AT_ranges: {
2091 // DW_AT_range Value encodes offset in debug_range section.
2092 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelb1fcfbe2010-09-02 16:43:44 +00002093
Nick Lewyckyffccd922012-06-22 01:25:12 +00002094 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelb1fcfbe2010-09-02 16:43:44 +00002095 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
2096 V->getValue(),
2097 4);
2098 } else {
2099 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
2100 V->getValue(),
2101 DwarfDebugRangeSectionSym,
2102 4);
2103 }
Devang Patelf2548ca2010-04-16 23:33:45 +00002104 break;
2105 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002106 case dwarf::DW_AT_location: {
Nick Lewyckyffccd922012-06-22 01:25:12 +00002107 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2108 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Ulrich Weigand1f8aacd2013-07-02 18:46:26 +00002109 Asm->EmitLabelReference(L->getValue(), 4);
Nick Lewyckyffccd922012-06-22 01:25:12 +00002110 else
Ulrich Weigand1f8aacd2013-07-02 18:46:26 +00002111 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewyckyffccd922012-06-22 01:25:12 +00002112 } else {
Devang Patelc3f5f782010-05-25 23:40:22 +00002113 Values[i]->EmitValue(Asm, Form);
Nick Lewyckyffccd922012-06-22 01:25:12 +00002114 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002115 break;
2116 }
Devang Patel2a361602010-09-29 19:08:08 +00002117 case dwarf::DW_AT_accessibility: {
2118 if (Asm->isVerbose()) {
2119 DIEInteger *V = cast<DIEInteger>(Values[i]);
2120 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2121 }
2122 Values[i]->EmitValue(Asm, Form);
2123 break;
2124 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002125 default:
2126 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002127 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00002128 break;
2129 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002130 }
2131
2132 // Emit the DIE children if any.
2133 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2134 const std::vector<DIE *> &Children = Die->getChildren();
2135
2136 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher6eebe472012-12-19 22:02:53 +00002137 emitDIE(Children[j], Abbrevs);
Bill Wendling94d04b82009-05-20 23:21:38 +00002138
Chris Lattner3f53c832010-04-04 18:52:31 +00002139 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00002140 Asm->OutStreamer.AddComment("End Of Children Mark");
2141 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00002142 }
2143}
2144
Eric Christopherb1e66d02012-12-15 00:04:07 +00002145// Emit the various dwarf units to the unit section USection with
2146// the abbreviations going into ASection.
2147void DwarfUnits::emitUnits(DwarfDebug *DD,
2148 const MCSection *USection,
2149 const MCSection *ASection,
2150 const MCSymbol *ASectionSym) {
2151 Asm->OutStreamer.SwitchSection(USection);
Eric Christopherf7cef702013-03-29 23:34:06 +00002152 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopherb1e66d02012-12-15 00:04:07 +00002153 E = CUs.end(); I != E; ++I) {
2154 CompileUnit *TheCU = *I;
Devang Patel163a9f72010-05-10 22:49:55 +00002155 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002156
Devang Patel163a9f72010-05-10 22:49:55 +00002157 // Emit the compile units header.
Eric Christopherb1e66d02012-12-15 00:04:07 +00002158 Asm->OutStreamer
2159 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
2160 TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002161
Devang Patel163a9f72010-05-10 22:49:55 +00002162 // Emit size of content not including length itself
David Blaikie1d361132013-10-30 20:42:41 +00002163 Asm->OutStreamer.AddComment("Length of Unit");
2164 Asm->EmitInt32(TheCU->getHeaderSize() + Die->getSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002165
David Blaikie1d361132013-10-30 20:42:41 +00002166 TheCU->emitHeader(ASection, ASectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002167
Eric Christopher6eebe472012-12-19 22:02:53 +00002168 DD->emitDIE(Die, Abbreviations);
Eric Christopherb1e66d02012-12-15 00:04:07 +00002169 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002170 TheCU->getUniqueID()));
Devang Patel163a9f72010-05-10 22:49:55 +00002171 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002172}
2173
Eric Christopher98e237f2012-11-30 23:59:06 +00002174// Emit the debug info section.
2175void DwarfDebug::emitDebugInfo() {
Eric Christopherb1e66d02012-12-15 00:04:07 +00002176 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2177
2178 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
2179 Asm->getObjFileLowering().getDwarfAbbrevSection(),
2180 DwarfAbbrevSectionSym);
Eric Christopher98e237f2012-11-30 23:59:06 +00002181}
2182
Eric Christopherb6dc8652012-11-27 22:43:45 +00002183// Emit the abbreviation section.
Eric Christopher7dc68db2012-11-20 23:30:11 +00002184void DwarfDebug::emitAbbreviations() {
Eric Christopher6eebe472012-12-19 22:02:53 +00002185 if (!useSplitDwarf())
2186 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
2187 &Abbreviations);
2188 else
2189 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2190}
Bill Wendling94d04b82009-05-20 23:21:38 +00002191
Eric Christopher6eebe472012-12-19 22:02:53 +00002192void DwarfDebug::emitAbbrevs(const MCSection *Section,
2193 std::vector<DIEAbbrev *> *Abbrevs) {
2194 // Check to see if it is worth the effort.
2195 if (!Abbrevs->empty()) {
2196 // Start the debug abbrev section.
2197 Asm->OutStreamer.SwitchSection(Section);
2198
2199 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
Eric Christopher44fedba2012-12-13 03:00:38 +00002200 Asm->OutStreamer.EmitLabel(Begin);
Bill Wendling94d04b82009-05-20 23:21:38 +00002201
2202 // For each abbrevation.
Eric Christopher6eebe472012-12-19 22:02:53 +00002203 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002204 // Get abbreviation data
Eric Christopher6eebe472012-12-19 22:02:53 +00002205 const DIEAbbrev *Abbrev = Abbrevs->at(i);
Bill Wendling94d04b82009-05-20 23:21:38 +00002206
2207 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002208 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00002209
2210 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002211 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00002212 }
2213
2214 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002215 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00002216
Eric Christopher6eebe472012-12-19 22:02:53 +00002217 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
Eric Christopher44fedba2012-12-13 03:00:38 +00002218 Asm->OutStreamer.EmitLabel(End);
Bill Wendling94d04b82009-05-20 23:21:38 +00002219 }
2220}
2221
Eric Christopherb6dc8652012-11-27 22:43:45 +00002222// Emit the last address of the section and the end of the line matrix.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002223void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002224 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00002225 Asm->OutStreamer.AddComment("Extended Op");
2226 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002227
Chris Lattner233f52b2010-03-09 23:52:58 +00002228 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002229 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00002230 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2231 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2232
2233 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00002234
Chris Lattnerc0215722010-04-04 19:25:43 +00002235 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Eric Christopherca1dd052013-01-09 01:35:34 +00002236 Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002237
2238 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00002239 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2240 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00002241 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00002242 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00002243}
2244
Eric Christopherb6dc8652012-11-27 22:43:45 +00002245// Emit visible names into a hashed accelerator table section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002246void DwarfDebug::emitAccelNames() {
Eric Christopher577056f2013-09-05 18:20:16 +00002247 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher09ac3d82011-11-07 09:24:32 +00002248 dwarf::DW_FORM_data4));
2249 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2250 E = CUMap.end(); I != E; ++I) {
2251 CompileUnit *TheCU = I->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00002252 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2253 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002254 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002255 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002256 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00002257 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2258 DE = Entities.end(); DI != DE; ++DI)
2259 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00002260 }
2261 }
2262
2263 AT.FinalizeTable(Asm, "Names");
2264 Asm->OutStreamer.SwitchSection(
2265 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2266 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2267 Asm->OutStreamer.EmitLabel(SectionBegin);
2268
2269 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002270 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002271}
2272
Eric Christopher72c16552012-12-20 21:58:40 +00002273// Emit objective C classes and categories into a hashed accelerator table
2274// section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002275void DwarfDebug::emitAccelObjC() {
Eric Christopher577056f2013-09-05 18:20:16 +00002276 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher09ac3d82011-11-07 09:24:32 +00002277 dwarf::DW_FORM_data4));
2278 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2279 E = CUMap.end(); I != E; ++I) {
2280 CompileUnit *TheCU = I->second;
2281 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2282 for (StringMap<std::vector<DIE*> >::const_iterator
2283 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002284 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002285 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher09ac3d82011-11-07 09:24:32 +00002286 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2287 DE = Entities.end(); DI != DE; ++DI)
2288 AT.AddName(Name, (*DI));
2289 }
2290 }
2291
2292 AT.FinalizeTable(Asm, "ObjC");
2293 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2294 .getDwarfAccelObjCSection());
2295 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2296 Asm->OutStreamer.EmitLabel(SectionBegin);
2297
2298 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002299 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002300}
2301
Eric Christopherb6dc8652012-11-27 22:43:45 +00002302// Emit namespace dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002303void DwarfDebug::emitAccelNamespaces() {
Eric Christopher577056f2013-09-05 18:20:16 +00002304 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher09ac3d82011-11-07 09:24:32 +00002305 dwarf::DW_FORM_data4));
2306 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2307 E = CUMap.end(); I != E; ++I) {
2308 CompileUnit *TheCU = I->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00002309 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2310 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002311 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002312 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002313 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00002314 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2315 DE = Entities.end(); DI != DE; ++DI)
2316 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00002317 }
2318 }
2319
2320 AT.FinalizeTable(Asm, "namespac");
2321 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2322 .getDwarfAccelNamespaceSection());
2323 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2324 Asm->OutStreamer.EmitLabel(SectionBegin);
2325
2326 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002327 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002328}
2329
Eric Christopherb6dc8652012-11-27 22:43:45 +00002330// Emit type dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002331void DwarfDebug::emitAccelTypes() {
Eric Christopherc36145f2012-01-06 04:35:23 +00002332 std::vector<DwarfAccelTable::Atom> Atoms;
Eric Christopher577056f2013-09-05 18:20:16 +00002333 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopherc36145f2012-01-06 04:35:23 +00002334 dwarf::DW_FORM_data4));
Eric Christopher577056f2013-09-05 18:20:16 +00002335 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag,
Eric Christopherc36145f2012-01-06 04:35:23 +00002336 dwarf::DW_FORM_data2));
Eric Christopher577056f2013-09-05 18:20:16 +00002337 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags,
Eric Christopherc36145f2012-01-06 04:35:23 +00002338 dwarf::DW_FORM_data1));
2339 DwarfAccelTable AT(Atoms);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002340 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2341 E = CUMap.end(); I != E; ++I) {
2342 CompileUnit *TheCU = I->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002343 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2344 = TheCU->getAccelTypes();
2345 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002346 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002347 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002348 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002349 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2350 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2351 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002352 }
2353 }
2354
2355 AT.FinalizeTable(Asm, "types");
2356 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2357 .getDwarfAccelTypesSection());
2358 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2359 Asm->OutStreamer.EmitLabel(SectionBegin);
2360
2361 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002362 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002363}
2364
Eric Christopher8f1a9292013-09-13 00:35:05 +00002365// Public name handling.
2366// The format for the various pubnames:
2367//
2368// dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2369// for the DIE that is named.
2370//
2371// gnu pubnames - offset/index value/name tuples where the offset is the offset
2372// into the CU and the index value is computed according to the type of value
2373// for the DIE that is named.
2374//
2375// For type units the offset is the offset of the skeleton DIE. For split dwarf
2376// it's the offset within the debug_info/debug_types dwo section, however, the
2377// reference in the pubname header doesn't change.
2378
2379/// computeIndexValue - Compute the gdb index value for the DIE and CU.
David Blaikie9599f512013-09-19 20:40:26 +00002380static dwarf::PubIndexEntryDescriptor computeIndexValue(CompileUnit *CU,
2381 DIE *Die) {
Eric Christophera486f552013-10-16 01:37:49 +00002382 dwarf::GDBIndexEntryLinkage Linkage = dwarf::GIEL_STATIC;
2383
2384 // We could have a specification DIE that has our most of our knowledge,
2385 // look for that now.
2386 DIEValue *SpecVal = Die->findAttribute(dwarf::DW_AT_specification);
2387 if (SpecVal) {
2388 DIE *SpecDIE = cast<DIEEntry>(SpecVal)->getEntry();
2389 if (SpecDIE->findAttribute(dwarf::DW_AT_external))
2390 Linkage = dwarf::GIEL_EXTERNAL;
2391 } else if (Die->findAttribute(dwarf::DW_AT_external))
2392 Linkage = dwarf::GIEL_EXTERNAL;
Eric Christopher8f1a9292013-09-13 00:35:05 +00002393
2394 switch (Die->getTag()) {
2395 case dwarf::DW_TAG_class_type:
2396 case dwarf::DW_TAG_structure_type:
2397 case dwarf::DW_TAG_union_type:
2398 case dwarf::DW_TAG_enumeration_type:
Eric Christophercdeaae42013-09-23 20:55:35 +00002399 return dwarf::PubIndexEntryDescriptor(
2400 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2401 ? dwarf::GIEL_STATIC
2402 : dwarf::GIEL_EXTERNAL);
Eric Christopher8f1a9292013-09-13 00:35:05 +00002403 case dwarf::DW_TAG_typedef:
2404 case dwarf::DW_TAG_base_type:
2405 case dwarf::DW_TAG_subrange_type:
David Blaikie9599f512013-09-19 20:40:26 +00002406 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
Eric Christopher8f1a9292013-09-13 00:35:05 +00002407 case dwarf::DW_TAG_namespace:
David Blaikie9599f512013-09-19 20:40:26 +00002408 return dwarf::GIEK_TYPE;
Eric Christopher8f1a9292013-09-13 00:35:05 +00002409 case dwarf::DW_TAG_subprogram:
Eric Christophera31a9752013-09-23 22:59:14 +00002410 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
Eric Christopher8f1a9292013-09-13 00:35:05 +00002411 case dwarf::DW_TAG_constant:
2412 case dwarf::DW_TAG_variable:
Eric Christophera31a9752013-09-23 22:59:14 +00002413 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
Eric Christopher8f1a9292013-09-13 00:35:05 +00002414 case dwarf::DW_TAG_enumerator:
David Blaikie9599f512013-09-19 20:40:26 +00002415 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2416 dwarf::GIEL_STATIC);
Eric Christopher8f1a9292013-09-13 00:35:05 +00002417 default:
David Blaikie9599f512013-09-19 20:40:26 +00002418 return dwarf::GIEK_NONE;
Eric Christopher8f1a9292013-09-13 00:35:05 +00002419 }
Eric Christopher8f1a9292013-09-13 00:35:05 +00002420}
2421
Eric Christopher57479322013-09-09 20:03:17 +00002422/// emitDebugPubNames - Emit visible names into a debug pubnames section.
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002423///
Eric Christopher8f1a9292013-09-13 00:35:05 +00002424void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002425 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christopher8f1a9292013-09-13 00:35:05 +00002426 const MCSection *PSec =
2427 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2428 : Asm->getObjFileLowering().getDwarfPubNamesSection();
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002429
2430 typedef DenseMap<const MDNode*, CompileUnit*> CUMapType;
2431 for (CUMapType::iterator I = CUMap.begin(), E = CUMap.end(); I != E; ++I) {
2432 CompileUnit *TheCU = I->second;
2433 unsigned ID = TheCU->getUniqueID();
2434
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002435 // Start the dwarf pubnames section.
Eric Christopher21a6a502013-09-10 21:49:37 +00002436 Asm->OutStreamer.SwitchSection(PSec);
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002437
Eric Christophera6d84152013-09-30 23:14:16 +00002438 // Emit a label so we can reference the beginning of this pubname section.
2439 if (GnuStyle)
2440 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames",
2441 TheCU->getUniqueID()));
2442
Eric Christopher8f1a9292013-09-13 00:35:05 +00002443 // Emit the header.
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002444 Asm->OutStreamer.AddComment("Length of Public Names Info");
2445 Asm->EmitLabelDifference(Asm->GetTempSymbol("pubnames_end", ID),
2446 Asm->GetTempSymbol("pubnames_begin", ID), 4);
2447
2448 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin", ID));
2449
2450 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemerd7d43dc2013-08-21 06:13:34 +00002451 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002452
2453 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2454 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2455 DwarfInfoSectionSym);
2456
2457 Asm->OutStreamer.AddComment("Compilation Unit Length");
2458 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(), ID),
2459 Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2460 4);
2461
Eric Christopher8f1a9292013-09-13 00:35:05 +00002462 // Emit the pubnames for this compilation unit.
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002463 const StringMap<DIE*> &Globals = TheCU->getGlobalNames();
2464 for (StringMap<DIE*>::const_iterator
2465 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2466 const char *Name = GI->getKeyData();
Eric Christopher8f1a9292013-09-13 00:35:05 +00002467 DIE *Entity = GI->second;
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002468
2469 Asm->OutStreamer.AddComment("DIE offset");
2470 Asm->EmitInt32(Entity->getOffset());
2471
Eric Christopher8f1a9292013-09-13 00:35:05 +00002472 if (GnuStyle) {
David Blaikie18a6ade2013-09-19 22:19:37 +00002473 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2474 Asm->OutStreamer.AddComment(
David Blaikieac3f0162013-09-20 00:33:15 +00002475 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie994c37f2013-09-19 23:01:29 +00002476 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikie18a6ade2013-09-19 22:19:37 +00002477 Asm->EmitInt8(Desc.toBits());
Eric Christopher8f1a9292013-09-13 00:35:05 +00002478 }
2479
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002480 if (Asm->isVerbose())
2481 Asm->OutStreamer.AddComment("External Name");
Rafael Espindolaa3863ea2013-07-02 15:49:13 +00002482 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002483 }
2484
2485 Asm->OutStreamer.AddComment("End Mark");
2486 Asm->EmitInt32(0);
2487 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end", ID));
2488 }
2489}
2490
Eric Christopher8f1a9292013-09-13 00:35:05 +00002491void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
Eric Christopher5704d642013-09-13 00:34:58 +00002492 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christophercdeaae42013-09-23 20:55:35 +00002493 const MCSection *PSec =
2494 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2495 : Asm->getObjFileLowering().getDwarfPubTypesSection();
Eric Christopher5704d642013-09-13 00:34:58 +00002496
Devang Patel163a9f72010-05-10 22:49:55 +00002497 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
Eric Christopher5704d642013-09-13 00:34:58 +00002498 E = CUMap.end();
2499 I != E; ++I) {
Devang Patel163a9f72010-05-10 22:49:55 +00002500 CompileUnit *TheCU = I->second;
Eric Christopher63701182011-11-07 09:18:35 +00002501 // Start the dwarf pubtypes section.
Eric Christopher5704d642013-09-13 00:34:58 +00002502 Asm->OutStreamer.SwitchSection(PSec);
Eric Christophera6d84152013-09-30 23:14:16 +00002503
2504 // Emit a label so we can reference the beginning of this pubtype section.
2505 if (GnuStyle)
2506 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes",
2507 TheCU->getUniqueID()));
2508
2509 // Emit the header.
Devang Patel163a9f72010-05-10 22:49:55 +00002510 Asm->OutStreamer.AddComment("Length of Public Types Info");
2511 Asm->EmitLabelDifference(
Eric Christopher5704d642013-09-13 00:34:58 +00002512 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2513 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002514
Eric Christopher5704d642013-09-13 00:34:58 +00002515 Asm->OutStreamer.EmitLabel(
2516 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002517
Eric Christopher5704d642013-09-13 00:34:58 +00002518 if (Asm->isVerbose())
2519 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemerd7d43dc2013-08-21 06:13:34 +00002520 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002521
Devang Patel163a9f72010-05-10 22:49:55 +00002522 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eric Christopher5704d642013-09-13 00:34:58 +00002523 Asm->EmitSectionOffset(
2524 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()),
2525 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002526
Devang Patel163a9f72010-05-10 22:49:55 +00002527 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eric Christopher5704d642013-09-13 00:34:58 +00002528 Asm->EmitLabelDifference(
2529 Asm->GetTempSymbol(ISec->getLabelEndName(), TheCU->getUniqueID()),
2530 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002531
Eric Christophera6d84152013-09-30 23:14:16 +00002532 // Emit the pubtypes.
Eric Christopher5704d642013-09-13 00:34:58 +00002533 const StringMap<DIE *> &Globals = TheCU->getGlobalTypes();
2534 for (StringMap<DIE *>::const_iterator GI = Globals.begin(),
2535 GE = Globals.end();
2536 GI != GE; ++GI) {
Devang Patel163a9f72010-05-10 22:49:55 +00002537 const char *Name = GI->getKeyData();
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00002538 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002539
Eric Christopher5704d642013-09-13 00:34:58 +00002540 if (Asm->isVerbose())
2541 Asm->OutStreamer.AddComment("DIE offset");
Devang Patel163a9f72010-05-10 22:49:55 +00002542 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002543
Eric Christopher8f1a9292013-09-13 00:35:05 +00002544 if (GnuStyle) {
David Blaikie18a6ade2013-09-19 22:19:37 +00002545 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2546 Asm->OutStreamer.AddComment(
David Blaikieac3f0162013-09-20 00:33:15 +00002547 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie994c37f2013-09-19 23:01:29 +00002548 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikie18a6ade2013-09-19 22:19:37 +00002549 Asm->EmitInt8(Desc.toBits());
Eric Christopher8f1a9292013-09-13 00:35:05 +00002550 }
2551
Eric Christopher5704d642013-09-13 00:34:58 +00002552 if (Asm->isVerbose())
2553 Asm->OutStreamer.AddComment("External Name");
2554
Benjamin Kramer983c4572011-11-09 18:16:11 +00002555 // Emit the name with a terminating null byte.
Eric Christopher5704d642013-09-13 00:34:58 +00002556 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Devang Patel163a9f72010-05-10 22:49:55 +00002557 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002558
Devang Patel163a9f72010-05-10 22:49:55 +00002559 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00002560 Asm->EmitInt32(0);
Eric Christopher5704d642013-09-13 00:34:58 +00002561 Asm->OutStreamer.EmitLabel(
2562 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()));
Devang Patel193f7202009-11-24 01:14:22 +00002563 }
Devang Patel193f7202009-11-24 01:14:22 +00002564}
2565
Eric Christopher64f824c2012-12-27 02:14:01 +00002566// Emit strings into a string section.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002567void DwarfUnits::emitStrings(const MCSection *StrSection,
2568 const MCSection *OffsetSection = NULL,
2569 const MCSymbol *StrSecSym = NULL) {
Eric Christopher64f824c2012-12-27 02:14:01 +00002570
Eric Christopherb6714222013-01-08 22:22:06 +00002571 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002572
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002573 // Start the dwarf str section.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002574 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling94d04b82009-05-20 23:21:38 +00002575
Chris Lattnerbc733f52010-03-13 02:17:42 +00002576 // Get all of the string pool entries and put them in an array by their ID so
2577 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002578 SmallVector<std::pair<unsigned,
Eric Christopherff348452013-01-07 22:40:45 +00002579 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002580
Chris Lattnerbc733f52010-03-13 02:17:42 +00002581 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
Eric Christopherb6714222013-01-08 22:22:06 +00002582 I = StringPool.begin(), E = StringPool.end();
Eric Christopher72c16552012-12-20 21:58:40 +00002583 I != E; ++I)
Chris Lattnerbc733f52010-03-13 02:17:42 +00002584 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002585
Chris Lattnerbc733f52010-03-13 02:17:42 +00002586 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002587
Chris Lattnerbc733f52010-03-13 02:17:42 +00002588 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002589 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00002590 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002591
Benjamin Kramer983c4572011-11-09 18:16:11 +00002592 // Emit the string itself with a terminating null byte.
Benjamin Kramer0c45f7d2011-11-09 12:12:04 +00002593 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
Eric Christopherca1dd052013-01-09 01:35:34 +00002594 Entries[i].second->getKeyLength()+1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002595 }
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002596
2597 // If we've got an offset section go ahead and emit that now as well.
2598 if (OffsetSection) {
2599 Asm->OutStreamer.SwitchSection(OffsetSection);
2600 unsigned offset = 0;
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002601 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002602 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopher1ced2082013-01-09 03:52:05 +00002603 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002604 offset += Entries[i].second->getKeyLength() + 1;
2605 }
2606 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002607}
2608
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002609// Emit strings into a string section.
2610void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2611
2612 if (AddressPool.empty()) return;
2613
2614 // Start the dwarf addr section.
2615 Asm->OutStreamer.SwitchSection(AddrSection);
2616
David Blaikie66f464e2013-07-08 17:51:28 +00002617 // Order the address pool entries by ID
David Blaikie5ce40912013-07-08 17:33:10 +00002618 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002619
David Blaikie66f464e2013-07-08 17:51:28 +00002620 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2621 E = AddressPool.end();
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002622 I != E; ++I)
David Blaikie5ce40912013-07-08 17:33:10 +00002623 Entries[I->second] = I->first;
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002624
2625 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Ulrich Weigand18dbe502013-07-02 18:46:46 +00002626 // Emit an expression for reference from debug information entries.
David Blaikie5ce40912013-07-08 17:33:10 +00002627 if (const MCExpr *Expr = Entries[i])
Ulrich Weigand18dbe502013-07-02 18:46:46 +00002628 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002629 else
2630 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2631 }
2632
2633}
2634
Eric Christopher64f824c2012-12-27 02:14:01 +00002635// Emit visible names into a debug str section.
2636void DwarfDebug::emitDebugStr() {
2637 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2638 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2639}
2640
Eric Christopherd3b98532013-07-02 21:36:07 +00002641// Emit locations into the debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002642void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00002643 if (DotDebugLocEntries.empty())
2644 return;
2645
Eric Christopherf7cef702013-03-29 23:34:06 +00002646 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Devang Patel6c3ea902011-02-04 22:57:18 +00002647 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2648 I != E; ++I) {
2649 DotDebugLocEntry &Entry = *I;
2650 if (I + 1 != DotDebugLocEntries.end())
2651 Entry.Merge(I+1);
2652 }
2653
Daniel Dunbar83320a02011-03-16 22:16:39 +00002654 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002655 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00002656 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002657 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00002658 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2659 unsigned index = 1;
Eric Christopherf7cef702013-03-29 23:34:06 +00002660 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00002661 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00002662 I != E; ++I, ++index) {
Devang Patel6c3ea902011-02-04 22:57:18 +00002663 DotDebugLocEntry &Entry = *I;
2664 if (Entry.isMerged()) continue;
Devang Patelc3f5f782010-05-25 23:40:22 +00002665 if (Entry.isEmpty()) {
Eric Christopherca1dd052013-01-09 01:35:34 +00002666 Asm->OutStreamer.EmitIntValue(0, Size);
2667 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel80250682010-05-26 23:55:23 +00002668 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00002669 } else {
Eric Christopher0d0782a2013-07-03 22:40:18 +00002670 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2671 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2672 DIVariable DV(Entry.getVariable());
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002673 Asm->OutStreamer.AddComment("Loc expr size");
2674 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2675 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2676 Asm->EmitLabelDifference(end, begin, 2);
2677 Asm->OutStreamer.EmitLabel(begin);
Devang Patel80efd4e2011-07-08 16:49:43 +00002678 if (Entry.isInt()) {
Devang Patelc4329072011-06-01 22:03:25 +00002679 DIBasicType BTy(DV.getType());
2680 if (BTy.Verify() &&
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002681 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patelc4329072011-06-01 22:03:25 +00002682 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2683 Asm->OutStreamer.AddComment("DW_OP_consts");
2684 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Patel80efd4e2011-07-08 16:49:43 +00002685 Asm->EmitSLEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002686 } else {
2687 Asm->OutStreamer.AddComment("DW_OP_constu");
2688 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Patel80efd4e2011-07-08 16:49:43 +00002689 Asm->EmitULEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002690 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002691 } else if (Entry.isLocation()) {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002692 MachineLocation Loc = Entry.getLoc();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002693 if (!DV.hasComplexAddress())
Devang Patel80efd4e2011-07-08 16:49:43 +00002694 // Regular entry.
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002695 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002696 else {
2697 // Complex address entry.
2698 unsigned N = DV.getNumAddrElements();
2699 unsigned i = 0;
2700 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002701 if (Loc.getOffset()) {
Devang Patel80efd4e2011-07-08 16:49:43 +00002702 i = 2;
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002703 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002704 Asm->OutStreamer.AddComment("DW_OP_deref");
2705 Asm->EmitInt8(dwarf::DW_OP_deref);
2706 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2707 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2708 Asm->EmitSLEB128(DV.getAddrElement(1));
2709 } else {
2710 // If first address element is OpPlus then emit
2711 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002712 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2713 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002714 i = 2;
2715 }
2716 } else {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002717 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002718 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002719
Devang Patel80efd4e2011-07-08 16:49:43 +00002720 // Emit remaining complex address elements.
2721 for (; i < N; ++i) {
2722 uint64_t Element = DV.getAddrElement(i);
2723 if (Element == DIBuilder::OpPlus) {
2724 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2725 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher50120762012-05-08 18:56:00 +00002726 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002727 if (!Loc.isReg())
Eric Christopher50120762012-05-08 18:56:00 +00002728 Asm->EmitInt8(dwarf::DW_OP_deref);
2729 } else
2730 llvm_unreachable("unknown Opcode found in complex address");
Devang Patel80efd4e2011-07-08 16:49:43 +00002731 }
Devang Patelc26f5442011-04-28 02:22:40 +00002732 }
Devang Patelc26f5442011-04-28 02:22:40 +00002733 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002734 // else ... ignore constant fp. There is not any good way to
2735 // to represent them here in dwarf.
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002736 Asm->OutStreamer.EmitLabel(end);
Devang Patelc3f5f782010-05-25 23:40:22 +00002737 }
2738 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002739}
2740
Richard Mitton5cc319a2013-09-19 23:21:01 +00002741struct SymbolCUSorter {
2742 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2743 const MCStreamer &Streamer;
2744
2745 bool operator() (const SymbolCU &A, const SymbolCU &B) {
2746 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2747 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2748
2749 // Symbols with no order assigned should be placed at the end.
2750 // (e.g. section end labels)
2751 if (IA == 0)
2752 IA = (unsigned)(-1);
2753 if (IB == 0)
2754 IB = (unsigned)(-1);
2755 return IA < IB;
2756 }
2757};
2758
Richard Mitton5cc319a2013-09-19 23:21:01 +00002759static bool CUSort(const CompileUnit *A, const CompileUnit *B) {
2760 return (A->getUniqueID() < B->getUniqueID());
2761}
2762
2763struct ArangeSpan {
2764 const MCSymbol *Start, *End;
2765};
2766
2767// Emit a debug aranges section, containing a CU lookup for any
2768// address we can tie back to a CU.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002769void DwarfDebug::emitDebugARanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002770 // Start the dwarf aranges section.
Eric Christopherab6cd832013-08-30 00:39:57 +00002771 Asm->OutStreamer
2772 .SwitchSection(Asm->getObjFileLowering().getDwarfARangesSection());
Richard Mitton5cc319a2013-09-19 23:21:01 +00002773
2774 typedef DenseMap<CompileUnit *, std::vector<ArangeSpan> > SpansType;
2775
2776 SpansType Spans;
2777
2778 // Build a list of sections used.
2779 std::vector<const MCSection *> Sections;
2780 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2781 it++) {
2782 const MCSection *Section = it->first;
2783 Sections.push_back(Section);
2784 }
2785
2786 // Sort the sections into order.
2787 // This is only done to ensure consistent output order across different runs.
2788 std::sort(Sections.begin(), Sections.end(), SectionSort);
2789
2790 // Build a set of address spans, sorted by CU.
2791 for (size_t SecIdx=0;SecIdx<Sections.size();SecIdx++) {
2792 const MCSection *Section = Sections[SecIdx];
2793 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2794 if (List.size() < 2)
2795 continue;
2796
2797 // Sort the symbols by offset within the section.
2798 SymbolCUSorter sorter(Asm->OutStreamer);
2799 std::sort(List.begin(), List.end(), sorter);
2800
2801 // If we have no section (e.g. common), just write out
2802 // individual spans for each symbol.
2803 if (Section == NULL) {
2804 for (size_t n = 0; n < List.size(); n++) {
2805 const SymbolCU &Cur = List[n];
2806
2807 ArangeSpan Span;
2808 Span.Start = Cur.Sym;
2809 Span.End = NULL;
2810 if (Cur.CU)
2811 Spans[Cur.CU].push_back(Span);
2812 }
2813 } else {
2814 // Build spans between each label.
2815 const MCSymbol *StartSym = List[0].Sym;
2816 for (size_t n = 1; n < List.size(); n++) {
2817 const SymbolCU &Prev = List[n - 1];
2818 const SymbolCU &Cur = List[n];
2819
2820 // Try and build the longest span we can within the same CU.
2821 if (Cur.CU != Prev.CU) {
2822 ArangeSpan Span;
2823 Span.Start = StartSym;
2824 Span.End = Cur.Sym;
2825 Spans[Prev.CU].push_back(Span);
2826 StartSym = Cur.Sym;
2827 }
2828 }
2829 }
2830 }
2831
2832 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2833 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2834
2835 // Build a list of CUs used.
2836 std::vector<CompileUnit *> CUs;
2837 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
2838 CompileUnit *CU = it->first;
2839 CUs.push_back(CU);
2840 }
2841
2842 // Sort the CU list (again, to ensure consistent output order).
2843 std::sort(CUs.begin(), CUs.end(), CUSort);
2844
2845 // Emit an arange table for each CU we used.
2846 for (size_t CUIdx=0;CUIdx<CUs.size();CUIdx++) {
2847 CompileUnit *CU = CUs[CUIdx];
2848 std::vector<ArangeSpan> &List = Spans[CU];
2849
2850 // Emit size of content not including length itself.
2851 unsigned ContentSize
2852 = sizeof(int16_t) // DWARF ARange version number
2853 + sizeof(int32_t) // Offset of CU in the .debug_info section
2854 + sizeof(int8_t) // Pointer Size (in bytes)
2855 + sizeof(int8_t); // Segment Size (in bytes)
2856
2857 unsigned TupleSize = PtrSize * 2;
2858
2859 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2860 unsigned Padding = 0;
2861 while (((sizeof(int32_t) + ContentSize + Padding) % TupleSize) != 0)
2862 Padding++;
2863
2864 ContentSize += Padding;
2865 ContentSize += (List.size() + 1) * TupleSize;
2866
2867 // For each compile unit, write the list of spans it covers.
2868 Asm->OutStreamer.AddComment("Length of ARange Set");
2869 Asm->EmitInt32(ContentSize);
2870 Asm->OutStreamer.AddComment("DWARF Arange version number");
2871 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2872 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
2873 Asm->EmitSectionOffset(
2874 Asm->GetTempSymbol(ISec->getLabelBeginName(), CU->getUniqueID()),
2875 DwarfInfoSectionSym);
2876 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2877 Asm->EmitInt8(PtrSize);
2878 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2879 Asm->EmitInt8(0);
2880
2881 for (unsigned n = 0; n < Padding; n++)
2882 Asm->EmitInt8(0xff);
2883
2884 for (unsigned n = 0; n < List.size(); n++) {
2885 const ArangeSpan &Span = List[n];
2886 Asm->EmitLabelReference(Span.Start, PtrSize);
2887
2888 // Calculate the size as being from the span start to it's end.
Richard Mittoneb46def2013-09-23 17:56:20 +00002889 if (Span.End) {
Richard Mitton5cc319a2013-09-19 23:21:01 +00002890 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
Richard Mittoneb46def2013-09-23 17:56:20 +00002891 } else {
2892 // For symbols without an end marker (e.g. common), we
2893 // write a single arange entry containing just that one symbol.
2894 uint64_t Size = SymSize[Span.Start];
2895 if (Size == 0)
2896 Size = 1;
2897
2898 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2899 }
Richard Mitton5cc319a2013-09-19 23:21:01 +00002900 }
2901
2902 Asm->OutStreamer.AddComment("ARange terminator");
2903 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2904 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2905 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002906}
2907
Eric Christopherb6dc8652012-11-27 22:43:45 +00002908// Emit visible names into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002909void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002910 // Start the dwarf ranges section.
Eric Christopherab6cd832013-08-30 00:39:57 +00002911 Asm->OutStreamer
2912 .SwitchSection(Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002913 unsigned char Size = Asm->getDataLayout().getPointerSize();
Eric Christopherf7cef702013-03-29 23:34:06 +00002914 for (SmallVectorImpl<const MCSymbol *>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00002915 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00002916 I != E; ++I) {
2917 if (*I)
Eric Christopher1ced2082013-01-09 03:52:05 +00002918 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
Devang Patelf2548ca2010-04-16 23:33:45 +00002919 else
Eric Christopherca1dd052013-01-09 01:35:34 +00002920 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patelf2548ca2010-04-16 23:33:45 +00002921 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002922}
2923
Eric Christopherb6dc8652012-11-27 22:43:45 +00002924// Emit visible names into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002925void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002926 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00002927 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002928 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002929 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002930 }
2931}
2932
Eric Christopher0b944ee2012-12-11 19:42:09 +00002933// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher98e237f2012-11-30 23:59:06 +00002934
2935// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2936// 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 +00002937// DW_AT_ranges_base, DW_AT_addr_base.
Eric Christophera9b2c792013-08-26 23:50:43 +00002938CompileUnit *DwarfDebug::constructSkeletonCU(const CompileUnit *CU) {
Eric Christopher98e237f2012-11-30 23:59:06 +00002939
2940 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christophera9b2c792013-08-26 23:50:43 +00002941 CompileUnit *NewCU = new CompileUnit(CU->getUniqueID(), Die, CU->getNode(),
2942 Asm, this, &SkeletonHolder);
Eric Christopher446b88f2013-01-17 03:00:04 +00002943
Eric Christopher3ce51a92013-02-22 23:50:08 +00002944 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
Eric Christopher30410d52013-08-26 23:57:03 +00002945 DICompileUnit(CU->getNode()).getSplitDebugFilename());
Eric Christopher98e237f2012-11-30 23:59:06 +00002946
Eric Christopher1b0cd2f2013-04-22 07:51:08 +00002947 // Relocate to the beginning of the addr_base section, else 0 for the
2948 // beginning of the one for this compile unit.
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002949 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2950 NewCU->addLabel(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2951 DwarfAddrSectionSym);
2952 else
Eric Christopher1b0cd2f2013-04-22 07:51:08 +00002953 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base,
2954 dwarf::DW_FORM_sec_offset, 0);
Eric Christopher98e237f2012-11-30 23:59:06 +00002955
2956 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002957 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher98e237f2012-11-30 23:59:06 +00002958 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002959
Eric Christopher98e237f2012-11-30 23:59:06 +00002960 // DW_AT_stmt_list is a offset of line number information for this
2961 // compile unit in debug_line section.
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002962 // FIXME: Should handle multiple compile units.
Eric Christopher98e237f2012-11-30 23:59:06 +00002963 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher446b88f2013-01-17 03:00:04 +00002964 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher7a0103c2013-02-07 21:19:50 +00002965 DwarfLineSectionSym);
Eric Christopher98e237f2012-11-30 23:59:06 +00002966 else
Eric Christopher446b88f2013-01-17 03:00:04 +00002967 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher98e237f2012-11-30 23:59:06 +00002968
2969 if (!CompilationDir.empty())
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002970 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher98e237f2012-11-30 23:59:06 +00002971
Eric Christopher08bd9232013-10-01 00:43:31 +00002972 // Flags to let the linker know we have emitted new style pubnames.
Eric Christophera6d84152013-09-30 23:14:16 +00002973 if (GenerateGnuPubSections) {
2974 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2975 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_sec_offset,
2976 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()));
2977 else
2978 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
2979 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()),
2980 DwarfGnuPubNamesSectionSym);
2981
2982 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2983 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_sec_offset,
2984 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()));
2985 else
2986 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopher7c9fc902013-10-03 17:41:16 +00002987 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()),
Eric Christophera6d84152013-09-30 23:14:16 +00002988 DwarfGnuPubTypesSectionSym);
2989 }
Eric Christopher8f1a9292013-09-13 00:35:05 +00002990
Eric Christopher451c71d2013-10-01 00:43:36 +00002991 // Flag if we've emitted any ranges and their location for the compile unit.
2992 if (DebugRangeSymbols.size()) {
2993 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2994 NewCU->addLabel(Die, dwarf::DW_AT_GNU_ranges_base,
2995 dwarf::DW_FORM_sec_offset, DwarfDebugRangeSectionSym);
2996 else
2997 NewCU->addUInt(Die, dwarf::DW_AT_GNU_ranges_base, dwarf::DW_FORM_data4,
2998 0);
2999 }
3000
Eric Christopher0e3e9b72012-12-10 23:34:43 +00003001 SkeletonHolder.addUnit(NewCU);
Eric Christopher01776a52013-02-06 21:53:56 +00003002 SkeletonCUs.push_back(NewCU);
Eric Christopher0e3e9b72012-12-10 23:34:43 +00003003
Eric Christopher98e237f2012-11-30 23:59:06 +00003004 return NewCU;
3005}
3006
Eric Christopher6eebe472012-12-19 22:02:53 +00003007void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
3008 assert(useSplitDwarf() && "No split dwarf debug info?");
3009 emitAbbrevs(Section, &SkeletonAbbrevs);
Eric Christopher98e237f2012-11-30 23:59:06 +00003010}
3011
Eric Christopher0b944ee2012-12-11 19:42:09 +00003012// Emit the .debug_info.dwo section for separated dwarf. This contains the
3013// compile units that would normally be in debug_info.
Eric Christopher98e237f2012-11-30 23:59:06 +00003014void DwarfDebug::emitDebugInfoDWO() {
Eric Christopher4daaed12012-12-10 19:51:21 +00003015 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christopherb1e66d02012-12-15 00:04:07 +00003016 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
Eric Christopher6eebe472012-12-19 22:02:53 +00003017 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
3018 DwarfAbbrevDWOSectionSym);
3019}
3020
3021// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
3022// abbreviations for the .debug_info.dwo section.
3023void DwarfDebug::emitDebugAbbrevDWO() {
3024 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopher72c16552012-12-20 21:58:40 +00003025 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
3026 &Abbreviations);
Eric Christopher98e237f2012-11-30 23:59:06 +00003027}
Eric Christopher64f824c2012-12-27 02:14:01 +00003028
3029// Emit the .debug_str.dwo section for separated dwarf. This contains the
3030// string section and is identical in format to traditional .debug_str
3031// sections.
3032void DwarfDebug::emitDebugStrDWO() {
3033 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherff348452013-01-07 22:40:45 +00003034 const MCSection *OffSec = Asm->getObjFileLowering()
3035 .getDwarfStrOffDWOSection();
Eric Christopherdd8e9f32013-01-07 19:32:41 +00003036 const MCSymbol *StrSym = DwarfStrSectionSym;
3037 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
3038 OffSec, StrSym);
Eric Christopher64f824c2012-12-27 02:14:01 +00003039}