blob: cfe4ea6e3f4b52b3ee0421f78a8459bc410f52ee [file] [log] [blame]
Bill Wendling2f921f82009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Chris Lattnerb14490d2010-03-09 00:39:24 +000013
Devang Patel80ae3492009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling2f921f82009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000016#include "DIE.h"
Eric Christopher45731982013-08-08 23:45:55 +000017#include "DIEHash.h"
Eric Christopher4996c702011-11-07 09:24:32 +000018#include "DwarfAccelTable.h"
Devang Patel5eb43192011-04-12 17:40:32 +000019#include "DwarfCompileUnit.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000020#include "llvm/ADT/STLExtras.h"
21#include "llvm/ADT/Statistic.h"
22#include "llvm/ADT/StringExtras.h"
23#include "llvm/ADT/Triple.h"
David Greene829b3e82009-08-19 21:52:55 +000024#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000025#include "llvm/CodeGen/MachineModuleInfo.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000026#include "llvm/DIBuilder.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000027#include "llvm/DebugInfo.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000028#include "llvm/IR/Constants.h"
29#include "llvm/IR/DataLayout.h"
30#include "llvm/IR/Instructions.h"
31#include "llvm/IR/Module.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000032#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000033#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000034#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000035#include "llvm/MC/MCSymbol.h"
Devang Patel6c74a872010-04-27 19:46:33 +000036#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000037#include "llvm/Support/Debug.h"
David Majnemered89b5c2013-08-21 06:13:34 +000038#include "llvm/Support/Dwarf.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000039#include "llvm/Support/ErrorHandling.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000040#include "llvm/Support/FormattedStream.h"
Eric Christopher67646432013-07-26 17:02:41 +000041#include "llvm/Support/MD5.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000042#include "llvm/Support/Path.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000043#include "llvm/Support/Timer.h"
44#include "llvm/Support/ValueHandle.h"
45#include "llvm/Target/TargetFrameLowering.h"
46#include "llvm/Target/TargetLoweringObjectFile.h"
47#include "llvm/Target/TargetMachine.h"
48#include "llvm/Target/TargetOptions.h"
49#include "llvm/Target/TargetRegisterInfo.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000050using namespace llvm;
51
Eric Christopher7f2b5512013-07-23 22:16:41 +000052static cl::opt<bool>
53DisableDebugInfoPrinting("disable-debug-info-print", cl::Hidden,
54 cl::desc("Disable debug info printing"));
Devang Patel6c74a872010-04-27 19:46:33 +000055
Eric Christopher7f2b5512013-07-23 22:16:41 +000056static cl::opt<bool> UnknownLocations(
57 "use-unknown-locations", cl::Hidden,
58 cl::desc("Make an absence of debug location information explicit."),
59 cl::init(false));
Dan Gohman7421ae42010-05-07 01:08:53 +000060
Eric Christopher7f2b5512013-07-23 22:16:41 +000061static cl::opt<bool>
Eric Christopher67646432013-07-26 17:02:41 +000062GenerateODRHash("generate-odr-hash", cl::Hidden,
63 cl::desc("Add an ODR hash to external type DIEs."),
64 cl::init(false));
65
Eric Christopherd29614f2013-08-13 01:21:55 +000066static cl::opt<bool>
67GenerateCUHash("generate-cu-hash", cl::Hidden,
68 cl::desc("Add the CU hash as the dwo_id."),
69 cl::init(false));
70
Eric Christopherdd1a0122013-09-13 00:35:05 +000071static cl::opt<bool>
72GenerateGnuPubSections("generate-gnu-dwarf-pub-sections", cl::Hidden,
73 cl::desc("Generate GNU-style pubnames and pubtypes"),
74 cl::init(false));
75
Eric Christopher20b76a72012-08-23 22:36:40 +000076namespace {
Eric Christopher7f2b5512013-07-23 22:16:41 +000077enum DefaultOnOff {
78 Default,
79 Enable,
80 Disable
81};
Eric Christopher20b76a72012-08-23 22:36:40 +000082}
Eric Christopher4996c702011-11-07 09:24:32 +000083
Eric Christopher7f2b5512013-07-23 22:16:41 +000084static cl::opt<DefaultOnOff>
85DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
86 cl::desc("Output prototype dwarf accelerator tables."),
87 cl::values(clEnumVal(Default, "Default for platform"),
88 clEnumVal(Enable, "Enabled"),
89 clEnumVal(Disable, "Disabled"), clEnumValEnd),
90 cl::init(Default));
Eric Christopher20b76a72012-08-23 22:36:40 +000091
Eric Christopher7f2b5512013-07-23 22:16:41 +000092static cl::opt<DefaultOnOff>
Eric Christopher7f2b5512013-07-23 22:16:41 +000093SplitDwarf("split-dwarf", cl::Hidden,
94 cl::desc("Output prototype dwarf split debug info."),
95 cl::values(clEnumVal(Default, "Default for platform"),
96 clEnumVal(Enable, "Enabled"),
97 clEnumVal(Disable, "Disabled"), clEnumValEnd),
98 cl::init(Default));
Eric Christopher29424312012-11-12 22:22:20 +000099
Eric Christopher7da24882013-08-19 21:07:38 +0000100static cl::opt<DefaultOnOff>
Eric Christopher4d36ca02013-08-26 23:24:35 +0000101DwarfPubSections("generate-dwarf-pub-sections", cl::Hidden,
102 cl::desc("Generate DWARF pubnames and pubtypes sections"),
103 cl::values(clEnumVal(Default, "Default for platform"),
104 clEnumVal(Enable, "Enabled"),
105 clEnumVal(Disable, "Disabled"), clEnumValEnd),
106 cl::init(Default));
Eric Christopher7da24882013-08-19 21:07:38 +0000107
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000108static const char *const DWARFGroupName = "DWARF Emission";
109static const char *const DbgTimerName = "DWARF Debug Writer";
Bill Wendlingfcc14142010-04-07 09:28:04 +0000110
Bill Wendling2f921f82009-05-15 09:23:25 +0000111//===----------------------------------------------------------------------===//
112
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000113// Configuration values for initial hash set sizes (log2).
114//
Bill Wendling2f921f82009-05-15 09:23:25 +0000115static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +0000116
117namespace llvm {
118
Manman Renbe5576f2013-10-08 19:07:44 +0000119/// resolve - Look in the DwarfDebug map for the MDNode that
120/// corresponds to the reference.
121template <typename T>
122T DbgVariable::resolve(DIRef<T> Ref) const {
123 return DD->resolve(Ref);
124}
125
Nick Lewycky019d2552011-07-29 03:49:23 +0000126DIType DbgVariable::getType() const {
Devang Patelf20c4f72011-04-12 22:53:02 +0000127 DIType Ty = Var.getType();
128 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
129 // addresses instead.
130 if (Var.isBlockByrefVariable()) {
131 /* Byref variables, in Blocks, are declared by the programmer as
132 "SomeType VarName;", but the compiler creates a
133 __Block_byref_x_VarName struct, and gives the variable VarName
134 either the struct, or a pointer to the struct, as its type. This
135 is necessary for various behind-the-scenes things the compiler
136 needs to do with by-reference variables in blocks.
Eric Christopher6a841382012-11-19 22:42:10 +0000137
Devang Patelf20c4f72011-04-12 22:53:02 +0000138 However, as far as the original *programmer* is concerned, the
139 variable should still have type 'SomeType', as originally declared.
Eric Christopher6a841382012-11-19 22:42:10 +0000140
Devang Patelf20c4f72011-04-12 22:53:02 +0000141 The following function dives into the __Block_byref_x_VarName
142 struct to find the original type of the variable. This will be
143 passed back to the code generating the type for the Debug
144 Information Entry for the variable 'VarName'. 'VarName' will then
145 have the original type 'SomeType' in its debug information.
Eric Christopher6a841382012-11-19 22:42:10 +0000146
Devang Patelf20c4f72011-04-12 22:53:02 +0000147 The original type 'SomeType' will be the type of the field named
148 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher6a841382012-11-19 22:42:10 +0000149
Devang Patelf20c4f72011-04-12 22:53:02 +0000150 NOTE: In order for this to not completely fail on the debugger
151 side, the Debug Information Entry for the variable VarName needs to
152 have a DW_AT_location that tells the debugger how to unwind through
153 the pointers and __Block_byref_x_VarName struct to find the actual
154 value of the variable. The function addBlockByrefType does this. */
155 DIType subType = Ty;
Eric Christopher31b05762013-08-08 01:41:00 +0000156 uint16_t tag = Ty.getTag();
Eric Christopher6a841382012-11-19 22:42:10 +0000157
Eric Christopher9adc55f2013-09-04 19:53:21 +0000158 if (tag == dwarf::DW_TAG_pointer_type)
Manman Renbe5576f2013-10-08 19:07:44 +0000159 subType = resolve(DIDerivedType(Ty).getTypeDerivedFrom());
Eric Christopher6a841382012-11-19 22:42:10 +0000160
Eric Christopher9adc55f2013-09-04 19:53:21 +0000161 DIArray Elements = DICompositeType(subType).getTypeArray();
Devang Patelf20c4f72011-04-12 22:53:02 +0000162 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
Eric Christopher9adc55f2013-09-04 19:53:21 +0000163 DIDerivedType DT = DIDerivedType(Elements.getElement(i));
Devang Patelf20c4f72011-04-12 22:53:02 +0000164 if (getName() == DT.getName())
Manman Renbe5576f2013-10-08 19:07:44 +0000165 return (resolve(DT.getTypeDerivedFrom()));
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000166 }
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000167 }
Devang Patelf20c4f72011-04-12 22:53:02 +0000168 return Ty;
169}
Bill Wendling2f921f82009-05-15 09:23:25 +0000170
Chris Lattnerf5d06362010-04-05 04:09:20 +0000171} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000172
Manman Renac8062b2013-07-02 23:40:10 +0000173/// Return Dwarf Version by checking module flags.
174static unsigned getDwarfVersionFromModule(const Module *M) {
Manman Ren8bfde892013-07-16 23:21:16 +0000175 Value *Val = M->getModuleFlag("Dwarf Version");
176 if (!Val)
Eric Christophere31e0722013-09-04 22:21:24 +0000177 return dwarf::DWARF_VERSION;
Manman Ren8bfde892013-07-16 23:21:16 +0000178 return cast<ConstantInt>(Val)->getZExtValue();
Manman Renac8062b2013-07-02 23:40:10 +0000179}
180
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000181DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Eric Christopherd79f5482012-12-10 19:51:13 +0000182 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000183 AbbreviationsSet(InitAbbreviationsSetSize),
Eric Christopher27614582013-01-08 22:22:06 +0000184 SourceIdMap(DIEValueAllocator),
Eric Christopherc8a310e2012-12-10 23:34:43 +0000185 PrevLabel(NULL), GlobalCUIndexCount(0),
Eric Christopher27614582013-01-08 22:22:06 +0000186 InfoHolder(A, &AbbreviationsSet, &Abbreviations, "info_string",
187 DIEValueAllocator),
Eric Christopher3c5a1912012-12-19 22:02:53 +0000188 SkeletonAbbrevSet(InitAbbreviationsSetSize),
Eric Christopher27614582013-01-08 22:22:06 +0000189 SkeletonHolder(A, &SkeletonAbbrevSet, &SkeletonAbbrevs, "skel_string",
190 DIEValueAllocator) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000191
Rafael Espindolaa7160962011-05-06 14:56:22 +0000192 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattnere58b5472010-04-04 23:10:38 +0000193 DwarfStrSectionSym = TextSectionSym = 0;
Eric Christopher74804332013-02-07 21:19:50 +0000194 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
Eric Christopher55863be2013-04-07 03:43:09 +0000195 DwarfAddrSectionSym = 0;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000196 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000197 FunctionBeginSym = FunctionEndSym = 0;
Eric Christopherad9fe892012-04-02 17:58:52 +0000198
Eric Christopher978fbff2012-08-23 07:10:46 +0000199 // Turn on accelerator tables and older gdb compatibility
Eric Christopher574b5c82013-08-19 21:41:38 +0000200 // for Darwin by default, pubnames by default for non-Darwin,
201 // and handle split dwarf.
Eric Christopher203e12b2013-04-27 01:07:52 +0000202 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
Eric Christopher4977f212012-08-23 22:36:36 +0000203
Eric Christopher574b5c82013-08-19 21:41:38 +0000204 if (DwarfAccelTables == Default)
205 HasDwarfAccelTables = IsDarwin;
206 else
Eric Christopher5297df02013-08-26 20:58:35 +0000207 HasDwarfAccelTables = DwarfAccelTables == Enable;
Eric Christopher20b76a72012-08-23 22:36:40 +0000208
Eric Christophercdf218d2012-12-10 19:51:21 +0000209 if (SplitDwarf == Default)
210 HasSplitDwarf = false;
Eric Christopher29424312012-11-12 22:22:20 +0000211 else
Eric Christopher574b5c82013-08-19 21:41:38 +0000212 HasSplitDwarf = SplitDwarf == Enable;
Eric Christopher29424312012-11-12 22:22:20 +0000213
Eric Christopher4d36ca02013-08-26 23:24:35 +0000214 if (DwarfPubSections == Default)
215 HasDwarfPubSections = !IsDarwin;
Eric Christopher574b5c82013-08-19 21:41:38 +0000216 else
Eric Christopher4d36ca02013-08-26 23:24:35 +0000217 HasDwarfPubSections = DwarfPubSections == Enable;
Eric Christopher7da24882013-08-19 21:07:38 +0000218
Manman Renac8062b2013-07-02 23:40:10 +0000219 DwarfVersion = getDwarfVersionFromModule(MMI->getModule());
220
Dan Gohman6e681a52010-06-18 15:56:31 +0000221 {
222 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopher58f41952012-11-19 22:42:15 +0000223 beginModule();
Torok Edwinf8dba242010-04-07 10:44:46 +0000224 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000225}
226DwarfDebug::~DwarfDebug() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000227}
228
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000229// Switch to the specified MCSection and emit an assembler
230// temporary label to it if SymbolStem is specified.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000231static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christophera7b61892011-11-07 09:18:38 +0000232 const char *SymbolStem = 0) {
233 Asm->OutStreamer.SwitchSection(Section);
234 if (!SymbolStem) return 0;
235
236 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
237 Asm->OutStreamer.EmitLabel(TmpSym);
238 return TmpSym;
239}
240
Eric Christophere698f532012-12-20 21:58:36 +0000241MCSymbol *DwarfUnits::getStringPoolSym() {
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000242 return Asm->GetTempSymbol(StringPref);
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000243}
244
Eric Christophere698f532012-12-20 21:58:36 +0000245MCSymbol *DwarfUnits::getStringPoolEntry(StringRef Str) {
246 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopher27614582013-01-08 22:22:06 +0000247 StringPool.GetOrCreateValue(Str).getValue();
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000248 if (Entry.first) return Entry.first;
249
250 Entry.second = NextStringPoolNumber++;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000251 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000252}
253
Eric Christopher2cbd5762013-01-07 19:32:41 +0000254unsigned DwarfUnits::getStringPoolIndex(StringRef Str) {
255 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopher27614582013-01-08 22:22:06 +0000256 StringPool.GetOrCreateValue(Str).getValue();
Eric Christopher2cbd5762013-01-07 19:32:41 +0000257 if (Entry.first) return Entry.second;
258
259 Entry.second = NextStringPoolNumber++;
260 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
261 return Entry.second;
262}
263
David Blaikiedea547b2013-06-28 18:47:14 +0000264unsigned DwarfUnits::getAddrPoolIndex(const MCSymbol *Sym) {
David Blaikie8466ca82013-07-01 23:55:52 +0000265 return getAddrPoolIndex(MCSymbolRefExpr::Create(Sym, Asm->OutContext));
266}
267
Ulrich Weigand8b3d2262013-07-02 18:46:46 +0000268unsigned DwarfUnits::getAddrPoolIndex(const MCExpr *Sym) {
269 std::pair<DenseMap<const MCExpr *, unsigned>::iterator, bool> P =
David Blaikieb8ef7852013-06-28 18:47:19 +0000270 AddressPool.insert(std::make_pair(Sym, NextAddrPoolNumber));
David Blaikiea67de2b2013-06-28 18:55:13 +0000271 if (P.second)
272 ++NextAddrPoolNumber;
David Blaikieb8ef7852013-06-28 18:47:19 +0000273 return P.first->second;
Eric Christopher962c9082013-01-15 23:56:56 +0000274}
275
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000276// Define a unique number for the abbreviation.
277//
Eric Christopherc8a310e2012-12-10 23:34:43 +0000278void DwarfUnits::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000279 // Check the set for priors.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000280 DIEAbbrev *InSet = AbbreviationsSet->GetOrInsertNode(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000281
282 // If it's newly added.
283 if (InSet == &Abbrev) {
284 // Add to abbreviation list.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000285 Abbreviations->push_back(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000286
287 // Assign the vector position + 1 as its number.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000288 Abbrev.setNumber(Abbreviations->size());
Bill Wendling2f921f82009-05-15 09:23:25 +0000289 } else {
290 // Assign existing abbreviation number.
291 Abbrev.setNumber(InSet->getNumber());
292 }
293}
294
Eric Christopherd9843b32011-11-10 19:25:34 +0000295static bool isObjCClass(StringRef Name) {
296 return Name.startswith("+") || Name.startswith("-");
297}
298
299static bool hasObjCCategory(StringRef Name) {
300 if (!isObjCClass(Name)) return false;
301
Benjamin Kramer260de742013-08-24 12:15:54 +0000302 return Name.find(") ") != StringRef::npos;
Eric Christopherd9843b32011-11-10 19:25:34 +0000303}
304
305static void getObjCClassCategory(StringRef In, StringRef &Class,
306 StringRef &Category) {
307 if (!hasObjCCategory(In)) {
308 Class = In.slice(In.find('[') + 1, In.find(' '));
309 Category = "";
310 return;
311 }
312
313 Class = In.slice(In.find('[') + 1, In.find('('));
314 Category = In.slice(In.find('[') + 1, In.find(' '));
315 return;
316}
317
318static StringRef getObjCMethodName(StringRef In) {
319 return In.slice(In.find(' ') + 1, In.find(']'));
320}
321
Richard Mittonc2508242013-10-03 22:07:08 +0000322// Helper for sorting sections into a stable output order.
323static bool SectionSort(const MCSection *A, const MCSection *B) {
324 std::string LA = (A ? A->getLabelBeginName() : "");
325 std::string LB = (B ? B->getLabelBeginName() : "");
326 return LA < LB;
327}
328
Eric Christopherd9843b32011-11-10 19:25:34 +0000329// Add the various names to the Dwarf accelerator table names.
Eric Christopher9cd26af2013-09-20 23:22:52 +0000330// TODO: Determine whether or not we should add names for programs
331// that do not have a DW_AT_name or DW_AT_linkage_name field - this
332// is only slightly different than the lookup of non-standard ObjC names.
Eric Christopherd9843b32011-11-10 19:25:34 +0000333static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
334 DIE* Die) {
335 if (!SP.isDefinition()) return;
Eric Christopherd9843b32011-11-10 19:25:34 +0000336 TheCU->addAccelName(SP.getName(), Die);
337
338 // If the linkage name is different than the name, go ahead and output
339 // that as well into the name table.
340 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
341 TheCU->addAccelName(SP.getLinkageName(), Die);
342
343 // If this is an Objective-C selector name add it to the ObjC accelerator
344 // too.
345 if (isObjCClass(SP.getName())) {
346 StringRef Class, Category;
347 getObjCClassCategory(SP.getName(), Class, Category);
348 TheCU->addAccelObjC(Class, Die);
349 if (Category != "")
350 TheCU->addAccelObjC(Category, Die);
351 // Also add the base method name to the name table.
352 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
353 }
354}
355
Manman Ren3eb9dff2013-09-09 19:05:21 +0000356/// isSubprogramContext - Return true if Context is either a subprogram
357/// or another context nested inside a subprogram.
358bool DwarfDebug::isSubprogramContext(const MDNode *Context) {
359 if (!Context)
360 return false;
361 DIDescriptor D(Context);
362 if (D.isSubprogram())
363 return true;
364 if (D.isType())
Manman Ren116868e2013-09-09 19:47:11 +0000365 return isSubprogramContext(resolve(DIType(Context).getContext()));
Manman Ren3eb9dff2013-09-09 19:05:21 +0000366 return false;
367}
368
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000369// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
370// and DW_AT_high_pc attributes. If there are global variables in this
371// scope then create and insert DIEs for these variables.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000372DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
373 const MDNode *SPNode) {
Eric Christophere595bae2013-10-04 17:08:38 +0000374 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +0000375
Chris Lattner3a383cb2010-04-05 00:13:49 +0000376 assert(SPDie && "Unable to find subprogram DIE!");
377 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000378
Bill Wendlingf720bf62012-11-07 05:19:04 +0000379 // If we're updating an abstract DIE, then we will be adding the children and
380 // object pointer later on. But what we don't want to do is process the
381 // concrete DIE twice.
Eric Christopherc19d6f02013-10-04 19:40:33 +0000382 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
Bill Wendlingf720bf62012-11-07 05:19:04 +0000383 // Pick up abstract subprogram DIE.
Devang Patela37a95e2010-07-07 22:20:57 +0000384 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf20c4f72011-04-12 22:53:02 +0000385 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
Eric Christopherc19d6f02013-10-04 19:40:33 +0000386 dwarf::DW_FORM_ref4, AbsSPDIE);
Devang Patela37a95e2010-07-07 22:20:57 +0000387 SPCU->addDie(SPDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000388 } else {
389 DISubprogram SPDecl = SP.getFunctionDeclaration();
390 if (!SPDecl.isSubprogram()) {
391 // There is not any need to generate specification DIE for a function
392 // defined at compile unit level. If a function is defined inside another
393 // function then gdb prefers the definition at top level and but does not
394 // expect specification DIE in parent function. So avoid creating
395 // specification DIE for a function defined inside a function.
396 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
397 !SP.getContext().isFile() &&
398 !isSubprogramContext(SP.getContext())) {
399 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
400
401 // Add arguments.
402 DICompositeType SPTy = SP.getType();
403 DIArray Args = SPTy.getTypeArray();
Eric Christopher31b05762013-08-08 01:41:00 +0000404 uint16_t SPTag = SPTy.getTag();
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000405 if (SPTag == dwarf::DW_TAG_subroutine_type)
406 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
407 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
408 DIType ATy = DIType(Args.getElement(i));
409 SPCU->addType(Arg, ATy);
410 if (ATy.isArtificial())
411 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
412 if (ATy.isObjectPointer())
413 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer,
414 dwarf::DW_FORM_ref4, Arg);
415 SPDie->addChild(Arg);
416 }
417 DIE *SPDeclDie = SPDie;
418 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Eric Christopher6a841382012-11-19 22:42:10 +0000419 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification,
420 dwarf::DW_FORM_ref4, SPDeclDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000421 SPCU->addDie(SPDie);
422 }
423 }
Devang Patela37a95e2010-07-07 22:20:57 +0000424 }
425
Eric Christopher962c9082013-01-15 23:56:56 +0000426 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc,
427 Asm->GetTempSymbol("func_begin",
428 Asm->getFunctionNumber()));
429 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
430 Asm->GetTempSymbol("func_end",
431 Asm->getFunctionNumber()));
Chris Lattner3a383cb2010-04-05 00:13:49 +0000432 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
433 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000434 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000435
Eric Christopherd9843b32011-11-10 19:25:34 +0000436 // Add name to the name table, we do this here because we're guaranteed
437 // to have concrete versions of our DW_TAG_subprogram nodes.
438 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher6a841382012-11-19 22:42:10 +0000439
Chris Lattner3a383cb2010-04-05 00:13:49 +0000440 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000441}
442
Manman Ren5b2f4b02013-09-11 19:40:28 +0000443/// Check whether we should create a DIE for the given Scope, return true
444/// if we don't create a DIE (the corresponding DIE is null).
Manman Ren2312ed32013-09-10 18:40:41 +0000445bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
446 if (Scope->isAbstractScope())
447 return false;
448
Manman Ren5b2f4b02013-09-11 19:40:28 +0000449 // We don't create a DIE if there is no Range.
Manman Ren2312ed32013-09-10 18:40:41 +0000450 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
451 if (Ranges.empty())
452 return true;
453
454 if (Ranges.size() > 1)
455 return false;
456
Manman Ren5b2f4b02013-09-11 19:40:28 +0000457 // We don't create a DIE if we have a single Range and the end label
458 // is null.
Manman Ren2312ed32013-09-10 18:40:41 +0000459 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
460 MCSymbol *End = getLabelAfterInsn(RI->second);
461 return !End;
462}
463
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000464// Construct new DW_TAG_lexical_block for this scope and attach
465// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher6a841382012-11-19 22:42:10 +0000466DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000467 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000468 if (isLexicalScopeDIENull(Scope))
469 return 0;
470
Devang Patel6c74a872010-04-27 19:46:33 +0000471 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
472 if (Scope->isAbstractScope())
473 return ScopeDIE;
474
Craig Topper977e9cd2013-07-03 04:24:43 +0000475 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Eric Christopherdc42ea82013-07-03 01:57:28 +0000476 // If we have multiple ranges, emit them into the range section.
Devang Patel6c74a872010-04-27 19:46:33 +0000477 if (Ranges.size() > 1) {
478 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000479 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +0000480 // DW_AT_ranges appropriately.
Devang Patelf20c4f72011-04-12 22:53:02 +0000481 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000482 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000483 * Asm->getDataLayout().getPointerSize());
Craig Topperd8e43652013-07-03 04:17:25 +0000484 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +0000485 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +0000486 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
487 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +0000488 }
Eric Christopherc1110832013-07-03 01:22:29 +0000489
490 // Terminate the range list.
Devang Patel6c74a872010-04-27 19:46:33 +0000491 DebugRangeSymbols.push_back(NULL);
492 DebugRangeSymbols.push_back(NULL);
493 return ScopeDIE;
494 }
495
Eric Christopherdc42ea82013-07-03 01:57:28 +0000496 // Construct the address range for this DIE.
Craig Topperd8e43652013-07-03 04:17:25 +0000497 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopher962c9082013-01-15 23:56:56 +0000498 MCSymbol *Start = getLabelBeforeInsn(RI->first);
499 MCSymbol *End = getLabelAfterInsn(RI->second);
Manman Ren2312ed32013-09-10 18:40:41 +0000500 assert(End && "End label should not be null!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000501
Chris Lattnere13c3722010-03-09 01:58:53 +0000502 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
503 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000504
Eric Christopher962c9082013-01-15 23:56:56 +0000505 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
506 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000507
508 return ScopeDIE;
509}
510
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000511// This scope represents inlined body of a function. Construct DIE to
512// represent this concrete inlined copy of the function.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000513DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
514 LexicalScope *Scope) {
Craig Topper977e9cd2013-07-03 04:24:43 +0000515 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000516 assert(Ranges.empty() == false &&
517 "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000518
Devang Patelf098ce22011-07-27 00:34:13 +0000519 if (!Scope->getScopeNode())
520 return NULL;
521 DIScope DS(Scope->getScopeNode());
522 DISubprogram InlinedSP = getDISubprogram(DS);
Eric Christophere595bae2013-10-04 17:08:38 +0000523 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patelf098ce22011-07-27 00:34:13 +0000524 if (!OriginDIE) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000525 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patelf098ce22011-07-27 00:34:13 +0000526 return NULL;
527 }
528
Devang Patel73bc1722011-05-05 17:54:26 +0000529 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Devang Patelf20c4f72011-04-12 22:53:02 +0000530 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Manman Ren4213c392013-05-29 17:16:59 +0000531 dwarf::DW_FORM_ref4, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000532
Devang Patelf098ce22011-07-27 00:34:13 +0000533 if (Ranges.size() > 1) {
534 // .debug_range section has not been laid out yet. Emit offset in
535 // .debug_range as a uint, size 4, for now. emitDIE will handle
536 // DW_AT_ranges appropriately.
537 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000538 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000539 * Asm->getDataLayout().getPointerSize());
Craig Topperd8e43652013-07-03 04:17:25 +0000540 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patelf098ce22011-07-27 00:34:13 +0000541 RE = Ranges.end(); RI != RE; ++RI) {
542 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
543 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
544 }
545 DebugRangeSymbols.push_back(NULL);
546 DebugRangeSymbols.push_back(NULL);
547 } else {
Craig Topperd8e43652013-07-03 04:17:25 +0000548 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000549 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
550 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
551
552 if (StartLabel == 0 || EndLabel == 0)
553 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
554
555 assert(StartLabel->isDefined() &&
556 "Invalid starting label for an inlined scope!");
557 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
558
Eric Christopher962c9082013-01-15 23:56:56 +0000559 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
560 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patelf098ce22011-07-27 00:34:13 +0000561 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000562
563 InlinedSubprogramDIEs.insert(OriginDIE);
564
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000565 // Add the call site information to the DIE.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000566 DILocation DL(Scope->getInlinedAt());
Eric Christopher0925c622012-03-26 21:38:38 +0000567 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0,
Manman Ren1e427202013-03-07 01:42:00 +0000568 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
569 TheCU->getUniqueID()));
Devang Patelf20c4f72011-04-12 22:53:02 +0000570 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000571
Eric Christopher8dda5d02011-12-04 06:02:38 +0000572 // Add name to the name table, we do this here because we're guaranteed
573 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
574 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher6a841382012-11-19 22:42:10 +0000575
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000576 return ScopeDIE;
577}
578
Manman Ren2312ed32013-09-10 18:40:41 +0000579DIE *DwarfDebug::createScopeChildrenDIE(CompileUnit *TheCU, LexicalScope *Scope,
580 SmallVectorImpl<DIE*> &Children) {
581 DIE *ObjectPointer = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +0000582
583 // Collect arguments for current function.
Devang Patel7e623022011-08-10 20:55:27 +0000584 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000585 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
586 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher6a841382012-11-19 22:42:10 +0000587 if (DIE *Arg =
Eric Christophere3417762012-09-12 23:36:19 +0000588 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel6c622ef2011-03-01 22:58:55 +0000589 Children.push_back(Arg);
Eric Christophere3417762012-09-12 23:36:19 +0000590 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
591 }
Devang Patel6c622ef2011-03-01 22:58:55 +0000592
Eric Christopherf84354b2011-10-03 15:49:16 +0000593 // Collect lexical scope children first.
Craig Topper977e9cd2013-07-03 04:24:43 +0000594 const SmallVectorImpl<DbgVariable *> &Variables =ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000595 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher6a841382012-11-19 22:42:10 +0000596 if (DIE *Variable =
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000597 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000598 Children.push_back(Variable);
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000599 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
600 }
Craig Topper977e9cd2013-07-03 04:24:43 +0000601 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000602 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Patel3acc70e2011-08-15 22:04:40 +0000603 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000604 Children.push_back(Nested);
Manman Ren2312ed32013-09-10 18:40:41 +0000605 return ObjectPointer;
606}
607
608// Construct a DIE for this scope.
609DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
610 if (!Scope || !Scope->getScopeNode())
611 return NULL;
612
613 DIScope DS(Scope->getScopeNode());
614
615 SmallVector<DIE *, 8> Children;
616 DIE *ObjectPointer = NULL;
617 bool ChildrenCreated = false;
618
Manman Ren5b2f4b02013-09-11 19:40:28 +0000619 // We try to create the scope DIE first, then the children DIEs. This will
620 // avoid creating un-used children then removing them later when we find out
621 // the scope DIE is null.
Devang Patel3b548aa2010-03-08 20:52:55 +0000622 DIE *ScopeDIE = NULL;
623 if (Scope->getInlinedAt())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000624 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3b548aa2010-03-08 20:52:55 +0000625 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000626 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000627 if (Scope->isAbstractScope()) {
Eric Christophere595bae2013-10-04 17:08:38 +0000628 ScopeDIE = TheCU->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000629 // Note down abstract DIE.
630 if (ScopeDIE)
631 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
632 }
Devang Patel3b548aa2010-03-08 20:52:55 +0000633 else
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000634 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3b548aa2010-03-08 20:52:55 +0000635 }
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000636 else {
Manman Ren5b2f4b02013-09-11 19:40:28 +0000637 // Early exit when we know the scope DIE is going to be null.
Manman Ren2312ed32013-09-10 18:40:41 +0000638 if (isLexicalScopeDIENull(Scope))
639 return NULL;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000640
641 // We create children here when we know the scope DIE is not going to be
642 // null and the children will be added to the scope DIE.
Manman Ren2312ed32013-09-10 18:40:41 +0000643 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
644 ChildrenCreated = true;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000645
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000646 // There is no need to emit empty lexical block DIE.
David Blaikie684fc532013-05-06 23:33:07 +0000647 std::pair<ImportedEntityMap::const_iterator,
648 ImportedEntityMap::const_iterator> Range = std::equal_range(
649 ScopesWithImportedEntities.begin(), ScopesWithImportedEntities.end(),
Timur Iskhodzhanovec4afe62013-05-07 07:47:47 +0000650 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode*)0),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000651 less_first());
David Blaikie684fc532013-05-06 23:33:07 +0000652 if (Children.empty() && Range.first == Range.second)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000653 return NULL;
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000654 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Manman Ren2312ed32013-09-10 18:40:41 +0000655 assert(ScopeDIE && "Scope DIE should not be null.");
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000656 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
657 ++i)
David Blaikie4dd2de72013-05-08 06:01:38 +0000658 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000659 }
Eric Christopher6a841382012-11-19 22:42:10 +0000660
Benjamin Kramer892daba2013-08-24 11:55:49 +0000661 if (!ScopeDIE) {
Manman Ren2312ed32013-09-10 18:40:41 +0000662 assert(Children.empty() &&
663 "We create children only when the scope DIE is not null.");
Benjamin Kramer892daba2013-08-24 11:55:49 +0000664 return NULL;
665 }
Manman Ren2312ed32013-09-10 18:40:41 +0000666 if (!ChildrenCreated)
Manman Ren5b2f4b02013-09-11 19:40:28 +0000667 // We create children when the scope DIE is not null.
Manman Ren2312ed32013-09-10 18:40:41 +0000668 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000669
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000670 // Add children
Craig Topperd8e43652013-07-03 04:17:25 +0000671 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000672 E = Children.end(); I != E; ++I)
673 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000674
Eric Christophere3417762012-09-12 23:36:19 +0000675 if (DS.isSubprogram() && ObjectPointer != NULL)
676 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer,
677 dwarf::DW_FORM_ref4, ObjectPointer);
678
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000679 if (DS.isSubprogram())
Eric Christopherd9843b32011-11-10 19:25:34 +0000680 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000681
Eric Christopherd9843b32011-11-10 19:25:34 +0000682 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000683}
684
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000685// Look up the source id with the given directory and source file names.
686// If none currently exists, create a new id and insert it in the
687// SourceIds map. This can update DirectoryNames and SourceFileNames maps
688// as well.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000689unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Manman Ren1e427202013-03-07 01:42:00 +0000690 StringRef DirName, unsigned CUID) {
691 // If we use .loc in assembly, we can't separate .file entries according to
692 // compile units. Thus all files will belong to the default compile unit.
Rafael Espindolaac4ad252013-10-05 16:42:21 +0000693
694 // FIXME: add a better feature test than hasRawTextSupport. Even better,
695 // extend .file to support this.
696 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren1e427202013-03-07 01:42:00 +0000697 CUID = 0;
698
Devang Patel871d0b12010-09-16 20:57:49 +0000699 // If FE did not provide a file name, then assume stdin.
700 if (FileName.empty())
Manman Ren1e427202013-03-07 01:42:00 +0000701 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patele01b75c2011-03-24 20:30:50 +0000702
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000703 // TODO: this might not belong here. See if we can factor this better.
704 if (DirName == CompilationDir)
705 DirName = "";
706
Manman Ren1e427202013-03-07 01:42:00 +0000707 // FileIDCUMap stores the current ID for the given compile unit.
708 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel871d0b12010-09-16 20:57:49 +0000709
Manman Ren1e427202013-03-07 01:42:00 +0000710 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer71b19732012-03-11 14:56:26 +0000711 SmallString<128> NamePair;
Manman Ren5b22f9f2013-04-06 01:02:38 +0000712 NamePair += utostr(CUID);
Manman Ren1e427202013-03-07 01:42:00 +0000713 NamePair += '\0';
Benjamin Kramer71b19732012-03-11 14:56:26 +0000714 NamePair += DirName;
715 NamePair += '\0'; // Zero bytes are not allowed in paths.
716 NamePair += FileName;
717
718 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
719 if (Ent.getValue() != SrcId)
720 return Ent.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +0000721
Manman Ren1e427202013-03-07 01:42:00 +0000722 FileIDCUMap[CUID] = SrcId;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000723 // Print out a .file directive to specify files for .loc directives.
Manman Ren1e427202013-03-07 01:42:00 +0000724 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendling2b128d72009-05-20 23:19:06 +0000725
726 return SrcId;
727}
728
Eric Christopher48fef592012-12-20 21:58:40 +0000729// Create new CompileUnit for the given metadata node with tag
730// DW_TAG_compile_unit.
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000731CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +0000732 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +0000733 StringRef FN = DIUnit.getFilename();
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000734 CompilationDir = DIUnit.getDirectory();
Bill Wendling2b128d72009-05-20 23:19:06 +0000735
736 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopherbfceb2f2013-08-26 23:50:38 +0000737 CompileUnit *NewCU =
738 new CompileUnit(GlobalCUIndexCount++, Die, N, Asm, this, &InfoHolder);
Manman Ren1e427202013-03-07 01:42:00 +0000739
740 FileIDCUMap[NewCU->getUniqueID()] = 0;
741 // Call this to emit a .file directive if it wasn't emitted for the source
742 // file this CU comes from yet.
743 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
744
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000745 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patelf20c4f72011-04-12 22:53:02 +0000746 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
747 DIUnit.getLanguage());
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000748 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christopher52ce7182013-04-09 19:23:15 +0000749
Eric Christopherb1b94512012-08-01 18:19:01 +0000750 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher52ce7182013-04-09 19:23:15 +0000751 // into an entity. We're using 0 (or a NULL label) for this. For
752 // split dwarf it's in the skeleton CU so omit it here.
753 if (!useSplitDwarf())
754 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
Manman Ren4e042a62013-02-05 21:52:47 +0000755
756 // Define start line table label for each Compile Unit.
757 MCSymbol *LineTableStartSym = Asm->GetTempSymbol("line_table_start",
758 NewCU->getUniqueID());
759 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
760 NewCU->getUniqueID());
761
Manman Ren9d4c7352013-05-21 00:57:22 +0000762 // Use a single line table if we are using .loc and generating assembly.
763 bool UseTheFirstCU =
Rafael Espindolaac4ad252013-10-05 16:42:21 +0000764 (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport()) ||
765 (NewCU->getUniqueID() == 0);
Manman Ren9d4c7352013-05-21 00:57:22 +0000766
Eric Christopher52ce7182013-04-09 19:23:15 +0000767 if (!useSplitDwarf()) {
Eric Christophera51d3fc2013-09-27 22:50:48 +0000768 // DW_AT_stmt_list is a offset of line number information for this
769 // compile unit in debug_line section. For split dwarf this is
770 // left in the skeleton CU and so not included.
771 // The line table entries are not always emitted in assembly, so it
772 // is not okay to use line_table_start here.
Eric Christopher52ce7182013-04-09 19:23:15 +0000773 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Carlo Kokbac096a2013-08-13 17:46:57 +0000774 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christophera51d3fc2013-09-27 22:50:48 +0000775 UseTheFirstCU ? Asm->GetTempSymbol("section_line")
776 : LineTableStartSym);
Manman Ren9d4c7352013-05-21 00:57:22 +0000777 else if (UseTheFirstCU)
Eric Christopher52ce7182013-04-09 19:23:15 +0000778 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
779 else
780 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
781 LineTableStartSym, DwarfLineSectionSym);
Eric Christophera51d3fc2013-09-27 22:50:48 +0000782
783 // If we're using split dwarf the compilation dir is going to be in the
784 // skeleton CU and so we don't need to duplicate it here.
785 if (!CompilationDir.empty())
786 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
787
Eric Christopher1d06eb52013-10-01 00:43:31 +0000788 // Flags to let the linker know we have emitted new style pubnames. Only
Eric Christophera51d3fc2013-09-27 22:50:48 +0000789 // emit it here if we don't have a skeleton CU for split dwarf.
Eric Christopher39eebfa2013-09-30 23:14:16 +0000790 if (GenerateGnuPubSections) {
791 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
792 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames,
793 dwarf::DW_FORM_sec_offset,
794 Asm->GetTempSymbol("gnu_pubnames",
795 NewCU->getUniqueID()));
796 else
797 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
798 Asm->GetTempSymbol("gnu_pubnames",
799 NewCU->getUniqueID()),
800 DwarfGnuPubNamesSectionSym);
801
802 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
803 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes,
804 dwarf::DW_FORM_sec_offset,
805 Asm->GetTempSymbol("gnu_pubtypes",
806 NewCU->getUniqueID()));
807 else
808 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopherf976c772013-10-03 17:41:16 +0000809 Asm->GetTempSymbol("gnu_pubtypes",
Eric Christopher39eebfa2013-09-30 23:14:16 +0000810 NewCU->getUniqueID()),
811 DwarfGnuPubTypesSectionSym);
812 }
Eric Christopher52ce7182013-04-09 19:23:15 +0000813 }
Bill Wendling2b128d72009-05-20 23:19:06 +0000814
Bill Wendling2b128d72009-05-20 23:19:06 +0000815 if (DIUnit.isOptimized())
Eric Christopherbb69a272012-08-24 01:14:27 +0000816 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendling2b128d72009-05-20 23:19:06 +0000817
Devang Patel2d9caf92009-11-25 17:36:49 +0000818 StringRef Flags = DIUnit.getFlags();
819 if (!Flags.empty())
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000820 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher6a841382012-11-19 22:42:10 +0000821
Nick Lewycky479a8fe2011-10-17 23:27:36 +0000822 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patelf20c4f72011-04-12 22:53:02 +0000823 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +0000824 dwarf::DW_FORM_data1, RVer);
825
Devang Patel1a0df9a2010-05-10 22:49:55 +0000826 if (!FirstCU)
827 FirstCU = NewCU;
Eric Christopher7a2cdf72013-02-05 07:31:55 +0000828
Eric Christopherc8a310e2012-12-10 23:34:43 +0000829 InfoHolder.addUnit(NewCU);
830
Devang Patel1a0df9a2010-05-10 22:49:55 +0000831 CUMap.insert(std::make_pair(N, NewCU));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000832 return NewCU;
Devang Patel1a0df9a2010-05-10 22:49:55 +0000833}
834
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000835// Construct subprogram DIE.
Eric Christopher6a841382012-11-19 22:42:10 +0000836void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
Devang Patel1f4f98d2011-08-15 23:36:40 +0000837 const MDNode *N) {
Rafael Espindola6cf4e832011-11-04 19:00:29 +0000838 CompileUnit *&CURef = SPMap[N];
839 if (CURef)
840 return;
841 CURef = TheCU;
842
Devang Patel80ae3492009-08-28 23:24:31 +0000843 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000844 if (!SP.isDefinition())
845 // This is a method declaration which will be handled while constructing
846 // class type.
Devang Patel0751a282009-06-26 01:49:18 +0000847 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000848
Devang Patel89543712011-08-15 17:24:54 +0000849 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000850
Eric Christopherba506db2013-09-09 20:03:20 +0000851 // Expose as a global name.
852 TheCU->addGlobalName(SP.getName(), SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +0000853}
854
David Blaikie1fd43652013-05-07 21:35:53 +0000855void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikief55abea2013-04-22 06:12:31 +0000856 const MDNode *N) {
David Blaikie1fd43652013-05-07 21:35:53 +0000857 DIImportedEntity Module(N);
David Blaikief55abea2013-04-22 06:12:31 +0000858 if (!Module.Verify())
859 return;
David Blaikie684fc532013-05-06 23:33:07 +0000860 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
David Blaikie4dd2de72013-05-08 06:01:38 +0000861 constructImportedEntityDIE(TheCU, Module, D);
David Blaikie684fc532013-05-06 23:33:07 +0000862}
863
David Blaikie4dd2de72013-05-08 06:01:38 +0000864void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
David Blaikie684fc532013-05-06 23:33:07 +0000865 DIE *Context) {
David Blaikie1fd43652013-05-07 21:35:53 +0000866 DIImportedEntity Module(N);
David Blaikie684fc532013-05-06 23:33:07 +0000867 if (!Module.Verify())
868 return;
David Blaikie4dd2de72013-05-08 06:01:38 +0000869 return constructImportedEntityDIE(TheCU, Module, Context);
David Blaikie684fc532013-05-06 23:33:07 +0000870}
871
David Blaikie4dd2de72013-05-08 06:01:38 +0000872void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikie1fd43652013-05-07 21:35:53 +0000873 const DIImportedEntity &Module,
David Blaikie684fc532013-05-06 23:33:07 +0000874 DIE *Context) {
875 assert(Module.Verify() &&
876 "Use one of the MDNode * overloads to handle invalid metadata");
877 assert(Context && "Should always have a context for an imported_module");
David Blaikie1fd43652013-05-07 21:35:53 +0000878 DIE *IMDie = new DIE(Module.getTag());
David Blaikief55abea2013-04-22 06:12:31 +0000879 TheCU->insertDIE(Module, IMDie);
David Blaikie1fd43652013-05-07 21:35:53 +0000880 DIE *EntityDie;
881 DIDescriptor Entity = Module.getEntity();
882 if (Entity.isNameSpace())
883 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
884 else if (Entity.isSubprogram())
885 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
David Blaikie3b6038b2013-05-08 06:01:41 +0000886 else if (Entity.isType())
887 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
David Blaikie1fd43652013-05-07 21:35:53 +0000888 else
David Blaikie3b6038b2013-05-08 06:01:41 +0000889 EntityDie = TheCU->getDIE(Entity);
David Blaikief55abea2013-04-22 06:12:31 +0000890 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
891 Module.getContext().getDirectory(),
892 TheCU->getUniqueID());
893 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, 0, FileID);
894 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, 0, Module.getLineNumber());
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000895 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, dwarf::DW_FORM_ref4,
896 EntityDie);
David Blaikiee63d5d12013-05-20 22:50:35 +0000897 StringRef Name = Module.getName();
898 if (!Name.empty())
899 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
David Blaikie684fc532013-05-06 23:33:07 +0000900 Context->addChild(IMDie);
David Blaikief55abea2013-04-22 06:12:31 +0000901}
902
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000903// Emit all Dwarf sections that should come prior to the content. Create
904// global DIEs and emit initial debug info sections. This is invoked by
905// the target AsmPrinter.
Eric Christopher58f41952012-11-19 22:42:15 +0000906void DwarfDebug::beginModule() {
Devang Patel6c74a872010-04-27 19:46:33 +0000907 if (DisableDebugInfoPrinting)
908 return;
909
Eric Christopher58f41952012-11-19 22:42:15 +0000910 const Module *M = MMI->getModule();
911
Nick Lewycky019d2552011-07-29 03:49:23 +0000912 // If module has named metadata anchors then use them, otherwise scan the
913 // module using debug info finder to collect debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000914 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
David Blaikiedc69ebb2013-03-11 23:39:23 +0000915 if (!CU_Nodes)
Devang Patel07bb9ee2011-08-15 23:47:24 +0000916 return;
Manman Ren60352032013-09-05 18:48:31 +0000917 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
Devang Patele02e5852011-05-03 16:45:22 +0000918
David Blaikiedc69ebb2013-03-11 23:39:23 +0000919 // Emit initial sections so we can reference labels later.
920 emitSectionLabels();
921
922 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
923 DICompileUnit CUNode(CU_Nodes->getOperand(i));
924 CompileUnit *CU = constructCompileUnit(CUNode);
David Blaikie1fd43652013-05-07 21:35:53 +0000925 DIArray ImportedEntities = CUNode.getImportedEntities();
926 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
David Blaikie684fc532013-05-06 23:33:07 +0000927 ScopesWithImportedEntities.push_back(std::make_pair(
David Blaikie1fd43652013-05-07 21:35:53 +0000928 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
929 ImportedEntities.getElement(i)));
David Blaikie684fc532013-05-06 23:33:07 +0000930 std::sort(ScopesWithImportedEntities.begin(),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000931 ScopesWithImportedEntities.end(), less_first());
David Blaikiedc69ebb2013-03-11 23:39:23 +0000932 DIArray GVs = CUNode.getGlobalVariables();
933 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
934 CU->createGlobalVariableDIE(GVs.getElement(i));
935 DIArray SPs = CUNode.getSubprograms();
936 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
937 constructSubprogramDIE(CU, SPs.getElement(i));
938 DIArray EnumTypes = CUNode.getEnumTypes();
939 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
940 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
941 DIArray RetainedTypes = CUNode.getRetainedTypes();
942 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
943 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
David Blaikief55abea2013-04-22 06:12:31 +0000944 // Emit imported_modules last so that the relevant context is already
945 // available.
David Blaikie1fd43652013-05-07 21:35:53 +0000946 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
947 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
David Blaikiedc69ebb2013-03-11 23:39:23 +0000948 }
Eric Christopher6a841382012-11-19 22:42:10 +0000949
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000950 // Tell MMI that we have debug info.
951 MMI->setDebugInfoAvailability(true);
Eric Christopher6a841382012-11-19 22:42:10 +0000952
Bill Wendling2b128d72009-05-20 23:19:06 +0000953 // Prime section data.
Richard Mitton21101b32013-09-19 23:21:01 +0000954 SectionMap[Asm->getObjFileLowering().getTextSection()];
Bill Wendling2b128d72009-05-20 23:19:06 +0000955}
956
Eric Christopher960ac372012-11-22 00:59:49 +0000957// Attach DW_AT_inline attribute with inlined subprogram DIEs.
958void DwarfDebug::computeInlinedDIEs() {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000959 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
960 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000961 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000962 DIE *ISP = *AI;
Devang Patelf20c4f72011-04-12 22:53:02 +0000963 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000964 }
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000965 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000966 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000967 DIE *ISP = AI->second;
968 if (InlinedSubprogramDIEs.count(ISP))
969 continue;
970 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
971 }
Eric Christopher960ac372012-11-22 00:59:49 +0000972}
973
974// Collect info for variables that were optimized out.
975void DwarfDebug::collectDeadVariables() {
976 const Module *M = MMI->getModule();
977 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
978
979 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
980 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
981 DICompileUnit TheCU(CU_Nodes->getOperand(i));
982 DIArray Subprograms = TheCU.getSubprograms();
983 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopher735401c2012-11-27 00:13:51 +0000984 DISubprogram SP(Subprograms.getElement(i));
985 if (ProcessedSPNodes.count(SP) != 0) continue;
Manman Ren7504ed42013-07-08 18:33:29 +0000986 if (!SP.isSubprogram()) continue;
Eric Christopher735401c2012-11-27 00:13:51 +0000987 if (!SP.isDefinition()) continue;
988 DIArray Variables = SP.getVariables();
989 if (Variables.getNumElements() == 0) continue;
Eric Christopher960ac372012-11-22 00:59:49 +0000990
Eric Christopher735401c2012-11-27 00:13:51 +0000991 LexicalScope *Scope =
992 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
993 DeadFnScopeMap[SP] = Scope;
Eric Christopher960ac372012-11-22 00:59:49 +0000994
Eric Christopher735401c2012-11-27 00:13:51 +0000995 // Construct subprogram DIE and add variables DIEs.
996 CompileUnit *SPCU = CUMap.lookup(TheCU);
997 assert(SPCU && "Unable to find Compile Unit!");
998 constructSubprogramDIE(SPCU, SP);
Eric Christophere595bae2013-10-04 17:08:38 +0000999 DIE *ScopeDIE = SPCU->getDIE(SP);
Eric Christopher735401c2012-11-27 00:13:51 +00001000 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
1001 DIVariable DV(Variables.getElement(vi));
Manman Ren7504ed42013-07-08 18:33:29 +00001002 if (!DV.isVariable()) continue;
Manman Renb3388602013-10-05 01:43:03 +00001003 DbgVariable NewVar(DV, NULL, this);
Eric Christopher735401c2012-11-27 00:13:51 +00001004 if (DIE *VariableDIE =
Chandler Carruth2a1c0d22013-07-27 11:09:58 +00001005 SPCU->constructVariableDIE(&NewVar, Scope->isAbstractScope()))
Eric Christopher735401c2012-11-27 00:13:51 +00001006 ScopeDIE->addChild(VariableDIE);
1007 }
Eric Christopher960ac372012-11-22 00:59:49 +00001008 }
1009 }
1010 }
1011 DeleteContainerSeconds(DeadFnScopeMap);
1012}
1013
Eric Christopher45731982013-08-08 23:45:55 +00001014// Type Signature [7.27] and ODR Hash code.
Eric Christopher67646432013-07-26 17:02:41 +00001015
1016/// \brief Grabs the string in whichever attribute is passed in and returns
Eric Christopher8552e222013-08-07 01:18:33 +00001017/// a reference to it. Returns "" if the attribute doesn't exist.
Eric Christopher67646432013-07-26 17:02:41 +00001018static StringRef getDIEStringAttr(DIE *Die, unsigned Attr) {
Eric Christopher8552e222013-08-07 01:18:33 +00001019 DIEValue *V = Die->findAttribute(Attr);
Eric Christopher67646432013-07-26 17:02:41 +00001020
Eric Christopher8552e222013-08-07 01:18:33 +00001021 if (DIEString *S = dyn_cast_or_null<DIEString>(V))
1022 return S->getString();
1023
Eric Christopher67646432013-07-26 17:02:41 +00001024 return StringRef("");
1025}
1026
Eric Christopher67646432013-07-26 17:02:41 +00001027/// Return true if the current DIE is contained within an anonymous namespace.
1028static bool isContainedInAnonNamespace(DIE *Die) {
1029 DIE *Parent = Die->getParent();
1030
1031 while (Parent) {
Eric Christophere414ece2013-07-29 23:53:08 +00001032 if (Parent->getTag() == dwarf::DW_TAG_namespace &&
1033 getDIEStringAttr(Parent, dwarf::DW_AT_name) == "")
Eric Christopher67646432013-07-26 17:02:41 +00001034 return true;
1035 Parent = Parent->getParent();
1036 }
1037
1038 return false;
1039}
1040
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001041/// Test if the current CU language is C++ and that we have
1042/// a named type that is not contained in an anonymous namespace.
1043static bool shouldAddODRHash(CompileUnit *CU, DIE *Die) {
Eric Christopher341770d2013-08-07 08:35:10 +00001044 return CU->getLanguage() == dwarf::DW_LANG_C_plus_plus &&
1045 getDIEStringAttr(Die, dwarf::DW_AT_name) != "" &&
1046 !isContainedInAnonNamespace(Die);
Eric Christopher45731982013-08-08 23:45:55 +00001047}
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001048
Eric Christopher960ac372012-11-22 00:59:49 +00001049void DwarfDebug::finalizeModuleInfo() {
1050 // Collect info for variables that were optimized out.
1051 collectDeadVariables();
1052
1053 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1054 computeInlinedDIEs();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001055
Eric Christopherf8542ec2013-07-29 22:24:32 +00001056 // Split out type units and conditionally add an ODR tag to the split
1057 // out type.
Eric Christopher67646432013-07-26 17:02:41 +00001058 // FIXME: Do type splitting.
1059 for (unsigned i = 0, e = TypeUnits.size(); i != e; ++i) {
Eric Christopher67646432013-07-26 17:02:41 +00001060 DIE *Die = TypeUnits[i];
Eric Christopher45731982013-08-08 23:45:55 +00001061 DIEHash Hash;
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001062 // If we've requested ODR hashes and it's applicable for an ODR hash then
1063 // add the ODR signature now.
Eric Christopher45731982013-08-08 23:45:55 +00001064 // FIXME: This should be added onto the type unit, not the type, but this
1065 // works as an intermediate stage.
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001066 if (GenerateODRHash && shouldAddODRHash(CUMap.begin()->second, Die))
Eric Christopher45731982013-08-08 23:45:55 +00001067 CUMap.begin()->second->addUInt(Die, dwarf::DW_AT_GNU_odr_signature,
1068 dwarf::DW_FORM_data8,
1069 Hash.computeDIEODRSignature(Die));
Eric Christopher67646432013-07-26 17:02:41 +00001070 }
1071
Eric Christopher60eb7692013-08-12 20:27:48 +00001072 // Handle anything that needs to be done on a per-cu basis.
1073 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
1074 CUE = CUMap.end();
1075 CUI != CUE; ++CUI) {
1076 CompileUnit *TheCU = CUI->second;
1077 // Emit DW_AT_containing_type attribute to connect types with their
1078 // vtable holding type.
1079 TheCU->constructContainingTypeDIEs();
1080
1081 // If we're splitting the dwarf out now that we've got the entire
1082 // CU then construct a skeleton CU based upon it.
1083 if (useSplitDwarf()) {
Eric Christopherd29614f2013-08-13 01:21:55 +00001084 uint64_t ID = 0;
1085 if (GenerateCUHash) {
1086 DIEHash CUHash;
1087 ID = CUHash.computeCUSignature(TheCU->getCUDie());
1088 }
Eric Christopher60eb7692013-08-12 20:27:48 +00001089 // This should be a unique identifier when we want to build .dwp files.
1090 TheCU->addUInt(TheCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopherd29614f2013-08-13 01:21:55 +00001091 dwarf::DW_FORM_data8, ID);
Eric Christopher60eb7692013-08-12 20:27:48 +00001092 // Now construct the skeleton CU associated.
Eric Christopher6fdf3242013-08-26 23:50:43 +00001093 CompileUnit *SkCU = constructSkeletonCU(TheCU);
Eric Christopher60eb7692013-08-12 20:27:48 +00001094 // This should be a unique identifier when we want to build .dwp files.
1095 SkCU->addUInt(SkCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopherd29614f2013-08-13 01:21:55 +00001096 dwarf::DW_FORM_data8, ID);
Eric Christopher60eb7692013-08-12 20:27:48 +00001097 }
1098 }
1099
1100 // Compute DIE offsets and sizes.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001101 InfoHolder.computeSizeAndOffsets();
1102 if (useSplitDwarf())
1103 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher960ac372012-11-22 00:59:49 +00001104}
1105
1106void DwarfDebug::endSections() {
Richard Mitton21101b32013-09-19 23:21:01 +00001107 // Filter labels by section.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001108 for (size_t n = 0; n < ArangeLabels.size(); n++) {
1109 const SymbolCU &SCU = ArangeLabels[n];
Richard Mitton21101b32013-09-19 23:21:01 +00001110 if (SCU.Sym->isInSection()) {
1111 // Make a note of this symbol and it's section.
1112 const MCSection *Section = &SCU.Sym->getSection();
1113 if (!Section->getKind().isMetadata())
1114 SectionMap[Section].push_back(SCU);
1115 } else {
1116 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1117 // appear in the output. This sucks as we rely on sections to build
1118 // arange spans. We can do it without, but it's icky.
1119 SectionMap[NULL].push_back(SCU);
1120 }
1121 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001122
Richard Mittonc2508242013-10-03 22:07:08 +00001123 // Build a list of sections used.
1124 std::vector<const MCSection *> Sections;
Richard Mitton21101b32013-09-19 23:21:01 +00001125 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1126 it++) {
1127 const MCSection *Section = it->first;
Richard Mittonc2508242013-10-03 22:07:08 +00001128 Sections.push_back(Section);
1129 }
1130
1131 // Sort the sections into order.
1132 // This is only done to ensure consistent output order across different runs.
1133 std::sort(Sections.begin(), Sections.end(), SectionSort);
1134
1135 // Add terminating symbols for each section.
1136 for (unsigned ID=0;ID<Sections.size();ID++) {
1137 const MCSection *Section = Sections[ID];
Richard Mitton21101b32013-09-19 23:21:01 +00001138 MCSymbol *Sym = NULL;
1139
1140 if (Section) {
Richard Mittonc2508242013-10-03 22:07:08 +00001141 // We can't call MCSection::getLabelEndName, as it's only safe to do so
1142 // if we know the section name up-front. For user-created sections, the resulting
1143 // label may not be valid to use as a label. (section names can use a greater
1144 // set of characters on some systems)
1145 Sym = Asm->GetTempSymbol("debug_end", ID);
Richard Mitton21101b32013-09-19 23:21:01 +00001146 Asm->OutStreamer.SwitchSection(Section);
1147 Asm->OutStreamer.EmitLabel(Sym);
1148 }
1149
1150 // Insert a final terminator.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001151 SectionMap[Section].push_back(SymbolCU(NULL, Sym));
Bill Wendling2b128d72009-05-20 23:19:06 +00001152 }
Eric Christopher960ac372012-11-22 00:59:49 +00001153}
Bill Wendling2b128d72009-05-20 23:19:06 +00001154
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001155// Emit all Dwarf sections that should come after the content.
Eric Christopher960ac372012-11-22 00:59:49 +00001156void DwarfDebug::endModule() {
1157
1158 if (!FirstCU) return;
1159
1160 // End any existing sections.
1161 // TODO: Does this need to happen?
1162 endSections();
1163
1164 // Finalize the debug info for the module.
1165 finalizeModuleInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001166
Eric Christophercdf218d2012-12-10 19:51:21 +00001167 if (!useSplitDwarf()) {
Eric Christopher9cd26af2013-09-20 23:22:52 +00001168 emitDebugStr();
1169
Eric Christopher95198f502012-11-27 22:43:42 +00001170 // Emit all the DIEs into a debug info section.
1171 emitDebugInfo();
Eric Christopher4c9b1192012-11-27 00:41:54 +00001172
Eric Christopher95198f502012-11-27 22:43:42 +00001173 // Corresponding abbreviations into a abbrev section.
1174 emitAbbreviations();
1175
1176 // Emit info into a debug loc section.
1177 emitDebugLoc();
1178
1179 // Emit info into a debug aranges section.
1180 emitDebugARanges();
1181
1182 // Emit info into a debug ranges section.
1183 emitDebugRanges();
1184
1185 // Emit info into a debug macinfo section.
1186 emitDebugMacInfo();
1187
Eric Christopher95198f502012-11-27 22:43:42 +00001188 } else {
Eric Christopherd692c1d2012-12-11 19:42:09 +00001189 // TODO: Fill this in for separated debug sections and separate
Eric Christopher95198f502012-11-27 22:43:42 +00001190 // out information into new sections.
Eric Christopher9cd26af2013-09-20 23:22:52 +00001191 emitDebugStr();
1192 if (useSplitDwarf())
1193 emitDebugStrDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001194
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001195 // Emit the debug info section and compile units.
Eric Christopher95198f502012-11-27 22:43:42 +00001196 emitDebugInfo();
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001197 emitDebugInfoDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001198
1199 // Corresponding abbreviations into a abbrev section.
1200 emitAbbreviations();
Eric Christopher3c5a1912012-12-19 22:02:53 +00001201 emitDebugAbbrevDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001202
1203 // Emit info into a debug loc section.
1204 emitDebugLoc();
1205
1206 // Emit info into a debug aranges section.
1207 emitDebugARanges();
1208
1209 // Emit info into a debug ranges section.
1210 emitDebugRanges();
1211
1212 // Emit info into a debug macinfo section.
1213 emitDebugMacInfo();
1214
Eric Christopher962c9082013-01-15 23:56:56 +00001215 // Emit DWO addresses.
1216 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1217
Eric Christopher95198f502012-11-27 22:43:42 +00001218 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001219
Eric Christophera876b822012-08-23 07:32:06 +00001220 // Emit info into the dwarf accelerator table sections.
Eric Christopher20b76a72012-08-23 22:36:40 +00001221 if (useDwarfAccelTables()) {
Eric Christopher4996c702011-11-07 09:24:32 +00001222 emitAccelNames();
1223 emitAccelObjC();
1224 emitAccelNamespaces();
1225 emitAccelTypes();
1226 }
Eric Christopher6a841382012-11-19 22:42:10 +00001227
Eric Christopher4b358182013-08-30 00:40:17 +00001228 // Emit the pubnames and pubtypes sections if requested.
1229 if (HasDwarfPubSections) {
David Blaikie70a33202013-09-19 17:33:35 +00001230 emitDebugPubNames(GenerateGnuPubSections);
1231 emitDebugPubTypes(GenerateGnuPubSections);
Eric Christopher4b358182013-08-30 00:40:17 +00001232 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001233
Devang Pateld0701282010-08-02 17:32:15 +00001234 // clean up.
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001235 SPMap.clear();
Devang Patel1a0df9a2010-05-10 22:49:55 +00001236 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1237 E = CUMap.end(); I != E; ++I)
1238 delete I->second;
Eric Christopher8afd7b62012-12-10 19:51:18 +00001239
Craig Topperd8e43652013-07-03 04:17:25 +00001240 for (SmallVectorImpl<CompileUnit *>::iterator I = SkeletonCUs.begin(),
Eric Christopher5b33b3c2013-02-06 21:53:56 +00001241 E = SkeletonCUs.end(); I != E; ++I)
1242 delete *I;
Eric Christopher8afd7b62012-12-10 19:51:18 +00001243
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001244 // Reset these for the next Module if we have one.
1245 FirstCU = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001246}
1247
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001248// Find abstract variable, if any, associated with Var.
Devang Patelbb23a4a2011-08-10 21:50:54 +00001249DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattner915c5f92010-04-02 19:42:39 +00001250 DebugLoc ScopeLoc) {
Devang Patelbb23a4a2011-08-10 21:50:54 +00001251 LLVMContext &Ctx = DV->getContext();
1252 // More then one inlined variable corresponds to one abstract variable.
1253 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001254 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001255 if (AbsDbgVariable)
1256 return AbsDbgVariable;
1257
Devang Patel7e623022011-08-10 20:55:27 +00001258 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001259 if (!Scope)
1260 return NULL;
1261
Manman Renb3388602013-10-05 01:43:03 +00001262 AbsDbgVariable = new DbgVariable(Var, NULL, this);
Devang Patel7e623022011-08-10 20:55:27 +00001263 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001264 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001265 return AbsDbgVariable;
1266}
1267
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001268// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel6c622ef2011-03-01 22:58:55 +00001269bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patel7e623022011-08-10 20:55:27 +00001270 DbgVariable *Var, LexicalScope *Scope) {
1271 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +00001272 return false;
1273 DIVariable DV = Var->getVariable();
1274 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1275 return false;
1276 unsigned ArgNo = DV.getArgNumber();
Eric Christopher6a841382012-11-19 22:42:10 +00001277 if (ArgNo == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001278 return false;
1279
Devang Patel4ab660b2011-03-03 20:02:02 +00001280 size_t Size = CurrentFnArguments.size();
1281 if (Size == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001282 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001283 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001284 // arguments does the function have at source level.
1285 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001286 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001287 CurrentFnArguments[ArgNo - 1] = Var;
1288 return true;
1289}
1290
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001291// Collect variable information from side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001292void
Nick Lewycky019d2552011-07-29 03:49:23 +00001293DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patel490c8ab2010-05-20 19:57:06 +00001294 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001295 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1296 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1297 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001298 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001299 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001300 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001301 DIVariable DV(Var);
1302 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001303
Devang Patel7e623022011-08-10 20:55:27 +00001304 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001305
Devang Patelcdb7d442009-11-10 23:20:04 +00001306 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001307 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001308 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001309
Devang Patele1c53f22010-05-20 16:36:41 +00001310 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Manman Renb3388602013-10-05 01:43:03 +00001311 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
Devang Patel3e4a9652011-08-15 21:24:36 +00001312 RegVar->setFrameIndex(VP.first);
Devang Patel6c622ef2011-03-01 22:58:55 +00001313 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001314 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001315 if (AbsDbgVariable)
Devang Patel3e4a9652011-08-15 21:24:36 +00001316 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patel475d32a2009-10-06 01:26:37 +00001317 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001318}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001319
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001320// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1321// defined reg.
Devang Patel9fc11702010-05-25 23:40:22 +00001322static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001323 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001324 return MI->getNumOperands() == 3 &&
1325 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
Adrian Prantl418d1d12013-07-09 20:28:37 +00001326 (MI->getOperand(1).isImm() ||
1327 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
Devang Patel9fc11702010-05-25 23:40:22 +00001328}
1329
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001330// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher6a841382012-11-19 22:42:10 +00001331static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1332 const MCSymbol *FLabel,
Devang Patel2442a892011-07-08 17:09:57 +00001333 const MCSymbol *SLabel,
1334 const MachineInstr *MI) {
1335 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1336
David Blaikie0252265b2013-06-16 20:34:15 +00001337 assert(MI->getNumOperands() == 3);
Adrian Prantl418d1d12013-07-09 20:28:37 +00001338 if (MI->getOperand(0).isReg()) {
Devang Patel2442a892011-07-08 17:09:57 +00001339 MachineLocation MLoc;
Adrian Prantl418d1d12013-07-09 20:28:37 +00001340 // If the second operand is an immediate, this is a
1341 // register-indirect address.
1342 if (!MI->getOperand(1).isImm())
Adrian Prantld4c0dd42013-04-26 21:57:17 +00001343 MLoc.set(MI->getOperand(0).getReg());
1344 else
1345 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel2442a892011-07-08 17:09:57 +00001346 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1347 }
1348 if (MI->getOperand(0).isImm())
1349 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1350 if (MI->getOperand(0).isFPImm())
1351 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1352 if (MI->getOperand(0).isCImm())
1353 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1354
Craig Topperee4dab52012-02-05 08:31:47 +00001355 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel2442a892011-07-08 17:09:57 +00001356}
1357
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001358// Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001359void
Devang Patel5c0f85c2010-06-25 22:07:34 +00001360DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1361 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001362
Eric Christopher270a12c2013-07-03 21:37:03 +00001363 // Grab the variable info that was squirreled away in the MMI side-table.
Devang Patel490c8ab2010-05-20 19:57:06 +00001364 collectVariableInfoFromMMITable(MF, Processed);
1365
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001366 for (SmallVectorImpl<const MDNode*>::const_iterator
1367 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1368 ++UVI) {
1369 const MDNode *Var = *UVI;
1370 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001371 continue;
1372
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001373 // History contains relevant DBG_VALUE instructions for Var and instructions
1374 // clobbering it.
1375 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1376 if (History.empty())
1377 continue;
1378 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001379
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001380 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001381 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001382 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1383 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +00001384 Scope = LScopes.getCurrentFunctionScope();
David Blaikiedc69ebb2013-03-11 23:39:23 +00001385 else if (MDNode *IA = DV.getInlinedAt())
1386 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1387 else
1388 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel490c8ab2010-05-20 19:57:06 +00001389 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001390 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001391 continue;
1392
1393 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001394 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel99819b52011-08-15 19:01:20 +00001395 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
Manman Renb3388602013-10-05 01:43:03 +00001396 DbgVariable *RegVar = new DbgVariable(DV, AbsVar, this);
Devang Patel6c622ef2011-03-01 22:58:55 +00001397 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001398 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001399 if (AbsVar)
Devang Patel3e4a9652011-08-15 21:24:36 +00001400 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001401
Eric Christophercc10d202012-10-08 20:48:54 +00001402 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001403 if (History.size() <= 1 || (History.size() == 2 &&
1404 MInsn->isIdenticalTo(History.back()))) {
Devang Patel3e4a9652011-08-15 21:24:36 +00001405 RegVar->setMInsn(MInsn);
Devang Patel9fc11702010-05-25 23:40:22 +00001406 continue;
1407 }
1408
Eric Christopher59cc0712013-01-28 17:33:26 +00001409 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001410 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001411
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001412 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1413 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1414 const MachineInstr *Begin = *HI;
1415 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001416
Devang Patele7181b52011-06-01 23:00:17 +00001417 // Check if DBG_VALUE is truncating a range.
1418 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1419 && !Begin->getOperand(0).getReg())
1420 continue;
1421
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001422 // Compute the range for a register location.
1423 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1424 const MCSymbol *SLabel = 0;
1425
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001426 if (HI + 1 == HE)
1427 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001428 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001429 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001430 else {
1431 const MachineInstr *End = HI[1];
Eric Christopher6a841382012-11-19 22:42:10 +00001432 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel53b050a2011-07-07 21:44:42 +00001433 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001434 if (End->isDebugValue())
1435 SLabel = getLabelBeforeInsn(End);
1436 else {
1437 // End is a normal instruction clobbering the range.
1438 SLabel = getLabelAfterInsn(End);
1439 assert(SLabel && "Forgot label after clobber instruction");
1440 ++HI;
1441 }
1442 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001443
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001444 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopher365d0832011-12-16 23:42:31 +00001445 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1446 Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001447 }
1448 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001449 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001450
1451 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001452 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1453 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1454 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1455 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001456 if (!DV || !DV.isVariable() || !Processed.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001457 continue;
1458 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001459 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patele0a94bf2010-05-14 21:01:35 +00001460 }
Devang Patel9fc11702010-05-25 23:40:22 +00001461}
Devang Patele0a94bf2010-05-14 21:01:35 +00001462
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001463// Return Label preceding the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001464MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001465 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1466 assert(Label && "Didn't insert label before instruction");
1467 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001468}
1469
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001470// Return Label immediately following the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001471MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001472 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001473}
1474
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001475// Process beginning of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001476void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001477 // Check if source location changes, but ignore DBG_VALUE locations.
1478 if (!MI->isDebugValue()) {
1479 DebugLoc DL = MI->getDebugLoc();
1480 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopheraec8a822012-04-05 20:39:05 +00001481 unsigned Flags = 0;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001482 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001483 if (DL == PrologEndLoc) {
1484 Flags |= DWARF2_FLAG_PROLOGUE_END;
1485 PrologEndLoc = DebugLoc();
1486 }
Eric Christopheraec8a822012-04-05 20:39:05 +00001487 if (PrologEndLoc.isUnknown())
1488 Flags |= DWARF2_FLAG_IS_STMT;
1489
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001490 if (!DL.isUnknown()) {
1491 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001492 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001493 } else
Devang Patel34a66202011-05-11 19:22:19 +00001494 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001495 }
Devang Patel9fc11702010-05-25 23:40:22 +00001496 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001497
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001498 // Insert labels where requested.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001499 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1500 LabelsBeforeInsn.find(MI);
1501
1502 // No label needed.
1503 if (I == LabelsBeforeInsn.end())
1504 return;
1505
1506 // Label already assigned.
1507 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001508 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001509
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001510 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001511 PrevLabel = MMI->getContext().CreateTempSymbol();
1512 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001513 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001514 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001515}
1516
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001517// Process end of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001518void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001519 // Don't create a new label after DBG_VALUE instructions.
1520 // They don't generate code.
1521 if (!MI->isDebugValue())
1522 PrevLabel = 0;
1523
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001524 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1525 LabelsAfterInsn.find(MI);
1526
1527 // No label needed.
1528 if (I == LabelsAfterInsn.end())
1529 return;
1530
1531 // Label already assigned.
1532 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001533 return;
1534
1535 // We need a label after this instruction.
1536 if (!PrevLabel) {
1537 PrevLabel = MMI->getContext().CreateTempSymbol();
1538 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001539 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001540 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001541}
1542
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001543// Each LexicalScope has first instruction and last instruction to mark
1544// beginning and end of a scope respectively. Create an inverse map that list
1545// scopes starts (and ends) with an instruction. One instruction may start (or
1546// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001547void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001548 SmallVector<LexicalScope *, 4> WorkList;
1549 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001550 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001551 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001552
Craig Topper977e9cd2013-07-03 04:24:43 +00001553 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001554 if (!Children.empty())
Craig Topperd8e43652013-07-03 04:17:25 +00001555 for (SmallVectorImpl<LexicalScope *>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00001556 SE = Children.end(); SI != SE; ++SI)
1557 WorkList.push_back(*SI);
1558
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001559 if (S->isAbstractScope())
1560 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001561
Craig Topper977e9cd2013-07-03 04:24:43 +00001562 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001563 if (Ranges.empty())
1564 continue;
Craig Topperd8e43652013-07-03 04:17:25 +00001565 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +00001566 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001567 assert(RI->first && "InsnRange does not have first instruction!");
1568 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001569 requestLabelBeforeInsn(RI->first);
1570 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001571 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001572 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001573}
1574
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001575// Get MDNode for DebugLoc's scope.
Devang Patel589845d2011-05-09 22:14:49 +00001576static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1577 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1578 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1579 return DL.getScope(Ctx);
1580}
1581
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001582// Walk up the scope chain of given debug loc and find line number info
1583// for the function.
Devang Patel34a66202011-05-11 19:22:19 +00001584static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1585 const MDNode *Scope = getScopeNode(DL, Ctx);
1586 DISubprogram SP = getDISubprogram(Scope);
Manman Ren7504ed42013-07-08 18:33:29 +00001587 if (SP.isSubprogram()) {
Eric Christopher34164192012-04-03 00:43:49 +00001588 // Check for number of operands since the compatibility is
1589 // cheap here.
Eric Christopherb81e2b42012-04-03 17:55:42 +00001590 if (SP->getNumOperands() > 19)
Eric Christopher34164192012-04-03 00:43:49 +00001591 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1592 else
1593 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1594 }
1595
Devang Patel34a66202011-05-11 19:22:19 +00001596 return DebugLoc();
1597}
1598
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001599// Gather pre-function debug information. Assumes being called immediately
1600// after the function entry point has been emitted.
Chris Lattner76555b52010-01-26 23:18:02 +00001601void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00001602 if (!MMI->hasDebugInfo()) return;
Devang Patel7e623022011-08-10 20:55:27 +00001603 LScopes.initialize(*MF);
1604 if (LScopes.empty()) return;
1605 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001606
Manman Ren4e042a62013-02-05 21:52:47 +00001607 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1608 // belongs to.
1609 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1610 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1611 assert(TheCU && "Unable to find compile unit!");
Rafael Espindolaac4ad252013-10-05 16:42:21 +00001612 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren9d4c7352013-05-21 00:57:22 +00001613 // Use a single line table if we are using .loc and generating assembly.
1614 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1615 else
1616 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
Manman Ren4e042a62013-02-05 21:52:47 +00001617
Devang Patel6c74a872010-04-27 19:46:33 +00001618 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1619 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001620 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001621 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001622
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001623 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1624
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001625 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001626 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001627 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1628
Devang Patel002d54d2010-05-26 19:37:24 +00001629 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001630 I != E; ++I) {
1631 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001632 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1633 II != IE; ++II) {
1634 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001635
Devang Patel002d54d2010-05-26 19:37:24 +00001636 if (MI->isDebugValue()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001637 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001638
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001639 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001640 const MDNode *Var =
1641 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001642
1643 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001644 if (isDbgValueInDefinedReg(MI))
1645 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1646
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001647 // Check the history of this variable.
1648 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1649 if (History.empty()) {
1650 UserVariables.push_back(Var);
1651 // The first mention of a function argument gets the FunctionBeginSym
1652 // label, so arguments are visible when breaking at function entry.
1653 DIVariable DV(Var);
Manman Ren7504ed42013-07-08 18:33:29 +00001654 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001655 DISubprogram(getDISubprogram(DV.getContext()))
1656 .describes(MF->getFunction()))
1657 LabelsBeforeInsn[MI] = FunctionBeginSym;
1658 } else {
1659 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1660 const MachineInstr *Prev = History.back();
1661 if (Prev->isDebugValue()) {
1662 // Coalesce identical entries at the end of History.
1663 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001664 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher85a495e2012-10-08 20:48:49 +00001665 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher6a841382012-11-19 22:42:10 +00001666 << "\t" << *Prev
Devang Patelb7a328e2011-07-07 00:14:27 +00001667 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001668 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001669 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001670
1671 // Terminate old register assignments that don't reach MI;
1672 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1673 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1674 isDbgValueInDefinedReg(Prev)) {
1675 // Previous register assignment needs to terminate at the end of
1676 // its basic block.
1677 MachineBasicBlock::const_iterator LastMI =
1678 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001679 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001680 // Drop DBG_VALUE for empty range.
Eric Christopher85a495e2012-10-08 20:48:49 +00001681 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patelb7a328e2011-07-07 00:14:27 +00001682 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001683 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001684 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001685 // Terminate after LastMI.
1686 History.push_back(LastMI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001687 }
1688 }
1689 }
1690 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001691 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001692 // Not a DBG_VALUE instruction.
1693 if (!MI->isLabel())
1694 AtBlockEntry = false;
1695
Eric Christopher133195782012-10-04 20:46:14 +00001696 // First known non-DBG_VALUE and non-frame setup location marks
1697 // the beginning of the function body.
1698 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1699 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel34a66202011-05-11 19:22:19 +00001700 PrologEndLoc = MI->getDebugLoc();
1701
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001702 // Check if the instruction clobbers any registers with debug vars.
1703 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1704 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1705 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1706 continue;
Jakob Stoklund Olesen54038d72012-06-01 23:28:30 +00001707 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1708 AI.isValid(); ++AI) {
1709 unsigned Reg = *AI;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001710 const MDNode *Var = LiveUserVar[Reg];
1711 if (!Var)
1712 continue;
1713 // Reg is now clobbered.
1714 LiveUserVar[Reg] = 0;
1715
1716 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001717 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1718 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001719 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001720 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1721 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001722 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001723 const MachineInstr *Prev = History.back();
1724 // Sanity-check: Register assignments are terminated at the end of
1725 // their block.
1726 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1727 continue;
1728 // Is the variable still in Reg?
1729 if (!isDbgValueInDefinedReg(Prev) ||
1730 Prev->getOperand(0).getReg() != Reg)
1731 continue;
1732 // Var is clobbered. Make sure the next instruction gets a label.
1733 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001734 }
1735 }
Devang Patel002d54d2010-05-26 19:37:24 +00001736 }
Devang Patel002d54d2010-05-26 19:37:24 +00001737 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001738 }
1739
1740 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1741 I != E; ++I) {
1742 SmallVectorImpl<const MachineInstr*> &History = I->second;
1743 if (History.empty())
1744 continue;
1745
1746 // Make sure the final register assignments are terminated.
1747 const MachineInstr *Prev = History.back();
1748 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1749 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher6a841382012-11-19 22:42:10 +00001750 MachineBasicBlock::const_iterator LastMI =
Devang Patel784077e2011-08-10 23:58:09 +00001751 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001752 if (LastMI == PrevMBB->end())
1753 // Drop DBG_VALUE for empty range.
1754 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001755 else if (PrevMBB != &PrevMBB->getParent()->back()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001756 // Terminate after LastMI.
1757 History.push_back(LastMI);
1758 }
1759 }
1760 // Request labels for the full history.
1761 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1762 const MachineInstr *MI = History[i];
1763 if (MI->isDebugValue())
1764 requestLabelBeforeInsn(MI);
1765 else
1766 requestLabelAfterInsn(MI);
1767 }
1768 }
Devang Patel002d54d2010-05-26 19:37:24 +00001769
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001770 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001771 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001772
1773 // Record beginning of function.
1774 if (!PrologEndLoc.isUnknown()) {
1775 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1776 MF->getFunction()->getContext());
1777 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1778 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie67cb31e2012-12-04 22:02:33 +00001779 // We'd like to list the prologue as "not statements" but GDB behaves
1780 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikie5a773bb2012-12-04 21:05:36 +00001781 DWARF2_FLAG_IS_STMT);
Devang Patel34a66202011-05-11 19:22:19 +00001782 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001783}
1784
Devang Patel7e623022011-08-10 20:55:27 +00001785void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
David Blaikie6f1a8062013-06-05 05:39:59 +00001786 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1787 DIVariable DV = Var->getVariable();
David Blaikie36d5d2f2013-06-06 21:04:51 +00001788 // Variables with positive arg numbers are parameters.
1789 if (unsigned ArgNum = DV.getArgNumber()) {
1790 // Keep all parameters in order at the start of the variable list to ensure
1791 // function types are correct (no out-of-order parameters)
1792 //
1793 // This could be improved by only doing it for optimized builds (unoptimized
1794 // builds have the right order to begin with), searching from the back (this
1795 // would catch the unoptimized case quickly), or doing a binary search
1796 // rather than linear search.
1797 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1798 while (I != Vars.end()) {
1799 unsigned CurNum = (*I)->getVariable().getArgNumber();
1800 // A local (non-parameter) variable has been found, insert immediately
1801 // before it.
1802 if (CurNum == 0)
1803 break;
1804 // A later indexed parameter has been found, insert immediately before it.
David Blaikieb272a752013-06-06 22:28:26 +00001805 if (CurNum > ArgNum)
David Blaikie36d5d2f2013-06-06 21:04:51 +00001806 break;
David Blaikieb272a752013-06-06 22:28:26 +00001807 ++I;
David Blaikie6f1a8062013-06-05 05:39:59 +00001808 }
David Blaikie36d5d2f2013-06-06 21:04:51 +00001809 Vars.insert(I, Var);
1810 return;
David Blaikie6f1a8062013-06-05 05:39:59 +00001811 }
1812
1813 Vars.push_back(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001814}
1815
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001816// Gather and emit post-function debug information.
Chris Lattner76555b52010-01-26 23:18:02 +00001817void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patel7e623022011-08-10 20:55:27 +00001818 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00001819
Devang Patel7e623022011-08-10 20:55:27 +00001820 // Define end label for subprogram.
1821 FunctionEndSym = Asm->GetTempSymbol("func_end",
1822 Asm->getFunctionNumber());
1823 // Assumes in correct section after the entry point.
1824 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Manman Ren4e042a62013-02-05 21:52:47 +00001825 // Set DwarfCompileUnitID in MCContext to default value.
1826 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher6a841382012-11-19 22:42:10 +00001827
Devang Patel7e623022011-08-10 20:55:27 +00001828 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1829 collectVariableInfo(MF, ProcessedVars);
Eric Christopher6a841382012-11-19 22:42:10 +00001830
Devang Patel3acc70e2011-08-15 22:04:40 +00001831 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001832 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001833 assert(TheCU && "Unable to find compile unit!");
Devang Patel3acc70e2011-08-15 22:04:40 +00001834
Devang Patel7e623022011-08-10 20:55:27 +00001835 // Construct abstract scopes.
Devang Patel44403472011-08-12 18:10:19 +00001836 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1837 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1838 LexicalScope *AScope = AList[i];
1839 DISubprogram SP(AScope->getScopeNode());
Manman Ren7504ed42013-07-08 18:33:29 +00001840 if (SP.isSubprogram()) {
Devang Patel7e623022011-08-10 20:55:27 +00001841 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001842 DIArray Variables = SP.getVariables();
1843 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1844 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001845 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001846 continue;
Alexey Samsonov39602782012-07-06 08:45:08 +00001847 // Check that DbgVariable for DV wasn't created earlier, when
1848 // findAbstractVariable() was called for inlined instance of DV.
1849 LLVMContext &Ctx = DV->getContext();
1850 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1851 if (AbstractVariables.lookup(CleanDV))
1852 continue;
Devang Patel59e27c52011-08-19 23:28:12 +00001853 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001854 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001855 }
1856 }
Devang Patel44403472011-08-12 18:10:19 +00001857 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Manman Ren4213c392013-05-29 17:16:59 +00001858 constructScopeDIE(TheCU, AScope);
Bill Wendling2b128d72009-05-20 23:19:06 +00001859 }
Eric Christopher6a841382012-11-19 22:42:10 +00001860
Devang Patel3acc70e2011-08-15 22:04:40 +00001861 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher6a841382012-11-19 22:42:10 +00001862
Nick Lewycky50f02cb2011-12-02 22:16:29 +00001863 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopherbb69a272012-08-24 01:14:27 +00001864 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Patel3acc70e2011-08-15 22:04:40 +00001865
Bill Wendling2b128d72009-05-20 23:19:06 +00001866 // Clear debug info
Craig Topper2b4a2012013-07-03 04:40:27 +00001867 for (ScopeVariablesMap::iterator
Devang Patel7e623022011-08-10 20:55:27 +00001868 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1869 DeleteContainerPointers(I->second);
1870 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001871 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001872 UserVariables.clear();
1873 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001874 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001875 LabelsBeforeInsn.clear();
1876 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001877 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001878}
1879
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001880// Register a source line with debug info. Returns the unique label that was
1881// emitted and which provides correspondence to the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00001882void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1883 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00001884 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00001885 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00001886 unsigned Src = 1;
1887 if (S) {
1888 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00001889
Dan Gohman50849c62010-05-05 23:41:32 +00001890 if (Scope.isCompileUnit()) {
1891 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001892 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001893 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00001894 } else if (Scope.isFile()) {
1895 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00001896 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001897 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001898 } else if (Scope.isSubprogram()) {
1899 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001900 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001901 Dir = SP.getDirectory();
Eric Christopher6647b832011-10-11 22:59:11 +00001902 } else if (Scope.isLexicalBlockFile()) {
1903 DILexicalBlockFile DBF(S);
1904 Fn = DBF.getFilename();
1905 Dir = DBF.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001906 } else if (Scope.isLexicalBlock()) {
1907 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001908 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001909 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001910 } else
Craig Topperee4dab52012-02-05 08:31:47 +00001911 llvm_unreachable("Unexpected scope info");
Dan Gohman50849c62010-05-05 23:41:32 +00001912
Manman Ren1e427202013-03-07 01:42:00 +00001913 Src = getOrCreateSourceID(Fn, Dir,
1914 Asm->OutStreamer.getContext().getDwarfCompileUnitID());
Dan Gohman50849c62010-05-05 23:41:32 +00001915 }
Nick Lewycky019d2552011-07-29 03:49:23 +00001916 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00001917}
1918
Bill Wendling806535f2009-05-20 23:22:40 +00001919//===----------------------------------------------------------------------===//
1920// Emit Methods
1921//===----------------------------------------------------------------------===//
1922
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001923// Compute the size and offset of a DIE.
Jim Grosbach00e9c612009-11-22 19:20:36 +00001924unsigned
Eric Christopherc8a310e2012-12-10 23:34:43 +00001925DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling480ff322009-05-20 23:21:38 +00001926 // Get the children.
1927 const std::vector<DIE *> &Children = Die->getChildren();
1928
Bill Wendling480ff322009-05-20 23:21:38 +00001929 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00001930 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00001931
1932 // Get the abbreviation for this DIE.
1933 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopherc8a310e2012-12-10 23:34:43 +00001934 const DIEAbbrev *Abbrev = Abbreviations->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00001935
1936 // Set DIE offset
1937 Die->setOffset(Offset);
1938
1939 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00001940 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001941
Eric Christopher4887c8f2013-03-29 23:34:06 +00001942 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1943 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling480ff322009-05-20 23:21:38 +00001944
1945 // Size the DIE attribute values.
1946 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1947 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001948 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001949
1950 // Size the DIE children if any.
1951 if (!Children.empty()) {
1952 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1953 "Children flag not set");
1954
1955 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001956 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling480ff322009-05-20 23:21:38 +00001957
1958 // End of children marker.
1959 Offset += sizeof(int8_t);
1960 }
1961
1962 Die->setSize(Offset - Die->getOffset());
1963 return Offset;
1964}
1965
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001966// Compute the size and offset of all the DIEs.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001967void DwarfUnits::computeSizeAndOffsets() {
Manman Ren14a029d2013-03-12 18:27:15 +00001968 // Offset from the beginning of debug info section.
Eric Christopher4887c8f2013-03-29 23:34:06 +00001969 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopherc8a310e2012-12-10 23:34:43 +00001970 E = CUs.end(); I != E; ++I) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001971 unsigned Offset =
1972 sizeof(int32_t) + // Length of Compilation Unit Info
1973 sizeof(int16_t) + // DWARF version number
1974 sizeof(int32_t) + // Offset Into Abbrev. Section
1975 sizeof(int8_t); // Pointer Size (in bytes)
Eric Christopherc19d6f02013-10-04 19:40:33 +00001976 computeSizeAndOffset((*I)->getCUDie(), Offset);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001977 }
Bill Wendling480ff322009-05-20 23:21:38 +00001978}
1979
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001980// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001981void DwarfDebug::emitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001982 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001983
Bill Wendling480ff322009-05-20 23:21:38 +00001984 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001985 DwarfInfoSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001986 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001987 DwarfAbbrevSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001988 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher3c5a1912012-12-19 22:02:53 +00001989 if (useSplitDwarf())
1990 DwarfAbbrevDWOSectionSym =
1991 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1992 "section_abbrev_dwo");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001993 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001994
Chris Lattner6629ca92010-04-04 22:59:04 +00001995 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001996 emitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00001997
Eric Christopher74804332013-02-07 21:19:50 +00001998 DwarfLineSectionSym =
1999 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002000 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Eric Christopher261d2342013-09-23 20:55:35 +00002001 if (GenerateGnuPubSections) {
Eric Christopher39eebfa2013-09-30 23:14:16 +00002002 DwarfGnuPubNamesSectionSym =
2003 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
2004 DwarfGnuPubTypesSectionSym =
2005 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
Eric Christopher261d2342013-09-23 20:55:35 +00002006 } else if (HasDwarfPubSections) {
2007 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2008 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Michael Gottesmanc89466f2013-09-04 04:39:38 +00002009 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002010
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002011 DwarfStrSectionSym =
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002012 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002013 if (useSplitDwarf()) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002014 DwarfStrDWOSectionSym =
2015 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002016 DwarfAddrSectionSym =
2017 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
2018 }
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002019 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patel12563b32010-04-16 23:33:45 +00002020 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00002021
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002022 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patel9fc11702010-05-25 23:40:22 +00002023 "section_debug_loc");
2024
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002025 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
2026 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002027}
2028
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002029// Recursively emits a debug information entry.
Eric Christopher3c5a1912012-12-19 22:02:53 +00002030void DwarfDebug::emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs) {
Bill Wendling480ff322009-05-20 23:21:38 +00002031 // Get the abbreviation for this DIE.
2032 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher3c5a1912012-12-19 22:02:53 +00002033 const DIEAbbrev *Abbrev = Abbrevs->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00002034
Bill Wendling480ff322009-05-20 23:21:38 +00002035 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00002036 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00002037 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2038 Twine::utohexstr(Die->getOffset()) + ":0x" +
2039 Twine::utohexstr(Die->getSize()) + " " +
2040 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00002041 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00002042
Eric Christopher4887c8f2013-03-29 23:34:06 +00002043 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
2044 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling480ff322009-05-20 23:21:38 +00002045
2046 // Emit the DIE attribute values.
2047 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2048 unsigned Attr = AbbrevData[i].getAttribute();
2049 unsigned Form = AbbrevData[i].getForm();
2050 assert(Form && "Too many attributes for DIE (check abbreviation)");
2051
Chris Lattner7bde8c02010-04-04 18:52:31 +00002052 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00002053 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002054
Bill Wendling480ff322009-05-20 23:21:38 +00002055 switch (Attr) {
Eric Christophere595bae2013-10-04 17:08:38 +00002056 case dwarf::DW_AT_abstract_origin: {
Bill Wendling480ff322009-05-20 23:21:38 +00002057 DIEEntry *E = cast<DIEEntry>(Values[i]);
2058 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002059 unsigned Addr = Origin->getOffset();
Eric Christopherc19d6f02013-10-04 19:40:33 +00002060 Asm->EmitInt32(Addr);
Bill Wendling480ff322009-05-20 23:21:38 +00002061 break;
2062 }
Devang Patel12563b32010-04-16 23:33:45 +00002063 case dwarf::DW_AT_ranges: {
2064 // DW_AT_range Value encodes offset in debug_range section.
2065 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00002066
Nick Lewycky33da3362012-06-22 01:25:12 +00002067 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelda3ef852010-09-02 16:43:44 +00002068 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
2069 V->getValue(),
2070 4);
2071 } else {
2072 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
2073 V->getValue(),
2074 DwarfDebugRangeSectionSym,
2075 4);
2076 }
Devang Patel12563b32010-04-16 23:33:45 +00002077 break;
2078 }
Devang Patel9fc11702010-05-25 23:40:22 +00002079 case dwarf::DW_AT_location: {
Nick Lewycky33da3362012-06-22 01:25:12 +00002080 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2081 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002082 Asm->EmitLabelReference(L->getValue(), 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002083 else
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002084 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002085 } else {
Devang Patel9fc11702010-05-25 23:40:22 +00002086 Values[i]->EmitValue(Asm, Form);
Nick Lewycky33da3362012-06-22 01:25:12 +00002087 }
Devang Patel9fc11702010-05-25 23:40:22 +00002088 break;
2089 }
Devang Patela1bd5a12010-09-29 19:08:08 +00002090 case dwarf::DW_AT_accessibility: {
2091 if (Asm->isVerbose()) {
2092 DIEInteger *V = cast<DIEInteger>(Values[i]);
2093 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2094 }
2095 Values[i]->EmitValue(Asm, Form);
2096 break;
2097 }
Bill Wendling480ff322009-05-20 23:21:38 +00002098 default:
2099 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002100 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00002101 break;
2102 }
Bill Wendling480ff322009-05-20 23:21:38 +00002103 }
2104
2105 // Emit the DIE children if any.
2106 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2107 const std::vector<DIE *> &Children = Die->getChildren();
2108
2109 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher3c5a1912012-12-19 22:02:53 +00002110 emitDIE(Children[j], Abbrevs);
Bill Wendling480ff322009-05-20 23:21:38 +00002111
Chris Lattner7bde8c02010-04-04 18:52:31 +00002112 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00002113 Asm->OutStreamer.AddComment("End Of Children Mark");
2114 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00002115 }
2116}
2117
Eric Christophera2de8262012-12-15 00:04:07 +00002118// Emit the various dwarf units to the unit section USection with
2119// the abbreviations going into ASection.
2120void DwarfUnits::emitUnits(DwarfDebug *DD,
2121 const MCSection *USection,
2122 const MCSection *ASection,
2123 const MCSymbol *ASectionSym) {
2124 Asm->OutStreamer.SwitchSection(USection);
Eric Christopher4887c8f2013-03-29 23:34:06 +00002125 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christophera2de8262012-12-15 00:04:07 +00002126 E = CUs.end(); I != E; ++I) {
2127 CompileUnit *TheCU = *I;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002128 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002129
Devang Patel1a0df9a2010-05-10 22:49:55 +00002130 // Emit the compile units header.
Eric Christophera2de8262012-12-15 00:04:07 +00002131 Asm->OutStreamer
2132 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
2133 TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002134
Devang Patel1a0df9a2010-05-10 22:49:55 +00002135 // Emit size of content not including length itself
2136 unsigned ContentSize = Die->getSize() +
2137 sizeof(int16_t) + // DWARF version number
2138 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patele141234942011-04-13 19:41:17 +00002139 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002140
Devang Patel1a0df9a2010-05-10 22:49:55 +00002141 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2142 Asm->EmitInt32(ContentSize);
2143 Asm->OutStreamer.AddComment("DWARF version number");
Manman Renac8062b2013-07-02 23:40:10 +00002144 Asm->EmitInt16(DD->getDwarfVersion());
Devang Patel1a0df9a2010-05-10 22:49:55 +00002145 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
Eric Christophera2de8262012-12-15 00:04:07 +00002146 Asm->EmitSectionOffset(Asm->GetTempSymbol(ASection->getLabelBeginName()),
2147 ASectionSym);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002148 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002149 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002150
Eric Christopher3c5a1912012-12-19 22:02:53 +00002151 DD->emitDIE(Die, Abbreviations);
Eric Christophera2de8262012-12-15 00:04:07 +00002152 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
Eli Benderskyb42d1462012-12-03 18:45:45 +00002153 TheCU->getUniqueID()));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002154 }
Bill Wendling480ff322009-05-20 23:21:38 +00002155}
2156
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002157// Emit the debug info section.
2158void DwarfDebug::emitDebugInfo() {
Eric Christophera2de8262012-12-15 00:04:07 +00002159 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2160
2161 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
2162 Asm->getObjFileLowering().getDwarfAbbrevSection(),
2163 DwarfAbbrevSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002164}
2165
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002166// Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +00002167void DwarfDebug::emitAbbreviations() {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002168 if (!useSplitDwarf())
2169 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
2170 &Abbreviations);
2171 else
2172 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2173}
Bill Wendling480ff322009-05-20 23:21:38 +00002174
Eric Christopher3c5a1912012-12-19 22:02:53 +00002175void DwarfDebug::emitAbbrevs(const MCSection *Section,
2176 std::vector<DIEAbbrev *> *Abbrevs) {
2177 // Check to see if it is worth the effort.
2178 if (!Abbrevs->empty()) {
2179 // Start the debug abbrev section.
2180 Asm->OutStreamer.SwitchSection(Section);
2181
2182 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
Eric Christopher996b2b72012-12-13 03:00:38 +00002183 Asm->OutStreamer.EmitLabel(Begin);
Bill Wendling480ff322009-05-20 23:21:38 +00002184
2185 // For each abbrevation.
Eric Christopher3c5a1912012-12-19 22:02:53 +00002186 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
Bill Wendling480ff322009-05-20 23:21:38 +00002187 // Get abbreviation data
Eric Christopher3c5a1912012-12-19 22:02:53 +00002188 const DIEAbbrev *Abbrev = Abbrevs->at(i);
Bill Wendling480ff322009-05-20 23:21:38 +00002189
2190 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00002191 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00002192
2193 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002194 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00002195 }
2196
2197 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00002198 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00002199
Eric Christopher3c5a1912012-12-19 22:02:53 +00002200 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
Eric Christopher996b2b72012-12-13 03:00:38 +00002201 Asm->OutStreamer.EmitLabel(End);
Bill Wendling480ff322009-05-20 23:21:38 +00002202 }
2203}
2204
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002205// Emit the last address of the section and the end of the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +00002206void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00002207 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00002208 Asm->OutStreamer.AddComment("Extended Op");
2209 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002210
Chris Lattner566cae92010-03-09 23:52:58 +00002211 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002212 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00002213 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2214 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2215
2216 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002217
Chris Lattnera179b522010-04-04 19:25:43 +00002218 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Eric Christopherce0cfce2013-01-09 01:35:34 +00002219 Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002220
2221 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00002222 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2223 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002224 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00002225 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002226}
2227
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002228// Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00002229void DwarfDebug::emitAccelNames() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002230 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002231 dwarf::DW_FORM_data4));
2232 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2233 E = CUMap.end(); I != E; ++I) {
2234 CompileUnit *TheCU = I->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00002235 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2236 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002237 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002238 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002239 const std::vector<DIE *> &Entities = GI->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00002240 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2241 DE = Entities.end(); DI != DE; ++DI)
2242 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00002243 }
2244 }
2245
2246 AT.FinalizeTable(Asm, "Names");
2247 Asm->OutStreamer.SwitchSection(
2248 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2249 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2250 Asm->OutStreamer.EmitLabel(SectionBegin);
2251
2252 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002253 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002254}
2255
Eric Christopher48fef592012-12-20 21:58:40 +00002256// Emit objective C classes and categories into a hashed accelerator table
2257// section.
Eric Christopher4996c702011-11-07 09:24:32 +00002258void DwarfDebug::emitAccelObjC() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002259 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002260 dwarf::DW_FORM_data4));
2261 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2262 E = CUMap.end(); I != E; ++I) {
2263 CompileUnit *TheCU = I->second;
2264 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2265 for (StringMap<std::vector<DIE*> >::const_iterator
2266 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002267 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002268 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher4996c702011-11-07 09:24:32 +00002269 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2270 DE = Entities.end(); DI != DE; ++DI)
2271 AT.AddName(Name, (*DI));
2272 }
2273 }
2274
2275 AT.FinalizeTable(Asm, "ObjC");
2276 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2277 .getDwarfAccelObjCSection());
2278 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2279 Asm->OutStreamer.EmitLabel(SectionBegin);
2280
2281 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002282 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002283}
2284
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002285// Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002286void DwarfDebug::emitAccelNamespaces() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002287 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002288 dwarf::DW_FORM_data4));
2289 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2290 E = CUMap.end(); I != E; ++I) {
2291 CompileUnit *TheCU = I->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00002292 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2293 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002294 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002295 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002296 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00002297 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2298 DE = Entities.end(); DI != DE; ++DI)
2299 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00002300 }
2301 }
2302
2303 AT.FinalizeTable(Asm, "namespac");
2304 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2305 .getDwarfAccelNamespaceSection());
2306 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2307 Asm->OutStreamer.EmitLabel(SectionBegin);
2308
2309 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002310 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002311}
2312
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002313// Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002314void DwarfDebug::emitAccelTypes() {
Eric Christopher21bde872012-01-06 04:35:23 +00002315 std::vector<DwarfAccelTable::Atom> Atoms;
Eric Christophercf7289f2013-09-05 18:20:16 +00002316 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher21bde872012-01-06 04:35:23 +00002317 dwarf::DW_FORM_data4));
Eric Christophercf7289f2013-09-05 18:20:16 +00002318 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag,
Eric Christopher21bde872012-01-06 04:35:23 +00002319 dwarf::DW_FORM_data2));
Eric Christophercf7289f2013-09-05 18:20:16 +00002320 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags,
Eric Christopher21bde872012-01-06 04:35:23 +00002321 dwarf::DW_FORM_data1));
2322 DwarfAccelTable AT(Atoms);
Eric Christopher4996c702011-11-07 09:24:32 +00002323 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2324 E = CUMap.end(); I != E; ++I) {
2325 CompileUnit *TheCU = I->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002326 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2327 = TheCU->getAccelTypes();
2328 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002329 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002330 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002331 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002332 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2333 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2334 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher4996c702011-11-07 09:24:32 +00002335 }
2336 }
2337
2338 AT.FinalizeTable(Asm, "types");
2339 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2340 .getDwarfAccelTypesSection());
2341 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2342 Asm->OutStreamer.EmitLabel(SectionBegin);
2343
2344 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002345 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002346}
2347
Eric Christopherdd1a0122013-09-13 00:35:05 +00002348// Public name handling.
2349// The format for the various pubnames:
2350//
2351// dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2352// for the DIE that is named.
2353//
2354// gnu pubnames - offset/index value/name tuples where the offset is the offset
2355// into the CU and the index value is computed according to the type of value
2356// for the DIE that is named.
2357//
2358// For type units the offset is the offset of the skeleton DIE. For split dwarf
2359// it's the offset within the debug_info/debug_types dwo section, however, the
2360// reference in the pubname header doesn't change.
2361
2362/// computeIndexValue - Compute the gdb index value for the DIE and CU.
David Blaikie8dec4072013-09-19 20:40:26 +00002363static dwarf::PubIndexEntryDescriptor computeIndexValue(CompileUnit *CU,
2364 DIE *Die) {
Eric Christopherccac5c42013-09-23 22:59:14 +00002365 dwarf::GDBIndexEntryLinkage Linkage =
David Blaikie8dec4072013-09-19 20:40:26 +00002366 Die->findAttribute(dwarf::DW_AT_external) ? dwarf::GIEL_EXTERNAL
2367 : dwarf::GIEL_STATIC;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002368
2369 switch (Die->getTag()) {
2370 case dwarf::DW_TAG_class_type:
2371 case dwarf::DW_TAG_structure_type:
2372 case dwarf::DW_TAG_union_type:
2373 case dwarf::DW_TAG_enumeration_type:
Eric Christopher261d2342013-09-23 20:55:35 +00002374 return dwarf::PubIndexEntryDescriptor(
2375 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2376 ? dwarf::GIEL_STATIC
2377 : dwarf::GIEL_EXTERNAL);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002378 case dwarf::DW_TAG_typedef:
2379 case dwarf::DW_TAG_base_type:
2380 case dwarf::DW_TAG_subrange_type:
David Blaikie8dec4072013-09-19 20:40:26 +00002381 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002382 case dwarf::DW_TAG_namespace:
David Blaikie8dec4072013-09-19 20:40:26 +00002383 return dwarf::GIEK_TYPE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002384 case dwarf::DW_TAG_subprogram:
Eric Christopherccac5c42013-09-23 22:59:14 +00002385 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002386 case dwarf::DW_TAG_constant:
2387 case dwarf::DW_TAG_variable:
Eric Christopherccac5c42013-09-23 22:59:14 +00002388 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002389 case dwarf::DW_TAG_enumerator:
David Blaikie8dec4072013-09-19 20:40:26 +00002390 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2391 dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002392 default:
David Blaikie8dec4072013-09-19 20:40:26 +00002393 return dwarf::GIEK_NONE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002394 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002395}
2396
Eric Christopher5f93bb92013-09-09 20:03:17 +00002397/// emitDebugPubNames - Emit visible names into a debug pubnames section.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002398///
Eric Christopherdd1a0122013-09-13 00:35:05 +00002399void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002400 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christopherdd1a0122013-09-13 00:35:05 +00002401 const MCSection *PSec =
2402 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2403 : Asm->getObjFileLowering().getDwarfPubNamesSection();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002404
2405 typedef DenseMap<const MDNode*, CompileUnit*> CUMapType;
2406 for (CUMapType::iterator I = CUMap.begin(), E = CUMap.end(); I != E; ++I) {
2407 CompileUnit *TheCU = I->second;
2408 unsigned ID = TheCU->getUniqueID();
2409
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002410 // Start the dwarf pubnames section.
Eric Christopher13b99d22013-09-10 21:49:37 +00002411 Asm->OutStreamer.SwitchSection(PSec);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002412
Eric Christopher39eebfa2013-09-30 23:14:16 +00002413 // Emit a label so we can reference the beginning of this pubname section.
2414 if (GnuStyle)
2415 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames",
2416 TheCU->getUniqueID()));
2417
Eric Christopherdd1a0122013-09-13 00:35:05 +00002418 // Emit the header.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002419 Asm->OutStreamer.AddComment("Length of Public Names Info");
2420 Asm->EmitLabelDifference(Asm->GetTempSymbol("pubnames_end", ID),
2421 Asm->GetTempSymbol("pubnames_begin", ID), 4);
2422
2423 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin", ID));
2424
2425 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002426 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002427
2428 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2429 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2430 DwarfInfoSectionSym);
2431
2432 Asm->OutStreamer.AddComment("Compilation Unit Length");
2433 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(), ID),
2434 Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2435 4);
2436
Eric Christopherdd1a0122013-09-13 00:35:05 +00002437 // Emit the pubnames for this compilation unit.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002438 const StringMap<DIE*> &Globals = TheCU->getGlobalNames();
2439 for (StringMap<DIE*>::const_iterator
2440 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2441 const char *Name = GI->getKeyData();
Eric Christopherdd1a0122013-09-13 00:35:05 +00002442 DIE *Entity = GI->second;
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002443
2444 Asm->OutStreamer.AddComment("DIE offset");
2445 Asm->EmitInt32(Entity->getOffset());
2446
Eric Christopherdd1a0122013-09-13 00:35:05 +00002447 if (GnuStyle) {
David Blaikied0a869d2013-09-19 22:19:37 +00002448 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2449 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002450 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002451 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002452 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002453 }
2454
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002455 if (Asm->isVerbose())
2456 Asm->OutStreamer.AddComment("External Name");
Rafael Espindola64e1af82013-07-02 15:49:13 +00002457 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002458 }
2459
2460 Asm->OutStreamer.AddComment("End Mark");
2461 Asm->EmitInt32(0);
2462 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end", ID));
2463 }
2464}
2465
Eric Christopherdd1a0122013-09-13 00:35:05 +00002466void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
Eric Christopher8b3737f2013-09-13 00:34:58 +00002467 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christopher261d2342013-09-23 20:55:35 +00002468 const MCSection *PSec =
2469 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2470 : Asm->getObjFileLowering().getDwarfPubTypesSection();
Eric Christopher8b3737f2013-09-13 00:34:58 +00002471
Devang Patel1a0df9a2010-05-10 22:49:55 +00002472 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
Eric Christopher8b3737f2013-09-13 00:34:58 +00002473 E = CUMap.end();
2474 I != E; ++I) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002475 CompileUnit *TheCU = I->second;
Eric Christopher6abc9c52011-11-07 09:18:35 +00002476 // Start the dwarf pubtypes section.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002477 Asm->OutStreamer.SwitchSection(PSec);
Eric Christopher39eebfa2013-09-30 23:14:16 +00002478
2479 // Emit a label so we can reference the beginning of this pubtype section.
2480 if (GnuStyle)
2481 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes",
2482 TheCU->getUniqueID()));
2483
2484 // Emit the header.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002485 Asm->OutStreamer.AddComment("Length of Public Types Info");
2486 Asm->EmitLabelDifference(
Eric Christopher8b3737f2013-09-13 00:34:58 +00002487 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2488 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002489
Eric Christopher8b3737f2013-09-13 00:34:58 +00002490 Asm->OutStreamer.EmitLabel(
2491 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002492
Eric Christopher8b3737f2013-09-13 00:34:58 +00002493 if (Asm->isVerbose())
2494 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002495 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002496
Devang Patel1a0df9a2010-05-10 22:49:55 +00002497 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002498 Asm->EmitSectionOffset(
2499 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()),
2500 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002501
Devang Patel1a0df9a2010-05-10 22:49:55 +00002502 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002503 Asm->EmitLabelDifference(
2504 Asm->GetTempSymbol(ISec->getLabelEndName(), TheCU->getUniqueID()),
2505 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002506
Eric Christopher39eebfa2013-09-30 23:14:16 +00002507 // Emit the pubtypes.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002508 const StringMap<DIE *> &Globals = TheCU->getGlobalTypes();
2509 for (StringMap<DIE *>::const_iterator GI = Globals.begin(),
2510 GE = Globals.end();
2511 GI != GE; ++GI) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002512 const char *Name = GI->getKeyData();
Nick Lewycky019d2552011-07-29 03:49:23 +00002513 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002514
Eric Christopher8b3737f2013-09-13 00:34:58 +00002515 if (Asm->isVerbose())
2516 Asm->OutStreamer.AddComment("DIE offset");
Devang Patel1a0df9a2010-05-10 22:49:55 +00002517 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002518
Eric Christopherdd1a0122013-09-13 00:35:05 +00002519 if (GnuStyle) {
David Blaikied0a869d2013-09-19 22:19:37 +00002520 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2521 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002522 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002523 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002524 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002525 }
2526
Eric Christopher8b3737f2013-09-13 00:34:58 +00002527 if (Asm->isVerbose())
2528 Asm->OutStreamer.AddComment("External Name");
2529
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002530 // Emit the name with a terminating null byte.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002531 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002532 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002533
Devang Patel1a0df9a2010-05-10 22:49:55 +00002534 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002535 Asm->EmitInt32(0);
Eric Christopher8b3737f2013-09-13 00:34:58 +00002536 Asm->OutStreamer.EmitLabel(
2537 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00002538 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002539}
2540
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002541// Emit strings into a string section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002542void DwarfUnits::emitStrings(const MCSection *StrSection,
2543 const MCSection *OffsetSection = NULL,
2544 const MCSymbol *StrSecSym = NULL) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002545
Eric Christopher27614582013-01-08 22:22:06 +00002546 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002547
Chris Lattner3d72a672010-03-09 23:38:23 +00002548 // Start the dwarf str section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002549 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling480ff322009-05-20 23:21:38 +00002550
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002551 // Get all of the string pool entries and put them in an array by their ID so
2552 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002553 SmallVector<std::pair<unsigned,
Eric Christopherb800ff72013-01-07 22:40:45 +00002554 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002555
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002556 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
Eric Christopher27614582013-01-08 22:22:06 +00002557 I = StringPool.begin(), E = StringPool.end();
Eric Christopher48fef592012-12-20 21:58:40 +00002558 I != E; ++I)
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002559 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002560
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002561 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002562
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002563 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002564 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002565 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002566
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002567 // Emit the string itself with a terminating null byte.
Benjamin Kramer148db362011-11-09 12:12:04 +00002568 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
Eric Christopherce0cfce2013-01-09 01:35:34 +00002569 Entries[i].second->getKeyLength()+1));
Bill Wendling480ff322009-05-20 23:21:38 +00002570 }
Eric Christopher2cbd5762013-01-07 19:32:41 +00002571
2572 // If we've got an offset section go ahead and emit that now as well.
2573 if (OffsetSection) {
2574 Asm->OutStreamer.SwitchSection(OffsetSection);
2575 unsigned offset = 0;
Eric Christopher962c9082013-01-15 23:56:56 +00002576 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002577 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopherbf7bc492013-01-09 03:52:05 +00002578 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopher2cbd5762013-01-07 19:32:41 +00002579 offset += Entries[i].second->getKeyLength() + 1;
2580 }
2581 }
Bill Wendling480ff322009-05-20 23:21:38 +00002582}
2583
Eric Christopher962c9082013-01-15 23:56:56 +00002584// Emit strings into a string section.
2585void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2586
2587 if (AddressPool.empty()) return;
2588
2589 // Start the dwarf addr section.
2590 Asm->OutStreamer.SwitchSection(AddrSection);
2591
David Blaikiece1960f2013-07-08 17:51:28 +00002592 // Order the address pool entries by ID
David Blaikieac569a62013-07-08 17:33:10 +00002593 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher962c9082013-01-15 23:56:56 +00002594
David Blaikiece1960f2013-07-08 17:51:28 +00002595 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2596 E = AddressPool.end();
Eric Christopher962c9082013-01-15 23:56:56 +00002597 I != E; ++I)
David Blaikieac569a62013-07-08 17:33:10 +00002598 Entries[I->second] = I->first;
Eric Christopher962c9082013-01-15 23:56:56 +00002599
2600 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002601 // Emit an expression for reference from debug information entries.
David Blaikieac569a62013-07-08 17:33:10 +00002602 if (const MCExpr *Expr = Entries[i])
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002603 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
Eric Christopher962c9082013-01-15 23:56:56 +00002604 else
2605 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2606 }
2607
2608}
2609
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002610// Emit visible names into a debug str section.
2611void DwarfDebug::emitDebugStr() {
2612 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2613 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2614}
2615
Eric Christopher9046f942013-07-02 21:36:07 +00002616// Emit locations into the debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002617void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002618 if (DotDebugLocEntries.empty())
2619 return;
2620
Eric Christopher4887c8f2013-03-29 23:34:06 +00002621 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Devang Patel116a9d72011-02-04 22:57:18 +00002622 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2623 I != E; ++I) {
2624 DotDebugLocEntry &Entry = *I;
2625 if (I + 1 != DotDebugLocEntries.end())
2626 Entry.Merge(I+1);
2627 }
2628
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002629 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002630 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00002631 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002632 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002633 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2634 unsigned index = 1;
Eric Christopher4887c8f2013-03-29 23:34:06 +00002635 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002636 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002637 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002638 DotDebugLocEntry &Entry = *I;
2639 if (Entry.isMerged()) continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002640 if (Entry.isEmpty()) {
Eric Christopherce0cfce2013-01-09 01:35:34 +00002641 Asm->OutStreamer.EmitIntValue(0, Size);
2642 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002643 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002644 } else {
Eric Christopher25f06422013-07-03 22:40:18 +00002645 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2646 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2647 DIVariable DV(Entry.getVariable());
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002648 Asm->OutStreamer.AddComment("Loc expr size");
2649 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2650 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2651 Asm->EmitLabelDifference(end, begin, 2);
2652 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002653 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002654 DIBasicType BTy(DV.getType());
2655 if (BTy.Verify() &&
Eric Christopher6a841382012-11-19 22:42:10 +00002656 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patel324f8432011-06-01 22:03:25 +00002657 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2658 Asm->OutStreamer.AddComment("DW_OP_consts");
2659 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002660 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002661 } else {
2662 Asm->OutStreamer.AddComment("DW_OP_constu");
2663 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002664 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002665 }
Devang Pateled9fd452011-07-08 16:49:43 +00002666 } else if (Entry.isLocation()) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002667 MachineLocation Loc = Entry.getLoc();
Eric Christopher6a841382012-11-19 22:42:10 +00002668 if (!DV.hasComplexAddress())
Devang Pateled9fd452011-07-08 16:49:43 +00002669 // Regular entry.
Eric Christopher614a89f2013-07-03 22:40:21 +00002670 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002671 else {
2672 // Complex address entry.
2673 unsigned N = DV.getNumAddrElements();
2674 unsigned i = 0;
2675 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002676 if (Loc.getOffset()) {
Devang Pateled9fd452011-07-08 16:49:43 +00002677 i = 2;
Eric Christopher614a89f2013-07-03 22:40:21 +00002678 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002679 Asm->OutStreamer.AddComment("DW_OP_deref");
2680 Asm->EmitInt8(dwarf::DW_OP_deref);
2681 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2682 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2683 Asm->EmitSLEB128(DV.getAddrElement(1));
2684 } else {
2685 // If first address element is OpPlus then emit
2686 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher614a89f2013-07-03 22:40:21 +00002687 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2688 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002689 i = 2;
2690 }
2691 } else {
Eric Christopher614a89f2013-07-03 22:40:21 +00002692 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002693 }
Eric Christopher6a841382012-11-19 22:42:10 +00002694
Devang Pateled9fd452011-07-08 16:49:43 +00002695 // Emit remaining complex address elements.
2696 for (; i < N; ++i) {
2697 uint64_t Element = DV.getAddrElement(i);
2698 if (Element == DIBuilder::OpPlus) {
2699 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2700 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher4d250522012-05-08 18:56:00 +00002701 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002702 if (!Loc.isReg())
Eric Christopher4d250522012-05-08 18:56:00 +00002703 Asm->EmitInt8(dwarf::DW_OP_deref);
2704 } else
2705 llvm_unreachable("unknown Opcode found in complex address");
Devang Pateled9fd452011-07-08 16:49:43 +00002706 }
Devang Patel3e021532011-04-28 02:22:40 +00002707 }
Devang Patel3e021532011-04-28 02:22:40 +00002708 }
Devang Pateled9fd452011-07-08 16:49:43 +00002709 // else ... ignore constant fp. There is not any good way to
2710 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002711 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002712 }
2713 }
Bill Wendling480ff322009-05-20 23:21:38 +00002714}
2715
Richard Mitton21101b32013-09-19 23:21:01 +00002716struct SymbolCUSorter {
2717 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2718 const MCStreamer &Streamer;
2719
2720 bool operator() (const SymbolCU &A, const SymbolCU &B) {
2721 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2722 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2723
2724 // Symbols with no order assigned should be placed at the end.
2725 // (e.g. section end labels)
2726 if (IA == 0)
2727 IA = (unsigned)(-1);
2728 if (IB == 0)
2729 IB = (unsigned)(-1);
2730 return IA < IB;
2731 }
2732};
2733
Richard Mitton21101b32013-09-19 23:21:01 +00002734static bool CUSort(const CompileUnit *A, const CompileUnit *B) {
2735 return (A->getUniqueID() < B->getUniqueID());
2736}
2737
2738struct ArangeSpan {
2739 const MCSymbol *Start, *End;
2740};
2741
2742// Emit a debug aranges section, containing a CU lookup for any
2743// address we can tie back to a CU.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002744void DwarfDebug::emitDebugARanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002745 // Start the dwarf aranges section.
Eric Christopherac8199b2013-08-30 00:39:57 +00002746 Asm->OutStreamer
2747 .SwitchSection(Asm->getObjFileLowering().getDwarfARangesSection());
Richard Mitton21101b32013-09-19 23:21:01 +00002748
2749 typedef DenseMap<CompileUnit *, std::vector<ArangeSpan> > SpansType;
2750
2751 SpansType Spans;
2752
2753 // Build a list of sections used.
2754 std::vector<const MCSection *> Sections;
2755 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2756 it++) {
2757 const MCSection *Section = it->first;
2758 Sections.push_back(Section);
2759 }
2760
2761 // Sort the sections into order.
2762 // This is only done to ensure consistent output order across different runs.
2763 std::sort(Sections.begin(), Sections.end(), SectionSort);
2764
2765 // Build a set of address spans, sorted by CU.
2766 for (size_t SecIdx=0;SecIdx<Sections.size();SecIdx++) {
2767 const MCSection *Section = Sections[SecIdx];
2768 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2769 if (List.size() < 2)
2770 continue;
2771
2772 // Sort the symbols by offset within the section.
2773 SymbolCUSorter sorter(Asm->OutStreamer);
2774 std::sort(List.begin(), List.end(), sorter);
2775
2776 // If we have no section (e.g. common), just write out
2777 // individual spans for each symbol.
2778 if (Section == NULL) {
2779 for (size_t n = 0; n < List.size(); n++) {
2780 const SymbolCU &Cur = List[n];
2781
2782 ArangeSpan Span;
2783 Span.Start = Cur.Sym;
2784 Span.End = NULL;
2785 if (Cur.CU)
2786 Spans[Cur.CU].push_back(Span);
2787 }
2788 } else {
2789 // Build spans between each label.
2790 const MCSymbol *StartSym = List[0].Sym;
2791 for (size_t n = 1; n < List.size(); n++) {
2792 const SymbolCU &Prev = List[n - 1];
2793 const SymbolCU &Cur = List[n];
2794
2795 // Try and build the longest span we can within the same CU.
2796 if (Cur.CU != Prev.CU) {
2797 ArangeSpan Span;
2798 Span.Start = StartSym;
2799 Span.End = Cur.Sym;
2800 Spans[Prev.CU].push_back(Span);
2801 StartSym = Cur.Sym;
2802 }
2803 }
2804 }
2805 }
2806
2807 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2808 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2809
2810 // Build a list of CUs used.
2811 std::vector<CompileUnit *> CUs;
2812 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
2813 CompileUnit *CU = it->first;
2814 CUs.push_back(CU);
2815 }
2816
2817 // Sort the CU list (again, to ensure consistent output order).
2818 std::sort(CUs.begin(), CUs.end(), CUSort);
2819
2820 // Emit an arange table for each CU we used.
2821 for (size_t CUIdx=0;CUIdx<CUs.size();CUIdx++) {
2822 CompileUnit *CU = CUs[CUIdx];
2823 std::vector<ArangeSpan> &List = Spans[CU];
2824
2825 // Emit size of content not including length itself.
2826 unsigned ContentSize
2827 = sizeof(int16_t) // DWARF ARange version number
2828 + sizeof(int32_t) // Offset of CU in the .debug_info section
2829 + sizeof(int8_t) // Pointer Size (in bytes)
2830 + sizeof(int8_t); // Segment Size (in bytes)
2831
2832 unsigned TupleSize = PtrSize * 2;
2833
2834 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2835 unsigned Padding = 0;
2836 while (((sizeof(int32_t) + ContentSize + Padding) % TupleSize) != 0)
2837 Padding++;
2838
2839 ContentSize += Padding;
2840 ContentSize += (List.size() + 1) * TupleSize;
2841
2842 // For each compile unit, write the list of spans it covers.
2843 Asm->OutStreamer.AddComment("Length of ARange Set");
2844 Asm->EmitInt32(ContentSize);
2845 Asm->OutStreamer.AddComment("DWARF Arange version number");
2846 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2847 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
2848 Asm->EmitSectionOffset(
2849 Asm->GetTempSymbol(ISec->getLabelBeginName(), CU->getUniqueID()),
2850 DwarfInfoSectionSym);
2851 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2852 Asm->EmitInt8(PtrSize);
2853 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2854 Asm->EmitInt8(0);
2855
2856 for (unsigned n = 0; n < Padding; n++)
2857 Asm->EmitInt8(0xff);
2858
2859 for (unsigned n = 0; n < List.size(); n++) {
2860 const ArangeSpan &Span = List[n];
2861 Asm->EmitLabelReference(Span.Start, PtrSize);
2862
2863 // Calculate the size as being from the span start to it's end.
Richard Mitton089ed892013-09-23 17:56:20 +00002864 if (Span.End) {
Richard Mitton21101b32013-09-19 23:21:01 +00002865 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
Richard Mitton089ed892013-09-23 17:56:20 +00002866 } else {
2867 // For symbols without an end marker (e.g. common), we
2868 // write a single arange entry containing just that one symbol.
2869 uint64_t Size = SymSize[Span.Start];
2870 if (Size == 0)
2871 Size = 1;
2872
2873 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2874 }
Richard Mitton21101b32013-09-19 23:21:01 +00002875 }
2876
2877 Asm->OutStreamer.AddComment("ARange terminator");
2878 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2879 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2880 }
Bill Wendling480ff322009-05-20 23:21:38 +00002881}
2882
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002883// Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002884void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002885 // Start the dwarf ranges section.
Eric Christopherac8199b2013-08-30 00:39:57 +00002886 Asm->OutStreamer
2887 .SwitchSection(Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002888 unsigned char Size = Asm->getDataLayout().getPointerSize();
Eric Christopher4887c8f2013-03-29 23:34:06 +00002889 for (SmallVectorImpl<const MCSymbol *>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002890 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00002891 I != E; ++I) {
2892 if (*I)
Eric Christopherbf7bc492013-01-09 03:52:05 +00002893 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
Devang Patel12563b32010-04-16 23:33:45 +00002894 else
Eric Christopherce0cfce2013-01-09 01:35:34 +00002895 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel12563b32010-04-16 23:33:45 +00002896 }
Bill Wendling480ff322009-05-20 23:21:38 +00002897}
2898
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002899// Emit visible names into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002900void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002901 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00002902 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00002903 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002904 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00002905 }
2906}
2907
Eric Christopherd692c1d2012-12-11 19:42:09 +00002908// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002909
2910// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2911// DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
Eric Christopher9a08f9e2013-10-01 00:43:36 +00002912// DW_AT_ranges_base, DW_AT_addr_base.
Eric Christopher6fdf3242013-08-26 23:50:43 +00002913CompileUnit *DwarfDebug::constructSkeletonCU(const CompileUnit *CU) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002914
2915 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher6fdf3242013-08-26 23:50:43 +00002916 CompileUnit *NewCU = new CompileUnit(CU->getUniqueID(), Die, CU->getNode(),
2917 Asm, this, &SkeletonHolder);
Eric Christopher4c7765f2013-01-17 03:00:04 +00002918
Eric Christopherdae389b2013-02-22 23:50:08 +00002919 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
Eric Christopher6b16b432013-08-26 23:57:03 +00002920 DICompileUnit(CU->getNode()).getSplitDebugFilename());
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002921
Eric Christopher44c6aa62013-04-22 07:51:08 +00002922 // Relocate to the beginning of the addr_base section, else 0 for the
2923 // beginning of the one for this compile unit.
Eric Christopher55863be2013-04-07 03:43:09 +00002924 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2925 NewCU->addLabel(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2926 DwarfAddrSectionSym);
2927 else
Eric Christopher44c6aa62013-04-22 07:51:08 +00002928 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base,
2929 dwarf::DW_FORM_sec_offset, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002930
2931 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher962c9082013-01-15 23:56:56 +00002932 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002933 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher962c9082013-01-15 23:56:56 +00002934
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002935 // DW_AT_stmt_list is a offset of line number information for this
2936 // compile unit in debug_line section.
Eric Christopher55863be2013-04-07 03:43:09 +00002937 // FIXME: Should handle multiple compile units.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002938 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher4c7765f2013-01-17 03:00:04 +00002939 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher74804332013-02-07 21:19:50 +00002940 DwarfLineSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002941 else
Eric Christopher4c7765f2013-01-17 03:00:04 +00002942 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002943
2944 if (!CompilationDir.empty())
Eric Christopher2cbd5762013-01-07 19:32:41 +00002945 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002946
Eric Christopher1d06eb52013-10-01 00:43:31 +00002947 // Flags to let the linker know we have emitted new style pubnames.
Eric Christopher39eebfa2013-09-30 23:14:16 +00002948 if (GenerateGnuPubSections) {
2949 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2950 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_sec_offset,
2951 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()));
2952 else
2953 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
2954 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()),
2955 DwarfGnuPubNamesSectionSym);
2956
2957 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2958 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_sec_offset,
2959 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()));
2960 else
2961 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopherf976c772013-10-03 17:41:16 +00002962 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()),
Eric Christopher39eebfa2013-09-30 23:14:16 +00002963 DwarfGnuPubTypesSectionSym);
2964 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002965
Eric Christopher9a08f9e2013-10-01 00:43:36 +00002966 // Flag if we've emitted any ranges and their location for the compile unit.
2967 if (DebugRangeSymbols.size()) {
2968 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2969 NewCU->addLabel(Die, dwarf::DW_AT_GNU_ranges_base,
2970 dwarf::DW_FORM_sec_offset, DwarfDebugRangeSectionSym);
2971 else
2972 NewCU->addUInt(Die, dwarf::DW_AT_GNU_ranges_base, dwarf::DW_FORM_data4,
2973 0);
2974 }
2975
Eric Christopherc8a310e2012-12-10 23:34:43 +00002976 SkeletonHolder.addUnit(NewCU);
Eric Christopher5b33b3c2013-02-06 21:53:56 +00002977 SkeletonCUs.push_back(NewCU);
Eric Christopherc8a310e2012-12-10 23:34:43 +00002978
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002979 return NewCU;
2980}
2981
Eric Christopher3c5a1912012-12-19 22:02:53 +00002982void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
2983 assert(useSplitDwarf() && "No split dwarf debug info?");
2984 emitAbbrevs(Section, &SkeletonAbbrevs);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002985}
2986
Eric Christopherd692c1d2012-12-11 19:42:09 +00002987// Emit the .debug_info.dwo section for separated dwarf. This contains the
2988// compile units that would normally be in debug_info.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002989void DwarfDebug::emitDebugInfoDWO() {
Eric Christophercdf218d2012-12-10 19:51:21 +00002990 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christophera2de8262012-12-15 00:04:07 +00002991 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
Eric Christopher3c5a1912012-12-19 22:02:53 +00002992 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2993 DwarfAbbrevDWOSectionSym);
2994}
2995
2996// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2997// abbreviations for the .debug_info.dwo section.
2998void DwarfDebug::emitDebugAbbrevDWO() {
2999 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopher48fef592012-12-20 21:58:40 +00003000 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
3001 &Abbreviations);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00003002}
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003003
3004// Emit the .debug_str.dwo section for separated dwarf. This contains the
3005// string section and is identical in format to traditional .debug_str
3006// sections.
3007void DwarfDebug::emitDebugStrDWO() {
3008 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherb800ff72013-01-07 22:40:45 +00003009 const MCSection *OffSec = Asm->getObjFileLowering()
3010 .getDwarfStrOffDWOSection();
Eric Christopher2cbd5762013-01-07 19:32:41 +00003011 const MCSymbol *StrSym = DwarfStrSectionSym;
3012 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
3013 OffSec, StrSym);
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003014}