blob: 254ecd256d759af83de5b7f1d6076672b7402765 [file] [log] [blame]
Bill Wendling0310d762009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Chris Lattner6cde3e62010-03-09 00:39:24 +000013
Devang Patele4b27562009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling0310d762009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner74e41f92010-04-05 05:24:55 +000016#include "DIE.h"
Eric Christopher09ac3d82011-11-07 09:24:32 +000017#include "DwarfAccelTable.h"
Devang Patel8b9df622011-04-12 17:40:32 +000018#include "DwarfCompileUnit.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000019#include "llvm/ADT/STLExtras.h"
20#include "llvm/ADT/Statistic.h"
21#include "llvm/ADT/StringExtras.h"
22#include "llvm/ADT/Triple.h"
David Greeneb2c66fc2009-08-19 21:52:55 +000023#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling0310d762009-05-15 09:23:25 +000024#include "llvm/CodeGen/MachineModuleInfo.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000025#include "llvm/DIBuilder.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000026#include "llvm/DebugInfo.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000027#include "llvm/IR/Constants.h"
28#include "llvm/IR/DataLayout.h"
29#include "llvm/IR/Instructions.h"
30#include "llvm/IR/Module.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000031#include "llvm/MC/MCAsmInfo.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000032#include "llvm/MC/MCSection.h"
Chris Lattner6c2f9e12009-08-19 05:49:37 +000033#include "llvm/MC/MCStreamer.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000034#include "llvm/MC/MCSymbol.h"
Devang Pateleac9c072010-04-27 19:46:33 +000035#include "llvm/Support/CommandLine.h"
Daniel Dunbar6e4bdfc2009-10-13 06:47:08 +000036#include "llvm/Support/Debug.h"
37#include "llvm/Support/ErrorHandling.h"
Chris Lattner0ad9c912010-01-22 22:09:00 +000038#include "llvm/Support/FormattedStream.h"
Michael J. Spencer1f6efa32010-11-29 18:16:10 +000039#include "llvm/Support/Path.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000040#include "llvm/Support/Timer.h"
41#include "llvm/Support/ValueHandle.h"
42#include "llvm/Target/TargetFrameLowering.h"
43#include "llvm/Target/TargetLoweringObjectFile.h"
44#include "llvm/Target/TargetMachine.h"
45#include "llvm/Target/TargetOptions.h"
46#include "llvm/Target/TargetRegisterInfo.h"
Bill Wendling0310d762009-05-15 09:23:25 +000047using namespace llvm;
48
Jim Grosbach1e20b962010-07-21 21:21:52 +000049static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel61409622010-07-07 20:12:52 +000050 cl::Hidden,
Devang Pateleac9c072010-04-27 19:46:33 +000051 cl::desc("Disable debug info printing"));
52
Dan Gohman281d65d2010-05-07 01:08:53 +000053static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
Chris Lattner7a2bdde2011-04-15 05:18:47 +000054 cl::desc("Make an absence of debug location information explicit."),
Dan Gohman281d65d2010-05-07 01:08:53 +000055 cl::init(false));
56
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +000057static cl::opt<bool> GenerateDwarfPubNamesSection("generate-dwarf-pubnames",
Eric Christopher3dcb5382013-04-03 05:26:07 +000058 cl::Hidden, cl::init(false),
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +000059 cl::desc("Generate DWARF pubnames section"));
60
Eric Christopher20f47ab2012-08-23 22:36:40 +000061namespace {
62 enum DefaultOnOff {
63 Default, Enable, Disable
64 };
65}
Eric Christopher09ac3d82011-11-07 09:24:32 +000066
Eric Christopher20f47ab2012-08-23 22:36:40 +000067static cl::opt<DefaultOnOff> DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
68 cl::desc("Output prototype dwarf accelerator tables."),
69 cl::values(
70 clEnumVal(Default, "Default for platform"),
71 clEnumVal(Enable, "Enabled"),
72 clEnumVal(Disable, "Disabled"),
73 clEnumValEnd),
74 cl::init(Default));
75
76static cl::opt<DefaultOnOff> DarwinGDBCompat("darwin-gdb-compat", cl::Hidden,
Eric Christopher10cb7442012-08-23 07:10:46 +000077 cl::desc("Compatibility with Darwin gdb."),
Eric Christopher20f47ab2012-08-23 22:36:40 +000078 cl::values(
79 clEnumVal(Default, "Default for platform"),
80 clEnumVal(Enable, "Enabled"),
81 clEnumVal(Disable, "Disabled"),
82 clEnumValEnd),
83 cl::init(Default));
Eric Christopher10cb7442012-08-23 07:10:46 +000084
Eric Christopher4daaed12012-12-10 19:51:21 +000085static cl::opt<DefaultOnOff> SplitDwarf("split-dwarf", cl::Hidden,
86 cl::desc("Output prototype dwarf split debug info."),
Eric Christopherf5b6dcd2012-11-12 22:22:20 +000087 cl::values(
88 clEnumVal(Default, "Default for platform"),
89 clEnumVal(Enable, "Enabled"),
90 clEnumVal(Disable, "Disabled"),
91 clEnumValEnd),
92 cl::init(Default));
93
Bill Wendling5f017e82010-04-07 09:28:04 +000094namespace {
Craig Topper4172a8a2013-07-16 01:17:10 +000095 const char *const DWARFGroupName = "DWARF Emission";
96 const char *const DbgTimerName = "DWARF Debug Writer";
David Blaikied2e0f7e2013-05-06 23:33:07 +000097
98 struct CompareFirst {
99 template <typename T> bool operator()(const T &lhs, const T &rhs) const {
100 return lhs.first < rhs.first;
101 }
102 };
Bill Wendling5f017e82010-04-07 09:28:04 +0000103} // end anonymous namespace
104
Bill Wendling0310d762009-05-15 09:23:25 +0000105//===----------------------------------------------------------------------===//
106
Eric Christopherb6dc8652012-11-27 22:43:45 +0000107// Configuration values for initial hash set sizes (log2).
108//
Bill Wendling0310d762009-05-15 09:23:25 +0000109static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling0310d762009-05-15 09:23:25 +0000110
111namespace llvm {
112
Nick Lewycky3bbb6f72011-07-29 03:49:23 +0000113DIType DbgVariable::getType() const {
Devang Patel3cbee302011-04-12 22:53:02 +0000114 DIType Ty = Var.getType();
115 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
116 // addresses instead.
117 if (Var.isBlockByrefVariable()) {
118 /* Byref variables, in Blocks, are declared by the programmer as
119 "SomeType VarName;", but the compiler creates a
120 __Block_byref_x_VarName struct, and gives the variable VarName
121 either the struct, or a pointer to the struct, as its type. This
122 is necessary for various behind-the-scenes things the compiler
123 needs to do with by-reference variables in blocks.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000124
Devang Patel3cbee302011-04-12 22:53:02 +0000125 However, as far as the original *programmer* is concerned, the
126 variable should still have type 'SomeType', as originally declared.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000127
Devang Patel3cbee302011-04-12 22:53:02 +0000128 The following function dives into the __Block_byref_x_VarName
129 struct to find the original type of the variable. This will be
130 passed back to the code generating the type for the Debug
131 Information Entry for the variable 'VarName'. 'VarName' will then
132 have the original type 'SomeType' in its debug information.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000133
Devang Patel3cbee302011-04-12 22:53:02 +0000134 The original type 'SomeType' will be the type of the field named
135 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000136
Devang Patel3cbee302011-04-12 22:53:02 +0000137 NOTE: In order for this to not completely fail on the debugger
138 side, the Debug Information Entry for the variable VarName needs to
139 have a DW_AT_location that tells the debugger how to unwind through
140 the pointers and __Block_byref_x_VarName struct to find the actual
141 value of the variable. The function addBlockByrefType does this. */
142 DIType subType = Ty;
143 unsigned tag = Ty.getTag();
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000144
Devang Patel3cbee302011-04-12 22:53:02 +0000145 if (tag == dwarf::DW_TAG_pointer_type) {
146 DIDerivedType DTy = DIDerivedType(Ty);
147 subType = DTy.getTypeDerivedFrom();
148 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000149
Devang Patel3cbee302011-04-12 22:53:02 +0000150 DICompositeType blockStruct = DICompositeType(subType);
151 DIArray Elements = blockStruct.getTypeArray();
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000152
Devang Patel3cbee302011-04-12 22:53:02 +0000153 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
154 DIDescriptor Element = Elements.getElement(i);
155 DIDerivedType DT = DIDerivedType(Element);
156 if (getName() == DT.getName())
157 return (DT.getTypeDerivedFrom());
Devang Patel8bd11de2010-08-09 21:01:39 +0000158 }
Devang Patel8bd11de2010-08-09 21:01:39 +0000159 }
Devang Patel3cbee302011-04-12 22:53:02 +0000160 return Ty;
161}
Bill Wendling0310d762009-05-15 09:23:25 +0000162
Chris Lattnerea761862010-04-05 04:09:20 +0000163} // end llvm namespace
Bill Wendling0310d762009-05-15 09:23:25 +0000164
Manman Ren0e6783f2013-07-02 23:40:10 +0000165/// Return Dwarf Version by checking module flags.
166static unsigned getDwarfVersionFromModule(const Module *M) {
Manman Renc8cfaa12013-07-16 23:21:16 +0000167 Value *Val = M->getModuleFlag("Dwarf Version");
168 if (!Val)
169 return dwarf::DWARF_VERSION;
170 return cast<ConstantInt>(Val)->getZExtValue();
Manman Ren0e6783f2013-07-02 23:40:10 +0000171}
172
Chris Lattner49cd6642010-04-05 05:11:15 +0000173DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Eric Christopher28bd25a2012-12-10 19:51:13 +0000174 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbach1e20b962010-07-21 21:21:52 +0000175 AbbreviationsSet(InitAbbreviationsSetSize),
Eric Christopherb6714222013-01-08 22:22:06 +0000176 SourceIdMap(DIEValueAllocator),
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000177 PrevLabel(NULL), GlobalCUIndexCount(0),
Eric Christopherb6714222013-01-08 22:22:06 +0000178 InfoHolder(A, &AbbreviationsSet, &Abbreviations, "info_string",
179 DIEValueAllocator),
Eric Christopher6eebe472012-12-19 22:02:53 +0000180 SkeletonAbbrevSet(InitAbbreviationsSetSize),
Eric Christopherb6714222013-01-08 22:22:06 +0000181 SkeletonHolder(A, &SkeletonAbbrevSet, &SkeletonAbbrevs, "skel_string",
182 DIEValueAllocator) {
Jim Grosbach1e20b962010-07-21 21:21:52 +0000183
Rafael Espindolaf2b04232011-05-06 14:56:22 +0000184 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattner4ad1efe2010-04-04 23:10:38 +0000185 DwarfStrSectionSym = TextSectionSym = 0;
Eric Christopher7a0103c2013-02-07 21:19:50 +0000186 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
Eric Christopher9a9e73b2013-04-07 03:43:09 +0000187 DwarfAddrSectionSym = 0;
Eric Christopher64f824c2012-12-27 02:14:01 +0000188 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
Devang Patelc3f5f782010-05-25 23:40:22 +0000189 FunctionBeginSym = FunctionEndSym = 0;
Eric Christopher60777d82012-04-02 17:58:52 +0000190
Eric Christopher10cb7442012-08-23 07:10:46 +0000191 // Turn on accelerator tables and older gdb compatibility
192 // for Darwin.
Eric Christopher00297ba2013-04-27 01:07:52 +0000193 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
Eric Christopher20f47ab2012-08-23 22:36:40 +0000194 if (DarwinGDBCompat == Default) {
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000195 if (IsDarwin)
196 IsDarwinGDBCompat = true;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000197 else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000198 IsDarwinGDBCompat = false;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000199 } else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000200 IsDarwinGDBCompat = DarwinGDBCompat == Enable ? true : false;
Eric Christopherc1610fa2012-08-23 22:36:36 +0000201
Eric Christopher20f47ab2012-08-23 22:36:40 +0000202 if (DwarfAccelTables == Default) {
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000203 if (IsDarwin)
204 HasDwarfAccelTables = true;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000205 else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000206 HasDwarfAccelTables = false;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000207 } else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000208 HasDwarfAccelTables = DwarfAccelTables == Enable ? true : false;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000209
Eric Christopher4daaed12012-12-10 19:51:21 +0000210 if (SplitDwarf == Default)
211 HasSplitDwarf = false;
Eric Christopherf5b6dcd2012-11-12 22:22:20 +0000212 else
Eric Christopher4daaed12012-12-10 19:51:21 +0000213 HasSplitDwarf = SplitDwarf == Enable ? true : false;
Eric Christopherf5b6dcd2012-11-12 22:22:20 +0000214
Manman Ren0e6783f2013-07-02 23:40:10 +0000215 DwarfVersion = getDwarfVersionFromModule(MMI->getModule());
216
Dan Gohman03c3dc72010-06-18 15:56:31 +0000217 {
218 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopherc4639d62012-11-19 22:42:15 +0000219 beginModule();
Torok Edwin9c421072010-04-07 10:44:46 +0000220 }
Bill Wendling0310d762009-05-15 09:23:25 +0000221}
222DwarfDebug::~DwarfDebug() {
Bill Wendling0310d762009-05-15 09:23:25 +0000223}
224
Eric Christopherb6dc8652012-11-27 22:43:45 +0000225// Switch to the specified MCSection and emit an assembler
226// temporary label to it if SymbolStem is specified.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000227static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christopherd8a87522011-11-07 09:18:38 +0000228 const char *SymbolStem = 0) {
229 Asm->OutStreamer.SwitchSection(Section);
230 if (!SymbolStem) return 0;
231
232 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
233 Asm->OutStreamer.EmitLabel(TmpSym);
234 return TmpSym;
235}
236
Eric Christopher2e5d8702012-12-20 21:58:36 +0000237MCSymbol *DwarfUnits::getStringPoolSym() {
Eric Christopher64f824c2012-12-27 02:14:01 +0000238 return Asm->GetTempSymbol(StringPref);
Nick Lewycky390c40d2011-10-27 06:44:11 +0000239}
240
Eric Christopher2e5d8702012-12-20 21:58:36 +0000241MCSymbol *DwarfUnits::getStringPoolEntry(StringRef Str) {
242 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopherb6714222013-01-08 22:22:06 +0000243 StringPool.GetOrCreateValue(Str).getValue();
Chris Lattnerbc733f52010-03-13 02:17:42 +0000244 if (Entry.first) return Entry.first;
245
246 Entry.second = NextStringPoolNumber++;
Eric Christopher64f824c2012-12-27 02:14:01 +0000247 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
Chris Lattnerbc733f52010-03-13 02:17:42 +0000248}
249
Eric Christopherdd8e9f32013-01-07 19:32:41 +0000250unsigned DwarfUnits::getStringPoolIndex(StringRef Str) {
251 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopherb6714222013-01-08 22:22:06 +0000252 StringPool.GetOrCreateValue(Str).getValue();
Eric Christopherdd8e9f32013-01-07 19:32:41 +0000253 if (Entry.first) return Entry.second;
254
255 Entry.second = NextStringPoolNumber++;
256 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
257 return Entry.second;
258}
259
David Blaikie321d83b2013-06-28 18:47:14 +0000260unsigned DwarfUnits::getAddrPoolIndex(const MCSymbol *Sym) {
David Blaikie8fed05e2013-07-01 23:55:52 +0000261 return getAddrPoolIndex(MCSymbolRefExpr::Create(Sym, Asm->OutContext));
262}
263
Ulrich Weigand18dbe502013-07-02 18:46:46 +0000264unsigned DwarfUnits::getAddrPoolIndex(const MCExpr *Sym) {
265 std::pair<DenseMap<const MCExpr *, unsigned>::iterator, bool> P =
David Blaikie1c736322013-06-28 18:47:19 +0000266 AddressPool.insert(std::make_pair(Sym, NextAddrPoolNumber));
David Blaikie1ca79902013-06-28 18:55:13 +0000267 if (P.second)
268 ++NextAddrPoolNumber;
David Blaikie1c736322013-06-28 18:47:19 +0000269 return P.first->second;
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000270}
271
Eric Christopherb6dc8652012-11-27 22:43:45 +0000272// Define a unique number for the abbreviation.
273//
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000274void DwarfUnits::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling0310d762009-05-15 09:23:25 +0000275 // Check the set for priors.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000276 DIEAbbrev *InSet = AbbreviationsSet->GetOrInsertNode(&Abbrev);
Bill Wendling0310d762009-05-15 09:23:25 +0000277
278 // If it's newly added.
279 if (InSet == &Abbrev) {
280 // Add to abbreviation list.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000281 Abbreviations->push_back(&Abbrev);
Bill Wendling0310d762009-05-15 09:23:25 +0000282
283 // Assign the vector position + 1 as its number.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000284 Abbrev.setNumber(Abbreviations->size());
Bill Wendling0310d762009-05-15 09:23:25 +0000285 } else {
286 // Assign existing abbreviation number.
287 Abbrev.setNumber(InSet->getNumber());
288 }
289}
290
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000291static bool isObjCClass(StringRef Name) {
292 return Name.startswith("+") || Name.startswith("-");
293}
294
295static bool hasObjCCategory(StringRef Name) {
296 if (!isObjCClass(Name)) return false;
297
298 size_t pos = Name.find(')');
299 if (pos != std::string::npos) {
300 if (Name[pos+1] != ' ') return false;
301 return true;
302 }
303 return false;
304}
305
306static void getObjCClassCategory(StringRef In, StringRef &Class,
307 StringRef &Category) {
308 if (!hasObjCCategory(In)) {
309 Class = In.slice(In.find('[') + 1, In.find(' '));
310 Category = "";
311 return;
312 }
313
314 Class = In.slice(In.find('[') + 1, In.find('('));
315 Category = In.slice(In.find('[') + 1, In.find(' '));
316 return;
317}
318
319static StringRef getObjCMethodName(StringRef In) {
320 return In.slice(In.find(' ') + 1, In.find(']'));
321}
322
323// Add the various names to the Dwarf accelerator table names.
324static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
325 DIE* Die) {
326 if (!SP.isDefinition()) return;
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000327
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000328 TheCU->addAccelName(SP.getName(), Die);
329
330 // If the linkage name is different than the name, go ahead and output
331 // that as well into the name table.
332 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
333 TheCU->addAccelName(SP.getLinkageName(), Die);
334
335 // If this is an Objective-C selector name add it to the ObjC accelerator
336 // too.
337 if (isObjCClass(SP.getName())) {
338 StringRef Class, Category;
339 getObjCClassCategory(SP.getName(), Class, Category);
340 TheCU->addAccelObjC(Class, Die);
341 if (Category != "")
342 TheCU->addAccelObjC(Category, Die);
343 // Also add the base method name to the name table.
344 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
345 }
346}
347
Eric Christopherb6dc8652012-11-27 22:43:45 +0000348// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
349// and DW_AT_high_pc attributes. If there are global variables in this
350// scope then create and insert DIEs for these variables.
Devang Pateld3024342011-08-15 22:24:32 +0000351DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
352 const MDNode *SPNode) {
Devang Patel163a9f72010-05-10 22:49:55 +0000353 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patel8aa61472010-07-07 22:20:57 +0000354
Chris Lattnerd38fee82010-04-05 00:13:49 +0000355 assert(SPDie && "Unable to find subprogram DIE!");
356 DISubprogram SP(SPNode);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000357
Bill Wendling168c1902012-11-07 05:19:04 +0000358 // If we're updating an abstract DIE, then we will be adding the children and
359 // object pointer later on. But what we don't want to do is process the
360 // concrete DIE twice.
Manman Renbc3e96f2013-03-12 18:27:15 +0000361 DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode);
362 if (AbsSPDIE) {
363 bool InSameCU = (AbsSPDIE->getCompileUnit() == SPCU->getCUDie());
Bill Wendling168c1902012-11-07 05:19:04 +0000364 // Pick up abstract subprogram DIE.
Devang Patel8aa61472010-07-07 22:20:57 +0000365 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Manman Renbc3e96f2013-03-12 18:27:15 +0000366 // If AbsSPDIE belongs to a different CU, use DW_FORM_ref_addr instead of
367 // DW_FORM_ref4.
Devang Patel3cbee302011-04-12 22:53:02 +0000368 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
Manman Renbc3e96f2013-03-12 18:27:15 +0000369 InSameCU ? dwarf::DW_FORM_ref4 : dwarf::DW_FORM_ref_addr,
370 AbsSPDIE);
Devang Patel8aa61472010-07-07 22:20:57 +0000371 SPCU->addDie(SPDie);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000372 } else {
373 DISubprogram SPDecl = SP.getFunctionDeclaration();
374 if (!SPDecl.isSubprogram()) {
375 // There is not any need to generate specification DIE for a function
376 // defined at compile unit level. If a function is defined inside another
377 // function then gdb prefers the definition at top level and but does not
378 // expect specification DIE in parent function. So avoid creating
379 // specification DIE for a function defined inside a function.
380 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
381 !SP.getContext().isFile() &&
382 !isSubprogramContext(SP.getContext())) {
383 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
384
385 // Add arguments.
386 DICompositeType SPTy = SP.getType();
387 DIArray Args = SPTy.getTypeArray();
388 unsigned SPTag = SPTy.getTag();
389 if (SPTag == dwarf::DW_TAG_subroutine_type)
390 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
391 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
392 DIType ATy = DIType(Args.getElement(i));
393 SPCU->addType(Arg, ATy);
394 if (ATy.isArtificial())
395 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
396 if (ATy.isObjectPointer())
397 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer,
398 dwarf::DW_FORM_ref4, Arg);
399 SPDie->addChild(Arg);
400 }
401 DIE *SPDeclDie = SPDie;
402 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000403 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification,
404 dwarf::DW_FORM_ref4, SPDeclDie);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000405 SPCU->addDie(SPDie);
406 }
407 }
Devang Patel8aa61472010-07-07 22:20:57 +0000408 }
409
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000410 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc,
411 Asm->GetTempSymbol("func_begin",
412 Asm->getFunctionNumber()));
413 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
414 Asm->GetTempSymbol("func_end",
415 Asm->getFunctionNumber()));
Chris Lattnerd38fee82010-04-05 00:13:49 +0000416 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
417 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patel3cbee302011-04-12 22:53:02 +0000418 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +0000419
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000420 // Add name to the name table, we do this here because we're guaranteed
421 // to have concrete versions of our DW_TAG_subprogram nodes.
422 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000423
Chris Lattnerd38fee82010-04-05 00:13:49 +0000424 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +0000425}
426
Eric Christopherb6dc8652012-11-27 22:43:45 +0000427// Construct new DW_TAG_lexical_block for this scope and attach
428// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000429DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld3024342011-08-15 22:24:32 +0000430 LexicalScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +0000431 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
432 if (Scope->isAbstractScope())
433 return ScopeDIE;
434
Craig Topper9f43ac62013-07-03 04:24:43 +0000435 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Devang Pateleac9c072010-04-27 19:46:33 +0000436 if (Ranges.empty())
437 return 0;
438
Eric Christopherf53d6432013-07-03 01:57:28 +0000439 // If we have multiple ranges, emit them into the range section.
Devang Pateleac9c072010-04-27 19:46:33 +0000440 if (Ranges.size() > 1) {
441 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbach1e20b962010-07-21 21:21:52 +0000442 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Pateleac9c072010-04-27 19:46:33 +0000443 // DW_AT_ranges appropriately.
Devang Patel3cbee302011-04-12 22:53:02 +0000444 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000445 DebugRangeSymbols.size()
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000446 * Asm->getDataLayout().getPointerSize());
Craig Topper2d785db2013-07-03 04:17:25 +0000447 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +0000448 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +0000449 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
450 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +0000451 }
Eric Christopherda965de2013-07-03 01:22:29 +0000452
453 // Terminate the range list.
Devang Pateleac9c072010-04-27 19:46:33 +0000454 DebugRangeSymbols.push_back(NULL);
455 DebugRangeSymbols.push_back(NULL);
456 return ScopeDIE;
457 }
458
Eric Christopherf53d6432013-07-03 01:57:28 +0000459 // Construct the address range for this DIE.
Craig Topper2d785db2013-07-03 04:17:25 +0000460 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000461 MCSymbol *Start = getLabelBeforeInsn(RI->first);
462 MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +0000463
Devang Patelc3f5f782010-05-25 23:40:22 +0000464 if (End == 0) return 0;
Devang Patel53bb5c92009-11-10 23:06:00 +0000465
Chris Lattnerb7db7332010-03-09 01:58:53 +0000466 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
467 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbach1e20b962010-07-21 21:21:52 +0000468
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000469 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
470 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patel53bb5c92009-11-10 23:06:00 +0000471
472 return ScopeDIE;
473}
474
Eric Christopherb6dc8652012-11-27 22:43:45 +0000475// This scope represents inlined body of a function. Construct DIE to
476// represent this concrete inlined copy of the function.
Devang Pateld3024342011-08-15 22:24:32 +0000477DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
478 LexicalScope *Scope) {
Craig Topper9f43ac62013-07-03 04:24:43 +0000479 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Nick Lewycky746cb672011-10-26 22:55:33 +0000480 assert(Ranges.empty() == false &&
481 "LexicalScope does not have instruction markers!");
Devang Pateleac9c072010-04-27 19:46:33 +0000482
Devang Patel26a92002011-07-27 00:34:13 +0000483 if (!Scope->getScopeNode())
484 return NULL;
485 DIScope DS(Scope->getScopeNode());
486 DISubprogram InlinedSP = getDISubprogram(DS);
Manman Ren742671b2013-05-29 17:16:59 +0000487 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patel26a92002011-07-27 00:34:13 +0000488 if (!OriginDIE) {
Bill Wendlinge0aae5b2012-10-30 17:51:02 +0000489 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patel26a92002011-07-27 00:34:13 +0000490 return NULL;
491 }
492
Devang Pateld96efb82011-05-05 17:54:26 +0000493 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Devang Patel3cbee302011-04-12 22:53:02 +0000494 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Manman Ren742671b2013-05-29 17:16:59 +0000495 dwarf::DW_FORM_ref4, OriginDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +0000496
Devang Patel26a92002011-07-27 00:34:13 +0000497 if (Ranges.size() > 1) {
498 // .debug_range section has not been laid out yet. Emit offset in
499 // .debug_range as a uint, size 4, for now. emitDIE will handle
500 // DW_AT_ranges appropriately.
501 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000502 DebugRangeSymbols.size()
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000503 * Asm->getDataLayout().getPointerSize());
Craig Topper2d785db2013-07-03 04:17:25 +0000504 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel26a92002011-07-27 00:34:13 +0000505 RE = Ranges.end(); RI != RE; ++RI) {
506 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
507 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
508 }
509 DebugRangeSymbols.push_back(NULL);
510 DebugRangeSymbols.push_back(NULL);
511 } else {
Craig Topper2d785db2013-07-03 04:17:25 +0000512 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christophere7177132013-07-03 02:23:53 +0000513 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
514 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
515
516 if (StartLabel == 0 || EndLabel == 0)
517 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
518
519 assert(StartLabel->isDefined() &&
520 "Invalid starting label for an inlined scope!");
521 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
522
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000523 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
524 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patel26a92002011-07-27 00:34:13 +0000525 }
Devang Patel53bb5c92009-11-10 23:06:00 +0000526
527 InlinedSubprogramDIEs.insert(OriginDIE);
528
Eric Christophere7177132013-07-03 02:23:53 +0000529 // Add the call site information to the DIE.
Devang Patel53bb5c92009-11-10 23:06:00 +0000530 DILocation DL(Scope->getInlinedAt());
Eric Christopher08212002012-03-26 21:38:38 +0000531 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0,
Manman Ren3de61b42013-03-07 01:42:00 +0000532 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
533 TheCU->getUniqueID()));
Devang Patel3cbee302011-04-12 22:53:02 +0000534 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +0000535
Eric Christophere7177132013-07-03 02:23:53 +0000536 // Track the start label for this inlined function.
537 //.debug_inlined section specification does not clearly state how
538 // to emit inlined scopes that are split into multiple instruction ranges.
539 // For now, use the first instruction range and emit low_pc/high_pc pair and
540 // corresponding the .debug_inlined section entry for this pair.
541 if (Asm->MAI->doesDwarfUseInlineInfoSection()) {
542 MCSymbol *StartLabel = getLabelBeforeInsn(Ranges.begin()->first);
Craig Topper01eb99a2013-07-03 04:40:27 +0000543 InlineInfoMap::iterator I = InlineInfo.find(InlinedSP);
Eric Christophere7177132013-07-03 02:23:53 +0000544
545 if (I == InlineInfo.end()) {
546 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel, ScopeDIE));
547 InlinedSPNodes.push_back(InlinedSP);
548 } else
549 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
550 }
551
Eric Christopher309bedd2011-12-04 06:02:38 +0000552 // Add name to the name table, we do this here because we're guaranteed
553 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
554 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000555
Devang Patel53bb5c92009-11-10 23:06:00 +0000556 return ScopeDIE;
557}
558
Eric Christopherb6dc8652012-11-27 22:43:45 +0000559// Construct a DIE for this scope.
Devang Pateld0b5a5e2011-08-15 22:04:40 +0000560DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
Devang Patel3c91b052010-03-08 20:52:55 +0000561 if (!Scope || !Scope->getScopeNode())
562 return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000563
Manman Ren8b15d742013-01-31 20:05:14 +0000564 DIScope DS(Scope->getScopeNode());
565 // Early return to avoid creating dangling variable|scope DIEs.
Manman Ren742671b2013-05-29 17:16:59 +0000566 if (!Scope->getInlinedAt() && DS.isSubprogram() && Scope->isAbstractScope() &&
567 !TheCU->getDIE(DS))
568 return NULL;
Manman Ren8b15d742013-01-31 20:05:14 +0000569
Nick Lewycky746cb672011-10-26 22:55:33 +0000570 SmallVector<DIE *, 8> Children;
Eric Christophere5212782012-09-12 23:36:19 +0000571 DIE *ObjectPointer = NULL;
Devang Patel0478c152011-03-01 22:58:55 +0000572
573 // Collect arguments for current function.
Devang Patelbf47fdb2011-08-10 20:55:27 +0000574 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +0000575 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
576 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000577 if (DIE *Arg =
Eric Christophere5212782012-09-12 23:36:19 +0000578 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel0478c152011-03-01 22:58:55 +0000579 Children.push_back(Arg);
Eric Christophere5212782012-09-12 23:36:19 +0000580 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
581 }
Devang Patel0478c152011-03-01 22:58:55 +0000582
Eric Christopher1aeb7ac2011-10-03 15:49:16 +0000583 // Collect lexical scope children first.
Craig Topper9f43ac62013-07-03 04:24:43 +0000584 const SmallVectorImpl<DbgVariable *> &Variables =ScopeVariables.lookup(Scope);
Devang Patel5bc9fec2011-02-19 01:31:27 +0000585 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000586 if (DIE *Variable =
Eric Christopher7b451cf2012-09-21 22:18:52 +0000587 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5bc9fec2011-02-19 01:31:27 +0000588 Children.push_back(Variable);
Eric Christopher7b451cf2012-09-21 22:18:52 +0000589 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
590 }
Craig Topper9f43ac62013-07-03 04:24:43 +0000591 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5bc9fec2011-02-19 01:31:27 +0000592 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Pateld0b5a5e2011-08-15 22:04:40 +0000593 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5bc9fec2011-02-19 01:31:27 +0000594 Children.push_back(Nested);
Devang Patel3c91b052010-03-08 20:52:55 +0000595 DIE *ScopeDIE = NULL;
596 if (Scope->getInlinedAt())
Devang Pateld3024342011-08-15 22:24:32 +0000597 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3c91b052010-03-08 20:52:55 +0000598 else if (DS.isSubprogram()) {
Devang Patel0dd45582010-06-28 20:53:04 +0000599 ProcessedSPNodes.insert(DS);
Devang Patel8aa61472010-07-07 22:20:57 +0000600 if (Scope->isAbstractScope()) {
Manman Ren742671b2013-05-29 17:16:59 +0000601 ScopeDIE = TheCU->getDIE(DS);
Devang Patel8aa61472010-07-07 22:20:57 +0000602 // Note down abstract DIE.
603 if (ScopeDIE)
604 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
605 }
Devang Patel3c91b052010-03-08 20:52:55 +0000606 else
Devang Pateld3024342011-08-15 22:24:32 +0000607 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3c91b052010-03-08 20:52:55 +0000608 }
Devang Patel5bc9fec2011-02-19 01:31:27 +0000609 else {
610 // There is no need to emit empty lexical block DIE.
David Blaikied2e0f7e2013-05-06 23:33:07 +0000611 std::pair<ImportedEntityMap::const_iterator,
612 ImportedEntityMap::const_iterator> Range = std::equal_range(
613 ScopesWithImportedEntities.begin(), ScopesWithImportedEntities.end(),
Timur Iskhodzhanov664fbee2013-05-07 07:47:47 +0000614 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode*)0),
615 CompareFirst());
David Blaikied2e0f7e2013-05-06 23:33:07 +0000616 if (Children.empty() && Range.first == Range.second)
Devang Patel5bc9fec2011-02-19 01:31:27 +0000617 return NULL;
Devang Pateld3024342011-08-15 22:24:32 +0000618 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Eric Christopherfdfc81f2013-06-24 23:20:02 +0000619 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
620 ++i)
David Blaikied1221e32013-05-08 06:01:38 +0000621 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5bc9fec2011-02-19 01:31:27 +0000622 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000623
Devang Patelaead63c2010-03-29 22:59:58 +0000624 if (!ScopeDIE) return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000625
Devang Patel5bc9fec2011-02-19 01:31:27 +0000626 // Add children
Craig Topper2d785db2013-07-03 04:17:25 +0000627 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Devang Patel5bc9fec2011-02-19 01:31:27 +0000628 E = Children.end(); I != E; ++I)
629 ScopeDIE->addChild(*I);
Devang Patel193f7202009-11-24 01:14:22 +0000630
Eric Christophere5212782012-09-12 23:36:19 +0000631 if (DS.isSubprogram() && ObjectPointer != NULL)
632 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer,
633 dwarf::DW_FORM_ref4, ObjectPointer);
634
Jim Grosbach1e20b962010-07-21 21:21:52 +0000635 if (DS.isSubprogram())
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000636 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbach1e20b962010-07-21 21:21:52 +0000637
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000638 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +0000639}
640
Eric Christopherb6dc8652012-11-27 22:43:45 +0000641// Look up the source id with the given directory and source file names.
642// If none currently exists, create a new id and insert it in the
643// SourceIds map. This can update DirectoryNames and SourceFileNames maps
644// as well.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000645unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Manman Ren3de61b42013-03-07 01:42:00 +0000646 StringRef DirName, unsigned CUID) {
647 // If we use .loc in assembly, we can't separate .file entries according to
648 // compile units. Thus all files will belong to the default compile unit.
649 if (Asm->TM.hasMCUseLoc() &&
650 Asm->OutStreamer.getKind() == MCStreamer::SK_AsmStreamer)
651 CUID = 0;
652
Devang Patel1905a182010-09-16 20:57:49 +0000653 // If FE did not provide a file name, then assume stdin.
654 if (FileName.empty())
Manman Ren3de61b42013-03-07 01:42:00 +0000655 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patel23670e52011-03-24 20:30:50 +0000656
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000657 // TODO: this might not belong here. See if we can factor this better.
658 if (DirName == CompilationDir)
659 DirName = "";
660
Manman Ren3de61b42013-03-07 01:42:00 +0000661 // FileIDCUMap stores the current ID for the given compile unit.
662 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel1905a182010-09-16 20:57:49 +0000663
Manman Ren3de61b42013-03-07 01:42:00 +0000664 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer74612c22012-03-11 14:56:26 +0000665 SmallString<128> NamePair;
Manman Ren5044a932013-04-06 01:02:38 +0000666 NamePair += utostr(CUID);
Manman Ren3de61b42013-03-07 01:42:00 +0000667 NamePair += '\0';
Benjamin Kramer74612c22012-03-11 14:56:26 +0000668 NamePair += DirName;
669 NamePair += '\0'; // Zero bytes are not allowed in paths.
670 NamePair += FileName;
671
672 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
673 if (Ent.getValue() != SrcId)
674 return Ent.getValue();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000675
Manman Ren3de61b42013-03-07 01:42:00 +0000676 FileIDCUMap[CUID] = SrcId;
Rafael Espindola5c055632010-11-18 02:04:25 +0000677 // Print out a .file directive to specify files for .loc directives.
Manman Ren3de61b42013-03-07 01:42:00 +0000678 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000679
680 return SrcId;
681}
682
Eric Christopher72c16552012-12-20 21:58:40 +0000683// Create new CompileUnit for the given metadata node with tag
684// DW_TAG_compile_unit.
Devang Patel94c7ddb2011-08-16 22:09:43 +0000685CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +0000686 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +0000687 StringRef FN = DIUnit.getFilename();
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000688 CompilationDir = DIUnit.getDirectory();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000689
690 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyd4a05e02012-12-03 18:45:45 +0000691 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
Eric Christopher9c57ad22013-05-08 00:58:51 +0000692 DIUnit.getLanguage(), Die, N, Asm,
Eric Christopher2e5d8702012-12-20 21:58:36 +0000693 this, &InfoHolder);
Manman Ren3de61b42013-03-07 01:42:00 +0000694
695 FileIDCUMap[NewCU->getUniqueID()] = 0;
696 // Call this to emit a .file directive if it wasn't emitted for the source
697 // file this CU comes from yet.
698 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
699
Nick Lewycky390c40d2011-10-27 06:44:11 +0000700 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patel3cbee302011-04-12 22:53:02 +0000701 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
702 DIUnit.getLanguage());
Nick Lewycky390c40d2011-10-27 06:44:11 +0000703 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christophere0828ec2013-04-09 19:23:15 +0000704
Eric Christopher6635cad2012-08-01 18:19:01 +0000705 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christophere0828ec2013-04-09 19:23:15 +0000706 // into an entity. We're using 0 (or a NULL label) for this. For
707 // split dwarf it's in the skeleton CU so omit it here.
708 if (!useSplitDwarf())
709 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
Manman Ren43213cf2013-02-05 21:52:47 +0000710
711 // Define start line table label for each Compile Unit.
712 MCSymbol *LineTableStartSym = Asm->GetTempSymbol("line_table_start",
713 NewCU->getUniqueID());
714 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
715 NewCU->getUniqueID());
716
Manman Ren01cb18e2013-05-21 00:57:22 +0000717 // Use a single line table if we are using .loc and generating assembly.
718 bool UseTheFirstCU =
719 (Asm->TM.hasMCUseLoc() &&
720 Asm->OutStreamer.getKind() == MCStreamer::SK_AsmStreamer) ||
721 (NewCU->getUniqueID() == 0);
722
Devang Patel4a602ca2010-03-22 23:11:36 +0000723 // DW_AT_stmt_list is a offset of line number information for this
Eric Christophere0828ec2013-04-09 19:23:15 +0000724 // compile unit in debug_line section. For split dwarf this is
725 // left in the skeleton CU and so not included.
Manman Renf2d89ff2013-02-09 00:41:44 +0000726 // The line table entries are not always emitted in assembly, so it
727 // is not okay to use line_table_start here.
Eric Christophere0828ec2013-04-09 19:23:15 +0000728 if (!useSplitDwarf()) {
729 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
730 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Manman Ren01cb18e2013-05-21 00:57:22 +0000731 UseTheFirstCU ?
Eric Christophere0828ec2013-04-09 19:23:15 +0000732 Asm->GetTempSymbol("section_line") : LineTableStartSym);
Manman Ren01cb18e2013-05-21 00:57:22 +0000733 else if (UseTheFirstCU)
Eric Christophere0828ec2013-04-09 19:23:15 +0000734 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
735 else
736 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
737 LineTableStartSym, DwarfLineSectionSym);
738 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000739
Eric Christophere0828ec2013-04-09 19:23:15 +0000740 // If we're using split dwarf the compilation dir is going to be in the
741 // skeleton CU and so we don't need to duplicate it here.
742 if (!useSplitDwarf() && !CompilationDir.empty())
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000743 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000744 if (DIUnit.isOptimized())
Eric Christopher873cf0a2012-08-24 01:14:27 +0000745 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000746
Devang Patel65dbc902009-11-25 17:36:49 +0000747 StringRef Flags = DIUnit.getFlags();
748 if (!Flags.empty())
Nick Lewycky390c40d2011-10-27 06:44:11 +0000749 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000750
Nick Lewyckyd5d52132011-10-17 23:27:36 +0000751 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patel3cbee302011-04-12 22:53:02 +0000752 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000753 dwarf::DW_FORM_data1, RVer);
754
Devang Patel163a9f72010-05-10 22:49:55 +0000755 if (!FirstCU)
756 FirstCU = NewCU;
Eric Christopher208cc6f2013-02-05 07:31:55 +0000757
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000758 InfoHolder.addUnit(NewCU);
759
Devang Patel163a9f72010-05-10 22:49:55 +0000760 CUMap.insert(std::make_pair(N, NewCU));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000761 return NewCU;
Devang Patel163a9f72010-05-10 22:49:55 +0000762}
763
Eric Christopherb6dc8652012-11-27 22:43:45 +0000764// Construct subprogram DIE.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000765void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
Devang Patel3655a212011-08-15 23:36:40 +0000766 const MDNode *N) {
Rafael Espindolab0527282011-11-04 19:00:29 +0000767 CompileUnit *&CURef = SPMap[N];
768 if (CURef)
769 return;
770 CURef = TheCU;
771
Devang Patele4b27562009-08-28 23:24:31 +0000772 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000773 if (!SP.isDefinition())
774 // This is a method declaration which will be handled while constructing
775 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +0000776 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000777
Devang Pateldbc64af2011-08-15 17:24:54 +0000778 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings639336e2010-04-06 21:38:29 +0000779
780 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +0000781 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000782
783 // Add to context owner.
Devang Patel3cbee302011-04-12 22:53:02 +0000784 TheCU->addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +0000785
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +0000786 // Expose as global, if requested.
787 if (GenerateDwarfPubNamesSection)
788 TheCU->addGlobalName(SP.getName(), SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000789}
790
David Blaikie20d9e412013-05-07 21:35:53 +0000791void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikiec462db62013-04-22 06:12:31 +0000792 const MDNode *N) {
David Blaikie20d9e412013-05-07 21:35:53 +0000793 DIImportedEntity Module(N);
David Blaikiec462db62013-04-22 06:12:31 +0000794 if (!Module.Verify())
795 return;
David Blaikied2e0f7e2013-05-06 23:33:07 +0000796 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
David Blaikied1221e32013-05-08 06:01:38 +0000797 constructImportedEntityDIE(TheCU, Module, D);
David Blaikied2e0f7e2013-05-06 23:33:07 +0000798}
799
David Blaikied1221e32013-05-08 06:01:38 +0000800void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
David Blaikied2e0f7e2013-05-06 23:33:07 +0000801 DIE *Context) {
David Blaikie20d9e412013-05-07 21:35:53 +0000802 DIImportedEntity Module(N);
David Blaikied2e0f7e2013-05-06 23:33:07 +0000803 if (!Module.Verify())
804 return;
David Blaikied1221e32013-05-08 06:01:38 +0000805 return constructImportedEntityDIE(TheCU, Module, Context);
David Blaikied2e0f7e2013-05-06 23:33:07 +0000806}
807
David Blaikied1221e32013-05-08 06:01:38 +0000808void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikie20d9e412013-05-07 21:35:53 +0000809 const DIImportedEntity &Module,
David Blaikied2e0f7e2013-05-06 23:33:07 +0000810 DIE *Context) {
811 assert(Module.Verify() &&
812 "Use one of the MDNode * overloads to handle invalid metadata");
813 assert(Context && "Should always have a context for an imported_module");
David Blaikie20d9e412013-05-07 21:35:53 +0000814 DIE *IMDie = new DIE(Module.getTag());
David Blaikiec462db62013-04-22 06:12:31 +0000815 TheCU->insertDIE(Module, IMDie);
David Blaikie20d9e412013-05-07 21:35:53 +0000816 DIE *EntityDie;
817 DIDescriptor Entity = Module.getEntity();
818 if (Entity.isNameSpace())
819 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
820 else if (Entity.isSubprogram())
821 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
David Blaikieaa76a932013-05-08 06:01:41 +0000822 else if (Entity.isType())
823 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
David Blaikie20d9e412013-05-07 21:35:53 +0000824 else
David Blaikieaa76a932013-05-08 06:01:41 +0000825 EntityDie = TheCU->getDIE(Entity);
David Blaikiec462db62013-04-22 06:12:31 +0000826 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
827 Module.getContext().getDirectory(),
828 TheCU->getUniqueID());
829 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, 0, FileID);
830 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, 0, Module.getLineNumber());
Eric Christopherfdfc81f2013-06-24 23:20:02 +0000831 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, dwarf::DW_FORM_ref4,
832 EntityDie);
David Blaikie7b72cc72013-05-20 22:50:35 +0000833 StringRef Name = Module.getName();
834 if (!Name.empty())
835 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
David Blaikied2e0f7e2013-05-06 23:33:07 +0000836 Context->addChild(IMDie);
David Blaikiec462db62013-04-22 06:12:31 +0000837}
838
Eric Christopherb6dc8652012-11-27 22:43:45 +0000839// Emit all Dwarf sections that should come prior to the content. Create
840// global DIEs and emit initial debug info sections. This is invoked by
841// the target AsmPrinter.
Eric Christopherc4639d62012-11-19 22:42:15 +0000842void DwarfDebug::beginModule() {
Devang Pateleac9c072010-04-27 19:46:33 +0000843 if (DisableDebugInfoPrinting)
844 return;
845
Eric Christopherc4639d62012-11-19 22:42:15 +0000846 const Module *M = MMI->getModule();
847
Nick Lewycky3bbb6f72011-07-29 03:49:23 +0000848 // If module has named metadata anchors then use them, otherwise scan the
849 // module using debug info finder to collect debug info.
Devang Patel30692ab2011-05-03 16:45:22 +0000850 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
David Blaikiec0ec8a42013-03-11 23:39:23 +0000851 if (!CU_Nodes)
Devang Patel02e603f2011-08-15 23:47:24 +0000852 return;
Devang Patel30692ab2011-05-03 16:45:22 +0000853
David Blaikiec0ec8a42013-03-11 23:39:23 +0000854 // Emit initial sections so we can reference labels later.
855 emitSectionLabels();
856
857 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
858 DICompileUnit CUNode(CU_Nodes->getOperand(i));
859 CompileUnit *CU = constructCompileUnit(CUNode);
David Blaikie20d9e412013-05-07 21:35:53 +0000860 DIArray ImportedEntities = CUNode.getImportedEntities();
861 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
David Blaikied2e0f7e2013-05-06 23:33:07 +0000862 ScopesWithImportedEntities.push_back(std::make_pair(
David Blaikie20d9e412013-05-07 21:35:53 +0000863 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
864 ImportedEntities.getElement(i)));
David Blaikied2e0f7e2013-05-06 23:33:07 +0000865 std::sort(ScopesWithImportedEntities.begin(),
866 ScopesWithImportedEntities.end(), CompareFirst());
David Blaikiec0ec8a42013-03-11 23:39:23 +0000867 DIArray GVs = CUNode.getGlobalVariables();
868 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
869 CU->createGlobalVariableDIE(GVs.getElement(i));
870 DIArray SPs = CUNode.getSubprograms();
871 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
872 constructSubprogramDIE(CU, SPs.getElement(i));
873 DIArray EnumTypes = CUNode.getEnumTypes();
874 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
875 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
876 DIArray RetainedTypes = CUNode.getRetainedTypes();
877 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
878 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
David Blaikiec462db62013-04-22 06:12:31 +0000879 // Emit imported_modules last so that the relevant context is already
880 // available.
David Blaikie20d9e412013-05-07 21:35:53 +0000881 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
882 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
Eric Christopherc126c322013-03-29 20:23:02 +0000883 // If we're splitting the dwarf out now that we've got the entire
884 // CU then construct a skeleton CU based upon it.
885 if (useSplitDwarf()) {
Eric Christopher13367122013-04-24 12:56:18 +0000886 // This should be a unique identifier when we want to build .dwp files.
Eric Christopher1b0cd2f2013-04-22 07:51:08 +0000887 CU->addUInt(CU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
888 dwarf::DW_FORM_data8, 0);
Eric Christopherc126c322013-03-29 20:23:02 +0000889 // Now construct the skeleton CU associated.
890 constructSkeletonCU(CUNode);
891 }
David Blaikiec0ec8a42013-03-11 23:39:23 +0000892 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000893
Chris Lattnerd850ac72010-04-05 02:19:28 +0000894 // Tell MMI that we have debug info.
895 MMI->setDebugInfoAvailability(true);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000896
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000897 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +0000898 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000899}
900
Eric Christopher4117bec2012-11-22 00:59:49 +0000901// Attach DW_AT_inline attribute with inlined subprogram DIEs.
902void DwarfDebug::computeInlinedDIEs() {
Devang Patel53bb5c92009-11-10 23:06:00 +0000903 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
904 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000905 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patel53bb5c92009-11-10 23:06:00 +0000906 DIE *ISP = *AI;
Devang Patel3cbee302011-04-12 22:53:02 +0000907 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +0000908 }
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000909 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000910 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000911 DIE *ISP = AI->second;
912 if (InlinedSubprogramDIEs.count(ISP))
913 continue;
914 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
915 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000916}
917
918// Collect info for variables that were optimized out.
919void DwarfDebug::collectDeadVariables() {
920 const Module *M = MMI->getModule();
921 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
922
923 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
924 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
925 DICompileUnit TheCU(CU_Nodes->getOperand(i));
926 DIArray Subprograms = TheCU.getSubprograms();
927 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopherbdab8002012-11-27 00:13:51 +0000928 DISubprogram SP(Subprograms.getElement(i));
929 if (ProcessedSPNodes.count(SP) != 0) continue;
Manman Rend03d2b22013-07-08 18:33:29 +0000930 if (!SP.isSubprogram()) continue;
Eric Christopherbdab8002012-11-27 00:13:51 +0000931 if (!SP.isDefinition()) continue;
932 DIArray Variables = SP.getVariables();
933 if (Variables.getNumElements() == 0) continue;
Eric Christopher4117bec2012-11-22 00:59:49 +0000934
Eric Christopherbdab8002012-11-27 00:13:51 +0000935 LexicalScope *Scope =
936 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
937 DeadFnScopeMap[SP] = Scope;
Eric Christopher4117bec2012-11-22 00:59:49 +0000938
Eric Christopherbdab8002012-11-27 00:13:51 +0000939 // Construct subprogram DIE and add variables DIEs.
940 CompileUnit *SPCU = CUMap.lookup(TheCU);
941 assert(SPCU && "Unable to find Compile Unit!");
942 constructSubprogramDIE(SPCU, SP);
943 DIE *ScopeDIE = SPCU->getDIE(SP);
944 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
945 DIVariable DV(Variables.getElement(vi));
Manman Rend03d2b22013-07-08 18:33:29 +0000946 if (!DV.isVariable()) continue;
Eric Christopherbdab8002012-11-27 00:13:51 +0000947 DbgVariable *NewVar = new DbgVariable(DV, NULL);
948 if (DIE *VariableDIE =
949 SPCU->constructVariableDIE(NewVar, Scope->isAbstractScope()))
950 ScopeDIE->addChild(VariableDIE);
951 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000952 }
953 }
954 }
955 DeleteContainerSeconds(DeadFnScopeMap);
956}
957
958void DwarfDebug::finalizeModuleInfo() {
959 // Collect info for variables that were optimized out.
960 collectDeadVariables();
961
962 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
963 computeInlinedDIEs();
Devang Patel53bb5c92009-11-10 23:06:00 +0000964
Eric Christopher6635cad2012-08-01 18:19:01 +0000965 // Emit DW_AT_containing_type attribute to connect types with their
966 // vtable holding type.
Devang Pateldbc64af2011-08-15 17:24:54 +0000967 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000968 CUE = CUMap.end(); CUI != CUE; ++CUI) {
Devang Pateldbc64af2011-08-15 17:24:54 +0000969 CompileUnit *TheCU = CUI->second;
970 TheCU->constructContainingTypeDIEs();
Devang Patel5d11eb02009-12-03 19:11:07 +0000971 }
972
Eric Christopher4117bec2012-11-22 00:59:49 +0000973 // Compute DIE offsets and sizes.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000974 InfoHolder.computeSizeAndOffsets();
975 if (useSplitDwarf())
976 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher4117bec2012-11-22 00:59:49 +0000977}
978
979void DwarfDebug::endSections() {
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000980 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +0000981 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +0000982 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +0000983 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +0000984 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000985
986 // End text sections.
Benjamin Kramerb4c9d9c2012-10-31 13:45:49 +0000987 for (unsigned I = 0, E = SectionMap.size(); I != E; ++I) {
988 Asm->OutStreamer.SwitchSection(SectionMap[I]);
989 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", I+1));
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000990 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000991}
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000992
Eric Christopherb6dc8652012-11-27 22:43:45 +0000993// Emit all Dwarf sections that should come after the content.
Eric Christopher4117bec2012-11-22 00:59:49 +0000994void DwarfDebug::endModule() {
995
996 if (!FirstCU) return;
997
998 // End any existing sections.
999 // TODO: Does this need to happen?
1000 endSections();
1001
1002 // Finalize the debug info for the module.
1003 finalizeModuleInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001004
Eric Christopher4daaed12012-12-10 19:51:21 +00001005 if (!useSplitDwarf()) {
Eric Christopher42885022012-11-27 22:43:42 +00001006 // Emit all the DIEs into a debug info section.
1007 emitDebugInfo();
Eric Christopher74802f72012-11-27 00:41:54 +00001008
Eric Christopher42885022012-11-27 22:43:42 +00001009 // Corresponding abbreviations into a abbrev section.
1010 emitAbbreviations();
1011
1012 // Emit info into a debug loc section.
1013 emitDebugLoc();
1014
1015 // Emit info into a debug aranges section.
1016 emitDebugARanges();
1017
1018 // Emit info into a debug ranges section.
1019 emitDebugRanges();
1020
1021 // Emit info into a debug macinfo section.
1022 emitDebugMacInfo();
1023
1024 // Emit inline info.
1025 // TODO: When we don't need the option anymore we
1026 // can remove all of the code that this section
1027 // depends upon.
1028 if (useDarwinGDBCompat())
1029 emitDebugInlineInfo();
1030 } else {
Eric Christopher0b944ee2012-12-11 19:42:09 +00001031 // TODO: Fill this in for separated debug sections and separate
Eric Christopher42885022012-11-27 22:43:42 +00001032 // out information into new sections.
1033
Eric Christopher98e237f2012-11-30 23:59:06 +00001034 // Emit the debug info section and compile units.
Eric Christopher42885022012-11-27 22:43:42 +00001035 emitDebugInfo();
Eric Christopher98e237f2012-11-30 23:59:06 +00001036 emitDebugInfoDWO();
Eric Christopher42885022012-11-27 22:43:42 +00001037
1038 // Corresponding abbreviations into a abbrev section.
1039 emitAbbreviations();
Eric Christopher6eebe472012-12-19 22:02:53 +00001040 emitDebugAbbrevDWO();
Eric Christopher42885022012-11-27 22:43:42 +00001041
1042 // Emit info into a debug loc section.
1043 emitDebugLoc();
1044
1045 // Emit info into a debug aranges section.
1046 emitDebugARanges();
1047
1048 // Emit info into a debug ranges section.
1049 emitDebugRanges();
1050
1051 // Emit info into a debug macinfo section.
1052 emitDebugMacInfo();
1053
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001054 // Emit DWO addresses.
1055 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1056
Eric Christopher42885022012-11-27 22:43:42 +00001057 // Emit inline info.
1058 // TODO: When we don't need the option anymore we
1059 // can remove all of the code that this section
1060 // depends upon.
1061 if (useDarwinGDBCompat())
1062 emitDebugInlineInfo();
1063 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001064
Eric Christopher9d9f5a52012-08-23 07:32:06 +00001065 // Emit info into the dwarf accelerator table sections.
Eric Christopher20f47ab2012-08-23 22:36:40 +00001066 if (useDwarfAccelTables()) {
Eric Christopher09ac3d82011-11-07 09:24:32 +00001067 emitAccelNames();
1068 emitAccelObjC();
1069 emitAccelNamespaces();
1070 emitAccelTypes();
1071 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001072
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00001073 // Emit info into a debug pubnames section, if requested.
1074 if (GenerateDwarfPubNamesSection)
1075 emitDebugPubnames();
1076
Devang Patel193f7202009-11-24 01:14:22 +00001077 // Emit info into a debug pubtypes section.
Eric Christopher360f0062012-08-23 07:10:56 +00001078 // TODO: When we don't need the option anymore we can
1079 // remove all of the code that adds to the table.
Eric Christopher20f47ab2012-08-23 22:36:40 +00001080 if (useDarwinGDBCompat())
Eric Christopher360f0062012-08-23 07:10:56 +00001081 emitDebugPubTypes();
Devang Patel193f7202009-11-24 01:14:22 +00001082
Eric Christopher42885022012-11-27 22:43:42 +00001083 // Finally emit string information into a string table.
Eric Christopherfcdbecb2012-11-27 06:49:23 +00001084 emitDebugStr();
Eric Christopher64f824c2012-12-27 02:14:01 +00001085 if (useSplitDwarf())
1086 emitDebugStrDWO();
Eric Christopherfcdbecb2012-11-27 06:49:23 +00001087
Devang Patele9a1cca2010-08-02 17:32:15 +00001088 // clean up.
Devang Patel94c7ddb2011-08-16 22:09:43 +00001089 SPMap.clear();
Devang Patel163a9f72010-05-10 22:49:55 +00001090 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1091 E = CUMap.end(); I != E; ++I)
1092 delete I->second;
Eric Christopher9ec87b32012-12-10 19:51:18 +00001093
Craig Topper2d785db2013-07-03 04:17:25 +00001094 for (SmallVectorImpl<CompileUnit *>::iterator I = SkeletonCUs.begin(),
Eric Christopher01776a52013-02-06 21:53:56 +00001095 E = SkeletonCUs.end(); I != E; ++I)
1096 delete *I;
Eric Christopher9ec87b32012-12-10 19:51:18 +00001097
Eric Christopher98e237f2012-11-30 23:59:06 +00001098 // Reset these for the next Module if we have one.
1099 FirstCU = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001100}
1101
Eric Christopherb6dc8652012-11-27 22:43:45 +00001102// Find abstract variable, if any, associated with Var.
Devang Patelb549bcf2011-08-10 21:50:54 +00001103DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattnerde4845c2010-04-02 19:42:39 +00001104 DebugLoc ScopeLoc) {
Devang Patelb549bcf2011-08-10 21:50:54 +00001105 LLVMContext &Ctx = DV->getContext();
1106 // More then one inlined variable corresponds to one abstract variable.
1107 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patel2db49d72010-05-07 18:11:54 +00001108 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00001109 if (AbsDbgVariable)
1110 return AbsDbgVariable;
1111
Devang Patelbf47fdb2011-08-10 20:55:27 +00001112 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00001113 if (!Scope)
1114 return NULL;
1115
Devang Patel5a1a67c2011-08-15 19:01:20 +00001116 AbsDbgVariable = new DbgVariable(Var, NULL);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001117 addScopeVariable(Scope, AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00001118 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00001119 return AbsDbgVariable;
1120}
1121
Eric Christopherb6dc8652012-11-27 22:43:45 +00001122// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel0478c152011-03-01 22:58:55 +00001123bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patelbf47fdb2011-08-10 20:55:27 +00001124 DbgVariable *Var, LexicalScope *Scope) {
1125 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +00001126 return false;
1127 DIVariable DV = Var->getVariable();
1128 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1129 return false;
1130 unsigned ArgNo = DV.getArgNumber();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001131 if (ArgNo == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001132 return false;
1133
Devang Patelcb3a6572011-03-03 20:02:02 +00001134 size_t Size = CurrentFnArguments.size();
1135 if (Size == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001136 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patelbbd0f452011-03-03 21:49:41 +00001137 // llvm::Function argument size is not good indicator of how many
Devang Patel6f676be2011-03-03 20:08:10 +00001138 // arguments does the function have at source level.
1139 if (ArgNo > Size)
Devang Patelcb3a6572011-03-03 20:02:02 +00001140 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel0478c152011-03-01 22:58:55 +00001141 CurrentFnArguments[ArgNo - 1] = Var;
1142 return true;
1143}
1144
Eric Christopherb6dc8652012-11-27 22:43:45 +00001145// Collect variable information from side table maintained by MMI.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001146void
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001147DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patelee432862010-05-20 19:57:06 +00001148 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patele717faa2009-10-06 01:26:37 +00001149 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1150 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1151 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00001152 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00001153 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00001154 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00001155 DIVariable DV(Var);
1156 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00001157
Devang Patelbf47fdb2011-08-10 20:55:27 +00001158 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001159
Devang Patelfb0ee432009-11-10 23:20:04 +00001160 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00001161 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00001162 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00001163
Devang Patel26c1e562010-05-20 16:36:41 +00001164 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001165 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable);
Devang Patelff9dd0a2011-08-15 21:24:36 +00001166 RegVar->setFrameIndex(VP.first);
Devang Patel0478c152011-03-01 22:58:55 +00001167 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001168 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001169 if (AbsDbgVariable)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001170 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patele717faa2009-10-06 01:26:37 +00001171 }
Devang Patelee432862010-05-20 19:57:06 +00001172}
Devang Patel90a48ad2010-03-15 18:33:46 +00001173
Eric Christopherb6dc8652012-11-27 22:43:45 +00001174// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1175// defined reg.
Devang Patelc3f5f782010-05-25 23:40:22 +00001176static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001177 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001178 return MI->getNumOperands() == 3 &&
1179 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
Adrian Prantl35176402013-07-09 20:28:37 +00001180 (MI->getOperand(1).isImm() ||
1181 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
Devang Patelc3f5f782010-05-25 23:40:22 +00001182}
1183
Eric Christopherb6dc8652012-11-27 22:43:45 +00001184// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001185static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1186 const MCSymbol *FLabel,
Devang Patel90b40412011-07-08 17:09:57 +00001187 const MCSymbol *SLabel,
1188 const MachineInstr *MI) {
1189 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1190
David Blaikie6d9dbd52013-06-16 20:34:15 +00001191 assert(MI->getNumOperands() == 3);
Adrian Prantl35176402013-07-09 20:28:37 +00001192 if (MI->getOperand(0).isReg()) {
Devang Patel90b40412011-07-08 17:09:57 +00001193 MachineLocation MLoc;
Adrian Prantl35176402013-07-09 20:28:37 +00001194 // If the second operand is an immediate, this is a
1195 // register-indirect address.
1196 if (!MI->getOperand(1).isImm())
Adrian Prantl13131e62013-04-26 21:57:17 +00001197 MLoc.set(MI->getOperand(0).getReg());
1198 else
1199 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel90b40412011-07-08 17:09:57 +00001200 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1201 }
1202 if (MI->getOperand(0).isImm())
1203 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1204 if (MI->getOperand(0).isFPImm())
1205 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1206 if (MI->getOperand(0).isCImm())
1207 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1208
Craig Topper5e25ee82012-02-05 08:31:47 +00001209 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel90b40412011-07-08 17:09:57 +00001210}
1211
Eric Christopherb6dc8652012-11-27 22:43:45 +00001212// Find variables for each lexical scope.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001213void
Devang Patel78e127d2010-06-25 22:07:34 +00001214DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1215 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00001216
Eric Christopher4e976452013-07-03 21:37:03 +00001217 // Grab the variable info that was squirreled away in the MMI side-table.
Devang Patelee432862010-05-20 19:57:06 +00001218 collectVariableInfoFromMMITable(MF, Processed);
1219
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001220 for (SmallVectorImpl<const MDNode*>::const_iterator
1221 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1222 ++UVI) {
1223 const MDNode *Var = *UVI;
1224 if (Processed.count(Var))
Devang Patelee432862010-05-20 19:57:06 +00001225 continue;
1226
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001227 // History contains relevant DBG_VALUE instructions for Var and instructions
1228 // clobbering it.
1229 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1230 if (History.empty())
1231 continue;
1232 const MachineInstr *MInsn = History.front();
Devang Patelc3f5f782010-05-25 23:40:22 +00001233
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001234 DIVariable DV(Var);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001235 LexicalScope *Scope = NULL;
Devang Pateld8720f42010-05-27 20:25:04 +00001236 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1237 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001238 Scope = LScopes.getCurrentFunctionScope();
David Blaikiec0ec8a42013-03-11 23:39:23 +00001239 else if (MDNode *IA = DV.getInlinedAt())
1240 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1241 else
1242 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patelee432862010-05-20 19:57:06 +00001243 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00001244 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00001245 continue;
1246
1247 Processed.insert(DV);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001248 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel5a1a67c2011-08-15 19:01:20 +00001249 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
1250 DbgVariable *RegVar = new DbgVariable(DV, AbsVar);
Devang Patel0478c152011-03-01 22:58:55 +00001251 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001252 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001253 if (AbsVar)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001254 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001255
Eric Christopherc56e3f02012-10-08 20:48:54 +00001256 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001257 if (History.size() <= 1 || (History.size() == 2 &&
1258 MInsn->isIdenticalTo(History.back()))) {
Devang Patelff9dd0a2011-08-15 21:24:36 +00001259 RegVar->setMInsn(MInsn);
Devang Patelc3f5f782010-05-25 23:40:22 +00001260 continue;
1261 }
1262
Eric Christopher498703b2013-01-28 17:33:26 +00001263 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001264 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001265
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001266 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1267 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1268 const MachineInstr *Begin = *HI;
1269 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesene17232e2011-03-22 00:21:41 +00001270
Devang Patel4ada1d72011-06-01 23:00:17 +00001271 // Check if DBG_VALUE is truncating a range.
1272 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1273 && !Begin->getOperand(0).getReg())
1274 continue;
1275
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001276 // Compute the range for a register location.
1277 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1278 const MCSymbol *SLabel = 0;
1279
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001280 if (HI + 1 == HE)
1281 // If Begin is the last instruction in History then its value is valid
Chris Lattner7a2bdde2011-04-15 05:18:47 +00001282 // until the end of the function.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001283 SLabel = FunctionEndSym;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001284 else {
1285 const MachineInstr *End = HI[1];
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001286 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel476df5f2011-07-07 21:44:42 +00001287 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001288 if (End->isDebugValue())
1289 SLabel = getLabelBeforeInsn(End);
1290 else {
1291 // End is a normal instruction clobbering the range.
1292 SLabel = getLabelAfterInsn(End);
1293 assert(SLabel && "Forgot label after clobber instruction");
1294 ++HI;
1295 }
1296 }
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001297
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001298 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopherabbb2002011-12-16 23:42:31 +00001299 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1300 Begin));
Devang Patelc3f5f782010-05-25 23:40:22 +00001301 }
1302 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00001303 }
Devang Patel98e1cac2010-05-14 21:01:35 +00001304
1305 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001306 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1307 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1308 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1309 DIVariable DV(Variables.getElement(i));
Manman Rend03d2b22013-07-08 18:33:29 +00001310 if (!DV || !DV.isVariable() || !Processed.insert(DV))
Devang Patel93d39be2011-08-19 23:28:12 +00001311 continue;
1312 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1313 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel98e1cac2010-05-14 21:01:35 +00001314 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001315}
Devang Patel98e1cac2010-05-14 21:01:35 +00001316
Eric Christopherb6dc8652012-11-27 22:43:45 +00001317// Return Label preceding the instruction.
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001318MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001319 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1320 assert(Label && "Didn't insert label before instruction");
1321 return Label;
Devang Patelc3f5f782010-05-25 23:40:22 +00001322}
1323
Eric Christopherb6dc8652012-11-27 22:43:45 +00001324// Return Label immediately following the instruction.
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001325MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001326 return LabelsAfterInsn.lookup(MI);
Devang Patele717faa2009-10-06 01:26:37 +00001327}
1328
Eric Christopherb6dc8652012-11-27 22:43:45 +00001329// Process beginning of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001330void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001331 // Check if source location changes, but ignore DBG_VALUE locations.
1332 if (!MI->isDebugValue()) {
1333 DebugLoc DL = MI->getDebugLoc();
1334 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopher60b35f42012-04-05 20:39:05 +00001335 unsigned Flags = 0;
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001336 PrevInstLoc = DL;
Devang Patel4243e672011-05-11 19:22:19 +00001337 if (DL == PrologEndLoc) {
1338 Flags |= DWARF2_FLAG_PROLOGUE_END;
1339 PrologEndLoc = DebugLoc();
1340 }
Eric Christopher60b35f42012-04-05 20:39:05 +00001341 if (PrologEndLoc.isUnknown())
1342 Flags |= DWARF2_FLAG_IS_STMT;
1343
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001344 if (!DL.isUnknown()) {
1345 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel4243e672011-05-11 19:22:19 +00001346 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001347 } else
Devang Patel4243e672011-05-11 19:22:19 +00001348 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001349 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001350 }
Devang Patelaead63c2010-03-29 22:59:58 +00001351
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001352 // Insert labels where requested.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001353 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1354 LabelsBeforeInsn.find(MI);
1355
1356 // No label needed.
1357 if (I == LabelsBeforeInsn.end())
1358 return;
1359
1360 // Label already assigned.
1361 if (I->second)
Devang Patelb2b31a62010-05-26 19:37:24 +00001362 return;
Devang Patel553881b2010-03-29 17:20:31 +00001363
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001364 if (!PrevLabel) {
Devang Patel77051f52010-05-26 21:23:46 +00001365 PrevLabel = MMI->getContext().CreateTempSymbol();
1366 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00001367 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001368 I->second = PrevLabel;
Devang Patel0d20ac82009-10-06 01:50:42 +00001369}
1370
Eric Christopherb6dc8652012-11-27 22:43:45 +00001371// Process end of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001372void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001373 // Don't create a new label after DBG_VALUE instructions.
1374 // They don't generate code.
1375 if (!MI->isDebugValue())
1376 PrevLabel = 0;
1377
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001378 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1379 LabelsAfterInsn.find(MI);
1380
1381 // No label needed.
1382 if (I == LabelsAfterInsn.end())
1383 return;
1384
1385 // Label already assigned.
1386 if (I->second)
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001387 return;
1388
1389 // We need a label after this instruction.
1390 if (!PrevLabel) {
1391 PrevLabel = MMI->getContext().CreateTempSymbol();
1392 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel1c246352010-04-08 16:50:29 +00001393 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001394 I->second = PrevLabel;
Devang Patel53bb5c92009-11-10 23:06:00 +00001395}
1396
Eric Christopherb6dc8652012-11-27 22:43:45 +00001397// Each LexicalScope has first instruction and last instruction to mark
1398// beginning and end of a scope respectively. Create an inverse map that list
1399// scopes starts (and ends) with an instruction. One instruction may start (or
1400// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00001401void DwarfDebug::identifyScopeMarkers() {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001402 SmallVector<LexicalScope *, 4> WorkList;
1403 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel42aafd72010-01-20 02:05:23 +00001404 while (!WorkList.empty()) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001405 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001406
Craig Topper9f43ac62013-07-03 04:24:43 +00001407 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001408 if (!Children.empty())
Craig Topper2d785db2013-07-03 04:17:25 +00001409 for (SmallVectorImpl<LexicalScope *>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00001410 SE = Children.end(); SI != SE; ++SI)
1411 WorkList.push_back(*SI);
1412
Devang Patel53bb5c92009-11-10 23:06:00 +00001413 if (S->isAbstractScope())
1414 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001415
Craig Topper9f43ac62013-07-03 04:24:43 +00001416 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
Devang Pateleac9c072010-04-27 19:46:33 +00001417 if (Ranges.empty())
1418 continue;
Craig Topper2d785db2013-07-03 04:17:25 +00001419 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +00001420 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001421 assert(RI->first && "InsnRange does not have first instruction!");
1422 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001423 requestLabelBeforeInsn(RI->first);
1424 requestLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001425 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001426 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001427}
1428
Eric Christopherb6dc8652012-11-27 22:43:45 +00001429// Get MDNode for DebugLoc's scope.
Devang Patela3f48672011-05-09 22:14:49 +00001430static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1431 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1432 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1433 return DL.getScope(Ctx);
1434}
1435
Eric Christopherb6dc8652012-11-27 22:43:45 +00001436// Walk up the scope chain of given debug loc and find line number info
1437// for the function.
Devang Patel4243e672011-05-11 19:22:19 +00001438static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1439 const MDNode *Scope = getScopeNode(DL, Ctx);
1440 DISubprogram SP = getDISubprogram(Scope);
Manman Rend03d2b22013-07-08 18:33:29 +00001441 if (SP.isSubprogram()) {
Eric Christopher6126a1e2012-04-03 00:43:49 +00001442 // Check for number of operands since the compatibility is
1443 // cheap here.
Eric Christopherfa5b0502012-04-03 17:55:42 +00001444 if (SP->getNumOperands() > 19)
Eric Christopher6126a1e2012-04-03 00:43:49 +00001445 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1446 else
1447 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1448 }
1449
Devang Patel4243e672011-05-11 19:22:19 +00001450 return DebugLoc();
1451}
1452
Eric Christopherb6dc8652012-11-27 22:43:45 +00001453// Gather pre-function debug information. Assumes being called immediately
1454// after the function entry point has been emitted.
Chris Lattnereec791a2010-01-26 23:18:02 +00001455void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00001456 if (!MMI->hasDebugInfo()) return;
Devang Patelbf47fdb2011-08-10 20:55:27 +00001457 LScopes.initialize(*MF);
1458 if (LScopes.empty()) return;
1459 identifyScopeMarkers();
Devang Patel60b35bd2009-10-06 18:37:31 +00001460
Manman Ren43213cf2013-02-05 21:52:47 +00001461 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1462 // belongs to.
1463 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1464 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1465 assert(TheCU && "Unable to find compile unit!");
Manman Ren01cb18e2013-05-21 00:57:22 +00001466 if (Asm->TM.hasMCUseLoc() &&
1467 Asm->OutStreamer.getKind() == MCStreamer::SK_AsmStreamer)
1468 // Use a single line table if we are using .loc and generating assembly.
1469 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1470 else
1471 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
Manman Ren43213cf2013-02-05 21:52:47 +00001472
Devang Pateleac9c072010-04-27 19:46:33 +00001473 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1474 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001475 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00001476 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001477
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001478 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1479
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001480 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopherb6dc8652012-11-27 22:43:45 +00001481 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001482 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1483
Devang Patelb2b31a62010-05-26 19:37:24 +00001484 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001485 I != E; ++I) {
1486 bool AtBlockEntry = true;
Devang Patelb2b31a62010-05-26 19:37:24 +00001487 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1488 II != IE; ++II) {
1489 const MachineInstr *MI = II;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001490
Devang Patelb2b31a62010-05-26 19:37:24 +00001491 if (MI->isDebugValue()) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001492 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001493
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001494 // Keep track of user variables.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001495 const MDNode *Var =
1496 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001497
1498 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001499 if (isDbgValueInDefinedReg(MI))
1500 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1501
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001502 // Check the history of this variable.
1503 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1504 if (History.empty()) {
1505 UserVariables.push_back(Var);
1506 // The first mention of a function argument gets the FunctionBeginSym
1507 // label, so arguments are visible when breaking at function entry.
1508 DIVariable DV(Var);
Manman Rend03d2b22013-07-08 18:33:29 +00001509 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001510 DISubprogram(getDISubprogram(DV.getContext()))
1511 .describes(MF->getFunction()))
1512 LabelsBeforeInsn[MI] = FunctionBeginSym;
1513 } else {
1514 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1515 const MachineInstr *Prev = History.back();
1516 if (Prev->isDebugValue()) {
1517 // Coalesce identical entries at the end of History.
1518 if (History.size() >= 2 &&
Devang Patel79862892011-07-07 00:14:27 +00001519 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher02c1a642012-10-08 20:48:49 +00001520 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001521 << "\t" << *Prev
Devang Patel79862892011-07-07 00:14:27 +00001522 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001523 History.pop_back();
Devang Patel79862892011-07-07 00:14:27 +00001524 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001525
1526 // Terminate old register assignments that don't reach MI;
1527 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1528 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1529 isDbgValueInDefinedReg(Prev)) {
1530 // Previous register assignment needs to terminate at the end of
1531 // its basic block.
1532 MachineBasicBlock::const_iterator LastMI =
1533 PrevMBB->getLastNonDebugInstr();
Devang Patel79862892011-07-07 00:14:27 +00001534 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001535 // Drop DBG_VALUE for empty range.
Eric Christopher02c1a642012-10-08 20:48:49 +00001536 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patel79862892011-07-07 00:14:27 +00001537 << "\t" << *Prev << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001538 History.pop_back();
David Blaikie4532c282013-06-20 00:25:24 +00001539 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001540 // Terminate after LastMI.
1541 History.push_back(LastMI);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001542 }
1543 }
1544 }
1545 History.push_back(MI);
Devang Patelb2b31a62010-05-26 19:37:24 +00001546 } else {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001547 // Not a DBG_VALUE instruction.
1548 if (!MI->isLabel())
1549 AtBlockEntry = false;
1550
Eric Christopher0313ced2012-10-04 20:46:14 +00001551 // First known non-DBG_VALUE and non-frame setup location marks
1552 // the beginning of the function body.
1553 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1554 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel4243e672011-05-11 19:22:19 +00001555 PrologEndLoc = MI->getDebugLoc();
1556
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001557 // Check if the instruction clobbers any registers with debug vars.
1558 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1559 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1560 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1561 continue;
Jakob Stoklund Olesen396618b2012-06-01 23:28:30 +00001562 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1563 AI.isValid(); ++AI) {
1564 unsigned Reg = *AI;
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001565 const MDNode *Var = LiveUserVar[Reg];
1566 if (!Var)
1567 continue;
1568 // Reg is now clobbered.
1569 LiveUserVar[Reg] = 0;
1570
1571 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001572 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1573 if (HistI == DbgValues.end())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001574 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001575 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1576 if (History.empty())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001577 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001578 const MachineInstr *Prev = History.back();
1579 // Sanity-check: Register assignments are terminated at the end of
1580 // their block.
1581 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1582 continue;
1583 // Is the variable still in Reg?
1584 if (!isDbgValueInDefinedReg(Prev) ||
1585 Prev->getOperand(0).getReg() != Reg)
1586 continue;
1587 // Var is clobbered. Make sure the next instruction gets a label.
1588 History.push_back(MI);
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001589 }
1590 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001591 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001592 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001593 }
1594
1595 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1596 I != E; ++I) {
1597 SmallVectorImpl<const MachineInstr*> &History = I->second;
1598 if (History.empty())
1599 continue;
1600
1601 // Make sure the final register assignments are terminated.
1602 const MachineInstr *Prev = History.back();
1603 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1604 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001605 MachineBasicBlock::const_iterator LastMI =
Devang Patel5bc942c2011-08-10 23:58:09 +00001606 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001607 if (LastMI == PrevMBB->end())
1608 // Drop DBG_VALUE for empty range.
1609 History.pop_back();
David Blaikie4532c282013-06-20 00:25:24 +00001610 else if (PrevMBB != &PrevMBB->getParent()->back()) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001611 // Terminate after LastMI.
1612 History.push_back(LastMI);
1613 }
1614 }
1615 // Request labels for the full history.
1616 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1617 const MachineInstr *MI = History[i];
1618 if (MI->isDebugValue())
1619 requestLabelBeforeInsn(MI);
1620 else
1621 requestLabelAfterInsn(MI);
1622 }
1623 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001624
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001625 PrevInstLoc = DebugLoc();
Devang Patelb2b31a62010-05-26 19:37:24 +00001626 PrevLabel = FunctionBeginSym;
Devang Patel4243e672011-05-11 19:22:19 +00001627
1628 // Record beginning of function.
1629 if (!PrologEndLoc.isUnknown()) {
1630 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1631 MF->getFunction()->getContext());
1632 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1633 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie836cfc42012-12-04 22:02:33 +00001634 // We'd like to list the prologue as "not statements" but GDB behaves
1635 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikieb36c5312012-12-04 21:05:36 +00001636 DWARF2_FLAG_IS_STMT);
Devang Patel4243e672011-05-11 19:22:19 +00001637 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001638}
1639
Devang Patelbf47fdb2011-08-10 20:55:27 +00001640void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
David Blaikie032d6242013-06-05 05:39:59 +00001641 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1642 DIVariable DV = Var->getVariable();
David Blaikieb20fdff2013-06-06 21:04:51 +00001643 // Variables with positive arg numbers are parameters.
1644 if (unsigned ArgNum = DV.getArgNumber()) {
1645 // Keep all parameters in order at the start of the variable list to ensure
1646 // function types are correct (no out-of-order parameters)
1647 //
1648 // This could be improved by only doing it for optimized builds (unoptimized
1649 // builds have the right order to begin with), searching from the back (this
1650 // would catch the unoptimized case quickly), or doing a binary search
1651 // rather than linear search.
1652 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1653 while (I != Vars.end()) {
1654 unsigned CurNum = (*I)->getVariable().getArgNumber();
1655 // A local (non-parameter) variable has been found, insert immediately
1656 // before it.
1657 if (CurNum == 0)
1658 break;
1659 // A later indexed parameter has been found, insert immediately before it.
David Blaikiebabfebb2013-06-06 22:28:26 +00001660 if (CurNum > ArgNum)
David Blaikieb20fdff2013-06-06 21:04:51 +00001661 break;
David Blaikiebabfebb2013-06-06 22:28:26 +00001662 ++I;
David Blaikie032d6242013-06-05 05:39:59 +00001663 }
David Blaikieb20fdff2013-06-06 21:04:51 +00001664 Vars.insert(I, Var);
1665 return;
David Blaikie032d6242013-06-05 05:39:59 +00001666 }
1667
1668 Vars.push_back(Var);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001669}
1670
Eric Christopherb6dc8652012-11-27 22:43:45 +00001671// Gather and emit post-function debug information.
Chris Lattnereec791a2010-01-26 23:18:02 +00001672void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001673 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00001674
Devang Patelbf47fdb2011-08-10 20:55:27 +00001675 // Define end label for subprogram.
1676 FunctionEndSym = Asm->GetTempSymbol("func_end",
1677 Asm->getFunctionNumber());
1678 // Assumes in correct section after the entry point.
1679 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Manman Ren43213cf2013-02-05 21:52:47 +00001680 // Set DwarfCompileUnitID in MCContext to default value.
1681 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001682
Devang Patelbf47fdb2011-08-10 20:55:27 +00001683 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1684 collectVariableInfo(MF, ProcessedVars);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001685
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001686 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Patel94c7ddb2011-08-16 22:09:43 +00001687 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky746cb672011-10-26 22:55:33 +00001688 assert(TheCU && "Unable to find compile unit!");
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001689
Devang Patelbf47fdb2011-08-10 20:55:27 +00001690 // Construct abstract scopes.
Devang Patelcd9f6c52011-08-12 18:10:19 +00001691 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1692 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1693 LexicalScope *AScope = AList[i];
1694 DISubprogram SP(AScope->getScopeNode());
Manman Rend03d2b22013-07-08 18:33:29 +00001695 if (SP.isSubprogram()) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001696 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001697 DIArray Variables = SP.getVariables();
1698 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1699 DIVariable DV(Variables.getElement(i));
Manman Rend03d2b22013-07-08 18:33:29 +00001700 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
Devang Patel93d39be2011-08-19 23:28:12 +00001701 continue;
Alexey Samsonovb67bd332012-07-06 08:45:08 +00001702 // Check that DbgVariable for DV wasn't created earlier, when
1703 // findAbstractVariable() was called for inlined instance of DV.
1704 LLVMContext &Ctx = DV->getContext();
1705 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1706 if (AbstractVariables.lookup(CleanDV))
1707 continue;
Devang Patel93d39be2011-08-19 23:28:12 +00001708 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1709 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel78e127d2010-06-25 22:07:34 +00001710 }
1711 }
Devang Patelcd9f6c52011-08-12 18:10:19 +00001712 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Manman Ren742671b2013-05-29 17:16:59 +00001713 constructScopeDIE(TheCU, AScope);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001714 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001715
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001716 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001717
Nick Lewycky8a8d4792011-12-02 22:16:29 +00001718 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopher873cf0a2012-08-24 01:14:27 +00001719 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001720
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001721 // Clear debug info
Craig Topper01eb99a2013-07-03 04:40:27 +00001722 for (ScopeVariablesMap::iterator
Devang Patelbf47fdb2011-08-10 20:55:27 +00001723 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1724 DeleteContainerPointers(I->second);
1725 ScopeVariables.clear();
Devang Pateleac0c9d2011-04-22 18:09:57 +00001726 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001727 UserVariables.clear();
1728 DbgValues.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001729 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00001730 LabelsBeforeInsn.clear();
1731 LabelsAfterInsn.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00001732 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001733}
1734
Eric Christopherb6dc8652012-11-27 22:43:45 +00001735// Register a source line with debug info. Returns the unique label that was
1736// emitted and which provides correspondence to the source line list.
Devang Patel4243e672011-05-11 19:22:19 +00001737void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1738 unsigned Flags) {
Devang Patel65dbc902009-11-25 17:36:49 +00001739 StringRef Fn;
Devang Patel23670e52011-03-24 20:30:50 +00001740 StringRef Dir;
Dan Gohman1cc0d622010-05-05 23:41:32 +00001741 unsigned Src = 1;
1742 if (S) {
1743 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00001744
Dan Gohman1cc0d622010-05-05 23:41:32 +00001745 if (Scope.isCompileUnit()) {
1746 DICompileUnit CU(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001747 Fn = CU.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001748 Dir = CU.getDirectory();
Devang Patel3cabc9d2010-10-28 17:30:52 +00001749 } else if (Scope.isFile()) {
1750 DIFile F(S);
Devang Patel3cabc9d2010-10-28 17:30:52 +00001751 Fn = F.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001752 Dir = F.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001753 } else if (Scope.isSubprogram()) {
1754 DISubprogram SP(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001755 Fn = SP.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001756 Dir = SP.getDirectory();
Eric Christopher6618a242011-10-11 22:59:11 +00001757 } else if (Scope.isLexicalBlockFile()) {
1758 DILexicalBlockFile DBF(S);
1759 Fn = DBF.getFilename();
1760 Dir = DBF.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001761 } else if (Scope.isLexicalBlock()) {
1762 DILexicalBlock DB(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001763 Fn = DB.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001764 Dir = DB.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001765 } else
Craig Topper5e25ee82012-02-05 08:31:47 +00001766 llvm_unreachable("Unexpected scope info");
Dan Gohman1cc0d622010-05-05 23:41:32 +00001767
Manman Ren3de61b42013-03-07 01:42:00 +00001768 Src = getOrCreateSourceID(Fn, Dir,
1769 Asm->OutStreamer.getContext().getDwarfCompileUnitID());
Dan Gohman1cc0d622010-05-05 23:41:32 +00001770 }
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001771 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001772}
1773
Bill Wendling829e67b2009-05-20 23:22:40 +00001774//===----------------------------------------------------------------------===//
1775// Emit Methods
1776//===----------------------------------------------------------------------===//
1777
Eric Christopherb6dc8652012-11-27 22:43:45 +00001778// Compute the size and offset of a DIE.
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001779unsigned
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001780DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001781 // Get the children.
1782 const std::vector<DIE *> &Children = Die->getChildren();
1783
Bill Wendling94d04b82009-05-20 23:21:38 +00001784 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001785 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00001786
1787 // Get the abbreviation for this DIE.
1788 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001789 const DIEAbbrev *Abbrev = Abbreviations->at(AbbrevNumber - 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00001790
1791 // Set DIE offset
1792 Die->setOffset(Offset);
1793
1794 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00001795 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001796
Eric Christopherf7cef702013-03-29 23:34:06 +00001797 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1798 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling94d04b82009-05-20 23:21:38 +00001799
1800 // Size the DIE attribute values.
1801 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1802 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00001803 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00001804
1805 // Size the DIE children if any.
1806 if (!Children.empty()) {
1807 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1808 "Children flag not set");
1809
1810 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopherfbd19752012-11-20 22:14:13 +00001811 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling94d04b82009-05-20 23:21:38 +00001812
1813 // End of children marker.
1814 Offset += sizeof(int8_t);
1815 }
1816
1817 Die->setSize(Offset - Die->getOffset());
1818 return Offset;
1819}
1820
Eric Christopherb6dc8652012-11-27 22:43:45 +00001821// Compute the size and offset of all the DIEs.
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001822void DwarfUnits::computeSizeAndOffsets() {
Manman Renbc3e96f2013-03-12 18:27:15 +00001823 // Offset from the beginning of debug info section.
Eric Christopherd2df98f2013-05-30 00:43:35 +00001824 unsigned SecOffset = 0;
Eric Christopherf7cef702013-03-29 23:34:06 +00001825 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001826 E = CUs.end(); I != E; ++I) {
Eric Christopherd2df98f2013-05-30 00:43:35 +00001827 (*I)->setDebugInfoOffset(SecOffset);
Eric Christopher98e237f2012-11-30 23:59:06 +00001828 unsigned Offset =
1829 sizeof(int32_t) + // Length of Compilation Unit Info
1830 sizeof(int16_t) + // DWARF version number
1831 sizeof(int32_t) + // Offset Into Abbrev. Section
1832 sizeof(int8_t); // Pointer Size (in bytes)
1833
Manman Renbc3e96f2013-03-12 18:27:15 +00001834 unsigned EndOffset = computeSizeAndOffset((*I)->getCUDie(), Offset);
Eric Christopherd2df98f2013-05-30 00:43:35 +00001835 SecOffset += EndOffset;
Devang Patel163a9f72010-05-10 22:49:55 +00001836 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001837}
1838
Eric Christopherb6dc8652012-11-27 22:43:45 +00001839// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001840void DwarfDebug::emitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001841 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001842
Bill Wendling94d04b82009-05-20 23:21:38 +00001843 // Dwarf sections base addresses.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001844 DwarfInfoSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001845 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00001846 DwarfAbbrevSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001847 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher6eebe472012-12-19 22:02:53 +00001848 if (useSplitDwarf())
1849 DwarfAbbrevDWOSectionSym =
1850 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1851 "section_abbrev_dwo");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001852 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001853
Chris Lattner9c69e285532010-04-04 22:59:04 +00001854 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001855 emitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00001856
Eric Christopher7a0103c2013-02-07 21:19:50 +00001857 DwarfLineSectionSym =
1858 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001859 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00001860 if (GenerateDwarfPubNamesSection)
1861 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001862 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001863 DwarfStrSectionSym =
Eric Christopher64f824c2012-12-27 02:14:01 +00001864 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher9a9e73b2013-04-07 03:43:09 +00001865 if (useSplitDwarf()) {
Eric Christopher64f824c2012-12-27 02:14:01 +00001866 DwarfStrDWOSectionSym =
1867 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher9a9e73b2013-04-07 03:43:09 +00001868 DwarfAddrSectionSym =
1869 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
1870 }
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001871 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patelf2548ca2010-04-16 23:33:45 +00001872 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00001873
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001874 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patelc3f5f782010-05-25 23:40:22 +00001875 "section_debug_loc");
1876
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001877 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
1878 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00001879}
1880
Eric Christopherb6dc8652012-11-27 22:43:45 +00001881// Recursively emits a debug information entry.
Eric Christopher6eebe472012-12-19 22:02:53 +00001882void DwarfDebug::emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001883 // Get the abbreviation for this DIE.
1884 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher6eebe472012-12-19 22:02:53 +00001885 const DIEAbbrev *Abbrev = Abbrevs->at(AbbrevNumber - 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00001886
Bill Wendling94d04b82009-05-20 23:21:38 +00001887 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00001888 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00001889 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
1890 Twine::utohexstr(Die->getOffset()) + ":0x" +
1891 Twine::utohexstr(Die->getSize()) + " " +
1892 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00001893 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001894
Eric Christopherf7cef702013-03-29 23:34:06 +00001895 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1896 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling94d04b82009-05-20 23:21:38 +00001897
1898 // Emit the DIE attribute values.
1899 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1900 unsigned Attr = AbbrevData[i].getAttribute();
1901 unsigned Form = AbbrevData[i].getForm();
1902 assert(Form && "Too many attributes for DIE (check abbreviation)");
1903
Chris Lattner3f53c832010-04-04 18:52:31 +00001904 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00001905 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001906
Bill Wendling94d04b82009-05-20 23:21:38 +00001907 switch (Attr) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001908 case dwarf::DW_AT_abstract_origin: {
1909 DIEEntry *E = cast<DIEEntry>(Values[i]);
1910 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00001911 unsigned Addr = Origin->getOffset();
Manman Renbc3e96f2013-03-12 18:27:15 +00001912 if (Form == dwarf::DW_FORM_ref_addr) {
1913 // For DW_FORM_ref_addr, output the offset from beginning of debug info
1914 // section. Origin->getOffset() returns the offset from start of the
1915 // compile unit.
1916 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
1917 Addr += Holder.getCUOffset(Origin->getCompileUnit());
1918 }
Manman Ren0e6783f2013-07-02 23:40:10 +00001919 Asm->OutStreamer.EmitIntValue(Addr,
1920 Form == dwarf::DW_FORM_ref_addr ? DIEEntry::getRefAddrSize(Asm) : 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00001921 break;
1922 }
Devang Patelf2548ca2010-04-16 23:33:45 +00001923 case dwarf::DW_AT_ranges: {
1924 // DW_AT_range Value encodes offset in debug_range section.
1925 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelb1fcfbe2010-09-02 16:43:44 +00001926
Nick Lewyckyffccd922012-06-22 01:25:12 +00001927 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelb1fcfbe2010-09-02 16:43:44 +00001928 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
1929 V->getValue(),
1930 4);
1931 } else {
1932 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
1933 V->getValue(),
1934 DwarfDebugRangeSectionSym,
1935 4);
1936 }
Devang Patelf2548ca2010-04-16 23:33:45 +00001937 break;
1938 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001939 case dwarf::DW_AT_location: {
Nick Lewyckyffccd922012-06-22 01:25:12 +00001940 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
1941 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Ulrich Weigand1f8aacd2013-07-02 18:46:26 +00001942 Asm->EmitLabelReference(L->getValue(), 4);
Nick Lewyckyffccd922012-06-22 01:25:12 +00001943 else
Ulrich Weigand1f8aacd2013-07-02 18:46:26 +00001944 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewyckyffccd922012-06-22 01:25:12 +00001945 } else {
Devang Patelc3f5f782010-05-25 23:40:22 +00001946 Values[i]->EmitValue(Asm, Form);
Nick Lewyckyffccd922012-06-22 01:25:12 +00001947 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001948 break;
1949 }
Devang Patel2a361602010-09-29 19:08:08 +00001950 case dwarf::DW_AT_accessibility: {
1951 if (Asm->isVerbose()) {
1952 DIEInteger *V = cast<DIEInteger>(Values[i]);
1953 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
1954 }
1955 Values[i]->EmitValue(Asm, Form);
1956 break;
1957 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001958 default:
1959 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001960 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00001961 break;
1962 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001963 }
1964
1965 // Emit the DIE children if any.
1966 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
1967 const std::vector<DIE *> &Children = Die->getChildren();
1968
1969 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher6eebe472012-12-19 22:02:53 +00001970 emitDIE(Children[j], Abbrevs);
Bill Wendling94d04b82009-05-20 23:21:38 +00001971
Chris Lattner3f53c832010-04-04 18:52:31 +00001972 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00001973 Asm->OutStreamer.AddComment("End Of Children Mark");
1974 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00001975 }
1976}
1977
Eric Christopherb1e66d02012-12-15 00:04:07 +00001978// Emit the various dwarf units to the unit section USection with
1979// the abbreviations going into ASection.
1980void DwarfUnits::emitUnits(DwarfDebug *DD,
1981 const MCSection *USection,
1982 const MCSection *ASection,
1983 const MCSymbol *ASectionSym) {
1984 Asm->OutStreamer.SwitchSection(USection);
Eric Christopherf7cef702013-03-29 23:34:06 +00001985 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopherb1e66d02012-12-15 00:04:07 +00001986 E = CUs.end(); I != E; ++I) {
1987 CompileUnit *TheCU = *I;
Devang Patel163a9f72010-05-10 22:49:55 +00001988 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001989
Devang Patel163a9f72010-05-10 22:49:55 +00001990 // Emit the compile units header.
Eric Christopherb1e66d02012-12-15 00:04:07 +00001991 Asm->OutStreamer
1992 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
1993 TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001994
Devang Patel163a9f72010-05-10 22:49:55 +00001995 // Emit size of content not including length itself
1996 unsigned ContentSize = Die->getSize() +
1997 sizeof(int16_t) + // DWARF version number
1998 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patel65705d52011-04-13 19:41:17 +00001999 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbach1e20b962010-07-21 21:21:52 +00002000
Devang Patel163a9f72010-05-10 22:49:55 +00002001 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2002 Asm->EmitInt32(ContentSize);
2003 Asm->OutStreamer.AddComment("DWARF version number");
Manman Ren0e6783f2013-07-02 23:40:10 +00002004 Asm->EmitInt16(DD->getDwarfVersion());
Devang Patel163a9f72010-05-10 22:49:55 +00002005 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
Eric Christopherb1e66d02012-12-15 00:04:07 +00002006 Asm->EmitSectionOffset(Asm->GetTempSymbol(ASection->getLabelBeginName()),
2007 ASectionSym);
Devang Patel163a9f72010-05-10 22:49:55 +00002008 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002009 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002010
Eric Christopher6eebe472012-12-19 22:02:53 +00002011 DD->emitDIE(Die, Abbreviations);
Eric Christopherb1e66d02012-12-15 00:04:07 +00002012 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002013 TheCU->getUniqueID()));
Devang Patel163a9f72010-05-10 22:49:55 +00002014 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002015}
2016
Manman Renbc3e96f2013-03-12 18:27:15 +00002017/// For a given compile unit DIE, returns offset from beginning of debug info.
2018unsigned DwarfUnits::getCUOffset(DIE *Die) {
Manman Ren4c6f8952013-03-13 18:41:27 +00002019 assert(Die->getTag() == dwarf::DW_TAG_compile_unit &&
2020 "Input DIE should be compile unit in getCUOffset.");
Eric Christopherf7cef702013-03-29 23:34:06 +00002021 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Manman Renbc3e96f2013-03-12 18:27:15 +00002022 E = CUs.end(); I != E; ++I) {
2023 CompileUnit *TheCU = *I;
2024 if (TheCU->getCUDie() == Die)
2025 return TheCU->getDebugInfoOffset();
2026 }
Manman Ren4c6f8952013-03-13 18:41:27 +00002027 llvm_unreachable("The compile unit DIE should belong to CUs in DwarfUnits.");
Manman Renbc3e96f2013-03-12 18:27:15 +00002028}
2029
Eric Christopher98e237f2012-11-30 23:59:06 +00002030// Emit the debug info section.
2031void DwarfDebug::emitDebugInfo() {
Eric Christopherb1e66d02012-12-15 00:04:07 +00002032 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2033
2034 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
2035 Asm->getObjFileLowering().getDwarfAbbrevSection(),
2036 DwarfAbbrevSectionSym);
Eric Christopher98e237f2012-11-30 23:59:06 +00002037}
2038
Eric Christopherb6dc8652012-11-27 22:43:45 +00002039// Emit the abbreviation section.
Eric Christopher7dc68db2012-11-20 23:30:11 +00002040void DwarfDebug::emitAbbreviations() {
Eric Christopher6eebe472012-12-19 22:02:53 +00002041 if (!useSplitDwarf())
2042 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
2043 &Abbreviations);
2044 else
2045 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2046}
Bill Wendling94d04b82009-05-20 23:21:38 +00002047
Eric Christopher6eebe472012-12-19 22:02:53 +00002048void DwarfDebug::emitAbbrevs(const MCSection *Section,
2049 std::vector<DIEAbbrev *> *Abbrevs) {
2050 // Check to see if it is worth the effort.
2051 if (!Abbrevs->empty()) {
2052 // Start the debug abbrev section.
2053 Asm->OutStreamer.SwitchSection(Section);
2054
2055 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
Eric Christopher44fedba2012-12-13 03:00:38 +00002056 Asm->OutStreamer.EmitLabel(Begin);
Bill Wendling94d04b82009-05-20 23:21:38 +00002057
2058 // For each abbrevation.
Eric Christopher6eebe472012-12-19 22:02:53 +00002059 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002060 // Get abbreviation data
Eric Christopher6eebe472012-12-19 22:02:53 +00002061 const DIEAbbrev *Abbrev = Abbrevs->at(i);
Bill Wendling94d04b82009-05-20 23:21:38 +00002062
2063 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002064 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00002065
2066 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002067 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00002068 }
2069
2070 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002071 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00002072
Eric Christopher6eebe472012-12-19 22:02:53 +00002073 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
Eric Christopher44fedba2012-12-13 03:00:38 +00002074 Asm->OutStreamer.EmitLabel(End);
Bill Wendling94d04b82009-05-20 23:21:38 +00002075 }
2076}
2077
Eric Christopherb6dc8652012-11-27 22:43:45 +00002078// Emit the last address of the section and the end of the line matrix.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002079void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002080 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00002081 Asm->OutStreamer.AddComment("Extended Op");
2082 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002083
Chris Lattner233f52b2010-03-09 23:52:58 +00002084 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002085 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00002086 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2087 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2088
2089 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00002090
Chris Lattnerc0215722010-04-04 19:25:43 +00002091 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Eric Christopherca1dd052013-01-09 01:35:34 +00002092 Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002093
2094 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00002095 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2096 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00002097 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00002098 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00002099}
2100
Eric Christopherb6dc8652012-11-27 22:43:45 +00002101// Emit visible names into a hashed accelerator table section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002102void DwarfDebug::emitAccelNames() {
2103 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2104 dwarf::DW_FORM_data4));
2105 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2106 E = CUMap.end(); I != E; ++I) {
2107 CompileUnit *TheCU = I->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00002108 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2109 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002110 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002111 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002112 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00002113 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2114 DE = Entities.end(); DI != DE; ++DI)
2115 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00002116 }
2117 }
2118
2119 AT.FinalizeTable(Asm, "Names");
2120 Asm->OutStreamer.SwitchSection(
2121 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2122 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2123 Asm->OutStreamer.EmitLabel(SectionBegin);
2124
2125 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002126 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002127}
2128
Eric Christopher72c16552012-12-20 21:58:40 +00002129// Emit objective C classes and categories into a hashed accelerator table
2130// section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002131void DwarfDebug::emitAccelObjC() {
2132 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2133 dwarf::DW_FORM_data4));
2134 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2135 E = CUMap.end(); I != E; ++I) {
2136 CompileUnit *TheCU = I->second;
2137 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2138 for (StringMap<std::vector<DIE*> >::const_iterator
2139 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002140 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002141 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher09ac3d82011-11-07 09:24:32 +00002142 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2143 DE = Entities.end(); DI != DE; ++DI)
2144 AT.AddName(Name, (*DI));
2145 }
2146 }
2147
2148 AT.FinalizeTable(Asm, "ObjC");
2149 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2150 .getDwarfAccelObjCSection());
2151 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2152 Asm->OutStreamer.EmitLabel(SectionBegin);
2153
2154 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002155 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002156}
2157
Eric Christopherb6dc8652012-11-27 22:43:45 +00002158// Emit namespace dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002159void DwarfDebug::emitAccelNamespaces() {
2160 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2161 dwarf::DW_FORM_data4));
2162 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2163 E = CUMap.end(); I != E; ++I) {
2164 CompileUnit *TheCU = I->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00002165 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2166 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002167 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002168 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002169 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00002170 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2171 DE = Entities.end(); DI != DE; ++DI)
2172 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00002173 }
2174 }
2175
2176 AT.FinalizeTable(Asm, "namespac");
2177 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2178 .getDwarfAccelNamespaceSection());
2179 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2180 Asm->OutStreamer.EmitLabel(SectionBegin);
2181
2182 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002183 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002184}
2185
Eric Christopherb6dc8652012-11-27 22:43:45 +00002186// Emit type dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002187void DwarfDebug::emitAccelTypes() {
Eric Christopherc36145f2012-01-06 04:35:23 +00002188 std::vector<DwarfAccelTable::Atom> Atoms;
2189 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2190 dwarf::DW_FORM_data4));
2191 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTag,
2192 dwarf::DW_FORM_data2));
2193 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTypeFlags,
2194 dwarf::DW_FORM_data1));
2195 DwarfAccelTable AT(Atoms);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002196 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2197 E = CUMap.end(); I != E; ++I) {
2198 CompileUnit *TheCU = I->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002199 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2200 = TheCU->getAccelTypes();
2201 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002202 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer03406c42013-05-11 18:24:28 +00002203 StringRef Name = GI->getKey();
Eric Christopherfa03db02012-01-06 23:03:34 +00002204 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002205 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2206 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2207 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002208 }
2209 }
2210
2211 AT.FinalizeTable(Asm, "types");
2212 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2213 .getDwarfAccelTypesSection());
2214 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2215 Asm->OutStreamer.EmitLabel(SectionBegin);
2216
2217 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002218 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002219}
2220
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002221/// emitDebugPubnames - Emit visible names into a debug pubnames section.
2222///
2223void DwarfDebug::emitDebugPubnames() {
2224 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2225
2226 typedef DenseMap<const MDNode*, CompileUnit*> CUMapType;
2227 for (CUMapType::iterator I = CUMap.begin(), E = CUMap.end(); I != E; ++I) {
2228 CompileUnit *TheCU = I->second;
2229 unsigned ID = TheCU->getUniqueID();
2230
2231 if (TheCU->getGlobalNames().empty())
2232 continue;
2233
2234 // Start the dwarf pubnames section.
2235 Asm->OutStreamer.SwitchSection(
2236 Asm->getObjFileLowering().getDwarfPubNamesSection());
2237
2238 Asm->OutStreamer.AddComment("Length of Public Names Info");
2239 Asm->EmitLabelDifference(Asm->GetTempSymbol("pubnames_end", ID),
2240 Asm->GetTempSymbol("pubnames_begin", ID), 4);
2241
2242 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin", ID));
2243
2244 Asm->OutStreamer.AddComment("DWARF Version");
Manman Ren0e6783f2013-07-02 23:40:10 +00002245 Asm->EmitInt16(DwarfVersion);
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002246
2247 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2248 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2249 DwarfInfoSectionSym);
2250
2251 Asm->OutStreamer.AddComment("Compilation Unit Length");
2252 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(), ID),
2253 Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2254 4);
2255
2256 const StringMap<DIE*> &Globals = TheCU->getGlobalNames();
2257 for (StringMap<DIE*>::const_iterator
2258 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2259 const char *Name = GI->getKeyData();
2260 const DIE *Entity = GI->second;
2261
2262 Asm->OutStreamer.AddComment("DIE offset");
2263 Asm->EmitInt32(Entity->getOffset());
2264
2265 if (Asm->isVerbose())
2266 Asm->OutStreamer.AddComment("External Name");
Rafael Espindolaa3863ea2013-07-02 15:49:13 +00002267 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +00002268 }
2269
2270 Asm->OutStreamer.AddComment("End Mark");
2271 Asm->EmitInt32(0);
2272 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end", ID));
2273 }
2274}
2275
Devang Patel193f7202009-11-24 01:14:22 +00002276void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00002277 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2278 E = CUMap.end(); I != E; ++I) {
2279 CompileUnit *TheCU = I->second;
Eric Christopher63701182011-11-07 09:18:35 +00002280 // Start the dwarf pubtypes section.
Devang Patel163a9f72010-05-10 22:49:55 +00002281 Asm->OutStreamer.SwitchSection(
2282 Asm->getObjFileLowering().getDwarfPubTypesSection());
2283 Asm->OutStreamer.AddComment("Length of Public Types Info");
2284 Asm->EmitLabelDifference(
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002285 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2286 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002287
Devang Patel163a9f72010-05-10 22:49:55 +00002288 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002289 TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002290
Devang Patel163a9f72010-05-10 22:49:55 +00002291 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
Manman Ren0e6783f2013-07-02 23:40:10 +00002292 Asm->EmitInt16(DwarfVersion);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002293
Devang Patel163a9f72010-05-10 22:49:55 +00002294 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eric Christophercf6b8ad2012-12-15 00:04:04 +00002295 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2296 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002297 TheCU->getUniqueID()),
Devang Patel163a9f72010-05-10 22:49:55 +00002298 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002299
Devang Patel163a9f72010-05-10 22:49:55 +00002300 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eric Christophercf6b8ad2012-12-15 00:04:04 +00002301 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002302 TheCU->getUniqueID()),
Eric Christophercf6b8ad2012-12-15 00:04:04 +00002303 Asm->GetTempSymbol(ISec->getLabelBeginName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002304 TheCU->getUniqueID()),
Devang Patel163a9f72010-05-10 22:49:55 +00002305 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002306
Devang Patel163a9f72010-05-10 22:49:55 +00002307 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
2308 for (StringMap<DIE*>::const_iterator
2309 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2310 const char *Name = GI->getKeyData();
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00002311 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002312
Devang Patel163a9f72010-05-10 22:49:55 +00002313 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
2314 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002315
Devang Patel163a9f72010-05-10 22:49:55 +00002316 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
Benjamin Kramer983c4572011-11-09 18:16:11 +00002317 // Emit the name with a terminating null byte.
Eric Christopher68ca5622013-01-09 01:57:54 +00002318 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Devang Patel163a9f72010-05-10 22:49:55 +00002319 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002320
Devang Patel163a9f72010-05-10 22:49:55 +00002321 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00002322 Asm->EmitInt32(0);
Devang Patel163a9f72010-05-10 22:49:55 +00002323 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002324 TheCU->getUniqueID()));
Devang Patel193f7202009-11-24 01:14:22 +00002325 }
Devang Patel193f7202009-11-24 01:14:22 +00002326}
2327
Eric Christopher64f824c2012-12-27 02:14:01 +00002328// Emit strings into a string section.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002329void DwarfUnits::emitStrings(const MCSection *StrSection,
2330 const MCSection *OffsetSection = NULL,
2331 const MCSymbol *StrSecSym = NULL) {
Eric Christopher64f824c2012-12-27 02:14:01 +00002332
Eric Christopherb6714222013-01-08 22:22:06 +00002333 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002334
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002335 // Start the dwarf str section.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002336 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling94d04b82009-05-20 23:21:38 +00002337
Chris Lattnerbc733f52010-03-13 02:17:42 +00002338 // Get all of the string pool entries and put them in an array by their ID so
2339 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002340 SmallVector<std::pair<unsigned,
Eric Christopherff348452013-01-07 22:40:45 +00002341 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002342
Chris Lattnerbc733f52010-03-13 02:17:42 +00002343 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
Eric Christopherb6714222013-01-08 22:22:06 +00002344 I = StringPool.begin(), E = StringPool.end();
Eric Christopher72c16552012-12-20 21:58:40 +00002345 I != E; ++I)
Chris Lattnerbc733f52010-03-13 02:17:42 +00002346 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002347
Chris Lattnerbc733f52010-03-13 02:17:42 +00002348 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002349
Chris Lattnerbc733f52010-03-13 02:17:42 +00002350 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002351 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00002352 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002353
Benjamin Kramer983c4572011-11-09 18:16:11 +00002354 // Emit the string itself with a terminating null byte.
Benjamin Kramer0c45f7d2011-11-09 12:12:04 +00002355 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
Eric Christopherca1dd052013-01-09 01:35:34 +00002356 Entries[i].second->getKeyLength()+1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002357 }
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002358
2359 // If we've got an offset section go ahead and emit that now as well.
2360 if (OffsetSection) {
2361 Asm->OutStreamer.SwitchSection(OffsetSection);
2362 unsigned offset = 0;
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002363 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002364 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopher1ced2082013-01-09 03:52:05 +00002365 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002366 offset += Entries[i].second->getKeyLength() + 1;
2367 }
2368 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002369}
2370
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002371// Emit strings into a string section.
2372void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2373
2374 if (AddressPool.empty()) return;
2375
2376 // Start the dwarf addr section.
2377 Asm->OutStreamer.SwitchSection(AddrSection);
2378
David Blaikie66f464e2013-07-08 17:51:28 +00002379 // Order the address pool entries by ID
David Blaikie5ce40912013-07-08 17:33:10 +00002380 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002381
David Blaikie66f464e2013-07-08 17:51:28 +00002382 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2383 E = AddressPool.end();
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002384 I != E; ++I)
David Blaikie5ce40912013-07-08 17:33:10 +00002385 Entries[I->second] = I->first;
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002386
2387 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Ulrich Weigand18dbe502013-07-02 18:46:46 +00002388 // Emit an expression for reference from debug information entries.
David Blaikie5ce40912013-07-08 17:33:10 +00002389 if (const MCExpr *Expr = Entries[i])
Ulrich Weigand18dbe502013-07-02 18:46:46 +00002390 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002391 else
2392 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2393 }
2394
2395}
2396
Eric Christopher64f824c2012-12-27 02:14:01 +00002397// Emit visible names into a debug str section.
2398void DwarfDebug::emitDebugStr() {
2399 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2400 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2401}
2402
Eric Christopherd3b98532013-07-02 21:36:07 +00002403// Emit locations into the debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002404void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00002405 if (DotDebugLocEntries.empty())
2406 return;
2407
Eric Christopherf7cef702013-03-29 23:34:06 +00002408 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Devang Patel6c3ea902011-02-04 22:57:18 +00002409 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2410 I != E; ++I) {
2411 DotDebugLocEntry &Entry = *I;
2412 if (I + 1 != DotDebugLocEntries.end())
2413 Entry.Merge(I+1);
2414 }
2415
Daniel Dunbar83320a02011-03-16 22:16:39 +00002416 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002417 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00002418 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002419 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00002420 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2421 unsigned index = 1;
Eric Christopherf7cef702013-03-29 23:34:06 +00002422 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00002423 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00002424 I != E; ++I, ++index) {
Devang Patel6c3ea902011-02-04 22:57:18 +00002425 DotDebugLocEntry &Entry = *I;
2426 if (Entry.isMerged()) continue;
Devang Patelc3f5f782010-05-25 23:40:22 +00002427 if (Entry.isEmpty()) {
Eric Christopherca1dd052013-01-09 01:35:34 +00002428 Asm->OutStreamer.EmitIntValue(0, Size);
2429 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel80250682010-05-26 23:55:23 +00002430 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00002431 } else {
Eric Christopher0d0782a2013-07-03 22:40:18 +00002432 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2433 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2434 DIVariable DV(Entry.getVariable());
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002435 Asm->OutStreamer.AddComment("Loc expr size");
2436 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2437 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2438 Asm->EmitLabelDifference(end, begin, 2);
2439 Asm->OutStreamer.EmitLabel(begin);
Devang Patel80efd4e2011-07-08 16:49:43 +00002440 if (Entry.isInt()) {
Devang Patelc4329072011-06-01 22:03:25 +00002441 DIBasicType BTy(DV.getType());
2442 if (BTy.Verify() &&
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002443 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patelc4329072011-06-01 22:03:25 +00002444 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2445 Asm->OutStreamer.AddComment("DW_OP_consts");
2446 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Patel80efd4e2011-07-08 16:49:43 +00002447 Asm->EmitSLEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002448 } else {
2449 Asm->OutStreamer.AddComment("DW_OP_constu");
2450 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Patel80efd4e2011-07-08 16:49:43 +00002451 Asm->EmitULEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002452 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002453 } else if (Entry.isLocation()) {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002454 MachineLocation Loc = Entry.getLoc();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002455 if (!DV.hasComplexAddress())
Devang Patel80efd4e2011-07-08 16:49:43 +00002456 // Regular entry.
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002457 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002458 else {
2459 // Complex address entry.
2460 unsigned N = DV.getNumAddrElements();
2461 unsigned i = 0;
2462 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002463 if (Loc.getOffset()) {
Devang Patel80efd4e2011-07-08 16:49:43 +00002464 i = 2;
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002465 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002466 Asm->OutStreamer.AddComment("DW_OP_deref");
2467 Asm->EmitInt8(dwarf::DW_OP_deref);
2468 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2469 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2470 Asm->EmitSLEB128(DV.getAddrElement(1));
2471 } else {
2472 // If first address element is OpPlus then emit
2473 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002474 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2475 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002476 i = 2;
2477 }
2478 } else {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002479 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Patel80efd4e2011-07-08 16:49:43 +00002480 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002481
Devang Patel80efd4e2011-07-08 16:49:43 +00002482 // Emit remaining complex address elements.
2483 for (; i < N; ++i) {
2484 uint64_t Element = DV.getAddrElement(i);
2485 if (Element == DIBuilder::OpPlus) {
2486 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2487 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher50120762012-05-08 18:56:00 +00002488 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher7c2f3e82013-07-03 22:40:21 +00002489 if (!Loc.isReg())
Eric Christopher50120762012-05-08 18:56:00 +00002490 Asm->EmitInt8(dwarf::DW_OP_deref);
2491 } else
2492 llvm_unreachable("unknown Opcode found in complex address");
Devang Patel80efd4e2011-07-08 16:49:43 +00002493 }
Devang Patelc26f5442011-04-28 02:22:40 +00002494 }
Devang Patelc26f5442011-04-28 02:22:40 +00002495 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002496 // else ... ignore constant fp. There is not any good way to
2497 // to represent them here in dwarf.
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002498 Asm->OutStreamer.EmitLabel(end);
Devang Patelc3f5f782010-05-25 23:40:22 +00002499 }
2500 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002501}
2502
Eric Christopherb6dc8652012-11-27 22:43:45 +00002503// Emit visible names into a debug aranges section.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002504void DwarfDebug::emitDebugARanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002505 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002506 Asm->OutStreamer.SwitchSection(
2507 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002508}
2509
Eric Christopherb6dc8652012-11-27 22:43:45 +00002510// Emit visible names into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002511void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002512 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002513 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00002514 Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002515 unsigned char Size = Asm->getDataLayout().getPointerSize();
Eric Christopherf7cef702013-03-29 23:34:06 +00002516 for (SmallVectorImpl<const MCSymbol *>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00002517 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00002518 I != E; ++I) {
2519 if (*I)
Eric Christopher1ced2082013-01-09 03:52:05 +00002520 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
Devang Patelf2548ca2010-04-16 23:33:45 +00002521 else
Eric Christopherca1dd052013-01-09 01:35:34 +00002522 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patelf2548ca2010-04-16 23:33:45 +00002523 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002524}
2525
Eric Christopherb6dc8652012-11-27 22:43:45 +00002526// Emit visible names into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002527void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002528 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00002529 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002530 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002531 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002532 }
2533}
2534
Eric Christopherb6dc8652012-11-27 22:43:45 +00002535// Emit inline info using following format.
2536// Section Header:
2537// 1. length of section
2538// 2. Dwarf version number
2539// 3. address size.
2540//
2541// Entries (one "entry" for each function that was inlined):
2542//
2543// 1. offset into __debug_str section for MIPS linkage name, if exists;
2544// otherwise offset into __debug_str for regular function name.
2545// 2. offset into __debug_str section for regular function name.
2546// 3. an unsigned LEB128 number indicating the number of distinct inlining
2547// instances for the function.
2548//
2549// The rest of the entry consists of a {die_offset, low_pc} pair for each
2550// inlined instance; the die_offset points to the inlined_subroutine die in the
2551// __debug_info section, and the low_pc is the starting address for the
2552// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002553void DwarfDebug::emitDebugInlineInfo() {
Eric Christopherb83e2bb2012-03-02 02:11:47 +00002554 if (!Asm->MAI->doesDwarfUseInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002555 return;
2556
Devang Patel163a9f72010-05-10 22:49:55 +00002557 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00002558 return;
2559
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002560 Asm->OutStreamer.SwitchSection(
2561 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00002562
Chris Lattner233f52b2010-03-09 23:52:58 +00002563 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00002564 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
2565 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00002566
Chris Lattnerc0215722010-04-04 19:25:43 +00002567 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002568
Chris Lattner233f52b2010-03-09 23:52:58 +00002569 Asm->OutStreamer.AddComment("Dwarf Version");
Manman Ren0e6783f2013-07-02 23:40:10 +00002570 Asm->EmitInt16(DwarfVersion);
Chris Lattner233f52b2010-03-09 23:52:58 +00002571 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002572 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002573
Eric Christopherf7cef702013-03-29 23:34:06 +00002574 for (SmallVectorImpl<const MDNode *>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00002575 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002576
Devang Patele9f8f5e2010-05-07 20:54:48 +00002577 const MDNode *Node = *I;
Craig Topper01eb99a2013-07-03 04:40:27 +00002578 InlineInfoMap::iterator II = InlineInfo.find(Node);
Eric Christopherf7cef702013-03-29 23:34:06 +00002579 SmallVectorImpl<InlineInfoLabels> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00002580 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00002581 StringRef LName = SP.getLinkageName();
2582 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00002583
Chris Lattner233f52b2010-03-09 23:52:58 +00002584 Asm->OutStreamer.AddComment("MIPS linkage name");
Eric Christopher50e26612012-03-02 01:57:52 +00002585 if (LName.empty())
Eric Christopher2e5d8702012-12-20 21:58:36 +00002586 Asm->EmitSectionOffset(InfoHolder.getStringPoolEntry(Name),
2587 DwarfStrSectionSym);
Eric Christopher50e26612012-03-02 01:57:52 +00002588 else
Benjamin Kramer7c2b4be2013-06-01 17:51:14 +00002589 Asm->EmitSectionOffset(
2590 InfoHolder.getStringPoolEntry(Function::getRealLinkageName(LName)),
2591 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00002592
Chris Lattner233f52b2010-03-09 23:52:58 +00002593 Asm->OutStreamer.AddComment("Function name");
Eric Christopher2e5d8702012-12-20 21:58:36 +00002594 Asm->EmitSectionOffset(InfoHolder.getStringPoolEntry(Name),
2595 DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002596 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00002597
Eric Christopherf7cef702013-03-29 23:34:06 +00002598 for (SmallVectorImpl<InlineInfoLabels>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00002599 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00002600 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00002601 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00002602
Chris Lattner3f53c832010-04-04 18:52:31 +00002603 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00002604 Asm->OutStreamer.EmitSymbolValue(LI->first,
Eric Christopher1ced2082013-01-09 03:52:05 +00002605 Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002606 }
2607 }
2608
Chris Lattnerc0215722010-04-04 19:25:43 +00002609 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002610}
Eric Christopher98e237f2012-11-30 23:59:06 +00002611
Eric Christopher0b944ee2012-12-11 19:42:09 +00002612// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher98e237f2012-11-30 23:59:06 +00002613
2614// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2615// DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2616// DW_AT_ranges_base, DW_AT_addr_base. If DW_AT_ranges is present,
2617// DW_AT_low_pc and DW_AT_high_pc are not used, and vice versa.
Eric Christopher4daaed12012-12-10 19:51:21 +00002618CompileUnit *DwarfDebug::constructSkeletonCU(const MDNode *N) {
Eric Christopher98e237f2012-11-30 23:59:06 +00002619 DICompileUnit DIUnit(N);
Eric Christopher98e237f2012-11-30 23:59:06 +00002620 CompilationDir = DIUnit.getDirectory();
Eric Christopher98e237f2012-11-30 23:59:06 +00002621
2622 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002623 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
Eric Christopher9c57ad22013-05-08 00:58:51 +00002624 DIUnit.getLanguage(), Die, N, Asm,
Eric Christopher64f824c2012-12-27 02:14:01 +00002625 this, &SkeletonHolder);
Eric Christopher446b88f2013-01-17 03:00:04 +00002626
Eric Christopher3ce51a92013-02-22 23:50:08 +00002627 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
2628 DIUnit.getSplitDebugFilename());
Eric Christopher98e237f2012-11-30 23:59:06 +00002629
Eric Christopher208cc6f2013-02-05 07:31:55 +00002630 // This should be a unique identifier when we want to build .dwp files.
2631 NewCU->addUInt(Die, dwarf::DW_AT_GNU_dwo_id, dwarf::DW_FORM_data8, 0);
Eric Christopherd96c72a2013-01-17 02:59:59 +00002632
Eric Christopher1b0cd2f2013-04-22 07:51:08 +00002633 // Relocate to the beginning of the addr_base section, else 0 for the
2634 // beginning of the one for this compile unit.
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002635 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2636 NewCU->addLabel(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2637 DwarfAddrSectionSym);
2638 else
Eric Christopher1b0cd2f2013-04-22 07:51:08 +00002639 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base,
2640 dwarf::DW_FORM_sec_offset, 0);
Eric Christopher98e237f2012-11-30 23:59:06 +00002641
2642 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002643 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher98e237f2012-11-30 23:59:06 +00002644 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002645
Eric Christopher98e237f2012-11-30 23:59:06 +00002646 // DW_AT_stmt_list is a offset of line number information for this
2647 // compile unit in debug_line section.
Eric Christopher9a9e73b2013-04-07 03:43:09 +00002648 // FIXME: Should handle multiple compile units.
Eric Christopher98e237f2012-11-30 23:59:06 +00002649 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher446b88f2013-01-17 03:00:04 +00002650 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher7a0103c2013-02-07 21:19:50 +00002651 DwarfLineSectionSym);
Eric Christopher98e237f2012-11-30 23:59:06 +00002652 else
Eric Christopher446b88f2013-01-17 03:00:04 +00002653 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher98e237f2012-11-30 23:59:06 +00002654
2655 if (!CompilationDir.empty())
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002656 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher98e237f2012-11-30 23:59:06 +00002657
Eric Christopher0e3e9b72012-12-10 23:34:43 +00002658 SkeletonHolder.addUnit(NewCU);
Eric Christopher01776a52013-02-06 21:53:56 +00002659 SkeletonCUs.push_back(NewCU);
Eric Christopher0e3e9b72012-12-10 23:34:43 +00002660
Eric Christopher98e237f2012-11-30 23:59:06 +00002661 return NewCU;
2662}
2663
Eric Christopher6eebe472012-12-19 22:02:53 +00002664void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
2665 assert(useSplitDwarf() && "No split dwarf debug info?");
2666 emitAbbrevs(Section, &SkeletonAbbrevs);
Eric Christopher98e237f2012-11-30 23:59:06 +00002667}
2668
Eric Christopher0b944ee2012-12-11 19:42:09 +00002669// Emit the .debug_info.dwo section for separated dwarf. This contains the
2670// compile units that would normally be in debug_info.
Eric Christopher98e237f2012-11-30 23:59:06 +00002671void DwarfDebug::emitDebugInfoDWO() {
Eric Christopher4daaed12012-12-10 19:51:21 +00002672 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christopherb1e66d02012-12-15 00:04:07 +00002673 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
Eric Christopher6eebe472012-12-19 22:02:53 +00002674 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2675 DwarfAbbrevDWOSectionSym);
2676}
2677
2678// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2679// abbreviations for the .debug_info.dwo section.
2680void DwarfDebug::emitDebugAbbrevDWO() {
2681 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopher72c16552012-12-20 21:58:40 +00002682 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2683 &Abbreviations);
Eric Christopher98e237f2012-11-30 23:59:06 +00002684}
Eric Christopher64f824c2012-12-27 02:14:01 +00002685
2686// Emit the .debug_str.dwo section for separated dwarf. This contains the
2687// string section and is identical in format to traditional .debug_str
2688// sections.
2689void DwarfDebug::emitDebugStrDWO() {
2690 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherff348452013-01-07 22:40:45 +00002691 const MCSection *OffSec = Asm->getObjFileLowering()
2692 .getDwarfStrOffDWOSection();
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002693 const MCSymbol *StrSym = DwarfStrSectionSym;
2694 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
2695 OffSec, StrSym);
Eric Christopher64f824c2012-12-27 02:14:01 +00002696}