blob: 3406d794180c5f3fc5b17ca2131ee9b68ba17150 [file] [log] [blame]
Bill Wendling2f921f82009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Chris Lattnerb14490d2010-03-09 00:39:24 +000013
Devang Patel80ae3492009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling2f921f82009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000016#include "DIE.h"
Eric Christopher45731982013-08-08 23:45:55 +000017#include "DIEHash.h"
Eric Christopher4996c702011-11-07 09:24:32 +000018#include "DwarfAccelTable.h"
Devang Patel5eb43192011-04-12 17:40:32 +000019#include "DwarfCompileUnit.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000020#include "llvm/ADT/STLExtras.h"
21#include "llvm/ADT/Statistic.h"
22#include "llvm/ADT/StringExtras.h"
23#include "llvm/ADT/Triple.h"
David Greene829b3e82009-08-19 21:52:55 +000024#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000025#include "llvm/CodeGen/MachineModuleInfo.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000026#include "llvm/DIBuilder.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000027#include "llvm/DebugInfo.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000028#include "llvm/IR/Constants.h"
29#include "llvm/IR/DataLayout.h"
30#include "llvm/IR/Instructions.h"
31#include "llvm/IR/Module.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000032#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000033#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000034#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000035#include "llvm/MC/MCSymbol.h"
Devang Patel6c74a872010-04-27 19:46:33 +000036#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000037#include "llvm/Support/Debug.h"
David Majnemered89b5c2013-08-21 06:13:34 +000038#include "llvm/Support/Dwarf.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000039#include "llvm/Support/ErrorHandling.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000040#include "llvm/Support/FormattedStream.h"
Eric Christopher67646432013-07-26 17:02:41 +000041#include "llvm/Support/MD5.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000042#include "llvm/Support/Path.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000043#include "llvm/Support/Timer.h"
44#include "llvm/Support/ValueHandle.h"
45#include "llvm/Target/TargetFrameLowering.h"
46#include "llvm/Target/TargetLoweringObjectFile.h"
47#include "llvm/Target/TargetMachine.h"
48#include "llvm/Target/TargetOptions.h"
49#include "llvm/Target/TargetRegisterInfo.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000050using namespace llvm;
51
Eric Christopher7f2b5512013-07-23 22:16:41 +000052static cl::opt<bool>
53DisableDebugInfoPrinting("disable-debug-info-print", cl::Hidden,
54 cl::desc("Disable debug info printing"));
Devang Patel6c74a872010-04-27 19:46:33 +000055
Eric Christopher7f2b5512013-07-23 22:16:41 +000056static cl::opt<bool> UnknownLocations(
57 "use-unknown-locations", cl::Hidden,
58 cl::desc("Make an absence of debug location information explicit."),
59 cl::init(false));
Dan Gohman7421ae42010-05-07 01:08:53 +000060
Eric Christopher7f2b5512013-07-23 22:16:41 +000061static cl::opt<bool>
Eric Christopher67646432013-07-26 17:02:41 +000062GenerateODRHash("generate-odr-hash", cl::Hidden,
63 cl::desc("Add an ODR hash to external type DIEs."),
64 cl::init(false));
65
Eric Christopherd29614f2013-08-13 01:21:55 +000066static cl::opt<bool>
67GenerateCUHash("generate-cu-hash", cl::Hidden,
68 cl::desc("Add the CU hash as the dwo_id."),
69 cl::init(false));
70
Eric Christopherdd1a0122013-09-13 00:35:05 +000071static cl::opt<bool>
72GenerateGnuPubSections("generate-gnu-dwarf-pub-sections", cl::Hidden,
73 cl::desc("Generate GNU-style pubnames and pubtypes"),
74 cl::init(false));
75
Eric Christopher20b76a72012-08-23 22:36:40 +000076namespace {
Eric Christopher7f2b5512013-07-23 22:16:41 +000077enum DefaultOnOff {
78 Default,
79 Enable,
80 Disable
81};
Eric Christopher20b76a72012-08-23 22:36:40 +000082}
Eric Christopher4996c702011-11-07 09:24:32 +000083
Eric Christopher7f2b5512013-07-23 22:16:41 +000084static cl::opt<DefaultOnOff>
85DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
86 cl::desc("Output prototype dwarf accelerator tables."),
87 cl::values(clEnumVal(Default, "Default for platform"),
88 clEnumVal(Enable, "Enabled"),
89 clEnumVal(Disable, "Disabled"), clEnumValEnd),
90 cl::init(Default));
Eric Christopher20b76a72012-08-23 22:36:40 +000091
Eric Christopher7f2b5512013-07-23 22:16:41 +000092static cl::opt<DefaultOnOff>
Eric Christopher7f2b5512013-07-23 22:16:41 +000093SplitDwarf("split-dwarf", cl::Hidden,
94 cl::desc("Output prototype dwarf split debug info."),
95 cl::values(clEnumVal(Default, "Default for platform"),
96 clEnumVal(Enable, "Enabled"),
97 clEnumVal(Disable, "Disabled"), clEnumValEnd),
98 cl::init(Default));
Eric Christopher29424312012-11-12 22:22:20 +000099
Eric Christopher7da24882013-08-19 21:07:38 +0000100static cl::opt<DefaultOnOff>
Eric Christopher4d36ca02013-08-26 23:24:35 +0000101DwarfPubSections("generate-dwarf-pub-sections", cl::Hidden,
102 cl::desc("Generate DWARF pubnames and pubtypes sections"),
103 cl::values(clEnumVal(Default, "Default for platform"),
104 clEnumVal(Enable, "Enabled"),
105 clEnumVal(Disable, "Disabled"), clEnumValEnd),
106 cl::init(Default));
Eric Christopher7da24882013-08-19 21:07:38 +0000107
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000108static const char *const DWARFGroupName = "DWARF Emission";
109static const char *const DbgTimerName = "DWARF Debug Writer";
Bill Wendlingfcc14142010-04-07 09:28:04 +0000110
Bill Wendling2f921f82009-05-15 09:23:25 +0000111//===----------------------------------------------------------------------===//
112
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000113// Configuration values for initial hash set sizes (log2).
114//
Bill Wendling2f921f82009-05-15 09:23:25 +0000115static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +0000116
117namespace llvm {
118
Nick Lewycky019d2552011-07-29 03:49:23 +0000119DIType DbgVariable::getType() const {
Devang Patelf20c4f72011-04-12 22:53:02 +0000120 DIType Ty = Var.getType();
121 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
122 // addresses instead.
123 if (Var.isBlockByrefVariable()) {
124 /* Byref variables, in Blocks, are declared by the programmer as
125 "SomeType VarName;", but the compiler creates a
126 __Block_byref_x_VarName struct, and gives the variable VarName
127 either the struct, or a pointer to the struct, as its type. This
128 is necessary for various behind-the-scenes things the compiler
129 needs to do with by-reference variables in blocks.
Eric Christopher6a841382012-11-19 22:42:10 +0000130
Devang Patelf20c4f72011-04-12 22:53:02 +0000131 However, as far as the original *programmer* is concerned, the
132 variable should still have type 'SomeType', as originally declared.
Eric Christopher6a841382012-11-19 22:42:10 +0000133
Devang Patelf20c4f72011-04-12 22:53:02 +0000134 The following function dives into the __Block_byref_x_VarName
135 struct to find the original type of the variable. This will be
136 passed back to the code generating the type for the Debug
137 Information Entry for the variable 'VarName'. 'VarName' will then
138 have the original type 'SomeType' in its debug information.
Eric Christopher6a841382012-11-19 22:42:10 +0000139
Devang Patelf20c4f72011-04-12 22:53:02 +0000140 The original type 'SomeType' will be the type of the field named
141 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher6a841382012-11-19 22:42:10 +0000142
Devang Patelf20c4f72011-04-12 22:53:02 +0000143 NOTE: In order for this to not completely fail on the debugger
144 side, the Debug Information Entry for the variable VarName needs to
145 have a DW_AT_location that tells the debugger how to unwind through
146 the pointers and __Block_byref_x_VarName struct to find the actual
147 value of the variable. The function addBlockByrefType does this. */
148 DIType subType = Ty;
Eric Christopher31b05762013-08-08 01:41:00 +0000149 uint16_t tag = Ty.getTag();
Eric Christopher6a841382012-11-19 22:42:10 +0000150
Eric Christopher9adc55f2013-09-04 19:53:21 +0000151 if (tag == dwarf::DW_TAG_pointer_type)
Eric Christophere595bae2013-10-04 17:08:38 +0000152 subType = DIDerivedType(Ty).getTypeDerivedFrom();
Eric Christopher6a841382012-11-19 22:42:10 +0000153
Eric Christopher9adc55f2013-09-04 19:53:21 +0000154 DIArray Elements = DICompositeType(subType).getTypeArray();
Devang Patelf20c4f72011-04-12 22:53:02 +0000155 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
Eric Christopher9adc55f2013-09-04 19:53:21 +0000156 DIDerivedType DT = DIDerivedType(Elements.getElement(i));
Devang Patelf20c4f72011-04-12 22:53:02 +0000157 if (getName() == DT.getName())
Eric Christophere595bae2013-10-04 17:08:38 +0000158 return (DT.getTypeDerivedFrom());
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000159 }
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000160 }
Devang Patelf20c4f72011-04-12 22:53:02 +0000161 return Ty;
162}
Bill Wendling2f921f82009-05-15 09:23:25 +0000163
Chris Lattnerf5d06362010-04-05 04:09:20 +0000164} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000165
Manman Renac8062b2013-07-02 23:40:10 +0000166/// Return Dwarf Version by checking module flags.
167static unsigned getDwarfVersionFromModule(const Module *M) {
Manman Ren8bfde892013-07-16 23:21:16 +0000168 Value *Val = M->getModuleFlag("Dwarf Version");
169 if (!Val)
Eric Christophere31e0722013-09-04 22:21:24 +0000170 return dwarf::DWARF_VERSION;
Manman Ren8bfde892013-07-16 23:21:16 +0000171 return cast<ConstantInt>(Val)->getZExtValue();
Manman Renac8062b2013-07-02 23:40:10 +0000172}
173
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000174DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Eric Christopherd79f5482012-12-10 19:51:13 +0000175 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000176 AbbreviationsSet(InitAbbreviationsSetSize),
Eric Christopher27614582013-01-08 22:22:06 +0000177 SourceIdMap(DIEValueAllocator),
Eric Christopherc8a310e2012-12-10 23:34:43 +0000178 PrevLabel(NULL), GlobalCUIndexCount(0),
Eric Christopher27614582013-01-08 22:22:06 +0000179 InfoHolder(A, &AbbreviationsSet, &Abbreviations, "info_string",
180 DIEValueAllocator),
Eric Christopher3c5a1912012-12-19 22:02:53 +0000181 SkeletonAbbrevSet(InitAbbreviationsSetSize),
Eric Christopher27614582013-01-08 22:22:06 +0000182 SkeletonHolder(A, &SkeletonAbbrevSet, &SkeletonAbbrevs, "skel_string",
183 DIEValueAllocator) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000184
Rafael Espindolaa7160962011-05-06 14:56:22 +0000185 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattnere58b5472010-04-04 23:10:38 +0000186 DwarfStrSectionSym = TextSectionSym = 0;
Eric Christopher74804332013-02-07 21:19:50 +0000187 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
Eric Christopher55863be2013-04-07 03:43:09 +0000188 DwarfAddrSectionSym = 0;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000189 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000190 FunctionBeginSym = FunctionEndSym = 0;
Eric Christopherad9fe892012-04-02 17:58:52 +0000191
Eric Christopher978fbff2012-08-23 07:10:46 +0000192 // Turn on accelerator tables and older gdb compatibility
Eric Christopher574b5c82013-08-19 21:41:38 +0000193 // for Darwin by default, pubnames by default for non-Darwin,
194 // and handle split dwarf.
Eric Christopher203e12b2013-04-27 01:07:52 +0000195 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
Eric Christopher4977f212012-08-23 22:36:36 +0000196
Eric Christopher574b5c82013-08-19 21:41:38 +0000197 if (DwarfAccelTables == Default)
198 HasDwarfAccelTables = IsDarwin;
199 else
Eric Christopher5297df02013-08-26 20:58:35 +0000200 HasDwarfAccelTables = DwarfAccelTables == Enable;
Eric Christopher20b76a72012-08-23 22:36:40 +0000201
Eric Christophercdf218d2012-12-10 19:51:21 +0000202 if (SplitDwarf == Default)
203 HasSplitDwarf = false;
Eric Christopher29424312012-11-12 22:22:20 +0000204 else
Eric Christopher574b5c82013-08-19 21:41:38 +0000205 HasSplitDwarf = SplitDwarf == Enable;
Eric Christopher29424312012-11-12 22:22:20 +0000206
Eric Christopher4d36ca02013-08-26 23:24:35 +0000207 if (DwarfPubSections == Default)
208 HasDwarfPubSections = !IsDarwin;
Eric Christopher574b5c82013-08-19 21:41:38 +0000209 else
Eric Christopher4d36ca02013-08-26 23:24:35 +0000210 HasDwarfPubSections = DwarfPubSections == Enable;
Eric Christopher7da24882013-08-19 21:07:38 +0000211
Manman Renac8062b2013-07-02 23:40:10 +0000212 DwarfVersion = getDwarfVersionFromModule(MMI->getModule());
213
Dan Gohman6e681a52010-06-18 15:56:31 +0000214 {
215 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopher58f41952012-11-19 22:42:15 +0000216 beginModule();
Torok Edwinf8dba242010-04-07 10:44:46 +0000217 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000218}
219DwarfDebug::~DwarfDebug() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000220}
221
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000222// Switch to the specified MCSection and emit an assembler
223// temporary label to it if SymbolStem is specified.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000224static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christophera7b61892011-11-07 09:18:38 +0000225 const char *SymbolStem = 0) {
226 Asm->OutStreamer.SwitchSection(Section);
227 if (!SymbolStem) return 0;
228
229 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
230 Asm->OutStreamer.EmitLabel(TmpSym);
231 return TmpSym;
232}
233
Eric Christophere698f532012-12-20 21:58:36 +0000234MCSymbol *DwarfUnits::getStringPoolSym() {
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000235 return Asm->GetTempSymbol(StringPref);
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000236}
237
Eric Christophere698f532012-12-20 21:58:36 +0000238MCSymbol *DwarfUnits::getStringPoolEntry(StringRef Str) {
239 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopher27614582013-01-08 22:22:06 +0000240 StringPool.GetOrCreateValue(Str).getValue();
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000241 if (Entry.first) return Entry.first;
242
243 Entry.second = NextStringPoolNumber++;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000244 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000245}
246
Eric Christopher2cbd5762013-01-07 19:32:41 +0000247unsigned DwarfUnits::getStringPoolIndex(StringRef Str) {
248 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopher27614582013-01-08 22:22:06 +0000249 StringPool.GetOrCreateValue(Str).getValue();
Eric Christopher2cbd5762013-01-07 19:32:41 +0000250 if (Entry.first) return Entry.second;
251
252 Entry.second = NextStringPoolNumber++;
253 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
254 return Entry.second;
255}
256
David Blaikiedea547b2013-06-28 18:47:14 +0000257unsigned DwarfUnits::getAddrPoolIndex(const MCSymbol *Sym) {
David Blaikie8466ca82013-07-01 23:55:52 +0000258 return getAddrPoolIndex(MCSymbolRefExpr::Create(Sym, Asm->OutContext));
259}
260
Ulrich Weigand8b3d2262013-07-02 18:46:46 +0000261unsigned DwarfUnits::getAddrPoolIndex(const MCExpr *Sym) {
262 std::pair<DenseMap<const MCExpr *, unsigned>::iterator, bool> P =
David Blaikieb8ef7852013-06-28 18:47:19 +0000263 AddressPool.insert(std::make_pair(Sym, NextAddrPoolNumber));
David Blaikiea67de2b2013-06-28 18:55:13 +0000264 if (P.second)
265 ++NextAddrPoolNumber;
David Blaikieb8ef7852013-06-28 18:47:19 +0000266 return P.first->second;
Eric Christopher962c9082013-01-15 23:56:56 +0000267}
268
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000269// Define a unique number for the abbreviation.
270//
Eric Christopherc8a310e2012-12-10 23:34:43 +0000271void DwarfUnits::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000272 // Check the set for priors.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000273 DIEAbbrev *InSet = AbbreviationsSet->GetOrInsertNode(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000274
275 // If it's newly added.
276 if (InSet == &Abbrev) {
277 // Add to abbreviation list.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000278 Abbreviations->push_back(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000279
280 // Assign the vector position + 1 as its number.
Eric Christopherc8a310e2012-12-10 23:34:43 +0000281 Abbrev.setNumber(Abbreviations->size());
Bill Wendling2f921f82009-05-15 09:23:25 +0000282 } else {
283 // Assign existing abbreviation number.
284 Abbrev.setNumber(InSet->getNumber());
285 }
286}
287
Eric Christopherd9843b32011-11-10 19:25:34 +0000288static bool isObjCClass(StringRef Name) {
289 return Name.startswith("+") || Name.startswith("-");
290}
291
292static bool hasObjCCategory(StringRef Name) {
293 if (!isObjCClass(Name)) return false;
294
Benjamin Kramer260de742013-08-24 12:15:54 +0000295 return Name.find(") ") != StringRef::npos;
Eric Christopherd9843b32011-11-10 19:25:34 +0000296}
297
298static void getObjCClassCategory(StringRef In, StringRef &Class,
299 StringRef &Category) {
300 if (!hasObjCCategory(In)) {
301 Class = In.slice(In.find('[') + 1, In.find(' '));
302 Category = "";
303 return;
304 }
305
306 Class = In.slice(In.find('[') + 1, In.find('('));
307 Category = In.slice(In.find('[') + 1, In.find(' '));
308 return;
309}
310
311static StringRef getObjCMethodName(StringRef In) {
312 return In.slice(In.find(' ') + 1, In.find(']'));
313}
314
Richard Mittonc2508242013-10-03 22:07:08 +0000315// Helper for sorting sections into a stable output order.
316static bool SectionSort(const MCSection *A, const MCSection *B) {
317 std::string LA = (A ? A->getLabelBeginName() : "");
318 std::string LB = (B ? B->getLabelBeginName() : "");
319 return LA < LB;
320}
321
Eric Christopherd9843b32011-11-10 19:25:34 +0000322// Add the various names to the Dwarf accelerator table names.
Eric Christopher9cd26af2013-09-20 23:22:52 +0000323// TODO: Determine whether or not we should add names for programs
324// that do not have a DW_AT_name or DW_AT_linkage_name field - this
325// is only slightly different than the lookup of non-standard ObjC names.
Eric Christopherd9843b32011-11-10 19:25:34 +0000326static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
327 DIE* Die) {
328 if (!SP.isDefinition()) return;
Eric Christopherd9843b32011-11-10 19:25:34 +0000329 TheCU->addAccelName(SP.getName(), Die);
330
331 // If the linkage name is different than the name, go ahead and output
332 // that as well into the name table.
333 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
334 TheCU->addAccelName(SP.getLinkageName(), Die);
335
336 // If this is an Objective-C selector name add it to the ObjC accelerator
337 // too.
338 if (isObjCClass(SP.getName())) {
339 StringRef Class, Category;
340 getObjCClassCategory(SP.getName(), Class, Category);
341 TheCU->addAccelObjC(Class, Die);
342 if (Category != "")
343 TheCU->addAccelObjC(Category, Die);
344 // Also add the base method name to the name table.
345 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
346 }
347}
348
Manman Ren3eb9dff2013-09-09 19:05:21 +0000349/// isSubprogramContext - Return true if Context is either a subprogram
350/// or another context nested inside a subprogram.
351bool DwarfDebug::isSubprogramContext(const MDNode *Context) {
352 if (!Context)
353 return false;
354 DIDescriptor D(Context);
355 if (D.isSubprogram())
356 return true;
357 if (D.isType())
Manman Ren116868e2013-09-09 19:47:11 +0000358 return isSubprogramContext(resolve(DIType(Context).getContext()));
Manman Ren3eb9dff2013-09-09 19:05:21 +0000359 return false;
360}
361
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000362// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
363// and DW_AT_high_pc attributes. If there are global variables in this
364// scope then create and insert DIEs for these variables.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000365DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
366 const MDNode *SPNode) {
Eric Christophere595bae2013-10-04 17:08:38 +0000367 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +0000368
Chris Lattner3a383cb2010-04-05 00:13:49 +0000369 assert(SPDie && "Unable to find subprogram DIE!");
370 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000371
Bill Wendlingf720bf62012-11-07 05:19:04 +0000372 // If we're updating an abstract DIE, then we will be adding the children and
373 // object pointer later on. But what we don't want to do is process the
374 // concrete DIE twice.
Manman Ren14a029d2013-03-12 18:27:15 +0000375 DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode);
376 if (AbsSPDIE) {
377 bool InSameCU = (AbsSPDIE->getCompileUnit() == SPCU->getCUDie());
Bill Wendlingf720bf62012-11-07 05:19:04 +0000378 // Pick up abstract subprogram DIE.
Devang Patela37a95e2010-07-07 22:20:57 +0000379 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Manman Ren14a029d2013-03-12 18:27:15 +0000380 // If AbsSPDIE belongs to a different CU, use DW_FORM_ref_addr instead of
381 // DW_FORM_ref4.
Devang Patelf20c4f72011-04-12 22:53:02 +0000382 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
Manman Ren14a029d2013-03-12 18:27:15 +0000383 InSameCU ? dwarf::DW_FORM_ref4 : dwarf::DW_FORM_ref_addr,
384 AbsSPDIE);
Devang Patela37a95e2010-07-07 22:20:57 +0000385 SPCU->addDie(SPDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000386 } else {
387 DISubprogram SPDecl = SP.getFunctionDeclaration();
388 if (!SPDecl.isSubprogram()) {
389 // There is not any need to generate specification DIE for a function
390 // defined at compile unit level. If a function is defined inside another
391 // function then gdb prefers the definition at top level and but does not
392 // expect specification DIE in parent function. So avoid creating
393 // specification DIE for a function defined inside a function.
394 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
395 !SP.getContext().isFile() &&
396 !isSubprogramContext(SP.getContext())) {
397 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
398
399 // Add arguments.
400 DICompositeType SPTy = SP.getType();
401 DIArray Args = SPTy.getTypeArray();
Eric Christopher31b05762013-08-08 01:41:00 +0000402 uint16_t SPTag = SPTy.getTag();
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000403 if (SPTag == dwarf::DW_TAG_subroutine_type)
404 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
405 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
406 DIType ATy = DIType(Args.getElement(i));
407 SPCU->addType(Arg, ATy);
408 if (ATy.isArtificial())
409 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
410 if (ATy.isObjectPointer())
411 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer,
412 dwarf::DW_FORM_ref4, Arg);
413 SPDie->addChild(Arg);
414 }
415 DIE *SPDeclDie = SPDie;
416 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Eric Christopher6a841382012-11-19 22:42:10 +0000417 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification,
418 dwarf::DW_FORM_ref4, SPDeclDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000419 SPCU->addDie(SPDie);
420 }
421 }
Devang Patela37a95e2010-07-07 22:20:57 +0000422 }
423
Eric Christopher962c9082013-01-15 23:56:56 +0000424 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc,
425 Asm->GetTempSymbol("func_begin",
426 Asm->getFunctionNumber()));
427 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
428 Asm->GetTempSymbol("func_end",
429 Asm->getFunctionNumber()));
Chris Lattner3a383cb2010-04-05 00:13:49 +0000430 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
431 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000432 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000433
Eric Christopherd9843b32011-11-10 19:25:34 +0000434 // Add name to the name table, we do this here because we're guaranteed
435 // to have concrete versions of our DW_TAG_subprogram nodes.
436 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher6a841382012-11-19 22:42:10 +0000437
Chris Lattner3a383cb2010-04-05 00:13:49 +0000438 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000439}
440
Manman Ren5b2f4b02013-09-11 19:40:28 +0000441/// Check whether we should create a DIE for the given Scope, return true
442/// if we don't create a DIE (the corresponding DIE is null).
Manman Ren2312ed32013-09-10 18:40:41 +0000443bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
444 if (Scope->isAbstractScope())
445 return false;
446
Manman Ren5b2f4b02013-09-11 19:40:28 +0000447 // We don't create a DIE if there is no Range.
Manman Ren2312ed32013-09-10 18:40:41 +0000448 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
449 if (Ranges.empty())
450 return true;
451
452 if (Ranges.size() > 1)
453 return false;
454
Manman Ren5b2f4b02013-09-11 19:40:28 +0000455 // We don't create a DIE if we have a single Range and the end label
456 // is null.
Manman Ren2312ed32013-09-10 18:40:41 +0000457 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
458 MCSymbol *End = getLabelAfterInsn(RI->second);
459 return !End;
460}
461
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000462// Construct new DW_TAG_lexical_block for this scope and attach
463// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher6a841382012-11-19 22:42:10 +0000464DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000465 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000466 if (isLexicalScopeDIENull(Scope))
467 return 0;
468
Devang Patel6c74a872010-04-27 19:46:33 +0000469 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
470 if (Scope->isAbstractScope())
471 return ScopeDIE;
472
Craig Topper977e9cd2013-07-03 04:24:43 +0000473 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Eric Christopherdc42ea82013-07-03 01:57:28 +0000474 // If we have multiple ranges, emit them into the range section.
Devang Patel6c74a872010-04-27 19:46:33 +0000475 if (Ranges.size() > 1) {
476 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000477 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +0000478 // DW_AT_ranges appropriately.
Devang Patelf20c4f72011-04-12 22:53:02 +0000479 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000480 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000481 * Asm->getDataLayout().getPointerSize());
Craig Topperd8e43652013-07-03 04:17:25 +0000482 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +0000483 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +0000484 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
485 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +0000486 }
Eric Christopherc1110832013-07-03 01:22:29 +0000487
488 // Terminate the range list.
Devang Patel6c74a872010-04-27 19:46:33 +0000489 DebugRangeSymbols.push_back(NULL);
490 DebugRangeSymbols.push_back(NULL);
491 return ScopeDIE;
492 }
493
Eric Christopherdc42ea82013-07-03 01:57:28 +0000494 // Construct the address range for this DIE.
Craig Topperd8e43652013-07-03 04:17:25 +0000495 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopher962c9082013-01-15 23:56:56 +0000496 MCSymbol *Start = getLabelBeforeInsn(RI->first);
497 MCSymbol *End = getLabelAfterInsn(RI->second);
Manman Ren2312ed32013-09-10 18:40:41 +0000498 assert(End && "End label should not be null!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000499
Chris Lattnere13c3722010-03-09 01:58:53 +0000500 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
501 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000502
Eric Christopher962c9082013-01-15 23:56:56 +0000503 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
504 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000505
506 return ScopeDIE;
507}
508
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000509// This scope represents inlined body of a function. Construct DIE to
510// represent this concrete inlined copy of the function.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000511DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
512 LexicalScope *Scope) {
Craig Topper977e9cd2013-07-03 04:24:43 +0000513 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000514 assert(Ranges.empty() == false &&
515 "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000516
Devang Patelf098ce22011-07-27 00:34:13 +0000517 if (!Scope->getScopeNode())
518 return NULL;
519 DIScope DS(Scope->getScopeNode());
520 DISubprogram InlinedSP = getDISubprogram(DS);
Eric Christophere595bae2013-10-04 17:08:38 +0000521 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patelf098ce22011-07-27 00:34:13 +0000522 if (!OriginDIE) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000523 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patelf098ce22011-07-27 00:34:13 +0000524 return NULL;
525 }
526
Devang Patel73bc1722011-05-05 17:54:26 +0000527 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Devang Patelf20c4f72011-04-12 22:53:02 +0000528 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Manman Ren4213c392013-05-29 17:16:59 +0000529 dwarf::DW_FORM_ref4, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000530
Devang Patelf098ce22011-07-27 00:34:13 +0000531 if (Ranges.size() > 1) {
532 // .debug_range section has not been laid out yet. Emit offset in
533 // .debug_range as a uint, size 4, for now. emitDIE will handle
534 // DW_AT_ranges appropriately.
535 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher6a841382012-11-19 22:42:10 +0000536 DebugRangeSymbols.size()
Chandler Carruth5da3f052012-11-01 09:14:31 +0000537 * Asm->getDataLayout().getPointerSize());
Craig Topperd8e43652013-07-03 04:17:25 +0000538 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patelf098ce22011-07-27 00:34:13 +0000539 RE = Ranges.end(); RI != RE; ++RI) {
540 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
541 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
542 }
543 DebugRangeSymbols.push_back(NULL);
544 DebugRangeSymbols.push_back(NULL);
545 } else {
Craig Topperd8e43652013-07-03 04:17:25 +0000546 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000547 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
548 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
549
550 if (StartLabel == 0 || EndLabel == 0)
551 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
552
553 assert(StartLabel->isDefined() &&
554 "Invalid starting label for an inlined scope!");
555 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
556
Eric Christopher962c9082013-01-15 23:56:56 +0000557 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
558 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patelf098ce22011-07-27 00:34:13 +0000559 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000560
561 InlinedSubprogramDIEs.insert(OriginDIE);
562
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000563 // Add the call site information to the DIE.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000564 DILocation DL(Scope->getInlinedAt());
Eric Christopher0925c622012-03-26 21:38:38 +0000565 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0,
Manman Ren1e427202013-03-07 01:42:00 +0000566 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
567 TheCU->getUniqueID()));
Devang Patelf20c4f72011-04-12 22:53:02 +0000568 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000569
Eric Christopher8dda5d02011-12-04 06:02:38 +0000570 // Add name to the name table, we do this here because we're guaranteed
571 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
572 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher6a841382012-11-19 22:42:10 +0000573
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000574 return ScopeDIE;
575}
576
Manman Ren2312ed32013-09-10 18:40:41 +0000577DIE *DwarfDebug::createScopeChildrenDIE(CompileUnit *TheCU, LexicalScope *Scope,
578 SmallVectorImpl<DIE*> &Children) {
579 DIE *ObjectPointer = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +0000580
581 // Collect arguments for current function.
Devang Patel7e623022011-08-10 20:55:27 +0000582 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000583 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
584 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher6a841382012-11-19 22:42:10 +0000585 if (DIE *Arg =
Eric Christophere3417762012-09-12 23:36:19 +0000586 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel6c622ef2011-03-01 22:58:55 +0000587 Children.push_back(Arg);
Eric Christophere3417762012-09-12 23:36:19 +0000588 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
589 }
Devang Patel6c622ef2011-03-01 22:58:55 +0000590
Eric Christopherf84354b2011-10-03 15:49:16 +0000591 // Collect lexical scope children first.
Craig Topper977e9cd2013-07-03 04:24:43 +0000592 const SmallVectorImpl<DbgVariable *> &Variables =ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000593 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher6a841382012-11-19 22:42:10 +0000594 if (DIE *Variable =
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000595 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000596 Children.push_back(Variable);
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000597 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
598 }
Craig Topper977e9cd2013-07-03 04:24:43 +0000599 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000600 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Patel3acc70e2011-08-15 22:04:40 +0000601 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000602 Children.push_back(Nested);
Manman Ren2312ed32013-09-10 18:40:41 +0000603 return ObjectPointer;
604}
605
606// Construct a DIE for this scope.
607DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
608 if (!Scope || !Scope->getScopeNode())
609 return NULL;
610
611 DIScope DS(Scope->getScopeNode());
612
613 SmallVector<DIE *, 8> Children;
614 DIE *ObjectPointer = NULL;
615 bool ChildrenCreated = false;
616
Manman Ren5b2f4b02013-09-11 19:40:28 +0000617 // We try to create the scope DIE first, then the children DIEs. This will
618 // avoid creating un-used children then removing them later when we find out
619 // the scope DIE is null.
Devang Patel3b548aa2010-03-08 20:52:55 +0000620 DIE *ScopeDIE = NULL;
621 if (Scope->getInlinedAt())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000622 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3b548aa2010-03-08 20:52:55 +0000623 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000624 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000625 if (Scope->isAbstractScope()) {
Eric Christophere595bae2013-10-04 17:08:38 +0000626 ScopeDIE = TheCU->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000627 // Note down abstract DIE.
628 if (ScopeDIE)
629 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
630 }
Devang Patel3b548aa2010-03-08 20:52:55 +0000631 else
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000632 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3b548aa2010-03-08 20:52:55 +0000633 }
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000634 else {
Manman Ren5b2f4b02013-09-11 19:40:28 +0000635 // Early exit when we know the scope DIE is going to be null.
Manman Ren2312ed32013-09-10 18:40:41 +0000636 if (isLexicalScopeDIENull(Scope))
637 return NULL;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000638
639 // We create children here when we know the scope DIE is not going to be
640 // null and the children will be added to the scope DIE.
Manman Ren2312ed32013-09-10 18:40:41 +0000641 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
642 ChildrenCreated = true;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000643
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000644 // There is no need to emit empty lexical block DIE.
David Blaikie684fc532013-05-06 23:33:07 +0000645 std::pair<ImportedEntityMap::const_iterator,
646 ImportedEntityMap::const_iterator> Range = std::equal_range(
647 ScopesWithImportedEntities.begin(), ScopesWithImportedEntities.end(),
Timur Iskhodzhanovec4afe62013-05-07 07:47:47 +0000648 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode*)0),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000649 less_first());
David Blaikie684fc532013-05-06 23:33:07 +0000650 if (Children.empty() && Range.first == Range.second)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000651 return NULL;
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000652 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Manman Ren2312ed32013-09-10 18:40:41 +0000653 assert(ScopeDIE && "Scope DIE should not be null.");
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000654 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
655 ++i)
David Blaikie4dd2de72013-05-08 06:01:38 +0000656 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000657 }
Eric Christopher6a841382012-11-19 22:42:10 +0000658
Benjamin Kramer892daba2013-08-24 11:55:49 +0000659 if (!ScopeDIE) {
Manman Ren2312ed32013-09-10 18:40:41 +0000660 assert(Children.empty() &&
661 "We create children only when the scope DIE is not null.");
Benjamin Kramer892daba2013-08-24 11:55:49 +0000662 return NULL;
663 }
Manman Ren2312ed32013-09-10 18:40:41 +0000664 if (!ChildrenCreated)
Manman Ren5b2f4b02013-09-11 19:40:28 +0000665 // We create children when the scope DIE is not null.
Manman Ren2312ed32013-09-10 18:40:41 +0000666 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000667
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000668 // Add children
Craig Topperd8e43652013-07-03 04:17:25 +0000669 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000670 E = Children.end(); I != E; ++I)
671 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000672
Eric Christophere3417762012-09-12 23:36:19 +0000673 if (DS.isSubprogram() && ObjectPointer != NULL)
674 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer,
675 dwarf::DW_FORM_ref4, ObjectPointer);
676
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000677 if (DS.isSubprogram())
Eric Christopherd9843b32011-11-10 19:25:34 +0000678 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000679
Eric Christopherd9843b32011-11-10 19:25:34 +0000680 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000681}
682
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000683// Look up the source id with the given directory and source file names.
684// If none currently exists, create a new id and insert it in the
685// SourceIds map. This can update DirectoryNames and SourceFileNames maps
686// as well.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000687unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Manman Ren1e427202013-03-07 01:42:00 +0000688 StringRef DirName, unsigned CUID) {
689 // If we use .loc in assembly, we can't separate .file entries according to
690 // compile units. Thus all files will belong to the default compile unit.
691 if (Asm->TM.hasMCUseLoc() &&
692 Asm->OutStreamer.getKind() == MCStreamer::SK_AsmStreamer)
693 CUID = 0;
694
Devang Patel871d0b12010-09-16 20:57:49 +0000695 // If FE did not provide a file name, then assume stdin.
696 if (FileName.empty())
Manman Ren1e427202013-03-07 01:42:00 +0000697 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patele01b75c2011-03-24 20:30:50 +0000698
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000699 // TODO: this might not belong here. See if we can factor this better.
700 if (DirName == CompilationDir)
701 DirName = "";
702
Manman Ren1e427202013-03-07 01:42:00 +0000703 // FileIDCUMap stores the current ID for the given compile unit.
704 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel871d0b12010-09-16 20:57:49 +0000705
Manman Ren1e427202013-03-07 01:42:00 +0000706 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer71b19732012-03-11 14:56:26 +0000707 SmallString<128> NamePair;
Manman Ren5b22f9f2013-04-06 01:02:38 +0000708 NamePair += utostr(CUID);
Manman Ren1e427202013-03-07 01:42:00 +0000709 NamePair += '\0';
Benjamin Kramer71b19732012-03-11 14:56:26 +0000710 NamePair += DirName;
711 NamePair += '\0'; // Zero bytes are not allowed in paths.
712 NamePair += FileName;
713
714 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
715 if (Ent.getValue() != SrcId)
716 return Ent.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +0000717
Manman Ren1e427202013-03-07 01:42:00 +0000718 FileIDCUMap[CUID] = SrcId;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000719 // Print out a .file directive to specify files for .loc directives.
Manman Ren1e427202013-03-07 01:42:00 +0000720 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendling2b128d72009-05-20 23:19:06 +0000721
722 return SrcId;
723}
724
Eric Christopher48fef592012-12-20 21:58:40 +0000725// Create new CompileUnit for the given metadata node with tag
726// DW_TAG_compile_unit.
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000727CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +0000728 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +0000729 StringRef FN = DIUnit.getFilename();
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000730 CompilationDir = DIUnit.getDirectory();
Bill Wendling2b128d72009-05-20 23:19:06 +0000731
732 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopherbfceb2f2013-08-26 23:50:38 +0000733 CompileUnit *NewCU =
734 new CompileUnit(GlobalCUIndexCount++, Die, N, Asm, this, &InfoHolder);
Manman Ren1e427202013-03-07 01:42:00 +0000735
736 FileIDCUMap[NewCU->getUniqueID()] = 0;
737 // Call this to emit a .file directive if it wasn't emitted for the source
738 // file this CU comes from yet.
739 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
740
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000741 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patelf20c4f72011-04-12 22:53:02 +0000742 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
743 DIUnit.getLanguage());
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000744 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christopher52ce7182013-04-09 19:23:15 +0000745
Eric Christopherb1b94512012-08-01 18:19:01 +0000746 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher52ce7182013-04-09 19:23:15 +0000747 // into an entity. We're using 0 (or a NULL label) for this. For
748 // split dwarf it's in the skeleton CU so omit it here.
749 if (!useSplitDwarf())
750 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
Manman Ren4e042a62013-02-05 21:52:47 +0000751
752 // Define start line table label for each Compile Unit.
753 MCSymbol *LineTableStartSym = Asm->GetTempSymbol("line_table_start",
754 NewCU->getUniqueID());
755 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
756 NewCU->getUniqueID());
757
Manman Ren9d4c7352013-05-21 00:57:22 +0000758 // Use a single line table if we are using .loc and generating assembly.
759 bool UseTheFirstCU =
760 (Asm->TM.hasMCUseLoc() &&
761 Asm->OutStreamer.getKind() == MCStreamer::SK_AsmStreamer) ||
762 (NewCU->getUniqueID() == 0);
763
Eric Christopher52ce7182013-04-09 19:23:15 +0000764 if (!useSplitDwarf()) {
Eric Christophera51d3fc2013-09-27 22:50:48 +0000765 // DW_AT_stmt_list is a offset of line number information for this
766 // compile unit in debug_line section. For split dwarf this is
767 // left in the skeleton CU and so not included.
768 // The line table entries are not always emitted in assembly, so it
769 // is not okay to use line_table_start here.
Eric Christopher52ce7182013-04-09 19:23:15 +0000770 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Carlo Kokbac096a2013-08-13 17:46:57 +0000771 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christophera51d3fc2013-09-27 22:50:48 +0000772 UseTheFirstCU ? Asm->GetTempSymbol("section_line")
773 : LineTableStartSym);
Manman Ren9d4c7352013-05-21 00:57:22 +0000774 else if (UseTheFirstCU)
Eric Christopher52ce7182013-04-09 19:23:15 +0000775 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
776 else
777 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
778 LineTableStartSym, DwarfLineSectionSym);
Eric Christophera51d3fc2013-09-27 22:50:48 +0000779
780 // If we're using split dwarf the compilation dir is going to be in the
781 // skeleton CU and so we don't need to duplicate it here.
782 if (!CompilationDir.empty())
783 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
784
Eric Christopher1d06eb52013-10-01 00:43:31 +0000785 // Flags to let the linker know we have emitted new style pubnames. Only
Eric Christophera51d3fc2013-09-27 22:50:48 +0000786 // emit it here if we don't have a skeleton CU for split dwarf.
Eric Christopher39eebfa2013-09-30 23:14:16 +0000787 if (GenerateGnuPubSections) {
788 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
789 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames,
790 dwarf::DW_FORM_sec_offset,
791 Asm->GetTempSymbol("gnu_pubnames",
792 NewCU->getUniqueID()));
793 else
794 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
795 Asm->GetTempSymbol("gnu_pubnames",
796 NewCU->getUniqueID()),
797 DwarfGnuPubNamesSectionSym);
798
799 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
800 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes,
801 dwarf::DW_FORM_sec_offset,
802 Asm->GetTempSymbol("gnu_pubtypes",
803 NewCU->getUniqueID()));
804 else
805 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopherf976c772013-10-03 17:41:16 +0000806 Asm->GetTempSymbol("gnu_pubtypes",
Eric Christopher39eebfa2013-09-30 23:14:16 +0000807 NewCU->getUniqueID()),
808 DwarfGnuPubTypesSectionSym);
809 }
Eric Christopher52ce7182013-04-09 19:23:15 +0000810 }
Bill Wendling2b128d72009-05-20 23:19:06 +0000811
Bill Wendling2b128d72009-05-20 23:19:06 +0000812 if (DIUnit.isOptimized())
Eric Christopherbb69a272012-08-24 01:14:27 +0000813 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendling2b128d72009-05-20 23:19:06 +0000814
Devang Patel2d9caf92009-11-25 17:36:49 +0000815 StringRef Flags = DIUnit.getFlags();
816 if (!Flags.empty())
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000817 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher6a841382012-11-19 22:42:10 +0000818
Nick Lewycky479a8fe2011-10-17 23:27:36 +0000819 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patelf20c4f72011-04-12 22:53:02 +0000820 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +0000821 dwarf::DW_FORM_data1, RVer);
822
Devang Patel1a0df9a2010-05-10 22:49:55 +0000823 if (!FirstCU)
824 FirstCU = NewCU;
Eric Christopher7a2cdf72013-02-05 07:31:55 +0000825
Eric Christopherc8a310e2012-12-10 23:34:43 +0000826 InfoHolder.addUnit(NewCU);
827
Devang Patel1a0df9a2010-05-10 22:49:55 +0000828 CUMap.insert(std::make_pair(N, NewCU));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000829 return NewCU;
Devang Patel1a0df9a2010-05-10 22:49:55 +0000830}
831
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000832// Construct subprogram DIE.
Eric Christopher6a841382012-11-19 22:42:10 +0000833void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
Devang Patel1f4f98d2011-08-15 23:36:40 +0000834 const MDNode *N) {
Rafael Espindola6cf4e832011-11-04 19:00:29 +0000835 CompileUnit *&CURef = SPMap[N];
836 if (CURef)
837 return;
838 CURef = TheCU;
839
Devang Patel80ae3492009-08-28 23:24:31 +0000840 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000841 if (!SP.isDefinition())
842 // This is a method declaration which will be handled while constructing
843 // class type.
Devang Patel0751a282009-06-26 01:49:18 +0000844 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000845
Devang Patel89543712011-08-15 17:24:54 +0000846 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000847
Eric Christopherba506db2013-09-09 20:03:20 +0000848 // Expose as a global name.
849 TheCU->addGlobalName(SP.getName(), SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +0000850}
851
David Blaikie1fd43652013-05-07 21:35:53 +0000852void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikief55abea2013-04-22 06:12:31 +0000853 const MDNode *N) {
David Blaikie1fd43652013-05-07 21:35:53 +0000854 DIImportedEntity Module(N);
David Blaikief55abea2013-04-22 06:12:31 +0000855 if (!Module.Verify())
856 return;
David Blaikie684fc532013-05-06 23:33:07 +0000857 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
David Blaikie4dd2de72013-05-08 06:01:38 +0000858 constructImportedEntityDIE(TheCU, Module, D);
David Blaikie684fc532013-05-06 23:33:07 +0000859}
860
David Blaikie4dd2de72013-05-08 06:01:38 +0000861void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
David Blaikie684fc532013-05-06 23:33:07 +0000862 DIE *Context) {
David Blaikie1fd43652013-05-07 21:35:53 +0000863 DIImportedEntity Module(N);
David Blaikie684fc532013-05-06 23:33:07 +0000864 if (!Module.Verify())
865 return;
David Blaikie4dd2de72013-05-08 06:01:38 +0000866 return constructImportedEntityDIE(TheCU, Module, Context);
David Blaikie684fc532013-05-06 23:33:07 +0000867}
868
David Blaikie4dd2de72013-05-08 06:01:38 +0000869void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikie1fd43652013-05-07 21:35:53 +0000870 const DIImportedEntity &Module,
David Blaikie684fc532013-05-06 23:33:07 +0000871 DIE *Context) {
872 assert(Module.Verify() &&
873 "Use one of the MDNode * overloads to handle invalid metadata");
874 assert(Context && "Should always have a context for an imported_module");
David Blaikie1fd43652013-05-07 21:35:53 +0000875 DIE *IMDie = new DIE(Module.getTag());
David Blaikief55abea2013-04-22 06:12:31 +0000876 TheCU->insertDIE(Module, IMDie);
David Blaikie1fd43652013-05-07 21:35:53 +0000877 DIE *EntityDie;
878 DIDescriptor Entity = Module.getEntity();
879 if (Entity.isNameSpace())
880 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
881 else if (Entity.isSubprogram())
882 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
David Blaikie3b6038b2013-05-08 06:01:41 +0000883 else if (Entity.isType())
884 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
David Blaikie1fd43652013-05-07 21:35:53 +0000885 else
David Blaikie3b6038b2013-05-08 06:01:41 +0000886 EntityDie = TheCU->getDIE(Entity);
David Blaikief55abea2013-04-22 06:12:31 +0000887 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
888 Module.getContext().getDirectory(),
889 TheCU->getUniqueID());
890 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, 0, FileID);
891 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, 0, Module.getLineNumber());
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000892 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, dwarf::DW_FORM_ref4,
893 EntityDie);
David Blaikiee63d5d12013-05-20 22:50:35 +0000894 StringRef Name = Module.getName();
895 if (!Name.empty())
896 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
David Blaikie684fc532013-05-06 23:33:07 +0000897 Context->addChild(IMDie);
David Blaikief55abea2013-04-22 06:12:31 +0000898}
899
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000900// Emit all Dwarf sections that should come prior to the content. Create
901// global DIEs and emit initial debug info sections. This is invoked by
902// the target AsmPrinter.
Eric Christopher58f41952012-11-19 22:42:15 +0000903void DwarfDebug::beginModule() {
Devang Patel6c74a872010-04-27 19:46:33 +0000904 if (DisableDebugInfoPrinting)
905 return;
906
Eric Christopher58f41952012-11-19 22:42:15 +0000907 const Module *M = MMI->getModule();
908
Nick Lewycky019d2552011-07-29 03:49:23 +0000909 // If module has named metadata anchors then use them, otherwise scan the
910 // module using debug info finder to collect debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000911 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
David Blaikiedc69ebb2013-03-11 23:39:23 +0000912 if (!CU_Nodes)
Devang Patel07bb9ee2011-08-15 23:47:24 +0000913 return;
Manman Ren60352032013-09-05 18:48:31 +0000914 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
Devang Patele02e5852011-05-03 16:45:22 +0000915
David Blaikiedc69ebb2013-03-11 23:39:23 +0000916 // Emit initial sections so we can reference labels later.
917 emitSectionLabels();
918
919 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
920 DICompileUnit CUNode(CU_Nodes->getOperand(i));
921 CompileUnit *CU = constructCompileUnit(CUNode);
David Blaikie1fd43652013-05-07 21:35:53 +0000922 DIArray ImportedEntities = CUNode.getImportedEntities();
923 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
David Blaikie684fc532013-05-06 23:33:07 +0000924 ScopesWithImportedEntities.push_back(std::make_pair(
David Blaikie1fd43652013-05-07 21:35:53 +0000925 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
926 ImportedEntities.getElement(i)));
David Blaikie684fc532013-05-06 23:33:07 +0000927 std::sort(ScopesWithImportedEntities.begin(),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000928 ScopesWithImportedEntities.end(), less_first());
David Blaikiedc69ebb2013-03-11 23:39:23 +0000929 DIArray GVs = CUNode.getGlobalVariables();
930 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
931 CU->createGlobalVariableDIE(GVs.getElement(i));
932 DIArray SPs = CUNode.getSubprograms();
933 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
934 constructSubprogramDIE(CU, SPs.getElement(i));
935 DIArray EnumTypes = CUNode.getEnumTypes();
936 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
937 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
938 DIArray RetainedTypes = CUNode.getRetainedTypes();
939 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
940 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
David Blaikief55abea2013-04-22 06:12:31 +0000941 // Emit imported_modules last so that the relevant context is already
942 // available.
David Blaikie1fd43652013-05-07 21:35:53 +0000943 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
944 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
David Blaikiedc69ebb2013-03-11 23:39:23 +0000945 }
Eric Christopher6a841382012-11-19 22:42:10 +0000946
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000947 // Tell MMI that we have debug info.
948 MMI->setDebugInfoAvailability(true);
Eric Christopher6a841382012-11-19 22:42:10 +0000949
Bill Wendling2b128d72009-05-20 23:19:06 +0000950 // Prime section data.
Richard Mitton21101b32013-09-19 23:21:01 +0000951 SectionMap[Asm->getObjFileLowering().getTextSection()];
Bill Wendling2b128d72009-05-20 23:19:06 +0000952}
953
Eric Christopher960ac372012-11-22 00:59:49 +0000954// Attach DW_AT_inline attribute with inlined subprogram DIEs.
955void DwarfDebug::computeInlinedDIEs() {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000956 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
957 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000958 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000959 DIE *ISP = *AI;
Devang Patelf20c4f72011-04-12 22:53:02 +0000960 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000961 }
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000962 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopher735401c2012-11-27 00:13:51 +0000963 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000964 DIE *ISP = AI->second;
965 if (InlinedSubprogramDIEs.count(ISP))
966 continue;
967 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
968 }
Eric Christopher960ac372012-11-22 00:59:49 +0000969}
970
971// Collect info for variables that were optimized out.
972void DwarfDebug::collectDeadVariables() {
973 const Module *M = MMI->getModule();
974 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
975
976 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
977 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
978 DICompileUnit TheCU(CU_Nodes->getOperand(i));
979 DIArray Subprograms = TheCU.getSubprograms();
980 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopher735401c2012-11-27 00:13:51 +0000981 DISubprogram SP(Subprograms.getElement(i));
982 if (ProcessedSPNodes.count(SP) != 0) continue;
Manman Ren7504ed42013-07-08 18:33:29 +0000983 if (!SP.isSubprogram()) continue;
Eric Christopher735401c2012-11-27 00:13:51 +0000984 if (!SP.isDefinition()) continue;
985 DIArray Variables = SP.getVariables();
986 if (Variables.getNumElements() == 0) continue;
Eric Christopher960ac372012-11-22 00:59:49 +0000987
Eric Christopher735401c2012-11-27 00:13:51 +0000988 LexicalScope *Scope =
989 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
990 DeadFnScopeMap[SP] = Scope;
Eric Christopher960ac372012-11-22 00:59:49 +0000991
Eric Christopher735401c2012-11-27 00:13:51 +0000992 // Construct subprogram DIE and add variables DIEs.
993 CompileUnit *SPCU = CUMap.lookup(TheCU);
994 assert(SPCU && "Unable to find Compile Unit!");
995 constructSubprogramDIE(SPCU, SP);
Eric Christophere595bae2013-10-04 17:08:38 +0000996 DIE *ScopeDIE = SPCU->getDIE(SP);
Eric Christopher735401c2012-11-27 00:13:51 +0000997 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
998 DIVariable DV(Variables.getElement(vi));
Manman Ren7504ed42013-07-08 18:33:29 +0000999 if (!DV.isVariable()) continue;
Eric Christophere595bae2013-10-04 17:08:38 +00001000 DbgVariable NewVar(DV, NULL);
Eric Christopher735401c2012-11-27 00:13:51 +00001001 if (DIE *VariableDIE =
Chandler Carruth2a1c0d22013-07-27 11:09:58 +00001002 SPCU->constructVariableDIE(&NewVar, Scope->isAbstractScope()))
Eric Christopher735401c2012-11-27 00:13:51 +00001003 ScopeDIE->addChild(VariableDIE);
1004 }
Eric Christopher960ac372012-11-22 00:59:49 +00001005 }
1006 }
1007 }
1008 DeleteContainerSeconds(DeadFnScopeMap);
1009}
1010
Eric Christopher45731982013-08-08 23:45:55 +00001011// Type Signature [7.27] and ODR Hash code.
Eric Christopher67646432013-07-26 17:02:41 +00001012
1013/// \brief Grabs the string in whichever attribute is passed in and returns
Eric Christopher8552e222013-08-07 01:18:33 +00001014/// a reference to it. Returns "" if the attribute doesn't exist.
Eric Christopher67646432013-07-26 17:02:41 +00001015static StringRef getDIEStringAttr(DIE *Die, unsigned Attr) {
Eric Christopher8552e222013-08-07 01:18:33 +00001016 DIEValue *V = Die->findAttribute(Attr);
Eric Christopher67646432013-07-26 17:02:41 +00001017
Eric Christopher8552e222013-08-07 01:18:33 +00001018 if (DIEString *S = dyn_cast_or_null<DIEString>(V))
1019 return S->getString();
1020
Eric Christopher67646432013-07-26 17:02:41 +00001021 return StringRef("");
1022}
1023
Eric Christopher67646432013-07-26 17:02:41 +00001024/// Return true if the current DIE is contained within an anonymous namespace.
1025static bool isContainedInAnonNamespace(DIE *Die) {
1026 DIE *Parent = Die->getParent();
1027
1028 while (Parent) {
Eric Christophere414ece2013-07-29 23:53:08 +00001029 if (Parent->getTag() == dwarf::DW_TAG_namespace &&
1030 getDIEStringAttr(Parent, dwarf::DW_AT_name) == "")
Eric Christopher67646432013-07-26 17:02:41 +00001031 return true;
1032 Parent = Parent->getParent();
1033 }
1034
1035 return false;
1036}
1037
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001038/// Test if the current CU language is C++ and that we have
1039/// a named type that is not contained in an anonymous namespace.
1040static bool shouldAddODRHash(CompileUnit *CU, DIE *Die) {
Eric Christopher341770d2013-08-07 08:35:10 +00001041 return CU->getLanguage() == dwarf::DW_LANG_C_plus_plus &&
1042 getDIEStringAttr(Die, dwarf::DW_AT_name) != "" &&
1043 !isContainedInAnonNamespace(Die);
Eric Christopher45731982013-08-08 23:45:55 +00001044}
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001045
Eric Christopher960ac372012-11-22 00:59:49 +00001046void DwarfDebug::finalizeModuleInfo() {
1047 // Collect info for variables that were optimized out.
1048 collectDeadVariables();
1049
1050 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1051 computeInlinedDIEs();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001052
Eric Christopherf8542ec2013-07-29 22:24:32 +00001053 // Split out type units and conditionally add an ODR tag to the split
1054 // out type.
Eric Christopher67646432013-07-26 17:02:41 +00001055 // FIXME: Do type splitting.
1056 for (unsigned i = 0, e = TypeUnits.size(); i != e; ++i) {
Eric Christopher67646432013-07-26 17:02:41 +00001057 DIE *Die = TypeUnits[i];
Eric Christopher45731982013-08-08 23:45:55 +00001058 DIEHash Hash;
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001059 // If we've requested ODR hashes and it's applicable for an ODR hash then
1060 // add the ODR signature now.
Eric Christopher45731982013-08-08 23:45:55 +00001061 // FIXME: This should be added onto the type unit, not the type, but this
1062 // works as an intermediate stage.
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001063 if (GenerateODRHash && shouldAddODRHash(CUMap.begin()->second, Die))
Eric Christopher45731982013-08-08 23:45:55 +00001064 CUMap.begin()->second->addUInt(Die, dwarf::DW_AT_GNU_odr_signature,
1065 dwarf::DW_FORM_data8,
1066 Hash.computeDIEODRSignature(Die));
Eric Christopher67646432013-07-26 17:02:41 +00001067 }
1068
Eric Christopher60eb7692013-08-12 20:27:48 +00001069 // Handle anything that needs to be done on a per-cu basis.
1070 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
1071 CUE = CUMap.end();
1072 CUI != CUE; ++CUI) {
1073 CompileUnit *TheCU = CUI->second;
1074 // Emit DW_AT_containing_type attribute to connect types with their
1075 // vtable holding type.
1076 TheCU->constructContainingTypeDIEs();
1077
1078 // If we're splitting the dwarf out now that we've got the entire
1079 // CU then construct a skeleton CU based upon it.
1080 if (useSplitDwarf()) {
Eric Christopherd29614f2013-08-13 01:21:55 +00001081 uint64_t ID = 0;
1082 if (GenerateCUHash) {
1083 DIEHash CUHash;
1084 ID = CUHash.computeCUSignature(TheCU->getCUDie());
1085 }
Eric Christopher60eb7692013-08-12 20:27:48 +00001086 // This should be a unique identifier when we want to build .dwp files.
1087 TheCU->addUInt(TheCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopherd29614f2013-08-13 01:21:55 +00001088 dwarf::DW_FORM_data8, ID);
Eric Christopher60eb7692013-08-12 20:27:48 +00001089 // Now construct the skeleton CU associated.
Eric Christopher6fdf3242013-08-26 23:50:43 +00001090 CompileUnit *SkCU = constructSkeletonCU(TheCU);
Eric Christopher60eb7692013-08-12 20:27:48 +00001091 // This should be a unique identifier when we want to build .dwp files.
1092 SkCU->addUInt(SkCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopherd29614f2013-08-13 01:21:55 +00001093 dwarf::DW_FORM_data8, ID);
Eric Christopher60eb7692013-08-12 20:27:48 +00001094 }
1095 }
1096
1097 // Compute DIE offsets and sizes.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001098 InfoHolder.computeSizeAndOffsets();
1099 if (useSplitDwarf())
1100 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher960ac372012-11-22 00:59:49 +00001101}
1102
1103void DwarfDebug::endSections() {
Richard Mitton21101b32013-09-19 23:21:01 +00001104 // Filter labels by section.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001105 for (size_t n = 0; n < ArangeLabels.size(); n++) {
1106 const SymbolCU &SCU = ArangeLabels[n];
Richard Mitton21101b32013-09-19 23:21:01 +00001107 if (SCU.Sym->isInSection()) {
1108 // Make a note of this symbol and it's section.
1109 const MCSection *Section = &SCU.Sym->getSection();
1110 if (!Section->getKind().isMetadata())
1111 SectionMap[Section].push_back(SCU);
1112 } else {
1113 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1114 // appear in the output. This sucks as we rely on sections to build
1115 // arange spans. We can do it without, but it's icky.
1116 SectionMap[NULL].push_back(SCU);
1117 }
1118 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001119
Richard Mittonc2508242013-10-03 22:07:08 +00001120 // Build a list of sections used.
1121 std::vector<const MCSection *> Sections;
Richard Mitton21101b32013-09-19 23:21:01 +00001122 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1123 it++) {
1124 const MCSection *Section = it->first;
Richard Mittonc2508242013-10-03 22:07:08 +00001125 Sections.push_back(Section);
1126 }
1127
1128 // Sort the sections into order.
1129 // This is only done to ensure consistent output order across different runs.
1130 std::sort(Sections.begin(), Sections.end(), SectionSort);
1131
1132 // Add terminating symbols for each section.
1133 for (unsigned ID=0;ID<Sections.size();ID++) {
1134 const MCSection *Section = Sections[ID];
Richard Mitton21101b32013-09-19 23:21:01 +00001135 MCSymbol *Sym = NULL;
1136
1137 if (Section) {
Richard Mittonc2508242013-10-03 22:07:08 +00001138 // We can't call MCSection::getLabelEndName, as it's only safe to do so
1139 // if we know the section name up-front. For user-created sections, the resulting
1140 // label may not be valid to use as a label. (section names can use a greater
1141 // set of characters on some systems)
1142 Sym = Asm->GetTempSymbol("debug_end", ID);
Richard Mitton21101b32013-09-19 23:21:01 +00001143 Asm->OutStreamer.SwitchSection(Section);
1144 Asm->OutStreamer.EmitLabel(Sym);
1145 }
1146
1147 // Insert a final terminator.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001148 SectionMap[Section].push_back(SymbolCU(NULL, Sym));
Bill Wendling2b128d72009-05-20 23:19:06 +00001149 }
Eric Christopher960ac372012-11-22 00:59:49 +00001150}
Bill Wendling2b128d72009-05-20 23:19:06 +00001151
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001152// Emit all Dwarf sections that should come after the content.
Eric Christopher960ac372012-11-22 00:59:49 +00001153void DwarfDebug::endModule() {
1154
1155 if (!FirstCU) return;
1156
1157 // End any existing sections.
1158 // TODO: Does this need to happen?
1159 endSections();
1160
1161 // Finalize the debug info for the module.
1162 finalizeModuleInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001163
Eric Christophercdf218d2012-12-10 19:51:21 +00001164 if (!useSplitDwarf()) {
Eric Christopher9cd26af2013-09-20 23:22:52 +00001165 emitDebugStr();
1166
Eric Christopher95198f502012-11-27 22:43:42 +00001167 // Emit all the DIEs into a debug info section.
1168 emitDebugInfo();
Eric Christopher4c9b1192012-11-27 00:41:54 +00001169
Eric Christopher95198f502012-11-27 22:43:42 +00001170 // Corresponding abbreviations into a abbrev section.
1171 emitAbbreviations();
1172
1173 // Emit info into a debug loc section.
1174 emitDebugLoc();
1175
1176 // Emit info into a debug aranges section.
1177 emitDebugARanges();
1178
1179 // Emit info into a debug ranges section.
1180 emitDebugRanges();
1181
1182 // Emit info into a debug macinfo section.
1183 emitDebugMacInfo();
1184
Eric Christopher95198f502012-11-27 22:43:42 +00001185 } else {
Eric Christopherd692c1d2012-12-11 19:42:09 +00001186 // TODO: Fill this in for separated debug sections and separate
Eric Christopher95198f502012-11-27 22:43:42 +00001187 // out information into new sections.
Eric Christopher9cd26af2013-09-20 23:22:52 +00001188 emitDebugStr();
1189 if (useSplitDwarf())
1190 emitDebugStrDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001191
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001192 // Emit the debug info section and compile units.
Eric Christopher95198f502012-11-27 22:43:42 +00001193 emitDebugInfo();
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001194 emitDebugInfoDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001195
1196 // Corresponding abbreviations into a abbrev section.
1197 emitAbbreviations();
Eric Christopher3c5a1912012-12-19 22:02:53 +00001198 emitDebugAbbrevDWO();
Eric Christopher95198f502012-11-27 22:43:42 +00001199
1200 // Emit info into a debug loc section.
1201 emitDebugLoc();
1202
1203 // Emit info into a debug aranges section.
1204 emitDebugARanges();
1205
1206 // Emit info into a debug ranges section.
1207 emitDebugRanges();
1208
1209 // Emit info into a debug macinfo section.
1210 emitDebugMacInfo();
1211
Eric Christopher962c9082013-01-15 23:56:56 +00001212 // Emit DWO addresses.
1213 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1214
Eric Christopher95198f502012-11-27 22:43:42 +00001215 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001216
Eric Christophera876b822012-08-23 07:32:06 +00001217 // Emit info into the dwarf accelerator table sections.
Eric Christopher20b76a72012-08-23 22:36:40 +00001218 if (useDwarfAccelTables()) {
Eric Christopher4996c702011-11-07 09:24:32 +00001219 emitAccelNames();
1220 emitAccelObjC();
1221 emitAccelNamespaces();
1222 emitAccelTypes();
1223 }
Eric Christopher6a841382012-11-19 22:42:10 +00001224
Eric Christopher4b358182013-08-30 00:40:17 +00001225 // Emit the pubnames and pubtypes sections if requested.
1226 if (HasDwarfPubSections) {
David Blaikie70a33202013-09-19 17:33:35 +00001227 emitDebugPubNames(GenerateGnuPubSections);
1228 emitDebugPubTypes(GenerateGnuPubSections);
Eric Christopher4b358182013-08-30 00:40:17 +00001229 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001230
Devang Pateld0701282010-08-02 17:32:15 +00001231 // clean up.
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001232 SPMap.clear();
Devang Patel1a0df9a2010-05-10 22:49:55 +00001233 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1234 E = CUMap.end(); I != E; ++I)
1235 delete I->second;
Eric Christopher8afd7b62012-12-10 19:51:18 +00001236
Craig Topperd8e43652013-07-03 04:17:25 +00001237 for (SmallVectorImpl<CompileUnit *>::iterator I = SkeletonCUs.begin(),
Eric Christopher5b33b3c2013-02-06 21:53:56 +00001238 E = SkeletonCUs.end(); I != E; ++I)
1239 delete *I;
Eric Christopher8afd7b62012-12-10 19:51:18 +00001240
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001241 // Reset these for the next Module if we have one.
1242 FirstCU = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001243}
1244
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001245// Find abstract variable, if any, associated with Var.
Devang Patelbb23a4a2011-08-10 21:50:54 +00001246DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattner915c5f92010-04-02 19:42:39 +00001247 DebugLoc ScopeLoc) {
Devang Patelbb23a4a2011-08-10 21:50:54 +00001248 LLVMContext &Ctx = DV->getContext();
1249 // More then one inlined variable corresponds to one abstract variable.
1250 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001251 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001252 if (AbsDbgVariable)
1253 return AbsDbgVariable;
1254
Devang Patel7e623022011-08-10 20:55:27 +00001255 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001256 if (!Scope)
1257 return NULL;
1258
Eric Christophere595bae2013-10-04 17:08:38 +00001259 AbsDbgVariable = new DbgVariable(Var, NULL);
Devang Patel7e623022011-08-10 20:55:27 +00001260 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001261 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001262 return AbsDbgVariable;
1263}
1264
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001265// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel6c622ef2011-03-01 22:58:55 +00001266bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patel7e623022011-08-10 20:55:27 +00001267 DbgVariable *Var, LexicalScope *Scope) {
1268 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +00001269 return false;
1270 DIVariable DV = Var->getVariable();
1271 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1272 return false;
1273 unsigned ArgNo = DV.getArgNumber();
Eric Christopher6a841382012-11-19 22:42:10 +00001274 if (ArgNo == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001275 return false;
1276
Devang Patel4ab660b2011-03-03 20:02:02 +00001277 size_t Size = CurrentFnArguments.size();
1278 if (Size == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001279 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001280 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001281 // arguments does the function have at source level.
1282 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001283 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001284 CurrentFnArguments[ArgNo - 1] = Var;
1285 return true;
1286}
1287
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001288// Collect variable information from side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001289void
Nick Lewycky019d2552011-07-29 03:49:23 +00001290DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patel490c8ab2010-05-20 19:57:06 +00001291 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001292 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1293 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1294 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001295 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001296 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001297 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001298 DIVariable DV(Var);
1299 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001300
Devang Patel7e623022011-08-10 20:55:27 +00001301 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001302
Devang Patelcdb7d442009-11-10 23:20:04 +00001303 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001304 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001305 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001306
Devang Patele1c53f22010-05-20 16:36:41 +00001307 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Eric Christophere595bae2013-10-04 17:08:38 +00001308 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable);
Devang Patel3e4a9652011-08-15 21:24:36 +00001309 RegVar->setFrameIndex(VP.first);
Devang Patel6c622ef2011-03-01 22:58:55 +00001310 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001311 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001312 if (AbsDbgVariable)
Devang Patel3e4a9652011-08-15 21:24:36 +00001313 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patel475d32a2009-10-06 01:26:37 +00001314 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001315}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001316
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001317// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1318// defined reg.
Devang Patel9fc11702010-05-25 23:40:22 +00001319static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001320 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001321 return MI->getNumOperands() == 3 &&
1322 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
Adrian Prantl418d1d12013-07-09 20:28:37 +00001323 (MI->getOperand(1).isImm() ||
1324 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
Devang Patel9fc11702010-05-25 23:40:22 +00001325}
1326
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001327// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher6a841382012-11-19 22:42:10 +00001328static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1329 const MCSymbol *FLabel,
Devang Patel2442a892011-07-08 17:09:57 +00001330 const MCSymbol *SLabel,
1331 const MachineInstr *MI) {
1332 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1333
David Blaikie0252265b2013-06-16 20:34:15 +00001334 assert(MI->getNumOperands() == 3);
Adrian Prantl418d1d12013-07-09 20:28:37 +00001335 if (MI->getOperand(0).isReg()) {
Devang Patel2442a892011-07-08 17:09:57 +00001336 MachineLocation MLoc;
Adrian Prantl418d1d12013-07-09 20:28:37 +00001337 // If the second operand is an immediate, this is a
1338 // register-indirect address.
1339 if (!MI->getOperand(1).isImm())
Adrian Prantld4c0dd42013-04-26 21:57:17 +00001340 MLoc.set(MI->getOperand(0).getReg());
1341 else
1342 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel2442a892011-07-08 17:09:57 +00001343 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1344 }
1345 if (MI->getOperand(0).isImm())
1346 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1347 if (MI->getOperand(0).isFPImm())
1348 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1349 if (MI->getOperand(0).isCImm())
1350 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1351
Craig Topperee4dab52012-02-05 08:31:47 +00001352 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel2442a892011-07-08 17:09:57 +00001353}
1354
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001355// Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001356void
Devang Patel5c0f85c2010-06-25 22:07:34 +00001357DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1358 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001359
Eric Christopher270a12c2013-07-03 21:37:03 +00001360 // Grab the variable info that was squirreled away in the MMI side-table.
Devang Patel490c8ab2010-05-20 19:57:06 +00001361 collectVariableInfoFromMMITable(MF, Processed);
1362
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001363 for (SmallVectorImpl<const MDNode*>::const_iterator
1364 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1365 ++UVI) {
1366 const MDNode *Var = *UVI;
1367 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001368 continue;
1369
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001370 // History contains relevant DBG_VALUE instructions for Var and instructions
1371 // clobbering it.
1372 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1373 if (History.empty())
1374 continue;
1375 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001376
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001377 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001378 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001379 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1380 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +00001381 Scope = LScopes.getCurrentFunctionScope();
David Blaikiedc69ebb2013-03-11 23:39:23 +00001382 else if (MDNode *IA = DV.getInlinedAt())
1383 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1384 else
1385 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel490c8ab2010-05-20 19:57:06 +00001386 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001387 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001388 continue;
1389
1390 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001391 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel99819b52011-08-15 19:01:20 +00001392 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
Eric Christophere595bae2013-10-04 17:08:38 +00001393 DbgVariable *RegVar = new DbgVariable(DV, AbsVar);
Devang Patel6c622ef2011-03-01 22:58:55 +00001394 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001395 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001396 if (AbsVar)
Devang Patel3e4a9652011-08-15 21:24:36 +00001397 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001398
Eric Christophercc10d202012-10-08 20:48:54 +00001399 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001400 if (History.size() <= 1 || (History.size() == 2 &&
1401 MInsn->isIdenticalTo(History.back()))) {
Devang Patel3e4a9652011-08-15 21:24:36 +00001402 RegVar->setMInsn(MInsn);
Devang Patel9fc11702010-05-25 23:40:22 +00001403 continue;
1404 }
1405
Eric Christopher59cc0712013-01-28 17:33:26 +00001406 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001407 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001408
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001409 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1410 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1411 const MachineInstr *Begin = *HI;
1412 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001413
Devang Patele7181b52011-06-01 23:00:17 +00001414 // Check if DBG_VALUE is truncating a range.
1415 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1416 && !Begin->getOperand(0).getReg())
1417 continue;
1418
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001419 // Compute the range for a register location.
1420 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1421 const MCSymbol *SLabel = 0;
1422
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001423 if (HI + 1 == HE)
1424 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001425 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001426 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001427 else {
1428 const MachineInstr *End = HI[1];
Eric Christopher6a841382012-11-19 22:42:10 +00001429 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel53b050a2011-07-07 21:44:42 +00001430 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001431 if (End->isDebugValue())
1432 SLabel = getLabelBeforeInsn(End);
1433 else {
1434 // End is a normal instruction clobbering the range.
1435 SLabel = getLabelAfterInsn(End);
1436 assert(SLabel && "Forgot label after clobber instruction");
1437 ++HI;
1438 }
1439 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001440
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001441 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopher365d0832011-12-16 23:42:31 +00001442 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1443 Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001444 }
1445 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001446 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001447
1448 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001449 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1450 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1451 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1452 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001453 if (!DV || !DV.isVariable() || !Processed.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001454 continue;
1455 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
Eric Christophere595bae2013-10-04 17:08:38 +00001456 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patele0a94bf2010-05-14 21:01:35 +00001457 }
Devang Patel9fc11702010-05-25 23:40:22 +00001458}
Devang Patele0a94bf2010-05-14 21:01:35 +00001459
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001460// Return Label preceding the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001461MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001462 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1463 assert(Label && "Didn't insert label before instruction");
1464 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001465}
1466
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001467// Return Label immediately following the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001468MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001469 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001470}
1471
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001472// Process beginning of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001473void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001474 // Check if source location changes, but ignore DBG_VALUE locations.
1475 if (!MI->isDebugValue()) {
1476 DebugLoc DL = MI->getDebugLoc();
1477 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopheraec8a822012-04-05 20:39:05 +00001478 unsigned Flags = 0;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001479 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001480 if (DL == PrologEndLoc) {
1481 Flags |= DWARF2_FLAG_PROLOGUE_END;
1482 PrologEndLoc = DebugLoc();
1483 }
Eric Christopheraec8a822012-04-05 20:39:05 +00001484 if (PrologEndLoc.isUnknown())
1485 Flags |= DWARF2_FLAG_IS_STMT;
1486
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001487 if (!DL.isUnknown()) {
1488 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001489 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001490 } else
Devang Patel34a66202011-05-11 19:22:19 +00001491 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001492 }
Devang Patel9fc11702010-05-25 23:40:22 +00001493 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001494
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001495 // Insert labels where requested.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001496 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1497 LabelsBeforeInsn.find(MI);
1498
1499 // No label needed.
1500 if (I == LabelsBeforeInsn.end())
1501 return;
1502
1503 // Label already assigned.
1504 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001505 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001506
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001507 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001508 PrevLabel = MMI->getContext().CreateTempSymbol();
1509 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001510 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001511 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001512}
1513
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001514// Process end of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001515void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001516 // Don't create a new label after DBG_VALUE instructions.
1517 // They don't generate code.
1518 if (!MI->isDebugValue())
1519 PrevLabel = 0;
1520
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001521 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1522 LabelsAfterInsn.find(MI);
1523
1524 // No label needed.
1525 if (I == LabelsAfterInsn.end())
1526 return;
1527
1528 // Label already assigned.
1529 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001530 return;
1531
1532 // We need a label after this instruction.
1533 if (!PrevLabel) {
1534 PrevLabel = MMI->getContext().CreateTempSymbol();
1535 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001536 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001537 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001538}
1539
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001540// Each LexicalScope has first instruction and last instruction to mark
1541// beginning and end of a scope respectively. Create an inverse map that list
1542// scopes starts (and ends) with an instruction. One instruction may start (or
1543// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001544void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001545 SmallVector<LexicalScope *, 4> WorkList;
1546 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001547 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001548 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001549
Craig Topper977e9cd2013-07-03 04:24:43 +00001550 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001551 if (!Children.empty())
Craig Topperd8e43652013-07-03 04:17:25 +00001552 for (SmallVectorImpl<LexicalScope *>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00001553 SE = Children.end(); SI != SE; ++SI)
1554 WorkList.push_back(*SI);
1555
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001556 if (S->isAbstractScope())
1557 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001558
Craig Topper977e9cd2013-07-03 04:24:43 +00001559 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001560 if (Ranges.empty())
1561 continue;
Craig Topperd8e43652013-07-03 04:17:25 +00001562 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +00001563 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001564 assert(RI->first && "InsnRange does not have first instruction!");
1565 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001566 requestLabelBeforeInsn(RI->first);
1567 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001568 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001569 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001570}
1571
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001572// Get MDNode for DebugLoc's scope.
Devang Patel589845d2011-05-09 22:14:49 +00001573static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1574 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1575 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1576 return DL.getScope(Ctx);
1577}
1578
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001579// Walk up the scope chain of given debug loc and find line number info
1580// for the function.
Devang Patel34a66202011-05-11 19:22:19 +00001581static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1582 const MDNode *Scope = getScopeNode(DL, Ctx);
1583 DISubprogram SP = getDISubprogram(Scope);
Manman Ren7504ed42013-07-08 18:33:29 +00001584 if (SP.isSubprogram()) {
Eric Christopher34164192012-04-03 00:43:49 +00001585 // Check for number of operands since the compatibility is
1586 // cheap here.
Eric Christopherb81e2b42012-04-03 17:55:42 +00001587 if (SP->getNumOperands() > 19)
Eric Christopher34164192012-04-03 00:43:49 +00001588 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1589 else
1590 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1591 }
1592
Devang Patel34a66202011-05-11 19:22:19 +00001593 return DebugLoc();
1594}
1595
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001596// Gather pre-function debug information. Assumes being called immediately
1597// after the function entry point has been emitted.
Chris Lattner76555b52010-01-26 23:18:02 +00001598void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00001599 if (!MMI->hasDebugInfo()) return;
Devang Patel7e623022011-08-10 20:55:27 +00001600 LScopes.initialize(*MF);
1601 if (LScopes.empty()) return;
1602 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001603
Manman Ren4e042a62013-02-05 21:52:47 +00001604 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1605 // belongs to.
1606 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1607 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1608 assert(TheCU && "Unable to find compile unit!");
Manman Ren9d4c7352013-05-21 00:57:22 +00001609 if (Asm->TM.hasMCUseLoc() &&
1610 Asm->OutStreamer.getKind() == MCStreamer::SK_AsmStreamer)
1611 // Use a single line table if we are using .loc and generating assembly.
1612 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1613 else
1614 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
Manman Ren4e042a62013-02-05 21:52:47 +00001615
Devang Patel6c74a872010-04-27 19:46:33 +00001616 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1617 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001618 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001619 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001620
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001621 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1622
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001623 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001624 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001625 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1626
Devang Patel002d54d2010-05-26 19:37:24 +00001627 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001628 I != E; ++I) {
1629 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001630 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1631 II != IE; ++II) {
1632 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001633
Devang Patel002d54d2010-05-26 19:37:24 +00001634 if (MI->isDebugValue()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001635 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001636
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001637 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001638 const MDNode *Var =
1639 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001640
1641 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001642 if (isDbgValueInDefinedReg(MI))
1643 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1644
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001645 // Check the history of this variable.
1646 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1647 if (History.empty()) {
1648 UserVariables.push_back(Var);
1649 // The first mention of a function argument gets the FunctionBeginSym
1650 // label, so arguments are visible when breaking at function entry.
1651 DIVariable DV(Var);
Manman Ren7504ed42013-07-08 18:33:29 +00001652 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001653 DISubprogram(getDISubprogram(DV.getContext()))
1654 .describes(MF->getFunction()))
1655 LabelsBeforeInsn[MI] = FunctionBeginSym;
1656 } else {
1657 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1658 const MachineInstr *Prev = History.back();
1659 if (Prev->isDebugValue()) {
1660 // Coalesce identical entries at the end of History.
1661 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001662 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher85a495e2012-10-08 20:48:49 +00001663 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher6a841382012-11-19 22:42:10 +00001664 << "\t" << *Prev
Devang Patelb7a328e2011-07-07 00:14:27 +00001665 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001666 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001667 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001668
1669 // Terminate old register assignments that don't reach MI;
1670 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1671 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1672 isDbgValueInDefinedReg(Prev)) {
1673 // Previous register assignment needs to terminate at the end of
1674 // its basic block.
1675 MachineBasicBlock::const_iterator LastMI =
1676 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001677 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001678 // Drop DBG_VALUE for empty range.
Eric Christopher85a495e2012-10-08 20:48:49 +00001679 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patelb7a328e2011-07-07 00:14:27 +00001680 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001681 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001682 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001683 // Terminate after LastMI.
1684 History.push_back(LastMI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001685 }
1686 }
1687 }
1688 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001689 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001690 // Not a DBG_VALUE instruction.
1691 if (!MI->isLabel())
1692 AtBlockEntry = false;
1693
Eric Christopher133195782012-10-04 20:46:14 +00001694 // First known non-DBG_VALUE and non-frame setup location marks
1695 // the beginning of the function body.
1696 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1697 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel34a66202011-05-11 19:22:19 +00001698 PrologEndLoc = MI->getDebugLoc();
1699
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001700 // Check if the instruction clobbers any registers with debug vars.
1701 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1702 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1703 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1704 continue;
Jakob Stoklund Olesen54038d72012-06-01 23:28:30 +00001705 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1706 AI.isValid(); ++AI) {
1707 unsigned Reg = *AI;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001708 const MDNode *Var = LiveUserVar[Reg];
1709 if (!Var)
1710 continue;
1711 // Reg is now clobbered.
1712 LiveUserVar[Reg] = 0;
1713
1714 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001715 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1716 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001717 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001718 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1719 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001720 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001721 const MachineInstr *Prev = History.back();
1722 // Sanity-check: Register assignments are terminated at the end of
1723 // their block.
1724 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1725 continue;
1726 // Is the variable still in Reg?
1727 if (!isDbgValueInDefinedReg(Prev) ||
1728 Prev->getOperand(0).getReg() != Reg)
1729 continue;
1730 // Var is clobbered. Make sure the next instruction gets a label.
1731 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001732 }
1733 }
Devang Patel002d54d2010-05-26 19:37:24 +00001734 }
Devang Patel002d54d2010-05-26 19:37:24 +00001735 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001736 }
1737
1738 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1739 I != E; ++I) {
1740 SmallVectorImpl<const MachineInstr*> &History = I->second;
1741 if (History.empty())
1742 continue;
1743
1744 // Make sure the final register assignments are terminated.
1745 const MachineInstr *Prev = History.back();
1746 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1747 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher6a841382012-11-19 22:42:10 +00001748 MachineBasicBlock::const_iterator LastMI =
Devang Patel784077e2011-08-10 23:58:09 +00001749 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001750 if (LastMI == PrevMBB->end())
1751 // Drop DBG_VALUE for empty range.
1752 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001753 else if (PrevMBB != &PrevMBB->getParent()->back()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001754 // Terminate after LastMI.
1755 History.push_back(LastMI);
1756 }
1757 }
1758 // Request labels for the full history.
1759 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1760 const MachineInstr *MI = History[i];
1761 if (MI->isDebugValue())
1762 requestLabelBeforeInsn(MI);
1763 else
1764 requestLabelAfterInsn(MI);
1765 }
1766 }
Devang Patel002d54d2010-05-26 19:37:24 +00001767
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001768 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001769 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001770
1771 // Record beginning of function.
1772 if (!PrologEndLoc.isUnknown()) {
1773 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1774 MF->getFunction()->getContext());
1775 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1776 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie67cb31e2012-12-04 22:02:33 +00001777 // We'd like to list the prologue as "not statements" but GDB behaves
1778 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikie5a773bb2012-12-04 21:05:36 +00001779 DWARF2_FLAG_IS_STMT);
Devang Patel34a66202011-05-11 19:22:19 +00001780 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001781}
1782
Devang Patel7e623022011-08-10 20:55:27 +00001783void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
David Blaikie6f1a8062013-06-05 05:39:59 +00001784 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1785 DIVariable DV = Var->getVariable();
David Blaikie36d5d2f2013-06-06 21:04:51 +00001786 // Variables with positive arg numbers are parameters.
1787 if (unsigned ArgNum = DV.getArgNumber()) {
1788 // Keep all parameters in order at the start of the variable list to ensure
1789 // function types are correct (no out-of-order parameters)
1790 //
1791 // This could be improved by only doing it for optimized builds (unoptimized
1792 // builds have the right order to begin with), searching from the back (this
1793 // would catch the unoptimized case quickly), or doing a binary search
1794 // rather than linear search.
1795 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1796 while (I != Vars.end()) {
1797 unsigned CurNum = (*I)->getVariable().getArgNumber();
1798 // A local (non-parameter) variable has been found, insert immediately
1799 // before it.
1800 if (CurNum == 0)
1801 break;
1802 // A later indexed parameter has been found, insert immediately before it.
David Blaikieb272a752013-06-06 22:28:26 +00001803 if (CurNum > ArgNum)
David Blaikie36d5d2f2013-06-06 21:04:51 +00001804 break;
David Blaikieb272a752013-06-06 22:28:26 +00001805 ++I;
David Blaikie6f1a8062013-06-05 05:39:59 +00001806 }
David Blaikie36d5d2f2013-06-06 21:04:51 +00001807 Vars.insert(I, Var);
1808 return;
David Blaikie6f1a8062013-06-05 05:39:59 +00001809 }
1810
1811 Vars.push_back(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001812}
1813
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001814// Gather and emit post-function debug information.
Chris Lattner76555b52010-01-26 23:18:02 +00001815void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patel7e623022011-08-10 20:55:27 +00001816 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00001817
Devang Patel7e623022011-08-10 20:55:27 +00001818 // Define end label for subprogram.
1819 FunctionEndSym = Asm->GetTempSymbol("func_end",
1820 Asm->getFunctionNumber());
1821 // Assumes in correct section after the entry point.
1822 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Manman Ren4e042a62013-02-05 21:52:47 +00001823 // Set DwarfCompileUnitID in MCContext to default value.
1824 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher6a841382012-11-19 22:42:10 +00001825
Devang Patel7e623022011-08-10 20:55:27 +00001826 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1827 collectVariableInfo(MF, ProcessedVars);
Eric Christopher6a841382012-11-19 22:42:10 +00001828
Devang Patel3acc70e2011-08-15 22:04:40 +00001829 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001830 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001831 assert(TheCU && "Unable to find compile unit!");
Devang Patel3acc70e2011-08-15 22:04:40 +00001832
Devang Patel7e623022011-08-10 20:55:27 +00001833 // Construct abstract scopes.
Devang Patel44403472011-08-12 18:10:19 +00001834 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1835 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1836 LexicalScope *AScope = AList[i];
1837 DISubprogram SP(AScope->getScopeNode());
Manman Ren7504ed42013-07-08 18:33:29 +00001838 if (SP.isSubprogram()) {
Devang Patel7e623022011-08-10 20:55:27 +00001839 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001840 DIArray Variables = SP.getVariables();
1841 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1842 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001843 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001844 continue;
Alexey Samsonov39602782012-07-06 08:45:08 +00001845 // Check that DbgVariable for DV wasn't created earlier, when
1846 // findAbstractVariable() was called for inlined instance of DV.
1847 LLVMContext &Ctx = DV->getContext();
1848 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1849 if (AbstractVariables.lookup(CleanDV))
1850 continue;
Devang Patel59e27c52011-08-19 23:28:12 +00001851 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
Eric Christophere595bae2013-10-04 17:08:38 +00001852 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001853 }
1854 }
Devang Patel44403472011-08-12 18:10:19 +00001855 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Manman Ren4213c392013-05-29 17:16:59 +00001856 constructScopeDIE(TheCU, AScope);
Bill Wendling2b128d72009-05-20 23:19:06 +00001857 }
Eric Christopher6a841382012-11-19 22:42:10 +00001858
Devang Patel3acc70e2011-08-15 22:04:40 +00001859 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher6a841382012-11-19 22:42:10 +00001860
Nick Lewycky50f02cb2011-12-02 22:16:29 +00001861 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopherbb69a272012-08-24 01:14:27 +00001862 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Patel3acc70e2011-08-15 22:04:40 +00001863
Bill Wendling2b128d72009-05-20 23:19:06 +00001864 // Clear debug info
Craig Topper2b4a2012013-07-03 04:40:27 +00001865 for (ScopeVariablesMap::iterator
Devang Patel7e623022011-08-10 20:55:27 +00001866 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1867 DeleteContainerPointers(I->second);
1868 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001869 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001870 UserVariables.clear();
1871 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001872 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001873 LabelsBeforeInsn.clear();
1874 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001875 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001876}
1877
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001878// Register a source line with debug info. Returns the unique label that was
1879// emitted and which provides correspondence to the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00001880void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1881 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00001882 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00001883 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00001884 unsigned Src = 1;
1885 if (S) {
1886 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00001887
Dan Gohman50849c62010-05-05 23:41:32 +00001888 if (Scope.isCompileUnit()) {
1889 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001890 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001891 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00001892 } else if (Scope.isFile()) {
1893 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00001894 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001895 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001896 } else if (Scope.isSubprogram()) {
1897 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001898 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001899 Dir = SP.getDirectory();
Eric Christopher6647b832011-10-11 22:59:11 +00001900 } else if (Scope.isLexicalBlockFile()) {
1901 DILexicalBlockFile DBF(S);
1902 Fn = DBF.getFilename();
1903 Dir = DBF.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001904 } else if (Scope.isLexicalBlock()) {
1905 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001906 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001907 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001908 } else
Craig Topperee4dab52012-02-05 08:31:47 +00001909 llvm_unreachable("Unexpected scope info");
Dan Gohman50849c62010-05-05 23:41:32 +00001910
Manman Ren1e427202013-03-07 01:42:00 +00001911 Src = getOrCreateSourceID(Fn, Dir,
1912 Asm->OutStreamer.getContext().getDwarfCompileUnitID());
Dan Gohman50849c62010-05-05 23:41:32 +00001913 }
Nick Lewycky019d2552011-07-29 03:49:23 +00001914 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00001915}
1916
Bill Wendling806535f2009-05-20 23:22:40 +00001917//===----------------------------------------------------------------------===//
1918// Emit Methods
1919//===----------------------------------------------------------------------===//
1920
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001921// Compute the size and offset of a DIE.
Jim Grosbach00e9c612009-11-22 19:20:36 +00001922unsigned
Eric Christopherc8a310e2012-12-10 23:34:43 +00001923DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling480ff322009-05-20 23:21:38 +00001924 // Get the children.
1925 const std::vector<DIE *> &Children = Die->getChildren();
1926
Bill Wendling480ff322009-05-20 23:21:38 +00001927 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00001928 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00001929
1930 // Get the abbreviation for this DIE.
1931 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopherc8a310e2012-12-10 23:34:43 +00001932 const DIEAbbrev *Abbrev = Abbreviations->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00001933
1934 // Set DIE offset
1935 Die->setOffset(Offset);
1936
1937 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00001938 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001939
Eric Christopher4887c8f2013-03-29 23:34:06 +00001940 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1941 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling480ff322009-05-20 23:21:38 +00001942
1943 // Size the DIE attribute values.
1944 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1945 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001946 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001947
1948 // Size the DIE children if any.
1949 if (!Children.empty()) {
1950 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1951 "Children flag not set");
1952
1953 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001954 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling480ff322009-05-20 23:21:38 +00001955
1956 // End of children marker.
1957 Offset += sizeof(int8_t);
1958 }
1959
1960 Die->setSize(Offset - Die->getOffset());
1961 return Offset;
1962}
1963
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001964// Compute the size and offset of all the DIEs.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001965void DwarfUnits::computeSizeAndOffsets() {
Manman Ren14a029d2013-03-12 18:27:15 +00001966 // Offset from the beginning of debug info section.
Eric Christopherd1c5a312013-05-30 00:43:35 +00001967 unsigned SecOffset = 0;
Eric Christopher4887c8f2013-03-29 23:34:06 +00001968 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christopherc8a310e2012-12-10 23:34:43 +00001969 E = CUs.end(); I != E; ++I) {
Eric Christopherd1c5a312013-05-30 00:43:35 +00001970 (*I)->setDebugInfoOffset(SecOffset);
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)
1976
Manman Ren14a029d2013-03-12 18:27:15 +00001977 unsigned EndOffset = computeSizeAndOffset((*I)->getCUDie(), Offset);
Eric Christopherd1c5a312013-05-30 00:43:35 +00001978 SecOffset += EndOffset;
Devang Patel1a0df9a2010-05-10 22:49:55 +00001979 }
Bill Wendling480ff322009-05-20 23:21:38 +00001980}
1981
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001982// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001983void DwarfDebug::emitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001984 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001985
Bill Wendling480ff322009-05-20 23:21:38 +00001986 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001987 DwarfInfoSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001988 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001989 DwarfAbbrevSectionSym =
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001990 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher3c5a1912012-12-19 22:02:53 +00001991 if (useSplitDwarf())
1992 DwarfAbbrevDWOSectionSym =
1993 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1994 "section_abbrev_dwo");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001995 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001996
Chris Lattner6629ca92010-04-04 22:59:04 +00001997 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001998 emitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00001999
Eric Christopher74804332013-02-07 21:19:50 +00002000 DwarfLineSectionSym =
2001 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002002 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Eric Christopher261d2342013-09-23 20:55:35 +00002003 if (GenerateGnuPubSections) {
Eric Christopher39eebfa2013-09-30 23:14:16 +00002004 DwarfGnuPubNamesSectionSym =
2005 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
2006 DwarfGnuPubTypesSectionSym =
2007 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
Eric Christopher261d2342013-09-23 20:55:35 +00002008 } else if (HasDwarfPubSections) {
2009 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2010 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Michael Gottesmanc89466f2013-09-04 04:39:38 +00002011 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002012
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002013 DwarfStrSectionSym =
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002014 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002015 if (useSplitDwarf()) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002016 DwarfStrDWOSectionSym =
2017 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002018 DwarfAddrSectionSym =
2019 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
2020 }
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002021 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patel12563b32010-04-16 23:33:45 +00002022 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00002023
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002024 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patel9fc11702010-05-25 23:40:22 +00002025 "section_debug_loc");
2026
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002027 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
2028 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002029}
2030
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002031// Recursively emits a debug information entry.
Eric Christopher3c5a1912012-12-19 22:02:53 +00002032void DwarfDebug::emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs) {
Bill Wendling480ff322009-05-20 23:21:38 +00002033 // Get the abbreviation for this DIE.
2034 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher3c5a1912012-12-19 22:02:53 +00002035 const DIEAbbrev *Abbrev = Abbrevs->at(AbbrevNumber - 1);
Bill Wendling480ff322009-05-20 23:21:38 +00002036
Bill Wendling480ff322009-05-20 23:21:38 +00002037 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00002038 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00002039 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2040 Twine::utohexstr(Die->getOffset()) + ":0x" +
2041 Twine::utohexstr(Die->getSize()) + " " +
2042 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00002043 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00002044
Eric Christopher4887c8f2013-03-29 23:34:06 +00002045 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
2046 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
Bill Wendling480ff322009-05-20 23:21:38 +00002047
2048 // Emit the DIE attribute values.
2049 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2050 unsigned Attr = AbbrevData[i].getAttribute();
2051 unsigned Form = AbbrevData[i].getForm();
2052 assert(Form && "Too many attributes for DIE (check abbreviation)");
2053
Chris Lattner7bde8c02010-04-04 18:52:31 +00002054 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00002055 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002056
Bill Wendling480ff322009-05-20 23:21:38 +00002057 switch (Attr) {
Eric Christophere595bae2013-10-04 17:08:38 +00002058 case dwarf::DW_AT_abstract_origin: {
Bill Wendling480ff322009-05-20 23:21:38 +00002059 DIEEntry *E = cast<DIEEntry>(Values[i]);
2060 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002061 unsigned Addr = Origin->getOffset();
Manman Ren14a029d2013-03-12 18:27:15 +00002062 if (Form == dwarf::DW_FORM_ref_addr) {
2063 // For DW_FORM_ref_addr, output the offset from beginning of debug info
2064 // section. Origin->getOffset() returns the offset from start of the
2065 // compile unit.
2066 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2067 Addr += Holder.getCUOffset(Origin->getCompileUnit());
2068 }
Manman Renac8062b2013-07-02 23:40:10 +00002069 Asm->OutStreamer.EmitIntValue(Addr,
2070 Form == dwarf::DW_FORM_ref_addr ? DIEEntry::getRefAddrSize(Asm) : 4);
Bill Wendling480ff322009-05-20 23:21:38 +00002071 break;
2072 }
Devang Patel12563b32010-04-16 23:33:45 +00002073 case dwarf::DW_AT_ranges: {
2074 // DW_AT_range Value encodes offset in debug_range section.
2075 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00002076
Nick Lewycky33da3362012-06-22 01:25:12 +00002077 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelda3ef852010-09-02 16:43:44 +00002078 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
2079 V->getValue(),
2080 4);
2081 } else {
2082 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
2083 V->getValue(),
2084 DwarfDebugRangeSectionSym,
2085 4);
2086 }
Devang Patel12563b32010-04-16 23:33:45 +00002087 break;
2088 }
Devang Patel9fc11702010-05-25 23:40:22 +00002089 case dwarf::DW_AT_location: {
Nick Lewycky33da3362012-06-22 01:25:12 +00002090 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2091 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002092 Asm->EmitLabelReference(L->getValue(), 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002093 else
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002094 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002095 } else {
Devang Patel9fc11702010-05-25 23:40:22 +00002096 Values[i]->EmitValue(Asm, Form);
Nick Lewycky33da3362012-06-22 01:25:12 +00002097 }
Devang Patel9fc11702010-05-25 23:40:22 +00002098 break;
2099 }
Devang Patela1bd5a12010-09-29 19:08:08 +00002100 case dwarf::DW_AT_accessibility: {
2101 if (Asm->isVerbose()) {
2102 DIEInteger *V = cast<DIEInteger>(Values[i]);
2103 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2104 }
2105 Values[i]->EmitValue(Asm, Form);
2106 break;
2107 }
Bill Wendling480ff322009-05-20 23:21:38 +00002108 default:
2109 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002110 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00002111 break;
2112 }
Bill Wendling480ff322009-05-20 23:21:38 +00002113 }
2114
2115 // Emit the DIE children if any.
2116 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2117 const std::vector<DIE *> &Children = Die->getChildren();
2118
2119 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher3c5a1912012-12-19 22:02:53 +00002120 emitDIE(Children[j], Abbrevs);
Bill Wendling480ff322009-05-20 23:21:38 +00002121
Chris Lattner7bde8c02010-04-04 18:52:31 +00002122 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00002123 Asm->OutStreamer.AddComment("End Of Children Mark");
2124 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00002125 }
2126}
2127
Eric Christophera2de8262012-12-15 00:04:07 +00002128// Emit the various dwarf units to the unit section USection with
2129// the abbreviations going into ASection.
2130void DwarfUnits::emitUnits(DwarfDebug *DD,
2131 const MCSection *USection,
2132 const MCSection *ASection,
2133 const MCSymbol *ASectionSym) {
2134 Asm->OutStreamer.SwitchSection(USection);
Eric Christopher4887c8f2013-03-29 23:34:06 +00002135 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
Eric Christophera2de8262012-12-15 00:04:07 +00002136 E = CUs.end(); I != E; ++I) {
2137 CompileUnit *TheCU = *I;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002138 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002139
Devang Patel1a0df9a2010-05-10 22:49:55 +00002140 // Emit the compile units header.
Eric Christophera2de8262012-12-15 00:04:07 +00002141 Asm->OutStreamer
2142 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
2143 TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002144
Devang Patel1a0df9a2010-05-10 22:49:55 +00002145 // Emit size of content not including length itself
2146 unsigned ContentSize = Die->getSize() +
2147 sizeof(int16_t) + // DWARF version number
2148 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patele141234942011-04-13 19:41:17 +00002149 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002150
Devang Patel1a0df9a2010-05-10 22:49:55 +00002151 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2152 Asm->EmitInt32(ContentSize);
2153 Asm->OutStreamer.AddComment("DWARF version number");
Manman Renac8062b2013-07-02 23:40:10 +00002154 Asm->EmitInt16(DD->getDwarfVersion());
Devang Patel1a0df9a2010-05-10 22:49:55 +00002155 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
Eric Christophera2de8262012-12-15 00:04:07 +00002156 Asm->EmitSectionOffset(Asm->GetTempSymbol(ASection->getLabelBeginName()),
2157 ASectionSym);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002158 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002159 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002160
Eric Christopher3c5a1912012-12-19 22:02:53 +00002161 DD->emitDIE(Die, Abbreviations);
Eric Christophera2de8262012-12-15 00:04:07 +00002162 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
Eli Benderskyb42d1462012-12-03 18:45:45 +00002163 TheCU->getUniqueID()));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002164 }
Bill Wendling480ff322009-05-20 23:21:38 +00002165}
2166
Manman Ren14a029d2013-03-12 18:27:15 +00002167/// For a given compile unit DIE, returns offset from beginning of debug info.
2168unsigned DwarfUnits::getCUOffset(DIE *Die) {
Manman Ren11fec382013-03-13 18:41:27 +00002169 assert(Die->getTag() == dwarf::DW_TAG_compile_unit &&
2170 "Input DIE should be compile unit in getCUOffset.");
Eric Christopherd25f7fc2013-08-08 01:41:05 +00002171 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(), E = CUs.end();
2172 I != E; ++I) {
Manman Ren14a029d2013-03-12 18:27:15 +00002173 CompileUnit *TheCU = *I;
2174 if (TheCU->getCUDie() == Die)
2175 return TheCU->getDebugInfoOffset();
2176 }
Manman Ren11fec382013-03-13 18:41:27 +00002177 llvm_unreachable("The compile unit DIE should belong to CUs in DwarfUnits.");
Manman Ren14a029d2013-03-12 18:27:15 +00002178}
2179
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002180// Emit the debug info section.
2181void DwarfDebug::emitDebugInfo() {
Eric Christophera2de8262012-12-15 00:04:07 +00002182 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2183
2184 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
2185 Asm->getObjFileLowering().getDwarfAbbrevSection(),
2186 DwarfAbbrevSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002187}
2188
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002189// Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +00002190void DwarfDebug::emitAbbreviations() {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002191 if (!useSplitDwarf())
2192 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
2193 &Abbreviations);
2194 else
2195 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2196}
Bill Wendling480ff322009-05-20 23:21:38 +00002197
Eric Christopher3c5a1912012-12-19 22:02:53 +00002198void DwarfDebug::emitAbbrevs(const MCSection *Section,
2199 std::vector<DIEAbbrev *> *Abbrevs) {
2200 // Check to see if it is worth the effort.
2201 if (!Abbrevs->empty()) {
2202 // Start the debug abbrev section.
2203 Asm->OutStreamer.SwitchSection(Section);
2204
2205 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
Eric Christopher996b2b72012-12-13 03:00:38 +00002206 Asm->OutStreamer.EmitLabel(Begin);
Bill Wendling480ff322009-05-20 23:21:38 +00002207
2208 // For each abbrevation.
Eric Christopher3c5a1912012-12-19 22:02:53 +00002209 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
Bill Wendling480ff322009-05-20 23:21:38 +00002210 // Get abbreviation data
Eric Christopher3c5a1912012-12-19 22:02:53 +00002211 const DIEAbbrev *Abbrev = Abbrevs->at(i);
Bill Wendling480ff322009-05-20 23:21:38 +00002212
2213 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00002214 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00002215
2216 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002217 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00002218 }
2219
2220 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00002221 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00002222
Eric Christopher3c5a1912012-12-19 22:02:53 +00002223 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
Eric Christopher996b2b72012-12-13 03:00:38 +00002224 Asm->OutStreamer.EmitLabel(End);
Bill Wendling480ff322009-05-20 23:21:38 +00002225 }
2226}
2227
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002228// Emit the last address of the section and the end of the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +00002229void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00002230 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00002231 Asm->OutStreamer.AddComment("Extended Op");
2232 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002233
Chris Lattner566cae92010-03-09 23:52:58 +00002234 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002235 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00002236 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2237 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2238
2239 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002240
Chris Lattnera179b522010-04-04 19:25:43 +00002241 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Eric Christopherce0cfce2013-01-09 01:35:34 +00002242 Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002243
2244 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00002245 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2246 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002247 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00002248 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002249}
2250
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002251// Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00002252void DwarfDebug::emitAccelNames() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002253 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002254 dwarf::DW_FORM_data4));
2255 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2256 E = CUMap.end(); I != E; ++I) {
2257 CompileUnit *TheCU = I->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00002258 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2259 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002260 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002261 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002262 const std::vector<DIE *> &Entities = GI->second;
Eric Christopherd9843b32011-11-10 19:25:34 +00002263 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2264 DE = Entities.end(); DI != DE; ++DI)
2265 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00002266 }
2267 }
2268
2269 AT.FinalizeTable(Asm, "Names");
2270 Asm->OutStreamer.SwitchSection(
2271 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2272 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2273 Asm->OutStreamer.EmitLabel(SectionBegin);
2274
2275 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002276 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002277}
2278
Eric Christopher48fef592012-12-20 21:58:40 +00002279// Emit objective C classes and categories into a hashed accelerator table
2280// section.
Eric Christopher4996c702011-11-07 09:24:32 +00002281void DwarfDebug::emitAccelObjC() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002282 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002283 dwarf::DW_FORM_data4));
2284 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2285 E = CUMap.end(); I != E; ++I) {
2286 CompileUnit *TheCU = I->second;
2287 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2288 for (StringMap<std::vector<DIE*> >::const_iterator
2289 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002290 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002291 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher4996c702011-11-07 09:24:32 +00002292 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2293 DE = Entities.end(); DI != DE; ++DI)
2294 AT.AddName(Name, (*DI));
2295 }
2296 }
2297
2298 AT.FinalizeTable(Asm, "ObjC");
2299 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2300 .getDwarfAccelObjCSection());
2301 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2302 Asm->OutStreamer.EmitLabel(SectionBegin);
2303
2304 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002305 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002306}
2307
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002308// Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002309void DwarfDebug::emitAccelNamespaces() {
Eric Christophercf7289f2013-09-05 18:20:16 +00002310 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher4996c702011-11-07 09:24:32 +00002311 dwarf::DW_FORM_data4));
2312 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2313 E = CUMap.end(); I != E; ++I) {
2314 CompileUnit *TheCU = I->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00002315 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2316 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002317 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002318 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002319 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher66b37db2011-11-10 21:47:55 +00002320 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2321 DE = Entities.end(); DI != DE; ++DI)
2322 AT.AddName(Name, (*DI));
Eric Christopher4996c702011-11-07 09:24:32 +00002323 }
2324 }
2325
2326 AT.FinalizeTable(Asm, "namespac");
2327 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2328 .getDwarfAccelNamespaceSection());
2329 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2330 Asm->OutStreamer.EmitLabel(SectionBegin);
2331
2332 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002333 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002334}
2335
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002336// Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002337void DwarfDebug::emitAccelTypes() {
Eric Christopher21bde872012-01-06 04:35:23 +00002338 std::vector<DwarfAccelTable::Atom> Atoms;
Eric Christophercf7289f2013-09-05 18:20:16 +00002339 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
Eric Christopher21bde872012-01-06 04:35:23 +00002340 dwarf::DW_FORM_data4));
Eric Christophercf7289f2013-09-05 18:20:16 +00002341 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag,
Eric Christopher21bde872012-01-06 04:35:23 +00002342 dwarf::DW_FORM_data2));
Eric Christophercf7289f2013-09-05 18:20:16 +00002343 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags,
Eric Christopher21bde872012-01-06 04:35:23 +00002344 dwarf::DW_FORM_data1));
2345 DwarfAccelTable AT(Atoms);
Eric Christopher4996c702011-11-07 09:24:32 +00002346 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2347 E = CUMap.end(); I != E; ++I) {
2348 CompileUnit *TheCU = I->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002349 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2350 = TheCU->getAccelTypes();
2351 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher4996c702011-11-07 09:24:32 +00002352 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002353 StringRef Name = GI->getKey();
Eric Christopher090fcc12012-01-06 23:03:34 +00002354 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopher21bde872012-01-06 04:35:23 +00002355 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2356 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2357 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher4996c702011-11-07 09:24:32 +00002358 }
2359 }
2360
2361 AT.FinalizeTable(Asm, "types");
2362 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2363 .getDwarfAccelTypesSection());
2364 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2365 Asm->OutStreamer.EmitLabel(SectionBegin);
2366
2367 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002368 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002369}
2370
Eric Christopherdd1a0122013-09-13 00:35:05 +00002371// Public name handling.
2372// The format for the various pubnames:
2373//
2374// dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2375// for the DIE that is named.
2376//
2377// gnu pubnames - offset/index value/name tuples where the offset is the offset
2378// into the CU and the index value is computed according to the type of value
2379// for the DIE that is named.
2380//
2381// For type units the offset is the offset of the skeleton DIE. For split dwarf
2382// it's the offset within the debug_info/debug_types dwo section, however, the
2383// reference in the pubname header doesn't change.
2384
2385/// computeIndexValue - Compute the gdb index value for the DIE and CU.
David Blaikie8dec4072013-09-19 20:40:26 +00002386static dwarf::PubIndexEntryDescriptor computeIndexValue(CompileUnit *CU,
2387 DIE *Die) {
Eric Christopherccac5c42013-09-23 22:59:14 +00002388 dwarf::GDBIndexEntryLinkage Linkage =
David Blaikie8dec4072013-09-19 20:40:26 +00002389 Die->findAttribute(dwarf::DW_AT_external) ? dwarf::GIEL_EXTERNAL
2390 : dwarf::GIEL_STATIC;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002391
2392 switch (Die->getTag()) {
2393 case dwarf::DW_TAG_class_type:
2394 case dwarf::DW_TAG_structure_type:
2395 case dwarf::DW_TAG_union_type:
2396 case dwarf::DW_TAG_enumeration_type:
Eric Christopher261d2342013-09-23 20:55:35 +00002397 return dwarf::PubIndexEntryDescriptor(
2398 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2399 ? dwarf::GIEL_STATIC
2400 : dwarf::GIEL_EXTERNAL);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002401 case dwarf::DW_TAG_typedef:
2402 case dwarf::DW_TAG_base_type:
2403 case dwarf::DW_TAG_subrange_type:
David Blaikie8dec4072013-09-19 20:40:26 +00002404 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002405 case dwarf::DW_TAG_namespace:
David Blaikie8dec4072013-09-19 20:40:26 +00002406 return dwarf::GIEK_TYPE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002407 case dwarf::DW_TAG_subprogram:
Eric Christopherccac5c42013-09-23 22:59:14 +00002408 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002409 case dwarf::DW_TAG_constant:
2410 case dwarf::DW_TAG_variable:
Eric Christopherccac5c42013-09-23 22:59:14 +00002411 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002412 case dwarf::DW_TAG_enumerator:
David Blaikie8dec4072013-09-19 20:40:26 +00002413 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2414 dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002415 default:
David Blaikie8dec4072013-09-19 20:40:26 +00002416 return dwarf::GIEK_NONE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002417 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002418}
2419
Eric Christopher5f93bb92013-09-09 20:03:17 +00002420/// emitDebugPubNames - Emit visible names into a debug pubnames section.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002421///
Eric Christopherdd1a0122013-09-13 00:35:05 +00002422void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002423 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christopherdd1a0122013-09-13 00:35:05 +00002424 const MCSection *PSec =
2425 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2426 : Asm->getObjFileLowering().getDwarfPubNamesSection();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002427
2428 typedef DenseMap<const MDNode*, CompileUnit*> CUMapType;
2429 for (CUMapType::iterator I = CUMap.begin(), E = CUMap.end(); I != E; ++I) {
2430 CompileUnit *TheCU = I->second;
2431 unsigned ID = TheCU->getUniqueID();
2432
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002433 // Start the dwarf pubnames section.
Eric Christopher13b99d22013-09-10 21:49:37 +00002434 Asm->OutStreamer.SwitchSection(PSec);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002435
Eric Christopher39eebfa2013-09-30 23:14:16 +00002436 // Emit a label so we can reference the beginning of this pubname section.
2437 if (GnuStyle)
2438 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames",
2439 TheCU->getUniqueID()));
2440
Eric Christopherdd1a0122013-09-13 00:35:05 +00002441 // Emit the header.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002442 Asm->OutStreamer.AddComment("Length of Public Names Info");
2443 Asm->EmitLabelDifference(Asm->GetTempSymbol("pubnames_end", ID),
2444 Asm->GetTempSymbol("pubnames_begin", ID), 4);
2445
2446 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin", ID));
2447
2448 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002449 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002450
2451 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2452 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2453 DwarfInfoSectionSym);
2454
2455 Asm->OutStreamer.AddComment("Compilation Unit Length");
2456 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(), ID),
2457 Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2458 4);
2459
Eric Christopherdd1a0122013-09-13 00:35:05 +00002460 // Emit the pubnames for this compilation unit.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002461 const StringMap<DIE*> &Globals = TheCU->getGlobalNames();
2462 for (StringMap<DIE*>::const_iterator
2463 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2464 const char *Name = GI->getKeyData();
Eric Christopherdd1a0122013-09-13 00:35:05 +00002465 DIE *Entity = GI->second;
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002466
2467 Asm->OutStreamer.AddComment("DIE offset");
2468 Asm->EmitInt32(Entity->getOffset());
2469
Eric Christopherdd1a0122013-09-13 00:35:05 +00002470 if (GnuStyle) {
David Blaikied0a869d2013-09-19 22:19:37 +00002471 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2472 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002473 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002474 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002475 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002476 }
2477
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002478 if (Asm->isVerbose())
2479 Asm->OutStreamer.AddComment("External Name");
Rafael Espindola64e1af82013-07-02 15:49:13 +00002480 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002481 }
2482
2483 Asm->OutStreamer.AddComment("End Mark");
2484 Asm->EmitInt32(0);
2485 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end", ID));
2486 }
2487}
2488
Eric Christopherdd1a0122013-09-13 00:35:05 +00002489void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
Eric Christopher8b3737f2013-09-13 00:34:58 +00002490 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
Eric Christopher261d2342013-09-23 20:55:35 +00002491 const MCSection *PSec =
2492 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2493 : Asm->getObjFileLowering().getDwarfPubTypesSection();
Eric Christopher8b3737f2013-09-13 00:34:58 +00002494
Devang Patel1a0df9a2010-05-10 22:49:55 +00002495 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
Eric Christopher8b3737f2013-09-13 00:34:58 +00002496 E = CUMap.end();
2497 I != E; ++I) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002498 CompileUnit *TheCU = I->second;
Eric Christopher6abc9c52011-11-07 09:18:35 +00002499 // Start the dwarf pubtypes section.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002500 Asm->OutStreamer.SwitchSection(PSec);
Eric Christopher39eebfa2013-09-30 23:14:16 +00002501
2502 // Emit a label so we can reference the beginning of this pubtype section.
2503 if (GnuStyle)
2504 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes",
2505 TheCU->getUniqueID()));
2506
2507 // Emit the header.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002508 Asm->OutStreamer.AddComment("Length of Public Types Info");
2509 Asm->EmitLabelDifference(
Eric Christopher8b3737f2013-09-13 00:34:58 +00002510 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2511 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002512
Eric Christopher8b3737f2013-09-13 00:34:58 +00002513 Asm->OutStreamer.EmitLabel(
2514 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002515
Eric Christopher8b3737f2013-09-13 00:34:58 +00002516 if (Asm->isVerbose())
2517 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002518 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002519
Devang Patel1a0df9a2010-05-10 22:49:55 +00002520 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002521 Asm->EmitSectionOffset(
2522 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()),
2523 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002524
Devang Patel1a0df9a2010-05-10 22:49:55 +00002525 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002526 Asm->EmitLabelDifference(
2527 Asm->GetTempSymbol(ISec->getLabelEndName(), TheCU->getUniqueID()),
2528 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002529
Eric Christopher39eebfa2013-09-30 23:14:16 +00002530 // Emit the pubtypes.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002531 const StringMap<DIE *> &Globals = TheCU->getGlobalTypes();
2532 for (StringMap<DIE *>::const_iterator GI = Globals.begin(),
2533 GE = Globals.end();
2534 GI != GE; ++GI) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002535 const char *Name = GI->getKeyData();
Nick Lewycky019d2552011-07-29 03:49:23 +00002536 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002537
Eric Christopher8b3737f2013-09-13 00:34:58 +00002538 if (Asm->isVerbose())
2539 Asm->OutStreamer.AddComment("DIE offset");
Devang Patel1a0df9a2010-05-10 22:49:55 +00002540 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002541
Eric Christopherdd1a0122013-09-13 00:35:05 +00002542 if (GnuStyle) {
David Blaikied0a869d2013-09-19 22:19:37 +00002543 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2544 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002545 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002546 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002547 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002548 }
2549
Eric Christopher8b3737f2013-09-13 00:34:58 +00002550 if (Asm->isVerbose())
2551 Asm->OutStreamer.AddComment("External Name");
2552
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002553 // Emit the name with a terminating null byte.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002554 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002555 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002556
Devang Patel1a0df9a2010-05-10 22:49:55 +00002557 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002558 Asm->EmitInt32(0);
Eric Christopher8b3737f2013-09-13 00:34:58 +00002559 Asm->OutStreamer.EmitLabel(
2560 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00002561 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002562}
2563
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002564// Emit strings into a string section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002565void DwarfUnits::emitStrings(const MCSection *StrSection,
2566 const MCSection *OffsetSection = NULL,
2567 const MCSymbol *StrSecSym = NULL) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002568
Eric Christopher27614582013-01-08 22:22:06 +00002569 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002570
Chris Lattner3d72a672010-03-09 23:38:23 +00002571 // Start the dwarf str section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002572 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling480ff322009-05-20 23:21:38 +00002573
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002574 // Get all of the string pool entries and put them in an array by their ID so
2575 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002576 SmallVector<std::pair<unsigned,
Eric Christopherb800ff72013-01-07 22:40:45 +00002577 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002578
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002579 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
Eric Christopher27614582013-01-08 22:22:06 +00002580 I = StringPool.begin(), E = StringPool.end();
Eric Christopher48fef592012-12-20 21:58:40 +00002581 I != E; ++I)
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002582 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002583
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002584 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002585
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002586 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002587 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002588 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002589
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002590 // Emit the string itself with a terminating null byte.
Benjamin Kramer148db362011-11-09 12:12:04 +00002591 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
Eric Christopherce0cfce2013-01-09 01:35:34 +00002592 Entries[i].second->getKeyLength()+1));
Bill Wendling480ff322009-05-20 23:21:38 +00002593 }
Eric Christopher2cbd5762013-01-07 19:32:41 +00002594
2595 // If we've got an offset section go ahead and emit that now as well.
2596 if (OffsetSection) {
2597 Asm->OutStreamer.SwitchSection(OffsetSection);
2598 unsigned offset = 0;
Eric Christopher962c9082013-01-15 23:56:56 +00002599 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002600 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopherbf7bc492013-01-09 03:52:05 +00002601 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopher2cbd5762013-01-07 19:32:41 +00002602 offset += Entries[i].second->getKeyLength() + 1;
2603 }
2604 }
Bill Wendling480ff322009-05-20 23:21:38 +00002605}
2606
Eric Christopher962c9082013-01-15 23:56:56 +00002607// Emit strings into a string section.
2608void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2609
2610 if (AddressPool.empty()) return;
2611
2612 // Start the dwarf addr section.
2613 Asm->OutStreamer.SwitchSection(AddrSection);
2614
David Blaikiece1960f2013-07-08 17:51:28 +00002615 // Order the address pool entries by ID
David Blaikieac569a62013-07-08 17:33:10 +00002616 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher962c9082013-01-15 23:56:56 +00002617
David Blaikiece1960f2013-07-08 17:51:28 +00002618 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2619 E = AddressPool.end();
Eric Christopher962c9082013-01-15 23:56:56 +00002620 I != E; ++I)
David Blaikieac569a62013-07-08 17:33:10 +00002621 Entries[I->second] = I->first;
Eric Christopher962c9082013-01-15 23:56:56 +00002622
2623 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002624 // Emit an expression for reference from debug information entries.
David Blaikieac569a62013-07-08 17:33:10 +00002625 if (const MCExpr *Expr = Entries[i])
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002626 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
Eric Christopher962c9082013-01-15 23:56:56 +00002627 else
2628 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2629 }
2630
2631}
2632
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002633// Emit visible names into a debug str section.
2634void DwarfDebug::emitDebugStr() {
2635 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2636 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2637}
2638
Eric Christopher9046f942013-07-02 21:36:07 +00002639// Emit locations into the debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002640void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002641 if (DotDebugLocEntries.empty())
2642 return;
2643
Eric Christopher4887c8f2013-03-29 23:34:06 +00002644 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Devang Patel116a9d72011-02-04 22:57:18 +00002645 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2646 I != E; ++I) {
2647 DotDebugLocEntry &Entry = *I;
2648 if (I + 1 != DotDebugLocEntries.end())
2649 Entry.Merge(I+1);
2650 }
2651
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002652 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002653 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00002654 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002655 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002656 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2657 unsigned index = 1;
Eric Christopher4887c8f2013-03-29 23:34:06 +00002658 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002659 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002660 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002661 DotDebugLocEntry &Entry = *I;
2662 if (Entry.isMerged()) continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002663 if (Entry.isEmpty()) {
Eric Christopherce0cfce2013-01-09 01:35:34 +00002664 Asm->OutStreamer.EmitIntValue(0, Size);
2665 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002666 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002667 } else {
Eric Christopher25f06422013-07-03 22:40:18 +00002668 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2669 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2670 DIVariable DV(Entry.getVariable());
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002671 Asm->OutStreamer.AddComment("Loc expr size");
2672 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2673 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2674 Asm->EmitLabelDifference(end, begin, 2);
2675 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002676 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002677 DIBasicType BTy(DV.getType());
2678 if (BTy.Verify() &&
Eric Christopher6a841382012-11-19 22:42:10 +00002679 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patel324f8432011-06-01 22:03:25 +00002680 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2681 Asm->OutStreamer.AddComment("DW_OP_consts");
2682 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002683 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002684 } else {
2685 Asm->OutStreamer.AddComment("DW_OP_constu");
2686 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002687 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002688 }
Devang Pateled9fd452011-07-08 16:49:43 +00002689 } else if (Entry.isLocation()) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002690 MachineLocation Loc = Entry.getLoc();
Eric Christopher6a841382012-11-19 22:42:10 +00002691 if (!DV.hasComplexAddress())
Devang Pateled9fd452011-07-08 16:49:43 +00002692 // Regular entry.
Eric Christopher614a89f2013-07-03 22:40:21 +00002693 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002694 else {
2695 // Complex address entry.
2696 unsigned N = DV.getNumAddrElements();
2697 unsigned i = 0;
2698 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002699 if (Loc.getOffset()) {
Devang Pateled9fd452011-07-08 16:49:43 +00002700 i = 2;
Eric Christopher614a89f2013-07-03 22:40:21 +00002701 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002702 Asm->OutStreamer.AddComment("DW_OP_deref");
2703 Asm->EmitInt8(dwarf::DW_OP_deref);
2704 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2705 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2706 Asm->EmitSLEB128(DV.getAddrElement(1));
2707 } else {
2708 // If first address element is OpPlus then emit
2709 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher614a89f2013-07-03 22:40:21 +00002710 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2711 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002712 i = 2;
2713 }
2714 } else {
Eric Christopher614a89f2013-07-03 22:40:21 +00002715 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002716 }
Eric Christopher6a841382012-11-19 22:42:10 +00002717
Devang Pateled9fd452011-07-08 16:49:43 +00002718 // Emit remaining complex address elements.
2719 for (; i < N; ++i) {
2720 uint64_t Element = DV.getAddrElement(i);
2721 if (Element == DIBuilder::OpPlus) {
2722 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2723 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher4d250522012-05-08 18:56:00 +00002724 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002725 if (!Loc.isReg())
Eric Christopher4d250522012-05-08 18:56:00 +00002726 Asm->EmitInt8(dwarf::DW_OP_deref);
2727 } else
2728 llvm_unreachable("unknown Opcode found in complex address");
Devang Pateled9fd452011-07-08 16:49:43 +00002729 }
Devang Patel3e021532011-04-28 02:22:40 +00002730 }
Devang Patel3e021532011-04-28 02:22:40 +00002731 }
Devang Pateled9fd452011-07-08 16:49:43 +00002732 // else ... ignore constant fp. There is not any good way to
2733 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002734 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002735 }
2736 }
Bill Wendling480ff322009-05-20 23:21:38 +00002737}
2738
Richard Mitton21101b32013-09-19 23:21:01 +00002739struct SymbolCUSorter {
2740 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2741 const MCStreamer &Streamer;
2742
2743 bool operator() (const SymbolCU &A, const SymbolCU &B) {
2744 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2745 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2746
2747 // Symbols with no order assigned should be placed at the end.
2748 // (e.g. section end labels)
2749 if (IA == 0)
2750 IA = (unsigned)(-1);
2751 if (IB == 0)
2752 IB = (unsigned)(-1);
2753 return IA < IB;
2754 }
2755};
2756
Richard Mitton21101b32013-09-19 23:21:01 +00002757static bool CUSort(const CompileUnit *A, const CompileUnit *B) {
2758 return (A->getUniqueID() < B->getUniqueID());
2759}
2760
2761struct ArangeSpan {
2762 const MCSymbol *Start, *End;
2763};
2764
2765// Emit a debug aranges section, containing a CU lookup for any
2766// address we can tie back to a CU.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002767void DwarfDebug::emitDebugARanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002768 // Start the dwarf aranges section.
Eric Christopherac8199b2013-08-30 00:39:57 +00002769 Asm->OutStreamer
2770 .SwitchSection(Asm->getObjFileLowering().getDwarfARangesSection());
Richard Mitton21101b32013-09-19 23:21:01 +00002771
2772 typedef DenseMap<CompileUnit *, std::vector<ArangeSpan> > SpansType;
2773
2774 SpansType Spans;
2775
2776 // Build a list of sections used.
2777 std::vector<const MCSection *> Sections;
2778 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2779 it++) {
2780 const MCSection *Section = it->first;
2781 Sections.push_back(Section);
2782 }
2783
2784 // Sort the sections into order.
2785 // This is only done to ensure consistent output order across different runs.
2786 std::sort(Sections.begin(), Sections.end(), SectionSort);
2787
2788 // Build a set of address spans, sorted by CU.
2789 for (size_t SecIdx=0;SecIdx<Sections.size();SecIdx++) {
2790 const MCSection *Section = Sections[SecIdx];
2791 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2792 if (List.size() < 2)
2793 continue;
2794
2795 // Sort the symbols by offset within the section.
2796 SymbolCUSorter sorter(Asm->OutStreamer);
2797 std::sort(List.begin(), List.end(), sorter);
2798
2799 // If we have no section (e.g. common), just write out
2800 // individual spans for each symbol.
2801 if (Section == NULL) {
2802 for (size_t n = 0; n < List.size(); n++) {
2803 const SymbolCU &Cur = List[n];
2804
2805 ArangeSpan Span;
2806 Span.Start = Cur.Sym;
2807 Span.End = NULL;
2808 if (Cur.CU)
2809 Spans[Cur.CU].push_back(Span);
2810 }
2811 } else {
2812 // Build spans between each label.
2813 const MCSymbol *StartSym = List[0].Sym;
2814 for (size_t n = 1; n < List.size(); n++) {
2815 const SymbolCU &Prev = List[n - 1];
2816 const SymbolCU &Cur = List[n];
2817
2818 // Try and build the longest span we can within the same CU.
2819 if (Cur.CU != Prev.CU) {
2820 ArangeSpan Span;
2821 Span.Start = StartSym;
2822 Span.End = Cur.Sym;
2823 Spans[Prev.CU].push_back(Span);
2824 StartSym = Cur.Sym;
2825 }
2826 }
2827 }
2828 }
2829
2830 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2831 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2832
2833 // Build a list of CUs used.
2834 std::vector<CompileUnit *> CUs;
2835 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
2836 CompileUnit *CU = it->first;
2837 CUs.push_back(CU);
2838 }
2839
2840 // Sort the CU list (again, to ensure consistent output order).
2841 std::sort(CUs.begin(), CUs.end(), CUSort);
2842
2843 // Emit an arange table for each CU we used.
2844 for (size_t CUIdx=0;CUIdx<CUs.size();CUIdx++) {
2845 CompileUnit *CU = CUs[CUIdx];
2846 std::vector<ArangeSpan> &List = Spans[CU];
2847
2848 // Emit size of content not including length itself.
2849 unsigned ContentSize
2850 = sizeof(int16_t) // DWARF ARange version number
2851 + sizeof(int32_t) // Offset of CU in the .debug_info section
2852 + sizeof(int8_t) // Pointer Size (in bytes)
2853 + sizeof(int8_t); // Segment Size (in bytes)
2854
2855 unsigned TupleSize = PtrSize * 2;
2856
2857 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2858 unsigned Padding = 0;
2859 while (((sizeof(int32_t) + ContentSize + Padding) % TupleSize) != 0)
2860 Padding++;
2861
2862 ContentSize += Padding;
2863 ContentSize += (List.size() + 1) * TupleSize;
2864
2865 // For each compile unit, write the list of spans it covers.
2866 Asm->OutStreamer.AddComment("Length of ARange Set");
2867 Asm->EmitInt32(ContentSize);
2868 Asm->OutStreamer.AddComment("DWARF Arange version number");
2869 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2870 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
2871 Asm->EmitSectionOffset(
2872 Asm->GetTempSymbol(ISec->getLabelBeginName(), CU->getUniqueID()),
2873 DwarfInfoSectionSym);
2874 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2875 Asm->EmitInt8(PtrSize);
2876 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2877 Asm->EmitInt8(0);
2878
2879 for (unsigned n = 0; n < Padding; n++)
2880 Asm->EmitInt8(0xff);
2881
2882 for (unsigned n = 0; n < List.size(); n++) {
2883 const ArangeSpan &Span = List[n];
2884 Asm->EmitLabelReference(Span.Start, PtrSize);
2885
2886 // Calculate the size as being from the span start to it's end.
Richard Mitton089ed892013-09-23 17:56:20 +00002887 if (Span.End) {
Richard Mitton21101b32013-09-19 23:21:01 +00002888 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
Richard Mitton089ed892013-09-23 17:56:20 +00002889 } else {
2890 // For symbols without an end marker (e.g. common), we
2891 // write a single arange entry containing just that one symbol.
2892 uint64_t Size = SymSize[Span.Start];
2893 if (Size == 0)
2894 Size = 1;
2895
2896 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2897 }
Richard Mitton21101b32013-09-19 23:21:01 +00002898 }
2899
2900 Asm->OutStreamer.AddComment("ARange terminator");
2901 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2902 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2903 }
Bill Wendling480ff322009-05-20 23:21:38 +00002904}
2905
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002906// Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002907void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002908 // Start the dwarf ranges section.
Eric Christopherac8199b2013-08-30 00:39:57 +00002909 Asm->OutStreamer
2910 .SwitchSection(Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002911 unsigned char Size = Asm->getDataLayout().getPointerSize();
Eric Christopher4887c8f2013-03-29 23:34:06 +00002912 for (SmallVectorImpl<const MCSymbol *>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002913 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00002914 I != E; ++I) {
2915 if (*I)
Eric Christopherbf7bc492013-01-09 03:52:05 +00002916 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
Devang Patel12563b32010-04-16 23:33:45 +00002917 else
Eric Christopherce0cfce2013-01-09 01:35:34 +00002918 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel12563b32010-04-16 23:33:45 +00002919 }
Bill Wendling480ff322009-05-20 23:21:38 +00002920}
2921
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002922// Emit visible names into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002923void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002924 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00002925 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00002926 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002927 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00002928 }
2929}
2930
Eric Christopherd692c1d2012-12-11 19:42:09 +00002931// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002932
2933// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2934// 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 +00002935// DW_AT_ranges_base, DW_AT_addr_base.
Eric Christopher6fdf3242013-08-26 23:50:43 +00002936CompileUnit *DwarfDebug::constructSkeletonCU(const CompileUnit *CU) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002937
2938 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher6fdf3242013-08-26 23:50:43 +00002939 CompileUnit *NewCU = new CompileUnit(CU->getUniqueID(), Die, CU->getNode(),
2940 Asm, this, &SkeletonHolder);
Eric Christopher4c7765f2013-01-17 03:00:04 +00002941
Eric Christopherdae389b2013-02-22 23:50:08 +00002942 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
Eric Christopher6b16b432013-08-26 23:57:03 +00002943 DICompileUnit(CU->getNode()).getSplitDebugFilename());
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002944
Eric Christopher44c6aa62013-04-22 07:51:08 +00002945 // Relocate to the beginning of the addr_base section, else 0 for the
2946 // beginning of the one for this compile unit.
Eric Christopher55863be2013-04-07 03:43:09 +00002947 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2948 NewCU->addLabel(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2949 DwarfAddrSectionSym);
2950 else
Eric Christopher44c6aa62013-04-22 07:51:08 +00002951 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base,
2952 dwarf::DW_FORM_sec_offset, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002953
2954 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher962c9082013-01-15 23:56:56 +00002955 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002956 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher962c9082013-01-15 23:56:56 +00002957
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002958 // DW_AT_stmt_list is a offset of line number information for this
2959 // compile unit in debug_line section.
Eric Christopher55863be2013-04-07 03:43:09 +00002960 // FIXME: Should handle multiple compile units.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002961 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher4c7765f2013-01-17 03:00:04 +00002962 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher74804332013-02-07 21:19:50 +00002963 DwarfLineSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002964 else
Eric Christopher4c7765f2013-01-17 03:00:04 +00002965 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002966
2967 if (!CompilationDir.empty())
Eric Christopher2cbd5762013-01-07 19:32:41 +00002968 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002969
Eric Christopher1d06eb52013-10-01 00:43:31 +00002970 // Flags to let the linker know we have emitted new style pubnames.
Eric Christopher39eebfa2013-09-30 23:14:16 +00002971 if (GenerateGnuPubSections) {
2972 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2973 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_sec_offset,
2974 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()));
2975 else
2976 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
2977 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()),
2978 DwarfGnuPubNamesSectionSym);
2979
2980 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2981 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_sec_offset,
2982 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()));
2983 else
2984 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
Eric Christopherf976c772013-10-03 17:41:16 +00002985 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()),
Eric Christopher39eebfa2013-09-30 23:14:16 +00002986 DwarfGnuPubTypesSectionSym);
2987 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002988
Eric Christopher9a08f9e2013-10-01 00:43:36 +00002989 // Flag if we've emitted any ranges and their location for the compile unit.
2990 if (DebugRangeSymbols.size()) {
2991 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2992 NewCU->addLabel(Die, dwarf::DW_AT_GNU_ranges_base,
2993 dwarf::DW_FORM_sec_offset, DwarfDebugRangeSectionSym);
2994 else
2995 NewCU->addUInt(Die, dwarf::DW_AT_GNU_ranges_base, dwarf::DW_FORM_data4,
2996 0);
2997 }
2998
Eric Christopherc8a310e2012-12-10 23:34:43 +00002999 SkeletonHolder.addUnit(NewCU);
Eric Christopher5b33b3c2013-02-06 21:53:56 +00003000 SkeletonCUs.push_back(NewCU);
Eric Christopherc8a310e2012-12-10 23:34:43 +00003001
Eric Christopher9c2ecd92012-11-30 23:59:06 +00003002 return NewCU;
3003}
3004
Eric Christopher3c5a1912012-12-19 22:02:53 +00003005void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
3006 assert(useSplitDwarf() && "No split dwarf debug info?");
3007 emitAbbrevs(Section, &SkeletonAbbrevs);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00003008}
3009
Eric Christopherd692c1d2012-12-11 19:42:09 +00003010// Emit the .debug_info.dwo section for separated dwarf. This contains the
3011// compile units that would normally be in debug_info.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00003012void DwarfDebug::emitDebugInfoDWO() {
Eric Christophercdf218d2012-12-10 19:51:21 +00003013 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christophera2de8262012-12-15 00:04:07 +00003014 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
Eric Christopher3c5a1912012-12-19 22:02:53 +00003015 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
3016 DwarfAbbrevDWOSectionSym);
3017}
3018
3019// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
3020// abbreviations for the .debug_info.dwo section.
3021void DwarfDebug::emitDebugAbbrevDWO() {
3022 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopher48fef592012-12-20 21:58:40 +00003023 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
3024 &Abbreviations);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00003025}
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003026
3027// Emit the .debug_str.dwo section for separated dwarf. This contains the
3028// string section and is identical in format to traditional .debug_str
3029// sections.
3030void DwarfDebug::emitDebugStrDWO() {
3031 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherb800ff72013-01-07 22:40:45 +00003032 const MCSection *OffSec = Asm->getObjFileLowering()
3033 .getDwarfStrOffDWOSection();
Eric Christopher2cbd5762013-01-07 19:32:41 +00003034 const MCSymbol *StrSym = DwarfStrSectionSym;
3035 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
3036 OffSec, StrSym);
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003037}