blob: 06ad16243838b2ba6c552c97f4702d4e609daf65 [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"
David Blaikie2c86a722013-12-02 19:33:15 +000019#include "DwarfUnit.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 Christopherb4bef6d2013-11-19 09:04:36 +000066static cl::opt<bool> GenerateCUHash("generate-cu-hash", cl::Hidden,
67 cl::desc("Add the CU hash as the dwo_id."),
68 cl::init(false));
Eric Christopherd29614f2013-08-13 01:21:55 +000069
Eric Christopherdd1a0122013-09-13 00:35:05 +000070static cl::opt<bool>
71GenerateGnuPubSections("generate-gnu-dwarf-pub-sections", cl::Hidden,
72 cl::desc("Generate GNU-style pubnames and pubtypes"),
73 cl::init(false));
74
Eric Christopher20b76a72012-08-23 22:36:40 +000075namespace {
Eric Christopher7f2b5512013-07-23 22:16:41 +000076enum DefaultOnOff {
77 Default,
78 Enable,
79 Disable
80};
Eric Christopher20b76a72012-08-23 22:36:40 +000081}
Eric Christopher4996c702011-11-07 09:24:32 +000082
Eric Christopher7f2b5512013-07-23 22:16:41 +000083static cl::opt<DefaultOnOff>
84DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
85 cl::desc("Output prototype dwarf accelerator tables."),
86 cl::values(clEnumVal(Default, "Default for platform"),
87 clEnumVal(Enable, "Enabled"),
88 clEnumVal(Disable, "Disabled"), clEnumValEnd),
89 cl::init(Default));
Eric Christopher20b76a72012-08-23 22:36:40 +000090
Eric Christopher7f2b5512013-07-23 22:16:41 +000091static cl::opt<DefaultOnOff>
Eric Christopher7f2b5512013-07-23 22:16:41 +000092SplitDwarf("split-dwarf", cl::Hidden,
Eric Christopher5d008fe2013-12-04 23:24:28 +000093 cl::desc("Output DWARF5 split debug info."),
Eric Christopher7f2b5512013-07-23 22:16:41 +000094 cl::values(clEnumVal(Default, "Default for platform"),
95 clEnumVal(Enable, "Enabled"),
96 clEnumVal(Disable, "Disabled"), clEnumValEnd),
97 cl::init(Default));
Eric Christopher29424312012-11-12 22:22:20 +000098
Eric Christopher7da24882013-08-19 21:07:38 +000099static cl::opt<DefaultOnOff>
Eric Christopher4d36ca02013-08-26 23:24:35 +0000100DwarfPubSections("generate-dwarf-pub-sections", cl::Hidden,
101 cl::desc("Generate DWARF pubnames and pubtypes sections"),
102 cl::values(clEnumVal(Default, "Default for platform"),
103 clEnumVal(Enable, "Enabled"),
104 clEnumVal(Disable, "Disabled"), clEnumValEnd),
105 cl::init(Default));
Eric Christopher7da24882013-08-19 21:07:38 +0000106
Eric Christopher33ff6972013-11-21 23:46:41 +0000107static cl::opt<unsigned>
108DwarfVersionNumber("dwarf-version", cl::Hidden,
Eric Christophera5a79422013-12-09 23:32:48 +0000109 cl::desc("Generate DWARF for dwarf version."), cl::init(0));
Eric Christopher33ff6972013-11-21 23:46:41 +0000110
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000111static const char *const DWARFGroupName = "DWARF Emission";
112static const char *const DbgTimerName = "DWARF Debug Writer";
Bill Wendlingfcc14142010-04-07 09:28:04 +0000113
Bill Wendling2f921f82009-05-15 09:23:25 +0000114//===----------------------------------------------------------------------===//
115
Bill Wendling2f921f82009-05-15 09:23:25 +0000116namespace llvm {
117
Manman Renbe5576f2013-10-08 19:07:44 +0000118/// resolve - Look in the DwarfDebug map for the MDNode that
119/// corresponds to the reference.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000120template <typename T> T DbgVariable::resolve(DIRef<T> Ref) const {
Manman Renbe5576f2013-10-08 19:07:44 +0000121 return DD->resolve(Ref);
122}
123
Nick Lewycky019d2552011-07-29 03:49:23 +0000124DIType DbgVariable::getType() const {
Devang Patelf20c4f72011-04-12 22:53:02 +0000125 DIType Ty = Var.getType();
126 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
127 // addresses instead.
128 if (Var.isBlockByrefVariable()) {
129 /* Byref variables, in Blocks, are declared by the programmer as
130 "SomeType VarName;", but the compiler creates a
131 __Block_byref_x_VarName struct, and gives the variable VarName
132 either the struct, or a pointer to the struct, as its type. This
133 is necessary for various behind-the-scenes things the compiler
134 needs to do with by-reference variables in blocks.
Eric Christopher6a841382012-11-19 22:42:10 +0000135
Devang Patelf20c4f72011-04-12 22:53:02 +0000136 However, as far as the original *programmer* is concerned, the
137 variable should still have type 'SomeType', as originally declared.
Eric Christopher6a841382012-11-19 22:42:10 +0000138
Devang Patelf20c4f72011-04-12 22:53:02 +0000139 The following function dives into the __Block_byref_x_VarName
140 struct to find the original type of the variable. This will be
141 passed back to the code generating the type for the Debug
142 Information Entry for the variable 'VarName'. 'VarName' will then
143 have the original type 'SomeType' in its debug information.
Eric Christopher6a841382012-11-19 22:42:10 +0000144
Devang Patelf20c4f72011-04-12 22:53:02 +0000145 The original type 'SomeType' will be the type of the field named
146 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher6a841382012-11-19 22:42:10 +0000147
Devang Patelf20c4f72011-04-12 22:53:02 +0000148 NOTE: In order for this to not completely fail on the debugger
149 side, the Debug Information Entry for the variable VarName needs to
150 have a DW_AT_location that tells the debugger how to unwind through
151 the pointers and __Block_byref_x_VarName struct to find the actual
152 value of the variable. The function addBlockByrefType does this. */
153 DIType subType = Ty;
Eric Christopher31b05762013-08-08 01:41:00 +0000154 uint16_t tag = Ty.getTag();
Eric Christopher6a841382012-11-19 22:42:10 +0000155
Eric Christopher9adc55f2013-09-04 19:53:21 +0000156 if (tag == dwarf::DW_TAG_pointer_type)
Manman Renbe5576f2013-10-08 19:07:44 +0000157 subType = resolve(DIDerivedType(Ty).getTypeDerivedFrom());
Eric Christopher6a841382012-11-19 22:42:10 +0000158
Eric Christopher9adc55f2013-09-04 19:53:21 +0000159 DIArray Elements = DICompositeType(subType).getTypeArray();
Devang Patelf20c4f72011-04-12 22:53:02 +0000160 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
David Blaikie5af2aca2013-11-18 23:57:26 +0000161 DIDerivedType DT(Elements.getElement(i));
Devang Patelf20c4f72011-04-12 22:53:02 +0000162 if (getName() == DT.getName())
Manman Renbe5576f2013-10-08 19:07:44 +0000163 return (resolve(DT.getTypeDerivedFrom()));
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000164 }
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000165 }
Devang Patelf20c4f72011-04-12 22:53:02 +0000166 return Ty;
167}
Bill Wendling2f921f82009-05-15 09:23:25 +0000168
Chris Lattnerf5d06362010-04-05 04:09:20 +0000169} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000170
Manman Renac8062b2013-07-02 23:40:10 +0000171/// Return Dwarf Version by checking module flags.
172static unsigned getDwarfVersionFromModule(const Module *M) {
Manman Ren8bfde892013-07-16 23:21:16 +0000173 Value *Val = M->getModuleFlag("Dwarf Version");
174 if (!Val)
Eric Christophere31e0722013-09-04 22:21:24 +0000175 return dwarf::DWARF_VERSION;
Manman Ren8bfde892013-07-16 23:21:16 +0000176 return cast<ConstantInt>(Val)->getZExtValue();
Manman Renac8062b2013-07-02 23:40:10 +0000177}
178
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000179DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
David Blaikie0504cda2013-12-05 07:43:55 +0000180 : Asm(A), MMI(Asm->MMI), FirstCU(0), SourceIdMap(DIEValueAllocator),
David Blaikie2666e242013-12-06 19:38:46 +0000181 PrevLabel(NULL), GlobalRangeCount(0),
David Blaikie0504cda2013-12-05 07:43:55 +0000182 InfoHolder(A, "info_string", DIEValueAllocator),
183 SkeletonHolder(A, "skel_string", 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 Christophera5a79422013-12-09 23:32:48 +0000191 CurFn = 0;
192 CurMI = 0;
Eric Christopherad9fe892012-04-02 17:58:52 +0000193
Adrian Prantl5bf1d002013-10-15 20:26:37 +0000194 // Turn on accelerator tables for Darwin by default, pubnames by
195 // default for non-Darwin, and handle split dwarf.
Eric Christopher203e12b2013-04-27 01:07:52 +0000196 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
Eric Christopher4977f212012-08-23 22:36:36 +0000197
Eric Christopher574b5c82013-08-19 21:41:38 +0000198 if (DwarfAccelTables == Default)
199 HasDwarfAccelTables = IsDarwin;
200 else
Eric Christopher5297df02013-08-26 20:58:35 +0000201 HasDwarfAccelTables = DwarfAccelTables == Enable;
Eric Christopher20b76a72012-08-23 22:36:40 +0000202
Eric Christophercdf218d2012-12-10 19:51:21 +0000203 if (SplitDwarf == Default)
204 HasSplitDwarf = false;
Eric Christopher29424312012-11-12 22:22:20 +0000205 else
Eric Christopher574b5c82013-08-19 21:41:38 +0000206 HasSplitDwarf = SplitDwarf == Enable;
Eric Christopher29424312012-11-12 22:22:20 +0000207
Eric Christopher4d36ca02013-08-26 23:24:35 +0000208 if (DwarfPubSections == Default)
209 HasDwarfPubSections = !IsDarwin;
Eric Christopher574b5c82013-08-19 21:41:38 +0000210 else
Eric Christopher4d36ca02013-08-26 23:24:35 +0000211 HasDwarfPubSections = DwarfPubSections == Enable;
Eric Christopher7da24882013-08-19 21:07:38 +0000212
Eric Christopher33ff6972013-11-21 23:46:41 +0000213 DwarfVersion = DwarfVersionNumber
214 ? DwarfVersionNumber
215 : getDwarfVersionFromModule(MMI->getModule());
Manman Renac8062b2013-07-02 23:40:10 +0000216
Dan Gohman6e681a52010-06-18 15:56:31 +0000217 {
218 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopher58f41952012-11-19 22:42:15 +0000219 beginModule();
Torok Edwinf8dba242010-04-07 10:44:46 +0000220 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000221}
Bill Wendling2f921f82009-05-15 09:23:25 +0000222
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000223// Switch to the specified MCSection and emit an assembler
224// temporary label to it if SymbolStem is specified.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000225static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christophera7b61892011-11-07 09:18:38 +0000226 const char *SymbolStem = 0) {
227 Asm->OutStreamer.SwitchSection(Section);
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000228 if (!SymbolStem)
229 return 0;
Eric Christophera7b61892011-11-07 09:18:38 +0000230
231 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
232 Asm->OutStreamer.EmitLabel(TmpSym);
233 return TmpSym;
234}
235
Eric Christopherf8194852013-12-05 18:06:10 +0000236DwarfFile::~DwarfFile() {
Eric Christophera5a79422013-12-09 23:32:48 +0000237 for (SmallVectorImpl<DwarfUnit *>::iterator I = CUs.begin(), E = CUs.end();
238 I != E; ++I)
David Blaikie72f1a3e2013-11-23 01:17:34 +0000239 delete *I;
240}
241
Eric Christopherf8194852013-12-05 18:06:10 +0000242MCSymbol *DwarfFile::getStringPoolSym() {
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000243 return Asm->GetTempSymbol(StringPref);
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000244}
245
Eric Christopherf8194852013-12-05 18:06:10 +0000246MCSymbol *DwarfFile::getStringPoolEntry(StringRef Str) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000247 std::pair<MCSymbol *, unsigned> &Entry =
248 StringPool.GetOrCreateValue(Str).getValue();
249 if (Entry.first)
250 return Entry.first;
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000251
252 Entry.second = NextStringPoolNumber++;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000253 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000254}
255
Eric Christopherf8194852013-12-05 18:06:10 +0000256unsigned DwarfFile::getStringPoolIndex(StringRef Str) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000257 std::pair<MCSymbol *, unsigned> &Entry =
258 StringPool.GetOrCreateValue(Str).getValue();
259 if (Entry.first)
260 return Entry.second;
Eric Christopher2cbd5762013-01-07 19:32:41 +0000261
262 Entry.second = NextStringPoolNumber++;
263 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
264 return Entry.second;
265}
266
Eric Christopherf8194852013-12-05 18:06:10 +0000267unsigned DwarfFile::getAddrPoolIndex(const MCSymbol *Sym) {
David Blaikie8466ca82013-07-01 23:55:52 +0000268 return getAddrPoolIndex(MCSymbolRefExpr::Create(Sym, Asm->OutContext));
269}
270
Eric Christopherf8194852013-12-05 18:06:10 +0000271unsigned DwarfFile::getAddrPoolIndex(const MCExpr *Sym) {
Ulrich Weigand8b3d2262013-07-02 18:46:46 +0000272 std::pair<DenseMap<const MCExpr *, unsigned>::iterator, bool> P =
David Blaikieb8ef7852013-06-28 18:47:19 +0000273 AddressPool.insert(std::make_pair(Sym, NextAddrPoolNumber));
David Blaikiea67de2b2013-06-28 18:55:13 +0000274 if (P.second)
275 ++NextAddrPoolNumber;
David Blaikieb8ef7852013-06-28 18:47:19 +0000276 return P.first->second;
Eric Christopher962c9082013-01-15 23:56:56 +0000277}
278
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000279// Define a unique number for the abbreviation.
280//
Eric Christopherf8194852013-12-05 18:06:10 +0000281void DwarfFile::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000282 // Check the set for priors.
David Blaikie0504cda2013-12-05 07:43:55 +0000283 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000284
285 // If it's newly added.
286 if (InSet == &Abbrev) {
287 // Add to abbreviation list.
David Blaikie2d4e1122013-10-30 17:14:24 +0000288 Abbreviations.push_back(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000289
290 // Assign the vector position + 1 as its number.
David Blaikie2d4e1122013-10-30 17:14:24 +0000291 Abbrev.setNumber(Abbreviations.size());
Bill Wendling2f921f82009-05-15 09:23:25 +0000292 } else {
293 // Assign existing abbreviation number.
294 Abbrev.setNumber(InSet->getNumber());
295 }
296}
297
Eric Christopherd9843b32011-11-10 19:25:34 +0000298static bool isObjCClass(StringRef Name) {
299 return Name.startswith("+") || Name.startswith("-");
300}
301
302static bool hasObjCCategory(StringRef Name) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000303 if (!isObjCClass(Name))
304 return false;
Eric Christopherd9843b32011-11-10 19:25:34 +0000305
Benjamin Kramer260de742013-08-24 12:15:54 +0000306 return Name.find(") ") != StringRef::npos;
Eric Christopherd9843b32011-11-10 19:25:34 +0000307}
308
309static void getObjCClassCategory(StringRef In, StringRef &Class,
310 StringRef &Category) {
311 if (!hasObjCCategory(In)) {
312 Class = In.slice(In.find('[') + 1, In.find(' '));
313 Category = "";
314 return;
315 }
316
317 Class = In.slice(In.find('[') + 1, In.find('('));
318 Category = In.slice(In.find('[') + 1, In.find(' '));
319 return;
320}
321
322static StringRef getObjCMethodName(StringRef In) {
323 return In.slice(In.find(' ') + 1, In.find(']'));
324}
325
Richard Mittonc2508242013-10-03 22:07:08 +0000326// Helper for sorting sections into a stable output order.
327static bool SectionSort(const MCSection *A, const MCSection *B) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000328 std::string LA = (A ? A->getLabelBeginName() : "");
329 std::string LB = (B ? B->getLabelBeginName() : "");
330 return LA < LB;
Richard Mittonc2508242013-10-03 22:07:08 +0000331}
332
Eric Christopherd9843b32011-11-10 19:25:34 +0000333// Add the various names to the Dwarf accelerator table names.
Eric Christopher9cd26af2013-09-20 23:22:52 +0000334// TODO: Determine whether or not we should add names for programs
335// that do not have a DW_AT_name or DW_AT_linkage_name field - this
336// is only slightly different than the lookup of non-standard ObjC names.
Eric Christophera5a79422013-12-09 23:32:48 +0000337static void addSubprogramNames(DwarfUnit *TheU, DISubprogram SP, DIE *Die) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000338 if (!SP.isDefinition())
339 return;
David Blaikie2a80e442013-12-02 22:09:48 +0000340 TheU->addAccelName(SP.getName(), Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000341
342 // If the linkage name is different than the name, go ahead and output
343 // that as well into the name table.
344 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
David Blaikie2a80e442013-12-02 22:09:48 +0000345 TheU->addAccelName(SP.getLinkageName(), Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000346
347 // If this is an Objective-C selector name add it to the ObjC accelerator
348 // too.
349 if (isObjCClass(SP.getName())) {
350 StringRef Class, Category;
351 getObjCClassCategory(SP.getName(), Class, Category);
David Blaikie2a80e442013-12-02 22:09:48 +0000352 TheU->addAccelObjC(Class, Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000353 if (Category != "")
David Blaikie2a80e442013-12-02 22:09:48 +0000354 TheU->addAccelObjC(Category, Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000355 // Also add the base method name to the name table.
David Blaikie2a80e442013-12-02 22:09:48 +0000356 TheU->addAccelName(getObjCMethodName(SP.getName()), Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000357 }
358}
359
Manman Ren3eb9dff2013-09-09 19:05:21 +0000360/// isSubprogramContext - Return true if Context is either a subprogram
361/// or another context nested inside a subprogram.
362bool DwarfDebug::isSubprogramContext(const MDNode *Context) {
363 if (!Context)
364 return false;
365 DIDescriptor D(Context);
366 if (D.isSubprogram())
367 return true;
368 if (D.isType())
Manman Ren116868e2013-09-09 19:47:11 +0000369 return isSubprogramContext(resolve(DIType(Context).getContext()));
Manman Ren3eb9dff2013-09-09 19:05:21 +0000370 return false;
371}
372
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000373// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
374// and DW_AT_high_pc attributes. If there are global variables in this
375// scope then create and insert DIEs for these variables.
Eric Christopher4287a492013-12-09 23:57:44 +0000376DIE *DwarfDebug::updateSubprogramScopeDIE(DwarfCompileUnit *SPCU,
377 DISubprogram SP) {
David Blaikie25bc7192013-11-15 23:13:08 +0000378 DIE *SPDie = SPCU->getDIE(SP);
Devang Patela37a95e2010-07-07 22:20:57 +0000379
Chris Lattner3a383cb2010-04-05 00:13:49 +0000380 assert(SPDie && "Unable to find subprogram DIE!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000381
Bill Wendlingf720bf62012-11-07 05:19:04 +0000382 // If we're updating an abstract DIE, then we will be adding the children and
383 // object pointer later on. But what we don't want to do is process the
384 // concrete DIE twice.
David Blaikie25bc7192013-11-15 23:13:08 +0000385 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SP)) {
Bill Wendlingf720bf62012-11-07 05:19:04 +0000386 // Pick up abstract subprogram DIE.
David Blaikie2a80e442013-12-02 22:09:48 +0000387 SPDie =
388 SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram, *SPCU->getUnitDie());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000389 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin, AbsSPDIE);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000390 } else {
391 DISubprogram SPDecl = SP.getFunctionDeclaration();
392 if (!SPDecl.isSubprogram()) {
393 // There is not any need to generate specification DIE for a function
394 // defined at compile unit level. If a function is defined inside another
395 // function then gdb prefers the definition at top level and but does not
396 // expect specification DIE in parent function. So avoid creating
397 // specification DIE for a function defined inside a function.
Manman Renc50fa112013-10-10 18:40:01 +0000398 DIScope SPContext = resolve(SP.getContext());
399 if (SP.isDefinition() && !SPContext.isCompileUnit() &&
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000400 !SPContext.isFile() && !isSubprogramContext(SPContext)) {
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000401 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
402
403 // Add arguments.
404 DICompositeType SPTy = SP.getType();
405 DIArray Args = SPTy.getTypeArray();
Eric Christopher31b05762013-08-08 01:41:00 +0000406 uint16_t SPTag = SPTy.getTag();
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000407 if (SPTag == dwarf::DW_TAG_subroutine_type)
408 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
Manman Ren4a841a82013-10-29 01:03:01 +0000409 DIE *Arg =
410 SPCU->createAndAddDIE(dwarf::DW_TAG_formal_parameter, *SPDie);
David Blaikie5af2aca2013-11-18 23:57:26 +0000411 DIType ATy(Args.getElement(i));
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000412 SPCU->addType(Arg, ATy);
413 if (ATy.isArtificial())
414 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
415 if (ATy.isObjectPointer())
Manman Ren4c4b69c2013-10-11 23:58:05 +0000416 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer, Arg);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000417 }
418 DIE *SPDeclDie = SPDie;
David Blaikie2a80e442013-12-02 22:09:48 +0000419 SPDie = SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram,
420 *SPCU->getUnitDie());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000421 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, SPDeclDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000422 }
423 }
Devang Patela37a95e2010-07-07 22:20:57 +0000424 }
425
David Blaikieb7a1c4d2013-12-04 17:55:41 +0000426 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc, FunctionBeginSym);
427 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc, FunctionEndSym);
Eric Christopher0f63d062013-12-03 00:45:45 +0000428
Chris Lattner3a383cb2010-04-05 00:13:49 +0000429 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
430 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000431 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000432
Eric Christopherd9843b32011-11-10 19:25:34 +0000433 // Add name to the name table, we do this here because we're guaranteed
434 // to have concrete versions of our DW_TAG_subprogram nodes.
435 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher6a841382012-11-19 22:42:10 +0000436
Chris Lattner3a383cb2010-04-05 00:13:49 +0000437 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000438}
439
Manman Ren5b2f4b02013-09-11 19:40:28 +0000440/// Check whether we should create a DIE for the given Scope, return true
441/// if we don't create a DIE (the corresponding DIE is null).
Manman Ren2312ed32013-09-10 18:40:41 +0000442bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
443 if (Scope->isAbstractScope())
444 return false;
445
Manman Ren5b2f4b02013-09-11 19:40:28 +0000446 // We don't create a DIE if there is no Range.
Manman Ren2312ed32013-09-10 18:40:41 +0000447 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
448 if (Ranges.empty())
449 return true;
450
451 if (Ranges.size() > 1)
452 return false;
453
Manman Ren5b2f4b02013-09-11 19:40:28 +0000454 // We don't create a DIE if we have a single Range and the end label
455 // is null.
Manman Ren2312ed32013-09-10 18:40:41 +0000456 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
457 MCSymbol *End = getLabelAfterInsn(RI->second);
458 return !End;
459}
460
Eric Christophera5a79422013-12-09 23:32:48 +0000461static void addSectionLabel(AsmPrinter *Asm, DwarfUnit *U, DIE *D,
Eric Christopherc31fe2d2013-12-05 00:36:17 +0000462 dwarf::Attribute A, const MCSymbol *L,
463 const MCSymbol *Sec) {
464 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
465 U->addSectionLabel(D, A, L);
466 else
467 U->addSectionDelta(D, A, L, Sec);
468}
469
Eric Christopher4287a492013-12-09 23:57:44 +0000470void DwarfDebug::addScopeRangeList(DwarfCompileUnit *TheCU, DIE *ScopeDIE,
Eric Christopherbe2513e2013-12-03 00:45:59 +0000471 const SmallVectorImpl<InsnRange> &Range) {
472 // Emit offset in .debug_range as a relocatable label. emitDIE will handle
473 // emitting it appropriately.
Eric Christopherf8790642013-12-04 22:04:50 +0000474 MCSymbol *RangeSym = Asm->GetTempSymbol("debug_ranges", GlobalRangeCount++);
Eric Christopherc31fe2d2013-12-05 00:36:17 +0000475 addSectionLabel(Asm, TheCU, ScopeDIE, dwarf::DW_AT_ranges, RangeSym,
476 DwarfDebugRangeSectionSym);
477
Eric Christopherf8790642013-12-04 22:04:50 +0000478 RangeSpanList List(RangeSym);
Eric Christopherbe2513e2013-12-03 00:45:59 +0000479 for (SmallVectorImpl<InsnRange>::const_iterator RI = Range.begin(),
480 RE = Range.end();
481 RI != RE; ++RI) {
482 RangeSpan Span(getLabelBeforeInsn(RI->first),
483 getLabelAfterInsn(RI->second));
Eric Christopher270ba4a2013-12-04 19:06:58 +0000484 List.addRange(llvm_move(Span));
Eric Christopherbe2513e2013-12-03 00:45:59 +0000485 }
486
487 // Add the range list to the set of ranges to be emitted.
Eric Christopher270ba4a2013-12-04 19:06:58 +0000488 TheCU->addRangeList(llvm_move(List));
Eric Christopherbe2513e2013-12-03 00:45:59 +0000489}
490
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000491// Construct new DW_TAG_lexical_block for this scope and attach
492// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher4287a492013-12-09 23:57:44 +0000493DIE *DwarfDebug::constructLexicalScopeDIE(DwarfCompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000494 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000495 if (isLexicalScopeDIENull(Scope))
496 return 0;
497
Devang Patel6c74a872010-04-27 19:46:33 +0000498 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
499 if (Scope->isAbstractScope())
500 return ScopeDIE;
501
Eric Christopher0f63d062013-12-03 00:45:45 +0000502 const SmallVectorImpl<InsnRange> &ScopeRanges = Scope->getRanges();
Eric Christopherbe2513e2013-12-03 00:45:59 +0000503
Eric Christopherdc42ea82013-07-03 01:57:28 +0000504 // If we have multiple ranges, emit them into the range section.
Eric Christopher0f63d062013-12-03 00:45:45 +0000505 if (ScopeRanges.size() > 1) {
Eric Christopherbe2513e2013-12-03 00:45:59 +0000506 addScopeRangeList(TheCU, ScopeDIE, ScopeRanges);
Devang Patel6c74a872010-04-27 19:46:33 +0000507 return ScopeDIE;
508 }
509
Eric Christopherdc42ea82013-07-03 01:57:28 +0000510 // Construct the address range for this DIE.
Eric Christopher0f63d062013-12-03 00:45:45 +0000511 SmallVectorImpl<InsnRange>::const_iterator RI = ScopeRanges.begin();
Eric Christopher962c9082013-01-15 23:56:56 +0000512 MCSymbol *Start = getLabelBeforeInsn(RI->first);
513 MCSymbol *End = getLabelAfterInsn(RI->second);
Manman Ren2312ed32013-09-10 18:40:41 +0000514 assert(End && "End label should not be null!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000515
Chris Lattnere13c3722010-03-09 01:58:53 +0000516 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
517 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000518
Eric Christopher962c9082013-01-15 23:56:56 +0000519 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
520 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000521
522 return ScopeDIE;
523}
524
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000525// This scope represents inlined body of a function. Construct DIE to
526// represent this concrete inlined copy of the function.
Eric Christopher4287a492013-12-09 23:57:44 +0000527DIE *DwarfDebug::constructInlinedScopeDIE(DwarfCompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000528 LexicalScope *Scope) {
Eric Christopher0f63d062013-12-03 00:45:45 +0000529 const SmallVectorImpl<InsnRange> &ScopeRanges = Scope->getRanges();
Eric Christopher1cdb63d2013-12-04 21:20:15 +0000530 assert(!ScopeRanges.empty() &&
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000531 "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000532
Devang Patelf098ce22011-07-27 00:34:13 +0000533 if (!Scope->getScopeNode())
534 return NULL;
535 DIScope DS(Scope->getScopeNode());
536 DISubprogram InlinedSP = getDISubprogram(DS);
Eric Christophere595bae2013-10-04 17:08:38 +0000537 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patelf098ce22011-07-27 00:34:13 +0000538 if (!OriginDIE) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000539 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patelf098ce22011-07-27 00:34:13 +0000540 return NULL;
541 }
542
Devang Patel73bc1722011-05-05 17:54:26 +0000543 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Manman Ren4c4b69c2013-10-11 23:58:05 +0000544 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000545
Eric Christopherbe2513e2013-12-03 00:45:59 +0000546 // If we have multiple ranges, emit them into the range section.
547 if (ScopeRanges.size() > 1)
548 addScopeRangeList(TheCU, ScopeDIE, ScopeRanges);
549 else {
Eric Christopher0f63d062013-12-03 00:45:45 +0000550 SmallVectorImpl<InsnRange>::const_iterator RI = ScopeRanges.begin();
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000551 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
552 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
553
554 if (StartLabel == 0 || EndLabel == 0)
555 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
556
557 assert(StartLabel->isDefined() &&
558 "Invalid starting label for an inlined scope!");
559 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
560
Eric Christopher962c9082013-01-15 23:56:56 +0000561 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
562 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patelf098ce22011-07-27 00:34:13 +0000563 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000564
565 InlinedSubprogramDIEs.insert(OriginDIE);
566
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000567 // Add the call site information to the DIE.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000568 DILocation DL(Scope->getInlinedAt());
David Blaikief2443192013-10-21 17:28:37 +0000569 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, None,
Manman Ren1e427202013-03-07 01:42:00 +0000570 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
571 TheCU->getUniqueID()));
David Blaikief2443192013-10-21 17:28:37 +0000572 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, None, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000573
Eric Christopher8dda5d02011-12-04 06:02:38 +0000574 // Add name to the name table, we do this here because we're guaranteed
575 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
576 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher6a841382012-11-19 22:42:10 +0000577
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000578 return ScopeDIE;
579}
580
Eric Christopher4287a492013-12-09 23:57:44 +0000581DIE *DwarfDebug::createScopeChildrenDIE(DwarfCompileUnit *TheCU,
582 LexicalScope *Scope,
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000583 SmallVectorImpl<DIE *> &Children) {
584 DIE *ObjectPointer = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +0000585
586 // Collect arguments for current function.
Devang Patel7e623022011-08-10 20:55:27 +0000587 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000588 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
589 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher6a841382012-11-19 22:42:10 +0000590 if (DIE *Arg =
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000591 TheCU->constructVariableDIE(*ArgDV, Scope->isAbstractScope())) {
Devang Patel6c622ef2011-03-01 22:58:55 +0000592 Children.push_back(Arg);
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000593 if (ArgDV->isObjectPointer())
594 ObjectPointer = Arg;
Eric Christophere3417762012-09-12 23:36:19 +0000595 }
Devang Patel6c622ef2011-03-01 22:58:55 +0000596
Eric Christopherf84354b2011-10-03 15:49:16 +0000597 // Collect lexical scope children first.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000598 const SmallVectorImpl<DbgVariable *> &Variables =
599 ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000600 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000601 if (DIE *Variable = TheCU->constructVariableDIE(*Variables[i],
602 Scope->isAbstractScope())) {
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000603 Children.push_back(Variable);
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000604 if (Variables[i]->isObjectPointer())
605 ObjectPointer = Variable;
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000606 }
Craig Topper977e9cd2013-07-03 04:24:43 +0000607 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000608 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Patel3acc70e2011-08-15 22:04:40 +0000609 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000610 Children.push_back(Nested);
Manman Ren2312ed32013-09-10 18:40:41 +0000611 return ObjectPointer;
612}
613
614// Construct a DIE for this scope.
Eric Christopher4287a492013-12-09 23:57:44 +0000615DIE *DwarfDebug::constructScopeDIE(DwarfCompileUnit *TheCU,
616 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000617 if (!Scope || !Scope->getScopeNode())
618 return NULL;
619
620 DIScope DS(Scope->getScopeNode());
621
622 SmallVector<DIE *, 8> Children;
623 DIE *ObjectPointer = NULL;
624 bool ChildrenCreated = false;
625
Manman Ren5b2f4b02013-09-11 19:40:28 +0000626 // We try to create the scope DIE first, then the children DIEs. This will
627 // avoid creating un-used children then removing them later when we find out
628 // the scope DIE is null.
Devang Patel3b548aa2010-03-08 20:52:55 +0000629 DIE *ScopeDIE = NULL;
630 if (Scope->getInlinedAt())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000631 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3b548aa2010-03-08 20:52:55 +0000632 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000633 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000634 if (Scope->isAbstractScope()) {
Eric Christophere595bae2013-10-04 17:08:38 +0000635 ScopeDIE = TheCU->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000636 // Note down abstract DIE.
637 if (ScopeDIE)
638 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
David Blaikiee26a3772013-11-18 23:59:04 +0000639 } else
David Blaikie25bc7192013-11-15 23:13:08 +0000640 ScopeDIE = updateSubprogramScopeDIE(TheCU, DISubprogram(DS));
David Blaikiee26a3772013-11-18 23:59:04 +0000641 } else {
Manman Ren5b2f4b02013-09-11 19:40:28 +0000642 // Early exit when we know the scope DIE is going to be null.
Manman Ren2312ed32013-09-10 18:40:41 +0000643 if (isLexicalScopeDIENull(Scope))
644 return NULL;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000645
646 // We create children here when we know the scope DIE is not going to be
647 // null and the children will be added to the scope DIE.
Manman Ren2312ed32013-09-10 18:40:41 +0000648 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
649 ChildrenCreated = true;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000650
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000651 // There is no need to emit empty lexical block DIE.
David Blaikie684fc532013-05-06 23:33:07 +0000652 std::pair<ImportedEntityMap::const_iterator,
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000653 ImportedEntityMap::const_iterator> Range =
654 std::equal_range(
655 ScopesWithImportedEntities.begin(),
656 ScopesWithImportedEntities.end(),
657 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode *)0),
658 less_first());
David Blaikie684fc532013-05-06 23:33:07 +0000659 if (Children.empty() && Range.first == Range.second)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000660 return NULL;
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000661 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Manman Ren2312ed32013-09-10 18:40:41 +0000662 assert(ScopeDIE && "Scope DIE should not be null.");
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000663 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
664 ++i)
David Blaikie4dd2de72013-05-08 06:01:38 +0000665 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000666 }
Eric Christopher6a841382012-11-19 22:42:10 +0000667
Benjamin Kramer892daba2013-08-24 11:55:49 +0000668 if (!ScopeDIE) {
Manman Ren2312ed32013-09-10 18:40:41 +0000669 assert(Children.empty() &&
670 "We create children only when the scope DIE is not null.");
Benjamin Kramer892daba2013-08-24 11:55:49 +0000671 return NULL;
672 }
Manman Ren2312ed32013-09-10 18:40:41 +0000673 if (!ChildrenCreated)
Manman Ren5b2f4b02013-09-11 19:40:28 +0000674 // We create children when the scope DIE is not null.
Manman Ren2312ed32013-09-10 18:40:41 +0000675 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000676
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000677 // Add children
Craig Topperd8e43652013-07-03 04:17:25 +0000678 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000679 E = Children.end();
680 I != E; ++I)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000681 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000682
Eric Christophere3417762012-09-12 23:36:19 +0000683 if (DS.isSubprogram() && ObjectPointer != NULL)
Manman Ren4c4b69c2013-10-11 23:58:05 +0000684 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, ObjectPointer);
Eric Christophere3417762012-09-12 23:36:19 +0000685
Eric Christopherd9843b32011-11-10 19:25:34 +0000686 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000687}
688
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000689// Look up the source id with the given directory and source file names.
690// If none currently exists, create a new id and insert it in the
691// SourceIds map. This can update DirectoryNames and SourceFileNames maps
692// as well.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000693unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName, StringRef DirName,
694 unsigned CUID) {
Manman Ren1e427202013-03-07 01:42:00 +0000695 // If we use .loc in assembly, we can't separate .file entries according to
696 // compile units. Thus all files will belong to the default compile unit.
Rafael Espindolaac4ad252013-10-05 16:42:21 +0000697
698 // FIXME: add a better feature test than hasRawTextSupport. Even better,
699 // extend .file to support this.
700 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren1e427202013-03-07 01:42:00 +0000701 CUID = 0;
702
Devang Patel871d0b12010-09-16 20:57:49 +0000703 // If FE did not provide a file name, then assume stdin.
704 if (FileName.empty())
Manman Ren1e427202013-03-07 01:42:00 +0000705 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patele01b75c2011-03-24 20:30:50 +0000706
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000707 // TODO: this might not belong here. See if we can factor this better.
708 if (DirName == CompilationDir)
709 DirName = "";
710
Manman Ren1e427202013-03-07 01:42:00 +0000711 // FileIDCUMap stores the current ID for the given compile unit.
712 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel871d0b12010-09-16 20:57:49 +0000713
Manman Ren1e427202013-03-07 01:42:00 +0000714 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer71b19732012-03-11 14:56:26 +0000715 SmallString<128> NamePair;
Manman Ren5b22f9f2013-04-06 01:02:38 +0000716 NamePair += utostr(CUID);
Manman Ren1e427202013-03-07 01:42:00 +0000717 NamePair += '\0';
Benjamin Kramer71b19732012-03-11 14:56:26 +0000718 NamePair += DirName;
719 NamePair += '\0'; // Zero bytes are not allowed in paths.
720 NamePair += FileName;
721
722 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
723 if (Ent.getValue() != SrcId)
724 return Ent.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +0000725
Manman Ren1e427202013-03-07 01:42:00 +0000726 FileIDCUMap[CUID] = SrcId;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000727 // Print out a .file directive to specify files for .loc directives.
Manman Ren1e427202013-03-07 01:42:00 +0000728 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendling2b128d72009-05-20 23:19:06 +0000729
730 return SrcId;
731}
732
Eric Christophera5a79422013-12-09 23:32:48 +0000733void DwarfDebug::addGnuPubAttributes(DwarfUnit *U, DIE *D) const {
David Blaikie3c842622013-12-04 21:31:26 +0000734 if (!GenerateGnuPubSections)
735 return;
736
737 addSectionLabel(Asm, U, D, dwarf::DW_AT_GNU_pubnames,
738 Asm->GetTempSymbol("gnu_pubnames", U->getUniqueID()),
739 DwarfGnuPubNamesSectionSym);
740
741 addSectionLabel(Asm, U, D, dwarf::DW_AT_GNU_pubtypes,
742 Asm->GetTempSymbol("gnu_pubtypes", U->getUniqueID()),
743 DwarfGnuPubTypesSectionSym);
744}
745
Eric Christopher4287a492013-12-09 23:57:44 +0000746// Create new DwarfCompileUnit for the given metadata node with tag
Eric Christopher48fef592012-12-20 21:58:40 +0000747// DW_TAG_compile_unit.
Eric Christopher4287a492013-12-09 23:57:44 +0000748DwarfCompileUnit *DwarfDebug::constructDwarfCompileUnit(DICompileUnit DIUnit) {
Devang Patel2d9caf92009-11-25 17:36:49 +0000749 StringRef FN = DIUnit.getFilename();
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000750 CompilationDir = DIUnit.getDirectory();
Bill Wendling2b128d72009-05-20 23:19:06 +0000751
752 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher4287a492013-12-09 23:57:44 +0000753 DwarfCompileUnit *NewCU = new DwarfCompileUnit(
754 InfoHolder.getUnits().size(), Die, DIUnit, Asm, this, &InfoHolder);
David Blaikie2666e242013-12-06 19:38:46 +0000755 InfoHolder.addUnit(NewCU);
756
Manman Ren1e427202013-03-07 01:42:00 +0000757 FileIDCUMap[NewCU->getUniqueID()] = 0;
758 // Call this to emit a .file directive if it wasn't emitted for the source
759 // file this CU comes from yet.
760 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
761
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000762 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patelf20c4f72011-04-12 22:53:02 +0000763 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
764 DIUnit.getLanguage());
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000765 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christopher52ce7182013-04-09 19:23:15 +0000766
Eric Christopherb1b94512012-08-01 18:19:01 +0000767 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher52ce7182013-04-09 19:23:15 +0000768 // into an entity. We're using 0 (or a NULL label) for this. For
769 // split dwarf it's in the skeleton CU so omit it here.
770 if (!useSplitDwarf())
771 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
Manman Ren4e042a62013-02-05 21:52:47 +0000772
773 // Define start line table label for each Compile Unit.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000774 MCSymbol *LineTableStartSym =
775 Asm->GetTempSymbol("line_table_start", NewCU->getUniqueID());
Manman Ren4e042a62013-02-05 21:52:47 +0000776 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
777 NewCU->getUniqueID());
778
Manman Ren9d4c7352013-05-21 00:57:22 +0000779 // Use a single line table if we are using .loc and generating assembly.
780 bool UseTheFirstCU =
Rafael Espindolaac4ad252013-10-05 16:42:21 +0000781 (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport()) ||
782 (NewCU->getUniqueID() == 0);
Manman Ren9d4c7352013-05-21 00:57:22 +0000783
Eric Christopher52ce7182013-04-09 19:23:15 +0000784 if (!useSplitDwarf()) {
Eric Christophera51d3fc2013-09-27 22:50:48 +0000785 // DW_AT_stmt_list is a offset of line number information for this
786 // compile unit in debug_line section. For split dwarf this is
787 // left in the skeleton CU and so not included.
788 // The line table entries are not always emitted in assembly, so it
789 // is not okay to use line_table_start here.
Eric Christopher52ce7182013-04-09 19:23:15 +0000790 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christophera5a79422013-12-09 23:32:48 +0000791 NewCU->addSectionLabel(Die, dwarf::DW_AT_stmt_list,
792 UseTheFirstCU ? Asm->GetTempSymbol("section_line")
793 : LineTableStartSym);
Manman Ren9d4c7352013-05-21 00:57:22 +0000794 else if (UseTheFirstCU)
Eric Christopher33ff6972013-11-21 23:46:41 +0000795 NewCU->addSectionOffset(Die, dwarf::DW_AT_stmt_list, 0);
Eric Christopher52ce7182013-04-09 19:23:15 +0000796 else
Eric Christophera5a79422013-12-09 23:32:48 +0000797 NewCU->addSectionDelta(Die, dwarf::DW_AT_stmt_list, LineTableStartSym,
798 DwarfLineSectionSym);
Eric Christophera51d3fc2013-09-27 22:50:48 +0000799
800 // If we're using split dwarf the compilation dir is going to be in the
801 // skeleton CU and so we don't need to duplicate it here.
802 if (!CompilationDir.empty())
803 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
804
David Blaikie3c842622013-12-04 21:31:26 +0000805 addGnuPubAttributes(NewCU, Die);
Eric Christopher52ce7182013-04-09 19:23:15 +0000806 }
Bill Wendling2b128d72009-05-20 23:19:06 +0000807
Bill Wendling2b128d72009-05-20 23:19:06 +0000808 if (DIUnit.isOptimized())
Eric Christopherbb69a272012-08-24 01:14:27 +0000809 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendling2b128d72009-05-20 23:19:06 +0000810
Devang Patel2d9caf92009-11-25 17:36:49 +0000811 StringRef Flags = DIUnit.getFlags();
812 if (!Flags.empty())
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000813 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher6a841382012-11-19 22:42:10 +0000814
Nick Lewycky479a8fe2011-10-17 23:27:36 +0000815 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patelf20c4f72011-04-12 22:53:02 +0000816 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000817 dwarf::DW_FORM_data1, RVer);
Bill Wendling2b128d72009-05-20 23:19:06 +0000818
Devang Patel1a0df9a2010-05-10 22:49:55 +0000819 if (!FirstCU)
820 FirstCU = NewCU;
Eric Christopher7a2cdf72013-02-05 07:31:55 +0000821
David Blaikie03073f72013-12-06 22:14:48 +0000822 NewCU->initSection(
823 useSplitDwarf() ? Asm->getObjFileLowering().getDwarfInfoDWOSection()
824 : Asm->getObjFileLowering().getDwarfInfoSection(),
825 // FIXME: This is subtle (using the info section even when
826 // this CU is in the dwo section) and necessary for the
827 // current arange code - ideally it should iterate
828 // skeleton units, not full units, if it's going to reference skeletons
829 DwarfInfoSectionSym);
830
David Blaikie5a152402013-11-15 23:52:02 +0000831 CUMap.insert(std::make_pair(DIUnit, NewCU));
Manman Rence20d462013-10-29 22:57:10 +0000832 CUDieMap.insert(std::make_pair(Die, NewCU));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000833 return NewCU;
Devang Patel1a0df9a2010-05-10 22:49:55 +0000834}
835
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000836// Construct subprogram DIE.
Eric Christopher4287a492013-12-09 23:57:44 +0000837void DwarfDebug::constructSubprogramDIE(DwarfCompileUnit *TheCU,
838 const MDNode *N) {
Eric Christopherffbc4de2013-10-18 01:57:30 +0000839 // FIXME: We should only call this routine once, however, during LTO if a
840 // program is defined in multiple CUs we could end up calling it out of
841 // beginModule as we walk the CUs.
842
Eric Christopher4287a492013-12-09 23:57:44 +0000843 DwarfCompileUnit *&CURef = SPMap[N];
Eric Christopherffbc4de2013-10-18 01:57:30 +0000844 if (CURef)
845 return;
846 CURef = TheCU;
Rafael Espindola6cf4e832011-11-04 19:00:29 +0000847
Devang Patel80ae3492009-08-28 23:24:31 +0000848 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000849 if (!SP.isDefinition())
850 // This is a method declaration which will be handled while constructing
851 // class type.
Devang Patel0751a282009-06-26 01:49:18 +0000852 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000853
Devang Patel89543712011-08-15 17:24:54 +0000854 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000855
Eric Christopherba506db2013-09-09 20:03:20 +0000856 // Expose as a global name.
Eric Christopher2c8b7902013-10-17 02:06:06 +0000857 TheCU->addGlobalName(SP.getName(), SubprogramDie, resolve(SP.getContext()));
Bill Wendling2b128d72009-05-20 23:19:06 +0000858}
859
Eric Christopher4287a492013-12-09 23:57:44 +0000860void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit *TheCU,
David Blaikief55abea2013-04-22 06:12:31 +0000861 const MDNode *N) {
David Blaikie1fd43652013-05-07 21:35:53 +0000862 DIImportedEntity Module(N);
David Blaikief55abea2013-04-22 06:12:31 +0000863 if (!Module.Verify())
864 return;
David Blaikie684fc532013-05-06 23:33:07 +0000865 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
David Blaikie4dd2de72013-05-08 06:01:38 +0000866 constructImportedEntityDIE(TheCU, Module, D);
David Blaikie684fc532013-05-06 23:33:07 +0000867}
868
Eric Christopher4287a492013-12-09 23:57:44 +0000869void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit *TheCU,
870 const MDNode *N, DIE *Context) {
David Blaikie1fd43652013-05-07 21:35:53 +0000871 DIImportedEntity Module(N);
David Blaikie684fc532013-05-06 23:33:07 +0000872 if (!Module.Verify())
873 return;
David Blaikie4dd2de72013-05-08 06:01:38 +0000874 return constructImportedEntityDIE(TheCU, Module, Context);
David Blaikie684fc532013-05-06 23:33:07 +0000875}
876
Eric Christopher4287a492013-12-09 23:57:44 +0000877void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit *TheCU,
David Blaikie1fd43652013-05-07 21:35:53 +0000878 const DIImportedEntity &Module,
David Blaikie684fc532013-05-06 23:33:07 +0000879 DIE *Context) {
880 assert(Module.Verify() &&
881 "Use one of the MDNode * overloads to handle invalid metadata");
882 assert(Context && "Should always have a context for an imported_module");
David Blaikie1fd43652013-05-07 21:35:53 +0000883 DIE *IMDie = new DIE(Module.getTag());
David Blaikief55abea2013-04-22 06:12:31 +0000884 TheCU->insertDIE(Module, IMDie);
David Blaikie1fd43652013-05-07 21:35:53 +0000885 DIE *EntityDie;
886 DIDescriptor Entity = Module.getEntity();
887 if (Entity.isNameSpace())
888 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
889 else if (Entity.isSubprogram())
890 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
David Blaikie3b6038b2013-05-08 06:01:41 +0000891 else if (Entity.isType())
892 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
David Blaikie1fd43652013-05-07 21:35:53 +0000893 else
David Blaikie3b6038b2013-05-08 06:01:41 +0000894 EntityDie = TheCU->getDIE(Entity);
David Blaikief55abea2013-04-22 06:12:31 +0000895 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
896 Module.getContext().getDirectory(),
897 TheCU->getUniqueID());
David Blaikief2443192013-10-21 17:28:37 +0000898 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, None, FileID);
899 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, None, Module.getLineNumber());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000900 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, EntityDie);
David Blaikiee63d5d12013-05-20 22:50:35 +0000901 StringRef Name = Module.getName();
902 if (!Name.empty())
903 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
David Blaikie684fc532013-05-06 23:33:07 +0000904 Context->addChild(IMDie);
David Blaikief55abea2013-04-22 06:12:31 +0000905}
906
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000907// Emit all Dwarf sections that should come prior to the content. Create
908// global DIEs and emit initial debug info sections. This is invoked by
909// the target AsmPrinter.
Eric Christopher58f41952012-11-19 22:42:15 +0000910void DwarfDebug::beginModule() {
Devang Patel6c74a872010-04-27 19:46:33 +0000911 if (DisableDebugInfoPrinting)
912 return;
913
Eric Christopher58f41952012-11-19 22:42:15 +0000914 const Module *M = MMI->getModule();
915
Nick Lewycky019d2552011-07-29 03:49:23 +0000916 // If module has named metadata anchors then use them, otherwise scan the
917 // module using debug info finder to collect debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000918 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
David Blaikiedc69ebb2013-03-11 23:39:23 +0000919 if (!CU_Nodes)
Devang Patel07bb9ee2011-08-15 23:47:24 +0000920 return;
Manman Ren60352032013-09-05 18:48:31 +0000921 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
Devang Patele02e5852011-05-03 16:45:22 +0000922
David Blaikiedc69ebb2013-03-11 23:39:23 +0000923 // Emit initial sections so we can reference labels later.
924 emitSectionLabels();
925
926 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
927 DICompileUnit CUNode(CU_Nodes->getOperand(i));
Eric Christopher4287a492013-12-09 23:57:44 +0000928 DwarfCompileUnit *CU = constructDwarfCompileUnit(CUNode);
David Blaikie1fd43652013-05-07 21:35:53 +0000929 DIArray ImportedEntities = CUNode.getImportedEntities();
930 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
David Blaikie684fc532013-05-06 23:33:07 +0000931 ScopesWithImportedEntities.push_back(std::make_pair(
David Blaikie1fd43652013-05-07 21:35:53 +0000932 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
933 ImportedEntities.getElement(i)));
David Blaikie684fc532013-05-06 23:33:07 +0000934 std::sort(ScopesWithImportedEntities.begin(),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000935 ScopesWithImportedEntities.end(), less_first());
David Blaikiedc69ebb2013-03-11 23:39:23 +0000936 DIArray GVs = CUNode.getGlobalVariables();
937 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
David Blaikiea781b25b2013-11-17 21:55:13 +0000938 CU->createGlobalVariableDIE(DIGlobalVariable(GVs.getElement(i)));
David Blaikiedc69ebb2013-03-11 23:39:23 +0000939 DIArray SPs = CUNode.getSubprograms();
940 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
941 constructSubprogramDIE(CU, SPs.getElement(i));
942 DIArray EnumTypes = CUNode.getEnumTypes();
943 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
944 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
945 DIArray RetainedTypes = CUNode.getRetainedTypes();
946 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
947 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
David Blaikief55abea2013-04-22 06:12:31 +0000948 // Emit imported_modules last so that the relevant context is already
949 // available.
David Blaikie1fd43652013-05-07 21:35:53 +0000950 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
951 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
David Blaikiedc69ebb2013-03-11 23:39:23 +0000952 }
Eric Christopher6a841382012-11-19 22:42:10 +0000953
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000954 // Tell MMI that we have debug info.
955 MMI->setDebugInfoAvailability(true);
Eric Christopher6a841382012-11-19 22:42:10 +0000956
Bill Wendling2b128d72009-05-20 23:19:06 +0000957 // Prime section data.
Richard Mitton21101b32013-09-19 23:21:01 +0000958 SectionMap[Asm->getObjFileLowering().getTextSection()];
Bill Wendling2b128d72009-05-20 23:19:06 +0000959}
960
Eric Christopher960ac372012-11-22 00:59:49 +0000961// Attach DW_AT_inline attribute with inlined subprogram DIEs.
962void DwarfDebug::computeInlinedDIEs() {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000963 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
964 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000965 AE = InlinedSubprogramDIEs.end();
966 AI != AE; ++AI) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000967 DIE *ISP = *AI;
David Blaikief2443192013-10-21 17:28:37 +0000968 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000969 }
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000970 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000971 AE = AbstractSPDies.end();
972 AI != AE; ++AI) {
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000973 DIE *ISP = AI->second;
974 if (InlinedSubprogramDIEs.count(ISP))
975 continue;
David Blaikief2443192013-10-21 17:28:37 +0000976 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000977 }
Eric Christopher960ac372012-11-22 00:59:49 +0000978}
979
980// Collect info for variables that were optimized out.
981void DwarfDebug::collectDeadVariables() {
982 const Module *M = MMI->getModule();
Eric Christopher960ac372012-11-22 00:59:49 +0000983
984 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
985 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
986 DICompileUnit TheCU(CU_Nodes->getOperand(i));
987 DIArray Subprograms = TheCU.getSubprograms();
988 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopher735401c2012-11-27 00:13:51 +0000989 DISubprogram SP(Subprograms.getElement(i));
Eric Christophera6c38a32013-10-15 23:31:38 +0000990 if (ProcessedSPNodes.count(SP) != 0)
991 continue;
992 if (!SP.isSubprogram())
993 continue;
994 if (!SP.isDefinition())
995 continue;
Eric Christopher735401c2012-11-27 00:13:51 +0000996 DIArray Variables = SP.getVariables();
Eric Christophera6c38a32013-10-15 23:31:38 +0000997 if (Variables.getNumElements() == 0)
998 continue;
Eric Christopher960ac372012-11-22 00:59:49 +0000999
Eric Christopher735401c2012-11-27 00:13:51 +00001000 // Construct subprogram DIE and add variables DIEs.
Eric Christopher4287a492013-12-09 23:57:44 +00001001 DwarfCompileUnit *SPCU =
1002 static_cast<DwarfCompileUnit *>(CUMap.lookup(TheCU));
Eric Christopher735401c2012-11-27 00:13:51 +00001003 assert(SPCU && "Unable to find Compile Unit!");
Eric Christopherc798d8a2013-10-22 00:22:39 +00001004 // FIXME: See the comment in constructSubprogramDIE about duplicate
1005 // subprogram DIEs.
1006 constructSubprogramDIE(SPCU, SP);
1007 DIE *SPDIE = SPCU->getDIE(SP);
Eric Christopher735401c2012-11-27 00:13:51 +00001008 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
1009 DIVariable DV(Variables.getElement(vi));
Eric Christophera6c38a32013-10-15 23:31:38 +00001010 if (!DV.isVariable())
1011 continue;
Manman Renb3388602013-10-05 01:43:03 +00001012 DbgVariable NewVar(DV, NULL, this);
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001013 if (DIE *VariableDIE = SPCU->constructVariableDIE(NewVar, false))
Eric Christophera6c38a32013-10-15 23:31:38 +00001014 SPDIE->addChild(VariableDIE);
Eric Christopher735401c2012-11-27 00:13:51 +00001015 }
Eric Christopher960ac372012-11-22 00:59:49 +00001016 }
1017 }
1018 }
Eric Christopher960ac372012-11-22 00:59:49 +00001019}
1020
Eric Christopher45731982013-08-08 23:45:55 +00001021// Type Signature [7.27] and ODR Hash code.
Eric Christopher67646432013-07-26 17:02:41 +00001022
1023/// \brief Grabs the string in whichever attribute is passed in and returns
Eric Christopher8552e222013-08-07 01:18:33 +00001024/// a reference to it. Returns "" if the attribute doesn't exist.
Eric Christopher67646432013-07-26 17:02:41 +00001025static StringRef getDIEStringAttr(DIE *Die, unsigned Attr) {
Eric Christopher8552e222013-08-07 01:18:33 +00001026 DIEValue *V = Die->findAttribute(Attr);
Eric Christopher67646432013-07-26 17:02:41 +00001027
Eric Christopher8552e222013-08-07 01:18:33 +00001028 if (DIEString *S = dyn_cast_or_null<DIEString>(V))
1029 return S->getString();
1030
Eric Christopher67646432013-07-26 17:02:41 +00001031 return StringRef("");
1032}
1033
Eric Christopher67646432013-07-26 17:02:41 +00001034/// Return true if the current DIE is contained within an anonymous namespace.
1035static bool isContainedInAnonNamespace(DIE *Die) {
1036 DIE *Parent = Die->getParent();
1037
1038 while (Parent) {
Eric Christophere414ece2013-07-29 23:53:08 +00001039 if (Parent->getTag() == dwarf::DW_TAG_namespace &&
1040 getDIEStringAttr(Parent, dwarf::DW_AT_name) == "")
Eric Christopher67646432013-07-26 17:02:41 +00001041 return true;
1042 Parent = Parent->getParent();
1043 }
1044
1045 return false;
1046}
1047
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001048/// Test if the current CU language is C++ and that we have
1049/// a named type that is not contained in an anonymous namespace.
Eric Christopher4287a492013-12-09 23:57:44 +00001050static bool shouldAddODRHash(DwarfTypeUnit *CU, DIE *Die) {
Eric Christopher341770d2013-08-07 08:35:10 +00001051 return CU->getLanguage() == dwarf::DW_LANG_C_plus_plus &&
1052 getDIEStringAttr(Die, dwarf::DW_AT_name) != "" &&
1053 !isContainedInAnonNamespace(Die);
Eric Christopher45731982013-08-08 23:45:55 +00001054}
Eric Christopheraf15f8d2013-08-07 01:18:24 +00001055
Eric Christopher960ac372012-11-22 00:59:49 +00001056void DwarfDebug::finalizeModuleInfo() {
1057 // Collect info for variables that were optimized out.
1058 collectDeadVariables();
1059
1060 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1061 computeInlinedDIEs();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001062
Eric Christopherad10cb52013-12-04 23:24:38 +00001063 // Handle anything that needs to be done on a per-unit basis after
1064 // all other generation.
Eric Christophera5a79422013-12-09 23:32:48 +00001065 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
1066 E = getUnits().end();
David Blaikiefd1eff52013-11-26 19:14:34 +00001067 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00001068 DwarfUnit *TheU = *I;
Eric Christopher60eb7692013-08-12 20:27:48 +00001069 // Emit DW_AT_containing_type attribute to connect types with their
1070 // vtable holding type.
David Blaikie2a80e442013-12-02 22:09:48 +00001071 TheU->constructContainingTypeDIEs();
Eric Christopher60eb7692013-08-12 20:27:48 +00001072
1073 // If we're splitting the dwarf out now that we've got the entire
1074 // CU then construct a skeleton CU based upon it.
David Blaikie319a05f2013-12-02 19:33:10 +00001075 if (useSplitDwarf() &&
David Blaikie2a80e442013-12-02 22:09:48 +00001076 TheU->getUnitDie()->getTag() == dwarf::DW_TAG_compile_unit) {
Eric Christopherd29614f2013-08-13 01:21:55 +00001077 uint64_t ID = 0;
1078 if (GenerateCUHash) {
1079 DIEHash CUHash;
David Blaikie2a80e442013-12-02 22:09:48 +00001080 ID = CUHash.computeCUSignature(*TheU->getUnitDie());
Eric Christopherd29614f2013-08-13 01:21:55 +00001081 }
Eric Christopher60eb7692013-08-12 20:27:48 +00001082 // This should be a unique identifier when we want to build .dwp files.
David Blaikie2a80e442013-12-02 22:09:48 +00001083 TheU->addUInt(TheU->getUnitDie(), dwarf::DW_AT_GNU_dwo_id,
1084 dwarf::DW_FORM_data8, ID);
Eric Christopher60eb7692013-08-12 20:27:48 +00001085 // Now construct the skeleton CU associated.
Eric Christopher4287a492013-12-09 23:57:44 +00001086 DwarfCompileUnit *SkCU =
1087 constructSkeletonCU(static_cast<DwarfCompileUnit *>(TheU));
Eric Christopher60eb7692013-08-12 20:27:48 +00001088 // This should be a unique identifier when we want to build .dwp files.
David Blaikie2a80e442013-12-02 22:09:48 +00001089 SkCU->addUInt(SkCU->getUnitDie(), dwarf::DW_AT_GNU_dwo_id,
Eric Christopherd29614f2013-08-13 01:21:55 +00001090 dwarf::DW_FORM_data8, ID);
Eric Christopher60eb7692013-08-12 20:27:48 +00001091 }
1092 }
1093
1094 // Compute DIE offsets and sizes.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001095 InfoHolder.computeSizeAndOffsets();
1096 if (useSplitDwarf())
1097 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher960ac372012-11-22 00:59:49 +00001098}
1099
1100void DwarfDebug::endSections() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001101 // Filter labels by section.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001102 for (size_t n = 0; n < ArangeLabels.size(); n++) {
1103 const SymbolCU &SCU = ArangeLabels[n];
Richard Mitton21101b32013-09-19 23:21:01 +00001104 if (SCU.Sym->isInSection()) {
1105 // Make a note of this symbol and it's section.
1106 const MCSection *Section = &SCU.Sym->getSection();
1107 if (!Section->getKind().isMetadata())
1108 SectionMap[Section].push_back(SCU);
1109 } else {
1110 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1111 // appear in the output. This sucks as we rely on sections to build
1112 // arange spans. We can do it without, but it's icky.
1113 SectionMap[NULL].push_back(SCU);
1114 }
1115 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001116
Richard Mittonc2508242013-10-03 22:07:08 +00001117 // Build a list of sections used.
1118 std::vector<const MCSection *> Sections;
Richard Mitton21101b32013-09-19 23:21:01 +00001119 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1120 it++) {
1121 const MCSection *Section = it->first;
Richard Mittonc2508242013-10-03 22:07:08 +00001122 Sections.push_back(Section);
1123 }
1124
1125 // Sort the sections into order.
1126 // This is only done to ensure consistent output order across different runs.
1127 std::sort(Sections.begin(), Sections.end(), SectionSort);
1128
1129 // Add terminating symbols for each section.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001130 for (unsigned ID = 0; ID < Sections.size(); ID++) {
Richard Mittonc2508242013-10-03 22:07:08 +00001131 const MCSection *Section = Sections[ID];
Richard Mitton21101b32013-09-19 23:21:01 +00001132 MCSymbol *Sym = NULL;
1133
1134 if (Section) {
Richard Mittonc2508242013-10-03 22:07:08 +00001135 // We can't call MCSection::getLabelEndName, as it's only safe to do so
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001136 // if we know the section name up-front. For user-created sections, the
1137 // resulting
1138 // label may not be valid to use as a label. (section names can use a
1139 // greater
Richard Mittonc2508242013-10-03 22:07:08 +00001140 // set of characters on some systems)
1141 Sym = Asm->GetTempSymbol("debug_end", ID);
Richard Mitton21101b32013-09-19 23:21:01 +00001142 Asm->OutStreamer.SwitchSection(Section);
1143 Asm->OutStreamer.EmitLabel(Sym);
1144 }
1145
1146 // Insert a final terminator.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001147 SectionMap[Section].push_back(SymbolCU(NULL, Sym));
Bill Wendling2b128d72009-05-20 23:19:06 +00001148 }
Eric Christopher960ac372012-11-22 00:59:49 +00001149}
Bill Wendling2b128d72009-05-20 23:19:06 +00001150
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001151// Emit all Dwarf sections that should come after the content.
Eric Christopher960ac372012-11-22 00:59:49 +00001152void DwarfDebug::endModule() {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001153 assert(CurFn == 0);
1154 assert(CurMI == 0);
Eric Christopher960ac372012-11-22 00:59:49 +00001155
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001156 if (!FirstCU)
1157 return;
Eric Christopher960ac372012-11-22 00:59:49 +00001158
1159 // End any existing sections.
1160 // TODO: Does this need to happen?
1161 endSections();
1162
1163 // Finalize the debug info for the module.
1164 finalizeModuleInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001165
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001166 emitDebugStr();
Eric Christopher9cd26af2013-09-20 23:22:52 +00001167
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001168 // Emit all the DIEs into a debug info section.
1169 emitDebugInfo();
Eric Christopher4c9b1192012-11-27 00:41:54 +00001170
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001171 // Corresponding abbreviations into a abbrev section.
1172 emitAbbreviations();
Eric Christopher95198f502012-11-27 22:43:42 +00001173
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001174 // Emit info into a debug loc section.
1175 emitDebugLoc();
Eric Christopher95198f502012-11-27 22:43:42 +00001176
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001177 // Emit info into a debug aranges section.
1178 emitDebugARanges();
Eric Christopher95198f502012-11-27 22:43:42 +00001179
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001180 // Emit info into a debug ranges section.
1181 emitDebugRanges();
Eric Christopher95198f502012-11-27 22:43:42 +00001182
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001183 if (useSplitDwarf()) {
1184 emitDebugStrDWO();
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001185 emitDebugInfoDWO();
Eric Christopher3c5a1912012-12-19 22:02:53 +00001186 emitDebugAbbrevDWO();
Eric Christopher962c9082013-01-15 23:56:56 +00001187 // Emit DWO addresses.
1188 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
Eric Christopher95198f502012-11-27 22:43:42 +00001189 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001190
Eric Christophera876b822012-08-23 07:32:06 +00001191 // Emit info into the dwarf accelerator table sections.
Eric Christopher20b76a72012-08-23 22:36:40 +00001192 if (useDwarfAccelTables()) {
Eric Christopher4996c702011-11-07 09:24:32 +00001193 emitAccelNames();
1194 emitAccelObjC();
1195 emitAccelNamespaces();
1196 emitAccelTypes();
1197 }
Eric Christopher6a841382012-11-19 22:42:10 +00001198
Eric Christopher4b358182013-08-30 00:40:17 +00001199 // Emit the pubnames and pubtypes sections if requested.
1200 if (HasDwarfPubSections) {
David Blaikie70a33202013-09-19 17:33:35 +00001201 emitDebugPubNames(GenerateGnuPubSections);
1202 emitDebugPubTypes(GenerateGnuPubSections);
Eric Christopher4b358182013-08-30 00:40:17 +00001203 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001204
Devang Pateld0701282010-08-02 17:32:15 +00001205 // clean up.
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001206 SPMap.clear();
Eric Christopher8afd7b62012-12-10 19:51:18 +00001207
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001208 // Reset these for the next Module if we have one.
1209 FirstCU = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001210}
1211
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001212// Find abstract variable, if any, associated with Var.
Devang Patelbb23a4a2011-08-10 21:50:54 +00001213DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattner915c5f92010-04-02 19:42:39 +00001214 DebugLoc ScopeLoc) {
Devang Patelbb23a4a2011-08-10 21:50:54 +00001215 LLVMContext &Ctx = DV->getContext();
1216 // More then one inlined variable corresponds to one abstract variable.
1217 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001218 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001219 if (AbsDbgVariable)
1220 return AbsDbgVariable;
1221
Devang Patel7e623022011-08-10 20:55:27 +00001222 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001223 if (!Scope)
1224 return NULL;
1225
Manman Renb3388602013-10-05 01:43:03 +00001226 AbsDbgVariable = new DbgVariable(Var, NULL, this);
Devang Patel7e623022011-08-10 20:55:27 +00001227 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001228 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001229 return AbsDbgVariable;
1230}
1231
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001232// If Var is a current function argument then add it to CurrentFnArguments list.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001233bool DwarfDebug::addCurrentFnArgument(DbgVariable *Var, LexicalScope *Scope) {
Devang Patel7e623022011-08-10 20:55:27 +00001234 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +00001235 return false;
1236 DIVariable DV = Var->getVariable();
1237 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1238 return false;
1239 unsigned ArgNo = DV.getArgNumber();
Eric Christopher6a841382012-11-19 22:42:10 +00001240 if (ArgNo == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001241 return false;
1242
Devang Patel4ab660b2011-03-03 20:02:02 +00001243 size_t Size = CurrentFnArguments.size();
1244 if (Size == 0)
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001245 CurrentFnArguments.resize(CurFn->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001246 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001247 // arguments does the function have at source level.
1248 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001249 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001250 CurrentFnArguments[ArgNo - 1] = Var;
1251 return true;
1252}
1253
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001254// Collect variable information from side table maintained by MMI.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001255void DwarfDebug::collectVariableInfoFromMMITable(
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001256 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001257 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1258 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001259 VE = VMap.end();
1260 VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001261 const MDNode *Var = VI->first;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001262 if (!Var)
1263 continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001264 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001265 DIVariable DV(Var);
1266 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001267
Devang Patel7e623022011-08-10 20:55:27 +00001268 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001269
Devang Patelcdb7d442009-11-10 23:20:04 +00001270 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001271 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001272 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001273
Devang Patele1c53f22010-05-20 16:36:41 +00001274 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Manman Renb3388602013-10-05 01:43:03 +00001275 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
Devang Patel3e4a9652011-08-15 21:24:36 +00001276 RegVar->setFrameIndex(VP.first);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001277 if (!addCurrentFnArgument(RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001278 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001279 if (AbsDbgVariable)
Devang Patel3e4a9652011-08-15 21:24:36 +00001280 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patel475d32a2009-10-06 01:26:37 +00001281 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001282}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001283
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001284// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1285// defined reg.
Devang Patel9fc11702010-05-25 23:40:22 +00001286static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001287 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001288 return MI->getNumOperands() == 3 && MI->getOperand(0).isReg() &&
1289 MI->getOperand(0).getReg() &&
Adrian Prantl418d1d12013-07-09 20:28:37 +00001290 (MI->getOperand(1).isImm() ||
1291 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
Devang Patel9fc11702010-05-25 23:40:22 +00001292}
1293
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001294// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher6a841382012-11-19 22:42:10 +00001295static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1296 const MCSymbol *FLabel,
Devang Patel2442a892011-07-08 17:09:57 +00001297 const MCSymbol *SLabel,
1298 const MachineInstr *MI) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001299 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Devang Patel2442a892011-07-08 17:09:57 +00001300
David Blaikie0252265b2013-06-16 20:34:15 +00001301 assert(MI->getNumOperands() == 3);
Adrian Prantl418d1d12013-07-09 20:28:37 +00001302 if (MI->getOperand(0).isReg()) {
Devang Patel2442a892011-07-08 17:09:57 +00001303 MachineLocation MLoc;
Adrian Prantl418d1d12013-07-09 20:28:37 +00001304 // If the second operand is an immediate, this is a
1305 // register-indirect address.
1306 if (!MI->getOperand(1).isImm())
Adrian Prantld4c0dd42013-04-26 21:57:17 +00001307 MLoc.set(MI->getOperand(0).getReg());
1308 else
1309 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel2442a892011-07-08 17:09:57 +00001310 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1311 }
1312 if (MI->getOperand(0).isImm())
1313 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1314 if (MI->getOperand(0).isFPImm())
1315 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1316 if (MI->getOperand(0).isCImm())
1317 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1318
Craig Topperee4dab52012-02-05 08:31:47 +00001319 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel2442a892011-07-08 17:09:57 +00001320}
1321
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001322// Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001323void
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001324DwarfDebug::collectVariableInfo(SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001325
Eric Christopher270a12c2013-07-03 21:37:03 +00001326 // Grab the variable info that was squirreled away in the MMI side-table.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001327 collectVariableInfoFromMMITable(Processed);
Devang Patel490c8ab2010-05-20 19:57:06 +00001328
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001329 for (SmallVectorImpl<const MDNode *>::const_iterator
1330 UVI = UserVariables.begin(),
1331 UVE = UserVariables.end();
1332 UVI != UVE; ++UVI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001333 const MDNode *Var = *UVI;
1334 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001335 continue;
1336
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001337 // History contains relevant DBG_VALUE instructions for Var and instructions
1338 // clobbering it.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001339 SmallVectorImpl<const MachineInstr *> &History = DbgValues[Var];
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001340 if (History.empty())
1341 continue;
1342 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001343
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001344 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001345 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001346 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001347 DISubprogram(DV.getContext()).describes(CurFn->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +00001348 Scope = LScopes.getCurrentFunctionScope();
David Blaikiedc69ebb2013-03-11 23:39:23 +00001349 else if (MDNode *IA = DV.getInlinedAt())
1350 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1351 else
1352 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel490c8ab2010-05-20 19:57:06 +00001353 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001354 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001355 continue;
1356
1357 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001358 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel99819b52011-08-15 19:01:20 +00001359 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
Manman Renb3388602013-10-05 01:43:03 +00001360 DbgVariable *RegVar = new DbgVariable(DV, AbsVar, this);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001361 if (!addCurrentFnArgument(RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001362 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001363 if (AbsVar)
Devang Patel3e4a9652011-08-15 21:24:36 +00001364 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001365
Eric Christophercc10d202012-10-08 20:48:54 +00001366 // Simplify ranges that are fully coalesced.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001367 if (History.size() <= 1 ||
1368 (History.size() == 2 && MInsn->isIdenticalTo(History.back()))) {
Devang Patel3e4a9652011-08-15 21:24:36 +00001369 RegVar->setMInsn(MInsn);
Devang Patel9fc11702010-05-25 23:40:22 +00001370 continue;
1371 }
1372
Eric Christopher59cc0712013-01-28 17:33:26 +00001373 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001374 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001375
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001376 for (SmallVectorImpl<const MachineInstr *>::const_iterator
1377 HI = History.begin(),
1378 HE = History.end();
1379 HI != HE; ++HI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001380 const MachineInstr *Begin = *HI;
1381 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001382
Devang Patele7181b52011-06-01 23:00:17 +00001383 // Check if DBG_VALUE is truncating a range.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001384 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg() &&
1385 !Begin->getOperand(0).getReg())
Devang Patele7181b52011-06-01 23:00:17 +00001386 continue;
1387
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001388 // Compute the range for a register location.
1389 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1390 const MCSymbol *SLabel = 0;
1391
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001392 if (HI + 1 == HE)
1393 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001394 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001395 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001396 else {
1397 const MachineInstr *End = HI[1];
Eric Christopher6a841382012-11-19 22:42:10 +00001398 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001399 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001400 if (End->isDebugValue())
1401 SLabel = getLabelBeforeInsn(End);
1402 else {
1403 // End is a normal instruction clobbering the range.
1404 SLabel = getLabelAfterInsn(End);
1405 assert(SLabel && "Forgot label after clobber instruction");
1406 ++HI;
1407 }
1408 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001409
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001410 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001411 DotDebugLocEntries.push_back(
1412 getDebugLocEntry(Asm, FLabel, SLabel, Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001413 }
1414 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001415 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001416
1417 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001418 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1419 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1420 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1421 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001422 if (!DV || !DV.isVariable() || !Processed.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001423 continue;
1424 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001425 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patele0a94bf2010-05-14 21:01:35 +00001426 }
Devang Patel9fc11702010-05-25 23:40:22 +00001427}
Devang Patele0a94bf2010-05-14 21:01:35 +00001428
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001429// Return Label preceding the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001430MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001431 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1432 assert(Label && "Didn't insert label before instruction");
1433 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001434}
1435
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001436// Return Label immediately following the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001437MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001438 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001439}
1440
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001441// Process beginning of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001442void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001443 assert(CurMI == 0);
1444 CurMI = MI;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001445 // Check if source location changes, but ignore DBG_VALUE locations.
1446 if (!MI->isDebugValue()) {
1447 DebugLoc DL = MI->getDebugLoc();
1448 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopheraec8a822012-04-05 20:39:05 +00001449 unsigned Flags = 0;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001450 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001451 if (DL == PrologEndLoc) {
1452 Flags |= DWARF2_FLAG_PROLOGUE_END;
1453 PrologEndLoc = DebugLoc();
1454 }
Eric Christopheraec8a822012-04-05 20:39:05 +00001455 if (PrologEndLoc.isUnknown())
1456 Flags |= DWARF2_FLAG_IS_STMT;
1457
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001458 if (!DL.isUnknown()) {
1459 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001460 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001461 } else
Devang Patel34a66202011-05-11 19:22:19 +00001462 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001463 }
Devang Patel9fc11702010-05-25 23:40:22 +00001464 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001465
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001466 // Insert labels where requested.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001467 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
1468 LabelsBeforeInsn.find(MI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001469
1470 // No label needed.
1471 if (I == LabelsBeforeInsn.end())
1472 return;
1473
1474 // Label already assigned.
1475 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001476 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001477
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001478 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001479 PrevLabel = MMI->getContext().CreateTempSymbol();
1480 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001481 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001482 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001483}
1484
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001485// Process end of an instruction.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001486void DwarfDebug::endInstruction() {
1487 assert(CurMI != 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001488 // Don't create a new label after DBG_VALUE instructions.
1489 // They don't generate code.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001490 if (!CurMI->isDebugValue())
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001491 PrevLabel = 0;
1492
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001493 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001494 LabelsAfterInsn.find(CurMI);
1495 CurMI = 0;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001496
1497 // No label needed.
1498 if (I == LabelsAfterInsn.end())
1499 return;
1500
1501 // Label already assigned.
1502 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001503 return;
1504
1505 // We need a label after this instruction.
1506 if (!PrevLabel) {
1507 PrevLabel = MMI->getContext().CreateTempSymbol();
1508 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001509 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001510 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001511}
1512
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001513// Each LexicalScope has first instruction and last instruction to mark
1514// beginning and end of a scope respectively. Create an inverse map that list
1515// scopes starts (and ends) with an instruction. One instruction may start (or
1516// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001517void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001518 SmallVector<LexicalScope *, 4> WorkList;
1519 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001520 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001521 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001522
Craig Topper977e9cd2013-07-03 04:24:43 +00001523 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001524 if (!Children.empty())
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001525 for (SmallVectorImpl<LexicalScope *>::const_iterator
1526 SI = Children.begin(),
1527 SE = Children.end();
1528 SI != SE; ++SI)
Devang Patel7771b7c2010-01-20 02:05:23 +00001529 WorkList.push_back(*SI);
1530
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001531 if (S->isAbstractScope())
1532 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001533
Craig Topper977e9cd2013-07-03 04:24:43 +00001534 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001535 if (Ranges.empty())
1536 continue;
Craig Topperd8e43652013-07-03 04:17:25 +00001537 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001538 RE = Ranges.end();
1539 RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001540 assert(RI->first && "InsnRange does not have first instruction!");
1541 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001542 requestLabelBeforeInsn(RI->first);
1543 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001544 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001545 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001546}
1547
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001548// Get MDNode for DebugLoc's scope.
Devang Patel589845d2011-05-09 22:14:49 +00001549static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1550 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1551 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1552 return DL.getScope(Ctx);
1553}
1554
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001555// Walk up the scope chain of given debug loc and find line number info
1556// for the function.
Devang Patel34a66202011-05-11 19:22:19 +00001557static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1558 const MDNode *Scope = getScopeNode(DL, Ctx);
1559 DISubprogram SP = getDISubprogram(Scope);
Manman Ren7504ed42013-07-08 18:33:29 +00001560 if (SP.isSubprogram()) {
Eric Christopher34164192012-04-03 00:43:49 +00001561 // Check for number of operands since the compatibility is
1562 // cheap here.
Eric Christopherb81e2b42012-04-03 17:55:42 +00001563 if (SP->getNumOperands() > 19)
Eric Christopher34164192012-04-03 00:43:49 +00001564 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1565 else
1566 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1567 }
1568
Devang Patel34a66202011-05-11 19:22:19 +00001569 return DebugLoc();
1570}
1571
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001572// Gather pre-function debug information. Assumes being called immediately
1573// after the function entry point has been emitted.
Chris Lattner76555b52010-01-26 23:18:02 +00001574void DwarfDebug::beginFunction(const MachineFunction *MF) {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001575 CurFn = MF;
Eric Christopherfedfa442013-11-01 23:14:17 +00001576
1577 // If there's no debug info for the function we're not going to do anything.
1578 if (!MMI->hasDebugInfo())
1579 return;
1580
1581 // Grab the lexical scopes for the function, if we don't have any of those
1582 // then we're not going to be able to do anything.
Devang Patel7e623022011-08-10 20:55:27 +00001583 LScopes.initialize(*MF);
Eric Christopherfedfa442013-11-01 23:14:17 +00001584 if (LScopes.empty())
1585 return;
1586
1587 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1588
1589 // Make sure that each lexical scope will have a begin/end label.
Devang Patel7e623022011-08-10 20:55:27 +00001590 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001591
Eric Christopher4287a492013-12-09 23:57:44 +00001592 // Set DwarfDwarfCompileUnitID in MCContext to the Compile Unit this function
Eric Christopherfedfa442013-11-01 23:14:17 +00001593 // belongs to so that we add to the correct per-cu line table in the
1594 // non-asm case.
Manman Ren4e042a62013-02-05 21:52:47 +00001595 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Eric Christopher4287a492013-12-09 23:57:44 +00001596 DwarfCompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Manman Ren4e042a62013-02-05 21:52:47 +00001597 assert(TheCU && "Unable to find compile unit!");
Rafael Espindolaac4ad252013-10-05 16:42:21 +00001598 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren9d4c7352013-05-21 00:57:22 +00001599 // Use a single line table if we are using .loc and generating assembly.
1600 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1601 else
1602 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
Manman Ren4e042a62013-02-05 21:52:47 +00001603
Eric Christopherfedfa442013-11-01 23:14:17 +00001604 // Emit a label for the function so that we have a beginning address.
1605 FunctionBeginSym = Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001606 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001607 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001608
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001609 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001610 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Eric Christopherfedfa442013-11-01 23:14:17 +00001611 std::vector<const MDNode *> LiveUserVar(TRI->getNumRegs());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001612
Eric Christopherfedfa442013-11-01 23:14:17 +00001613 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end(); I != E;
1614 ++I) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001615 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001616 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1617 II != IE; ++II) {
1618 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001619
Devang Patel002d54d2010-05-26 19:37:24 +00001620 if (MI->isDebugValue()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001621 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001622
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001623 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001624 const MDNode *Var =
Eric Christopherfedfa442013-11-01 23:14:17 +00001625 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001626
1627 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001628 if (isDbgValueInDefinedReg(MI))
1629 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1630
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001631 // Check the history of this variable.
Eric Christopherfedfa442013-11-01 23:14:17 +00001632 SmallVectorImpl<const MachineInstr *> &History = DbgValues[Var];
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001633 if (History.empty()) {
1634 UserVariables.push_back(Var);
1635 // The first mention of a function argument gets the FunctionBeginSym
1636 // label, so arguments are visible when breaking at function entry.
1637 DIVariable DV(Var);
Manman Ren7504ed42013-07-08 18:33:29 +00001638 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
David Blaikie5af2aca2013-11-18 23:57:26 +00001639 getDISubprogram(DV.getContext()).describes(MF->getFunction()))
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001640 LabelsBeforeInsn[MI] = FunctionBeginSym;
1641 } else {
1642 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1643 const MachineInstr *Prev = History.back();
1644 if (Prev->isDebugValue()) {
1645 // Coalesce identical entries at the end of History.
1646 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001647 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher85a495e2012-10-08 20:48:49 +00001648 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopherfedfa442013-11-01 23:14:17 +00001649 << "\t" << *Prev << "\t"
1650 << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001651 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001652 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001653
1654 // Terminate old register assignments that don't reach MI;
1655 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1656 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1657 isDbgValueInDefinedReg(Prev)) {
1658 // Previous register assignment needs to terminate at the end of
1659 // its basic block.
1660 MachineBasicBlock::const_iterator LastMI =
Eric Christopherfedfa442013-11-01 23:14:17 +00001661 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001662 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001663 // Drop DBG_VALUE for empty range.
Eric Christopher85a495e2012-10-08 20:48:49 +00001664 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Eric Christopherfedfa442013-11-01 23:14:17 +00001665 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001666 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001667 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001668 // Terminate after LastMI.
1669 History.push_back(LastMI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001670 }
1671 }
1672 }
1673 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001674 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001675 // Not a DBG_VALUE instruction.
1676 if (!MI->isLabel())
1677 AtBlockEntry = false;
1678
Eric Christopher133195782012-10-04 20:46:14 +00001679 // First known non-DBG_VALUE and non-frame setup location marks
1680 // the beginning of the function body.
1681 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1682 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel34a66202011-05-11 19:22:19 +00001683 PrologEndLoc = MI->getDebugLoc();
1684
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001685 // Check if the instruction clobbers any registers with debug vars.
1686 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
Eric Christopherfedfa442013-11-01 23:14:17 +00001687 MOE = MI->operands_end();
1688 MOI != MOE; ++MOI) {
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001689 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1690 continue;
Eric Christopherfedfa442013-11-01 23:14:17 +00001691 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true); AI.isValid();
1692 ++AI) {
Jakob Stoklund Olesen54038d72012-06-01 23:28:30 +00001693 unsigned Reg = *AI;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001694 const MDNode *Var = LiveUserVar[Reg];
1695 if (!Var)
1696 continue;
1697 // Reg is now clobbered.
1698 LiveUserVar[Reg] = 0;
1699
1700 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001701 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1702 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001703 continue;
Eric Christopherfedfa442013-11-01 23:14:17 +00001704 SmallVectorImpl<const MachineInstr *> &History = HistI->second;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001705 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001706 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001707 const MachineInstr *Prev = History.back();
1708 // Sanity-check: Register assignments are terminated at the end of
1709 // their block.
1710 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1711 continue;
1712 // Is the variable still in Reg?
1713 if (!isDbgValueInDefinedReg(Prev) ||
1714 Prev->getOperand(0).getReg() != Reg)
1715 continue;
1716 // Var is clobbered. Make sure the next instruction gets a label.
1717 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001718 }
1719 }
Devang Patel002d54d2010-05-26 19:37:24 +00001720 }
Devang Patel002d54d2010-05-26 19:37:24 +00001721 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001722 }
1723
1724 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1725 I != E; ++I) {
Eric Christopherfedfa442013-11-01 23:14:17 +00001726 SmallVectorImpl<const MachineInstr *> &History = I->second;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001727 if (History.empty())
1728 continue;
1729
1730 // Make sure the final register assignments are terminated.
1731 const MachineInstr *Prev = History.back();
1732 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1733 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher6a841382012-11-19 22:42:10 +00001734 MachineBasicBlock::const_iterator LastMI =
Eric Christopherfedfa442013-11-01 23:14:17 +00001735 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001736 if (LastMI == PrevMBB->end())
1737 // Drop DBG_VALUE for empty range.
1738 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001739 else if (PrevMBB != &PrevMBB->getParent()->back()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001740 // Terminate after LastMI.
1741 History.push_back(LastMI);
1742 }
1743 }
1744 // Request labels for the full history.
1745 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1746 const MachineInstr *MI = History[i];
1747 if (MI->isDebugValue())
1748 requestLabelBeforeInsn(MI);
1749 else
1750 requestLabelAfterInsn(MI);
1751 }
1752 }
Devang Patel002d54d2010-05-26 19:37:24 +00001753
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001754 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001755 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001756
1757 // Record beginning of function.
1758 if (!PrologEndLoc.isUnknown()) {
Eric Christopherfedfa442013-11-01 23:14:17 +00001759 DebugLoc FnStartDL =
1760 getFnDebugLoc(PrologEndLoc, MF->getFunction()->getContext());
1761 recordSourceLine(
1762 FnStartDL.getLine(), FnStartDL.getCol(),
1763 FnStartDL.getScope(MF->getFunction()->getContext()),
1764 // We'd like to list the prologue as "not statements" but GDB behaves
1765 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
1766 DWARF2_FLAG_IS_STMT);
Devang Patel34a66202011-05-11 19:22:19 +00001767 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001768}
1769
Devang Patel7e623022011-08-10 20:55:27 +00001770void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
David Blaikie6f1a8062013-06-05 05:39:59 +00001771 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1772 DIVariable DV = Var->getVariable();
David Blaikie36d5d2f2013-06-06 21:04:51 +00001773 // Variables with positive arg numbers are parameters.
1774 if (unsigned ArgNum = DV.getArgNumber()) {
1775 // Keep all parameters in order at the start of the variable list to ensure
1776 // function types are correct (no out-of-order parameters)
1777 //
1778 // This could be improved by only doing it for optimized builds (unoptimized
1779 // builds have the right order to begin with), searching from the back (this
1780 // would catch the unoptimized case quickly), or doing a binary search
1781 // rather than linear search.
1782 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1783 while (I != Vars.end()) {
1784 unsigned CurNum = (*I)->getVariable().getArgNumber();
1785 // A local (non-parameter) variable has been found, insert immediately
1786 // before it.
1787 if (CurNum == 0)
1788 break;
1789 // A later indexed parameter has been found, insert immediately before it.
David Blaikieb272a752013-06-06 22:28:26 +00001790 if (CurNum > ArgNum)
David Blaikie36d5d2f2013-06-06 21:04:51 +00001791 break;
David Blaikieb272a752013-06-06 22:28:26 +00001792 ++I;
David Blaikie6f1a8062013-06-05 05:39:59 +00001793 }
David Blaikie36d5d2f2013-06-06 21:04:51 +00001794 Vars.insert(I, Var);
1795 return;
David Blaikie6f1a8062013-06-05 05:39:59 +00001796 }
1797
1798 Vars.push_back(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001799}
1800
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001801// Gather and emit post-function debug information.
NAKAMURA Takumib9271612013-12-03 13:15:54 +00001802void DwarfDebug::endFunction(const MachineFunction *MF) {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001803 // Every beginFunction(MF) call should be followed by an endFunction(MF) call,
1804 // though the beginFunction may not be called at all.
1805 // We should handle both cases.
1806 if (CurFn == 0)
1807 CurFn = MF;
1808 else
1809 assert(CurFn == MF);
1810 assert(CurFn != 0);
1811
1812 if (!MMI->hasDebugInfo() || LScopes.empty()) {
1813 CurFn = 0;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001814 return;
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001815 }
Devang Patel2904aa92009-11-12 19:02:56 +00001816
Devang Patel7e623022011-08-10 20:55:27 +00001817 // Define end label for subprogram.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001818 FunctionEndSym = Asm->GetTempSymbol("func_end", Asm->getFunctionNumber());
Devang Patel7e623022011-08-10 20:55:27 +00001819 // Assumes in correct section after the entry point.
1820 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Eric Christopher4287a492013-12-09 23:57:44 +00001821 // Set DwarfDwarfCompileUnitID in MCContext to default value.
Manman Ren4e042a62013-02-05 21:52:47 +00001822 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher6a841382012-11-19 22:42:10 +00001823
Devang Patel7e623022011-08-10 20:55:27 +00001824 SmallPtrSet<const MDNode *, 16> ProcessedVars;
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001825 collectVariableInfo(ProcessedVars);
Eric Christopher6a841382012-11-19 22:42:10 +00001826
Devang Patel3acc70e2011-08-15 22:04:40 +00001827 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Eric Christopher4287a492013-12-09 23:57:44 +00001828 DwarfCompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001829 assert(TheCU && "Unable to find compile unit!");
Devang Patel3acc70e2011-08-15 22:04:40 +00001830
Devang Patel7e623022011-08-10 20:55:27 +00001831 // Construct abstract scopes.
Devang Patel44403472011-08-12 18:10:19 +00001832 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1833 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1834 LexicalScope *AScope = AList[i];
1835 DISubprogram SP(AScope->getScopeNode());
Manman Ren7504ed42013-07-08 18:33:29 +00001836 if (SP.isSubprogram()) {
Devang Patel7e623022011-08-10 20:55:27 +00001837 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001838 DIArray Variables = SP.getVariables();
1839 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1840 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001841 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001842 continue;
Alexey Samsonov39602782012-07-06 08:45:08 +00001843 // Check that DbgVariable for DV wasn't created earlier, when
1844 // findAbstractVariable() was called for inlined instance of DV.
1845 LLVMContext &Ctx = DV->getContext();
1846 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1847 if (AbstractVariables.lookup(CleanDV))
1848 continue;
Devang Patel59e27c52011-08-19 23:28:12 +00001849 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001850 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001851 }
1852 }
Devang Patel44403472011-08-12 18:10:19 +00001853 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Manman Ren4213c392013-05-29 17:16:59 +00001854 constructScopeDIE(TheCU, AScope);
Bill Wendling2b128d72009-05-20 23:19:06 +00001855 }
Eric Christopher6a841382012-11-19 22:42:10 +00001856
Devang Patel3acc70e2011-08-15 22:04:40 +00001857 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher6a841382012-11-19 22:42:10 +00001858
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001859 if (!CurFn->getTarget().Options.DisableFramePointerElim(*CurFn))
Eric Christopherbb69a272012-08-24 01:14:27 +00001860 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Patel3acc70e2011-08-15 22:04:40 +00001861
Bill Wendling2b128d72009-05-20 23:19:06 +00001862 // Clear debug info
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001863 for (ScopeVariablesMap::iterator I = ScopeVariables.begin(),
1864 E = ScopeVariables.end();
1865 I != E; ++I)
Devang Patel7e623022011-08-10 20:55:27 +00001866 DeleteContainerPointers(I->second);
1867 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001868 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001869 UserVariables.clear();
1870 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001871 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001872 LabelsBeforeInsn.clear();
1873 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001874 PrevLabel = NULL;
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001875 CurFn = 0;
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
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001911 Src = getOrCreateSourceID(
1912 Fn, Dir, 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
Manman Rence20d462013-10-29 22:57:10 +00001921// Compute the size and offset of a DIE. The offset is relative to start of the
1922// CU. It returns the offset after laying out the DIE.
Eric Christopherf8194852013-12-05 18:06:10 +00001923unsigned DwarfFile::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.
David Blaikieff3ab2c2013-12-05 01:01:41 +00001931 const DIEAbbrev &Abbrev = Die->getAbbrev();
Bill Wendling480ff322009-05-20 23:21:38 +00001932
1933 // Set DIE offset
1934 Die->setOffset(Offset);
1935
1936 // Start the size with the size of abbreviation code.
David Blaikieff3ab2c2013-12-05 01:01:41 +00001937 Offset += MCAsmInfo::getULEB128Size(Die->getAbbrevNumber());
Bill Wendling480ff322009-05-20 23:21:38 +00001938
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001939 const SmallVectorImpl<DIEValue *> &Values = Die->getValues();
David Blaikieff3ab2c2013-12-05 01:01:41 +00001940 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
Bill Wendling480ff322009-05-20 23:21:38 +00001941
1942 // Size the DIE attribute values.
1943 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1944 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001945 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001946
1947 // Size the DIE children if any.
1948 if (!Children.empty()) {
David Blaikieff3ab2c2013-12-05 01:01:41 +00001949 assert(Abbrev.getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
Bill Wendling480ff322009-05-20 23:21:38 +00001950 "Children flag not set");
1951
1952 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001953 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling480ff322009-05-20 23:21:38 +00001954
1955 // End of children marker.
1956 Offset += sizeof(int8_t);
1957 }
1958
1959 Die->setSize(Offset - Die->getOffset());
1960 return Offset;
1961}
1962
Eric Christopherb088d2d2013-10-24 21:05:08 +00001963// Compute the size and offset for each DIE.
Eric Christopherf8194852013-12-05 18:06:10 +00001964void DwarfFile::computeSizeAndOffsets() {
Manman Rence20d462013-10-29 22:57:10 +00001965 // Offset from the first CU in the debug info section is 0 initially.
1966 unsigned SecOffset = 0;
1967
Eric Christopherb088d2d2013-10-24 21:05:08 +00001968 // Iterate over each compile unit and set the size and offsets for each
1969 // DIE within each compile unit. All offsets are CU relative.
Eric Christophera5a79422013-12-09 23:32:48 +00001970 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = CUs.begin(),
1971 E = CUs.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001972 I != E; ++I) {
Manman Rence20d462013-10-29 22:57:10 +00001973 (*I)->setDebugInfoOffset(SecOffset);
1974
1975 // CU-relative offset is reset to 0 here.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001976 unsigned Offset = sizeof(int32_t) + // Length of Unit Info
David Blaikie6b288cf2013-10-30 20:42:41 +00001977 (*I)->getHeaderSize(); // Unit-specific headers
Manman Rence20d462013-10-29 22:57:10 +00001978
1979 // EndOffset here is CU-relative, after laying out
1980 // all of the CU DIE.
David Blaikie2a80e442013-12-02 22:09:48 +00001981 unsigned EndOffset = computeSizeAndOffset((*I)->getUnitDie(), Offset);
Manman Rence20d462013-10-29 22:57:10 +00001982 SecOffset += EndOffset;
Devang Patel1a0df9a2010-05-10 22:49:55 +00001983 }
Bill Wendling480ff322009-05-20 23:21:38 +00001984}
1985
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001986// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001987void DwarfDebug::emitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001988 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001989
Bill Wendling480ff322009-05-20 23:21:38 +00001990 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001991 DwarfInfoSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001992 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001993 DwarfAbbrevSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001994 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher3c5a1912012-12-19 22:02:53 +00001995 if (useSplitDwarf())
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001996 DwarfAbbrevDWOSectionSym = emitSectionSym(
1997 Asm, TLOF.getDwarfAbbrevDWOSection(), "section_abbrev_dwo");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001998 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001999
Chris Lattner6629ca92010-04-04 22:59:04 +00002000 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002001 emitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00002002
Eric Christopher74804332013-02-07 21:19:50 +00002003 DwarfLineSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002004 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002005 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Eric Christopher261d2342013-09-23 20:55:35 +00002006 if (GenerateGnuPubSections) {
Eric Christopher39eebfa2013-09-30 23:14:16 +00002007 DwarfGnuPubNamesSectionSym =
2008 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
2009 DwarfGnuPubTypesSectionSym =
2010 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
Eric Christopher261d2342013-09-23 20:55:35 +00002011 } else if (HasDwarfPubSections) {
2012 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2013 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Michael Gottesmanc89466f2013-09-04 04:39:38 +00002014 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002015
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002016 DwarfStrSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002017 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002018 if (useSplitDwarf()) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002019 DwarfStrDWOSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002020 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002021 DwarfAddrSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002022 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
Eric Christopher55863be2013-04-07 03:43:09 +00002023 }
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002024 DwarfDebugRangeSectionSym =
2025 emitSectionSym(Asm, TLOF.getDwarfRangesSection(), "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00002026
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002027 DwarfDebugLocSectionSym =
2028 emitSectionSym(Asm, TLOF.getDwarfLocSection(), "section_debug_loc");
Devang Patel9fc11702010-05-25 23:40:22 +00002029
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002030 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
2031 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002032}
2033
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002034// Recursively emits a debug information entry.
David Blaikieff3ab2c2013-12-05 01:01:41 +00002035void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00002036 // Get the abbreviation for this DIE.
David Blaikieff3ab2c2013-12-05 01:01:41 +00002037 const DIEAbbrev &Abbrev = Die->getAbbrev();
Bill Wendling480ff322009-05-20 23:21:38 +00002038
Bill Wendling480ff322009-05-20 23:21:38 +00002039 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00002040 if (Asm->isVerbose())
David Blaikieff3ab2c2013-12-05 01:01:41 +00002041 Asm->OutStreamer.AddComment("Abbrev [" + Twine(Abbrev.getNumber()) +
2042 "] 0x" + Twine::utohexstr(Die->getOffset()) +
2043 ":0x" + Twine::utohexstr(Die->getSize()) + " " +
2044 dwarf::TagString(Abbrev.getTag()));
2045 Asm->EmitULEB128(Abbrev.getNumber());
Bill Wendling480ff322009-05-20 23:21:38 +00002046
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002047 const SmallVectorImpl<DIEValue *> &Values = Die->getValues();
David Blaikieff3ab2c2013-12-05 01:01:41 +00002048 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
Bill Wendling480ff322009-05-20 23:21:38 +00002049
2050 // Emit the DIE attribute values.
2051 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
David Blaikief2443192013-10-21 17:28:37 +00002052 dwarf::Attribute Attr = AbbrevData[i].getAttribute();
2053 dwarf::Form Form = AbbrevData[i].getForm();
Bill Wendling480ff322009-05-20 23:21:38 +00002054 assert(Form && "Too many attributes for DIE (check abbreviation)");
2055
Chris Lattner7bde8c02010-04-04 18:52:31 +00002056 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00002057 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002058
Bill Wendling480ff322009-05-20 23:21:38 +00002059 switch (Attr) {
Manman Rence20d462013-10-29 22:57:10 +00002060 case dwarf::DW_AT_abstract_origin:
2061 case dwarf::DW_AT_type:
2062 case dwarf::DW_AT_friend:
2063 case dwarf::DW_AT_specification:
2064 case dwarf::DW_AT_import:
2065 case dwarf::DW_AT_containing_type: {
2066 DIEEntry *E = cast<DIEEntry>(Values[i]);
2067 DIE *Origin = E->getEntry();
2068 unsigned Addr = Origin->getOffset();
2069 if (Form == dwarf::DW_FORM_ref_addr) {
2070 assert(!useSplitDwarf() && "TODO: dwo files can't have relocations.");
2071 // For DW_FORM_ref_addr, output the offset from beginning of debug info
2072 // section. Origin->getOffset() returns the offset from start of the
2073 // compile unit.
Eric Christopher4287a492013-12-09 23:57:44 +00002074 DwarfCompileUnit *CU = CUDieMap.lookup(Origin->getUnit());
Manman Rence20d462013-10-29 22:57:10 +00002075 assert(CU && "CUDie should belong to a CU.");
2076 Addr += CU->getDebugInfoOffset();
2077 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
David Blaikie03073f72013-12-06 22:14:48 +00002078 Asm->EmitLabelPlusOffset(CU->getSectionSym(), Addr,
Manman Rence20d462013-10-29 22:57:10 +00002079 DIEEntry::getRefAddrSize(Asm));
2080 else
David Blaikie03073f72013-12-06 22:14:48 +00002081 Asm->EmitLabelOffsetDifference(CU->getSectionSym(), Addr,
2082 CU->getSectionSym(),
Manman Ren251a1bd2013-10-29 23:14:15 +00002083 DIEEntry::getRefAddrSize(Asm));
Manman Rence20d462013-10-29 22:57:10 +00002084 } else {
Manman Ren4dbdc902013-10-31 17:54:35 +00002085 // Make sure Origin belong to the same CU.
David Blaikie409dd9c2013-11-19 23:08:21 +00002086 assert(Die->getUnit() == Origin->getUnit() &&
Manman Ren4dbdc902013-10-31 17:54:35 +00002087 "The referenced DIE should belong to the same CU in ref4");
Manman Rence20d462013-10-29 22:57:10 +00002088 Asm->EmitInt32(Addr);
2089 }
2090 break;
2091 }
Devang Patel9fc11702010-05-25 23:40:22 +00002092 case dwarf::DW_AT_location: {
Nick Lewycky33da3362012-06-22 01:25:12 +00002093 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2094 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopherd0b82ae2013-11-16 00:18:40 +00002095 Asm->EmitSectionOffset(L->getValue(), DwarfDebugLocSectionSym);
Nick Lewycky33da3362012-06-22 01:25:12 +00002096 else
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002097 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002098 } else {
Devang Patel9fc11702010-05-25 23:40:22 +00002099 Values[i]->EmitValue(Asm, Form);
Nick Lewycky33da3362012-06-22 01:25:12 +00002100 }
Devang Patel9fc11702010-05-25 23:40:22 +00002101 break;
2102 }
Devang Patela1bd5a12010-09-29 19:08:08 +00002103 case dwarf::DW_AT_accessibility: {
2104 if (Asm->isVerbose()) {
2105 DIEInteger *V = cast<DIEInteger>(Values[i]);
2106 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2107 }
2108 Values[i]->EmitValue(Asm, Form);
2109 break;
2110 }
Bill Wendling480ff322009-05-20 23:21:38 +00002111 default:
2112 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002113 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00002114 break;
2115 }
Bill Wendling480ff322009-05-20 23:21:38 +00002116 }
2117
2118 // Emit the DIE children if any.
David Blaikieff3ab2c2013-12-05 01:01:41 +00002119 if (Abbrev.getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
Bill Wendling480ff322009-05-20 23:21:38 +00002120 const std::vector<DIE *> &Children = Die->getChildren();
2121
2122 for (unsigned j = 0, M = Children.size(); j < M; ++j)
David Blaikieff3ab2c2013-12-05 01:01:41 +00002123 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00002124
David Blaikie155f8812013-12-04 21:51:05 +00002125 Asm->OutStreamer.AddComment("End Of Children Mark");
Chris Lattner566cae92010-03-09 23:52:58 +00002126 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00002127 }
2128}
2129
Eric Christophera2de8262012-12-15 00:04:07 +00002130// Emit the various dwarf units to the unit section USection with
2131// the abbreviations going into ASection.
David Blaikie03073f72013-12-06 22:14:48 +00002132void DwarfFile::emitUnits(DwarfDebug *DD, const MCSection *ASection,
2133 const MCSymbol *ASectionSym) {
Eric Christophera5a79422013-12-09 23:32:48 +00002134 for (SmallVectorImpl<DwarfUnit *>::iterator I = CUs.begin(), E = CUs.end();
2135 I != E; ++I) {
2136 DwarfUnit *TheU = *I;
David Blaikie2a80e442013-12-02 22:09:48 +00002137 DIE *Die = TheU->getUnitDie();
David Blaikie03073f72013-12-06 22:14:48 +00002138 const MCSection *USection = TheU->getSection();
2139 Asm->OutStreamer.SwitchSection(USection);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002140
Devang Patel1a0df9a2010-05-10 22:49:55 +00002141 // Emit the compile units header.
David Blaikie7d734602013-12-06 22:33:05 +00002142 Asm->OutStreamer.EmitLabel(TheU->getLabelBegin());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002143
Devang Patel1a0df9a2010-05-10 22:49:55 +00002144 // Emit size of content not including length itself
David Blaikie6b288cf2013-10-30 20:42:41 +00002145 Asm->OutStreamer.AddComment("Length of Unit");
David Blaikie2a80e442013-12-02 22:09:48 +00002146 Asm->EmitInt32(TheU->getHeaderSize() + Die->getSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002147
David Blaikie2a80e442013-12-02 22:09:48 +00002148 TheU->emitHeader(ASection, ASectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002149
David Blaikieff3ab2c2013-12-05 01:01:41 +00002150 DD->emitDIE(Die);
David Blaikie7d734602013-12-06 22:33:05 +00002151 Asm->OutStreamer.EmitLabel(TheU->getLabelEnd());
Devang Patel1a0df9a2010-05-10 22:49:55 +00002152 }
Bill Wendling480ff322009-05-20 23:21:38 +00002153}
2154
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002155// Emit the debug info section.
2156void DwarfDebug::emitDebugInfo() {
Eric Christopherf8194852013-12-05 18:06:10 +00002157 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christophera2de8262012-12-15 00:04:07 +00002158
David Blaikie03073f72013-12-06 22:14:48 +00002159 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfAbbrevSection(),
Eric Christophera2de8262012-12-15 00:04:07 +00002160 DwarfAbbrevSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002161}
2162
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002163// Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +00002164void DwarfDebug::emitAbbreviations() {
Eric Christopherf8194852013-12-05 18:06:10 +00002165 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
David Blaikie0504cda2013-12-05 07:43:55 +00002166
2167 Holder.emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
Eric Christopher3c5a1912012-12-19 22:02:53 +00002168}
Bill Wendling480ff322009-05-20 23:21:38 +00002169
Eric Christopherf8194852013-12-05 18:06:10 +00002170void DwarfFile::emitAbbrevs(const MCSection *Section) {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002171 // Check to see if it is worth the effort.
David Blaikie0504cda2013-12-05 07:43:55 +00002172 if (!Abbreviations.empty()) {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002173 // Start the debug abbrev section.
2174 Asm->OutStreamer.SwitchSection(Section);
2175
Bill Wendling480ff322009-05-20 23:21:38 +00002176 // For each abbrevation.
David Blaikie0504cda2013-12-05 07:43:55 +00002177 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
Bill Wendling480ff322009-05-20 23:21:38 +00002178 // Get abbreviation data
David Blaikie0504cda2013-12-05 07:43:55 +00002179 const DIEAbbrev *Abbrev = Abbreviations[i];
Bill Wendling480ff322009-05-20 23:21:38 +00002180
2181 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00002182 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00002183
2184 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002185 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00002186 }
2187
2188 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00002189 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00002190 }
2191}
2192
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002193// Emit the last address of the section and the end of the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +00002194void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00002195 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00002196 Asm->OutStreamer.AddComment("Extended Op");
2197 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002198
Chris Lattner566cae92010-03-09 23:52:58 +00002199 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002200 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00002201 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2202 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2203
2204 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002205
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002206 Asm->OutStreamer.EmitSymbolValue(
2207 Asm->GetTempSymbol("section_end", SectionEnd),
2208 Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002209
2210 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00002211 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2212 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002213 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00002214 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002215}
2216
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002217// Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00002218void DwarfDebug::emitAccelNames() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002219 DwarfAccelTable AT(
2220 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
Eric Christophera5a79422013-12-09 23:32:48 +00002221 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2222 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002223 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002224 DwarfUnit *TheU = *I;
David Blaikie2a80e442013-12-02 22:09:48 +00002225 const StringMap<std::vector<const DIE *> > &Names = TheU->getAccelNames();
David Blaikie2ea848b2013-11-19 22:51:04 +00002226 for (StringMap<std::vector<const DIE *> >::const_iterator
2227 GI = Names.begin(),
2228 GE = Names.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002229 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002230 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002231 const std::vector<const DIE *> &Entities = GI->second;
2232 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2233 DE = Entities.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002234 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002235 AT.AddName(Name, *DI);
Eric Christopher4996c702011-11-07 09:24:32 +00002236 }
2237 }
2238
2239 AT.FinalizeTable(Asm, "Names");
2240 Asm->OutStreamer.SwitchSection(
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002241 Asm->getObjFileLowering().getDwarfAccelNamesSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002242 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2243 Asm->OutStreamer.EmitLabel(SectionBegin);
2244
2245 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002246 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002247}
2248
Eric Christopher48fef592012-12-20 21:58:40 +00002249// Emit objective C classes and categories into a hashed accelerator table
2250// section.
Eric Christopher4996c702011-11-07 09:24:32 +00002251void DwarfDebug::emitAccelObjC() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002252 DwarfAccelTable AT(
2253 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
Eric Christophera5a79422013-12-09 23:32:48 +00002254 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2255 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002256 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002257 DwarfUnit *TheU = *I;
David Blaikie2a80e442013-12-02 22:09:48 +00002258 const StringMap<std::vector<const DIE *> > &Names = TheU->getAccelObjC();
David Blaikie2ea848b2013-11-19 22:51:04 +00002259 for (StringMap<std::vector<const DIE *> >::const_iterator
2260 GI = Names.begin(),
2261 GE = Names.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002262 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002263 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002264 const std::vector<const DIE *> &Entities = GI->second;
2265 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2266 DE = Entities.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002267 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002268 AT.AddName(Name, *DI);
Eric Christopher4996c702011-11-07 09:24:32 +00002269 }
2270 }
2271
2272 AT.FinalizeTable(Asm, "ObjC");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002273 Asm->OutStreamer.SwitchSection(
2274 Asm->getObjFileLowering().getDwarfAccelObjCSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002275 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2276 Asm->OutStreamer.EmitLabel(SectionBegin);
2277
2278 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002279 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002280}
2281
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002282// Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002283void DwarfDebug::emitAccelNamespaces() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002284 DwarfAccelTable AT(
2285 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
Eric Christophera5a79422013-12-09 23:32:48 +00002286 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2287 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002288 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002289 DwarfUnit *TheU = *I;
David Blaikie2ea848b2013-11-19 22:51:04 +00002290 const StringMap<std::vector<const DIE *> > &Names =
David Blaikie2a80e442013-12-02 22:09:48 +00002291 TheU->getAccelNamespace();
David Blaikie2ea848b2013-11-19 22:51:04 +00002292 for (StringMap<std::vector<const DIE *> >::const_iterator
2293 GI = Names.begin(),
2294 GE = Names.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002295 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002296 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002297 const std::vector<const DIE *> &Entities = GI->second;
2298 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2299 DE = Entities.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002300 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002301 AT.AddName(Name, *DI);
Eric Christopher4996c702011-11-07 09:24:32 +00002302 }
2303 }
2304
2305 AT.FinalizeTable(Asm, "namespac");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002306 Asm->OutStreamer.SwitchSection(
2307 Asm->getObjFileLowering().getDwarfAccelNamespaceSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002308 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2309 Asm->OutStreamer.EmitLabel(SectionBegin);
2310
2311 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002312 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002313}
2314
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002315// Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002316void DwarfDebug::emitAccelTypes() {
Eric Christopher21bde872012-01-06 04:35:23 +00002317 std::vector<DwarfAccelTable::Atom> Atoms;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002318 Atoms.push_back(
2319 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
2320 Atoms.push_back(
2321 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag, dwarf::DW_FORM_data2));
2322 Atoms.push_back(
2323 DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags, dwarf::DW_FORM_data1));
Eric Christopher21bde872012-01-06 04:35:23 +00002324 DwarfAccelTable AT(Atoms);
Eric Christophera5a79422013-12-09 23:32:48 +00002325 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2326 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002327 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002328 DwarfUnit *TheU = *I;
David Blaikie2ea848b2013-11-19 22:51:04 +00002329 const StringMap<std::vector<std::pair<const DIE *, unsigned> > > &Names =
David Blaikie2a80e442013-12-02 22:09:48 +00002330 TheU->getAccelTypes();
David Blaikie2ea848b2013-11-19 22:51:04 +00002331 for (StringMap<
2332 std::vector<std::pair<const DIE *, unsigned> > >::const_iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002333 GI = Names.begin(),
2334 GE = Names.end();
2335 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002336 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002337 const std::vector<std::pair<const DIE *, unsigned> > &Entities =
2338 GI->second;
2339 for (std::vector<std::pair<const DIE *, unsigned> >::const_iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002340 DI = Entities.begin(),
2341 DE = Entities.end();
2342 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002343 AT.AddName(Name, DI->first, DI->second);
Eric Christopher4996c702011-11-07 09:24:32 +00002344 }
2345 }
2346
2347 AT.FinalizeTable(Asm, "types");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002348 Asm->OutStreamer.SwitchSection(
2349 Asm->getObjFileLowering().getDwarfAccelTypesSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002350 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2351 Asm->OutStreamer.EmitLabel(SectionBegin);
2352
2353 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002354 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002355}
2356
Eric Christopherdd1a0122013-09-13 00:35:05 +00002357// Public name handling.
2358// The format for the various pubnames:
2359//
2360// dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2361// for the DIE that is named.
2362//
2363// gnu pubnames - offset/index value/name tuples where the offset is the offset
2364// into the CU and the index value is computed according to the type of value
2365// for the DIE that is named.
2366//
2367// For type units the offset is the offset of the skeleton DIE. For split dwarf
2368// it's the offset within the debug_info/debug_types dwo section, however, the
2369// reference in the pubname header doesn't change.
2370
2371/// computeIndexValue - Compute the gdb index value for the DIE and CU.
Eric Christophera5a79422013-12-09 23:32:48 +00002372static dwarf::PubIndexEntryDescriptor computeIndexValue(DwarfUnit *CU,
Eric Christopher0fe676a2013-11-21 00:48:22 +00002373 const DIE *Die) {
Eric Christopherd2b497b2013-10-16 01:37:49 +00002374 dwarf::GDBIndexEntryLinkage Linkage = dwarf::GIEL_STATIC;
2375
2376 // We could have a specification DIE that has our most of our knowledge,
2377 // look for that now.
2378 DIEValue *SpecVal = Die->findAttribute(dwarf::DW_AT_specification);
2379 if (SpecVal) {
2380 DIE *SpecDIE = cast<DIEEntry>(SpecVal)->getEntry();
2381 if (SpecDIE->findAttribute(dwarf::DW_AT_external))
2382 Linkage = dwarf::GIEL_EXTERNAL;
2383 } else if (Die->findAttribute(dwarf::DW_AT_external))
2384 Linkage = dwarf::GIEL_EXTERNAL;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002385
2386 switch (Die->getTag()) {
2387 case dwarf::DW_TAG_class_type:
2388 case dwarf::DW_TAG_structure_type:
2389 case dwarf::DW_TAG_union_type:
2390 case dwarf::DW_TAG_enumeration_type:
Eric Christopher261d2342013-09-23 20:55:35 +00002391 return dwarf::PubIndexEntryDescriptor(
2392 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2393 ? dwarf::GIEL_STATIC
2394 : dwarf::GIEL_EXTERNAL);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002395 case dwarf::DW_TAG_typedef:
2396 case dwarf::DW_TAG_base_type:
2397 case dwarf::DW_TAG_subrange_type:
David Blaikie8dec4072013-09-19 20:40:26 +00002398 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002399 case dwarf::DW_TAG_namespace:
David Blaikie8dec4072013-09-19 20:40:26 +00002400 return dwarf::GIEK_TYPE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002401 case dwarf::DW_TAG_subprogram:
Eric Christopherccac5c42013-09-23 22:59:14 +00002402 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002403 case dwarf::DW_TAG_constant:
2404 case dwarf::DW_TAG_variable:
Eric Christopherccac5c42013-09-23 22:59:14 +00002405 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002406 case dwarf::DW_TAG_enumerator:
David Blaikie8dec4072013-09-19 20:40:26 +00002407 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2408 dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002409 default:
David Blaikie8dec4072013-09-19 20:40:26 +00002410 return dwarf::GIEK_NONE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002411 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002412}
2413
Eric Christopher5f93bb92013-09-09 20:03:17 +00002414/// emitDebugPubNames - Emit visible names into a debug pubnames section.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002415///
Eric Christopherdd1a0122013-09-13 00:35:05 +00002416void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
Eric Christopherdd1a0122013-09-13 00:35:05 +00002417 const MCSection *PSec =
2418 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2419 : Asm->getObjFileLowering().getDwarfPubNamesSection();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002420
David Blaikie4f623202013-12-06 19:38:49 +00002421 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christophera5a79422013-12-09 23:32:48 +00002422 const SmallVectorImpl<DwarfUnit *> &Units = Holder.getUnits();
David Blaikie4f623202013-12-06 19:38:49 +00002423 for (unsigned i = 0; i != Units.size(); ++i) {
Eric Christophera5a79422013-12-09 23:32:48 +00002424 DwarfUnit *TheU = Units[i];
David Blaikie2a80e442013-12-02 22:09:48 +00002425 unsigned ID = TheU->getUniqueID();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002426
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002427 // Start the dwarf pubnames section.
Eric Christopher13b99d22013-09-10 21:49:37 +00002428 Asm->OutStreamer.SwitchSection(PSec);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002429
Eric Christopher39eebfa2013-09-30 23:14:16 +00002430 // Emit a label so we can reference the beginning of this pubname section.
2431 if (GnuStyle)
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002432 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames", ID));
Eric Christopher39eebfa2013-09-30 23:14:16 +00002433
Eric Christopherdd1a0122013-09-13 00:35:05 +00002434 // Emit the header.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002435 Asm->OutStreamer.AddComment("Length of Public Names Info");
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002436 MCSymbol *BeginLabel = Asm->GetTempSymbol("pubnames_begin", ID);
2437 MCSymbol *EndLabel = Asm->GetTempSymbol("pubnames_end", ID);
2438 Asm->EmitLabelDifference(EndLabel, BeginLabel, 4);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002439
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002440 Asm->OutStreamer.EmitLabel(BeginLabel);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002441
2442 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002443 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002444
2445 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
David Blaikie7d734602013-12-06 22:33:05 +00002446 Asm->EmitSectionOffset(TheU->getLabelBegin(), TheU->getSectionSym());
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002447
2448 Asm->OutStreamer.AddComment("Compilation Unit Length");
David Blaikie7d734602013-12-06 22:33:05 +00002449 Asm->EmitLabelDifference(TheU->getLabelEnd(), TheU->getLabelBegin(), 4);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002450
Eric Christopherdd1a0122013-09-13 00:35:05 +00002451 // Emit the pubnames for this compilation unit.
David Blaikie4f623202013-12-06 19:38:49 +00002452 const StringMap<const DIE *> &Globals = getUnits()[ID]->getGlobalNames();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002453 for (StringMap<const DIE *>::const_iterator GI = Globals.begin(),
2454 GE = Globals.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002455 GI != GE; ++GI) {
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002456 const char *Name = GI->getKeyData();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002457 const DIE *Entity = GI->second;
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002458
2459 Asm->OutStreamer.AddComment("DIE offset");
2460 Asm->EmitInt32(Entity->getOffset());
2461
Eric Christopherdd1a0122013-09-13 00:35:05 +00002462 if (GnuStyle) {
David Blaikie2a80e442013-12-02 22:09:48 +00002463 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheU, Entity);
David Blaikied0a869d2013-09-19 22:19:37 +00002464 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002465 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002466 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002467 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002468 }
2469
David Blaikie155f8812013-12-04 21:51:05 +00002470 Asm->OutStreamer.AddComment("External Name");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002471 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002472 }
2473
2474 Asm->OutStreamer.AddComment("End Mark");
2475 Asm->EmitInt32(0);
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002476 Asm->OutStreamer.EmitLabel(EndLabel);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002477 }
2478}
2479
Eric Christopherdd1a0122013-09-13 00:35:05 +00002480void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
Eric Christopher261d2342013-09-23 20:55:35 +00002481 const MCSection *PSec =
2482 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2483 : Asm->getObjFileLowering().getDwarfPubTypesSection();
Eric Christopher8b3737f2013-09-13 00:34:58 +00002484
David Blaikie4f623202013-12-06 19:38:49 +00002485 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christophera5a79422013-12-09 23:32:48 +00002486 const SmallVectorImpl<DwarfUnit *> &Units = Holder.getUnits();
David Blaikie4f623202013-12-06 19:38:49 +00002487 for (unsigned i = 0; i != Units.size(); ++i) {
Eric Christophera5a79422013-12-09 23:32:48 +00002488 DwarfUnit *TheU = Units[i];
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002489 unsigned ID = TheU->getUniqueID();
2490
Eric Christopher6abc9c52011-11-07 09:18:35 +00002491 // Start the dwarf pubtypes section.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002492 Asm->OutStreamer.SwitchSection(PSec);
Eric Christopher39eebfa2013-09-30 23:14:16 +00002493
2494 // Emit a label so we can reference the beginning of this pubtype section.
2495 if (GnuStyle)
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002496 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes", ID));
Eric Christopher39eebfa2013-09-30 23:14:16 +00002497
2498 // Emit the header.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002499 Asm->OutStreamer.AddComment("Length of Public Types Info");
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002500 MCSymbol *BeginLabel = Asm->GetTempSymbol("pubtypes_begin", ID);
2501 MCSymbol *EndLabel = Asm->GetTempSymbol("pubtypes_end", ID);
2502 Asm->EmitLabelDifference(EndLabel, BeginLabel, 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002503
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002504 Asm->OutStreamer.EmitLabel(BeginLabel);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002505
David Blaikie155f8812013-12-04 21:51:05 +00002506 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002507 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002508
Devang Patel1a0df9a2010-05-10 22:49:55 +00002509 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
David Blaikie7d734602013-12-06 22:33:05 +00002510 Asm->EmitSectionOffset(TheU->getLabelBegin(), TheU->getSectionSym());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002511
Devang Patel1a0df9a2010-05-10 22:49:55 +00002512 Asm->OutStreamer.AddComment("Compilation Unit Length");
David Blaikie7d734602013-12-06 22:33:05 +00002513 Asm->EmitLabelDifference(TheU->getLabelEnd(), TheU->getLabelBegin(), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002514
Eric Christopher39eebfa2013-09-30 23:14:16 +00002515 // Emit the pubtypes.
David Blaikie4f623202013-12-06 19:38:49 +00002516 const StringMap<const DIE *> &Globals = getUnits()[ID]->getGlobalTypes();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002517 for (StringMap<const DIE *>::const_iterator GI = Globals.begin(),
2518 GE = Globals.end();
Eric Christopher8b3737f2013-09-13 00:34:58 +00002519 GI != GE; ++GI) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002520 const char *Name = GI->getKeyData();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002521 const DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002522
David Blaikie155f8812013-12-04 21:51:05 +00002523 Asm->OutStreamer.AddComment("DIE offset");
Devang Patel1a0df9a2010-05-10 22:49:55 +00002524 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002525
Eric Christopherdd1a0122013-09-13 00:35:05 +00002526 if (GnuStyle) {
David Blaikie2a80e442013-12-02 22:09:48 +00002527 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheU, Entity);
David Blaikied0a869d2013-09-19 22:19:37 +00002528 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002529 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002530 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002531 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002532 }
2533
David Blaikie155f8812013-12-04 21:51:05 +00002534 Asm->OutStreamer.AddComment("External Name");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002535
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002536 // Emit the name with a terminating null byte.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002537 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002538 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002539
Devang Patel1a0df9a2010-05-10 22:49:55 +00002540 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002541 Asm->EmitInt32(0);
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002542 Asm->OutStreamer.EmitLabel(EndLabel);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002543 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002544}
2545
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002546// Emit strings into a string section.
Eric Christopherf8194852013-12-05 18:06:10 +00002547void DwarfFile::emitStrings(const MCSection *StrSection,
Eric Christophera5a79422013-12-09 23:32:48 +00002548 const MCSection *OffsetSection = NULL,
2549 const MCSymbol *StrSecSym = NULL) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002550
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002551 if (StringPool.empty())
2552 return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002553
Chris Lattner3d72a672010-03-09 23:38:23 +00002554 // Start the dwarf str section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002555 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling480ff322009-05-20 23:21:38 +00002556
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002557 // Get all of the string pool entries and put them in an array by their ID so
2558 // we can sort them.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002559 SmallVector<
2560 std::pair<unsigned, StringMapEntry<std::pair<MCSymbol *, unsigned> > *>,
2561 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002562
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002563 for (StringMap<std::pair<MCSymbol *, unsigned> >::iterator
2564 I = StringPool.begin(),
2565 E = StringPool.end();
Eric Christopher48fef592012-12-20 21:58:40 +00002566 I != E; ++I)
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002567 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002568
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002569 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002570
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002571 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002572 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002573 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002574
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002575 // Emit the string itself with a terminating null byte.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002576 Asm->OutStreamer.EmitBytes(
2577 StringRef(Entries[i].second->getKeyData(),
2578 Entries[i].second->getKeyLength() + 1));
Bill Wendling480ff322009-05-20 23:21:38 +00002579 }
Eric Christopher2cbd5762013-01-07 19:32:41 +00002580
2581 // If we've got an offset section go ahead and emit that now as well.
2582 if (OffsetSection) {
2583 Asm->OutStreamer.SwitchSection(OffsetSection);
2584 unsigned offset = 0;
Eric Christopher962c9082013-01-15 23:56:56 +00002585 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002586 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopherbf7bc492013-01-09 03:52:05 +00002587 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopher2cbd5762013-01-07 19:32:41 +00002588 offset += Entries[i].second->getKeyLength() + 1;
2589 }
2590 }
Bill Wendling480ff322009-05-20 23:21:38 +00002591}
2592
Eric Christopher65132a82013-11-19 09:11:26 +00002593// Emit addresses into the section given.
Eric Christopherf8194852013-12-05 18:06:10 +00002594void DwarfFile::emitAddresses(const MCSection *AddrSection) {
Eric Christopher962c9082013-01-15 23:56:56 +00002595
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002596 if (AddressPool.empty())
2597 return;
Eric Christopher962c9082013-01-15 23:56:56 +00002598
2599 // Start the dwarf addr section.
2600 Asm->OutStreamer.SwitchSection(AddrSection);
2601
David Blaikiece1960f2013-07-08 17:51:28 +00002602 // Order the address pool entries by ID
David Blaikieac569a62013-07-08 17:33:10 +00002603 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher962c9082013-01-15 23:56:56 +00002604
David Blaikiece1960f2013-07-08 17:51:28 +00002605 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2606 E = AddressPool.end();
Eric Christopher962c9082013-01-15 23:56:56 +00002607 I != E; ++I)
David Blaikieac569a62013-07-08 17:33:10 +00002608 Entries[I->second] = I->first;
Eric Christopher962c9082013-01-15 23:56:56 +00002609
2610 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002611 // Emit an expression for reference from debug information entries.
David Blaikieac569a62013-07-08 17:33:10 +00002612 if (const MCExpr *Expr = Entries[i])
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002613 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
Eric Christopher962c9082013-01-15 23:56:56 +00002614 else
2615 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2616 }
Eric Christopher962c9082013-01-15 23:56:56 +00002617}
2618
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002619// Emit visible names into a debug str section.
2620void DwarfDebug::emitDebugStr() {
Eric Christopherf8194852013-12-05 18:06:10 +00002621 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002622 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2623}
2624
Eric Christopher9046f942013-07-02 21:36:07 +00002625// Emit locations into the debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002626void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002627 if (DotDebugLocEntries.empty())
2628 return;
2629
Eric Christopher4887c8f2013-03-29 23:34:06 +00002630 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002631 I = DotDebugLocEntries.begin(),
2632 E = DotDebugLocEntries.end();
Devang Patel116a9d72011-02-04 22:57:18 +00002633 I != E; ++I) {
2634 DotDebugLocEntry &Entry = *I;
2635 if (I + 1 != DotDebugLocEntries.end())
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002636 Entry.Merge(I + 1);
Devang Patel116a9d72011-02-04 22:57:18 +00002637 }
2638
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002639 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002640 Asm->OutStreamer.SwitchSection(
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002641 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002642 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002643 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2644 unsigned index = 1;
Eric Christopher4887c8f2013-03-29 23:34:06 +00002645 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002646 I = DotDebugLocEntries.begin(),
2647 E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002648 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002649 DotDebugLocEntry &Entry = *I;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002650 if (Entry.isMerged())
2651 continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002652 if (Entry.isEmpty()) {
Eric Christopherce0cfce2013-01-09 01:35:34 +00002653 Asm->OutStreamer.EmitIntValue(0, Size);
2654 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002655 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002656 } else {
Eric Christopher25f06422013-07-03 22:40:18 +00002657 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2658 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2659 DIVariable DV(Entry.getVariable());
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002660 Asm->OutStreamer.AddComment("Loc expr size");
2661 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2662 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2663 Asm->EmitLabelDifference(end, begin, 2);
2664 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002665 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002666 DIBasicType BTy(DV.getType());
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002667 if (BTy.Verify() && (BTy.getEncoding() == dwarf::DW_ATE_signed ||
2668 BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
Devang Patel324f8432011-06-01 22:03:25 +00002669 Asm->OutStreamer.AddComment("DW_OP_consts");
2670 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002671 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002672 } else {
2673 Asm->OutStreamer.AddComment("DW_OP_constu");
2674 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002675 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002676 }
Devang Pateled9fd452011-07-08 16:49:43 +00002677 } else if (Entry.isLocation()) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002678 MachineLocation Loc = Entry.getLoc();
Eric Christopher6a841382012-11-19 22:42:10 +00002679 if (!DV.hasComplexAddress())
Devang Pateled9fd452011-07-08 16:49:43 +00002680 // Regular entry.
Eric Christopher614a89f2013-07-03 22:40:21 +00002681 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002682 else {
2683 // Complex address entry.
2684 unsigned N = DV.getNumAddrElements();
2685 unsigned i = 0;
2686 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002687 if (Loc.getOffset()) {
Devang Pateled9fd452011-07-08 16:49:43 +00002688 i = 2;
Eric Christopher614a89f2013-07-03 22:40:21 +00002689 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002690 Asm->OutStreamer.AddComment("DW_OP_deref");
2691 Asm->EmitInt8(dwarf::DW_OP_deref);
2692 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2693 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2694 Asm->EmitSLEB128(DV.getAddrElement(1));
2695 } else {
2696 // If first address element is OpPlus then emit
2697 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher614a89f2013-07-03 22:40:21 +00002698 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2699 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002700 i = 2;
2701 }
2702 } else {
Eric Christopher614a89f2013-07-03 22:40:21 +00002703 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002704 }
Eric Christopher6a841382012-11-19 22:42:10 +00002705
Devang Pateled9fd452011-07-08 16:49:43 +00002706 // Emit remaining complex address elements.
2707 for (; i < N; ++i) {
2708 uint64_t Element = DV.getAddrElement(i);
2709 if (Element == DIBuilder::OpPlus) {
2710 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2711 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher4d250522012-05-08 18:56:00 +00002712 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002713 if (!Loc.isReg())
Eric Christopher4d250522012-05-08 18:56:00 +00002714 Asm->EmitInt8(dwarf::DW_OP_deref);
2715 } else
2716 llvm_unreachable("unknown Opcode found in complex address");
Devang Pateled9fd452011-07-08 16:49:43 +00002717 }
Devang Patel3e021532011-04-28 02:22:40 +00002718 }
Devang Patel3e021532011-04-28 02:22:40 +00002719 }
Devang Pateled9fd452011-07-08 16:49:43 +00002720 // else ... ignore constant fp. There is not any good way to
2721 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002722 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002723 }
2724 }
Bill Wendling480ff322009-05-20 23:21:38 +00002725}
2726
Richard Mitton21101b32013-09-19 23:21:01 +00002727struct SymbolCUSorter {
2728 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2729 const MCStreamer &Streamer;
2730
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002731 bool operator()(const SymbolCU &A, const SymbolCU &B) {
Richard Mitton21101b32013-09-19 23:21:01 +00002732 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2733 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2734
2735 // Symbols with no order assigned should be placed at the end.
2736 // (e.g. section end labels)
2737 if (IA == 0)
2738 IA = (unsigned)(-1);
2739 if (IB == 0)
2740 IB = (unsigned)(-1);
2741 return IA < IB;
2742 }
2743};
2744
Eric Christophera5a79422013-12-09 23:32:48 +00002745static bool CUSort(const DwarfUnit *A, const DwarfUnit *B) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002746 return (A->getUniqueID() < B->getUniqueID());
Richard Mitton21101b32013-09-19 23:21:01 +00002747}
2748
2749struct ArangeSpan {
2750 const MCSymbol *Start, *End;
2751};
2752
2753// Emit a debug aranges section, containing a CU lookup for any
2754// address we can tie back to a CU.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002755void DwarfDebug::emitDebugARanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002756 // Start the dwarf aranges section.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002757 Asm->OutStreamer.SwitchSection(
2758 Asm->getObjFileLowering().getDwarfARangesSection());
Richard Mitton21101b32013-09-19 23:21:01 +00002759
Eric Christopher4287a492013-12-09 23:57:44 +00002760 typedef DenseMap<DwarfCompileUnit *, std::vector<ArangeSpan> > SpansType;
Richard Mitton21101b32013-09-19 23:21:01 +00002761
2762 SpansType Spans;
2763
2764 // Build a list of sections used.
2765 std::vector<const MCSection *> Sections;
2766 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2767 it++) {
2768 const MCSection *Section = it->first;
2769 Sections.push_back(Section);
2770 }
2771
2772 // Sort the sections into order.
2773 // This is only done to ensure consistent output order across different runs.
2774 std::sort(Sections.begin(), Sections.end(), SectionSort);
2775
2776 // Build a set of address spans, sorted by CU.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002777 for (size_t SecIdx = 0; SecIdx < Sections.size(); SecIdx++) {
Richard Mitton21101b32013-09-19 23:21:01 +00002778 const MCSection *Section = Sections[SecIdx];
2779 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2780 if (List.size() < 2)
2781 continue;
2782
2783 // Sort the symbols by offset within the section.
2784 SymbolCUSorter sorter(Asm->OutStreamer);
2785 std::sort(List.begin(), List.end(), sorter);
2786
2787 // If we have no section (e.g. common), just write out
2788 // individual spans for each symbol.
2789 if (Section == NULL) {
2790 for (size_t n = 0; n < List.size(); n++) {
2791 const SymbolCU &Cur = List[n];
2792
2793 ArangeSpan Span;
2794 Span.Start = Cur.Sym;
2795 Span.End = NULL;
2796 if (Cur.CU)
2797 Spans[Cur.CU].push_back(Span);
2798 }
2799 } else {
2800 // Build spans between each label.
2801 const MCSymbol *StartSym = List[0].Sym;
2802 for (size_t n = 1; n < List.size(); n++) {
2803 const SymbolCU &Prev = List[n - 1];
2804 const SymbolCU &Cur = List[n];
2805
2806 // Try and build the longest span we can within the same CU.
2807 if (Cur.CU != Prev.CU) {
2808 ArangeSpan Span;
2809 Span.Start = StartSym;
2810 Span.End = Cur.Sym;
2811 Spans[Prev.CU].push_back(Span);
2812 StartSym = Cur.Sym;
2813 }
2814 }
2815 }
2816 }
2817
Richard Mitton21101b32013-09-19 23:21:01 +00002818 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2819
2820 // Build a list of CUs used.
Eric Christopher4287a492013-12-09 23:57:44 +00002821 std::vector<DwarfCompileUnit *> CUs;
Richard Mitton21101b32013-09-19 23:21:01 +00002822 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
Eric Christopher4287a492013-12-09 23:57:44 +00002823 DwarfCompileUnit *CU = it->first;
Richard Mitton21101b32013-09-19 23:21:01 +00002824 CUs.push_back(CU);
2825 }
2826
2827 // Sort the CU list (again, to ensure consistent output order).
2828 std::sort(CUs.begin(), CUs.end(), CUSort);
2829
2830 // Emit an arange table for each CU we used.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002831 for (size_t CUIdx = 0; CUIdx < CUs.size(); CUIdx++) {
Eric Christopher4287a492013-12-09 23:57:44 +00002832 DwarfCompileUnit *CU = CUs[CUIdx];
Richard Mitton21101b32013-09-19 23:21:01 +00002833 std::vector<ArangeSpan> &List = Spans[CU];
2834
2835 // Emit size of content not including length itself.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002836 unsigned ContentSize =
2837 sizeof(int16_t) + // DWARF ARange version number
2838 sizeof(int32_t) + // Offset of CU in the .debug_info section
2839 sizeof(int8_t) + // Pointer Size (in bytes)
2840 sizeof(int8_t); // Segment Size (in bytes)
Richard Mitton21101b32013-09-19 23:21:01 +00002841
2842 unsigned TupleSize = PtrSize * 2;
2843
2844 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2845 unsigned Padding = 0;
2846 while (((sizeof(int32_t) + ContentSize + Padding) % TupleSize) != 0)
2847 Padding++;
2848
2849 ContentSize += Padding;
2850 ContentSize += (List.size() + 1) * TupleSize;
2851
2852 // For each compile unit, write the list of spans it covers.
2853 Asm->OutStreamer.AddComment("Length of ARange Set");
2854 Asm->EmitInt32(ContentSize);
2855 Asm->OutStreamer.AddComment("DWARF Arange version number");
2856 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2857 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
David Blaikie7d734602013-12-06 22:33:05 +00002858 Asm->EmitSectionOffset(CU->getLabelBegin(), CU->getSectionSym());
Richard Mitton21101b32013-09-19 23:21:01 +00002859 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2860 Asm->EmitInt8(PtrSize);
2861 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2862 Asm->EmitInt8(0);
2863
2864 for (unsigned n = 0; n < Padding; n++)
2865 Asm->EmitInt8(0xff);
2866
2867 for (unsigned n = 0; n < List.size(); n++) {
2868 const ArangeSpan &Span = List[n];
2869 Asm->EmitLabelReference(Span.Start, PtrSize);
2870
2871 // Calculate the size as being from the span start to it's end.
Richard Mitton089ed892013-09-23 17:56:20 +00002872 if (Span.End) {
Richard Mitton21101b32013-09-19 23:21:01 +00002873 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
Richard Mitton089ed892013-09-23 17:56:20 +00002874 } else {
2875 // For symbols without an end marker (e.g. common), we
2876 // write a single arange entry containing just that one symbol.
2877 uint64_t Size = SymSize[Span.Start];
2878 if (Size == 0)
2879 Size = 1;
2880
2881 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2882 }
Richard Mitton21101b32013-09-19 23:21:01 +00002883 }
2884
2885 Asm->OutStreamer.AddComment("ARange terminator");
2886 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2887 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2888 }
Bill Wendling480ff322009-05-20 23:21:38 +00002889}
2890
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002891// Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002892void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002893 // Start the dwarf ranges section.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002894 Asm->OutStreamer.SwitchSection(
2895 Asm->getObjFileLowering().getDwarfRangesSection());
Eric Christopher4751d702013-11-23 00:05:29 +00002896
Eric Christopher0f63d062013-12-03 00:45:45 +00002897 // Size for our labels.
2898 unsigned char Size = Asm->getDataLayout().getPointerSize();
2899
2900 // Grab the specific ranges for the compile units in the module.
Eric Christopher4287a492013-12-09 23:57:44 +00002901 for (DenseMap<const MDNode *, DwarfCompileUnit *>::iterator I = CUMap.begin(),
2902 E = CUMap.end();
Eric Christopher0f63d062013-12-03 00:45:45 +00002903 I != E; ++I) {
Eric Christopher4287a492013-12-09 23:57:44 +00002904 DwarfCompileUnit *TheCU = I->second;
Eric Christopher0f63d062013-12-03 00:45:45 +00002905
2906 // Emit a symbol so we can find the beginning of our ranges.
David Blaikie1ab7c2d2013-12-09 17:51:30 +00002907 Asm->OutStreamer.EmitLabel(TheCU->getLabelRange());
Eric Christopher0f63d062013-12-03 00:45:45 +00002908
2909 // Iterate over the misc ranges for the compile units in the module.
Eric Christopher270ba4a2013-12-04 19:06:58 +00002910 const SmallVectorImpl<RangeSpanList> &RangeLists = TheCU->getRangeLists();
Eric Christophera5a79422013-12-09 23:32:48 +00002911 for (SmallVectorImpl<RangeSpanList>::const_iterator I = RangeLists.begin(),
2912 E = RangeLists.end();
Eric Christopher0f63d062013-12-03 00:45:45 +00002913 I != E; ++I) {
Eric Christopher270ba4a2013-12-04 19:06:58 +00002914 const RangeSpanList &List = *I;
Eric Christopher0f63d062013-12-03 00:45:45 +00002915
Eric Christopherf8790642013-12-04 22:04:50 +00002916 // Emit our symbol so we can find the beginning of the range.
2917 Asm->OutStreamer.EmitLabel(List.getSym());
Eric Christopher0f63d062013-12-03 00:45:45 +00002918
2919 for (SmallVectorImpl<RangeSpan>::const_iterator
Eric Christopher270ba4a2013-12-04 19:06:58 +00002920 RI = List.getRanges().begin(),
2921 RE = List.getRanges().end();
2922 RI != RE; ++RI) {
2923 const RangeSpan &Range = *RI;
Eric Christopher0f63d062013-12-03 00:45:45 +00002924 // We occasionally have ranges without begin/end labels.
2925 // FIXME: Verify and fix.
2926 const MCSymbol *Begin = Range.getStart();
2927 const MCSymbol *End = Range.getEnd();
2928 Begin ? Asm->OutStreamer.EmitSymbolValue(Begin, Size)
2929 : Asm->OutStreamer.EmitIntValue(0, Size);
2930 End ? Asm->OutStreamer.EmitSymbolValue(End, Size)
2931 : Asm->OutStreamer.EmitIntValue(0, Size);
2932 }
2933
2934 // And terminate the list with two 0 values.
Eric Christopherce0cfce2013-01-09 01:35:34 +00002935 Asm->OutStreamer.EmitIntValue(0, Size);
Eric Christopher0f63d062013-12-03 00:45:45 +00002936 Asm->OutStreamer.EmitIntValue(0, Size);
2937 }
Devang Patel12563b32010-04-16 23:33:45 +00002938 }
Bill Wendling480ff322009-05-20 23:21:38 +00002939}
2940
Eric Christopherd692c1d2012-12-11 19:42:09 +00002941// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002942
2943// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2944// 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 +00002945// DW_AT_ranges_base, DW_AT_addr_base.
Eric Christopher5090d572013-12-10 00:40:03 +00002946// TODO: Implement DW_AT_ranges_base.
Eric Christopher4287a492013-12-09 23:57:44 +00002947DwarfCompileUnit *DwarfDebug::constructSkeletonCU(const DwarfCompileUnit *CU) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002948
2949 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher4287a492013-12-09 23:57:44 +00002950 DwarfCompileUnit *NewCU = new DwarfCompileUnit(
2951 CU->getUniqueID(), Die, CU->getNode(), Asm, this, &SkeletonHolder);
David Blaikie1ab7c2d2013-12-09 17:51:30 +00002952 NewCU->initSection(Asm->getObjFileLowering().getDwarfInfoSection(),
2953 DwarfInfoSectionSym);
Eric Christopher4c7765f2013-01-17 03:00:04 +00002954
Eric Christopherdae389b2013-02-22 23:50:08 +00002955 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
David Blaikieb01f13e2013-11-15 23:54:45 +00002956 CU->getNode().getSplitDebugFilename());
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002957
Eric Christopher44c6aa62013-04-22 07:51:08 +00002958 // Relocate to the beginning of the addr_base section, else 0 for the
2959 // beginning of the one for this compile unit.
Eric Christopher55863be2013-04-07 03:43:09 +00002960 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher33ff6972013-11-21 23:46:41 +00002961 NewCU->addSectionLabel(Die, dwarf::DW_AT_GNU_addr_base,
2962 DwarfAddrSectionSym);
Eric Christopher55863be2013-04-07 03:43:09 +00002963 else
Eric Christopher33ff6972013-11-21 23:46:41 +00002964 NewCU->addSectionOffset(Die, dwarf::DW_AT_GNU_addr_base, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002965
2966 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher962c9082013-01-15 23:56:56 +00002967 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002968 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher962c9082013-01-15 23:56:56 +00002969
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002970 // DW_AT_stmt_list is a offset of line number information for this
2971 // compile unit in debug_line section.
Eric Christopher55863be2013-04-07 03:43:09 +00002972 // FIXME: Should handle multiple compile units.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002973 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christophera5a79422013-12-09 23:32:48 +00002974 NewCU->addSectionLabel(Die, dwarf::DW_AT_stmt_list, DwarfLineSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002975 else
Eric Christopher33ff6972013-11-21 23:46:41 +00002976 NewCU->addSectionOffset(Die, dwarf::DW_AT_stmt_list, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002977
2978 if (!CompilationDir.empty())
Eric Christopher2cbd5762013-01-07 19:32:41 +00002979 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002980
David Blaikie3c842622013-12-04 21:31:26 +00002981 addGnuPubAttributes(NewCU, Die);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002982
Eric Christopherc8a310e2012-12-10 23:34:43 +00002983 SkeletonHolder.addUnit(NewCU);
2984
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002985 return NewCU;
2986}
2987
Eric Christopherd692c1d2012-12-11 19:42:09 +00002988// Emit the .debug_info.dwo section for separated dwarf. This contains the
2989// compile units that would normally be in debug_info.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002990void DwarfDebug::emitDebugInfoDWO() {
Eric Christophercdf218d2012-12-10 19:51:21 +00002991 assert(useSplitDwarf() && "No split dwarf debug info?");
David Blaikie03073f72013-12-06 22:14:48 +00002992 InfoHolder.emitUnits(this,
Eric Christopher3c5a1912012-12-19 22:02:53 +00002993 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2994 DwarfAbbrevDWOSectionSym);
2995}
2996
2997// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2998// abbreviations for the .debug_info.dwo section.
2999void DwarfDebug::emitDebugAbbrevDWO() {
3000 assert(useSplitDwarf() && "No split dwarf?");
David Blaikie0504cda2013-12-05 07:43:55 +00003001 InfoHolder.emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection());
Eric Christopher9c2ecd92012-11-30 23:59:06 +00003002}
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003003
3004// Emit the .debug_str.dwo section for separated dwarf. This contains the
3005// string section and is identical in format to traditional .debug_str
3006// sections.
3007void DwarfDebug::emitDebugStrDWO() {
3008 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00003009 const MCSection *OffSec =
3010 Asm->getObjFileLowering().getDwarfStrOffDWOSection();
Eric Christopher2cbd5762013-01-07 19:32:41 +00003011 const MCSymbol *StrSym = DwarfStrSectionSym;
3012 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
3013 OffSec, StrSym);
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003014}
David Blaikie409dd9c2013-11-19 23:08:21 +00003015
Eric Christopher4287a492013-12-09 23:57:44 +00003016void DwarfDebug::addDwarfTypeUnitType(uint16_t Language, DIE *RefDie,
3017 DICompositeType CTy) {
David Blaikie47f615e2013-12-17 23:32:35 +00003018 const DwarfTypeUnit *&TU = DwarfTypeUnits[CTy];
3019 if (!TU) {
David Blaikie409dd9c2013-11-19 23:08:21 +00003020 DIE *UnitDie = new DIE(dwarf::DW_TAG_type_unit);
Eric Christopher4287a492013-12-09 23:57:44 +00003021 DwarfTypeUnit *NewTU =
3022 new DwarfTypeUnit(InfoHolder.getUnits().size(), UnitDie, Language, Asm,
3023 this, &InfoHolder);
David Blaikie47f615e2013-12-17 23:32:35 +00003024 TU = NewTU;
David Blaikie2666e242013-12-06 19:38:46 +00003025 InfoHolder.addUnit(NewTU);
3026
David Blaikie319a05f2013-12-02 19:33:10 +00003027 NewTU->addUInt(UnitDie, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
David Blaikie3c1d3322013-12-02 18:44:29 +00003028 Language);
David Blaikie409dd9c2013-11-19 23:08:21 +00003029
David Blaikie319a05f2013-12-02 19:33:10 +00003030 DIE *Die = NewTU->createTypeDIE(CTy);
David Blaikie409dd9c2013-11-19 23:08:21 +00003031
David Blaikie319a05f2013-12-02 19:33:10 +00003032 if (GenerateODRHash && shouldAddODRHash(NewTU, Die))
3033 NewTU->addUInt(UnitDie, dwarf::DW_AT_GNU_odr_signature,
David Blaikie409dd9c2013-11-19 23:08:21 +00003034 dwarf::DW_FORM_data8,
3035 DIEHash().computeDIEODRSignature(*Die));
3036 // FIXME: This won't handle circularly referential structures, as the DIE
3037 // may have references to other DIEs still under construction and missing
3038 // their signature. Hashing should walk through the signatures to their
3039 // referenced type, or possibly walk the precomputed hashes of related types
3040 // at the end.
3041 uint64_t Signature = DIEHash().computeTypeSignature(*Die);
David Blaikiebc563272013-12-13 21:33:40 +00003042 NewTU->setTypeSignature(Signature);
3043 NewTU->setType(Die);
David Blaikie409dd9c2013-11-19 23:08:21 +00003044
David Blaikie03073f72013-12-06 22:14:48 +00003045 NewTU->initSection(
David Blaikiebc563272013-12-13 21:33:40 +00003046 useSplitDwarf()
3047 ? Asm->getObjFileLowering().getDwarfTypesDWOSection(Signature)
3048 : Asm->getObjFileLowering().getDwarfTypesSection(Signature));
David Blaikie409dd9c2013-11-19 23:08:21 +00003049 }
3050
David Blaikie47f615e2013-12-17 23:32:35 +00003051 CUMap.begin()->second->addDIETypeSignature(RefDie, *TU);
David Blaikie409dd9c2013-11-19 23:08:21 +00003052}