blob: 4bebecd8070780ea83d3732d36f684b47c9850ef [file] [log] [blame]
Bill Wendling0310d762009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Chris Lattner6cde3e62010-03-09 00:39:24 +000013
Devang Patele4b27562009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling0310d762009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner74e41f92010-04-05 05:24:55 +000016#include "DIE.h"
Eric Christopher0d27ca12013-08-08 23:45:55 +000017#include "DIEHash.h"
Eric Christopher09ac3d82011-11-07 09:24:32 +000018#include "DwarfAccelTable.h"
Devang Patel8b9df622011-04-12 17:40:32 +000019#include "DwarfCompileUnit.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000020#include "llvm/ADT/STLExtras.h"
21#include "llvm/ADT/Statistic.h"
22#include "llvm/ADT/StringExtras.h"
23#include "llvm/ADT/Triple.h"
David Greeneb2c66fc2009-08-19 21:52:55 +000024#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling0310d762009-05-15 09:23:25 +000025#include "llvm/CodeGen/MachineModuleInfo.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000026#include "llvm/DIBuilder.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000027#include "llvm/DebugInfo.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000028#include "llvm/IR/Constants.h"
29#include "llvm/IR/DataLayout.h"
30#include "llvm/IR/Instructions.h"
31#include "llvm/IR/Module.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000032#include "llvm/MC/MCAsmInfo.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000033#include "llvm/MC/MCSection.h"
Chris Lattner6c2f9e12009-08-19 05:49:37 +000034#include "llvm/MC/MCStreamer.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000035#include "llvm/MC/MCSymbol.h"
Devang Pateleac9c072010-04-27 19:46:33 +000036#include "llvm/Support/CommandLine.h"
Daniel Dunbar6e4bdfc2009-10-13 06:47:08 +000037#include "llvm/Support/Debug.h"
David Majnemerd7d43dc2013-08-21 06:13:34 +000038#include "llvm/Support/Dwarf.h"
Daniel Dunbar6e4bdfc2009-10-13 06:47:08 +000039#include "llvm/Support/ErrorHandling.h"
Chris Lattner0ad9c912010-01-22 22:09:00 +000040#include "llvm/Support/FormattedStream.h"
Eric Christopher3dee5752013-07-26 17:02:41 +000041#include "llvm/Support/MD5.h"
Michael J. Spencer1f6efa32010-11-29 18:16:10 +000042#include "llvm/Support/Path.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000043#include "llvm/Support/Timer.h"
44#include "llvm/Support/ValueHandle.h"
45#include "llvm/Target/TargetFrameLowering.h"
46#include "llvm/Target/TargetLoweringObjectFile.h"
47#include "llvm/Target/TargetMachine.h"
48#include "llvm/Target/TargetOptions.h"
49#include "llvm/Target/TargetRegisterInfo.h"
Bill Wendling0310d762009-05-15 09:23:25 +000050using namespace llvm;
51
Eric Christopher6e61e0b2013-07-23 22:16:41 +000052static cl::opt<bool>
53DisableDebugInfoPrinting("disable-debug-info-print", cl::Hidden,
54 cl::desc("Disable debug info printing"));
Devang Pateleac9c072010-04-27 19:46:33 +000055
Eric Christopher6e61e0b2013-07-23 22:16:41 +000056static cl::opt<bool> UnknownLocations(
57 "use-unknown-locations", cl::Hidden,
58 cl::desc("Make an absence of debug location information explicit."),
59 cl::init(false));
Dan Gohman281d65d2010-05-07 01:08:53 +000060
Eric Christopher6e61e0b2013-07-23 22:16:41 +000061static cl::opt<bool>
Eric Christopher3dee5752013-07-26 17:02:41 +000062GenerateODRHash("generate-odr-hash", cl::Hidden,
63 cl::desc("Add an ODR hash to external type DIEs."),
64 cl::init(false));
65
Eric Christopher0710bfa2013-08-13 01:21:55 +000066static cl::opt<bool>
67GenerateCUHash("generate-cu-hash", cl::Hidden,
68 cl::desc("Add the CU hash as the dwo_id."),
69 cl::init(false));
70
Eric Christopher8f1a9292013-09-13 00:35:05 +000071static cl::opt<bool>
72GenerateGnuPubSections("generate-gnu-dwarf-pub-sections", cl::Hidden,
73 cl::desc("Generate GNU-style pubnames and pubtypes"),
74 cl::init(false));
75
Eric Christopher20f47ab2012-08-23 22:36:40 +000076namespace {
Eric Christopher6e61e0b2013-07-23 22:16:41 +000077enum DefaultOnOff {
78 Default,
79 Enable,
80 Disable
81};
Eric Christopher20f47ab2012-08-23 22:36:40 +000082}
Eric Christopher09ac3d82011-11-07 09:24:32 +000083
Eric Christopher6e61e0b2013-07-23 22:16:41 +000084static cl::opt<DefaultOnOff>
85DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
86 cl::desc("Output prototype dwarf accelerator tables."),
87 cl::values(clEnumVal(Default, "Default for platform"),
88 clEnumVal(Enable, "Enabled"),
89 clEnumVal(Disable, "Disabled"), clEnumValEnd),
90 cl::init(Default));
Eric Christopher20f47ab2012-08-23 22:36:40 +000091
Eric Christopher6e61e0b2013-07-23 22:16:41 +000092static cl::opt<DefaultOnOff>
Eric Christopher6e61e0b2013-07-23 22:16:41 +000093SplitDwarf("split-dwarf", cl::Hidden,
94 cl::desc("Output prototype dwarf split debug info."),
95 cl::values(clEnumVal(Default, "Default for platform"),
96 clEnumVal(Enable, "Enabled"),
97 clEnumVal(Disable, "Disabled"), clEnumValEnd),
98 cl::init(Default));
Eric Christopherf5b6dcd2012-11-12 22:22:20 +000099
Eric Christopherf04e4ef2013-08-19 21:07:38 +0000100static cl::opt<DefaultOnOff>
Eric Christopher63ae7c92013-08-26 23:24:35 +0000101DwarfPubSections("generate-dwarf-pub-sections", cl::Hidden,
102 cl::desc("Generate DWARF pubnames and pubtypes sections"),
103 cl::values(clEnumVal(Default, "Default for platform"),
104 clEnumVal(Enable, "Enabled"),
105 clEnumVal(Disable, "Disabled"), clEnumValEnd),
106 cl::init(Default));
Eric Christopherf04e4ef2013-08-19 21:07:38 +0000107
Benjamin Kramer0b6962f2013-08-24 12:54:27 +0000108static const char *const DWARFGroupName = "DWARF Emission";
109static const char *const DbgTimerName = "DWARF Debug Writer";
Bill Wendling5f017e82010-04-07 09:28:04 +0000110
Bill Wendling0310d762009-05-15 09:23:25 +0000111//===----------------------------------------------------------------------===//
112
Eric Christopherb6dc8652012-11-27 22:43:45 +0000113// Configuration values for initial hash set sizes (log2).
114//
Bill Wendling0310d762009-05-15 09:23:25 +0000115static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling0310d762009-05-15 09:23:25 +0000116
117namespace llvm {
118
Manman Ren8199f0b2013-10-08 19:07:44 +0000119/// resolve - Look in the DwarfDebug map for the MDNode that
120/// corresponds to the reference.
121template <typename T>
122T DbgVariable::resolve(DIRef<T> Ref) const {
123 return DD->resolve(Ref);
124}
125
Nick Lewycky3bbb6f72011-07-29 03:49:23 +0000126DIType DbgVariable::getType() const {
Devang Patel3cbee302011-04-12 22:53:02 +0000127 DIType Ty = Var.getType();
128 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
129 // addresses instead.
130 if (Var.isBlockByrefVariable()) {
131 /* Byref variables, in Blocks, are declared by the programmer as
132 "SomeType VarName;", but the compiler creates a
133 __Block_byref_x_VarName struct, and gives the variable VarName
134 either the struct, or a pointer to the struct, as its type. This
135 is necessary for various behind-the-scenes things the compiler
136 needs to do with by-reference variables in blocks.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000137
Devang Patel3cbee302011-04-12 22:53:02 +0000138 However, as far as the original *programmer* is concerned, the
139 variable should still have type 'SomeType', as originally declared.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000140
Devang Patel3cbee302011-04-12 22:53:02 +0000141 The following function dives into the __Block_byref_x_VarName
142 struct to find the original type of the variable. This will be
143 passed back to the code generating the type for the Debug
144 Information Entry for the variable 'VarName'. 'VarName' will then
145 have the original type 'SomeType' in its debug information.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000146
Devang Patel3cbee302011-04-12 22:53:02 +0000147 The original type 'SomeType' will be the type of the field named
148 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000149
Devang Patel3cbee302011-04-12 22:53:02 +0000150 NOTE: In order for this to not completely fail on the debugger
151 side, the Debug Information Entry for the variable VarName needs to
152 have a DW_AT_location that tells the debugger how to unwind through
153 the pointers and __Block_byref_x_VarName struct to find the actual
154 value of the variable. The function addBlockByrefType does this. */
155 DIType subType = Ty;
Eric Christopher31667622013-08-08 01:41:00 +0000156 uint16_t tag = Ty.getTag();
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000157
Eric Christopher4dc211a2013-09-04 19:53:21 +0000158 if (tag == dwarf::DW_TAG_pointer_type)
Manman Ren8199f0b2013-10-08 19:07:44 +0000159 subType = resolve(DIDerivedType(Ty).getTypeDerivedFrom());
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000160
Eric Christopher4dc211a2013-09-04 19:53:21 +0000161 DIArray Elements = DICompositeType(subType).getTypeArray();
Devang Patel3cbee302011-04-12 22:53:02 +0000162 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
Eric Christopher4dc211a2013-09-04 19:53:21 +0000163 DIDerivedType DT = DIDerivedType(Elements.getElement(i));
Devang Patel3cbee302011-04-12 22:53:02 +0000164 if (getName() == DT.getName())
Manman Ren8199f0b2013-10-08 19:07:44 +0000165 return (resolve(DT.getTypeDerivedFrom()));
Devang Patel8bd11de2010-08-09 21:01:39 +0000166 }
Devang Patel8bd11de2010-08-09 21:01:39 +0000167 }
Devang Patel3cbee302011-04-12 22:53:02 +0000168 return Ty;
169}
Bill Wendling0310d762009-05-15 09:23:25 +0000170
Chris Lattnerea761862010-04-05 04:09:20 +0000171} // end llvm namespace
Bill Wendling0310d762009-05-15 09:23:25 +0000172
Manman Ren0e6783f2013-07-02 23:40:10 +0000173/// Return Dwarf Version by checking module flags.
174static unsigned getDwarfVersionFromModule(const Module *M) {
Manman Renc8cfaa12013-07-16 23:21:16 +0000175 Value *Val = M->getModuleFlag("Dwarf Version");
176 if (!Val)
Eric Christopherefc47ec2013-09-04 22:21:24 +0000177 return dwarf::DWARF_VERSION;
Manman Renc8cfaa12013-07-16 23:21:16 +0000178 return cast<ConstantInt>(Val)->getZExtValue();
Manman Ren0e6783f2013-07-02 23:40:10 +0000179}
180
Chris Lattner49cd6642010-04-05 05:11:15 +0000181DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Eric Christopher28bd25a2012-12-10 19:51:13 +0000182 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbach1e20b962010-07-21 21:21:52 +0000183 AbbreviationsSet(InitAbbreviationsSetSize),
Eric Christopherb6714222013-01-08 22:22:06 +0000184 SourceIdMap(DIEValueAllocator),
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000185 PrevLabel(NULL), GlobalCUIndexCount(0),
Eric Christopherb6714222013-01-08 22:22:06 +0000186 InfoHolder(A, &AbbreviationsSet, &Abbreviations, "info_string",
187 DIEValueAllocator),
Eric Christopher6eebe472012-12-19 22:02:53 +0000188 SkeletonAbbrevSet(InitAbbreviationsSetSize),
Eric Christopherb6714222013-01-08 22:22:06 +0000189 SkeletonHolder(A, &SkeletonAbbrevSet, &SkeletonAbbrevs, "skel_string",
190 DIEValueAllocator) {
Jim Grosbach1e20b962010-07-21 21:21:52 +0000191
Rafael Espindolaf2b04232011-05-06 14:56:22 +0000192 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattner4ad1efe2010-04-04 23:10:38 +0000193 DwarfStrSectionSym = TextSectionSym = 0;
Eric Christopher7a0103c2013-02-07 21:19:50 +0000194 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
Eric Christopher9a9e73b2013-04-07 03:43:09 +0000195 DwarfAddrSectionSym = 0;
Eric Christopher64f824c2012-12-27 02:14:01 +0000196 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
Devang Patelc3f5f782010-05-25 23:40:22 +0000197 FunctionBeginSym = FunctionEndSym = 0;
Eric Christopher60777d82012-04-02 17:58:52 +0000198
Eric Christopher10cb7442012-08-23 07:10:46 +0000199 // Turn on accelerator tables and older gdb compatibility
Eric Christopher05bae3b2013-08-19 21:41:38 +0000200 // for Darwin by default, pubnames by default for non-Darwin,
201 // and handle split dwarf.
Eric Christopher00297ba2013-04-27 01:07:52 +0000202 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
Eric Christopherc1610fa2012-08-23 22:36:36 +0000203
Eric Christopher05bae3b2013-08-19 21:41:38 +0000204 if (DwarfAccelTables == Default)
205 HasDwarfAccelTables = IsDarwin;
206 else
Eric Christopher03be5e52013-08-26 20:58:35 +0000207 HasDwarfAccelTables = DwarfAccelTables == Enable;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000208
Eric Christopher4daaed12012-12-10 19:51:21 +0000209 if (SplitDwarf == Default)
210 HasSplitDwarf = false;
Eric Christopherf5b6dcd2012-11-12 22:22:20 +0000211 else
Eric Christopher05bae3b2013-08-19 21:41:38 +0000212 HasSplitDwarf = SplitDwarf == Enable;
Eric Christopherf5b6dcd2012-11-12 22:22:20 +0000213
Eric Christopher63ae7c92013-08-26 23:24:35 +0000214 if (DwarfPubSections == Default)
215 HasDwarfPubSections = !IsDarwin;
Eric Christopher05bae3b2013-08-19 21:41:38 +0000216 else
Eric Christopher63ae7c92013-08-26 23:24:35 +0000217 HasDwarfPubSections = DwarfPubSections == Enable;
Eric Christopherf04e4ef2013-08-19 21:07:38 +0000218
Manman Ren0e6783f2013-07-02 23:40:10 +0000219 DwarfVersion = getDwarfVersionFromModule(MMI->getModule());
220
Dan Gohman03c3dc72010-06-18 15:56:31 +0000221 {
222 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopherc4639d62012-11-19 22:42:15 +0000223 beginModule();
Torok Edwin9c421072010-04-07 10:44:46 +0000224 }
Bill Wendling0310d762009-05-15 09:23:25 +0000225}
226DwarfDebug::~DwarfDebug() {
Bill Wendling0310d762009-05-15 09:23:25 +0000227}
228
Eric Christopherb6dc8652012-11-27 22:43:45 +0000229// Switch to the specified MCSection and emit an assembler
230// temporary label to it if SymbolStem is specified.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000231static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christopherd8a87522011-11-07 09:18:38 +0000232 const char *SymbolStem = 0) {
233 Asm->OutStreamer.SwitchSection(Section);
234 if (!SymbolStem) return 0;
235
236 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
237 Asm->OutStreamer.EmitLabel(TmpSym);
238 return TmpSym;
239}
240
Eric Christopher2e5d8702012-12-20 21:58:36 +0000241MCSymbol *DwarfUnits::getStringPoolSym() {
Eric Christopher64f824c2012-12-27 02:14:01 +0000242 return Asm->GetTempSymbol(StringPref);
Nick Lewycky390c40d2011-10-27 06:44:11 +0000243}
244
Eric Christopher2e5d8702012-12-20 21:58:36 +0000245MCSymbol *DwarfUnits::getStringPoolEntry(StringRef Str) {
246 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopherb6714222013-01-08 22:22:06 +0000247 StringPool.GetOrCreateValue(Str).getValue();
Chris Lattnerbc733f52010-03-13 02:17:42 +0000248 if (Entry.first) return Entry.first;
249
250 Entry.second = NextStringPoolNumber++;
Eric Christopher64f824c2012-12-27 02:14:01 +0000251 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
Chris Lattnerbc733f52010-03-13 02:17:42 +0000252}
253
Eric Christopherdd8e9f32013-01-07 19:32:41 +0000254unsigned DwarfUnits::getStringPoolIndex(StringRef Str) {
255 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopherb6714222013-01-08 22:22:06 +0000256 StringPool.GetOrCreateValue(Str).getValue();
Eric Christopherdd8e9f32013-01-07 19:32:41 +0000257 if (Entry.first) return Entry.second;
258
259 Entry.second = NextStringPoolNumber++;
260 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
261 return Entry.second;
262}
263
David Blaikie321d83b2013-06-28 18:47:14 +0000264unsigned DwarfUnits::getAddrPoolIndex(const MCSymbol *Sym) {
David Blaikie8fed05e2013-07-01 23:55:52 +0000265 return getAddrPoolIndex(MCSymbolRefExpr::Create(Sym, Asm->OutContext));
266}
267
Ulrich Weigand18dbe502013-07-02 18:46:46 +0000268unsigned DwarfUnits::getAddrPoolIndex(const MCExpr *Sym) {
269 std::pair<DenseMap<const MCExpr *, unsigned>::iterator, bool> P =
David Blaikie1c736322013-06-28 18:47:19 +0000270 AddressPool.insert(std::make_pair(Sym, NextAddrPoolNumber));
David Blaikie1ca79902013-06-28 18:55:13 +0000271 if (P.second)
272 ++NextAddrPoolNumber;
David Blaikie1c736322013-06-28 18:47:19 +0000273 return P.first->second;
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000274}
275
Eric Christopherb6dc8652012-11-27 22:43:45 +0000276// Define a unique number for the abbreviation.
277//
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000278void DwarfUnits::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling0310d762009-05-15 09:23:25 +0000279 // Check the set for priors.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000280 DIEAbbrev *InSet = AbbreviationsSet->GetOrInsertNode(&Abbrev);
Bill Wendling0310d762009-05-15 09:23:25 +0000281
282 // If it's newly added.
283 if (InSet == &Abbrev) {
284 // Add to abbreviation list.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000285 Abbreviations->push_back(&Abbrev);
Bill Wendling0310d762009-05-15 09:23:25 +0000286
287 // Assign the vector position + 1 as its number.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000288 Abbrev.setNumber(Abbreviations->size());
Bill Wendling0310d762009-05-15 09:23:25 +0000289 } else {
290 // Assign existing abbreviation number.
291 Abbrev.setNumber(InSet->getNumber());
292 }
293}
294
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000295static bool isObjCClass(StringRef Name) {
296 return Name.startswith("+") || Name.startswith("-");
297}
298
299static bool hasObjCCategory(StringRef Name) {
300 if (!isObjCClass(Name)) return false;
301
Benjamin Kramer4321d4e2013-08-24 12:15:54 +0000302 return Name.find(") ") != StringRef::npos;
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000303}
304
305static void getObjCClassCategory(StringRef In, StringRef &Class,
306 StringRef &Category) {
307 if (!hasObjCCategory(In)) {
308 Class = In.slice(In.find('[') + 1, In.find(' '));
309 Category = "";
310 return;
311 }
312
313 Class = In.slice(In.find('[') + 1, In.find('('));
314 Category = In.slice(In.find('[') + 1, In.find(' '));
315 return;
316}
317
318static StringRef getObjCMethodName(StringRef In) {
319 return In.slice(In.find(' ') + 1, In.find(']'));
320}
321
Richard Mitton7c9659a2013-10-03 22:07:08 +0000322// Helper for sorting sections into a stable output order.
323static bool SectionSort(const MCSection *A, const MCSection *B) {
324 std::string LA = (A ? A->getLabelBeginName() : "");
325 std::string LB = (B ? B->getLabelBeginName() : "");
326 return LA < LB;
327}
328
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000329// Add the various names to the Dwarf accelerator table names.
Eric Christopher9e0b08d2013-09-20 23:22:52 +0000330// TODO: Determine whether or not we should add names for programs
331// that do not have a DW_AT_name or DW_AT_linkage_name field - this
332// is only slightly different than the lookup of non-standard ObjC names.
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000333static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
334 DIE* Die) {
335 if (!SP.isDefinition()) return;
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000336 TheCU->addAccelName(SP.getName(), Die);
337
338 // If the linkage name is different than the name, go ahead and output
339 // that as well into the name table.
340 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
341 TheCU->addAccelName(SP.getLinkageName(), Die);
342
343 // If this is an Objective-C selector name add it to the ObjC accelerator
344 // too.
345 if (isObjCClass(SP.getName())) {
346 StringRef Class, Category;
347 getObjCClassCategory(SP.getName(), Class, Category);
348 TheCU->addAccelObjC(Class, Die);
349 if (Category != "")
350 TheCU->addAccelObjC(Category, Die);
351 // Also add the base method name to the name table.
352 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
353 }
354}
355
Manman Ren02d29672013-09-09 19:05:21 +0000356/// isSubprogramContext - Return true if Context is either a subprogram
357/// or another context nested inside a subprogram.
358bool DwarfDebug::isSubprogramContext(const MDNode *Context) {
359 if (!Context)
360 return false;
361 DIDescriptor D(Context);
362 if (D.isSubprogram())
363 return true;
364 if (D.isType())
Manman Ren2c9905a2013-09-09 19:47:11 +0000365 return isSubprogramContext(resolve(DIType(Context).getContext()));
Manman Ren02d29672013-09-09 19:05:21 +0000366 return false;
367}
368
Eric Christopherb6dc8652012-11-27 22:43:45 +0000369// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
370// and DW_AT_high_pc attributes. If there are global variables in this
371// scope then create and insert DIEs for these variables.
Devang Pateld3024342011-08-15 22:24:32 +0000372DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
373 const MDNode *SPNode) {
Eric Christopher3f045002013-10-04 17:08:38 +0000374 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patel8aa61472010-07-07 22:20:57 +0000375
Chris Lattnerd38fee82010-04-05 00:13:49 +0000376 assert(SPDie && "Unable to find subprogram DIE!");
377 DISubprogram SP(SPNode);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000378
Bill Wendling168c1902012-11-07 05:19:04 +0000379 // If we're updating an abstract DIE, then we will be adding the children and
380 // object pointer later on. But what we don't want to do is process the
381 // concrete DIE twice.
Eric Christophere7099f62013-10-04 19:40:33 +0000382 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
Bill Wendling168c1902012-11-07 05:19:04 +0000383 // Pick up abstract subprogram DIE.
Devang Patel8aa61472010-07-07 22:20:57 +0000384 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Manman Ren87b110a2013-10-11 23:58:05 +0000385 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin, AbsSPDIE);
Devang Patel8aa61472010-07-07 22:20:57 +0000386 SPCU->addDie(SPDie);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000387 } else {
388 DISubprogram SPDecl = SP.getFunctionDeclaration();
389 if (!SPDecl.isSubprogram()) {
390 // There is not any need to generate specification DIE for a function
391 // defined at compile unit level. If a function is defined inside another
392 // function then gdb prefers the definition at top level and but does not
393 // expect specification DIE in parent function. So avoid creating
394 // specification DIE for a function defined inside a function.
Manman Renb8e48a62013-10-10 18:40:01 +0000395 DIScope SPContext = resolve(SP.getContext());
396 if (SP.isDefinition() && !SPContext.isCompileUnit() &&
397 !SPContext.isFile() &&
398 !isSubprogramContext(SPContext)) {
Bill Wendlinga4c76932012-11-07 04:42:18 +0000399 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
400
401 // Add arguments.
402 DICompositeType SPTy = SP.getType();
403 DIArray Args = SPTy.getTypeArray();
Eric Christopher31667622013-08-08 01:41:00 +0000404 uint16_t SPTag = SPTy.getTag();
Bill Wendlinga4c76932012-11-07 04:42:18 +0000405 if (SPTag == dwarf::DW_TAG_subroutine_type)
406 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
407 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
408 DIType ATy = DIType(Args.getElement(i));
409 SPCU->addType(Arg, ATy);
410 if (ATy.isArtificial())
411 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
412 if (ATy.isObjectPointer())
Manman Ren87b110a2013-10-11 23:58:05 +0000413 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer, Arg);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000414 SPDie->addChild(Arg);
415 }
416 DIE *SPDeclDie = SPDie;
417 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Manman Ren87b110a2013-10-11 23:58:05 +0000418 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, SPDeclDie);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000419 SPCU->addDie(SPDie);
420 }
421 }
Devang Patel8aa61472010-07-07 22:20:57 +0000422 }
423
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000424 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc,
425 Asm->GetTempSymbol("func_begin",
426 Asm->getFunctionNumber()));
427 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
428 Asm->GetTempSymbol("func_end",
429 Asm->getFunctionNumber()));
Chris Lattnerd38fee82010-04-05 00:13:49 +0000430 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
431 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patel3cbee302011-04-12 22:53:02 +0000432 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +0000433
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000434 // Add name to the name table, we do this here because we're guaranteed
435 // to have concrete versions of our DW_TAG_subprogram nodes.
436 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000437
Chris Lattnerd38fee82010-04-05 00:13:49 +0000438 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +0000439}
440
Manman Ren995de6c2013-09-11 19:40:28 +0000441/// Check whether we should create a DIE for the given Scope, return true
442/// if we don't create a DIE (the corresponding DIE is null).
Manman Renfd2210a2013-09-10 18:40:41 +0000443bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
444 if (Scope->isAbstractScope())
445 return false;
446
Manman Ren995de6c2013-09-11 19:40:28 +0000447 // We don't create a DIE if there is no Range.
Manman Renfd2210a2013-09-10 18:40:41 +0000448 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
449 if (Ranges.empty())
450 return true;
451
452 if (Ranges.size() > 1)
453 return false;
454
Manman Ren995de6c2013-09-11 19:40:28 +0000455 // We don't create a DIE if we have a single Range and the end label
456 // is null.
Manman Renfd2210a2013-09-10 18:40:41 +0000457 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
458 MCSymbol *End = getLabelAfterInsn(RI->second);
459 return !End;
460}
461
Eric Christopherb6dc8652012-11-27 22:43:45 +0000462// Construct new DW_TAG_lexical_block for this scope and attach
463// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000464DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld3024342011-08-15 22:24:32 +0000465 LexicalScope *Scope) {
Manman Renfd2210a2013-09-10 18:40:41 +0000466 if (isLexicalScopeDIENull(Scope))
467 return 0;
468
Devang Pateleac9c072010-04-27 19:46:33 +0000469 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
470 if (Scope->isAbstractScope())
471 return ScopeDIE;
472
Craig Topper9f43ac62013-07-03 04:24:43 +0000473 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Eric Christopherf53d6432013-07-03 01:57:28 +0000474 // If we have multiple ranges, emit them into the range section.
Devang Pateleac9c072010-04-27 19:46:33 +0000475 if (Ranges.size() > 1) {
476 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbach1e20b962010-07-21 21:21:52 +0000477 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Pateleac9c072010-04-27 19:46:33 +0000478 // DW_AT_ranges appropriately.
Devang Patel3cbee302011-04-12 22:53:02 +0000479 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000480 DebugRangeSymbols.size()
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000481 * Asm->getDataLayout().getPointerSize());
Craig Topper2d785db2013-07-03 04:17:25 +0000482 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +0000483 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +0000484 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
485 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +0000486 }
Eric Christopherda965de2013-07-03 01:22:29 +0000487
488 // Terminate the range list.
Devang Pateleac9c072010-04-27 19:46:33 +0000489 DebugRangeSymbols.push_back(NULL);
490 DebugRangeSymbols.push_back(NULL);
491 return ScopeDIE;
492 }
493
Eric Christopherf53d6432013-07-03 01:57:28 +0000494 // Construct the address range for this DIE.
Craig Topper2d785db2013-07-03 04:17:25 +0000495 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000496 MCSymbol *Start = getLabelBeforeInsn(RI->first);
497 MCSymbol *End = getLabelAfterInsn(RI->second);
Manman Renfd2210a2013-09-10 18:40:41 +0000498 assert(End && "End label should not be null!");
Devang Patel53bb5c92009-11-10 23:06:00 +0000499
Chris Lattnerb7db7332010-03-09 01:58:53 +0000500 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
501 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbach1e20b962010-07-21 21:21:52 +0000502
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000503 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
504 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patel53bb5c92009-11-10 23:06:00 +0000505
506 return ScopeDIE;
507}
508
Eric Christopherb6dc8652012-11-27 22:43:45 +0000509// This scope represents inlined body of a function. Construct DIE to
510// represent this concrete inlined copy of the function.
Devang Pateld3024342011-08-15 22:24:32 +0000511DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
512 LexicalScope *Scope) {
Craig Topper9f43ac62013-07-03 04:24:43 +0000513 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Nick Lewycky746cb672011-10-26 22:55:33 +0000514 assert(Ranges.empty() == false &&
515 "LexicalScope does not have instruction markers!");
Devang Pateleac9c072010-04-27 19:46:33 +0000516
Devang Patel26a92002011-07-27 00:34:13 +0000517 if (!Scope->getScopeNode())
518 return NULL;
519 DIScope DS(Scope->getScopeNode());
520 DISubprogram InlinedSP = getDISubprogram(DS);
Eric Christopher3f045002013-10-04 17:08:38 +0000521 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patel26a92002011-07-27 00:34:13 +0000522 if (!OriginDIE) {
Bill Wendlinge0aae5b2012-10-30 17:51:02 +0000523 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patel26a92002011-07-27 00:34:13 +0000524 return NULL;
525 }
526
Devang Pateld96efb82011-05-05 17:54:26 +0000527 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Manman Ren87b110a2013-10-11 23:58:05 +0000528 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin, OriginDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +0000529
Devang Patel26a92002011-07-27 00:34:13 +0000530 if (Ranges.size() > 1) {
531 // .debug_range section has not been laid out yet. Emit offset in
532 // .debug_range as a uint, size 4, for now. emitDIE will handle
533 // DW_AT_ranges appropriately.
534 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000535 DebugRangeSymbols.size()
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000536 * Asm->getDataLayout().getPointerSize());
Craig Topper2d785db2013-07-03 04:17:25 +0000537 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel26a92002011-07-27 00:34:13 +0000538 RE = Ranges.end(); RI != RE; ++RI) {
539 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
540 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
541 }
542 DebugRangeSymbols.push_back(NULL);
543 DebugRangeSymbols.push_back(NULL);
544 } else {
Craig Topper2d785db2013-07-03 04:17:25 +0000545 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christophere7177132013-07-03 02:23:53 +0000546 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
547 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
548
549 if (StartLabel == 0 || EndLabel == 0)
550 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
551
552 assert(StartLabel->isDefined() &&
553 "Invalid starting label for an inlined scope!");
554 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
555
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000556 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
557 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patel26a92002011-07-27 00:34:13 +0000558 }
Devang Patel53bb5c92009-11-10 23:06:00 +0000559
560 InlinedSubprogramDIEs.insert(OriginDIE);
561
Eric Christophere7177132013-07-03 02:23:53 +0000562 // Add the call site information to the DIE.
Devang Patel53bb5c92009-11-10 23:06:00 +0000563 DILocation DL(Scope->getInlinedAt());
Eric Christopher08212002012-03-26 21:38:38 +0000564 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0,
Manman Ren3de61b42013-03-07 01:42:00 +0000565 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
566 TheCU->getUniqueID()));
Devang Patel3cbee302011-04-12 22:53:02 +0000567 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +0000568
Eric Christopher309bedd2011-12-04 06:02:38 +0000569 // Add name to the name table, we do this here because we're guaranteed
570 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
571 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000572
Devang Patel53bb5c92009-11-10 23:06:00 +0000573 return ScopeDIE;
574}
575
Manman Renfd2210a2013-09-10 18:40:41 +0000576DIE *DwarfDebug::createScopeChildrenDIE(CompileUnit *TheCU, LexicalScope *Scope,
577 SmallVectorImpl<DIE*> &Children) {
578 DIE *ObjectPointer = NULL;
Devang Patel0478c152011-03-01 22:58:55 +0000579
580 // Collect arguments for current function.
Devang Patelbf47fdb2011-08-10 20:55:27 +0000581 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +0000582 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
583 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000584 if (DIE *Arg =
Eric Christophere5212782012-09-12 23:36:19 +0000585 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel0478c152011-03-01 22:58:55 +0000586 Children.push_back(Arg);
Eric Christophere5212782012-09-12 23:36:19 +0000587 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
588 }
Devang Patel0478c152011-03-01 22:58:55 +0000589
Eric Christopher1aeb7ac2011-10-03 15:49:16 +0000590 // Collect lexical scope children first.
Craig Topper9f43ac62013-07-03 04:24:43 +0000591 const SmallVectorImpl<DbgVariable *> &Variables =ScopeVariables.lookup(Scope);
Devang Patel5bc9fec2011-02-19 01:31:27 +0000592 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000593 if (DIE *Variable =
Eric Christopher7b451cf2012-09-21 22:18:52 +0000594 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5bc9fec2011-02-19 01:31:27 +0000595 Children.push_back(Variable);
Eric Christopher7b451cf2012-09-21 22:18:52 +0000596 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
597 }
Craig Topper9f43ac62013-07-03 04:24:43 +0000598 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5bc9fec2011-02-19 01:31:27 +0000599 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Pateld0b5a5e2011-08-15 22:04:40 +0000600 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5bc9fec2011-02-19 01:31:27 +0000601 Children.push_back(Nested);
Manman Renfd2210a2013-09-10 18:40:41 +0000602 return ObjectPointer;
603}
604
605// Construct a DIE for this scope.
606DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
607 if (!Scope || !Scope->getScopeNode())
608 return NULL;
609
610 DIScope DS(Scope->getScopeNode());
611
612 SmallVector<DIE *, 8> Children;
613 DIE *ObjectPointer = NULL;
614 bool ChildrenCreated = false;
615
Manman Ren995de6c2013-09-11 19:40:28 +0000616 // We try to create the scope DIE first, then the children DIEs. This will
617 // avoid creating un-used children then removing them later when we find out
618 // the scope DIE is null.
Devang Patel3c91b052010-03-08 20:52:55 +0000619 DIE *ScopeDIE = NULL;
620 if (Scope->getInlinedAt())
Devang Pateld3024342011-08-15 22:24:32 +0000621 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3c91b052010-03-08 20:52:55 +0000622 else if (DS.isSubprogram()) {
Devang Patel0dd45582010-06-28 20:53:04 +0000623 ProcessedSPNodes.insert(DS);
Devang Patel8aa61472010-07-07 22:20:57 +0000624 if (Scope->isAbstractScope()) {
Eric Christopher3f045002013-10-04 17:08:38 +0000625 ScopeDIE = TheCU->getDIE(DS);
Devang Patel8aa61472010-07-07 22:20:57 +0000626 // Note down abstract DIE.
627 if (ScopeDIE)
628 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
629 }
Devang Patel3c91b052010-03-08 20:52:55 +0000630 else
Devang Pateld3024342011-08-15 22:24:32 +0000631 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3c91b052010-03-08 20:52:55 +0000632 }
Devang Patel5bc9fec2011-02-19 01:31:27 +0000633 else {
Manman Ren995de6c2013-09-11 19:40:28 +0000634 // Early exit when we know the scope DIE is going to be null.
Manman Renfd2210a2013-09-10 18:40:41 +0000635 if (isLexicalScopeDIENull(Scope))
636 return NULL;
Manman Ren995de6c2013-09-11 19:40:28 +0000637
638 // We create children here when we know the scope DIE is not going to be
639 // null and the children will be added to the scope DIE.
Manman Renfd2210a2013-09-10 18:40:41 +0000640 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
641 ChildrenCreated = true;
Manman Ren995de6c2013-09-11 19:40:28 +0000642
Devang Patel5bc9fec2011-02-19 01:31:27 +0000643 // There is no need to emit empty lexical block DIE.
David Blaikied2e0f7e2013-05-06 23:33:07 +0000644 std::pair<ImportedEntityMap::const_iterator,
645 ImportedEntityMap::const_iterator> Range = std::equal_range(
646 ScopesWithImportedEntities.begin(), ScopesWithImportedEntities.end(),
Timur Iskhodzhanov664fbee2013-05-07 07:47:47 +0000647 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode*)0),
Benjamin Kramer0b6962f2013-08-24 12:54:27 +0000648 less_first());
David Blaikied2e0f7e2013-05-06 23:33:07 +0000649 if (Children.empty() && Range.first == Range.second)
Devang Patel5bc9fec2011-02-19 01:31:27 +0000650 return NULL;
Devang Pateld3024342011-08-15 22:24:32 +0000651 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Manman Renfd2210a2013-09-10 18:40:41 +0000652 assert(ScopeDIE && "Scope DIE should not be null.");
Eric Christopherfdfc81f2013-06-24 23:20:02 +0000653 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
654 ++i)
David Blaikied1221e32013-05-08 06:01:38 +0000655 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5bc9fec2011-02-19 01:31:27 +0000656 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000657
Benjamin Kramer6bee6312013-08-24 11:55:49 +0000658 if (!ScopeDIE) {
Manman Renfd2210a2013-09-10 18:40:41 +0000659 assert(Children.empty() &&
660 "We create children only when the scope DIE is not null.");
Benjamin Kramer6bee6312013-08-24 11:55:49 +0000661 return NULL;
662 }
Manman Renfd2210a2013-09-10 18:40:41 +0000663 if (!ChildrenCreated)
Manman Ren995de6c2013-09-11 19:40:28 +0000664 // We create children when the scope DIE is not null.
Manman Renfd2210a2013-09-10 18:40:41 +0000665 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000666
Devang Patel5bc9fec2011-02-19 01:31:27 +0000667 // Add children
Craig Topper2d785db2013-07-03 04:17:25 +0000668 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Devang Patel5bc9fec2011-02-19 01:31:27 +0000669 E = Children.end(); I != E; ++I)
670 ScopeDIE->addChild(*I);
Devang Patel193f7202009-11-24 01:14:22 +0000671
Eric Christophere5212782012-09-12 23:36:19 +0000672 if (DS.isSubprogram() && ObjectPointer != NULL)
Manman Ren87b110a2013-10-11 23:58:05 +0000673 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, ObjectPointer);
Eric Christophere5212782012-09-12 23:36:19 +0000674
Jim Grosbach1e20b962010-07-21 21:21:52 +0000675 if (DS.isSubprogram())
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000676 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbach1e20b962010-07-21 21:21:52 +0000677
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000678 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +0000679}
680
Eric Christopherb6dc8652012-11-27 22:43:45 +0000681// Look up the source id with the given directory and source file names.
682// If none currently exists, create a new id and insert it in the
683// SourceIds map. This can update DirectoryNames and SourceFileNames maps
684// as well.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000685unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Manman Ren3de61b42013-03-07 01:42:00 +0000686 StringRef DirName, unsigned CUID) {
687 // If we use .loc in assembly, we can't separate .file entries according to
688 // compile units. Thus all files will belong to the default compile unit.
Rafael Espindola5e195a42013-10-05 16:42:21 +0000689
690 // FIXME: add a better feature test than hasRawTextSupport. Even better,
691 // extend .file to support this.
692 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren3de61b42013-03-07 01:42:00 +0000693 CUID = 0;
694
Devang Patel1905a182010-09-16 20:57:49 +0000695 // If FE did not provide a file name, then assume stdin.
696 if (FileName.empty())
Manman Ren3de61b42013-03-07 01:42:00 +0000697 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patel23670e52011-03-24 20:30:50 +0000698
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000699 // TODO: this might not belong here. See if we can factor this better.
700 if (DirName == CompilationDir)
701 DirName = "";
702
Manman Ren3de61b42013-03-07 01:42:00 +0000703 // FileIDCUMap stores the current ID for the given compile unit.
704 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel1905a182010-09-16 20:57:49 +0000705
Manman Ren3de61b42013-03-07 01:42:00 +0000706 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer74612c22012-03-11 14:56:26 +0000707 SmallString<128> NamePair;
Manman Ren5044a932013-04-06 01:02:38 +0000708 NamePair += utostr(CUID);
Manman Ren3de61b42013-03-07 01:42:00 +0000709 NamePair += '\0';
Benjamin Kramer74612c22012-03-11 14:56:26 +0000710 NamePair += DirName;
711 NamePair += '\0'; // Zero bytes are not allowed in paths.
712 NamePair += FileName;
713
714 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
715 if (Ent.getValue() != SrcId)
716 return Ent.getValue();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000717
Manman Ren3de61b42013-03-07 01:42:00 +0000718 FileIDCUMap[CUID] = SrcId;
Rafael Espindola5c055632010-11-18 02:04:25 +0000719 // Print out a .file directive to specify files for .loc directives.
Manman Ren3de61b42013-03-07 01:42:00 +0000720 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000721
722 return SrcId;
723}
724
Eric Christopher72c16552012-12-20 21:58:40 +0000725// Create new CompileUnit for the given metadata node with tag
726// DW_TAG_compile_unit.
Devang Patel94c7ddb2011-08-16 22:09:43 +0000727CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +0000728 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +0000729 StringRef FN = DIUnit.getFilename();
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000730 CompilationDir = DIUnit.getDirectory();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000731
732 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher7b878952013-08-26 23:50:38 +0000733 CompileUnit *NewCU =
734 new CompileUnit(GlobalCUIndexCount++, Die, N, Asm, this, &InfoHolder);
Manman Ren3de61b42013-03-07 01:42:00 +0000735
736 FileIDCUMap[NewCU->getUniqueID()] = 0;
737 // Call this to emit a .file directive if it wasn't emitted for the source
738 // file this CU comes from yet.
739 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
740
Nick Lewycky390c40d2011-10-27 06:44:11 +0000741 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patel3cbee302011-04-12 22:53:02 +0000742 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
743 DIUnit.getLanguage());
Nick Lewycky390c40d2011-10-27 06:44:11 +0000744 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christophere0828ec2013-04-09 19:23:15 +0000745
Eric Christopher6635cad2012-08-01 18:19:01 +0000746 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christophere0828ec2013-04-09 19:23:15 +0000747 // into an entity. We're using 0 (or a NULL label) for this. For
748 // split dwarf it's in the skeleton CU so omit it here.
749 if (!useSplitDwarf())
750 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
Manman Ren43213cf2013-02-05 21:52:47 +0000751
752 // Define start line table label for each Compile Unit.
753 MCSymbol *LineTableStartSym = Asm->GetTempSymbol("line_table_start",
754 NewCU->getUniqueID());
755 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
756 NewCU->getUniqueID());
757
Manman Ren01cb18e2013-05-21 00:57:22 +0000758 // Use a single line table if we are using .loc and generating assembly.
759 bool UseTheFirstCU =
Rafael Espindola5e195a42013-10-05 16:42:21 +0000760 (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport()) ||
761 (NewCU->getUniqueID() == 0);
Manman Ren01cb18e2013-05-21 00:57:22 +0000762
Eric Christophere0828ec2013-04-09 19:23:15 +0000763 if (!useSplitDwarf()) {
Eric Christopher0b15e982013-09-27 22:50:48 +0000764 // DW_AT_stmt_list is a offset of line number information for this
765 // compile unit in debug_line section. For split dwarf this is
766 // left in the skeleton CU and so not included.
767 // The line table entries are not always emitted in assembly, so it
768 // is not okay to use line_table_start here.
Eric Christophere0828ec2013-04-09 19:23:15 +0000769 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Carlo Kok46f0b6f2013-08-13 17:46:57 +0000770 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher0b15e982013-09-27 22:50:48 +0000771 UseTheFirstCU ? Asm->GetTempSymbol("section_line")
772 : LineTableStartSym);
Manman Ren01cb18e2013-05-21 00:57:22 +0000773 else if (UseTheFirstCU)
Eric Christophere0828ec2013-04-09 19:23:15 +0000774 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
775 else
776 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
777 LineTableStartSym, DwarfLineSectionSym);
Eric Christopher0b15e982013-09-27 22:50:48 +0000778
779 // If we're using split dwarf the compilation dir is going to be in the
780 // skeleton CU and so we don't need to duplicate it here.
781 if (!CompilationDir.empty())
782 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
783
Eric Christopher08bd9232013-10-01 00:43:31 +0000784 // Flags to let the linker know we have emitted new style pubnames. Only
Eric Christopher0b15e982013-09-27 22:50:48 +0000785 // emit it here if we don't have a skeleton CU for split dwarf.
Eric Christophera6d84152013-09-30 23:14:16 +0000786 if (GenerateGnuPubSections) {
787 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
788 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames,
789 dwarf::DW_FORM_sec_offset,
790 Asm->GetTempSymbol("gnu_pubnames",
791 NewCU->getUniqueID()));
792 else
793 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
794 Asm->GetTempSymbol("gnu_pubnames",
795 NewCU->getUniqueID()),
796 DwarfGnuPubNamesSectionSym);
797
798 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
799 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes,
800 dwarf::DW_FORM_sec_offset,
801 Asm->GetTempSymbol("gnu_pubtypes",
802 NewCU->getUniqueID()));
803 else
804 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopher7c9fc902013-10-03 17:41:16 +0000805 Asm->GetTempSymbol("gnu_pubtypes",
Eric Christophera6d84152013-09-30 23:14:16 +0000806 NewCU->getUniqueID()),
807 DwarfGnuPubTypesSectionSym);
808 }
Eric Christophere0828ec2013-04-09 19:23:15 +0000809 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000810
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000811 if (DIUnit.isOptimized())
Eric Christopher873cf0a2012-08-24 01:14:27 +0000812 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000813
Devang Patel65dbc902009-11-25 17:36:49 +0000814 StringRef Flags = DIUnit.getFlags();
815 if (!Flags.empty())
Nick Lewycky390c40d2011-10-27 06:44:11 +0000816 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000817
Nick Lewyckyd5d52132011-10-17 23:27:36 +0000818 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patel3cbee302011-04-12 22:53:02 +0000819 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000820 dwarf::DW_FORM_data1, RVer);
821
Devang Patel163a9f72010-05-10 22:49:55 +0000822 if (!FirstCU)
823 FirstCU = NewCU;
Eric Christopher208cc6f2013-02-05 07:31:55 +0000824
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000825 InfoHolder.addUnit(NewCU);
826
Devang Patel163a9f72010-05-10 22:49:55 +0000827 CUMap.insert(std::make_pair(N, NewCU));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000828 return NewCU;
Devang Patel163a9f72010-05-10 22:49:55 +0000829}
830
Eric Christopherb6dc8652012-11-27 22:43:45 +0000831// Construct subprogram DIE.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000832void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
Devang Patel3655a212011-08-15 23:36:40 +0000833 const MDNode *N) {
Rafael Espindolab0527282011-11-04 19:00:29 +0000834 CompileUnit *&CURef = SPMap[N];
835 if (CURef)
836 return;
837 CURef = TheCU;
838
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.
848 TheCU->addGlobalName(SP.getName(), SubprogramDie);
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());
889 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, 0, FileID);
890 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, 0, 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;
Devang Patel3cbee302011-04-12 22:53:02 +0000958 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, 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;
965 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
966 }
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();
972 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
973
974 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
975 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
976 DICompileUnit TheCU(CU_Nodes->getOperand(i));
977 DIArray Subprograms = TheCU.getSubprograms();
978 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopherbdab8002012-11-27 00:13:51 +0000979 DISubprogram SP(Subprograms.getElement(i));
980 if (ProcessedSPNodes.count(SP) != 0) continue;
Manman Rend03d2b22013-07-08 18:33:29 +0000981 if (!SP.isSubprogram()) continue;
Eric Christopherbdab8002012-11-27 00:13:51 +0000982 if (!SP.isDefinition()) continue;
983 DIArray Variables = SP.getVariables();
984 if (Variables.getNumElements() == 0) continue;
Eric Christopher4117bec2012-11-22 00:59:49 +0000985
Eric Christopherbdab8002012-11-27 00:13:51 +0000986 LexicalScope *Scope =
987 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
988 DeadFnScopeMap[SP] = Scope;
Eric Christopher4117bec2012-11-22 00:59:49 +0000989
Eric Christopherbdab8002012-11-27 00:13:51 +0000990 // Construct subprogram DIE and add variables DIEs.
991 CompileUnit *SPCU = CUMap.lookup(TheCU);
992 assert(SPCU && "Unable to find Compile Unit!");
993 constructSubprogramDIE(SPCU, SP);
Eric Christopher3f045002013-10-04 17:08:38 +0000994 DIE *ScopeDIE = SPCU->getDIE(SP);
Eric Christopherbdab8002012-11-27 00:13:51 +0000995 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
996 DIVariable DV(Variables.getElement(vi));
Manman Rend03d2b22013-07-08 18:33:29 +0000997 if (!DV.isVariable()) continue;
Manman Renc664d762013-10-05 01:43:03 +0000998 DbgVariable NewVar(DV, NULL, this);
Eric Christopherbdab8002012-11-27 00:13:51 +0000999 if (DIE *VariableDIE =
Chandler Carruth05497cc2013-07-27 11:09:58 +00001000 SPCU->constructVariableDIE(&NewVar, Scope->isAbstractScope()))
Eric Christopherbdab8002012-11-27 00:13:51 +00001001 ScopeDIE->addChild(VariableDIE);
1002 }
Eric Christopher4117bec2012-11-22 00:59:49 +00001003 }
1004 }
1005 }
1006 DeleteContainerSeconds(DeadFnScopeMap);
1007}
1008
Eric Christopher0d27ca12013-08-08 23:45:55 +00001009// Type Signature [7.27] and ODR Hash code.
Eric Christopher3dee5752013-07-26 17:02:41 +00001010
1011/// \brief Grabs the string in whichever attribute is passed in and returns
Eric Christopherb7669132013-08-07 01:18:33 +00001012/// a reference to it. Returns "" if the attribute doesn't exist.
Eric Christopher3dee5752013-07-26 17:02:41 +00001013static StringRef getDIEStringAttr(DIE *Die, unsigned Attr) {
Eric Christopherb7669132013-08-07 01:18:33 +00001014 DIEValue *V = Die->findAttribute(Attr);
Eric Christopher3dee5752013-07-26 17:02:41 +00001015
Eric Christopherb7669132013-08-07 01:18:33 +00001016 if (DIEString *S = dyn_cast_or_null<DIEString>(V))
1017 return S->getString();
1018
Eric Christopher3dee5752013-07-26 17:02:41 +00001019 return StringRef("");
1020}
1021
Eric Christopher3dee5752013-07-26 17:02:41 +00001022/// Return true if the current DIE is contained within an anonymous namespace.
1023static bool isContainedInAnonNamespace(DIE *Die) {
1024 DIE *Parent = Die->getParent();
1025
1026 while (Parent) {
Eric Christopher86aa03d2013-07-29 23:53:08 +00001027 if (Parent->getTag() == dwarf::DW_TAG_namespace &&
1028 getDIEStringAttr(Parent, dwarf::DW_AT_name) == "")
Eric Christopher3dee5752013-07-26 17:02:41 +00001029 return true;
1030 Parent = Parent->getParent();
1031 }
1032
1033 return false;
1034}
1035
Eric Christopher028f3472013-08-07 01:18:24 +00001036/// Test if the current CU language is C++ and that we have
1037/// a named type that is not contained in an anonymous namespace.
1038static bool shouldAddODRHash(CompileUnit *CU, DIE *Die) {
Eric Christopherf76e1182013-08-07 08:35:10 +00001039 return CU->getLanguage() == dwarf::DW_LANG_C_plus_plus &&
1040 getDIEStringAttr(Die, dwarf::DW_AT_name) != "" &&
1041 !isContainedInAnonNamespace(Die);
Eric Christopher0d27ca12013-08-08 23:45:55 +00001042}
Eric Christopher028f3472013-08-07 01:18:24 +00001043
Eric Christopher4117bec2012-11-22 00:59:49 +00001044void DwarfDebug::finalizeModuleInfo() {
1045 // Collect info for variables that were optimized out.
1046 collectDeadVariables();
1047
1048 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1049 computeInlinedDIEs();
Devang Patel53bb5c92009-11-10 23:06:00 +00001050
Eric Christopherbe482042013-07-29 22:24:32 +00001051 // Split out type units and conditionally add an ODR tag to the split
1052 // out type.
Eric Christopher3dee5752013-07-26 17:02:41 +00001053 // FIXME: Do type splitting.
1054 for (unsigned i = 0, e = TypeUnits.size(); i != e; ++i) {
Eric Christopher3dee5752013-07-26 17:02:41 +00001055 DIE *Die = TypeUnits[i];
Eric Christopher0d27ca12013-08-08 23:45:55 +00001056 DIEHash Hash;
Eric Christopher028f3472013-08-07 01:18:24 +00001057 // If we've requested ODR hashes and it's applicable for an ODR hash then
1058 // add the ODR signature now.
Eric Christopher0d27ca12013-08-08 23:45:55 +00001059 // FIXME: This should be added onto the type unit, not the type, but this
1060 // works as an intermediate stage.
Eric Christopher028f3472013-08-07 01:18:24 +00001061 if (GenerateODRHash && shouldAddODRHash(CUMap.begin()->second, Die))
Eric Christopher0d27ca12013-08-08 23:45:55 +00001062 CUMap.begin()->second->addUInt(Die, dwarf::DW_AT_GNU_odr_signature,
1063 dwarf::DW_FORM_data8,
1064 Hash.computeDIEODRSignature(Die));
Eric Christopher3dee5752013-07-26 17:02:41 +00001065 }
1066
Eric Christopherf962c022013-08-12 20:27:48 +00001067 // Handle anything that needs to be done on a per-cu basis.
1068 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
1069 CUE = CUMap.end();
1070 CUI != CUE; ++CUI) {
1071 CompileUnit *TheCU = CUI->second;
1072 // Emit DW_AT_containing_type attribute to connect types with their
1073 // vtable holding type.
1074 TheCU->constructContainingTypeDIEs();
1075
1076 // If we're splitting the dwarf out now that we've got the entire
1077 // CU then construct a skeleton CU based upon it.
1078 if (useSplitDwarf()) {
Eric Christopher0710bfa2013-08-13 01:21:55 +00001079 uint64_t ID = 0;
1080 if (GenerateCUHash) {
1081 DIEHash CUHash;
1082 ID = CUHash.computeCUSignature(TheCU->getCUDie());
1083 }
Eric Christopherf962c022013-08-12 20:27:48 +00001084 // This should be a unique identifier when we want to build .dwp files.
1085 TheCU->addUInt(TheCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopher0710bfa2013-08-13 01:21:55 +00001086 dwarf::DW_FORM_data8, ID);
Eric Christopherf962c022013-08-12 20:27:48 +00001087 // Now construct the skeleton CU associated.
Eric Christophera9b2c792013-08-26 23:50:43 +00001088 CompileUnit *SkCU = constructSkeletonCU(TheCU);
Eric Christopherf962c022013-08-12 20:27:48 +00001089 // This should be a unique identifier when we want to build .dwp files.
1090 SkCU->addUInt(SkCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopher0710bfa2013-08-13 01:21:55 +00001091 dwarf::DW_FORM_data8, ID);
Eric Christopherf962c022013-08-12 20:27:48 +00001092 }
1093 }
1094
1095 // Compute DIE offsets and sizes.
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001096 InfoHolder.computeSizeAndOffsets();
1097 if (useSplitDwarf())
1098 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher4117bec2012-11-22 00:59:49 +00001099}
1100
1101void DwarfDebug::endSections() {
Richard Mitton5cc319a2013-09-19 23:21:01 +00001102 // Filter labels by section.
Alexey Samsonov9d08d692013-10-03 08:54:43 +00001103 for (size_t n = 0; n < ArangeLabels.size(); n++) {
1104 const SymbolCU &SCU = ArangeLabels[n];
Richard Mitton5cc319a2013-09-19 23:21:01 +00001105 if (SCU.Sym->isInSection()) {
1106 // Make a note of this symbol and it's section.
1107 const MCSection *Section = &SCU.Sym->getSection();
1108 if (!Section->getKind().isMetadata())
1109 SectionMap[Section].push_back(SCU);
1110 } else {
1111 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1112 // appear in the output. This sucks as we rely on sections to build
1113 // arange spans. We can do it without, but it's icky.
1114 SectionMap[NULL].push_back(SCU);
1115 }
1116 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001117
Richard Mitton7c9659a2013-10-03 22:07:08 +00001118 // Build a list of sections used.
1119 std::vector<const MCSection *> Sections;
Richard Mitton5cc319a2013-09-19 23:21:01 +00001120 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1121 it++) {
1122 const MCSection *Section = it->first;
Richard Mitton7c9659a2013-10-03 22:07:08 +00001123 Sections.push_back(Section);
1124 }
1125
1126 // Sort the sections into order.
1127 // This is only done to ensure consistent output order across different runs.
1128 std::sort(Sections.begin(), Sections.end(), SectionSort);
1129
1130 // Add terminating symbols for each section.
1131 for (unsigned ID=0;ID<Sections.size();ID++) {
1132 const MCSection *Section = Sections[ID];
Richard Mitton5cc319a2013-09-19 23:21:01 +00001133 MCSymbol *Sym = NULL;
1134
1135 if (Section) {
Richard Mitton7c9659a2013-10-03 22:07:08 +00001136 // We can't call MCSection::getLabelEndName, as it's only safe to do so
1137 // if we know the section name up-front. For user-created sections, the resulting
1138 // label may not be valid to use as a label. (section names can use a greater
1139 // set of characters on some systems)
1140 Sym = Asm->GetTempSymbol("debug_end", ID);
Richard Mitton5cc319a2013-09-19 23:21:01 +00001141 Asm->OutStreamer.SwitchSection(Section);
1142 Asm->OutStreamer.EmitLabel(Sym);
1143 }
1144
1145 // Insert a final terminator.
Alexey Samsonov9d08d692013-10-03 08:54:43 +00001146 SectionMap[Section].push_back(SymbolCU(NULL, Sym));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001147 }
Eric Christopher4117bec2012-11-22 00:59:49 +00001148}
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001149
Eric Christopherb6dc8652012-11-27 22:43:45 +00001150// Emit all Dwarf sections that should come after the content.
Eric Christopher4117bec2012-11-22 00:59:49 +00001151void DwarfDebug::endModule() {
1152
1153 if (!FirstCU) return;
1154
1155 // End any existing sections.
1156 // TODO: Does this need to happen?
1157 endSections();
1158
1159 // Finalize the debug info for the module.
1160 finalizeModuleInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001161
Eric Christopher4daaed12012-12-10 19:51:21 +00001162 if (!useSplitDwarf()) {
Eric Christopher9e0b08d2013-09-20 23:22:52 +00001163 emitDebugStr();
1164
Eric Christopher42885022012-11-27 22:43:42 +00001165 // Emit all the DIEs into a debug info section.
1166 emitDebugInfo();
Eric Christopher74802f72012-11-27 00:41:54 +00001167
Eric Christopher42885022012-11-27 22:43:42 +00001168 // Corresponding abbreviations into a abbrev section.
1169 emitAbbreviations();
1170
1171 // Emit info into a debug loc section.
1172 emitDebugLoc();
1173
1174 // Emit info into a debug aranges section.
1175 emitDebugARanges();
1176
1177 // Emit info into a debug ranges section.
1178 emitDebugRanges();
1179
1180 // Emit info into a debug macinfo section.
1181 emitDebugMacInfo();
1182
Eric Christopher42885022012-11-27 22:43:42 +00001183 } else {
Eric Christopher0b944ee2012-12-11 19:42:09 +00001184 // TODO: Fill this in for separated debug sections and separate
Eric Christopher42885022012-11-27 22:43:42 +00001185 // out information into new sections.
Eric Christopher9e0b08d2013-09-20 23:22:52 +00001186 emitDebugStr();
1187 if (useSplitDwarf())
1188 emitDebugStrDWO();
Eric Christopher42885022012-11-27 22:43:42 +00001189
Eric Christopher98e237f2012-11-30 23:59:06 +00001190 // Emit the debug info section and compile units.
Eric Christopher42885022012-11-27 22:43:42 +00001191 emitDebugInfo();
Eric Christopher98e237f2012-11-30 23:59:06 +00001192 emitDebugInfoDWO();
Eric Christopher42885022012-11-27 22:43:42 +00001193
1194 // Corresponding abbreviations into a abbrev section.
1195 emitAbbreviations();
Eric Christopher6eebe472012-12-19 22:02:53 +00001196 emitDebugAbbrevDWO();
Eric Christopher42885022012-11-27 22:43:42 +00001197
1198 // Emit info into a debug loc section.
1199 emitDebugLoc();
1200
1201 // Emit info into a debug aranges section.
1202 emitDebugARanges();
1203
1204 // Emit info into a debug ranges section.
1205 emitDebugRanges();
1206
1207 // Emit info into a debug macinfo section.
1208 emitDebugMacInfo();
1209
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001210 // Emit DWO addresses.
1211 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1212
Eric Christopher42885022012-11-27 22:43:42 +00001213 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001214
Eric Christopher9d9f5a52012-08-23 07:32:06 +00001215 // Emit info into the dwarf accelerator table sections.
Eric Christopher20f47ab2012-08-23 22:36:40 +00001216 if (useDwarfAccelTables()) {
Eric Christopher09ac3d82011-11-07 09:24:32 +00001217 emitAccelNames();
1218 emitAccelObjC();
1219 emitAccelNamespaces();
1220 emitAccelTypes();
1221 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001222
Eric Christopher26123542013-08-30 00:40:17 +00001223 // Emit the pubnames and pubtypes sections if requested.
1224 if (HasDwarfPubSections) {
David Blaikiee56a4d92013-09-19 17:33:35 +00001225 emitDebugPubNames(GenerateGnuPubSections);
1226 emitDebugPubTypes(GenerateGnuPubSections);
Eric Christopher26123542013-08-30 00:40:17 +00001227 }
Devang Patel193f7202009-11-24 01:14:22 +00001228
Devang Patele9a1cca2010-08-02 17:32:15 +00001229 // clean up.
Devang Patel94c7ddb2011-08-16 22:09:43 +00001230 SPMap.clear();
Devang Patel163a9f72010-05-10 22:49:55 +00001231 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1232 E = CUMap.end(); I != E; ++I)
1233 delete I->second;
Eric Christopher9ec87b32012-12-10 19:51:18 +00001234
Craig Topper2d785db2013-07-03 04:17:25 +00001235 for (SmallVectorImpl<CompileUnit *>::iterator I = SkeletonCUs.begin(),
Eric Christopher01776a52013-02-06 21:53:56 +00001236 E = SkeletonCUs.end(); I != E; ++I)
1237 delete *I;
Eric Christopher9ec87b32012-12-10 19:51:18 +00001238
Eric Christopher98e237f2012-11-30 23:59:06 +00001239 // Reset these for the next Module if we have one.
1240 FirstCU = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001241}
1242
Eric Christopherb6dc8652012-11-27 22:43:45 +00001243// Find abstract variable, if any, associated with Var.
Devang Patelb549bcf2011-08-10 21:50:54 +00001244DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattnerde4845c2010-04-02 19:42:39 +00001245 DebugLoc ScopeLoc) {
Devang Patelb549bcf2011-08-10 21:50:54 +00001246 LLVMContext &Ctx = DV->getContext();
1247 // More then one inlined variable corresponds to one abstract variable.
1248 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patel2db49d72010-05-07 18:11:54 +00001249 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00001250 if (AbsDbgVariable)
1251 return AbsDbgVariable;
1252
Devang Patelbf47fdb2011-08-10 20:55:27 +00001253 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00001254 if (!Scope)
1255 return NULL;
1256
Manman Renc664d762013-10-05 01:43:03 +00001257 AbsDbgVariable = new DbgVariable(Var, NULL, this);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001258 addScopeVariable(Scope, AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00001259 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00001260 return AbsDbgVariable;
1261}
1262
Eric Christopherb6dc8652012-11-27 22:43:45 +00001263// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel0478c152011-03-01 22:58:55 +00001264bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patelbf47fdb2011-08-10 20:55:27 +00001265 DbgVariable *Var, LexicalScope *Scope) {
1266 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +00001267 return false;
1268 DIVariable DV = Var->getVariable();
1269 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1270 return false;
1271 unsigned ArgNo = DV.getArgNumber();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001272 if (ArgNo == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001273 return false;
1274
Devang Patelcb3a6572011-03-03 20:02:02 +00001275 size_t Size = CurrentFnArguments.size();
1276 if (Size == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001277 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patelbbd0f452011-03-03 21:49:41 +00001278 // llvm::Function argument size is not good indicator of how many
Devang Patel6f676be2011-03-03 20:08:10 +00001279 // arguments does the function have at source level.
1280 if (ArgNo > Size)
Devang Patelcb3a6572011-03-03 20:02:02 +00001281 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel0478c152011-03-01 22:58:55 +00001282 CurrentFnArguments[ArgNo - 1] = Var;
1283 return true;
1284}
1285
Eric Christopherb6dc8652012-11-27 22:43:45 +00001286// Collect variable information from side table maintained by MMI.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001287void
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001288DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patelee432862010-05-20 19:57:06 +00001289 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patele717faa2009-10-06 01:26:37 +00001290 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1291 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1292 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00001293 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00001294 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00001295 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00001296 DIVariable DV(Var);
1297 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00001298
Devang Patelbf47fdb2011-08-10 20:55:27 +00001299 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001300
Devang Patelfb0ee432009-11-10 23:20:04 +00001301 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00001302 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00001303 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00001304
Devang Patel26c1e562010-05-20 16:36:41 +00001305 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Manman Renc664d762013-10-05 01:43:03 +00001306 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
Devang Patelff9dd0a2011-08-15 21:24:36 +00001307 RegVar->setFrameIndex(VP.first);
Devang Patel0478c152011-03-01 22:58:55 +00001308 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001309 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001310 if (AbsDbgVariable)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001311 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patele717faa2009-10-06 01:26:37 +00001312 }
Devang Patelee432862010-05-20 19:57:06 +00001313}
Devang Patel90a48ad2010-03-15 18:33:46 +00001314
Eric Christopherb6dc8652012-11-27 22:43:45 +00001315// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1316// defined reg.
Devang Patelc3f5f782010-05-25 23:40:22 +00001317static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001318 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001319 return MI->getNumOperands() == 3 &&
1320 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
Adrian Prantl35176402013-07-09 20:28:37 +00001321 (MI->getOperand(1).isImm() ||
1322 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
Devang Patelc3f5f782010-05-25 23:40:22 +00001323}
1324
Eric Christopherb6dc8652012-11-27 22:43:45 +00001325// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001326static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1327 const MCSymbol *FLabel,
Devang Patel90b40412011-07-08 17:09:57 +00001328 const MCSymbol *SLabel,
1329 const MachineInstr *MI) {
1330 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1331
David Blaikie6d9dbd52013-06-16 20:34:15 +00001332 assert(MI->getNumOperands() == 3);
Adrian Prantl35176402013-07-09 20:28:37 +00001333 if (MI->getOperand(0).isReg()) {
Devang Patel90b40412011-07-08 17:09:57 +00001334 MachineLocation MLoc;
Adrian Prantl35176402013-07-09 20:28:37 +00001335 // If the second operand is an immediate, this is a
1336 // register-indirect address.
1337 if (!MI->getOperand(1).isImm())
Adrian Prantl13131e62013-04-26 21:57:17 +00001338 MLoc.set(MI->getOperand(0).getReg());
1339 else
1340 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel90b40412011-07-08 17:09:57 +00001341 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1342 }
1343 if (MI->getOperand(0).isImm())
1344 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1345 if (MI->getOperand(0).isFPImm())
1346 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1347 if (MI->getOperand(0).isCImm())
1348 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1349
Craig Topper5e25ee82012-02-05 08:31:47 +00001350 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel90b40412011-07-08 17:09:57 +00001351}
1352
Eric Christopherb6dc8652012-11-27 22:43:45 +00001353// Find variables for each lexical scope.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001354void
Devang Patel78e127d2010-06-25 22:07:34 +00001355DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1356 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00001357
Eric Christopher4e976452013-07-03 21:37:03 +00001358 // Grab the variable info that was squirreled away in the MMI side-table.
Devang Patelee432862010-05-20 19:57:06 +00001359 collectVariableInfoFromMMITable(MF, Processed);
1360
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001361 for (SmallVectorImpl<const MDNode*>::const_iterator
1362 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1363 ++UVI) {
1364 const MDNode *Var = *UVI;
1365 if (Processed.count(Var))
Devang Patelee432862010-05-20 19:57:06 +00001366 continue;
1367
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001368 // History contains relevant DBG_VALUE instructions for Var and instructions
1369 // clobbering it.
1370 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1371 if (History.empty())
1372 continue;
1373 const MachineInstr *MInsn = History.front();
Devang Patelc3f5f782010-05-25 23:40:22 +00001374
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001375 DIVariable DV(Var);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001376 LexicalScope *Scope = NULL;
Devang Pateld8720f42010-05-27 20:25:04 +00001377 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1378 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001379 Scope = LScopes.getCurrentFunctionScope();
David Blaikiec0ec8a42013-03-11 23:39:23 +00001380 else if (MDNode *IA = DV.getInlinedAt())
1381 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1382 else
1383 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patelee432862010-05-20 19:57:06 +00001384 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00001385 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00001386 continue;
1387
1388 Processed.insert(DV);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001389 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel5a1a67c2011-08-15 19:01:20 +00001390 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
Manman Renc664d762013-10-05 01:43:03 +00001391 DbgVariable *RegVar = new DbgVariable(DV, AbsVar, this);
Devang Patel0478c152011-03-01 22:58:55 +00001392 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001393 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001394 if (AbsVar)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001395 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001396
Eric Christopherc56e3f02012-10-08 20:48:54 +00001397 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001398 if (History.size() <= 1 || (History.size() == 2 &&
1399 MInsn->isIdenticalTo(History.back()))) {
Devang Patelff9dd0a2011-08-15 21:24:36 +00001400 RegVar->setMInsn(MInsn);
Devang Patelc3f5f782010-05-25 23:40:22 +00001401 continue;
1402 }
1403
Eric Christopher498703b2013-01-28 17:33:26 +00001404 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001405 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001406
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001407 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1408 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1409 const MachineInstr *Begin = *HI;
1410 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesene17232e2011-03-22 00:21:41 +00001411
Devang Patel4ada1d72011-06-01 23:00:17 +00001412 // Check if DBG_VALUE is truncating a range.
1413 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1414 && !Begin->getOperand(0).getReg())
1415 continue;
1416
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001417 // Compute the range for a register location.
1418 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1419 const MCSymbol *SLabel = 0;
1420
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001421 if (HI + 1 == HE)
1422 // If Begin is the last instruction in History then its value is valid
Chris Lattner7a2bdde2011-04-15 05:18:47 +00001423 // until the end of the function.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001424 SLabel = FunctionEndSym;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001425 else {
1426 const MachineInstr *End = HI[1];
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001427 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel476df5f2011-07-07 21:44:42 +00001428 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001429 if (End->isDebugValue())
1430 SLabel = getLabelBeforeInsn(End);
1431 else {
1432 // End is a normal instruction clobbering the range.
1433 SLabel = getLabelAfterInsn(End);
1434 assert(SLabel && "Forgot label after clobber instruction");
1435 ++HI;
1436 }
1437 }
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001438
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001439 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopherabbb2002011-12-16 23:42:31 +00001440 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1441 Begin));
Devang Patelc3f5f782010-05-25 23:40:22 +00001442 }
1443 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00001444 }
Devang Patel98e1cac2010-05-14 21:01:35 +00001445
1446 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001447 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1448 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1449 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1450 DIVariable DV(Variables.getElement(i));
Manman Rend03d2b22013-07-08 18:33:29 +00001451 if (!DV || !DV.isVariable() || !Processed.insert(DV))
Devang Patel93d39be2011-08-19 23:28:12 +00001452 continue;
1453 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
Manman Renc664d762013-10-05 01:43:03 +00001454 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patel98e1cac2010-05-14 21:01:35 +00001455 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001456}
Devang Patel98e1cac2010-05-14 21:01:35 +00001457
Eric Christopherb6dc8652012-11-27 22:43:45 +00001458// Return Label preceding the instruction.
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001459MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001460 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1461 assert(Label && "Didn't insert label before instruction");
1462 return Label;
Devang Patelc3f5f782010-05-25 23:40:22 +00001463}
1464
Eric Christopherb6dc8652012-11-27 22:43:45 +00001465// Return Label immediately following the instruction.
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001466MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001467 return LabelsAfterInsn.lookup(MI);
Devang Patele717faa2009-10-06 01:26:37 +00001468}
1469
Eric Christopherb6dc8652012-11-27 22:43:45 +00001470// Process beginning of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001471void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001472 // Check if source location changes, but ignore DBG_VALUE locations.
1473 if (!MI->isDebugValue()) {
1474 DebugLoc DL = MI->getDebugLoc();
1475 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopher60b35f42012-04-05 20:39:05 +00001476 unsigned Flags = 0;
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001477 PrevInstLoc = DL;
Devang Patel4243e672011-05-11 19:22:19 +00001478 if (DL == PrologEndLoc) {
1479 Flags |= DWARF2_FLAG_PROLOGUE_END;
1480 PrologEndLoc = DebugLoc();
1481 }
Eric Christopher60b35f42012-04-05 20:39:05 +00001482 if (PrologEndLoc.isUnknown())
1483 Flags |= DWARF2_FLAG_IS_STMT;
1484
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001485 if (!DL.isUnknown()) {
1486 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel4243e672011-05-11 19:22:19 +00001487 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001488 } else
Devang Patel4243e672011-05-11 19:22:19 +00001489 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001490 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001491 }
Devang Patelaead63c2010-03-29 22:59:58 +00001492
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001493 // Insert labels where requested.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001494 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1495 LabelsBeforeInsn.find(MI);
1496
1497 // No label needed.
1498 if (I == LabelsBeforeInsn.end())
1499 return;
1500
1501 // Label already assigned.
1502 if (I->second)
Devang Patelb2b31a62010-05-26 19:37:24 +00001503 return;
Devang Patel553881b2010-03-29 17:20:31 +00001504
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001505 if (!PrevLabel) {
Devang Patel77051f52010-05-26 21:23:46 +00001506 PrevLabel = MMI->getContext().CreateTempSymbol();
1507 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00001508 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001509 I->second = PrevLabel;
Devang Patel0d20ac82009-10-06 01:50:42 +00001510}
1511
Eric Christopherb6dc8652012-11-27 22:43:45 +00001512// Process end of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001513void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001514 // Don't create a new label after DBG_VALUE instructions.
1515 // They don't generate code.
1516 if (!MI->isDebugValue())
1517 PrevLabel = 0;
1518
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001519 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1520 LabelsAfterInsn.find(MI);
1521
1522 // No label needed.
1523 if (I == LabelsAfterInsn.end())
1524 return;
1525
1526 // Label already assigned.
1527 if (I->second)
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001528 return;
1529
1530 // We need a label after this instruction.
1531 if (!PrevLabel) {
1532 PrevLabel = MMI->getContext().CreateTempSymbol();
1533 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel1c246352010-04-08 16:50:29 +00001534 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001535 I->second = PrevLabel;
Devang Patel53bb5c92009-11-10 23:06:00 +00001536}
1537
Eric Christopherb6dc8652012-11-27 22:43:45 +00001538// Each LexicalScope has first instruction and last instruction to mark
1539// beginning and end of a scope respectively. Create an inverse map that list
1540// scopes starts (and ends) with an instruction. One instruction may start (or
1541// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00001542void DwarfDebug::identifyScopeMarkers() {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001543 SmallVector<LexicalScope *, 4> WorkList;
1544 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel42aafd72010-01-20 02:05:23 +00001545 while (!WorkList.empty()) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001546 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001547
Craig Topper9f43ac62013-07-03 04:24:43 +00001548 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001549 if (!Children.empty())
Craig Topper2d785db2013-07-03 04:17:25 +00001550 for (SmallVectorImpl<LexicalScope *>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00001551 SE = Children.end(); SI != SE; ++SI)
1552 WorkList.push_back(*SI);
1553
Devang Patel53bb5c92009-11-10 23:06:00 +00001554 if (S->isAbstractScope())
1555 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001556
Craig Topper9f43ac62013-07-03 04:24:43 +00001557 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
Devang Pateleac9c072010-04-27 19:46:33 +00001558 if (Ranges.empty())
1559 continue;
Craig Topper2d785db2013-07-03 04:17:25 +00001560 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +00001561 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001562 assert(RI->first && "InsnRange does not have first instruction!");
1563 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001564 requestLabelBeforeInsn(RI->first);
1565 requestLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001566 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001567 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001568}
1569
Eric Christopherb6dc8652012-11-27 22:43:45 +00001570// Get MDNode for DebugLoc's scope.
Devang Patela3f48672011-05-09 22:14:49 +00001571static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1572 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1573 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1574 return DL.getScope(Ctx);
1575}
1576
Eric Christopherb6dc8652012-11-27 22:43:45 +00001577// Walk up the scope chain of given debug loc and find line number info
1578// for the function.
Devang Patel4243e672011-05-11 19:22:19 +00001579static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1580 const MDNode *Scope = getScopeNode(DL, Ctx);
1581 DISubprogram SP = getDISubprogram(Scope);
Manman Rend03d2b22013-07-08 18:33:29 +00001582 if (SP.isSubprogram()) {
Eric Christopher6126a1e2012-04-03 00:43:49 +00001583 // Check for number of operands since the compatibility is
1584 // cheap here.
Eric Christopherfa5b0502012-04-03 17:55:42 +00001585 if (SP->getNumOperands() > 19)
Eric Christopher6126a1e2012-04-03 00:43:49 +00001586 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1587 else
1588 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1589 }
1590
Devang Patel4243e672011-05-11 19:22:19 +00001591 return DebugLoc();
1592}
1593
Eric Christopherb6dc8652012-11-27 22:43:45 +00001594// Gather pre-function debug information. Assumes being called immediately
1595// after the function entry point has been emitted.
Chris Lattnereec791a2010-01-26 23:18:02 +00001596void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00001597 if (!MMI->hasDebugInfo()) return;
Devang Patelbf47fdb2011-08-10 20:55:27 +00001598 LScopes.initialize(*MF);
1599 if (LScopes.empty()) return;
1600 identifyScopeMarkers();
Devang Patel60b35bd2009-10-06 18:37:31 +00001601
Manman Ren43213cf2013-02-05 21:52:47 +00001602 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1603 // belongs to.
1604 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1605 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1606 assert(TheCU && "Unable to find compile unit!");
Rafael Espindola5e195a42013-10-05 16:42:21 +00001607 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren01cb18e2013-05-21 00:57:22 +00001608 // Use a single line table if we are using .loc and generating assembly.
1609 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1610 else
1611 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
Manman Ren43213cf2013-02-05 21:52:47 +00001612
Devang Pateleac9c072010-04-27 19:46:33 +00001613 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1614 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001615 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00001616 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001617
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001618 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1619
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001620 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopherb6dc8652012-11-27 22:43:45 +00001621 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001622 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1623
Devang Patelb2b31a62010-05-26 19:37:24 +00001624 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001625 I != E; ++I) {
1626 bool AtBlockEntry = true;
Devang Patelb2b31a62010-05-26 19:37:24 +00001627 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1628 II != IE; ++II) {
1629 const MachineInstr *MI = II;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001630
Devang Patelb2b31a62010-05-26 19:37:24 +00001631 if (MI->isDebugValue()) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001632 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001633
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001634 // Keep track of user variables.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001635 const MDNode *Var =
1636 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001637
1638 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001639 if (isDbgValueInDefinedReg(MI))
1640 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1641
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001642 // Check the history of this variable.
1643 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1644 if (History.empty()) {
1645 UserVariables.push_back(Var);
1646 // The first mention of a function argument gets the FunctionBeginSym
1647 // label, so arguments are visible when breaking at function entry.
1648 DIVariable DV(Var);
Manman Rend03d2b22013-07-08 18:33:29 +00001649 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001650 DISubprogram(getDISubprogram(DV.getContext()))
1651 .describes(MF->getFunction()))
1652 LabelsBeforeInsn[MI] = FunctionBeginSym;
1653 } else {
1654 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1655 const MachineInstr *Prev = History.back();
1656 if (Prev->isDebugValue()) {
1657 // Coalesce identical entries at the end of History.
1658 if (History.size() >= 2 &&
Devang Patel79862892011-07-07 00:14:27 +00001659 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher02c1a642012-10-08 20:48:49 +00001660 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001661 << "\t" << *Prev
Devang Patel79862892011-07-07 00:14:27 +00001662 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001663 History.pop_back();
Devang Patel79862892011-07-07 00:14:27 +00001664 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001665
1666 // Terminate old register assignments that don't reach MI;
1667 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1668 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1669 isDbgValueInDefinedReg(Prev)) {
1670 // Previous register assignment needs to terminate at the end of
1671 // its basic block.
1672 MachineBasicBlock::const_iterator LastMI =
1673 PrevMBB->getLastNonDebugInstr();
Devang Patel79862892011-07-07 00:14:27 +00001674 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001675 // Drop DBG_VALUE for empty range.
Eric Christopher02c1a642012-10-08 20:48:49 +00001676 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patel79862892011-07-07 00:14:27 +00001677 << "\t" << *Prev << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001678 History.pop_back();
David Blaikie4532c282013-06-20 00:25:24 +00001679 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001680 // Terminate after LastMI.
1681 History.push_back(LastMI);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001682 }
1683 }
1684 }
1685 History.push_back(MI);
Devang Patelb2b31a62010-05-26 19:37:24 +00001686 } else {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001687 // Not a DBG_VALUE instruction.
1688 if (!MI->isLabel())
1689 AtBlockEntry = false;
1690
Eric Christopher0313ced2012-10-04 20:46:14 +00001691 // First known non-DBG_VALUE and non-frame setup location marks
1692 // the beginning of the function body.
1693 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1694 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel4243e672011-05-11 19:22:19 +00001695 PrologEndLoc = MI->getDebugLoc();
1696
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001697 // Check if the instruction clobbers any registers with debug vars.
1698 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1699 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1700 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1701 continue;
Jakob Stoklund Olesen396618b2012-06-01 23:28:30 +00001702 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1703 AI.isValid(); ++AI) {
1704 unsigned Reg = *AI;
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001705 const MDNode *Var = LiveUserVar[Reg];
1706 if (!Var)
1707 continue;
1708 // Reg is now clobbered.
1709 LiveUserVar[Reg] = 0;
1710
1711 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001712 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1713 if (HistI == DbgValues.end())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001714 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001715 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1716 if (History.empty())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001717 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001718 const MachineInstr *Prev = History.back();
1719 // Sanity-check: Register assignments are terminated at the end of
1720 // their block.
1721 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1722 continue;
1723 // Is the variable still in Reg?
1724 if (!isDbgValueInDefinedReg(Prev) ||
1725 Prev->getOperand(0).getReg() != Reg)
1726 continue;
1727 // Var is clobbered. Make sure the next instruction gets a label.
1728 History.push_back(MI);
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001729 }
1730 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001731 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001732 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001733 }
1734
1735 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1736 I != E; ++I) {
1737 SmallVectorImpl<const MachineInstr*> &History = I->second;
1738 if (History.empty())
1739 continue;
1740
1741 // Make sure the final register assignments are terminated.
1742 const MachineInstr *Prev = History.back();
1743 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1744 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001745 MachineBasicBlock::const_iterator LastMI =
Devang Patel5bc942c2011-08-10 23:58:09 +00001746 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001747 if (LastMI == PrevMBB->end())
1748 // Drop DBG_VALUE for empty range.
1749 History.pop_back();
David Blaikie4532c282013-06-20 00:25:24 +00001750 else if (PrevMBB != &PrevMBB->getParent()->back()) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001751 // Terminate after LastMI.
1752 History.push_back(LastMI);
1753 }
1754 }
1755 // Request labels for the full history.
1756 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1757 const MachineInstr *MI = History[i];
1758 if (MI->isDebugValue())
1759 requestLabelBeforeInsn(MI);
1760 else
1761 requestLabelAfterInsn(MI);
1762 }
1763 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001764
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001765 PrevInstLoc = DebugLoc();
Devang Patelb2b31a62010-05-26 19:37:24 +00001766 PrevLabel = FunctionBeginSym;
Devang Patel4243e672011-05-11 19:22:19 +00001767
1768 // Record beginning of function.
1769 if (!PrologEndLoc.isUnknown()) {
1770 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1771 MF->getFunction()->getContext());
1772 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1773 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie836cfc42012-12-04 22:02:33 +00001774 // We'd like to list the prologue as "not statements" but GDB behaves
1775 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikieb36c5312012-12-04 21:05:36 +00001776 DWARF2_FLAG_IS_STMT);
Devang Patel4243e672011-05-11 19:22:19 +00001777 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001778}
1779
Devang Patelbf47fdb2011-08-10 20:55:27 +00001780void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
David Blaikie032d6242013-06-05 05:39:59 +00001781 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1782 DIVariable DV = Var->getVariable();
David Blaikieb20fdff2013-06-06 21:04:51 +00001783 // Variables with positive arg numbers are parameters.
1784 if (unsigned ArgNum = DV.getArgNumber()) {
1785 // Keep all parameters in order at the start of the variable list to ensure
1786 // function types are correct (no out-of-order parameters)
1787 //
1788 // This could be improved by only doing it for optimized builds (unoptimized
1789 // builds have the right order to begin with), searching from the back (this
1790 // would catch the unoptimized case quickly), or doing a binary search
1791 // rather than linear search.
1792 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1793 while (I != Vars.end()) {
1794 unsigned CurNum = (*I)->getVariable().getArgNumber();
1795 // A local (non-parameter) variable has been found, insert immediately
1796 // before it.
1797 if (CurNum == 0)
1798 break;
1799 // A later indexed parameter has been found, insert immediately before it.
David Blaikiebabfebb2013-06-06 22:28:26 +00001800 if (CurNum > ArgNum)
David Blaikieb20fdff2013-06-06 21:04:51 +00001801 break;
David Blaikiebabfebb2013-06-06 22:28:26 +00001802 ++I;
David Blaikie032d6242013-06-05 05:39:59 +00001803 }
David Blaikieb20fdff2013-06-06 21:04:51 +00001804 Vars.insert(I, Var);
1805 return;
David Blaikie032d6242013-06-05 05:39:59 +00001806 }
1807
1808 Vars.push_back(Var);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001809}
1810
Eric Christopherb6dc8652012-11-27 22:43:45 +00001811// Gather and emit post-function debug information.
Chris Lattnereec791a2010-01-26 23:18:02 +00001812void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001813 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00001814
Devang Patelbf47fdb2011-08-10 20:55:27 +00001815 // Define end label for subprogram.
1816 FunctionEndSym = Asm->GetTempSymbol("func_end",
1817 Asm->getFunctionNumber());
1818 // Assumes in correct section after the entry point.
1819 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Manman Ren43213cf2013-02-05 21:52:47 +00001820 // Set DwarfCompileUnitID in MCContext to default value.
1821 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001822
Devang Patelbf47fdb2011-08-10 20:55:27 +00001823 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1824 collectVariableInfo(MF, ProcessedVars);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001825
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001826 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Patel94c7ddb2011-08-16 22:09:43 +00001827 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky746cb672011-10-26 22:55:33 +00001828 assert(TheCU && "Unable to find compile unit!");
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001829
Devang Patelbf47fdb2011-08-10 20:55:27 +00001830 // Construct abstract scopes.
Devang Patelcd9f6c52011-08-12 18:10:19 +00001831 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1832 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1833 LexicalScope *AScope = AList[i];
1834 DISubprogram SP(AScope->getScopeNode());
Manman Rend03d2b22013-07-08 18:33:29 +00001835 if (SP.isSubprogram()) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001836 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001837 DIArray Variables = SP.getVariables();
1838 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1839 DIVariable DV(Variables.getElement(i));
Manman Rend03d2b22013-07-08 18:33:29 +00001840 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
Devang Patel93d39be2011-08-19 23:28:12 +00001841 continue;
Alexey Samsonovb67bd332012-07-06 08:45:08 +00001842 // Check that DbgVariable for DV wasn't created earlier, when
1843 // findAbstractVariable() was called for inlined instance of DV.
1844 LLVMContext &Ctx = DV->getContext();
1845 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1846 if (AbstractVariables.lookup(CleanDV))
1847 continue;
Devang Patel93d39be2011-08-19 23:28:12 +00001848 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
Manman Renc664d762013-10-05 01:43:03 +00001849 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patel78e127d2010-06-25 22:07:34 +00001850 }
1851 }
Devang Patelcd9f6c52011-08-12 18:10:19 +00001852 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Manman Ren742671b2013-05-29 17:16:59 +00001853 constructScopeDIE(TheCU, AScope);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001854 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001855
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001856 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001857
Nick Lewycky8a8d4792011-12-02 22:16:29 +00001858 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopher873cf0a2012-08-24 01:14:27 +00001859 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001860
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001861 // Clear debug info
Craig Topper01eb99a2013-07-03 04:40:27 +00001862 for (ScopeVariablesMap::iterator
Devang Patelbf47fdb2011-08-10 20:55:27 +00001863 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1864 DeleteContainerPointers(I->second);
1865 ScopeVariables.clear();
Devang Pateleac0c9d2011-04-22 18:09:57 +00001866 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001867 UserVariables.clear();
1868 DbgValues.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001869 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00001870 LabelsBeforeInsn.clear();
1871 LabelsAfterInsn.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00001872 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001873}
1874
Eric Christopherb6dc8652012-11-27 22:43:45 +00001875// Register a source line with debug info. Returns the unique label that was
1876// emitted and which provides correspondence to the source line list.
Devang Patel4243e672011-05-11 19:22:19 +00001877void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1878 unsigned Flags) {
Devang Patel65dbc902009-11-25 17:36:49 +00001879 StringRef Fn;
Devang Patel23670e52011-03-24 20:30:50 +00001880 StringRef Dir;
Dan Gohman1cc0d622010-05-05 23:41:32 +00001881 unsigned Src = 1;
1882 if (S) {
1883 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00001884
Dan Gohman1cc0d622010-05-05 23:41:32 +00001885 if (Scope.isCompileUnit()) {
1886 DICompileUnit CU(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001887 Fn = CU.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001888 Dir = CU.getDirectory();
Devang Patel3cabc9d2010-10-28 17:30:52 +00001889 } else if (Scope.isFile()) {
1890 DIFile F(S);
Devang Patel3cabc9d2010-10-28 17:30:52 +00001891 Fn = F.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001892 Dir = F.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001893 } else if (Scope.isSubprogram()) {
1894 DISubprogram SP(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001895 Fn = SP.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001896 Dir = SP.getDirectory();
Eric Christopher6618a242011-10-11 22:59:11 +00001897 } else if (Scope.isLexicalBlockFile()) {
1898 DILexicalBlockFile DBF(S);
1899 Fn = DBF.getFilename();
1900 Dir = DBF.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001901 } else if (Scope.isLexicalBlock()) {
1902 DILexicalBlock DB(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001903 Fn = DB.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001904 Dir = DB.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001905 } else
Craig Topper5e25ee82012-02-05 08:31:47 +00001906 llvm_unreachable("Unexpected scope info");
Dan Gohman1cc0d622010-05-05 23:41:32 +00001907
Manman Ren3de61b42013-03-07 01:42:00 +00001908 Src = getOrCreateSourceID(Fn, Dir,
1909 Asm->OutStreamer.getContext().getDwarfCompileUnitID());
Dan Gohman1cc0d622010-05-05 23:41:32 +00001910 }
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001911 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001912}
1913
Bill Wendling829e67b2009-05-20 23:22:40 +00001914//===----------------------------------------------------------------------===//
1915// Emit Methods
1916//===----------------------------------------------------------------------===//
1917
Eric Christopherb6dc8652012-11-27 22:43:45 +00001918// Compute the size and offset of a DIE.
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001919unsigned
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001920DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001921 // Get the children.
1922 const std::vector<DIE *> &Children = Die->getChildren();
1923
Bill Wendling94d04b82009-05-20 23:21:38 +00001924 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001925 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00001926
1927 // Get the abbreviation for this DIE.
1928 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001929 const DIEAbbrev *Abbrev = Abbreviations->at(AbbrevNumber - 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00001930
1931 // Set DIE offset
1932 Die->setOffset(Offset);
1933
1934 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00001935 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001936
Eric Christopherf7cef702013-03-29 23:34:06 +00001937 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1938 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling94d04b82009-05-20 23:21:38 +00001939
1940 // Size the DIE attribute values.
1941 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1942 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00001943 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00001944
1945 // Size the DIE children if any.
1946 if (!Children.empty()) {
1947 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1948 "Children flag not set");
1949
1950 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopherfbd19752012-11-20 22:14:13 +00001951 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling94d04b82009-05-20 23:21:38 +00001952
1953 // End of children marker.
1954 Offset += sizeof(int8_t);
1955 }
1956
1957 Die->setSize(Offset - Die->getOffset());
1958 return Offset;
1959}
1960
Eric Christopherb6dc8652012-11-27 22:43:45 +00001961// Compute the size and offset of all the DIEs.
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001962void DwarfUnits::computeSizeAndOffsets() {
Manman Renbc3e96f2013-03-12 18:27:15 +00001963 // Offset from the beginning of debug info section.
Eric Christopherf7cef702013-03-29 23:34:06 +00001964 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001965 E = CUs.end(); I != E; ++I) {
Eric Christopher98e237f2012-11-30 23:59:06 +00001966 unsigned Offset =
1967 sizeof(int32_t) + // Length of Compilation Unit Info
1968 sizeof(int16_t) + // DWARF version number
1969 sizeof(int32_t) + // Offset Into Abbrev. Section
1970 sizeof(int8_t); // Pointer Size (in bytes)
Eric Christophere7099f62013-10-04 19:40:33 +00001971 computeSizeAndOffset((*I)->getCUDie(), Offset);
Devang Patel163a9f72010-05-10 22:49:55 +00001972 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001973}
1974
Eric Christopherb6dc8652012-11-27 22:43:45 +00001975// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001976void DwarfDebug::emitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001977 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001978
Bill Wendling94d04b82009-05-20 23:21:38 +00001979 // Dwarf sections base addresses.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001980 DwarfInfoSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001981 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00001982 DwarfAbbrevSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001983 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher6eebe472012-12-19 22:02:53 +00001984 if (useSplitDwarf())
1985 DwarfAbbrevDWOSectionSym =
1986 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1987 "section_abbrev_dwo");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001988 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001989
Chris Lattner9c69e285532010-04-04 22:59:04 +00001990 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001991 emitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00001992
Eric Christopher7a0103c2013-02-07 21:19:50 +00001993 DwarfLineSectionSym =
1994 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001995 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Eric Christophercdeaae42013-09-23 20:55:35 +00001996 if (GenerateGnuPubSections) {
Eric Christophera6d84152013-09-30 23:14:16 +00001997 DwarfGnuPubNamesSectionSym =
1998 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
1999 DwarfGnuPubTypesSectionSym =
2000 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
Eric Christophercdeaae42013-09-23 20:55:35 +00002001 } else if (HasDwarfPubSections) {
2002 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2003 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Michael Gottesmandc42d032013-09-04 04:39:38 +00002004 }
Eric Christopher8f1a9292013-09-13 00:35:05 +00002005
Jim Grosbach1e20b962010-07-21 21:21:52 +00002006 DwarfStrSectionSym =
Eric Christopher64f824c2012-12-27 02:14:01 +00002007 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002008 if (useSplitDwarf()) {
Eric Christopher64f824c2012-12-27 02:14:01 +00002009 DwarfStrDWOSectionSym =
2010 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002011 DwarfAddrSectionSym =
2012 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
2013 }
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002014 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patelf2548ca2010-04-16 23:33:45 +00002015 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00002016
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002017 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patelc3f5f782010-05-25 23:40:22 +00002018 "section_debug_loc");
2019
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002020 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
2021 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002022}
2023
Eric Christopherb6dc8652012-11-27 22:43:45 +00002024// Recursively emits a debug information entry.
Eric Christopher6eebe472012-12-19 22:02:53 +00002025void DwarfDebug::emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002026 // Get the abbreviation for this DIE.
2027 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher6eebe472012-12-19 22:02:53 +00002028 const DIEAbbrev *Abbrev = Abbrevs->at(AbbrevNumber - 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00002029
Bill Wendling94d04b82009-05-20 23:21:38 +00002030 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00002031 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00002032 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2033 Twine::utohexstr(Die->getOffset()) + ":0x" +
2034 Twine::utohexstr(Die->getSize()) + " " +
2035 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002036 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00002037
Eric Christopherf7cef702013-03-29 23:34:06 +00002038 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
2039 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling94d04b82009-05-20 23:21:38 +00002040
2041 // Emit the DIE attribute values.
2042 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2043 unsigned Attr = AbbrevData[i].getAttribute();
2044 unsigned Form = AbbrevData[i].getForm();
2045 assert(Form && "Too many attributes for DIE (check abbreviation)");
2046
Chris Lattner3f53c832010-04-04 18:52:31 +00002047 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00002048 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002049
Bill Wendling94d04b82009-05-20 23:21:38 +00002050 switch (Attr) {
Eric Christopher3f045002013-10-04 17:08:38 +00002051 case dwarf::DW_AT_abstract_origin: {
Bill Wendling94d04b82009-05-20 23:21:38 +00002052 DIEEntry *E = cast<DIEEntry>(Values[i]);
2053 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00002054 unsigned Addr = Origin->getOffset();
Eric Christophere7099f62013-10-04 19:40:33 +00002055 Asm->EmitInt32(Addr);
Bill Wendling94d04b82009-05-20 23:21:38 +00002056 break;
2057 }
Devang Patelf2548ca2010-04-16 23:33:45 +00002058 case dwarf::DW_AT_ranges: {
2059 // DW_AT_range Value encodes offset in debug_range section.
2060 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelb1fcfbe2010-09-02 16:43:44 +00002061
Nick Lewyckyffccd922012-06-22 01:25:12 +00002062 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelb1fcfbe2010-09-02 16:43:44 +00002063 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
2064 V->getValue(),
2065 4);
2066 } else {
2067 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
2068 V->getValue(),
2069 DwarfDebugRangeSectionSym,
2070 4);
2071 }
Devang Patelf2548ca2010-04-16 23:33:45 +00002072 break;
2073 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002074 case dwarf::DW_AT_location: {
Nick Lewyckyffccd922012-06-22 01:25:12 +00002075 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2076 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Ulrich Weigand1f8aacd2013-07-02 18:46:26 +00002077 Asm->EmitLabelReference(L->getValue(), 4);
Nick Lewyckyffccd922012-06-22 01:25:12 +00002078 else
Ulrich Weigand1f8aacd2013-07-02 18:46:26 +00002079 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewyckyffccd922012-06-22 01:25:12 +00002080 } else {
Devang Patelc3f5f782010-05-25 23:40:22 +00002081 Values[i]->EmitValue(Asm, Form);
Nick Lewyckyffccd922012-06-22 01:25:12 +00002082 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002083 break;
2084 }
Devang Patel2a361602010-09-29 19:08:08 +00002085 case dwarf::DW_AT_accessibility: {
2086 if (Asm->isVerbose()) {
2087 DIEInteger *V = cast<DIEInteger>(Values[i]);
2088 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2089 }
2090 Values[i]->EmitValue(Asm, Form);
2091 break;
2092 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002093 default:
2094 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002095 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00002096 break;
2097 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002098 }
2099
2100 // Emit the DIE children if any.
2101 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2102 const std::vector<DIE *> &Children = Die->getChildren();
2103
2104 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher6eebe472012-12-19 22:02:53 +00002105 emitDIE(Children[j], Abbrevs);
Bill Wendling94d04b82009-05-20 23:21:38 +00002106
Chris Lattner3f53c832010-04-04 18:52:31 +00002107 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00002108 Asm->OutStreamer.AddComment("End Of Children Mark");
2109 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00002110 }
2111}
2112
Eric Christopherb1e66d02012-12-15 00:04:07 +00002113// Emit the various dwarf units to the unit section USection with
2114// the abbreviations going into ASection.
2115void DwarfUnits::emitUnits(DwarfDebug *DD,
2116 const MCSection *USection,
2117 const MCSection *ASection,
2118 const MCSymbol *ASectionSym) {
2119 Asm->OutStreamer.SwitchSection(USection);
Eric Christopherf7cef702013-03-29 23:34:06 +00002120 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopherb1e66d02012-12-15 00:04:07 +00002121 E = CUs.end(); I != E; ++I) {
2122 CompileUnit *TheCU = *I;
Devang Patel163a9f72010-05-10 22:49:55 +00002123 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002124
Devang Patel163a9f72010-05-10 22:49:55 +00002125 // Emit the compile units header.
Eric Christopherb1e66d02012-12-15 00:04:07 +00002126 Asm->OutStreamer
2127 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
2128 TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002129
Devang Patel163a9f72010-05-10 22:49:55 +00002130 // Emit size of content not including length itself
2131 unsigned ContentSize = Die->getSize() +
2132 sizeof(int16_t) + // DWARF version number
2133 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patel65705d52011-04-13 19:41:17 +00002134 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbach1e20b962010-07-21 21:21:52 +00002135
Devang Patel163a9f72010-05-10 22:49:55 +00002136 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2137 Asm->EmitInt32(ContentSize);
2138 Asm->OutStreamer.AddComment("DWARF version number");
Manman Ren0e6783f2013-07-02 23:40:10 +00002139 Asm->EmitInt16(DD->getDwarfVersion());
Devang Patel163a9f72010-05-10 22:49:55 +00002140 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
Eric Christopherb1e66d02012-12-15 00:04:07 +00002141 Asm->EmitSectionOffset(Asm->GetTempSymbol(ASection->getLabelBeginName()),
2142 ASectionSym);
Devang Patel163a9f72010-05-10 22:49:55 +00002143 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002144 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002145
Eric Christopher6eebe472012-12-19 22:02:53 +00002146 DD->emitDIE(Die, Abbreviations);
Eric Christopherb1e66d02012-12-15 00:04:07 +00002147 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002148 TheCU->getUniqueID()));
Devang Patel163a9f72010-05-10 22:49:55 +00002149 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002150}
2151
Eric Christopher98e237f2012-11-30 23:59:06 +00002152// Emit the debug info section.
2153void DwarfDebug::emitDebugInfo() {
Eric Christopherb1e66d02012-12-15 00:04:07 +00002154 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2155
2156 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
2157 Asm->getObjFileLowering().getDwarfAbbrevSection(),
2158 DwarfAbbrevSectionSym);
Eric Christopher98e237f2012-11-30 23:59:06 +00002159}
2160
Eric Christopherb6dc8652012-11-27 22:43:45 +00002161// Emit the abbreviation section.
Eric Christopher7dc68db2012-11-20 23:30:11 +00002162void DwarfDebug::emitAbbreviations() {
Eric Christopher6eebe472012-12-19 22:02:53 +00002163 if (!useSplitDwarf())
2164 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
2165 &Abbreviations);
2166 else
2167 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2168}
Bill Wendling94d04b82009-05-20 23:21:38 +00002169
Eric Christopher6eebe472012-12-19 22:02:53 +00002170void DwarfDebug::emitAbbrevs(const MCSection *Section,
2171 std::vector<DIEAbbrev *> *Abbrevs) {
2172 // Check to see if it is worth the effort.
2173 if (!Abbrevs->empty()) {
2174 // Start the debug abbrev section.
2175 Asm->OutStreamer.SwitchSection(Section);
2176
2177 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
Eric Christopher44fedba2012-12-13 03:00:38 +00002178 Asm->OutStreamer.EmitLabel(Begin);
Bill Wendling94d04b82009-05-20 23:21:38 +00002179
2180 // For each abbrevation.
Eric Christopher6eebe472012-12-19 22:02:53 +00002181 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002182 // Get abbreviation data
Eric Christopher6eebe472012-12-19 22:02:53 +00002183 const DIEAbbrev *Abbrev = Abbrevs->at(i);
Bill Wendling94d04b82009-05-20 23:21:38 +00002184
2185 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002186 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00002187
2188 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002189 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00002190 }
2191
2192 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002193 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00002194
Eric Christopher6eebe472012-12-19 22:02:53 +00002195 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
Eric Christopher44fedba2012-12-13 03:00:38 +00002196 Asm->OutStreamer.EmitLabel(End);
Bill Wendling94d04b82009-05-20 23:21:38 +00002197 }
2198}
2199
Eric Christopherb6dc8652012-11-27 22:43:45 +00002200// Emit the last address of the section and the end of the line matrix.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002201void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002202 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00002203 Asm->OutStreamer.AddComment("Extended Op");
2204 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002205
Chris Lattner233f52b2010-03-09 23:52:58 +00002206 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002207 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00002208 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2209 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2210
2211 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00002212
Chris Lattnerc0215722010-04-04 19:25:43 +00002213 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Eric Christopherca1dd052013-01-09 01:35:34 +00002214 Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002215
2216 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00002217 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2218 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00002219 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00002220 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00002221}
2222
Eric Christopherb6dc8652012-11-27 22:43:45 +00002223// Emit visible names into a hashed accelerator table section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002224void DwarfDebug::emitAccelNames() {
Eric Christopher577056f2013-09-05 18:20:16 +00002225 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher09ac3d82011-11-07 09:24:32 +00002226 dwarf::DW_FORM_data4));
2227 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2228 E = CUMap.end(); I != E; ++I) {
2229 CompileUnit *TheCU = I->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00002230 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2231 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002232 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002233 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002234 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00002235 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2236 DE = Entities.end(); DI != DE; ++DI)
2237 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00002238 }
2239 }
2240
2241 AT.FinalizeTable(Asm, "Names");
2242 Asm->OutStreamer.SwitchSection(
2243 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2244 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2245 Asm->OutStreamer.EmitLabel(SectionBegin);
2246
2247 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002248 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002249}
2250
Eric Christopher72c16552012-12-20 21:58:40 +00002251// Emit objective C classes and categories into a hashed accelerator table
2252// section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002253void DwarfDebug::emitAccelObjC() {
Eric Christopher577056f2013-09-05 18:20:16 +00002254 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher09ac3d82011-11-07 09:24:32 +00002255 dwarf::DW_FORM_data4));
2256 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2257 E = CUMap.end(); I != E; ++I) {
2258 CompileUnit *TheCU = I->second;
2259 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2260 for (StringMap<std::vector<DIE*> >::const_iterator
2261 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002262 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002263 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher09ac3d82011-11-07 09:24:32 +00002264 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2265 DE = Entities.end(); DI != DE; ++DI)
2266 AT.AddName(Name, (*DI));
2267 }
2268 }
2269
2270 AT.FinalizeTable(Asm, "ObjC");
2271 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2272 .getDwarfAccelObjCSection());
2273 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2274 Asm->OutStreamer.EmitLabel(SectionBegin);
2275
2276 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002277 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002278}
2279
Eric Christopherb6dc8652012-11-27 22:43:45 +00002280// Emit namespace dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002281void DwarfDebug::emitAccelNamespaces() {
Eric Christopher577056f2013-09-05 18:20:16 +00002282 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher09ac3d82011-11-07 09:24:32 +00002283 dwarf::DW_FORM_data4));
2284 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2285 E = CUMap.end(); I != E; ++I) {
2286 CompileUnit *TheCU = I->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00002287 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2288 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002289 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002290 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002291 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00002292 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2293 DE = Entities.end(); DI != DE; ++DI)
2294 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00002295 }
2296 }
2297
2298 AT.FinalizeTable(Asm, "namespac");
2299 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2300 .getDwarfAccelNamespaceSection());
2301 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2302 Asm->OutStreamer.EmitLabel(SectionBegin);
2303
2304 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002305 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002306}
2307
Eric Christopherb6dc8652012-11-27 22:43:45 +00002308// Emit type dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002309void DwarfDebug::emitAccelTypes() {
Eric Christopherc36145f2012-01-06 04:35:23 +00002310 std::vector<DwarfAccelTable::Atom> Atoms;
Eric Christopher577056f2013-09-05 18:20:16 +00002311 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopherc36145f2012-01-06 04:35:23 +00002312 dwarf::DW_FORM_data4));
Eric Christopher577056f2013-09-05 18:20:16 +00002313 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag,
Eric Christopherc36145f2012-01-06 04:35:23 +00002314 dwarf::DW_FORM_data2));
Eric Christopher577056f2013-09-05 18:20:16 +00002315 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags,
Eric Christopherc36145f2012-01-06 04:35:23 +00002316 dwarf::DW_FORM_data1));
2317 DwarfAccelTable AT(Atoms);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002318 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2319 E = CUMap.end(); I != E; ++I) {
2320 CompileUnit *TheCU = I->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002321 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2322 = TheCU->getAccelTypes();
2323 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002324 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002325 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002326 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002327 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2328 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2329 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002330 }
2331 }
2332
2333 AT.FinalizeTable(Asm, "types");
2334 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2335 .getDwarfAccelTypesSection());
2336 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2337 Asm->OutStreamer.EmitLabel(SectionBegin);
2338
2339 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002340 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002341}
2342
Eric Christopher8f1a9292013-09-13 00:35:05 +00002343// Public name handling.
2344// The format for the various pubnames:
2345//
2346// dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2347// for the DIE that is named.
2348//
2349// gnu pubnames - offset/index value/name tuples where the offset is the offset
2350// into the CU and the index value is computed according to the type of value
2351// for the DIE that is named.
2352//
2353// For type units the offset is the offset of the skeleton DIE. For split dwarf
2354// it's the offset within the debug_info/debug_types dwo section, however, the
2355// reference in the pubname header doesn't change.
2356
2357/// computeIndexValue - Compute the gdb index value for the DIE and CU.
David Blaikie9599f512013-09-19 20:40:26 +00002358static dwarf::PubIndexEntryDescriptor computeIndexValue(CompileUnit *CU,
2359 DIE *Die) {
Eric Christophera31a9752013-09-23 22:59:14 +00002360 dwarf::GDBIndexEntryLinkage Linkage =
David Blaikie9599f512013-09-19 20:40:26 +00002361 Die->findAttribute(dwarf::DW_AT_external) ? dwarf::GIEL_EXTERNAL
2362 : dwarf::GIEL_STATIC;
Eric Christopher8f1a9292013-09-13 00:35:05 +00002363
2364 switch (Die->getTag()) {
2365 case dwarf::DW_TAG_class_type:
2366 case dwarf::DW_TAG_structure_type:
2367 case dwarf::DW_TAG_union_type:
2368 case dwarf::DW_TAG_enumeration_type:
Eric Christophercdeaae42013-09-23 20:55:35 +00002369 return dwarf::PubIndexEntryDescriptor(
2370 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2371 ? dwarf::GIEL_STATIC
2372 : dwarf::GIEL_EXTERNAL);
Eric Christopher8f1a9292013-09-13 00:35:05 +00002373 case dwarf::DW_TAG_typedef:
2374 case dwarf::DW_TAG_base_type:
2375 case dwarf::DW_TAG_subrange_type:
David Blaikie9599f512013-09-19 20:40:26 +00002376 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
Eric Christopher8f1a9292013-09-13 00:35:05 +00002377 case dwarf::DW_TAG_namespace:
David Blaikie9599f512013-09-19 20:40:26 +00002378 return dwarf::GIEK_TYPE;
Eric Christopher8f1a9292013-09-13 00:35:05 +00002379 case dwarf::DW_TAG_subprogram:
Eric Christophera31a9752013-09-23 22:59:14 +00002380 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
Eric Christopher8f1a9292013-09-13 00:35:05 +00002381 case dwarf::DW_TAG_constant:
2382 case dwarf::DW_TAG_variable:
Eric Christophera31a9752013-09-23 22:59:14 +00002383 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
Eric Christopher8f1a9292013-09-13 00:35:05 +00002384 case dwarf::DW_TAG_enumerator:
David Blaikie9599f512013-09-19 20:40:26 +00002385 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2386 dwarf::GIEL_STATIC);
Eric Christopher8f1a9292013-09-13 00:35:05 +00002387 default:
David Blaikie9599f512013-09-19 20:40:26 +00002388 return dwarf::GIEK_NONE;
Eric Christopher8f1a9292013-09-13 00:35:05 +00002389 }
Eric Christopher8f1a9292013-09-13 00:35:05 +00002390}
2391
Eric Christopher57479322013-09-09 20:03:17 +00002392/// emitDebugPubNames - Emit visible names into a debug pubnames section.
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002393///
Eric Christopher8f1a9292013-09-13 00:35:05 +00002394void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002395 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christopher8f1a9292013-09-13 00:35:05 +00002396 const MCSection *PSec =
2397 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2398 : Asm->getObjFileLowering().getDwarfPubNamesSection();
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002399
2400 typedef DenseMap<const MDNode*, CompileUnit*> CUMapType;
2401 for (CUMapType::iterator I = CUMap.begin(), E = CUMap.end(); I != E; ++I) {
2402 CompileUnit *TheCU = I->second;
2403 unsigned ID = TheCU->getUniqueID();
2404
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002405 // Start the dwarf pubnames section.
Eric Christopher21a6a502013-09-10 21:49:37 +00002406 Asm->OutStreamer.SwitchSection(PSec);
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002407
Eric Christophera6d84152013-09-30 23:14:16 +00002408 // Emit a label so we can reference the beginning of this pubname section.
2409 if (GnuStyle)
2410 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames",
2411 TheCU->getUniqueID()));
2412
Eric Christopher8f1a9292013-09-13 00:35:05 +00002413 // Emit the header.
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002414 Asm->OutStreamer.AddComment("Length of Public Names Info");
2415 Asm->EmitLabelDifference(Asm->GetTempSymbol("pubnames_end", ID),
2416 Asm->GetTempSymbol("pubnames_begin", ID), 4);
2417
2418 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin", ID));
2419
2420 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemerd7d43dc2013-08-21 06:13:34 +00002421 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002422
2423 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2424 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2425 DwarfInfoSectionSym);
2426
2427 Asm->OutStreamer.AddComment("Compilation Unit Length");
2428 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(), ID),
2429 Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2430 4);
2431
Eric Christopher8f1a9292013-09-13 00:35:05 +00002432 // Emit the pubnames for this compilation unit.
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002433 const StringMap<DIE*> &Globals = TheCU->getGlobalNames();
2434 for (StringMap<DIE*>::const_iterator
2435 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2436 const char *Name = GI->getKeyData();
Eric Christopher8f1a9292013-09-13 00:35:05 +00002437 DIE *Entity = GI->second;
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002438
2439 Asm->OutStreamer.AddComment("DIE offset");
2440 Asm->EmitInt32(Entity->getOffset());
2441
Eric Christopher8f1a9292013-09-13 00:35:05 +00002442 if (GnuStyle) {
David Blaikie18a6ade2013-09-19 22:19:37 +00002443 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2444 Asm->OutStreamer.AddComment(
David Blaikieac3f0162013-09-20 00:33:15 +00002445 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie994c37f2013-09-19 23:01:29 +00002446 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikie18a6ade2013-09-19 22:19:37 +00002447 Asm->EmitInt8(Desc.toBits());
Eric Christopher8f1a9292013-09-13 00:35:05 +00002448 }
2449
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002450 if (Asm->isVerbose())
2451 Asm->OutStreamer.AddComment("External Name");
Rafael Espindolaa3863ea2013-07-02 15:49:13 +00002452 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002453 }
2454
2455 Asm->OutStreamer.AddComment("End Mark");
2456 Asm->EmitInt32(0);
2457 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end", ID));
2458 }
2459}
2460
Eric Christopher8f1a9292013-09-13 00:35:05 +00002461void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
Eric Christopher5704d642013-09-13 00:34:58 +00002462 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christophercdeaae42013-09-23 20:55:35 +00002463 const MCSection *PSec =
2464 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2465 : Asm->getObjFileLowering().getDwarfPubTypesSection();
Eric Christopher5704d642013-09-13 00:34:58 +00002466
Devang Patel163a9f72010-05-10 22:49:55 +00002467 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
Eric Christopher5704d642013-09-13 00:34:58 +00002468 E = CUMap.end();
2469 I != E; ++I) {
Devang Patel163a9f72010-05-10 22:49:55 +00002470 CompileUnit *TheCU = I->second;
Eric Christopher63701182011-11-07 09:18:35 +00002471 // Start the dwarf pubtypes section.
Eric Christopher5704d642013-09-13 00:34:58 +00002472 Asm->OutStreamer.SwitchSection(PSec);
Eric Christophera6d84152013-09-30 23:14:16 +00002473
2474 // Emit a label so we can reference the beginning of this pubtype section.
2475 if (GnuStyle)
2476 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes",
2477 TheCU->getUniqueID()));
2478
2479 // Emit the header.
Devang Patel163a9f72010-05-10 22:49:55 +00002480 Asm->OutStreamer.AddComment("Length of Public Types Info");
2481 Asm->EmitLabelDifference(
Eric Christopher5704d642013-09-13 00:34:58 +00002482 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2483 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002484
Eric Christopher5704d642013-09-13 00:34:58 +00002485 Asm->OutStreamer.EmitLabel(
2486 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002487
Eric Christopher5704d642013-09-13 00:34:58 +00002488 if (Asm->isVerbose())
2489 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemerd7d43dc2013-08-21 06:13:34 +00002490 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002491
Devang Patel163a9f72010-05-10 22:49:55 +00002492 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eric Christopher5704d642013-09-13 00:34:58 +00002493 Asm->EmitSectionOffset(
2494 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()),
2495 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002496
Devang Patel163a9f72010-05-10 22:49:55 +00002497 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eric Christopher5704d642013-09-13 00:34:58 +00002498 Asm->EmitLabelDifference(
2499 Asm->GetTempSymbol(ISec->getLabelEndName(), TheCU->getUniqueID()),
2500 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002501
Eric Christophera6d84152013-09-30 23:14:16 +00002502 // Emit the pubtypes.
Eric Christopher5704d642013-09-13 00:34:58 +00002503 const StringMap<DIE *> &Globals = TheCU->getGlobalTypes();
2504 for (StringMap<DIE *>::const_iterator GI = Globals.begin(),
2505 GE = Globals.end();
2506 GI != GE; ++GI) {
Devang Patel163a9f72010-05-10 22:49:55 +00002507 const char *Name = GI->getKeyData();
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00002508 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002509
Eric Christopher5704d642013-09-13 00:34:58 +00002510 if (Asm->isVerbose())
2511 Asm->OutStreamer.AddComment("DIE offset");
Devang Patel163a9f72010-05-10 22:49:55 +00002512 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002513
Eric Christopher8f1a9292013-09-13 00:35:05 +00002514 if (GnuStyle) {
David Blaikie18a6ade2013-09-19 22:19:37 +00002515 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2516 Asm->OutStreamer.AddComment(
David Blaikieac3f0162013-09-20 00:33:15 +00002517 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie994c37f2013-09-19 23:01:29 +00002518 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikie18a6ade2013-09-19 22:19:37 +00002519 Asm->EmitInt8(Desc.toBits());
Eric Christopher8f1a9292013-09-13 00:35:05 +00002520 }
2521
Eric Christopher5704d642013-09-13 00:34:58 +00002522 if (Asm->isVerbose())
2523 Asm->OutStreamer.AddComment("External Name");
2524
Benjamin Kramer983c4572011-11-09 18:16:11 +00002525 // Emit the name with a terminating null byte.
Eric Christopher5704d642013-09-13 00:34:58 +00002526 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Devang Patel163a9f72010-05-10 22:49:55 +00002527 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002528
Devang Patel163a9f72010-05-10 22:49:55 +00002529 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00002530 Asm->EmitInt32(0);
Eric Christopher5704d642013-09-13 00:34:58 +00002531 Asm->OutStreamer.EmitLabel(
2532 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()));
Devang Patel193f7202009-11-24 01:14:22 +00002533 }
Devang Patel193f7202009-11-24 01:14:22 +00002534}
2535
Eric Christopher64f824c2012-12-27 02:14:01 +00002536// Emit strings into a string section.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002537void DwarfUnits::emitStrings(const MCSection *StrSection,
2538 const MCSection *OffsetSection = NULL,
2539 const MCSymbol *StrSecSym = NULL) {
Eric Christopher64f824c2012-12-27 02:14:01 +00002540
Eric Christopherb6714222013-01-08 22:22:06 +00002541 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002542
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002543 // Start the dwarf str section.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002544 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling94d04b82009-05-20 23:21:38 +00002545
Chris Lattnerbc733f52010-03-13 02:17:42 +00002546 // Get all of the string pool entries and put them in an array by their ID so
2547 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002548 SmallVector<std::pair<unsigned,
Eric Christopherff348452013-01-07 22:40:45 +00002549 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002550
Chris Lattnerbc733f52010-03-13 02:17:42 +00002551 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
Eric Christopherb6714222013-01-08 22:22:06 +00002552 I = StringPool.begin(), E = StringPool.end();
Eric Christopher72c16552012-12-20 21:58:40 +00002553 I != E; ++I)
Chris Lattnerbc733f52010-03-13 02:17:42 +00002554 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002555
Chris Lattnerbc733f52010-03-13 02:17:42 +00002556 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002557
Chris Lattnerbc733f52010-03-13 02:17:42 +00002558 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002559 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00002560 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002561
Benjamin Kramer983c4572011-11-09 18:16:11 +00002562 // Emit the string itself with a terminating null byte.
Benjamin Kramer0c45f7d2011-11-09 12:12:04 +00002563 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
Eric Christopherca1dd052013-01-09 01:35:34 +00002564 Entries[i].second->getKeyLength()+1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002565 }
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002566
2567 // If we've got an offset section go ahead and emit that now as well.
2568 if (OffsetSection) {
2569 Asm->OutStreamer.SwitchSection(OffsetSection);
2570 unsigned offset = 0;
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002571 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002572 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopher1ced2082013-01-09 03:52:05 +00002573 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002574 offset += Entries[i].second->getKeyLength() + 1;
2575 }
2576 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002577}
2578
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002579// Emit strings into a string section.
2580void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2581
2582 if (AddressPool.empty()) return;
2583
2584 // Start the dwarf addr section.
2585 Asm->OutStreamer.SwitchSection(AddrSection);
2586
David Blaikie66f464e2013-07-08 17:51:28 +00002587 // Order the address pool entries by ID
David Blaikie5ce40912013-07-08 17:33:10 +00002588 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002589
David Blaikie66f464e2013-07-08 17:51:28 +00002590 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2591 E = AddressPool.end();
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002592 I != E; ++I)
David Blaikie5ce40912013-07-08 17:33:10 +00002593 Entries[I->second] = I->first;
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002594
2595 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Ulrich Weigand18dbe502013-07-02 18:46:46 +00002596 // Emit an expression for reference from debug information entries.
David Blaikie5ce40912013-07-08 17:33:10 +00002597 if (const MCExpr *Expr = Entries[i])
Ulrich Weigand18dbe502013-07-02 18:46:46 +00002598 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002599 else
2600 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2601 }
2602
2603}
2604
Eric Christopher64f824c2012-12-27 02:14:01 +00002605// Emit visible names into a debug str section.
2606void DwarfDebug::emitDebugStr() {
2607 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2608 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2609}
2610
Eric Christopherd3b98532013-07-02 21:36:07 +00002611// Emit locations into the debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002612void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00002613 if (DotDebugLocEntries.empty())
2614 return;
2615
Eric Christopherf7cef702013-03-29 23:34:06 +00002616 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Devang Patel6c3ea902011-02-04 22:57:18 +00002617 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2618 I != E; ++I) {
2619 DotDebugLocEntry &Entry = *I;
2620 if (I + 1 != DotDebugLocEntries.end())
2621 Entry.Merge(I+1);
2622 }
2623
Daniel Dunbar83320a02011-03-16 22:16:39 +00002624 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002625 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00002626 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002627 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00002628 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2629 unsigned index = 1;
Eric Christopherf7cef702013-03-29 23:34:06 +00002630 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00002631 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00002632 I != E; ++I, ++index) {
Devang Patel6c3ea902011-02-04 22:57:18 +00002633 DotDebugLocEntry &Entry = *I;
2634 if (Entry.isMerged()) continue;
Devang Patelc3f5f782010-05-25 23:40:22 +00002635 if (Entry.isEmpty()) {
Eric Christopherca1dd052013-01-09 01:35:34 +00002636 Asm->OutStreamer.EmitIntValue(0, Size);
2637 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel80250682010-05-26 23:55:23 +00002638 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00002639 } else {
Eric Christopher0d0782a2013-07-03 22:40:18 +00002640 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2641 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2642 DIVariable DV(Entry.getVariable());
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002643 Asm->OutStreamer.AddComment("Loc expr size");
2644 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2645 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2646 Asm->EmitLabelDifference(end, begin, 2);
2647 Asm->OutStreamer.EmitLabel(begin);
Devang Patel80efd4e2011-07-08 16:49:43 +00002648 if (Entry.isInt()) {
Devang Patelc4329072011-06-01 22:03:25 +00002649 DIBasicType BTy(DV.getType());
2650 if (BTy.Verify() &&
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002651 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patelc4329072011-06-01 22:03:25 +00002652 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2653 Asm->OutStreamer.AddComment("DW_OP_consts");
2654 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Patel80efd4e2011-07-08 16:49:43 +00002655 Asm->EmitSLEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002656 } else {
2657 Asm->OutStreamer.AddComment("DW_OP_constu");
2658 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Patel80efd4e2011-07-08 16:49:43 +00002659 Asm->EmitULEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002660 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002661 } else if (Entry.isLocation()) {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002662 MachineLocation Loc = Entry.getLoc();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002663 if (!DV.hasComplexAddress())
Devang Patel80efd4e2011-07-08 16:49:43 +00002664 // Regular entry.
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002665 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002666 else {
2667 // Complex address entry.
2668 unsigned N = DV.getNumAddrElements();
2669 unsigned i = 0;
2670 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002671 if (Loc.getOffset()) {
Devang Patel80efd4e2011-07-08 16:49:43 +00002672 i = 2;
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002673 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002674 Asm->OutStreamer.AddComment("DW_OP_deref");
2675 Asm->EmitInt8(dwarf::DW_OP_deref);
2676 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2677 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2678 Asm->EmitSLEB128(DV.getAddrElement(1));
2679 } else {
2680 // If first address element is OpPlus then emit
2681 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002682 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2683 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002684 i = 2;
2685 }
2686 } else {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002687 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002688 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002689
Devang Patel80efd4e2011-07-08 16:49:43 +00002690 // Emit remaining complex address elements.
2691 for (; i < N; ++i) {
2692 uint64_t Element = DV.getAddrElement(i);
2693 if (Element == DIBuilder::OpPlus) {
2694 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2695 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher50120762012-05-08 18:56:00 +00002696 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002697 if (!Loc.isReg())
Eric Christopher50120762012-05-08 18:56:00 +00002698 Asm->EmitInt8(dwarf::DW_OP_deref);
2699 } else
2700 llvm_unreachable("unknown Opcode found in complex address");
Devang Patel80efd4e2011-07-08 16:49:43 +00002701 }
Devang Patelc26f5442011-04-28 02:22:40 +00002702 }
Devang Patelc26f5442011-04-28 02:22:40 +00002703 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002704 // else ... ignore constant fp. There is not any good way to
2705 // to represent them here in dwarf.
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002706 Asm->OutStreamer.EmitLabel(end);
Devang Patelc3f5f782010-05-25 23:40:22 +00002707 }
2708 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002709}
2710
Richard Mitton5cc319a2013-09-19 23:21:01 +00002711struct SymbolCUSorter {
2712 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2713 const MCStreamer &Streamer;
2714
2715 bool operator() (const SymbolCU &A, const SymbolCU &B) {
2716 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2717 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2718
2719 // Symbols with no order assigned should be placed at the end.
2720 // (e.g. section end labels)
2721 if (IA == 0)
2722 IA = (unsigned)(-1);
2723 if (IB == 0)
2724 IB = (unsigned)(-1);
2725 return IA < IB;
2726 }
2727};
2728
Richard Mitton5cc319a2013-09-19 23:21:01 +00002729static bool CUSort(const CompileUnit *A, const CompileUnit *B) {
2730 return (A->getUniqueID() < B->getUniqueID());
2731}
2732
2733struct ArangeSpan {
2734 const MCSymbol *Start, *End;
2735};
2736
2737// Emit a debug aranges section, containing a CU lookup for any
2738// address we can tie back to a CU.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002739void DwarfDebug::emitDebugARanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002740 // Start the dwarf aranges section.
Eric Christopherab6cd832013-08-30 00:39:57 +00002741 Asm->OutStreamer
2742 .SwitchSection(Asm->getObjFileLowering().getDwarfARangesSection());
Richard Mitton5cc319a2013-09-19 23:21:01 +00002743
2744 typedef DenseMap<CompileUnit *, std::vector<ArangeSpan> > SpansType;
2745
2746 SpansType Spans;
2747
2748 // Build a list of sections used.
2749 std::vector<const MCSection *> Sections;
2750 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2751 it++) {
2752 const MCSection *Section = it->first;
2753 Sections.push_back(Section);
2754 }
2755
2756 // Sort the sections into order.
2757 // This is only done to ensure consistent output order across different runs.
2758 std::sort(Sections.begin(), Sections.end(), SectionSort);
2759
2760 // Build a set of address spans, sorted by CU.
2761 for (size_t SecIdx=0;SecIdx<Sections.size();SecIdx++) {
2762 const MCSection *Section = Sections[SecIdx];
2763 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2764 if (List.size() < 2)
2765 continue;
2766
2767 // Sort the symbols by offset within the section.
2768 SymbolCUSorter sorter(Asm->OutStreamer);
2769 std::sort(List.begin(), List.end(), sorter);
2770
2771 // If we have no section (e.g. common), just write out
2772 // individual spans for each symbol.
2773 if (Section == NULL) {
2774 for (size_t n = 0; n < List.size(); n++) {
2775 const SymbolCU &Cur = List[n];
2776
2777 ArangeSpan Span;
2778 Span.Start = Cur.Sym;
2779 Span.End = NULL;
2780 if (Cur.CU)
2781 Spans[Cur.CU].push_back(Span);
2782 }
2783 } else {
2784 // Build spans between each label.
2785 const MCSymbol *StartSym = List[0].Sym;
2786 for (size_t n = 1; n < List.size(); n++) {
2787 const SymbolCU &Prev = List[n - 1];
2788 const SymbolCU &Cur = List[n];
2789
2790 // Try and build the longest span we can within the same CU.
2791 if (Cur.CU != Prev.CU) {
2792 ArangeSpan Span;
2793 Span.Start = StartSym;
2794 Span.End = Cur.Sym;
2795 Spans[Prev.CU].push_back(Span);
2796 StartSym = Cur.Sym;
2797 }
2798 }
2799 }
2800 }
2801
2802 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2803 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2804
2805 // Build a list of CUs used.
2806 std::vector<CompileUnit *> CUs;
2807 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
2808 CompileUnit *CU = it->first;
2809 CUs.push_back(CU);
2810 }
2811
2812 // Sort the CU list (again, to ensure consistent output order).
2813 std::sort(CUs.begin(), CUs.end(), CUSort);
2814
2815 // Emit an arange table for each CU we used.
2816 for (size_t CUIdx=0;CUIdx<CUs.size();CUIdx++) {
2817 CompileUnit *CU = CUs[CUIdx];
2818 std::vector<ArangeSpan> &List = Spans[CU];
2819
2820 // Emit size of content not including length itself.
2821 unsigned ContentSize
2822 = sizeof(int16_t) // DWARF ARange version number
2823 + sizeof(int32_t) // Offset of CU in the .debug_info section
2824 + sizeof(int8_t) // Pointer Size (in bytes)
2825 + sizeof(int8_t); // Segment Size (in bytes)
2826
2827 unsigned TupleSize = PtrSize * 2;
2828
2829 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2830 unsigned Padding = 0;
2831 while (((sizeof(int32_t) + ContentSize + Padding) % TupleSize) != 0)
2832 Padding++;
2833
2834 ContentSize += Padding;
2835 ContentSize += (List.size() + 1) * TupleSize;
2836
2837 // For each compile unit, write the list of spans it covers.
2838 Asm->OutStreamer.AddComment("Length of ARange Set");
2839 Asm->EmitInt32(ContentSize);
2840 Asm->OutStreamer.AddComment("DWARF Arange version number");
2841 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2842 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
2843 Asm->EmitSectionOffset(
2844 Asm->GetTempSymbol(ISec->getLabelBeginName(), CU->getUniqueID()),
2845 DwarfInfoSectionSym);
2846 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2847 Asm->EmitInt8(PtrSize);
2848 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2849 Asm->EmitInt8(0);
2850
2851 for (unsigned n = 0; n < Padding; n++)
2852 Asm->EmitInt8(0xff);
2853
2854 for (unsigned n = 0; n < List.size(); n++) {
2855 const ArangeSpan &Span = List[n];
2856 Asm->EmitLabelReference(Span.Start, PtrSize);
2857
2858 // Calculate the size as being from the span start to it's end.
Richard Mittoneb46def2013-09-23 17:56:20 +00002859 if (Span.End) {
Richard Mitton5cc319a2013-09-19 23:21:01 +00002860 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
Richard Mittoneb46def2013-09-23 17:56:20 +00002861 } else {
2862 // For symbols without an end marker (e.g. common), we
2863 // write a single arange entry containing just that one symbol.
2864 uint64_t Size = SymSize[Span.Start];
2865 if (Size == 0)
2866 Size = 1;
2867
2868 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2869 }
Richard Mitton5cc319a2013-09-19 23:21:01 +00002870 }
2871
2872 Asm->OutStreamer.AddComment("ARange terminator");
2873 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2874 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2875 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002876}
2877
Eric Christopherb6dc8652012-11-27 22:43:45 +00002878// Emit visible names into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002879void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002880 // Start the dwarf ranges section.
Eric Christopherab6cd832013-08-30 00:39:57 +00002881 Asm->OutStreamer
2882 .SwitchSection(Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002883 unsigned char Size = Asm->getDataLayout().getPointerSize();
Eric Christopherf7cef702013-03-29 23:34:06 +00002884 for (SmallVectorImpl<const MCSymbol *>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00002885 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00002886 I != E; ++I) {
2887 if (*I)
Eric Christopher1ced2082013-01-09 03:52:05 +00002888 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
Devang Patelf2548ca2010-04-16 23:33:45 +00002889 else
Eric Christopherca1dd052013-01-09 01:35:34 +00002890 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patelf2548ca2010-04-16 23:33:45 +00002891 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002892}
2893
Eric Christopherb6dc8652012-11-27 22:43:45 +00002894// Emit visible names into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002895void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002896 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00002897 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002898 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002899 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002900 }
2901}
2902
Eric Christopher0b944ee2012-12-11 19:42:09 +00002903// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher98e237f2012-11-30 23:59:06 +00002904
2905// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2906// 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 +00002907// DW_AT_ranges_base, DW_AT_addr_base.
Eric Christophera9b2c792013-08-26 23:50:43 +00002908CompileUnit *DwarfDebug::constructSkeletonCU(const CompileUnit *CU) {
Eric Christopher98e237f2012-11-30 23:59:06 +00002909
2910 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christophera9b2c792013-08-26 23:50:43 +00002911 CompileUnit *NewCU = new CompileUnit(CU->getUniqueID(), Die, CU->getNode(),
2912 Asm, this, &SkeletonHolder);
Eric Christopher446b88f2013-01-17 03:00:04 +00002913
Eric Christopher3ce51a92013-02-22 23:50:08 +00002914 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
Eric Christopher30410d52013-08-26 23:57:03 +00002915 DICompileUnit(CU->getNode()).getSplitDebugFilename());
Eric Christopher98e237f2012-11-30 23:59:06 +00002916
Eric Christopher1b0cd2f2013-04-22 07:51:08 +00002917 // Relocate to the beginning of the addr_base section, else 0 for the
2918 // beginning of the one for this compile unit.
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002919 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2920 NewCU->addLabel(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2921 DwarfAddrSectionSym);
2922 else
Eric Christopher1b0cd2f2013-04-22 07:51:08 +00002923 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base,
2924 dwarf::DW_FORM_sec_offset, 0);
Eric Christopher98e237f2012-11-30 23:59:06 +00002925
2926 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002927 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher98e237f2012-11-30 23:59:06 +00002928 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002929
Eric Christopher98e237f2012-11-30 23:59:06 +00002930 // DW_AT_stmt_list is a offset of line number information for this
2931 // compile unit in debug_line section.
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002932 // FIXME: Should handle multiple compile units.
Eric Christopher98e237f2012-11-30 23:59:06 +00002933 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher446b88f2013-01-17 03:00:04 +00002934 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher7a0103c2013-02-07 21:19:50 +00002935 DwarfLineSectionSym);
Eric Christopher98e237f2012-11-30 23:59:06 +00002936 else
Eric Christopher446b88f2013-01-17 03:00:04 +00002937 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher98e237f2012-11-30 23:59:06 +00002938
2939 if (!CompilationDir.empty())
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002940 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher98e237f2012-11-30 23:59:06 +00002941
Eric Christopher08bd9232013-10-01 00:43:31 +00002942 // Flags to let the linker know we have emitted new style pubnames.
Eric Christophera6d84152013-09-30 23:14:16 +00002943 if (GenerateGnuPubSections) {
2944 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2945 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_sec_offset,
2946 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()));
2947 else
2948 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
2949 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()),
2950 DwarfGnuPubNamesSectionSym);
2951
2952 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2953 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_sec_offset,
2954 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()));
2955 else
2956 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopher7c9fc902013-10-03 17:41:16 +00002957 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()),
Eric Christophera6d84152013-09-30 23:14:16 +00002958 DwarfGnuPubTypesSectionSym);
2959 }
Eric Christopher8f1a9292013-09-13 00:35:05 +00002960
Eric Christopher451c71d2013-10-01 00:43:36 +00002961 // Flag if we've emitted any ranges and their location for the compile unit.
2962 if (DebugRangeSymbols.size()) {
2963 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2964 NewCU->addLabel(Die, dwarf::DW_AT_GNU_ranges_base,
2965 dwarf::DW_FORM_sec_offset, DwarfDebugRangeSectionSym);
2966 else
2967 NewCU->addUInt(Die, dwarf::DW_AT_GNU_ranges_base, dwarf::DW_FORM_data4,
2968 0);
2969 }
2970
Eric Christopher0e3e9b72012-12-10 23:34:43 +00002971 SkeletonHolder.addUnit(NewCU);
Eric Christopher01776a52013-02-06 21:53:56 +00002972 SkeletonCUs.push_back(NewCU);
Eric Christopher0e3e9b72012-12-10 23:34:43 +00002973
Eric Christopher98e237f2012-11-30 23:59:06 +00002974 return NewCU;
2975}
2976
Eric Christopher6eebe472012-12-19 22:02:53 +00002977void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
2978 assert(useSplitDwarf() && "No split dwarf debug info?");
2979 emitAbbrevs(Section, &SkeletonAbbrevs);
Eric Christopher98e237f2012-11-30 23:59:06 +00002980}
2981
Eric Christopher0b944ee2012-12-11 19:42:09 +00002982// Emit the .debug_info.dwo section for separated dwarf. This contains the
2983// compile units that would normally be in debug_info.
Eric Christopher98e237f2012-11-30 23:59:06 +00002984void DwarfDebug::emitDebugInfoDWO() {
Eric Christopher4daaed12012-12-10 19:51:21 +00002985 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christopherb1e66d02012-12-15 00:04:07 +00002986 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
Eric Christopher6eebe472012-12-19 22:02:53 +00002987 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2988 DwarfAbbrevDWOSectionSym);
2989}
2990
2991// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2992// abbreviations for the .debug_info.dwo section.
2993void DwarfDebug::emitDebugAbbrevDWO() {
2994 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopher72c16552012-12-20 21:58:40 +00002995 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2996 &Abbreviations);
Eric Christopher98e237f2012-11-30 23:59:06 +00002997}
Eric Christopher64f824c2012-12-27 02:14:01 +00002998
2999// Emit the .debug_str.dwo section for separated dwarf. This contains the
3000// string section and is identical in format to traditional .debug_str
3001// sections.
3002void DwarfDebug::emitDebugStrDWO() {
3003 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherff348452013-01-07 22:40:45 +00003004 const MCSection *OffSec = Asm->getObjFileLowering()
3005 .getDwarfStrOffDWOSection();
Eric Christopherdd8e9f32013-01-07 19:32:41 +00003006 const MCSymbol *StrSym = DwarfStrSectionSym;
3007 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
3008 OffSec, StrSym);
Eric Christopher64f824c2012-12-27 02:14:01 +00003009}