blob: 2e5205205d02130d44f8257288865abd5e23848d [file] [log] [blame]
Bill Wendling2f921f82009-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 Lattnerb14490d2010-03-09 00:39:24 +000013
Devang Patel80ae3492009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling2f921f82009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000016#include "DIE.h"
Eric Christopher45731982013-08-08 23:45:55 +000017#include "DIEHash.h"
Eric Christopher4996c702011-11-07 09:24:32 +000018#include "DwarfAccelTable.h"
Devang Patel5eb43192011-04-12 17:40:32 +000019#include "DwarfCompileUnit.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000020#include "llvm/ADT/STLExtras.h"
21#include "llvm/ADT/Statistic.h"
22#include "llvm/ADT/StringExtras.h"
23#include "llvm/ADT/Triple.h"
David Greene829b3e82009-08-19 21:52:55 +000024#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000025#include "llvm/CodeGen/MachineModuleInfo.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000026#include "llvm/DIBuilder.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000027#include "llvm/DebugInfo.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000028#include "llvm/IR/Constants.h"
29#include "llvm/IR/DataLayout.h"
30#include "llvm/IR/Instructions.h"
31#include "llvm/IR/Module.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000032#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000033#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000034#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000035#include "llvm/MC/MCSymbol.h"
Devang Patel6c74a872010-04-27 19:46:33 +000036#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000037#include "llvm/Support/Debug.h"
David Majnemered89b5c2013-08-21 06:13:34 +000038#include "llvm/Support/Dwarf.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000039#include "llvm/Support/ErrorHandling.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000040#include "llvm/Support/FormattedStream.h"
Eric Christopher67646432013-07-26 17:02:41 +000041#include "llvm/Support/MD5.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000042#include "llvm/Support/Path.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000043#include "llvm/Support/Timer.h"
44#include "llvm/Support/ValueHandle.h"
45#include "llvm/Target/TargetFrameLowering.h"
46#include "llvm/Target/TargetLoweringObjectFile.h"
47#include "llvm/Target/TargetMachine.h"
48#include "llvm/Target/TargetOptions.h"
49#include "llvm/Target/TargetRegisterInfo.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000050using namespace llvm;
51
Eric Christopher7f2b5512013-07-23 22:16:41 +000052static cl::opt<bool>
53DisableDebugInfoPrinting("disable-debug-info-print", cl::Hidden,
54 cl::desc("Disable debug info printing"));
Devang Patel6c74a872010-04-27 19:46:33 +000055
Eric Christopher7f2b5512013-07-23 22:16:41 +000056static cl::opt<bool> UnknownLocations(
57 "use-unknown-locations", cl::Hidden,
58 cl::desc("Make an absence of debug location information explicit."),
59 cl::init(false));
Dan Gohman7421ae42010-05-07 01:08:53 +000060
Eric Christopher7f2b5512013-07-23 22:16:41 +000061static cl::opt<bool>
Eric Christopher67646432013-07-26 17:02:41 +000062GenerateODRHash("generate-odr-hash", cl::Hidden,
63 cl::desc("Add an ODR hash to external type DIEs."),
64 cl::init(false));
65
Eric Christopherd29614f2013-08-13 01:21:55 +000066static cl::opt<bool>
67GenerateCUHash("generate-cu-hash", cl::Hidden,
68 cl::desc("Add the CU hash as the dwo_id."),
69 cl::init(false));
70
Eric Christopherdd1a0122013-09-13 00:35:05 +000071static cl::opt<bool>
72GenerateGnuPubSections("generate-gnu-dwarf-pub-sections", cl::Hidden,
73 cl::desc("Generate GNU-style pubnames and pubtypes"),
74 cl::init(false));
75
Eric Christopher20b76a72012-08-23 22:36:40 +000076namespace {
Eric Christopher7f2b5512013-07-23 22:16:41 +000077enum DefaultOnOff {
78 Default,
79 Enable,
80 Disable
81};
Eric Christopher20b76a72012-08-23 22:36:40 +000082}
Eric Christopher4996c702011-11-07 09:24:32 +000083
Eric Christopher7f2b5512013-07-23 22:16:41 +000084static cl::opt<DefaultOnOff>
85DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
86 cl::desc("Output prototype dwarf accelerator tables."),
87 cl::values(clEnumVal(Default, "Default for platform"),
88 clEnumVal(Enable, "Enabled"),
89 clEnumVal(Disable, "Disabled"), clEnumValEnd),
90 cl::init(Default));
Eric Christopher20b76a72012-08-23 22:36:40 +000091
Eric Christopher7f2b5512013-07-23 22:16:41 +000092static cl::opt<DefaultOnOff>
Eric Christopher7f2b5512013-07-23 22:16:41 +000093SplitDwarf("split-dwarf", cl::Hidden,
94 cl::desc("Output prototype dwarf split debug info."),
95 cl::values(clEnumVal(Default, "Default for platform"),
96 clEnumVal(Enable, "Enabled"),
97 clEnumVal(Disable, "Disabled"), clEnumValEnd),
98 cl::init(Default));
Eric Christopher29424312012-11-12 22:22:20 +000099
Eric Christopher7da24882013-08-19 21:07:38 +0000100static cl::opt<DefaultOnOff>
Eric Christopher4d36ca02013-08-26 23:24:35 +0000101DwarfPubSections("generate-dwarf-pub-sections", cl::Hidden,
102 cl::desc("Generate DWARF pubnames and pubtypes sections"),
103 cl::values(clEnumVal(Default, "Default for platform"),
104 clEnumVal(Enable, "Enabled"),
105 clEnumVal(Disable, "Disabled"), clEnumValEnd),
106 cl::init(Default));
Eric Christopher7da24882013-08-19 21:07:38 +0000107
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000108static const char *const DWARFGroupName = "DWARF Emission";
109static const char *const DbgTimerName = "DWARF Debug Writer";
Bill Wendlingfcc14142010-04-07 09:28:04 +0000110
Bill Wendling2f921f82009-05-15 09:23:25 +0000111//===----------------------------------------------------------------------===//
112
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000113// Configuration values for initial hash set sizes (log2).
114//
Bill Wendling2f921f82009-05-15 09:23:25 +0000115static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +0000116
117namespace llvm {
118
Manman Renbe5576f2013-10-08 19:07:44 +0000119/// resolve - Look in the DwarfDebug map for the MDNode that
120/// corresponds to the reference.
121template <typename T>
122T DbgVariable::resolve(DIRef<T> Ref) const {
123 return DD->resolve(Ref);
124}
125
Nick Lewycky019d2552011-07-29 03:49:23 +0000126DIType DbgVariable::getType() const {
Devang Patelf20c4f72011-04-12 22:53:02 +0000127 DIType Ty = Var.getType();
128 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
129 // addresses instead.
130 if (Var.isBlockByrefVariable()) {
131 /* Byref variables, in Blocks, are declared by the programmer as
132 "SomeType VarName;", but the compiler creates a
133 __Block_byref_x_VarName struct, and gives the variable VarName
134 either the struct, or a pointer to the struct, as its type. This
135 is necessary for various behind-the-scenes things the compiler
136 needs to do with by-reference variables in blocks.
Eric Christopher6a841382012-11-19 22:42:10 +0000137
Devang Patelf20c4f72011-04-12 22:53:02 +0000138 However, as far as the original *programmer* is concerned, the
139 variable should still have type 'SomeType', as originally declared.
Eric Christopher6a841382012-11-19 22:42:10 +0000140
Devang Patelf20c4f72011-04-12 22:53:02 +0000141 The following function dives into the __Block_byref_x_VarName
142 struct to find the original type of the variable. This will be
143 passed back to the code generating the type for the Debug
144 Information Entry for the variable 'VarName'. 'VarName' will then
145 have the original type 'SomeType' in its debug information.
Eric Christopher6a841382012-11-19 22:42:10 +0000146
Devang Patelf20c4f72011-04-12 22:53:02 +0000147 The original type 'SomeType' will be the type of the field named
148 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher6a841382012-11-19 22:42:10 +0000149
Devang Patelf20c4f72011-04-12 22:53:02 +0000150 NOTE: In order for this to not completely fail on the debugger
151 side, the Debug Information Entry for the variable VarName needs to
152 have a DW_AT_location that tells the debugger how to unwind through
153 the pointers and __Block_byref_x_VarName struct to find the actual
154 value of the variable. The function addBlockByrefType does this. */
155 DIType subType = Ty;
Eric Christopher31b05762013-08-08 01:41:00 +0000156 uint16_t tag = Ty.getTag();
Eric Christopher6a841382012-11-19 22:42:10 +0000157
Eric Christopher9adc55f2013-09-04 19:53:21 +0000158 if (tag == dwarf::DW_TAG_pointer_type)
Manman Renbe5576f2013-10-08 19:07:44 +0000159 subType = resolve(DIDerivedType(Ty).getTypeDerivedFrom());
Eric Christopher6a841382012-11-19 22:42:10 +0000160
Eric Christopher9adc55f2013-09-04 19:53:21 +0000161 DIArray Elements = DICompositeType(subType).getTypeArray();
Devang Patelf20c4f72011-04-12 22:53:02 +0000162 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
Eric Christopher9adc55f2013-09-04 19:53:21 +0000163 DIDerivedType DT = DIDerivedType(Elements.getElement(i));
Devang Patelf20c4f72011-04-12 22:53:02 +0000164 if (getName() == DT.getName())
Manman Renbe5576f2013-10-08 19:07:44 +0000165 return (resolve(DT.getTypeDerivedFrom()));
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000166 }
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000167 }
Devang Patelf20c4f72011-04-12 22:53:02 +0000168 return Ty;
169}
Bill Wendling2f921f82009-05-15 09:23:25 +0000170
Chris Lattnerf5d06362010-04-05 04:09:20 +0000171} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000172
Manman Renac8062b2013-07-02 23:40:10 +0000173/// Return Dwarf Version by checking module flags.
174static unsigned getDwarfVersionFromModule(const Module *M) {
Manman Ren8bfde892013-07-16 23:21:16 +0000175 Value *Val = M->getModuleFlag("Dwarf Version");
176 if (!Val)
Eric Christophere31e0722013-09-04 22:21:24 +0000177 return dwarf::DWARF_VERSION;
Manman Ren8bfde892013-07-16 23:21:16 +0000178 return cast<ConstantInt>(Val)->getZExtValue();
Manman Renac8062b2013-07-02 23:40:10 +0000179}
180
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000181DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Eric Christopherd79f5482012-12-10 19:51:13 +0000182 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000183 AbbreviationsSet(InitAbbreviationsSetSize),
Eric Christopher27614582013-01-08 22:22:06 +0000184 SourceIdMap(DIEValueAllocator),
Eric Christopherc8a310e2012-12-10 23:34:43 +0000185 PrevLabel(NULL), GlobalCUIndexCount(0),
Eric Christopher27614582013-01-08 22:22:06 +0000186 InfoHolder(A, &AbbreviationsSet, &Abbreviations, "info_string",
187 DIEValueAllocator),
Eric Christopher3c5a1912012-12-19 22:02:53 +0000188 SkeletonAbbrevSet(InitAbbreviationsSetSize),
Eric Christopher27614582013-01-08 22:22:06 +0000189 SkeletonHolder(A, &SkeletonAbbrevSet, &SkeletonAbbrevs, "skel_string",
190 DIEValueAllocator) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000191
Rafael Espindolaa7160962011-05-06 14:56:22 +0000192 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattnere58b5472010-04-04 23:10:38 +0000193 DwarfStrSectionSym = TextSectionSym = 0;
Eric Christopher74804332013-02-07 21:19:50 +0000194 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
Eric Christopher55863be2013-04-07 03:43:09 +0000195 DwarfAddrSectionSym = 0;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000196 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000197 FunctionBeginSym = FunctionEndSym = 0;
Eric Christopherad9fe892012-04-02 17:58:52 +0000198
Adrian Prantl5bf1d002013-10-15 20:26:37 +0000199 // Turn on accelerator tables for Darwin by default, pubnames by
200 // default for non-Darwin, and handle split dwarf.
Eric Christopher203e12b2013-04-27 01:07:52 +0000201 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
Eric Christopher4977f212012-08-23 22:36:36 +0000202
Eric Christopher574b5c82013-08-19 21:41:38 +0000203 if (DwarfAccelTables == Default)
204 HasDwarfAccelTables = IsDarwin;
205 else
Eric Christopher5297df02013-08-26 20:58:35 +0000206 HasDwarfAccelTables = DwarfAccelTables == Enable;
Eric Christopher20b76a72012-08-23 22:36:40 +0000207
Eric Christophercdf218d2012-12-10 19:51:21 +0000208 if (SplitDwarf == Default)
209 HasSplitDwarf = false;
Eric Christopher29424312012-11-12 22:22:20 +0000210 else
Eric Christopher574b5c82013-08-19 21:41:38 +0000211 HasSplitDwarf = SplitDwarf == Enable;
Eric Christopher29424312012-11-12 22:22:20 +0000212
Eric Christopher4d36ca02013-08-26 23:24:35 +0000213 if (DwarfPubSections == Default)
214 HasDwarfPubSections = !IsDarwin;
Eric Christopher574b5c82013-08-19 21:41:38 +0000215 else
Eric Christopher4d36ca02013-08-26 23:24:35 +0000216 HasDwarfPubSections = DwarfPubSections == Enable;
Eric Christopher7da24882013-08-19 21:07:38 +0000217
Manman Renac8062b2013-07-02 23:40:10 +0000218 DwarfVersion = getDwarfVersionFromModule(MMI->getModule());
219
Dan Gohman6e681a52010-06-18 15:56:31 +0000220 {
221 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopher58f41952012-11-19 22:42:15 +0000222 beginModule();
Torok Edwinf8dba242010-04-07 10:44:46 +0000223 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000224}
Bill Wendling2f921f82009-05-15 09:23:25 +0000225
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000226// Switch to the specified MCSection and emit an assembler
227// temporary label to it if SymbolStem is specified.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000228static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christophera7b61892011-11-07 09:18:38 +0000229 const char *SymbolStem = 0) {
230 Asm->OutStreamer.SwitchSection(Section);
231 if (!SymbolStem) return 0;
232
233 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
234 Asm->OutStreamer.EmitLabel(TmpSym);
235 return TmpSym;
236}
237
Eric Christophere698f532012-12-20 21:58:36 +0000238MCSymbol *DwarfUnits::getStringPoolSym() {
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000239 return Asm->GetTempSymbol(StringPref);
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000240}
241
Eric Christophere698f532012-12-20 21:58:36 +0000242MCSymbol *DwarfUnits::getStringPoolEntry(StringRef Str) {
243 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopher27614582013-01-08 22:22:06 +0000244 StringPool.GetOrCreateValue(Str).getValue();
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000245 if (Entry.first) return Entry.first;
246
247 Entry.second = NextStringPoolNumber++;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000248 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000249}
250
Eric Christopher2cbd5762013-01-07 19:32:41 +0000251unsigned DwarfUnits::getStringPoolIndex(StringRef Str) {
252 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopher27614582013-01-08 22:22:06 +0000253 StringPool.GetOrCreateValue(Str).getValue();
Eric Christopher2cbd5762013-01-07 19:32:41 +0000254 if (Entry.first) return Entry.second;
255
256 Entry.second = NextStringPoolNumber++;
257 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
258 return Entry.second;
259}
260
David Blaikiedea547b2013-06-28 18:47:14 +0000261unsigned DwarfUnits::getAddrPoolIndex(const MCSymbol *Sym) {
David Blaikie8466ca82013-07-01 23:55:52 +0000262 return getAddrPoolIndex(MCSymbolRefExpr::Create(Sym, Asm->OutContext));
263}
264
Ulrich Weigand8b3d2262013-07-02 18:46:46 +0000265unsigned DwarfUnits::getAddrPoolIndex(const MCExpr *Sym) {
266 std::pair<DenseMap<const MCExpr *, unsigned>::iterator, bool> P =
David Blaikieb8ef7852013-06-28 18:47:19 +0000267 AddressPool.insert(std::make_pair(Sym, NextAddrPoolNumber));
David Blaikiea67de2b2013-06-28 18:55:13 +0000268 if (P.second)
269 ++NextAddrPoolNumber;
David Blaikieb8ef7852013-06-28 18:47:19 +0000270 return P.first->second;
Eric Christopher962c9082013-01-15 23:56:56 +0000271}
272
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000273// Define a unique number for the abbreviation.
274//
Eric Christopherc8a310e2012-12-10 23:34:43 +0000275void DwarfUnits::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000276 // Check the set for priors.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000277 DIEAbbrev *InSet = AbbreviationsSet->GetOrInsertNode(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000278
279 // If it's newly added.
280 if (InSet == &Abbrev) {
281 // Add to abbreviation list.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000282 Abbreviations->push_back(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000283
284 // Assign the vector position + 1 as its number.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000285 Abbrev.setNumber(Abbreviations->size());
Bill Wendling2f921f82009-05-15 09:23:25 +0000286 } else {
287 // Assign existing abbreviation number.
288 Abbrev.setNumber(InSet->getNumber());
289 }
290}
291
Eric Christopherd9843b32011-11-10 19:25:34 +0000292static bool isObjCClass(StringRef Name) {
293 return Name.startswith("+") || Name.startswith("-");
294}
295
296static bool hasObjCCategory(StringRef Name) {
297 if (!isObjCClass(Name)) return false;
298
Benjamin Kramer260de742013-08-24 12:15:54 +0000299 return Name.find(") ") != StringRef::npos;
Eric Christopherd9843b32011-11-10 19:25:34 +0000300}
301
302static void getObjCClassCategory(StringRef In, StringRef &Class,
303 StringRef &Category) {
304 if (!hasObjCCategory(In)) {
305 Class = In.slice(In.find('[') + 1, In.find(' '));
306 Category = "";
307 return;
308 }
309
310 Class = In.slice(In.find('[') + 1, In.find('('));
311 Category = In.slice(In.find('[') + 1, In.find(' '));
312 return;
313}
314
315static StringRef getObjCMethodName(StringRef In) {
316 return In.slice(In.find(' ') + 1, In.find(']'));
317}
318
Richard Mittonc2508242013-10-03 22:07:08 +0000319// Helper for sorting sections into a stable output order.
320static bool SectionSort(const MCSection *A, const MCSection *B) {
321 std::string LA = (A ? A->getLabelBeginName() : "");
322 std::string LB = (B ? B->getLabelBeginName() : "");
323 return LA < LB;
324}
325
Eric Christopherd9843b32011-11-10 19:25:34 +0000326// Add the various names to the Dwarf accelerator table names.
Eric Christopher9cd26af2013-09-20 23:22:52 +0000327// TODO: Determine whether or not we should add names for programs
328// that do not have a DW_AT_name or DW_AT_linkage_name field - this
329// is only slightly different than the lookup of non-standard ObjC names.
Eric Christopherd9843b32011-11-10 19:25:34 +0000330static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
331 DIE* Die) {
332 if (!SP.isDefinition()) return;
Eric Christopherd9843b32011-11-10 19:25:34 +0000333 TheCU->addAccelName(SP.getName(), Die);
334
335 // If the linkage name is different than the name, go ahead and output
336 // that as well into the name table.
337 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
338 TheCU->addAccelName(SP.getLinkageName(), Die);
339
340 // If this is an Objective-C selector name add it to the ObjC accelerator
341 // too.
342 if (isObjCClass(SP.getName())) {
343 StringRef Class, Category;
344 getObjCClassCategory(SP.getName(), Class, Category);
345 TheCU->addAccelObjC(Class, Die);
346 if (Category != "")
347 TheCU->addAccelObjC(Category, Die);
348 // Also add the base method name to the name table.
349 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
350 }
351}
352
Manman Ren3eb9dff2013-09-09 19:05:21 +0000353/// isSubprogramContext - Return true if Context is either a subprogram
354/// or another context nested inside a subprogram.
355bool DwarfDebug::isSubprogramContext(const MDNode *Context) {
356 if (!Context)
357 return false;
358 DIDescriptor D(Context);
359 if (D.isSubprogram())
360 return true;
361 if (D.isType())
Manman Ren116868e2013-09-09 19:47:11 +0000362 return isSubprogramContext(resolve(DIType(Context).getContext()));
Manman Ren3eb9dff2013-09-09 19:05:21 +0000363 return false;
364}
365
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000366// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
367// and DW_AT_high_pc attributes. If there are global variables in this
368// scope then create and insert DIEs for these variables.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000369DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
370 const MDNode *SPNode) {
Eric Christophere595bae2013-10-04 17:08:38 +0000371 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +0000372
Chris Lattner3a383cb2010-04-05 00:13:49 +0000373 assert(SPDie && "Unable to find subprogram DIE!");
374 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000375
Bill Wendlingf720bf62012-11-07 05:19:04 +0000376 // If we're updating an abstract DIE, then we will be adding the children and
377 // object pointer later on. But what we don't want to do is process the
378 // concrete DIE twice.
Eric Christopherc19d6f02013-10-04 19:40:33 +0000379 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
Bill Wendlingf720bf62012-11-07 05:19:04 +0000380 // Pick up abstract subprogram DIE.
Devang Patela37a95e2010-07-07 22:20:57 +0000381 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Manman Ren4c4b69c2013-10-11 23:58:05 +0000382 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin, AbsSPDIE);
Devang Patela37a95e2010-07-07 22:20:57 +0000383 SPCU->addDie(SPDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000384 } else {
385 DISubprogram SPDecl = SP.getFunctionDeclaration();
386 if (!SPDecl.isSubprogram()) {
387 // There is not any need to generate specification DIE for a function
388 // defined at compile unit level. If a function is defined inside another
389 // function then gdb prefers the definition at top level and but does not
390 // expect specification DIE in parent function. So avoid creating
391 // specification DIE for a function defined inside a function.
Manman Renc50fa112013-10-10 18:40:01 +0000392 DIScope SPContext = resolve(SP.getContext());
393 if (SP.isDefinition() && !SPContext.isCompileUnit() &&
394 !SPContext.isFile() &&
395 !isSubprogramContext(SPContext)) {
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000396 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
397
398 // Add arguments.
399 DICompositeType SPTy = SP.getType();
400 DIArray Args = SPTy.getTypeArray();
Eric Christopher31b05762013-08-08 01:41:00 +0000401 uint16_t SPTag = SPTy.getTag();
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000402 if (SPTag == dwarf::DW_TAG_subroutine_type)
403 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
404 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
405 DIType ATy = DIType(Args.getElement(i));
406 SPCU->addType(Arg, ATy);
407 if (ATy.isArtificial())
408 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
409 if (ATy.isObjectPointer())
Manman Ren4c4b69c2013-10-11 23:58:05 +0000410 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer, Arg);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000411 SPDie->addChild(Arg);
412 }
413 DIE *SPDeclDie = SPDie;
414 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Manman Ren4c4b69c2013-10-11 23:58:05 +0000415 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, SPDeclDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000416 SPCU->addDie(SPDie);
417 }
418 }
Devang Patela37a95e2010-07-07 22:20:57 +0000419 }
420
Eric Christopher962c9082013-01-15 23:56:56 +0000421 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc,
422 Asm->GetTempSymbol("func_begin",
423 Asm->getFunctionNumber()));
424 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
425 Asm->GetTempSymbol("func_end",
426 Asm->getFunctionNumber()));
Chris Lattner3a383cb2010-04-05 00:13:49 +0000427 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
428 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000429 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000430
Eric Christopherd9843b32011-11-10 19:25:34 +0000431 // Add name to the name table, we do this here because we're guaranteed
432 // to have concrete versions of our DW_TAG_subprogram nodes.
433 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher6a841382012-11-19 22:42:10 +0000434
Chris Lattner3a383cb2010-04-05 00:13:49 +0000435 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000436}
437
Manman Ren5b2f4b02013-09-11 19:40:28 +0000438/// Check whether we should create a DIE for the given Scope, return true
439/// if we don't create a DIE (the corresponding DIE is null).
Manman Ren2312ed32013-09-10 18:40:41 +0000440bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
441 if (Scope->isAbstractScope())
442 return false;
443
Manman Ren5b2f4b02013-09-11 19:40:28 +0000444 // We don't create a DIE if there is no Range.
Manman Ren2312ed32013-09-10 18:40:41 +0000445 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
446 if (Ranges.empty())
447 return true;
448
449 if (Ranges.size() > 1)
450 return false;
451
Manman Ren5b2f4b02013-09-11 19:40:28 +0000452 // We don't create a DIE if we have a single Range and the end label
453 // is null.
Manman Ren2312ed32013-09-10 18:40:41 +0000454 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
455 MCSymbol *End = getLabelAfterInsn(RI->second);
456 return !End;
457}
458
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000459// Construct new DW_TAG_lexical_block for this scope and attach
460// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher6a841382012-11-19 22:42:10 +0000461DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000462 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000463 if (isLexicalScopeDIENull(Scope))
464 return 0;
465
Devang Patel6c74a872010-04-27 19:46:33 +0000466 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
467 if (Scope->isAbstractScope())
468 return ScopeDIE;
469
Craig Topper977e9cd2013-07-03 04:24:43 +0000470 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Eric Christopherdc42ea82013-07-03 01:57:28 +0000471 // If we have multiple ranges, emit them into the range section.
Devang Patel6c74a872010-04-27 19:46:33 +0000472 if (Ranges.size() > 1) {
473 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000474 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +0000475 // DW_AT_ranges appropriately.
Devang Patelf20c4f72011-04-12 22:53:02 +0000476 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000477 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000478 * Asm->getDataLayout().getPointerSize());
Craig Topperd8e43652013-07-03 04:17:25 +0000479 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +0000480 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +0000481 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
482 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +0000483 }
Eric Christopherc1110832013-07-03 01:22:29 +0000484
485 // Terminate the range list.
Devang Patel6c74a872010-04-27 19:46:33 +0000486 DebugRangeSymbols.push_back(NULL);
487 DebugRangeSymbols.push_back(NULL);
488 return ScopeDIE;
489 }
490
Eric Christopherdc42ea82013-07-03 01:57:28 +0000491 // Construct the address range for this DIE.
Craig Topperd8e43652013-07-03 04:17:25 +0000492 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopher962c9082013-01-15 23:56:56 +0000493 MCSymbol *Start = getLabelBeforeInsn(RI->first);
494 MCSymbol *End = getLabelAfterInsn(RI->second);
Manman Ren2312ed32013-09-10 18:40:41 +0000495 assert(End && "End label should not be null!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000496
Chris Lattnere13c3722010-03-09 01:58:53 +0000497 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
498 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000499
Eric Christopher962c9082013-01-15 23:56:56 +0000500 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
501 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000502
503 return ScopeDIE;
504}
505
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000506// This scope represents inlined body of a function. Construct DIE to
507// represent this concrete inlined copy of the function.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000508DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
509 LexicalScope *Scope) {
Craig Topper977e9cd2013-07-03 04:24:43 +0000510 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000511 assert(Ranges.empty() == false &&
512 "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000513
Devang Patelf098ce22011-07-27 00:34:13 +0000514 if (!Scope->getScopeNode())
515 return NULL;
516 DIScope DS(Scope->getScopeNode());
517 DISubprogram InlinedSP = getDISubprogram(DS);
Eric Christophere595bae2013-10-04 17:08:38 +0000518 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patelf098ce22011-07-27 00:34:13 +0000519 if (!OriginDIE) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000520 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patelf098ce22011-07-27 00:34:13 +0000521 return NULL;
522 }
523
Devang Patel73bc1722011-05-05 17:54:26 +0000524 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Manman Ren4c4b69c2013-10-11 23:58:05 +0000525 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000526
Devang Patelf098ce22011-07-27 00:34:13 +0000527 if (Ranges.size() > 1) {
528 // .debug_range section has not been laid out yet. Emit offset in
529 // .debug_range as a uint, size 4, for now. emitDIE will handle
530 // DW_AT_ranges appropriately.
531 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000532 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000533 * Asm->getDataLayout().getPointerSize());
Craig Topperd8e43652013-07-03 04:17:25 +0000534 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patelf098ce22011-07-27 00:34:13 +0000535 RE = Ranges.end(); RI != RE; ++RI) {
536 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
537 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
538 }
539 DebugRangeSymbols.push_back(NULL);
540 DebugRangeSymbols.push_back(NULL);
541 } else {
Craig Topperd8e43652013-07-03 04:17:25 +0000542 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000543 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
544 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
545
546 if (StartLabel == 0 || EndLabel == 0)
547 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
548
549 assert(StartLabel->isDefined() &&
550 "Invalid starting label for an inlined scope!");
551 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
552
Eric Christopher962c9082013-01-15 23:56:56 +0000553 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
554 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patelf098ce22011-07-27 00:34:13 +0000555 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000556
557 InlinedSubprogramDIEs.insert(OriginDIE);
558
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000559 // Add the call site information to the DIE.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000560 DILocation DL(Scope->getInlinedAt());
Eric Christopher0925c622012-03-26 21:38:38 +0000561 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0,
Manman Ren1e427202013-03-07 01:42:00 +0000562 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
563 TheCU->getUniqueID()));
Devang Patelf20c4f72011-04-12 22:53:02 +0000564 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000565
Eric Christopher8dda5d02011-12-04 06:02:38 +0000566 // Add name to the name table, we do this here because we're guaranteed
567 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
568 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher6a841382012-11-19 22:42:10 +0000569
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000570 return ScopeDIE;
571}
572
Manman Ren2312ed32013-09-10 18:40:41 +0000573DIE *DwarfDebug::createScopeChildrenDIE(CompileUnit *TheCU, LexicalScope *Scope,
574 SmallVectorImpl<DIE*> &Children) {
575 DIE *ObjectPointer = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +0000576
577 // Collect arguments for current function.
Devang Patel7e623022011-08-10 20:55:27 +0000578 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000579 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
580 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher6a841382012-11-19 22:42:10 +0000581 if (DIE *Arg =
Eric Christophere3417762012-09-12 23:36:19 +0000582 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel6c622ef2011-03-01 22:58:55 +0000583 Children.push_back(Arg);
Eric Christophere3417762012-09-12 23:36:19 +0000584 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
585 }
Devang Patel6c622ef2011-03-01 22:58:55 +0000586
Eric Christopherf84354b2011-10-03 15:49:16 +0000587 // Collect lexical scope children first.
Craig Topper977e9cd2013-07-03 04:24:43 +0000588 const SmallVectorImpl<DbgVariable *> &Variables =ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000589 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher6a841382012-11-19 22:42:10 +0000590 if (DIE *Variable =
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000591 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000592 Children.push_back(Variable);
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000593 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
594 }
Craig Topper977e9cd2013-07-03 04:24:43 +0000595 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000596 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Patel3acc70e2011-08-15 22:04:40 +0000597 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000598 Children.push_back(Nested);
Manman Ren2312ed32013-09-10 18:40:41 +0000599 return ObjectPointer;
600}
601
602// Construct a DIE for this scope.
603DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
604 if (!Scope || !Scope->getScopeNode())
605 return NULL;
606
607 DIScope DS(Scope->getScopeNode());
608
609 SmallVector<DIE *, 8> Children;
610 DIE *ObjectPointer = NULL;
611 bool ChildrenCreated = false;
612
Manman Ren5b2f4b02013-09-11 19:40:28 +0000613 // We try to create the scope DIE first, then the children DIEs. This will
614 // avoid creating un-used children then removing them later when we find out
615 // the scope DIE is null.
Devang Patel3b548aa2010-03-08 20:52:55 +0000616 DIE *ScopeDIE = NULL;
617 if (Scope->getInlinedAt())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000618 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3b548aa2010-03-08 20:52:55 +0000619 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000620 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000621 if (Scope->isAbstractScope()) {
Eric Christophere595bae2013-10-04 17:08:38 +0000622 ScopeDIE = TheCU->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000623 // Note down abstract DIE.
624 if (ScopeDIE)
625 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
626 }
Devang Patel3b548aa2010-03-08 20:52:55 +0000627 else
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000628 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3b548aa2010-03-08 20:52:55 +0000629 }
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000630 else {
Manman Ren5b2f4b02013-09-11 19:40:28 +0000631 // Early exit when we know the scope DIE is going to be null.
Manman Ren2312ed32013-09-10 18:40:41 +0000632 if (isLexicalScopeDIENull(Scope))
633 return NULL;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000634
635 // We create children here when we know the scope DIE is not going to be
636 // null and the children will be added to the scope DIE.
Manman Ren2312ed32013-09-10 18:40:41 +0000637 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
638 ChildrenCreated = true;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000639
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000640 // There is no need to emit empty lexical block DIE.
David Blaikie684fc532013-05-06 23:33:07 +0000641 std::pair<ImportedEntityMap::const_iterator,
642 ImportedEntityMap::const_iterator> Range = std::equal_range(
643 ScopesWithImportedEntities.begin(), ScopesWithImportedEntities.end(),
Timur Iskhodzhanovec4afe62013-05-07 07:47:47 +0000644 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode*)0),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000645 less_first());
David Blaikie684fc532013-05-06 23:33:07 +0000646 if (Children.empty() && Range.first == Range.second)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000647 return NULL;
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000648 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Manman Ren2312ed32013-09-10 18:40:41 +0000649 assert(ScopeDIE && "Scope DIE should not be null.");
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000650 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
651 ++i)
David Blaikie4dd2de72013-05-08 06:01:38 +0000652 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000653 }
Eric Christopher6a841382012-11-19 22:42:10 +0000654
Benjamin Kramer892daba2013-08-24 11:55:49 +0000655 if (!ScopeDIE) {
Manman Ren2312ed32013-09-10 18:40:41 +0000656 assert(Children.empty() &&
657 "We create children only when the scope DIE is not null.");
Benjamin Kramer892daba2013-08-24 11:55:49 +0000658 return NULL;
659 }
Manman Ren2312ed32013-09-10 18:40:41 +0000660 if (!ChildrenCreated)
Manman Ren5b2f4b02013-09-11 19:40:28 +0000661 // We create children when the scope DIE is not null.
Manman Ren2312ed32013-09-10 18:40:41 +0000662 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000663
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000664 // Add children
Craig Topperd8e43652013-07-03 04:17:25 +0000665 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000666 E = Children.end(); I != E; ++I)
667 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000668
Eric Christophere3417762012-09-12 23:36:19 +0000669 if (DS.isSubprogram() && ObjectPointer != NULL)
Manman Ren4c4b69c2013-10-11 23:58:05 +0000670 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, ObjectPointer);
Eric Christophere3417762012-09-12 23:36:19 +0000671
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000672 if (DS.isSubprogram())
Eric Christopherd9843b32011-11-10 19:25:34 +0000673 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000674
Eric Christopherd9843b32011-11-10 19:25:34 +0000675 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000676}
677
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000678// Look up the source id with the given directory and source file names.
679// If none currently exists, create a new id and insert it in the
680// SourceIds map. This can update DirectoryNames and SourceFileNames maps
681// as well.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000682unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Manman Ren1e427202013-03-07 01:42:00 +0000683 StringRef DirName, unsigned CUID) {
684 // If we use .loc in assembly, we can't separate .file entries according to
685 // compile units. Thus all files will belong to the default compile unit.
Rafael Espindolaac4ad252013-10-05 16:42:21 +0000686
687 // FIXME: add a better feature test than hasRawTextSupport. Even better,
688 // extend .file to support this.
689 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren1e427202013-03-07 01:42:00 +0000690 CUID = 0;
691
Devang Patel871d0b12010-09-16 20:57:49 +0000692 // If FE did not provide a file name, then assume stdin.
693 if (FileName.empty())
Manman Ren1e427202013-03-07 01:42:00 +0000694 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patele01b75c2011-03-24 20:30:50 +0000695
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000696 // TODO: this might not belong here. See if we can factor this better.
697 if (DirName == CompilationDir)
698 DirName = "";
699
Manman Ren1e427202013-03-07 01:42:00 +0000700 // FileIDCUMap stores the current ID for the given compile unit.
701 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel871d0b12010-09-16 20:57:49 +0000702
Manman Ren1e427202013-03-07 01:42:00 +0000703 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer71b19732012-03-11 14:56:26 +0000704 SmallString<128> NamePair;
Manman Ren5b22f9f2013-04-06 01:02:38 +0000705 NamePair += utostr(CUID);
Manman Ren1e427202013-03-07 01:42:00 +0000706 NamePair += '\0';
Benjamin Kramer71b19732012-03-11 14:56:26 +0000707 NamePair += DirName;
708 NamePair += '\0'; // Zero bytes are not allowed in paths.
709 NamePair += FileName;
710
711 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
712 if (Ent.getValue() != SrcId)
713 return Ent.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +0000714
Manman Ren1e427202013-03-07 01:42:00 +0000715 FileIDCUMap[CUID] = SrcId;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000716 // Print out a .file directive to specify files for .loc directives.
Manman Ren1e427202013-03-07 01:42:00 +0000717 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendling2b128d72009-05-20 23:19:06 +0000718
719 return SrcId;
720}
721
Eric Christopher48fef592012-12-20 21:58:40 +0000722// Create new CompileUnit for the given metadata node with tag
723// DW_TAG_compile_unit.
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000724CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +0000725 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +0000726 StringRef FN = DIUnit.getFilename();
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000727 CompilationDir = DIUnit.getDirectory();
Bill Wendling2b128d72009-05-20 23:19:06 +0000728
729 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopherbfceb2f2013-08-26 23:50:38 +0000730 CompileUnit *NewCU =
731 new CompileUnit(GlobalCUIndexCount++, Die, N, Asm, this, &InfoHolder);
Manman Ren1e427202013-03-07 01:42:00 +0000732
733 FileIDCUMap[NewCU->getUniqueID()] = 0;
734 // Call this to emit a .file directive if it wasn't emitted for the source
735 // file this CU comes from yet.
736 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
737
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000738 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patelf20c4f72011-04-12 22:53:02 +0000739 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
740 DIUnit.getLanguage());
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000741 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christopher52ce7182013-04-09 19:23:15 +0000742
Eric Christopherb1b94512012-08-01 18:19:01 +0000743 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher52ce7182013-04-09 19:23:15 +0000744 // into an entity. We're using 0 (or a NULL label) for this. For
745 // split dwarf it's in the skeleton CU so omit it here.
746 if (!useSplitDwarf())
747 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
Manman Ren4e042a62013-02-05 21:52:47 +0000748
749 // Define start line table label for each Compile Unit.
750 MCSymbol *LineTableStartSym = Asm->GetTempSymbol("line_table_start",
751 NewCU->getUniqueID());
752 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
753 NewCU->getUniqueID());
754
Manman Ren9d4c7352013-05-21 00:57:22 +0000755 // Use a single line table if we are using .loc and generating assembly.
756 bool UseTheFirstCU =
Rafael Espindolaac4ad252013-10-05 16:42:21 +0000757 (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport()) ||
758 (NewCU->getUniqueID() == 0);
Manman Ren9d4c7352013-05-21 00:57:22 +0000759
Eric Christopher52ce7182013-04-09 19:23:15 +0000760 if (!useSplitDwarf()) {
Eric Christophera51d3fc2013-09-27 22:50:48 +0000761 // DW_AT_stmt_list is a offset of line number information for this
762 // compile unit in debug_line section. For split dwarf this is
763 // left in the skeleton CU and so not included.
764 // The line table entries are not always emitted in assembly, so it
765 // is not okay to use line_table_start here.
Eric Christopher52ce7182013-04-09 19:23:15 +0000766 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Carlo Kokbac096a2013-08-13 17:46:57 +0000767 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christophera51d3fc2013-09-27 22:50:48 +0000768 UseTheFirstCU ? Asm->GetTempSymbol("section_line")
769 : LineTableStartSym);
Manman Ren9d4c7352013-05-21 00:57:22 +0000770 else if (UseTheFirstCU)
Eric Christopher52ce7182013-04-09 19:23:15 +0000771 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
772 else
773 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
774 LineTableStartSym, DwarfLineSectionSym);
Eric Christophera51d3fc2013-09-27 22:50:48 +0000775
776 // If we're using split dwarf the compilation dir is going to be in the
777 // skeleton CU and so we don't need to duplicate it here.
778 if (!CompilationDir.empty())
779 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
780
Eric Christopher1d06eb52013-10-01 00:43:31 +0000781 // Flags to let the linker know we have emitted new style pubnames. Only
Eric Christophera51d3fc2013-09-27 22:50:48 +0000782 // emit it here if we don't have a skeleton CU for split dwarf.
Eric Christopher39eebfa2013-09-30 23:14:16 +0000783 if (GenerateGnuPubSections) {
784 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
785 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames,
786 dwarf::DW_FORM_sec_offset,
787 Asm->GetTempSymbol("gnu_pubnames",
788 NewCU->getUniqueID()));
789 else
790 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
791 Asm->GetTempSymbol("gnu_pubnames",
792 NewCU->getUniqueID()),
793 DwarfGnuPubNamesSectionSym);
794
795 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
796 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes,
797 dwarf::DW_FORM_sec_offset,
798 Asm->GetTempSymbol("gnu_pubtypes",
799 NewCU->getUniqueID()));
800 else
801 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopherf976c772013-10-03 17:41:16 +0000802 Asm->GetTempSymbol("gnu_pubtypes",
Eric Christopher39eebfa2013-09-30 23:14:16 +0000803 NewCU->getUniqueID()),
804 DwarfGnuPubTypesSectionSym);
805 }
Eric Christopher52ce7182013-04-09 19:23:15 +0000806 }
Bill Wendling2b128d72009-05-20 23:19:06 +0000807
Bill Wendling2b128d72009-05-20 23:19:06 +0000808 if (DIUnit.isOptimized())
Eric Christopherbb69a272012-08-24 01:14:27 +0000809 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendling2b128d72009-05-20 23:19:06 +0000810
Devang Patel2d9caf92009-11-25 17:36:49 +0000811 StringRef Flags = DIUnit.getFlags();
812 if (!Flags.empty())
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000813 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher6a841382012-11-19 22:42:10 +0000814
Nick Lewycky479a8fe2011-10-17 23:27:36 +0000815 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patelf20c4f72011-04-12 22:53:02 +0000816 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +0000817 dwarf::DW_FORM_data1, RVer);
818
Devang Patel1a0df9a2010-05-10 22:49:55 +0000819 if (!FirstCU)
820 FirstCU = NewCU;
Eric Christopher7a2cdf72013-02-05 07:31:55 +0000821
Eric Christopherc8a310e2012-12-10 23:34:43 +0000822 InfoHolder.addUnit(NewCU);
823
Devang Patel1a0df9a2010-05-10 22:49:55 +0000824 CUMap.insert(std::make_pair(N, NewCU));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000825 return NewCU;
Devang Patel1a0df9a2010-05-10 22:49:55 +0000826}
827
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000828// Construct subprogram DIE.
Eric Christophera6c38a32013-10-15 23:31:38 +0000829void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU, const MDNode *N) {
830 assert(!SPMap[N] && "Trying to create a subprogram DIE twice!");
Rafael Espindola6cf4e832011-11-04 19:00:29 +0000831
Devang Patel80ae3492009-08-28 23:24:31 +0000832 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000833 if (!SP.isDefinition())
834 // This is a method declaration which will be handled while constructing
835 // class type.
Devang Patel0751a282009-06-26 01:49:18 +0000836 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000837
Devang Patel89543712011-08-15 17:24:54 +0000838 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Eric Christophera6c38a32013-10-15 23:31:38 +0000839 SPMap[N] = TheCU;
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000840
Eric Christopherba506db2013-09-09 20:03:20 +0000841 // Expose as a global name.
Eric Christopher2c8b7902013-10-17 02:06:06 +0000842 TheCU->addGlobalName(SP.getName(), SubprogramDie, resolve(SP.getContext()));
Bill Wendling2b128d72009-05-20 23:19:06 +0000843}
844
David Blaikie1fd43652013-05-07 21:35:53 +0000845void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikief55abea2013-04-22 06:12:31 +0000846 const MDNode *N) {
David Blaikie1fd43652013-05-07 21:35:53 +0000847 DIImportedEntity Module(N);
David Blaikief55abea2013-04-22 06:12:31 +0000848 if (!Module.Verify())
849 return;
David Blaikie684fc532013-05-06 23:33:07 +0000850 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
David Blaikie4dd2de72013-05-08 06:01:38 +0000851 constructImportedEntityDIE(TheCU, Module, D);
David Blaikie684fc532013-05-06 23:33:07 +0000852}
853
David Blaikie4dd2de72013-05-08 06:01:38 +0000854void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
David Blaikie684fc532013-05-06 23:33:07 +0000855 DIE *Context) {
David Blaikie1fd43652013-05-07 21:35:53 +0000856 DIImportedEntity Module(N);
David Blaikie684fc532013-05-06 23:33:07 +0000857 if (!Module.Verify())
858 return;
David Blaikie4dd2de72013-05-08 06:01:38 +0000859 return constructImportedEntityDIE(TheCU, Module, Context);
David Blaikie684fc532013-05-06 23:33:07 +0000860}
861
David Blaikie4dd2de72013-05-08 06:01:38 +0000862void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikie1fd43652013-05-07 21:35:53 +0000863 const DIImportedEntity &Module,
David Blaikie684fc532013-05-06 23:33:07 +0000864 DIE *Context) {
865 assert(Module.Verify() &&
866 "Use one of the MDNode * overloads to handle invalid metadata");
867 assert(Context && "Should always have a context for an imported_module");
David Blaikie1fd43652013-05-07 21:35:53 +0000868 DIE *IMDie = new DIE(Module.getTag());
David Blaikief55abea2013-04-22 06:12:31 +0000869 TheCU->insertDIE(Module, IMDie);
David Blaikie1fd43652013-05-07 21:35:53 +0000870 DIE *EntityDie;
871 DIDescriptor Entity = Module.getEntity();
872 if (Entity.isNameSpace())
873 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
874 else if (Entity.isSubprogram())
875 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
David Blaikie3b6038b2013-05-08 06:01:41 +0000876 else if (Entity.isType())
877 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
David Blaikie1fd43652013-05-07 21:35:53 +0000878 else
David Blaikie3b6038b2013-05-08 06:01:41 +0000879 EntityDie = TheCU->getDIE(Entity);
David Blaikief55abea2013-04-22 06:12:31 +0000880 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
881 Module.getContext().getDirectory(),
882 TheCU->getUniqueID());
883 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, 0, FileID);
884 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, 0, Module.getLineNumber());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000885 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, EntityDie);
David Blaikiee63d5d12013-05-20 22:50:35 +0000886 StringRef Name = Module.getName();
887 if (!Name.empty())
888 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
David Blaikie684fc532013-05-06 23:33:07 +0000889 Context->addChild(IMDie);
David Blaikief55abea2013-04-22 06:12:31 +0000890}
891
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000892// Emit all Dwarf sections that should come prior to the content. Create
893// global DIEs and emit initial debug info sections. This is invoked by
894// the target AsmPrinter.
Eric Christopher58f41952012-11-19 22:42:15 +0000895void DwarfDebug::beginModule() {
Devang Patel6c74a872010-04-27 19:46:33 +0000896 if (DisableDebugInfoPrinting)
897 return;
898
Eric Christopher58f41952012-11-19 22:42:15 +0000899 const Module *M = MMI->getModule();
900
Nick Lewycky019d2552011-07-29 03:49:23 +0000901 // If module has named metadata anchors then use them, otherwise scan the
902 // module using debug info finder to collect debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000903 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
David Blaikiedc69ebb2013-03-11 23:39:23 +0000904 if (!CU_Nodes)
Devang Patel07bb9ee2011-08-15 23:47:24 +0000905 return;
Manman Ren60352032013-09-05 18:48:31 +0000906 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
Devang Patele02e5852011-05-03 16:45:22 +0000907
David Blaikiedc69ebb2013-03-11 23:39:23 +0000908 // Emit initial sections so we can reference labels later.
909 emitSectionLabels();
910
911 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
912 DICompileUnit CUNode(CU_Nodes->getOperand(i));
913 CompileUnit *CU = constructCompileUnit(CUNode);
David Blaikie1fd43652013-05-07 21:35:53 +0000914 DIArray ImportedEntities = CUNode.getImportedEntities();
915 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
David Blaikie684fc532013-05-06 23:33:07 +0000916 ScopesWithImportedEntities.push_back(std::make_pair(
David Blaikie1fd43652013-05-07 21:35:53 +0000917 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
918 ImportedEntities.getElement(i)));
David Blaikie684fc532013-05-06 23:33:07 +0000919 std::sort(ScopesWithImportedEntities.begin(),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000920 ScopesWithImportedEntities.end(), less_first());
David Blaikiedc69ebb2013-03-11 23:39:23 +0000921 DIArray GVs = CUNode.getGlobalVariables();
922 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
923 CU->createGlobalVariableDIE(GVs.getElement(i));
924 DIArray SPs = CUNode.getSubprograms();
925 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
926 constructSubprogramDIE(CU, SPs.getElement(i));
927 DIArray EnumTypes = CUNode.getEnumTypes();
928 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
929 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
930 DIArray RetainedTypes = CUNode.getRetainedTypes();
931 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
932 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
David Blaikief55abea2013-04-22 06:12:31 +0000933 // Emit imported_modules last so that the relevant context is already
934 // available.
David Blaikie1fd43652013-05-07 21:35:53 +0000935 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
936 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
David Blaikiedc69ebb2013-03-11 23:39:23 +0000937 }
Eric Christopher6a841382012-11-19 22:42:10 +0000938
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000939 // Tell MMI that we have debug info.
940 MMI->setDebugInfoAvailability(true);
Eric Christopher6a841382012-11-19 22:42:10 +0000941
Bill Wendling2b128d72009-05-20 23:19:06 +0000942 // Prime section data.
Richard Mitton21101b32013-09-19 23:21:01 +0000943 SectionMap[Asm->getObjFileLowering().getTextSection()];
Bill Wendling2b128d72009-05-20 23:19:06 +0000944}
945
Eric Christopher960ac372012-11-22 00:59:49 +0000946// Attach DW_AT_inline attribute with inlined subprogram DIEs.
947void DwarfDebug::computeInlinedDIEs() {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000948 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
949 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000950 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000951 DIE *ISP = *AI;
Devang Patelf20c4f72011-04-12 22:53:02 +0000952 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000953 }
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000954 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000955 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000956 DIE *ISP = AI->second;
957 if (InlinedSubprogramDIEs.count(ISP))
958 continue;
959 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
960 }
Eric Christopher960ac372012-11-22 00:59:49 +0000961}
962
963// Collect info for variables that were optimized out.
964void DwarfDebug::collectDeadVariables() {
965 const Module *M = MMI->getModule();
966 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
967
968 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
969 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
970 DICompileUnit TheCU(CU_Nodes->getOperand(i));
971 DIArray Subprograms = TheCU.getSubprograms();
972 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopher735401c2012-11-27 00:13:51 +0000973 DISubprogram SP(Subprograms.getElement(i));
Eric Christophera6c38a32013-10-15 23:31:38 +0000974 if (ProcessedSPNodes.count(SP) != 0)
975 continue;
976 if (!SP.isSubprogram())
977 continue;
978 if (!SP.isDefinition())
979 continue;
Eric Christopher735401c2012-11-27 00:13:51 +0000980 DIArray Variables = SP.getVariables();
Eric Christophera6c38a32013-10-15 23:31:38 +0000981 if (Variables.getNumElements() == 0)
982 continue;
Eric Christopher960ac372012-11-22 00:59:49 +0000983
Eric Christopher735401c2012-11-27 00:13:51 +0000984 LexicalScope *Scope =
Eric Christophera6c38a32013-10-15 23:31:38 +0000985 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
Eric Christopher735401c2012-11-27 00:13:51 +0000986 DeadFnScopeMap[SP] = Scope;
Eric Christopher960ac372012-11-22 00:59:49 +0000987
Eric Christopher735401c2012-11-27 00:13:51 +0000988 // Construct subprogram DIE and add variables DIEs.
989 CompileUnit *SPCU = CUMap.lookup(TheCU);
990 assert(SPCU && "Unable to find Compile Unit!");
Eric Christophera6c38a32013-10-15 23:31:38 +0000991 DIE *SPDIE = SPCU->getDIE(SP);
992 assert(SPDIE && "Subprogram wasn't created?");
Eric Christopher735401c2012-11-27 00:13:51 +0000993 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
994 DIVariable DV(Variables.getElement(vi));
Eric Christophera6c38a32013-10-15 23:31:38 +0000995 if (!DV.isVariable())
996 continue;
Manman Renb3388602013-10-05 01:43:03 +0000997 DbgVariable NewVar(DV, NULL, this);
Eric Christopher735401c2012-11-27 00:13:51 +0000998 if (DIE *VariableDIE =
Eric Christophera6c38a32013-10-15 23:31:38 +0000999 SPCU->constructVariableDIE(&NewVar, Scope->isAbstractScope()))
1000 SPDIE->addChild(VariableDIE);
Eric Christopher735401c2012-11-27 00:13:51 +00001001 }
Eric Christopher960ac372012-11-22 00:59:49 +00001002 }
1003 }
1004 }
1005 DeleteContainerSeconds(DeadFnScopeMap);
1006}
1007
Eric Christopher45731982013-08-08 23:45:55 +00001008// Type Signature [7.27] and ODR Hash code.
Eric Christopher67646432013-07-26 17:02:41 +00001009
1010/// \brief Grabs the string in whichever attribute is passed in and returns
Eric Christopher8552e222013-08-07 01:18:33 +00001011/// a reference to it. Returns "" if the attribute doesn't exist.
Eric Christopher67646432013-07-26 17:02:41 +00001012static StringRef getDIEStringAttr(DIE *Die, unsigned Attr) {
Eric Christopher8552e222013-08-07 01:18:33 +00001013 DIEValue *V = Die->findAttribute(Attr);
Eric Christopher67646432013-07-26 17:02:41 +00001014
Eric Christopher8552e222013-08-07 01:18:33 +00001015 if (DIEString *S = dyn_cast_or_null<DIEString>(V))
1016 return S->getString();
1017
Eric Christopher67646432013-07-26 17:02:41 +00001018 return StringRef("");
1019}
1020
Eric Christopher67646432013-07-26 17:02:41 +00001021/// Return true if the current DIE is contained within an anonymous namespace.
1022static bool isContainedInAnonNamespace(DIE *Die) {
1023 DIE *Parent = Die->getParent();
1024
1025 while (Parent) {
Eric Christophere414ece2013-07-29 23:53:08 +00001026 if (Parent->getTag() == dwarf::DW_TAG_namespace &&
1027 getDIEStringAttr(Parent, dwarf::DW_AT_name) == "")
Eric Christopher67646432013-07-26 17:02:41 +00001028 return true;
1029 Parent = Parent->getParent();
1030 }
1031
1032 return false;
1033}
1034
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001035/// Test if the current CU language is C++ and that we have
1036/// a named type that is not contained in an anonymous namespace.
1037static bool shouldAddODRHash(CompileUnit *CU, DIE *Die) {
Eric Christopher341770d2013-08-07 08:35:10 +00001038 return CU->getLanguage() == dwarf::DW_LANG_C_plus_plus &&
1039 getDIEStringAttr(Die, dwarf::DW_AT_name) != "" &&
1040 !isContainedInAnonNamespace(Die);
Eric Christopher45731982013-08-08 23:45:55 +00001041}
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001042
Eric Christopher960ac372012-11-22 00:59:49 +00001043void DwarfDebug::finalizeModuleInfo() {
1044 // Collect info for variables that were optimized out.
1045 collectDeadVariables();
1046
1047 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1048 computeInlinedDIEs();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001049
Eric Christopherf8542ec2013-07-29 22:24:32 +00001050 // Split out type units and conditionally add an ODR tag to the split
1051 // out type.
Eric Christopher67646432013-07-26 17:02:41 +00001052 // FIXME: Do type splitting.
1053 for (unsigned i = 0, e = TypeUnits.size(); i != e; ++i) {
Eric Christopher67646432013-07-26 17:02:41 +00001054 DIE *Die = TypeUnits[i];
Eric Christopher45731982013-08-08 23:45:55 +00001055 DIEHash Hash;
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001056 // If we've requested ODR hashes and it's applicable for an ODR hash then
1057 // add the ODR signature now.
Eric Christopher45731982013-08-08 23:45:55 +00001058 // FIXME: This should be added onto the type unit, not the type, but this
1059 // works as an intermediate stage.
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001060 if (GenerateODRHash && shouldAddODRHash(CUMap.begin()->second, Die))
Eric Christopher45731982013-08-08 23:45:55 +00001061 CUMap.begin()->second->addUInt(Die, dwarf::DW_AT_GNU_odr_signature,
1062 dwarf::DW_FORM_data8,
1063 Hash.computeDIEODRSignature(Die));
Eric Christopher67646432013-07-26 17:02:41 +00001064 }
1065
Eric Christopher60eb7692013-08-12 20:27:48 +00001066 // Handle anything that needs to be done on a per-cu basis.
1067 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
1068 CUE = CUMap.end();
1069 CUI != CUE; ++CUI) {
1070 CompileUnit *TheCU = CUI->second;
1071 // Emit DW_AT_containing_type attribute to connect types with their
1072 // vtable holding type.
1073 TheCU->constructContainingTypeDIEs();
1074
1075 // If we're splitting the dwarf out now that we've got the entire
1076 // CU then construct a skeleton CU based upon it.
1077 if (useSplitDwarf()) {
Eric Christopherd29614f2013-08-13 01:21:55 +00001078 uint64_t ID = 0;
1079 if (GenerateCUHash) {
1080 DIEHash CUHash;
1081 ID = CUHash.computeCUSignature(TheCU->getCUDie());
1082 }
Eric Christopher60eb7692013-08-12 20:27:48 +00001083 // This should be a unique identifier when we want to build .dwp files.
1084 TheCU->addUInt(TheCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopherd29614f2013-08-13 01:21:55 +00001085 dwarf::DW_FORM_data8, ID);
Eric Christopher60eb7692013-08-12 20:27:48 +00001086 // Now construct the skeleton CU associated.
Eric Christopher6fdf3242013-08-26 23:50:43 +00001087 CompileUnit *SkCU = constructSkeletonCU(TheCU);
Eric Christopher60eb7692013-08-12 20:27:48 +00001088 // This should be a unique identifier when we want to build .dwp files.
1089 SkCU->addUInt(SkCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopherd29614f2013-08-13 01:21:55 +00001090 dwarf::DW_FORM_data8, ID);
Eric Christopher60eb7692013-08-12 20:27:48 +00001091 }
1092 }
1093
1094 // Compute DIE offsets and sizes.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001095 InfoHolder.computeSizeAndOffsets();
1096 if (useSplitDwarf())
1097 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher960ac372012-11-22 00:59:49 +00001098}
1099
1100void DwarfDebug::endSections() {
Richard Mitton21101b32013-09-19 23:21:01 +00001101 // Filter labels by section.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001102 for (size_t n = 0; n < ArangeLabels.size(); n++) {
1103 const SymbolCU &SCU = ArangeLabels[n];
Richard Mitton21101b32013-09-19 23:21:01 +00001104 if (SCU.Sym->isInSection()) {
1105 // Make a note of this symbol and it's section.
1106 const MCSection *Section = &SCU.Sym->getSection();
1107 if (!Section->getKind().isMetadata())
1108 SectionMap[Section].push_back(SCU);
1109 } else {
1110 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1111 // appear in the output. This sucks as we rely on sections to build
1112 // arange spans. We can do it without, but it's icky.
1113 SectionMap[NULL].push_back(SCU);
1114 }
1115 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001116
Richard Mittonc2508242013-10-03 22:07:08 +00001117 // Build a list of sections used.
1118 std::vector<const MCSection *> Sections;
Richard Mitton21101b32013-09-19 23:21:01 +00001119 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1120 it++) {
1121 const MCSection *Section = it->first;
Richard Mittonc2508242013-10-03 22:07:08 +00001122 Sections.push_back(Section);
1123 }
1124
1125 // Sort the sections into order.
1126 // This is only done to ensure consistent output order across different runs.
1127 std::sort(Sections.begin(), Sections.end(), SectionSort);
1128
1129 // Add terminating symbols for each section.
1130 for (unsigned ID=0;ID<Sections.size();ID++) {
1131 const MCSection *Section = Sections[ID];
Richard Mitton21101b32013-09-19 23:21:01 +00001132 MCSymbol *Sym = NULL;
1133
1134 if (Section) {
Richard Mittonc2508242013-10-03 22:07:08 +00001135 // We can't call MCSection::getLabelEndName, as it's only safe to do so
1136 // if we know the section name up-front. For user-created sections, the resulting
1137 // label may not be valid to use as a label. (section names can use a greater
1138 // set of characters on some systems)
1139 Sym = Asm->GetTempSymbol("debug_end", ID);
Richard Mitton21101b32013-09-19 23:21:01 +00001140 Asm->OutStreamer.SwitchSection(Section);
1141 Asm->OutStreamer.EmitLabel(Sym);
1142 }
1143
1144 // Insert a final terminator.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001145 SectionMap[Section].push_back(SymbolCU(NULL, Sym));
Bill Wendling2b128d72009-05-20 23:19:06 +00001146 }
Eric Christopher960ac372012-11-22 00:59:49 +00001147}
Bill Wendling2b128d72009-05-20 23:19:06 +00001148
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001149// Emit all Dwarf sections that should come after the content.
Eric Christopher960ac372012-11-22 00:59:49 +00001150void DwarfDebug::endModule() {
1151
1152 if (!FirstCU) return;
1153
1154 // End any existing sections.
1155 // TODO: Does this need to happen?
1156 endSections();
1157
1158 // Finalize the debug info for the module.
1159 finalizeModuleInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001160
Eric Christophercdf218d2012-12-10 19:51:21 +00001161 if (!useSplitDwarf()) {
Eric Christopher9cd26af2013-09-20 23:22:52 +00001162 emitDebugStr();
1163
Eric Christopher95198f502012-11-27 22:43:42 +00001164 // Emit all the DIEs into a debug info section.
1165 emitDebugInfo();
Eric Christopher4c9b1192012-11-27 00:41:54 +00001166
Eric Christopher95198f502012-11-27 22:43:42 +00001167 // Corresponding abbreviations into a abbrev section.
1168 emitAbbreviations();
1169
1170 // Emit info into a debug loc section.
1171 emitDebugLoc();
1172
1173 // Emit info into a debug aranges section.
1174 emitDebugARanges();
1175
1176 // Emit info into a debug ranges section.
1177 emitDebugRanges();
1178
1179 // Emit info into a debug macinfo section.
1180 emitDebugMacInfo();
1181
Eric Christopher95198f502012-11-27 22:43:42 +00001182 } else {
Eric Christopherd692c1d2012-12-11 19:42:09 +00001183 // TODO: Fill this in for separated debug sections and separate
Eric Christopher95198f502012-11-27 22:43:42 +00001184 // out information into new sections.
Eric Christopher9cd26af2013-09-20 23:22:52 +00001185 emitDebugStr();
1186 if (useSplitDwarf())
1187 emitDebugStrDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001188
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001189 // Emit the debug info section and compile units.
Eric Christopher95198f502012-11-27 22:43:42 +00001190 emitDebugInfo();
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001191 emitDebugInfoDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001192
1193 // Corresponding abbreviations into a abbrev section.
1194 emitAbbreviations();
Eric Christopher3c5a1912012-12-19 22:02:53 +00001195 emitDebugAbbrevDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001196
1197 // Emit info into a debug loc section.
1198 emitDebugLoc();
1199
1200 // Emit info into a debug aranges section.
1201 emitDebugARanges();
1202
1203 // Emit info into a debug ranges section.
1204 emitDebugRanges();
1205
1206 // Emit info into a debug macinfo section.
1207 emitDebugMacInfo();
1208
Eric Christopher962c9082013-01-15 23:56:56 +00001209 // Emit DWO addresses.
1210 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1211
Eric Christopher95198f502012-11-27 22:43:42 +00001212 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001213
Eric Christophera876b822012-08-23 07:32:06 +00001214 // Emit info into the dwarf accelerator table sections.
Eric Christopher20b76a72012-08-23 22:36:40 +00001215 if (useDwarfAccelTables()) {
Eric Christopher4996c702011-11-07 09:24:32 +00001216 emitAccelNames();
1217 emitAccelObjC();
1218 emitAccelNamespaces();
1219 emitAccelTypes();
1220 }
Eric Christopher6a841382012-11-19 22:42:10 +00001221
Eric Christopher4b358182013-08-30 00:40:17 +00001222 // Emit the pubnames and pubtypes sections if requested.
1223 if (HasDwarfPubSections) {
David Blaikie70a33202013-09-19 17:33:35 +00001224 emitDebugPubNames(GenerateGnuPubSections);
1225 emitDebugPubTypes(GenerateGnuPubSections);
Eric Christopher4b358182013-08-30 00:40:17 +00001226 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001227
Devang Pateld0701282010-08-02 17:32:15 +00001228 // clean up.
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001229 SPMap.clear();
Devang Patel1a0df9a2010-05-10 22:49:55 +00001230 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1231 E = CUMap.end(); I != E; ++I)
1232 delete I->second;
Eric Christopher8afd7b62012-12-10 19:51:18 +00001233
Craig Topperd8e43652013-07-03 04:17:25 +00001234 for (SmallVectorImpl<CompileUnit *>::iterator I = SkeletonCUs.begin(),
Eric Christopher5b33b3c2013-02-06 21:53:56 +00001235 E = SkeletonCUs.end(); I != E; ++I)
1236 delete *I;
Eric Christopher8afd7b62012-12-10 19:51:18 +00001237
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001238 // Reset these for the next Module if we have one.
1239 FirstCU = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001240}
1241
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001242// Find abstract variable, if any, associated with Var.
Devang Patelbb23a4a2011-08-10 21:50:54 +00001243DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattner915c5f92010-04-02 19:42:39 +00001244 DebugLoc ScopeLoc) {
Devang Patelbb23a4a2011-08-10 21:50:54 +00001245 LLVMContext &Ctx = DV->getContext();
1246 // More then one inlined variable corresponds to one abstract variable.
1247 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001248 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001249 if (AbsDbgVariable)
1250 return AbsDbgVariable;
1251
Devang Patel7e623022011-08-10 20:55:27 +00001252 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001253 if (!Scope)
1254 return NULL;
1255
Manman Renb3388602013-10-05 01:43:03 +00001256 AbsDbgVariable = new DbgVariable(Var, NULL, this);
Devang Patel7e623022011-08-10 20:55:27 +00001257 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001258 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001259 return AbsDbgVariable;
1260}
1261
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001262// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel6c622ef2011-03-01 22:58:55 +00001263bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patel7e623022011-08-10 20:55:27 +00001264 DbgVariable *Var, LexicalScope *Scope) {
1265 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +00001266 return false;
1267 DIVariable DV = Var->getVariable();
1268 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1269 return false;
1270 unsigned ArgNo = DV.getArgNumber();
Eric Christopher6a841382012-11-19 22:42:10 +00001271 if (ArgNo == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001272 return false;
1273
Devang Patel4ab660b2011-03-03 20:02:02 +00001274 size_t Size = CurrentFnArguments.size();
1275 if (Size == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001276 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001277 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001278 // arguments does the function have at source level.
1279 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001280 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001281 CurrentFnArguments[ArgNo - 1] = Var;
1282 return true;
1283}
1284
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001285// Collect variable information from side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001286void
Nick Lewycky019d2552011-07-29 03:49:23 +00001287DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patel490c8ab2010-05-20 19:57:06 +00001288 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001289 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1290 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1291 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001292 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001293 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001294 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001295 DIVariable DV(Var);
1296 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001297
Devang Patel7e623022011-08-10 20:55:27 +00001298 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001299
Devang Patelcdb7d442009-11-10 23:20:04 +00001300 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001301 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001302 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001303
Devang Patele1c53f22010-05-20 16:36:41 +00001304 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Manman Renb3388602013-10-05 01:43:03 +00001305 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
Devang Patel3e4a9652011-08-15 21:24:36 +00001306 RegVar->setFrameIndex(VP.first);
Devang Patel6c622ef2011-03-01 22:58:55 +00001307 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001308 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001309 if (AbsDbgVariable)
Devang Patel3e4a9652011-08-15 21:24:36 +00001310 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patel475d32a2009-10-06 01:26:37 +00001311 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001312}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001313
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001314// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1315// defined reg.
Devang Patel9fc11702010-05-25 23:40:22 +00001316static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001317 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001318 return MI->getNumOperands() == 3 &&
1319 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
Adrian Prantl418d1d12013-07-09 20:28:37 +00001320 (MI->getOperand(1).isImm() ||
1321 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
Devang Patel9fc11702010-05-25 23:40:22 +00001322}
1323
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001324// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher6a841382012-11-19 22:42:10 +00001325static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1326 const MCSymbol *FLabel,
Devang Patel2442a892011-07-08 17:09:57 +00001327 const MCSymbol *SLabel,
1328 const MachineInstr *MI) {
1329 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1330
David Blaikie0252265b2013-06-16 20:34:15 +00001331 assert(MI->getNumOperands() == 3);
Adrian Prantl418d1d12013-07-09 20:28:37 +00001332 if (MI->getOperand(0).isReg()) {
Devang Patel2442a892011-07-08 17:09:57 +00001333 MachineLocation MLoc;
Adrian Prantl418d1d12013-07-09 20:28:37 +00001334 // If the second operand is an immediate, this is a
1335 // register-indirect address.
1336 if (!MI->getOperand(1).isImm())
Adrian Prantld4c0dd42013-04-26 21:57:17 +00001337 MLoc.set(MI->getOperand(0).getReg());
1338 else
1339 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel2442a892011-07-08 17:09:57 +00001340 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1341 }
1342 if (MI->getOperand(0).isImm())
1343 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1344 if (MI->getOperand(0).isFPImm())
1345 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1346 if (MI->getOperand(0).isCImm())
1347 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1348
Craig Topperee4dab52012-02-05 08:31:47 +00001349 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel2442a892011-07-08 17:09:57 +00001350}
1351
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001352// Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001353void
Devang Patel5c0f85c2010-06-25 22:07:34 +00001354DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1355 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001356
Eric Christopher270a12c2013-07-03 21:37:03 +00001357 // Grab the variable info that was squirreled away in the MMI side-table.
Devang Patel490c8ab2010-05-20 19:57:06 +00001358 collectVariableInfoFromMMITable(MF, Processed);
1359
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001360 for (SmallVectorImpl<const MDNode*>::const_iterator
1361 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1362 ++UVI) {
1363 const MDNode *Var = *UVI;
1364 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001365 continue;
1366
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001367 // History contains relevant DBG_VALUE instructions for Var and instructions
1368 // clobbering it.
1369 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1370 if (History.empty())
1371 continue;
1372 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001373
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001374 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001375 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001376 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1377 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +00001378 Scope = LScopes.getCurrentFunctionScope();
David Blaikiedc69ebb2013-03-11 23:39:23 +00001379 else if (MDNode *IA = DV.getInlinedAt())
1380 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1381 else
1382 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel490c8ab2010-05-20 19:57:06 +00001383 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001384 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001385 continue;
1386
1387 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001388 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel99819b52011-08-15 19:01:20 +00001389 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
Manman Renb3388602013-10-05 01:43:03 +00001390 DbgVariable *RegVar = new DbgVariable(DV, AbsVar, this);
Devang Patel6c622ef2011-03-01 22:58:55 +00001391 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001392 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001393 if (AbsVar)
Devang Patel3e4a9652011-08-15 21:24:36 +00001394 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001395
Eric Christophercc10d202012-10-08 20:48:54 +00001396 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001397 if (History.size() <= 1 || (History.size() == 2 &&
1398 MInsn->isIdenticalTo(History.back()))) {
Devang Patel3e4a9652011-08-15 21:24:36 +00001399 RegVar->setMInsn(MInsn);
Devang Patel9fc11702010-05-25 23:40:22 +00001400 continue;
1401 }
1402
Eric Christopher59cc0712013-01-28 17:33:26 +00001403 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001404 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001405
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001406 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1407 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1408 const MachineInstr *Begin = *HI;
1409 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001410
Devang Patele7181b52011-06-01 23:00:17 +00001411 // Check if DBG_VALUE is truncating a range.
1412 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1413 && !Begin->getOperand(0).getReg())
1414 continue;
1415
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001416 // Compute the range for a register location.
1417 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1418 const MCSymbol *SLabel = 0;
1419
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001420 if (HI + 1 == HE)
1421 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001422 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001423 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001424 else {
1425 const MachineInstr *End = HI[1];
Eric Christopher6a841382012-11-19 22:42:10 +00001426 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel53b050a2011-07-07 21:44:42 +00001427 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001428 if (End->isDebugValue())
1429 SLabel = getLabelBeforeInsn(End);
1430 else {
1431 // End is a normal instruction clobbering the range.
1432 SLabel = getLabelAfterInsn(End);
1433 assert(SLabel && "Forgot label after clobber instruction");
1434 ++HI;
1435 }
1436 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001437
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001438 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopher365d0832011-12-16 23:42:31 +00001439 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1440 Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001441 }
1442 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001443 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001444
1445 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001446 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1447 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1448 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1449 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001450 if (!DV || !DV.isVariable() || !Processed.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001451 continue;
1452 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001453 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patele0a94bf2010-05-14 21:01:35 +00001454 }
Devang Patel9fc11702010-05-25 23:40:22 +00001455}
Devang Patele0a94bf2010-05-14 21:01:35 +00001456
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001457// Return Label preceding the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001458MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001459 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1460 assert(Label && "Didn't insert label before instruction");
1461 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001462}
1463
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001464// Return Label immediately following the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001465MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001466 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001467}
1468
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001469// Process beginning of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001470void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001471 // Check if source location changes, but ignore DBG_VALUE locations.
1472 if (!MI->isDebugValue()) {
1473 DebugLoc DL = MI->getDebugLoc();
1474 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopheraec8a822012-04-05 20:39:05 +00001475 unsigned Flags = 0;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001476 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001477 if (DL == PrologEndLoc) {
1478 Flags |= DWARF2_FLAG_PROLOGUE_END;
1479 PrologEndLoc = DebugLoc();
1480 }
Eric Christopheraec8a822012-04-05 20:39:05 +00001481 if (PrologEndLoc.isUnknown())
1482 Flags |= DWARF2_FLAG_IS_STMT;
1483
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001484 if (!DL.isUnknown()) {
1485 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001486 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001487 } else
Devang Patel34a66202011-05-11 19:22:19 +00001488 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001489 }
Devang Patel9fc11702010-05-25 23:40:22 +00001490 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001491
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001492 // Insert labels where requested.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001493 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1494 LabelsBeforeInsn.find(MI);
1495
1496 // No label needed.
1497 if (I == LabelsBeforeInsn.end())
1498 return;
1499
1500 // Label already assigned.
1501 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001502 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001503
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001504 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001505 PrevLabel = MMI->getContext().CreateTempSymbol();
1506 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001507 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001508 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001509}
1510
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001511// Process end of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001512void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001513 // Don't create a new label after DBG_VALUE instructions.
1514 // They don't generate code.
1515 if (!MI->isDebugValue())
1516 PrevLabel = 0;
1517
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001518 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1519 LabelsAfterInsn.find(MI);
1520
1521 // No label needed.
1522 if (I == LabelsAfterInsn.end())
1523 return;
1524
1525 // Label already assigned.
1526 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001527 return;
1528
1529 // We need a label after this instruction.
1530 if (!PrevLabel) {
1531 PrevLabel = MMI->getContext().CreateTempSymbol();
1532 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001533 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001534 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001535}
1536
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001537// Each LexicalScope has first instruction and last instruction to mark
1538// beginning and end of a scope respectively. Create an inverse map that list
1539// scopes starts (and ends) with an instruction. One instruction may start (or
1540// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001541void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001542 SmallVector<LexicalScope *, 4> WorkList;
1543 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001544 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001545 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001546
Craig Topper977e9cd2013-07-03 04:24:43 +00001547 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001548 if (!Children.empty())
Craig Topperd8e43652013-07-03 04:17:25 +00001549 for (SmallVectorImpl<LexicalScope *>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00001550 SE = Children.end(); SI != SE; ++SI)
1551 WorkList.push_back(*SI);
1552
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001553 if (S->isAbstractScope())
1554 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001555
Craig Topper977e9cd2013-07-03 04:24:43 +00001556 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001557 if (Ranges.empty())
1558 continue;
Craig Topperd8e43652013-07-03 04:17:25 +00001559 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +00001560 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001561 assert(RI->first && "InsnRange does not have first instruction!");
1562 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001563 requestLabelBeforeInsn(RI->first);
1564 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001565 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001566 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001567}
1568
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001569// Get MDNode for DebugLoc's scope.
Devang Patel589845d2011-05-09 22:14:49 +00001570static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1571 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1572 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1573 return DL.getScope(Ctx);
1574}
1575
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001576// Walk up the scope chain of given debug loc and find line number info
1577// for the function.
Devang Patel34a66202011-05-11 19:22:19 +00001578static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1579 const MDNode *Scope = getScopeNode(DL, Ctx);
1580 DISubprogram SP = getDISubprogram(Scope);
Manman Ren7504ed42013-07-08 18:33:29 +00001581 if (SP.isSubprogram()) {
Eric Christopher34164192012-04-03 00:43:49 +00001582 // Check for number of operands since the compatibility is
1583 // cheap here.
Eric Christopherb81e2b42012-04-03 17:55:42 +00001584 if (SP->getNumOperands() > 19)
Eric Christopher34164192012-04-03 00:43:49 +00001585 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1586 else
1587 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1588 }
1589
Devang Patel34a66202011-05-11 19:22:19 +00001590 return DebugLoc();
1591}
1592
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001593// Gather pre-function debug information. Assumes being called immediately
1594// after the function entry point has been emitted.
Chris Lattner76555b52010-01-26 23:18:02 +00001595void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00001596 if (!MMI->hasDebugInfo()) return;
Devang Patel7e623022011-08-10 20:55:27 +00001597 LScopes.initialize(*MF);
1598 if (LScopes.empty()) return;
1599 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001600
Manman Ren4e042a62013-02-05 21:52:47 +00001601 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1602 // belongs to.
1603 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1604 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1605 assert(TheCU && "Unable to find compile unit!");
Rafael Espindolaac4ad252013-10-05 16:42:21 +00001606 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren9d4c7352013-05-21 00:57:22 +00001607 // Use a single line table if we are using .loc and generating assembly.
1608 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1609 else
1610 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
Manman Ren4e042a62013-02-05 21:52:47 +00001611
Devang Patel6c74a872010-04-27 19:46:33 +00001612 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1613 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001614 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001615 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001616
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001617 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1618
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001619 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001620 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001621 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1622
Devang Patel002d54d2010-05-26 19:37:24 +00001623 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001624 I != E; ++I) {
1625 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001626 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1627 II != IE; ++II) {
1628 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001629
Devang Patel002d54d2010-05-26 19:37:24 +00001630 if (MI->isDebugValue()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001631 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001632
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001633 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001634 const MDNode *Var =
1635 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001636
1637 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001638 if (isDbgValueInDefinedReg(MI))
1639 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1640
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001641 // Check the history of this variable.
1642 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1643 if (History.empty()) {
1644 UserVariables.push_back(Var);
1645 // The first mention of a function argument gets the FunctionBeginSym
1646 // label, so arguments are visible when breaking at function entry.
1647 DIVariable DV(Var);
Manman Ren7504ed42013-07-08 18:33:29 +00001648 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001649 DISubprogram(getDISubprogram(DV.getContext()))
1650 .describes(MF->getFunction()))
1651 LabelsBeforeInsn[MI] = FunctionBeginSym;
1652 } else {
1653 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1654 const MachineInstr *Prev = History.back();
1655 if (Prev->isDebugValue()) {
1656 // Coalesce identical entries at the end of History.
1657 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001658 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher85a495e2012-10-08 20:48:49 +00001659 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher6a841382012-11-19 22:42:10 +00001660 << "\t" << *Prev
Devang Patelb7a328e2011-07-07 00:14:27 +00001661 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001662 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001663 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001664
1665 // Terminate old register assignments that don't reach MI;
1666 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1667 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1668 isDbgValueInDefinedReg(Prev)) {
1669 // Previous register assignment needs to terminate at the end of
1670 // its basic block.
1671 MachineBasicBlock::const_iterator LastMI =
1672 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001673 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001674 // Drop DBG_VALUE for empty range.
Eric Christopher85a495e2012-10-08 20:48:49 +00001675 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patelb7a328e2011-07-07 00:14:27 +00001676 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001677 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001678 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001679 // Terminate after LastMI.
1680 History.push_back(LastMI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001681 }
1682 }
1683 }
1684 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001685 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001686 // Not a DBG_VALUE instruction.
1687 if (!MI->isLabel())
1688 AtBlockEntry = false;
1689
Eric Christopher133195782012-10-04 20:46:14 +00001690 // First known non-DBG_VALUE and non-frame setup location marks
1691 // the beginning of the function body.
1692 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1693 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel34a66202011-05-11 19:22:19 +00001694 PrologEndLoc = MI->getDebugLoc();
1695
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001696 // Check if the instruction clobbers any registers with debug vars.
1697 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1698 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1699 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1700 continue;
Jakob Stoklund Olesen54038d72012-06-01 23:28:30 +00001701 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1702 AI.isValid(); ++AI) {
1703 unsigned Reg = *AI;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001704 const MDNode *Var = LiveUserVar[Reg];
1705 if (!Var)
1706 continue;
1707 // Reg is now clobbered.
1708 LiveUserVar[Reg] = 0;
1709
1710 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001711 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1712 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001713 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001714 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1715 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001716 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001717 const MachineInstr *Prev = History.back();
1718 // Sanity-check: Register assignments are terminated at the end of
1719 // their block.
1720 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1721 continue;
1722 // Is the variable still in Reg?
1723 if (!isDbgValueInDefinedReg(Prev) ||
1724 Prev->getOperand(0).getReg() != Reg)
1725 continue;
1726 // Var is clobbered. Make sure the next instruction gets a label.
1727 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001728 }
1729 }
Devang Patel002d54d2010-05-26 19:37:24 +00001730 }
Devang Patel002d54d2010-05-26 19:37:24 +00001731 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001732 }
1733
1734 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1735 I != E; ++I) {
1736 SmallVectorImpl<const MachineInstr*> &History = I->second;
1737 if (History.empty())
1738 continue;
1739
1740 // Make sure the final register assignments are terminated.
1741 const MachineInstr *Prev = History.back();
1742 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1743 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher6a841382012-11-19 22:42:10 +00001744 MachineBasicBlock::const_iterator LastMI =
Devang Patel784077e2011-08-10 23:58:09 +00001745 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001746 if (LastMI == PrevMBB->end())
1747 // Drop DBG_VALUE for empty range.
1748 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001749 else if (PrevMBB != &PrevMBB->getParent()->back()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001750 // Terminate after LastMI.
1751 History.push_back(LastMI);
1752 }
1753 }
1754 // Request labels for the full history.
1755 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1756 const MachineInstr *MI = History[i];
1757 if (MI->isDebugValue())
1758 requestLabelBeforeInsn(MI);
1759 else
1760 requestLabelAfterInsn(MI);
1761 }
1762 }
Devang Patel002d54d2010-05-26 19:37:24 +00001763
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001764 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001765 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001766
1767 // Record beginning of function.
1768 if (!PrologEndLoc.isUnknown()) {
1769 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1770 MF->getFunction()->getContext());
1771 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1772 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie67cb31e2012-12-04 22:02:33 +00001773 // We'd like to list the prologue as "not statements" but GDB behaves
1774 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikie5a773bb2012-12-04 21:05:36 +00001775 DWARF2_FLAG_IS_STMT);
Devang Patel34a66202011-05-11 19:22:19 +00001776 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001777}
1778
Devang Patel7e623022011-08-10 20:55:27 +00001779void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
David Blaikie6f1a8062013-06-05 05:39:59 +00001780 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1781 DIVariable DV = Var->getVariable();
David Blaikie36d5d2f2013-06-06 21:04:51 +00001782 // Variables with positive arg numbers are parameters.
1783 if (unsigned ArgNum = DV.getArgNumber()) {
1784 // Keep all parameters in order at the start of the variable list to ensure
1785 // function types are correct (no out-of-order parameters)
1786 //
1787 // This could be improved by only doing it for optimized builds (unoptimized
1788 // builds have the right order to begin with), searching from the back (this
1789 // would catch the unoptimized case quickly), or doing a binary search
1790 // rather than linear search.
1791 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1792 while (I != Vars.end()) {
1793 unsigned CurNum = (*I)->getVariable().getArgNumber();
1794 // A local (non-parameter) variable has been found, insert immediately
1795 // before it.
1796 if (CurNum == 0)
1797 break;
1798 // A later indexed parameter has been found, insert immediately before it.
David Blaikieb272a752013-06-06 22:28:26 +00001799 if (CurNum > ArgNum)
David Blaikie36d5d2f2013-06-06 21:04:51 +00001800 break;
David Blaikieb272a752013-06-06 22:28:26 +00001801 ++I;
David Blaikie6f1a8062013-06-05 05:39:59 +00001802 }
David Blaikie36d5d2f2013-06-06 21:04:51 +00001803 Vars.insert(I, Var);
1804 return;
David Blaikie6f1a8062013-06-05 05:39:59 +00001805 }
1806
1807 Vars.push_back(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001808}
1809
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001810// Gather and emit post-function debug information.
Chris Lattner76555b52010-01-26 23:18:02 +00001811void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patel7e623022011-08-10 20:55:27 +00001812 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00001813
Devang Patel7e623022011-08-10 20:55:27 +00001814 // Define end label for subprogram.
1815 FunctionEndSym = Asm->GetTempSymbol("func_end",
1816 Asm->getFunctionNumber());
1817 // Assumes in correct section after the entry point.
1818 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Manman Ren4e042a62013-02-05 21:52:47 +00001819 // Set DwarfCompileUnitID in MCContext to default value.
1820 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher6a841382012-11-19 22:42:10 +00001821
Devang Patel7e623022011-08-10 20:55:27 +00001822 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1823 collectVariableInfo(MF, ProcessedVars);
Eric Christopher6a841382012-11-19 22:42:10 +00001824
Devang Patel3acc70e2011-08-15 22:04:40 +00001825 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001826 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001827 assert(TheCU && "Unable to find compile unit!");
Devang Patel3acc70e2011-08-15 22:04:40 +00001828
Devang Patel7e623022011-08-10 20:55:27 +00001829 // Construct abstract scopes.
Devang Patel44403472011-08-12 18:10:19 +00001830 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1831 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1832 LexicalScope *AScope = AList[i];
1833 DISubprogram SP(AScope->getScopeNode());
Manman Ren7504ed42013-07-08 18:33:29 +00001834 if (SP.isSubprogram()) {
Devang Patel7e623022011-08-10 20:55:27 +00001835 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001836 DIArray Variables = SP.getVariables();
1837 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1838 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001839 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001840 continue;
Alexey Samsonov39602782012-07-06 08:45:08 +00001841 // Check that DbgVariable for DV wasn't created earlier, when
1842 // findAbstractVariable() was called for inlined instance of DV.
1843 LLVMContext &Ctx = DV->getContext();
1844 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1845 if (AbstractVariables.lookup(CleanDV))
1846 continue;
Devang Patel59e27c52011-08-19 23:28:12 +00001847 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001848 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001849 }
1850 }
Devang Patel44403472011-08-12 18:10:19 +00001851 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Manman Ren4213c392013-05-29 17:16:59 +00001852 constructScopeDIE(TheCU, AScope);
Bill Wendling2b128d72009-05-20 23:19:06 +00001853 }
Eric Christopher6a841382012-11-19 22:42:10 +00001854
Devang Patel3acc70e2011-08-15 22:04:40 +00001855 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher6a841382012-11-19 22:42:10 +00001856
Nick Lewycky50f02cb2011-12-02 22:16:29 +00001857 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopherbb69a272012-08-24 01:14:27 +00001858 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Patel3acc70e2011-08-15 22:04:40 +00001859
Bill Wendling2b128d72009-05-20 23:19:06 +00001860 // Clear debug info
Craig Topper2b4a2012013-07-03 04:40:27 +00001861 for (ScopeVariablesMap::iterator
Devang Patel7e623022011-08-10 20:55:27 +00001862 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1863 DeleteContainerPointers(I->second);
1864 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001865 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001866 UserVariables.clear();
1867 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001868 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001869 LabelsBeforeInsn.clear();
1870 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001871 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001872}
1873
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001874// Register a source line with debug info. Returns the unique label that was
1875// emitted and which provides correspondence to the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00001876void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1877 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00001878 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00001879 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00001880 unsigned Src = 1;
1881 if (S) {
1882 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00001883
Dan Gohman50849c62010-05-05 23:41:32 +00001884 if (Scope.isCompileUnit()) {
1885 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001886 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001887 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00001888 } else if (Scope.isFile()) {
1889 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00001890 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001891 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001892 } else if (Scope.isSubprogram()) {
1893 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001894 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001895 Dir = SP.getDirectory();
Eric Christopher6647b832011-10-11 22:59:11 +00001896 } else if (Scope.isLexicalBlockFile()) {
1897 DILexicalBlockFile DBF(S);
1898 Fn = DBF.getFilename();
1899 Dir = DBF.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001900 } else if (Scope.isLexicalBlock()) {
1901 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001902 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001903 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001904 } else
Craig Topperee4dab52012-02-05 08:31:47 +00001905 llvm_unreachable("Unexpected scope info");
Dan Gohman50849c62010-05-05 23:41:32 +00001906
Manman Ren1e427202013-03-07 01:42:00 +00001907 Src = getOrCreateSourceID(Fn, Dir,
1908 Asm->OutStreamer.getContext().getDwarfCompileUnitID());
Dan Gohman50849c62010-05-05 23:41:32 +00001909 }
Nick Lewycky019d2552011-07-29 03:49:23 +00001910 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00001911}
1912
Bill Wendling806535f2009-05-20 23:22:40 +00001913//===----------------------------------------------------------------------===//
1914// Emit Methods
1915//===----------------------------------------------------------------------===//
1916
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001917// Compute the size and offset of a DIE.
Jim Grosbach00e9c612009-11-22 19:20:36 +00001918unsigned
Eric Christopherc8a310e2012-12-10 23:34:43 +00001919DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling480ff322009-05-20 23:21:38 +00001920 // Get the children.
1921 const std::vector<DIE *> &Children = Die->getChildren();
1922
Bill Wendling480ff322009-05-20 23:21:38 +00001923 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00001924 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00001925
1926 // Get the abbreviation for this DIE.
1927 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopherc8a310e2012-12-10 23:34:43 +00001928 const DIEAbbrev *Abbrev = Abbreviations->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00001929
1930 // Set DIE offset
1931 Die->setOffset(Offset);
1932
1933 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00001934 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001935
Eric Christopher4887c8f2013-03-29 23:34:06 +00001936 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1937 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling480ff322009-05-20 23:21:38 +00001938
1939 // Size the DIE attribute values.
1940 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1941 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001942 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001943
1944 // Size the DIE children if any.
1945 if (!Children.empty()) {
1946 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1947 "Children flag not set");
1948
1949 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001950 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling480ff322009-05-20 23:21:38 +00001951
1952 // End of children marker.
1953 Offset += sizeof(int8_t);
1954 }
1955
1956 Die->setSize(Offset - Die->getOffset());
1957 return Offset;
1958}
1959
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001960// Compute the size and offset of all the DIEs.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001961void DwarfUnits::computeSizeAndOffsets() {
Manman Ren14a029d2013-03-12 18:27:15 +00001962 // Offset from the beginning of debug info section.
Eric Christopher4887c8f2013-03-29 23:34:06 +00001963 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopherc8a310e2012-12-10 23:34:43 +00001964 E = CUs.end(); I != E; ++I) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001965 unsigned Offset =
1966 sizeof(int32_t) + // Length of Compilation Unit Info
1967 sizeof(int16_t) + // DWARF version number
1968 sizeof(int32_t) + // Offset Into Abbrev. Section
1969 sizeof(int8_t); // Pointer Size (in bytes)
Eric Christopherc19d6f02013-10-04 19:40:33 +00001970 computeSizeAndOffset((*I)->getCUDie(), Offset);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001971 }
Bill Wendling480ff322009-05-20 23:21:38 +00001972}
1973
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001974// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001975void DwarfDebug::emitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001976 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001977
Bill Wendling480ff322009-05-20 23:21:38 +00001978 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001979 DwarfInfoSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001980 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001981 DwarfAbbrevSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001982 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher3c5a1912012-12-19 22:02:53 +00001983 if (useSplitDwarf())
1984 DwarfAbbrevDWOSectionSym =
1985 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1986 "section_abbrev_dwo");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001987 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001988
Chris Lattner6629ca92010-04-04 22:59:04 +00001989 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001990 emitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00001991
Eric Christopher74804332013-02-07 21:19:50 +00001992 DwarfLineSectionSym =
1993 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001994 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Eric Christopher261d2342013-09-23 20:55:35 +00001995 if (GenerateGnuPubSections) {
Eric Christopher39eebfa2013-09-30 23:14:16 +00001996 DwarfGnuPubNamesSectionSym =
1997 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
1998 DwarfGnuPubTypesSectionSym =
1999 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
Eric Christopher261d2342013-09-23 20:55:35 +00002000 } else if (HasDwarfPubSections) {
2001 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2002 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Michael Gottesmanc89466f2013-09-04 04:39:38 +00002003 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002004
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002005 DwarfStrSectionSym =
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002006 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002007 if (useSplitDwarf()) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002008 DwarfStrDWOSectionSym =
2009 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002010 DwarfAddrSectionSym =
2011 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
2012 }
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002013 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patel12563b32010-04-16 23:33:45 +00002014 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00002015
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002016 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patel9fc11702010-05-25 23:40:22 +00002017 "section_debug_loc");
2018
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002019 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
2020 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002021}
2022
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002023// Recursively emits a debug information entry.
Eric Christopher3c5a1912012-12-19 22:02:53 +00002024void DwarfDebug::emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs) {
Bill Wendling480ff322009-05-20 23:21:38 +00002025 // Get the abbreviation for this DIE.
2026 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher3c5a1912012-12-19 22:02:53 +00002027 const DIEAbbrev *Abbrev = Abbrevs->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00002028
Bill Wendling480ff322009-05-20 23:21:38 +00002029 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00002030 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00002031 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2032 Twine::utohexstr(Die->getOffset()) + ":0x" +
2033 Twine::utohexstr(Die->getSize()) + " " +
2034 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00002035 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00002036
Eric Christopher4887c8f2013-03-29 23:34:06 +00002037 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
2038 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling480ff322009-05-20 23:21:38 +00002039
2040 // Emit the DIE attribute values.
2041 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2042 unsigned Attr = AbbrevData[i].getAttribute();
2043 unsigned Form = AbbrevData[i].getForm();
2044 assert(Form && "Too many attributes for DIE (check abbreviation)");
2045
Chris Lattner7bde8c02010-04-04 18:52:31 +00002046 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00002047 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002048
Bill Wendling480ff322009-05-20 23:21:38 +00002049 switch (Attr) {
Eric Christophere595bae2013-10-04 17:08:38 +00002050 case dwarf::DW_AT_abstract_origin: {
Bill Wendling480ff322009-05-20 23:21:38 +00002051 DIEEntry *E = cast<DIEEntry>(Values[i]);
2052 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002053 unsigned Addr = Origin->getOffset();
Eric Christopherc19d6f02013-10-04 19:40:33 +00002054 Asm->EmitInt32(Addr);
Bill Wendling480ff322009-05-20 23:21:38 +00002055 break;
2056 }
Devang Patel12563b32010-04-16 23:33:45 +00002057 case dwarf::DW_AT_ranges: {
2058 // DW_AT_range Value encodes offset in debug_range section.
2059 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00002060
Nick Lewycky33da3362012-06-22 01:25:12 +00002061 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelda3ef852010-09-02 16:43:44 +00002062 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
2063 V->getValue(),
2064 4);
2065 } else {
2066 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
2067 V->getValue(),
2068 DwarfDebugRangeSectionSym,
2069 4);
2070 }
Devang Patel12563b32010-04-16 23:33:45 +00002071 break;
2072 }
Devang Patel9fc11702010-05-25 23:40:22 +00002073 case dwarf::DW_AT_location: {
Nick Lewycky33da3362012-06-22 01:25:12 +00002074 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2075 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002076 Asm->EmitLabelReference(L->getValue(), 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002077 else
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002078 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002079 } else {
Devang Patel9fc11702010-05-25 23:40:22 +00002080 Values[i]->EmitValue(Asm, Form);
Nick Lewycky33da3362012-06-22 01:25:12 +00002081 }
Devang Patel9fc11702010-05-25 23:40:22 +00002082 break;
2083 }
Devang Patela1bd5a12010-09-29 19:08:08 +00002084 case dwarf::DW_AT_accessibility: {
2085 if (Asm->isVerbose()) {
2086 DIEInteger *V = cast<DIEInteger>(Values[i]);
2087 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2088 }
2089 Values[i]->EmitValue(Asm, Form);
2090 break;
2091 }
Bill Wendling480ff322009-05-20 23:21:38 +00002092 default:
2093 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002094 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00002095 break;
2096 }
Bill Wendling480ff322009-05-20 23:21:38 +00002097 }
2098
2099 // Emit the DIE children if any.
2100 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2101 const std::vector<DIE *> &Children = Die->getChildren();
2102
2103 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher3c5a1912012-12-19 22:02:53 +00002104 emitDIE(Children[j], Abbrevs);
Bill Wendling480ff322009-05-20 23:21:38 +00002105
Chris Lattner7bde8c02010-04-04 18:52:31 +00002106 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00002107 Asm->OutStreamer.AddComment("End Of Children Mark");
2108 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00002109 }
2110}
2111
Eric Christophera2de8262012-12-15 00:04:07 +00002112// Emit the various dwarf units to the unit section USection with
2113// the abbreviations going into ASection.
2114void DwarfUnits::emitUnits(DwarfDebug *DD,
2115 const MCSection *USection,
2116 const MCSection *ASection,
2117 const MCSymbol *ASectionSym) {
2118 Asm->OutStreamer.SwitchSection(USection);
Eric Christopher4887c8f2013-03-29 23:34:06 +00002119 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christophera2de8262012-12-15 00:04:07 +00002120 E = CUs.end(); I != E; ++I) {
2121 CompileUnit *TheCU = *I;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002122 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002123
Devang Patel1a0df9a2010-05-10 22:49:55 +00002124 // Emit the compile units header.
Eric Christophera2de8262012-12-15 00:04:07 +00002125 Asm->OutStreamer
2126 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
2127 TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002128
Devang Patel1a0df9a2010-05-10 22:49:55 +00002129 // Emit size of content not including length itself
2130 unsigned ContentSize = Die->getSize() +
2131 sizeof(int16_t) + // DWARF version number
2132 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patele141234942011-04-13 19:41:17 +00002133 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002134
Devang Patel1a0df9a2010-05-10 22:49:55 +00002135 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2136 Asm->EmitInt32(ContentSize);
2137 Asm->OutStreamer.AddComment("DWARF version number");
Manman Renac8062b2013-07-02 23:40:10 +00002138 Asm->EmitInt16(DD->getDwarfVersion());
Devang Patel1a0df9a2010-05-10 22:49:55 +00002139 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
Eric Christophera2de8262012-12-15 00:04:07 +00002140 Asm->EmitSectionOffset(Asm->GetTempSymbol(ASection->getLabelBeginName()),
2141 ASectionSym);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002142 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002143 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002144
Eric Christopher3c5a1912012-12-19 22:02:53 +00002145 DD->emitDIE(Die, Abbreviations);
Eric Christophera2de8262012-12-15 00:04:07 +00002146 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
Eli Benderskyb42d1462012-12-03 18:45:45 +00002147 TheCU->getUniqueID()));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002148 }
Bill Wendling480ff322009-05-20 23:21:38 +00002149}
2150
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002151// Emit the debug info section.
2152void DwarfDebug::emitDebugInfo() {
Eric Christophera2de8262012-12-15 00:04:07 +00002153 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2154
2155 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
2156 Asm->getObjFileLowering().getDwarfAbbrevSection(),
2157 DwarfAbbrevSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002158}
2159
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002160// Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +00002161void DwarfDebug::emitAbbreviations() {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002162 if (!useSplitDwarf())
2163 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
2164 &Abbreviations);
2165 else
2166 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2167}
Bill Wendling480ff322009-05-20 23:21:38 +00002168
Eric Christopher3c5a1912012-12-19 22:02:53 +00002169void DwarfDebug::emitAbbrevs(const MCSection *Section,
2170 std::vector<DIEAbbrev *> *Abbrevs) {
2171 // Check to see if it is worth the effort.
2172 if (!Abbrevs->empty()) {
2173 // Start the debug abbrev section.
2174 Asm->OutStreamer.SwitchSection(Section);
2175
2176 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
Eric Christopher996b2b72012-12-13 03:00:38 +00002177 Asm->OutStreamer.EmitLabel(Begin);
Bill Wendling480ff322009-05-20 23:21:38 +00002178
2179 // For each abbrevation.
Eric Christopher3c5a1912012-12-19 22:02:53 +00002180 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
Bill Wendling480ff322009-05-20 23:21:38 +00002181 // Get abbreviation data
Eric Christopher3c5a1912012-12-19 22:02:53 +00002182 const DIEAbbrev *Abbrev = Abbrevs->at(i);
Bill Wendling480ff322009-05-20 23:21:38 +00002183
2184 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00002185 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00002186
2187 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002188 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00002189 }
2190
2191 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00002192 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00002193
Eric Christopher3c5a1912012-12-19 22:02:53 +00002194 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
Eric Christopher996b2b72012-12-13 03:00:38 +00002195 Asm->OutStreamer.EmitLabel(End);
Bill Wendling480ff322009-05-20 23:21:38 +00002196 }
2197}
2198
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002199// Emit the last address of the section and the end of the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +00002200void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00002201 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00002202 Asm->OutStreamer.AddComment("Extended Op");
2203 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002204
Chris Lattner566cae92010-03-09 23:52:58 +00002205 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002206 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00002207 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2208 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2209
2210 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002211
Chris Lattnera179b522010-04-04 19:25:43 +00002212 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Eric Christopherce0cfce2013-01-09 01:35:34 +00002213 Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002214
2215 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00002216 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2217 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002218 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00002219 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002220}
2221
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002222// Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00002223void DwarfDebug::emitAccelNames() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002224 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002225 dwarf::DW_FORM_data4));
2226 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2227 E = CUMap.end(); I != E; ++I) {
2228 CompileUnit *TheCU = I->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00002229 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2230 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002231 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002232 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002233 const std::vector<DIE *> &Entities = GI->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00002234 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2235 DE = Entities.end(); DI != DE; ++DI)
2236 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00002237 }
2238 }
2239
2240 AT.FinalizeTable(Asm, "Names");
2241 Asm->OutStreamer.SwitchSection(
2242 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2243 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2244 Asm->OutStreamer.EmitLabel(SectionBegin);
2245
2246 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002247 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002248}
2249
Eric Christopher48fef592012-12-20 21:58:40 +00002250// Emit objective C classes and categories into a hashed accelerator table
2251// section.
Eric Christopher4996c702011-11-07 09:24:32 +00002252void DwarfDebug::emitAccelObjC() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002253 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002254 dwarf::DW_FORM_data4));
2255 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2256 E = CUMap.end(); I != E; ++I) {
2257 CompileUnit *TheCU = I->second;
2258 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2259 for (StringMap<std::vector<DIE*> >::const_iterator
2260 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002261 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002262 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher4996c702011-11-07 09:24:32 +00002263 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2264 DE = Entities.end(); DI != DE; ++DI)
2265 AT.AddName(Name, (*DI));
2266 }
2267 }
2268
2269 AT.FinalizeTable(Asm, "ObjC");
2270 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2271 .getDwarfAccelObjCSection());
2272 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2273 Asm->OutStreamer.EmitLabel(SectionBegin);
2274
2275 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002276 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002277}
2278
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002279// Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002280void DwarfDebug::emitAccelNamespaces() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002281 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002282 dwarf::DW_FORM_data4));
2283 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2284 E = CUMap.end(); I != E; ++I) {
2285 CompileUnit *TheCU = I->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00002286 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2287 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002288 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002289 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002290 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00002291 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2292 DE = Entities.end(); DI != DE; ++DI)
2293 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00002294 }
2295 }
2296
2297 AT.FinalizeTable(Asm, "namespac");
2298 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2299 .getDwarfAccelNamespaceSection());
2300 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2301 Asm->OutStreamer.EmitLabel(SectionBegin);
2302
2303 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002304 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002305}
2306
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002307// Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002308void DwarfDebug::emitAccelTypes() {
Eric Christopher21bde872012-01-06 04:35:23 +00002309 std::vector<DwarfAccelTable::Atom> Atoms;
Eric Christophercf7289f2013-09-05 18:20:16 +00002310 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher21bde872012-01-06 04:35:23 +00002311 dwarf::DW_FORM_data4));
Eric Christophercf7289f2013-09-05 18:20:16 +00002312 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag,
Eric Christopher21bde872012-01-06 04:35:23 +00002313 dwarf::DW_FORM_data2));
Eric Christophercf7289f2013-09-05 18:20:16 +00002314 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags,
Eric Christopher21bde872012-01-06 04:35:23 +00002315 dwarf::DW_FORM_data1));
2316 DwarfAccelTable AT(Atoms);
Eric Christopher4996c702011-11-07 09:24:32 +00002317 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2318 E = CUMap.end(); I != E; ++I) {
2319 CompileUnit *TheCU = I->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002320 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2321 = TheCU->getAccelTypes();
2322 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002323 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002324 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002325 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002326 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2327 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2328 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher4996c702011-11-07 09:24:32 +00002329 }
2330 }
2331
2332 AT.FinalizeTable(Asm, "types");
2333 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2334 .getDwarfAccelTypesSection());
2335 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2336 Asm->OutStreamer.EmitLabel(SectionBegin);
2337
2338 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002339 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002340}
2341
Eric Christopherdd1a0122013-09-13 00:35:05 +00002342// Public name handling.
2343// The format for the various pubnames:
2344//
2345// dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2346// for the DIE that is named.
2347//
2348// gnu pubnames - offset/index value/name tuples where the offset is the offset
2349// into the CU and the index value is computed according to the type of value
2350// for the DIE that is named.
2351//
2352// For type units the offset is the offset of the skeleton DIE. For split dwarf
2353// it's the offset within the debug_info/debug_types dwo section, however, the
2354// reference in the pubname header doesn't change.
2355
2356/// computeIndexValue - Compute the gdb index value for the DIE and CU.
David Blaikie8dec4072013-09-19 20:40:26 +00002357static dwarf::PubIndexEntryDescriptor computeIndexValue(CompileUnit *CU,
2358 DIE *Die) {
Eric Christopherd2b497b2013-10-16 01:37:49 +00002359 dwarf::GDBIndexEntryLinkage Linkage = dwarf::GIEL_STATIC;
2360
2361 // We could have a specification DIE that has our most of our knowledge,
2362 // look for that now.
2363 DIEValue *SpecVal = Die->findAttribute(dwarf::DW_AT_specification);
2364 if (SpecVal) {
2365 DIE *SpecDIE = cast<DIEEntry>(SpecVal)->getEntry();
2366 if (SpecDIE->findAttribute(dwarf::DW_AT_external))
2367 Linkage = dwarf::GIEL_EXTERNAL;
2368 } else if (Die->findAttribute(dwarf::DW_AT_external))
2369 Linkage = dwarf::GIEL_EXTERNAL;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002370
2371 switch (Die->getTag()) {
2372 case dwarf::DW_TAG_class_type:
2373 case dwarf::DW_TAG_structure_type:
2374 case dwarf::DW_TAG_union_type:
2375 case dwarf::DW_TAG_enumeration_type:
Eric Christopher261d2342013-09-23 20:55:35 +00002376 return dwarf::PubIndexEntryDescriptor(
2377 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2378 ? dwarf::GIEL_STATIC
2379 : dwarf::GIEL_EXTERNAL);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002380 case dwarf::DW_TAG_typedef:
2381 case dwarf::DW_TAG_base_type:
2382 case dwarf::DW_TAG_subrange_type:
David Blaikie8dec4072013-09-19 20:40:26 +00002383 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002384 case dwarf::DW_TAG_namespace:
David Blaikie8dec4072013-09-19 20:40:26 +00002385 return dwarf::GIEK_TYPE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002386 case dwarf::DW_TAG_subprogram:
Eric Christopherccac5c42013-09-23 22:59:14 +00002387 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002388 case dwarf::DW_TAG_constant:
2389 case dwarf::DW_TAG_variable:
Eric Christopherccac5c42013-09-23 22:59:14 +00002390 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002391 case dwarf::DW_TAG_enumerator:
David Blaikie8dec4072013-09-19 20:40:26 +00002392 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2393 dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002394 default:
David Blaikie8dec4072013-09-19 20:40:26 +00002395 return dwarf::GIEK_NONE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002396 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002397}
2398
Eric Christopher5f93bb92013-09-09 20:03:17 +00002399/// emitDebugPubNames - Emit visible names into a debug pubnames section.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002400///
Eric Christopherdd1a0122013-09-13 00:35:05 +00002401void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002402 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christopherdd1a0122013-09-13 00:35:05 +00002403 const MCSection *PSec =
2404 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2405 : Asm->getObjFileLowering().getDwarfPubNamesSection();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002406
2407 typedef DenseMap<const MDNode*, CompileUnit*> CUMapType;
2408 for (CUMapType::iterator I = CUMap.begin(), E = CUMap.end(); I != E; ++I) {
2409 CompileUnit *TheCU = I->second;
2410 unsigned ID = TheCU->getUniqueID();
2411
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002412 // Start the dwarf pubnames section.
Eric Christopher13b99d22013-09-10 21:49:37 +00002413 Asm->OutStreamer.SwitchSection(PSec);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002414
Eric Christopher39eebfa2013-09-30 23:14:16 +00002415 // Emit a label so we can reference the beginning of this pubname section.
2416 if (GnuStyle)
2417 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames",
2418 TheCU->getUniqueID()));
2419
Eric Christopherdd1a0122013-09-13 00:35:05 +00002420 // Emit the header.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002421 Asm->OutStreamer.AddComment("Length of Public Names Info");
2422 Asm->EmitLabelDifference(Asm->GetTempSymbol("pubnames_end", ID),
2423 Asm->GetTempSymbol("pubnames_begin", ID), 4);
2424
2425 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin", ID));
2426
2427 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002428 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002429
2430 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2431 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2432 DwarfInfoSectionSym);
2433
2434 Asm->OutStreamer.AddComment("Compilation Unit Length");
2435 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(), ID),
2436 Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2437 4);
2438
Eric Christopherdd1a0122013-09-13 00:35:05 +00002439 // Emit the pubnames for this compilation unit.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002440 const StringMap<DIE*> &Globals = TheCU->getGlobalNames();
2441 for (StringMap<DIE*>::const_iterator
2442 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2443 const char *Name = GI->getKeyData();
Eric Christopherdd1a0122013-09-13 00:35:05 +00002444 DIE *Entity = GI->second;
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002445
2446 Asm->OutStreamer.AddComment("DIE offset");
2447 Asm->EmitInt32(Entity->getOffset());
2448
Eric Christopherdd1a0122013-09-13 00:35:05 +00002449 if (GnuStyle) {
David Blaikied0a869d2013-09-19 22:19:37 +00002450 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2451 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002452 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002453 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002454 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002455 }
2456
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002457 if (Asm->isVerbose())
2458 Asm->OutStreamer.AddComment("External Name");
Rafael Espindola64e1af82013-07-02 15:49:13 +00002459 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002460 }
2461
2462 Asm->OutStreamer.AddComment("End Mark");
2463 Asm->EmitInt32(0);
2464 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end", ID));
2465 }
2466}
2467
Eric Christopherdd1a0122013-09-13 00:35:05 +00002468void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
Eric Christopher8b3737f2013-09-13 00:34:58 +00002469 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christopher261d2342013-09-23 20:55:35 +00002470 const MCSection *PSec =
2471 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2472 : Asm->getObjFileLowering().getDwarfPubTypesSection();
Eric Christopher8b3737f2013-09-13 00:34:58 +00002473
Devang Patel1a0df9a2010-05-10 22:49:55 +00002474 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
Eric Christopher8b3737f2013-09-13 00:34:58 +00002475 E = CUMap.end();
2476 I != E; ++I) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002477 CompileUnit *TheCU = I->second;
Eric Christopher6abc9c52011-11-07 09:18:35 +00002478 // Start the dwarf pubtypes section.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002479 Asm->OutStreamer.SwitchSection(PSec);
Eric Christopher39eebfa2013-09-30 23:14:16 +00002480
2481 // Emit a label so we can reference the beginning of this pubtype section.
2482 if (GnuStyle)
2483 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes",
2484 TheCU->getUniqueID()));
2485
2486 // Emit the header.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002487 Asm->OutStreamer.AddComment("Length of Public Types Info");
2488 Asm->EmitLabelDifference(
Eric Christopher8b3737f2013-09-13 00:34:58 +00002489 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2490 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002491
Eric Christopher8b3737f2013-09-13 00:34:58 +00002492 Asm->OutStreamer.EmitLabel(
2493 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002494
Eric Christopher8b3737f2013-09-13 00:34:58 +00002495 if (Asm->isVerbose())
2496 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002497 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002498
Devang Patel1a0df9a2010-05-10 22:49:55 +00002499 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002500 Asm->EmitSectionOffset(
2501 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()),
2502 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002503
Devang Patel1a0df9a2010-05-10 22:49:55 +00002504 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002505 Asm->EmitLabelDifference(
2506 Asm->GetTempSymbol(ISec->getLabelEndName(), TheCU->getUniqueID()),
2507 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002508
Eric Christopher39eebfa2013-09-30 23:14:16 +00002509 // Emit the pubtypes.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002510 const StringMap<DIE *> &Globals = TheCU->getGlobalTypes();
2511 for (StringMap<DIE *>::const_iterator GI = Globals.begin(),
2512 GE = Globals.end();
2513 GI != GE; ++GI) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002514 const char *Name = GI->getKeyData();
Nick Lewycky019d2552011-07-29 03:49:23 +00002515 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002516
Eric Christopher8b3737f2013-09-13 00:34:58 +00002517 if (Asm->isVerbose())
2518 Asm->OutStreamer.AddComment("DIE offset");
Devang Patel1a0df9a2010-05-10 22:49:55 +00002519 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002520
Eric Christopherdd1a0122013-09-13 00:35:05 +00002521 if (GnuStyle) {
David Blaikied0a869d2013-09-19 22:19:37 +00002522 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2523 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002524 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002525 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002526 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002527 }
2528
Eric Christopher8b3737f2013-09-13 00:34:58 +00002529 if (Asm->isVerbose())
2530 Asm->OutStreamer.AddComment("External Name");
2531
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002532 // Emit the name with a terminating null byte.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002533 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002534 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002535
Devang Patel1a0df9a2010-05-10 22:49:55 +00002536 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002537 Asm->EmitInt32(0);
Eric Christopher8b3737f2013-09-13 00:34:58 +00002538 Asm->OutStreamer.EmitLabel(
2539 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00002540 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002541}
2542
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002543// Emit strings into a string section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002544void DwarfUnits::emitStrings(const MCSection *StrSection,
2545 const MCSection *OffsetSection = NULL,
2546 const MCSymbol *StrSecSym = NULL) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002547
Eric Christopher27614582013-01-08 22:22:06 +00002548 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002549
Chris Lattner3d72a672010-03-09 23:38:23 +00002550 // Start the dwarf str section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002551 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling480ff322009-05-20 23:21:38 +00002552
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002553 // Get all of the string pool entries and put them in an array by their ID so
2554 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002555 SmallVector<std::pair<unsigned,
Eric Christopherb800ff72013-01-07 22:40:45 +00002556 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002557
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002558 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
Eric Christopher27614582013-01-08 22:22:06 +00002559 I = StringPool.begin(), E = StringPool.end();
Eric Christopher48fef592012-12-20 21:58:40 +00002560 I != E; ++I)
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002561 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002562
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002563 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002564
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002565 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002566 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002567 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002568
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002569 // Emit the string itself with a terminating null byte.
Benjamin Kramer148db362011-11-09 12:12:04 +00002570 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
Eric Christopherce0cfce2013-01-09 01:35:34 +00002571 Entries[i].second->getKeyLength()+1));
Bill Wendling480ff322009-05-20 23:21:38 +00002572 }
Eric Christopher2cbd5762013-01-07 19:32:41 +00002573
2574 // If we've got an offset section go ahead and emit that now as well.
2575 if (OffsetSection) {
2576 Asm->OutStreamer.SwitchSection(OffsetSection);
2577 unsigned offset = 0;
Eric Christopher962c9082013-01-15 23:56:56 +00002578 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002579 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopherbf7bc492013-01-09 03:52:05 +00002580 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopher2cbd5762013-01-07 19:32:41 +00002581 offset += Entries[i].second->getKeyLength() + 1;
2582 }
2583 }
Bill Wendling480ff322009-05-20 23:21:38 +00002584}
2585
Eric Christopher962c9082013-01-15 23:56:56 +00002586// Emit strings into a string section.
2587void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2588
2589 if (AddressPool.empty()) return;
2590
2591 // Start the dwarf addr section.
2592 Asm->OutStreamer.SwitchSection(AddrSection);
2593
David Blaikiece1960f2013-07-08 17:51:28 +00002594 // Order the address pool entries by ID
David Blaikieac569a62013-07-08 17:33:10 +00002595 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher962c9082013-01-15 23:56:56 +00002596
David Blaikiece1960f2013-07-08 17:51:28 +00002597 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2598 E = AddressPool.end();
Eric Christopher962c9082013-01-15 23:56:56 +00002599 I != E; ++I)
David Blaikieac569a62013-07-08 17:33:10 +00002600 Entries[I->second] = I->first;
Eric Christopher962c9082013-01-15 23:56:56 +00002601
2602 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002603 // Emit an expression for reference from debug information entries.
David Blaikieac569a62013-07-08 17:33:10 +00002604 if (const MCExpr *Expr = Entries[i])
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002605 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
Eric Christopher962c9082013-01-15 23:56:56 +00002606 else
2607 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2608 }
2609
2610}
2611
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002612// Emit visible names into a debug str section.
2613void DwarfDebug::emitDebugStr() {
2614 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2615 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2616}
2617
Eric Christopher9046f942013-07-02 21:36:07 +00002618// Emit locations into the debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002619void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002620 if (DotDebugLocEntries.empty())
2621 return;
2622
Eric Christopher4887c8f2013-03-29 23:34:06 +00002623 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Devang Patel116a9d72011-02-04 22:57:18 +00002624 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2625 I != E; ++I) {
2626 DotDebugLocEntry &Entry = *I;
2627 if (I + 1 != DotDebugLocEntries.end())
2628 Entry.Merge(I+1);
2629 }
2630
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002631 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002632 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00002633 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002634 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002635 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2636 unsigned index = 1;
Eric Christopher4887c8f2013-03-29 23:34:06 +00002637 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002638 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002639 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002640 DotDebugLocEntry &Entry = *I;
2641 if (Entry.isMerged()) continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002642 if (Entry.isEmpty()) {
Eric Christopherce0cfce2013-01-09 01:35:34 +00002643 Asm->OutStreamer.EmitIntValue(0, Size);
2644 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002645 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002646 } else {
Eric Christopher25f06422013-07-03 22:40:18 +00002647 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2648 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2649 DIVariable DV(Entry.getVariable());
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002650 Asm->OutStreamer.AddComment("Loc expr size");
2651 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2652 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2653 Asm->EmitLabelDifference(end, begin, 2);
2654 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002655 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002656 DIBasicType BTy(DV.getType());
2657 if (BTy.Verify() &&
Eric Christopher6a841382012-11-19 22:42:10 +00002658 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patel324f8432011-06-01 22:03:25 +00002659 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2660 Asm->OutStreamer.AddComment("DW_OP_consts");
2661 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002662 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002663 } else {
2664 Asm->OutStreamer.AddComment("DW_OP_constu");
2665 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002666 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002667 }
Devang Pateled9fd452011-07-08 16:49:43 +00002668 } else if (Entry.isLocation()) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002669 MachineLocation Loc = Entry.getLoc();
Eric Christopher6a841382012-11-19 22:42:10 +00002670 if (!DV.hasComplexAddress())
Devang Pateled9fd452011-07-08 16:49:43 +00002671 // Regular entry.
Eric Christopher614a89f2013-07-03 22:40:21 +00002672 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002673 else {
2674 // Complex address entry.
2675 unsigned N = DV.getNumAddrElements();
2676 unsigned i = 0;
2677 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002678 if (Loc.getOffset()) {
Devang Pateled9fd452011-07-08 16:49:43 +00002679 i = 2;
Eric Christopher614a89f2013-07-03 22:40:21 +00002680 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002681 Asm->OutStreamer.AddComment("DW_OP_deref");
2682 Asm->EmitInt8(dwarf::DW_OP_deref);
2683 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2684 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2685 Asm->EmitSLEB128(DV.getAddrElement(1));
2686 } else {
2687 // If first address element is OpPlus then emit
2688 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher614a89f2013-07-03 22:40:21 +00002689 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2690 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002691 i = 2;
2692 }
2693 } else {
Eric Christopher614a89f2013-07-03 22:40:21 +00002694 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002695 }
Eric Christopher6a841382012-11-19 22:42:10 +00002696
Devang Pateled9fd452011-07-08 16:49:43 +00002697 // Emit remaining complex address elements.
2698 for (; i < N; ++i) {
2699 uint64_t Element = DV.getAddrElement(i);
2700 if (Element == DIBuilder::OpPlus) {
2701 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2702 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher4d250522012-05-08 18:56:00 +00002703 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002704 if (!Loc.isReg())
Eric Christopher4d250522012-05-08 18:56:00 +00002705 Asm->EmitInt8(dwarf::DW_OP_deref);
2706 } else
2707 llvm_unreachable("unknown Opcode found in complex address");
Devang Pateled9fd452011-07-08 16:49:43 +00002708 }
Devang Patel3e021532011-04-28 02:22:40 +00002709 }
Devang Patel3e021532011-04-28 02:22:40 +00002710 }
Devang Pateled9fd452011-07-08 16:49:43 +00002711 // else ... ignore constant fp. There is not any good way to
2712 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002713 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002714 }
2715 }
Bill Wendling480ff322009-05-20 23:21:38 +00002716}
2717
Richard Mitton21101b32013-09-19 23:21:01 +00002718struct SymbolCUSorter {
2719 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2720 const MCStreamer &Streamer;
2721
2722 bool operator() (const SymbolCU &A, const SymbolCU &B) {
2723 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2724 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2725
2726 // Symbols with no order assigned should be placed at the end.
2727 // (e.g. section end labels)
2728 if (IA == 0)
2729 IA = (unsigned)(-1);
2730 if (IB == 0)
2731 IB = (unsigned)(-1);
2732 return IA < IB;
2733 }
2734};
2735
Richard Mitton21101b32013-09-19 23:21:01 +00002736static bool CUSort(const CompileUnit *A, const CompileUnit *B) {
2737 return (A->getUniqueID() < B->getUniqueID());
2738}
2739
2740struct ArangeSpan {
2741 const MCSymbol *Start, *End;
2742};
2743
2744// Emit a debug aranges section, containing a CU lookup for any
2745// address we can tie back to a CU.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002746void DwarfDebug::emitDebugARanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002747 // Start the dwarf aranges section.
Eric Christopherac8199b2013-08-30 00:39:57 +00002748 Asm->OutStreamer
2749 .SwitchSection(Asm->getObjFileLowering().getDwarfARangesSection());
Richard Mitton21101b32013-09-19 23:21:01 +00002750
2751 typedef DenseMap<CompileUnit *, std::vector<ArangeSpan> > SpansType;
2752
2753 SpansType Spans;
2754
2755 // Build a list of sections used.
2756 std::vector<const MCSection *> Sections;
2757 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2758 it++) {
2759 const MCSection *Section = it->first;
2760 Sections.push_back(Section);
2761 }
2762
2763 // Sort the sections into order.
2764 // This is only done to ensure consistent output order across different runs.
2765 std::sort(Sections.begin(), Sections.end(), SectionSort);
2766
2767 // Build a set of address spans, sorted by CU.
2768 for (size_t SecIdx=0;SecIdx<Sections.size();SecIdx++) {
2769 const MCSection *Section = Sections[SecIdx];
2770 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2771 if (List.size() < 2)
2772 continue;
2773
2774 // Sort the symbols by offset within the section.
2775 SymbolCUSorter sorter(Asm->OutStreamer);
2776 std::sort(List.begin(), List.end(), sorter);
2777
2778 // If we have no section (e.g. common), just write out
2779 // individual spans for each symbol.
2780 if (Section == NULL) {
2781 for (size_t n = 0; n < List.size(); n++) {
2782 const SymbolCU &Cur = List[n];
2783
2784 ArangeSpan Span;
2785 Span.Start = Cur.Sym;
2786 Span.End = NULL;
2787 if (Cur.CU)
2788 Spans[Cur.CU].push_back(Span);
2789 }
2790 } else {
2791 // Build spans between each label.
2792 const MCSymbol *StartSym = List[0].Sym;
2793 for (size_t n = 1; n < List.size(); n++) {
2794 const SymbolCU &Prev = List[n - 1];
2795 const SymbolCU &Cur = List[n];
2796
2797 // Try and build the longest span we can within the same CU.
2798 if (Cur.CU != Prev.CU) {
2799 ArangeSpan Span;
2800 Span.Start = StartSym;
2801 Span.End = Cur.Sym;
2802 Spans[Prev.CU].push_back(Span);
2803 StartSym = Cur.Sym;
2804 }
2805 }
2806 }
2807 }
2808
2809 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2810 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2811
2812 // Build a list of CUs used.
2813 std::vector<CompileUnit *> CUs;
2814 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
2815 CompileUnit *CU = it->first;
2816 CUs.push_back(CU);
2817 }
2818
2819 // Sort the CU list (again, to ensure consistent output order).
2820 std::sort(CUs.begin(), CUs.end(), CUSort);
2821
2822 // Emit an arange table for each CU we used.
2823 for (size_t CUIdx=0;CUIdx<CUs.size();CUIdx++) {
2824 CompileUnit *CU = CUs[CUIdx];
2825 std::vector<ArangeSpan> &List = Spans[CU];
2826
2827 // Emit size of content not including length itself.
2828 unsigned ContentSize
2829 = sizeof(int16_t) // DWARF ARange version number
2830 + sizeof(int32_t) // Offset of CU in the .debug_info section
2831 + sizeof(int8_t) // Pointer Size (in bytes)
2832 + sizeof(int8_t); // Segment Size (in bytes)
2833
2834 unsigned TupleSize = PtrSize * 2;
2835
2836 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2837 unsigned Padding = 0;
2838 while (((sizeof(int32_t) + ContentSize + Padding) % TupleSize) != 0)
2839 Padding++;
2840
2841 ContentSize += Padding;
2842 ContentSize += (List.size() + 1) * TupleSize;
2843
2844 // For each compile unit, write the list of spans it covers.
2845 Asm->OutStreamer.AddComment("Length of ARange Set");
2846 Asm->EmitInt32(ContentSize);
2847 Asm->OutStreamer.AddComment("DWARF Arange version number");
2848 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2849 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
2850 Asm->EmitSectionOffset(
2851 Asm->GetTempSymbol(ISec->getLabelBeginName(), CU->getUniqueID()),
2852 DwarfInfoSectionSym);
2853 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2854 Asm->EmitInt8(PtrSize);
2855 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2856 Asm->EmitInt8(0);
2857
2858 for (unsigned n = 0; n < Padding; n++)
2859 Asm->EmitInt8(0xff);
2860
2861 for (unsigned n = 0; n < List.size(); n++) {
2862 const ArangeSpan &Span = List[n];
2863 Asm->EmitLabelReference(Span.Start, PtrSize);
2864
2865 // Calculate the size as being from the span start to it's end.
Richard Mitton089ed892013-09-23 17:56:20 +00002866 if (Span.End) {
Richard Mitton21101b32013-09-19 23:21:01 +00002867 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
Richard Mitton089ed892013-09-23 17:56:20 +00002868 } else {
2869 // For symbols without an end marker (e.g. common), we
2870 // write a single arange entry containing just that one symbol.
2871 uint64_t Size = SymSize[Span.Start];
2872 if (Size == 0)
2873 Size = 1;
2874
2875 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2876 }
Richard Mitton21101b32013-09-19 23:21:01 +00002877 }
2878
2879 Asm->OutStreamer.AddComment("ARange terminator");
2880 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2881 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2882 }
Bill Wendling480ff322009-05-20 23:21:38 +00002883}
2884
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002885// Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002886void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002887 // Start the dwarf ranges section.
Eric Christopherac8199b2013-08-30 00:39:57 +00002888 Asm->OutStreamer
2889 .SwitchSection(Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002890 unsigned char Size = Asm->getDataLayout().getPointerSize();
Eric Christopher4887c8f2013-03-29 23:34:06 +00002891 for (SmallVectorImpl<const MCSymbol *>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002892 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00002893 I != E; ++I) {
2894 if (*I)
Eric Christopherbf7bc492013-01-09 03:52:05 +00002895 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
Devang Patel12563b32010-04-16 23:33:45 +00002896 else
Eric Christopherce0cfce2013-01-09 01:35:34 +00002897 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel12563b32010-04-16 23:33:45 +00002898 }
Bill Wendling480ff322009-05-20 23:21:38 +00002899}
2900
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002901// Emit visible names into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002902void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002903 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00002904 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00002905 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002906 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00002907 }
2908}
2909
Eric Christopherd692c1d2012-12-11 19:42:09 +00002910// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002911
2912// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2913// DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
Eric Christopher9a08f9e2013-10-01 00:43:36 +00002914// DW_AT_ranges_base, DW_AT_addr_base.
Eric Christopher6fdf3242013-08-26 23:50:43 +00002915CompileUnit *DwarfDebug::constructSkeletonCU(const CompileUnit *CU) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002916
2917 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher6fdf3242013-08-26 23:50:43 +00002918 CompileUnit *NewCU = new CompileUnit(CU->getUniqueID(), Die, CU->getNode(),
2919 Asm, this, &SkeletonHolder);
Eric Christopher4c7765f2013-01-17 03:00:04 +00002920
Eric Christopherdae389b2013-02-22 23:50:08 +00002921 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
Eric Christopher6b16b432013-08-26 23:57:03 +00002922 DICompileUnit(CU->getNode()).getSplitDebugFilename());
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002923
Eric Christopher44c6aa62013-04-22 07:51:08 +00002924 // Relocate to the beginning of the addr_base section, else 0 for the
2925 // beginning of the one for this compile unit.
Eric Christopher55863be2013-04-07 03:43:09 +00002926 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2927 NewCU->addLabel(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2928 DwarfAddrSectionSym);
2929 else
Eric Christopher44c6aa62013-04-22 07:51:08 +00002930 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base,
2931 dwarf::DW_FORM_sec_offset, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002932
2933 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher962c9082013-01-15 23:56:56 +00002934 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002935 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher962c9082013-01-15 23:56:56 +00002936
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002937 // DW_AT_stmt_list is a offset of line number information for this
2938 // compile unit in debug_line section.
Eric Christopher55863be2013-04-07 03:43:09 +00002939 // FIXME: Should handle multiple compile units.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002940 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher4c7765f2013-01-17 03:00:04 +00002941 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher74804332013-02-07 21:19:50 +00002942 DwarfLineSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002943 else
Eric Christopher4c7765f2013-01-17 03:00:04 +00002944 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002945
2946 if (!CompilationDir.empty())
Eric Christopher2cbd5762013-01-07 19:32:41 +00002947 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002948
Eric Christopher1d06eb52013-10-01 00:43:31 +00002949 // Flags to let the linker know we have emitted new style pubnames.
Eric Christopher39eebfa2013-09-30 23:14:16 +00002950 if (GenerateGnuPubSections) {
2951 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2952 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_sec_offset,
2953 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()));
2954 else
2955 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
2956 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()),
2957 DwarfGnuPubNamesSectionSym);
2958
2959 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2960 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_sec_offset,
2961 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()));
2962 else
2963 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopherf976c772013-10-03 17:41:16 +00002964 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()),
Eric Christopher39eebfa2013-09-30 23:14:16 +00002965 DwarfGnuPubTypesSectionSym);
2966 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002967
Eric Christopher9a08f9e2013-10-01 00:43:36 +00002968 // Flag if we've emitted any ranges and their location for the compile unit.
2969 if (DebugRangeSymbols.size()) {
2970 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2971 NewCU->addLabel(Die, dwarf::DW_AT_GNU_ranges_base,
2972 dwarf::DW_FORM_sec_offset, DwarfDebugRangeSectionSym);
2973 else
2974 NewCU->addUInt(Die, dwarf::DW_AT_GNU_ranges_base, dwarf::DW_FORM_data4,
2975 0);
2976 }
2977
Eric Christopherc8a310e2012-12-10 23:34:43 +00002978 SkeletonHolder.addUnit(NewCU);
Eric Christopher5b33b3c2013-02-06 21:53:56 +00002979 SkeletonCUs.push_back(NewCU);
Eric Christopherc8a310e2012-12-10 23:34:43 +00002980
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002981 return NewCU;
2982}
2983
Eric Christopher3c5a1912012-12-19 22:02:53 +00002984void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
2985 assert(useSplitDwarf() && "No split dwarf debug info?");
2986 emitAbbrevs(Section, &SkeletonAbbrevs);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002987}
2988
Eric Christopherd692c1d2012-12-11 19:42:09 +00002989// Emit the .debug_info.dwo section for separated dwarf. This contains the
2990// compile units that would normally be in debug_info.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002991void DwarfDebug::emitDebugInfoDWO() {
Eric Christophercdf218d2012-12-10 19:51:21 +00002992 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christophera2de8262012-12-15 00:04:07 +00002993 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
Eric Christopher3c5a1912012-12-19 22:02:53 +00002994 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2995 DwarfAbbrevDWOSectionSym);
2996}
2997
2998// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2999// abbreviations for the .debug_info.dwo section.
3000void DwarfDebug::emitDebugAbbrevDWO() {
3001 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopher48fef592012-12-20 21:58:40 +00003002 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
3003 &Abbreviations);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00003004}
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003005
3006// Emit the .debug_str.dwo section for separated dwarf. This contains the
3007// string section and is identical in format to traditional .debug_str
3008// sections.
3009void DwarfDebug::emitDebugStrDWO() {
3010 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherb800ff72013-01-07 22:40:45 +00003011 const MCSection *OffSec = Asm->getObjFileLowering()
3012 .getDwarfStrOffDWOSection();
Eric Christopher2cbd5762013-01-07 19:32:41 +00003013 const MCSymbol *StrSym = DwarfStrSectionSym;
3014 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
3015 OffSec, StrSym);
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003016}