blob: 71838bdd6944fea55a760c761b58495783800e29 [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
Nick Lewycky019d2552011-07-29 03:49:23 +0000119DIType DbgVariable::getType() const {
Devang Patelf20c4f72011-04-12 22:53:02 +0000120 DIType Ty = Var.getType();
121 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
122 // addresses instead.
123 if (Var.isBlockByrefVariable()) {
124 /* Byref variables, in Blocks, are declared by the programmer as
125 "SomeType VarName;", but the compiler creates a
126 __Block_byref_x_VarName struct, and gives the variable VarName
127 either the struct, or a pointer to the struct, as its type. This
128 is necessary for various behind-the-scenes things the compiler
129 needs to do with by-reference variables in blocks.
Eric Christopher6a841382012-11-19 22:42:10 +0000130
Devang Patelf20c4f72011-04-12 22:53:02 +0000131 However, as far as the original *programmer* is concerned, the
132 variable should still have type 'SomeType', as originally declared.
Eric Christopher6a841382012-11-19 22:42:10 +0000133
Devang Patelf20c4f72011-04-12 22:53:02 +0000134 The following function dives into the __Block_byref_x_VarName
135 struct to find the original type of the variable. This will be
136 passed back to the code generating the type for the Debug
137 Information Entry for the variable 'VarName'. 'VarName' will then
138 have the original type 'SomeType' in its debug information.
Eric Christopher6a841382012-11-19 22:42:10 +0000139
Devang Patelf20c4f72011-04-12 22:53:02 +0000140 The original type 'SomeType' will be the type of the field named
141 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher6a841382012-11-19 22:42:10 +0000142
Devang Patelf20c4f72011-04-12 22:53:02 +0000143 NOTE: In order for this to not completely fail on the debugger
144 side, the Debug Information Entry for the variable VarName needs to
145 have a DW_AT_location that tells the debugger how to unwind through
146 the pointers and __Block_byref_x_VarName struct to find the actual
147 value of the variable. The function addBlockByrefType does this. */
148 DIType subType = Ty;
Eric Christopher31b05762013-08-08 01:41:00 +0000149 uint16_t tag = Ty.getTag();
Eric Christopher6a841382012-11-19 22:42:10 +0000150
Eric Christopher9adc55f2013-09-04 19:53:21 +0000151 if (tag == dwarf::DW_TAG_pointer_type)
Manman Renb3388602013-10-05 01:43:03 +0000152 subType = DD->resolve(DIDerivedType(Ty).getTypeDerivedFrom());
Eric Christopher6a841382012-11-19 22:42:10 +0000153
Eric Christopher9adc55f2013-09-04 19:53:21 +0000154 DIArray Elements = DICompositeType(subType).getTypeArray();
Devang Patelf20c4f72011-04-12 22:53:02 +0000155 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
Eric Christopher9adc55f2013-09-04 19:53:21 +0000156 DIDerivedType DT = DIDerivedType(Elements.getElement(i));
Devang Patelf20c4f72011-04-12 22:53:02 +0000157 if (getName() == DT.getName())
Manman Renb3388602013-10-05 01:43:03 +0000158 return (DD->resolve(DT.getTypeDerivedFrom()));
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000159 }
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000160 }
Devang Patelf20c4f72011-04-12 22:53:02 +0000161 return Ty;
162}
Bill Wendling2f921f82009-05-15 09:23:25 +0000163
Chris Lattnerf5d06362010-04-05 04:09:20 +0000164} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000165
Manman Renac8062b2013-07-02 23:40:10 +0000166/// Return Dwarf Version by checking module flags.
167static unsigned getDwarfVersionFromModule(const Module *M) {
Manman Ren8bfde892013-07-16 23:21:16 +0000168 Value *Val = M->getModuleFlag("Dwarf Version");
169 if (!Val)
Eric Christophere31e0722013-09-04 22:21:24 +0000170 return dwarf::DWARF_VERSION;
Manman Ren8bfde892013-07-16 23:21:16 +0000171 return cast<ConstantInt>(Val)->getZExtValue();
Manman Renac8062b2013-07-02 23:40:10 +0000172}
173
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000174DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Eric Christopherd79f5482012-12-10 19:51:13 +0000175 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000176 AbbreviationsSet(InitAbbreviationsSetSize),
Eric Christopher27614582013-01-08 22:22:06 +0000177 SourceIdMap(DIEValueAllocator),
Eric Christopherc8a310e2012-12-10 23:34:43 +0000178 PrevLabel(NULL), GlobalCUIndexCount(0),
Eric Christopher27614582013-01-08 22:22:06 +0000179 InfoHolder(A, &AbbreviationsSet, &Abbreviations, "info_string",
180 DIEValueAllocator),
Eric Christopher3c5a1912012-12-19 22:02:53 +0000181 SkeletonAbbrevSet(InitAbbreviationsSetSize),
Eric Christopher27614582013-01-08 22:22:06 +0000182 SkeletonHolder(A, &SkeletonAbbrevSet, &SkeletonAbbrevs, "skel_string",
183 DIEValueAllocator) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000184
Rafael Espindolaa7160962011-05-06 14:56:22 +0000185 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattnere58b5472010-04-04 23:10:38 +0000186 DwarfStrSectionSym = TextSectionSym = 0;
Eric Christopher74804332013-02-07 21:19:50 +0000187 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
Eric Christopher55863be2013-04-07 03:43:09 +0000188 DwarfAddrSectionSym = 0;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000189 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000190 FunctionBeginSym = FunctionEndSym = 0;
Eric Christopherad9fe892012-04-02 17:58:52 +0000191
Eric Christopher978fbff2012-08-23 07:10:46 +0000192 // Turn on accelerator tables and older gdb compatibility
Eric Christopher574b5c82013-08-19 21:41:38 +0000193 // for Darwin by default, pubnames by default for non-Darwin,
194 // and handle split dwarf.
Eric Christopher203e12b2013-04-27 01:07:52 +0000195 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
Eric Christopher4977f212012-08-23 22:36:36 +0000196
Eric Christopher574b5c82013-08-19 21:41:38 +0000197 if (DwarfAccelTables == Default)
198 HasDwarfAccelTables = IsDarwin;
199 else
Eric Christopher5297df02013-08-26 20:58:35 +0000200 HasDwarfAccelTables = DwarfAccelTables == Enable;
Eric Christopher20b76a72012-08-23 22:36:40 +0000201
Eric Christophercdf218d2012-12-10 19:51:21 +0000202 if (SplitDwarf == Default)
203 HasSplitDwarf = false;
Eric Christopher29424312012-11-12 22:22:20 +0000204 else
Eric Christopher574b5c82013-08-19 21:41:38 +0000205 HasSplitDwarf = SplitDwarf == Enable;
Eric Christopher29424312012-11-12 22:22:20 +0000206
Eric Christopher4d36ca02013-08-26 23:24:35 +0000207 if (DwarfPubSections == Default)
208 HasDwarfPubSections = !IsDarwin;
Eric Christopher574b5c82013-08-19 21:41:38 +0000209 else
Eric Christopher4d36ca02013-08-26 23:24:35 +0000210 HasDwarfPubSections = DwarfPubSections == Enable;
Eric Christopher7da24882013-08-19 21:07:38 +0000211
Manman Renac8062b2013-07-02 23:40:10 +0000212 DwarfVersion = getDwarfVersionFromModule(MMI->getModule());
213
Dan Gohman6e681a52010-06-18 15:56:31 +0000214 {
215 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopher58f41952012-11-19 22:42:15 +0000216 beginModule();
Torok Edwinf8dba242010-04-07 10:44:46 +0000217 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000218}
219DwarfDebug::~DwarfDebug() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000220}
221
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000222// Switch to the specified MCSection and emit an assembler
223// temporary label to it if SymbolStem is specified.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000224static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christophera7b61892011-11-07 09:18:38 +0000225 const char *SymbolStem = 0) {
226 Asm->OutStreamer.SwitchSection(Section);
227 if (!SymbolStem) return 0;
228
229 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
230 Asm->OutStreamer.EmitLabel(TmpSym);
231 return TmpSym;
232}
233
Eric Christophere698f532012-12-20 21:58:36 +0000234MCSymbol *DwarfUnits::getStringPoolSym() {
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000235 return Asm->GetTempSymbol(StringPref);
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000236}
237
Eric Christophere698f532012-12-20 21:58:36 +0000238MCSymbol *DwarfUnits::getStringPoolEntry(StringRef Str) {
239 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopher27614582013-01-08 22:22:06 +0000240 StringPool.GetOrCreateValue(Str).getValue();
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000241 if (Entry.first) return Entry.first;
242
243 Entry.second = NextStringPoolNumber++;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000244 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000245}
246
Eric Christopher2cbd5762013-01-07 19:32:41 +0000247unsigned DwarfUnits::getStringPoolIndex(StringRef Str) {
248 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopher27614582013-01-08 22:22:06 +0000249 StringPool.GetOrCreateValue(Str).getValue();
Eric Christopher2cbd5762013-01-07 19:32:41 +0000250 if (Entry.first) return Entry.second;
251
252 Entry.second = NextStringPoolNumber++;
253 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
254 return Entry.second;
255}
256
David Blaikiedea547b2013-06-28 18:47:14 +0000257unsigned DwarfUnits::getAddrPoolIndex(const MCSymbol *Sym) {
David Blaikie8466ca82013-07-01 23:55:52 +0000258 return getAddrPoolIndex(MCSymbolRefExpr::Create(Sym, Asm->OutContext));
259}
260
Ulrich Weigand8b3d2262013-07-02 18:46:46 +0000261unsigned DwarfUnits::getAddrPoolIndex(const MCExpr *Sym) {
262 std::pair<DenseMap<const MCExpr *, unsigned>::iterator, bool> P =
David Blaikieb8ef7852013-06-28 18:47:19 +0000263 AddressPool.insert(std::make_pair(Sym, NextAddrPoolNumber));
David Blaikiea67de2b2013-06-28 18:55:13 +0000264 if (P.second)
265 ++NextAddrPoolNumber;
David Blaikieb8ef7852013-06-28 18:47:19 +0000266 return P.first->second;
Eric Christopher962c9082013-01-15 23:56:56 +0000267}
268
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000269// Define a unique number for the abbreviation.
270//
Eric Christopherc8a310e2012-12-10 23:34:43 +0000271void DwarfUnits::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000272 // Check the set for priors.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000273 DIEAbbrev *InSet = AbbreviationsSet->GetOrInsertNode(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000274
275 // If it's newly added.
276 if (InSet == &Abbrev) {
277 // Add to abbreviation list.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000278 Abbreviations->push_back(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000279
280 // Assign the vector position + 1 as its number.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000281 Abbrev.setNumber(Abbreviations->size());
Bill Wendling2f921f82009-05-15 09:23:25 +0000282 } else {
283 // Assign existing abbreviation number.
284 Abbrev.setNumber(InSet->getNumber());
285 }
286}
287
Eric Christopherd9843b32011-11-10 19:25:34 +0000288static bool isObjCClass(StringRef Name) {
289 return Name.startswith("+") || Name.startswith("-");
290}
291
292static bool hasObjCCategory(StringRef Name) {
293 if (!isObjCClass(Name)) return false;
294
Benjamin Kramer260de742013-08-24 12:15:54 +0000295 return Name.find(") ") != StringRef::npos;
Eric Christopherd9843b32011-11-10 19:25:34 +0000296}
297
298static void getObjCClassCategory(StringRef In, StringRef &Class,
299 StringRef &Category) {
300 if (!hasObjCCategory(In)) {
301 Class = In.slice(In.find('[') + 1, In.find(' '));
302 Category = "";
303 return;
304 }
305
306 Class = In.slice(In.find('[') + 1, In.find('('));
307 Category = In.slice(In.find('[') + 1, In.find(' '));
308 return;
309}
310
311static StringRef getObjCMethodName(StringRef In) {
312 return In.slice(In.find(' ') + 1, In.find(']'));
313}
314
Richard Mittonc2508242013-10-03 22:07:08 +0000315// Helper for sorting sections into a stable output order.
316static bool SectionSort(const MCSection *A, const MCSection *B) {
317 std::string LA = (A ? A->getLabelBeginName() : "");
318 std::string LB = (B ? B->getLabelBeginName() : "");
319 return LA < LB;
320}
321
Eric Christopherd9843b32011-11-10 19:25:34 +0000322// Add the various names to the Dwarf accelerator table names.
Eric Christopher9cd26af2013-09-20 23:22:52 +0000323// TODO: Determine whether or not we should add names for programs
324// that do not have a DW_AT_name or DW_AT_linkage_name field - this
325// is only slightly different than the lookup of non-standard ObjC names.
Eric Christopherd9843b32011-11-10 19:25:34 +0000326static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
327 DIE* Die) {
328 if (!SP.isDefinition()) return;
Eric Christopherd9843b32011-11-10 19:25:34 +0000329 TheCU->addAccelName(SP.getName(), Die);
330
331 // If the linkage name is different than the name, go ahead and output
332 // that as well into the name table.
333 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
334 TheCU->addAccelName(SP.getLinkageName(), Die);
335
336 // If this is an Objective-C selector name add it to the ObjC accelerator
337 // too.
338 if (isObjCClass(SP.getName())) {
339 StringRef Class, Category;
340 getObjCClassCategory(SP.getName(), Class, Category);
341 TheCU->addAccelObjC(Class, Die);
342 if (Category != "")
343 TheCU->addAccelObjC(Category, Die);
344 // Also add the base method name to the name table.
345 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
346 }
347}
348
Manman Ren3eb9dff2013-09-09 19:05:21 +0000349/// isSubprogramContext - Return true if Context is either a subprogram
350/// or another context nested inside a subprogram.
351bool DwarfDebug::isSubprogramContext(const MDNode *Context) {
352 if (!Context)
353 return false;
354 DIDescriptor D(Context);
355 if (D.isSubprogram())
356 return true;
357 if (D.isType())
Manman Ren116868e2013-09-09 19:47:11 +0000358 return isSubprogramContext(resolve(DIType(Context).getContext()));
Manman Ren3eb9dff2013-09-09 19:05:21 +0000359 return false;
360}
361
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000362// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
363// and DW_AT_high_pc attributes. If there are global variables in this
364// scope then create and insert DIEs for these variables.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000365DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
366 const MDNode *SPNode) {
Eric Christophere595bae2013-10-04 17:08:38 +0000367 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +0000368
Chris Lattner3a383cb2010-04-05 00:13:49 +0000369 assert(SPDie && "Unable to find subprogram DIE!");
370 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000371
Bill Wendlingf720bf62012-11-07 05:19:04 +0000372 // If we're updating an abstract DIE, then we will be adding the children and
373 // object pointer later on. But what we don't want to do is process the
374 // concrete DIE twice.
Eric Christopherc19d6f02013-10-04 19:40:33 +0000375 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
Bill Wendlingf720bf62012-11-07 05:19:04 +0000376 // Pick up abstract subprogram DIE.
Devang Patela37a95e2010-07-07 22:20:57 +0000377 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf20c4f72011-04-12 22:53:02 +0000378 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
Eric Christopherc19d6f02013-10-04 19:40:33 +0000379 dwarf::DW_FORM_ref4, AbsSPDIE);
Devang Patela37a95e2010-07-07 22:20:57 +0000380 SPCU->addDie(SPDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000381 } else {
382 DISubprogram SPDecl = SP.getFunctionDeclaration();
383 if (!SPDecl.isSubprogram()) {
384 // There is not any need to generate specification DIE for a function
385 // defined at compile unit level. If a function is defined inside another
386 // function then gdb prefers the definition at top level and but does not
387 // expect specification DIE in parent function. So avoid creating
388 // specification DIE for a function defined inside a function.
389 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
390 !SP.getContext().isFile() &&
391 !isSubprogramContext(SP.getContext())) {
392 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
393
394 // Add arguments.
395 DICompositeType SPTy = SP.getType();
396 DIArray Args = SPTy.getTypeArray();
Eric Christopher31b05762013-08-08 01:41:00 +0000397 uint16_t SPTag = SPTy.getTag();
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000398 if (SPTag == dwarf::DW_TAG_subroutine_type)
399 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
400 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
401 DIType ATy = DIType(Args.getElement(i));
402 SPCU->addType(Arg, ATy);
403 if (ATy.isArtificial())
404 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
405 if (ATy.isObjectPointer())
406 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer,
407 dwarf::DW_FORM_ref4, Arg);
408 SPDie->addChild(Arg);
409 }
410 DIE *SPDeclDie = SPDie;
411 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Eric Christopher6a841382012-11-19 22:42:10 +0000412 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification,
413 dwarf::DW_FORM_ref4, SPDeclDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000414 SPCU->addDie(SPDie);
415 }
416 }
Devang Patela37a95e2010-07-07 22:20:57 +0000417 }
418
Eric Christopher962c9082013-01-15 23:56:56 +0000419 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc,
420 Asm->GetTempSymbol("func_begin",
421 Asm->getFunctionNumber()));
422 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
423 Asm->GetTempSymbol("func_end",
424 Asm->getFunctionNumber()));
Chris Lattner3a383cb2010-04-05 00:13:49 +0000425 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
426 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000427 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000428
Eric Christopherd9843b32011-11-10 19:25:34 +0000429 // Add name to the name table, we do this here because we're guaranteed
430 // to have concrete versions of our DW_TAG_subprogram nodes.
431 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher6a841382012-11-19 22:42:10 +0000432
Chris Lattner3a383cb2010-04-05 00:13:49 +0000433 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000434}
435
Manman Ren5b2f4b02013-09-11 19:40:28 +0000436/// Check whether we should create a DIE for the given Scope, return true
437/// if we don't create a DIE (the corresponding DIE is null).
Manman Ren2312ed32013-09-10 18:40:41 +0000438bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
439 if (Scope->isAbstractScope())
440 return false;
441
Manman Ren5b2f4b02013-09-11 19:40:28 +0000442 // We don't create a DIE if there is no Range.
Manman Ren2312ed32013-09-10 18:40:41 +0000443 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
444 if (Ranges.empty())
445 return true;
446
447 if (Ranges.size() > 1)
448 return false;
449
Manman Ren5b2f4b02013-09-11 19:40:28 +0000450 // We don't create a DIE if we have a single Range and the end label
451 // is null.
Manman Ren2312ed32013-09-10 18:40:41 +0000452 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
453 MCSymbol *End = getLabelAfterInsn(RI->second);
454 return !End;
455}
456
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000457// Construct new DW_TAG_lexical_block for this scope and attach
458// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher6a841382012-11-19 22:42:10 +0000459DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000460 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000461 if (isLexicalScopeDIENull(Scope))
462 return 0;
463
Devang Patel6c74a872010-04-27 19:46:33 +0000464 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
465 if (Scope->isAbstractScope())
466 return ScopeDIE;
467
Craig Topper977e9cd2013-07-03 04:24:43 +0000468 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Eric Christopherdc42ea82013-07-03 01:57:28 +0000469 // If we have multiple ranges, emit them into the range section.
Devang Patel6c74a872010-04-27 19:46:33 +0000470 if (Ranges.size() > 1) {
471 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000472 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +0000473 // DW_AT_ranges appropriately.
Devang Patelf20c4f72011-04-12 22:53:02 +0000474 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000475 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000476 * Asm->getDataLayout().getPointerSize());
Craig Topperd8e43652013-07-03 04:17:25 +0000477 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +0000478 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +0000479 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
480 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +0000481 }
Eric Christopherc1110832013-07-03 01:22:29 +0000482
483 // Terminate the range list.
Devang Patel6c74a872010-04-27 19:46:33 +0000484 DebugRangeSymbols.push_back(NULL);
485 DebugRangeSymbols.push_back(NULL);
486 return ScopeDIE;
487 }
488
Eric Christopherdc42ea82013-07-03 01:57:28 +0000489 // Construct the address range for this DIE.
Craig Topperd8e43652013-07-03 04:17:25 +0000490 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopher962c9082013-01-15 23:56:56 +0000491 MCSymbol *Start = getLabelBeforeInsn(RI->first);
492 MCSymbol *End = getLabelAfterInsn(RI->second);
Manman Ren2312ed32013-09-10 18:40:41 +0000493 assert(End && "End label should not be null!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000494
Chris Lattnere13c3722010-03-09 01:58:53 +0000495 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
496 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000497
Eric Christopher962c9082013-01-15 23:56:56 +0000498 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
499 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000500
501 return ScopeDIE;
502}
503
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000504// This scope represents inlined body of a function. Construct DIE to
505// represent this concrete inlined copy of the function.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000506DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
507 LexicalScope *Scope) {
Craig Topper977e9cd2013-07-03 04:24:43 +0000508 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000509 assert(Ranges.empty() == false &&
510 "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000511
Devang Patelf098ce22011-07-27 00:34:13 +0000512 if (!Scope->getScopeNode())
513 return NULL;
514 DIScope DS(Scope->getScopeNode());
515 DISubprogram InlinedSP = getDISubprogram(DS);
Eric Christophere595bae2013-10-04 17:08:38 +0000516 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patelf098ce22011-07-27 00:34:13 +0000517 if (!OriginDIE) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000518 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patelf098ce22011-07-27 00:34:13 +0000519 return NULL;
520 }
521
Devang Patel73bc1722011-05-05 17:54:26 +0000522 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Devang Patelf20c4f72011-04-12 22:53:02 +0000523 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Manman Ren4213c392013-05-29 17:16:59 +0000524 dwarf::DW_FORM_ref4, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000525
Devang Patelf098ce22011-07-27 00:34:13 +0000526 if (Ranges.size() > 1) {
527 // .debug_range section has not been laid out yet. Emit offset in
528 // .debug_range as a uint, size 4, for now. emitDIE will handle
529 // DW_AT_ranges appropriately.
530 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000531 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000532 * Asm->getDataLayout().getPointerSize());
Craig Topperd8e43652013-07-03 04:17:25 +0000533 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patelf098ce22011-07-27 00:34:13 +0000534 RE = Ranges.end(); RI != RE; ++RI) {
535 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
536 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
537 }
538 DebugRangeSymbols.push_back(NULL);
539 DebugRangeSymbols.push_back(NULL);
540 } else {
Craig Topperd8e43652013-07-03 04:17:25 +0000541 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000542 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
543 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
544
545 if (StartLabel == 0 || EndLabel == 0)
546 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
547
548 assert(StartLabel->isDefined() &&
549 "Invalid starting label for an inlined scope!");
550 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
551
Eric Christopher962c9082013-01-15 23:56:56 +0000552 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
553 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patelf098ce22011-07-27 00:34:13 +0000554 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000555
556 InlinedSubprogramDIEs.insert(OriginDIE);
557
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000558 // Add the call site information to the DIE.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000559 DILocation DL(Scope->getInlinedAt());
Eric Christopher0925c622012-03-26 21:38:38 +0000560 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0,
Manman Ren1e427202013-03-07 01:42:00 +0000561 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
562 TheCU->getUniqueID()));
Devang Patelf20c4f72011-04-12 22:53:02 +0000563 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000564
Eric Christopher8dda5d02011-12-04 06:02:38 +0000565 // Add name to the name table, we do this here because we're guaranteed
566 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
567 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher6a841382012-11-19 22:42:10 +0000568
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000569 return ScopeDIE;
570}
571
Manman Ren2312ed32013-09-10 18:40:41 +0000572DIE *DwarfDebug::createScopeChildrenDIE(CompileUnit *TheCU, LexicalScope *Scope,
573 SmallVectorImpl<DIE*> &Children) {
574 DIE *ObjectPointer = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +0000575
576 // Collect arguments for current function.
Devang Patel7e623022011-08-10 20:55:27 +0000577 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000578 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
579 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher6a841382012-11-19 22:42:10 +0000580 if (DIE *Arg =
Eric Christophere3417762012-09-12 23:36:19 +0000581 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel6c622ef2011-03-01 22:58:55 +0000582 Children.push_back(Arg);
Eric Christophere3417762012-09-12 23:36:19 +0000583 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
584 }
Devang Patel6c622ef2011-03-01 22:58:55 +0000585
Eric Christopherf84354b2011-10-03 15:49:16 +0000586 // Collect lexical scope children first.
Craig Topper977e9cd2013-07-03 04:24:43 +0000587 const SmallVectorImpl<DbgVariable *> &Variables =ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000588 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher6a841382012-11-19 22:42:10 +0000589 if (DIE *Variable =
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000590 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000591 Children.push_back(Variable);
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000592 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
593 }
Craig Topper977e9cd2013-07-03 04:24:43 +0000594 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000595 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Patel3acc70e2011-08-15 22:04:40 +0000596 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000597 Children.push_back(Nested);
Manman Ren2312ed32013-09-10 18:40:41 +0000598 return ObjectPointer;
599}
600
601// Construct a DIE for this scope.
602DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
603 if (!Scope || !Scope->getScopeNode())
604 return NULL;
605
606 DIScope DS(Scope->getScopeNode());
607
608 SmallVector<DIE *, 8> Children;
609 DIE *ObjectPointer = NULL;
610 bool ChildrenCreated = false;
611
Manman Ren5b2f4b02013-09-11 19:40:28 +0000612 // We try to create the scope DIE first, then the children DIEs. This will
613 // avoid creating un-used children then removing them later when we find out
614 // the scope DIE is null.
Devang Patel3b548aa2010-03-08 20:52:55 +0000615 DIE *ScopeDIE = NULL;
616 if (Scope->getInlinedAt())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000617 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3b548aa2010-03-08 20:52:55 +0000618 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000619 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000620 if (Scope->isAbstractScope()) {
Eric Christophere595bae2013-10-04 17:08:38 +0000621 ScopeDIE = TheCU->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000622 // Note down abstract DIE.
623 if (ScopeDIE)
624 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
625 }
Devang Patel3b548aa2010-03-08 20:52:55 +0000626 else
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000627 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3b548aa2010-03-08 20:52:55 +0000628 }
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000629 else {
Manman Ren5b2f4b02013-09-11 19:40:28 +0000630 // Early exit when we know the scope DIE is going to be null.
Manman Ren2312ed32013-09-10 18:40:41 +0000631 if (isLexicalScopeDIENull(Scope))
632 return NULL;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000633
634 // We create children here when we know the scope DIE is not going to be
635 // null and the children will be added to the scope DIE.
Manman Ren2312ed32013-09-10 18:40:41 +0000636 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
637 ChildrenCreated = true;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000638
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000639 // There is no need to emit empty lexical block DIE.
David Blaikie684fc532013-05-06 23:33:07 +0000640 std::pair<ImportedEntityMap::const_iterator,
641 ImportedEntityMap::const_iterator> Range = std::equal_range(
642 ScopesWithImportedEntities.begin(), ScopesWithImportedEntities.end(),
Timur Iskhodzhanovec4afe62013-05-07 07:47:47 +0000643 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode*)0),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000644 less_first());
David Blaikie684fc532013-05-06 23:33:07 +0000645 if (Children.empty() && Range.first == Range.second)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000646 return NULL;
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000647 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Manman Ren2312ed32013-09-10 18:40:41 +0000648 assert(ScopeDIE && "Scope DIE should not be null.");
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000649 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
650 ++i)
David Blaikie4dd2de72013-05-08 06:01:38 +0000651 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000652 }
Eric Christopher6a841382012-11-19 22:42:10 +0000653
Benjamin Kramer892daba2013-08-24 11:55:49 +0000654 if (!ScopeDIE) {
Manman Ren2312ed32013-09-10 18:40:41 +0000655 assert(Children.empty() &&
656 "We create children only when the scope DIE is not null.");
Benjamin Kramer892daba2013-08-24 11:55:49 +0000657 return NULL;
658 }
Manman Ren2312ed32013-09-10 18:40:41 +0000659 if (!ChildrenCreated)
Manman Ren5b2f4b02013-09-11 19:40:28 +0000660 // We create children when the scope DIE is not null.
Manman Ren2312ed32013-09-10 18:40:41 +0000661 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000662
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000663 // Add children
Craig Topperd8e43652013-07-03 04:17:25 +0000664 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000665 E = Children.end(); I != E; ++I)
666 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000667
Eric Christophere3417762012-09-12 23:36:19 +0000668 if (DS.isSubprogram() && ObjectPointer != NULL)
669 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer,
670 dwarf::DW_FORM_ref4, ObjectPointer);
671
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 Christopher6a841382012-11-19 22:42:10 +0000829void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
Devang Patel1f4f98d2011-08-15 23:36:40 +0000830 const MDNode *N) {
Rafael Espindola6cf4e832011-11-04 19:00:29 +0000831 CompileUnit *&CURef = SPMap[N];
832 if (CURef)
833 return;
834 CURef = TheCU;
835
Devang Patel80ae3492009-08-28 23:24:31 +0000836 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000837 if (!SP.isDefinition())
838 // This is a method declaration which will be handled while constructing
839 // class type.
Devang Patel0751a282009-06-26 01:49:18 +0000840 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000841
Devang Patel89543712011-08-15 17:24:54 +0000842 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000843
Eric Christopherba506db2013-09-09 20:03:20 +0000844 // Expose as a global name.
845 TheCU->addGlobalName(SP.getName(), SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +0000846}
847
David Blaikie1fd43652013-05-07 21:35:53 +0000848void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikief55abea2013-04-22 06:12:31 +0000849 const MDNode *N) {
David Blaikie1fd43652013-05-07 21:35:53 +0000850 DIImportedEntity Module(N);
David Blaikief55abea2013-04-22 06:12:31 +0000851 if (!Module.Verify())
852 return;
David Blaikie684fc532013-05-06 23:33:07 +0000853 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
David Blaikie4dd2de72013-05-08 06:01:38 +0000854 constructImportedEntityDIE(TheCU, Module, D);
David Blaikie684fc532013-05-06 23:33:07 +0000855}
856
David Blaikie4dd2de72013-05-08 06:01:38 +0000857void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
David Blaikie684fc532013-05-06 23:33:07 +0000858 DIE *Context) {
David Blaikie1fd43652013-05-07 21:35:53 +0000859 DIImportedEntity Module(N);
David Blaikie684fc532013-05-06 23:33:07 +0000860 if (!Module.Verify())
861 return;
David Blaikie4dd2de72013-05-08 06:01:38 +0000862 return constructImportedEntityDIE(TheCU, Module, Context);
David Blaikie684fc532013-05-06 23:33:07 +0000863}
864
David Blaikie4dd2de72013-05-08 06:01:38 +0000865void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikie1fd43652013-05-07 21:35:53 +0000866 const DIImportedEntity &Module,
David Blaikie684fc532013-05-06 23:33:07 +0000867 DIE *Context) {
868 assert(Module.Verify() &&
869 "Use one of the MDNode * overloads to handle invalid metadata");
870 assert(Context && "Should always have a context for an imported_module");
David Blaikie1fd43652013-05-07 21:35:53 +0000871 DIE *IMDie = new DIE(Module.getTag());
David Blaikief55abea2013-04-22 06:12:31 +0000872 TheCU->insertDIE(Module, IMDie);
David Blaikie1fd43652013-05-07 21:35:53 +0000873 DIE *EntityDie;
874 DIDescriptor Entity = Module.getEntity();
875 if (Entity.isNameSpace())
876 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
877 else if (Entity.isSubprogram())
878 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
David Blaikie3b6038b2013-05-08 06:01:41 +0000879 else if (Entity.isType())
880 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
David Blaikie1fd43652013-05-07 21:35:53 +0000881 else
David Blaikie3b6038b2013-05-08 06:01:41 +0000882 EntityDie = TheCU->getDIE(Entity);
David Blaikief55abea2013-04-22 06:12:31 +0000883 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
884 Module.getContext().getDirectory(),
885 TheCU->getUniqueID());
886 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, 0, FileID);
887 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, 0, Module.getLineNumber());
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000888 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, dwarf::DW_FORM_ref4,
889 EntityDie);
David Blaikiee63d5d12013-05-20 22:50:35 +0000890 StringRef Name = Module.getName();
891 if (!Name.empty())
892 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
David Blaikie684fc532013-05-06 23:33:07 +0000893 Context->addChild(IMDie);
David Blaikief55abea2013-04-22 06:12:31 +0000894}
895
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000896// Emit all Dwarf sections that should come prior to the content. Create
897// global DIEs and emit initial debug info sections. This is invoked by
898// the target AsmPrinter.
Eric Christopher58f41952012-11-19 22:42:15 +0000899void DwarfDebug::beginModule() {
Devang Patel6c74a872010-04-27 19:46:33 +0000900 if (DisableDebugInfoPrinting)
901 return;
902
Eric Christopher58f41952012-11-19 22:42:15 +0000903 const Module *M = MMI->getModule();
904
Nick Lewycky019d2552011-07-29 03:49:23 +0000905 // If module has named metadata anchors then use them, otherwise scan the
906 // module using debug info finder to collect debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000907 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
David Blaikiedc69ebb2013-03-11 23:39:23 +0000908 if (!CU_Nodes)
Devang Patel07bb9ee2011-08-15 23:47:24 +0000909 return;
Manman Ren60352032013-09-05 18:48:31 +0000910 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
Devang Patele02e5852011-05-03 16:45:22 +0000911
David Blaikiedc69ebb2013-03-11 23:39:23 +0000912 // Emit initial sections so we can reference labels later.
913 emitSectionLabels();
914
915 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
916 DICompileUnit CUNode(CU_Nodes->getOperand(i));
917 CompileUnit *CU = constructCompileUnit(CUNode);
David Blaikie1fd43652013-05-07 21:35:53 +0000918 DIArray ImportedEntities = CUNode.getImportedEntities();
919 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
David Blaikie684fc532013-05-06 23:33:07 +0000920 ScopesWithImportedEntities.push_back(std::make_pair(
David Blaikie1fd43652013-05-07 21:35:53 +0000921 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
922 ImportedEntities.getElement(i)));
David Blaikie684fc532013-05-06 23:33:07 +0000923 std::sort(ScopesWithImportedEntities.begin(),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000924 ScopesWithImportedEntities.end(), less_first());
David Blaikiedc69ebb2013-03-11 23:39:23 +0000925 DIArray GVs = CUNode.getGlobalVariables();
926 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
927 CU->createGlobalVariableDIE(GVs.getElement(i));
928 DIArray SPs = CUNode.getSubprograms();
929 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
930 constructSubprogramDIE(CU, SPs.getElement(i));
931 DIArray EnumTypes = CUNode.getEnumTypes();
932 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
933 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
934 DIArray RetainedTypes = CUNode.getRetainedTypes();
935 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
936 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
David Blaikief55abea2013-04-22 06:12:31 +0000937 // Emit imported_modules last so that the relevant context is already
938 // available.
David Blaikie1fd43652013-05-07 21:35:53 +0000939 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
940 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
David Blaikiedc69ebb2013-03-11 23:39:23 +0000941 }
Eric Christopher6a841382012-11-19 22:42:10 +0000942
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000943 // Tell MMI that we have debug info.
944 MMI->setDebugInfoAvailability(true);
Eric Christopher6a841382012-11-19 22:42:10 +0000945
Bill Wendling2b128d72009-05-20 23:19:06 +0000946 // Prime section data.
Richard Mitton21101b32013-09-19 23:21:01 +0000947 SectionMap[Asm->getObjFileLowering().getTextSection()];
Bill Wendling2b128d72009-05-20 23:19:06 +0000948}
949
Eric Christopher960ac372012-11-22 00:59:49 +0000950// Attach DW_AT_inline attribute with inlined subprogram DIEs.
951void DwarfDebug::computeInlinedDIEs() {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000952 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
953 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000954 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000955 DIE *ISP = *AI;
Devang Patelf20c4f72011-04-12 22:53:02 +0000956 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000957 }
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000958 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000959 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000960 DIE *ISP = AI->second;
961 if (InlinedSubprogramDIEs.count(ISP))
962 continue;
963 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
964 }
Eric Christopher960ac372012-11-22 00:59:49 +0000965}
966
967// Collect info for variables that were optimized out.
968void DwarfDebug::collectDeadVariables() {
969 const Module *M = MMI->getModule();
970 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
971
972 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
973 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
974 DICompileUnit TheCU(CU_Nodes->getOperand(i));
975 DIArray Subprograms = TheCU.getSubprograms();
976 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopher735401c2012-11-27 00:13:51 +0000977 DISubprogram SP(Subprograms.getElement(i));
978 if (ProcessedSPNodes.count(SP) != 0) continue;
Manman Ren7504ed42013-07-08 18:33:29 +0000979 if (!SP.isSubprogram()) continue;
Eric Christopher735401c2012-11-27 00:13:51 +0000980 if (!SP.isDefinition()) continue;
981 DIArray Variables = SP.getVariables();
982 if (Variables.getNumElements() == 0) continue;
Eric Christopher960ac372012-11-22 00:59:49 +0000983
Eric Christopher735401c2012-11-27 00:13:51 +0000984 LexicalScope *Scope =
985 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
986 DeadFnScopeMap[SP] = Scope;
Eric Christopher960ac372012-11-22 00:59:49 +0000987
Eric Christopher735401c2012-11-27 00:13:51 +0000988 // Construct subprogram DIE and add variables DIEs.
989 CompileUnit *SPCU = CUMap.lookup(TheCU);
990 assert(SPCU && "Unable to find Compile Unit!");
991 constructSubprogramDIE(SPCU, SP);
Eric Christophere595bae2013-10-04 17:08:38 +0000992 DIE *ScopeDIE = SPCU->getDIE(SP);
Eric Christopher735401c2012-11-27 00:13:51 +0000993 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
994 DIVariable DV(Variables.getElement(vi));
Manman Ren7504ed42013-07-08 18:33:29 +0000995 if (!DV.isVariable()) continue;
Manman Renb3388602013-10-05 01:43:03 +0000996 DbgVariable NewVar(DV, NULL, this);
Eric Christopher735401c2012-11-27 00:13:51 +0000997 if (DIE *VariableDIE =
Chandler Carruth2a1c0d22013-07-27 11:09:58 +0000998 SPCU->constructVariableDIE(&NewVar, Scope->isAbstractScope()))
Eric Christopher735401c2012-11-27 00:13:51 +0000999 ScopeDIE->addChild(VariableDIE);
1000 }
Eric Christopher960ac372012-11-22 00:59:49 +00001001 }
1002 }
1003 }
1004 DeleteContainerSeconds(DeadFnScopeMap);
1005}
1006
Eric Christopher45731982013-08-08 23:45:55 +00001007// Type Signature [7.27] and ODR Hash code.
Eric Christopher67646432013-07-26 17:02:41 +00001008
1009/// \brief Grabs the string in whichever attribute is passed in and returns
Eric Christopher8552e222013-08-07 01:18:33 +00001010/// a reference to it. Returns "" if the attribute doesn't exist.
Eric Christopher67646432013-07-26 17:02:41 +00001011static StringRef getDIEStringAttr(DIE *Die, unsigned Attr) {
Eric Christopher8552e222013-08-07 01:18:33 +00001012 DIEValue *V = Die->findAttribute(Attr);
Eric Christopher67646432013-07-26 17:02:41 +00001013
Eric Christopher8552e222013-08-07 01:18:33 +00001014 if (DIEString *S = dyn_cast_or_null<DIEString>(V))
1015 return S->getString();
1016
Eric Christopher67646432013-07-26 17:02:41 +00001017 return StringRef("");
1018}
1019
Eric Christopher67646432013-07-26 17:02:41 +00001020/// Return true if the current DIE is contained within an anonymous namespace.
1021static bool isContainedInAnonNamespace(DIE *Die) {
1022 DIE *Parent = Die->getParent();
1023
1024 while (Parent) {
Eric Christophere414ece2013-07-29 23:53:08 +00001025 if (Parent->getTag() == dwarf::DW_TAG_namespace &&
1026 getDIEStringAttr(Parent, dwarf::DW_AT_name) == "")
Eric Christopher67646432013-07-26 17:02:41 +00001027 return true;
1028 Parent = Parent->getParent();
1029 }
1030
1031 return false;
1032}
1033
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001034/// Test if the current CU language is C++ and that we have
1035/// a named type that is not contained in an anonymous namespace.
1036static bool shouldAddODRHash(CompileUnit *CU, DIE *Die) {
Eric Christopher341770d2013-08-07 08:35:10 +00001037 return CU->getLanguage() == dwarf::DW_LANG_C_plus_plus &&
1038 getDIEStringAttr(Die, dwarf::DW_AT_name) != "" &&
1039 !isContainedInAnonNamespace(Die);
Eric Christopher45731982013-08-08 23:45:55 +00001040}
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001041
Eric Christopher960ac372012-11-22 00:59:49 +00001042void DwarfDebug::finalizeModuleInfo() {
1043 // Collect info for variables that were optimized out.
1044 collectDeadVariables();
1045
1046 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1047 computeInlinedDIEs();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001048
Eric Christopherf8542ec2013-07-29 22:24:32 +00001049 // Split out type units and conditionally add an ODR tag to the split
1050 // out type.
Eric Christopher67646432013-07-26 17:02:41 +00001051 // FIXME: Do type splitting.
1052 for (unsigned i = 0, e = TypeUnits.size(); i != e; ++i) {
Eric Christopher67646432013-07-26 17:02:41 +00001053 DIE *Die = TypeUnits[i];
Eric Christopher45731982013-08-08 23:45:55 +00001054 DIEHash Hash;
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001055 // If we've requested ODR hashes and it's applicable for an ODR hash then
1056 // add the ODR signature now.
Eric Christopher45731982013-08-08 23:45:55 +00001057 // FIXME: This should be added onto the type unit, not the type, but this
1058 // works as an intermediate stage.
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001059 if (GenerateODRHash && shouldAddODRHash(CUMap.begin()->second, Die))
Eric Christopher45731982013-08-08 23:45:55 +00001060 CUMap.begin()->second->addUInt(Die, dwarf::DW_AT_GNU_odr_signature,
1061 dwarf::DW_FORM_data8,
1062 Hash.computeDIEODRSignature(Die));
Eric Christopher67646432013-07-26 17:02:41 +00001063 }
1064
Eric Christopher60eb7692013-08-12 20:27:48 +00001065 // Handle anything that needs to be done on a per-cu basis.
1066 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
1067 CUE = CUMap.end();
1068 CUI != CUE; ++CUI) {
1069 CompileUnit *TheCU = CUI->second;
1070 // Emit DW_AT_containing_type attribute to connect types with their
1071 // vtable holding type.
1072 TheCU->constructContainingTypeDIEs();
1073
1074 // If we're splitting the dwarf out now that we've got the entire
1075 // CU then construct a skeleton CU based upon it.
1076 if (useSplitDwarf()) {
Eric Christopherd29614f2013-08-13 01:21:55 +00001077 uint64_t ID = 0;
1078 if (GenerateCUHash) {
1079 DIEHash CUHash;
1080 ID = CUHash.computeCUSignature(TheCU->getCUDie());
1081 }
Eric Christopher60eb7692013-08-12 20:27:48 +00001082 // This should be a unique identifier when we want to build .dwp files.
1083 TheCU->addUInt(TheCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopherd29614f2013-08-13 01:21:55 +00001084 dwarf::DW_FORM_data8, ID);
Eric Christopher60eb7692013-08-12 20:27:48 +00001085 // Now construct the skeleton CU associated.
Eric Christopher6fdf3242013-08-26 23:50:43 +00001086 CompileUnit *SkCU = constructSkeletonCU(TheCU);
Eric Christopher60eb7692013-08-12 20:27:48 +00001087 // This should be a unique identifier when we want to build .dwp files.
1088 SkCU->addUInt(SkCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopherd29614f2013-08-13 01:21:55 +00001089 dwarf::DW_FORM_data8, ID);
Eric Christopher60eb7692013-08-12 20:27:48 +00001090 }
1091 }
1092
1093 // Compute DIE offsets and sizes.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001094 InfoHolder.computeSizeAndOffsets();
1095 if (useSplitDwarf())
1096 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher960ac372012-11-22 00:59:49 +00001097}
1098
1099void DwarfDebug::endSections() {
Richard Mitton21101b32013-09-19 23:21:01 +00001100 // Filter labels by section.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001101 for (size_t n = 0; n < ArangeLabels.size(); n++) {
1102 const SymbolCU &SCU = ArangeLabels[n];
Richard Mitton21101b32013-09-19 23:21:01 +00001103 if (SCU.Sym->isInSection()) {
1104 // Make a note of this symbol and it's section.
1105 const MCSection *Section = &SCU.Sym->getSection();
1106 if (!Section->getKind().isMetadata())
1107 SectionMap[Section].push_back(SCU);
1108 } else {
1109 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1110 // appear in the output. This sucks as we rely on sections to build
1111 // arange spans. We can do it without, but it's icky.
1112 SectionMap[NULL].push_back(SCU);
1113 }
1114 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001115
Richard Mittonc2508242013-10-03 22:07:08 +00001116 // Build a list of sections used.
1117 std::vector<const MCSection *> Sections;
Richard Mitton21101b32013-09-19 23:21:01 +00001118 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1119 it++) {
1120 const MCSection *Section = it->first;
Richard Mittonc2508242013-10-03 22:07:08 +00001121 Sections.push_back(Section);
1122 }
1123
1124 // Sort the sections into order.
1125 // This is only done to ensure consistent output order across different runs.
1126 std::sort(Sections.begin(), Sections.end(), SectionSort);
1127
1128 // Add terminating symbols for each section.
1129 for (unsigned ID=0;ID<Sections.size();ID++) {
1130 const MCSection *Section = Sections[ID];
Richard Mitton21101b32013-09-19 23:21:01 +00001131 MCSymbol *Sym = NULL;
1132
1133 if (Section) {
Richard Mittonc2508242013-10-03 22:07:08 +00001134 // We can't call MCSection::getLabelEndName, as it's only safe to do so
1135 // if we know the section name up-front. For user-created sections, the resulting
1136 // label may not be valid to use as a label. (section names can use a greater
1137 // set of characters on some systems)
1138 Sym = Asm->GetTempSymbol("debug_end", ID);
Richard Mitton21101b32013-09-19 23:21:01 +00001139 Asm->OutStreamer.SwitchSection(Section);
1140 Asm->OutStreamer.EmitLabel(Sym);
1141 }
1142
1143 // Insert a final terminator.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001144 SectionMap[Section].push_back(SymbolCU(NULL, Sym));
Bill Wendling2b128d72009-05-20 23:19:06 +00001145 }
Eric Christopher960ac372012-11-22 00:59:49 +00001146}
Bill Wendling2b128d72009-05-20 23:19:06 +00001147
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001148// Emit all Dwarf sections that should come after the content.
Eric Christopher960ac372012-11-22 00:59:49 +00001149void DwarfDebug::endModule() {
1150
1151 if (!FirstCU) return;
1152
1153 // End any existing sections.
1154 // TODO: Does this need to happen?
1155 endSections();
1156
1157 // Finalize the debug info for the module.
1158 finalizeModuleInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001159
Eric Christophercdf218d2012-12-10 19:51:21 +00001160 if (!useSplitDwarf()) {
Eric Christopher9cd26af2013-09-20 23:22:52 +00001161 emitDebugStr();
1162
Eric Christopher95198f502012-11-27 22:43:42 +00001163 // Emit all the DIEs into a debug info section.
1164 emitDebugInfo();
Eric Christopher4c9b1192012-11-27 00:41:54 +00001165
Eric Christopher95198f502012-11-27 22:43:42 +00001166 // Corresponding abbreviations into a abbrev section.
1167 emitAbbreviations();
1168
1169 // Emit info into a debug loc section.
1170 emitDebugLoc();
1171
1172 // Emit info into a debug aranges section.
1173 emitDebugARanges();
1174
1175 // Emit info into a debug ranges section.
1176 emitDebugRanges();
1177
1178 // Emit info into a debug macinfo section.
1179 emitDebugMacInfo();
1180
Eric Christopher95198f502012-11-27 22:43:42 +00001181 } else {
Eric Christopherd692c1d2012-12-11 19:42:09 +00001182 // TODO: Fill this in for separated debug sections and separate
Eric Christopher95198f502012-11-27 22:43:42 +00001183 // out information into new sections.
Eric Christopher9cd26af2013-09-20 23:22:52 +00001184 emitDebugStr();
1185 if (useSplitDwarf())
1186 emitDebugStrDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001187
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001188 // Emit the debug info section and compile units.
Eric Christopher95198f502012-11-27 22:43:42 +00001189 emitDebugInfo();
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001190 emitDebugInfoDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001191
1192 // Corresponding abbreviations into a abbrev section.
1193 emitAbbreviations();
Eric Christopher3c5a1912012-12-19 22:02:53 +00001194 emitDebugAbbrevDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001195
1196 // Emit info into a debug loc section.
1197 emitDebugLoc();
1198
1199 // Emit info into a debug aranges section.
1200 emitDebugARanges();
1201
1202 // Emit info into a debug ranges section.
1203 emitDebugRanges();
1204
1205 // Emit info into a debug macinfo section.
1206 emitDebugMacInfo();
1207
Eric Christopher962c9082013-01-15 23:56:56 +00001208 // Emit DWO addresses.
1209 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1210
Eric Christopher95198f502012-11-27 22:43:42 +00001211 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001212
Eric Christophera876b822012-08-23 07:32:06 +00001213 // Emit info into the dwarf accelerator table sections.
Eric Christopher20b76a72012-08-23 22:36:40 +00001214 if (useDwarfAccelTables()) {
Eric Christopher4996c702011-11-07 09:24:32 +00001215 emitAccelNames();
1216 emitAccelObjC();
1217 emitAccelNamespaces();
1218 emitAccelTypes();
1219 }
Eric Christopher6a841382012-11-19 22:42:10 +00001220
Eric Christopher4b358182013-08-30 00:40:17 +00001221 // Emit the pubnames and pubtypes sections if requested.
1222 if (HasDwarfPubSections) {
David Blaikie70a33202013-09-19 17:33:35 +00001223 emitDebugPubNames(GenerateGnuPubSections);
1224 emitDebugPubTypes(GenerateGnuPubSections);
Eric Christopher4b358182013-08-30 00:40:17 +00001225 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001226
Devang Pateld0701282010-08-02 17:32:15 +00001227 // clean up.
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001228 SPMap.clear();
Devang Patel1a0df9a2010-05-10 22:49:55 +00001229 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1230 E = CUMap.end(); I != E; ++I)
1231 delete I->second;
Eric Christopher8afd7b62012-12-10 19:51:18 +00001232
Craig Topperd8e43652013-07-03 04:17:25 +00001233 for (SmallVectorImpl<CompileUnit *>::iterator I = SkeletonCUs.begin(),
Eric Christopher5b33b3c2013-02-06 21:53:56 +00001234 E = SkeletonCUs.end(); I != E; ++I)
1235 delete *I;
Eric Christopher8afd7b62012-12-10 19:51:18 +00001236
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001237 // Reset these for the next Module if we have one.
1238 FirstCU = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001239}
1240
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001241// Find abstract variable, if any, associated with Var.
Devang Patelbb23a4a2011-08-10 21:50:54 +00001242DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattner915c5f92010-04-02 19:42:39 +00001243 DebugLoc ScopeLoc) {
Devang Patelbb23a4a2011-08-10 21:50:54 +00001244 LLVMContext &Ctx = DV->getContext();
1245 // More then one inlined variable corresponds to one abstract variable.
1246 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001247 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001248 if (AbsDbgVariable)
1249 return AbsDbgVariable;
1250
Devang Patel7e623022011-08-10 20:55:27 +00001251 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001252 if (!Scope)
1253 return NULL;
1254
Manman Renb3388602013-10-05 01:43:03 +00001255 AbsDbgVariable = new DbgVariable(Var, NULL, this);
Devang Patel7e623022011-08-10 20:55:27 +00001256 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001257 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001258 return AbsDbgVariable;
1259}
1260
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001261// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel6c622ef2011-03-01 22:58:55 +00001262bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patel7e623022011-08-10 20:55:27 +00001263 DbgVariable *Var, LexicalScope *Scope) {
1264 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +00001265 return false;
1266 DIVariable DV = Var->getVariable();
1267 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1268 return false;
1269 unsigned ArgNo = DV.getArgNumber();
Eric Christopher6a841382012-11-19 22:42:10 +00001270 if (ArgNo == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001271 return false;
1272
Devang Patel4ab660b2011-03-03 20:02:02 +00001273 size_t Size = CurrentFnArguments.size();
1274 if (Size == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001275 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001276 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001277 // arguments does the function have at source level.
1278 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001279 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001280 CurrentFnArguments[ArgNo - 1] = Var;
1281 return true;
1282}
1283
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001284// Collect variable information from side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001285void
Nick Lewycky019d2552011-07-29 03:49:23 +00001286DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patel490c8ab2010-05-20 19:57:06 +00001287 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001288 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1289 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1290 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001291 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001292 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001293 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001294 DIVariable DV(Var);
1295 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001296
Devang Patel7e623022011-08-10 20:55:27 +00001297 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001298
Devang Patelcdb7d442009-11-10 23:20:04 +00001299 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001300 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001301 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001302
Devang Patele1c53f22010-05-20 16:36:41 +00001303 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Manman Renb3388602013-10-05 01:43:03 +00001304 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
Devang Patel3e4a9652011-08-15 21:24:36 +00001305 RegVar->setFrameIndex(VP.first);
Devang Patel6c622ef2011-03-01 22:58:55 +00001306 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001307 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001308 if (AbsDbgVariable)
Devang Patel3e4a9652011-08-15 21:24:36 +00001309 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patel475d32a2009-10-06 01:26:37 +00001310 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001311}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001312
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001313// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1314// defined reg.
Devang Patel9fc11702010-05-25 23:40:22 +00001315static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001316 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001317 return MI->getNumOperands() == 3 &&
1318 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
Adrian Prantl418d1d12013-07-09 20:28:37 +00001319 (MI->getOperand(1).isImm() ||
1320 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
Devang Patel9fc11702010-05-25 23:40:22 +00001321}
1322
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001323// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher6a841382012-11-19 22:42:10 +00001324static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1325 const MCSymbol *FLabel,
Devang Patel2442a892011-07-08 17:09:57 +00001326 const MCSymbol *SLabel,
1327 const MachineInstr *MI) {
1328 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1329
David Blaikie0252265b2013-06-16 20:34:15 +00001330 assert(MI->getNumOperands() == 3);
Adrian Prantl418d1d12013-07-09 20:28:37 +00001331 if (MI->getOperand(0).isReg()) {
Devang Patel2442a892011-07-08 17:09:57 +00001332 MachineLocation MLoc;
Adrian Prantl418d1d12013-07-09 20:28:37 +00001333 // If the second operand is an immediate, this is a
1334 // register-indirect address.
1335 if (!MI->getOperand(1).isImm())
Adrian Prantld4c0dd42013-04-26 21:57:17 +00001336 MLoc.set(MI->getOperand(0).getReg());
1337 else
1338 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel2442a892011-07-08 17:09:57 +00001339 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1340 }
1341 if (MI->getOperand(0).isImm())
1342 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1343 if (MI->getOperand(0).isFPImm())
1344 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1345 if (MI->getOperand(0).isCImm())
1346 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1347
Craig Topperee4dab52012-02-05 08:31:47 +00001348 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel2442a892011-07-08 17:09:57 +00001349}
1350
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001351// Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001352void
Devang Patel5c0f85c2010-06-25 22:07:34 +00001353DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1354 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001355
Eric Christopher270a12c2013-07-03 21:37:03 +00001356 // Grab the variable info that was squirreled away in the MMI side-table.
Devang Patel490c8ab2010-05-20 19:57:06 +00001357 collectVariableInfoFromMMITable(MF, Processed);
1358
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001359 for (SmallVectorImpl<const MDNode*>::const_iterator
1360 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1361 ++UVI) {
1362 const MDNode *Var = *UVI;
1363 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001364 continue;
1365
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001366 // History contains relevant DBG_VALUE instructions for Var and instructions
1367 // clobbering it.
1368 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1369 if (History.empty())
1370 continue;
1371 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001372
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001373 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001374 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001375 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1376 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +00001377 Scope = LScopes.getCurrentFunctionScope();
David Blaikiedc69ebb2013-03-11 23:39:23 +00001378 else if (MDNode *IA = DV.getInlinedAt())
1379 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1380 else
1381 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel490c8ab2010-05-20 19:57:06 +00001382 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001383 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001384 continue;
1385
1386 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001387 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel99819b52011-08-15 19:01:20 +00001388 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
Manman Renb3388602013-10-05 01:43:03 +00001389 DbgVariable *RegVar = new DbgVariable(DV, AbsVar, this);
Devang Patel6c622ef2011-03-01 22:58:55 +00001390 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001391 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001392 if (AbsVar)
Devang Patel3e4a9652011-08-15 21:24:36 +00001393 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001394
Eric Christophercc10d202012-10-08 20:48:54 +00001395 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001396 if (History.size() <= 1 || (History.size() == 2 &&
1397 MInsn->isIdenticalTo(History.back()))) {
Devang Patel3e4a9652011-08-15 21:24:36 +00001398 RegVar->setMInsn(MInsn);
Devang Patel9fc11702010-05-25 23:40:22 +00001399 continue;
1400 }
1401
Eric Christopher59cc0712013-01-28 17:33:26 +00001402 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001403 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001404
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001405 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1406 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1407 const MachineInstr *Begin = *HI;
1408 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001409
Devang Patele7181b52011-06-01 23:00:17 +00001410 // Check if DBG_VALUE is truncating a range.
1411 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1412 && !Begin->getOperand(0).getReg())
1413 continue;
1414
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001415 // Compute the range for a register location.
1416 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1417 const MCSymbol *SLabel = 0;
1418
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001419 if (HI + 1 == HE)
1420 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001421 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001422 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001423 else {
1424 const MachineInstr *End = HI[1];
Eric Christopher6a841382012-11-19 22:42:10 +00001425 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel53b050a2011-07-07 21:44:42 +00001426 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001427 if (End->isDebugValue())
1428 SLabel = getLabelBeforeInsn(End);
1429 else {
1430 // End is a normal instruction clobbering the range.
1431 SLabel = getLabelAfterInsn(End);
1432 assert(SLabel && "Forgot label after clobber instruction");
1433 ++HI;
1434 }
1435 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001436
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001437 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopher365d0832011-12-16 23:42:31 +00001438 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1439 Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001440 }
1441 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001442 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001443
1444 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001445 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1446 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1447 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1448 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001449 if (!DV || !DV.isVariable() || !Processed.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001450 continue;
1451 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001452 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patele0a94bf2010-05-14 21:01:35 +00001453 }
Devang Patel9fc11702010-05-25 23:40:22 +00001454}
Devang Patele0a94bf2010-05-14 21:01:35 +00001455
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001456// Return Label preceding the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001457MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001458 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1459 assert(Label && "Didn't insert label before instruction");
1460 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001461}
1462
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001463// Return Label immediately following the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001464MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001465 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001466}
1467
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001468// Process beginning of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001469void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001470 // Check if source location changes, but ignore DBG_VALUE locations.
1471 if (!MI->isDebugValue()) {
1472 DebugLoc DL = MI->getDebugLoc();
1473 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopheraec8a822012-04-05 20:39:05 +00001474 unsigned Flags = 0;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001475 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001476 if (DL == PrologEndLoc) {
1477 Flags |= DWARF2_FLAG_PROLOGUE_END;
1478 PrologEndLoc = DebugLoc();
1479 }
Eric Christopheraec8a822012-04-05 20:39:05 +00001480 if (PrologEndLoc.isUnknown())
1481 Flags |= DWARF2_FLAG_IS_STMT;
1482
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001483 if (!DL.isUnknown()) {
1484 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001485 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001486 } else
Devang Patel34a66202011-05-11 19:22:19 +00001487 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001488 }
Devang Patel9fc11702010-05-25 23:40:22 +00001489 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001490
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001491 // Insert labels where requested.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001492 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1493 LabelsBeforeInsn.find(MI);
1494
1495 // No label needed.
1496 if (I == LabelsBeforeInsn.end())
1497 return;
1498
1499 // Label already assigned.
1500 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001501 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001502
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001503 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001504 PrevLabel = MMI->getContext().CreateTempSymbol();
1505 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001506 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001507 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001508}
1509
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001510// Process end of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001511void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001512 // Don't create a new label after DBG_VALUE instructions.
1513 // They don't generate code.
1514 if (!MI->isDebugValue())
1515 PrevLabel = 0;
1516
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001517 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1518 LabelsAfterInsn.find(MI);
1519
1520 // No label needed.
1521 if (I == LabelsAfterInsn.end())
1522 return;
1523
1524 // Label already assigned.
1525 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001526 return;
1527
1528 // We need a label after this instruction.
1529 if (!PrevLabel) {
1530 PrevLabel = MMI->getContext().CreateTempSymbol();
1531 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001532 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001533 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001534}
1535
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001536// Each LexicalScope has first instruction and last instruction to mark
1537// beginning and end of a scope respectively. Create an inverse map that list
1538// scopes starts (and ends) with an instruction. One instruction may start (or
1539// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001540void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001541 SmallVector<LexicalScope *, 4> WorkList;
1542 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001543 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001544 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001545
Craig Topper977e9cd2013-07-03 04:24:43 +00001546 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001547 if (!Children.empty())
Craig Topperd8e43652013-07-03 04:17:25 +00001548 for (SmallVectorImpl<LexicalScope *>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00001549 SE = Children.end(); SI != SE; ++SI)
1550 WorkList.push_back(*SI);
1551
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001552 if (S->isAbstractScope())
1553 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001554
Craig Topper977e9cd2013-07-03 04:24:43 +00001555 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001556 if (Ranges.empty())
1557 continue;
Craig Topperd8e43652013-07-03 04:17:25 +00001558 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +00001559 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001560 assert(RI->first && "InsnRange does not have first instruction!");
1561 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001562 requestLabelBeforeInsn(RI->first);
1563 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001564 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001565 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001566}
1567
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001568// Get MDNode for DebugLoc's scope.
Devang Patel589845d2011-05-09 22:14:49 +00001569static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1570 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1571 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1572 return DL.getScope(Ctx);
1573}
1574
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001575// Walk up the scope chain of given debug loc and find line number info
1576// for the function.
Devang Patel34a66202011-05-11 19:22:19 +00001577static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1578 const MDNode *Scope = getScopeNode(DL, Ctx);
1579 DISubprogram SP = getDISubprogram(Scope);
Manman Ren7504ed42013-07-08 18:33:29 +00001580 if (SP.isSubprogram()) {
Eric Christopher34164192012-04-03 00:43:49 +00001581 // Check for number of operands since the compatibility is
1582 // cheap here.
Eric Christopherb81e2b42012-04-03 17:55:42 +00001583 if (SP->getNumOperands() > 19)
Eric Christopher34164192012-04-03 00:43:49 +00001584 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1585 else
1586 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1587 }
1588
Devang Patel34a66202011-05-11 19:22:19 +00001589 return DebugLoc();
1590}
1591
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001592// Gather pre-function debug information. Assumes being called immediately
1593// after the function entry point has been emitted.
Chris Lattner76555b52010-01-26 23:18:02 +00001594void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00001595 if (!MMI->hasDebugInfo()) return;
Devang Patel7e623022011-08-10 20:55:27 +00001596 LScopes.initialize(*MF);
1597 if (LScopes.empty()) return;
1598 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001599
Manman Ren4e042a62013-02-05 21:52:47 +00001600 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1601 // belongs to.
1602 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1603 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1604 assert(TheCU && "Unable to find compile unit!");
Rafael Espindolaac4ad252013-10-05 16:42:21 +00001605 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren9d4c7352013-05-21 00:57:22 +00001606 // Use a single line table if we are using .loc and generating assembly.
1607 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1608 else
1609 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
Manman Ren4e042a62013-02-05 21:52:47 +00001610
Devang Patel6c74a872010-04-27 19:46:33 +00001611 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1612 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001613 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001614 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001615
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001616 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1617
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001618 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001619 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001620 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1621
Devang Patel002d54d2010-05-26 19:37:24 +00001622 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001623 I != E; ++I) {
1624 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001625 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1626 II != IE; ++II) {
1627 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001628
Devang Patel002d54d2010-05-26 19:37:24 +00001629 if (MI->isDebugValue()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001630 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001631
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001632 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001633 const MDNode *Var =
1634 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001635
1636 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001637 if (isDbgValueInDefinedReg(MI))
1638 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1639
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001640 // Check the history of this variable.
1641 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1642 if (History.empty()) {
1643 UserVariables.push_back(Var);
1644 // The first mention of a function argument gets the FunctionBeginSym
1645 // label, so arguments are visible when breaking at function entry.
1646 DIVariable DV(Var);
Manman Ren7504ed42013-07-08 18:33:29 +00001647 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001648 DISubprogram(getDISubprogram(DV.getContext()))
1649 .describes(MF->getFunction()))
1650 LabelsBeforeInsn[MI] = FunctionBeginSym;
1651 } else {
1652 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1653 const MachineInstr *Prev = History.back();
1654 if (Prev->isDebugValue()) {
1655 // Coalesce identical entries at the end of History.
1656 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001657 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher85a495e2012-10-08 20:48:49 +00001658 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher6a841382012-11-19 22:42:10 +00001659 << "\t" << *Prev
Devang Patelb7a328e2011-07-07 00:14:27 +00001660 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001661 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001662 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001663
1664 // Terminate old register assignments that don't reach MI;
1665 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1666 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1667 isDbgValueInDefinedReg(Prev)) {
1668 // Previous register assignment needs to terminate at the end of
1669 // its basic block.
1670 MachineBasicBlock::const_iterator LastMI =
1671 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001672 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001673 // Drop DBG_VALUE for empty range.
Eric Christopher85a495e2012-10-08 20:48:49 +00001674 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patelb7a328e2011-07-07 00:14:27 +00001675 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001676 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001677 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001678 // Terminate after LastMI.
1679 History.push_back(LastMI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001680 }
1681 }
1682 }
1683 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001684 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001685 // Not a DBG_VALUE instruction.
1686 if (!MI->isLabel())
1687 AtBlockEntry = false;
1688
Eric Christopher133195782012-10-04 20:46:14 +00001689 // First known non-DBG_VALUE and non-frame setup location marks
1690 // the beginning of the function body.
1691 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1692 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel34a66202011-05-11 19:22:19 +00001693 PrologEndLoc = MI->getDebugLoc();
1694
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001695 // Check if the instruction clobbers any registers with debug vars.
1696 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1697 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1698 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1699 continue;
Jakob Stoklund Olesen54038d72012-06-01 23:28:30 +00001700 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1701 AI.isValid(); ++AI) {
1702 unsigned Reg = *AI;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001703 const MDNode *Var = LiveUserVar[Reg];
1704 if (!Var)
1705 continue;
1706 // Reg is now clobbered.
1707 LiveUserVar[Reg] = 0;
1708
1709 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001710 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1711 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001712 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001713 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1714 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001715 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001716 const MachineInstr *Prev = History.back();
1717 // Sanity-check: Register assignments are terminated at the end of
1718 // their block.
1719 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1720 continue;
1721 // Is the variable still in Reg?
1722 if (!isDbgValueInDefinedReg(Prev) ||
1723 Prev->getOperand(0).getReg() != Reg)
1724 continue;
1725 // Var is clobbered. Make sure the next instruction gets a label.
1726 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001727 }
1728 }
Devang Patel002d54d2010-05-26 19:37:24 +00001729 }
Devang Patel002d54d2010-05-26 19:37:24 +00001730 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001731 }
1732
1733 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1734 I != E; ++I) {
1735 SmallVectorImpl<const MachineInstr*> &History = I->second;
1736 if (History.empty())
1737 continue;
1738
1739 // Make sure the final register assignments are terminated.
1740 const MachineInstr *Prev = History.back();
1741 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1742 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher6a841382012-11-19 22:42:10 +00001743 MachineBasicBlock::const_iterator LastMI =
Devang Patel784077e2011-08-10 23:58:09 +00001744 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001745 if (LastMI == PrevMBB->end())
1746 // Drop DBG_VALUE for empty range.
1747 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001748 else if (PrevMBB != &PrevMBB->getParent()->back()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001749 // Terminate after LastMI.
1750 History.push_back(LastMI);
1751 }
1752 }
1753 // Request labels for the full history.
1754 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1755 const MachineInstr *MI = History[i];
1756 if (MI->isDebugValue())
1757 requestLabelBeforeInsn(MI);
1758 else
1759 requestLabelAfterInsn(MI);
1760 }
1761 }
Devang Patel002d54d2010-05-26 19:37:24 +00001762
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001763 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001764 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001765
1766 // Record beginning of function.
1767 if (!PrologEndLoc.isUnknown()) {
1768 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1769 MF->getFunction()->getContext());
1770 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1771 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie67cb31e2012-12-04 22:02:33 +00001772 // We'd like to list the prologue as "not statements" but GDB behaves
1773 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikie5a773bb2012-12-04 21:05:36 +00001774 DWARF2_FLAG_IS_STMT);
Devang Patel34a66202011-05-11 19:22:19 +00001775 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001776}
1777
Devang Patel7e623022011-08-10 20:55:27 +00001778void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
David Blaikie6f1a8062013-06-05 05:39:59 +00001779 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1780 DIVariable DV = Var->getVariable();
David Blaikie36d5d2f2013-06-06 21:04:51 +00001781 // Variables with positive arg numbers are parameters.
1782 if (unsigned ArgNum = DV.getArgNumber()) {
1783 // Keep all parameters in order at the start of the variable list to ensure
1784 // function types are correct (no out-of-order parameters)
1785 //
1786 // This could be improved by only doing it for optimized builds (unoptimized
1787 // builds have the right order to begin with), searching from the back (this
1788 // would catch the unoptimized case quickly), or doing a binary search
1789 // rather than linear search.
1790 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1791 while (I != Vars.end()) {
1792 unsigned CurNum = (*I)->getVariable().getArgNumber();
1793 // A local (non-parameter) variable has been found, insert immediately
1794 // before it.
1795 if (CurNum == 0)
1796 break;
1797 // A later indexed parameter has been found, insert immediately before it.
David Blaikieb272a752013-06-06 22:28:26 +00001798 if (CurNum > ArgNum)
David Blaikie36d5d2f2013-06-06 21:04:51 +00001799 break;
David Blaikieb272a752013-06-06 22:28:26 +00001800 ++I;
David Blaikie6f1a8062013-06-05 05:39:59 +00001801 }
David Blaikie36d5d2f2013-06-06 21:04:51 +00001802 Vars.insert(I, Var);
1803 return;
David Blaikie6f1a8062013-06-05 05:39:59 +00001804 }
1805
1806 Vars.push_back(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001807}
1808
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001809// Gather and emit post-function debug information.
Chris Lattner76555b52010-01-26 23:18:02 +00001810void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patel7e623022011-08-10 20:55:27 +00001811 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00001812
Devang Patel7e623022011-08-10 20:55:27 +00001813 // Define end label for subprogram.
1814 FunctionEndSym = Asm->GetTempSymbol("func_end",
1815 Asm->getFunctionNumber());
1816 // Assumes in correct section after the entry point.
1817 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Manman Ren4e042a62013-02-05 21:52:47 +00001818 // Set DwarfCompileUnitID in MCContext to default value.
1819 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher6a841382012-11-19 22:42:10 +00001820
Devang Patel7e623022011-08-10 20:55:27 +00001821 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1822 collectVariableInfo(MF, ProcessedVars);
Eric Christopher6a841382012-11-19 22:42:10 +00001823
Devang Patel3acc70e2011-08-15 22:04:40 +00001824 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001825 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001826 assert(TheCU && "Unable to find compile unit!");
Devang Patel3acc70e2011-08-15 22:04:40 +00001827
Devang Patel7e623022011-08-10 20:55:27 +00001828 // Construct abstract scopes.
Devang Patel44403472011-08-12 18:10:19 +00001829 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1830 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1831 LexicalScope *AScope = AList[i];
1832 DISubprogram SP(AScope->getScopeNode());
Manman Ren7504ed42013-07-08 18:33:29 +00001833 if (SP.isSubprogram()) {
Devang Patel7e623022011-08-10 20:55:27 +00001834 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001835 DIArray Variables = SP.getVariables();
1836 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1837 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001838 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001839 continue;
Alexey Samsonov39602782012-07-06 08:45:08 +00001840 // Check that DbgVariable for DV wasn't created earlier, when
1841 // findAbstractVariable() was called for inlined instance of DV.
1842 LLVMContext &Ctx = DV->getContext();
1843 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1844 if (AbstractVariables.lookup(CleanDV))
1845 continue;
Devang Patel59e27c52011-08-19 23:28:12 +00001846 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001847 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001848 }
1849 }
Devang Patel44403472011-08-12 18:10:19 +00001850 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Manman Ren4213c392013-05-29 17:16:59 +00001851 constructScopeDIE(TheCU, AScope);
Bill Wendling2b128d72009-05-20 23:19:06 +00001852 }
Eric Christopher6a841382012-11-19 22:42:10 +00001853
Devang Patel3acc70e2011-08-15 22:04:40 +00001854 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher6a841382012-11-19 22:42:10 +00001855
Nick Lewycky50f02cb2011-12-02 22:16:29 +00001856 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopherbb69a272012-08-24 01:14:27 +00001857 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Patel3acc70e2011-08-15 22:04:40 +00001858
Bill Wendling2b128d72009-05-20 23:19:06 +00001859 // Clear debug info
Craig Topper2b4a2012013-07-03 04:40:27 +00001860 for (ScopeVariablesMap::iterator
Devang Patel7e623022011-08-10 20:55:27 +00001861 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1862 DeleteContainerPointers(I->second);
1863 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001864 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001865 UserVariables.clear();
1866 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001867 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001868 LabelsBeforeInsn.clear();
1869 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001870 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001871}
1872
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001873// Register a source line with debug info. Returns the unique label that was
1874// emitted and which provides correspondence to the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00001875void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1876 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00001877 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00001878 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00001879 unsigned Src = 1;
1880 if (S) {
1881 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00001882
Dan Gohman50849c62010-05-05 23:41:32 +00001883 if (Scope.isCompileUnit()) {
1884 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001885 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001886 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00001887 } else if (Scope.isFile()) {
1888 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00001889 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001890 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001891 } else if (Scope.isSubprogram()) {
1892 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001893 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001894 Dir = SP.getDirectory();
Eric Christopher6647b832011-10-11 22:59:11 +00001895 } else if (Scope.isLexicalBlockFile()) {
1896 DILexicalBlockFile DBF(S);
1897 Fn = DBF.getFilename();
1898 Dir = DBF.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001899 } else if (Scope.isLexicalBlock()) {
1900 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001901 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001902 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001903 } else
Craig Topperee4dab52012-02-05 08:31:47 +00001904 llvm_unreachable("Unexpected scope info");
Dan Gohman50849c62010-05-05 23:41:32 +00001905
Manman Ren1e427202013-03-07 01:42:00 +00001906 Src = getOrCreateSourceID(Fn, Dir,
1907 Asm->OutStreamer.getContext().getDwarfCompileUnitID());
Dan Gohman50849c62010-05-05 23:41:32 +00001908 }
Nick Lewycky019d2552011-07-29 03:49:23 +00001909 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00001910}
1911
Bill Wendling806535f2009-05-20 23:22:40 +00001912//===----------------------------------------------------------------------===//
1913// Emit Methods
1914//===----------------------------------------------------------------------===//
1915
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001916// Compute the size and offset of a DIE.
Jim Grosbach00e9c612009-11-22 19:20:36 +00001917unsigned
Eric Christopherc8a310e2012-12-10 23:34:43 +00001918DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling480ff322009-05-20 23:21:38 +00001919 // Get the children.
1920 const std::vector<DIE *> &Children = Die->getChildren();
1921
Bill Wendling480ff322009-05-20 23:21:38 +00001922 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00001923 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00001924
1925 // Get the abbreviation for this DIE.
1926 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopherc8a310e2012-12-10 23:34:43 +00001927 const DIEAbbrev *Abbrev = Abbreviations->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00001928
1929 // Set DIE offset
1930 Die->setOffset(Offset);
1931
1932 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00001933 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001934
Eric Christopher4887c8f2013-03-29 23:34:06 +00001935 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1936 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling480ff322009-05-20 23:21:38 +00001937
1938 // Size the DIE attribute values.
1939 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1940 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001941 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001942
1943 // Size the DIE children if any.
1944 if (!Children.empty()) {
1945 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1946 "Children flag not set");
1947
1948 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001949 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling480ff322009-05-20 23:21:38 +00001950
1951 // End of children marker.
1952 Offset += sizeof(int8_t);
1953 }
1954
1955 Die->setSize(Offset - Die->getOffset());
1956 return Offset;
1957}
1958
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001959// Compute the size and offset of all the DIEs.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001960void DwarfUnits::computeSizeAndOffsets() {
Manman Ren14a029d2013-03-12 18:27:15 +00001961 // Offset from the beginning of debug info section.
Eric Christopher4887c8f2013-03-29 23:34:06 +00001962 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopherc8a310e2012-12-10 23:34:43 +00001963 E = CUs.end(); I != E; ++I) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001964 unsigned Offset =
1965 sizeof(int32_t) + // Length of Compilation Unit Info
1966 sizeof(int16_t) + // DWARF version number
1967 sizeof(int32_t) + // Offset Into Abbrev. Section
1968 sizeof(int8_t); // Pointer Size (in bytes)
Eric Christopherc19d6f02013-10-04 19:40:33 +00001969 computeSizeAndOffset((*I)->getCUDie(), Offset);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001970 }
Bill Wendling480ff322009-05-20 23:21:38 +00001971}
1972
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001973// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001974void DwarfDebug::emitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001975 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001976
Bill Wendling480ff322009-05-20 23:21:38 +00001977 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001978 DwarfInfoSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001979 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001980 DwarfAbbrevSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001981 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher3c5a1912012-12-19 22:02:53 +00001982 if (useSplitDwarf())
1983 DwarfAbbrevDWOSectionSym =
1984 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1985 "section_abbrev_dwo");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001986 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001987
Chris Lattner6629ca92010-04-04 22:59:04 +00001988 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001989 emitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00001990
Eric Christopher74804332013-02-07 21:19:50 +00001991 DwarfLineSectionSym =
1992 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001993 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Eric Christopher261d2342013-09-23 20:55:35 +00001994 if (GenerateGnuPubSections) {
Eric Christopher39eebfa2013-09-30 23:14:16 +00001995 DwarfGnuPubNamesSectionSym =
1996 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
1997 DwarfGnuPubTypesSectionSym =
1998 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
Eric Christopher261d2342013-09-23 20:55:35 +00001999 } else if (HasDwarfPubSections) {
2000 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2001 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Michael Gottesmanc89466f2013-09-04 04:39:38 +00002002 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002003
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002004 DwarfStrSectionSym =
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002005 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002006 if (useSplitDwarf()) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002007 DwarfStrDWOSectionSym =
2008 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002009 DwarfAddrSectionSym =
2010 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
2011 }
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002012 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patel12563b32010-04-16 23:33:45 +00002013 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00002014
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002015 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patel9fc11702010-05-25 23:40:22 +00002016 "section_debug_loc");
2017
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002018 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
2019 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002020}
2021
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002022// Recursively emits a debug information entry.
Eric Christopher3c5a1912012-12-19 22:02:53 +00002023void DwarfDebug::emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs) {
Bill Wendling480ff322009-05-20 23:21:38 +00002024 // Get the abbreviation for this DIE.
2025 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher3c5a1912012-12-19 22:02:53 +00002026 const DIEAbbrev *Abbrev = Abbrevs->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00002027
Bill Wendling480ff322009-05-20 23:21:38 +00002028 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00002029 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00002030 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2031 Twine::utohexstr(Die->getOffset()) + ":0x" +
2032 Twine::utohexstr(Die->getSize()) + " " +
2033 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00002034 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00002035
Eric Christopher4887c8f2013-03-29 23:34:06 +00002036 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
2037 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling480ff322009-05-20 23:21:38 +00002038
2039 // Emit the DIE attribute values.
2040 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2041 unsigned Attr = AbbrevData[i].getAttribute();
2042 unsigned Form = AbbrevData[i].getForm();
2043 assert(Form && "Too many attributes for DIE (check abbreviation)");
2044
Chris Lattner7bde8c02010-04-04 18:52:31 +00002045 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00002046 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002047
Bill Wendling480ff322009-05-20 23:21:38 +00002048 switch (Attr) {
Eric Christophere595bae2013-10-04 17:08:38 +00002049 case dwarf::DW_AT_abstract_origin: {
Bill Wendling480ff322009-05-20 23:21:38 +00002050 DIEEntry *E = cast<DIEEntry>(Values[i]);
2051 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002052 unsigned Addr = Origin->getOffset();
Eric Christopherc19d6f02013-10-04 19:40:33 +00002053 Asm->EmitInt32(Addr);
Bill Wendling480ff322009-05-20 23:21:38 +00002054 break;
2055 }
Devang Patel12563b32010-04-16 23:33:45 +00002056 case dwarf::DW_AT_ranges: {
2057 // DW_AT_range Value encodes offset in debug_range section.
2058 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00002059
Nick Lewycky33da3362012-06-22 01:25:12 +00002060 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelda3ef852010-09-02 16:43:44 +00002061 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
2062 V->getValue(),
2063 4);
2064 } else {
2065 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
2066 V->getValue(),
2067 DwarfDebugRangeSectionSym,
2068 4);
2069 }
Devang Patel12563b32010-04-16 23:33:45 +00002070 break;
2071 }
Devang Patel9fc11702010-05-25 23:40:22 +00002072 case dwarf::DW_AT_location: {
Nick Lewycky33da3362012-06-22 01:25:12 +00002073 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2074 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002075 Asm->EmitLabelReference(L->getValue(), 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002076 else
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002077 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002078 } else {
Devang Patel9fc11702010-05-25 23:40:22 +00002079 Values[i]->EmitValue(Asm, Form);
Nick Lewycky33da3362012-06-22 01:25:12 +00002080 }
Devang Patel9fc11702010-05-25 23:40:22 +00002081 break;
2082 }
Devang Patela1bd5a12010-09-29 19:08:08 +00002083 case dwarf::DW_AT_accessibility: {
2084 if (Asm->isVerbose()) {
2085 DIEInteger *V = cast<DIEInteger>(Values[i]);
2086 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2087 }
2088 Values[i]->EmitValue(Asm, Form);
2089 break;
2090 }
Bill Wendling480ff322009-05-20 23:21:38 +00002091 default:
2092 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002093 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00002094 break;
2095 }
Bill Wendling480ff322009-05-20 23:21:38 +00002096 }
2097
2098 // Emit the DIE children if any.
2099 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2100 const std::vector<DIE *> &Children = Die->getChildren();
2101
2102 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher3c5a1912012-12-19 22:02:53 +00002103 emitDIE(Children[j], Abbrevs);
Bill Wendling480ff322009-05-20 23:21:38 +00002104
Chris Lattner7bde8c02010-04-04 18:52:31 +00002105 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00002106 Asm->OutStreamer.AddComment("End Of Children Mark");
2107 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00002108 }
2109}
2110
Eric Christophera2de8262012-12-15 00:04:07 +00002111// Emit the various dwarf units to the unit section USection with
2112// the abbreviations going into ASection.
2113void DwarfUnits::emitUnits(DwarfDebug *DD,
2114 const MCSection *USection,
2115 const MCSection *ASection,
2116 const MCSymbol *ASectionSym) {
2117 Asm->OutStreamer.SwitchSection(USection);
Eric Christopher4887c8f2013-03-29 23:34:06 +00002118 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christophera2de8262012-12-15 00:04:07 +00002119 E = CUs.end(); I != E; ++I) {
2120 CompileUnit *TheCU = *I;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002121 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002122
Devang Patel1a0df9a2010-05-10 22:49:55 +00002123 // Emit the compile units header.
Eric Christophera2de8262012-12-15 00:04:07 +00002124 Asm->OutStreamer
2125 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
2126 TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002127
Devang Patel1a0df9a2010-05-10 22:49:55 +00002128 // Emit size of content not including length itself
2129 unsigned ContentSize = Die->getSize() +
2130 sizeof(int16_t) + // DWARF version number
2131 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patele141234942011-04-13 19:41:17 +00002132 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002133
Devang Patel1a0df9a2010-05-10 22:49:55 +00002134 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2135 Asm->EmitInt32(ContentSize);
2136 Asm->OutStreamer.AddComment("DWARF version number");
Manman Renac8062b2013-07-02 23:40:10 +00002137 Asm->EmitInt16(DD->getDwarfVersion());
Devang Patel1a0df9a2010-05-10 22:49:55 +00002138 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
Eric Christophera2de8262012-12-15 00:04:07 +00002139 Asm->EmitSectionOffset(Asm->GetTempSymbol(ASection->getLabelBeginName()),
2140 ASectionSym);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002141 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002142 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002143
Eric Christopher3c5a1912012-12-19 22:02:53 +00002144 DD->emitDIE(Die, Abbreviations);
Eric Christophera2de8262012-12-15 00:04:07 +00002145 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
Eli Benderskyb42d1462012-12-03 18:45:45 +00002146 TheCU->getUniqueID()));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002147 }
Bill Wendling480ff322009-05-20 23:21:38 +00002148}
2149
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002150// Emit the debug info section.
2151void DwarfDebug::emitDebugInfo() {
Eric Christophera2de8262012-12-15 00:04:07 +00002152 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2153
2154 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
2155 Asm->getObjFileLowering().getDwarfAbbrevSection(),
2156 DwarfAbbrevSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002157}
2158
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002159// Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +00002160void DwarfDebug::emitAbbreviations() {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002161 if (!useSplitDwarf())
2162 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
2163 &Abbreviations);
2164 else
2165 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2166}
Bill Wendling480ff322009-05-20 23:21:38 +00002167
Eric Christopher3c5a1912012-12-19 22:02:53 +00002168void DwarfDebug::emitAbbrevs(const MCSection *Section,
2169 std::vector<DIEAbbrev *> *Abbrevs) {
2170 // Check to see if it is worth the effort.
2171 if (!Abbrevs->empty()) {
2172 // Start the debug abbrev section.
2173 Asm->OutStreamer.SwitchSection(Section);
2174
2175 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
Eric Christopher996b2b72012-12-13 03:00:38 +00002176 Asm->OutStreamer.EmitLabel(Begin);
Bill Wendling480ff322009-05-20 23:21:38 +00002177
2178 // For each abbrevation.
Eric Christopher3c5a1912012-12-19 22:02:53 +00002179 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
Bill Wendling480ff322009-05-20 23:21:38 +00002180 // Get abbreviation data
Eric Christopher3c5a1912012-12-19 22:02:53 +00002181 const DIEAbbrev *Abbrev = Abbrevs->at(i);
Bill Wendling480ff322009-05-20 23:21:38 +00002182
2183 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00002184 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00002185
2186 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002187 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00002188 }
2189
2190 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00002191 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00002192
Eric Christopher3c5a1912012-12-19 22:02:53 +00002193 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
Eric Christopher996b2b72012-12-13 03:00:38 +00002194 Asm->OutStreamer.EmitLabel(End);
Bill Wendling480ff322009-05-20 23:21:38 +00002195 }
2196}
2197
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002198// Emit the last address of the section and the end of the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +00002199void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00002200 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00002201 Asm->OutStreamer.AddComment("Extended Op");
2202 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002203
Chris Lattner566cae92010-03-09 23:52:58 +00002204 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002205 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00002206 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2207 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2208
2209 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002210
Chris Lattnera179b522010-04-04 19:25:43 +00002211 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Eric Christopherce0cfce2013-01-09 01:35:34 +00002212 Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002213
2214 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00002215 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2216 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002217 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00002218 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002219}
2220
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002221// Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00002222void DwarfDebug::emitAccelNames() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002223 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002224 dwarf::DW_FORM_data4));
2225 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2226 E = CUMap.end(); I != E; ++I) {
2227 CompileUnit *TheCU = I->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00002228 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2229 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002230 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002231 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002232 const std::vector<DIE *> &Entities = GI->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00002233 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2234 DE = Entities.end(); DI != DE; ++DI)
2235 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00002236 }
2237 }
2238
2239 AT.FinalizeTable(Asm, "Names");
2240 Asm->OutStreamer.SwitchSection(
2241 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2242 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2243 Asm->OutStreamer.EmitLabel(SectionBegin);
2244
2245 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002246 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002247}
2248
Eric Christopher48fef592012-12-20 21:58:40 +00002249// Emit objective C classes and categories into a hashed accelerator table
2250// section.
Eric Christopher4996c702011-11-07 09:24:32 +00002251void DwarfDebug::emitAccelObjC() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002252 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002253 dwarf::DW_FORM_data4));
2254 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2255 E = CUMap.end(); I != E; ++I) {
2256 CompileUnit *TheCU = I->second;
2257 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2258 for (StringMap<std::vector<DIE*> >::const_iterator
2259 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002260 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002261 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher4996c702011-11-07 09:24:32 +00002262 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2263 DE = Entities.end(); DI != DE; ++DI)
2264 AT.AddName(Name, (*DI));
2265 }
2266 }
2267
2268 AT.FinalizeTable(Asm, "ObjC");
2269 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2270 .getDwarfAccelObjCSection());
2271 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2272 Asm->OutStreamer.EmitLabel(SectionBegin);
2273
2274 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002275 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002276}
2277
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002278// Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002279void DwarfDebug::emitAccelNamespaces() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002280 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002281 dwarf::DW_FORM_data4));
2282 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2283 E = CUMap.end(); I != E; ++I) {
2284 CompileUnit *TheCU = I->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00002285 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2286 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002287 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002288 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002289 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00002290 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2291 DE = Entities.end(); DI != DE; ++DI)
2292 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00002293 }
2294 }
2295
2296 AT.FinalizeTable(Asm, "namespac");
2297 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2298 .getDwarfAccelNamespaceSection());
2299 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2300 Asm->OutStreamer.EmitLabel(SectionBegin);
2301
2302 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002303 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002304}
2305
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002306// Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002307void DwarfDebug::emitAccelTypes() {
Eric Christopher21bde872012-01-06 04:35:23 +00002308 std::vector<DwarfAccelTable::Atom> Atoms;
Eric Christophercf7289f2013-09-05 18:20:16 +00002309 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher21bde872012-01-06 04:35:23 +00002310 dwarf::DW_FORM_data4));
Eric Christophercf7289f2013-09-05 18:20:16 +00002311 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag,
Eric Christopher21bde872012-01-06 04:35:23 +00002312 dwarf::DW_FORM_data2));
Eric Christophercf7289f2013-09-05 18:20:16 +00002313 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags,
Eric Christopher21bde872012-01-06 04:35:23 +00002314 dwarf::DW_FORM_data1));
2315 DwarfAccelTable AT(Atoms);
Eric Christopher4996c702011-11-07 09:24:32 +00002316 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2317 E = CUMap.end(); I != E; ++I) {
2318 CompileUnit *TheCU = I->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002319 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2320 = TheCU->getAccelTypes();
2321 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002322 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002323 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002324 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002325 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2326 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2327 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher4996c702011-11-07 09:24:32 +00002328 }
2329 }
2330
2331 AT.FinalizeTable(Asm, "types");
2332 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2333 .getDwarfAccelTypesSection());
2334 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2335 Asm->OutStreamer.EmitLabel(SectionBegin);
2336
2337 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002338 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002339}
2340
Eric Christopherdd1a0122013-09-13 00:35:05 +00002341// Public name handling.
2342// The format for the various pubnames:
2343//
2344// dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2345// for the DIE that is named.
2346//
2347// gnu pubnames - offset/index value/name tuples where the offset is the offset
2348// into the CU and the index value is computed according to the type of value
2349// for the DIE that is named.
2350//
2351// For type units the offset is the offset of the skeleton DIE. For split dwarf
2352// it's the offset within the debug_info/debug_types dwo section, however, the
2353// reference in the pubname header doesn't change.
2354
2355/// computeIndexValue - Compute the gdb index value for the DIE and CU.
David Blaikie8dec4072013-09-19 20:40:26 +00002356static dwarf::PubIndexEntryDescriptor computeIndexValue(CompileUnit *CU,
2357 DIE *Die) {
Eric Christopherccac5c42013-09-23 22:59:14 +00002358 dwarf::GDBIndexEntryLinkage Linkage =
David Blaikie8dec4072013-09-19 20:40:26 +00002359 Die->findAttribute(dwarf::DW_AT_external) ? dwarf::GIEL_EXTERNAL
2360 : dwarf::GIEL_STATIC;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002361
2362 switch (Die->getTag()) {
2363 case dwarf::DW_TAG_class_type:
2364 case dwarf::DW_TAG_structure_type:
2365 case dwarf::DW_TAG_union_type:
2366 case dwarf::DW_TAG_enumeration_type:
Eric Christopher261d2342013-09-23 20:55:35 +00002367 return dwarf::PubIndexEntryDescriptor(
2368 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2369 ? dwarf::GIEL_STATIC
2370 : dwarf::GIEL_EXTERNAL);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002371 case dwarf::DW_TAG_typedef:
2372 case dwarf::DW_TAG_base_type:
2373 case dwarf::DW_TAG_subrange_type:
David Blaikie8dec4072013-09-19 20:40:26 +00002374 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002375 case dwarf::DW_TAG_namespace:
David Blaikie8dec4072013-09-19 20:40:26 +00002376 return dwarf::GIEK_TYPE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002377 case dwarf::DW_TAG_subprogram:
Eric Christopherccac5c42013-09-23 22:59:14 +00002378 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002379 case dwarf::DW_TAG_constant:
2380 case dwarf::DW_TAG_variable:
Eric Christopherccac5c42013-09-23 22:59:14 +00002381 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002382 case dwarf::DW_TAG_enumerator:
David Blaikie8dec4072013-09-19 20:40:26 +00002383 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2384 dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002385 default:
David Blaikie8dec4072013-09-19 20:40:26 +00002386 return dwarf::GIEK_NONE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002387 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002388}
2389
Eric Christopher5f93bb92013-09-09 20:03:17 +00002390/// emitDebugPubNames - Emit visible names into a debug pubnames section.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002391///
Eric Christopherdd1a0122013-09-13 00:35:05 +00002392void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002393 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christopherdd1a0122013-09-13 00:35:05 +00002394 const MCSection *PSec =
2395 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2396 : Asm->getObjFileLowering().getDwarfPubNamesSection();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002397
2398 typedef DenseMap<const MDNode*, CompileUnit*> CUMapType;
2399 for (CUMapType::iterator I = CUMap.begin(), E = CUMap.end(); I != E; ++I) {
2400 CompileUnit *TheCU = I->second;
2401 unsigned ID = TheCU->getUniqueID();
2402
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002403 // Start the dwarf pubnames section.
Eric Christopher13b99d22013-09-10 21:49:37 +00002404 Asm->OutStreamer.SwitchSection(PSec);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002405
Eric Christopher39eebfa2013-09-30 23:14:16 +00002406 // Emit a label so we can reference the beginning of this pubname section.
2407 if (GnuStyle)
2408 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames",
2409 TheCU->getUniqueID()));
2410
Eric Christopherdd1a0122013-09-13 00:35:05 +00002411 // Emit the header.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002412 Asm->OutStreamer.AddComment("Length of Public Names Info");
2413 Asm->EmitLabelDifference(Asm->GetTempSymbol("pubnames_end", ID),
2414 Asm->GetTempSymbol("pubnames_begin", ID), 4);
2415
2416 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin", ID));
2417
2418 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002419 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002420
2421 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2422 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2423 DwarfInfoSectionSym);
2424
2425 Asm->OutStreamer.AddComment("Compilation Unit Length");
2426 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(), ID),
2427 Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2428 4);
2429
Eric Christopherdd1a0122013-09-13 00:35:05 +00002430 // Emit the pubnames for this compilation unit.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002431 const StringMap<DIE*> &Globals = TheCU->getGlobalNames();
2432 for (StringMap<DIE*>::const_iterator
2433 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2434 const char *Name = GI->getKeyData();
Eric Christopherdd1a0122013-09-13 00:35:05 +00002435 DIE *Entity = GI->second;
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002436
2437 Asm->OutStreamer.AddComment("DIE offset");
2438 Asm->EmitInt32(Entity->getOffset());
2439
Eric Christopherdd1a0122013-09-13 00:35:05 +00002440 if (GnuStyle) {
David Blaikied0a869d2013-09-19 22:19:37 +00002441 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2442 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002443 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002444 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002445 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002446 }
2447
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002448 if (Asm->isVerbose())
2449 Asm->OutStreamer.AddComment("External Name");
Rafael Espindola64e1af82013-07-02 15:49:13 +00002450 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002451 }
2452
2453 Asm->OutStreamer.AddComment("End Mark");
2454 Asm->EmitInt32(0);
2455 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end", ID));
2456 }
2457}
2458
Eric Christopherdd1a0122013-09-13 00:35:05 +00002459void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
Eric Christopher8b3737f2013-09-13 00:34:58 +00002460 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christopher261d2342013-09-23 20:55:35 +00002461 const MCSection *PSec =
2462 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2463 : Asm->getObjFileLowering().getDwarfPubTypesSection();
Eric Christopher8b3737f2013-09-13 00:34:58 +00002464
Devang Patel1a0df9a2010-05-10 22:49:55 +00002465 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
Eric Christopher8b3737f2013-09-13 00:34:58 +00002466 E = CUMap.end();
2467 I != E; ++I) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002468 CompileUnit *TheCU = I->second;
Eric Christopher6abc9c52011-11-07 09:18:35 +00002469 // Start the dwarf pubtypes section.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002470 Asm->OutStreamer.SwitchSection(PSec);
Eric Christopher39eebfa2013-09-30 23:14:16 +00002471
2472 // Emit a label so we can reference the beginning of this pubtype section.
2473 if (GnuStyle)
2474 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes",
2475 TheCU->getUniqueID()));
2476
2477 // Emit the header.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002478 Asm->OutStreamer.AddComment("Length of Public Types Info");
2479 Asm->EmitLabelDifference(
Eric Christopher8b3737f2013-09-13 00:34:58 +00002480 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2481 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002482
Eric Christopher8b3737f2013-09-13 00:34:58 +00002483 Asm->OutStreamer.EmitLabel(
2484 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002485
Eric Christopher8b3737f2013-09-13 00:34:58 +00002486 if (Asm->isVerbose())
2487 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002488 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002489
Devang Patel1a0df9a2010-05-10 22:49:55 +00002490 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002491 Asm->EmitSectionOffset(
2492 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()),
2493 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002494
Devang Patel1a0df9a2010-05-10 22:49:55 +00002495 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002496 Asm->EmitLabelDifference(
2497 Asm->GetTempSymbol(ISec->getLabelEndName(), TheCU->getUniqueID()),
2498 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002499
Eric Christopher39eebfa2013-09-30 23:14:16 +00002500 // Emit the pubtypes.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002501 const StringMap<DIE *> &Globals = TheCU->getGlobalTypes();
2502 for (StringMap<DIE *>::const_iterator GI = Globals.begin(),
2503 GE = Globals.end();
2504 GI != GE; ++GI) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002505 const char *Name = GI->getKeyData();
Nick Lewycky019d2552011-07-29 03:49:23 +00002506 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002507
Eric Christopher8b3737f2013-09-13 00:34:58 +00002508 if (Asm->isVerbose())
2509 Asm->OutStreamer.AddComment("DIE offset");
Devang Patel1a0df9a2010-05-10 22:49:55 +00002510 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002511
Eric Christopherdd1a0122013-09-13 00:35:05 +00002512 if (GnuStyle) {
David Blaikied0a869d2013-09-19 22:19:37 +00002513 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2514 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002515 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002516 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002517 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002518 }
2519
Eric Christopher8b3737f2013-09-13 00:34:58 +00002520 if (Asm->isVerbose())
2521 Asm->OutStreamer.AddComment("External Name");
2522
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002523 // Emit the name with a terminating null byte.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002524 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002525 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002526
Devang Patel1a0df9a2010-05-10 22:49:55 +00002527 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002528 Asm->EmitInt32(0);
Eric Christopher8b3737f2013-09-13 00:34:58 +00002529 Asm->OutStreamer.EmitLabel(
2530 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00002531 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002532}
2533
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002534// Emit strings into a string section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002535void DwarfUnits::emitStrings(const MCSection *StrSection,
2536 const MCSection *OffsetSection = NULL,
2537 const MCSymbol *StrSecSym = NULL) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002538
Eric Christopher27614582013-01-08 22:22:06 +00002539 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002540
Chris Lattner3d72a672010-03-09 23:38:23 +00002541 // Start the dwarf str section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002542 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling480ff322009-05-20 23:21:38 +00002543
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002544 // Get all of the string pool entries and put them in an array by their ID so
2545 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002546 SmallVector<std::pair<unsigned,
Eric Christopherb800ff72013-01-07 22:40:45 +00002547 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002548
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002549 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
Eric Christopher27614582013-01-08 22:22:06 +00002550 I = StringPool.begin(), E = StringPool.end();
Eric Christopher48fef592012-12-20 21:58:40 +00002551 I != E; ++I)
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002552 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002553
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002554 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002555
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002556 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002557 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002558 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002559
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002560 // Emit the string itself with a terminating null byte.
Benjamin Kramer148db362011-11-09 12:12:04 +00002561 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
Eric Christopherce0cfce2013-01-09 01:35:34 +00002562 Entries[i].second->getKeyLength()+1));
Bill Wendling480ff322009-05-20 23:21:38 +00002563 }
Eric Christopher2cbd5762013-01-07 19:32:41 +00002564
2565 // If we've got an offset section go ahead and emit that now as well.
2566 if (OffsetSection) {
2567 Asm->OutStreamer.SwitchSection(OffsetSection);
2568 unsigned offset = 0;
Eric Christopher962c9082013-01-15 23:56:56 +00002569 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002570 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopherbf7bc492013-01-09 03:52:05 +00002571 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopher2cbd5762013-01-07 19:32:41 +00002572 offset += Entries[i].second->getKeyLength() + 1;
2573 }
2574 }
Bill Wendling480ff322009-05-20 23:21:38 +00002575}
2576
Eric Christopher962c9082013-01-15 23:56:56 +00002577// Emit strings into a string section.
2578void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2579
2580 if (AddressPool.empty()) return;
2581
2582 // Start the dwarf addr section.
2583 Asm->OutStreamer.SwitchSection(AddrSection);
2584
David Blaikiece1960f2013-07-08 17:51:28 +00002585 // Order the address pool entries by ID
David Blaikieac569a62013-07-08 17:33:10 +00002586 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher962c9082013-01-15 23:56:56 +00002587
David Blaikiece1960f2013-07-08 17:51:28 +00002588 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2589 E = AddressPool.end();
Eric Christopher962c9082013-01-15 23:56:56 +00002590 I != E; ++I)
David Blaikieac569a62013-07-08 17:33:10 +00002591 Entries[I->second] = I->first;
Eric Christopher962c9082013-01-15 23:56:56 +00002592
2593 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002594 // Emit an expression for reference from debug information entries.
David Blaikieac569a62013-07-08 17:33:10 +00002595 if (const MCExpr *Expr = Entries[i])
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002596 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
Eric Christopher962c9082013-01-15 23:56:56 +00002597 else
2598 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2599 }
2600
2601}
2602
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002603// Emit visible names into a debug str section.
2604void DwarfDebug::emitDebugStr() {
2605 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2606 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2607}
2608
Eric Christopher9046f942013-07-02 21:36:07 +00002609// Emit locations into the debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002610void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002611 if (DotDebugLocEntries.empty())
2612 return;
2613
Eric Christopher4887c8f2013-03-29 23:34:06 +00002614 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Devang Patel116a9d72011-02-04 22:57:18 +00002615 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2616 I != E; ++I) {
2617 DotDebugLocEntry &Entry = *I;
2618 if (I + 1 != DotDebugLocEntries.end())
2619 Entry.Merge(I+1);
2620 }
2621
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002622 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002623 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00002624 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002625 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002626 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2627 unsigned index = 1;
Eric Christopher4887c8f2013-03-29 23:34:06 +00002628 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002629 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002630 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002631 DotDebugLocEntry &Entry = *I;
2632 if (Entry.isMerged()) continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002633 if (Entry.isEmpty()) {
Eric Christopherce0cfce2013-01-09 01:35:34 +00002634 Asm->OutStreamer.EmitIntValue(0, Size);
2635 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002636 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002637 } else {
Eric Christopher25f06422013-07-03 22:40:18 +00002638 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2639 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2640 DIVariable DV(Entry.getVariable());
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002641 Asm->OutStreamer.AddComment("Loc expr size");
2642 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2643 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2644 Asm->EmitLabelDifference(end, begin, 2);
2645 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002646 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002647 DIBasicType BTy(DV.getType());
2648 if (BTy.Verify() &&
Eric Christopher6a841382012-11-19 22:42:10 +00002649 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patel324f8432011-06-01 22:03:25 +00002650 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2651 Asm->OutStreamer.AddComment("DW_OP_consts");
2652 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002653 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002654 } else {
2655 Asm->OutStreamer.AddComment("DW_OP_constu");
2656 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002657 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002658 }
Devang Pateled9fd452011-07-08 16:49:43 +00002659 } else if (Entry.isLocation()) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002660 MachineLocation Loc = Entry.getLoc();
Eric Christopher6a841382012-11-19 22:42:10 +00002661 if (!DV.hasComplexAddress())
Devang Pateled9fd452011-07-08 16:49:43 +00002662 // Regular entry.
Eric Christopher614a89f2013-07-03 22:40:21 +00002663 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002664 else {
2665 // Complex address entry.
2666 unsigned N = DV.getNumAddrElements();
2667 unsigned i = 0;
2668 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002669 if (Loc.getOffset()) {
Devang Pateled9fd452011-07-08 16:49:43 +00002670 i = 2;
Eric Christopher614a89f2013-07-03 22:40:21 +00002671 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002672 Asm->OutStreamer.AddComment("DW_OP_deref");
2673 Asm->EmitInt8(dwarf::DW_OP_deref);
2674 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2675 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2676 Asm->EmitSLEB128(DV.getAddrElement(1));
2677 } else {
2678 // If first address element is OpPlus then emit
2679 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher614a89f2013-07-03 22:40:21 +00002680 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2681 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002682 i = 2;
2683 }
2684 } else {
Eric Christopher614a89f2013-07-03 22:40:21 +00002685 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002686 }
Eric Christopher6a841382012-11-19 22:42:10 +00002687
Devang Pateled9fd452011-07-08 16:49:43 +00002688 // Emit remaining complex address elements.
2689 for (; i < N; ++i) {
2690 uint64_t Element = DV.getAddrElement(i);
2691 if (Element == DIBuilder::OpPlus) {
2692 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2693 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher4d250522012-05-08 18:56:00 +00002694 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002695 if (!Loc.isReg())
Eric Christopher4d250522012-05-08 18:56:00 +00002696 Asm->EmitInt8(dwarf::DW_OP_deref);
2697 } else
2698 llvm_unreachable("unknown Opcode found in complex address");
Devang Pateled9fd452011-07-08 16:49:43 +00002699 }
Devang Patel3e021532011-04-28 02:22:40 +00002700 }
Devang Patel3e021532011-04-28 02:22:40 +00002701 }
Devang Pateled9fd452011-07-08 16:49:43 +00002702 // else ... ignore constant fp. There is not any good way to
2703 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002704 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002705 }
2706 }
Bill Wendling480ff322009-05-20 23:21:38 +00002707}
2708
Richard Mitton21101b32013-09-19 23:21:01 +00002709struct SymbolCUSorter {
2710 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2711 const MCStreamer &Streamer;
2712
2713 bool operator() (const SymbolCU &A, const SymbolCU &B) {
2714 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2715 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2716
2717 // Symbols with no order assigned should be placed at the end.
2718 // (e.g. section end labels)
2719 if (IA == 0)
2720 IA = (unsigned)(-1);
2721 if (IB == 0)
2722 IB = (unsigned)(-1);
2723 return IA < IB;
2724 }
2725};
2726
Richard Mitton21101b32013-09-19 23:21:01 +00002727static bool CUSort(const CompileUnit *A, const CompileUnit *B) {
2728 return (A->getUniqueID() < B->getUniqueID());
2729}
2730
2731struct ArangeSpan {
2732 const MCSymbol *Start, *End;
2733};
2734
2735// Emit a debug aranges section, containing a CU lookup for any
2736// address we can tie back to a CU.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002737void DwarfDebug::emitDebugARanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002738 // Start the dwarf aranges section.
Eric Christopherac8199b2013-08-30 00:39:57 +00002739 Asm->OutStreamer
2740 .SwitchSection(Asm->getObjFileLowering().getDwarfARangesSection());
Richard Mitton21101b32013-09-19 23:21:01 +00002741
2742 typedef DenseMap<CompileUnit *, std::vector<ArangeSpan> > SpansType;
2743
2744 SpansType Spans;
2745
2746 // Build a list of sections used.
2747 std::vector<const MCSection *> Sections;
2748 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2749 it++) {
2750 const MCSection *Section = it->first;
2751 Sections.push_back(Section);
2752 }
2753
2754 // Sort the sections into order.
2755 // This is only done to ensure consistent output order across different runs.
2756 std::sort(Sections.begin(), Sections.end(), SectionSort);
2757
2758 // Build a set of address spans, sorted by CU.
2759 for (size_t SecIdx=0;SecIdx<Sections.size();SecIdx++) {
2760 const MCSection *Section = Sections[SecIdx];
2761 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2762 if (List.size() < 2)
2763 continue;
2764
2765 // Sort the symbols by offset within the section.
2766 SymbolCUSorter sorter(Asm->OutStreamer);
2767 std::sort(List.begin(), List.end(), sorter);
2768
2769 // If we have no section (e.g. common), just write out
2770 // individual spans for each symbol.
2771 if (Section == NULL) {
2772 for (size_t n = 0; n < List.size(); n++) {
2773 const SymbolCU &Cur = List[n];
2774
2775 ArangeSpan Span;
2776 Span.Start = Cur.Sym;
2777 Span.End = NULL;
2778 if (Cur.CU)
2779 Spans[Cur.CU].push_back(Span);
2780 }
2781 } else {
2782 // Build spans between each label.
2783 const MCSymbol *StartSym = List[0].Sym;
2784 for (size_t n = 1; n < List.size(); n++) {
2785 const SymbolCU &Prev = List[n - 1];
2786 const SymbolCU &Cur = List[n];
2787
2788 // Try and build the longest span we can within the same CU.
2789 if (Cur.CU != Prev.CU) {
2790 ArangeSpan Span;
2791 Span.Start = StartSym;
2792 Span.End = Cur.Sym;
2793 Spans[Prev.CU].push_back(Span);
2794 StartSym = Cur.Sym;
2795 }
2796 }
2797 }
2798 }
2799
2800 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2801 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2802
2803 // Build a list of CUs used.
2804 std::vector<CompileUnit *> CUs;
2805 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
2806 CompileUnit *CU = it->first;
2807 CUs.push_back(CU);
2808 }
2809
2810 // Sort the CU list (again, to ensure consistent output order).
2811 std::sort(CUs.begin(), CUs.end(), CUSort);
2812
2813 // Emit an arange table for each CU we used.
2814 for (size_t CUIdx=0;CUIdx<CUs.size();CUIdx++) {
2815 CompileUnit *CU = CUs[CUIdx];
2816 std::vector<ArangeSpan> &List = Spans[CU];
2817
2818 // Emit size of content not including length itself.
2819 unsigned ContentSize
2820 = sizeof(int16_t) // DWARF ARange version number
2821 + sizeof(int32_t) // Offset of CU in the .debug_info section
2822 + sizeof(int8_t) // Pointer Size (in bytes)
2823 + sizeof(int8_t); // Segment Size (in bytes)
2824
2825 unsigned TupleSize = PtrSize * 2;
2826
2827 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2828 unsigned Padding = 0;
2829 while (((sizeof(int32_t) + ContentSize + Padding) % TupleSize) != 0)
2830 Padding++;
2831
2832 ContentSize += Padding;
2833 ContentSize += (List.size() + 1) * TupleSize;
2834
2835 // For each compile unit, write the list of spans it covers.
2836 Asm->OutStreamer.AddComment("Length of ARange Set");
2837 Asm->EmitInt32(ContentSize);
2838 Asm->OutStreamer.AddComment("DWARF Arange version number");
2839 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2840 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
2841 Asm->EmitSectionOffset(
2842 Asm->GetTempSymbol(ISec->getLabelBeginName(), CU->getUniqueID()),
2843 DwarfInfoSectionSym);
2844 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2845 Asm->EmitInt8(PtrSize);
2846 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2847 Asm->EmitInt8(0);
2848
2849 for (unsigned n = 0; n < Padding; n++)
2850 Asm->EmitInt8(0xff);
2851
2852 for (unsigned n = 0; n < List.size(); n++) {
2853 const ArangeSpan &Span = List[n];
2854 Asm->EmitLabelReference(Span.Start, PtrSize);
2855
2856 // Calculate the size as being from the span start to it's end.
Richard Mitton089ed892013-09-23 17:56:20 +00002857 if (Span.End) {
Richard Mitton21101b32013-09-19 23:21:01 +00002858 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
Richard Mitton089ed892013-09-23 17:56:20 +00002859 } else {
2860 // For symbols without an end marker (e.g. common), we
2861 // write a single arange entry containing just that one symbol.
2862 uint64_t Size = SymSize[Span.Start];
2863 if (Size == 0)
2864 Size = 1;
2865
2866 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2867 }
Richard Mitton21101b32013-09-19 23:21:01 +00002868 }
2869
2870 Asm->OutStreamer.AddComment("ARange terminator");
2871 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2872 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2873 }
Bill Wendling480ff322009-05-20 23:21:38 +00002874}
2875
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002876// Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002877void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002878 // Start the dwarf ranges section.
Eric Christopherac8199b2013-08-30 00:39:57 +00002879 Asm->OutStreamer
2880 .SwitchSection(Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002881 unsigned char Size = Asm->getDataLayout().getPointerSize();
Eric Christopher4887c8f2013-03-29 23:34:06 +00002882 for (SmallVectorImpl<const MCSymbol *>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002883 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00002884 I != E; ++I) {
2885 if (*I)
Eric Christopherbf7bc492013-01-09 03:52:05 +00002886 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
Devang Patel12563b32010-04-16 23:33:45 +00002887 else
Eric Christopherce0cfce2013-01-09 01:35:34 +00002888 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel12563b32010-04-16 23:33:45 +00002889 }
Bill Wendling480ff322009-05-20 23:21:38 +00002890}
2891
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002892// Emit visible names into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002893void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002894 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00002895 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00002896 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002897 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00002898 }
2899}
2900
Eric Christopherd692c1d2012-12-11 19:42:09 +00002901// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002902
2903// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2904// 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 +00002905// DW_AT_ranges_base, DW_AT_addr_base.
Eric Christopher6fdf3242013-08-26 23:50:43 +00002906CompileUnit *DwarfDebug::constructSkeletonCU(const CompileUnit *CU) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002907
2908 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher6fdf3242013-08-26 23:50:43 +00002909 CompileUnit *NewCU = new CompileUnit(CU->getUniqueID(), Die, CU->getNode(),
2910 Asm, this, &SkeletonHolder);
Eric Christopher4c7765f2013-01-17 03:00:04 +00002911
Eric Christopherdae389b2013-02-22 23:50:08 +00002912 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
Eric Christopher6b16b432013-08-26 23:57:03 +00002913 DICompileUnit(CU->getNode()).getSplitDebugFilename());
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002914
Eric Christopher44c6aa62013-04-22 07:51:08 +00002915 // Relocate to the beginning of the addr_base section, else 0 for the
2916 // beginning of the one for this compile unit.
Eric Christopher55863be2013-04-07 03:43:09 +00002917 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2918 NewCU->addLabel(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2919 DwarfAddrSectionSym);
2920 else
Eric Christopher44c6aa62013-04-22 07:51:08 +00002921 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base,
2922 dwarf::DW_FORM_sec_offset, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002923
2924 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher962c9082013-01-15 23:56:56 +00002925 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002926 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher962c9082013-01-15 23:56:56 +00002927
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002928 // DW_AT_stmt_list is a offset of line number information for this
2929 // compile unit in debug_line section.
Eric Christopher55863be2013-04-07 03:43:09 +00002930 // FIXME: Should handle multiple compile units.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002931 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher4c7765f2013-01-17 03:00:04 +00002932 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher74804332013-02-07 21:19:50 +00002933 DwarfLineSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002934 else
Eric Christopher4c7765f2013-01-17 03:00:04 +00002935 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002936
2937 if (!CompilationDir.empty())
Eric Christopher2cbd5762013-01-07 19:32:41 +00002938 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002939
Eric Christopher1d06eb52013-10-01 00:43:31 +00002940 // Flags to let the linker know we have emitted new style pubnames.
Eric Christopher39eebfa2013-09-30 23:14:16 +00002941 if (GenerateGnuPubSections) {
2942 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2943 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_sec_offset,
2944 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()));
2945 else
2946 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
2947 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()),
2948 DwarfGnuPubNamesSectionSym);
2949
2950 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2951 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_sec_offset,
2952 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()));
2953 else
2954 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopherf976c772013-10-03 17:41:16 +00002955 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()),
Eric Christopher39eebfa2013-09-30 23:14:16 +00002956 DwarfGnuPubTypesSectionSym);
2957 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002958
Eric Christopher9a08f9e2013-10-01 00:43:36 +00002959 // Flag if we've emitted any ranges and their location for the compile unit.
2960 if (DebugRangeSymbols.size()) {
2961 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2962 NewCU->addLabel(Die, dwarf::DW_AT_GNU_ranges_base,
2963 dwarf::DW_FORM_sec_offset, DwarfDebugRangeSectionSym);
2964 else
2965 NewCU->addUInt(Die, dwarf::DW_AT_GNU_ranges_base, dwarf::DW_FORM_data4,
2966 0);
2967 }
2968
Eric Christopherc8a310e2012-12-10 23:34:43 +00002969 SkeletonHolder.addUnit(NewCU);
Eric Christopher5b33b3c2013-02-06 21:53:56 +00002970 SkeletonCUs.push_back(NewCU);
Eric Christopherc8a310e2012-12-10 23:34:43 +00002971
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002972 return NewCU;
2973}
2974
Eric Christopher3c5a1912012-12-19 22:02:53 +00002975void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
2976 assert(useSplitDwarf() && "No split dwarf debug info?");
2977 emitAbbrevs(Section, &SkeletonAbbrevs);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002978}
2979
Eric Christopherd692c1d2012-12-11 19:42:09 +00002980// Emit the .debug_info.dwo section for separated dwarf. This contains the
2981// compile units that would normally be in debug_info.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002982void DwarfDebug::emitDebugInfoDWO() {
Eric Christophercdf218d2012-12-10 19:51:21 +00002983 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christophera2de8262012-12-15 00:04:07 +00002984 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
Eric Christopher3c5a1912012-12-19 22:02:53 +00002985 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2986 DwarfAbbrevDWOSectionSym);
2987}
2988
2989// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2990// abbreviations for the .debug_info.dwo section.
2991void DwarfDebug::emitDebugAbbrevDWO() {
2992 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopher48fef592012-12-20 21:58:40 +00002993 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2994 &Abbreviations);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002995}
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002996
2997// Emit the .debug_str.dwo section for separated dwarf. This contains the
2998// string section and is identical in format to traditional .debug_str
2999// sections.
3000void DwarfDebug::emitDebugStrDWO() {
3001 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherb800ff72013-01-07 22:40:45 +00003002 const MCSection *OffSec = Asm->getObjFileLowering()
3003 .getDwarfStrOffDWOSection();
Eric Christopher2cbd5762013-01-07 19:32:41 +00003004 const MCSymbol *StrSym = DwarfStrSectionSym;
3005 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
3006 OffSec, StrSym);
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003007}