blob: 6414969774b2490b98639be80ba8299bd1529f6e [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)
152 subType = 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())
158 return (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
315// Add the various names to the Dwarf accelerator table names.
Eric Christopher9cd26af2013-09-20 23:22:52 +0000316// TODO: Determine whether or not we should add names for programs
317// that do not have a DW_AT_name or DW_AT_linkage_name field - this
318// is only slightly different than the lookup of non-standard ObjC names.
Eric Christopherd9843b32011-11-10 19:25:34 +0000319static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
320 DIE* Die) {
321 if (!SP.isDefinition()) return;
Eric Christopherd9843b32011-11-10 19:25:34 +0000322 TheCU->addAccelName(SP.getName(), Die);
323
324 // If the linkage name is different than the name, go ahead and output
325 // that as well into the name table.
326 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
327 TheCU->addAccelName(SP.getLinkageName(), Die);
328
329 // If this is an Objective-C selector name add it to the ObjC accelerator
330 // too.
331 if (isObjCClass(SP.getName())) {
332 StringRef Class, Category;
333 getObjCClassCategory(SP.getName(), Class, Category);
334 TheCU->addAccelObjC(Class, Die);
335 if (Category != "")
336 TheCU->addAccelObjC(Category, Die);
337 // Also add the base method name to the name table.
338 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
339 }
340}
341
Manman Ren3eb9dff2013-09-09 19:05:21 +0000342/// isSubprogramContext - Return true if Context is either a subprogram
343/// or another context nested inside a subprogram.
344bool DwarfDebug::isSubprogramContext(const MDNode *Context) {
345 if (!Context)
346 return false;
347 DIDescriptor D(Context);
348 if (D.isSubprogram())
349 return true;
350 if (D.isType())
Manman Ren116868e2013-09-09 19:47:11 +0000351 return isSubprogramContext(resolve(DIType(Context).getContext()));
Manman Ren3eb9dff2013-09-09 19:05:21 +0000352 return false;
353}
354
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000355// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
356// and DW_AT_high_pc attributes. If there are global variables in this
357// scope then create and insert DIEs for these variables.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000358DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
359 const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000360 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +0000361
Chris Lattner3a383cb2010-04-05 00:13:49 +0000362 assert(SPDie && "Unable to find subprogram DIE!");
363 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000364
Bill Wendlingf720bf62012-11-07 05:19:04 +0000365 // If we're updating an abstract DIE, then we will be adding the children and
366 // object pointer later on. But what we don't want to do is process the
367 // concrete DIE twice.
Manman Ren14a029d2013-03-12 18:27:15 +0000368 DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode);
369 if (AbsSPDIE) {
370 bool InSameCU = (AbsSPDIE->getCompileUnit() == SPCU->getCUDie());
Bill Wendlingf720bf62012-11-07 05:19:04 +0000371 // Pick up abstract subprogram DIE.
Devang Patela37a95e2010-07-07 22:20:57 +0000372 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Manman Ren14a029d2013-03-12 18:27:15 +0000373 // If AbsSPDIE belongs to a different CU, use DW_FORM_ref_addr instead of
374 // DW_FORM_ref4.
Devang Patelf20c4f72011-04-12 22:53:02 +0000375 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
Manman Ren14a029d2013-03-12 18:27:15 +0000376 InSameCU ? dwarf::DW_FORM_ref4 : dwarf::DW_FORM_ref_addr,
377 AbsSPDIE);
Devang Patela37a95e2010-07-07 22:20:57 +0000378 SPCU->addDie(SPDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000379 } else {
380 DISubprogram SPDecl = SP.getFunctionDeclaration();
381 if (!SPDecl.isSubprogram()) {
382 // There is not any need to generate specification DIE for a function
383 // defined at compile unit level. If a function is defined inside another
384 // function then gdb prefers the definition at top level and but does not
385 // expect specification DIE in parent function. So avoid creating
386 // specification DIE for a function defined inside a function.
387 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
388 !SP.getContext().isFile() &&
389 !isSubprogramContext(SP.getContext())) {
390 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
391
392 // Add arguments.
393 DICompositeType SPTy = SP.getType();
394 DIArray Args = SPTy.getTypeArray();
Eric Christopher31b05762013-08-08 01:41:00 +0000395 uint16_t SPTag = SPTy.getTag();
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000396 if (SPTag == dwarf::DW_TAG_subroutine_type)
397 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
398 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
399 DIType ATy = DIType(Args.getElement(i));
400 SPCU->addType(Arg, ATy);
401 if (ATy.isArtificial())
402 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
403 if (ATy.isObjectPointer())
404 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer,
405 dwarf::DW_FORM_ref4, Arg);
406 SPDie->addChild(Arg);
407 }
408 DIE *SPDeclDie = SPDie;
409 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Eric Christopher6a841382012-11-19 22:42:10 +0000410 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification,
411 dwarf::DW_FORM_ref4, SPDeclDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000412 SPCU->addDie(SPDie);
413 }
414 }
Devang Patela37a95e2010-07-07 22:20:57 +0000415 }
416
Eric Christopher962c9082013-01-15 23:56:56 +0000417 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc,
418 Asm->GetTempSymbol("func_begin",
419 Asm->getFunctionNumber()));
420 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
421 Asm->GetTempSymbol("func_end",
422 Asm->getFunctionNumber()));
Chris Lattner3a383cb2010-04-05 00:13:49 +0000423 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
424 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000425 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000426
Eric Christopherd9843b32011-11-10 19:25:34 +0000427 // Add name to the name table, we do this here because we're guaranteed
428 // to have concrete versions of our DW_TAG_subprogram nodes.
429 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher6a841382012-11-19 22:42:10 +0000430
Chris Lattner3a383cb2010-04-05 00:13:49 +0000431 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000432}
433
Manman Ren5b2f4b02013-09-11 19:40:28 +0000434/// Check whether we should create a DIE for the given Scope, return true
435/// if we don't create a DIE (the corresponding DIE is null).
Manman Ren2312ed32013-09-10 18:40:41 +0000436bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
437 if (Scope->isAbstractScope())
438 return false;
439
Manman Ren5b2f4b02013-09-11 19:40:28 +0000440 // We don't create a DIE if there is no Range.
Manman Ren2312ed32013-09-10 18:40:41 +0000441 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
442 if (Ranges.empty())
443 return true;
444
445 if (Ranges.size() > 1)
446 return false;
447
Manman Ren5b2f4b02013-09-11 19:40:28 +0000448 // We don't create a DIE if we have a single Range and the end label
449 // is null.
Manman Ren2312ed32013-09-10 18:40:41 +0000450 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
451 MCSymbol *End = getLabelAfterInsn(RI->second);
452 return !End;
453}
454
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000455// Construct new DW_TAG_lexical_block for this scope and attach
456// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher6a841382012-11-19 22:42:10 +0000457DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000458 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000459 if (isLexicalScopeDIENull(Scope))
460 return 0;
461
Devang Patel6c74a872010-04-27 19:46:33 +0000462 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
463 if (Scope->isAbstractScope())
464 return ScopeDIE;
465
Craig Topper977e9cd2013-07-03 04:24:43 +0000466 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Eric Christopherdc42ea82013-07-03 01:57:28 +0000467 // If we have multiple ranges, emit them into the range section.
Devang Patel6c74a872010-04-27 19:46:33 +0000468 if (Ranges.size() > 1) {
469 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000470 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +0000471 // DW_AT_ranges appropriately.
Devang Patelf20c4f72011-04-12 22:53:02 +0000472 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000473 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000474 * Asm->getDataLayout().getPointerSize());
Craig Topperd8e43652013-07-03 04:17:25 +0000475 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +0000476 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +0000477 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
478 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +0000479 }
Eric Christopherc1110832013-07-03 01:22:29 +0000480
481 // Terminate the range list.
Devang Patel6c74a872010-04-27 19:46:33 +0000482 DebugRangeSymbols.push_back(NULL);
483 DebugRangeSymbols.push_back(NULL);
484 return ScopeDIE;
485 }
486
Eric Christopherdc42ea82013-07-03 01:57:28 +0000487 // Construct the address range for this DIE.
Craig Topperd8e43652013-07-03 04:17:25 +0000488 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopher962c9082013-01-15 23:56:56 +0000489 MCSymbol *Start = getLabelBeforeInsn(RI->first);
490 MCSymbol *End = getLabelAfterInsn(RI->second);
Manman Ren2312ed32013-09-10 18:40:41 +0000491 assert(End && "End label should not be null!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000492
Chris Lattnere13c3722010-03-09 01:58:53 +0000493 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
494 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000495
Eric Christopher962c9082013-01-15 23:56:56 +0000496 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
497 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000498
499 return ScopeDIE;
500}
501
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000502// This scope represents inlined body of a function. Construct DIE to
503// represent this concrete inlined copy of the function.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000504DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
505 LexicalScope *Scope) {
Craig Topper977e9cd2013-07-03 04:24:43 +0000506 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000507 assert(Ranges.empty() == false &&
508 "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000509
Devang Patelf098ce22011-07-27 00:34:13 +0000510 if (!Scope->getScopeNode())
511 return NULL;
512 DIScope DS(Scope->getScopeNode());
513 DISubprogram InlinedSP = getDISubprogram(DS);
Manman Ren4213c392013-05-29 17:16:59 +0000514 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patelf098ce22011-07-27 00:34:13 +0000515 if (!OriginDIE) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000516 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patelf098ce22011-07-27 00:34:13 +0000517 return NULL;
518 }
519
Devang Patel73bc1722011-05-05 17:54:26 +0000520 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Devang Patelf20c4f72011-04-12 22:53:02 +0000521 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Manman Ren4213c392013-05-29 17:16:59 +0000522 dwarf::DW_FORM_ref4, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000523
Devang Patelf098ce22011-07-27 00:34:13 +0000524 if (Ranges.size() > 1) {
525 // .debug_range section has not been laid out yet. Emit offset in
526 // .debug_range as a uint, size 4, for now. emitDIE will handle
527 // DW_AT_ranges appropriately.
528 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000529 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000530 * Asm->getDataLayout().getPointerSize());
Craig Topperd8e43652013-07-03 04:17:25 +0000531 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patelf098ce22011-07-27 00:34:13 +0000532 RE = Ranges.end(); RI != RE; ++RI) {
533 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
534 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
535 }
536 DebugRangeSymbols.push_back(NULL);
537 DebugRangeSymbols.push_back(NULL);
538 } else {
Craig Topperd8e43652013-07-03 04:17:25 +0000539 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000540 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
541 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
542
543 if (StartLabel == 0 || EndLabel == 0)
544 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
545
546 assert(StartLabel->isDefined() &&
547 "Invalid starting label for an inlined scope!");
548 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
549
Eric Christopher962c9082013-01-15 23:56:56 +0000550 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
551 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patelf098ce22011-07-27 00:34:13 +0000552 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000553
554 InlinedSubprogramDIEs.insert(OriginDIE);
555
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000556 // Add the call site information to the DIE.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000557 DILocation DL(Scope->getInlinedAt());
Eric Christopher0925c622012-03-26 21:38:38 +0000558 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0,
Manman Ren1e427202013-03-07 01:42:00 +0000559 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
560 TheCU->getUniqueID()));
Devang Patelf20c4f72011-04-12 22:53:02 +0000561 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000562
Eric Christopher8dda5d02011-12-04 06:02:38 +0000563 // Add name to the name table, we do this here because we're guaranteed
564 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
565 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher6a841382012-11-19 22:42:10 +0000566
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000567 return ScopeDIE;
568}
569
Manman Ren2312ed32013-09-10 18:40:41 +0000570DIE *DwarfDebug::createScopeChildrenDIE(CompileUnit *TheCU, LexicalScope *Scope,
571 SmallVectorImpl<DIE*> &Children) {
572 DIE *ObjectPointer = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +0000573
574 // Collect arguments for current function.
Devang Patel7e623022011-08-10 20:55:27 +0000575 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000576 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
577 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher6a841382012-11-19 22:42:10 +0000578 if (DIE *Arg =
Eric Christophere3417762012-09-12 23:36:19 +0000579 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel6c622ef2011-03-01 22:58:55 +0000580 Children.push_back(Arg);
Eric Christophere3417762012-09-12 23:36:19 +0000581 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
582 }
Devang Patel6c622ef2011-03-01 22:58:55 +0000583
Eric Christopherf84354b2011-10-03 15:49:16 +0000584 // Collect lexical scope children first.
Craig Topper977e9cd2013-07-03 04:24:43 +0000585 const SmallVectorImpl<DbgVariable *> &Variables =ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000586 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher6a841382012-11-19 22:42:10 +0000587 if (DIE *Variable =
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000588 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000589 Children.push_back(Variable);
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000590 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
591 }
Craig Topper977e9cd2013-07-03 04:24:43 +0000592 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000593 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Patel3acc70e2011-08-15 22:04:40 +0000594 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000595 Children.push_back(Nested);
Manman Ren2312ed32013-09-10 18:40:41 +0000596 return ObjectPointer;
597}
598
599// Construct a DIE for this scope.
600DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
601 if (!Scope || !Scope->getScopeNode())
602 return NULL;
603
604 DIScope DS(Scope->getScopeNode());
605
606 SmallVector<DIE *, 8> Children;
607 DIE *ObjectPointer = NULL;
608 bool ChildrenCreated = false;
609
Manman Ren5b2f4b02013-09-11 19:40:28 +0000610 // We try to create the scope DIE first, then the children DIEs. This will
611 // avoid creating un-used children then removing them later when we find out
612 // the scope DIE is null.
Devang Patel3b548aa2010-03-08 20:52:55 +0000613 DIE *ScopeDIE = NULL;
614 if (Scope->getInlinedAt())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000615 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3b548aa2010-03-08 20:52:55 +0000616 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000617 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000618 if (Scope->isAbstractScope()) {
Manman Ren4213c392013-05-29 17:16:59 +0000619 ScopeDIE = TheCU->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000620 // Note down abstract DIE.
621 if (ScopeDIE)
622 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
623 }
Devang Patel3b548aa2010-03-08 20:52:55 +0000624 else
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000625 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3b548aa2010-03-08 20:52:55 +0000626 }
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000627 else {
Manman Ren5b2f4b02013-09-11 19:40:28 +0000628 // Early exit when we know the scope DIE is going to be null.
Manman Ren2312ed32013-09-10 18:40:41 +0000629 if (isLexicalScopeDIENull(Scope))
630 return NULL;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000631
632 // We create children here when we know the scope DIE is not going to be
633 // null and the children will be added to the scope DIE.
Manman Ren2312ed32013-09-10 18:40:41 +0000634 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
635 ChildrenCreated = true;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000636
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000637 // There is no need to emit empty lexical block DIE.
David Blaikie684fc532013-05-06 23:33:07 +0000638 std::pair<ImportedEntityMap::const_iterator,
639 ImportedEntityMap::const_iterator> Range = std::equal_range(
640 ScopesWithImportedEntities.begin(), ScopesWithImportedEntities.end(),
Timur Iskhodzhanovec4afe62013-05-07 07:47:47 +0000641 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode*)0),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000642 less_first());
David Blaikie684fc532013-05-06 23:33:07 +0000643 if (Children.empty() && Range.first == Range.second)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000644 return NULL;
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000645 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Manman Ren2312ed32013-09-10 18:40:41 +0000646 assert(ScopeDIE && "Scope DIE should not be null.");
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000647 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
648 ++i)
David Blaikie4dd2de72013-05-08 06:01:38 +0000649 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000650 }
Eric Christopher6a841382012-11-19 22:42:10 +0000651
Benjamin Kramer892daba2013-08-24 11:55:49 +0000652 if (!ScopeDIE) {
Manman Ren2312ed32013-09-10 18:40:41 +0000653 assert(Children.empty() &&
654 "We create children only when the scope DIE is not null.");
Benjamin Kramer892daba2013-08-24 11:55:49 +0000655 return NULL;
656 }
Manman Ren2312ed32013-09-10 18:40:41 +0000657 if (!ChildrenCreated)
Manman Ren5b2f4b02013-09-11 19:40:28 +0000658 // We create children when the scope DIE is not null.
Manman Ren2312ed32013-09-10 18:40:41 +0000659 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000660
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000661 // Add children
Craig Topperd8e43652013-07-03 04:17:25 +0000662 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000663 E = Children.end(); I != E; ++I)
664 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000665
Eric Christophere3417762012-09-12 23:36:19 +0000666 if (DS.isSubprogram() && ObjectPointer != NULL)
667 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer,
668 dwarf::DW_FORM_ref4, ObjectPointer);
669
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000670 if (DS.isSubprogram())
Eric Christopherd9843b32011-11-10 19:25:34 +0000671 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000672
Eric Christopherd9843b32011-11-10 19:25:34 +0000673 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000674}
675
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000676// Look up the source id with the given directory and source file names.
677// If none currently exists, create a new id and insert it in the
678// SourceIds map. This can update DirectoryNames and SourceFileNames maps
679// as well.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000680unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Manman Ren1e427202013-03-07 01:42:00 +0000681 StringRef DirName, unsigned CUID) {
682 // If we use .loc in assembly, we can't separate .file entries according to
683 // compile units. Thus all files will belong to the default compile unit.
684 if (Asm->TM.hasMCUseLoc() &&
685 Asm->OutStreamer.getKind() == MCStreamer::SK_AsmStreamer)
686 CUID = 0;
687
Devang Patel871d0b12010-09-16 20:57:49 +0000688 // If FE did not provide a file name, then assume stdin.
689 if (FileName.empty())
Manman Ren1e427202013-03-07 01:42:00 +0000690 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patele01b75c2011-03-24 20:30:50 +0000691
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000692 // TODO: this might not belong here. See if we can factor this better.
693 if (DirName == CompilationDir)
694 DirName = "";
695
Manman Ren1e427202013-03-07 01:42:00 +0000696 // FileIDCUMap stores the current ID for the given compile unit.
697 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel871d0b12010-09-16 20:57:49 +0000698
Manman Ren1e427202013-03-07 01:42:00 +0000699 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer71b19732012-03-11 14:56:26 +0000700 SmallString<128> NamePair;
Manman Ren5b22f9f2013-04-06 01:02:38 +0000701 NamePair += utostr(CUID);
Manman Ren1e427202013-03-07 01:42:00 +0000702 NamePair += '\0';
Benjamin Kramer71b19732012-03-11 14:56:26 +0000703 NamePair += DirName;
704 NamePair += '\0'; // Zero bytes are not allowed in paths.
705 NamePair += FileName;
706
707 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
708 if (Ent.getValue() != SrcId)
709 return Ent.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +0000710
Manman Ren1e427202013-03-07 01:42:00 +0000711 FileIDCUMap[CUID] = SrcId;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000712 // Print out a .file directive to specify files for .loc directives.
Manman Ren1e427202013-03-07 01:42:00 +0000713 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendling2b128d72009-05-20 23:19:06 +0000714
715 return SrcId;
716}
717
Eric Christopher48fef592012-12-20 21:58:40 +0000718// Create new CompileUnit for the given metadata node with tag
719// DW_TAG_compile_unit.
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000720CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +0000721 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +0000722 StringRef FN = DIUnit.getFilename();
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000723 CompilationDir = DIUnit.getDirectory();
Bill Wendling2b128d72009-05-20 23:19:06 +0000724
725 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopherbfceb2f2013-08-26 23:50:38 +0000726 CompileUnit *NewCU =
727 new CompileUnit(GlobalCUIndexCount++, Die, N, Asm, this, &InfoHolder);
Manman Ren1e427202013-03-07 01:42:00 +0000728
729 FileIDCUMap[NewCU->getUniqueID()] = 0;
730 // Call this to emit a .file directive if it wasn't emitted for the source
731 // file this CU comes from yet.
732 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
733
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000734 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patelf20c4f72011-04-12 22:53:02 +0000735 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
736 DIUnit.getLanguage());
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000737 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christopher52ce7182013-04-09 19:23:15 +0000738
Eric Christopherb1b94512012-08-01 18:19:01 +0000739 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher52ce7182013-04-09 19:23:15 +0000740 // into an entity. We're using 0 (or a NULL label) for this. For
741 // split dwarf it's in the skeleton CU so omit it here.
742 if (!useSplitDwarf())
743 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
Manman Ren4e042a62013-02-05 21:52:47 +0000744
745 // Define start line table label for each Compile Unit.
746 MCSymbol *LineTableStartSym = Asm->GetTempSymbol("line_table_start",
747 NewCU->getUniqueID());
748 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
749 NewCU->getUniqueID());
750
Manman Ren9d4c7352013-05-21 00:57:22 +0000751 // Use a single line table if we are using .loc and generating assembly.
752 bool UseTheFirstCU =
753 (Asm->TM.hasMCUseLoc() &&
754 Asm->OutStreamer.getKind() == MCStreamer::SK_AsmStreamer) ||
755 (NewCU->getUniqueID() == 0);
756
Devang Pateld22ed622010-03-22 23:11:36 +0000757 // DW_AT_stmt_list is a offset of line number information for this
Eric Christopher52ce7182013-04-09 19:23:15 +0000758 // compile unit in debug_line section. For split dwarf this is
759 // left in the skeleton CU and so not included.
Manman Rend2c95eb2013-02-09 00:41:44 +0000760 // The line table entries are not always emitted in assembly, so it
761 // is not okay to use line_table_start here.
Eric Christopher52ce7182013-04-09 19:23:15 +0000762 if (!useSplitDwarf()) {
763 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Carlo Kokbac096a2013-08-13 17:46:57 +0000764 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Manman Ren9d4c7352013-05-21 00:57:22 +0000765 UseTheFirstCU ?
Eric Christopher52ce7182013-04-09 19:23:15 +0000766 Asm->GetTempSymbol("section_line") : LineTableStartSym);
Manman Ren9d4c7352013-05-21 00:57:22 +0000767 else if (UseTheFirstCU)
Eric Christopher52ce7182013-04-09 19:23:15 +0000768 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
769 else
770 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
771 LineTableStartSym, DwarfLineSectionSym);
772 }
Bill Wendling2b128d72009-05-20 23:19:06 +0000773
Eric Christopher52ce7182013-04-09 19:23:15 +0000774 // If we're using split dwarf the compilation dir is going to be in the
775 // skeleton CU and so we don't need to duplicate it here.
776 if (!useSplitDwarf() && !CompilationDir.empty())
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000777 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopherdd1a0122013-09-13 00:35:05 +0000778
779 // Flag to let the linker know we have emitted new style pubnames. Only
780 // emit it here if we don't have a skeleton CU for split dwarf.
781 if (!useSplitDwarf() && GenerateGnuPubSections)
782 NewCU->addFlag(Die, dwarf::DW_AT_GNU_pubnames);
783
Bill Wendling2b128d72009-05-20 23:19:06 +0000784 if (DIUnit.isOptimized())
Eric Christopherbb69a272012-08-24 01:14:27 +0000785 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendling2b128d72009-05-20 23:19:06 +0000786
Devang Patel2d9caf92009-11-25 17:36:49 +0000787 StringRef Flags = DIUnit.getFlags();
788 if (!Flags.empty())
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000789 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher6a841382012-11-19 22:42:10 +0000790
Nick Lewycky479a8fe2011-10-17 23:27:36 +0000791 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patelf20c4f72011-04-12 22:53:02 +0000792 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +0000793 dwarf::DW_FORM_data1, RVer);
794
Devang Patel1a0df9a2010-05-10 22:49:55 +0000795 if (!FirstCU)
796 FirstCU = NewCU;
Eric Christopher7a2cdf72013-02-05 07:31:55 +0000797
Eric Christopherc8a310e2012-12-10 23:34:43 +0000798 InfoHolder.addUnit(NewCU);
799
Devang Patel1a0df9a2010-05-10 22:49:55 +0000800 CUMap.insert(std::make_pair(N, NewCU));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000801 return NewCU;
Devang Patel1a0df9a2010-05-10 22:49:55 +0000802}
803
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000804// Construct subprogram DIE.
Eric Christopher6a841382012-11-19 22:42:10 +0000805void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
Devang Patel1f4f98d2011-08-15 23:36:40 +0000806 const MDNode *N) {
Rafael Espindola6cf4e832011-11-04 19:00:29 +0000807 CompileUnit *&CURef = SPMap[N];
808 if (CURef)
809 return;
810 CURef = TheCU;
811
Devang Patel80ae3492009-08-28 23:24:31 +0000812 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000813 if (!SP.isDefinition())
814 // This is a method declaration which will be handled while constructing
815 // class type.
Devang Patel0751a282009-06-26 01:49:18 +0000816 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000817
Devang Patel89543712011-08-15 17:24:54 +0000818 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000819
820 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000821 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +0000822
823 // Add to context owner.
Devang Patelf20c4f72011-04-12 22:53:02 +0000824 TheCU->addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +0000825
Eric Christopherba506db2013-09-09 20:03:20 +0000826 // Expose as a global name.
827 TheCU->addGlobalName(SP.getName(), SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +0000828}
829
David Blaikie1fd43652013-05-07 21:35:53 +0000830void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikief55abea2013-04-22 06:12:31 +0000831 const MDNode *N) {
David Blaikie1fd43652013-05-07 21:35:53 +0000832 DIImportedEntity Module(N);
David Blaikief55abea2013-04-22 06:12:31 +0000833 if (!Module.Verify())
834 return;
David Blaikie684fc532013-05-06 23:33:07 +0000835 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
David Blaikie4dd2de72013-05-08 06:01:38 +0000836 constructImportedEntityDIE(TheCU, Module, D);
David Blaikie684fc532013-05-06 23:33:07 +0000837}
838
David Blaikie4dd2de72013-05-08 06:01:38 +0000839void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
David Blaikie684fc532013-05-06 23:33:07 +0000840 DIE *Context) {
David Blaikie1fd43652013-05-07 21:35:53 +0000841 DIImportedEntity Module(N);
David Blaikie684fc532013-05-06 23:33:07 +0000842 if (!Module.Verify())
843 return;
David Blaikie4dd2de72013-05-08 06:01:38 +0000844 return constructImportedEntityDIE(TheCU, Module, Context);
David Blaikie684fc532013-05-06 23:33:07 +0000845}
846
David Blaikie4dd2de72013-05-08 06:01:38 +0000847void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikie1fd43652013-05-07 21:35:53 +0000848 const DIImportedEntity &Module,
David Blaikie684fc532013-05-06 23:33:07 +0000849 DIE *Context) {
850 assert(Module.Verify() &&
851 "Use one of the MDNode * overloads to handle invalid metadata");
852 assert(Context && "Should always have a context for an imported_module");
David Blaikie1fd43652013-05-07 21:35:53 +0000853 DIE *IMDie = new DIE(Module.getTag());
David Blaikief55abea2013-04-22 06:12:31 +0000854 TheCU->insertDIE(Module, IMDie);
David Blaikie1fd43652013-05-07 21:35:53 +0000855 DIE *EntityDie;
856 DIDescriptor Entity = Module.getEntity();
857 if (Entity.isNameSpace())
858 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
859 else if (Entity.isSubprogram())
860 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
David Blaikie3b6038b2013-05-08 06:01:41 +0000861 else if (Entity.isType())
862 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
David Blaikie1fd43652013-05-07 21:35:53 +0000863 else
David Blaikie3b6038b2013-05-08 06:01:41 +0000864 EntityDie = TheCU->getDIE(Entity);
David Blaikief55abea2013-04-22 06:12:31 +0000865 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
866 Module.getContext().getDirectory(),
867 TheCU->getUniqueID());
868 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, 0, FileID);
869 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, 0, Module.getLineNumber());
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000870 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, dwarf::DW_FORM_ref4,
871 EntityDie);
David Blaikiee63d5d12013-05-20 22:50:35 +0000872 StringRef Name = Module.getName();
873 if (!Name.empty())
874 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
David Blaikie684fc532013-05-06 23:33:07 +0000875 Context->addChild(IMDie);
David Blaikief55abea2013-04-22 06:12:31 +0000876}
877
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000878// Emit all Dwarf sections that should come prior to the content. Create
879// global DIEs and emit initial debug info sections. This is invoked by
880// the target AsmPrinter.
Eric Christopher58f41952012-11-19 22:42:15 +0000881void DwarfDebug::beginModule() {
Devang Patel6c74a872010-04-27 19:46:33 +0000882 if (DisableDebugInfoPrinting)
883 return;
884
Eric Christopher58f41952012-11-19 22:42:15 +0000885 const Module *M = MMI->getModule();
886
Nick Lewycky019d2552011-07-29 03:49:23 +0000887 // If module has named metadata anchors then use them, otherwise scan the
888 // module using debug info finder to collect debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000889 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
David Blaikiedc69ebb2013-03-11 23:39:23 +0000890 if (!CU_Nodes)
Devang Patel07bb9ee2011-08-15 23:47:24 +0000891 return;
Manman Ren60352032013-09-05 18:48:31 +0000892 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
Devang Patele02e5852011-05-03 16:45:22 +0000893
David Blaikiedc69ebb2013-03-11 23:39:23 +0000894 // Emit initial sections so we can reference labels later.
895 emitSectionLabels();
896
897 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
898 DICompileUnit CUNode(CU_Nodes->getOperand(i));
899 CompileUnit *CU = constructCompileUnit(CUNode);
David Blaikie1fd43652013-05-07 21:35:53 +0000900 DIArray ImportedEntities = CUNode.getImportedEntities();
901 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
David Blaikie684fc532013-05-06 23:33:07 +0000902 ScopesWithImportedEntities.push_back(std::make_pair(
David Blaikie1fd43652013-05-07 21:35:53 +0000903 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
904 ImportedEntities.getElement(i)));
David Blaikie684fc532013-05-06 23:33:07 +0000905 std::sort(ScopesWithImportedEntities.begin(),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000906 ScopesWithImportedEntities.end(), less_first());
David Blaikiedc69ebb2013-03-11 23:39:23 +0000907 DIArray GVs = CUNode.getGlobalVariables();
908 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
909 CU->createGlobalVariableDIE(GVs.getElement(i));
910 DIArray SPs = CUNode.getSubprograms();
911 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
912 constructSubprogramDIE(CU, SPs.getElement(i));
913 DIArray EnumTypes = CUNode.getEnumTypes();
914 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
915 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
916 DIArray RetainedTypes = CUNode.getRetainedTypes();
917 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
918 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
David Blaikief55abea2013-04-22 06:12:31 +0000919 // Emit imported_modules last so that the relevant context is already
920 // available.
David Blaikie1fd43652013-05-07 21:35:53 +0000921 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
922 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
David Blaikiedc69ebb2013-03-11 23:39:23 +0000923 }
Eric Christopher6a841382012-11-19 22:42:10 +0000924
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000925 // Tell MMI that we have debug info.
926 MMI->setDebugInfoAvailability(true);
Eric Christopher6a841382012-11-19 22:42:10 +0000927
Bill Wendling2b128d72009-05-20 23:19:06 +0000928 // Prime section data.
Richard Mitton21101b32013-09-19 23:21:01 +0000929 SectionMap[Asm->getObjFileLowering().getTextSection()];
Bill Wendling2b128d72009-05-20 23:19:06 +0000930}
931
Eric Christopher960ac372012-11-22 00:59:49 +0000932// Attach DW_AT_inline attribute with inlined subprogram DIEs.
933void DwarfDebug::computeInlinedDIEs() {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000934 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
935 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000936 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000937 DIE *ISP = *AI;
Devang Patelf20c4f72011-04-12 22:53:02 +0000938 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000939 }
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000940 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000941 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000942 DIE *ISP = AI->second;
943 if (InlinedSubprogramDIEs.count(ISP))
944 continue;
945 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
946 }
Eric Christopher960ac372012-11-22 00:59:49 +0000947}
948
949// Collect info for variables that were optimized out.
950void DwarfDebug::collectDeadVariables() {
951 const Module *M = MMI->getModule();
952 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
953
954 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
955 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
956 DICompileUnit TheCU(CU_Nodes->getOperand(i));
957 DIArray Subprograms = TheCU.getSubprograms();
958 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopher735401c2012-11-27 00:13:51 +0000959 DISubprogram SP(Subprograms.getElement(i));
960 if (ProcessedSPNodes.count(SP) != 0) continue;
Manman Ren7504ed42013-07-08 18:33:29 +0000961 if (!SP.isSubprogram()) continue;
Eric Christopher735401c2012-11-27 00:13:51 +0000962 if (!SP.isDefinition()) continue;
963 DIArray Variables = SP.getVariables();
964 if (Variables.getNumElements() == 0) continue;
Eric Christopher960ac372012-11-22 00:59:49 +0000965
Eric Christopher735401c2012-11-27 00:13:51 +0000966 LexicalScope *Scope =
967 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
968 DeadFnScopeMap[SP] = Scope;
Eric Christopher960ac372012-11-22 00:59:49 +0000969
Eric Christopher735401c2012-11-27 00:13:51 +0000970 // Construct subprogram DIE and add variables DIEs.
971 CompileUnit *SPCU = CUMap.lookup(TheCU);
972 assert(SPCU && "Unable to find Compile Unit!");
973 constructSubprogramDIE(SPCU, SP);
974 DIE *ScopeDIE = SPCU->getDIE(SP);
975 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
976 DIVariable DV(Variables.getElement(vi));
Manman Ren7504ed42013-07-08 18:33:29 +0000977 if (!DV.isVariable()) continue;
Chandler Carruth2a1c0d22013-07-27 11:09:58 +0000978 DbgVariable NewVar(DV, NULL);
Eric Christopher735401c2012-11-27 00:13:51 +0000979 if (DIE *VariableDIE =
Chandler Carruth2a1c0d22013-07-27 11:09:58 +0000980 SPCU->constructVariableDIE(&NewVar, Scope->isAbstractScope()))
Eric Christopher735401c2012-11-27 00:13:51 +0000981 ScopeDIE->addChild(VariableDIE);
982 }
Eric Christopher960ac372012-11-22 00:59:49 +0000983 }
984 }
985 }
986 DeleteContainerSeconds(DeadFnScopeMap);
987}
988
Eric Christopher45731982013-08-08 23:45:55 +0000989// Type Signature [7.27] and ODR Hash code.
Eric Christopher67646432013-07-26 17:02:41 +0000990
991/// \brief Grabs the string in whichever attribute is passed in and returns
Eric Christopher8552e222013-08-07 01:18:33 +0000992/// a reference to it. Returns "" if the attribute doesn't exist.
Eric Christopher67646432013-07-26 17:02:41 +0000993static StringRef getDIEStringAttr(DIE *Die, unsigned Attr) {
Eric Christopher8552e222013-08-07 01:18:33 +0000994 DIEValue *V = Die->findAttribute(Attr);
Eric Christopher67646432013-07-26 17:02:41 +0000995
Eric Christopher8552e222013-08-07 01:18:33 +0000996 if (DIEString *S = dyn_cast_or_null<DIEString>(V))
997 return S->getString();
998
Eric Christopher67646432013-07-26 17:02:41 +0000999 return StringRef("");
1000}
1001
Eric Christopher67646432013-07-26 17:02:41 +00001002/// Return true if the current DIE is contained within an anonymous namespace.
1003static bool isContainedInAnonNamespace(DIE *Die) {
1004 DIE *Parent = Die->getParent();
1005
1006 while (Parent) {
Eric Christophere414ece2013-07-29 23:53:08 +00001007 if (Parent->getTag() == dwarf::DW_TAG_namespace &&
1008 getDIEStringAttr(Parent, dwarf::DW_AT_name) == "")
Eric Christopher67646432013-07-26 17:02:41 +00001009 return true;
1010 Parent = Parent->getParent();
1011 }
1012
1013 return false;
1014}
1015
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001016/// Test if the current CU language is C++ and that we have
1017/// a named type that is not contained in an anonymous namespace.
1018static bool shouldAddODRHash(CompileUnit *CU, DIE *Die) {
Eric Christopher341770d2013-08-07 08:35:10 +00001019 return CU->getLanguage() == dwarf::DW_LANG_C_plus_plus &&
1020 getDIEStringAttr(Die, dwarf::DW_AT_name) != "" &&
1021 !isContainedInAnonNamespace(Die);
Eric Christopher45731982013-08-08 23:45:55 +00001022}
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001023
Eric Christopher960ac372012-11-22 00:59:49 +00001024void DwarfDebug::finalizeModuleInfo() {
1025 // Collect info for variables that were optimized out.
1026 collectDeadVariables();
1027
1028 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1029 computeInlinedDIEs();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001030
Eric Christopherf8542ec2013-07-29 22:24:32 +00001031 // Split out type units and conditionally add an ODR tag to the split
1032 // out type.
Eric Christopher67646432013-07-26 17:02:41 +00001033 // FIXME: Do type splitting.
1034 for (unsigned i = 0, e = TypeUnits.size(); i != e; ++i) {
Eric Christopher67646432013-07-26 17:02:41 +00001035 DIE *Die = TypeUnits[i];
Eric Christopher45731982013-08-08 23:45:55 +00001036 DIEHash Hash;
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001037 // If we've requested ODR hashes and it's applicable for an ODR hash then
1038 // add the ODR signature now.
Eric Christopher45731982013-08-08 23:45:55 +00001039 // FIXME: This should be added onto the type unit, not the type, but this
1040 // works as an intermediate stage.
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001041 if (GenerateODRHash && shouldAddODRHash(CUMap.begin()->second, Die))
Eric Christopher45731982013-08-08 23:45:55 +00001042 CUMap.begin()->second->addUInt(Die, dwarf::DW_AT_GNU_odr_signature,
1043 dwarf::DW_FORM_data8,
1044 Hash.computeDIEODRSignature(Die));
Eric Christopher67646432013-07-26 17:02:41 +00001045 }
1046
Eric Christopher60eb7692013-08-12 20:27:48 +00001047 // Handle anything that needs to be done on a per-cu basis.
1048 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
1049 CUE = CUMap.end();
1050 CUI != CUE; ++CUI) {
1051 CompileUnit *TheCU = CUI->second;
1052 // Emit DW_AT_containing_type attribute to connect types with their
1053 // vtable holding type.
1054 TheCU->constructContainingTypeDIEs();
1055
1056 // If we're splitting the dwarf out now that we've got the entire
1057 // CU then construct a skeleton CU based upon it.
1058 if (useSplitDwarf()) {
Eric Christopherd29614f2013-08-13 01:21:55 +00001059 uint64_t ID = 0;
1060 if (GenerateCUHash) {
1061 DIEHash CUHash;
1062 ID = CUHash.computeCUSignature(TheCU->getCUDie());
1063 }
Eric Christopher60eb7692013-08-12 20:27:48 +00001064 // This should be a unique identifier when we want to build .dwp files.
1065 TheCU->addUInt(TheCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopherd29614f2013-08-13 01:21:55 +00001066 dwarf::DW_FORM_data8, ID);
Eric Christopher60eb7692013-08-12 20:27:48 +00001067 // Now construct the skeleton CU associated.
Eric Christopher6fdf3242013-08-26 23:50:43 +00001068 CompileUnit *SkCU = constructSkeletonCU(TheCU);
Eric Christopher60eb7692013-08-12 20:27:48 +00001069 // This should be a unique identifier when we want to build .dwp files.
1070 SkCU->addUInt(SkCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopherd29614f2013-08-13 01:21:55 +00001071 dwarf::DW_FORM_data8, ID);
Eric Christopher60eb7692013-08-12 20:27:48 +00001072 }
1073 }
1074
1075 // Compute DIE offsets and sizes.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001076 InfoHolder.computeSizeAndOffsets();
1077 if (useSplitDwarf())
1078 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher960ac372012-11-22 00:59:49 +00001079}
1080
1081void DwarfDebug::endSections() {
Richard Mitton21101b32013-09-19 23:21:01 +00001082 // Filter labels by section.
1083 for (size_t n = 0; n < Labels.size(); n++) {
1084 const SymbolCU &SCU = Labels[n];
1085 if (SCU.Sym->isInSection()) {
1086 // Make a note of this symbol and it's section.
1087 const MCSection *Section = &SCU.Sym->getSection();
1088 if (!Section->getKind().isMetadata())
1089 SectionMap[Section].push_back(SCU);
1090 } else {
1091 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1092 // appear in the output. This sucks as we rely on sections to build
1093 // arange spans. We can do it without, but it's icky.
1094 SectionMap[NULL].push_back(SCU);
1095 }
1096 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001097
Richard Mitton21101b32013-09-19 23:21:01 +00001098 // Add terminating symbols for each section.
1099 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1100 it++) {
1101 const MCSection *Section = it->first;
1102 MCSymbol *Sym = NULL;
1103
1104 if (Section) {
1105 Sym = Asm->GetTempSymbol(Section->getLabelEndName());
1106 Asm->OutStreamer.SwitchSection(Section);
1107 Asm->OutStreamer.EmitLabel(Sym);
1108 }
1109
1110 // Insert a final terminator.
1111 SymbolCU Entry;
1112 Entry.CU = NULL;
1113 Entry.Sym = Sym;
1114 SectionMap[Section].push_back(Entry);
Bill Wendling2b128d72009-05-20 23:19:06 +00001115 }
Eric Christopher960ac372012-11-22 00:59:49 +00001116}
Bill Wendling2b128d72009-05-20 23:19:06 +00001117
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001118// Emit all Dwarf sections that should come after the content.
Eric Christopher960ac372012-11-22 00:59:49 +00001119void DwarfDebug::endModule() {
1120
1121 if (!FirstCU) return;
1122
1123 // End any existing sections.
1124 // TODO: Does this need to happen?
1125 endSections();
1126
1127 // Finalize the debug info for the module.
1128 finalizeModuleInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001129
Eric Christophercdf218d2012-12-10 19:51:21 +00001130 if (!useSplitDwarf()) {
Eric Christopher9cd26af2013-09-20 23:22:52 +00001131 emitDebugStr();
1132
Eric Christopher95198f502012-11-27 22:43:42 +00001133 // Emit all the DIEs into a debug info section.
1134 emitDebugInfo();
Eric Christopher4c9b1192012-11-27 00:41:54 +00001135
Eric Christopher95198f502012-11-27 22:43:42 +00001136 // Corresponding abbreviations into a abbrev section.
1137 emitAbbreviations();
1138
1139 // Emit info into a debug loc section.
1140 emitDebugLoc();
1141
1142 // Emit info into a debug aranges section.
1143 emitDebugARanges();
1144
1145 // Emit info into a debug ranges section.
1146 emitDebugRanges();
1147
1148 // Emit info into a debug macinfo section.
1149 emitDebugMacInfo();
1150
Eric Christopher95198f502012-11-27 22:43:42 +00001151 } else {
Eric Christopherd692c1d2012-12-11 19:42:09 +00001152 // TODO: Fill this in for separated debug sections and separate
Eric Christopher95198f502012-11-27 22:43:42 +00001153 // out information into new sections.
Eric Christopher9cd26af2013-09-20 23:22:52 +00001154 emitDebugStr();
1155 if (useSplitDwarf())
1156 emitDebugStrDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001157
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001158 // Emit the debug info section and compile units.
Eric Christopher95198f502012-11-27 22:43:42 +00001159 emitDebugInfo();
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001160 emitDebugInfoDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001161
1162 // Corresponding abbreviations into a abbrev section.
1163 emitAbbreviations();
Eric Christopher3c5a1912012-12-19 22:02:53 +00001164 emitDebugAbbrevDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001165
1166 // Emit info into a debug loc section.
1167 emitDebugLoc();
1168
1169 // Emit info into a debug aranges section.
1170 emitDebugARanges();
1171
1172 // Emit info into a debug ranges section.
1173 emitDebugRanges();
1174
1175 // Emit info into a debug macinfo section.
1176 emitDebugMacInfo();
1177
Eric Christopher962c9082013-01-15 23:56:56 +00001178 // Emit DWO addresses.
1179 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1180
Eric Christopher95198f502012-11-27 22:43:42 +00001181 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001182
Eric Christophera876b822012-08-23 07:32:06 +00001183 // Emit info into the dwarf accelerator table sections.
Eric Christopher20b76a72012-08-23 22:36:40 +00001184 if (useDwarfAccelTables()) {
Eric Christopher4996c702011-11-07 09:24:32 +00001185 emitAccelNames();
1186 emitAccelObjC();
1187 emitAccelNamespaces();
1188 emitAccelTypes();
1189 }
Eric Christopher6a841382012-11-19 22:42:10 +00001190
Eric Christopher4b358182013-08-30 00:40:17 +00001191 // Emit the pubnames and pubtypes sections if requested.
1192 if (HasDwarfPubSections) {
David Blaikie70a33202013-09-19 17:33:35 +00001193 emitDebugPubNames(GenerateGnuPubSections);
1194 emitDebugPubTypes(GenerateGnuPubSections);
Eric Christopher4b358182013-08-30 00:40:17 +00001195 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001196
Devang Pateld0701282010-08-02 17:32:15 +00001197 // clean up.
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001198 SPMap.clear();
Devang Patel1a0df9a2010-05-10 22:49:55 +00001199 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1200 E = CUMap.end(); I != E; ++I)
1201 delete I->second;
Eric Christopher8afd7b62012-12-10 19:51:18 +00001202
Craig Topperd8e43652013-07-03 04:17:25 +00001203 for (SmallVectorImpl<CompileUnit *>::iterator I = SkeletonCUs.begin(),
Eric Christopher5b33b3c2013-02-06 21:53:56 +00001204 E = SkeletonCUs.end(); I != E; ++I)
1205 delete *I;
Eric Christopher8afd7b62012-12-10 19:51:18 +00001206
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001207 // Reset these for the next Module if we have one.
1208 FirstCU = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001209}
1210
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001211// Find abstract variable, if any, associated with Var.
Devang Patelbb23a4a2011-08-10 21:50:54 +00001212DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattner915c5f92010-04-02 19:42:39 +00001213 DebugLoc ScopeLoc) {
Devang Patelbb23a4a2011-08-10 21:50:54 +00001214 LLVMContext &Ctx = DV->getContext();
1215 // More then one inlined variable corresponds to one abstract variable.
1216 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001217 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001218 if (AbsDbgVariable)
1219 return AbsDbgVariable;
1220
Devang Patel7e623022011-08-10 20:55:27 +00001221 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001222 if (!Scope)
1223 return NULL;
1224
Devang Patel99819b52011-08-15 19:01:20 +00001225 AbsDbgVariable = new DbgVariable(Var, NULL);
Devang Patel7e623022011-08-10 20:55:27 +00001226 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001227 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001228 return AbsDbgVariable;
1229}
1230
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001231// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel6c622ef2011-03-01 22:58:55 +00001232bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patel7e623022011-08-10 20:55:27 +00001233 DbgVariable *Var, LexicalScope *Scope) {
1234 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +00001235 return false;
1236 DIVariable DV = Var->getVariable();
1237 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1238 return false;
1239 unsigned ArgNo = DV.getArgNumber();
Eric Christopher6a841382012-11-19 22:42:10 +00001240 if (ArgNo == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001241 return false;
1242
Devang Patel4ab660b2011-03-03 20:02:02 +00001243 size_t Size = CurrentFnArguments.size();
1244 if (Size == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001245 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001246 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001247 // arguments does the function have at source level.
1248 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001249 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001250 CurrentFnArguments[ArgNo - 1] = Var;
1251 return true;
1252}
1253
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001254// Collect variable information from side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001255void
Nick Lewycky019d2552011-07-29 03:49:23 +00001256DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patel490c8ab2010-05-20 19:57:06 +00001257 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001258 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1259 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1260 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001261 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001262 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001263 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001264 DIVariable DV(Var);
1265 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001266
Devang Patel7e623022011-08-10 20:55:27 +00001267 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001268
Devang Patelcdb7d442009-11-10 23:20:04 +00001269 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001270 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001271 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001272
Devang Patele1c53f22010-05-20 16:36:41 +00001273 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Devang Patel99819b52011-08-15 19:01:20 +00001274 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable);
Devang Patel3e4a9652011-08-15 21:24:36 +00001275 RegVar->setFrameIndex(VP.first);
Devang Patel6c622ef2011-03-01 22:58:55 +00001276 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001277 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001278 if (AbsDbgVariable)
Devang Patel3e4a9652011-08-15 21:24:36 +00001279 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patel475d32a2009-10-06 01:26:37 +00001280 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001281}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001282
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001283// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1284// defined reg.
Devang Patel9fc11702010-05-25 23:40:22 +00001285static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001286 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001287 return MI->getNumOperands() == 3 &&
1288 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
Adrian Prantl418d1d12013-07-09 20:28:37 +00001289 (MI->getOperand(1).isImm() ||
1290 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
Devang Patel9fc11702010-05-25 23:40:22 +00001291}
1292
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001293// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher6a841382012-11-19 22:42:10 +00001294static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1295 const MCSymbol *FLabel,
Devang Patel2442a892011-07-08 17:09:57 +00001296 const MCSymbol *SLabel,
1297 const MachineInstr *MI) {
1298 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1299
David Blaikie0252265b2013-06-16 20:34:15 +00001300 assert(MI->getNumOperands() == 3);
Adrian Prantl418d1d12013-07-09 20:28:37 +00001301 if (MI->getOperand(0).isReg()) {
Devang Patel2442a892011-07-08 17:09:57 +00001302 MachineLocation MLoc;
Adrian Prantl418d1d12013-07-09 20:28:37 +00001303 // If the second operand is an immediate, this is a
1304 // register-indirect address.
1305 if (!MI->getOperand(1).isImm())
Adrian Prantld4c0dd42013-04-26 21:57:17 +00001306 MLoc.set(MI->getOperand(0).getReg());
1307 else
1308 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel2442a892011-07-08 17:09:57 +00001309 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1310 }
1311 if (MI->getOperand(0).isImm())
1312 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1313 if (MI->getOperand(0).isFPImm())
1314 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1315 if (MI->getOperand(0).isCImm())
1316 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1317
Craig Topperee4dab52012-02-05 08:31:47 +00001318 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel2442a892011-07-08 17:09:57 +00001319}
1320
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001321// Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001322void
Devang Patel5c0f85c2010-06-25 22:07:34 +00001323DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1324 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001325
Eric Christopher270a12c2013-07-03 21:37:03 +00001326 // Grab the variable info that was squirreled away in the MMI side-table.
Devang Patel490c8ab2010-05-20 19:57:06 +00001327 collectVariableInfoFromMMITable(MF, Processed);
1328
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001329 for (SmallVectorImpl<const MDNode*>::const_iterator
1330 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1331 ++UVI) {
1332 const MDNode *Var = *UVI;
1333 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001334 continue;
1335
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001336 // History contains relevant DBG_VALUE instructions for Var and instructions
1337 // clobbering it.
1338 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1339 if (History.empty())
1340 continue;
1341 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001342
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001343 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001344 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001345 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1346 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +00001347 Scope = LScopes.getCurrentFunctionScope();
David Blaikiedc69ebb2013-03-11 23:39:23 +00001348 else if (MDNode *IA = DV.getInlinedAt())
1349 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1350 else
1351 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel490c8ab2010-05-20 19:57:06 +00001352 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001353 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001354 continue;
1355
1356 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001357 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel99819b52011-08-15 19:01:20 +00001358 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
1359 DbgVariable *RegVar = new DbgVariable(DV, AbsVar);
Devang Patel6c622ef2011-03-01 22:58:55 +00001360 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001361 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001362 if (AbsVar)
Devang Patel3e4a9652011-08-15 21:24:36 +00001363 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001364
Eric Christophercc10d202012-10-08 20:48:54 +00001365 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001366 if (History.size() <= 1 || (History.size() == 2 &&
1367 MInsn->isIdenticalTo(History.back()))) {
Devang Patel3e4a9652011-08-15 21:24:36 +00001368 RegVar->setMInsn(MInsn);
Devang Patel9fc11702010-05-25 23:40:22 +00001369 continue;
1370 }
1371
Eric Christopher59cc0712013-01-28 17:33:26 +00001372 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001373 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001374
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001375 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1376 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1377 const MachineInstr *Begin = *HI;
1378 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001379
Devang Patele7181b52011-06-01 23:00:17 +00001380 // Check if DBG_VALUE is truncating a range.
1381 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1382 && !Begin->getOperand(0).getReg())
1383 continue;
1384
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001385 // Compute the range for a register location.
1386 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1387 const MCSymbol *SLabel = 0;
1388
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001389 if (HI + 1 == HE)
1390 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001391 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001392 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001393 else {
1394 const MachineInstr *End = HI[1];
Eric Christopher6a841382012-11-19 22:42:10 +00001395 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel53b050a2011-07-07 21:44:42 +00001396 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001397 if (End->isDebugValue())
1398 SLabel = getLabelBeforeInsn(End);
1399 else {
1400 // End is a normal instruction clobbering the range.
1401 SLabel = getLabelAfterInsn(End);
1402 assert(SLabel && "Forgot label after clobber instruction");
1403 ++HI;
1404 }
1405 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001406
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001407 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopher365d0832011-12-16 23:42:31 +00001408 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1409 Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001410 }
1411 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001412 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001413
1414 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001415 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1416 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1417 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1418 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001419 if (!DV || !DV.isVariable() || !Processed.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001420 continue;
1421 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1422 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patele0a94bf2010-05-14 21:01:35 +00001423 }
Devang Patel9fc11702010-05-25 23:40:22 +00001424}
Devang Patele0a94bf2010-05-14 21:01:35 +00001425
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001426// Return Label preceding the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001427MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001428 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1429 assert(Label && "Didn't insert label before instruction");
1430 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001431}
1432
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001433// Return Label immediately following the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001434MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001435 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001436}
1437
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001438// Process beginning of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001439void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001440 // Check if source location changes, but ignore DBG_VALUE locations.
1441 if (!MI->isDebugValue()) {
1442 DebugLoc DL = MI->getDebugLoc();
1443 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopheraec8a822012-04-05 20:39:05 +00001444 unsigned Flags = 0;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001445 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001446 if (DL == PrologEndLoc) {
1447 Flags |= DWARF2_FLAG_PROLOGUE_END;
1448 PrologEndLoc = DebugLoc();
1449 }
Eric Christopheraec8a822012-04-05 20:39:05 +00001450 if (PrologEndLoc.isUnknown())
1451 Flags |= DWARF2_FLAG_IS_STMT;
1452
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001453 if (!DL.isUnknown()) {
1454 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001455 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001456 } else
Devang Patel34a66202011-05-11 19:22:19 +00001457 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001458 }
Devang Patel9fc11702010-05-25 23:40:22 +00001459 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001460
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001461 // Insert labels where requested.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001462 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1463 LabelsBeforeInsn.find(MI);
1464
1465 // No label needed.
1466 if (I == LabelsBeforeInsn.end())
1467 return;
1468
1469 // Label already assigned.
1470 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001471 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001472
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001473 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001474 PrevLabel = MMI->getContext().CreateTempSymbol();
1475 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001476 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001477 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001478}
1479
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001480// Process end of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001481void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001482 // Don't create a new label after DBG_VALUE instructions.
1483 // They don't generate code.
1484 if (!MI->isDebugValue())
1485 PrevLabel = 0;
1486
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001487 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1488 LabelsAfterInsn.find(MI);
1489
1490 // No label needed.
1491 if (I == LabelsAfterInsn.end())
1492 return;
1493
1494 // Label already assigned.
1495 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001496 return;
1497
1498 // We need a label after this instruction.
1499 if (!PrevLabel) {
1500 PrevLabel = MMI->getContext().CreateTempSymbol();
1501 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001502 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001503 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001504}
1505
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001506// Each LexicalScope has first instruction and last instruction to mark
1507// beginning and end of a scope respectively. Create an inverse map that list
1508// scopes starts (and ends) with an instruction. One instruction may start (or
1509// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001510void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001511 SmallVector<LexicalScope *, 4> WorkList;
1512 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001513 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001514 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001515
Craig Topper977e9cd2013-07-03 04:24:43 +00001516 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001517 if (!Children.empty())
Craig Topperd8e43652013-07-03 04:17:25 +00001518 for (SmallVectorImpl<LexicalScope *>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00001519 SE = Children.end(); SI != SE; ++SI)
1520 WorkList.push_back(*SI);
1521
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001522 if (S->isAbstractScope())
1523 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001524
Craig Topper977e9cd2013-07-03 04:24:43 +00001525 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001526 if (Ranges.empty())
1527 continue;
Craig Topperd8e43652013-07-03 04:17:25 +00001528 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +00001529 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001530 assert(RI->first && "InsnRange does not have first instruction!");
1531 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001532 requestLabelBeforeInsn(RI->first);
1533 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001534 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001535 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001536}
1537
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001538// Get MDNode for DebugLoc's scope.
Devang Patel589845d2011-05-09 22:14:49 +00001539static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1540 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1541 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1542 return DL.getScope(Ctx);
1543}
1544
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001545// Walk up the scope chain of given debug loc and find line number info
1546// for the function.
Devang Patel34a66202011-05-11 19:22:19 +00001547static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1548 const MDNode *Scope = getScopeNode(DL, Ctx);
1549 DISubprogram SP = getDISubprogram(Scope);
Manman Ren7504ed42013-07-08 18:33:29 +00001550 if (SP.isSubprogram()) {
Eric Christopher34164192012-04-03 00:43:49 +00001551 // Check for number of operands since the compatibility is
1552 // cheap here.
Eric Christopherb81e2b42012-04-03 17:55:42 +00001553 if (SP->getNumOperands() > 19)
Eric Christopher34164192012-04-03 00:43:49 +00001554 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1555 else
1556 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1557 }
1558
Devang Patel34a66202011-05-11 19:22:19 +00001559 return DebugLoc();
1560}
1561
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001562// Gather pre-function debug information. Assumes being called immediately
1563// after the function entry point has been emitted.
Chris Lattner76555b52010-01-26 23:18:02 +00001564void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00001565 if (!MMI->hasDebugInfo()) return;
Devang Patel7e623022011-08-10 20:55:27 +00001566 LScopes.initialize(*MF);
1567 if (LScopes.empty()) return;
1568 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001569
Manman Ren4e042a62013-02-05 21:52:47 +00001570 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1571 // belongs to.
1572 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1573 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1574 assert(TheCU && "Unable to find compile unit!");
Manman Ren9d4c7352013-05-21 00:57:22 +00001575 if (Asm->TM.hasMCUseLoc() &&
1576 Asm->OutStreamer.getKind() == MCStreamer::SK_AsmStreamer)
1577 // Use a single line table if we are using .loc and generating assembly.
1578 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1579 else
1580 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
Manman Ren4e042a62013-02-05 21:52:47 +00001581
Devang Patel6c74a872010-04-27 19:46:33 +00001582 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1583 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001584 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001585 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001586
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001587 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1588
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001589 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001590 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001591 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1592
Devang Patel002d54d2010-05-26 19:37:24 +00001593 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001594 I != E; ++I) {
1595 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001596 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1597 II != IE; ++II) {
1598 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001599
Devang Patel002d54d2010-05-26 19:37:24 +00001600 if (MI->isDebugValue()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001601 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001602
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001603 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001604 const MDNode *Var =
1605 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001606
1607 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001608 if (isDbgValueInDefinedReg(MI))
1609 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1610
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001611 // Check the history of this variable.
1612 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1613 if (History.empty()) {
1614 UserVariables.push_back(Var);
1615 // The first mention of a function argument gets the FunctionBeginSym
1616 // label, so arguments are visible when breaking at function entry.
1617 DIVariable DV(Var);
Manman Ren7504ed42013-07-08 18:33:29 +00001618 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001619 DISubprogram(getDISubprogram(DV.getContext()))
1620 .describes(MF->getFunction()))
1621 LabelsBeforeInsn[MI] = FunctionBeginSym;
1622 } else {
1623 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1624 const MachineInstr *Prev = History.back();
1625 if (Prev->isDebugValue()) {
1626 // Coalesce identical entries at the end of History.
1627 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001628 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher85a495e2012-10-08 20:48:49 +00001629 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher6a841382012-11-19 22:42:10 +00001630 << "\t" << *Prev
Devang Patelb7a328e2011-07-07 00:14:27 +00001631 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001632 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001633 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001634
1635 // Terminate old register assignments that don't reach MI;
1636 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1637 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1638 isDbgValueInDefinedReg(Prev)) {
1639 // Previous register assignment needs to terminate at the end of
1640 // its basic block.
1641 MachineBasicBlock::const_iterator LastMI =
1642 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001643 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001644 // Drop DBG_VALUE for empty range.
Eric Christopher85a495e2012-10-08 20:48:49 +00001645 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patelb7a328e2011-07-07 00:14:27 +00001646 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001647 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001648 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001649 // Terminate after LastMI.
1650 History.push_back(LastMI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001651 }
1652 }
1653 }
1654 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001655 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001656 // Not a DBG_VALUE instruction.
1657 if (!MI->isLabel())
1658 AtBlockEntry = false;
1659
Eric Christopher133195782012-10-04 20:46:14 +00001660 // First known non-DBG_VALUE and non-frame setup location marks
1661 // the beginning of the function body.
1662 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1663 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel34a66202011-05-11 19:22:19 +00001664 PrologEndLoc = MI->getDebugLoc();
1665
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001666 // Check if the instruction clobbers any registers with debug vars.
1667 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1668 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1669 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1670 continue;
Jakob Stoklund Olesen54038d72012-06-01 23:28:30 +00001671 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1672 AI.isValid(); ++AI) {
1673 unsigned Reg = *AI;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001674 const MDNode *Var = LiveUserVar[Reg];
1675 if (!Var)
1676 continue;
1677 // Reg is now clobbered.
1678 LiveUserVar[Reg] = 0;
1679
1680 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001681 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1682 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001683 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001684 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1685 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001686 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001687 const MachineInstr *Prev = History.back();
1688 // Sanity-check: Register assignments are terminated at the end of
1689 // their block.
1690 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1691 continue;
1692 // Is the variable still in Reg?
1693 if (!isDbgValueInDefinedReg(Prev) ||
1694 Prev->getOperand(0).getReg() != Reg)
1695 continue;
1696 // Var is clobbered. Make sure the next instruction gets a label.
1697 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001698 }
1699 }
Devang Patel002d54d2010-05-26 19:37:24 +00001700 }
Devang Patel002d54d2010-05-26 19:37:24 +00001701 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001702 }
1703
1704 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1705 I != E; ++I) {
1706 SmallVectorImpl<const MachineInstr*> &History = I->second;
1707 if (History.empty())
1708 continue;
1709
1710 // Make sure the final register assignments are terminated.
1711 const MachineInstr *Prev = History.back();
1712 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1713 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher6a841382012-11-19 22:42:10 +00001714 MachineBasicBlock::const_iterator LastMI =
Devang Patel784077e2011-08-10 23:58:09 +00001715 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001716 if (LastMI == PrevMBB->end())
1717 // Drop DBG_VALUE for empty range.
1718 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001719 else if (PrevMBB != &PrevMBB->getParent()->back()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001720 // Terminate after LastMI.
1721 History.push_back(LastMI);
1722 }
1723 }
1724 // Request labels for the full history.
1725 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1726 const MachineInstr *MI = History[i];
1727 if (MI->isDebugValue())
1728 requestLabelBeforeInsn(MI);
1729 else
1730 requestLabelAfterInsn(MI);
1731 }
1732 }
Devang Patel002d54d2010-05-26 19:37:24 +00001733
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001734 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001735 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001736
1737 // Record beginning of function.
1738 if (!PrologEndLoc.isUnknown()) {
1739 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1740 MF->getFunction()->getContext());
1741 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1742 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie67cb31e2012-12-04 22:02:33 +00001743 // We'd like to list the prologue as "not statements" but GDB behaves
1744 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikie5a773bb2012-12-04 21:05:36 +00001745 DWARF2_FLAG_IS_STMT);
Devang Patel34a66202011-05-11 19:22:19 +00001746 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001747}
1748
Devang Patel7e623022011-08-10 20:55:27 +00001749void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
David Blaikie6f1a8062013-06-05 05:39:59 +00001750 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1751 DIVariable DV = Var->getVariable();
David Blaikie36d5d2f2013-06-06 21:04:51 +00001752 // Variables with positive arg numbers are parameters.
1753 if (unsigned ArgNum = DV.getArgNumber()) {
1754 // Keep all parameters in order at the start of the variable list to ensure
1755 // function types are correct (no out-of-order parameters)
1756 //
1757 // This could be improved by only doing it for optimized builds (unoptimized
1758 // builds have the right order to begin with), searching from the back (this
1759 // would catch the unoptimized case quickly), or doing a binary search
1760 // rather than linear search.
1761 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1762 while (I != Vars.end()) {
1763 unsigned CurNum = (*I)->getVariable().getArgNumber();
1764 // A local (non-parameter) variable has been found, insert immediately
1765 // before it.
1766 if (CurNum == 0)
1767 break;
1768 // A later indexed parameter has been found, insert immediately before it.
David Blaikieb272a752013-06-06 22:28:26 +00001769 if (CurNum > ArgNum)
David Blaikie36d5d2f2013-06-06 21:04:51 +00001770 break;
David Blaikieb272a752013-06-06 22:28:26 +00001771 ++I;
David Blaikie6f1a8062013-06-05 05:39:59 +00001772 }
David Blaikie36d5d2f2013-06-06 21:04:51 +00001773 Vars.insert(I, Var);
1774 return;
David Blaikie6f1a8062013-06-05 05:39:59 +00001775 }
1776
1777 Vars.push_back(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001778}
1779
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001780// Gather and emit post-function debug information.
Chris Lattner76555b52010-01-26 23:18:02 +00001781void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patel7e623022011-08-10 20:55:27 +00001782 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00001783
Devang Patel7e623022011-08-10 20:55:27 +00001784 // Define end label for subprogram.
1785 FunctionEndSym = Asm->GetTempSymbol("func_end",
1786 Asm->getFunctionNumber());
1787 // Assumes in correct section after the entry point.
1788 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Manman Ren4e042a62013-02-05 21:52:47 +00001789 // Set DwarfCompileUnitID in MCContext to default value.
1790 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher6a841382012-11-19 22:42:10 +00001791
Devang Patel7e623022011-08-10 20:55:27 +00001792 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1793 collectVariableInfo(MF, ProcessedVars);
Eric Christopher6a841382012-11-19 22:42:10 +00001794
Devang Patel3acc70e2011-08-15 22:04:40 +00001795 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001796 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001797 assert(TheCU && "Unable to find compile unit!");
Devang Patel3acc70e2011-08-15 22:04:40 +00001798
Devang Patel7e623022011-08-10 20:55:27 +00001799 // Construct abstract scopes.
Devang Patel44403472011-08-12 18:10:19 +00001800 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1801 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1802 LexicalScope *AScope = AList[i];
1803 DISubprogram SP(AScope->getScopeNode());
Manman Ren7504ed42013-07-08 18:33:29 +00001804 if (SP.isSubprogram()) {
Devang Patel7e623022011-08-10 20:55:27 +00001805 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001806 DIArray Variables = SP.getVariables();
1807 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1808 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001809 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001810 continue;
Alexey Samsonov39602782012-07-06 08:45:08 +00001811 // Check that DbgVariable for DV wasn't created earlier, when
1812 // findAbstractVariable() was called for inlined instance of DV.
1813 LLVMContext &Ctx = DV->getContext();
1814 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1815 if (AbstractVariables.lookup(CleanDV))
1816 continue;
Devang Patel59e27c52011-08-19 23:28:12 +00001817 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1818 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001819 }
1820 }
Devang Patel44403472011-08-12 18:10:19 +00001821 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Manman Ren4213c392013-05-29 17:16:59 +00001822 constructScopeDIE(TheCU, AScope);
Bill Wendling2b128d72009-05-20 23:19:06 +00001823 }
Eric Christopher6a841382012-11-19 22:42:10 +00001824
Devang Patel3acc70e2011-08-15 22:04:40 +00001825 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher6a841382012-11-19 22:42:10 +00001826
Nick Lewycky50f02cb2011-12-02 22:16:29 +00001827 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopherbb69a272012-08-24 01:14:27 +00001828 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Patel3acc70e2011-08-15 22:04:40 +00001829
Bill Wendling2b128d72009-05-20 23:19:06 +00001830 // Clear debug info
Craig Topper2b4a2012013-07-03 04:40:27 +00001831 for (ScopeVariablesMap::iterator
Devang Patel7e623022011-08-10 20:55:27 +00001832 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1833 DeleteContainerPointers(I->second);
1834 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001835 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001836 UserVariables.clear();
1837 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001838 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001839 LabelsBeforeInsn.clear();
1840 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001841 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001842}
1843
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001844// Register a source line with debug info. Returns the unique label that was
1845// emitted and which provides correspondence to the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00001846void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1847 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00001848 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00001849 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00001850 unsigned Src = 1;
1851 if (S) {
1852 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00001853
Dan Gohman50849c62010-05-05 23:41:32 +00001854 if (Scope.isCompileUnit()) {
1855 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001856 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001857 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00001858 } else if (Scope.isFile()) {
1859 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00001860 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001861 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001862 } else if (Scope.isSubprogram()) {
1863 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001864 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001865 Dir = SP.getDirectory();
Eric Christopher6647b832011-10-11 22:59:11 +00001866 } else if (Scope.isLexicalBlockFile()) {
1867 DILexicalBlockFile DBF(S);
1868 Fn = DBF.getFilename();
1869 Dir = DBF.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001870 } else if (Scope.isLexicalBlock()) {
1871 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001872 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001873 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001874 } else
Craig Topperee4dab52012-02-05 08:31:47 +00001875 llvm_unreachable("Unexpected scope info");
Dan Gohman50849c62010-05-05 23:41:32 +00001876
Manman Ren1e427202013-03-07 01:42:00 +00001877 Src = getOrCreateSourceID(Fn, Dir,
1878 Asm->OutStreamer.getContext().getDwarfCompileUnitID());
Dan Gohman50849c62010-05-05 23:41:32 +00001879 }
Nick Lewycky019d2552011-07-29 03:49:23 +00001880 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00001881}
1882
Bill Wendling806535f2009-05-20 23:22:40 +00001883//===----------------------------------------------------------------------===//
1884// Emit Methods
1885//===----------------------------------------------------------------------===//
1886
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001887// Compute the size and offset of a DIE.
Jim Grosbach00e9c612009-11-22 19:20:36 +00001888unsigned
Eric Christopherc8a310e2012-12-10 23:34:43 +00001889DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling480ff322009-05-20 23:21:38 +00001890 // Get the children.
1891 const std::vector<DIE *> &Children = Die->getChildren();
1892
Bill Wendling480ff322009-05-20 23:21:38 +00001893 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00001894 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00001895
1896 // Get the abbreviation for this DIE.
1897 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopherc8a310e2012-12-10 23:34:43 +00001898 const DIEAbbrev *Abbrev = Abbreviations->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00001899
1900 // Set DIE offset
1901 Die->setOffset(Offset);
1902
1903 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00001904 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001905
Eric Christopher4887c8f2013-03-29 23:34:06 +00001906 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1907 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling480ff322009-05-20 23:21:38 +00001908
1909 // Size the DIE attribute values.
1910 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1911 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001912 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001913
1914 // Size the DIE children if any.
1915 if (!Children.empty()) {
1916 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1917 "Children flag not set");
1918
1919 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001920 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling480ff322009-05-20 23:21:38 +00001921
1922 // End of children marker.
1923 Offset += sizeof(int8_t);
1924 }
1925
1926 Die->setSize(Offset - Die->getOffset());
1927 return Offset;
1928}
1929
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001930// Compute the size and offset of all the DIEs.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001931void DwarfUnits::computeSizeAndOffsets() {
Manman Ren14a029d2013-03-12 18:27:15 +00001932 // Offset from the beginning of debug info section.
Eric Christopherd1c5a312013-05-30 00:43:35 +00001933 unsigned SecOffset = 0;
Eric Christopher4887c8f2013-03-29 23:34:06 +00001934 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopherc8a310e2012-12-10 23:34:43 +00001935 E = CUs.end(); I != E; ++I) {
Eric Christopherd1c5a312013-05-30 00:43:35 +00001936 (*I)->setDebugInfoOffset(SecOffset);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001937 unsigned Offset =
1938 sizeof(int32_t) + // Length of Compilation Unit Info
1939 sizeof(int16_t) + // DWARF version number
1940 sizeof(int32_t) + // Offset Into Abbrev. Section
1941 sizeof(int8_t); // Pointer Size (in bytes)
1942
Manman Ren14a029d2013-03-12 18:27:15 +00001943 unsigned EndOffset = computeSizeAndOffset((*I)->getCUDie(), Offset);
Eric Christopherd1c5a312013-05-30 00:43:35 +00001944 SecOffset += EndOffset;
Devang Patel1a0df9a2010-05-10 22:49:55 +00001945 }
Bill Wendling480ff322009-05-20 23:21:38 +00001946}
1947
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001948// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001949void DwarfDebug::emitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001950 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001951
Bill Wendling480ff322009-05-20 23:21:38 +00001952 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001953 DwarfInfoSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001954 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001955 DwarfAbbrevSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001956 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher3c5a1912012-12-19 22:02:53 +00001957 if (useSplitDwarf())
1958 DwarfAbbrevDWOSectionSym =
1959 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1960 "section_abbrev_dwo");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001961 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001962
Chris Lattner6629ca92010-04-04 22:59:04 +00001963 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001964 emitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00001965
Eric Christopher74804332013-02-07 21:19:50 +00001966 DwarfLineSectionSym =
1967 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001968 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Michael Gottesmanc89466f2013-09-04 04:39:38 +00001969 if (HasDwarfPubSections) {
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00001970 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
Eric Christopherbf1ea3c2013-08-26 23:24:31 +00001971 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Eric Christopherdd1a0122013-09-13 00:35:05 +00001972 } else if (GenerateGnuPubSections) {
1973 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
1974 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
Michael Gottesmanc89466f2013-09-04 04:39:38 +00001975 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00001976
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001977 DwarfStrSectionSym =
Eric Christopher3bf29fd2012-12-27 02:14:01 +00001978 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher55863be2013-04-07 03:43:09 +00001979 if (useSplitDwarf()) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00001980 DwarfStrDWOSectionSym =
1981 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher55863be2013-04-07 03:43:09 +00001982 DwarfAddrSectionSym =
1983 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
1984 }
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001985 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patel12563b32010-04-16 23:33:45 +00001986 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00001987
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001988 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patel9fc11702010-05-25 23:40:22 +00001989 "section_debug_loc");
1990
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001991 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
1992 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00001993}
1994
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001995// Recursively emits a debug information entry.
Eric Christopher3c5a1912012-12-19 22:02:53 +00001996void DwarfDebug::emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs) {
Bill Wendling480ff322009-05-20 23:21:38 +00001997 // Get the abbreviation for this DIE.
1998 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher3c5a1912012-12-19 22:02:53 +00001999 const DIEAbbrev *Abbrev = Abbrevs->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00002000
Bill Wendling480ff322009-05-20 23:21:38 +00002001 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00002002 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00002003 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2004 Twine::utohexstr(Die->getOffset()) + ":0x" +
2005 Twine::utohexstr(Die->getSize()) + " " +
2006 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00002007 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00002008
Eric Christopher4887c8f2013-03-29 23:34:06 +00002009 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
2010 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling480ff322009-05-20 23:21:38 +00002011
2012 // Emit the DIE attribute values.
2013 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2014 unsigned Attr = AbbrevData[i].getAttribute();
2015 unsigned Form = AbbrevData[i].getForm();
2016 assert(Form && "Too many attributes for DIE (check abbreviation)");
2017
Chris Lattner7bde8c02010-04-04 18:52:31 +00002018 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00002019 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002020
Bill Wendling480ff322009-05-20 23:21:38 +00002021 switch (Attr) {
Bill Wendling480ff322009-05-20 23:21:38 +00002022 case dwarf::DW_AT_abstract_origin: {
2023 DIEEntry *E = cast<DIEEntry>(Values[i]);
2024 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002025 unsigned Addr = Origin->getOffset();
Manman Ren14a029d2013-03-12 18:27:15 +00002026 if (Form == dwarf::DW_FORM_ref_addr) {
2027 // For DW_FORM_ref_addr, output the offset from beginning of debug info
2028 // section. Origin->getOffset() returns the offset from start of the
2029 // compile unit.
2030 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2031 Addr += Holder.getCUOffset(Origin->getCompileUnit());
2032 }
Manman Renac8062b2013-07-02 23:40:10 +00002033 Asm->OutStreamer.EmitIntValue(Addr,
2034 Form == dwarf::DW_FORM_ref_addr ? DIEEntry::getRefAddrSize(Asm) : 4);
Bill Wendling480ff322009-05-20 23:21:38 +00002035 break;
2036 }
Devang Patel12563b32010-04-16 23:33:45 +00002037 case dwarf::DW_AT_ranges: {
2038 // DW_AT_range Value encodes offset in debug_range section.
2039 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00002040
Nick Lewycky33da3362012-06-22 01:25:12 +00002041 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelda3ef852010-09-02 16:43:44 +00002042 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
2043 V->getValue(),
2044 4);
2045 } else {
2046 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
2047 V->getValue(),
2048 DwarfDebugRangeSectionSym,
2049 4);
2050 }
Devang Patel12563b32010-04-16 23:33:45 +00002051 break;
2052 }
Devang Patel9fc11702010-05-25 23:40:22 +00002053 case dwarf::DW_AT_location: {
Nick Lewycky33da3362012-06-22 01:25:12 +00002054 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2055 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002056 Asm->EmitLabelReference(L->getValue(), 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002057 else
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002058 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002059 } else {
Devang Patel9fc11702010-05-25 23:40:22 +00002060 Values[i]->EmitValue(Asm, Form);
Nick Lewycky33da3362012-06-22 01:25:12 +00002061 }
Devang Patel9fc11702010-05-25 23:40:22 +00002062 break;
2063 }
Devang Patela1bd5a12010-09-29 19:08:08 +00002064 case dwarf::DW_AT_accessibility: {
2065 if (Asm->isVerbose()) {
2066 DIEInteger *V = cast<DIEInteger>(Values[i]);
2067 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2068 }
2069 Values[i]->EmitValue(Asm, Form);
2070 break;
2071 }
Bill Wendling480ff322009-05-20 23:21:38 +00002072 default:
2073 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002074 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00002075 break;
2076 }
Bill Wendling480ff322009-05-20 23:21:38 +00002077 }
2078
2079 // Emit the DIE children if any.
2080 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2081 const std::vector<DIE *> &Children = Die->getChildren();
2082
2083 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher3c5a1912012-12-19 22:02:53 +00002084 emitDIE(Children[j], Abbrevs);
Bill Wendling480ff322009-05-20 23:21:38 +00002085
Chris Lattner7bde8c02010-04-04 18:52:31 +00002086 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00002087 Asm->OutStreamer.AddComment("End Of Children Mark");
2088 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00002089 }
2090}
2091
Eric Christophera2de8262012-12-15 00:04:07 +00002092// Emit the various dwarf units to the unit section USection with
2093// the abbreviations going into ASection.
2094void DwarfUnits::emitUnits(DwarfDebug *DD,
2095 const MCSection *USection,
2096 const MCSection *ASection,
2097 const MCSymbol *ASectionSym) {
2098 Asm->OutStreamer.SwitchSection(USection);
Eric Christopher4887c8f2013-03-29 23:34:06 +00002099 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christophera2de8262012-12-15 00:04:07 +00002100 E = CUs.end(); I != E; ++I) {
2101 CompileUnit *TheCU = *I;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002102 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002103
Devang Patel1a0df9a2010-05-10 22:49:55 +00002104 // Emit the compile units header.
Eric Christophera2de8262012-12-15 00:04:07 +00002105 Asm->OutStreamer
2106 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
2107 TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002108
Devang Patel1a0df9a2010-05-10 22:49:55 +00002109 // Emit size of content not including length itself
2110 unsigned ContentSize = Die->getSize() +
2111 sizeof(int16_t) + // DWARF version number
2112 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patele141234942011-04-13 19:41:17 +00002113 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002114
Devang Patel1a0df9a2010-05-10 22:49:55 +00002115 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2116 Asm->EmitInt32(ContentSize);
2117 Asm->OutStreamer.AddComment("DWARF version number");
Manman Renac8062b2013-07-02 23:40:10 +00002118 Asm->EmitInt16(DD->getDwarfVersion());
Devang Patel1a0df9a2010-05-10 22:49:55 +00002119 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
Eric Christophera2de8262012-12-15 00:04:07 +00002120 Asm->EmitSectionOffset(Asm->GetTempSymbol(ASection->getLabelBeginName()),
2121 ASectionSym);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002122 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002123 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002124
Eric Christopher3c5a1912012-12-19 22:02:53 +00002125 DD->emitDIE(Die, Abbreviations);
Eric Christophera2de8262012-12-15 00:04:07 +00002126 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
Eli Benderskyb42d1462012-12-03 18:45:45 +00002127 TheCU->getUniqueID()));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002128 }
Bill Wendling480ff322009-05-20 23:21:38 +00002129}
2130
Manman Ren14a029d2013-03-12 18:27:15 +00002131/// For a given compile unit DIE, returns offset from beginning of debug info.
2132unsigned DwarfUnits::getCUOffset(DIE *Die) {
Manman Ren11fec382013-03-13 18:41:27 +00002133 assert(Die->getTag() == dwarf::DW_TAG_compile_unit &&
2134 "Input DIE should be compile unit in getCUOffset.");
Eric Christopherd25f7fc2013-08-08 01:41:05 +00002135 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(), E = CUs.end();
2136 I != E; ++I) {
Manman Ren14a029d2013-03-12 18:27:15 +00002137 CompileUnit *TheCU = *I;
2138 if (TheCU->getCUDie() == Die)
2139 return TheCU->getDebugInfoOffset();
2140 }
Manman Ren11fec382013-03-13 18:41:27 +00002141 llvm_unreachable("The compile unit DIE should belong to CUs in DwarfUnits.");
Manman Ren14a029d2013-03-12 18:27:15 +00002142}
2143
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002144// Emit the debug info section.
2145void DwarfDebug::emitDebugInfo() {
Eric Christophera2de8262012-12-15 00:04:07 +00002146 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2147
2148 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
2149 Asm->getObjFileLowering().getDwarfAbbrevSection(),
2150 DwarfAbbrevSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002151}
2152
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002153// Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +00002154void DwarfDebug::emitAbbreviations() {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002155 if (!useSplitDwarf())
2156 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
2157 &Abbreviations);
2158 else
2159 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2160}
Bill Wendling480ff322009-05-20 23:21:38 +00002161
Eric Christopher3c5a1912012-12-19 22:02:53 +00002162void DwarfDebug::emitAbbrevs(const MCSection *Section,
2163 std::vector<DIEAbbrev *> *Abbrevs) {
2164 // Check to see if it is worth the effort.
2165 if (!Abbrevs->empty()) {
2166 // Start the debug abbrev section.
2167 Asm->OutStreamer.SwitchSection(Section);
2168
2169 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
Eric Christopher996b2b72012-12-13 03:00:38 +00002170 Asm->OutStreamer.EmitLabel(Begin);
Bill Wendling480ff322009-05-20 23:21:38 +00002171
2172 // For each abbrevation.
Eric Christopher3c5a1912012-12-19 22:02:53 +00002173 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
Bill Wendling480ff322009-05-20 23:21:38 +00002174 // Get abbreviation data
Eric Christopher3c5a1912012-12-19 22:02:53 +00002175 const DIEAbbrev *Abbrev = Abbrevs->at(i);
Bill Wendling480ff322009-05-20 23:21:38 +00002176
2177 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00002178 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00002179
2180 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002181 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00002182 }
2183
2184 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00002185 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00002186
Eric Christopher3c5a1912012-12-19 22:02:53 +00002187 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
Eric Christopher996b2b72012-12-13 03:00:38 +00002188 Asm->OutStreamer.EmitLabel(End);
Bill Wendling480ff322009-05-20 23:21:38 +00002189 }
2190}
2191
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002192// Emit the last address of the section and the end of the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +00002193void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00002194 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00002195 Asm->OutStreamer.AddComment("Extended Op");
2196 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002197
Chris Lattner566cae92010-03-09 23:52:58 +00002198 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002199 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00002200 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2201 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2202
2203 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002204
Chris Lattnera179b522010-04-04 19:25:43 +00002205 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Eric Christopherce0cfce2013-01-09 01:35:34 +00002206 Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002207
2208 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00002209 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2210 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002211 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00002212 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002213}
2214
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002215// Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00002216void DwarfDebug::emitAccelNames() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002217 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002218 dwarf::DW_FORM_data4));
2219 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2220 E = CUMap.end(); I != E; ++I) {
2221 CompileUnit *TheCU = I->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00002222 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2223 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002224 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002225 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002226 const std::vector<DIE *> &Entities = GI->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00002227 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2228 DE = Entities.end(); DI != DE; ++DI)
2229 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00002230 }
2231 }
2232
2233 AT.FinalizeTable(Asm, "Names");
2234 Asm->OutStreamer.SwitchSection(
2235 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2236 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2237 Asm->OutStreamer.EmitLabel(SectionBegin);
2238
2239 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002240 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002241}
2242
Eric Christopher48fef592012-12-20 21:58:40 +00002243// Emit objective C classes and categories into a hashed accelerator table
2244// section.
Eric Christopher4996c702011-11-07 09:24:32 +00002245void DwarfDebug::emitAccelObjC() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002246 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002247 dwarf::DW_FORM_data4));
2248 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2249 E = CUMap.end(); I != E; ++I) {
2250 CompileUnit *TheCU = I->second;
2251 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2252 for (StringMap<std::vector<DIE*> >::const_iterator
2253 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002254 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002255 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher4996c702011-11-07 09:24:32 +00002256 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2257 DE = Entities.end(); DI != DE; ++DI)
2258 AT.AddName(Name, (*DI));
2259 }
2260 }
2261
2262 AT.FinalizeTable(Asm, "ObjC");
2263 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2264 .getDwarfAccelObjCSection());
2265 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2266 Asm->OutStreamer.EmitLabel(SectionBegin);
2267
2268 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002269 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002270}
2271
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002272// Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002273void DwarfDebug::emitAccelNamespaces() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002274 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002275 dwarf::DW_FORM_data4));
2276 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2277 E = CUMap.end(); I != E; ++I) {
2278 CompileUnit *TheCU = I->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00002279 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2280 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002281 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002282 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002283 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00002284 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2285 DE = Entities.end(); DI != DE; ++DI)
2286 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00002287 }
2288 }
2289
2290 AT.FinalizeTable(Asm, "namespac");
2291 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2292 .getDwarfAccelNamespaceSection());
2293 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2294 Asm->OutStreamer.EmitLabel(SectionBegin);
2295
2296 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002297 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002298}
2299
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002300// Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002301void DwarfDebug::emitAccelTypes() {
Eric Christopher21bde872012-01-06 04:35:23 +00002302 std::vector<DwarfAccelTable::Atom> Atoms;
Eric Christophercf7289f2013-09-05 18:20:16 +00002303 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher21bde872012-01-06 04:35:23 +00002304 dwarf::DW_FORM_data4));
Eric Christophercf7289f2013-09-05 18:20:16 +00002305 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag,
Eric Christopher21bde872012-01-06 04:35:23 +00002306 dwarf::DW_FORM_data2));
Eric Christophercf7289f2013-09-05 18:20:16 +00002307 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags,
Eric Christopher21bde872012-01-06 04:35:23 +00002308 dwarf::DW_FORM_data1));
2309 DwarfAccelTable AT(Atoms);
Eric Christopher4996c702011-11-07 09:24:32 +00002310 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2311 E = CUMap.end(); I != E; ++I) {
2312 CompileUnit *TheCU = I->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002313 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2314 = TheCU->getAccelTypes();
2315 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002316 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002317 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002318 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002319 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2320 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2321 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher4996c702011-11-07 09:24:32 +00002322 }
2323 }
2324
2325 AT.FinalizeTable(Asm, "types");
2326 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2327 .getDwarfAccelTypesSection());
2328 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2329 Asm->OutStreamer.EmitLabel(SectionBegin);
2330
2331 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002332 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002333}
2334
Eric Christopherdd1a0122013-09-13 00:35:05 +00002335// Public name handling.
2336// The format for the various pubnames:
2337//
2338// dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2339// for the DIE that is named.
2340//
2341// gnu pubnames - offset/index value/name tuples where the offset is the offset
2342// into the CU and the index value is computed according to the type of value
2343// for the DIE that is named.
2344//
2345// For type units the offset is the offset of the skeleton DIE. For split dwarf
2346// it's the offset within the debug_info/debug_types dwo section, however, the
2347// reference in the pubname header doesn't change.
2348
2349/// computeIndexValue - Compute the gdb index value for the DIE and CU.
David Blaikie8dec4072013-09-19 20:40:26 +00002350static dwarf::PubIndexEntryDescriptor computeIndexValue(CompileUnit *CU,
2351 DIE *Die) {
2352 dwarf::GDBIndexEntryLinkage IsStatic =
2353 Die->findAttribute(dwarf::DW_AT_external) ? dwarf::GIEL_EXTERNAL
2354 : dwarf::GIEL_STATIC;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002355
2356 switch (Die->getTag()) {
2357 case dwarf::DW_TAG_class_type:
2358 case dwarf::DW_TAG_structure_type:
2359 case dwarf::DW_TAG_union_type:
2360 case dwarf::DW_TAG_enumeration_type:
2361 case dwarf::DW_TAG_typedef:
2362 case dwarf::DW_TAG_base_type:
2363 case dwarf::DW_TAG_subrange_type:
David Blaikie8dec4072013-09-19 20:40:26 +00002364 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002365 case dwarf::DW_TAG_namespace:
David Blaikie8dec4072013-09-19 20:40:26 +00002366 return dwarf::GIEK_TYPE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002367 case dwarf::DW_TAG_subprogram:
David Blaikie8dec4072013-09-19 20:40:26 +00002368 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, IsStatic);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002369 case dwarf::DW_TAG_constant:
2370 case dwarf::DW_TAG_variable:
David Blaikie8dec4072013-09-19 20:40:26 +00002371 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, IsStatic);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002372 case dwarf::DW_TAG_enumerator:
David Blaikie8dec4072013-09-19 20:40:26 +00002373 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2374 dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002375 default:
David Blaikie8dec4072013-09-19 20:40:26 +00002376 return dwarf::GIEK_NONE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002377 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002378}
2379
Eric Christopher5f93bb92013-09-09 20:03:17 +00002380/// emitDebugPubNames - Emit visible names into a debug pubnames section.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002381///
Eric Christopherdd1a0122013-09-13 00:35:05 +00002382void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002383 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christopherdd1a0122013-09-13 00:35:05 +00002384 const MCSection *PSec =
2385 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2386 : Asm->getObjFileLowering().getDwarfPubNamesSection();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002387
2388 typedef DenseMap<const MDNode*, CompileUnit*> CUMapType;
2389 for (CUMapType::iterator I = CUMap.begin(), E = CUMap.end(); I != E; ++I) {
2390 CompileUnit *TheCU = I->second;
2391 unsigned ID = TheCU->getUniqueID();
2392
2393 if (TheCU->getGlobalNames().empty())
2394 continue;
2395
2396 // Start the dwarf pubnames section.
Eric Christopher13b99d22013-09-10 21:49:37 +00002397 Asm->OutStreamer.SwitchSection(PSec);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002398
Eric Christopherdd1a0122013-09-13 00:35:05 +00002399 // Emit the header.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002400 Asm->OutStreamer.AddComment("Length of Public Names Info");
2401 Asm->EmitLabelDifference(Asm->GetTempSymbol("pubnames_end", ID),
2402 Asm->GetTempSymbol("pubnames_begin", ID), 4);
2403
2404 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin", ID));
2405
2406 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002407 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002408
2409 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2410 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2411 DwarfInfoSectionSym);
2412
2413 Asm->OutStreamer.AddComment("Compilation Unit Length");
2414 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(), ID),
2415 Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2416 4);
2417
Eric Christopherdd1a0122013-09-13 00:35:05 +00002418 // Emit the pubnames for this compilation unit.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002419 const StringMap<DIE*> &Globals = TheCU->getGlobalNames();
2420 for (StringMap<DIE*>::const_iterator
2421 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2422 const char *Name = GI->getKeyData();
Eric Christopherdd1a0122013-09-13 00:35:05 +00002423 DIE *Entity = GI->second;
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002424
2425 Asm->OutStreamer.AddComment("DIE offset");
2426 Asm->EmitInt32(Entity->getOffset());
2427
Eric Christopherdd1a0122013-09-13 00:35:05 +00002428 if (GnuStyle) {
David Blaikied0a869d2013-09-19 22:19:37 +00002429 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2430 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002431 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002432 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002433 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002434 }
2435
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002436 if (Asm->isVerbose())
2437 Asm->OutStreamer.AddComment("External Name");
Rafael Espindola64e1af82013-07-02 15:49:13 +00002438 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002439 }
2440
2441 Asm->OutStreamer.AddComment("End Mark");
2442 Asm->EmitInt32(0);
2443 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end", ID));
2444 }
2445}
2446
Eric Christopherdd1a0122013-09-13 00:35:05 +00002447void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
Eric Christopher8b3737f2013-09-13 00:34:58 +00002448 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2449 const MCSection *PSec = Asm->getObjFileLowering().getDwarfPubTypesSection();
2450
Devang Patel1a0df9a2010-05-10 22:49:55 +00002451 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
Eric Christopher8b3737f2013-09-13 00:34:58 +00002452 E = CUMap.end();
2453 I != E; ++I) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002454 CompileUnit *TheCU = I->second;
Eric Christopher6abc9c52011-11-07 09:18:35 +00002455 // Start the dwarf pubtypes section.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002456 Asm->OutStreamer.SwitchSection(PSec);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002457 Asm->OutStreamer.AddComment("Length of Public Types Info");
2458 Asm->EmitLabelDifference(
Eric Christopher8b3737f2013-09-13 00:34:58 +00002459 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2460 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002461
Eric Christopher8b3737f2013-09-13 00:34:58 +00002462 Asm->OutStreamer.EmitLabel(
2463 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002464
Eric Christopher8b3737f2013-09-13 00:34:58 +00002465 if (Asm->isVerbose())
2466 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002467 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002468
Devang Patel1a0df9a2010-05-10 22:49:55 +00002469 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002470 Asm->EmitSectionOffset(
2471 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()),
2472 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002473
Devang Patel1a0df9a2010-05-10 22:49:55 +00002474 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002475 Asm->EmitLabelDifference(
2476 Asm->GetTempSymbol(ISec->getLabelEndName(), TheCU->getUniqueID()),
2477 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002478
Eric Christopher8b3737f2013-09-13 00:34:58 +00002479 const StringMap<DIE *> &Globals = TheCU->getGlobalTypes();
2480 for (StringMap<DIE *>::const_iterator GI = Globals.begin(),
2481 GE = Globals.end();
2482 GI != GE; ++GI) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002483 const char *Name = GI->getKeyData();
Nick Lewycky019d2552011-07-29 03:49:23 +00002484 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002485
Eric Christopher8b3737f2013-09-13 00:34:58 +00002486 if (Asm->isVerbose())
2487 Asm->OutStreamer.AddComment("DIE offset");
Devang Patel1a0df9a2010-05-10 22:49:55 +00002488 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002489
Eric Christopherdd1a0122013-09-13 00:35:05 +00002490 if (GnuStyle) {
David Blaikied0a869d2013-09-19 22:19:37 +00002491 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2492 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002493 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002494 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002495 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002496 }
2497
Eric Christopher8b3737f2013-09-13 00:34:58 +00002498 if (Asm->isVerbose())
2499 Asm->OutStreamer.AddComment("External Name");
2500
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002501 // Emit the name with a terminating null byte.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002502 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002503 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002504
Devang Patel1a0df9a2010-05-10 22:49:55 +00002505 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002506 Asm->EmitInt32(0);
Eric Christopher8b3737f2013-09-13 00:34:58 +00002507 Asm->OutStreamer.EmitLabel(
2508 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00002509 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002510}
2511
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002512// Emit strings into a string section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002513void DwarfUnits::emitStrings(const MCSection *StrSection,
2514 const MCSection *OffsetSection = NULL,
2515 const MCSymbol *StrSecSym = NULL) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002516
Eric Christopher27614582013-01-08 22:22:06 +00002517 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002518
Chris Lattner3d72a672010-03-09 23:38:23 +00002519 // Start the dwarf str section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002520 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling480ff322009-05-20 23:21:38 +00002521
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002522 // Get all of the string pool entries and put them in an array by their ID so
2523 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002524 SmallVector<std::pair<unsigned,
Eric Christopherb800ff72013-01-07 22:40:45 +00002525 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002526
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002527 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
Eric Christopher27614582013-01-08 22:22:06 +00002528 I = StringPool.begin(), E = StringPool.end();
Eric Christopher48fef592012-12-20 21:58:40 +00002529 I != E; ++I)
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002530 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002531
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002532 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002533
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002534 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002535 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002536 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002537
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002538 // Emit the string itself with a terminating null byte.
Benjamin Kramer148db362011-11-09 12:12:04 +00002539 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
Eric Christopherce0cfce2013-01-09 01:35:34 +00002540 Entries[i].second->getKeyLength()+1));
Bill Wendling480ff322009-05-20 23:21:38 +00002541 }
Eric Christopher2cbd5762013-01-07 19:32:41 +00002542
2543 // If we've got an offset section go ahead and emit that now as well.
2544 if (OffsetSection) {
2545 Asm->OutStreamer.SwitchSection(OffsetSection);
2546 unsigned offset = 0;
Eric Christopher962c9082013-01-15 23:56:56 +00002547 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002548 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopherbf7bc492013-01-09 03:52:05 +00002549 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopher2cbd5762013-01-07 19:32:41 +00002550 offset += Entries[i].second->getKeyLength() + 1;
2551 }
2552 }
Bill Wendling480ff322009-05-20 23:21:38 +00002553}
2554
Eric Christopher962c9082013-01-15 23:56:56 +00002555// Emit strings into a string section.
2556void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2557
2558 if (AddressPool.empty()) return;
2559
2560 // Start the dwarf addr section.
2561 Asm->OutStreamer.SwitchSection(AddrSection);
2562
David Blaikiece1960f2013-07-08 17:51:28 +00002563 // Order the address pool entries by ID
David Blaikieac569a62013-07-08 17:33:10 +00002564 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher962c9082013-01-15 23:56:56 +00002565
David Blaikiece1960f2013-07-08 17:51:28 +00002566 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2567 E = AddressPool.end();
Eric Christopher962c9082013-01-15 23:56:56 +00002568 I != E; ++I)
David Blaikieac569a62013-07-08 17:33:10 +00002569 Entries[I->second] = I->first;
Eric Christopher962c9082013-01-15 23:56:56 +00002570
2571 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002572 // Emit an expression for reference from debug information entries.
David Blaikieac569a62013-07-08 17:33:10 +00002573 if (const MCExpr *Expr = Entries[i])
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002574 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
Eric Christopher962c9082013-01-15 23:56:56 +00002575 else
2576 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2577 }
2578
2579}
2580
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002581// Emit visible names into a debug str section.
2582void DwarfDebug::emitDebugStr() {
2583 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2584 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2585}
2586
Eric Christopher9046f942013-07-02 21:36:07 +00002587// Emit locations into the debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002588void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002589 if (DotDebugLocEntries.empty())
2590 return;
2591
Eric Christopher4887c8f2013-03-29 23:34:06 +00002592 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Devang Patel116a9d72011-02-04 22:57:18 +00002593 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2594 I != E; ++I) {
2595 DotDebugLocEntry &Entry = *I;
2596 if (I + 1 != DotDebugLocEntries.end())
2597 Entry.Merge(I+1);
2598 }
2599
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002600 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002601 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00002602 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002603 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002604 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2605 unsigned index = 1;
Eric Christopher4887c8f2013-03-29 23:34:06 +00002606 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002607 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002608 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002609 DotDebugLocEntry &Entry = *I;
2610 if (Entry.isMerged()) continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002611 if (Entry.isEmpty()) {
Eric Christopherce0cfce2013-01-09 01:35:34 +00002612 Asm->OutStreamer.EmitIntValue(0, Size);
2613 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002614 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002615 } else {
Eric Christopher25f06422013-07-03 22:40:18 +00002616 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2617 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2618 DIVariable DV(Entry.getVariable());
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002619 Asm->OutStreamer.AddComment("Loc expr size");
2620 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2621 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2622 Asm->EmitLabelDifference(end, begin, 2);
2623 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002624 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002625 DIBasicType BTy(DV.getType());
2626 if (BTy.Verify() &&
Eric Christopher6a841382012-11-19 22:42:10 +00002627 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patel324f8432011-06-01 22:03:25 +00002628 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2629 Asm->OutStreamer.AddComment("DW_OP_consts");
2630 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002631 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002632 } else {
2633 Asm->OutStreamer.AddComment("DW_OP_constu");
2634 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002635 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002636 }
Devang Pateled9fd452011-07-08 16:49:43 +00002637 } else if (Entry.isLocation()) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002638 MachineLocation Loc = Entry.getLoc();
Eric Christopher6a841382012-11-19 22:42:10 +00002639 if (!DV.hasComplexAddress())
Devang Pateled9fd452011-07-08 16:49:43 +00002640 // Regular entry.
Eric Christopher614a89f2013-07-03 22:40:21 +00002641 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002642 else {
2643 // Complex address entry.
2644 unsigned N = DV.getNumAddrElements();
2645 unsigned i = 0;
2646 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002647 if (Loc.getOffset()) {
Devang Pateled9fd452011-07-08 16:49:43 +00002648 i = 2;
Eric Christopher614a89f2013-07-03 22:40:21 +00002649 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002650 Asm->OutStreamer.AddComment("DW_OP_deref");
2651 Asm->EmitInt8(dwarf::DW_OP_deref);
2652 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2653 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2654 Asm->EmitSLEB128(DV.getAddrElement(1));
2655 } else {
2656 // If first address element is OpPlus then emit
2657 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher614a89f2013-07-03 22:40:21 +00002658 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2659 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002660 i = 2;
2661 }
2662 } else {
Eric Christopher614a89f2013-07-03 22:40:21 +00002663 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002664 }
Eric Christopher6a841382012-11-19 22:42:10 +00002665
Devang Pateled9fd452011-07-08 16:49:43 +00002666 // Emit remaining complex address elements.
2667 for (; i < N; ++i) {
2668 uint64_t Element = DV.getAddrElement(i);
2669 if (Element == DIBuilder::OpPlus) {
2670 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2671 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher4d250522012-05-08 18:56:00 +00002672 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002673 if (!Loc.isReg())
Eric Christopher4d250522012-05-08 18:56:00 +00002674 Asm->EmitInt8(dwarf::DW_OP_deref);
2675 } else
2676 llvm_unreachable("unknown Opcode found in complex address");
Devang Pateled9fd452011-07-08 16:49:43 +00002677 }
Devang Patel3e021532011-04-28 02:22:40 +00002678 }
Devang Patel3e021532011-04-28 02:22:40 +00002679 }
Devang Pateled9fd452011-07-08 16:49:43 +00002680 // else ... ignore constant fp. There is not any good way to
2681 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002682 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002683 }
2684 }
Bill Wendling480ff322009-05-20 23:21:38 +00002685}
2686
Richard Mitton21101b32013-09-19 23:21:01 +00002687struct SymbolCUSorter {
2688 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2689 const MCStreamer &Streamer;
2690
2691 bool operator() (const SymbolCU &A, const SymbolCU &B) {
2692 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2693 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2694
2695 // Symbols with no order assigned should be placed at the end.
2696 // (e.g. section end labels)
2697 if (IA == 0)
2698 IA = (unsigned)(-1);
2699 if (IB == 0)
2700 IB = (unsigned)(-1);
2701 return IA < IB;
2702 }
2703};
2704
2705static bool SectionSort(const MCSection *A, const MCSection *B) {
2706 std::string LA = (A ? A->getLabelBeginName() : "");
2707 std::string LB = (B ? B->getLabelBeginName() : "");
2708 return LA < LB;
2709}
2710
2711static bool CUSort(const CompileUnit *A, const CompileUnit *B) {
2712 return (A->getUniqueID() < B->getUniqueID());
2713}
2714
2715struct ArangeSpan {
2716 const MCSymbol *Start, *End;
2717};
2718
2719// Emit a debug aranges section, containing a CU lookup for any
2720// address we can tie back to a CU.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002721void DwarfDebug::emitDebugARanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002722 // Start the dwarf aranges section.
Eric Christopherac8199b2013-08-30 00:39:57 +00002723 Asm->OutStreamer
2724 .SwitchSection(Asm->getObjFileLowering().getDwarfARangesSection());
Richard Mitton21101b32013-09-19 23:21:01 +00002725
2726 typedef DenseMap<CompileUnit *, std::vector<ArangeSpan> > SpansType;
2727
2728 SpansType Spans;
2729
2730 // Build a list of sections used.
2731 std::vector<const MCSection *> Sections;
2732 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2733 it++) {
2734 const MCSection *Section = it->first;
2735 Sections.push_back(Section);
2736 }
2737
2738 // Sort the sections into order.
2739 // This is only done to ensure consistent output order across different runs.
2740 std::sort(Sections.begin(), Sections.end(), SectionSort);
2741
2742 // Build a set of address spans, sorted by CU.
2743 for (size_t SecIdx=0;SecIdx<Sections.size();SecIdx++) {
2744 const MCSection *Section = Sections[SecIdx];
2745 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2746 if (List.size() < 2)
2747 continue;
2748
2749 // Sort the symbols by offset within the section.
2750 SymbolCUSorter sorter(Asm->OutStreamer);
2751 std::sort(List.begin(), List.end(), sorter);
2752
2753 // If we have no section (e.g. common), just write out
2754 // individual spans for each symbol.
2755 if (Section == NULL) {
2756 for (size_t n = 0; n < List.size(); n++) {
2757 const SymbolCU &Cur = List[n];
2758
2759 ArangeSpan Span;
2760 Span.Start = Cur.Sym;
2761 Span.End = NULL;
2762 if (Cur.CU)
2763 Spans[Cur.CU].push_back(Span);
2764 }
2765 } else {
2766 // Build spans between each label.
2767 const MCSymbol *StartSym = List[0].Sym;
2768 for (size_t n = 1; n < List.size(); n++) {
2769 const SymbolCU &Prev = List[n - 1];
2770 const SymbolCU &Cur = List[n];
2771
2772 // Try and build the longest span we can within the same CU.
2773 if (Cur.CU != Prev.CU) {
2774 ArangeSpan Span;
2775 Span.Start = StartSym;
2776 Span.End = Cur.Sym;
2777 Spans[Prev.CU].push_back(Span);
2778 StartSym = Cur.Sym;
2779 }
2780 }
2781 }
2782 }
2783
2784 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2785 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2786
2787 // Build a list of CUs used.
2788 std::vector<CompileUnit *> CUs;
2789 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
2790 CompileUnit *CU = it->first;
2791 CUs.push_back(CU);
2792 }
2793
2794 // Sort the CU list (again, to ensure consistent output order).
2795 std::sort(CUs.begin(), CUs.end(), CUSort);
2796
2797 // Emit an arange table for each CU we used.
2798 for (size_t CUIdx=0;CUIdx<CUs.size();CUIdx++) {
2799 CompileUnit *CU = CUs[CUIdx];
2800 std::vector<ArangeSpan> &List = Spans[CU];
2801
2802 // Emit size of content not including length itself.
2803 unsigned ContentSize
2804 = sizeof(int16_t) // DWARF ARange version number
2805 + sizeof(int32_t) // Offset of CU in the .debug_info section
2806 + sizeof(int8_t) // Pointer Size (in bytes)
2807 + sizeof(int8_t); // Segment Size (in bytes)
2808
2809 unsigned TupleSize = PtrSize * 2;
2810
2811 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2812 unsigned Padding = 0;
2813 while (((sizeof(int32_t) + ContentSize + Padding) % TupleSize) != 0)
2814 Padding++;
2815
2816 ContentSize += Padding;
2817 ContentSize += (List.size() + 1) * TupleSize;
2818
2819 // For each compile unit, write the list of spans it covers.
2820 Asm->OutStreamer.AddComment("Length of ARange Set");
2821 Asm->EmitInt32(ContentSize);
2822 Asm->OutStreamer.AddComment("DWARF Arange version number");
2823 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2824 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
2825 Asm->EmitSectionOffset(
2826 Asm->GetTempSymbol(ISec->getLabelBeginName(), CU->getUniqueID()),
2827 DwarfInfoSectionSym);
2828 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2829 Asm->EmitInt8(PtrSize);
2830 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2831 Asm->EmitInt8(0);
2832
2833 for (unsigned n = 0; n < Padding; n++)
2834 Asm->EmitInt8(0xff);
2835
2836 for (unsigned n = 0; n < List.size(); n++) {
2837 const ArangeSpan &Span = List[n];
2838 Asm->EmitLabelReference(Span.Start, PtrSize);
2839
2840 // Calculate the size as being from the span start to it's end.
2841 // If we have no valid end symbol, then we just cover the first byte.
2842 // (this sucks, but I can't seem to figure out how to get the size)
2843 if (Span.End)
2844 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
2845 else
2846 Asm->OutStreamer.EmitIntValue(1, PtrSize);
2847 }
2848
2849 Asm->OutStreamer.AddComment("ARange terminator");
2850 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2851 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2852 }
Bill Wendling480ff322009-05-20 23:21:38 +00002853}
2854
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002855// Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002856void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002857 // Start the dwarf ranges section.
Eric Christopherac8199b2013-08-30 00:39:57 +00002858 Asm->OutStreamer
2859 .SwitchSection(Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002860 unsigned char Size = Asm->getDataLayout().getPointerSize();
Eric Christopher4887c8f2013-03-29 23:34:06 +00002861 for (SmallVectorImpl<const MCSymbol *>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002862 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00002863 I != E; ++I) {
2864 if (*I)
Eric Christopherbf7bc492013-01-09 03:52:05 +00002865 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
Devang Patel12563b32010-04-16 23:33:45 +00002866 else
Eric Christopherce0cfce2013-01-09 01:35:34 +00002867 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel12563b32010-04-16 23:33:45 +00002868 }
Bill Wendling480ff322009-05-20 23:21:38 +00002869}
2870
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002871// Emit visible names into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002872void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002873 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00002874 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00002875 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002876 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00002877 }
2878}
2879
Eric Christopherd692c1d2012-12-11 19:42:09 +00002880// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002881
2882// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2883// DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2884// DW_AT_ranges_base, DW_AT_addr_base. If DW_AT_ranges is present,
2885// DW_AT_low_pc and DW_AT_high_pc are not used, and vice versa.
Eric Christopher6fdf3242013-08-26 23:50:43 +00002886CompileUnit *DwarfDebug::constructSkeletonCU(const CompileUnit *CU) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002887
2888 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher6fdf3242013-08-26 23:50:43 +00002889 CompileUnit *NewCU = new CompileUnit(CU->getUniqueID(), Die, CU->getNode(),
2890 Asm, this, &SkeletonHolder);
Eric Christopher4c7765f2013-01-17 03:00:04 +00002891
Eric Christopherdae389b2013-02-22 23:50:08 +00002892 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
Eric Christopher6b16b432013-08-26 23:57:03 +00002893 DICompileUnit(CU->getNode()).getSplitDebugFilename());
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002894
Eric Christopher44c6aa62013-04-22 07:51:08 +00002895 // Relocate to the beginning of the addr_base section, else 0 for the
2896 // beginning of the one for this compile unit.
Eric Christopher55863be2013-04-07 03:43:09 +00002897 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2898 NewCU->addLabel(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2899 DwarfAddrSectionSym);
2900 else
Eric Christopher44c6aa62013-04-22 07:51:08 +00002901 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base,
2902 dwarf::DW_FORM_sec_offset, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002903
2904 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher962c9082013-01-15 23:56:56 +00002905 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002906 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher962c9082013-01-15 23:56:56 +00002907
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002908 // DW_AT_stmt_list is a offset of line number information for this
2909 // compile unit in debug_line section.
Eric Christopher55863be2013-04-07 03:43:09 +00002910 // FIXME: Should handle multiple compile units.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002911 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher4c7765f2013-01-17 03:00:04 +00002912 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher74804332013-02-07 21:19:50 +00002913 DwarfLineSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002914 else
Eric Christopher4c7765f2013-01-17 03:00:04 +00002915 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002916
2917 if (!CompilationDir.empty())
Eric Christopher2cbd5762013-01-07 19:32:41 +00002918 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002919
Eric Christopherdd1a0122013-09-13 00:35:05 +00002920 // Flag to let the linker know we have emitted new style pubnames.
2921 if (GenerateGnuPubSections)
2922 NewCU->addFlag(Die, dwarf::DW_AT_GNU_pubnames);
2923
Eric Christopherc8a310e2012-12-10 23:34:43 +00002924 SkeletonHolder.addUnit(NewCU);
Eric Christopher5b33b3c2013-02-06 21:53:56 +00002925 SkeletonCUs.push_back(NewCU);
Eric Christopherc8a310e2012-12-10 23:34:43 +00002926
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002927 return NewCU;
2928}
2929
Eric Christopher3c5a1912012-12-19 22:02:53 +00002930void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
2931 assert(useSplitDwarf() && "No split dwarf debug info?");
2932 emitAbbrevs(Section, &SkeletonAbbrevs);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002933}
2934
Eric Christopherd692c1d2012-12-11 19:42:09 +00002935// Emit the .debug_info.dwo section for separated dwarf. This contains the
2936// compile units that would normally be in debug_info.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002937void DwarfDebug::emitDebugInfoDWO() {
Eric Christophercdf218d2012-12-10 19:51:21 +00002938 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christophera2de8262012-12-15 00:04:07 +00002939 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
Eric Christopher3c5a1912012-12-19 22:02:53 +00002940 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2941 DwarfAbbrevDWOSectionSym);
2942}
2943
2944// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2945// abbreviations for the .debug_info.dwo section.
2946void DwarfDebug::emitDebugAbbrevDWO() {
2947 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopher48fef592012-12-20 21:58:40 +00002948 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2949 &Abbreviations);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002950}
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002951
2952// Emit the .debug_str.dwo section for separated dwarf. This contains the
2953// string section and is identical in format to traditional .debug_str
2954// sections.
2955void DwarfDebug::emitDebugStrDWO() {
2956 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherb800ff72013-01-07 22:40:45 +00002957 const MCSection *OffSec = Asm->getObjFileLowering()
2958 .getDwarfStrOffDWOSection();
Eric Christopher2cbd5762013-01-07 19:32:41 +00002959 const MCSymbol *StrSym = DwarfStrSectionSym;
2960 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
2961 OffSec, StrSym);
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002962}