blob: f491d01876c7dada765f8e9cb329a387d912acfa [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.
Manman Ren4a841a82013-10-29 01:03:01 +0000381 SPDie = SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram, *SPCU->getCUDie());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000382 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin, AbsSPDIE);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000383 } else {
384 DISubprogram SPDecl = SP.getFunctionDeclaration();
385 if (!SPDecl.isSubprogram()) {
386 // There is not any need to generate specification DIE for a function
387 // defined at compile unit level. If a function is defined inside another
388 // function then gdb prefers the definition at top level and but does not
389 // expect specification DIE in parent function. So avoid creating
390 // specification DIE for a function defined inside a function.
Manman Renc50fa112013-10-10 18:40:01 +0000391 DIScope SPContext = resolve(SP.getContext());
392 if (SP.isDefinition() && !SPContext.isCompileUnit() &&
393 !SPContext.isFile() &&
394 !isSubprogramContext(SPContext)) {
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000395 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
396
397 // Add arguments.
398 DICompositeType SPTy = SP.getType();
399 DIArray Args = SPTy.getTypeArray();
Eric Christopher31b05762013-08-08 01:41:00 +0000400 uint16_t SPTag = SPTy.getTag();
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000401 if (SPTag == dwarf::DW_TAG_subroutine_type)
402 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
Manman Ren4a841a82013-10-29 01:03:01 +0000403 DIE *Arg =
404 SPCU->createAndAddDIE(dwarf::DW_TAG_formal_parameter, *SPDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000405 DIType ATy = DIType(Args.getElement(i));
406 SPCU->addType(Arg, ATy);
407 if (ATy.isArtificial())
408 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
409 if (ATy.isObjectPointer())
Manman Ren4c4b69c2013-10-11 23:58:05 +0000410 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer, Arg);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000411 }
412 DIE *SPDeclDie = SPDie;
Manman Ren4a841a82013-10-29 01:03:01 +0000413 SPDie =
414 SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram, *SPCU->getCUDie());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000415 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, SPDeclDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000416 }
417 }
Devang Patela37a95e2010-07-07 22:20:57 +0000418 }
419
Eric Christopher962c9082013-01-15 23:56:56 +0000420 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc,
421 Asm->GetTempSymbol("func_begin",
422 Asm->getFunctionNumber()));
423 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
424 Asm->GetTempSymbol("func_end",
425 Asm->getFunctionNumber()));
Chris Lattner3a383cb2010-04-05 00:13:49 +0000426 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
427 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000428 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000429
Eric Christopherd9843b32011-11-10 19:25:34 +0000430 // Add name to the name table, we do this here because we're guaranteed
431 // to have concrete versions of our DW_TAG_subprogram nodes.
432 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher6a841382012-11-19 22:42:10 +0000433
Chris Lattner3a383cb2010-04-05 00:13:49 +0000434 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000435}
436
Manman Ren5b2f4b02013-09-11 19:40:28 +0000437/// Check whether we should create a DIE for the given Scope, return true
438/// if we don't create a DIE (the corresponding DIE is null).
Manman Ren2312ed32013-09-10 18:40:41 +0000439bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
440 if (Scope->isAbstractScope())
441 return false;
442
Manman Ren5b2f4b02013-09-11 19:40:28 +0000443 // We don't create a DIE if there is no Range.
Manman Ren2312ed32013-09-10 18:40:41 +0000444 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
445 if (Ranges.empty())
446 return true;
447
448 if (Ranges.size() > 1)
449 return false;
450
Manman Ren5b2f4b02013-09-11 19:40:28 +0000451 // We don't create a DIE if we have a single Range and the end label
452 // is null.
Manman Ren2312ed32013-09-10 18:40:41 +0000453 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
454 MCSymbol *End = getLabelAfterInsn(RI->second);
455 return !End;
456}
457
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000458// Construct new DW_TAG_lexical_block for this scope and attach
459// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher6a841382012-11-19 22:42:10 +0000460DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000461 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000462 if (isLexicalScopeDIENull(Scope))
463 return 0;
464
Devang Patel6c74a872010-04-27 19:46:33 +0000465 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
466 if (Scope->isAbstractScope())
467 return ScopeDIE;
468
Craig Topper977e9cd2013-07-03 04:24:43 +0000469 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Eric Christopherdc42ea82013-07-03 01:57:28 +0000470 // If we have multiple ranges, emit them into the range section.
Devang Patel6c74a872010-04-27 19:46:33 +0000471 if (Ranges.size() > 1) {
472 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000473 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +0000474 // DW_AT_ranges appropriately.
Devang Patelf20c4f72011-04-12 22:53:02 +0000475 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000476 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000477 * Asm->getDataLayout().getPointerSize());
Craig Topperd8e43652013-07-03 04:17:25 +0000478 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +0000479 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +0000480 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
481 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +0000482 }
Eric Christopherc1110832013-07-03 01:22:29 +0000483
484 // Terminate the range list.
Devang Patel6c74a872010-04-27 19:46:33 +0000485 DebugRangeSymbols.push_back(NULL);
486 DebugRangeSymbols.push_back(NULL);
487 return ScopeDIE;
488 }
489
Eric Christopherdc42ea82013-07-03 01:57:28 +0000490 // Construct the address range for this DIE.
Craig Topperd8e43652013-07-03 04:17:25 +0000491 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopher962c9082013-01-15 23:56:56 +0000492 MCSymbol *Start = getLabelBeforeInsn(RI->first);
493 MCSymbol *End = getLabelAfterInsn(RI->second);
Manman Ren2312ed32013-09-10 18:40:41 +0000494 assert(End && "End label should not be null!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000495
Chris Lattnere13c3722010-03-09 01:58:53 +0000496 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
497 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000498
Eric Christopher962c9082013-01-15 23:56:56 +0000499 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
500 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000501
502 return ScopeDIE;
503}
504
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000505// This scope represents inlined body of a function. Construct DIE to
506// represent this concrete inlined copy of the function.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000507DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
508 LexicalScope *Scope) {
Craig Topper977e9cd2013-07-03 04:24:43 +0000509 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000510 assert(Ranges.empty() == false &&
511 "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000512
Devang Patelf098ce22011-07-27 00:34:13 +0000513 if (!Scope->getScopeNode())
514 return NULL;
515 DIScope DS(Scope->getScopeNode());
516 DISubprogram InlinedSP = getDISubprogram(DS);
Eric Christophere595bae2013-10-04 17:08:38 +0000517 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patelf098ce22011-07-27 00:34:13 +0000518 if (!OriginDIE) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000519 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patelf098ce22011-07-27 00:34:13 +0000520 return NULL;
521 }
522
Devang Patel73bc1722011-05-05 17:54:26 +0000523 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Manman Ren4c4b69c2013-10-11 23:58:05 +0000524 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000525
Devang Patelf098ce22011-07-27 00:34:13 +0000526 if (Ranges.size() > 1) {
527 // .debug_range section has not been laid out yet. Emit offset in
528 // .debug_range as a uint, size 4, for now. emitDIE will handle
529 // DW_AT_ranges appropriately.
530 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000531 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000532 * Asm->getDataLayout().getPointerSize());
Craig Topperd8e43652013-07-03 04:17:25 +0000533 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patelf098ce22011-07-27 00:34:13 +0000534 RE = Ranges.end(); RI != RE; ++RI) {
535 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
536 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
537 }
538 DebugRangeSymbols.push_back(NULL);
539 DebugRangeSymbols.push_back(NULL);
540 } else {
Craig Topperd8e43652013-07-03 04:17:25 +0000541 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000542 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
543 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
544
545 if (StartLabel == 0 || EndLabel == 0)
546 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
547
548 assert(StartLabel->isDefined() &&
549 "Invalid starting label for an inlined scope!");
550 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
551
Eric Christopher962c9082013-01-15 23:56:56 +0000552 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
553 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patelf098ce22011-07-27 00:34:13 +0000554 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000555
556 InlinedSubprogramDIEs.insert(OriginDIE);
557
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000558 // Add the call site information to the DIE.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000559 DILocation DL(Scope->getInlinedAt());
David Blaikief2443192013-10-21 17:28:37 +0000560 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, None,
Manman Ren1e427202013-03-07 01:42:00 +0000561 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
562 TheCU->getUniqueID()));
David Blaikief2443192013-10-21 17:28:37 +0000563 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, None, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000564
Eric Christopher8dda5d02011-12-04 06:02:38 +0000565 // Add name to the name table, we do this here because we're guaranteed
566 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
567 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher6a841382012-11-19 22:42:10 +0000568
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000569 return ScopeDIE;
570}
571
Manman Ren2312ed32013-09-10 18:40:41 +0000572DIE *DwarfDebug::createScopeChildrenDIE(CompileUnit *TheCU, LexicalScope *Scope,
573 SmallVectorImpl<DIE*> &Children) {
574 DIE *ObjectPointer = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +0000575
576 // Collect arguments for current function.
Devang Patel7e623022011-08-10 20:55:27 +0000577 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000578 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
579 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher6a841382012-11-19 22:42:10 +0000580 if (DIE *Arg =
Eric Christophere3417762012-09-12 23:36:19 +0000581 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel6c622ef2011-03-01 22:58:55 +0000582 Children.push_back(Arg);
Eric Christophere3417762012-09-12 23:36:19 +0000583 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
584 }
Devang Patel6c622ef2011-03-01 22:58:55 +0000585
Eric Christopherf84354b2011-10-03 15:49:16 +0000586 // Collect lexical scope children first.
Craig Topper977e9cd2013-07-03 04:24:43 +0000587 const SmallVectorImpl<DbgVariable *> &Variables =ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000588 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher6a841382012-11-19 22:42:10 +0000589 if (DIE *Variable =
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000590 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000591 Children.push_back(Variable);
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000592 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
593 }
Craig Topper977e9cd2013-07-03 04:24:43 +0000594 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000595 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Patel3acc70e2011-08-15 22:04:40 +0000596 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000597 Children.push_back(Nested);
Manman Ren2312ed32013-09-10 18:40:41 +0000598 return ObjectPointer;
599}
600
601// Construct a DIE for this scope.
602DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
603 if (!Scope || !Scope->getScopeNode())
604 return NULL;
605
606 DIScope DS(Scope->getScopeNode());
607
608 SmallVector<DIE *, 8> Children;
609 DIE *ObjectPointer = NULL;
610 bool ChildrenCreated = false;
611
Manman Ren5b2f4b02013-09-11 19:40:28 +0000612 // We try to create the scope DIE first, then the children DIEs. This will
613 // avoid creating un-used children then removing them later when we find out
614 // the scope DIE is null.
Devang Patel3b548aa2010-03-08 20:52:55 +0000615 DIE *ScopeDIE = NULL;
616 if (Scope->getInlinedAt())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000617 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3b548aa2010-03-08 20:52:55 +0000618 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000619 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000620 if (Scope->isAbstractScope()) {
Eric Christophere595bae2013-10-04 17:08:38 +0000621 ScopeDIE = TheCU->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000622 // Note down abstract DIE.
623 if (ScopeDIE)
624 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
625 }
Devang Patel3b548aa2010-03-08 20:52:55 +0000626 else
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000627 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3b548aa2010-03-08 20:52:55 +0000628 }
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000629 else {
Manman Ren5b2f4b02013-09-11 19:40:28 +0000630 // Early exit when we know the scope DIE is going to be null.
Manman Ren2312ed32013-09-10 18:40:41 +0000631 if (isLexicalScopeDIENull(Scope))
632 return NULL;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000633
634 // We create children here when we know the scope DIE is not going to be
635 // null and the children will be added to the scope DIE.
Manman Ren2312ed32013-09-10 18:40:41 +0000636 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
637 ChildrenCreated = true;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000638
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000639 // There is no need to emit empty lexical block DIE.
David Blaikie684fc532013-05-06 23:33:07 +0000640 std::pair<ImportedEntityMap::const_iterator,
641 ImportedEntityMap::const_iterator> Range = std::equal_range(
642 ScopesWithImportedEntities.begin(), ScopesWithImportedEntities.end(),
Timur Iskhodzhanovec4afe62013-05-07 07:47:47 +0000643 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode*)0),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000644 less_first());
David Blaikie684fc532013-05-06 23:33:07 +0000645 if (Children.empty() && Range.first == Range.second)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000646 return NULL;
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000647 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Manman Ren2312ed32013-09-10 18:40:41 +0000648 assert(ScopeDIE && "Scope DIE should not be null.");
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000649 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
650 ++i)
David Blaikie4dd2de72013-05-08 06:01:38 +0000651 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000652 }
Eric Christopher6a841382012-11-19 22:42:10 +0000653
Benjamin Kramer892daba2013-08-24 11:55:49 +0000654 if (!ScopeDIE) {
Manman Ren2312ed32013-09-10 18:40:41 +0000655 assert(Children.empty() &&
656 "We create children only when the scope DIE is not null.");
Benjamin Kramer892daba2013-08-24 11:55:49 +0000657 return NULL;
658 }
Manman Ren2312ed32013-09-10 18:40:41 +0000659 if (!ChildrenCreated)
Manman Ren5b2f4b02013-09-11 19:40:28 +0000660 // We create children when the scope DIE is not null.
Manman Ren2312ed32013-09-10 18:40:41 +0000661 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000662
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000663 // Add children
Craig Topperd8e43652013-07-03 04:17:25 +0000664 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000665 E = Children.end(); I != E; ++I)
666 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000667
Eric Christophere3417762012-09-12 23:36:19 +0000668 if (DS.isSubprogram() && ObjectPointer != NULL)
Manman Ren4c4b69c2013-10-11 23:58:05 +0000669 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, ObjectPointer);
Eric Christophere3417762012-09-12 23:36:19 +0000670
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000671 if (DS.isSubprogram())
Eric Christopherd9843b32011-11-10 19:25:34 +0000672 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000673
Eric Christopherd9843b32011-11-10 19:25:34 +0000674 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000675}
676
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000677// Look up the source id with the given directory and source file names.
678// If none currently exists, create a new id and insert it in the
679// SourceIds map. This can update DirectoryNames and SourceFileNames maps
680// as well.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000681unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Manman Ren1e427202013-03-07 01:42:00 +0000682 StringRef DirName, unsigned CUID) {
683 // If we use .loc in assembly, we can't separate .file entries according to
684 // compile units. Thus all files will belong to the default compile unit.
Rafael Espindolaac4ad252013-10-05 16:42:21 +0000685
686 // FIXME: add a better feature test than hasRawTextSupport. Even better,
687 // extend .file to support this.
688 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren1e427202013-03-07 01:42:00 +0000689 CUID = 0;
690
Devang Patel871d0b12010-09-16 20:57:49 +0000691 // If FE did not provide a file name, then assume stdin.
692 if (FileName.empty())
Manman Ren1e427202013-03-07 01:42:00 +0000693 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patele01b75c2011-03-24 20:30:50 +0000694
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000695 // TODO: this might not belong here. See if we can factor this better.
696 if (DirName == CompilationDir)
697 DirName = "";
698
Manman Ren1e427202013-03-07 01:42:00 +0000699 // FileIDCUMap stores the current ID for the given compile unit.
700 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel871d0b12010-09-16 20:57:49 +0000701
Manman Ren1e427202013-03-07 01:42:00 +0000702 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer71b19732012-03-11 14:56:26 +0000703 SmallString<128> NamePair;
Manman Ren5b22f9f2013-04-06 01:02:38 +0000704 NamePair += utostr(CUID);
Manman Ren1e427202013-03-07 01:42:00 +0000705 NamePair += '\0';
Benjamin Kramer71b19732012-03-11 14:56:26 +0000706 NamePair += DirName;
707 NamePair += '\0'; // Zero bytes are not allowed in paths.
708 NamePair += FileName;
709
710 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
711 if (Ent.getValue() != SrcId)
712 return Ent.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +0000713
Manman Ren1e427202013-03-07 01:42:00 +0000714 FileIDCUMap[CUID] = SrcId;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000715 // Print out a .file directive to specify files for .loc directives.
Manman Ren1e427202013-03-07 01:42:00 +0000716 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendling2b128d72009-05-20 23:19:06 +0000717
718 return SrcId;
719}
720
Eric Christopher48fef592012-12-20 21:58:40 +0000721// Create new CompileUnit for the given metadata node with tag
722// DW_TAG_compile_unit.
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000723CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +0000724 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +0000725 StringRef FN = DIUnit.getFilename();
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000726 CompilationDir = DIUnit.getDirectory();
Bill Wendling2b128d72009-05-20 23:19:06 +0000727
728 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopherbfceb2f2013-08-26 23:50:38 +0000729 CompileUnit *NewCU =
730 new CompileUnit(GlobalCUIndexCount++, Die, N, Asm, this, &InfoHolder);
Manman Ren1e427202013-03-07 01:42:00 +0000731
732 FileIDCUMap[NewCU->getUniqueID()] = 0;
733 // Call this to emit a .file directive if it wasn't emitted for the source
734 // file this CU comes from yet.
735 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
736
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000737 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patelf20c4f72011-04-12 22:53:02 +0000738 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
739 DIUnit.getLanguage());
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000740 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christopher52ce7182013-04-09 19:23:15 +0000741
Eric Christopherb1b94512012-08-01 18:19:01 +0000742 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher52ce7182013-04-09 19:23:15 +0000743 // into an entity. We're using 0 (or a NULL label) for this. For
744 // split dwarf it's in the skeleton CU so omit it here.
745 if (!useSplitDwarf())
746 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
Manman Ren4e042a62013-02-05 21:52:47 +0000747
748 // Define start line table label for each Compile Unit.
749 MCSymbol *LineTableStartSym = Asm->GetTempSymbol("line_table_start",
750 NewCU->getUniqueID());
751 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
752 NewCU->getUniqueID());
753
Manman Ren9d4c7352013-05-21 00:57:22 +0000754 // Use a single line table if we are using .loc and generating assembly.
755 bool UseTheFirstCU =
Rafael Espindolaac4ad252013-10-05 16:42:21 +0000756 (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport()) ||
757 (NewCU->getUniqueID() == 0);
Manman Ren9d4c7352013-05-21 00:57:22 +0000758
Eric Christopher52ce7182013-04-09 19:23:15 +0000759 if (!useSplitDwarf()) {
Eric Christophera51d3fc2013-09-27 22:50:48 +0000760 // DW_AT_stmt_list is a offset of line number information for this
761 // compile unit in debug_line section. For split dwarf this is
762 // left in the skeleton CU and so not included.
763 // The line table entries are not always emitted in assembly, so it
764 // is not okay to use line_table_start here.
Eric Christopher52ce7182013-04-09 19:23:15 +0000765 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Carlo Kokbac096a2013-08-13 17:46:57 +0000766 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christophera51d3fc2013-09-27 22:50:48 +0000767 UseTheFirstCU ? Asm->GetTempSymbol("section_line")
768 : LineTableStartSym);
Manman Ren9d4c7352013-05-21 00:57:22 +0000769 else if (UseTheFirstCU)
Eric Christopher52ce7182013-04-09 19:23:15 +0000770 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
771 else
772 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
773 LineTableStartSym, DwarfLineSectionSym);
Eric Christophera51d3fc2013-09-27 22:50:48 +0000774
775 // If we're using split dwarf the compilation dir is going to be in the
776 // skeleton CU and so we don't need to duplicate it here.
777 if (!CompilationDir.empty())
778 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
779
Eric Christopher1d06eb52013-10-01 00:43:31 +0000780 // Flags to let the linker know we have emitted new style pubnames. Only
Eric Christophera51d3fc2013-09-27 22:50:48 +0000781 // emit it here if we don't have a skeleton CU for split dwarf.
Eric Christopher39eebfa2013-09-30 23:14:16 +0000782 if (GenerateGnuPubSections) {
783 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
784 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames,
785 dwarf::DW_FORM_sec_offset,
786 Asm->GetTempSymbol("gnu_pubnames",
787 NewCU->getUniqueID()));
788 else
789 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
790 Asm->GetTempSymbol("gnu_pubnames",
791 NewCU->getUniqueID()),
792 DwarfGnuPubNamesSectionSym);
793
794 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
795 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes,
796 dwarf::DW_FORM_sec_offset,
797 Asm->GetTempSymbol("gnu_pubtypes",
798 NewCU->getUniqueID()));
799 else
800 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopherf976c772013-10-03 17:41:16 +0000801 Asm->GetTempSymbol("gnu_pubtypes",
Eric Christopher39eebfa2013-09-30 23:14:16 +0000802 NewCU->getUniqueID()),
803 DwarfGnuPubTypesSectionSym);
804 }
Eric Christopher52ce7182013-04-09 19:23:15 +0000805 }
Bill Wendling2b128d72009-05-20 23:19:06 +0000806
Bill Wendling2b128d72009-05-20 23:19:06 +0000807 if (DIUnit.isOptimized())
Eric Christopherbb69a272012-08-24 01:14:27 +0000808 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendling2b128d72009-05-20 23:19:06 +0000809
Devang Patel2d9caf92009-11-25 17:36:49 +0000810 StringRef Flags = DIUnit.getFlags();
811 if (!Flags.empty())
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000812 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher6a841382012-11-19 22:42:10 +0000813
Nick Lewycky479a8fe2011-10-17 23:27:36 +0000814 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patelf20c4f72011-04-12 22:53:02 +0000815 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +0000816 dwarf::DW_FORM_data1, RVer);
817
Devang Patel1a0df9a2010-05-10 22:49:55 +0000818 if (!FirstCU)
819 FirstCU = NewCU;
Eric Christopher7a2cdf72013-02-05 07:31:55 +0000820
Eric Christopherc8a310e2012-12-10 23:34:43 +0000821 InfoHolder.addUnit(NewCU);
822
Devang Patel1a0df9a2010-05-10 22:49:55 +0000823 CUMap.insert(std::make_pair(N, NewCU));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000824 return NewCU;
Devang Patel1a0df9a2010-05-10 22:49:55 +0000825}
826
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000827// Construct subprogram DIE.
Eric Christophera6c38a32013-10-15 23:31:38 +0000828void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU, const MDNode *N) {
Eric Christopherffbc4de2013-10-18 01:57:30 +0000829 // FIXME: We should only call this routine once, however, during LTO if a
830 // program is defined in multiple CUs we could end up calling it out of
831 // beginModule as we walk the CUs.
832
833 CompileUnit *&CURef = SPMap[N];
834 if (CURef)
835 return;
836 CURef = TheCU;
Rafael Espindola6cf4e832011-11-04 19:00:29 +0000837
Devang Patel80ae3492009-08-28 23:24:31 +0000838 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000839 if (!SP.isDefinition())
840 // This is a method declaration which will be handled while constructing
841 // class type.
Devang Patel0751a282009-06-26 01:49:18 +0000842 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000843
Devang Patel89543712011-08-15 17:24:54 +0000844 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000845
Eric Christopherba506db2013-09-09 20:03:20 +0000846 // Expose as a global name.
Eric Christopher2c8b7902013-10-17 02:06:06 +0000847 TheCU->addGlobalName(SP.getName(), SubprogramDie, resolve(SP.getContext()));
Bill Wendling2b128d72009-05-20 23:19:06 +0000848}
849
David Blaikie1fd43652013-05-07 21:35:53 +0000850void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikief55abea2013-04-22 06:12:31 +0000851 const MDNode *N) {
David Blaikie1fd43652013-05-07 21:35:53 +0000852 DIImportedEntity Module(N);
David Blaikief55abea2013-04-22 06:12:31 +0000853 if (!Module.Verify())
854 return;
David Blaikie684fc532013-05-06 23:33:07 +0000855 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
David Blaikie4dd2de72013-05-08 06:01:38 +0000856 constructImportedEntityDIE(TheCU, Module, D);
David Blaikie684fc532013-05-06 23:33:07 +0000857}
858
David Blaikie4dd2de72013-05-08 06:01:38 +0000859void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
David Blaikie684fc532013-05-06 23:33:07 +0000860 DIE *Context) {
David Blaikie1fd43652013-05-07 21:35:53 +0000861 DIImportedEntity Module(N);
David Blaikie684fc532013-05-06 23:33:07 +0000862 if (!Module.Verify())
863 return;
David Blaikie4dd2de72013-05-08 06:01:38 +0000864 return constructImportedEntityDIE(TheCU, Module, Context);
David Blaikie684fc532013-05-06 23:33:07 +0000865}
866
David Blaikie4dd2de72013-05-08 06:01:38 +0000867void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikie1fd43652013-05-07 21:35:53 +0000868 const DIImportedEntity &Module,
David Blaikie684fc532013-05-06 23:33:07 +0000869 DIE *Context) {
870 assert(Module.Verify() &&
871 "Use one of the MDNode * overloads to handle invalid metadata");
872 assert(Context && "Should always have a context for an imported_module");
David Blaikie1fd43652013-05-07 21:35:53 +0000873 DIE *IMDie = new DIE(Module.getTag());
David Blaikief55abea2013-04-22 06:12:31 +0000874 TheCU->insertDIE(Module, IMDie);
David Blaikie1fd43652013-05-07 21:35:53 +0000875 DIE *EntityDie;
876 DIDescriptor Entity = Module.getEntity();
877 if (Entity.isNameSpace())
878 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
879 else if (Entity.isSubprogram())
880 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
David Blaikie3b6038b2013-05-08 06:01:41 +0000881 else if (Entity.isType())
882 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
David Blaikie1fd43652013-05-07 21:35:53 +0000883 else
David Blaikie3b6038b2013-05-08 06:01:41 +0000884 EntityDie = TheCU->getDIE(Entity);
David Blaikief55abea2013-04-22 06:12:31 +0000885 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
886 Module.getContext().getDirectory(),
887 TheCU->getUniqueID());
David Blaikief2443192013-10-21 17:28:37 +0000888 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, None, FileID);
889 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, None, Module.getLineNumber());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000890 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, EntityDie);
David Blaikiee63d5d12013-05-20 22:50:35 +0000891 StringRef Name = Module.getName();
892 if (!Name.empty())
893 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
David Blaikie684fc532013-05-06 23:33:07 +0000894 Context->addChild(IMDie);
David Blaikief55abea2013-04-22 06:12:31 +0000895}
896
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000897// Emit all Dwarf sections that should come prior to the content. Create
898// global DIEs and emit initial debug info sections. This is invoked by
899// the target AsmPrinter.
Eric Christopher58f41952012-11-19 22:42:15 +0000900void DwarfDebug::beginModule() {
Devang Patel6c74a872010-04-27 19:46:33 +0000901 if (DisableDebugInfoPrinting)
902 return;
903
Eric Christopher58f41952012-11-19 22:42:15 +0000904 const Module *M = MMI->getModule();
905
Nick Lewycky019d2552011-07-29 03:49:23 +0000906 // If module has named metadata anchors then use them, otherwise scan the
907 // module using debug info finder to collect debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000908 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
David Blaikiedc69ebb2013-03-11 23:39:23 +0000909 if (!CU_Nodes)
Devang Patel07bb9ee2011-08-15 23:47:24 +0000910 return;
Manman Ren60352032013-09-05 18:48:31 +0000911 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
Devang Patele02e5852011-05-03 16:45:22 +0000912
David Blaikiedc69ebb2013-03-11 23:39:23 +0000913 // Emit initial sections so we can reference labels later.
914 emitSectionLabels();
915
916 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
917 DICompileUnit CUNode(CU_Nodes->getOperand(i));
918 CompileUnit *CU = constructCompileUnit(CUNode);
David Blaikie1fd43652013-05-07 21:35:53 +0000919 DIArray ImportedEntities = CUNode.getImportedEntities();
920 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
David Blaikie684fc532013-05-06 23:33:07 +0000921 ScopesWithImportedEntities.push_back(std::make_pair(
David Blaikie1fd43652013-05-07 21:35:53 +0000922 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
923 ImportedEntities.getElement(i)));
David Blaikie684fc532013-05-06 23:33:07 +0000924 std::sort(ScopesWithImportedEntities.begin(),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000925 ScopesWithImportedEntities.end(), less_first());
David Blaikiedc69ebb2013-03-11 23:39:23 +0000926 DIArray GVs = CUNode.getGlobalVariables();
927 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
928 CU->createGlobalVariableDIE(GVs.getElement(i));
929 DIArray SPs = CUNode.getSubprograms();
930 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
931 constructSubprogramDIE(CU, SPs.getElement(i));
932 DIArray EnumTypes = CUNode.getEnumTypes();
933 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
934 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
935 DIArray RetainedTypes = CUNode.getRetainedTypes();
936 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
937 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
David Blaikief55abea2013-04-22 06:12:31 +0000938 // Emit imported_modules last so that the relevant context is already
939 // available.
David Blaikie1fd43652013-05-07 21:35:53 +0000940 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
941 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
David Blaikiedc69ebb2013-03-11 23:39:23 +0000942 }
Eric Christopher6a841382012-11-19 22:42:10 +0000943
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000944 // Tell MMI that we have debug info.
945 MMI->setDebugInfoAvailability(true);
Eric Christopher6a841382012-11-19 22:42:10 +0000946
Bill Wendling2b128d72009-05-20 23:19:06 +0000947 // Prime section data.
Richard Mitton21101b32013-09-19 23:21:01 +0000948 SectionMap[Asm->getObjFileLowering().getTextSection()];
Bill Wendling2b128d72009-05-20 23:19:06 +0000949}
950
Eric Christopher960ac372012-11-22 00:59:49 +0000951// Attach DW_AT_inline attribute with inlined subprogram DIEs.
952void DwarfDebug::computeInlinedDIEs() {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000953 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
954 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000955 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000956 DIE *ISP = *AI;
David Blaikief2443192013-10-21 17:28:37 +0000957 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000958 }
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000959 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000960 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000961 DIE *ISP = AI->second;
962 if (InlinedSubprogramDIEs.count(ISP))
963 continue;
David Blaikief2443192013-10-21 17:28:37 +0000964 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000965 }
Eric Christopher960ac372012-11-22 00:59:49 +0000966}
967
968// Collect info for variables that were optimized out.
969void DwarfDebug::collectDeadVariables() {
970 const Module *M = MMI->getModule();
Eric Christopher960ac372012-11-22 00:59:49 +0000971
972 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
973 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
974 DICompileUnit TheCU(CU_Nodes->getOperand(i));
975 DIArray Subprograms = TheCU.getSubprograms();
976 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopher735401c2012-11-27 00:13:51 +0000977 DISubprogram SP(Subprograms.getElement(i));
Eric Christophera6c38a32013-10-15 23:31:38 +0000978 if (ProcessedSPNodes.count(SP) != 0)
979 continue;
980 if (!SP.isSubprogram())
981 continue;
982 if (!SP.isDefinition())
983 continue;
Eric Christopher735401c2012-11-27 00:13:51 +0000984 DIArray Variables = SP.getVariables();
Eric Christophera6c38a32013-10-15 23:31:38 +0000985 if (Variables.getNumElements() == 0)
986 continue;
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 Christopherc798d8a2013-10-22 00:22:39 +0000991 // FIXME: See the comment in constructSubprogramDIE about duplicate
992 // subprogram DIEs.
993 constructSubprogramDIE(SPCU, SP);
994 DIE *SPDIE = SPCU->getDIE(SP);
Eric Christopher735401c2012-11-27 00:13:51 +0000995 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
996 DIVariable DV(Variables.getElement(vi));
Eric Christophera6c38a32013-10-15 23:31:38 +0000997 if (!DV.isVariable())
998 continue;
Manman Renb3388602013-10-05 01:43:03 +0000999 DbgVariable NewVar(DV, NULL, this);
Eric Christopher735401c2012-11-27 00:13:51 +00001000 if (DIE *VariableDIE =
Manman Ren642a0ac2013-10-22 20:59:19 +00001001 SPCU->constructVariableDIE(&NewVar, false))
Eric Christophera6c38a32013-10-15 23:31:38 +00001002 SPDIE->addChild(VariableDIE);
Eric Christopher735401c2012-11-27 00:13:51 +00001003 }
Eric Christopher960ac372012-11-22 00:59:49 +00001004 }
1005 }
1006 }
Eric Christopher960ac372012-11-22 00:59:49 +00001007}
1008
Eric Christopher45731982013-08-08 23:45:55 +00001009// Type Signature [7.27] and ODR Hash code.
Eric Christopher67646432013-07-26 17:02:41 +00001010
1011/// \brief Grabs the string in whichever attribute is passed in and returns
Eric Christopher8552e222013-08-07 01:18:33 +00001012/// a reference to it. Returns "" if the attribute doesn't exist.
Eric Christopher67646432013-07-26 17:02:41 +00001013static StringRef getDIEStringAttr(DIE *Die, unsigned Attr) {
Eric Christopher8552e222013-08-07 01:18:33 +00001014 DIEValue *V = Die->findAttribute(Attr);
Eric Christopher67646432013-07-26 17:02:41 +00001015
Eric Christopher8552e222013-08-07 01:18:33 +00001016 if (DIEString *S = dyn_cast_or_null<DIEString>(V))
1017 return S->getString();
1018
Eric Christopher67646432013-07-26 17:02:41 +00001019 return StringRef("");
1020}
1021
Eric Christopher67646432013-07-26 17:02:41 +00001022/// Return true if the current DIE is contained within an anonymous namespace.
1023static bool isContainedInAnonNamespace(DIE *Die) {
1024 DIE *Parent = Die->getParent();
1025
1026 while (Parent) {
Eric Christophere414ece2013-07-29 23:53:08 +00001027 if (Parent->getTag() == dwarf::DW_TAG_namespace &&
1028 getDIEStringAttr(Parent, dwarf::DW_AT_name) == "")
Eric Christopher67646432013-07-26 17:02:41 +00001029 return true;
1030 Parent = Parent->getParent();
1031 }
1032
1033 return false;
1034}
1035
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001036/// Test if the current CU language is C++ and that we have
1037/// a named type that is not contained in an anonymous namespace.
1038static bool shouldAddODRHash(CompileUnit *CU, DIE *Die) {
Eric Christopher341770d2013-08-07 08:35:10 +00001039 return CU->getLanguage() == dwarf::DW_LANG_C_plus_plus &&
1040 getDIEStringAttr(Die, dwarf::DW_AT_name) != "" &&
1041 !isContainedInAnonNamespace(Die);
Eric Christopher45731982013-08-08 23:45:55 +00001042}
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001043
Eric Christopher960ac372012-11-22 00:59:49 +00001044void DwarfDebug::finalizeModuleInfo() {
1045 // Collect info for variables that were optimized out.
1046 collectDeadVariables();
1047
1048 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1049 computeInlinedDIEs();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001050
Eric Christopherf8542ec2013-07-29 22:24:32 +00001051 // Split out type units and conditionally add an ODR tag to the split
1052 // out type.
Eric Christopher67646432013-07-26 17:02:41 +00001053 // FIXME: Do type splitting.
1054 for (unsigned i = 0, e = TypeUnits.size(); i != e; ++i) {
Eric Christopher67646432013-07-26 17:02:41 +00001055 DIE *Die = TypeUnits[i];
Eric Christopher45731982013-08-08 23:45:55 +00001056 DIEHash Hash;
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001057 // If we've requested ODR hashes and it's applicable for an ODR hash then
1058 // add the ODR signature now.
Eric Christopher45731982013-08-08 23:45:55 +00001059 // FIXME: This should be added onto the type unit, not the type, but this
1060 // works as an intermediate stage.
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001061 if (GenerateODRHash && shouldAddODRHash(CUMap.begin()->second, Die))
Eric Christopher45731982013-08-08 23:45:55 +00001062 CUMap.begin()->second->addUInt(Die, dwarf::DW_AT_GNU_odr_signature,
1063 dwarf::DW_FORM_data8,
David Blaikie2aee7be2013-10-24 18:29:03 +00001064 Hash.computeDIEODRSignature(*Die));
Eric Christopher67646432013-07-26 17:02:41 +00001065 }
1066
Eric Christopher60eb7692013-08-12 20:27:48 +00001067 // Handle anything that needs to be done on a per-cu basis.
1068 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
1069 CUE = CUMap.end();
1070 CUI != CUE; ++CUI) {
1071 CompileUnit *TheCU = CUI->second;
1072 // Emit DW_AT_containing_type attribute to connect types with their
1073 // vtable holding type.
1074 TheCU->constructContainingTypeDIEs();
1075
1076 // If we're splitting the dwarf out now that we've got the entire
1077 // CU then construct a skeleton CU based upon it.
1078 if (useSplitDwarf()) {
Eric Christopherd29614f2013-08-13 01:21:55 +00001079 uint64_t ID = 0;
1080 if (GenerateCUHash) {
1081 DIEHash CUHash;
David Blaikie2aee7be2013-10-24 18:29:03 +00001082 ID = CUHash.computeCUSignature(*TheCU->getCUDie());
Eric Christopherd29614f2013-08-13 01:21:55 +00001083 }
Eric Christopher60eb7692013-08-12 20:27:48 +00001084 // This should be a unique identifier when we want to build .dwp files.
1085 TheCU->addUInt(TheCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopherd29614f2013-08-13 01:21:55 +00001086 dwarf::DW_FORM_data8, ID);
Eric Christopher60eb7692013-08-12 20:27:48 +00001087 // Now construct the skeleton CU associated.
Eric Christopher6fdf3242013-08-26 23:50:43 +00001088 CompileUnit *SkCU = constructSkeletonCU(TheCU);
Eric Christopher60eb7692013-08-12 20:27:48 +00001089 // This should be a unique identifier when we want to build .dwp files.
1090 SkCU->addUInt(SkCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopherd29614f2013-08-13 01:21:55 +00001091 dwarf::DW_FORM_data8, ID);
Eric Christopher60eb7692013-08-12 20:27:48 +00001092 }
1093 }
1094
1095 // Compute DIE offsets and sizes.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001096 InfoHolder.computeSizeAndOffsets();
1097 if (useSplitDwarf())
1098 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher960ac372012-11-22 00:59:49 +00001099}
1100
1101void DwarfDebug::endSections() {
Richard Mitton21101b32013-09-19 23:21:01 +00001102 // Filter labels by section.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001103 for (size_t n = 0; n < ArangeLabels.size(); n++) {
1104 const SymbolCU &SCU = ArangeLabels[n];
Richard Mitton21101b32013-09-19 23:21:01 +00001105 if (SCU.Sym->isInSection()) {
1106 // Make a note of this symbol and it's section.
1107 const MCSection *Section = &SCU.Sym->getSection();
1108 if (!Section->getKind().isMetadata())
1109 SectionMap[Section].push_back(SCU);
1110 } else {
1111 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1112 // appear in the output. This sucks as we rely on sections to build
1113 // arange spans. We can do it without, but it's icky.
1114 SectionMap[NULL].push_back(SCU);
1115 }
1116 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001117
Richard Mittonc2508242013-10-03 22:07:08 +00001118 // Build a list of sections used.
1119 std::vector<const MCSection *> Sections;
Richard Mitton21101b32013-09-19 23:21:01 +00001120 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1121 it++) {
1122 const MCSection *Section = it->first;
Richard Mittonc2508242013-10-03 22:07:08 +00001123 Sections.push_back(Section);
1124 }
1125
1126 // Sort the sections into order.
1127 // This is only done to ensure consistent output order across different runs.
1128 std::sort(Sections.begin(), Sections.end(), SectionSort);
1129
1130 // Add terminating symbols for each section.
1131 for (unsigned ID=0;ID<Sections.size();ID++) {
1132 const MCSection *Section = Sections[ID];
Richard Mitton21101b32013-09-19 23:21:01 +00001133 MCSymbol *Sym = NULL;
1134
1135 if (Section) {
Richard Mittonc2508242013-10-03 22:07:08 +00001136 // We can't call MCSection::getLabelEndName, as it's only safe to do so
1137 // if we know the section name up-front. For user-created sections, the resulting
1138 // label may not be valid to use as a label. (section names can use a greater
1139 // set of characters on some systems)
1140 Sym = Asm->GetTempSymbol("debug_end", ID);
Richard Mitton21101b32013-09-19 23:21:01 +00001141 Asm->OutStreamer.SwitchSection(Section);
1142 Asm->OutStreamer.EmitLabel(Sym);
1143 }
1144
1145 // Insert a final terminator.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001146 SectionMap[Section].push_back(SymbolCU(NULL, Sym));
Bill Wendling2b128d72009-05-20 23:19:06 +00001147 }
Eric Christopher960ac372012-11-22 00:59:49 +00001148}
Bill Wendling2b128d72009-05-20 23:19:06 +00001149
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001150// Emit all Dwarf sections that should come after the content.
Eric Christopher960ac372012-11-22 00:59:49 +00001151void DwarfDebug::endModule() {
1152
1153 if (!FirstCU) return;
1154
1155 // End any existing sections.
1156 // TODO: Does this need to happen?
1157 endSections();
1158
1159 // Finalize the debug info for the module.
1160 finalizeModuleInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001161
Eric Christophercdf218d2012-12-10 19:51:21 +00001162 if (!useSplitDwarf()) {
Eric Christopher9cd26af2013-09-20 23:22:52 +00001163 emitDebugStr();
1164
Eric Christopher95198f502012-11-27 22:43:42 +00001165 // Emit all the DIEs into a debug info section.
1166 emitDebugInfo();
Eric Christopher4c9b1192012-11-27 00:41:54 +00001167
Eric Christopher95198f502012-11-27 22:43:42 +00001168 // Corresponding abbreviations into a abbrev section.
1169 emitAbbreviations();
1170
1171 // Emit info into a debug loc section.
1172 emitDebugLoc();
1173
1174 // Emit info into a debug aranges section.
1175 emitDebugARanges();
1176
1177 // Emit info into a debug ranges section.
1178 emitDebugRanges();
1179
1180 // Emit info into a debug macinfo section.
1181 emitDebugMacInfo();
1182
Eric Christopher95198f502012-11-27 22:43:42 +00001183 } else {
Eric Christopherd692c1d2012-12-11 19:42:09 +00001184 // TODO: Fill this in for separated debug sections and separate
Eric Christopher95198f502012-11-27 22:43:42 +00001185 // out information into new sections.
Eric Christopher9cd26af2013-09-20 23:22:52 +00001186 emitDebugStr();
1187 if (useSplitDwarf())
1188 emitDebugStrDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001189
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001190 // Emit the debug info section and compile units.
Eric Christopher95198f502012-11-27 22:43:42 +00001191 emitDebugInfo();
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001192 emitDebugInfoDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001193
1194 // Corresponding abbreviations into a abbrev section.
1195 emitAbbreviations();
Eric Christopher3c5a1912012-12-19 22:02:53 +00001196 emitDebugAbbrevDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001197
1198 // Emit info into a debug loc section.
1199 emitDebugLoc();
1200
1201 // Emit info into a debug aranges section.
1202 emitDebugARanges();
1203
1204 // Emit info into a debug ranges section.
1205 emitDebugRanges();
1206
1207 // Emit info into a debug macinfo section.
1208 emitDebugMacInfo();
1209
Eric Christopher962c9082013-01-15 23:56:56 +00001210 // Emit DWO addresses.
1211 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1212
Eric Christopher95198f502012-11-27 22:43:42 +00001213 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001214
Eric Christophera876b822012-08-23 07:32:06 +00001215 // Emit info into the dwarf accelerator table sections.
Eric Christopher20b76a72012-08-23 22:36:40 +00001216 if (useDwarfAccelTables()) {
Eric Christopher4996c702011-11-07 09:24:32 +00001217 emitAccelNames();
1218 emitAccelObjC();
1219 emitAccelNamespaces();
1220 emitAccelTypes();
1221 }
Eric Christopher6a841382012-11-19 22:42:10 +00001222
Eric Christopher4b358182013-08-30 00:40:17 +00001223 // Emit the pubnames and pubtypes sections if requested.
1224 if (HasDwarfPubSections) {
David Blaikie70a33202013-09-19 17:33:35 +00001225 emitDebugPubNames(GenerateGnuPubSections);
1226 emitDebugPubTypes(GenerateGnuPubSections);
Eric Christopher4b358182013-08-30 00:40:17 +00001227 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001228
Devang Pateld0701282010-08-02 17:32:15 +00001229 // clean up.
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001230 SPMap.clear();
Devang Patel1a0df9a2010-05-10 22:49:55 +00001231 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1232 E = CUMap.end(); I != E; ++I)
1233 delete I->second;
Eric Christopher8afd7b62012-12-10 19:51:18 +00001234
Craig Topperd8e43652013-07-03 04:17:25 +00001235 for (SmallVectorImpl<CompileUnit *>::iterator I = SkeletonCUs.begin(),
Eric Christopher5b33b3c2013-02-06 21:53:56 +00001236 E = SkeletonCUs.end(); I != E; ++I)
1237 delete *I;
Eric Christopher8afd7b62012-12-10 19:51:18 +00001238
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001239 // Reset these for the next Module if we have one.
1240 FirstCU = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001241}
1242
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001243// Find abstract variable, if any, associated with Var.
Devang Patelbb23a4a2011-08-10 21:50:54 +00001244DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattner915c5f92010-04-02 19:42:39 +00001245 DebugLoc ScopeLoc) {
Devang Patelbb23a4a2011-08-10 21:50:54 +00001246 LLVMContext &Ctx = DV->getContext();
1247 // More then one inlined variable corresponds to one abstract variable.
1248 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001249 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001250 if (AbsDbgVariable)
1251 return AbsDbgVariable;
1252
Devang Patel7e623022011-08-10 20:55:27 +00001253 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001254 if (!Scope)
1255 return NULL;
1256
Manman Renb3388602013-10-05 01:43:03 +00001257 AbsDbgVariable = new DbgVariable(Var, NULL, this);
Devang Patel7e623022011-08-10 20:55:27 +00001258 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001259 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001260 return AbsDbgVariable;
1261}
1262
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001263// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel6c622ef2011-03-01 22:58:55 +00001264bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patel7e623022011-08-10 20:55:27 +00001265 DbgVariable *Var, LexicalScope *Scope) {
1266 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +00001267 return false;
1268 DIVariable DV = Var->getVariable();
1269 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1270 return false;
1271 unsigned ArgNo = DV.getArgNumber();
Eric Christopher6a841382012-11-19 22:42:10 +00001272 if (ArgNo == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001273 return false;
1274
Devang Patel4ab660b2011-03-03 20:02:02 +00001275 size_t Size = CurrentFnArguments.size();
1276 if (Size == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001277 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001278 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001279 // arguments does the function have at source level.
1280 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001281 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001282 CurrentFnArguments[ArgNo - 1] = Var;
1283 return true;
1284}
1285
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001286// Collect variable information from side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001287void
Nick Lewycky019d2552011-07-29 03:49:23 +00001288DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patel490c8ab2010-05-20 19:57:06 +00001289 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001290 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1291 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1292 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001293 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001294 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001295 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001296 DIVariable DV(Var);
1297 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001298
Devang Patel7e623022011-08-10 20:55:27 +00001299 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001300
Devang Patelcdb7d442009-11-10 23:20:04 +00001301 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001302 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001303 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001304
Devang Patele1c53f22010-05-20 16:36:41 +00001305 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Manman Renb3388602013-10-05 01:43:03 +00001306 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
Devang Patel3e4a9652011-08-15 21:24:36 +00001307 RegVar->setFrameIndex(VP.first);
Devang Patel6c622ef2011-03-01 22:58:55 +00001308 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001309 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001310 if (AbsDbgVariable)
Devang Patel3e4a9652011-08-15 21:24:36 +00001311 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patel475d32a2009-10-06 01:26:37 +00001312 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001313}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001314
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001315// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1316// defined reg.
Devang Patel9fc11702010-05-25 23:40:22 +00001317static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001318 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001319 return MI->getNumOperands() == 3 &&
1320 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
Adrian Prantl418d1d12013-07-09 20:28:37 +00001321 (MI->getOperand(1).isImm() ||
1322 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
Devang Patel9fc11702010-05-25 23:40:22 +00001323}
1324
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001325// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher6a841382012-11-19 22:42:10 +00001326static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1327 const MCSymbol *FLabel,
Devang Patel2442a892011-07-08 17:09:57 +00001328 const MCSymbol *SLabel,
1329 const MachineInstr *MI) {
1330 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1331
David Blaikie0252265b2013-06-16 20:34:15 +00001332 assert(MI->getNumOperands() == 3);
Adrian Prantl418d1d12013-07-09 20:28:37 +00001333 if (MI->getOperand(0).isReg()) {
Devang Patel2442a892011-07-08 17:09:57 +00001334 MachineLocation MLoc;
Adrian Prantl418d1d12013-07-09 20:28:37 +00001335 // If the second operand is an immediate, this is a
1336 // register-indirect address.
1337 if (!MI->getOperand(1).isImm())
Adrian Prantld4c0dd42013-04-26 21:57:17 +00001338 MLoc.set(MI->getOperand(0).getReg());
1339 else
1340 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel2442a892011-07-08 17:09:57 +00001341 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1342 }
1343 if (MI->getOperand(0).isImm())
1344 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1345 if (MI->getOperand(0).isFPImm())
1346 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1347 if (MI->getOperand(0).isCImm())
1348 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1349
Craig Topperee4dab52012-02-05 08:31:47 +00001350 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel2442a892011-07-08 17:09:57 +00001351}
1352
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001353// Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001354void
Devang Patel5c0f85c2010-06-25 22:07:34 +00001355DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1356 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001357
Eric Christopher270a12c2013-07-03 21:37:03 +00001358 // Grab the variable info that was squirreled away in the MMI side-table.
Devang Patel490c8ab2010-05-20 19:57:06 +00001359 collectVariableInfoFromMMITable(MF, Processed);
1360
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001361 for (SmallVectorImpl<const MDNode*>::const_iterator
1362 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1363 ++UVI) {
1364 const MDNode *Var = *UVI;
1365 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001366 continue;
1367
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001368 // History contains relevant DBG_VALUE instructions for Var and instructions
1369 // clobbering it.
1370 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1371 if (History.empty())
1372 continue;
1373 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001374
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001375 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001376 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001377 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1378 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +00001379 Scope = LScopes.getCurrentFunctionScope();
David Blaikiedc69ebb2013-03-11 23:39:23 +00001380 else if (MDNode *IA = DV.getInlinedAt())
1381 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1382 else
1383 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel490c8ab2010-05-20 19:57:06 +00001384 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001385 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001386 continue;
1387
1388 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001389 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel99819b52011-08-15 19:01:20 +00001390 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
Manman Renb3388602013-10-05 01:43:03 +00001391 DbgVariable *RegVar = new DbgVariable(DV, AbsVar, this);
Devang Patel6c622ef2011-03-01 22:58:55 +00001392 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001393 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001394 if (AbsVar)
Devang Patel3e4a9652011-08-15 21:24:36 +00001395 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001396
Eric Christophercc10d202012-10-08 20:48:54 +00001397 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001398 if (History.size() <= 1 || (History.size() == 2 &&
1399 MInsn->isIdenticalTo(History.back()))) {
Devang Patel3e4a9652011-08-15 21:24:36 +00001400 RegVar->setMInsn(MInsn);
Devang Patel9fc11702010-05-25 23:40:22 +00001401 continue;
1402 }
1403
Eric Christopher59cc0712013-01-28 17:33:26 +00001404 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001405 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001406
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001407 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1408 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1409 const MachineInstr *Begin = *HI;
1410 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001411
Devang Patele7181b52011-06-01 23:00:17 +00001412 // Check if DBG_VALUE is truncating a range.
1413 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1414 && !Begin->getOperand(0).getReg())
1415 continue;
1416
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001417 // Compute the range for a register location.
1418 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1419 const MCSymbol *SLabel = 0;
1420
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001421 if (HI + 1 == HE)
1422 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001423 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001424 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001425 else {
1426 const MachineInstr *End = HI[1];
Eric Christopher6a841382012-11-19 22:42:10 +00001427 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel53b050a2011-07-07 21:44:42 +00001428 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001429 if (End->isDebugValue())
1430 SLabel = getLabelBeforeInsn(End);
1431 else {
1432 // End is a normal instruction clobbering the range.
1433 SLabel = getLabelAfterInsn(End);
1434 assert(SLabel && "Forgot label after clobber instruction");
1435 ++HI;
1436 }
1437 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001438
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001439 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopher365d0832011-12-16 23:42:31 +00001440 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1441 Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001442 }
1443 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001444 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001445
1446 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001447 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1448 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1449 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1450 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001451 if (!DV || !DV.isVariable() || !Processed.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001452 continue;
1453 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001454 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patele0a94bf2010-05-14 21:01:35 +00001455 }
Devang Patel9fc11702010-05-25 23:40:22 +00001456}
Devang Patele0a94bf2010-05-14 21:01:35 +00001457
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001458// Return Label preceding the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001459MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001460 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1461 assert(Label && "Didn't insert label before instruction");
1462 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001463}
1464
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001465// Return Label immediately following the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001466MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001467 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001468}
1469
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001470// Process beginning of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001471void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001472 // Check if source location changes, but ignore DBG_VALUE locations.
1473 if (!MI->isDebugValue()) {
1474 DebugLoc DL = MI->getDebugLoc();
1475 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopheraec8a822012-04-05 20:39:05 +00001476 unsigned Flags = 0;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001477 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001478 if (DL == PrologEndLoc) {
1479 Flags |= DWARF2_FLAG_PROLOGUE_END;
1480 PrologEndLoc = DebugLoc();
1481 }
Eric Christopheraec8a822012-04-05 20:39:05 +00001482 if (PrologEndLoc.isUnknown())
1483 Flags |= DWARF2_FLAG_IS_STMT;
1484
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001485 if (!DL.isUnknown()) {
1486 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001487 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001488 } else
Devang Patel34a66202011-05-11 19:22:19 +00001489 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001490 }
Devang Patel9fc11702010-05-25 23:40:22 +00001491 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001492
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001493 // Insert labels where requested.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001494 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1495 LabelsBeforeInsn.find(MI);
1496
1497 // No label needed.
1498 if (I == LabelsBeforeInsn.end())
1499 return;
1500
1501 // Label already assigned.
1502 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001503 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001504
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001505 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001506 PrevLabel = MMI->getContext().CreateTempSymbol();
1507 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001508 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001509 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001510}
1511
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001512// Process end of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001513void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001514 // Don't create a new label after DBG_VALUE instructions.
1515 // They don't generate code.
1516 if (!MI->isDebugValue())
1517 PrevLabel = 0;
1518
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001519 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1520 LabelsAfterInsn.find(MI);
1521
1522 // No label needed.
1523 if (I == LabelsAfterInsn.end())
1524 return;
1525
1526 // Label already assigned.
1527 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001528 return;
1529
1530 // We need a label after this instruction.
1531 if (!PrevLabel) {
1532 PrevLabel = MMI->getContext().CreateTempSymbol();
1533 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001534 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001535 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001536}
1537
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001538// Each LexicalScope has first instruction and last instruction to mark
1539// beginning and end of a scope respectively. Create an inverse map that list
1540// scopes starts (and ends) with an instruction. One instruction may start (or
1541// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001542void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001543 SmallVector<LexicalScope *, 4> WorkList;
1544 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001545 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001546 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001547
Craig Topper977e9cd2013-07-03 04:24:43 +00001548 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001549 if (!Children.empty())
Craig Topperd8e43652013-07-03 04:17:25 +00001550 for (SmallVectorImpl<LexicalScope *>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00001551 SE = Children.end(); SI != SE; ++SI)
1552 WorkList.push_back(*SI);
1553
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001554 if (S->isAbstractScope())
1555 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001556
Craig Topper977e9cd2013-07-03 04:24:43 +00001557 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001558 if (Ranges.empty())
1559 continue;
Craig Topperd8e43652013-07-03 04:17:25 +00001560 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +00001561 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001562 assert(RI->first && "InsnRange does not have first instruction!");
1563 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001564 requestLabelBeforeInsn(RI->first);
1565 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001566 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001567 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001568}
1569
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001570// Get MDNode for DebugLoc's scope.
Devang Patel589845d2011-05-09 22:14:49 +00001571static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1572 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1573 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1574 return DL.getScope(Ctx);
1575}
1576
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001577// Walk up the scope chain of given debug loc and find line number info
1578// for the function.
Devang Patel34a66202011-05-11 19:22:19 +00001579static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1580 const MDNode *Scope = getScopeNode(DL, Ctx);
1581 DISubprogram SP = getDISubprogram(Scope);
Manman Ren7504ed42013-07-08 18:33:29 +00001582 if (SP.isSubprogram()) {
Eric Christopher34164192012-04-03 00:43:49 +00001583 // Check for number of operands since the compatibility is
1584 // cheap here.
Eric Christopherb81e2b42012-04-03 17:55:42 +00001585 if (SP->getNumOperands() > 19)
Eric Christopher34164192012-04-03 00:43:49 +00001586 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1587 else
1588 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1589 }
1590
Devang Patel34a66202011-05-11 19:22:19 +00001591 return DebugLoc();
1592}
1593
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001594// Gather pre-function debug information. Assumes being called immediately
1595// after the function entry point has been emitted.
Chris Lattner76555b52010-01-26 23:18:02 +00001596void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00001597 if (!MMI->hasDebugInfo()) return;
Devang Patel7e623022011-08-10 20:55:27 +00001598 LScopes.initialize(*MF);
1599 if (LScopes.empty()) return;
1600 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001601
Manman Ren4e042a62013-02-05 21:52:47 +00001602 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1603 // belongs to.
1604 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1605 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1606 assert(TheCU && "Unable to find compile unit!");
Rafael Espindolaac4ad252013-10-05 16:42:21 +00001607 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren9d4c7352013-05-21 00:57:22 +00001608 // Use a single line table if we are using .loc and generating assembly.
1609 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1610 else
1611 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
Manman Ren4e042a62013-02-05 21:52:47 +00001612
Devang Patel6c74a872010-04-27 19:46:33 +00001613 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1614 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001615 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001616 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001617
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001618 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1619
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001620 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001621 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001622 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1623
Devang Patel002d54d2010-05-26 19:37:24 +00001624 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001625 I != E; ++I) {
1626 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001627 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1628 II != IE; ++II) {
1629 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001630
Devang Patel002d54d2010-05-26 19:37:24 +00001631 if (MI->isDebugValue()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001632 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001633
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001634 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001635 const MDNode *Var =
1636 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001637
1638 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001639 if (isDbgValueInDefinedReg(MI))
1640 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1641
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001642 // Check the history of this variable.
1643 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1644 if (History.empty()) {
1645 UserVariables.push_back(Var);
1646 // The first mention of a function argument gets the FunctionBeginSym
1647 // label, so arguments are visible when breaking at function entry.
1648 DIVariable DV(Var);
Manman Ren7504ed42013-07-08 18:33:29 +00001649 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001650 DISubprogram(getDISubprogram(DV.getContext()))
1651 .describes(MF->getFunction()))
1652 LabelsBeforeInsn[MI] = FunctionBeginSym;
1653 } else {
1654 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1655 const MachineInstr *Prev = History.back();
1656 if (Prev->isDebugValue()) {
1657 // Coalesce identical entries at the end of History.
1658 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001659 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher85a495e2012-10-08 20:48:49 +00001660 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher6a841382012-11-19 22:42:10 +00001661 << "\t" << *Prev
Devang Patelb7a328e2011-07-07 00:14:27 +00001662 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001663 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001664 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001665
1666 // Terminate old register assignments that don't reach MI;
1667 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1668 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1669 isDbgValueInDefinedReg(Prev)) {
1670 // Previous register assignment needs to terminate at the end of
1671 // its basic block.
1672 MachineBasicBlock::const_iterator LastMI =
1673 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001674 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001675 // Drop DBG_VALUE for empty range.
Eric Christopher85a495e2012-10-08 20:48:49 +00001676 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patelb7a328e2011-07-07 00:14:27 +00001677 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001678 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001679 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001680 // Terminate after LastMI.
1681 History.push_back(LastMI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001682 }
1683 }
1684 }
1685 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001686 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001687 // Not a DBG_VALUE instruction.
1688 if (!MI->isLabel())
1689 AtBlockEntry = false;
1690
Eric Christopher133195782012-10-04 20:46:14 +00001691 // First known non-DBG_VALUE and non-frame setup location marks
1692 // the beginning of the function body.
1693 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1694 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel34a66202011-05-11 19:22:19 +00001695 PrologEndLoc = MI->getDebugLoc();
1696
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001697 // Check if the instruction clobbers any registers with debug vars.
1698 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1699 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1700 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1701 continue;
Jakob Stoklund Olesen54038d72012-06-01 23:28:30 +00001702 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1703 AI.isValid(); ++AI) {
1704 unsigned Reg = *AI;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001705 const MDNode *Var = LiveUserVar[Reg];
1706 if (!Var)
1707 continue;
1708 // Reg is now clobbered.
1709 LiveUserVar[Reg] = 0;
1710
1711 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001712 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1713 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001714 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001715 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1716 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001717 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001718 const MachineInstr *Prev = History.back();
1719 // Sanity-check: Register assignments are terminated at the end of
1720 // their block.
1721 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1722 continue;
1723 // Is the variable still in Reg?
1724 if (!isDbgValueInDefinedReg(Prev) ||
1725 Prev->getOperand(0).getReg() != Reg)
1726 continue;
1727 // Var is clobbered. Make sure the next instruction gets a label.
1728 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001729 }
1730 }
Devang Patel002d54d2010-05-26 19:37:24 +00001731 }
Devang Patel002d54d2010-05-26 19:37:24 +00001732 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001733 }
1734
1735 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1736 I != E; ++I) {
1737 SmallVectorImpl<const MachineInstr*> &History = I->second;
1738 if (History.empty())
1739 continue;
1740
1741 // Make sure the final register assignments are terminated.
1742 const MachineInstr *Prev = History.back();
1743 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1744 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher6a841382012-11-19 22:42:10 +00001745 MachineBasicBlock::const_iterator LastMI =
Devang Patel784077e2011-08-10 23:58:09 +00001746 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001747 if (LastMI == PrevMBB->end())
1748 // Drop DBG_VALUE for empty range.
1749 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001750 else if (PrevMBB != &PrevMBB->getParent()->back()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001751 // Terminate after LastMI.
1752 History.push_back(LastMI);
1753 }
1754 }
1755 // Request labels for the full history.
1756 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1757 const MachineInstr *MI = History[i];
1758 if (MI->isDebugValue())
1759 requestLabelBeforeInsn(MI);
1760 else
1761 requestLabelAfterInsn(MI);
1762 }
1763 }
Devang Patel002d54d2010-05-26 19:37:24 +00001764
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001765 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001766 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001767
1768 // Record beginning of function.
1769 if (!PrologEndLoc.isUnknown()) {
1770 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1771 MF->getFunction()->getContext());
1772 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1773 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie67cb31e2012-12-04 22:02:33 +00001774 // We'd like to list the prologue as "not statements" but GDB behaves
1775 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikie5a773bb2012-12-04 21:05:36 +00001776 DWARF2_FLAG_IS_STMT);
Devang Patel34a66202011-05-11 19:22:19 +00001777 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001778}
1779
Devang Patel7e623022011-08-10 20:55:27 +00001780void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
David Blaikie6f1a8062013-06-05 05:39:59 +00001781 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1782 DIVariable DV = Var->getVariable();
David Blaikie36d5d2f2013-06-06 21:04:51 +00001783 // Variables with positive arg numbers are parameters.
1784 if (unsigned ArgNum = DV.getArgNumber()) {
1785 // Keep all parameters in order at the start of the variable list to ensure
1786 // function types are correct (no out-of-order parameters)
1787 //
1788 // This could be improved by only doing it for optimized builds (unoptimized
1789 // builds have the right order to begin with), searching from the back (this
1790 // would catch the unoptimized case quickly), or doing a binary search
1791 // rather than linear search.
1792 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1793 while (I != Vars.end()) {
1794 unsigned CurNum = (*I)->getVariable().getArgNumber();
1795 // A local (non-parameter) variable has been found, insert immediately
1796 // before it.
1797 if (CurNum == 0)
1798 break;
1799 // A later indexed parameter has been found, insert immediately before it.
David Blaikieb272a752013-06-06 22:28:26 +00001800 if (CurNum > ArgNum)
David Blaikie36d5d2f2013-06-06 21:04:51 +00001801 break;
David Blaikieb272a752013-06-06 22:28:26 +00001802 ++I;
David Blaikie6f1a8062013-06-05 05:39:59 +00001803 }
David Blaikie36d5d2f2013-06-06 21:04:51 +00001804 Vars.insert(I, Var);
1805 return;
David Blaikie6f1a8062013-06-05 05:39:59 +00001806 }
1807
1808 Vars.push_back(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001809}
1810
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001811// Gather and emit post-function debug information.
Chris Lattner76555b52010-01-26 23:18:02 +00001812void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patel7e623022011-08-10 20:55:27 +00001813 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00001814
Devang Patel7e623022011-08-10 20:55:27 +00001815 // Define end label for subprogram.
1816 FunctionEndSym = Asm->GetTempSymbol("func_end",
1817 Asm->getFunctionNumber());
1818 // Assumes in correct section after the entry point.
1819 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Manman Ren4e042a62013-02-05 21:52:47 +00001820 // Set DwarfCompileUnitID in MCContext to default value.
1821 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher6a841382012-11-19 22:42:10 +00001822
Devang Patel7e623022011-08-10 20:55:27 +00001823 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1824 collectVariableInfo(MF, ProcessedVars);
Eric Christopher6a841382012-11-19 22:42:10 +00001825
Devang Patel3acc70e2011-08-15 22:04:40 +00001826 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001827 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001828 assert(TheCU && "Unable to find compile unit!");
Devang Patel3acc70e2011-08-15 22:04:40 +00001829
Devang Patel7e623022011-08-10 20:55:27 +00001830 // Construct abstract scopes.
Devang Patel44403472011-08-12 18:10:19 +00001831 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1832 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1833 LexicalScope *AScope = AList[i];
1834 DISubprogram SP(AScope->getScopeNode());
Manman Ren7504ed42013-07-08 18:33:29 +00001835 if (SP.isSubprogram()) {
Devang Patel7e623022011-08-10 20:55:27 +00001836 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001837 DIArray Variables = SP.getVariables();
1838 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1839 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001840 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001841 continue;
Alexey Samsonov39602782012-07-06 08:45:08 +00001842 // Check that DbgVariable for DV wasn't created earlier, when
1843 // findAbstractVariable() was called for inlined instance of DV.
1844 LLVMContext &Ctx = DV->getContext();
1845 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1846 if (AbstractVariables.lookup(CleanDV))
1847 continue;
Devang Patel59e27c52011-08-19 23:28:12 +00001848 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001849 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001850 }
1851 }
Devang Patel44403472011-08-12 18:10:19 +00001852 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Manman Ren4213c392013-05-29 17:16:59 +00001853 constructScopeDIE(TheCU, AScope);
Bill Wendling2b128d72009-05-20 23:19:06 +00001854 }
Eric Christopher6a841382012-11-19 22:42:10 +00001855
Devang Patel3acc70e2011-08-15 22:04:40 +00001856 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher6a841382012-11-19 22:42:10 +00001857
Nick Lewycky50f02cb2011-12-02 22:16:29 +00001858 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopherbb69a272012-08-24 01:14:27 +00001859 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Patel3acc70e2011-08-15 22:04:40 +00001860
Bill Wendling2b128d72009-05-20 23:19:06 +00001861 // Clear debug info
Craig Topper2b4a2012013-07-03 04:40:27 +00001862 for (ScopeVariablesMap::iterator
Devang Patel7e623022011-08-10 20:55:27 +00001863 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1864 DeleteContainerPointers(I->second);
1865 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001866 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001867 UserVariables.clear();
1868 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001869 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001870 LabelsBeforeInsn.clear();
1871 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001872 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001873}
1874
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001875// Register a source line with debug info. Returns the unique label that was
1876// emitted and which provides correspondence to the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00001877void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1878 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00001879 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00001880 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00001881 unsigned Src = 1;
1882 if (S) {
1883 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00001884
Dan Gohman50849c62010-05-05 23:41:32 +00001885 if (Scope.isCompileUnit()) {
1886 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001887 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001888 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00001889 } else if (Scope.isFile()) {
1890 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00001891 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001892 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001893 } else if (Scope.isSubprogram()) {
1894 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001895 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001896 Dir = SP.getDirectory();
Eric Christopher6647b832011-10-11 22:59:11 +00001897 } else if (Scope.isLexicalBlockFile()) {
1898 DILexicalBlockFile DBF(S);
1899 Fn = DBF.getFilename();
1900 Dir = DBF.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001901 } else if (Scope.isLexicalBlock()) {
1902 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001903 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001904 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001905 } else
Craig Topperee4dab52012-02-05 08:31:47 +00001906 llvm_unreachable("Unexpected scope info");
Dan Gohman50849c62010-05-05 23:41:32 +00001907
Manman Ren1e427202013-03-07 01:42:00 +00001908 Src = getOrCreateSourceID(Fn, Dir,
1909 Asm->OutStreamer.getContext().getDwarfCompileUnitID());
Dan Gohman50849c62010-05-05 23:41:32 +00001910 }
Nick Lewycky019d2552011-07-29 03:49:23 +00001911 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00001912}
1913
Bill Wendling806535f2009-05-20 23:22:40 +00001914//===----------------------------------------------------------------------===//
1915// Emit Methods
1916//===----------------------------------------------------------------------===//
1917
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001918// Compute the size and offset of a DIE.
Jim Grosbach00e9c612009-11-22 19:20:36 +00001919unsigned
Eric Christopherc8a310e2012-12-10 23:34:43 +00001920DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling480ff322009-05-20 23:21:38 +00001921 // Get the children.
1922 const std::vector<DIE *> &Children = Die->getChildren();
1923
Bill Wendling480ff322009-05-20 23:21:38 +00001924 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00001925 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00001926
1927 // Get the abbreviation for this DIE.
1928 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopherc8a310e2012-12-10 23:34:43 +00001929 const DIEAbbrev *Abbrev = Abbreviations->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00001930
1931 // Set DIE offset
1932 Die->setOffset(Offset);
1933
1934 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00001935 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001936
Eric Christopher4887c8f2013-03-29 23:34:06 +00001937 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1938 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling480ff322009-05-20 23:21:38 +00001939
1940 // Size the DIE attribute values.
1941 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1942 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001943 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001944
1945 // Size the DIE children if any.
1946 if (!Children.empty()) {
1947 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1948 "Children flag not set");
1949
1950 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001951 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling480ff322009-05-20 23:21:38 +00001952
1953 // End of children marker.
1954 Offset += sizeof(int8_t);
1955 }
1956
1957 Die->setSize(Offset - Die->getOffset());
1958 return Offset;
1959}
1960
Eric Christopherb088d2d2013-10-24 21:05:08 +00001961// Compute the size and offset for each DIE.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001962void DwarfUnits::computeSizeAndOffsets() {
Eric Christopherb088d2d2013-10-24 21:05:08 +00001963 // Iterate over each compile unit and set the size and offsets for each
1964 // DIE within each compile unit. All offsets are CU relative.
Eric Christopher4887c8f2013-03-29 23:34:06 +00001965 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopherc8a310e2012-12-10 23:34:43 +00001966 E = CUs.end(); I != E; ++I) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001967 unsigned Offset =
1968 sizeof(int32_t) + // Length of Compilation Unit Info
1969 sizeof(int16_t) + // DWARF version number
1970 sizeof(int32_t) + // Offset Into Abbrev. Section
1971 sizeof(int8_t); // Pointer Size (in bytes)
Eric Christopherc19d6f02013-10-04 19:40:33 +00001972 computeSizeAndOffset((*I)->getCUDie(), Offset);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001973 }
Bill Wendling480ff322009-05-20 23:21:38 +00001974}
1975
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001976// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001977void DwarfDebug::emitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001978 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001979
Bill Wendling480ff322009-05-20 23:21:38 +00001980 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001981 DwarfInfoSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001982 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001983 DwarfAbbrevSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001984 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher3c5a1912012-12-19 22:02:53 +00001985 if (useSplitDwarf())
1986 DwarfAbbrevDWOSectionSym =
1987 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1988 "section_abbrev_dwo");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001989 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001990
Chris Lattner6629ca92010-04-04 22:59:04 +00001991 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001992 emitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00001993
Eric Christopher74804332013-02-07 21:19:50 +00001994 DwarfLineSectionSym =
1995 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001996 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Eric Christopher261d2342013-09-23 20:55:35 +00001997 if (GenerateGnuPubSections) {
Eric Christopher39eebfa2013-09-30 23:14:16 +00001998 DwarfGnuPubNamesSectionSym =
1999 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
2000 DwarfGnuPubTypesSectionSym =
2001 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
Eric Christopher261d2342013-09-23 20:55:35 +00002002 } else if (HasDwarfPubSections) {
2003 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2004 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Michael Gottesmanc89466f2013-09-04 04:39:38 +00002005 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002006
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002007 DwarfStrSectionSym =
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002008 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002009 if (useSplitDwarf()) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002010 DwarfStrDWOSectionSym =
2011 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002012 DwarfAddrSectionSym =
2013 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
2014 }
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002015 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patel12563b32010-04-16 23:33:45 +00002016 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00002017
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002018 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patel9fc11702010-05-25 23:40:22 +00002019 "section_debug_loc");
2020
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002021 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
2022 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002023}
2024
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002025// Recursively emits a debug information entry.
Eric Christopher3c5a1912012-12-19 22:02:53 +00002026void DwarfDebug::emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs) {
Bill Wendling480ff322009-05-20 23:21:38 +00002027 // Get the abbreviation for this DIE.
2028 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher3c5a1912012-12-19 22:02:53 +00002029 const DIEAbbrev *Abbrev = Abbrevs->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00002030
Bill Wendling480ff322009-05-20 23:21:38 +00002031 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00002032 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00002033 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2034 Twine::utohexstr(Die->getOffset()) + ":0x" +
2035 Twine::utohexstr(Die->getSize()) + " " +
2036 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00002037 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00002038
Eric Christopher4887c8f2013-03-29 23:34:06 +00002039 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
2040 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling480ff322009-05-20 23:21:38 +00002041
2042 // Emit the DIE attribute values.
2043 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
David Blaikief2443192013-10-21 17:28:37 +00002044 dwarf::Attribute Attr = AbbrevData[i].getAttribute();
2045 dwarf::Form Form = AbbrevData[i].getForm();
Bill Wendling480ff322009-05-20 23:21:38 +00002046 assert(Form && "Too many attributes for DIE (check abbreviation)");
2047
Chris Lattner7bde8c02010-04-04 18:52:31 +00002048 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00002049 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002050
Bill Wendling480ff322009-05-20 23:21:38 +00002051 switch (Attr) {
Devang Patel12563b32010-04-16 23:33:45 +00002052 case dwarf::DW_AT_ranges: {
2053 // DW_AT_range Value encodes offset in debug_range section.
2054 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00002055
Nick Lewycky33da3362012-06-22 01:25:12 +00002056 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelda3ef852010-09-02 16:43:44 +00002057 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
2058 V->getValue(),
2059 4);
2060 } else {
2061 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
2062 V->getValue(),
2063 DwarfDebugRangeSectionSym,
2064 4);
2065 }
Devang Patel12563b32010-04-16 23:33:45 +00002066 break;
2067 }
Devang Patel9fc11702010-05-25 23:40:22 +00002068 case dwarf::DW_AT_location: {
Nick Lewycky33da3362012-06-22 01:25:12 +00002069 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2070 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002071 Asm->EmitLabelReference(L->getValue(), 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002072 else
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002073 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002074 } else {
Devang Patel9fc11702010-05-25 23:40:22 +00002075 Values[i]->EmitValue(Asm, Form);
Nick Lewycky33da3362012-06-22 01:25:12 +00002076 }
Devang Patel9fc11702010-05-25 23:40:22 +00002077 break;
2078 }
Devang Patela1bd5a12010-09-29 19:08:08 +00002079 case dwarf::DW_AT_accessibility: {
2080 if (Asm->isVerbose()) {
2081 DIEInteger *V = cast<DIEInteger>(Values[i]);
2082 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2083 }
2084 Values[i]->EmitValue(Asm, Form);
2085 break;
2086 }
Bill Wendling480ff322009-05-20 23:21:38 +00002087 default:
2088 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002089 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00002090 break;
2091 }
Bill Wendling480ff322009-05-20 23:21:38 +00002092 }
2093
2094 // Emit the DIE children if any.
2095 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2096 const std::vector<DIE *> &Children = Die->getChildren();
2097
2098 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher3c5a1912012-12-19 22:02:53 +00002099 emitDIE(Children[j], Abbrevs);
Bill Wendling480ff322009-05-20 23:21:38 +00002100
Chris Lattner7bde8c02010-04-04 18:52:31 +00002101 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00002102 Asm->OutStreamer.AddComment("End Of Children Mark");
2103 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00002104 }
2105}
2106
Eric Christophera2de8262012-12-15 00:04:07 +00002107// Emit the various dwarf units to the unit section USection with
2108// the abbreviations going into ASection.
2109void DwarfUnits::emitUnits(DwarfDebug *DD,
2110 const MCSection *USection,
2111 const MCSection *ASection,
2112 const MCSymbol *ASectionSym) {
2113 Asm->OutStreamer.SwitchSection(USection);
Eric Christopher4887c8f2013-03-29 23:34:06 +00002114 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christophera2de8262012-12-15 00:04:07 +00002115 E = CUs.end(); I != E; ++I) {
2116 CompileUnit *TheCU = *I;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002117 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002118
Devang Patel1a0df9a2010-05-10 22:49:55 +00002119 // Emit the compile units header.
Eric Christophera2de8262012-12-15 00:04:07 +00002120 Asm->OutStreamer
2121 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
2122 TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002123
Devang Patel1a0df9a2010-05-10 22:49:55 +00002124 // Emit size of content not including length itself
2125 unsigned ContentSize = Die->getSize() +
2126 sizeof(int16_t) + // DWARF version number
2127 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patele141234942011-04-13 19:41:17 +00002128 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002129
Devang Patel1a0df9a2010-05-10 22:49:55 +00002130 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2131 Asm->EmitInt32(ContentSize);
2132 Asm->OutStreamer.AddComment("DWARF version number");
Manman Renac8062b2013-07-02 23:40:10 +00002133 Asm->EmitInt16(DD->getDwarfVersion());
Devang Patel1a0df9a2010-05-10 22:49:55 +00002134 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
Eric Christophera2de8262012-12-15 00:04:07 +00002135 Asm->EmitSectionOffset(Asm->GetTempSymbol(ASection->getLabelBeginName()),
2136 ASectionSym);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002137 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002138 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002139
Eric Christopher3c5a1912012-12-19 22:02:53 +00002140 DD->emitDIE(Die, Abbreviations);
Eric Christophera2de8262012-12-15 00:04:07 +00002141 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
Eli Benderskyb42d1462012-12-03 18:45:45 +00002142 TheCU->getUniqueID()));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002143 }
Bill Wendling480ff322009-05-20 23:21:38 +00002144}
2145
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002146// Emit the debug info section.
2147void DwarfDebug::emitDebugInfo() {
Eric Christophera2de8262012-12-15 00:04:07 +00002148 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2149
2150 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
2151 Asm->getObjFileLowering().getDwarfAbbrevSection(),
2152 DwarfAbbrevSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002153}
2154
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002155// Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +00002156void DwarfDebug::emitAbbreviations() {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002157 if (!useSplitDwarf())
2158 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
2159 &Abbreviations);
2160 else
2161 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2162}
Bill Wendling480ff322009-05-20 23:21:38 +00002163
Eric Christopher3c5a1912012-12-19 22:02:53 +00002164void DwarfDebug::emitAbbrevs(const MCSection *Section,
2165 std::vector<DIEAbbrev *> *Abbrevs) {
2166 // Check to see if it is worth the effort.
2167 if (!Abbrevs->empty()) {
2168 // Start the debug abbrev section.
2169 Asm->OutStreamer.SwitchSection(Section);
2170
2171 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
Eric Christopher996b2b72012-12-13 03:00:38 +00002172 Asm->OutStreamer.EmitLabel(Begin);
Bill Wendling480ff322009-05-20 23:21:38 +00002173
2174 // For each abbrevation.
Eric Christopher3c5a1912012-12-19 22:02:53 +00002175 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
Bill Wendling480ff322009-05-20 23:21:38 +00002176 // Get abbreviation data
Eric Christopher3c5a1912012-12-19 22:02:53 +00002177 const DIEAbbrev *Abbrev = Abbrevs->at(i);
Bill Wendling480ff322009-05-20 23:21:38 +00002178
2179 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00002180 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00002181
2182 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002183 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00002184 }
2185
2186 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00002187 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00002188
Eric Christopher3c5a1912012-12-19 22:02:53 +00002189 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
Eric Christopher996b2b72012-12-13 03:00:38 +00002190 Asm->OutStreamer.EmitLabel(End);
Bill Wendling480ff322009-05-20 23:21:38 +00002191 }
2192}
2193
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002194// Emit the last address of the section and the end of the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +00002195void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00002196 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00002197 Asm->OutStreamer.AddComment("Extended Op");
2198 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002199
Chris Lattner566cae92010-03-09 23:52:58 +00002200 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002201 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00002202 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2203 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2204
2205 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002206
Chris Lattnera179b522010-04-04 19:25:43 +00002207 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Eric Christopherce0cfce2013-01-09 01:35:34 +00002208 Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002209
2210 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00002211 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2212 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002213 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00002214 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002215}
2216
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002217// Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00002218void DwarfDebug::emitAccelNames() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002219 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002220 dwarf::DW_FORM_data4));
2221 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2222 E = CUMap.end(); I != E; ++I) {
2223 CompileUnit *TheCU = I->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00002224 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2225 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002226 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002227 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002228 const std::vector<DIE *> &Entities = GI->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00002229 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2230 DE = Entities.end(); DI != DE; ++DI)
2231 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00002232 }
2233 }
2234
2235 AT.FinalizeTable(Asm, "Names");
2236 Asm->OutStreamer.SwitchSection(
2237 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2238 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2239 Asm->OutStreamer.EmitLabel(SectionBegin);
2240
2241 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002242 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002243}
2244
Eric Christopher48fef592012-12-20 21:58:40 +00002245// Emit objective C classes and categories into a hashed accelerator table
2246// section.
Eric Christopher4996c702011-11-07 09:24:32 +00002247void DwarfDebug::emitAccelObjC() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002248 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002249 dwarf::DW_FORM_data4));
2250 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2251 E = CUMap.end(); I != E; ++I) {
2252 CompileUnit *TheCU = I->second;
2253 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2254 for (StringMap<std::vector<DIE*> >::const_iterator
2255 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002256 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002257 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher4996c702011-11-07 09:24:32 +00002258 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2259 DE = Entities.end(); DI != DE; ++DI)
2260 AT.AddName(Name, (*DI));
2261 }
2262 }
2263
2264 AT.FinalizeTable(Asm, "ObjC");
2265 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2266 .getDwarfAccelObjCSection());
2267 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2268 Asm->OutStreamer.EmitLabel(SectionBegin);
2269
2270 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002271 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002272}
2273
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002274// Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002275void DwarfDebug::emitAccelNamespaces() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002276 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002277 dwarf::DW_FORM_data4));
2278 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2279 E = CUMap.end(); I != E; ++I) {
2280 CompileUnit *TheCU = I->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00002281 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2282 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002283 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002284 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002285 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00002286 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2287 DE = Entities.end(); DI != DE; ++DI)
2288 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00002289 }
2290 }
2291
2292 AT.FinalizeTable(Asm, "namespac");
2293 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2294 .getDwarfAccelNamespaceSection());
2295 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2296 Asm->OutStreamer.EmitLabel(SectionBegin);
2297
2298 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002299 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002300}
2301
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002302// Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002303void DwarfDebug::emitAccelTypes() {
Eric Christopher21bde872012-01-06 04:35:23 +00002304 std::vector<DwarfAccelTable::Atom> Atoms;
Eric Christophercf7289f2013-09-05 18:20:16 +00002305 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher21bde872012-01-06 04:35:23 +00002306 dwarf::DW_FORM_data4));
Eric Christophercf7289f2013-09-05 18:20:16 +00002307 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag,
Eric Christopher21bde872012-01-06 04:35:23 +00002308 dwarf::DW_FORM_data2));
Eric Christophercf7289f2013-09-05 18:20:16 +00002309 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags,
Eric Christopher21bde872012-01-06 04:35:23 +00002310 dwarf::DW_FORM_data1));
2311 DwarfAccelTable AT(Atoms);
Eric Christopher4996c702011-11-07 09:24:32 +00002312 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2313 E = CUMap.end(); I != E; ++I) {
2314 CompileUnit *TheCU = I->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002315 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2316 = TheCU->getAccelTypes();
2317 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002318 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002319 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002320 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002321 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2322 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2323 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher4996c702011-11-07 09:24:32 +00002324 }
2325 }
2326
2327 AT.FinalizeTable(Asm, "types");
2328 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2329 .getDwarfAccelTypesSection());
2330 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2331 Asm->OutStreamer.EmitLabel(SectionBegin);
2332
2333 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002334 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002335}
2336
Eric Christopherdd1a0122013-09-13 00:35:05 +00002337// Public name handling.
2338// The format for the various pubnames:
2339//
2340// dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2341// for the DIE that is named.
2342//
2343// gnu pubnames - offset/index value/name tuples where the offset is the offset
2344// into the CU and the index value is computed according to the type of value
2345// for the DIE that is named.
2346//
2347// For type units the offset is the offset of the skeleton DIE. For split dwarf
2348// it's the offset within the debug_info/debug_types dwo section, however, the
2349// reference in the pubname header doesn't change.
2350
2351/// computeIndexValue - Compute the gdb index value for the DIE and CU.
David Blaikie8dec4072013-09-19 20:40:26 +00002352static dwarf::PubIndexEntryDescriptor computeIndexValue(CompileUnit *CU,
2353 DIE *Die) {
Eric Christopherd2b497b2013-10-16 01:37:49 +00002354 dwarf::GDBIndexEntryLinkage Linkage = dwarf::GIEL_STATIC;
2355
2356 // We could have a specification DIE that has our most of our knowledge,
2357 // look for that now.
2358 DIEValue *SpecVal = Die->findAttribute(dwarf::DW_AT_specification);
2359 if (SpecVal) {
2360 DIE *SpecDIE = cast<DIEEntry>(SpecVal)->getEntry();
2361 if (SpecDIE->findAttribute(dwarf::DW_AT_external))
2362 Linkage = dwarf::GIEL_EXTERNAL;
2363 } else if (Die->findAttribute(dwarf::DW_AT_external))
2364 Linkage = dwarf::GIEL_EXTERNAL;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002365
2366 switch (Die->getTag()) {
2367 case dwarf::DW_TAG_class_type:
2368 case dwarf::DW_TAG_structure_type:
2369 case dwarf::DW_TAG_union_type:
2370 case dwarf::DW_TAG_enumeration_type:
Eric Christopher261d2342013-09-23 20:55:35 +00002371 return dwarf::PubIndexEntryDescriptor(
2372 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2373 ? dwarf::GIEL_STATIC
2374 : dwarf::GIEL_EXTERNAL);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002375 case dwarf::DW_TAG_typedef:
2376 case dwarf::DW_TAG_base_type:
2377 case dwarf::DW_TAG_subrange_type:
David Blaikie8dec4072013-09-19 20:40:26 +00002378 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002379 case dwarf::DW_TAG_namespace:
David Blaikie8dec4072013-09-19 20:40:26 +00002380 return dwarf::GIEK_TYPE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002381 case dwarf::DW_TAG_subprogram:
Eric Christopherccac5c42013-09-23 22:59:14 +00002382 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002383 case dwarf::DW_TAG_constant:
2384 case dwarf::DW_TAG_variable:
Eric Christopherccac5c42013-09-23 22:59:14 +00002385 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002386 case dwarf::DW_TAG_enumerator:
David Blaikie8dec4072013-09-19 20:40:26 +00002387 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2388 dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002389 default:
David Blaikie8dec4072013-09-19 20:40:26 +00002390 return dwarf::GIEK_NONE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002391 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002392}
2393
Eric Christopher5f93bb92013-09-09 20:03:17 +00002394/// emitDebugPubNames - Emit visible names into a debug pubnames section.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002395///
Eric Christopherdd1a0122013-09-13 00:35:05 +00002396void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002397 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christopherdd1a0122013-09-13 00:35:05 +00002398 const MCSection *PSec =
2399 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2400 : Asm->getObjFileLowering().getDwarfPubNamesSection();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002401
2402 typedef DenseMap<const MDNode*, CompileUnit*> CUMapType;
2403 for (CUMapType::iterator I = CUMap.begin(), E = CUMap.end(); I != E; ++I) {
2404 CompileUnit *TheCU = I->second;
2405 unsigned ID = TheCU->getUniqueID();
2406
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002407 // Start the dwarf pubnames section.
Eric Christopher13b99d22013-09-10 21:49:37 +00002408 Asm->OutStreamer.SwitchSection(PSec);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002409
Eric Christopher39eebfa2013-09-30 23:14:16 +00002410 // Emit a label so we can reference the beginning of this pubname section.
2411 if (GnuStyle)
2412 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames",
2413 TheCU->getUniqueID()));
2414
Eric Christopherdd1a0122013-09-13 00:35:05 +00002415 // Emit the header.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002416 Asm->OutStreamer.AddComment("Length of Public Names Info");
2417 Asm->EmitLabelDifference(Asm->GetTempSymbol("pubnames_end", ID),
2418 Asm->GetTempSymbol("pubnames_begin", ID), 4);
2419
2420 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin", ID));
2421
2422 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002423 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002424
2425 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2426 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2427 DwarfInfoSectionSym);
2428
2429 Asm->OutStreamer.AddComment("Compilation Unit Length");
2430 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(), ID),
2431 Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2432 4);
2433
Eric Christopherdd1a0122013-09-13 00:35:05 +00002434 // Emit the pubnames for this compilation unit.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002435 const StringMap<DIE*> &Globals = TheCU->getGlobalNames();
2436 for (StringMap<DIE*>::const_iterator
2437 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2438 const char *Name = GI->getKeyData();
Eric Christopherdd1a0122013-09-13 00:35:05 +00002439 DIE *Entity = GI->second;
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002440
2441 Asm->OutStreamer.AddComment("DIE offset");
2442 Asm->EmitInt32(Entity->getOffset());
2443
Eric Christopherdd1a0122013-09-13 00:35:05 +00002444 if (GnuStyle) {
David Blaikied0a869d2013-09-19 22:19:37 +00002445 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2446 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002447 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002448 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002449 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002450 }
2451
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002452 if (Asm->isVerbose())
2453 Asm->OutStreamer.AddComment("External Name");
Rafael Espindola64e1af82013-07-02 15:49:13 +00002454 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002455 }
2456
2457 Asm->OutStreamer.AddComment("End Mark");
2458 Asm->EmitInt32(0);
2459 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end", ID));
2460 }
2461}
2462
Eric Christopherdd1a0122013-09-13 00:35:05 +00002463void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
Eric Christopher8b3737f2013-09-13 00:34:58 +00002464 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christopher261d2342013-09-23 20:55:35 +00002465 const MCSection *PSec =
2466 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2467 : Asm->getObjFileLowering().getDwarfPubTypesSection();
Eric Christopher8b3737f2013-09-13 00:34:58 +00002468
Devang Patel1a0df9a2010-05-10 22:49:55 +00002469 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
Eric Christopher8b3737f2013-09-13 00:34:58 +00002470 E = CUMap.end();
2471 I != E; ++I) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002472 CompileUnit *TheCU = I->second;
Eric Christopher6abc9c52011-11-07 09:18:35 +00002473 // Start the dwarf pubtypes section.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002474 Asm->OutStreamer.SwitchSection(PSec);
Eric Christopher39eebfa2013-09-30 23:14:16 +00002475
2476 // Emit a label so we can reference the beginning of this pubtype section.
2477 if (GnuStyle)
2478 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes",
2479 TheCU->getUniqueID()));
2480
2481 // Emit the header.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002482 Asm->OutStreamer.AddComment("Length of Public Types Info");
2483 Asm->EmitLabelDifference(
Eric Christopher8b3737f2013-09-13 00:34:58 +00002484 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2485 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002486
Eric Christopher8b3737f2013-09-13 00:34:58 +00002487 Asm->OutStreamer.EmitLabel(
2488 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002489
Eric Christopher8b3737f2013-09-13 00:34:58 +00002490 if (Asm->isVerbose())
2491 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002492 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002493
Devang Patel1a0df9a2010-05-10 22:49:55 +00002494 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002495 Asm->EmitSectionOffset(
2496 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()),
2497 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002498
Devang Patel1a0df9a2010-05-10 22:49:55 +00002499 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002500 Asm->EmitLabelDifference(
2501 Asm->GetTempSymbol(ISec->getLabelEndName(), TheCU->getUniqueID()),
2502 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002503
Eric Christopher39eebfa2013-09-30 23:14:16 +00002504 // Emit the pubtypes.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002505 const StringMap<DIE *> &Globals = TheCU->getGlobalTypes();
2506 for (StringMap<DIE *>::const_iterator GI = Globals.begin(),
2507 GE = Globals.end();
2508 GI != GE; ++GI) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002509 const char *Name = GI->getKeyData();
Nick Lewycky019d2552011-07-29 03:49:23 +00002510 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002511
Eric Christopher8b3737f2013-09-13 00:34:58 +00002512 if (Asm->isVerbose())
2513 Asm->OutStreamer.AddComment("DIE offset");
Devang Patel1a0df9a2010-05-10 22:49:55 +00002514 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002515
Eric Christopherdd1a0122013-09-13 00:35:05 +00002516 if (GnuStyle) {
David Blaikied0a869d2013-09-19 22:19:37 +00002517 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2518 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002519 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002520 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002521 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002522 }
2523
Eric Christopher8b3737f2013-09-13 00:34:58 +00002524 if (Asm->isVerbose())
2525 Asm->OutStreamer.AddComment("External Name");
2526
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002527 // Emit the name with a terminating null byte.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002528 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002529 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002530
Devang Patel1a0df9a2010-05-10 22:49:55 +00002531 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002532 Asm->EmitInt32(0);
Eric Christopher8b3737f2013-09-13 00:34:58 +00002533 Asm->OutStreamer.EmitLabel(
2534 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00002535 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002536}
2537
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002538// Emit strings into a string section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002539void DwarfUnits::emitStrings(const MCSection *StrSection,
2540 const MCSection *OffsetSection = NULL,
2541 const MCSymbol *StrSecSym = NULL) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002542
Eric Christopher27614582013-01-08 22:22:06 +00002543 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002544
Chris Lattner3d72a672010-03-09 23:38:23 +00002545 // Start the dwarf str section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002546 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling480ff322009-05-20 23:21:38 +00002547
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002548 // Get all of the string pool entries and put them in an array by their ID so
2549 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002550 SmallVector<std::pair<unsigned,
Eric Christopherb800ff72013-01-07 22:40:45 +00002551 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002552
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002553 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
Eric Christopher27614582013-01-08 22:22:06 +00002554 I = StringPool.begin(), E = StringPool.end();
Eric Christopher48fef592012-12-20 21:58:40 +00002555 I != E; ++I)
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002556 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002557
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002558 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002559
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002560 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002561 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002562 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002563
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002564 // Emit the string itself with a terminating null byte.
Benjamin Kramer148db362011-11-09 12:12:04 +00002565 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
Eric Christopherce0cfce2013-01-09 01:35:34 +00002566 Entries[i].second->getKeyLength()+1));
Bill Wendling480ff322009-05-20 23:21:38 +00002567 }
Eric Christopher2cbd5762013-01-07 19:32:41 +00002568
2569 // If we've got an offset section go ahead and emit that now as well.
2570 if (OffsetSection) {
2571 Asm->OutStreamer.SwitchSection(OffsetSection);
2572 unsigned offset = 0;
Eric Christopher962c9082013-01-15 23:56:56 +00002573 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002574 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopherbf7bc492013-01-09 03:52:05 +00002575 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopher2cbd5762013-01-07 19:32:41 +00002576 offset += Entries[i].second->getKeyLength() + 1;
2577 }
2578 }
Bill Wendling480ff322009-05-20 23:21:38 +00002579}
2580
Eric Christopher962c9082013-01-15 23:56:56 +00002581// Emit strings into a string section.
2582void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2583
2584 if (AddressPool.empty()) return;
2585
2586 // Start the dwarf addr section.
2587 Asm->OutStreamer.SwitchSection(AddrSection);
2588
David Blaikiece1960f2013-07-08 17:51:28 +00002589 // Order the address pool entries by ID
David Blaikieac569a62013-07-08 17:33:10 +00002590 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher962c9082013-01-15 23:56:56 +00002591
David Blaikiece1960f2013-07-08 17:51:28 +00002592 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2593 E = AddressPool.end();
Eric Christopher962c9082013-01-15 23:56:56 +00002594 I != E; ++I)
David Blaikieac569a62013-07-08 17:33:10 +00002595 Entries[I->second] = I->first;
Eric Christopher962c9082013-01-15 23:56:56 +00002596
2597 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002598 // Emit an expression for reference from debug information entries.
David Blaikieac569a62013-07-08 17:33:10 +00002599 if (const MCExpr *Expr = Entries[i])
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002600 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
Eric Christopher962c9082013-01-15 23:56:56 +00002601 else
2602 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2603 }
2604
2605}
2606
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002607// Emit visible names into a debug str section.
2608void DwarfDebug::emitDebugStr() {
2609 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2610 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2611}
2612
Eric Christopher9046f942013-07-02 21:36:07 +00002613// Emit locations into the debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002614void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002615 if (DotDebugLocEntries.empty())
2616 return;
2617
Eric Christopher4887c8f2013-03-29 23:34:06 +00002618 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Devang Patel116a9d72011-02-04 22:57:18 +00002619 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2620 I != E; ++I) {
2621 DotDebugLocEntry &Entry = *I;
2622 if (I + 1 != DotDebugLocEntries.end())
2623 Entry.Merge(I+1);
2624 }
2625
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002626 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002627 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00002628 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002629 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002630 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2631 unsigned index = 1;
Eric Christopher4887c8f2013-03-29 23:34:06 +00002632 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002633 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002634 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002635 DotDebugLocEntry &Entry = *I;
2636 if (Entry.isMerged()) continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002637 if (Entry.isEmpty()) {
Eric Christopherce0cfce2013-01-09 01:35:34 +00002638 Asm->OutStreamer.EmitIntValue(0, Size);
2639 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002640 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002641 } else {
Eric Christopher25f06422013-07-03 22:40:18 +00002642 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2643 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2644 DIVariable DV(Entry.getVariable());
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002645 Asm->OutStreamer.AddComment("Loc expr size");
2646 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2647 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2648 Asm->EmitLabelDifference(end, begin, 2);
2649 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002650 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002651 DIBasicType BTy(DV.getType());
2652 if (BTy.Verify() &&
Eric Christopher6a841382012-11-19 22:42:10 +00002653 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patel324f8432011-06-01 22:03:25 +00002654 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2655 Asm->OutStreamer.AddComment("DW_OP_consts");
2656 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002657 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002658 } else {
2659 Asm->OutStreamer.AddComment("DW_OP_constu");
2660 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002661 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002662 }
Devang Pateled9fd452011-07-08 16:49:43 +00002663 } else if (Entry.isLocation()) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002664 MachineLocation Loc = Entry.getLoc();
Eric Christopher6a841382012-11-19 22:42:10 +00002665 if (!DV.hasComplexAddress())
Devang Pateled9fd452011-07-08 16:49:43 +00002666 // Regular entry.
Eric Christopher614a89f2013-07-03 22:40:21 +00002667 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002668 else {
2669 // Complex address entry.
2670 unsigned N = DV.getNumAddrElements();
2671 unsigned i = 0;
2672 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002673 if (Loc.getOffset()) {
Devang Pateled9fd452011-07-08 16:49:43 +00002674 i = 2;
Eric Christopher614a89f2013-07-03 22:40:21 +00002675 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002676 Asm->OutStreamer.AddComment("DW_OP_deref");
2677 Asm->EmitInt8(dwarf::DW_OP_deref);
2678 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2679 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2680 Asm->EmitSLEB128(DV.getAddrElement(1));
2681 } else {
2682 // If first address element is OpPlus then emit
2683 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher614a89f2013-07-03 22:40:21 +00002684 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2685 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002686 i = 2;
2687 }
2688 } else {
Eric Christopher614a89f2013-07-03 22:40:21 +00002689 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002690 }
Eric Christopher6a841382012-11-19 22:42:10 +00002691
Devang Pateled9fd452011-07-08 16:49:43 +00002692 // Emit remaining complex address elements.
2693 for (; i < N; ++i) {
2694 uint64_t Element = DV.getAddrElement(i);
2695 if (Element == DIBuilder::OpPlus) {
2696 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2697 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher4d250522012-05-08 18:56:00 +00002698 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002699 if (!Loc.isReg())
Eric Christopher4d250522012-05-08 18:56:00 +00002700 Asm->EmitInt8(dwarf::DW_OP_deref);
2701 } else
2702 llvm_unreachable("unknown Opcode found in complex address");
Devang Pateled9fd452011-07-08 16:49:43 +00002703 }
Devang Patel3e021532011-04-28 02:22:40 +00002704 }
Devang Patel3e021532011-04-28 02:22:40 +00002705 }
Devang Pateled9fd452011-07-08 16:49:43 +00002706 // else ... ignore constant fp. There is not any good way to
2707 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002708 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002709 }
2710 }
Bill Wendling480ff322009-05-20 23:21:38 +00002711}
2712
Richard Mitton21101b32013-09-19 23:21:01 +00002713struct SymbolCUSorter {
2714 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2715 const MCStreamer &Streamer;
2716
2717 bool operator() (const SymbolCU &A, const SymbolCU &B) {
2718 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2719 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2720
2721 // Symbols with no order assigned should be placed at the end.
2722 // (e.g. section end labels)
2723 if (IA == 0)
2724 IA = (unsigned)(-1);
2725 if (IB == 0)
2726 IB = (unsigned)(-1);
2727 return IA < IB;
2728 }
2729};
2730
Richard Mitton21101b32013-09-19 23:21:01 +00002731static bool CUSort(const CompileUnit *A, const CompileUnit *B) {
2732 return (A->getUniqueID() < B->getUniqueID());
2733}
2734
2735struct ArangeSpan {
2736 const MCSymbol *Start, *End;
2737};
2738
2739// Emit a debug aranges section, containing a CU lookup for any
2740// address we can tie back to a CU.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002741void DwarfDebug::emitDebugARanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002742 // Start the dwarf aranges section.
Eric Christopherac8199b2013-08-30 00:39:57 +00002743 Asm->OutStreamer
2744 .SwitchSection(Asm->getObjFileLowering().getDwarfARangesSection());
Richard Mitton21101b32013-09-19 23:21:01 +00002745
2746 typedef DenseMap<CompileUnit *, std::vector<ArangeSpan> > SpansType;
2747
2748 SpansType Spans;
2749
2750 // Build a list of sections used.
2751 std::vector<const MCSection *> Sections;
2752 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2753 it++) {
2754 const MCSection *Section = it->first;
2755 Sections.push_back(Section);
2756 }
2757
2758 // Sort the sections into order.
2759 // This is only done to ensure consistent output order across different runs.
2760 std::sort(Sections.begin(), Sections.end(), SectionSort);
2761
2762 // Build a set of address spans, sorted by CU.
2763 for (size_t SecIdx=0;SecIdx<Sections.size();SecIdx++) {
2764 const MCSection *Section = Sections[SecIdx];
2765 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2766 if (List.size() < 2)
2767 continue;
2768
2769 // Sort the symbols by offset within the section.
2770 SymbolCUSorter sorter(Asm->OutStreamer);
2771 std::sort(List.begin(), List.end(), sorter);
2772
2773 // If we have no section (e.g. common), just write out
2774 // individual spans for each symbol.
2775 if (Section == NULL) {
2776 for (size_t n = 0; n < List.size(); n++) {
2777 const SymbolCU &Cur = List[n];
2778
2779 ArangeSpan Span;
2780 Span.Start = Cur.Sym;
2781 Span.End = NULL;
2782 if (Cur.CU)
2783 Spans[Cur.CU].push_back(Span);
2784 }
2785 } else {
2786 // Build spans between each label.
2787 const MCSymbol *StartSym = List[0].Sym;
2788 for (size_t n = 1; n < List.size(); n++) {
2789 const SymbolCU &Prev = List[n - 1];
2790 const SymbolCU &Cur = List[n];
2791
2792 // Try and build the longest span we can within the same CU.
2793 if (Cur.CU != Prev.CU) {
2794 ArangeSpan Span;
2795 Span.Start = StartSym;
2796 Span.End = Cur.Sym;
2797 Spans[Prev.CU].push_back(Span);
2798 StartSym = Cur.Sym;
2799 }
2800 }
2801 }
2802 }
2803
2804 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2805 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2806
2807 // Build a list of CUs used.
2808 std::vector<CompileUnit *> CUs;
2809 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
2810 CompileUnit *CU = it->first;
2811 CUs.push_back(CU);
2812 }
2813
2814 // Sort the CU list (again, to ensure consistent output order).
2815 std::sort(CUs.begin(), CUs.end(), CUSort);
2816
2817 // Emit an arange table for each CU we used.
2818 for (size_t CUIdx=0;CUIdx<CUs.size();CUIdx++) {
2819 CompileUnit *CU = CUs[CUIdx];
2820 std::vector<ArangeSpan> &List = Spans[CU];
2821
2822 // Emit size of content not including length itself.
2823 unsigned ContentSize
2824 = sizeof(int16_t) // DWARF ARange version number
2825 + sizeof(int32_t) // Offset of CU in the .debug_info section
2826 + sizeof(int8_t) // Pointer Size (in bytes)
2827 + sizeof(int8_t); // Segment Size (in bytes)
2828
2829 unsigned TupleSize = PtrSize * 2;
2830
2831 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2832 unsigned Padding = 0;
2833 while (((sizeof(int32_t) + ContentSize + Padding) % TupleSize) != 0)
2834 Padding++;
2835
2836 ContentSize += Padding;
2837 ContentSize += (List.size() + 1) * TupleSize;
2838
2839 // For each compile unit, write the list of spans it covers.
2840 Asm->OutStreamer.AddComment("Length of ARange Set");
2841 Asm->EmitInt32(ContentSize);
2842 Asm->OutStreamer.AddComment("DWARF Arange version number");
2843 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2844 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
2845 Asm->EmitSectionOffset(
2846 Asm->GetTempSymbol(ISec->getLabelBeginName(), CU->getUniqueID()),
2847 DwarfInfoSectionSym);
2848 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2849 Asm->EmitInt8(PtrSize);
2850 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2851 Asm->EmitInt8(0);
2852
2853 for (unsigned n = 0; n < Padding; n++)
2854 Asm->EmitInt8(0xff);
2855
2856 for (unsigned n = 0; n < List.size(); n++) {
2857 const ArangeSpan &Span = List[n];
2858 Asm->EmitLabelReference(Span.Start, PtrSize);
2859
2860 // Calculate the size as being from the span start to it's end.
Richard Mitton089ed892013-09-23 17:56:20 +00002861 if (Span.End) {
Richard Mitton21101b32013-09-19 23:21:01 +00002862 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
Richard Mitton089ed892013-09-23 17:56:20 +00002863 } else {
2864 // For symbols without an end marker (e.g. common), we
2865 // write a single arange entry containing just that one symbol.
2866 uint64_t Size = SymSize[Span.Start];
2867 if (Size == 0)
2868 Size = 1;
2869
2870 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2871 }
Richard Mitton21101b32013-09-19 23:21:01 +00002872 }
2873
2874 Asm->OutStreamer.AddComment("ARange terminator");
2875 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2876 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2877 }
Bill Wendling480ff322009-05-20 23:21:38 +00002878}
2879
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002880// Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002881void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002882 // Start the dwarf ranges section.
Eric Christopherac8199b2013-08-30 00:39:57 +00002883 Asm->OutStreamer
2884 .SwitchSection(Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002885 unsigned char Size = Asm->getDataLayout().getPointerSize();
Eric Christopher4887c8f2013-03-29 23:34:06 +00002886 for (SmallVectorImpl<const MCSymbol *>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002887 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00002888 I != E; ++I) {
2889 if (*I)
Eric Christopherbf7bc492013-01-09 03:52:05 +00002890 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
Devang Patel12563b32010-04-16 23:33:45 +00002891 else
Eric Christopherce0cfce2013-01-09 01:35:34 +00002892 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel12563b32010-04-16 23:33:45 +00002893 }
Bill Wendling480ff322009-05-20 23:21:38 +00002894}
2895
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002896// Emit visible names into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002897void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002898 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00002899 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00002900 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002901 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00002902 }
2903}
2904
Eric Christopherd692c1d2012-12-11 19:42:09 +00002905// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002906
2907// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2908// 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 +00002909// DW_AT_ranges_base, DW_AT_addr_base.
Eric Christopher6fdf3242013-08-26 23:50:43 +00002910CompileUnit *DwarfDebug::constructSkeletonCU(const CompileUnit *CU) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002911
2912 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher6fdf3242013-08-26 23:50:43 +00002913 CompileUnit *NewCU = new CompileUnit(CU->getUniqueID(), Die, CU->getNode(),
2914 Asm, this, &SkeletonHolder);
Eric Christopher4c7765f2013-01-17 03:00:04 +00002915
Eric Christopherdae389b2013-02-22 23:50:08 +00002916 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
Eric Christopher6b16b432013-08-26 23:57:03 +00002917 DICompileUnit(CU->getNode()).getSplitDebugFilename());
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002918
Eric Christopher44c6aa62013-04-22 07:51:08 +00002919 // Relocate to the beginning of the addr_base section, else 0 for the
2920 // beginning of the one for this compile unit.
Eric Christopher55863be2013-04-07 03:43:09 +00002921 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2922 NewCU->addLabel(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2923 DwarfAddrSectionSym);
2924 else
Eric Christopher44c6aa62013-04-22 07:51:08 +00002925 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base,
2926 dwarf::DW_FORM_sec_offset, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002927
2928 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher962c9082013-01-15 23:56:56 +00002929 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002930 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher962c9082013-01-15 23:56:56 +00002931
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002932 // DW_AT_stmt_list is a offset of line number information for this
2933 // compile unit in debug_line section.
Eric Christopher55863be2013-04-07 03:43:09 +00002934 // FIXME: Should handle multiple compile units.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002935 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher4c7765f2013-01-17 03:00:04 +00002936 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher74804332013-02-07 21:19:50 +00002937 DwarfLineSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002938 else
Eric Christopher4c7765f2013-01-17 03:00:04 +00002939 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002940
2941 if (!CompilationDir.empty())
Eric Christopher2cbd5762013-01-07 19:32:41 +00002942 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002943
Eric Christopher1d06eb52013-10-01 00:43:31 +00002944 // Flags to let the linker know we have emitted new style pubnames.
Eric Christopher39eebfa2013-09-30 23:14:16 +00002945 if (GenerateGnuPubSections) {
2946 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2947 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_sec_offset,
2948 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()));
2949 else
2950 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
2951 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()),
2952 DwarfGnuPubNamesSectionSym);
2953
2954 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2955 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_sec_offset,
2956 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()));
2957 else
2958 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopherf976c772013-10-03 17:41:16 +00002959 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()),
Eric Christopher39eebfa2013-09-30 23:14:16 +00002960 DwarfGnuPubTypesSectionSym);
2961 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002962
Eric Christopher9a08f9e2013-10-01 00:43:36 +00002963 // Flag if we've emitted any ranges and their location for the compile unit.
2964 if (DebugRangeSymbols.size()) {
2965 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2966 NewCU->addLabel(Die, dwarf::DW_AT_GNU_ranges_base,
2967 dwarf::DW_FORM_sec_offset, DwarfDebugRangeSectionSym);
2968 else
2969 NewCU->addUInt(Die, dwarf::DW_AT_GNU_ranges_base, dwarf::DW_FORM_data4,
2970 0);
2971 }
2972
Eric Christopherc8a310e2012-12-10 23:34:43 +00002973 SkeletonHolder.addUnit(NewCU);
Eric Christopher5b33b3c2013-02-06 21:53:56 +00002974 SkeletonCUs.push_back(NewCU);
Eric Christopherc8a310e2012-12-10 23:34:43 +00002975
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002976 return NewCU;
2977}
2978
Eric Christopher3c5a1912012-12-19 22:02:53 +00002979void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
2980 assert(useSplitDwarf() && "No split dwarf debug info?");
2981 emitAbbrevs(Section, &SkeletonAbbrevs);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002982}
2983
Eric Christopherd692c1d2012-12-11 19:42:09 +00002984// Emit the .debug_info.dwo section for separated dwarf. This contains the
2985// compile units that would normally be in debug_info.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002986void DwarfDebug::emitDebugInfoDWO() {
Eric Christophercdf218d2012-12-10 19:51:21 +00002987 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christophera2de8262012-12-15 00:04:07 +00002988 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
Eric Christopher3c5a1912012-12-19 22:02:53 +00002989 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2990 DwarfAbbrevDWOSectionSym);
2991}
2992
2993// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2994// abbreviations for the .debug_info.dwo section.
2995void DwarfDebug::emitDebugAbbrevDWO() {
2996 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopher48fef592012-12-20 21:58:40 +00002997 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2998 &Abbreviations);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002999}
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003000
3001// Emit the .debug_str.dwo section for separated dwarf. This contains the
3002// string section and is identical in format to traditional .debug_str
3003// sections.
3004void DwarfDebug::emitDebugStrDWO() {
3005 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherb800ff72013-01-07 22:40:45 +00003006 const MCSection *OffSec = Asm->getObjFileLowering()
3007 .getDwarfStrOffDWOSection();
Eric Christopher2cbd5762013-01-07 19:32:41 +00003008 const MCSymbol *StrSym = DwarfStrSectionSym;
3009 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
3010 OffSec, StrSym);
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003011}