blob: f76e898cfb5aa63344a94affc755832e4a8b7ef4 [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 Christopherb4bef6d2013-11-19 09:04:36 +000061static cl::opt<bool> GenerateCUHash("generate-cu-hash", cl::Hidden,
62 cl::desc("Add the CU hash as the dwo_id."),
63 cl::init(false));
Eric Christopherd29614f2013-08-13 01:21:55 +000064
Eric Christopherdd1a0122013-09-13 00:35:05 +000065static cl::opt<bool>
66GenerateGnuPubSections("generate-gnu-dwarf-pub-sections", cl::Hidden,
67 cl::desc("Generate GNU-style pubnames and pubtypes"),
68 cl::init(false));
69
Eric Christopher20b76a72012-08-23 22:36:40 +000070namespace {
Eric Christopher7f2b5512013-07-23 22:16:41 +000071enum DefaultOnOff {
72 Default,
73 Enable,
74 Disable
75};
Eric Christopher20b76a72012-08-23 22:36:40 +000076}
Eric Christopher4996c702011-11-07 09:24:32 +000077
Eric Christopher7f2b5512013-07-23 22:16:41 +000078static cl::opt<DefaultOnOff>
79DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
80 cl::desc("Output prototype dwarf accelerator tables."),
81 cl::values(clEnumVal(Default, "Default for platform"),
82 clEnumVal(Enable, "Enabled"),
83 clEnumVal(Disable, "Disabled"), clEnumValEnd),
84 cl::init(Default));
Eric Christopher20b76a72012-08-23 22:36:40 +000085
Eric Christopher7f2b5512013-07-23 22:16:41 +000086static cl::opt<DefaultOnOff>
Eric Christopher7f2b5512013-07-23 22:16:41 +000087SplitDwarf("split-dwarf", cl::Hidden,
Eric Christopher5d008fe2013-12-04 23:24:28 +000088 cl::desc("Output DWARF5 split debug info."),
Eric Christopher7f2b5512013-07-23 22:16:41 +000089 cl::values(clEnumVal(Default, "Default for platform"),
90 clEnumVal(Enable, "Enabled"),
91 clEnumVal(Disable, "Disabled"), clEnumValEnd),
92 cl::init(Default));
Eric Christopher29424312012-11-12 22:22:20 +000093
Eric Christopher7da24882013-08-19 21:07:38 +000094static cl::opt<DefaultOnOff>
Eric Christopher4d36ca02013-08-26 23:24:35 +000095DwarfPubSections("generate-dwarf-pub-sections", cl::Hidden,
96 cl::desc("Generate DWARF pubnames and pubtypes sections"),
97 cl::values(clEnumVal(Default, "Default for platform"),
98 clEnumVal(Enable, "Enabled"),
99 clEnumVal(Disable, "Disabled"), clEnumValEnd),
100 cl::init(Default));
Eric Christopher7da24882013-08-19 21:07:38 +0000101
Eric Christopher33ff6972013-11-21 23:46:41 +0000102static cl::opt<unsigned>
103DwarfVersionNumber("dwarf-version", cl::Hidden,
Eric Christophera5a79422013-12-09 23:32:48 +0000104 cl::desc("Generate DWARF for dwarf version."), cl::init(0));
Eric Christopher33ff6972013-11-21 23:46:41 +0000105
Eric Christopher46e23432013-12-20 04:16:18 +0000106static cl::opt<bool>
107DwarfCURanges("generate-dwarf-cu-ranges", cl::Hidden,
108 cl::desc("Generate DW_AT_ranges for compile units"),
109 cl::init(false));
110
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
Eric Christopher942f22c2014-01-11 00:28:12 +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
Eric Christopher50effa02014-01-03 02:16:44 +0000185 DwarfInfoSectionSym = DwarfAbbrevSectionSym = DwarfStrSectionSym = 0;
Eric Christopher74804332013-02-07 21:19:50 +0000186 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
Eric Christopher55863be2013-04-07 03:43:09 +0000187 DwarfAddrSectionSym = 0;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000188 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000189 FunctionBeginSym = FunctionEndSym = 0;
Eric Christophera5a79422013-12-09 23:32:48 +0000190 CurFn = 0;
191 CurMI = 0;
Eric Christopherad9fe892012-04-02 17:58:52 +0000192
Adrian Prantl5bf1d002013-10-15 20:26:37 +0000193 // Turn on accelerator tables for Darwin by default, pubnames by
194 // default for non-Darwin, and handle split dwarf.
Eric Christopher203e12b2013-04-27 01:07:52 +0000195 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
Eric Christopher4977f212012-08-23 22:36:36 +0000196
Eric Christopher574b5c82013-08-19 21:41:38 +0000197 if (DwarfAccelTables == Default)
198 HasDwarfAccelTables = IsDarwin;
199 else
Eric Christopher5297df02013-08-26 20:58:35 +0000200 HasDwarfAccelTables = DwarfAccelTables == Enable;
Eric Christopher20b76a72012-08-23 22:36:40 +0000201
Eric Christophercdf218d2012-12-10 19:51:21 +0000202 if (SplitDwarf == Default)
203 HasSplitDwarf = false;
Eric Christopher29424312012-11-12 22:22:20 +0000204 else
Eric Christopher574b5c82013-08-19 21:41:38 +0000205 HasSplitDwarf = SplitDwarf == Enable;
Eric Christopher29424312012-11-12 22:22:20 +0000206
Eric Christopher4d36ca02013-08-26 23:24:35 +0000207 if (DwarfPubSections == Default)
208 HasDwarfPubSections = !IsDarwin;
Eric Christopher574b5c82013-08-19 21:41:38 +0000209 else
Eric Christopher4d36ca02013-08-26 23:24:35 +0000210 HasDwarfPubSections = DwarfPubSections == Enable;
Eric Christopher7da24882013-08-19 21:07:38 +0000211
Eric Christopher1ad84572014-01-15 00:04:29 +0000212 // For now only turn on CU ranges if we've explicitly asked for it
213 // or we have -ffunction-sections enabled.
214 HasCURanges = DwarfCURanges || TargetMachine::getFunctionSections();
215
Eric Christopher942f22c2014-01-11 00:28:12 +0000216 DwarfVersion = DwarfVersionNumber
217 ? DwarfVersionNumber
218 : getDwarfVersionFromModule(MMI->getModule());
Manman Renac8062b2013-07-02 23:40:10 +0000219
Dan Gohman6e681a52010-06-18 15:56:31 +0000220 {
221 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopher58f41952012-11-19 22:42:15 +0000222 beginModule();
Torok Edwinf8dba242010-04-07 10:44:46 +0000223 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000224}
Bill Wendling2f921f82009-05-15 09:23:25 +0000225
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000226// Switch to the specified MCSection and emit an assembler
227// temporary label to it if SymbolStem is specified.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000228static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christophera7b61892011-11-07 09:18:38 +0000229 const char *SymbolStem = 0) {
230 Asm->OutStreamer.SwitchSection(Section);
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000231 if (!SymbolStem)
232 return 0;
Eric Christophera7b61892011-11-07 09:18:38 +0000233
234 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
235 Asm->OutStreamer.EmitLabel(TmpSym);
236 return TmpSym;
237}
238
Eric Christopherf8194852013-12-05 18:06:10 +0000239DwarfFile::~DwarfFile() {
Eric Christophera5a79422013-12-09 23:32:48 +0000240 for (SmallVectorImpl<DwarfUnit *>::iterator I = CUs.begin(), E = CUs.end();
241 I != E; ++I)
David Blaikie72f1a3e2013-11-23 01:17:34 +0000242 delete *I;
243}
244
Eric Christopherf8194852013-12-05 18:06:10 +0000245MCSymbol *DwarfFile::getStringPoolSym() {
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000246 return Asm->GetTempSymbol(StringPref);
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000247}
248
Eric Christopherf8194852013-12-05 18:06:10 +0000249MCSymbol *DwarfFile::getStringPoolEntry(StringRef Str) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000250 std::pair<MCSymbol *, unsigned> &Entry =
251 StringPool.GetOrCreateValue(Str).getValue();
252 if (Entry.first)
253 return Entry.first;
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000254
255 Entry.second = NextStringPoolNumber++;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000256 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000257}
258
Eric Christopherf8194852013-12-05 18:06:10 +0000259unsigned DwarfFile::getStringPoolIndex(StringRef Str) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000260 std::pair<MCSymbol *, unsigned> &Entry =
261 StringPool.GetOrCreateValue(Str).getValue();
262 if (Entry.first)
263 return Entry.second;
Eric Christopher2cbd5762013-01-07 19:32:41 +0000264
265 Entry.second = NextStringPoolNumber++;
266 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
267 return Entry.second;
268}
269
Eric Christopherf8194852013-12-05 18:06:10 +0000270unsigned DwarfFile::getAddrPoolIndex(const MCSymbol *Sym) {
David Blaikie8466ca82013-07-01 23:55:52 +0000271 return getAddrPoolIndex(MCSymbolRefExpr::Create(Sym, Asm->OutContext));
272}
273
Eric Christopherf8194852013-12-05 18:06:10 +0000274unsigned DwarfFile::getAddrPoolIndex(const MCExpr *Sym) {
Ulrich Weigand8b3d2262013-07-02 18:46:46 +0000275 std::pair<DenseMap<const MCExpr *, unsigned>::iterator, bool> P =
David Blaikieb8ef7852013-06-28 18:47:19 +0000276 AddressPool.insert(std::make_pair(Sym, NextAddrPoolNumber));
David Blaikiea67de2b2013-06-28 18:55:13 +0000277 if (P.second)
278 ++NextAddrPoolNumber;
David Blaikieb8ef7852013-06-28 18:47:19 +0000279 return P.first->second;
Eric Christopher962c9082013-01-15 23:56:56 +0000280}
281
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000282// Define a unique number for the abbreviation.
283//
Eric Christopherf8194852013-12-05 18:06:10 +0000284void DwarfFile::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000285 // Check the set for priors.
David Blaikie0504cda2013-12-05 07:43:55 +0000286 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000287
288 // If it's newly added.
289 if (InSet == &Abbrev) {
290 // Add to abbreviation list.
David Blaikie2d4e1122013-10-30 17:14:24 +0000291 Abbreviations.push_back(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000292
293 // Assign the vector position + 1 as its number.
David Blaikie2d4e1122013-10-30 17:14:24 +0000294 Abbrev.setNumber(Abbreviations.size());
Bill Wendling2f921f82009-05-15 09:23:25 +0000295 } else {
296 // Assign existing abbreviation number.
297 Abbrev.setNumber(InSet->getNumber());
298 }
299}
300
Eric Christopherd9843b32011-11-10 19:25:34 +0000301static bool isObjCClass(StringRef Name) {
302 return Name.startswith("+") || Name.startswith("-");
303}
304
305static bool hasObjCCategory(StringRef Name) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000306 if (!isObjCClass(Name))
307 return false;
Eric Christopherd9843b32011-11-10 19:25:34 +0000308
Benjamin Kramer260de742013-08-24 12:15:54 +0000309 return Name.find(") ") != StringRef::npos;
Eric Christopherd9843b32011-11-10 19:25:34 +0000310}
311
312static void getObjCClassCategory(StringRef In, StringRef &Class,
313 StringRef &Category) {
314 if (!hasObjCCategory(In)) {
315 Class = In.slice(In.find('[') + 1, In.find(' '));
316 Category = "";
317 return;
318 }
319
320 Class = In.slice(In.find('[') + 1, In.find('('));
321 Category = In.slice(In.find('[') + 1, In.find(' '));
322 return;
323}
324
325static StringRef getObjCMethodName(StringRef In) {
326 return In.slice(In.find(' ') + 1, In.find(']'));
327}
328
Richard Mittonc2508242013-10-03 22:07:08 +0000329// Helper for sorting sections into a stable output order.
330static bool SectionSort(const MCSection *A, const MCSection *B) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000331 std::string LA = (A ? A->getLabelBeginName() : "");
332 std::string LB = (B ? B->getLabelBeginName() : "");
333 return LA < LB;
Richard Mittonc2508242013-10-03 22:07:08 +0000334}
335
Eric Christopherd9843b32011-11-10 19:25:34 +0000336// Add the various names to the Dwarf accelerator table names.
Eric Christopher9cd26af2013-09-20 23:22:52 +0000337// TODO: Determine whether or not we should add names for programs
338// that do not have a DW_AT_name or DW_AT_linkage_name field - this
339// is only slightly different than the lookup of non-standard ObjC names.
Eric Christophera5a79422013-12-09 23:32:48 +0000340static void addSubprogramNames(DwarfUnit *TheU, DISubprogram SP, DIE *Die) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000341 if (!SP.isDefinition())
342 return;
David Blaikie2a80e442013-12-02 22:09:48 +0000343 TheU->addAccelName(SP.getName(), Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000344
345 // If the linkage name is different than the name, go ahead and output
346 // that as well into the name table.
347 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
David Blaikie2a80e442013-12-02 22:09:48 +0000348 TheU->addAccelName(SP.getLinkageName(), Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000349
350 // If this is an Objective-C selector name add it to the ObjC accelerator
351 // too.
352 if (isObjCClass(SP.getName())) {
353 StringRef Class, Category;
354 getObjCClassCategory(SP.getName(), Class, Category);
David Blaikie2a80e442013-12-02 22:09:48 +0000355 TheU->addAccelObjC(Class, Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000356 if (Category != "")
David Blaikie2a80e442013-12-02 22:09:48 +0000357 TheU->addAccelObjC(Category, Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000358 // Also add the base method name to the name table.
David Blaikie2a80e442013-12-02 22:09:48 +0000359 TheU->addAccelName(getObjCMethodName(SP.getName()), Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000360 }
361}
362
Manman Ren3eb9dff2013-09-09 19:05:21 +0000363/// isSubprogramContext - Return true if Context is either a subprogram
364/// or another context nested inside a subprogram.
365bool DwarfDebug::isSubprogramContext(const MDNode *Context) {
366 if (!Context)
367 return false;
368 DIDescriptor D(Context);
369 if (D.isSubprogram())
370 return true;
371 if (D.isType())
Manman Ren116868e2013-09-09 19:47:11 +0000372 return isSubprogramContext(resolve(DIType(Context).getContext()));
Manman Ren3eb9dff2013-09-09 19:05:21 +0000373 return false;
374}
375
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000376// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
377// and DW_AT_high_pc attributes. If there are global variables in this
378// scope then create and insert DIEs for these variables.
Eric Christopher4287a492013-12-09 23:57:44 +0000379DIE *DwarfDebug::updateSubprogramScopeDIE(DwarfCompileUnit *SPCU,
380 DISubprogram SP) {
David Blaikie25bc7192013-11-15 23:13:08 +0000381 DIE *SPDie = SPCU->getDIE(SP);
Devang Patela37a95e2010-07-07 22:20:57 +0000382
Chris Lattner3a383cb2010-04-05 00:13:49 +0000383 assert(SPDie && "Unable to find subprogram DIE!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000384
Bill Wendlingf720bf62012-11-07 05:19:04 +0000385 // If we're updating an abstract DIE, then we will be adding the children and
386 // object pointer later on. But what we don't want to do is process the
387 // concrete DIE twice.
David Blaikie25bc7192013-11-15 23:13:08 +0000388 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SP)) {
Bill Wendlingf720bf62012-11-07 05:19:04 +0000389 // Pick up abstract subprogram DIE.
David Blaikie2a80e442013-12-02 22:09:48 +0000390 SPDie =
391 SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram, *SPCU->getUnitDie());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000392 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin, AbsSPDIE);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000393 } else {
394 DISubprogram SPDecl = SP.getFunctionDeclaration();
395 if (!SPDecl.isSubprogram()) {
396 // There is not any need to generate specification DIE for a function
397 // defined at compile unit level. If a function is defined inside another
398 // function then gdb prefers the definition at top level and but does not
399 // expect specification DIE in parent function. So avoid creating
400 // specification DIE for a function defined inside a function.
Manman Renc50fa112013-10-10 18:40:01 +0000401 DIScope SPContext = resolve(SP.getContext());
402 if (SP.isDefinition() && !SPContext.isCompileUnit() &&
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000403 !SPContext.isFile() && !isSubprogramContext(SPContext)) {
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000404 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
405
406 // Add arguments.
407 DICompositeType SPTy = SP.getType();
408 DIArray Args = SPTy.getTypeArray();
Eric Christopher31b05762013-08-08 01:41:00 +0000409 uint16_t SPTag = SPTy.getTag();
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000410 if (SPTag == dwarf::DW_TAG_subroutine_type)
411 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
Manman Ren4a841a82013-10-29 01:03:01 +0000412 DIE *Arg =
413 SPCU->createAndAddDIE(dwarf::DW_TAG_formal_parameter, *SPDie);
David Blaikie5af2aca2013-11-18 23:57:26 +0000414 DIType ATy(Args.getElement(i));
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000415 SPCU->addType(Arg, ATy);
416 if (ATy.isArtificial())
417 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
418 if (ATy.isObjectPointer())
Manman Ren4c4b69c2013-10-11 23:58:05 +0000419 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer, Arg);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000420 }
421 DIE *SPDeclDie = SPDie;
David Blaikie2a80e442013-12-02 22:09:48 +0000422 SPDie = SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram,
423 *SPCU->getUnitDie());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000424 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, SPDeclDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000425 }
426 }
Devang Patela37a95e2010-07-07 22:20:57 +0000427 }
428
David Blaikieb7a1c4d2013-12-04 17:55:41 +0000429 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc, FunctionBeginSym);
430 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc, FunctionEndSym);
Eric Christopher0f63d062013-12-03 00:45:45 +0000431
Eric Christopher46e23432013-12-20 04:16:18 +0000432 // Add this range to the list of ranges for the CU.
433 RangeSpan Span(FunctionBeginSym, FunctionEndSym);
434 SPCU->addRange(llvm_move(Span));
435
Chris Lattner3a383cb2010-04-05 00:13:49 +0000436 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
437 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000438 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000439
Eric Christopherd9843b32011-11-10 19:25:34 +0000440 // Add name to the name table, we do this here because we're guaranteed
441 // to have concrete versions of our DW_TAG_subprogram nodes.
442 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher6a841382012-11-19 22:42:10 +0000443
Chris Lattner3a383cb2010-04-05 00:13:49 +0000444 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000445}
446
Manman Ren5b2f4b02013-09-11 19:40:28 +0000447/// Check whether we should create a DIE for the given Scope, return true
448/// if we don't create a DIE (the corresponding DIE is null).
Manman Ren2312ed32013-09-10 18:40:41 +0000449bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
450 if (Scope->isAbstractScope())
451 return false;
452
Manman Ren5b2f4b02013-09-11 19:40:28 +0000453 // We don't create a DIE if there is no Range.
Manman Ren2312ed32013-09-10 18:40:41 +0000454 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
455 if (Ranges.empty())
456 return true;
457
458 if (Ranges.size() > 1)
459 return false;
460
Manman Ren5b2f4b02013-09-11 19:40:28 +0000461 // We don't create a DIE if we have a single Range and the end label
462 // is null.
Manman Ren2312ed32013-09-10 18:40:41 +0000463 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
464 MCSymbol *End = getLabelAfterInsn(RI->second);
465 return !End;
466}
467
Eric Christophera5a79422013-12-09 23:32:48 +0000468static void addSectionLabel(AsmPrinter *Asm, DwarfUnit *U, DIE *D,
Eric Christopherc31fe2d2013-12-05 00:36:17 +0000469 dwarf::Attribute A, const MCSymbol *L,
470 const MCSymbol *Sec) {
471 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
472 U->addSectionLabel(D, A, L);
473 else
474 U->addSectionDelta(D, A, L, Sec);
475}
476
Eric Christopher4287a492013-12-09 23:57:44 +0000477void DwarfDebug::addScopeRangeList(DwarfCompileUnit *TheCU, DIE *ScopeDIE,
Eric Christopherbe2513e2013-12-03 00:45:59 +0000478 const SmallVectorImpl<InsnRange> &Range) {
479 // Emit offset in .debug_range as a relocatable label. emitDIE will handle
480 // emitting it appropriately.
Eric Christopherf8790642013-12-04 22:04:50 +0000481 MCSymbol *RangeSym = Asm->GetTempSymbol("debug_ranges", GlobalRangeCount++);
Eric Christopherc31fe2d2013-12-05 00:36:17 +0000482 addSectionLabel(Asm, TheCU, ScopeDIE, dwarf::DW_AT_ranges, RangeSym,
483 DwarfDebugRangeSectionSym);
484
Eric Christopherf8790642013-12-04 22:04:50 +0000485 RangeSpanList List(RangeSym);
Eric Christopherbe2513e2013-12-03 00:45:59 +0000486 for (SmallVectorImpl<InsnRange>::const_iterator RI = Range.begin(),
487 RE = Range.end();
488 RI != RE; ++RI) {
489 RangeSpan Span(getLabelBeforeInsn(RI->first),
490 getLabelAfterInsn(RI->second));
Eric Christopher270ba4a2013-12-04 19:06:58 +0000491 List.addRange(llvm_move(Span));
Eric Christopherbe2513e2013-12-03 00:45:59 +0000492 }
493
494 // Add the range list to the set of ranges to be emitted.
Eric Christopher270ba4a2013-12-04 19:06:58 +0000495 TheCU->addRangeList(llvm_move(List));
Eric Christopherbe2513e2013-12-03 00:45:59 +0000496}
497
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000498// Construct new DW_TAG_lexical_block for this scope and attach
499// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher4287a492013-12-09 23:57:44 +0000500DIE *DwarfDebug::constructLexicalScopeDIE(DwarfCompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000501 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000502 if (isLexicalScopeDIENull(Scope))
503 return 0;
504
Devang Patel6c74a872010-04-27 19:46:33 +0000505 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
506 if (Scope->isAbstractScope())
507 return ScopeDIE;
508
Eric Christopher0f63d062013-12-03 00:45:45 +0000509 const SmallVectorImpl<InsnRange> &ScopeRanges = Scope->getRanges();
Eric Christopherbe2513e2013-12-03 00:45:59 +0000510
Eric Christopherdc42ea82013-07-03 01:57:28 +0000511 // If we have multiple ranges, emit them into the range section.
Eric Christopher0f63d062013-12-03 00:45:45 +0000512 if (ScopeRanges.size() > 1) {
Eric Christopherbe2513e2013-12-03 00:45:59 +0000513 addScopeRangeList(TheCU, ScopeDIE, ScopeRanges);
Devang Patel6c74a872010-04-27 19:46:33 +0000514 return ScopeDIE;
515 }
516
Eric Christopherdc42ea82013-07-03 01:57:28 +0000517 // Construct the address range for this DIE.
Eric Christopher0f63d062013-12-03 00:45:45 +0000518 SmallVectorImpl<InsnRange>::const_iterator RI = ScopeRanges.begin();
Eric Christopher962c9082013-01-15 23:56:56 +0000519 MCSymbol *Start = getLabelBeforeInsn(RI->first);
520 MCSymbol *End = getLabelAfterInsn(RI->second);
Manman Ren2312ed32013-09-10 18:40:41 +0000521 assert(End && "End label should not be null!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000522
Chris Lattnere13c3722010-03-09 01:58:53 +0000523 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
524 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000525
Eric Christopher962c9082013-01-15 23:56:56 +0000526 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
527 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000528
529 return ScopeDIE;
530}
531
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000532// This scope represents inlined body of a function. Construct DIE to
533// represent this concrete inlined copy of the function.
Eric Christopher4287a492013-12-09 23:57:44 +0000534DIE *DwarfDebug::constructInlinedScopeDIE(DwarfCompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000535 LexicalScope *Scope) {
Eric Christopher0f63d062013-12-03 00:45:45 +0000536 const SmallVectorImpl<InsnRange> &ScopeRanges = Scope->getRanges();
Eric Christopher1cdb63d2013-12-04 21:20:15 +0000537 assert(!ScopeRanges.empty() &&
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000538 "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000539
Devang Patelf098ce22011-07-27 00:34:13 +0000540 if (!Scope->getScopeNode())
541 return NULL;
542 DIScope DS(Scope->getScopeNode());
543 DISubprogram InlinedSP = getDISubprogram(DS);
Eric Christophere595bae2013-10-04 17:08:38 +0000544 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patelf098ce22011-07-27 00:34:13 +0000545 if (!OriginDIE) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000546 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patelf098ce22011-07-27 00:34:13 +0000547 return NULL;
548 }
549
Devang Patel73bc1722011-05-05 17:54:26 +0000550 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Manman Ren4c4b69c2013-10-11 23:58:05 +0000551 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000552
Eric Christopherbe2513e2013-12-03 00:45:59 +0000553 // If we have multiple ranges, emit them into the range section.
554 if (ScopeRanges.size() > 1)
555 addScopeRangeList(TheCU, ScopeDIE, ScopeRanges);
556 else {
Eric Christopher0f63d062013-12-03 00:45:45 +0000557 SmallVectorImpl<InsnRange>::const_iterator RI = ScopeRanges.begin();
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000558 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
559 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
560
561 if (StartLabel == 0 || EndLabel == 0)
562 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
563
564 assert(StartLabel->isDefined() &&
565 "Invalid starting label for an inlined scope!");
566 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
567
Eric Christopher962c9082013-01-15 23:56:56 +0000568 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
569 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patelf098ce22011-07-27 00:34:13 +0000570 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000571
572 InlinedSubprogramDIEs.insert(OriginDIE);
573
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000574 // Add the call site information to the DIE.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000575 DILocation DL(Scope->getInlinedAt());
David Blaikief2443192013-10-21 17:28:37 +0000576 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, None,
Manman Ren1e427202013-03-07 01:42:00 +0000577 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
578 TheCU->getUniqueID()));
David Blaikief2443192013-10-21 17:28:37 +0000579 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, None, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000580
Eric Christopher8dda5d02011-12-04 06:02:38 +0000581 // Add name to the name table, we do this here because we're guaranteed
582 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
583 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher6a841382012-11-19 22:42:10 +0000584
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000585 return ScopeDIE;
586}
587
Eric Christopher4287a492013-12-09 23:57:44 +0000588DIE *DwarfDebug::createScopeChildrenDIE(DwarfCompileUnit *TheCU,
589 LexicalScope *Scope,
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000590 SmallVectorImpl<DIE *> &Children) {
591 DIE *ObjectPointer = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +0000592
593 // Collect arguments for current function.
Devang Patel7e623022011-08-10 20:55:27 +0000594 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000595 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
596 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher6a841382012-11-19 22:42:10 +0000597 if (DIE *Arg =
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000598 TheCU->constructVariableDIE(*ArgDV, Scope->isAbstractScope())) {
Devang Patel6c622ef2011-03-01 22:58:55 +0000599 Children.push_back(Arg);
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000600 if (ArgDV->isObjectPointer())
601 ObjectPointer = Arg;
Eric Christophere3417762012-09-12 23:36:19 +0000602 }
Devang Patel6c622ef2011-03-01 22:58:55 +0000603
Eric Christopherf84354b2011-10-03 15:49:16 +0000604 // Collect lexical scope children first.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000605 const SmallVectorImpl<DbgVariable *> &Variables =
606 ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000607 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000608 if (DIE *Variable = TheCU->constructVariableDIE(*Variables[i],
609 Scope->isAbstractScope())) {
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000610 Children.push_back(Variable);
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000611 if (Variables[i]->isObjectPointer())
612 ObjectPointer = Variable;
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000613 }
Craig Topper977e9cd2013-07-03 04:24:43 +0000614 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000615 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Patel3acc70e2011-08-15 22:04:40 +0000616 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000617 Children.push_back(Nested);
Manman Ren2312ed32013-09-10 18:40:41 +0000618 return ObjectPointer;
619}
620
621// Construct a DIE for this scope.
Eric Christopher4287a492013-12-09 23:57:44 +0000622DIE *DwarfDebug::constructScopeDIE(DwarfCompileUnit *TheCU,
623 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000624 if (!Scope || !Scope->getScopeNode())
625 return NULL;
626
627 DIScope DS(Scope->getScopeNode());
628
629 SmallVector<DIE *, 8> Children;
630 DIE *ObjectPointer = NULL;
631 bool ChildrenCreated = false;
632
Manman Ren5b2f4b02013-09-11 19:40:28 +0000633 // We try to create the scope DIE first, then the children DIEs. This will
634 // avoid creating un-used children then removing them later when we find out
635 // the scope DIE is null.
Devang Patel3b548aa2010-03-08 20:52:55 +0000636 DIE *ScopeDIE = NULL;
637 if (Scope->getInlinedAt())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000638 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3b548aa2010-03-08 20:52:55 +0000639 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000640 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000641 if (Scope->isAbstractScope()) {
Eric Christophere595bae2013-10-04 17:08:38 +0000642 ScopeDIE = TheCU->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000643 // Note down abstract DIE.
644 if (ScopeDIE)
645 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
David Blaikiee26a3772013-11-18 23:59:04 +0000646 } else
David Blaikie25bc7192013-11-15 23:13:08 +0000647 ScopeDIE = updateSubprogramScopeDIE(TheCU, DISubprogram(DS));
David Blaikiee26a3772013-11-18 23:59:04 +0000648 } else {
Manman Ren5b2f4b02013-09-11 19:40:28 +0000649 // Early exit when we know the scope DIE is going to be null.
Manman Ren2312ed32013-09-10 18:40:41 +0000650 if (isLexicalScopeDIENull(Scope))
651 return NULL;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000652
653 // We create children here when we know the scope DIE is not going to be
654 // null and the children will be added to the scope DIE.
Manman Ren2312ed32013-09-10 18:40:41 +0000655 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
656 ChildrenCreated = true;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000657
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000658 // There is no need to emit empty lexical block DIE.
David Blaikie684fc532013-05-06 23:33:07 +0000659 std::pair<ImportedEntityMap::const_iterator,
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000660 ImportedEntityMap::const_iterator> Range =
661 std::equal_range(
662 ScopesWithImportedEntities.begin(),
663 ScopesWithImportedEntities.end(),
664 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode *)0),
665 less_first());
David Blaikie684fc532013-05-06 23:33:07 +0000666 if (Children.empty() && Range.first == Range.second)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000667 return NULL;
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000668 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Manman Ren2312ed32013-09-10 18:40:41 +0000669 assert(ScopeDIE && "Scope DIE should not be null.");
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000670 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
671 ++i)
David Blaikie4dd2de72013-05-08 06:01:38 +0000672 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000673 }
Eric Christopher6a841382012-11-19 22:42:10 +0000674
Benjamin Kramer892daba2013-08-24 11:55:49 +0000675 if (!ScopeDIE) {
Manman Ren2312ed32013-09-10 18:40:41 +0000676 assert(Children.empty() &&
677 "We create children only when the scope DIE is not null.");
Benjamin Kramer892daba2013-08-24 11:55:49 +0000678 return NULL;
679 }
Manman Ren2312ed32013-09-10 18:40:41 +0000680 if (!ChildrenCreated)
Manman Ren5b2f4b02013-09-11 19:40:28 +0000681 // We create children when the scope DIE is not null.
Manman Ren2312ed32013-09-10 18:40:41 +0000682 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000683
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000684 // Add children
Craig Topperd8e43652013-07-03 04:17:25 +0000685 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000686 E = Children.end();
687 I != E; ++I)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000688 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000689
Eric Christophere3417762012-09-12 23:36:19 +0000690 if (DS.isSubprogram() && ObjectPointer != NULL)
Manman Ren4c4b69c2013-10-11 23:58:05 +0000691 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, ObjectPointer);
Eric Christophere3417762012-09-12 23:36:19 +0000692
Eric Christopherd9843b32011-11-10 19:25:34 +0000693 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000694}
695
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000696// Look up the source id with the given directory and source file names.
697// If none currently exists, create a new id and insert it in the
698// SourceIds map. This can update DirectoryNames and SourceFileNames maps
699// as well.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000700unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName, StringRef DirName,
701 unsigned CUID) {
Manman Ren1e427202013-03-07 01:42:00 +0000702 // If we use .loc in assembly, we can't separate .file entries according to
703 // compile units. Thus all files will belong to the default compile unit.
Rafael Espindolaac4ad252013-10-05 16:42:21 +0000704
705 // FIXME: add a better feature test than hasRawTextSupport. Even better,
706 // extend .file to support this.
707 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren1e427202013-03-07 01:42:00 +0000708 CUID = 0;
709
Devang Patel871d0b12010-09-16 20:57:49 +0000710 // If FE did not provide a file name, then assume stdin.
711 if (FileName.empty())
Manman Ren1e427202013-03-07 01:42:00 +0000712 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patele01b75c2011-03-24 20:30:50 +0000713
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000714 // TODO: this might not belong here. See if we can factor this better.
715 if (DirName == CompilationDir)
716 DirName = "";
717
Manman Ren1e427202013-03-07 01:42:00 +0000718 // FileIDCUMap stores the current ID for the given compile unit.
719 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel871d0b12010-09-16 20:57:49 +0000720
Manman Ren1e427202013-03-07 01:42:00 +0000721 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer71b19732012-03-11 14:56:26 +0000722 SmallString<128> NamePair;
Manman Ren5b22f9f2013-04-06 01:02:38 +0000723 NamePair += utostr(CUID);
Manman Ren1e427202013-03-07 01:42:00 +0000724 NamePair += '\0';
Benjamin Kramer71b19732012-03-11 14:56:26 +0000725 NamePair += DirName;
726 NamePair += '\0'; // Zero bytes are not allowed in paths.
727 NamePair += FileName;
728
729 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
730 if (Ent.getValue() != SrcId)
731 return Ent.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +0000732
Manman Ren1e427202013-03-07 01:42:00 +0000733 FileIDCUMap[CUID] = SrcId;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000734 // Print out a .file directive to specify files for .loc directives.
Manman Ren1e427202013-03-07 01:42:00 +0000735 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendling2b128d72009-05-20 23:19:06 +0000736
737 return SrcId;
738}
739
Eric Christophera5a79422013-12-09 23:32:48 +0000740void DwarfDebug::addGnuPubAttributes(DwarfUnit *U, DIE *D) const {
David Blaikie3c842622013-12-04 21:31:26 +0000741 if (!GenerateGnuPubSections)
742 return;
743
744 addSectionLabel(Asm, U, D, dwarf::DW_AT_GNU_pubnames,
745 Asm->GetTempSymbol("gnu_pubnames", U->getUniqueID()),
746 DwarfGnuPubNamesSectionSym);
747
748 addSectionLabel(Asm, U, D, dwarf::DW_AT_GNU_pubtypes,
749 Asm->GetTempSymbol("gnu_pubtypes", U->getUniqueID()),
750 DwarfGnuPubTypesSectionSym);
751}
752
Eric Christopher4287a492013-12-09 23:57:44 +0000753// Create new DwarfCompileUnit for the given metadata node with tag
Eric Christopher48fef592012-12-20 21:58:40 +0000754// DW_TAG_compile_unit.
Eric Christopher4287a492013-12-09 23:57:44 +0000755DwarfCompileUnit *DwarfDebug::constructDwarfCompileUnit(DICompileUnit DIUnit) {
Devang Patel2d9caf92009-11-25 17:36:49 +0000756 StringRef FN = DIUnit.getFilename();
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000757 CompilationDir = DIUnit.getDirectory();
Bill Wendling2b128d72009-05-20 23:19:06 +0000758
759 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher4287a492013-12-09 23:57:44 +0000760 DwarfCompileUnit *NewCU = new DwarfCompileUnit(
761 InfoHolder.getUnits().size(), Die, DIUnit, Asm, this, &InfoHolder);
David Blaikie2666e242013-12-06 19:38:46 +0000762 InfoHolder.addUnit(NewCU);
763
Manman Ren1e427202013-03-07 01:42:00 +0000764 FileIDCUMap[NewCU->getUniqueID()] = 0;
765 // Call this to emit a .file directive if it wasn't emitted for the source
766 // file this CU comes from yet.
767 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
768
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000769 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patelf20c4f72011-04-12 22:53:02 +0000770 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
771 DIUnit.getLanguage());
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000772 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christopher52ce7182013-04-09 19:23:15 +0000773
Manman Ren4e042a62013-02-05 21:52:47 +0000774 // Define start line table label for each Compile Unit.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000775 MCSymbol *LineTableStartSym =
776 Asm->GetTempSymbol("line_table_start", NewCU->getUniqueID());
Manman Ren4e042a62013-02-05 21:52:47 +0000777 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
778 NewCU->getUniqueID());
779
Manman Ren9d4c7352013-05-21 00:57:22 +0000780 // Use a single line table if we are using .loc and generating assembly.
781 bool UseTheFirstCU =
Rafael Espindolaac4ad252013-10-05 16:42:21 +0000782 (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport()) ||
783 (NewCU->getUniqueID() == 0);
Manman Ren9d4c7352013-05-21 00:57:22 +0000784
Eric Christopher52ce7182013-04-09 19:23:15 +0000785 if (!useSplitDwarf()) {
Eric Christophera51d3fc2013-09-27 22:50:48 +0000786 // DW_AT_stmt_list is a offset of line number information for this
787 // compile unit in debug_line section. For split dwarf this is
788 // left in the skeleton CU and so not included.
789 // The line table entries are not always emitted in assembly, so it
790 // is not okay to use line_table_start here.
Eric Christopher52ce7182013-04-09 19:23:15 +0000791 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christophera5a79422013-12-09 23:32:48 +0000792 NewCU->addSectionLabel(Die, dwarf::DW_AT_stmt_list,
793 UseTheFirstCU ? Asm->GetTempSymbol("section_line")
794 : LineTableStartSym);
Manman Ren9d4c7352013-05-21 00:57:22 +0000795 else if (UseTheFirstCU)
Eric Christopher33ff6972013-11-21 23:46:41 +0000796 NewCU->addSectionOffset(Die, dwarf::DW_AT_stmt_list, 0);
Eric Christopher52ce7182013-04-09 19:23:15 +0000797 else
Eric Christophera5a79422013-12-09 23:32:48 +0000798 NewCU->addSectionDelta(Die, dwarf::DW_AT_stmt_list, LineTableStartSym,
799 DwarfLineSectionSym);
Eric Christophera51d3fc2013-09-27 22:50:48 +0000800
801 // If we're using split dwarf the compilation dir is going to be in the
802 // skeleton CU and so we don't need to duplicate it here.
803 if (!CompilationDir.empty())
804 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
805
David Blaikie3c842622013-12-04 21:31:26 +0000806 addGnuPubAttributes(NewCU, Die);
Eric Christopher52ce7182013-04-09 19:23:15 +0000807 }
Bill Wendling2b128d72009-05-20 23:19:06 +0000808
Bill Wendling2b128d72009-05-20 23:19:06 +0000809 if (DIUnit.isOptimized())
Eric Christopherbb69a272012-08-24 01:14:27 +0000810 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendling2b128d72009-05-20 23:19:06 +0000811
Devang Patel2d9caf92009-11-25 17:36:49 +0000812 StringRef Flags = DIUnit.getFlags();
813 if (!Flags.empty())
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000814 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher6a841382012-11-19 22:42:10 +0000815
Nick Lewycky479a8fe2011-10-17 23:27:36 +0000816 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patelf20c4f72011-04-12 22:53:02 +0000817 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000818 dwarf::DW_FORM_data1, RVer);
Bill Wendling2b128d72009-05-20 23:19:06 +0000819
Devang Patel1a0df9a2010-05-10 22:49:55 +0000820 if (!FirstCU)
821 FirstCU = NewCU;
Eric Christopher7a2cdf72013-02-05 07:31:55 +0000822
Eric Christopherd4368fd2014-01-02 21:03:28 +0000823 if (useSplitDwarf()) {
824 NewCU->initSection(Asm->getObjFileLowering().getDwarfInfoDWOSection(),
825 DwarfInfoDWOSectionSym);
Eric Christopherd8667202013-12-30 17:22:27 +0000826 NewCU->setSkeleton(constructSkeletonCU(NewCU));
Eric Christopherd4368fd2014-01-02 21:03:28 +0000827 } else
828 NewCU->initSection(Asm->getObjFileLowering().getDwarfInfoSection(),
829 DwarfInfoSectionSym);
Eric Christopherd039baa2013-12-30 03:40:32 +0000830
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
1021void DwarfDebug::finalizeModuleInfo() {
1022 // Collect info for variables that were optimized out.
1023 collectDeadVariables();
1024
1025 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1026 computeInlinedDIEs();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001027
Eric Christopherad10cb52013-12-04 23:24:38 +00001028 // Handle anything that needs to be done on a per-unit basis after
1029 // all other generation.
Eric Christophera5a79422013-12-09 23:32:48 +00001030 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
1031 E = getUnits().end();
David Blaikiefd1eff52013-11-26 19:14:34 +00001032 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00001033 DwarfUnit *TheU = *I;
Eric Christopher60eb7692013-08-12 20:27:48 +00001034 // Emit DW_AT_containing_type attribute to connect types with their
1035 // vtable holding type.
David Blaikie2a80e442013-12-02 22:09:48 +00001036 TheU->constructContainingTypeDIEs();
Eric Christopher60eb7692013-08-12 20:27:48 +00001037
Eric Christopher46e23432013-12-20 04:16:18 +00001038 // Add CU specific attributes if we need to add any.
1039 if (TheU->getUnitDie()->getTag() == dwarf::DW_TAG_compile_unit) {
1040 // If we're splitting the dwarf out now that we've got the entire
Eric Christopherd8667202013-12-30 17:22:27 +00001041 // CU then add the dwo id to it.
1042 DwarfCompileUnit *SkCU =
1043 static_cast<DwarfCompileUnit *>(TheU->getSkeleton());
Eric Christopher46e23432013-12-20 04:16:18 +00001044 if (useSplitDwarf()) {
1045 // This should be a unique identifier when we want to build .dwp files.
1046 uint64_t ID = 0;
1047 if (GenerateCUHash) {
1048 DIEHash CUHash;
1049 ID = CUHash.computeCUSignature(*TheU->getUnitDie());
1050 }
1051 TheU->addUInt(TheU->getUnitDie(), dwarf::DW_AT_GNU_dwo_id,
1052 dwarf::DW_FORM_data8, ID);
Eric Christopher46e23432013-12-20 04:16:18 +00001053 SkCU->addUInt(SkCU->getUnitDie(), dwarf::DW_AT_GNU_dwo_id,
1054 dwarf::DW_FORM_data8, ID);
Eric Christopherd29614f2013-08-13 01:21:55 +00001055 }
Eric Christopherd8667202013-12-30 17:22:27 +00001056
Eric Christopher39cde8c2014-01-14 22:44:17 +00001057 // If we have code split among multiple sections or we've requested
1058 // it then emit a DW_AT_ranges attribute on the unit that will remain
1059 // in the .o file, otherwise add a DW_AT_low_pc.
Eric Christopherd8667202013-12-30 17:22:27 +00001060 // FIXME: Also add a high pc if we can.
Eric Christopher39cde8c2014-01-14 22:44:17 +00001061 // FIXME: We should use ranges if we have multiple compile units or
1062 // allow reordering of code ala .subsections_via_symbols in mach-o.
Eric Christopherd8667202013-12-30 17:22:27 +00001063 DwarfCompileUnit *U = SkCU ? SkCU : static_cast<DwarfCompileUnit *>(TheU);
Eric Christopher1ad84572014-01-15 00:04:29 +00001064 if (useCURanges() && TheU->getRanges().size())
Eric Christopherd8667202013-12-30 17:22:27 +00001065 addSectionLabel(Asm, U, U->getUnitDie(), dwarf::DW_AT_ranges,
1066 Asm->GetTempSymbol("cu_ranges", U->getUniqueID()),
1067 DwarfDebugRangeSectionSym);
1068 else
Eric Christopher4d214b92014-01-03 02:17:35 +00001069 U->addUInt(U->getUnitDie(), dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1070 0);
Eric Christopher60eb7692013-08-12 20:27:48 +00001071 }
1072 }
1073
1074 // Compute DIE offsets and sizes.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001075 InfoHolder.computeSizeAndOffsets();
1076 if (useSplitDwarf())
1077 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher960ac372012-11-22 00:59:49 +00001078}
1079
1080void DwarfDebug::endSections() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001081 // Filter labels by section.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001082 for (size_t n = 0; n < ArangeLabels.size(); n++) {
1083 const SymbolCU &SCU = ArangeLabels[n];
Richard Mitton21101b32013-09-19 23:21:01 +00001084 if (SCU.Sym->isInSection()) {
1085 // Make a note of this symbol and it's section.
1086 const MCSection *Section = &SCU.Sym->getSection();
1087 if (!Section->getKind().isMetadata())
1088 SectionMap[Section].push_back(SCU);
1089 } else {
1090 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1091 // appear in the output. This sucks as we rely on sections to build
1092 // arange spans. We can do it without, but it's icky.
1093 SectionMap[NULL].push_back(SCU);
1094 }
1095 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001096
Richard Mittonc2508242013-10-03 22:07:08 +00001097 // Build a list of sections used.
1098 std::vector<const MCSection *> Sections;
Richard Mitton21101b32013-09-19 23:21:01 +00001099 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1100 it++) {
1101 const MCSection *Section = it->first;
Richard Mittonc2508242013-10-03 22:07:08 +00001102 Sections.push_back(Section);
1103 }
1104
1105 // Sort the sections into order.
1106 // This is only done to ensure consistent output order across different runs.
1107 std::sort(Sections.begin(), Sections.end(), SectionSort);
1108
1109 // Add terminating symbols for each section.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001110 for (unsigned ID = 0; ID < Sections.size(); ID++) {
Richard Mittonc2508242013-10-03 22:07:08 +00001111 const MCSection *Section = Sections[ID];
Richard Mitton21101b32013-09-19 23:21:01 +00001112 MCSymbol *Sym = NULL;
1113
1114 if (Section) {
Richard Mittonc2508242013-10-03 22:07:08 +00001115 // We can't call MCSection::getLabelEndName, as it's only safe to do so
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001116 // if we know the section name up-front. For user-created sections, the
1117 // resulting
1118 // label may not be valid to use as a label. (section names can use a
1119 // greater
Richard Mittonc2508242013-10-03 22:07:08 +00001120 // set of characters on some systems)
1121 Sym = Asm->GetTempSymbol("debug_end", ID);
Richard Mitton21101b32013-09-19 23:21:01 +00001122 Asm->OutStreamer.SwitchSection(Section);
1123 Asm->OutStreamer.EmitLabel(Sym);
1124 }
1125
1126 // Insert a final terminator.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001127 SectionMap[Section].push_back(SymbolCU(NULL, Sym));
Bill Wendling2b128d72009-05-20 23:19:06 +00001128 }
Eric Christopher960ac372012-11-22 00:59:49 +00001129}
Bill Wendling2b128d72009-05-20 23:19:06 +00001130
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001131// Emit all Dwarf sections that should come after the content.
Eric Christopher960ac372012-11-22 00:59:49 +00001132void DwarfDebug::endModule() {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001133 assert(CurFn == 0);
1134 assert(CurMI == 0);
Eric Christopher960ac372012-11-22 00:59:49 +00001135
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001136 if (!FirstCU)
1137 return;
Eric Christopher960ac372012-11-22 00:59:49 +00001138
1139 // End any existing sections.
1140 // TODO: Does this need to happen?
1141 endSections();
1142
1143 // Finalize the debug info for the module.
1144 finalizeModuleInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001145
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001146 emitDebugStr();
Eric Christopher9cd26af2013-09-20 23:22:52 +00001147
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001148 // Emit all the DIEs into a debug info section.
1149 emitDebugInfo();
Eric Christopher4c9b1192012-11-27 00:41:54 +00001150
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001151 // Corresponding abbreviations into a abbrev section.
1152 emitAbbreviations();
Eric Christopher95198f502012-11-27 22:43:42 +00001153
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001154 // Emit info into a debug loc section.
1155 emitDebugLoc();
Eric Christopher95198f502012-11-27 22:43:42 +00001156
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001157 // Emit info into a debug aranges section.
1158 emitDebugARanges();
Eric Christopher95198f502012-11-27 22:43:42 +00001159
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001160 // Emit info into a debug ranges section.
1161 emitDebugRanges();
Eric Christopher95198f502012-11-27 22:43:42 +00001162
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001163 if (useSplitDwarf()) {
1164 emitDebugStrDWO();
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001165 emitDebugInfoDWO();
Eric Christopher3c5a1912012-12-19 22:02:53 +00001166 emitDebugAbbrevDWO();
Eric Christopher962c9082013-01-15 23:56:56 +00001167 // Emit DWO addresses.
1168 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
Eric Christopher95198f502012-11-27 22:43:42 +00001169 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001170
Eric Christophera876b822012-08-23 07:32:06 +00001171 // Emit info into the dwarf accelerator table sections.
Eric Christopher20b76a72012-08-23 22:36:40 +00001172 if (useDwarfAccelTables()) {
Eric Christopher4996c702011-11-07 09:24:32 +00001173 emitAccelNames();
1174 emitAccelObjC();
1175 emitAccelNamespaces();
1176 emitAccelTypes();
1177 }
Eric Christopher6a841382012-11-19 22:42:10 +00001178
Eric Christopher4b358182013-08-30 00:40:17 +00001179 // Emit the pubnames and pubtypes sections if requested.
1180 if (HasDwarfPubSections) {
David Blaikie70a33202013-09-19 17:33:35 +00001181 emitDebugPubNames(GenerateGnuPubSections);
1182 emitDebugPubTypes(GenerateGnuPubSections);
Eric Christopher4b358182013-08-30 00:40:17 +00001183 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001184
Devang Pateld0701282010-08-02 17:32:15 +00001185 // clean up.
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001186 SPMap.clear();
Eric Christopher8afd7b62012-12-10 19:51:18 +00001187
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001188 // Reset these for the next Module if we have one.
1189 FirstCU = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001190}
1191
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001192// Find abstract variable, if any, associated with Var.
Devang Patelbb23a4a2011-08-10 21:50:54 +00001193DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattner915c5f92010-04-02 19:42:39 +00001194 DebugLoc ScopeLoc) {
Devang Patelbb23a4a2011-08-10 21:50:54 +00001195 LLVMContext &Ctx = DV->getContext();
1196 // More then one inlined variable corresponds to one abstract variable.
1197 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001198 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001199 if (AbsDbgVariable)
1200 return AbsDbgVariable;
1201
Devang Patel7e623022011-08-10 20:55:27 +00001202 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001203 if (!Scope)
1204 return NULL;
1205
Manman Renb3388602013-10-05 01:43:03 +00001206 AbsDbgVariable = new DbgVariable(Var, NULL, this);
Devang Patel7e623022011-08-10 20:55:27 +00001207 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001208 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001209 return AbsDbgVariable;
1210}
1211
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001212// If Var is a current function argument then add it to CurrentFnArguments list.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001213bool DwarfDebug::addCurrentFnArgument(DbgVariable *Var, LexicalScope *Scope) {
Devang Patel7e623022011-08-10 20:55:27 +00001214 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +00001215 return false;
1216 DIVariable DV = Var->getVariable();
1217 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1218 return false;
1219 unsigned ArgNo = DV.getArgNumber();
Eric Christopher6a841382012-11-19 22:42:10 +00001220 if (ArgNo == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001221 return false;
1222
Devang Patel4ab660b2011-03-03 20:02:02 +00001223 size_t Size = CurrentFnArguments.size();
1224 if (Size == 0)
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001225 CurrentFnArguments.resize(CurFn->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001226 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001227 // arguments does the function have at source level.
1228 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001229 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001230 CurrentFnArguments[ArgNo - 1] = Var;
1231 return true;
1232}
1233
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001234// Collect variable information from side table maintained by MMI.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001235void DwarfDebug::collectVariableInfoFromMMITable(
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001236 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001237 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1238 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001239 VE = VMap.end();
1240 VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001241 const MDNode *Var = VI->first;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001242 if (!Var)
1243 continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001244 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001245 DIVariable DV(Var);
1246 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001247
Devang Patel7e623022011-08-10 20:55:27 +00001248 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001249
Devang Patelcdb7d442009-11-10 23:20:04 +00001250 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001251 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001252 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001253
Devang Patele1c53f22010-05-20 16:36:41 +00001254 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Manman Renb3388602013-10-05 01:43:03 +00001255 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
Devang Patel3e4a9652011-08-15 21:24:36 +00001256 RegVar->setFrameIndex(VP.first);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001257 if (!addCurrentFnArgument(RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001258 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001259 if (AbsDbgVariable)
Devang Patel3e4a9652011-08-15 21:24:36 +00001260 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patel475d32a2009-10-06 01:26:37 +00001261 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001262}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001263
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001264// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1265// defined reg.
Devang Patel9fc11702010-05-25 23:40:22 +00001266static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001267 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001268 return MI->getNumOperands() == 3 && MI->getOperand(0).isReg() &&
1269 MI->getOperand(0).getReg() &&
Adrian Prantl418d1d12013-07-09 20:28:37 +00001270 (MI->getOperand(1).isImm() ||
1271 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
Devang Patel9fc11702010-05-25 23:40:22 +00001272}
1273
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001274// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher6a841382012-11-19 22:42:10 +00001275static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1276 const MCSymbol *FLabel,
Devang Patel2442a892011-07-08 17:09:57 +00001277 const MCSymbol *SLabel,
1278 const MachineInstr *MI) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001279 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Devang Patel2442a892011-07-08 17:09:57 +00001280
David Blaikie0252265b2013-06-16 20:34:15 +00001281 assert(MI->getNumOperands() == 3);
Adrian Prantl418d1d12013-07-09 20:28:37 +00001282 if (MI->getOperand(0).isReg()) {
Devang Patel2442a892011-07-08 17:09:57 +00001283 MachineLocation MLoc;
Adrian Prantl418d1d12013-07-09 20:28:37 +00001284 // If the second operand is an immediate, this is a
1285 // register-indirect address.
1286 if (!MI->getOperand(1).isImm())
Adrian Prantld4c0dd42013-04-26 21:57:17 +00001287 MLoc.set(MI->getOperand(0).getReg());
1288 else
1289 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel2442a892011-07-08 17:09:57 +00001290 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1291 }
1292 if (MI->getOperand(0).isImm())
1293 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1294 if (MI->getOperand(0).isFPImm())
1295 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1296 if (MI->getOperand(0).isCImm())
1297 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1298
Craig Topperee4dab52012-02-05 08:31:47 +00001299 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel2442a892011-07-08 17:09:57 +00001300}
1301
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001302// Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001303void
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001304DwarfDebug::collectVariableInfo(SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001305
Eric Christopher270a12c2013-07-03 21:37:03 +00001306 // Grab the variable info that was squirreled away in the MMI side-table.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001307 collectVariableInfoFromMMITable(Processed);
Devang Patel490c8ab2010-05-20 19:57:06 +00001308
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001309 for (SmallVectorImpl<const MDNode *>::const_iterator
1310 UVI = UserVariables.begin(),
1311 UVE = UserVariables.end();
1312 UVI != UVE; ++UVI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001313 const MDNode *Var = *UVI;
1314 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001315 continue;
1316
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001317 // History contains relevant DBG_VALUE instructions for Var and instructions
1318 // clobbering it.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001319 SmallVectorImpl<const MachineInstr *> &History = DbgValues[Var];
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001320 if (History.empty())
1321 continue;
1322 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001323
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001324 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001325 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001326 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001327 DISubprogram(DV.getContext()).describes(CurFn->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +00001328 Scope = LScopes.getCurrentFunctionScope();
David Blaikiedc69ebb2013-03-11 23:39:23 +00001329 else if (MDNode *IA = DV.getInlinedAt())
1330 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1331 else
1332 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel490c8ab2010-05-20 19:57:06 +00001333 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001334 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001335 continue;
1336
1337 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001338 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel99819b52011-08-15 19:01:20 +00001339 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
Manman Renb3388602013-10-05 01:43:03 +00001340 DbgVariable *RegVar = new DbgVariable(DV, AbsVar, this);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001341 if (!addCurrentFnArgument(RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001342 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001343 if (AbsVar)
Devang Patel3e4a9652011-08-15 21:24:36 +00001344 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001345
Eric Christophercc10d202012-10-08 20:48:54 +00001346 // Simplify ranges that are fully coalesced.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001347 if (History.size() <= 1 ||
1348 (History.size() == 2 && MInsn->isIdenticalTo(History.back()))) {
Devang Patel3e4a9652011-08-15 21:24:36 +00001349 RegVar->setMInsn(MInsn);
Devang Patel9fc11702010-05-25 23:40:22 +00001350 continue;
1351 }
1352
Eric Christopher59cc0712013-01-28 17:33:26 +00001353 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001354 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001355
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001356 for (SmallVectorImpl<const MachineInstr *>::const_iterator
1357 HI = History.begin(),
1358 HE = History.end();
1359 HI != HE; ++HI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001360 const MachineInstr *Begin = *HI;
1361 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001362
Devang Patele7181b52011-06-01 23:00:17 +00001363 // Check if DBG_VALUE is truncating a range.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001364 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg() &&
1365 !Begin->getOperand(0).getReg())
Devang Patele7181b52011-06-01 23:00:17 +00001366 continue;
1367
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001368 // Compute the range for a register location.
1369 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1370 const MCSymbol *SLabel = 0;
1371
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001372 if (HI + 1 == HE)
1373 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001374 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001375 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001376 else {
1377 const MachineInstr *End = HI[1];
Eric Christopher6a841382012-11-19 22:42:10 +00001378 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001379 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001380 if (End->isDebugValue())
1381 SLabel = getLabelBeforeInsn(End);
1382 else {
1383 // End is a normal instruction clobbering the range.
1384 SLabel = getLabelAfterInsn(End);
1385 assert(SLabel && "Forgot label after clobber instruction");
1386 ++HI;
1387 }
1388 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001389
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001390 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001391 DotDebugLocEntries.push_back(
1392 getDebugLocEntry(Asm, FLabel, SLabel, Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001393 }
1394 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001395 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001396
1397 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001398 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1399 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1400 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1401 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001402 if (!DV || !DV.isVariable() || !Processed.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001403 continue;
1404 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001405 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patele0a94bf2010-05-14 21:01:35 +00001406 }
Devang Patel9fc11702010-05-25 23:40:22 +00001407}
Devang Patele0a94bf2010-05-14 21:01:35 +00001408
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001409// Return Label preceding the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001410MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001411 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1412 assert(Label && "Didn't insert label before instruction");
1413 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001414}
1415
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001416// Return Label immediately following the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001417MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001418 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001419}
1420
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001421// Process beginning of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001422void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001423 assert(CurMI == 0);
1424 CurMI = MI;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001425 // Check if source location changes, but ignore DBG_VALUE locations.
1426 if (!MI->isDebugValue()) {
1427 DebugLoc DL = MI->getDebugLoc();
1428 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopheraec8a822012-04-05 20:39:05 +00001429 unsigned Flags = 0;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001430 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001431 if (DL == PrologEndLoc) {
1432 Flags |= DWARF2_FLAG_PROLOGUE_END;
1433 PrologEndLoc = DebugLoc();
1434 }
Eric Christopheraec8a822012-04-05 20:39:05 +00001435 if (PrologEndLoc.isUnknown())
1436 Flags |= DWARF2_FLAG_IS_STMT;
1437
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001438 if (!DL.isUnknown()) {
1439 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001440 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001441 } else
Devang Patel34a66202011-05-11 19:22:19 +00001442 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001443 }
Devang Patel9fc11702010-05-25 23:40:22 +00001444 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001445
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001446 // Insert labels where requested.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001447 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
1448 LabelsBeforeInsn.find(MI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001449
1450 // No label needed.
1451 if (I == LabelsBeforeInsn.end())
1452 return;
1453
1454 // Label already assigned.
1455 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001456 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001457
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001458 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001459 PrevLabel = MMI->getContext().CreateTempSymbol();
1460 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001461 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001462 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001463}
1464
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001465// Process end of an instruction.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001466void DwarfDebug::endInstruction() {
1467 assert(CurMI != 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001468 // Don't create a new label after DBG_VALUE instructions.
1469 // They don't generate code.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001470 if (!CurMI->isDebugValue())
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001471 PrevLabel = 0;
1472
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001473 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001474 LabelsAfterInsn.find(CurMI);
1475 CurMI = 0;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001476
1477 // No label needed.
1478 if (I == LabelsAfterInsn.end())
1479 return;
1480
1481 // Label already assigned.
1482 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001483 return;
1484
1485 // We need a label after this instruction.
1486 if (!PrevLabel) {
1487 PrevLabel = MMI->getContext().CreateTempSymbol();
1488 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001489 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001490 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001491}
1492
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001493// Each LexicalScope has first instruction and last instruction to mark
1494// beginning and end of a scope respectively. Create an inverse map that list
1495// scopes starts (and ends) with an instruction. One instruction may start (or
1496// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001497void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001498 SmallVector<LexicalScope *, 4> WorkList;
1499 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001500 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001501 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001502
Craig Topper977e9cd2013-07-03 04:24:43 +00001503 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001504 if (!Children.empty())
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001505 for (SmallVectorImpl<LexicalScope *>::const_iterator
1506 SI = Children.begin(),
1507 SE = Children.end();
1508 SI != SE; ++SI)
Devang Patel7771b7c2010-01-20 02:05:23 +00001509 WorkList.push_back(*SI);
1510
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001511 if (S->isAbstractScope())
1512 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001513
Craig Topper977e9cd2013-07-03 04:24:43 +00001514 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001515 if (Ranges.empty())
1516 continue;
Craig Topperd8e43652013-07-03 04:17:25 +00001517 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001518 RE = Ranges.end();
1519 RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001520 assert(RI->first && "InsnRange does not have first instruction!");
1521 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001522 requestLabelBeforeInsn(RI->first);
1523 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001524 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001525 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001526}
1527
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001528// Get MDNode for DebugLoc's scope.
Devang Patel589845d2011-05-09 22:14:49 +00001529static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1530 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1531 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1532 return DL.getScope(Ctx);
1533}
1534
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001535// Walk up the scope chain of given debug loc and find line number info
1536// for the function.
Devang Patel34a66202011-05-11 19:22:19 +00001537static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1538 const MDNode *Scope = getScopeNode(DL, Ctx);
1539 DISubprogram SP = getDISubprogram(Scope);
Manman Ren7504ed42013-07-08 18:33:29 +00001540 if (SP.isSubprogram()) {
Eric Christopher34164192012-04-03 00:43:49 +00001541 // Check for number of operands since the compatibility is
1542 // cheap here.
Eric Christopherb81e2b42012-04-03 17:55:42 +00001543 if (SP->getNumOperands() > 19)
Eric Christopher34164192012-04-03 00:43:49 +00001544 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1545 else
1546 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1547 }
1548
Devang Patel34a66202011-05-11 19:22:19 +00001549 return DebugLoc();
1550}
1551
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001552// Gather pre-function debug information. Assumes being called immediately
1553// after the function entry point has been emitted.
Chris Lattner76555b52010-01-26 23:18:02 +00001554void DwarfDebug::beginFunction(const MachineFunction *MF) {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001555 CurFn = MF;
Eric Christopherfedfa442013-11-01 23:14:17 +00001556
1557 // If there's no debug info for the function we're not going to do anything.
1558 if (!MMI->hasDebugInfo())
1559 return;
1560
1561 // Grab the lexical scopes for the function, if we don't have any of those
1562 // then we're not going to be able to do anything.
Devang Patel7e623022011-08-10 20:55:27 +00001563 LScopes.initialize(*MF);
Eric Christopherfedfa442013-11-01 23:14:17 +00001564 if (LScopes.empty())
1565 return;
1566
1567 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1568
1569 // Make sure that each lexical scope will have a begin/end label.
Devang Patel7e623022011-08-10 20:55:27 +00001570 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001571
Eric Christopher4287a492013-12-09 23:57:44 +00001572 // Set DwarfDwarfCompileUnitID in MCContext to the Compile Unit this function
Eric Christopherfedfa442013-11-01 23:14:17 +00001573 // belongs to so that we add to the correct per-cu line table in the
1574 // non-asm case.
Manman Ren4e042a62013-02-05 21:52:47 +00001575 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Eric Christopher4287a492013-12-09 23:57:44 +00001576 DwarfCompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Manman Ren4e042a62013-02-05 21:52:47 +00001577 assert(TheCU && "Unable to find compile unit!");
Rafael Espindolaac4ad252013-10-05 16:42:21 +00001578 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren9d4c7352013-05-21 00:57:22 +00001579 // Use a single line table if we are using .loc and generating assembly.
1580 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1581 else
1582 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
Manman Ren4e042a62013-02-05 21:52:47 +00001583
Eric Christopherfedfa442013-11-01 23:14:17 +00001584 // Emit a label for the function so that we have a beginning address.
1585 FunctionBeginSym = Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001586 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001587 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001588
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001589 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001590 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Eric Christopherfedfa442013-11-01 23:14:17 +00001591 std::vector<const MDNode *> LiveUserVar(TRI->getNumRegs());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001592
Eric Christopherfedfa442013-11-01 23:14:17 +00001593 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end(); I != E;
1594 ++I) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001595 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001596 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1597 II != IE; ++II) {
1598 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001599
Devang Patel002d54d2010-05-26 19:37:24 +00001600 if (MI->isDebugValue()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001601 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001602
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001603 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001604 const MDNode *Var =
Eric Christopherfedfa442013-11-01 23:14:17 +00001605 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001606
1607 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001608 if (isDbgValueInDefinedReg(MI))
1609 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1610
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001611 // Check the history of this variable.
Eric Christopherfedfa442013-11-01 23:14:17 +00001612 SmallVectorImpl<const MachineInstr *> &History = DbgValues[Var];
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001613 if (History.empty()) {
1614 UserVariables.push_back(Var);
1615 // The first mention of a function argument gets the FunctionBeginSym
1616 // label, so arguments are visible when breaking at function entry.
1617 DIVariable DV(Var);
Manman Ren7504ed42013-07-08 18:33:29 +00001618 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
David Blaikie5af2aca2013-11-18 23:57:26 +00001619 getDISubprogram(DV.getContext()).describes(MF->getFunction()))
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001620 LabelsBeforeInsn[MI] = FunctionBeginSym;
1621 } else {
1622 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1623 const MachineInstr *Prev = History.back();
1624 if (Prev->isDebugValue()) {
1625 // Coalesce identical entries at the end of History.
1626 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001627 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher85a495e2012-10-08 20:48:49 +00001628 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopherfedfa442013-11-01 23:14:17 +00001629 << "\t" << *Prev << "\t"
1630 << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001631 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001632 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001633
1634 // Terminate old register assignments that don't reach MI;
1635 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1636 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1637 isDbgValueInDefinedReg(Prev)) {
1638 // Previous register assignment needs to terminate at the end of
1639 // its basic block.
1640 MachineBasicBlock::const_iterator LastMI =
Eric Christopherfedfa442013-11-01 23:14:17 +00001641 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001642 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001643 // Drop DBG_VALUE for empty range.
Eric Christopher85a495e2012-10-08 20:48:49 +00001644 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Eric Christopherfedfa442013-11-01 23:14:17 +00001645 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001646 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001647 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001648 // Terminate after LastMI.
1649 History.push_back(LastMI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001650 }
1651 }
1652 }
1653 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001654 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001655 // Not a DBG_VALUE instruction.
1656 if (!MI->isLabel())
1657 AtBlockEntry = false;
1658
Eric Christopher133195782012-10-04 20:46:14 +00001659 // First known non-DBG_VALUE and non-frame setup location marks
1660 // the beginning of the function body.
1661 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1662 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel34a66202011-05-11 19:22:19 +00001663 PrologEndLoc = MI->getDebugLoc();
1664
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001665 // Check if the instruction clobbers any registers with debug vars.
1666 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
Eric Christopherfedfa442013-11-01 23:14:17 +00001667 MOE = MI->operands_end();
1668 MOI != MOE; ++MOI) {
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001669 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1670 continue;
Eric Christopherfedfa442013-11-01 23:14:17 +00001671 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true); AI.isValid();
1672 ++AI) {
Jakob Stoklund Olesen54038d72012-06-01 23:28:30 +00001673 unsigned Reg = *AI;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001674 const MDNode *Var = LiveUserVar[Reg];
1675 if (!Var)
1676 continue;
1677 // Reg is now clobbered.
1678 LiveUserVar[Reg] = 0;
1679
1680 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001681 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1682 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001683 continue;
Eric Christopherfedfa442013-11-01 23:14:17 +00001684 SmallVectorImpl<const MachineInstr *> &History = HistI->second;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001685 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001686 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001687 const MachineInstr *Prev = History.back();
1688 // Sanity-check: Register assignments are terminated at the end of
1689 // their block.
1690 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1691 continue;
1692 // Is the variable still in Reg?
1693 if (!isDbgValueInDefinedReg(Prev) ||
1694 Prev->getOperand(0).getReg() != Reg)
1695 continue;
1696 // Var is clobbered. Make sure the next instruction gets a label.
1697 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001698 }
1699 }
Devang Patel002d54d2010-05-26 19:37:24 +00001700 }
Devang Patel002d54d2010-05-26 19:37:24 +00001701 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001702 }
1703
1704 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1705 I != E; ++I) {
Eric Christopherfedfa442013-11-01 23:14:17 +00001706 SmallVectorImpl<const MachineInstr *> &History = I->second;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001707 if (History.empty())
1708 continue;
1709
1710 // Make sure the final register assignments are terminated.
1711 const MachineInstr *Prev = History.back();
1712 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1713 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher6a841382012-11-19 22:42:10 +00001714 MachineBasicBlock::const_iterator LastMI =
Eric Christopherfedfa442013-11-01 23:14:17 +00001715 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001716 if (LastMI == PrevMBB->end())
1717 // Drop DBG_VALUE for empty range.
1718 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001719 else if (PrevMBB != &PrevMBB->getParent()->back()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001720 // Terminate after LastMI.
1721 History.push_back(LastMI);
1722 }
1723 }
1724 // Request labels for the full history.
1725 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1726 const MachineInstr *MI = History[i];
1727 if (MI->isDebugValue())
1728 requestLabelBeforeInsn(MI);
1729 else
1730 requestLabelAfterInsn(MI);
1731 }
1732 }
Devang Patel002d54d2010-05-26 19:37:24 +00001733
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001734 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001735 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001736
1737 // Record beginning of function.
1738 if (!PrologEndLoc.isUnknown()) {
Eric Christopherfedfa442013-11-01 23:14:17 +00001739 DebugLoc FnStartDL =
1740 getFnDebugLoc(PrologEndLoc, MF->getFunction()->getContext());
1741 recordSourceLine(
1742 FnStartDL.getLine(), FnStartDL.getCol(),
1743 FnStartDL.getScope(MF->getFunction()->getContext()),
1744 // We'd like to list the prologue as "not statements" but GDB behaves
1745 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
1746 DWARF2_FLAG_IS_STMT);
Devang Patel34a66202011-05-11 19:22:19 +00001747 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001748}
1749
Devang Patel7e623022011-08-10 20:55:27 +00001750void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
David Blaikie6f1a8062013-06-05 05:39:59 +00001751 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1752 DIVariable DV = Var->getVariable();
David Blaikie36d5d2f2013-06-06 21:04:51 +00001753 // Variables with positive arg numbers are parameters.
1754 if (unsigned ArgNum = DV.getArgNumber()) {
1755 // Keep all parameters in order at the start of the variable list to ensure
1756 // function types are correct (no out-of-order parameters)
1757 //
1758 // This could be improved by only doing it for optimized builds (unoptimized
1759 // builds have the right order to begin with), searching from the back (this
1760 // would catch the unoptimized case quickly), or doing a binary search
1761 // rather than linear search.
1762 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1763 while (I != Vars.end()) {
1764 unsigned CurNum = (*I)->getVariable().getArgNumber();
1765 // A local (non-parameter) variable has been found, insert immediately
1766 // before it.
1767 if (CurNum == 0)
1768 break;
1769 // A later indexed parameter has been found, insert immediately before it.
David Blaikieb272a752013-06-06 22:28:26 +00001770 if (CurNum > ArgNum)
David Blaikie36d5d2f2013-06-06 21:04:51 +00001771 break;
David Blaikieb272a752013-06-06 22:28:26 +00001772 ++I;
David Blaikie6f1a8062013-06-05 05:39:59 +00001773 }
David Blaikie36d5d2f2013-06-06 21:04:51 +00001774 Vars.insert(I, Var);
1775 return;
David Blaikie6f1a8062013-06-05 05:39:59 +00001776 }
1777
1778 Vars.push_back(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001779}
1780
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001781// Gather and emit post-function debug information.
NAKAMURA Takumib9271612013-12-03 13:15:54 +00001782void DwarfDebug::endFunction(const MachineFunction *MF) {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001783 // Every beginFunction(MF) call should be followed by an endFunction(MF) call,
1784 // though the beginFunction may not be called at all.
1785 // We should handle both cases.
1786 if (CurFn == 0)
1787 CurFn = MF;
1788 else
1789 assert(CurFn == MF);
1790 assert(CurFn != 0);
1791
1792 if (!MMI->hasDebugInfo() || LScopes.empty()) {
1793 CurFn = 0;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001794 return;
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001795 }
Devang Patel2904aa92009-11-12 19:02:56 +00001796
Devang Patel7e623022011-08-10 20:55:27 +00001797 // Define end label for subprogram.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001798 FunctionEndSym = Asm->GetTempSymbol("func_end", Asm->getFunctionNumber());
Devang Patel7e623022011-08-10 20:55:27 +00001799 // Assumes in correct section after the entry point.
1800 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Eric Christopher4287a492013-12-09 23:57:44 +00001801 // Set DwarfDwarfCompileUnitID in MCContext to default value.
Manman Ren4e042a62013-02-05 21:52:47 +00001802 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher6a841382012-11-19 22:42:10 +00001803
Devang Patel7e623022011-08-10 20:55:27 +00001804 SmallPtrSet<const MDNode *, 16> ProcessedVars;
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001805 collectVariableInfo(ProcessedVars);
Eric Christopher6a841382012-11-19 22:42:10 +00001806
Devang Patel3acc70e2011-08-15 22:04:40 +00001807 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Eric Christopher4287a492013-12-09 23:57:44 +00001808 DwarfCompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001809 assert(TheCU && "Unable to find compile unit!");
Devang Patel3acc70e2011-08-15 22:04:40 +00001810
Devang Patel7e623022011-08-10 20:55:27 +00001811 // Construct abstract scopes.
Devang Patel44403472011-08-12 18:10:19 +00001812 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1813 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1814 LexicalScope *AScope = AList[i];
1815 DISubprogram SP(AScope->getScopeNode());
Manman Ren7504ed42013-07-08 18:33:29 +00001816 if (SP.isSubprogram()) {
Devang Patel7e623022011-08-10 20:55:27 +00001817 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001818 DIArray Variables = SP.getVariables();
1819 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1820 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001821 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001822 continue;
Alexey Samsonov39602782012-07-06 08:45:08 +00001823 // Check that DbgVariable for DV wasn't created earlier, when
1824 // findAbstractVariable() was called for inlined instance of DV.
1825 LLVMContext &Ctx = DV->getContext();
1826 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1827 if (AbstractVariables.lookup(CleanDV))
1828 continue;
Devang Patel59e27c52011-08-19 23:28:12 +00001829 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001830 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001831 }
1832 }
Devang Patel44403472011-08-12 18:10:19 +00001833 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Manman Ren4213c392013-05-29 17:16:59 +00001834 constructScopeDIE(TheCU, AScope);
Bill Wendling2b128d72009-05-20 23:19:06 +00001835 }
Eric Christopher6a841382012-11-19 22:42:10 +00001836
Devang Patel3acc70e2011-08-15 22:04:40 +00001837 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher6a841382012-11-19 22:42:10 +00001838
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001839 if (!CurFn->getTarget().Options.DisableFramePointerElim(*CurFn))
Eric Christopherbb69a272012-08-24 01:14:27 +00001840 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Patel3acc70e2011-08-15 22:04:40 +00001841
Bill Wendling2b128d72009-05-20 23:19:06 +00001842 // Clear debug info
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001843 for (ScopeVariablesMap::iterator I = ScopeVariables.begin(),
1844 E = ScopeVariables.end();
1845 I != E; ++I)
Devang Patel7e623022011-08-10 20:55:27 +00001846 DeleteContainerPointers(I->second);
1847 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001848 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001849 UserVariables.clear();
1850 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001851 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001852 LabelsBeforeInsn.clear();
1853 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001854 PrevLabel = NULL;
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001855 CurFn = 0;
Bill Wendling2b128d72009-05-20 23:19:06 +00001856}
1857
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001858// Register a source line with debug info. Returns the unique label that was
1859// emitted and which provides correspondence to the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00001860void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1861 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00001862 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00001863 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00001864 unsigned Src = 1;
1865 if (S) {
1866 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00001867
Dan Gohman50849c62010-05-05 23:41:32 +00001868 if (Scope.isCompileUnit()) {
1869 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001870 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001871 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00001872 } else if (Scope.isFile()) {
1873 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00001874 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001875 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001876 } else if (Scope.isSubprogram()) {
1877 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001878 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001879 Dir = SP.getDirectory();
Eric Christopher6647b832011-10-11 22:59:11 +00001880 } else if (Scope.isLexicalBlockFile()) {
1881 DILexicalBlockFile DBF(S);
1882 Fn = DBF.getFilename();
1883 Dir = DBF.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001884 } else if (Scope.isLexicalBlock()) {
1885 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001886 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001887 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001888 } else
Craig Topperee4dab52012-02-05 08:31:47 +00001889 llvm_unreachable("Unexpected scope info");
Dan Gohman50849c62010-05-05 23:41:32 +00001890
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001891 Src = getOrCreateSourceID(
1892 Fn, Dir, Asm->OutStreamer.getContext().getDwarfCompileUnitID());
Dan Gohman50849c62010-05-05 23:41:32 +00001893 }
Nick Lewycky019d2552011-07-29 03:49:23 +00001894 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00001895}
1896
Bill Wendling806535f2009-05-20 23:22:40 +00001897//===----------------------------------------------------------------------===//
1898// Emit Methods
1899//===----------------------------------------------------------------------===//
1900
Manman Rence20d462013-10-29 22:57:10 +00001901// Compute the size and offset of a DIE. The offset is relative to start of the
1902// CU. It returns the offset after laying out the DIE.
Eric Christopherf8194852013-12-05 18:06:10 +00001903unsigned DwarfFile::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling480ff322009-05-20 23:21:38 +00001904 // Get the children.
1905 const std::vector<DIE *> &Children = Die->getChildren();
1906
Bill Wendling480ff322009-05-20 23:21:38 +00001907 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00001908 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00001909
1910 // Get the abbreviation for this DIE.
David Blaikieff3ab2c2013-12-05 01:01:41 +00001911 const DIEAbbrev &Abbrev = Die->getAbbrev();
Bill Wendling480ff322009-05-20 23:21:38 +00001912
1913 // Set DIE offset
1914 Die->setOffset(Offset);
1915
1916 // Start the size with the size of abbreviation code.
David Blaikieff3ab2c2013-12-05 01:01:41 +00001917 Offset += MCAsmInfo::getULEB128Size(Die->getAbbrevNumber());
Bill Wendling480ff322009-05-20 23:21:38 +00001918
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001919 const SmallVectorImpl<DIEValue *> &Values = Die->getValues();
David Blaikieff3ab2c2013-12-05 01:01:41 +00001920 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
Bill Wendling480ff322009-05-20 23:21:38 +00001921
1922 // Size the DIE attribute values.
1923 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1924 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001925 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001926
1927 // Size the DIE children if any.
1928 if (!Children.empty()) {
David Blaikieff3ab2c2013-12-05 01:01:41 +00001929 assert(Abbrev.getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
Bill Wendling480ff322009-05-20 23:21:38 +00001930 "Children flag not set");
1931
1932 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001933 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling480ff322009-05-20 23:21:38 +00001934
1935 // End of children marker.
1936 Offset += sizeof(int8_t);
1937 }
1938
1939 Die->setSize(Offset - Die->getOffset());
1940 return Offset;
1941}
1942
Eric Christopherb088d2d2013-10-24 21:05:08 +00001943// Compute the size and offset for each DIE.
Eric Christopherf8194852013-12-05 18:06:10 +00001944void DwarfFile::computeSizeAndOffsets() {
Manman Rence20d462013-10-29 22:57:10 +00001945 // Offset from the first CU in the debug info section is 0 initially.
1946 unsigned SecOffset = 0;
1947
Eric Christopherb088d2d2013-10-24 21:05:08 +00001948 // Iterate over each compile unit and set the size and offsets for each
1949 // DIE within each compile unit. All offsets are CU relative.
Eric Christophera5a79422013-12-09 23:32:48 +00001950 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = CUs.begin(),
1951 E = CUs.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001952 I != E; ++I) {
Manman Rence20d462013-10-29 22:57:10 +00001953 (*I)->setDebugInfoOffset(SecOffset);
1954
1955 // CU-relative offset is reset to 0 here.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001956 unsigned Offset = sizeof(int32_t) + // Length of Unit Info
David Blaikie6b288cf2013-10-30 20:42:41 +00001957 (*I)->getHeaderSize(); // Unit-specific headers
Manman Rence20d462013-10-29 22:57:10 +00001958
1959 // EndOffset here is CU-relative, after laying out
1960 // all of the CU DIE.
David Blaikie2a80e442013-12-02 22:09:48 +00001961 unsigned EndOffset = computeSizeAndOffset((*I)->getUnitDie(), Offset);
Manman Rence20d462013-10-29 22:57:10 +00001962 SecOffset += EndOffset;
Devang Patel1a0df9a2010-05-10 22:49:55 +00001963 }
Bill Wendling480ff322009-05-20 23:21:38 +00001964}
1965
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001966// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001967void DwarfDebug::emitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001968 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001969
Bill Wendling480ff322009-05-20 23:21:38 +00001970 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001971 DwarfInfoSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001972 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Eric Christopherd8667202013-12-30 17:22:27 +00001973 if (useSplitDwarf())
1974 DwarfInfoDWOSectionSym =
1975 emitSectionSym(Asm, TLOF.getDwarfInfoDWOSection(), "section_info_dwo");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001976 DwarfAbbrevSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001977 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher3c5a1912012-12-19 22:02:53 +00001978 if (useSplitDwarf())
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001979 DwarfAbbrevDWOSectionSym = emitSectionSym(
1980 Asm, TLOF.getDwarfAbbrevDWOSection(), "section_abbrev_dwo");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001981 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001982
Chris Lattner6629ca92010-04-04 22:59:04 +00001983 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001984 emitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00001985
Eric Christopher74804332013-02-07 21:19:50 +00001986 DwarfLineSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001987 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001988 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Eric Christopher261d2342013-09-23 20:55:35 +00001989 if (GenerateGnuPubSections) {
Eric Christopher39eebfa2013-09-30 23:14:16 +00001990 DwarfGnuPubNamesSectionSym =
1991 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
1992 DwarfGnuPubTypesSectionSym =
1993 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
Eric Christopher261d2342013-09-23 20:55:35 +00001994 } else if (HasDwarfPubSections) {
1995 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
1996 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Michael Gottesmanc89466f2013-09-04 04:39:38 +00001997 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00001998
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001999 DwarfStrSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002000 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002001 if (useSplitDwarf()) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002002 DwarfStrDWOSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002003 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002004 DwarfAddrSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002005 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
Eric Christopher55863be2013-04-07 03:43:09 +00002006 }
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002007 DwarfDebugRangeSectionSym =
2008 emitSectionSym(Asm, TLOF.getDwarfRangesSection(), "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00002009
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002010 DwarfDebugLocSectionSym =
2011 emitSectionSym(Asm, TLOF.getDwarfLocSection(), "section_debug_loc");
Bill Wendling480ff322009-05-20 23:21:38 +00002012}
2013
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002014// Recursively emits a debug information entry.
David Blaikieff3ab2c2013-12-05 01:01:41 +00002015void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00002016 // Get the abbreviation for this DIE.
David Blaikieff3ab2c2013-12-05 01:01:41 +00002017 const DIEAbbrev &Abbrev = Die->getAbbrev();
Bill Wendling480ff322009-05-20 23:21:38 +00002018
Bill Wendling480ff322009-05-20 23:21:38 +00002019 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00002020 if (Asm->isVerbose())
David Blaikieff3ab2c2013-12-05 01:01:41 +00002021 Asm->OutStreamer.AddComment("Abbrev [" + Twine(Abbrev.getNumber()) +
2022 "] 0x" + Twine::utohexstr(Die->getOffset()) +
2023 ":0x" + Twine::utohexstr(Die->getSize()) + " " +
2024 dwarf::TagString(Abbrev.getTag()));
2025 Asm->EmitULEB128(Abbrev.getNumber());
Bill Wendling480ff322009-05-20 23:21:38 +00002026
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002027 const SmallVectorImpl<DIEValue *> &Values = Die->getValues();
David Blaikieff3ab2c2013-12-05 01:01:41 +00002028 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
Bill Wendling480ff322009-05-20 23:21:38 +00002029
2030 // Emit the DIE attribute values.
2031 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
David Blaikief2443192013-10-21 17:28:37 +00002032 dwarf::Attribute Attr = AbbrevData[i].getAttribute();
2033 dwarf::Form Form = AbbrevData[i].getForm();
Bill Wendling480ff322009-05-20 23:21:38 +00002034 assert(Form && "Too many attributes for DIE (check abbreviation)");
2035
Chris Lattner7bde8c02010-04-04 18:52:31 +00002036 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00002037 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002038
Bill Wendling480ff322009-05-20 23:21:38 +00002039 switch (Attr) {
Manman Rence20d462013-10-29 22:57:10 +00002040 case dwarf::DW_AT_abstract_origin:
2041 case dwarf::DW_AT_type:
2042 case dwarf::DW_AT_friend:
2043 case dwarf::DW_AT_specification:
2044 case dwarf::DW_AT_import:
2045 case dwarf::DW_AT_containing_type: {
2046 DIEEntry *E = cast<DIEEntry>(Values[i]);
2047 DIE *Origin = E->getEntry();
2048 unsigned Addr = Origin->getOffset();
2049 if (Form == dwarf::DW_FORM_ref_addr) {
2050 assert(!useSplitDwarf() && "TODO: dwo files can't have relocations.");
2051 // For DW_FORM_ref_addr, output the offset from beginning of debug info
2052 // section. Origin->getOffset() returns the offset from start of the
2053 // compile unit.
Eric Christopher4287a492013-12-09 23:57:44 +00002054 DwarfCompileUnit *CU = CUDieMap.lookup(Origin->getUnit());
Manman Rence20d462013-10-29 22:57:10 +00002055 assert(CU && "CUDie should belong to a CU.");
2056 Addr += CU->getDebugInfoOffset();
2057 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
David Blaikie03073f72013-12-06 22:14:48 +00002058 Asm->EmitLabelPlusOffset(CU->getSectionSym(), Addr,
Manman Rence20d462013-10-29 22:57:10 +00002059 DIEEntry::getRefAddrSize(Asm));
2060 else
David Blaikie03073f72013-12-06 22:14:48 +00002061 Asm->EmitLabelOffsetDifference(CU->getSectionSym(), Addr,
2062 CU->getSectionSym(),
Manman Ren251a1bd2013-10-29 23:14:15 +00002063 DIEEntry::getRefAddrSize(Asm));
Manman Rence20d462013-10-29 22:57:10 +00002064 } else {
Manman Ren4dbdc902013-10-31 17:54:35 +00002065 // Make sure Origin belong to the same CU.
David Blaikie409dd9c2013-11-19 23:08:21 +00002066 assert(Die->getUnit() == Origin->getUnit() &&
Manman Ren4dbdc902013-10-31 17:54:35 +00002067 "The referenced DIE should belong to the same CU in ref4");
Manman Rence20d462013-10-29 22:57:10 +00002068 Asm->EmitInt32(Addr);
2069 }
2070 break;
2071 }
Devang Patel9fc11702010-05-25 23:40:22 +00002072 case dwarf::DW_AT_location: {
Nick Lewycky33da3362012-06-22 01:25:12 +00002073 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2074 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopherd0b82ae2013-11-16 00:18:40 +00002075 Asm->EmitSectionOffset(L->getValue(), DwarfDebugLocSectionSym);
Nick Lewycky33da3362012-06-22 01:25:12 +00002076 else
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002077 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002078 } else {
Devang Patel9fc11702010-05-25 23:40:22 +00002079 Values[i]->EmitValue(Asm, Form);
Nick Lewycky33da3362012-06-22 01:25:12 +00002080 }
Devang Patel9fc11702010-05-25 23:40:22 +00002081 break;
2082 }
Devang Patela1bd5a12010-09-29 19:08:08 +00002083 case dwarf::DW_AT_accessibility: {
2084 if (Asm->isVerbose()) {
2085 DIEInteger *V = cast<DIEInteger>(Values[i]);
2086 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2087 }
2088 Values[i]->EmitValue(Asm, Form);
2089 break;
2090 }
Bill Wendling480ff322009-05-20 23:21:38 +00002091 default:
2092 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002093 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00002094 break;
2095 }
Bill Wendling480ff322009-05-20 23:21:38 +00002096 }
2097
2098 // Emit the DIE children if any.
David Blaikieff3ab2c2013-12-05 01:01:41 +00002099 if (Abbrev.getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
Bill Wendling480ff322009-05-20 23:21:38 +00002100 const std::vector<DIE *> &Children = Die->getChildren();
2101
2102 for (unsigned j = 0, M = Children.size(); j < M; ++j)
David Blaikieff3ab2c2013-12-05 01:01:41 +00002103 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00002104
David Blaikie155f8812013-12-04 21:51:05 +00002105 Asm->OutStreamer.AddComment("End Of Children Mark");
Chris Lattner566cae92010-03-09 23:52:58 +00002106 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00002107 }
2108}
2109
Eric Christophera2de8262012-12-15 00:04:07 +00002110// Emit the various dwarf units to the unit section USection with
2111// the abbreviations going into ASection.
David Blaikie03073f72013-12-06 22:14:48 +00002112void DwarfFile::emitUnits(DwarfDebug *DD, const MCSection *ASection,
2113 const MCSymbol *ASectionSym) {
Eric Christophera5a79422013-12-09 23:32:48 +00002114 for (SmallVectorImpl<DwarfUnit *>::iterator I = CUs.begin(), E = CUs.end();
2115 I != E; ++I) {
2116 DwarfUnit *TheU = *I;
David Blaikie2a80e442013-12-02 22:09:48 +00002117 DIE *Die = TheU->getUnitDie();
David Blaikie03073f72013-12-06 22:14:48 +00002118 const MCSection *USection = TheU->getSection();
2119 Asm->OutStreamer.SwitchSection(USection);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002120
Devang Patel1a0df9a2010-05-10 22:49:55 +00002121 // Emit the compile units header.
David Blaikie7d734602013-12-06 22:33:05 +00002122 Asm->OutStreamer.EmitLabel(TheU->getLabelBegin());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002123
Devang Patel1a0df9a2010-05-10 22:49:55 +00002124 // Emit size of content not including length itself
David Blaikie6b288cf2013-10-30 20:42:41 +00002125 Asm->OutStreamer.AddComment("Length of Unit");
David Blaikie2a80e442013-12-02 22:09:48 +00002126 Asm->EmitInt32(TheU->getHeaderSize() + Die->getSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002127
David Blaikie2a80e442013-12-02 22:09:48 +00002128 TheU->emitHeader(ASection, ASectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002129
David Blaikieff3ab2c2013-12-05 01:01:41 +00002130 DD->emitDIE(Die);
David Blaikie7d734602013-12-06 22:33:05 +00002131 Asm->OutStreamer.EmitLabel(TheU->getLabelEnd());
Devang Patel1a0df9a2010-05-10 22:49:55 +00002132 }
Bill Wendling480ff322009-05-20 23:21:38 +00002133}
2134
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002135// Emit the debug info section.
2136void DwarfDebug::emitDebugInfo() {
Eric Christopherf8194852013-12-05 18:06:10 +00002137 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christophera2de8262012-12-15 00:04:07 +00002138
David Blaikie03073f72013-12-06 22:14:48 +00002139 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfAbbrevSection(),
Eric Christophera2de8262012-12-15 00:04:07 +00002140 DwarfAbbrevSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002141}
2142
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002143// Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +00002144void DwarfDebug::emitAbbreviations() {
Eric Christopherf8194852013-12-05 18:06:10 +00002145 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
David Blaikie0504cda2013-12-05 07:43:55 +00002146
2147 Holder.emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
Eric Christopher3c5a1912012-12-19 22:02:53 +00002148}
Bill Wendling480ff322009-05-20 23:21:38 +00002149
Eric Christopherf8194852013-12-05 18:06:10 +00002150void DwarfFile::emitAbbrevs(const MCSection *Section) {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002151 // Check to see if it is worth the effort.
David Blaikie0504cda2013-12-05 07:43:55 +00002152 if (!Abbreviations.empty()) {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002153 // Start the debug abbrev section.
2154 Asm->OutStreamer.SwitchSection(Section);
2155
Bill Wendling480ff322009-05-20 23:21:38 +00002156 // For each abbrevation.
David Blaikie0504cda2013-12-05 07:43:55 +00002157 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
Bill Wendling480ff322009-05-20 23:21:38 +00002158 // Get abbreviation data
David Blaikie0504cda2013-12-05 07:43:55 +00002159 const DIEAbbrev *Abbrev = Abbreviations[i];
Bill Wendling480ff322009-05-20 23:21:38 +00002160
2161 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00002162 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00002163
2164 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002165 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00002166 }
2167
2168 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00002169 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00002170 }
2171}
2172
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002173// Emit the last address of the section and the end of the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +00002174void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00002175 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00002176 Asm->OutStreamer.AddComment("Extended Op");
2177 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002178
Chris Lattner566cae92010-03-09 23:52:58 +00002179 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002180 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00002181 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2182 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2183
2184 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002185
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002186 Asm->OutStreamer.EmitSymbolValue(
2187 Asm->GetTempSymbol("section_end", SectionEnd),
2188 Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002189
2190 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00002191 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2192 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002193 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00002194 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002195}
2196
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002197// Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00002198void DwarfDebug::emitAccelNames() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002199 DwarfAccelTable AT(
2200 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
Eric Christophera5a79422013-12-09 23:32:48 +00002201 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2202 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002203 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002204 DwarfUnit *TheU = *I;
David Blaikie2a80e442013-12-02 22:09:48 +00002205 const StringMap<std::vector<const DIE *> > &Names = TheU->getAccelNames();
David Blaikie2ea848b2013-11-19 22:51:04 +00002206 for (StringMap<std::vector<const DIE *> >::const_iterator
2207 GI = Names.begin(),
2208 GE = Names.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002209 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002210 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002211 const std::vector<const DIE *> &Entities = GI->second;
2212 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2213 DE = Entities.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002214 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002215 AT.AddName(Name, *DI);
Eric Christopher4996c702011-11-07 09:24:32 +00002216 }
2217 }
2218
2219 AT.FinalizeTable(Asm, "Names");
2220 Asm->OutStreamer.SwitchSection(
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002221 Asm->getObjFileLowering().getDwarfAccelNamesSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002222 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2223 Asm->OutStreamer.EmitLabel(SectionBegin);
2224
2225 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002226 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002227}
2228
Eric Christopher48fef592012-12-20 21:58:40 +00002229// Emit objective C classes and categories into a hashed accelerator table
2230// section.
Eric Christopher4996c702011-11-07 09:24:32 +00002231void DwarfDebug::emitAccelObjC() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002232 DwarfAccelTable AT(
2233 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
Eric Christophera5a79422013-12-09 23:32:48 +00002234 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2235 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002236 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002237 DwarfUnit *TheU = *I;
David Blaikie2a80e442013-12-02 22:09:48 +00002238 const StringMap<std::vector<const DIE *> > &Names = TheU->getAccelObjC();
David Blaikie2ea848b2013-11-19 22:51:04 +00002239 for (StringMap<std::vector<const DIE *> >::const_iterator
2240 GI = Names.begin(),
2241 GE = Names.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002242 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002243 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002244 const std::vector<const DIE *> &Entities = GI->second;
2245 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2246 DE = Entities.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002247 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002248 AT.AddName(Name, *DI);
Eric Christopher4996c702011-11-07 09:24:32 +00002249 }
2250 }
2251
2252 AT.FinalizeTable(Asm, "ObjC");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002253 Asm->OutStreamer.SwitchSection(
2254 Asm->getObjFileLowering().getDwarfAccelObjCSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002255 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2256 Asm->OutStreamer.EmitLabel(SectionBegin);
2257
2258 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002259 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002260}
2261
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002262// Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002263void DwarfDebug::emitAccelNamespaces() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002264 DwarfAccelTable AT(
2265 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
Eric Christophera5a79422013-12-09 23:32:48 +00002266 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2267 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002268 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002269 DwarfUnit *TheU = *I;
David Blaikie2ea848b2013-11-19 22:51:04 +00002270 const StringMap<std::vector<const DIE *> > &Names =
David Blaikie2a80e442013-12-02 22:09:48 +00002271 TheU->getAccelNamespace();
David Blaikie2ea848b2013-11-19 22:51:04 +00002272 for (StringMap<std::vector<const DIE *> >::const_iterator
2273 GI = Names.begin(),
2274 GE = Names.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002275 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002276 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002277 const std::vector<const DIE *> &Entities = GI->second;
2278 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2279 DE = Entities.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002280 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002281 AT.AddName(Name, *DI);
Eric Christopher4996c702011-11-07 09:24:32 +00002282 }
2283 }
2284
2285 AT.FinalizeTable(Asm, "namespac");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002286 Asm->OutStreamer.SwitchSection(
2287 Asm->getObjFileLowering().getDwarfAccelNamespaceSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002288 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2289 Asm->OutStreamer.EmitLabel(SectionBegin);
2290
2291 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002292 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002293}
2294
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002295// Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002296void DwarfDebug::emitAccelTypes() {
Eric Christopher21bde872012-01-06 04:35:23 +00002297 std::vector<DwarfAccelTable::Atom> Atoms;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002298 Atoms.push_back(
2299 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
2300 Atoms.push_back(
2301 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag, dwarf::DW_FORM_data2));
2302 Atoms.push_back(
2303 DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags, dwarf::DW_FORM_data1));
Eric Christopher21bde872012-01-06 04:35:23 +00002304 DwarfAccelTable AT(Atoms);
Eric Christophera5a79422013-12-09 23:32:48 +00002305 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2306 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002307 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002308 DwarfUnit *TheU = *I;
David Blaikie2ea848b2013-11-19 22:51:04 +00002309 const StringMap<std::vector<std::pair<const DIE *, unsigned> > > &Names =
David Blaikie2a80e442013-12-02 22:09:48 +00002310 TheU->getAccelTypes();
David Blaikie2ea848b2013-11-19 22:51:04 +00002311 for (StringMap<
2312 std::vector<std::pair<const DIE *, unsigned> > >::const_iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002313 GI = Names.begin(),
2314 GE = Names.end();
2315 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002316 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002317 const std::vector<std::pair<const DIE *, unsigned> > &Entities =
2318 GI->second;
2319 for (std::vector<std::pair<const DIE *, unsigned> >::const_iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002320 DI = Entities.begin(),
2321 DE = Entities.end();
2322 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002323 AT.AddName(Name, DI->first, DI->second);
Eric Christopher4996c702011-11-07 09:24:32 +00002324 }
2325 }
2326
2327 AT.FinalizeTable(Asm, "types");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002328 Asm->OutStreamer.SwitchSection(
2329 Asm->getObjFileLowering().getDwarfAccelTypesSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002330 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2331 Asm->OutStreamer.EmitLabel(SectionBegin);
2332
2333 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002334 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002335}
2336
Eric Christopherdd1a0122013-09-13 00:35:05 +00002337// Public name handling.
2338// The format for the various pubnames:
2339//
2340// dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2341// for the DIE that is named.
2342//
2343// gnu pubnames - offset/index value/name tuples where the offset is the offset
2344// into the CU and the index value is computed according to the type of value
2345// for the DIE that is named.
2346//
2347// For type units the offset is the offset of the skeleton DIE. For split dwarf
2348// it's the offset within the debug_info/debug_types dwo section, however, the
2349// reference in the pubname header doesn't change.
2350
2351/// computeIndexValue - Compute the gdb index value for the DIE and CU.
Eric Christophera5a79422013-12-09 23:32:48 +00002352static dwarf::PubIndexEntryDescriptor computeIndexValue(DwarfUnit *CU,
Eric Christopher0fe676a2013-11-21 00:48:22 +00002353 const DIE *Die) {
Eric Christopherd2b497b2013-10-16 01:37:49 +00002354 dwarf::GDBIndexEntryLinkage Linkage = dwarf::GIEL_STATIC;
2355
2356 // We could have a specification DIE that has our most of our knowledge,
2357 // look for that now.
2358 DIEValue *SpecVal = Die->findAttribute(dwarf::DW_AT_specification);
2359 if (SpecVal) {
2360 DIE *SpecDIE = cast<DIEEntry>(SpecVal)->getEntry();
2361 if (SpecDIE->findAttribute(dwarf::DW_AT_external))
2362 Linkage = dwarf::GIEL_EXTERNAL;
2363 } else if (Die->findAttribute(dwarf::DW_AT_external))
2364 Linkage = dwarf::GIEL_EXTERNAL;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002365
2366 switch (Die->getTag()) {
2367 case dwarf::DW_TAG_class_type:
2368 case dwarf::DW_TAG_structure_type:
2369 case dwarf::DW_TAG_union_type:
2370 case dwarf::DW_TAG_enumeration_type:
Eric Christopher261d2342013-09-23 20:55:35 +00002371 return dwarf::PubIndexEntryDescriptor(
2372 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2373 ? dwarf::GIEL_STATIC
2374 : dwarf::GIEL_EXTERNAL);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002375 case dwarf::DW_TAG_typedef:
2376 case dwarf::DW_TAG_base_type:
2377 case dwarf::DW_TAG_subrange_type:
David Blaikie8dec4072013-09-19 20:40:26 +00002378 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002379 case dwarf::DW_TAG_namespace:
David Blaikie8dec4072013-09-19 20:40:26 +00002380 return dwarf::GIEK_TYPE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002381 case dwarf::DW_TAG_subprogram:
Eric Christopherccac5c42013-09-23 22:59:14 +00002382 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002383 case dwarf::DW_TAG_constant:
2384 case dwarf::DW_TAG_variable:
Eric Christopherccac5c42013-09-23 22:59:14 +00002385 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002386 case dwarf::DW_TAG_enumerator:
David Blaikie8dec4072013-09-19 20:40:26 +00002387 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2388 dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002389 default:
David Blaikie8dec4072013-09-19 20:40:26 +00002390 return dwarf::GIEK_NONE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002391 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002392}
2393
Eric Christopher5f93bb92013-09-09 20:03:17 +00002394/// emitDebugPubNames - Emit visible names into a debug pubnames section.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002395///
Eric Christopherdd1a0122013-09-13 00:35:05 +00002396void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
Eric Christopherdd1a0122013-09-13 00:35:05 +00002397 const MCSection *PSec =
2398 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2399 : Asm->getObjFileLowering().getDwarfPubNamesSection();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002400
David Blaikie4f623202013-12-06 19:38:49 +00002401 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christophera5a79422013-12-09 23:32:48 +00002402 const SmallVectorImpl<DwarfUnit *> &Units = Holder.getUnits();
David Blaikie4f623202013-12-06 19:38:49 +00002403 for (unsigned i = 0; i != Units.size(); ++i) {
Eric Christophera5a79422013-12-09 23:32:48 +00002404 DwarfUnit *TheU = Units[i];
David Blaikie2a80e442013-12-02 22:09:48 +00002405 unsigned ID = TheU->getUniqueID();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002406
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002407 // Start the dwarf pubnames section.
Eric Christopher13b99d22013-09-10 21:49:37 +00002408 Asm->OutStreamer.SwitchSection(PSec);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002409
Eric Christopher39eebfa2013-09-30 23:14:16 +00002410 // Emit a label so we can reference the beginning of this pubname section.
2411 if (GnuStyle)
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002412 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames", ID));
Eric Christopher39eebfa2013-09-30 23:14:16 +00002413
Eric Christopherdd1a0122013-09-13 00:35:05 +00002414 // Emit the header.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002415 Asm->OutStreamer.AddComment("Length of Public Names Info");
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002416 MCSymbol *BeginLabel = Asm->GetTempSymbol("pubnames_begin", ID);
2417 MCSymbol *EndLabel = Asm->GetTempSymbol("pubnames_end", ID);
2418 Asm->EmitLabelDifference(EndLabel, BeginLabel, 4);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002419
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002420 Asm->OutStreamer.EmitLabel(BeginLabel);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002421
2422 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002423 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002424
2425 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
David Blaikie7d734602013-12-06 22:33:05 +00002426 Asm->EmitSectionOffset(TheU->getLabelBegin(), TheU->getSectionSym());
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002427
2428 Asm->OutStreamer.AddComment("Compilation Unit Length");
David Blaikie7d734602013-12-06 22:33:05 +00002429 Asm->EmitLabelDifference(TheU->getLabelEnd(), TheU->getLabelBegin(), 4);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002430
Eric Christopherdd1a0122013-09-13 00:35:05 +00002431 // Emit the pubnames for this compilation unit.
David Blaikie4f623202013-12-06 19:38:49 +00002432 const StringMap<const DIE *> &Globals = getUnits()[ID]->getGlobalNames();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002433 for (StringMap<const DIE *>::const_iterator GI = Globals.begin(),
2434 GE = Globals.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002435 GI != GE; ++GI) {
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002436 const char *Name = GI->getKeyData();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002437 const DIE *Entity = GI->second;
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002438
2439 Asm->OutStreamer.AddComment("DIE offset");
2440 Asm->EmitInt32(Entity->getOffset());
2441
Eric Christopherdd1a0122013-09-13 00:35:05 +00002442 if (GnuStyle) {
David Blaikie2a80e442013-12-02 22:09:48 +00002443 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheU, Entity);
David Blaikied0a869d2013-09-19 22:19:37 +00002444 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002445 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002446 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002447 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002448 }
2449
David Blaikie155f8812013-12-04 21:51:05 +00002450 Asm->OutStreamer.AddComment("External Name");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002451 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002452 }
2453
2454 Asm->OutStreamer.AddComment("End Mark");
2455 Asm->EmitInt32(0);
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002456 Asm->OutStreamer.EmitLabel(EndLabel);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002457 }
2458}
2459
Eric Christopherdd1a0122013-09-13 00:35:05 +00002460void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
Eric Christopher261d2342013-09-23 20:55:35 +00002461 const MCSection *PSec =
2462 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2463 : Asm->getObjFileLowering().getDwarfPubTypesSection();
Eric Christopher8b3737f2013-09-13 00:34:58 +00002464
David Blaikie4f623202013-12-06 19:38:49 +00002465 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christophera5a79422013-12-09 23:32:48 +00002466 const SmallVectorImpl<DwarfUnit *> &Units = Holder.getUnits();
David Blaikie4f623202013-12-06 19:38:49 +00002467 for (unsigned i = 0; i != Units.size(); ++i) {
Eric Christophera5a79422013-12-09 23:32:48 +00002468 DwarfUnit *TheU = Units[i];
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002469 unsigned ID = TheU->getUniqueID();
2470
Eric Christopher6abc9c52011-11-07 09:18:35 +00002471 // Start the dwarf pubtypes section.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002472 Asm->OutStreamer.SwitchSection(PSec);
Eric Christopher39eebfa2013-09-30 23:14:16 +00002473
2474 // Emit a label so we can reference the beginning of this pubtype section.
2475 if (GnuStyle)
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002476 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes", ID));
Eric Christopher39eebfa2013-09-30 23:14:16 +00002477
2478 // Emit the header.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002479 Asm->OutStreamer.AddComment("Length of Public Types Info");
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002480 MCSymbol *BeginLabel = Asm->GetTempSymbol("pubtypes_begin", ID);
2481 MCSymbol *EndLabel = Asm->GetTempSymbol("pubtypes_end", ID);
2482 Asm->EmitLabelDifference(EndLabel, BeginLabel, 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002483
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002484 Asm->OutStreamer.EmitLabel(BeginLabel);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002485
David Blaikie155f8812013-12-04 21:51:05 +00002486 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002487 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002488
Devang Patel1a0df9a2010-05-10 22:49:55 +00002489 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
David Blaikie7d734602013-12-06 22:33:05 +00002490 Asm->EmitSectionOffset(TheU->getLabelBegin(), TheU->getSectionSym());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002491
Devang Patel1a0df9a2010-05-10 22:49:55 +00002492 Asm->OutStreamer.AddComment("Compilation Unit Length");
David Blaikie7d734602013-12-06 22:33:05 +00002493 Asm->EmitLabelDifference(TheU->getLabelEnd(), TheU->getLabelBegin(), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002494
Eric Christopher39eebfa2013-09-30 23:14:16 +00002495 // Emit the pubtypes.
David Blaikie4f623202013-12-06 19:38:49 +00002496 const StringMap<const DIE *> &Globals = getUnits()[ID]->getGlobalTypes();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002497 for (StringMap<const DIE *>::const_iterator GI = Globals.begin(),
2498 GE = Globals.end();
Eric Christopher8b3737f2013-09-13 00:34:58 +00002499 GI != GE; ++GI) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002500 const char *Name = GI->getKeyData();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002501 const DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002502
David Blaikie155f8812013-12-04 21:51:05 +00002503 Asm->OutStreamer.AddComment("DIE offset");
Devang Patel1a0df9a2010-05-10 22:49:55 +00002504 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002505
Eric Christopherdd1a0122013-09-13 00:35:05 +00002506 if (GnuStyle) {
David Blaikie2a80e442013-12-02 22:09:48 +00002507 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheU, Entity);
David Blaikied0a869d2013-09-19 22:19:37 +00002508 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002509 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002510 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002511 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002512 }
2513
David Blaikie155f8812013-12-04 21:51:05 +00002514 Asm->OutStreamer.AddComment("External Name");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002515
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002516 // Emit the name with a terminating null byte.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002517 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002518 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002519
Devang Patel1a0df9a2010-05-10 22:49:55 +00002520 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002521 Asm->EmitInt32(0);
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002522 Asm->OutStreamer.EmitLabel(EndLabel);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002523 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002524}
2525
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002526// Emit strings into a string section.
Eric Christopherf8194852013-12-05 18:06:10 +00002527void DwarfFile::emitStrings(const MCSection *StrSection,
Eric Christophera5a79422013-12-09 23:32:48 +00002528 const MCSection *OffsetSection = NULL,
2529 const MCSymbol *StrSecSym = NULL) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002530
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002531 if (StringPool.empty())
2532 return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002533
Chris Lattner3d72a672010-03-09 23:38:23 +00002534 // Start the dwarf str section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002535 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling480ff322009-05-20 23:21:38 +00002536
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002537 // Get all of the string pool entries and put them in an array by their ID so
2538 // we can sort them.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002539 SmallVector<
2540 std::pair<unsigned, StringMapEntry<std::pair<MCSymbol *, unsigned> > *>,
2541 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002542
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002543 for (StringMap<std::pair<MCSymbol *, unsigned> >::iterator
2544 I = StringPool.begin(),
2545 E = StringPool.end();
Eric Christopher48fef592012-12-20 21:58:40 +00002546 I != E; ++I)
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002547 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002548
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002549 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002550
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002551 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002552 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002553 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002554
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002555 // Emit the string itself with a terminating null byte.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002556 Asm->OutStreamer.EmitBytes(
2557 StringRef(Entries[i].second->getKeyData(),
2558 Entries[i].second->getKeyLength() + 1));
Bill Wendling480ff322009-05-20 23:21:38 +00002559 }
Eric Christopher2cbd5762013-01-07 19:32:41 +00002560
2561 // If we've got an offset section go ahead and emit that now as well.
2562 if (OffsetSection) {
2563 Asm->OutStreamer.SwitchSection(OffsetSection);
2564 unsigned offset = 0;
Eric Christopher962c9082013-01-15 23:56:56 +00002565 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002566 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopherbf7bc492013-01-09 03:52:05 +00002567 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopher2cbd5762013-01-07 19:32:41 +00002568 offset += Entries[i].second->getKeyLength() + 1;
2569 }
2570 }
Bill Wendling480ff322009-05-20 23:21:38 +00002571}
2572
Eric Christopher65132a82013-11-19 09:11:26 +00002573// Emit addresses into the section given.
Eric Christopherf8194852013-12-05 18:06:10 +00002574void DwarfFile::emitAddresses(const MCSection *AddrSection) {
Eric Christopher962c9082013-01-15 23:56:56 +00002575
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002576 if (AddressPool.empty())
2577 return;
Eric Christopher962c9082013-01-15 23:56:56 +00002578
2579 // Start the dwarf addr section.
2580 Asm->OutStreamer.SwitchSection(AddrSection);
2581
David Blaikiece1960f2013-07-08 17:51:28 +00002582 // Order the address pool entries by ID
David Blaikieac569a62013-07-08 17:33:10 +00002583 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher962c9082013-01-15 23:56:56 +00002584
David Blaikiece1960f2013-07-08 17:51:28 +00002585 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2586 E = AddressPool.end();
Eric Christopher962c9082013-01-15 23:56:56 +00002587 I != E; ++I)
David Blaikieac569a62013-07-08 17:33:10 +00002588 Entries[I->second] = I->first;
Eric Christopher962c9082013-01-15 23:56:56 +00002589
2590 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002591 // Emit an expression for reference from debug information entries.
David Blaikieac569a62013-07-08 17:33:10 +00002592 if (const MCExpr *Expr = Entries[i])
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002593 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
Eric Christopher962c9082013-01-15 23:56:56 +00002594 else
2595 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2596 }
Eric Christopher962c9082013-01-15 23:56:56 +00002597}
2598
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002599// Emit visible names into a debug str section.
2600void DwarfDebug::emitDebugStr() {
Eric Christopherf8194852013-12-05 18:06:10 +00002601 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002602 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2603}
2604
Eric Christopher9046f942013-07-02 21:36:07 +00002605// Emit locations into the debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002606void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002607 if (DotDebugLocEntries.empty())
2608 return;
2609
Eric Christopher4887c8f2013-03-29 23:34:06 +00002610 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002611 I = DotDebugLocEntries.begin(),
2612 E = DotDebugLocEntries.end();
Devang Patel116a9d72011-02-04 22:57:18 +00002613 I != E; ++I) {
2614 DotDebugLocEntry &Entry = *I;
2615 if (I + 1 != DotDebugLocEntries.end())
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002616 Entry.Merge(I + 1);
Devang Patel116a9d72011-02-04 22:57:18 +00002617 }
2618
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002619 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002620 Asm->OutStreamer.SwitchSection(
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002621 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002622 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002623 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2624 unsigned index = 1;
Eric Christopher4887c8f2013-03-29 23:34:06 +00002625 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002626 I = DotDebugLocEntries.begin(),
2627 E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002628 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002629 DotDebugLocEntry &Entry = *I;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002630 if (Entry.isMerged())
2631 continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002632 if (Entry.isEmpty()) {
Eric Christopherce0cfce2013-01-09 01:35:34 +00002633 Asm->OutStreamer.EmitIntValue(0, Size);
2634 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002635 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002636 } else {
Eric Christopher25f06422013-07-03 22:40:18 +00002637 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2638 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2639 DIVariable DV(Entry.getVariable());
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002640 Asm->OutStreamer.AddComment("Loc expr size");
2641 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2642 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2643 Asm->EmitLabelDifference(end, begin, 2);
2644 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002645 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002646 DIBasicType BTy(DV.getType());
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002647 if (BTy.Verify() && (BTy.getEncoding() == dwarf::DW_ATE_signed ||
2648 BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
Devang Patel324f8432011-06-01 22:03:25 +00002649 Asm->OutStreamer.AddComment("DW_OP_consts");
2650 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002651 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002652 } else {
2653 Asm->OutStreamer.AddComment("DW_OP_constu");
2654 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002655 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002656 }
Devang Pateled9fd452011-07-08 16:49:43 +00002657 } else if (Entry.isLocation()) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002658 MachineLocation Loc = Entry.getLoc();
Eric Christopher6a841382012-11-19 22:42:10 +00002659 if (!DV.hasComplexAddress())
Devang Pateled9fd452011-07-08 16:49:43 +00002660 // Regular entry.
Eric Christopher614a89f2013-07-03 22:40:21 +00002661 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002662 else {
2663 // Complex address entry.
2664 unsigned N = DV.getNumAddrElements();
2665 unsigned i = 0;
2666 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002667 if (Loc.getOffset()) {
Devang Pateled9fd452011-07-08 16:49:43 +00002668 i = 2;
Eric Christopher614a89f2013-07-03 22:40:21 +00002669 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002670 Asm->OutStreamer.AddComment("DW_OP_deref");
2671 Asm->EmitInt8(dwarf::DW_OP_deref);
2672 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2673 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2674 Asm->EmitSLEB128(DV.getAddrElement(1));
2675 } else {
2676 // If first address element is OpPlus then emit
2677 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher614a89f2013-07-03 22:40:21 +00002678 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2679 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002680 i = 2;
2681 }
2682 } else {
Eric Christopher614a89f2013-07-03 22:40:21 +00002683 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002684 }
Eric Christopher6a841382012-11-19 22:42:10 +00002685
Devang Pateled9fd452011-07-08 16:49:43 +00002686 // Emit remaining complex address elements.
2687 for (; i < N; ++i) {
2688 uint64_t Element = DV.getAddrElement(i);
2689 if (Element == DIBuilder::OpPlus) {
2690 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2691 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher4d250522012-05-08 18:56:00 +00002692 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002693 if (!Loc.isReg())
Eric Christopher4d250522012-05-08 18:56:00 +00002694 Asm->EmitInt8(dwarf::DW_OP_deref);
2695 } else
2696 llvm_unreachable("unknown Opcode found in complex address");
Devang Pateled9fd452011-07-08 16:49:43 +00002697 }
Devang Patel3e021532011-04-28 02:22:40 +00002698 }
Devang Patel3e021532011-04-28 02:22:40 +00002699 }
Devang Pateled9fd452011-07-08 16:49:43 +00002700 // else ... ignore constant fp. There is not any good way to
2701 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002702 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002703 }
2704 }
Bill Wendling480ff322009-05-20 23:21:38 +00002705}
2706
Richard Mitton21101b32013-09-19 23:21:01 +00002707struct SymbolCUSorter {
2708 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2709 const MCStreamer &Streamer;
2710
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002711 bool operator()(const SymbolCU &A, const SymbolCU &B) {
Richard Mitton21101b32013-09-19 23:21:01 +00002712 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2713 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2714
2715 // Symbols with no order assigned should be placed at the end.
2716 // (e.g. section end labels)
2717 if (IA == 0)
2718 IA = (unsigned)(-1);
2719 if (IB == 0)
2720 IB = (unsigned)(-1);
2721 return IA < IB;
2722 }
2723};
2724
Eric Christophera5a79422013-12-09 23:32:48 +00002725static bool CUSort(const DwarfUnit *A, const DwarfUnit *B) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002726 return (A->getUniqueID() < B->getUniqueID());
Richard Mitton21101b32013-09-19 23:21:01 +00002727}
2728
2729struct ArangeSpan {
2730 const MCSymbol *Start, *End;
2731};
2732
2733// Emit a debug aranges section, containing a CU lookup for any
2734// address we can tie back to a CU.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002735void DwarfDebug::emitDebugARanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002736 // Start the dwarf aranges section.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002737 Asm->OutStreamer.SwitchSection(
2738 Asm->getObjFileLowering().getDwarfARangesSection());
Richard Mitton21101b32013-09-19 23:21:01 +00002739
Eric Christopher4287a492013-12-09 23:57:44 +00002740 typedef DenseMap<DwarfCompileUnit *, std::vector<ArangeSpan> > SpansType;
Richard Mitton21101b32013-09-19 23:21:01 +00002741
2742 SpansType Spans;
2743
2744 // Build a list of sections used.
2745 std::vector<const MCSection *> Sections;
2746 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2747 it++) {
2748 const MCSection *Section = it->first;
2749 Sections.push_back(Section);
2750 }
2751
2752 // Sort the sections into order.
2753 // This is only done to ensure consistent output order across different runs.
2754 std::sort(Sections.begin(), Sections.end(), SectionSort);
2755
2756 // Build a set of address spans, sorted by CU.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002757 for (size_t SecIdx = 0; SecIdx < Sections.size(); SecIdx++) {
Richard Mitton21101b32013-09-19 23:21:01 +00002758 const MCSection *Section = Sections[SecIdx];
2759 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2760 if (List.size() < 2)
2761 continue;
2762
2763 // Sort the symbols by offset within the section.
2764 SymbolCUSorter sorter(Asm->OutStreamer);
2765 std::sort(List.begin(), List.end(), sorter);
2766
2767 // If we have no section (e.g. common), just write out
2768 // individual spans for each symbol.
2769 if (Section == NULL) {
2770 for (size_t n = 0; n < List.size(); n++) {
2771 const SymbolCU &Cur = List[n];
2772
2773 ArangeSpan Span;
2774 Span.Start = Cur.Sym;
2775 Span.End = NULL;
2776 if (Cur.CU)
2777 Spans[Cur.CU].push_back(Span);
2778 }
2779 } else {
2780 // Build spans between each label.
2781 const MCSymbol *StartSym = List[0].Sym;
2782 for (size_t n = 1; n < List.size(); n++) {
2783 const SymbolCU &Prev = List[n - 1];
2784 const SymbolCU &Cur = List[n];
2785
2786 // Try and build the longest span we can within the same CU.
2787 if (Cur.CU != Prev.CU) {
2788 ArangeSpan Span;
2789 Span.Start = StartSym;
2790 Span.End = Cur.Sym;
2791 Spans[Prev.CU].push_back(Span);
2792 StartSym = Cur.Sym;
2793 }
2794 }
2795 }
2796 }
2797
Richard Mitton21101b32013-09-19 23:21:01 +00002798 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2799
2800 // Build a list of CUs used.
Eric Christopher4287a492013-12-09 23:57:44 +00002801 std::vector<DwarfCompileUnit *> CUs;
Richard Mitton21101b32013-09-19 23:21:01 +00002802 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
Eric Christopher4287a492013-12-09 23:57:44 +00002803 DwarfCompileUnit *CU = it->first;
Richard Mitton21101b32013-09-19 23:21:01 +00002804 CUs.push_back(CU);
2805 }
2806
2807 // Sort the CU list (again, to ensure consistent output order).
2808 std::sort(CUs.begin(), CUs.end(), CUSort);
2809
2810 // Emit an arange table for each CU we used.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002811 for (size_t CUIdx = 0; CUIdx < CUs.size(); CUIdx++) {
Eric Christopher4287a492013-12-09 23:57:44 +00002812 DwarfCompileUnit *CU = CUs[CUIdx];
Richard Mitton21101b32013-09-19 23:21:01 +00002813 std::vector<ArangeSpan> &List = Spans[CU];
2814
2815 // Emit size of content not including length itself.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002816 unsigned ContentSize =
2817 sizeof(int16_t) + // DWARF ARange version number
2818 sizeof(int32_t) + // Offset of CU in the .debug_info section
2819 sizeof(int8_t) + // Pointer Size (in bytes)
2820 sizeof(int8_t); // Segment Size (in bytes)
Richard Mitton21101b32013-09-19 23:21:01 +00002821
2822 unsigned TupleSize = PtrSize * 2;
2823
2824 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
Benjamin Kramer8a68ab32014-01-07 19:28:14 +00002825 unsigned Padding =
2826 OffsetToAlignment(sizeof(int32_t) + ContentSize, TupleSize);
Richard Mitton21101b32013-09-19 23:21:01 +00002827
2828 ContentSize += Padding;
2829 ContentSize += (List.size() + 1) * TupleSize;
2830
2831 // For each compile unit, write the list of spans it covers.
2832 Asm->OutStreamer.AddComment("Length of ARange Set");
2833 Asm->EmitInt32(ContentSize);
2834 Asm->OutStreamer.AddComment("DWARF Arange version number");
2835 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2836 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
Eric Christopherd8667202013-12-30 17:22:27 +00002837 Asm->EmitSectionOffset(CU->getLocalLabelBegin(), CU->getLocalSectionSym());
Richard Mitton21101b32013-09-19 23:21:01 +00002838 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2839 Asm->EmitInt8(PtrSize);
2840 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2841 Asm->EmitInt8(0);
2842
Benjamin Kramer8a68ab32014-01-07 19:28:14 +00002843 Asm->OutStreamer.EmitFill(Padding, 0xff);
Richard Mitton21101b32013-09-19 23:21:01 +00002844
2845 for (unsigned n = 0; n < List.size(); n++) {
2846 const ArangeSpan &Span = List[n];
2847 Asm->EmitLabelReference(Span.Start, PtrSize);
2848
2849 // Calculate the size as being from the span start to it's end.
Richard Mitton089ed892013-09-23 17:56:20 +00002850 if (Span.End) {
Richard Mitton21101b32013-09-19 23:21:01 +00002851 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
Richard Mitton089ed892013-09-23 17:56:20 +00002852 } else {
2853 // For symbols without an end marker (e.g. common), we
2854 // write a single arange entry containing just that one symbol.
2855 uint64_t Size = SymSize[Span.Start];
2856 if (Size == 0)
2857 Size = 1;
2858
2859 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2860 }
Richard Mitton21101b32013-09-19 23:21:01 +00002861 }
2862
2863 Asm->OutStreamer.AddComment("ARange terminator");
2864 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2865 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2866 }
Bill Wendling480ff322009-05-20 23:21:38 +00002867}
2868
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002869// Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002870void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002871 // Start the dwarf ranges section.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002872 Asm->OutStreamer.SwitchSection(
2873 Asm->getObjFileLowering().getDwarfRangesSection());
Eric Christopher4751d702013-11-23 00:05:29 +00002874
Eric Christopher0f63d062013-12-03 00:45:45 +00002875 // Size for our labels.
2876 unsigned char Size = Asm->getDataLayout().getPointerSize();
2877
2878 // Grab the specific ranges for the compile units in the module.
Eric Christopher4287a492013-12-09 23:57:44 +00002879 for (DenseMap<const MDNode *, DwarfCompileUnit *>::iterator I = CUMap.begin(),
2880 E = CUMap.end();
Eric Christopher0f63d062013-12-03 00:45:45 +00002881 I != E; ++I) {
Eric Christopher4287a492013-12-09 23:57:44 +00002882 DwarfCompileUnit *TheCU = I->second;
Eric Christopher0f63d062013-12-03 00:45:45 +00002883
2884 // Emit a symbol so we can find the beginning of our ranges.
David Blaikie1ab7c2d2013-12-09 17:51:30 +00002885 Asm->OutStreamer.EmitLabel(TheCU->getLabelRange());
Eric Christopher0f63d062013-12-03 00:45:45 +00002886
2887 // Iterate over the misc ranges for the compile units in the module.
Eric Christopher270ba4a2013-12-04 19:06:58 +00002888 const SmallVectorImpl<RangeSpanList> &RangeLists = TheCU->getRangeLists();
Eric Christophera5a79422013-12-09 23:32:48 +00002889 for (SmallVectorImpl<RangeSpanList>::const_iterator I = RangeLists.begin(),
2890 E = RangeLists.end();
Eric Christopher0f63d062013-12-03 00:45:45 +00002891 I != E; ++I) {
Eric Christopher270ba4a2013-12-04 19:06:58 +00002892 const RangeSpanList &List = *I;
Eric Christopher0f63d062013-12-03 00:45:45 +00002893
Eric Christopherf8790642013-12-04 22:04:50 +00002894 // Emit our symbol so we can find the beginning of the range.
2895 Asm->OutStreamer.EmitLabel(List.getSym());
Eric Christopher0f63d062013-12-03 00:45:45 +00002896
2897 for (SmallVectorImpl<RangeSpan>::const_iterator
Eric Christopher270ba4a2013-12-04 19:06:58 +00002898 RI = List.getRanges().begin(),
2899 RE = List.getRanges().end();
2900 RI != RE; ++RI) {
2901 const RangeSpan &Range = *RI;
Eric Christopher0f63d062013-12-03 00:45:45 +00002902 const MCSymbol *Begin = Range.getStart();
2903 const MCSymbol *End = Range.getEnd();
Eric Christopher565ab112013-12-20 04:34:22 +00002904 assert(Begin && "Range without a begin symbol?");
2905 assert(End && "Range without an end symbol?");
2906 Asm->OutStreamer.EmitSymbolValue(Begin, Size);
2907 Asm->OutStreamer.EmitSymbolValue(End, Size);
Eric Christopher0f63d062013-12-03 00:45:45 +00002908 }
2909
2910 // And terminate the list with two 0 values.
Eric Christopherce0cfce2013-01-09 01:35:34 +00002911 Asm->OutStreamer.EmitIntValue(0, Size);
Eric Christopher0f63d062013-12-03 00:45:45 +00002912 Asm->OutStreamer.EmitIntValue(0, Size);
2913 }
Eric Christopher46e23432013-12-20 04:16:18 +00002914
2915 // Now emit a range for the CU itself.
Eric Christopher1ad84572014-01-15 00:04:29 +00002916 if (useCURanges()) {
Eric Christopher46e23432013-12-20 04:16:18 +00002917 Asm->OutStreamer.EmitLabel(
2918 Asm->GetTempSymbol("cu_ranges", TheCU->getUniqueID()));
2919 const SmallVectorImpl<RangeSpan> &Ranges = TheCU->getRanges();
2920 for (uint32_t i = 0, e = Ranges.size(); i != e; ++i) {
2921 RangeSpan Range = Ranges[i];
Eric Christopher46e23432013-12-20 04:16:18 +00002922 const MCSymbol *Begin = Range.getStart();
2923 const MCSymbol *End = Range.getEnd();
Eric Christopher565ab112013-12-20 04:34:22 +00002924 assert(Begin && "Range without a begin symbol?");
2925 assert(End && "Range without an end symbol?");
2926 Asm->OutStreamer.EmitSymbolValue(Begin, Size);
2927 Asm->OutStreamer.EmitSymbolValue(End, Size);
Eric Christopher46e23432013-12-20 04:16:18 +00002928 }
2929 // And terminate the list with two 0 values.
2930 Asm->OutStreamer.EmitIntValue(0, Size);
2931 Asm->OutStreamer.EmitIntValue(0, Size);
2932 }
Devang Patel12563b32010-04-16 23:33:45 +00002933 }
Bill Wendling480ff322009-05-20 23:21:38 +00002934}
2935
Eric Christopherd692c1d2012-12-11 19:42:09 +00002936// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002937
David Blaikie38fe6342014-01-09 04:28:46 +00002938void DwarfDebug::initSkeletonUnit(const DwarfUnit *U, DIE *Die,
2939 DwarfUnit *NewU) {
2940 NewU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
2941 U->getCUNode().getSplitDebugFilename());
2942
2943 // Relocate to the beginning of the addr_base section, else 0 for the
2944 // beginning of the one for this compile unit.
2945 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopherceec7b02014-01-11 00:23:18 +00002946 NewU->addSectionLabel(Die, dwarf::DW_AT_GNU_addr_base, DwarfAddrSectionSym);
David Blaikie38fe6342014-01-09 04:28:46 +00002947 else
2948 NewU->addSectionOffset(Die, dwarf::DW_AT_GNU_addr_base, 0);
2949
2950 if (!CompilationDir.empty())
2951 NewU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
2952
2953 addGnuPubAttributes(NewU, Die);
2954
2955 SkeletonHolder.addUnit(NewU);
2956}
2957
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002958// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2959// 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 +00002960// DW_AT_ranges_base, DW_AT_addr_base.
Eric Christopher5090d572013-12-10 00:40:03 +00002961// TODO: Implement DW_AT_ranges_base.
Eric Christopher4287a492013-12-09 23:57:44 +00002962DwarfCompileUnit *DwarfDebug::constructSkeletonCU(const DwarfCompileUnit *CU) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002963
2964 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher4287a492013-12-09 23:57:44 +00002965 DwarfCompileUnit *NewCU = new DwarfCompileUnit(
David Blaikief645f962014-01-09 03:23:41 +00002966 CU->getUniqueID(), Die, CU->getCUNode(), Asm, this, &SkeletonHolder);
David Blaikie1ab7c2d2013-12-09 17:51:30 +00002967 NewCU->initSection(Asm->getObjFileLowering().getDwarfInfoSection(),
2968 DwarfInfoSectionSym);
Eric Christopher4c7765f2013-01-17 03:00:04 +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
David Blaikie38fe6342014-01-09 04:28:46 +00002978 initSkeletonUnit(CU, Die, NewCU);
Eric Christopherc8a310e2012-12-10 23:34:43 +00002979
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002980 return NewCU;
2981}
2982
David Blaikie15ed5eb2014-01-10 01:38:41 +00002983// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_dwo_name,
2984// DW_AT_addr_base.
2985DwarfTypeUnit *DwarfDebug::constructSkeletonTU(const DwarfTypeUnit *TU) {
2986
2987 DIE *Die = new DIE(dwarf::DW_TAG_type_unit);
2988 DwarfTypeUnit *NewTU = new DwarfTypeUnit(
2989 TU->getUniqueID(), Die, TU->getCUNode(), Asm, this, &SkeletonHolder);
2990 NewTU->setTypeSignature(TU->getTypeSignature());
2991 NewTU->setType(NULL);
2992 NewTU->initSection(
2993 Asm->getObjFileLowering().getDwarfTypesSection(TU->getTypeSignature()));
2994
2995 initSkeletonUnit(TU, Die, NewTU);
2996 return NewTU;
2997}
2998
Eric Christopherd692c1d2012-12-11 19:42:09 +00002999// Emit the .debug_info.dwo section for separated dwarf. This contains the
3000// compile units that would normally be in debug_info.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00003001void DwarfDebug::emitDebugInfoDWO() {
Eric Christophercdf218d2012-12-10 19:51:21 +00003002 assert(useSplitDwarf() && "No split dwarf debug info?");
David Blaikie03073f72013-12-06 22:14:48 +00003003 InfoHolder.emitUnits(this,
Eric Christopher3c5a1912012-12-19 22:02:53 +00003004 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
3005 DwarfAbbrevDWOSectionSym);
3006}
3007
3008// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
3009// abbreviations for the .debug_info.dwo section.
3010void DwarfDebug::emitDebugAbbrevDWO() {
3011 assert(useSplitDwarf() && "No split dwarf?");
David Blaikie0504cda2013-12-05 07:43:55 +00003012 InfoHolder.emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection());
Eric Christopher9c2ecd92012-11-30 23:59:06 +00003013}
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003014
3015// Emit the .debug_str.dwo section for separated dwarf. This contains the
3016// string section and is identical in format to traditional .debug_str
3017// sections.
3018void DwarfDebug::emitDebugStrDWO() {
3019 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00003020 const MCSection *OffSec =
3021 Asm->getObjFileLowering().getDwarfStrOffDWOSection();
Eric Christopher2cbd5762013-01-07 19:32:41 +00003022 const MCSymbol *StrSym = DwarfStrSectionSym;
3023 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
3024 OffSec, StrSym);
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003025}
David Blaikie409dd9c2013-11-19 23:08:21 +00003026
David Blaikief645f962014-01-09 03:23:41 +00003027void DwarfDebug::addDwarfTypeUnitType(DICompileUnit CUNode,
3028 StringRef Identifier, DIE *RefDie,
3029 DICompositeType CTy) {
David Blaikie47f615e2013-12-17 23:32:35 +00003030 const DwarfTypeUnit *&TU = DwarfTypeUnits[CTy];
3031 if (!TU) {
David Blaikie409dd9c2013-11-19 23:08:21 +00003032 DIE *UnitDie = new DIE(dwarf::DW_TAG_type_unit);
David Blaikieb334e942014-01-09 03:24:13 +00003033 DwarfTypeUnit *NewTU = new DwarfTypeUnit(
3034 InfoHolder.getUnits().size(), UnitDie, CUNode, Asm, this, &InfoHolder);
David Blaikie47f615e2013-12-17 23:32:35 +00003035 TU = NewTU;
David Blaikie2666e242013-12-06 19:38:46 +00003036 InfoHolder.addUnit(NewTU);
3037
David Blaikie319a05f2013-12-02 19:33:10 +00003038 NewTU->addUInt(UnitDie, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
David Blaikief645f962014-01-09 03:23:41 +00003039 CUNode.getLanguage());
David Blaikie409dd9c2013-11-19 23:08:21 +00003040
David Blaikiecfb21152014-01-03 18:59:42 +00003041 MD5 Hash;
3042 Hash.update(Identifier);
3043 // ... take the least significant 8 bytes and return those. Our MD5
3044 // implementation always returns its results in little endian, swap bytes
3045 // appropriately.
3046 MD5::MD5Result Result;
3047 Hash.final(Result);
3048 uint64_t Signature = *reinterpret_cast<support::ulittle64_t *>(Result + 8);
David Blaikiebc563272013-12-13 21:33:40 +00003049 NewTU->setTypeSignature(Signature);
David Blaikie15ed5eb2014-01-10 01:38:41 +00003050 if (useSplitDwarf())
3051 NewTU->setSkeleton(constructSkeletonTU(NewTU));
3052
3053 NewTU->setType(NewTU->createTypeDIE(CTy));
David Blaikie409dd9c2013-11-19 23:08:21 +00003054
David Blaikie03073f72013-12-06 22:14:48 +00003055 NewTU->initSection(
David Blaikiebc563272013-12-13 21:33:40 +00003056 useSplitDwarf()
3057 ? Asm->getObjFileLowering().getDwarfTypesDWOSection(Signature)
3058 : Asm->getObjFileLowering().getDwarfTypesSection(Signature));
David Blaikie409dd9c2013-11-19 23:08:21 +00003059 }
3060
David Blaikie47f615e2013-12-17 23:32:35 +00003061 CUMap.begin()->second->addDIETypeSignature(RefDie, *TU);
David Blaikie409dd9c2013-11-19 23:08:21 +00003062}