blob: 2ab4684f62360accf2a5f3bd957ff68ad9a2a693 [file] [log] [blame]
Bill Wendling2f921f82009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Chris Lattnerb14490d2010-03-09 00:39:24 +000013
Devang Patel80ae3492009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling2f921f82009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000016#include "DIE.h"
Eric Christopher45731982013-08-08 23:45:55 +000017#include "DIEHash.h"
Eric Christopher4996c702011-11-07 09:24:32 +000018#include "DwarfAccelTable.h"
Devang Patel5eb43192011-04-12 17:40:32 +000019#include "DwarfCompileUnit.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000020#include "llvm/ADT/STLExtras.h"
21#include "llvm/ADT/Statistic.h"
22#include "llvm/ADT/StringExtras.h"
23#include "llvm/ADT/Triple.h"
David Greene829b3e82009-08-19 21:52:55 +000024#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000025#include "llvm/CodeGen/MachineModuleInfo.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000026#include "llvm/DIBuilder.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000027#include "llvm/DebugInfo.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000028#include "llvm/IR/Constants.h"
29#include "llvm/IR/DataLayout.h"
30#include "llvm/IR/Instructions.h"
31#include "llvm/IR/Module.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000032#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000033#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000034#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000035#include "llvm/MC/MCSymbol.h"
Devang Patel6c74a872010-04-27 19:46:33 +000036#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000037#include "llvm/Support/Debug.h"
David Majnemered89b5c2013-08-21 06:13:34 +000038#include "llvm/Support/Dwarf.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000039#include "llvm/Support/ErrorHandling.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000040#include "llvm/Support/FormattedStream.h"
Eric Christopher67646432013-07-26 17:02:41 +000041#include "llvm/Support/MD5.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000042#include "llvm/Support/Path.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000043#include "llvm/Support/Timer.h"
44#include "llvm/Support/ValueHandle.h"
45#include "llvm/Target/TargetFrameLowering.h"
46#include "llvm/Target/TargetLoweringObjectFile.h"
47#include "llvm/Target/TargetMachine.h"
48#include "llvm/Target/TargetOptions.h"
49#include "llvm/Target/TargetRegisterInfo.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000050using namespace llvm;
51
Eric Christopher7f2b5512013-07-23 22:16:41 +000052static cl::opt<bool>
53DisableDebugInfoPrinting("disable-debug-info-print", cl::Hidden,
54 cl::desc("Disable debug info printing"));
Devang Patel6c74a872010-04-27 19:46:33 +000055
Eric Christopher7f2b5512013-07-23 22:16:41 +000056static cl::opt<bool> UnknownLocations(
57 "use-unknown-locations", cl::Hidden,
58 cl::desc("Make an absence of debug location information explicit."),
59 cl::init(false));
Dan Gohman7421ae42010-05-07 01:08:53 +000060
Eric Christopher7f2b5512013-07-23 22:16:41 +000061static cl::opt<bool>
Eric Christopher67646432013-07-26 17:02:41 +000062GenerateODRHash("generate-odr-hash", cl::Hidden,
63 cl::desc("Add an ODR hash to external type DIEs."),
64 cl::init(false));
65
Eric Christopherd29614f2013-08-13 01:21:55 +000066static cl::opt<bool>
67GenerateCUHash("generate-cu-hash", cl::Hidden,
68 cl::desc("Add the CU hash as the dwo_id."),
69 cl::init(false));
70
Eric Christopherdd1a0122013-09-13 00:35:05 +000071static cl::opt<bool>
72GenerateGnuPubSections("generate-gnu-dwarf-pub-sections", cl::Hidden,
73 cl::desc("Generate GNU-style pubnames and pubtypes"),
74 cl::init(false));
75
Eric Christopher20b76a72012-08-23 22:36:40 +000076namespace {
Eric Christopher7f2b5512013-07-23 22:16:41 +000077enum DefaultOnOff {
78 Default,
79 Enable,
80 Disable
81};
Eric Christopher20b76a72012-08-23 22:36:40 +000082}
Eric Christopher4996c702011-11-07 09:24:32 +000083
Eric Christopher7f2b5512013-07-23 22:16:41 +000084static cl::opt<DefaultOnOff>
85DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
86 cl::desc("Output prototype dwarf accelerator tables."),
87 cl::values(clEnumVal(Default, "Default for platform"),
88 clEnumVal(Enable, "Enabled"),
89 clEnumVal(Disable, "Disabled"), clEnumValEnd),
90 cl::init(Default));
Eric Christopher20b76a72012-08-23 22:36:40 +000091
Eric Christopher7f2b5512013-07-23 22:16:41 +000092static cl::opt<DefaultOnOff>
Eric Christopher7f2b5512013-07-23 22:16:41 +000093SplitDwarf("split-dwarf", cl::Hidden,
94 cl::desc("Output prototype dwarf split debug info."),
95 cl::values(clEnumVal(Default, "Default for platform"),
96 clEnumVal(Enable, "Enabled"),
97 clEnumVal(Disable, "Disabled"), clEnumValEnd),
98 cl::init(Default));
Eric Christopher29424312012-11-12 22:22:20 +000099
Eric Christopher7da24882013-08-19 21:07:38 +0000100static cl::opt<DefaultOnOff>
Eric Christopher4d36ca02013-08-26 23:24:35 +0000101DwarfPubSections("generate-dwarf-pub-sections", cl::Hidden,
102 cl::desc("Generate DWARF pubnames and pubtypes sections"),
103 cl::values(clEnumVal(Default, "Default for platform"),
104 clEnumVal(Enable, "Enabled"),
105 clEnumVal(Disable, "Disabled"), clEnumValEnd),
106 cl::init(Default));
Eric Christopher7da24882013-08-19 21:07:38 +0000107
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000108static const char *const DWARFGroupName = "DWARF Emission";
109static const char *const DbgTimerName = "DWARF Debug Writer";
Bill Wendlingfcc14142010-04-07 09:28:04 +0000110
Bill Wendling2f921f82009-05-15 09:23:25 +0000111//===----------------------------------------------------------------------===//
112
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000113// Configuration values for initial hash set sizes (log2).
114//
Bill Wendling2f921f82009-05-15 09:23:25 +0000115static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +0000116
117namespace llvm {
118
Manman Renbe5576f2013-10-08 19:07:44 +0000119/// resolve - Look in the DwarfDebug map for the MDNode that
120/// corresponds to the reference.
121template <typename T>
122T DbgVariable::resolve(DIRef<T> Ref) const {
123 return DD->resolve(Ref);
124}
125
Nick Lewycky019d2552011-07-29 03:49:23 +0000126DIType DbgVariable::getType() const {
Devang Patelf20c4f72011-04-12 22:53:02 +0000127 DIType Ty = Var.getType();
128 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
129 // addresses instead.
130 if (Var.isBlockByrefVariable()) {
131 /* Byref variables, in Blocks, are declared by the programmer as
132 "SomeType VarName;", but the compiler creates a
133 __Block_byref_x_VarName struct, and gives the variable VarName
134 either the struct, or a pointer to the struct, as its type. This
135 is necessary for various behind-the-scenes things the compiler
136 needs to do with by-reference variables in blocks.
Eric Christopher6a841382012-11-19 22:42:10 +0000137
Devang Patelf20c4f72011-04-12 22:53:02 +0000138 However, as far as the original *programmer* is concerned, the
139 variable should still have type 'SomeType', as originally declared.
Eric Christopher6a841382012-11-19 22:42:10 +0000140
Devang Patelf20c4f72011-04-12 22:53:02 +0000141 The following function dives into the __Block_byref_x_VarName
142 struct to find the original type of the variable. This will be
143 passed back to the code generating the type for the Debug
144 Information Entry for the variable 'VarName'. 'VarName' will then
145 have the original type 'SomeType' in its debug information.
Eric Christopher6a841382012-11-19 22:42:10 +0000146
Devang Patelf20c4f72011-04-12 22:53:02 +0000147 The original type 'SomeType' will be the type of the field named
148 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher6a841382012-11-19 22:42:10 +0000149
Devang Patelf20c4f72011-04-12 22:53:02 +0000150 NOTE: In order for this to not completely fail on the debugger
151 side, the Debug Information Entry for the variable VarName needs to
152 have a DW_AT_location that tells the debugger how to unwind through
153 the pointers and __Block_byref_x_VarName struct to find the actual
154 value of the variable. The function addBlockByrefType does this. */
155 DIType subType = Ty;
Eric Christopher31b05762013-08-08 01:41:00 +0000156 uint16_t tag = Ty.getTag();
Eric Christopher6a841382012-11-19 22:42:10 +0000157
Eric Christopher9adc55f2013-09-04 19:53:21 +0000158 if (tag == dwarf::DW_TAG_pointer_type)
Manman Renbe5576f2013-10-08 19:07:44 +0000159 subType = resolve(DIDerivedType(Ty).getTypeDerivedFrom());
Eric Christopher6a841382012-11-19 22:42:10 +0000160
Eric Christopher9adc55f2013-09-04 19:53:21 +0000161 DIArray Elements = DICompositeType(subType).getTypeArray();
Devang Patelf20c4f72011-04-12 22:53:02 +0000162 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
Eric Christopher9adc55f2013-09-04 19:53:21 +0000163 DIDerivedType DT = DIDerivedType(Elements.getElement(i));
Devang Patelf20c4f72011-04-12 22:53:02 +0000164 if (getName() == DT.getName())
Manman Renbe5576f2013-10-08 19:07:44 +0000165 return (resolve(DT.getTypeDerivedFrom()));
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000166 }
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000167 }
Devang Patelf20c4f72011-04-12 22:53:02 +0000168 return Ty;
169}
Bill Wendling2f921f82009-05-15 09:23:25 +0000170
Chris Lattnerf5d06362010-04-05 04:09:20 +0000171} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000172
Manman Renac8062b2013-07-02 23:40:10 +0000173/// Return Dwarf Version by checking module flags.
174static unsigned getDwarfVersionFromModule(const Module *M) {
Manman Ren8bfde892013-07-16 23:21:16 +0000175 Value *Val = M->getModuleFlag("Dwarf Version");
176 if (!Val)
Eric Christophere31e0722013-09-04 22:21:24 +0000177 return dwarf::DWARF_VERSION;
Manman Ren8bfde892013-07-16 23:21:16 +0000178 return cast<ConstantInt>(Val)->getZExtValue();
Manman Renac8062b2013-07-02 23:40:10 +0000179}
180
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000181DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Eric Christopherd79f5482012-12-10 19:51:13 +0000182 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000183 AbbreviationsSet(InitAbbreviationsSetSize),
Eric Christopher27614582013-01-08 22:22:06 +0000184 SourceIdMap(DIEValueAllocator),
Eric Christopherc8a310e2012-12-10 23:34:43 +0000185 PrevLabel(NULL), GlobalCUIndexCount(0),
Eric Christopher27614582013-01-08 22:22:06 +0000186 InfoHolder(A, &AbbreviationsSet, &Abbreviations, "info_string",
187 DIEValueAllocator),
Eric Christopher3c5a1912012-12-19 22:02:53 +0000188 SkeletonAbbrevSet(InitAbbreviationsSetSize),
Eric Christopher27614582013-01-08 22:22:06 +0000189 SkeletonHolder(A, &SkeletonAbbrevSet, &SkeletonAbbrevs, "skel_string",
190 DIEValueAllocator) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000191
Rafael Espindolaa7160962011-05-06 14:56:22 +0000192 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattnere58b5472010-04-04 23:10:38 +0000193 DwarfStrSectionSym = TextSectionSym = 0;
Eric Christopher74804332013-02-07 21:19:50 +0000194 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
Eric Christopher55863be2013-04-07 03:43:09 +0000195 DwarfAddrSectionSym = 0;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000196 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000197 FunctionBeginSym = FunctionEndSym = 0;
Eric Christopherad9fe892012-04-02 17:58:52 +0000198
Adrian Prantl5bf1d002013-10-15 20:26:37 +0000199 // Turn on accelerator tables for Darwin by default, pubnames by
200 // default for non-Darwin, and handle split dwarf.
Eric Christopher203e12b2013-04-27 01:07:52 +0000201 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
Eric Christopher4977f212012-08-23 22:36:36 +0000202
Eric Christopher574b5c82013-08-19 21:41:38 +0000203 if (DwarfAccelTables == Default)
204 HasDwarfAccelTables = IsDarwin;
205 else
Eric Christopher5297df02013-08-26 20:58:35 +0000206 HasDwarfAccelTables = DwarfAccelTables == Enable;
Eric Christopher20b76a72012-08-23 22:36:40 +0000207
Eric Christophercdf218d2012-12-10 19:51:21 +0000208 if (SplitDwarf == Default)
209 HasSplitDwarf = false;
Eric Christopher29424312012-11-12 22:22:20 +0000210 else
Eric Christopher574b5c82013-08-19 21:41:38 +0000211 HasSplitDwarf = SplitDwarf == Enable;
Eric Christopher29424312012-11-12 22:22:20 +0000212
Eric Christopher4d36ca02013-08-26 23:24:35 +0000213 if (DwarfPubSections == Default)
214 HasDwarfPubSections = !IsDarwin;
Eric Christopher574b5c82013-08-19 21:41:38 +0000215 else
Eric Christopher4d36ca02013-08-26 23:24:35 +0000216 HasDwarfPubSections = DwarfPubSections == Enable;
Eric Christopher7da24882013-08-19 21:07:38 +0000217
Manman Renac8062b2013-07-02 23:40:10 +0000218 DwarfVersion = getDwarfVersionFromModule(MMI->getModule());
219
Dan Gohman6e681a52010-06-18 15:56:31 +0000220 {
221 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopher58f41952012-11-19 22:42:15 +0000222 beginModule();
Torok Edwinf8dba242010-04-07 10:44:46 +0000223 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000224}
Bill Wendling2f921f82009-05-15 09:23:25 +0000225
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000226// Switch to the specified MCSection and emit an assembler
227// temporary label to it if SymbolStem is specified.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000228static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christophera7b61892011-11-07 09:18:38 +0000229 const char *SymbolStem = 0) {
230 Asm->OutStreamer.SwitchSection(Section);
231 if (!SymbolStem) return 0;
232
233 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
234 Asm->OutStreamer.EmitLabel(TmpSym);
235 return TmpSym;
236}
237
Eric Christophere698f532012-12-20 21:58:36 +0000238MCSymbol *DwarfUnits::getStringPoolSym() {
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000239 return Asm->GetTempSymbol(StringPref);
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000240}
241
Eric Christophere698f532012-12-20 21:58:36 +0000242MCSymbol *DwarfUnits::getStringPoolEntry(StringRef Str) {
243 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopher27614582013-01-08 22:22:06 +0000244 StringPool.GetOrCreateValue(Str).getValue();
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000245 if (Entry.first) return Entry.first;
246
247 Entry.second = NextStringPoolNumber++;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000248 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000249}
250
Eric Christopher2cbd5762013-01-07 19:32:41 +0000251unsigned DwarfUnits::getStringPoolIndex(StringRef Str) {
252 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopher27614582013-01-08 22:22:06 +0000253 StringPool.GetOrCreateValue(Str).getValue();
Eric Christopher2cbd5762013-01-07 19:32:41 +0000254 if (Entry.first) return Entry.second;
255
256 Entry.second = NextStringPoolNumber++;
257 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
258 return Entry.second;
259}
260
David Blaikiedea547b2013-06-28 18:47:14 +0000261unsigned DwarfUnits::getAddrPoolIndex(const MCSymbol *Sym) {
David Blaikie8466ca82013-07-01 23:55:52 +0000262 return getAddrPoolIndex(MCSymbolRefExpr::Create(Sym, Asm->OutContext));
263}
264
Ulrich Weigand8b3d2262013-07-02 18:46:46 +0000265unsigned DwarfUnits::getAddrPoolIndex(const MCExpr *Sym) {
266 std::pair<DenseMap<const MCExpr *, unsigned>::iterator, bool> P =
David Blaikieb8ef7852013-06-28 18:47:19 +0000267 AddressPool.insert(std::make_pair(Sym, NextAddrPoolNumber));
David Blaikiea67de2b2013-06-28 18:55:13 +0000268 if (P.second)
269 ++NextAddrPoolNumber;
David Blaikieb8ef7852013-06-28 18:47:19 +0000270 return P.first->second;
Eric Christopher962c9082013-01-15 23:56:56 +0000271}
272
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000273// Define a unique number for the abbreviation.
274//
Eric Christopherc8a310e2012-12-10 23:34:43 +0000275void DwarfUnits::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000276 // Check the set for priors.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000277 DIEAbbrev *InSet = AbbreviationsSet->GetOrInsertNode(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000278
279 // If it's newly added.
280 if (InSet == &Abbrev) {
281 // Add to abbreviation list.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000282 Abbreviations->push_back(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000283
284 // Assign the vector position + 1 as its number.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000285 Abbrev.setNumber(Abbreviations->size());
Bill Wendling2f921f82009-05-15 09:23:25 +0000286 } else {
287 // Assign existing abbreviation number.
288 Abbrev.setNumber(InSet->getNumber());
289 }
290}
291
Eric Christopherd9843b32011-11-10 19:25:34 +0000292static bool isObjCClass(StringRef Name) {
293 return Name.startswith("+") || Name.startswith("-");
294}
295
296static bool hasObjCCategory(StringRef Name) {
297 if (!isObjCClass(Name)) return false;
298
Benjamin Kramer260de742013-08-24 12:15:54 +0000299 return Name.find(") ") != StringRef::npos;
Eric Christopherd9843b32011-11-10 19:25:34 +0000300}
301
302static void getObjCClassCategory(StringRef In, StringRef &Class,
303 StringRef &Category) {
304 if (!hasObjCCategory(In)) {
305 Class = In.slice(In.find('[') + 1, In.find(' '));
306 Category = "";
307 return;
308 }
309
310 Class = In.slice(In.find('[') + 1, In.find('('));
311 Category = In.slice(In.find('[') + 1, In.find(' '));
312 return;
313}
314
315static StringRef getObjCMethodName(StringRef In) {
316 return In.slice(In.find(' ') + 1, In.find(']'));
317}
318
Richard Mittonc2508242013-10-03 22:07:08 +0000319// Helper for sorting sections into a stable output order.
320static bool SectionSort(const MCSection *A, const MCSection *B) {
321 std::string LA = (A ? A->getLabelBeginName() : "");
322 std::string LB = (B ? B->getLabelBeginName() : "");
323 return LA < LB;
324}
325
Eric Christopherd9843b32011-11-10 19:25:34 +0000326// Add the various names to the Dwarf accelerator table names.
Eric Christopher9cd26af2013-09-20 23:22:52 +0000327// TODO: Determine whether or not we should add names for programs
328// that do not have a DW_AT_name or DW_AT_linkage_name field - this
329// is only slightly different than the lookup of non-standard ObjC names.
Eric Christopherd9843b32011-11-10 19:25:34 +0000330static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
331 DIE* Die) {
332 if (!SP.isDefinition()) return;
Eric Christopherd9843b32011-11-10 19:25:34 +0000333 TheCU->addAccelName(SP.getName(), Die);
334
335 // If the linkage name is different than the name, go ahead and output
336 // that as well into the name table.
337 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
338 TheCU->addAccelName(SP.getLinkageName(), Die);
339
340 // If this is an Objective-C selector name add it to the ObjC accelerator
341 // too.
342 if (isObjCClass(SP.getName())) {
343 StringRef Class, Category;
344 getObjCClassCategory(SP.getName(), Class, Category);
345 TheCU->addAccelObjC(Class, Die);
346 if (Category != "")
347 TheCU->addAccelObjC(Category, Die);
348 // Also add the base method name to the name table.
349 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
350 }
351}
352
Manman Ren3eb9dff2013-09-09 19:05:21 +0000353/// isSubprogramContext - Return true if Context is either a subprogram
354/// or another context nested inside a subprogram.
355bool DwarfDebug::isSubprogramContext(const MDNode *Context) {
356 if (!Context)
357 return false;
358 DIDescriptor D(Context);
359 if (D.isSubprogram())
360 return true;
361 if (D.isType())
Manman Ren116868e2013-09-09 19:47:11 +0000362 return isSubprogramContext(resolve(DIType(Context).getContext()));
Manman Ren3eb9dff2013-09-09 19:05:21 +0000363 return false;
364}
365
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000366// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
367// and DW_AT_high_pc attributes. If there are global variables in this
368// scope then create and insert DIEs for these variables.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000369DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
370 const MDNode *SPNode) {
Eric Christophere595bae2013-10-04 17:08:38 +0000371 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +0000372
Chris Lattner3a383cb2010-04-05 00:13:49 +0000373 assert(SPDie && "Unable to find subprogram DIE!");
374 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000375
Bill Wendlingf720bf62012-11-07 05:19:04 +0000376 // If we're updating an abstract DIE, then we will be adding the children and
377 // object pointer later on. But what we don't want to do is process the
378 // concrete DIE twice.
Eric Christopherc19d6f02013-10-04 19:40:33 +0000379 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
Bill Wendlingf720bf62012-11-07 05:19:04 +0000380 // Pick up abstract subprogram DIE.
Devang Patela37a95e2010-07-07 22:20:57 +0000381 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Manman Ren4c4b69c2013-10-11 23:58:05 +0000382 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin, AbsSPDIE);
Devang Patela37a95e2010-07-07 22:20:57 +0000383 SPCU->addDie(SPDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000384 } else {
385 DISubprogram SPDecl = SP.getFunctionDeclaration();
386 if (!SPDecl.isSubprogram()) {
387 // There is not any need to generate specification DIE for a function
388 // defined at compile unit level. If a function is defined inside another
389 // function then gdb prefers the definition at top level and but does not
390 // expect specification DIE in parent function. So avoid creating
391 // specification DIE for a function defined inside a function.
Manman Renc50fa112013-10-10 18:40:01 +0000392 DIScope SPContext = resolve(SP.getContext());
393 if (SP.isDefinition() && !SPContext.isCompileUnit() &&
394 !SPContext.isFile() &&
395 !isSubprogramContext(SPContext)) {
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000396 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
397
398 // Add arguments.
399 DICompositeType SPTy = SP.getType();
400 DIArray Args = SPTy.getTypeArray();
Eric Christopher31b05762013-08-08 01:41:00 +0000401 uint16_t SPTag = SPTy.getTag();
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000402 if (SPTag == dwarf::DW_TAG_subroutine_type)
403 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
404 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
405 DIType ATy = DIType(Args.getElement(i));
406 SPCU->addType(Arg, ATy);
407 if (ATy.isArtificial())
408 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
409 if (ATy.isObjectPointer())
Manman Ren4c4b69c2013-10-11 23:58:05 +0000410 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer, Arg);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000411 SPDie->addChild(Arg);
412 }
413 DIE *SPDeclDie = SPDie;
414 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Manman Ren4c4b69c2013-10-11 23:58:05 +0000415 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, SPDeclDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000416 SPCU->addDie(SPDie);
417 }
418 }
Devang Patela37a95e2010-07-07 22:20:57 +0000419 }
420
Eric Christopher962c9082013-01-15 23:56:56 +0000421 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc,
422 Asm->GetTempSymbol("func_begin",
423 Asm->getFunctionNumber()));
424 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
425 Asm->GetTempSymbol("func_end",
426 Asm->getFunctionNumber()));
Chris Lattner3a383cb2010-04-05 00:13:49 +0000427 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
428 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000429 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000430
Eric Christopherd9843b32011-11-10 19:25:34 +0000431 // Add name to the name table, we do this here because we're guaranteed
432 // to have concrete versions of our DW_TAG_subprogram nodes.
433 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher6a841382012-11-19 22:42:10 +0000434
Chris Lattner3a383cb2010-04-05 00:13:49 +0000435 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000436}
437
Manman Ren5b2f4b02013-09-11 19:40:28 +0000438/// Check whether we should create a DIE for the given Scope, return true
439/// if we don't create a DIE (the corresponding DIE is null).
Manman Ren2312ed32013-09-10 18:40:41 +0000440bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
441 if (Scope->isAbstractScope())
442 return false;
443
Manman Ren5b2f4b02013-09-11 19:40:28 +0000444 // We don't create a DIE if there is no Range.
Manman Ren2312ed32013-09-10 18:40:41 +0000445 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
446 if (Ranges.empty())
447 return true;
448
449 if (Ranges.size() > 1)
450 return false;
451
Manman Ren5b2f4b02013-09-11 19:40:28 +0000452 // We don't create a DIE if we have a single Range and the end label
453 // is null.
Manman Ren2312ed32013-09-10 18:40:41 +0000454 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
455 MCSymbol *End = getLabelAfterInsn(RI->second);
456 return !End;
457}
458
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000459// Construct new DW_TAG_lexical_block for this scope and attach
460// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher6a841382012-11-19 22:42:10 +0000461DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000462 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000463 if (isLexicalScopeDIENull(Scope))
464 return 0;
465
Devang Patel6c74a872010-04-27 19:46:33 +0000466 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
467 if (Scope->isAbstractScope())
468 return ScopeDIE;
469
Craig Topper977e9cd2013-07-03 04:24:43 +0000470 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Eric Christopherdc42ea82013-07-03 01:57:28 +0000471 // If we have multiple ranges, emit them into the range section.
Devang Patel6c74a872010-04-27 19:46:33 +0000472 if (Ranges.size() > 1) {
473 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000474 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +0000475 // DW_AT_ranges appropriately.
Devang Patelf20c4f72011-04-12 22:53:02 +0000476 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000477 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000478 * Asm->getDataLayout().getPointerSize());
Craig Topperd8e43652013-07-03 04:17:25 +0000479 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +0000480 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +0000481 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
482 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +0000483 }
Eric Christopherc1110832013-07-03 01:22:29 +0000484
485 // Terminate the range list.
Devang Patel6c74a872010-04-27 19:46:33 +0000486 DebugRangeSymbols.push_back(NULL);
487 DebugRangeSymbols.push_back(NULL);
488 return ScopeDIE;
489 }
490
Eric Christopherdc42ea82013-07-03 01:57:28 +0000491 // Construct the address range for this DIE.
Craig Topperd8e43652013-07-03 04:17:25 +0000492 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopher962c9082013-01-15 23:56:56 +0000493 MCSymbol *Start = getLabelBeforeInsn(RI->first);
494 MCSymbol *End = getLabelAfterInsn(RI->second);
Manman Ren2312ed32013-09-10 18:40:41 +0000495 assert(End && "End label should not be null!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000496
Chris Lattnere13c3722010-03-09 01:58:53 +0000497 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
498 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000499
Eric Christopher962c9082013-01-15 23:56:56 +0000500 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
501 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000502
503 return ScopeDIE;
504}
505
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000506// This scope represents inlined body of a function. Construct DIE to
507// represent this concrete inlined copy of the function.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000508DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
509 LexicalScope *Scope) {
Craig Topper977e9cd2013-07-03 04:24:43 +0000510 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000511 assert(Ranges.empty() == false &&
512 "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000513
Devang Patelf098ce22011-07-27 00:34:13 +0000514 if (!Scope->getScopeNode())
515 return NULL;
516 DIScope DS(Scope->getScopeNode());
517 DISubprogram InlinedSP = getDISubprogram(DS);
Eric Christophere595bae2013-10-04 17:08:38 +0000518 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patelf098ce22011-07-27 00:34:13 +0000519 if (!OriginDIE) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000520 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patelf098ce22011-07-27 00:34:13 +0000521 return NULL;
522 }
523
Devang Patel73bc1722011-05-05 17:54:26 +0000524 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Manman Ren4c4b69c2013-10-11 23:58:05 +0000525 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000526
Devang Patelf098ce22011-07-27 00:34:13 +0000527 if (Ranges.size() > 1) {
528 // .debug_range section has not been laid out yet. Emit offset in
529 // .debug_range as a uint, size 4, for now. emitDIE will handle
530 // DW_AT_ranges appropriately.
531 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000532 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000533 * Asm->getDataLayout().getPointerSize());
Craig Topperd8e43652013-07-03 04:17:25 +0000534 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patelf098ce22011-07-27 00:34:13 +0000535 RE = Ranges.end(); RI != RE; ++RI) {
536 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
537 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
538 }
539 DebugRangeSymbols.push_back(NULL);
540 DebugRangeSymbols.push_back(NULL);
541 } else {
Craig Topperd8e43652013-07-03 04:17:25 +0000542 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000543 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
544 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
545
546 if (StartLabel == 0 || EndLabel == 0)
547 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
548
549 assert(StartLabel->isDefined() &&
550 "Invalid starting label for an inlined scope!");
551 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
552
Eric Christopher962c9082013-01-15 23:56:56 +0000553 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
554 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patelf098ce22011-07-27 00:34:13 +0000555 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000556
557 InlinedSubprogramDIEs.insert(OriginDIE);
558
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000559 // Add the call site information to the DIE.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000560 DILocation DL(Scope->getInlinedAt());
David Blaikief2443192013-10-21 17:28:37 +0000561 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, None,
Manman Ren1e427202013-03-07 01:42:00 +0000562 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
563 TheCU->getUniqueID()));
David Blaikief2443192013-10-21 17:28:37 +0000564 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, None, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000565
Eric Christopher8dda5d02011-12-04 06:02:38 +0000566 // Add name to the name table, we do this here because we're guaranteed
567 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
568 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher6a841382012-11-19 22:42:10 +0000569
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000570 return ScopeDIE;
571}
572
Manman Ren2312ed32013-09-10 18:40:41 +0000573DIE *DwarfDebug::createScopeChildrenDIE(CompileUnit *TheCU, LexicalScope *Scope,
574 SmallVectorImpl<DIE*> &Children) {
575 DIE *ObjectPointer = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +0000576
577 // Collect arguments for current function.
Devang Patel7e623022011-08-10 20:55:27 +0000578 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000579 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
580 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher6a841382012-11-19 22:42:10 +0000581 if (DIE *Arg =
Eric Christophere3417762012-09-12 23:36:19 +0000582 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel6c622ef2011-03-01 22:58:55 +0000583 Children.push_back(Arg);
Eric Christophere3417762012-09-12 23:36:19 +0000584 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
585 }
Devang Patel6c622ef2011-03-01 22:58:55 +0000586
Eric Christopherf84354b2011-10-03 15:49:16 +0000587 // Collect lexical scope children first.
Craig Topper977e9cd2013-07-03 04:24:43 +0000588 const SmallVectorImpl<DbgVariable *> &Variables =ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000589 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher6a841382012-11-19 22:42:10 +0000590 if (DIE *Variable =
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000591 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000592 Children.push_back(Variable);
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000593 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
594 }
Craig Topper977e9cd2013-07-03 04:24:43 +0000595 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000596 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Patel3acc70e2011-08-15 22:04:40 +0000597 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000598 Children.push_back(Nested);
Manman Ren2312ed32013-09-10 18:40:41 +0000599 return ObjectPointer;
600}
601
602// Construct a DIE for this scope.
603DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
604 if (!Scope || !Scope->getScopeNode())
605 return NULL;
606
607 DIScope DS(Scope->getScopeNode());
608
609 SmallVector<DIE *, 8> Children;
610 DIE *ObjectPointer = NULL;
611 bool ChildrenCreated = false;
612
Manman Ren5b2f4b02013-09-11 19:40:28 +0000613 // We try to create the scope DIE first, then the children DIEs. This will
614 // avoid creating un-used children then removing them later when we find out
615 // the scope DIE is null.
Devang Patel3b548aa2010-03-08 20:52:55 +0000616 DIE *ScopeDIE = NULL;
617 if (Scope->getInlinedAt())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000618 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3b548aa2010-03-08 20:52:55 +0000619 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000620 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000621 if (Scope->isAbstractScope()) {
Eric Christophere595bae2013-10-04 17:08:38 +0000622 ScopeDIE = TheCU->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000623 // Note down abstract DIE.
624 if (ScopeDIE)
625 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
626 }
Devang Patel3b548aa2010-03-08 20:52:55 +0000627 else
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000628 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3b548aa2010-03-08 20:52:55 +0000629 }
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000630 else {
Manman Ren5b2f4b02013-09-11 19:40:28 +0000631 // Early exit when we know the scope DIE is going to be null.
Manman Ren2312ed32013-09-10 18:40:41 +0000632 if (isLexicalScopeDIENull(Scope))
633 return NULL;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000634
635 // We create children here when we know the scope DIE is not going to be
636 // null and the children will be added to the scope DIE.
Manman Ren2312ed32013-09-10 18:40:41 +0000637 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
638 ChildrenCreated = true;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000639
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000640 // There is no need to emit empty lexical block DIE.
David Blaikie684fc532013-05-06 23:33:07 +0000641 std::pair<ImportedEntityMap::const_iterator,
642 ImportedEntityMap::const_iterator> Range = std::equal_range(
643 ScopesWithImportedEntities.begin(), ScopesWithImportedEntities.end(),
Timur Iskhodzhanovec4afe62013-05-07 07:47:47 +0000644 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode*)0),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000645 less_first());
David Blaikie684fc532013-05-06 23:33:07 +0000646 if (Children.empty() && Range.first == Range.second)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000647 return NULL;
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000648 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Manman Ren2312ed32013-09-10 18:40:41 +0000649 assert(ScopeDIE && "Scope DIE should not be null.");
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000650 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
651 ++i)
David Blaikie4dd2de72013-05-08 06:01:38 +0000652 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000653 }
Eric Christopher6a841382012-11-19 22:42:10 +0000654
Benjamin Kramer892daba2013-08-24 11:55:49 +0000655 if (!ScopeDIE) {
Manman Ren2312ed32013-09-10 18:40:41 +0000656 assert(Children.empty() &&
657 "We create children only when the scope DIE is not null.");
Benjamin Kramer892daba2013-08-24 11:55:49 +0000658 return NULL;
659 }
Manman Ren2312ed32013-09-10 18:40:41 +0000660 if (!ChildrenCreated)
Manman Ren5b2f4b02013-09-11 19:40:28 +0000661 // We create children when the scope DIE is not null.
Manman Ren2312ed32013-09-10 18:40:41 +0000662 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000663
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000664 // Add children
Craig Topperd8e43652013-07-03 04:17:25 +0000665 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000666 E = Children.end(); I != E; ++I)
667 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000668
Eric Christophere3417762012-09-12 23:36:19 +0000669 if (DS.isSubprogram() && ObjectPointer != NULL)
Manman Ren4c4b69c2013-10-11 23:58:05 +0000670 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, ObjectPointer);
Eric Christophere3417762012-09-12 23:36:19 +0000671
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000672 if (DS.isSubprogram())
Eric Christopherd9843b32011-11-10 19:25:34 +0000673 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000674
Eric Christopherd9843b32011-11-10 19:25:34 +0000675 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000676}
677
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000678// Look up the source id with the given directory and source file names.
679// If none currently exists, create a new id and insert it in the
680// SourceIds map. This can update DirectoryNames and SourceFileNames maps
681// as well.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000682unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Manman Ren1e427202013-03-07 01:42:00 +0000683 StringRef DirName, unsigned CUID) {
684 // If we use .loc in assembly, we can't separate .file entries according to
685 // compile units. Thus all files will belong to the default compile unit.
Rafael Espindolaac4ad252013-10-05 16:42:21 +0000686
687 // FIXME: add a better feature test than hasRawTextSupport. Even better,
688 // extend .file to support this.
689 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren1e427202013-03-07 01:42:00 +0000690 CUID = 0;
691
Devang Patel871d0b12010-09-16 20:57:49 +0000692 // If FE did not provide a file name, then assume stdin.
693 if (FileName.empty())
Manman Ren1e427202013-03-07 01:42:00 +0000694 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patele01b75c2011-03-24 20:30:50 +0000695
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000696 // TODO: this might not belong here. See if we can factor this better.
697 if (DirName == CompilationDir)
698 DirName = "";
699
Manman Ren1e427202013-03-07 01:42:00 +0000700 // FileIDCUMap stores the current ID for the given compile unit.
701 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel871d0b12010-09-16 20:57:49 +0000702
Manman Ren1e427202013-03-07 01:42:00 +0000703 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer71b19732012-03-11 14:56:26 +0000704 SmallString<128> NamePair;
Manman Ren5b22f9f2013-04-06 01:02:38 +0000705 NamePair += utostr(CUID);
Manman Ren1e427202013-03-07 01:42:00 +0000706 NamePair += '\0';
Benjamin Kramer71b19732012-03-11 14:56:26 +0000707 NamePair += DirName;
708 NamePair += '\0'; // Zero bytes are not allowed in paths.
709 NamePair += FileName;
710
711 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
712 if (Ent.getValue() != SrcId)
713 return Ent.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +0000714
Manman Ren1e427202013-03-07 01:42:00 +0000715 FileIDCUMap[CUID] = SrcId;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000716 // Print out a .file directive to specify files for .loc directives.
Manman Ren1e427202013-03-07 01:42:00 +0000717 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendling2b128d72009-05-20 23:19:06 +0000718
719 return SrcId;
720}
721
Eric Christopher48fef592012-12-20 21:58:40 +0000722// Create new CompileUnit for the given metadata node with tag
723// DW_TAG_compile_unit.
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000724CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +0000725 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +0000726 StringRef FN = DIUnit.getFilename();
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000727 CompilationDir = DIUnit.getDirectory();
Bill Wendling2b128d72009-05-20 23:19:06 +0000728
729 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopherbfceb2f2013-08-26 23:50:38 +0000730 CompileUnit *NewCU =
731 new CompileUnit(GlobalCUIndexCount++, Die, N, Asm, this, &InfoHolder);
Manman Ren1e427202013-03-07 01:42:00 +0000732
733 FileIDCUMap[NewCU->getUniqueID()] = 0;
734 // Call this to emit a .file directive if it wasn't emitted for the source
735 // file this CU comes from yet.
736 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
737
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000738 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patelf20c4f72011-04-12 22:53:02 +0000739 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
740 DIUnit.getLanguage());
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000741 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christopher52ce7182013-04-09 19:23:15 +0000742
Eric Christopherb1b94512012-08-01 18:19:01 +0000743 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher52ce7182013-04-09 19:23:15 +0000744 // into an entity. We're using 0 (or a NULL label) for this. For
745 // split dwarf it's in the skeleton CU so omit it here.
746 if (!useSplitDwarf())
747 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
Manman Ren4e042a62013-02-05 21:52:47 +0000748
749 // Define start line table label for each Compile Unit.
750 MCSymbol *LineTableStartSym = Asm->GetTempSymbol("line_table_start",
751 NewCU->getUniqueID());
752 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
753 NewCU->getUniqueID());
754
Manman Ren9d4c7352013-05-21 00:57:22 +0000755 // Use a single line table if we are using .loc and generating assembly.
756 bool UseTheFirstCU =
Rafael Espindolaac4ad252013-10-05 16:42:21 +0000757 (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport()) ||
758 (NewCU->getUniqueID() == 0);
Manman Ren9d4c7352013-05-21 00:57:22 +0000759
Eric Christopher52ce7182013-04-09 19:23:15 +0000760 if (!useSplitDwarf()) {
Eric Christophera51d3fc2013-09-27 22:50:48 +0000761 // DW_AT_stmt_list is a offset of line number information for this
762 // compile unit in debug_line section. For split dwarf this is
763 // left in the skeleton CU and so not included.
764 // The line table entries are not always emitted in assembly, so it
765 // is not okay to use line_table_start here.
Eric Christopher52ce7182013-04-09 19:23:15 +0000766 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Carlo Kokbac096a2013-08-13 17:46:57 +0000767 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christophera51d3fc2013-09-27 22:50:48 +0000768 UseTheFirstCU ? Asm->GetTempSymbol("section_line")
769 : LineTableStartSym);
Manman Ren9d4c7352013-05-21 00:57:22 +0000770 else if (UseTheFirstCU)
Eric Christopher52ce7182013-04-09 19:23:15 +0000771 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
772 else
773 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
774 LineTableStartSym, DwarfLineSectionSym);
Eric Christophera51d3fc2013-09-27 22:50:48 +0000775
776 // If we're using split dwarf the compilation dir is going to be in the
777 // skeleton CU and so we don't need to duplicate it here.
778 if (!CompilationDir.empty())
779 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
780
Eric Christopher1d06eb52013-10-01 00:43:31 +0000781 // Flags to let the linker know we have emitted new style pubnames. Only
Eric Christophera51d3fc2013-09-27 22:50:48 +0000782 // emit it here if we don't have a skeleton CU for split dwarf.
Eric Christopher39eebfa2013-09-30 23:14:16 +0000783 if (GenerateGnuPubSections) {
784 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
785 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames,
786 dwarf::DW_FORM_sec_offset,
787 Asm->GetTempSymbol("gnu_pubnames",
788 NewCU->getUniqueID()));
789 else
790 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
791 Asm->GetTempSymbol("gnu_pubnames",
792 NewCU->getUniqueID()),
793 DwarfGnuPubNamesSectionSym);
794
795 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
796 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes,
797 dwarf::DW_FORM_sec_offset,
798 Asm->GetTempSymbol("gnu_pubtypes",
799 NewCU->getUniqueID()));
800 else
801 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopherf976c772013-10-03 17:41:16 +0000802 Asm->GetTempSymbol("gnu_pubtypes",
Eric Christopher39eebfa2013-09-30 23:14:16 +0000803 NewCU->getUniqueID()),
804 DwarfGnuPubTypesSectionSym);
805 }
Eric Christopher52ce7182013-04-09 19:23:15 +0000806 }
Bill Wendling2b128d72009-05-20 23:19:06 +0000807
Bill Wendling2b128d72009-05-20 23:19:06 +0000808 if (DIUnit.isOptimized())
Eric Christopherbb69a272012-08-24 01:14:27 +0000809 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendling2b128d72009-05-20 23:19:06 +0000810
Devang Patel2d9caf92009-11-25 17:36:49 +0000811 StringRef Flags = DIUnit.getFlags();
812 if (!Flags.empty())
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000813 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher6a841382012-11-19 22:42:10 +0000814
Nick Lewycky479a8fe2011-10-17 23:27:36 +0000815 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patelf20c4f72011-04-12 22:53:02 +0000816 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +0000817 dwarf::DW_FORM_data1, RVer);
818
Devang Patel1a0df9a2010-05-10 22:49:55 +0000819 if (!FirstCU)
820 FirstCU = NewCU;
Eric Christopher7a2cdf72013-02-05 07:31:55 +0000821
Eric Christopherc8a310e2012-12-10 23:34:43 +0000822 InfoHolder.addUnit(NewCU);
823
Devang Patel1a0df9a2010-05-10 22:49:55 +0000824 CUMap.insert(std::make_pair(N, NewCU));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000825 return NewCU;
Devang Patel1a0df9a2010-05-10 22:49:55 +0000826}
827
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000828// Construct subprogram DIE.
Eric Christophera6c38a32013-10-15 23:31:38 +0000829void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU, const MDNode *N) {
Eric Christopherffbc4de2013-10-18 01:57:30 +0000830 // FIXME: We should only call this routine once, however, during LTO if a
831 // program is defined in multiple CUs we could end up calling it out of
832 // beginModule as we walk the CUs.
833
834 CompileUnit *&CURef = SPMap[N];
835 if (CURef)
836 return;
837 CURef = TheCU;
Rafael Espindola6cf4e832011-11-04 19:00:29 +0000838
Devang Patel80ae3492009-08-28 23:24:31 +0000839 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000840 if (!SP.isDefinition())
841 // This is a method declaration which will be handled while constructing
842 // class type.
Devang Patel0751a282009-06-26 01:49:18 +0000843 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000844
Devang Patel89543712011-08-15 17:24:54 +0000845 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000846
Eric Christopherba506db2013-09-09 20:03:20 +0000847 // Expose as a global name.
Eric Christopher2c8b7902013-10-17 02:06:06 +0000848 TheCU->addGlobalName(SP.getName(), SubprogramDie, resolve(SP.getContext()));
Bill Wendling2b128d72009-05-20 23:19:06 +0000849}
850
David Blaikie1fd43652013-05-07 21:35:53 +0000851void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikief55abea2013-04-22 06:12:31 +0000852 const MDNode *N) {
David Blaikie1fd43652013-05-07 21:35:53 +0000853 DIImportedEntity Module(N);
David Blaikief55abea2013-04-22 06:12:31 +0000854 if (!Module.Verify())
855 return;
David Blaikie684fc532013-05-06 23:33:07 +0000856 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
David Blaikie4dd2de72013-05-08 06:01:38 +0000857 constructImportedEntityDIE(TheCU, Module, D);
David Blaikie684fc532013-05-06 23:33:07 +0000858}
859
David Blaikie4dd2de72013-05-08 06:01:38 +0000860void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
David Blaikie684fc532013-05-06 23:33:07 +0000861 DIE *Context) {
David Blaikie1fd43652013-05-07 21:35:53 +0000862 DIImportedEntity Module(N);
David Blaikie684fc532013-05-06 23:33:07 +0000863 if (!Module.Verify())
864 return;
David Blaikie4dd2de72013-05-08 06:01:38 +0000865 return constructImportedEntityDIE(TheCU, Module, Context);
David Blaikie684fc532013-05-06 23:33:07 +0000866}
867
David Blaikie4dd2de72013-05-08 06:01:38 +0000868void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikie1fd43652013-05-07 21:35:53 +0000869 const DIImportedEntity &Module,
David Blaikie684fc532013-05-06 23:33:07 +0000870 DIE *Context) {
871 assert(Module.Verify() &&
872 "Use one of the MDNode * overloads to handle invalid metadata");
873 assert(Context && "Should always have a context for an imported_module");
David Blaikie1fd43652013-05-07 21:35:53 +0000874 DIE *IMDie = new DIE(Module.getTag());
David Blaikief55abea2013-04-22 06:12:31 +0000875 TheCU->insertDIE(Module, IMDie);
David Blaikie1fd43652013-05-07 21:35:53 +0000876 DIE *EntityDie;
877 DIDescriptor Entity = Module.getEntity();
878 if (Entity.isNameSpace())
879 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
880 else if (Entity.isSubprogram())
881 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
David Blaikie3b6038b2013-05-08 06:01:41 +0000882 else if (Entity.isType())
883 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
David Blaikie1fd43652013-05-07 21:35:53 +0000884 else
David Blaikie3b6038b2013-05-08 06:01:41 +0000885 EntityDie = TheCU->getDIE(Entity);
David Blaikief55abea2013-04-22 06:12:31 +0000886 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
887 Module.getContext().getDirectory(),
888 TheCU->getUniqueID());
David Blaikief2443192013-10-21 17:28:37 +0000889 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, None, FileID);
890 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, None, Module.getLineNumber());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000891 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, EntityDie);
David Blaikiee63d5d12013-05-20 22:50:35 +0000892 StringRef Name = Module.getName();
893 if (!Name.empty())
894 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
David Blaikie684fc532013-05-06 23:33:07 +0000895 Context->addChild(IMDie);
David Blaikief55abea2013-04-22 06:12:31 +0000896}
897
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000898// Emit all Dwarf sections that should come prior to the content. Create
899// global DIEs and emit initial debug info sections. This is invoked by
900// the target AsmPrinter.
Eric Christopher58f41952012-11-19 22:42:15 +0000901void DwarfDebug::beginModule() {
Devang Patel6c74a872010-04-27 19:46:33 +0000902 if (DisableDebugInfoPrinting)
903 return;
904
Eric Christopher58f41952012-11-19 22:42:15 +0000905 const Module *M = MMI->getModule();
906
Nick Lewycky019d2552011-07-29 03:49:23 +0000907 // If module has named metadata anchors then use them, otherwise scan the
908 // module using debug info finder to collect debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000909 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
David Blaikiedc69ebb2013-03-11 23:39:23 +0000910 if (!CU_Nodes)
Devang Patel07bb9ee2011-08-15 23:47:24 +0000911 return;
Manman Ren60352032013-09-05 18:48:31 +0000912 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
Devang Patele02e5852011-05-03 16:45:22 +0000913
David Blaikiedc69ebb2013-03-11 23:39:23 +0000914 // Emit initial sections so we can reference labels later.
915 emitSectionLabels();
916
917 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
918 DICompileUnit CUNode(CU_Nodes->getOperand(i));
919 CompileUnit *CU = constructCompileUnit(CUNode);
David Blaikie1fd43652013-05-07 21:35:53 +0000920 DIArray ImportedEntities = CUNode.getImportedEntities();
921 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
David Blaikie684fc532013-05-06 23:33:07 +0000922 ScopesWithImportedEntities.push_back(std::make_pair(
David Blaikie1fd43652013-05-07 21:35:53 +0000923 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
924 ImportedEntities.getElement(i)));
David Blaikie684fc532013-05-06 23:33:07 +0000925 std::sort(ScopesWithImportedEntities.begin(),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000926 ScopesWithImportedEntities.end(), less_first());
David Blaikiedc69ebb2013-03-11 23:39:23 +0000927 DIArray GVs = CUNode.getGlobalVariables();
928 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
929 CU->createGlobalVariableDIE(GVs.getElement(i));
930 DIArray SPs = CUNode.getSubprograms();
931 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
932 constructSubprogramDIE(CU, SPs.getElement(i));
933 DIArray EnumTypes = CUNode.getEnumTypes();
934 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
935 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
936 DIArray RetainedTypes = CUNode.getRetainedTypes();
937 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
938 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
David Blaikief55abea2013-04-22 06:12:31 +0000939 // Emit imported_modules last so that the relevant context is already
940 // available.
David Blaikie1fd43652013-05-07 21:35:53 +0000941 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
942 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
David Blaikiedc69ebb2013-03-11 23:39:23 +0000943 }
Eric Christopher6a841382012-11-19 22:42:10 +0000944
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000945 // Tell MMI that we have debug info.
946 MMI->setDebugInfoAvailability(true);
Eric Christopher6a841382012-11-19 22:42:10 +0000947
Bill Wendling2b128d72009-05-20 23:19:06 +0000948 // Prime section data.
Richard Mitton21101b32013-09-19 23:21:01 +0000949 SectionMap[Asm->getObjFileLowering().getTextSection()];
Bill Wendling2b128d72009-05-20 23:19:06 +0000950}
951
Eric Christopher960ac372012-11-22 00:59:49 +0000952// Attach DW_AT_inline attribute with inlined subprogram DIEs.
953void DwarfDebug::computeInlinedDIEs() {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000954 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
955 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000956 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000957 DIE *ISP = *AI;
David Blaikief2443192013-10-21 17:28:37 +0000958 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000959 }
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000960 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000961 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000962 DIE *ISP = AI->second;
963 if (InlinedSubprogramDIEs.count(ISP))
964 continue;
David Blaikief2443192013-10-21 17:28:37 +0000965 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000966 }
Eric Christopher960ac372012-11-22 00:59:49 +0000967}
968
969// Collect info for variables that were optimized out.
970void DwarfDebug::collectDeadVariables() {
971 const Module *M = MMI->getModule();
972 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
973
974 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
975 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
976 DICompileUnit TheCU(CU_Nodes->getOperand(i));
977 DIArray Subprograms = TheCU.getSubprograms();
978 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopher735401c2012-11-27 00:13:51 +0000979 DISubprogram SP(Subprograms.getElement(i));
Eric Christophera6c38a32013-10-15 23:31:38 +0000980 if (ProcessedSPNodes.count(SP) != 0)
981 continue;
982 if (!SP.isSubprogram())
983 continue;
984 if (!SP.isDefinition())
985 continue;
Eric Christopher735401c2012-11-27 00:13:51 +0000986 DIArray Variables = SP.getVariables();
Eric Christophera6c38a32013-10-15 23:31:38 +0000987 if (Variables.getNumElements() == 0)
988 continue;
Eric Christopher960ac372012-11-22 00:59:49 +0000989
Eric Christopher735401c2012-11-27 00:13:51 +0000990 LexicalScope *Scope =
Eric Christophera6c38a32013-10-15 23:31:38 +0000991 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
Eric Christopher735401c2012-11-27 00:13:51 +0000992 DeadFnScopeMap[SP] = Scope;
Eric Christopher960ac372012-11-22 00:59:49 +0000993
Eric Christopher735401c2012-11-27 00:13:51 +0000994 // Construct subprogram DIE and add variables DIEs.
995 CompileUnit *SPCU = CUMap.lookup(TheCU);
996 assert(SPCU && "Unable to find Compile Unit!");
Eric Christopher4d964a52013-10-18 16:56:48 +0000997 // FIXME: See the comment in constructSubprogramDIE about duplicate
998 // subprogram DIEs.
999 constructSubprogramDIE(SPCU, SP);
1000 DIE *SPDIE = SPCU->getDIE(SP);
Eric Christopher735401c2012-11-27 00:13:51 +00001001 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
1002 DIVariable DV(Variables.getElement(vi));
Eric Christophera6c38a32013-10-15 23:31:38 +00001003 if (!DV.isVariable())
1004 continue;
Manman Renb3388602013-10-05 01:43:03 +00001005 DbgVariable NewVar(DV, NULL, this);
Eric Christopher735401c2012-11-27 00:13:51 +00001006 if (DIE *VariableDIE =
Eric Christophera6c38a32013-10-15 23:31:38 +00001007 SPCU->constructVariableDIE(&NewVar, Scope->isAbstractScope()))
1008 SPDIE->addChild(VariableDIE);
Eric Christopher735401c2012-11-27 00:13:51 +00001009 }
Eric Christopher960ac372012-11-22 00:59:49 +00001010 }
1011 }
1012 }
1013 DeleteContainerSeconds(DeadFnScopeMap);
1014}
1015
Eric Christopher45731982013-08-08 23:45:55 +00001016// Type Signature [7.27] and ODR Hash code.
Eric Christopher67646432013-07-26 17:02:41 +00001017
1018/// \brief Grabs the string in whichever attribute is passed in and returns
Eric Christopher8552e222013-08-07 01:18:33 +00001019/// a reference to it. Returns "" if the attribute doesn't exist.
Eric Christopher67646432013-07-26 17:02:41 +00001020static StringRef getDIEStringAttr(DIE *Die, unsigned Attr) {
Eric Christopher8552e222013-08-07 01:18:33 +00001021 DIEValue *V = Die->findAttribute(Attr);
Eric Christopher67646432013-07-26 17:02:41 +00001022
Eric Christopher8552e222013-08-07 01:18:33 +00001023 if (DIEString *S = dyn_cast_or_null<DIEString>(V))
1024 return S->getString();
1025
Eric Christopher67646432013-07-26 17:02:41 +00001026 return StringRef("");
1027}
1028
Eric Christopher67646432013-07-26 17:02:41 +00001029/// Return true if the current DIE is contained within an anonymous namespace.
1030static bool isContainedInAnonNamespace(DIE *Die) {
1031 DIE *Parent = Die->getParent();
1032
1033 while (Parent) {
Eric Christophere414ece2013-07-29 23:53:08 +00001034 if (Parent->getTag() == dwarf::DW_TAG_namespace &&
1035 getDIEStringAttr(Parent, dwarf::DW_AT_name) == "")
Eric Christopher67646432013-07-26 17:02:41 +00001036 return true;
1037 Parent = Parent->getParent();
1038 }
1039
1040 return false;
1041}
1042
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001043/// Test if the current CU language is C++ and that we have
1044/// a named type that is not contained in an anonymous namespace.
1045static bool shouldAddODRHash(CompileUnit *CU, DIE *Die) {
Eric Christopher341770d2013-08-07 08:35:10 +00001046 return CU->getLanguage() == dwarf::DW_LANG_C_plus_plus &&
1047 getDIEStringAttr(Die, dwarf::DW_AT_name) != "" &&
1048 !isContainedInAnonNamespace(Die);
Eric Christopher45731982013-08-08 23:45:55 +00001049}
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001050
Eric Christopher960ac372012-11-22 00:59:49 +00001051void DwarfDebug::finalizeModuleInfo() {
1052 // Collect info for variables that were optimized out.
1053 collectDeadVariables();
1054
1055 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1056 computeInlinedDIEs();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001057
Eric Christopherf8542ec2013-07-29 22:24:32 +00001058 // Split out type units and conditionally add an ODR tag to the split
1059 // out type.
Eric Christopher67646432013-07-26 17:02:41 +00001060 // FIXME: Do type splitting.
1061 for (unsigned i = 0, e = TypeUnits.size(); i != e; ++i) {
Eric Christopher67646432013-07-26 17:02:41 +00001062 DIE *Die = TypeUnits[i];
Eric Christopher45731982013-08-08 23:45:55 +00001063 DIEHash Hash;
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001064 // If we've requested ODR hashes and it's applicable for an ODR hash then
1065 // add the ODR signature now.
Eric Christopher45731982013-08-08 23:45:55 +00001066 // FIXME: This should be added onto the type unit, not the type, but this
1067 // works as an intermediate stage.
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001068 if (GenerateODRHash && shouldAddODRHash(CUMap.begin()->second, Die))
Eric Christopher45731982013-08-08 23:45:55 +00001069 CUMap.begin()->second->addUInt(Die, dwarf::DW_AT_GNU_odr_signature,
1070 dwarf::DW_FORM_data8,
1071 Hash.computeDIEODRSignature(Die));
Eric Christopher67646432013-07-26 17:02:41 +00001072 }
1073
Eric Christopher60eb7692013-08-12 20:27:48 +00001074 // Handle anything that needs to be done on a per-cu basis.
1075 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
1076 CUE = CUMap.end();
1077 CUI != CUE; ++CUI) {
1078 CompileUnit *TheCU = CUI->second;
1079 // Emit DW_AT_containing_type attribute to connect types with their
1080 // vtable holding type.
1081 TheCU->constructContainingTypeDIEs();
1082
1083 // If we're splitting the dwarf out now that we've got the entire
1084 // CU then construct a skeleton CU based upon it.
1085 if (useSplitDwarf()) {
Eric Christopherd29614f2013-08-13 01:21:55 +00001086 uint64_t ID = 0;
1087 if (GenerateCUHash) {
1088 DIEHash CUHash;
1089 ID = CUHash.computeCUSignature(TheCU->getCUDie());
1090 }
Eric Christopher60eb7692013-08-12 20:27:48 +00001091 // This should be a unique identifier when we want to build .dwp files.
1092 TheCU->addUInt(TheCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopherd29614f2013-08-13 01:21:55 +00001093 dwarf::DW_FORM_data8, ID);
Eric Christopher60eb7692013-08-12 20:27:48 +00001094 // Now construct the skeleton CU associated.
Eric Christopher6fdf3242013-08-26 23:50:43 +00001095 CompileUnit *SkCU = constructSkeletonCU(TheCU);
Eric Christopher60eb7692013-08-12 20:27:48 +00001096 // This should be a unique identifier when we want to build .dwp files.
1097 SkCU->addUInt(SkCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopherd29614f2013-08-13 01:21:55 +00001098 dwarf::DW_FORM_data8, ID);
Eric Christopher60eb7692013-08-12 20:27:48 +00001099 }
1100 }
1101
1102 // Compute DIE offsets and sizes.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001103 InfoHolder.computeSizeAndOffsets();
1104 if (useSplitDwarf())
1105 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher960ac372012-11-22 00:59:49 +00001106}
1107
1108void DwarfDebug::endSections() {
Richard Mitton21101b32013-09-19 23:21:01 +00001109 // Filter labels by section.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001110 for (size_t n = 0; n < ArangeLabels.size(); n++) {
1111 const SymbolCU &SCU = ArangeLabels[n];
Richard Mitton21101b32013-09-19 23:21:01 +00001112 if (SCU.Sym->isInSection()) {
1113 // Make a note of this symbol and it's section.
1114 const MCSection *Section = &SCU.Sym->getSection();
1115 if (!Section->getKind().isMetadata())
1116 SectionMap[Section].push_back(SCU);
1117 } else {
1118 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1119 // appear in the output. This sucks as we rely on sections to build
1120 // arange spans. We can do it without, but it's icky.
1121 SectionMap[NULL].push_back(SCU);
1122 }
1123 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001124
Richard Mittonc2508242013-10-03 22:07:08 +00001125 // Build a list of sections used.
1126 std::vector<const MCSection *> Sections;
Richard Mitton21101b32013-09-19 23:21:01 +00001127 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1128 it++) {
1129 const MCSection *Section = it->first;
Richard Mittonc2508242013-10-03 22:07:08 +00001130 Sections.push_back(Section);
1131 }
1132
1133 // Sort the sections into order.
1134 // This is only done to ensure consistent output order across different runs.
1135 std::sort(Sections.begin(), Sections.end(), SectionSort);
1136
1137 // Add terminating symbols for each section.
1138 for (unsigned ID=0;ID<Sections.size();ID++) {
1139 const MCSection *Section = Sections[ID];
Richard Mitton21101b32013-09-19 23:21:01 +00001140 MCSymbol *Sym = NULL;
1141
1142 if (Section) {
Richard Mittonc2508242013-10-03 22:07:08 +00001143 // We can't call MCSection::getLabelEndName, as it's only safe to do so
1144 // if we know the section name up-front. For user-created sections, the resulting
1145 // label may not be valid to use as a label. (section names can use a greater
1146 // set of characters on some systems)
1147 Sym = Asm->GetTempSymbol("debug_end", ID);
Richard Mitton21101b32013-09-19 23:21:01 +00001148 Asm->OutStreamer.SwitchSection(Section);
1149 Asm->OutStreamer.EmitLabel(Sym);
1150 }
1151
1152 // Insert a final terminator.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001153 SectionMap[Section].push_back(SymbolCU(NULL, Sym));
Bill Wendling2b128d72009-05-20 23:19:06 +00001154 }
Eric Christopher960ac372012-11-22 00:59:49 +00001155}
Bill Wendling2b128d72009-05-20 23:19:06 +00001156
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001157// Emit all Dwarf sections that should come after the content.
Eric Christopher960ac372012-11-22 00:59:49 +00001158void DwarfDebug::endModule() {
1159
1160 if (!FirstCU) return;
1161
1162 // End any existing sections.
1163 // TODO: Does this need to happen?
1164 endSections();
1165
1166 // Finalize the debug info for the module.
1167 finalizeModuleInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001168
Eric Christophercdf218d2012-12-10 19:51:21 +00001169 if (!useSplitDwarf()) {
Eric Christopher9cd26af2013-09-20 23:22:52 +00001170 emitDebugStr();
1171
Eric Christopher95198f502012-11-27 22:43:42 +00001172 // Emit all the DIEs into a debug info section.
1173 emitDebugInfo();
Eric Christopher4c9b1192012-11-27 00:41:54 +00001174
Eric Christopher95198f502012-11-27 22:43:42 +00001175 // Corresponding abbreviations into a abbrev section.
1176 emitAbbreviations();
1177
1178 // Emit info into a debug loc section.
1179 emitDebugLoc();
1180
1181 // Emit info into a debug aranges section.
1182 emitDebugARanges();
1183
1184 // Emit info into a debug ranges section.
1185 emitDebugRanges();
1186
1187 // Emit info into a debug macinfo section.
1188 emitDebugMacInfo();
1189
Eric Christopher95198f502012-11-27 22:43:42 +00001190 } else {
Eric Christopherd692c1d2012-12-11 19:42:09 +00001191 // TODO: Fill this in for separated debug sections and separate
Eric Christopher95198f502012-11-27 22:43:42 +00001192 // out information into new sections.
Eric Christopher9cd26af2013-09-20 23:22:52 +00001193 emitDebugStr();
1194 if (useSplitDwarf())
1195 emitDebugStrDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001196
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001197 // Emit the debug info section and compile units.
Eric Christopher95198f502012-11-27 22:43:42 +00001198 emitDebugInfo();
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001199 emitDebugInfoDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001200
1201 // Corresponding abbreviations into a abbrev section.
1202 emitAbbreviations();
Eric Christopher3c5a1912012-12-19 22:02:53 +00001203 emitDebugAbbrevDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001204
1205 // Emit info into a debug loc section.
1206 emitDebugLoc();
1207
1208 // Emit info into a debug aranges section.
1209 emitDebugARanges();
1210
1211 // Emit info into a debug ranges section.
1212 emitDebugRanges();
1213
1214 // Emit info into a debug macinfo section.
1215 emitDebugMacInfo();
1216
Eric Christopher962c9082013-01-15 23:56:56 +00001217 // Emit DWO addresses.
1218 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1219
Eric Christopher95198f502012-11-27 22:43:42 +00001220 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001221
Eric Christophera876b822012-08-23 07:32:06 +00001222 // Emit info into the dwarf accelerator table sections.
Eric Christopher20b76a72012-08-23 22:36:40 +00001223 if (useDwarfAccelTables()) {
Eric Christopher4996c702011-11-07 09:24:32 +00001224 emitAccelNames();
1225 emitAccelObjC();
1226 emitAccelNamespaces();
1227 emitAccelTypes();
1228 }
Eric Christopher6a841382012-11-19 22:42:10 +00001229
Eric Christopher4b358182013-08-30 00:40:17 +00001230 // Emit the pubnames and pubtypes sections if requested.
1231 if (HasDwarfPubSections) {
David Blaikie70a33202013-09-19 17:33:35 +00001232 emitDebugPubNames(GenerateGnuPubSections);
1233 emitDebugPubTypes(GenerateGnuPubSections);
Eric Christopher4b358182013-08-30 00:40:17 +00001234 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001235
Devang Pateld0701282010-08-02 17:32:15 +00001236 // clean up.
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001237 SPMap.clear();
Devang Patel1a0df9a2010-05-10 22:49:55 +00001238 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1239 E = CUMap.end(); I != E; ++I)
1240 delete I->second;
Eric Christopher8afd7b62012-12-10 19:51:18 +00001241
Craig Topperd8e43652013-07-03 04:17:25 +00001242 for (SmallVectorImpl<CompileUnit *>::iterator I = SkeletonCUs.begin(),
Eric Christopher5b33b3c2013-02-06 21:53:56 +00001243 E = SkeletonCUs.end(); I != E; ++I)
1244 delete *I;
Eric Christopher8afd7b62012-12-10 19:51:18 +00001245
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001246 // Reset these for the next Module if we have one.
1247 FirstCU = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001248}
1249
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001250// Find abstract variable, if any, associated with Var.
Devang Patelbb23a4a2011-08-10 21:50:54 +00001251DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattner915c5f92010-04-02 19:42:39 +00001252 DebugLoc ScopeLoc) {
Devang Patelbb23a4a2011-08-10 21:50:54 +00001253 LLVMContext &Ctx = DV->getContext();
1254 // More then one inlined variable corresponds to one abstract variable.
1255 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001256 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001257 if (AbsDbgVariable)
1258 return AbsDbgVariable;
1259
Devang Patel7e623022011-08-10 20:55:27 +00001260 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001261 if (!Scope)
1262 return NULL;
1263
Manman Renb3388602013-10-05 01:43:03 +00001264 AbsDbgVariable = new DbgVariable(Var, NULL, this);
Devang Patel7e623022011-08-10 20:55:27 +00001265 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001266 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001267 return AbsDbgVariable;
1268}
1269
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001270// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel6c622ef2011-03-01 22:58:55 +00001271bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patel7e623022011-08-10 20:55:27 +00001272 DbgVariable *Var, LexicalScope *Scope) {
1273 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +00001274 return false;
1275 DIVariable DV = Var->getVariable();
1276 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1277 return false;
1278 unsigned ArgNo = DV.getArgNumber();
Eric Christopher6a841382012-11-19 22:42:10 +00001279 if (ArgNo == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001280 return false;
1281
Devang Patel4ab660b2011-03-03 20:02:02 +00001282 size_t Size = CurrentFnArguments.size();
1283 if (Size == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001284 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001285 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001286 // arguments does the function have at source level.
1287 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001288 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001289 CurrentFnArguments[ArgNo - 1] = Var;
1290 return true;
1291}
1292
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001293// Collect variable information from side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001294void
Nick Lewycky019d2552011-07-29 03:49:23 +00001295DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patel490c8ab2010-05-20 19:57:06 +00001296 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001297 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1298 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1299 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001300 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001301 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001302 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001303 DIVariable DV(Var);
1304 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001305
Devang Patel7e623022011-08-10 20:55:27 +00001306 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001307
Devang Patelcdb7d442009-11-10 23:20:04 +00001308 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001309 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001310 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001311
Devang Patele1c53f22010-05-20 16:36:41 +00001312 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Manman Renb3388602013-10-05 01:43:03 +00001313 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
Devang Patel3e4a9652011-08-15 21:24:36 +00001314 RegVar->setFrameIndex(VP.first);
Devang Patel6c622ef2011-03-01 22:58:55 +00001315 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001316 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001317 if (AbsDbgVariable)
Devang Patel3e4a9652011-08-15 21:24:36 +00001318 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patel475d32a2009-10-06 01:26:37 +00001319 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001320}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001321
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001322// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1323// defined reg.
Devang Patel9fc11702010-05-25 23:40:22 +00001324static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001325 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001326 return MI->getNumOperands() == 3 &&
1327 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
Adrian Prantl418d1d12013-07-09 20:28:37 +00001328 (MI->getOperand(1).isImm() ||
1329 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
Devang Patel9fc11702010-05-25 23:40:22 +00001330}
1331
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001332// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher6a841382012-11-19 22:42:10 +00001333static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1334 const MCSymbol *FLabel,
Devang Patel2442a892011-07-08 17:09:57 +00001335 const MCSymbol *SLabel,
1336 const MachineInstr *MI) {
1337 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1338
David Blaikie0252265b2013-06-16 20:34:15 +00001339 assert(MI->getNumOperands() == 3);
Adrian Prantl418d1d12013-07-09 20:28:37 +00001340 if (MI->getOperand(0).isReg()) {
Devang Patel2442a892011-07-08 17:09:57 +00001341 MachineLocation MLoc;
Adrian Prantl418d1d12013-07-09 20:28:37 +00001342 // If the second operand is an immediate, this is a
1343 // register-indirect address.
1344 if (!MI->getOperand(1).isImm())
Adrian Prantld4c0dd42013-04-26 21:57:17 +00001345 MLoc.set(MI->getOperand(0).getReg());
1346 else
1347 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel2442a892011-07-08 17:09:57 +00001348 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1349 }
1350 if (MI->getOperand(0).isImm())
1351 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1352 if (MI->getOperand(0).isFPImm())
1353 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1354 if (MI->getOperand(0).isCImm())
1355 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1356
Craig Topperee4dab52012-02-05 08:31:47 +00001357 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel2442a892011-07-08 17:09:57 +00001358}
1359
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001360// Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001361void
Devang Patel5c0f85c2010-06-25 22:07:34 +00001362DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1363 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001364
Eric Christopher270a12c2013-07-03 21:37:03 +00001365 // Grab the variable info that was squirreled away in the MMI side-table.
Devang Patel490c8ab2010-05-20 19:57:06 +00001366 collectVariableInfoFromMMITable(MF, Processed);
1367
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001368 for (SmallVectorImpl<const MDNode*>::const_iterator
1369 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1370 ++UVI) {
1371 const MDNode *Var = *UVI;
1372 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001373 continue;
1374
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001375 // History contains relevant DBG_VALUE instructions for Var and instructions
1376 // clobbering it.
1377 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1378 if (History.empty())
1379 continue;
1380 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001381
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001382 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001383 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001384 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1385 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +00001386 Scope = LScopes.getCurrentFunctionScope();
David Blaikiedc69ebb2013-03-11 23:39:23 +00001387 else if (MDNode *IA = DV.getInlinedAt())
1388 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1389 else
1390 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel490c8ab2010-05-20 19:57:06 +00001391 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001392 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001393 continue;
1394
1395 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001396 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel99819b52011-08-15 19:01:20 +00001397 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
Manman Renb3388602013-10-05 01:43:03 +00001398 DbgVariable *RegVar = new DbgVariable(DV, AbsVar, this);
Devang Patel6c622ef2011-03-01 22:58:55 +00001399 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001400 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001401 if (AbsVar)
Devang Patel3e4a9652011-08-15 21:24:36 +00001402 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001403
Eric Christophercc10d202012-10-08 20:48:54 +00001404 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001405 if (History.size() <= 1 || (History.size() == 2 &&
1406 MInsn->isIdenticalTo(History.back()))) {
Devang Patel3e4a9652011-08-15 21:24:36 +00001407 RegVar->setMInsn(MInsn);
Devang Patel9fc11702010-05-25 23:40:22 +00001408 continue;
1409 }
1410
Eric Christopher59cc0712013-01-28 17:33:26 +00001411 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001412 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001413
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001414 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1415 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1416 const MachineInstr *Begin = *HI;
1417 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001418
Devang Patele7181b52011-06-01 23:00:17 +00001419 // Check if DBG_VALUE is truncating a range.
1420 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1421 && !Begin->getOperand(0).getReg())
1422 continue;
1423
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001424 // Compute the range for a register location.
1425 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1426 const MCSymbol *SLabel = 0;
1427
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001428 if (HI + 1 == HE)
1429 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001430 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001431 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001432 else {
1433 const MachineInstr *End = HI[1];
Eric Christopher6a841382012-11-19 22:42:10 +00001434 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel53b050a2011-07-07 21:44:42 +00001435 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001436 if (End->isDebugValue())
1437 SLabel = getLabelBeforeInsn(End);
1438 else {
1439 // End is a normal instruction clobbering the range.
1440 SLabel = getLabelAfterInsn(End);
1441 assert(SLabel && "Forgot label after clobber instruction");
1442 ++HI;
1443 }
1444 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001445
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001446 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopher365d0832011-12-16 23:42:31 +00001447 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1448 Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001449 }
1450 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001451 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001452
1453 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001454 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1455 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1456 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1457 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001458 if (!DV || !DV.isVariable() || !Processed.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001459 continue;
1460 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001461 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patele0a94bf2010-05-14 21:01:35 +00001462 }
Devang Patel9fc11702010-05-25 23:40:22 +00001463}
Devang Patele0a94bf2010-05-14 21:01:35 +00001464
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001465// Return Label preceding the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001466MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001467 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1468 assert(Label && "Didn't insert label before instruction");
1469 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001470}
1471
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001472// Return Label immediately following the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001473MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001474 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001475}
1476
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001477// Process beginning of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001478void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001479 // Check if source location changes, but ignore DBG_VALUE locations.
1480 if (!MI->isDebugValue()) {
1481 DebugLoc DL = MI->getDebugLoc();
1482 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopheraec8a822012-04-05 20:39:05 +00001483 unsigned Flags = 0;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001484 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001485 if (DL == PrologEndLoc) {
1486 Flags |= DWARF2_FLAG_PROLOGUE_END;
1487 PrologEndLoc = DebugLoc();
1488 }
Eric Christopheraec8a822012-04-05 20:39:05 +00001489 if (PrologEndLoc.isUnknown())
1490 Flags |= DWARF2_FLAG_IS_STMT;
1491
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001492 if (!DL.isUnknown()) {
1493 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001494 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001495 } else
Devang Patel34a66202011-05-11 19:22:19 +00001496 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001497 }
Devang Patel9fc11702010-05-25 23:40:22 +00001498 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001499
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001500 // Insert labels where requested.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001501 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1502 LabelsBeforeInsn.find(MI);
1503
1504 // No label needed.
1505 if (I == LabelsBeforeInsn.end())
1506 return;
1507
1508 // Label already assigned.
1509 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001510 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001511
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001512 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001513 PrevLabel = MMI->getContext().CreateTempSymbol();
1514 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001515 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001516 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001517}
1518
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001519// Process end of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001520void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001521 // Don't create a new label after DBG_VALUE instructions.
1522 // They don't generate code.
1523 if (!MI->isDebugValue())
1524 PrevLabel = 0;
1525
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001526 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1527 LabelsAfterInsn.find(MI);
1528
1529 // No label needed.
1530 if (I == LabelsAfterInsn.end())
1531 return;
1532
1533 // Label already assigned.
1534 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001535 return;
1536
1537 // We need a label after this instruction.
1538 if (!PrevLabel) {
1539 PrevLabel = MMI->getContext().CreateTempSymbol();
1540 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001541 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001542 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001543}
1544
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001545// Each LexicalScope has first instruction and last instruction to mark
1546// beginning and end of a scope respectively. Create an inverse map that list
1547// scopes starts (and ends) with an instruction. One instruction may start (or
1548// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001549void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001550 SmallVector<LexicalScope *, 4> WorkList;
1551 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001552 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001553 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001554
Craig Topper977e9cd2013-07-03 04:24:43 +00001555 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001556 if (!Children.empty())
Craig Topperd8e43652013-07-03 04:17:25 +00001557 for (SmallVectorImpl<LexicalScope *>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00001558 SE = Children.end(); SI != SE; ++SI)
1559 WorkList.push_back(*SI);
1560
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001561 if (S->isAbstractScope())
1562 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001563
Craig Topper977e9cd2013-07-03 04:24:43 +00001564 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001565 if (Ranges.empty())
1566 continue;
Craig Topperd8e43652013-07-03 04:17:25 +00001567 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +00001568 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001569 assert(RI->first && "InsnRange does not have first instruction!");
1570 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001571 requestLabelBeforeInsn(RI->first);
1572 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001573 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001574 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001575}
1576
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001577// Get MDNode for DebugLoc's scope.
Devang Patel589845d2011-05-09 22:14:49 +00001578static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1579 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1580 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1581 return DL.getScope(Ctx);
1582}
1583
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001584// Walk up the scope chain of given debug loc and find line number info
1585// for the function.
Devang Patel34a66202011-05-11 19:22:19 +00001586static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1587 const MDNode *Scope = getScopeNode(DL, Ctx);
1588 DISubprogram SP = getDISubprogram(Scope);
Manman Ren7504ed42013-07-08 18:33:29 +00001589 if (SP.isSubprogram()) {
Eric Christopher34164192012-04-03 00:43:49 +00001590 // Check for number of operands since the compatibility is
1591 // cheap here.
Eric Christopherb81e2b42012-04-03 17:55:42 +00001592 if (SP->getNumOperands() > 19)
Eric Christopher34164192012-04-03 00:43:49 +00001593 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1594 else
1595 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1596 }
1597
Devang Patel34a66202011-05-11 19:22:19 +00001598 return DebugLoc();
1599}
1600
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001601// Gather pre-function debug information. Assumes being called immediately
1602// after the function entry point has been emitted.
Chris Lattner76555b52010-01-26 23:18:02 +00001603void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00001604 if (!MMI->hasDebugInfo()) return;
Devang Patel7e623022011-08-10 20:55:27 +00001605 LScopes.initialize(*MF);
1606 if (LScopes.empty()) return;
1607 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001608
Manman Ren4e042a62013-02-05 21:52:47 +00001609 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1610 // belongs to.
1611 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1612 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1613 assert(TheCU && "Unable to find compile unit!");
Rafael Espindolaac4ad252013-10-05 16:42:21 +00001614 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren9d4c7352013-05-21 00:57:22 +00001615 // Use a single line table if we are using .loc and generating assembly.
1616 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1617 else
1618 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
Manman Ren4e042a62013-02-05 21:52:47 +00001619
Devang Patel6c74a872010-04-27 19:46:33 +00001620 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1621 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001622 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001623 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001624
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001625 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1626
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001627 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001628 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001629 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1630
Devang Patel002d54d2010-05-26 19:37:24 +00001631 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001632 I != E; ++I) {
1633 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001634 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1635 II != IE; ++II) {
1636 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001637
Devang Patel002d54d2010-05-26 19:37:24 +00001638 if (MI->isDebugValue()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001639 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001640
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001641 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001642 const MDNode *Var =
1643 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001644
1645 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001646 if (isDbgValueInDefinedReg(MI))
1647 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1648
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001649 // Check the history of this variable.
1650 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1651 if (History.empty()) {
1652 UserVariables.push_back(Var);
1653 // The first mention of a function argument gets the FunctionBeginSym
1654 // label, so arguments are visible when breaking at function entry.
1655 DIVariable DV(Var);
Manman Ren7504ed42013-07-08 18:33:29 +00001656 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001657 DISubprogram(getDISubprogram(DV.getContext()))
1658 .describes(MF->getFunction()))
1659 LabelsBeforeInsn[MI] = FunctionBeginSym;
1660 } else {
1661 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1662 const MachineInstr *Prev = History.back();
1663 if (Prev->isDebugValue()) {
1664 // Coalesce identical entries at the end of History.
1665 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001666 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher85a495e2012-10-08 20:48:49 +00001667 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher6a841382012-11-19 22:42:10 +00001668 << "\t" << *Prev
Devang Patelb7a328e2011-07-07 00:14:27 +00001669 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001670 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001671 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001672
1673 // Terminate old register assignments that don't reach MI;
1674 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1675 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1676 isDbgValueInDefinedReg(Prev)) {
1677 // Previous register assignment needs to terminate at the end of
1678 // its basic block.
1679 MachineBasicBlock::const_iterator LastMI =
1680 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001681 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001682 // Drop DBG_VALUE for empty range.
Eric Christopher85a495e2012-10-08 20:48:49 +00001683 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patelb7a328e2011-07-07 00:14:27 +00001684 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001685 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001686 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001687 // Terminate after LastMI.
1688 History.push_back(LastMI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001689 }
1690 }
1691 }
1692 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001693 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001694 // Not a DBG_VALUE instruction.
1695 if (!MI->isLabel())
1696 AtBlockEntry = false;
1697
Eric Christopher133195782012-10-04 20:46:14 +00001698 // First known non-DBG_VALUE and non-frame setup location marks
1699 // the beginning of the function body.
1700 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1701 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel34a66202011-05-11 19:22:19 +00001702 PrologEndLoc = MI->getDebugLoc();
1703
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001704 // Check if the instruction clobbers any registers with debug vars.
1705 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1706 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1707 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1708 continue;
Jakob Stoklund Olesen54038d72012-06-01 23:28:30 +00001709 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1710 AI.isValid(); ++AI) {
1711 unsigned Reg = *AI;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001712 const MDNode *Var = LiveUserVar[Reg];
1713 if (!Var)
1714 continue;
1715 // Reg is now clobbered.
1716 LiveUserVar[Reg] = 0;
1717
1718 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001719 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1720 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001721 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001722 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1723 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001724 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001725 const MachineInstr *Prev = History.back();
1726 // Sanity-check: Register assignments are terminated at the end of
1727 // their block.
1728 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1729 continue;
1730 // Is the variable still in Reg?
1731 if (!isDbgValueInDefinedReg(Prev) ||
1732 Prev->getOperand(0).getReg() != Reg)
1733 continue;
1734 // Var is clobbered. Make sure the next instruction gets a label.
1735 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001736 }
1737 }
Devang Patel002d54d2010-05-26 19:37:24 +00001738 }
Devang Patel002d54d2010-05-26 19:37:24 +00001739 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001740 }
1741
1742 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1743 I != E; ++I) {
1744 SmallVectorImpl<const MachineInstr*> &History = I->second;
1745 if (History.empty())
1746 continue;
1747
1748 // Make sure the final register assignments are terminated.
1749 const MachineInstr *Prev = History.back();
1750 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1751 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher6a841382012-11-19 22:42:10 +00001752 MachineBasicBlock::const_iterator LastMI =
Devang Patel784077e2011-08-10 23:58:09 +00001753 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001754 if (LastMI == PrevMBB->end())
1755 // Drop DBG_VALUE for empty range.
1756 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001757 else if (PrevMBB != &PrevMBB->getParent()->back()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001758 // Terminate after LastMI.
1759 History.push_back(LastMI);
1760 }
1761 }
1762 // Request labels for the full history.
1763 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1764 const MachineInstr *MI = History[i];
1765 if (MI->isDebugValue())
1766 requestLabelBeforeInsn(MI);
1767 else
1768 requestLabelAfterInsn(MI);
1769 }
1770 }
Devang Patel002d54d2010-05-26 19:37:24 +00001771
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001772 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001773 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001774
1775 // Record beginning of function.
1776 if (!PrologEndLoc.isUnknown()) {
1777 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1778 MF->getFunction()->getContext());
1779 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1780 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie67cb31e2012-12-04 22:02:33 +00001781 // We'd like to list the prologue as "not statements" but GDB behaves
1782 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikie5a773bb2012-12-04 21:05:36 +00001783 DWARF2_FLAG_IS_STMT);
Devang Patel34a66202011-05-11 19:22:19 +00001784 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001785}
1786
Devang Patel7e623022011-08-10 20:55:27 +00001787void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
David Blaikie6f1a8062013-06-05 05:39:59 +00001788 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1789 DIVariable DV = Var->getVariable();
David Blaikie36d5d2f2013-06-06 21:04:51 +00001790 // Variables with positive arg numbers are parameters.
1791 if (unsigned ArgNum = DV.getArgNumber()) {
1792 // Keep all parameters in order at the start of the variable list to ensure
1793 // function types are correct (no out-of-order parameters)
1794 //
1795 // This could be improved by only doing it for optimized builds (unoptimized
1796 // builds have the right order to begin with), searching from the back (this
1797 // would catch the unoptimized case quickly), or doing a binary search
1798 // rather than linear search.
1799 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1800 while (I != Vars.end()) {
1801 unsigned CurNum = (*I)->getVariable().getArgNumber();
1802 // A local (non-parameter) variable has been found, insert immediately
1803 // before it.
1804 if (CurNum == 0)
1805 break;
1806 // A later indexed parameter has been found, insert immediately before it.
David Blaikieb272a752013-06-06 22:28:26 +00001807 if (CurNum > ArgNum)
David Blaikie36d5d2f2013-06-06 21:04:51 +00001808 break;
David Blaikieb272a752013-06-06 22:28:26 +00001809 ++I;
David Blaikie6f1a8062013-06-05 05:39:59 +00001810 }
David Blaikie36d5d2f2013-06-06 21:04:51 +00001811 Vars.insert(I, Var);
1812 return;
David Blaikie6f1a8062013-06-05 05:39:59 +00001813 }
1814
1815 Vars.push_back(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001816}
1817
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001818// Gather and emit post-function debug information.
Chris Lattner76555b52010-01-26 23:18:02 +00001819void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patel7e623022011-08-10 20:55:27 +00001820 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00001821
Devang Patel7e623022011-08-10 20:55:27 +00001822 // Define end label for subprogram.
1823 FunctionEndSym = Asm->GetTempSymbol("func_end",
1824 Asm->getFunctionNumber());
1825 // Assumes in correct section after the entry point.
1826 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Manman Ren4e042a62013-02-05 21:52:47 +00001827 // Set DwarfCompileUnitID in MCContext to default value.
1828 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher6a841382012-11-19 22:42:10 +00001829
Devang Patel7e623022011-08-10 20:55:27 +00001830 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1831 collectVariableInfo(MF, ProcessedVars);
Eric Christopher6a841382012-11-19 22:42:10 +00001832
Devang Patel3acc70e2011-08-15 22:04:40 +00001833 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001834 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001835 assert(TheCU && "Unable to find compile unit!");
Devang Patel3acc70e2011-08-15 22:04:40 +00001836
Devang Patel7e623022011-08-10 20:55:27 +00001837 // Construct abstract scopes.
Devang Patel44403472011-08-12 18:10:19 +00001838 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1839 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1840 LexicalScope *AScope = AList[i];
1841 DISubprogram SP(AScope->getScopeNode());
Manman Ren7504ed42013-07-08 18:33:29 +00001842 if (SP.isSubprogram()) {
Devang Patel7e623022011-08-10 20:55:27 +00001843 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001844 DIArray Variables = SP.getVariables();
1845 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1846 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001847 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001848 continue;
Alexey Samsonov39602782012-07-06 08:45:08 +00001849 // Check that DbgVariable for DV wasn't created earlier, when
1850 // findAbstractVariable() was called for inlined instance of DV.
1851 LLVMContext &Ctx = DV->getContext();
1852 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1853 if (AbstractVariables.lookup(CleanDV))
1854 continue;
Devang Patel59e27c52011-08-19 23:28:12 +00001855 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001856 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001857 }
1858 }
Devang Patel44403472011-08-12 18:10:19 +00001859 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Manman Ren4213c392013-05-29 17:16:59 +00001860 constructScopeDIE(TheCU, AScope);
Bill Wendling2b128d72009-05-20 23:19:06 +00001861 }
Eric Christopher6a841382012-11-19 22:42:10 +00001862
Devang Patel3acc70e2011-08-15 22:04:40 +00001863 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher6a841382012-11-19 22:42:10 +00001864
Nick Lewycky50f02cb2011-12-02 22:16:29 +00001865 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopherbb69a272012-08-24 01:14:27 +00001866 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Patel3acc70e2011-08-15 22:04:40 +00001867
Bill Wendling2b128d72009-05-20 23:19:06 +00001868 // Clear debug info
Craig Topper2b4a2012013-07-03 04:40:27 +00001869 for (ScopeVariablesMap::iterator
Devang Patel7e623022011-08-10 20:55:27 +00001870 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1871 DeleteContainerPointers(I->second);
1872 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001873 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001874 UserVariables.clear();
1875 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001876 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001877 LabelsBeforeInsn.clear();
1878 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001879 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001880}
1881
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001882// Register a source line with debug info. Returns the unique label that was
1883// emitted and which provides correspondence to the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00001884void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1885 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00001886 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00001887 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00001888 unsigned Src = 1;
1889 if (S) {
1890 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00001891
Dan Gohman50849c62010-05-05 23:41:32 +00001892 if (Scope.isCompileUnit()) {
1893 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001894 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001895 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00001896 } else if (Scope.isFile()) {
1897 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00001898 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001899 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001900 } else if (Scope.isSubprogram()) {
1901 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001902 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001903 Dir = SP.getDirectory();
Eric Christopher6647b832011-10-11 22:59:11 +00001904 } else if (Scope.isLexicalBlockFile()) {
1905 DILexicalBlockFile DBF(S);
1906 Fn = DBF.getFilename();
1907 Dir = DBF.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001908 } else if (Scope.isLexicalBlock()) {
1909 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001910 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001911 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001912 } else
Craig Topperee4dab52012-02-05 08:31:47 +00001913 llvm_unreachable("Unexpected scope info");
Dan Gohman50849c62010-05-05 23:41:32 +00001914
Manman Ren1e427202013-03-07 01:42:00 +00001915 Src = getOrCreateSourceID(Fn, Dir,
1916 Asm->OutStreamer.getContext().getDwarfCompileUnitID());
Dan Gohman50849c62010-05-05 23:41:32 +00001917 }
Nick Lewycky019d2552011-07-29 03:49:23 +00001918 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00001919}
1920
Bill Wendling806535f2009-05-20 23:22:40 +00001921//===----------------------------------------------------------------------===//
1922// Emit Methods
1923//===----------------------------------------------------------------------===//
1924
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001925// Compute the size and offset of a DIE.
Jim Grosbach00e9c612009-11-22 19:20:36 +00001926unsigned
Eric Christopherc8a310e2012-12-10 23:34:43 +00001927DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling480ff322009-05-20 23:21:38 +00001928 // Get the children.
1929 const std::vector<DIE *> &Children = Die->getChildren();
1930
Bill Wendling480ff322009-05-20 23:21:38 +00001931 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00001932 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00001933
1934 // Get the abbreviation for this DIE.
1935 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopherc8a310e2012-12-10 23:34:43 +00001936 const DIEAbbrev *Abbrev = Abbreviations->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00001937
1938 // Set DIE offset
1939 Die->setOffset(Offset);
1940
1941 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00001942 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001943
Eric Christopher4887c8f2013-03-29 23:34:06 +00001944 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1945 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling480ff322009-05-20 23:21:38 +00001946
1947 // Size the DIE attribute values.
1948 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1949 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001950 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001951
1952 // Size the DIE children if any.
1953 if (!Children.empty()) {
1954 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1955 "Children flag not set");
1956
1957 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001958 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling480ff322009-05-20 23:21:38 +00001959
1960 // End of children marker.
1961 Offset += sizeof(int8_t);
1962 }
1963
1964 Die->setSize(Offset - Die->getOffset());
1965 return Offset;
1966}
1967
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001968// Compute the size and offset of all the DIEs.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001969void DwarfUnits::computeSizeAndOffsets() {
Manman Ren14a029d2013-03-12 18:27:15 +00001970 // Offset from the beginning of debug info section.
Eric Christopher4887c8f2013-03-29 23:34:06 +00001971 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopherc8a310e2012-12-10 23:34:43 +00001972 E = CUs.end(); I != E; ++I) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001973 unsigned Offset =
1974 sizeof(int32_t) + // Length of Compilation Unit Info
1975 sizeof(int16_t) + // DWARF version number
1976 sizeof(int32_t) + // Offset Into Abbrev. Section
1977 sizeof(int8_t); // Pointer Size (in bytes)
Eric Christopherc19d6f02013-10-04 19:40:33 +00001978 computeSizeAndOffset((*I)->getCUDie(), Offset);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001979 }
Bill Wendling480ff322009-05-20 23:21:38 +00001980}
1981
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001982// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001983void DwarfDebug::emitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001984 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001985
Bill Wendling480ff322009-05-20 23:21:38 +00001986 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001987 DwarfInfoSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001988 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001989 DwarfAbbrevSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001990 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher3c5a1912012-12-19 22:02:53 +00001991 if (useSplitDwarf())
1992 DwarfAbbrevDWOSectionSym =
1993 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1994 "section_abbrev_dwo");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001995 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001996
Chris Lattner6629ca92010-04-04 22:59:04 +00001997 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001998 emitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00001999
Eric Christopher74804332013-02-07 21:19:50 +00002000 DwarfLineSectionSym =
2001 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002002 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Eric Christopher261d2342013-09-23 20:55:35 +00002003 if (GenerateGnuPubSections) {
Eric Christopher39eebfa2013-09-30 23:14:16 +00002004 DwarfGnuPubNamesSectionSym =
2005 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
2006 DwarfGnuPubTypesSectionSym =
2007 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
Eric Christopher261d2342013-09-23 20:55:35 +00002008 } else if (HasDwarfPubSections) {
2009 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2010 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Michael Gottesmanc89466f2013-09-04 04:39:38 +00002011 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002012
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002013 DwarfStrSectionSym =
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002014 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002015 if (useSplitDwarf()) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002016 DwarfStrDWOSectionSym =
2017 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002018 DwarfAddrSectionSym =
2019 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
2020 }
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002021 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patel12563b32010-04-16 23:33:45 +00002022 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00002023
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002024 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patel9fc11702010-05-25 23:40:22 +00002025 "section_debug_loc");
2026
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002027 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
2028 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002029}
2030
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002031// Recursively emits a debug information entry.
Eric Christopher3c5a1912012-12-19 22:02:53 +00002032void DwarfDebug::emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs) {
Bill Wendling480ff322009-05-20 23:21:38 +00002033 // Get the abbreviation for this DIE.
2034 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher3c5a1912012-12-19 22:02:53 +00002035 const DIEAbbrev *Abbrev = Abbrevs->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00002036
Bill Wendling480ff322009-05-20 23:21:38 +00002037 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00002038 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00002039 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2040 Twine::utohexstr(Die->getOffset()) + ":0x" +
2041 Twine::utohexstr(Die->getSize()) + " " +
2042 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00002043 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00002044
Eric Christopher4887c8f2013-03-29 23:34:06 +00002045 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
2046 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling480ff322009-05-20 23:21:38 +00002047
2048 // Emit the DIE attribute values.
2049 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
David Blaikief2443192013-10-21 17:28:37 +00002050 dwarf::Attribute Attr = AbbrevData[i].getAttribute();
2051 dwarf::Form Form = AbbrevData[i].getForm();
Bill Wendling480ff322009-05-20 23:21:38 +00002052 assert(Form && "Too many attributes for DIE (check abbreviation)");
2053
Chris Lattner7bde8c02010-04-04 18:52:31 +00002054 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00002055 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002056
Bill Wendling480ff322009-05-20 23:21:38 +00002057 switch (Attr) {
Eric Christophere595bae2013-10-04 17:08:38 +00002058 case dwarf::DW_AT_abstract_origin: {
Bill Wendling480ff322009-05-20 23:21:38 +00002059 DIEEntry *E = cast<DIEEntry>(Values[i]);
2060 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002061 unsigned Addr = Origin->getOffset();
Eric Christopherc19d6f02013-10-04 19:40:33 +00002062 Asm->EmitInt32(Addr);
Bill Wendling480ff322009-05-20 23:21:38 +00002063 break;
2064 }
Devang Patel12563b32010-04-16 23:33:45 +00002065 case dwarf::DW_AT_ranges: {
2066 // DW_AT_range Value encodes offset in debug_range section.
2067 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00002068
Nick Lewycky33da3362012-06-22 01:25:12 +00002069 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelda3ef852010-09-02 16:43:44 +00002070 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
2071 V->getValue(),
2072 4);
2073 } else {
2074 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
2075 V->getValue(),
2076 DwarfDebugRangeSectionSym,
2077 4);
2078 }
Devang Patel12563b32010-04-16 23:33:45 +00002079 break;
2080 }
Devang Patel9fc11702010-05-25 23:40:22 +00002081 case dwarf::DW_AT_location: {
Nick Lewycky33da3362012-06-22 01:25:12 +00002082 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2083 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002084 Asm->EmitLabelReference(L->getValue(), 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002085 else
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002086 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002087 } else {
Devang Patel9fc11702010-05-25 23:40:22 +00002088 Values[i]->EmitValue(Asm, Form);
Nick Lewycky33da3362012-06-22 01:25:12 +00002089 }
Devang Patel9fc11702010-05-25 23:40:22 +00002090 break;
2091 }
Devang Patela1bd5a12010-09-29 19:08:08 +00002092 case dwarf::DW_AT_accessibility: {
2093 if (Asm->isVerbose()) {
2094 DIEInteger *V = cast<DIEInteger>(Values[i]);
2095 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2096 }
2097 Values[i]->EmitValue(Asm, Form);
2098 break;
2099 }
Bill Wendling480ff322009-05-20 23:21:38 +00002100 default:
2101 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002102 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00002103 break;
2104 }
Bill Wendling480ff322009-05-20 23:21:38 +00002105 }
2106
2107 // Emit the DIE children if any.
2108 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2109 const std::vector<DIE *> &Children = Die->getChildren();
2110
2111 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher3c5a1912012-12-19 22:02:53 +00002112 emitDIE(Children[j], Abbrevs);
Bill Wendling480ff322009-05-20 23:21:38 +00002113
Chris Lattner7bde8c02010-04-04 18:52:31 +00002114 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00002115 Asm->OutStreamer.AddComment("End Of Children Mark");
2116 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00002117 }
2118}
2119
Eric Christophera2de8262012-12-15 00:04:07 +00002120// Emit the various dwarf units to the unit section USection with
2121// the abbreviations going into ASection.
2122void DwarfUnits::emitUnits(DwarfDebug *DD,
2123 const MCSection *USection,
2124 const MCSection *ASection,
2125 const MCSymbol *ASectionSym) {
2126 Asm->OutStreamer.SwitchSection(USection);
Eric Christopher4887c8f2013-03-29 23:34:06 +00002127 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christophera2de8262012-12-15 00:04:07 +00002128 E = CUs.end(); I != E; ++I) {
2129 CompileUnit *TheCU = *I;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002130 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002131
Devang Patel1a0df9a2010-05-10 22:49:55 +00002132 // Emit the compile units header.
Eric Christophera2de8262012-12-15 00:04:07 +00002133 Asm->OutStreamer
2134 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
2135 TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002136
Devang Patel1a0df9a2010-05-10 22:49:55 +00002137 // Emit size of content not including length itself
2138 unsigned ContentSize = Die->getSize() +
2139 sizeof(int16_t) + // DWARF version number
2140 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patele141234942011-04-13 19:41:17 +00002141 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002142
Devang Patel1a0df9a2010-05-10 22:49:55 +00002143 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2144 Asm->EmitInt32(ContentSize);
2145 Asm->OutStreamer.AddComment("DWARF version number");
Manman Renac8062b2013-07-02 23:40:10 +00002146 Asm->EmitInt16(DD->getDwarfVersion());
Devang Patel1a0df9a2010-05-10 22:49:55 +00002147 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
Eric Christophera2de8262012-12-15 00:04:07 +00002148 Asm->EmitSectionOffset(Asm->GetTempSymbol(ASection->getLabelBeginName()),
2149 ASectionSym);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002150 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002151 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002152
Eric Christopher3c5a1912012-12-19 22:02:53 +00002153 DD->emitDIE(Die, Abbreviations);
Eric Christophera2de8262012-12-15 00:04:07 +00002154 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
Eli Benderskyb42d1462012-12-03 18:45:45 +00002155 TheCU->getUniqueID()));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002156 }
Bill Wendling480ff322009-05-20 23:21:38 +00002157}
2158
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002159// Emit the debug info section.
2160void DwarfDebug::emitDebugInfo() {
Eric Christophera2de8262012-12-15 00:04:07 +00002161 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2162
2163 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
2164 Asm->getObjFileLowering().getDwarfAbbrevSection(),
2165 DwarfAbbrevSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002166}
2167
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002168// Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +00002169void DwarfDebug::emitAbbreviations() {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002170 if (!useSplitDwarf())
2171 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
2172 &Abbreviations);
2173 else
2174 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2175}
Bill Wendling480ff322009-05-20 23:21:38 +00002176
Eric Christopher3c5a1912012-12-19 22:02:53 +00002177void DwarfDebug::emitAbbrevs(const MCSection *Section,
2178 std::vector<DIEAbbrev *> *Abbrevs) {
2179 // Check to see if it is worth the effort.
2180 if (!Abbrevs->empty()) {
2181 // Start the debug abbrev section.
2182 Asm->OutStreamer.SwitchSection(Section);
2183
2184 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
Eric Christopher996b2b72012-12-13 03:00:38 +00002185 Asm->OutStreamer.EmitLabel(Begin);
Bill Wendling480ff322009-05-20 23:21:38 +00002186
2187 // For each abbrevation.
Eric Christopher3c5a1912012-12-19 22:02:53 +00002188 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
Bill Wendling480ff322009-05-20 23:21:38 +00002189 // Get abbreviation data
Eric Christopher3c5a1912012-12-19 22:02:53 +00002190 const DIEAbbrev *Abbrev = Abbrevs->at(i);
Bill Wendling480ff322009-05-20 23:21:38 +00002191
2192 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00002193 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00002194
2195 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002196 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00002197 }
2198
2199 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00002200 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00002201
Eric Christopher3c5a1912012-12-19 22:02:53 +00002202 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
Eric Christopher996b2b72012-12-13 03:00:38 +00002203 Asm->OutStreamer.EmitLabel(End);
Bill Wendling480ff322009-05-20 23:21:38 +00002204 }
2205}
2206
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002207// Emit the last address of the section and the end of the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +00002208void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00002209 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00002210 Asm->OutStreamer.AddComment("Extended Op");
2211 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002212
Chris Lattner566cae92010-03-09 23:52:58 +00002213 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002214 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00002215 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2216 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2217
2218 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002219
Chris Lattnera179b522010-04-04 19:25:43 +00002220 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Eric Christopherce0cfce2013-01-09 01:35:34 +00002221 Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002222
2223 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00002224 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2225 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002226 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00002227 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002228}
2229
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002230// Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00002231void DwarfDebug::emitAccelNames() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002232 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002233 dwarf::DW_FORM_data4));
2234 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2235 E = CUMap.end(); I != E; ++I) {
2236 CompileUnit *TheCU = I->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00002237 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2238 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002239 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002240 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002241 const std::vector<DIE *> &Entities = GI->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00002242 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2243 DE = Entities.end(); DI != DE; ++DI)
2244 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00002245 }
2246 }
2247
2248 AT.FinalizeTable(Asm, "Names");
2249 Asm->OutStreamer.SwitchSection(
2250 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2251 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2252 Asm->OutStreamer.EmitLabel(SectionBegin);
2253
2254 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002255 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002256}
2257
Eric Christopher48fef592012-12-20 21:58:40 +00002258// Emit objective C classes and categories into a hashed accelerator table
2259// section.
Eric Christopher4996c702011-11-07 09:24:32 +00002260void DwarfDebug::emitAccelObjC() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002261 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002262 dwarf::DW_FORM_data4));
2263 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2264 E = CUMap.end(); I != E; ++I) {
2265 CompileUnit *TheCU = I->second;
2266 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2267 for (StringMap<std::vector<DIE*> >::const_iterator
2268 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002269 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002270 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher4996c702011-11-07 09:24:32 +00002271 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2272 DE = Entities.end(); DI != DE; ++DI)
2273 AT.AddName(Name, (*DI));
2274 }
2275 }
2276
2277 AT.FinalizeTable(Asm, "ObjC");
2278 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2279 .getDwarfAccelObjCSection());
2280 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2281 Asm->OutStreamer.EmitLabel(SectionBegin);
2282
2283 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002284 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002285}
2286
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002287// Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002288void DwarfDebug::emitAccelNamespaces() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002289 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002290 dwarf::DW_FORM_data4));
2291 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2292 E = CUMap.end(); I != E; ++I) {
2293 CompileUnit *TheCU = I->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00002294 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2295 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002296 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002297 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002298 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00002299 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2300 DE = Entities.end(); DI != DE; ++DI)
2301 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00002302 }
2303 }
2304
2305 AT.FinalizeTable(Asm, "namespac");
2306 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2307 .getDwarfAccelNamespaceSection());
2308 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2309 Asm->OutStreamer.EmitLabel(SectionBegin);
2310
2311 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002312 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002313}
2314
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002315// Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002316void DwarfDebug::emitAccelTypes() {
Eric Christopher21bde872012-01-06 04:35:23 +00002317 std::vector<DwarfAccelTable::Atom> Atoms;
Eric Christophercf7289f2013-09-05 18:20:16 +00002318 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher21bde872012-01-06 04:35:23 +00002319 dwarf::DW_FORM_data4));
Eric Christophercf7289f2013-09-05 18:20:16 +00002320 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag,
Eric Christopher21bde872012-01-06 04:35:23 +00002321 dwarf::DW_FORM_data2));
Eric Christophercf7289f2013-09-05 18:20:16 +00002322 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags,
Eric Christopher21bde872012-01-06 04:35:23 +00002323 dwarf::DW_FORM_data1));
2324 DwarfAccelTable AT(Atoms);
Eric Christopher4996c702011-11-07 09:24:32 +00002325 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2326 E = CUMap.end(); I != E; ++I) {
2327 CompileUnit *TheCU = I->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002328 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2329 = TheCU->getAccelTypes();
2330 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002331 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002332 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002333 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002334 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2335 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2336 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher4996c702011-11-07 09:24:32 +00002337 }
2338 }
2339
2340 AT.FinalizeTable(Asm, "types");
2341 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2342 .getDwarfAccelTypesSection());
2343 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2344 Asm->OutStreamer.EmitLabel(SectionBegin);
2345
2346 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002347 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002348}
2349
Eric Christopherdd1a0122013-09-13 00:35:05 +00002350// Public name handling.
2351// The format for the various pubnames:
2352//
2353// dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2354// for the DIE that is named.
2355//
2356// gnu pubnames - offset/index value/name tuples where the offset is the offset
2357// into the CU and the index value is computed according to the type of value
2358// for the DIE that is named.
2359//
2360// For type units the offset is the offset of the skeleton DIE. For split dwarf
2361// it's the offset within the debug_info/debug_types dwo section, however, the
2362// reference in the pubname header doesn't change.
2363
2364/// computeIndexValue - Compute the gdb index value for the DIE and CU.
David Blaikie8dec4072013-09-19 20:40:26 +00002365static dwarf::PubIndexEntryDescriptor computeIndexValue(CompileUnit *CU,
2366 DIE *Die) {
Eric Christopherd2b497b2013-10-16 01:37:49 +00002367 dwarf::GDBIndexEntryLinkage Linkage = dwarf::GIEL_STATIC;
2368
2369 // We could have a specification DIE that has our most of our knowledge,
2370 // look for that now.
2371 DIEValue *SpecVal = Die->findAttribute(dwarf::DW_AT_specification);
2372 if (SpecVal) {
2373 DIE *SpecDIE = cast<DIEEntry>(SpecVal)->getEntry();
2374 if (SpecDIE->findAttribute(dwarf::DW_AT_external))
2375 Linkage = dwarf::GIEL_EXTERNAL;
2376 } else if (Die->findAttribute(dwarf::DW_AT_external))
2377 Linkage = dwarf::GIEL_EXTERNAL;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002378
2379 switch (Die->getTag()) {
2380 case dwarf::DW_TAG_class_type:
2381 case dwarf::DW_TAG_structure_type:
2382 case dwarf::DW_TAG_union_type:
2383 case dwarf::DW_TAG_enumeration_type:
Eric Christopher261d2342013-09-23 20:55:35 +00002384 return dwarf::PubIndexEntryDescriptor(
2385 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2386 ? dwarf::GIEL_STATIC
2387 : dwarf::GIEL_EXTERNAL);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002388 case dwarf::DW_TAG_typedef:
2389 case dwarf::DW_TAG_base_type:
2390 case dwarf::DW_TAG_subrange_type:
David Blaikie8dec4072013-09-19 20:40:26 +00002391 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002392 case dwarf::DW_TAG_namespace:
David Blaikie8dec4072013-09-19 20:40:26 +00002393 return dwarf::GIEK_TYPE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002394 case dwarf::DW_TAG_subprogram:
Eric Christopherccac5c42013-09-23 22:59:14 +00002395 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002396 case dwarf::DW_TAG_constant:
2397 case dwarf::DW_TAG_variable:
Eric Christopherccac5c42013-09-23 22:59:14 +00002398 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002399 case dwarf::DW_TAG_enumerator:
David Blaikie8dec4072013-09-19 20:40:26 +00002400 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2401 dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002402 default:
David Blaikie8dec4072013-09-19 20:40:26 +00002403 return dwarf::GIEK_NONE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002404 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002405}
2406
Eric Christopher5f93bb92013-09-09 20:03:17 +00002407/// emitDebugPubNames - Emit visible names into a debug pubnames section.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002408///
Eric Christopherdd1a0122013-09-13 00:35:05 +00002409void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002410 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christopherdd1a0122013-09-13 00:35:05 +00002411 const MCSection *PSec =
2412 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2413 : Asm->getObjFileLowering().getDwarfPubNamesSection();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002414
2415 typedef DenseMap<const MDNode*, CompileUnit*> CUMapType;
2416 for (CUMapType::iterator I = CUMap.begin(), E = CUMap.end(); I != E; ++I) {
2417 CompileUnit *TheCU = I->second;
2418 unsigned ID = TheCU->getUniqueID();
2419
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002420 // Start the dwarf pubnames section.
Eric Christopher13b99d22013-09-10 21:49:37 +00002421 Asm->OutStreamer.SwitchSection(PSec);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002422
Eric Christopher39eebfa2013-09-30 23:14:16 +00002423 // Emit a label so we can reference the beginning of this pubname section.
2424 if (GnuStyle)
2425 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames",
2426 TheCU->getUniqueID()));
2427
Eric Christopherdd1a0122013-09-13 00:35:05 +00002428 // Emit the header.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002429 Asm->OutStreamer.AddComment("Length of Public Names Info");
2430 Asm->EmitLabelDifference(Asm->GetTempSymbol("pubnames_end", ID),
2431 Asm->GetTempSymbol("pubnames_begin", ID), 4);
2432
2433 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin", ID));
2434
2435 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002436 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002437
2438 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2439 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2440 DwarfInfoSectionSym);
2441
2442 Asm->OutStreamer.AddComment("Compilation Unit Length");
2443 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(), ID),
2444 Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2445 4);
2446
Eric Christopherdd1a0122013-09-13 00:35:05 +00002447 // Emit the pubnames for this compilation unit.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002448 const StringMap<DIE*> &Globals = TheCU->getGlobalNames();
2449 for (StringMap<DIE*>::const_iterator
2450 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2451 const char *Name = GI->getKeyData();
Eric Christopherdd1a0122013-09-13 00:35:05 +00002452 DIE *Entity = GI->second;
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002453
2454 Asm->OutStreamer.AddComment("DIE offset");
2455 Asm->EmitInt32(Entity->getOffset());
2456
Eric Christopherdd1a0122013-09-13 00:35:05 +00002457 if (GnuStyle) {
David Blaikied0a869d2013-09-19 22:19:37 +00002458 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2459 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002460 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002461 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002462 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002463 }
2464
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002465 if (Asm->isVerbose())
2466 Asm->OutStreamer.AddComment("External Name");
Rafael Espindola64e1af82013-07-02 15:49:13 +00002467 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002468 }
2469
2470 Asm->OutStreamer.AddComment("End Mark");
2471 Asm->EmitInt32(0);
2472 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end", ID));
2473 }
2474}
2475
Eric Christopherdd1a0122013-09-13 00:35:05 +00002476void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
Eric Christopher8b3737f2013-09-13 00:34:58 +00002477 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christopher261d2342013-09-23 20:55:35 +00002478 const MCSection *PSec =
2479 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2480 : Asm->getObjFileLowering().getDwarfPubTypesSection();
Eric Christopher8b3737f2013-09-13 00:34:58 +00002481
Devang Patel1a0df9a2010-05-10 22:49:55 +00002482 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
Eric Christopher8b3737f2013-09-13 00:34:58 +00002483 E = CUMap.end();
2484 I != E; ++I) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002485 CompileUnit *TheCU = I->second;
Eric Christopher6abc9c52011-11-07 09:18:35 +00002486 // Start the dwarf pubtypes section.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002487 Asm->OutStreamer.SwitchSection(PSec);
Eric Christopher39eebfa2013-09-30 23:14:16 +00002488
2489 // Emit a label so we can reference the beginning of this pubtype section.
2490 if (GnuStyle)
2491 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes",
2492 TheCU->getUniqueID()));
2493
2494 // Emit the header.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002495 Asm->OutStreamer.AddComment("Length of Public Types Info");
2496 Asm->EmitLabelDifference(
Eric Christopher8b3737f2013-09-13 00:34:58 +00002497 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2498 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002499
Eric Christopher8b3737f2013-09-13 00:34:58 +00002500 Asm->OutStreamer.EmitLabel(
2501 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002502
Eric Christopher8b3737f2013-09-13 00:34:58 +00002503 if (Asm->isVerbose())
2504 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002505 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002506
Devang Patel1a0df9a2010-05-10 22:49:55 +00002507 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002508 Asm->EmitSectionOffset(
2509 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()),
2510 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002511
Devang Patel1a0df9a2010-05-10 22:49:55 +00002512 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002513 Asm->EmitLabelDifference(
2514 Asm->GetTempSymbol(ISec->getLabelEndName(), TheCU->getUniqueID()),
2515 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002516
Eric Christopher39eebfa2013-09-30 23:14:16 +00002517 // Emit the pubtypes.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002518 const StringMap<DIE *> &Globals = TheCU->getGlobalTypes();
2519 for (StringMap<DIE *>::const_iterator GI = Globals.begin(),
2520 GE = Globals.end();
2521 GI != GE; ++GI) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002522 const char *Name = GI->getKeyData();
Nick Lewycky019d2552011-07-29 03:49:23 +00002523 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002524
Eric Christopher8b3737f2013-09-13 00:34:58 +00002525 if (Asm->isVerbose())
2526 Asm->OutStreamer.AddComment("DIE offset");
Devang Patel1a0df9a2010-05-10 22:49:55 +00002527 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002528
Eric Christopherdd1a0122013-09-13 00:35:05 +00002529 if (GnuStyle) {
David Blaikied0a869d2013-09-19 22:19:37 +00002530 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2531 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002532 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002533 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002534 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002535 }
2536
Eric Christopher8b3737f2013-09-13 00:34:58 +00002537 if (Asm->isVerbose())
2538 Asm->OutStreamer.AddComment("External Name");
2539
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002540 // Emit the name with a terminating null byte.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002541 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002542 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002543
Devang Patel1a0df9a2010-05-10 22:49:55 +00002544 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002545 Asm->EmitInt32(0);
Eric Christopher8b3737f2013-09-13 00:34:58 +00002546 Asm->OutStreamer.EmitLabel(
2547 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00002548 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002549}
2550
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002551// Emit strings into a string section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002552void DwarfUnits::emitStrings(const MCSection *StrSection,
2553 const MCSection *OffsetSection = NULL,
2554 const MCSymbol *StrSecSym = NULL) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002555
Eric Christopher27614582013-01-08 22:22:06 +00002556 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002557
Chris Lattner3d72a672010-03-09 23:38:23 +00002558 // Start the dwarf str section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002559 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling480ff322009-05-20 23:21:38 +00002560
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002561 // Get all of the string pool entries and put them in an array by their ID so
2562 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002563 SmallVector<std::pair<unsigned,
Eric Christopherb800ff72013-01-07 22:40:45 +00002564 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002565
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002566 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
Eric Christopher27614582013-01-08 22:22:06 +00002567 I = StringPool.begin(), E = StringPool.end();
Eric Christopher48fef592012-12-20 21:58:40 +00002568 I != E; ++I)
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002569 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002570
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002571 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002572
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002573 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002574 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002575 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002576
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002577 // Emit the string itself with a terminating null byte.
Benjamin Kramer148db362011-11-09 12:12:04 +00002578 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
Eric Christopherce0cfce2013-01-09 01:35:34 +00002579 Entries[i].second->getKeyLength()+1));
Bill Wendling480ff322009-05-20 23:21:38 +00002580 }
Eric Christopher2cbd5762013-01-07 19:32:41 +00002581
2582 // If we've got an offset section go ahead and emit that now as well.
2583 if (OffsetSection) {
2584 Asm->OutStreamer.SwitchSection(OffsetSection);
2585 unsigned offset = 0;
Eric Christopher962c9082013-01-15 23:56:56 +00002586 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002587 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopherbf7bc492013-01-09 03:52:05 +00002588 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopher2cbd5762013-01-07 19:32:41 +00002589 offset += Entries[i].second->getKeyLength() + 1;
2590 }
2591 }
Bill Wendling480ff322009-05-20 23:21:38 +00002592}
2593
Eric Christopher962c9082013-01-15 23:56:56 +00002594// Emit strings into a string section.
2595void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2596
2597 if (AddressPool.empty()) return;
2598
2599 // Start the dwarf addr section.
2600 Asm->OutStreamer.SwitchSection(AddrSection);
2601
David Blaikiece1960f2013-07-08 17:51:28 +00002602 // Order the address pool entries by ID
David Blaikieac569a62013-07-08 17:33:10 +00002603 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher962c9082013-01-15 23:56:56 +00002604
David Blaikiece1960f2013-07-08 17:51:28 +00002605 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2606 E = AddressPool.end();
Eric Christopher962c9082013-01-15 23:56:56 +00002607 I != E; ++I)
David Blaikieac569a62013-07-08 17:33:10 +00002608 Entries[I->second] = I->first;
Eric Christopher962c9082013-01-15 23:56:56 +00002609
2610 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002611 // Emit an expression for reference from debug information entries.
David Blaikieac569a62013-07-08 17:33:10 +00002612 if (const MCExpr *Expr = Entries[i])
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002613 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
Eric Christopher962c9082013-01-15 23:56:56 +00002614 else
2615 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2616 }
2617
2618}
2619
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002620// Emit visible names into a debug str section.
2621void DwarfDebug::emitDebugStr() {
2622 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2623 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2624}
2625
Eric Christopher9046f942013-07-02 21:36:07 +00002626// Emit locations into the debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002627void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002628 if (DotDebugLocEntries.empty())
2629 return;
2630
Eric Christopher4887c8f2013-03-29 23:34:06 +00002631 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Devang Patel116a9d72011-02-04 22:57:18 +00002632 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2633 I != E; ++I) {
2634 DotDebugLocEntry &Entry = *I;
2635 if (I + 1 != DotDebugLocEntries.end())
2636 Entry.Merge(I+1);
2637 }
2638
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002639 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002640 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00002641 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002642 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002643 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2644 unsigned index = 1;
Eric Christopher4887c8f2013-03-29 23:34:06 +00002645 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002646 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002647 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002648 DotDebugLocEntry &Entry = *I;
2649 if (Entry.isMerged()) continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002650 if (Entry.isEmpty()) {
Eric Christopherce0cfce2013-01-09 01:35:34 +00002651 Asm->OutStreamer.EmitIntValue(0, Size);
2652 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002653 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002654 } else {
Eric Christopher25f06422013-07-03 22:40:18 +00002655 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2656 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2657 DIVariable DV(Entry.getVariable());
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002658 Asm->OutStreamer.AddComment("Loc expr size");
2659 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2660 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2661 Asm->EmitLabelDifference(end, begin, 2);
2662 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002663 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002664 DIBasicType BTy(DV.getType());
2665 if (BTy.Verify() &&
Eric Christopher6a841382012-11-19 22:42:10 +00002666 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patel324f8432011-06-01 22:03:25 +00002667 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2668 Asm->OutStreamer.AddComment("DW_OP_consts");
2669 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002670 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002671 } else {
2672 Asm->OutStreamer.AddComment("DW_OP_constu");
2673 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002674 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002675 }
Devang Pateled9fd452011-07-08 16:49:43 +00002676 } else if (Entry.isLocation()) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002677 MachineLocation Loc = Entry.getLoc();
Eric Christopher6a841382012-11-19 22:42:10 +00002678 if (!DV.hasComplexAddress())
Devang Pateled9fd452011-07-08 16:49:43 +00002679 // Regular entry.
Eric Christopher614a89f2013-07-03 22:40:21 +00002680 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002681 else {
2682 // Complex address entry.
2683 unsigned N = DV.getNumAddrElements();
2684 unsigned i = 0;
2685 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002686 if (Loc.getOffset()) {
Devang Pateled9fd452011-07-08 16:49:43 +00002687 i = 2;
Eric Christopher614a89f2013-07-03 22:40:21 +00002688 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002689 Asm->OutStreamer.AddComment("DW_OP_deref");
2690 Asm->EmitInt8(dwarf::DW_OP_deref);
2691 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2692 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2693 Asm->EmitSLEB128(DV.getAddrElement(1));
2694 } else {
2695 // If first address element is OpPlus then emit
2696 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher614a89f2013-07-03 22:40:21 +00002697 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2698 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002699 i = 2;
2700 }
2701 } else {
Eric Christopher614a89f2013-07-03 22:40:21 +00002702 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002703 }
Eric Christopher6a841382012-11-19 22:42:10 +00002704
Devang Pateled9fd452011-07-08 16:49:43 +00002705 // Emit remaining complex address elements.
2706 for (; i < N; ++i) {
2707 uint64_t Element = DV.getAddrElement(i);
2708 if (Element == DIBuilder::OpPlus) {
2709 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2710 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher4d250522012-05-08 18:56:00 +00002711 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002712 if (!Loc.isReg())
Eric Christopher4d250522012-05-08 18:56:00 +00002713 Asm->EmitInt8(dwarf::DW_OP_deref);
2714 } else
2715 llvm_unreachable("unknown Opcode found in complex address");
Devang Pateled9fd452011-07-08 16:49:43 +00002716 }
Devang Patel3e021532011-04-28 02:22:40 +00002717 }
Devang Patel3e021532011-04-28 02:22:40 +00002718 }
Devang Pateled9fd452011-07-08 16:49:43 +00002719 // else ... ignore constant fp. There is not any good way to
2720 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002721 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002722 }
2723 }
Bill Wendling480ff322009-05-20 23:21:38 +00002724}
2725
Richard Mitton21101b32013-09-19 23:21:01 +00002726struct SymbolCUSorter {
2727 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2728 const MCStreamer &Streamer;
2729
2730 bool operator() (const SymbolCU &A, const SymbolCU &B) {
2731 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2732 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2733
2734 // Symbols with no order assigned should be placed at the end.
2735 // (e.g. section end labels)
2736 if (IA == 0)
2737 IA = (unsigned)(-1);
2738 if (IB == 0)
2739 IB = (unsigned)(-1);
2740 return IA < IB;
2741 }
2742};
2743
Richard Mitton21101b32013-09-19 23:21:01 +00002744static bool CUSort(const CompileUnit *A, const CompileUnit *B) {
2745 return (A->getUniqueID() < B->getUniqueID());
2746}
2747
2748struct ArangeSpan {
2749 const MCSymbol *Start, *End;
2750};
2751
2752// Emit a debug aranges section, containing a CU lookup for any
2753// address we can tie back to a CU.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002754void DwarfDebug::emitDebugARanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002755 // Start the dwarf aranges section.
Eric Christopherac8199b2013-08-30 00:39:57 +00002756 Asm->OutStreamer
2757 .SwitchSection(Asm->getObjFileLowering().getDwarfARangesSection());
Richard Mitton21101b32013-09-19 23:21:01 +00002758
2759 typedef DenseMap<CompileUnit *, std::vector<ArangeSpan> > SpansType;
2760
2761 SpansType Spans;
2762
2763 // Build a list of sections used.
2764 std::vector<const MCSection *> Sections;
2765 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2766 it++) {
2767 const MCSection *Section = it->first;
2768 Sections.push_back(Section);
2769 }
2770
2771 // Sort the sections into order.
2772 // This is only done to ensure consistent output order across different runs.
2773 std::sort(Sections.begin(), Sections.end(), SectionSort);
2774
2775 // Build a set of address spans, sorted by CU.
2776 for (size_t SecIdx=0;SecIdx<Sections.size();SecIdx++) {
2777 const MCSection *Section = Sections[SecIdx];
2778 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2779 if (List.size() < 2)
2780 continue;
2781
2782 // Sort the symbols by offset within the section.
2783 SymbolCUSorter sorter(Asm->OutStreamer);
2784 std::sort(List.begin(), List.end(), sorter);
2785
2786 // If we have no section (e.g. common), just write out
2787 // individual spans for each symbol.
2788 if (Section == NULL) {
2789 for (size_t n = 0; n < List.size(); n++) {
2790 const SymbolCU &Cur = List[n];
2791
2792 ArangeSpan Span;
2793 Span.Start = Cur.Sym;
2794 Span.End = NULL;
2795 if (Cur.CU)
2796 Spans[Cur.CU].push_back(Span);
2797 }
2798 } else {
2799 // Build spans between each label.
2800 const MCSymbol *StartSym = List[0].Sym;
2801 for (size_t n = 1; n < List.size(); n++) {
2802 const SymbolCU &Prev = List[n - 1];
2803 const SymbolCU &Cur = List[n];
2804
2805 // Try and build the longest span we can within the same CU.
2806 if (Cur.CU != Prev.CU) {
2807 ArangeSpan Span;
2808 Span.Start = StartSym;
2809 Span.End = Cur.Sym;
2810 Spans[Prev.CU].push_back(Span);
2811 StartSym = Cur.Sym;
2812 }
2813 }
2814 }
2815 }
2816
2817 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2818 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2819
2820 // Build a list of CUs used.
2821 std::vector<CompileUnit *> CUs;
2822 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
2823 CompileUnit *CU = it->first;
2824 CUs.push_back(CU);
2825 }
2826
2827 // Sort the CU list (again, to ensure consistent output order).
2828 std::sort(CUs.begin(), CUs.end(), CUSort);
2829
2830 // Emit an arange table for each CU we used.
2831 for (size_t CUIdx=0;CUIdx<CUs.size();CUIdx++) {
2832 CompileUnit *CU = CUs[CUIdx];
2833 std::vector<ArangeSpan> &List = Spans[CU];
2834
2835 // Emit size of content not including length itself.
2836 unsigned ContentSize
2837 = sizeof(int16_t) // DWARF ARange version number
2838 + sizeof(int32_t) // Offset of CU in the .debug_info section
2839 + sizeof(int8_t) // Pointer Size (in bytes)
2840 + sizeof(int8_t); // Segment Size (in bytes)
2841
2842 unsigned TupleSize = PtrSize * 2;
2843
2844 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2845 unsigned Padding = 0;
2846 while (((sizeof(int32_t) + ContentSize + Padding) % TupleSize) != 0)
2847 Padding++;
2848
2849 ContentSize += Padding;
2850 ContentSize += (List.size() + 1) * TupleSize;
2851
2852 // For each compile unit, write the list of spans it covers.
2853 Asm->OutStreamer.AddComment("Length of ARange Set");
2854 Asm->EmitInt32(ContentSize);
2855 Asm->OutStreamer.AddComment("DWARF Arange version number");
2856 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2857 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
2858 Asm->EmitSectionOffset(
2859 Asm->GetTempSymbol(ISec->getLabelBeginName(), CU->getUniqueID()),
2860 DwarfInfoSectionSym);
2861 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2862 Asm->EmitInt8(PtrSize);
2863 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2864 Asm->EmitInt8(0);
2865
2866 for (unsigned n = 0; n < Padding; n++)
2867 Asm->EmitInt8(0xff);
2868
2869 for (unsigned n = 0; n < List.size(); n++) {
2870 const ArangeSpan &Span = List[n];
2871 Asm->EmitLabelReference(Span.Start, PtrSize);
2872
2873 // Calculate the size as being from the span start to it's end.
Richard Mitton089ed892013-09-23 17:56:20 +00002874 if (Span.End) {
Richard Mitton21101b32013-09-19 23:21:01 +00002875 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
Richard Mitton089ed892013-09-23 17:56:20 +00002876 } else {
2877 // For symbols without an end marker (e.g. common), we
2878 // write a single arange entry containing just that one symbol.
2879 uint64_t Size = SymSize[Span.Start];
2880 if (Size == 0)
2881 Size = 1;
2882
2883 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2884 }
Richard Mitton21101b32013-09-19 23:21:01 +00002885 }
2886
2887 Asm->OutStreamer.AddComment("ARange terminator");
2888 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2889 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2890 }
Bill Wendling480ff322009-05-20 23:21:38 +00002891}
2892
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002893// Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002894void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002895 // Start the dwarf ranges section.
Eric Christopherac8199b2013-08-30 00:39:57 +00002896 Asm->OutStreamer
2897 .SwitchSection(Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002898 unsigned char Size = Asm->getDataLayout().getPointerSize();
Eric Christopher4887c8f2013-03-29 23:34:06 +00002899 for (SmallVectorImpl<const MCSymbol *>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002900 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00002901 I != E; ++I) {
2902 if (*I)
Eric Christopherbf7bc492013-01-09 03:52:05 +00002903 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
Devang Patel12563b32010-04-16 23:33:45 +00002904 else
Eric Christopherce0cfce2013-01-09 01:35:34 +00002905 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel12563b32010-04-16 23:33:45 +00002906 }
Bill Wendling480ff322009-05-20 23:21:38 +00002907}
2908
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002909// Emit visible names into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002910void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002911 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00002912 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00002913 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002914 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00002915 }
2916}
2917
Eric Christopherd692c1d2012-12-11 19:42:09 +00002918// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002919
2920// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2921// 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 +00002922// DW_AT_ranges_base, DW_AT_addr_base.
Eric Christopher6fdf3242013-08-26 23:50:43 +00002923CompileUnit *DwarfDebug::constructSkeletonCU(const CompileUnit *CU) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002924
2925 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher6fdf3242013-08-26 23:50:43 +00002926 CompileUnit *NewCU = new CompileUnit(CU->getUniqueID(), Die, CU->getNode(),
2927 Asm, this, &SkeletonHolder);
Eric Christopher4c7765f2013-01-17 03:00:04 +00002928
Eric Christopherdae389b2013-02-22 23:50:08 +00002929 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
Eric Christopher6b16b432013-08-26 23:57:03 +00002930 DICompileUnit(CU->getNode()).getSplitDebugFilename());
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002931
Eric Christopher44c6aa62013-04-22 07:51:08 +00002932 // Relocate to the beginning of the addr_base section, else 0 for the
2933 // beginning of the one for this compile unit.
Eric Christopher55863be2013-04-07 03:43:09 +00002934 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2935 NewCU->addLabel(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2936 DwarfAddrSectionSym);
2937 else
Eric Christopher44c6aa62013-04-22 07:51:08 +00002938 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base,
2939 dwarf::DW_FORM_sec_offset, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002940
2941 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher962c9082013-01-15 23:56:56 +00002942 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002943 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher962c9082013-01-15 23:56:56 +00002944
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002945 // DW_AT_stmt_list is a offset of line number information for this
2946 // compile unit in debug_line section.
Eric Christopher55863be2013-04-07 03:43:09 +00002947 // FIXME: Should handle multiple compile units.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002948 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher4c7765f2013-01-17 03:00:04 +00002949 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher74804332013-02-07 21:19:50 +00002950 DwarfLineSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002951 else
Eric Christopher4c7765f2013-01-17 03:00:04 +00002952 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002953
2954 if (!CompilationDir.empty())
Eric Christopher2cbd5762013-01-07 19:32:41 +00002955 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002956
Eric Christopher1d06eb52013-10-01 00:43:31 +00002957 // Flags to let the linker know we have emitted new style pubnames.
Eric Christopher39eebfa2013-09-30 23:14:16 +00002958 if (GenerateGnuPubSections) {
2959 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2960 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_sec_offset,
2961 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()));
2962 else
2963 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
2964 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()),
2965 DwarfGnuPubNamesSectionSym);
2966
2967 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2968 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_sec_offset,
2969 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()));
2970 else
2971 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopherf976c772013-10-03 17:41:16 +00002972 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()),
Eric Christopher39eebfa2013-09-30 23:14:16 +00002973 DwarfGnuPubTypesSectionSym);
2974 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002975
Eric Christopher9a08f9e2013-10-01 00:43:36 +00002976 // Flag if we've emitted any ranges and their location for the compile unit.
2977 if (DebugRangeSymbols.size()) {
2978 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2979 NewCU->addLabel(Die, dwarf::DW_AT_GNU_ranges_base,
2980 dwarf::DW_FORM_sec_offset, DwarfDebugRangeSectionSym);
2981 else
2982 NewCU->addUInt(Die, dwarf::DW_AT_GNU_ranges_base, dwarf::DW_FORM_data4,
2983 0);
2984 }
2985
Eric Christopherc8a310e2012-12-10 23:34:43 +00002986 SkeletonHolder.addUnit(NewCU);
Eric Christopher5b33b3c2013-02-06 21:53:56 +00002987 SkeletonCUs.push_back(NewCU);
Eric Christopherc8a310e2012-12-10 23:34:43 +00002988
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002989 return NewCU;
2990}
2991
Eric Christopher3c5a1912012-12-19 22:02:53 +00002992void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
2993 assert(useSplitDwarf() && "No split dwarf debug info?");
2994 emitAbbrevs(Section, &SkeletonAbbrevs);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002995}
2996
Eric Christopherd692c1d2012-12-11 19:42:09 +00002997// Emit the .debug_info.dwo section for separated dwarf. This contains the
2998// compile units that would normally be in debug_info.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002999void DwarfDebug::emitDebugInfoDWO() {
Eric Christophercdf218d2012-12-10 19:51:21 +00003000 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christophera2de8262012-12-15 00:04:07 +00003001 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
Eric Christopher3c5a1912012-12-19 22:02:53 +00003002 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
3003 DwarfAbbrevDWOSectionSym);
3004}
3005
3006// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
3007// abbreviations for the .debug_info.dwo section.
3008void DwarfDebug::emitDebugAbbrevDWO() {
3009 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopher48fef592012-12-20 21:58:40 +00003010 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
3011 &Abbreviations);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00003012}
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003013
3014// Emit the .debug_str.dwo section for separated dwarf. This contains the
3015// string section and is identical in format to traditional .debug_str
3016// sections.
3017void DwarfDebug::emitDebugStrDWO() {
3018 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherb800ff72013-01-07 22:40:45 +00003019 const MCSection *OffSec = Asm->getObjFileLowering()
3020 .getDwarfStrOffDWOSection();
Eric Christopher2cbd5762013-01-07 19:32:41 +00003021 const MCSymbol *StrSym = DwarfStrSectionSym;
3022 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
3023 OffSec, StrSym);
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003024}