blob: 91aa7639ad3993c54a412ec065661fce3d540197 [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"
Chandler Carruth4220e9c2014-03-04 11:17:44 +000032#include "llvm/IR/ValueHandle.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000033#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000034#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000035#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000036#include "llvm/MC/MCSymbol.h"
Devang Patel6c74a872010-04-27 19:46:33 +000037#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000038#include "llvm/Support/Debug.h"
David Majnemered89b5c2013-08-21 06:13:34 +000039#include "llvm/Support/Dwarf.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000040#include "llvm/Support/ErrorHandling.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000041#include "llvm/Support/FormattedStream.h"
Logan Chien5b776b72014-02-22 14:00:39 +000042#include "llvm/Support/LEB128.h"
Eric Christopher67646432013-07-26 17:02:41 +000043#include "llvm/Support/MD5.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000044#include "llvm/Support/Path.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000045#include "llvm/Support/Timer.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000046#include "llvm/Target/TargetFrameLowering.h"
47#include "llvm/Target/TargetLoweringObjectFile.h"
48#include "llvm/Target/TargetMachine.h"
49#include "llvm/Target/TargetOptions.h"
50#include "llvm/Target/TargetRegisterInfo.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000051using namespace llvm;
52
Eric Christopher7f2b5512013-07-23 22:16:41 +000053static cl::opt<bool>
54DisableDebugInfoPrinting("disable-debug-info-print", cl::Hidden,
55 cl::desc("Disable debug info printing"));
Devang Patel6c74a872010-04-27 19:46:33 +000056
Eric Christopher7f2b5512013-07-23 22:16:41 +000057static cl::opt<bool> UnknownLocations(
58 "use-unknown-locations", cl::Hidden,
59 cl::desc("Make an absence of debug location information explicit."),
60 cl::init(false));
Dan Gohman7421ae42010-05-07 01:08:53 +000061
Eric Christopherb4bef6d2013-11-19 09:04:36 +000062static cl::opt<bool> GenerateCUHash("generate-cu-hash", cl::Hidden,
63 cl::desc("Add the CU hash as the dwo_id."),
64 cl::init(false));
Eric Christopherd29614f2013-08-13 01:21:55 +000065
Eric Christopherdd1a0122013-09-13 00:35:05 +000066static cl::opt<bool>
67GenerateGnuPubSections("generate-gnu-dwarf-pub-sections", cl::Hidden,
68 cl::desc("Generate GNU-style pubnames and pubtypes"),
69 cl::init(false));
70
Eric Christopher02dbadb2014-02-14 01:26:55 +000071static cl::opt<bool> GenerateARangeSection("generate-arange-section",
72 cl::Hidden,
73 cl::desc("Generate dwarf aranges"),
74 cl::init(false));
75
Eric Christopher20b76a72012-08-23 22:36:40 +000076namespace {
Eric Christopherf07ee3a2014-01-27 23:50:03 +000077enum DefaultOnOff { Default, Enable, Disable };
Eric Christopher20b76a72012-08-23 22:36:40 +000078}
Eric Christopher4996c702011-11-07 09:24:32 +000079
Eric Christopher7f2b5512013-07-23 22:16:41 +000080static cl::opt<DefaultOnOff>
81DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
82 cl::desc("Output prototype dwarf accelerator tables."),
83 cl::values(clEnumVal(Default, "Default for platform"),
84 clEnumVal(Enable, "Enabled"),
85 clEnumVal(Disable, "Disabled"), clEnumValEnd),
86 cl::init(Default));
Eric Christopher20b76a72012-08-23 22:36:40 +000087
Eric Christopher7f2b5512013-07-23 22:16:41 +000088static cl::opt<DefaultOnOff>
Eric Christopher7f2b5512013-07-23 22:16:41 +000089SplitDwarf("split-dwarf", cl::Hidden,
Eric Christopher5d008fe2013-12-04 23:24:28 +000090 cl::desc("Output DWARF5 split debug info."),
Eric Christopher7f2b5512013-07-23 22:16:41 +000091 cl::values(clEnumVal(Default, "Default for platform"),
92 clEnumVal(Enable, "Enabled"),
93 clEnumVal(Disable, "Disabled"), clEnumValEnd),
94 cl::init(Default));
Eric Christopher29424312012-11-12 22:22:20 +000095
Eric Christopher7da24882013-08-19 21:07:38 +000096static cl::opt<DefaultOnOff>
Eric Christopher4d36ca02013-08-26 23:24:35 +000097DwarfPubSections("generate-dwarf-pub-sections", cl::Hidden,
98 cl::desc("Generate DWARF pubnames and pubtypes sections"),
99 cl::values(clEnumVal(Default, "Default for platform"),
100 clEnumVal(Enable, "Enabled"),
101 clEnumVal(Disable, "Disabled"), clEnumValEnd),
102 cl::init(Default));
Eric Christopher7da24882013-08-19 21:07:38 +0000103
Eric Christopher33ff6972013-11-21 23:46:41 +0000104static cl::opt<unsigned>
105DwarfVersionNumber("dwarf-version", cl::Hidden,
Eric Christophera5a79422013-12-09 23:32:48 +0000106 cl::desc("Generate DWARF for dwarf version."), cl::init(0));
Eric Christopher33ff6972013-11-21 23:46:41 +0000107
Eric Christopher46e23432013-12-20 04:16:18 +0000108static cl::opt<bool>
109DwarfCURanges("generate-dwarf-cu-ranges", cl::Hidden,
110 cl::desc("Generate DW_AT_ranges for compile units"),
111 cl::init(false));
112
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000113static const char *const DWARFGroupName = "DWARF Emission";
114static const char *const DbgTimerName = "DWARF Debug Writer";
Bill Wendlingfcc14142010-04-07 09:28:04 +0000115
Bill Wendling2f921f82009-05-15 09:23:25 +0000116//===----------------------------------------------------------------------===//
117
Bill Wendling2f921f82009-05-15 09:23:25 +0000118namespace llvm {
119
Manman Renbe5576f2013-10-08 19:07:44 +0000120/// resolve - Look in the DwarfDebug map for the MDNode that
121/// corresponds to the reference.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000122template <typename T> T DbgVariable::resolve(DIRef<T> Ref) const {
Manman Renbe5576f2013-10-08 19:07:44 +0000123 return DD->resolve(Ref);
124}
125
Nick Lewycky019d2552011-07-29 03:49:23 +0000126DIType DbgVariable::getType() const {
Devang Patelf20c4f72011-04-12 22:53:02 +0000127 DIType Ty = Var.getType();
128 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
129 // addresses instead.
130 if (Var.isBlockByrefVariable()) {
131 /* Byref variables, in Blocks, are declared by the programmer as
132 "SomeType VarName;", but the compiler creates a
133 __Block_byref_x_VarName struct, and gives the variable VarName
134 either the struct, or a pointer to the struct, as its type. This
135 is necessary for various behind-the-scenes things the compiler
136 needs to do with by-reference variables in blocks.
Eric Christopher6a841382012-11-19 22:42:10 +0000137
Devang Patelf20c4f72011-04-12 22:53:02 +0000138 However, as far as the original *programmer* is concerned, the
139 variable should still have type 'SomeType', as originally declared.
Eric Christopher6a841382012-11-19 22:42:10 +0000140
Devang Patelf20c4f72011-04-12 22:53:02 +0000141 The following function dives into the __Block_byref_x_VarName
142 struct to find the original type of the variable. This will be
143 passed back to the code generating the type for the Debug
144 Information Entry for the variable 'VarName'. 'VarName' will then
145 have the original type 'SomeType' in its debug information.
Eric Christopher6a841382012-11-19 22:42:10 +0000146
Devang Patelf20c4f72011-04-12 22:53:02 +0000147 The original type 'SomeType' will be the type of the field named
148 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher6a841382012-11-19 22:42:10 +0000149
Devang Patelf20c4f72011-04-12 22:53:02 +0000150 NOTE: In order for this to not completely fail on the debugger
151 side, the Debug Information Entry for the variable VarName needs to
152 have a DW_AT_location that tells the debugger how to unwind through
153 the pointers and __Block_byref_x_VarName struct to find the actual
154 value of the variable. The function addBlockByrefType does this. */
155 DIType subType = Ty;
Eric Christopher31b05762013-08-08 01:41:00 +0000156 uint16_t tag = Ty.getTag();
Eric Christopher6a841382012-11-19 22:42:10 +0000157
Eric Christopher9adc55f2013-09-04 19:53:21 +0000158 if (tag == dwarf::DW_TAG_pointer_type)
Manman Renbe5576f2013-10-08 19:07:44 +0000159 subType = resolve(DIDerivedType(Ty).getTypeDerivedFrom());
Eric Christopher6a841382012-11-19 22:42:10 +0000160
Eric Christopher9adc55f2013-09-04 19:53:21 +0000161 DIArray Elements = DICompositeType(subType).getTypeArray();
Devang Patelf20c4f72011-04-12 22:53:02 +0000162 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
David Blaikie5af2aca2013-11-18 23:57:26 +0000163 DIDerivedType DT(Elements.getElement(i));
Devang Patelf20c4f72011-04-12 22:53:02 +0000164 if (getName() == DT.getName())
Manman Renbe5576f2013-10-08 19:07:44 +0000165 return (resolve(DT.getTypeDerivedFrom()));
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000166 }
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000167 }
Devang Patelf20c4f72011-04-12 22:53:02 +0000168 return Ty;
169}
Bill Wendling2f921f82009-05-15 09:23:25 +0000170
Chris Lattnerf5d06362010-04-05 04:09:20 +0000171} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000172
Eric Christopher942f22c2014-01-11 00:28:12 +0000173/// Return Dwarf Version by checking module flags.
174static unsigned getDwarfVersionFromModule(const Module *M) {
Manman Ren8bfde892013-07-16 23:21:16 +0000175 Value *Val = M->getModuleFlag("Dwarf Version");
176 if (!Val)
Eric Christophere31e0722013-09-04 22:21:24 +0000177 return dwarf::DWARF_VERSION;
Manman Ren8bfde892013-07-16 23:21:16 +0000178 return cast<ConstantInt>(Val)->getZExtValue();
Manman Renac8062b2013-07-02 23:40:10 +0000179}
180
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000181DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
David Blaikie0504cda2013-12-05 07:43:55 +0000182 : Asm(A), MMI(Asm->MMI), FirstCU(0), SourceIdMap(DIEValueAllocator),
David Blaikie2666e242013-12-06 19:38:46 +0000183 PrevLabel(NULL), GlobalRangeCount(0),
Eric Christopher1bca60d2014-01-23 22:55:47 +0000184 InfoHolder(A, "info_string", DIEValueAllocator), HasCURanges(false),
Eric Christopher2037caf2014-01-28 00:49:26 +0000185 UsedNonDefaultText(false),
David Blaikie0504cda2013-12-05 07:43:55 +0000186 SkeletonHolder(A, "skel_string", DIEValueAllocator) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000187
Eric Christopher50effa02014-01-03 02:16:44 +0000188 DwarfInfoSectionSym = DwarfAbbrevSectionSym = DwarfStrSectionSym = 0;
Eric Christopher74804332013-02-07 21:19:50 +0000189 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
Eric Christopher55863be2013-04-07 03:43:09 +0000190 DwarfAddrSectionSym = 0;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000191 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000192 FunctionBeginSym = FunctionEndSym = 0;
Eric Christophera5a79422013-12-09 23:32:48 +0000193 CurFn = 0;
194 CurMI = 0;
Eric Christopherad9fe892012-04-02 17:58:52 +0000195
Adrian Prantl5bf1d002013-10-15 20:26:37 +0000196 // Turn on accelerator tables for Darwin by default, pubnames by
197 // default for non-Darwin, and handle split dwarf.
Eric Christopher203e12b2013-04-27 01:07:52 +0000198 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
Eric Christopher4977f212012-08-23 22:36:36 +0000199
Eric Christopher574b5c82013-08-19 21:41:38 +0000200 if (DwarfAccelTables == Default)
201 HasDwarfAccelTables = IsDarwin;
202 else
Eric Christopher5297df02013-08-26 20:58:35 +0000203 HasDwarfAccelTables = DwarfAccelTables == Enable;
Eric Christopher20b76a72012-08-23 22:36:40 +0000204
Eric Christophercdf218d2012-12-10 19:51:21 +0000205 if (SplitDwarf == Default)
206 HasSplitDwarf = false;
Eric Christopher29424312012-11-12 22:22:20 +0000207 else
Eric Christopher574b5c82013-08-19 21:41:38 +0000208 HasSplitDwarf = SplitDwarf == Enable;
Eric Christopher29424312012-11-12 22:22:20 +0000209
Eric Christopher4d36ca02013-08-26 23:24:35 +0000210 if (DwarfPubSections == Default)
211 HasDwarfPubSections = !IsDarwin;
Eric Christopher574b5c82013-08-19 21:41:38 +0000212 else
Eric Christopher4d36ca02013-08-26 23:24:35 +0000213 HasDwarfPubSections = DwarfPubSections == Enable;
Eric Christopher7da24882013-08-19 21:07:38 +0000214
Eric Christopher942f22c2014-01-11 00:28:12 +0000215 DwarfVersion = DwarfVersionNumber
216 ? DwarfVersionNumber
217 : getDwarfVersionFromModule(MMI->getModule());
Manman Renac8062b2013-07-02 23:40:10 +0000218
Dan Gohman6e681a52010-06-18 15:56:31 +0000219 {
220 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopher58f41952012-11-19 22:42:15 +0000221 beginModule();
Torok Edwinf8dba242010-04-07 10:44:46 +0000222 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000223}
Bill Wendling2f921f82009-05-15 09:23:25 +0000224
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000225// Switch to the specified MCSection and emit an assembler
226// temporary label to it if SymbolStem is specified.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000227static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christophera7b61892011-11-07 09:18:38 +0000228 const char *SymbolStem = 0) {
229 Asm->OutStreamer.SwitchSection(Section);
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000230 if (!SymbolStem)
231 return 0;
Eric Christophera7b61892011-11-07 09:18:38 +0000232
233 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
234 Asm->OutStreamer.EmitLabel(TmpSym);
235 return TmpSym;
236}
237
Eric Christopherf8194852013-12-05 18:06:10 +0000238DwarfFile::~DwarfFile() {
Eric Christophera5a79422013-12-09 23:32:48 +0000239 for (SmallVectorImpl<DwarfUnit *>::iterator I = CUs.begin(), E = CUs.end();
240 I != E; ++I)
David Blaikie72f1a3e2013-11-23 01:17:34 +0000241 delete *I;
242}
243
Eric Christopherf8194852013-12-05 18:06:10 +0000244MCSymbol *DwarfFile::getStringPoolSym() {
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000245 return Asm->GetTempSymbol(StringPref);
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000246}
247
Eric Christopherf8194852013-12-05 18:06:10 +0000248MCSymbol *DwarfFile::getStringPoolEntry(StringRef Str) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000249 std::pair<MCSymbol *, unsigned> &Entry =
250 StringPool.GetOrCreateValue(Str).getValue();
251 if (Entry.first)
252 return Entry.first;
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000253
254 Entry.second = NextStringPoolNumber++;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000255 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000256}
257
Eric Christopherf8194852013-12-05 18:06:10 +0000258unsigned DwarfFile::getStringPoolIndex(StringRef Str) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000259 std::pair<MCSymbol *, unsigned> &Entry =
260 StringPool.GetOrCreateValue(Str).getValue();
261 if (Entry.first)
262 return Entry.second;
Eric Christopher2cbd5762013-01-07 19:32:41 +0000263
264 Entry.second = NextStringPoolNumber++;
265 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
266 return Entry.second;
267}
268
David Blaikief1a6dea2014-02-15 19:34:03 +0000269unsigned DwarfFile::getAddrPoolIndex(const MCSymbol *Sym, bool TLS) {
270 std::pair<AddrPool::iterator, bool> P = AddressPool.insert(
271 std::make_pair(Sym, AddressPoolEntry(NextAddrPoolNumber, TLS)));
David Blaikiea67de2b2013-06-28 18:55:13 +0000272 if (P.second)
273 ++NextAddrPoolNumber;
David Blaikief1a6dea2014-02-15 19:34:03 +0000274 return P.first->second.Number;
Eric Christopher962c9082013-01-15 23:56:56 +0000275}
276
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000277// Define a unique number for the abbreviation.
278//
Eric Christopherf8194852013-12-05 18:06:10 +0000279void DwarfFile::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000280 // Check the set for priors.
David Blaikie0504cda2013-12-05 07:43:55 +0000281 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000282
283 // If it's newly added.
284 if (InSet == &Abbrev) {
285 // Add to abbreviation list.
David Blaikie2d4e1122013-10-30 17:14:24 +0000286 Abbreviations.push_back(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000287
288 // Assign the vector position + 1 as its number.
David Blaikie2d4e1122013-10-30 17:14:24 +0000289 Abbrev.setNumber(Abbreviations.size());
Bill Wendling2f921f82009-05-15 09:23:25 +0000290 } else {
291 // Assign existing abbreviation number.
292 Abbrev.setNumber(InSet->getNumber());
293 }
294}
295
Eric Christopherd9843b32011-11-10 19:25:34 +0000296static bool isObjCClass(StringRef Name) {
297 return Name.startswith("+") || Name.startswith("-");
298}
299
300static bool hasObjCCategory(StringRef Name) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000301 if (!isObjCClass(Name))
302 return false;
Eric Christopherd9843b32011-11-10 19:25:34 +0000303
Benjamin Kramer260de742013-08-24 12:15:54 +0000304 return Name.find(") ") != StringRef::npos;
Eric Christopherd9843b32011-11-10 19:25:34 +0000305}
306
307static void getObjCClassCategory(StringRef In, StringRef &Class,
308 StringRef &Category) {
309 if (!hasObjCCategory(In)) {
310 Class = In.slice(In.find('[') + 1, In.find(' '));
311 Category = "";
312 return;
313 }
314
315 Class = In.slice(In.find('[') + 1, In.find('('));
316 Category = In.slice(In.find('[') + 1, In.find(' '));
317 return;
318}
319
320static StringRef getObjCMethodName(StringRef In) {
321 return In.slice(In.find(' ') + 1, In.find(']'));
322}
323
Richard Mittonc2508242013-10-03 22:07:08 +0000324// Helper for sorting sections into a stable output order.
325static bool SectionSort(const MCSection *A, const MCSection *B) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000326 std::string LA = (A ? A->getLabelBeginName() : "");
327 std::string LB = (B ? B->getLabelBeginName() : "");
328 return LA < LB;
Richard Mittonc2508242013-10-03 22:07:08 +0000329}
330
Eric Christopherd9843b32011-11-10 19:25:34 +0000331// Add the various names to the Dwarf accelerator table names.
Eric Christopher9cd26af2013-09-20 23:22:52 +0000332// TODO: Determine whether or not we should add names for programs
333// that do not have a DW_AT_name or DW_AT_linkage_name field - this
334// is only slightly different than the lookup of non-standard ObjC names.
Eric Christophera5a79422013-12-09 23:32:48 +0000335static void addSubprogramNames(DwarfUnit *TheU, DISubprogram SP, DIE *Die) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000336 if (!SP.isDefinition())
337 return;
David Blaikie2a80e442013-12-02 22:09:48 +0000338 TheU->addAccelName(SP.getName(), Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000339
340 // If the linkage name is different than the name, go ahead and output
341 // that as well into the name table.
342 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
David Blaikie2a80e442013-12-02 22:09:48 +0000343 TheU->addAccelName(SP.getLinkageName(), Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000344
345 // If this is an Objective-C selector name add it to the ObjC accelerator
346 // too.
347 if (isObjCClass(SP.getName())) {
348 StringRef Class, Category;
349 getObjCClassCategory(SP.getName(), Class, Category);
David Blaikie2a80e442013-12-02 22:09:48 +0000350 TheU->addAccelObjC(Class, Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000351 if (Category != "")
David Blaikie2a80e442013-12-02 22:09:48 +0000352 TheU->addAccelObjC(Category, Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000353 // Also add the base method name to the name table.
David Blaikie2a80e442013-12-02 22:09:48 +0000354 TheU->addAccelName(getObjCMethodName(SP.getName()), Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000355 }
356}
357
Manman Ren3eb9dff2013-09-09 19:05:21 +0000358/// isSubprogramContext - Return true if Context is either a subprogram
359/// or another context nested inside a subprogram.
360bool DwarfDebug::isSubprogramContext(const MDNode *Context) {
361 if (!Context)
362 return false;
363 DIDescriptor D(Context);
364 if (D.isSubprogram())
365 return true;
366 if (D.isType())
Manman Ren116868e2013-09-09 19:47:11 +0000367 return isSubprogramContext(resolve(DIType(Context).getContext()));
Manman Ren3eb9dff2013-09-09 19:05:21 +0000368 return false;
369}
370
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000371// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
372// and DW_AT_high_pc attributes. If there are global variables in this
373// scope then create and insert DIEs for these variables.
Eric Christopher4287a492013-12-09 23:57:44 +0000374DIE *DwarfDebug::updateSubprogramScopeDIE(DwarfCompileUnit *SPCU,
375 DISubprogram SP) {
David Blaikie25bc7192013-11-15 23:13:08 +0000376 DIE *SPDie = SPCU->getDIE(SP);
Devang Patela37a95e2010-07-07 22:20:57 +0000377
Chris Lattner3a383cb2010-04-05 00:13:49 +0000378 assert(SPDie && "Unable to find subprogram DIE!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000379
Bill Wendlingf720bf62012-11-07 05:19:04 +0000380 // If we're updating an abstract DIE, then we will be adding the children and
381 // object pointer later on. But what we don't want to do is process the
382 // concrete DIE twice.
David Blaikie25bc7192013-11-15 23:13:08 +0000383 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SP)) {
Bill Wendlingf720bf62012-11-07 05:19:04 +0000384 // Pick up abstract subprogram DIE.
David Blaikie2a80e442013-12-02 22:09:48 +0000385 SPDie =
386 SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram, *SPCU->getUnitDie());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000387 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin, AbsSPDIE);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000388 } else {
389 DISubprogram SPDecl = SP.getFunctionDeclaration();
390 if (!SPDecl.isSubprogram()) {
391 // There is not any need to generate specification DIE for a function
392 // defined at compile unit level. If a function is defined inside another
393 // function then gdb prefers the definition at top level and but does not
394 // expect specification DIE in parent function. So avoid creating
395 // specification DIE for a function defined inside a function.
Manman Renc50fa112013-10-10 18:40:01 +0000396 DIScope SPContext = resolve(SP.getContext());
397 if (SP.isDefinition() && !SPContext.isCompileUnit() &&
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000398 !SPContext.isFile() && !isSubprogramContext(SPContext)) {
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000399 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
400
401 // Add arguments.
402 DICompositeType SPTy = SP.getType();
403 DIArray Args = SPTy.getTypeArray();
Eric Christopher31b05762013-08-08 01:41:00 +0000404 uint16_t SPTag = SPTy.getTag();
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000405 if (SPTag == dwarf::DW_TAG_subroutine_type)
Adrian Prantl69140d22014-02-25 22:27:14 +0000406 SPCU->constructSubprogramArguments(*SPDie, Args);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000407 DIE *SPDeclDie = SPDie;
David Blaikie2a80e442013-12-02 22:09:48 +0000408 SPDie = SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram,
409 *SPCU->getUnitDie());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000410 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, SPDeclDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000411 }
412 }
Devang Patela37a95e2010-07-07 22:20:57 +0000413 }
414
David Blaikieb7a1c4d2013-12-04 17:55:41 +0000415 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc, FunctionBeginSym);
416 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc, FunctionEndSym);
Eric Christopher0f63d062013-12-03 00:45:45 +0000417
Chris Lattner3a383cb2010-04-05 00:13:49 +0000418 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
419 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000420 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000421
Eric Christopherd9843b32011-11-10 19:25:34 +0000422 // Add name to the name table, we do this here because we're guaranteed
423 // to have concrete versions of our DW_TAG_subprogram nodes.
424 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher6a841382012-11-19 22:42:10 +0000425
Chris Lattner3a383cb2010-04-05 00:13:49 +0000426 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000427}
428
Manman Ren5b2f4b02013-09-11 19:40:28 +0000429/// Check whether we should create a DIE for the given Scope, return true
430/// if we don't create a DIE (the corresponding DIE is null).
Manman Ren2312ed32013-09-10 18:40:41 +0000431bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
432 if (Scope->isAbstractScope())
433 return false;
434
Manman Ren5b2f4b02013-09-11 19:40:28 +0000435 // We don't create a DIE if there is no Range.
Manman Ren2312ed32013-09-10 18:40:41 +0000436 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
437 if (Ranges.empty())
438 return true;
439
440 if (Ranges.size() > 1)
441 return false;
442
Manman Ren5b2f4b02013-09-11 19:40:28 +0000443 // We don't create a DIE if we have a single Range and the end label
444 // is null.
Manman Ren2312ed32013-09-10 18:40:41 +0000445 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
446 MCSymbol *End = getLabelAfterInsn(RI->second);
447 return !End;
448}
449
Eric Christophera5a79422013-12-09 23:32:48 +0000450static void addSectionLabel(AsmPrinter *Asm, DwarfUnit *U, DIE *D,
Eric Christopherc31fe2d2013-12-05 00:36:17 +0000451 dwarf::Attribute A, const MCSymbol *L,
452 const MCSymbol *Sec) {
453 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
454 U->addSectionLabel(D, A, L);
455 else
456 U->addSectionDelta(D, A, L, Sec);
457}
458
Eric Christopher4287a492013-12-09 23:57:44 +0000459void DwarfDebug::addScopeRangeList(DwarfCompileUnit *TheCU, DIE *ScopeDIE,
Eric Christopherbe2513e2013-12-03 00:45:59 +0000460 const SmallVectorImpl<InsnRange> &Range) {
461 // Emit offset in .debug_range as a relocatable label. emitDIE will handle
462 // emitting it appropriately.
Eric Christopherf8790642013-12-04 22:04:50 +0000463 MCSymbol *RangeSym = Asm->GetTempSymbol("debug_ranges", GlobalRangeCount++);
Eric Christopherc31fe2d2013-12-05 00:36:17 +0000464 addSectionLabel(Asm, TheCU, ScopeDIE, dwarf::DW_AT_ranges, RangeSym,
465 DwarfDebugRangeSectionSym);
466
Eric Christopherf8790642013-12-04 22:04:50 +0000467 RangeSpanList List(RangeSym);
Eric Christopherbe2513e2013-12-03 00:45:59 +0000468 for (SmallVectorImpl<InsnRange>::const_iterator RI = Range.begin(),
469 RE = Range.end();
470 RI != RE; ++RI) {
471 RangeSpan Span(getLabelBeforeInsn(RI->first),
472 getLabelAfterInsn(RI->second));
Chandler Carruth002da5d2014-03-02 04:08:41 +0000473 List.addRange(std::move(Span));
Eric Christopherbe2513e2013-12-03 00:45:59 +0000474 }
475
476 // Add the range list to the set of ranges to be emitted.
Chandler Carruth002da5d2014-03-02 04:08:41 +0000477 TheCU->addRangeList(std::move(List));
Eric Christopherbe2513e2013-12-03 00:45:59 +0000478}
479
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000480// Construct new DW_TAG_lexical_block for this scope and attach
481// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher4287a492013-12-09 23:57:44 +0000482DIE *DwarfDebug::constructLexicalScopeDIE(DwarfCompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000483 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000484 if (isLexicalScopeDIENull(Scope))
485 return 0;
486
Devang Patel6c74a872010-04-27 19:46:33 +0000487 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
488 if (Scope->isAbstractScope())
489 return ScopeDIE;
490
Eric Christopher0f63d062013-12-03 00:45:45 +0000491 const SmallVectorImpl<InsnRange> &ScopeRanges = Scope->getRanges();
Eric Christopherbe2513e2013-12-03 00:45:59 +0000492
Eric Christopherdc42ea82013-07-03 01:57:28 +0000493 // If we have multiple ranges, emit them into the range section.
Eric Christopher0f63d062013-12-03 00:45:45 +0000494 if (ScopeRanges.size() > 1) {
Eric Christopherbe2513e2013-12-03 00:45:59 +0000495 addScopeRangeList(TheCU, ScopeDIE, ScopeRanges);
Devang Patel6c74a872010-04-27 19:46:33 +0000496 return ScopeDIE;
497 }
498
Eric Christopherdc42ea82013-07-03 01:57:28 +0000499 // Construct the address range for this DIE.
Eric Christopher0f63d062013-12-03 00:45:45 +0000500 SmallVectorImpl<InsnRange>::const_iterator RI = ScopeRanges.begin();
Eric Christopher962c9082013-01-15 23:56:56 +0000501 MCSymbol *Start = getLabelBeforeInsn(RI->first);
502 MCSymbol *End = getLabelAfterInsn(RI->second);
Manman Ren2312ed32013-09-10 18:40:41 +0000503 assert(End && "End label should not be null!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000504
Chris Lattnere13c3722010-03-09 01:58:53 +0000505 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
506 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000507
Eric Christopher962c9082013-01-15 23:56:56 +0000508 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
509 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000510
511 return ScopeDIE;
512}
513
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000514// This scope represents inlined body of a function. Construct DIE to
515// represent this concrete inlined copy of the function.
Eric Christopher4287a492013-12-09 23:57:44 +0000516DIE *DwarfDebug::constructInlinedScopeDIE(DwarfCompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000517 LexicalScope *Scope) {
Eric Christopher0f63d062013-12-03 00:45:45 +0000518 const SmallVectorImpl<InsnRange> &ScopeRanges = Scope->getRanges();
Eric Christopher1cdb63d2013-12-04 21:20:15 +0000519 assert(!ScopeRanges.empty() &&
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000520 "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000521
Devang Patelf098ce22011-07-27 00:34:13 +0000522 if (!Scope->getScopeNode())
523 return NULL;
524 DIScope DS(Scope->getScopeNode());
525 DISubprogram InlinedSP = getDISubprogram(DS);
Eric Christophere595bae2013-10-04 17:08:38 +0000526 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patelf098ce22011-07-27 00:34:13 +0000527 if (!OriginDIE) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000528 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patelf098ce22011-07-27 00:34:13 +0000529 return NULL;
530 }
531
Devang Patel73bc1722011-05-05 17:54:26 +0000532 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Manman Ren4c4b69c2013-10-11 23:58:05 +0000533 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000534
Eric Christopherbe2513e2013-12-03 00:45:59 +0000535 // If we have multiple ranges, emit them into the range section.
536 if (ScopeRanges.size() > 1)
537 addScopeRangeList(TheCU, ScopeDIE, ScopeRanges);
538 else {
Eric Christopher0f63d062013-12-03 00:45:45 +0000539 SmallVectorImpl<InsnRange>::const_iterator RI = ScopeRanges.begin();
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000540 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
541 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
542
543 if (StartLabel == 0 || EndLabel == 0)
544 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
545
546 assert(StartLabel->isDefined() &&
547 "Invalid starting label for an inlined scope!");
548 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
549
Eric Christopher962c9082013-01-15 23:56:56 +0000550 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
551 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patelf098ce22011-07-27 00:34:13 +0000552 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000553
554 InlinedSubprogramDIEs.insert(OriginDIE);
555
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000556 // Add the call site information to the DIE.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000557 DILocation DL(Scope->getInlinedAt());
David Blaikief2443192013-10-21 17:28:37 +0000558 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, None,
Manman Ren1e427202013-03-07 01:42:00 +0000559 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
560 TheCU->getUniqueID()));
David Blaikief2443192013-10-21 17:28:37 +0000561 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, None, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000562
Eric Christopher8dda5d02011-12-04 06:02:38 +0000563 // Add name to the name table, we do this here because we're guaranteed
564 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
565 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher6a841382012-11-19 22:42:10 +0000566
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000567 return ScopeDIE;
568}
569
Eric Christopher4287a492013-12-09 23:57:44 +0000570DIE *DwarfDebug::createScopeChildrenDIE(DwarfCompileUnit *TheCU,
571 LexicalScope *Scope,
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000572 SmallVectorImpl<DIE *> &Children) {
573 DIE *ObjectPointer = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +0000574
575 // Collect arguments for current function.
Adrian Prantl3f49c892014-02-25 19:57:42 +0000576 if (LScopes.isCurrentFunctionScope(Scope)) {
Devang Patel6c622ef2011-03-01 22:58:55 +0000577 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
578 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher6a841382012-11-19 22:42:10 +0000579 if (DIE *Arg =
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000580 TheCU->constructVariableDIE(*ArgDV, Scope->isAbstractScope())) {
Devang Patel6c622ef2011-03-01 22:58:55 +0000581 Children.push_back(Arg);
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000582 if (ArgDV->isObjectPointer())
583 ObjectPointer = Arg;
Eric Christophere3417762012-09-12 23:36:19 +0000584 }
Devang Patel6c622ef2011-03-01 22:58:55 +0000585
Adrian Prantl69140d22014-02-25 22:27:14 +0000586 // If this is a variadic function, add an unspecified parameter.
Adrian Prantl3f49c892014-02-25 19:57:42 +0000587 DISubprogram SP(Scope->getScopeNode());
Adrian Prantl3f49c892014-02-25 19:57:42 +0000588 DIArray FnArgs = SP.getType().getTypeArray();
Eric Christopher73ffdb82014-02-26 02:50:56 +0000589 if (FnArgs.getElement(FnArgs.getNumElements() - 1)
590 .isUnspecifiedParameter()) {
Adrian Prantl3f49c892014-02-25 19:57:42 +0000591 DIE *Ellipsis = new DIE(dwarf::DW_TAG_unspecified_parameters);
592 Children.push_back(Ellipsis);
593 }
594 }
595
Eric Christopherf84354b2011-10-03 15:49:16 +0000596 // Collect lexical scope children first.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000597 const SmallVectorImpl<DbgVariable *> &Variables =
598 ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000599 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000600 if (DIE *Variable = TheCU->constructVariableDIE(*Variables[i],
601 Scope->isAbstractScope())) {
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000602 Children.push_back(Variable);
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000603 if (Variables[i]->isObjectPointer())
604 ObjectPointer = Variable;
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000605 }
Craig Topper977e9cd2013-07-03 04:24:43 +0000606 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000607 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Patel3acc70e2011-08-15 22:04:40 +0000608 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000609 Children.push_back(Nested);
Manman Ren2312ed32013-09-10 18:40:41 +0000610 return ObjectPointer;
611}
612
613// Construct a DIE for this scope.
Eric Christopher4287a492013-12-09 23:57:44 +0000614DIE *DwarfDebug::constructScopeDIE(DwarfCompileUnit *TheCU,
615 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000616 if (!Scope || !Scope->getScopeNode())
617 return NULL;
618
619 DIScope DS(Scope->getScopeNode());
620
621 SmallVector<DIE *, 8> Children;
622 DIE *ObjectPointer = NULL;
623 bool ChildrenCreated = false;
624
Manman Ren5b2f4b02013-09-11 19:40:28 +0000625 // We try to create the scope DIE first, then the children DIEs. This will
626 // avoid creating un-used children then removing them later when we find out
627 // the scope DIE is null.
Devang Patel3b548aa2010-03-08 20:52:55 +0000628 DIE *ScopeDIE = NULL;
629 if (Scope->getInlinedAt())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000630 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3b548aa2010-03-08 20:52:55 +0000631 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000632 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000633 if (Scope->isAbstractScope()) {
Eric Christophere595bae2013-10-04 17:08:38 +0000634 ScopeDIE = TheCU->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000635 // Note down abstract DIE.
636 if (ScopeDIE)
637 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
David Blaikiee26a3772013-11-18 23:59:04 +0000638 } else
David Blaikie25bc7192013-11-15 23:13:08 +0000639 ScopeDIE = updateSubprogramScopeDIE(TheCU, DISubprogram(DS));
David Blaikiee26a3772013-11-18 23:59:04 +0000640 } else {
Manman Ren5b2f4b02013-09-11 19:40:28 +0000641 // Early exit when we know the scope DIE is going to be null.
Manman Ren2312ed32013-09-10 18:40:41 +0000642 if (isLexicalScopeDIENull(Scope))
643 return NULL;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000644
645 // We create children here when we know the scope DIE is not going to be
646 // null and the children will be added to the scope DIE.
Manman Ren2312ed32013-09-10 18:40:41 +0000647 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
648 ChildrenCreated = true;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000649
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000650 // There is no need to emit empty lexical block DIE.
David Blaikie684fc532013-05-06 23:33:07 +0000651 std::pair<ImportedEntityMap::const_iterator,
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000652 ImportedEntityMap::const_iterator> Range =
653 std::equal_range(
654 ScopesWithImportedEntities.begin(),
655 ScopesWithImportedEntities.end(),
656 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode *)0),
657 less_first());
David Blaikie684fc532013-05-06 23:33:07 +0000658 if (Children.empty() && Range.first == Range.second)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000659 return NULL;
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000660 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Manman Ren2312ed32013-09-10 18:40:41 +0000661 assert(ScopeDIE && "Scope DIE should not be null.");
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000662 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
663 ++i)
David Blaikie4dd2de72013-05-08 06:01:38 +0000664 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000665 }
Eric Christopher6a841382012-11-19 22:42:10 +0000666
Benjamin Kramer892daba2013-08-24 11:55:49 +0000667 if (!ScopeDIE) {
Manman Ren2312ed32013-09-10 18:40:41 +0000668 assert(Children.empty() &&
669 "We create children only when the scope DIE is not null.");
Benjamin Kramer892daba2013-08-24 11:55:49 +0000670 return NULL;
671 }
Manman Ren2312ed32013-09-10 18:40:41 +0000672 if (!ChildrenCreated)
Manman Ren5b2f4b02013-09-11 19:40:28 +0000673 // We create children when the scope DIE is not null.
Manman Ren2312ed32013-09-10 18:40:41 +0000674 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000675
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000676 // Add children
Craig Topperd8e43652013-07-03 04:17:25 +0000677 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000678 E = Children.end();
679 I != E; ++I)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000680 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000681
Eric Christophere3417762012-09-12 23:36:19 +0000682 if (DS.isSubprogram() && ObjectPointer != NULL)
Manman Ren4c4b69c2013-10-11 23:58:05 +0000683 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, ObjectPointer);
Eric Christophere3417762012-09-12 23:36:19 +0000684
Eric Christopherd9843b32011-11-10 19:25:34 +0000685 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000686}
687
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000688// Look up the source id with the given directory and source file names.
689// If none currently exists, create a new id and insert it in the
690// SourceIds map. This can update DirectoryNames and SourceFileNames maps
691// as well.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000692unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName, StringRef DirName,
693 unsigned CUID) {
Rafael Espindolab4eec1d2014-02-05 18:00:21 +0000694 // If we print assembly, we can't separate .file entries according to
Manman Ren1e427202013-03-07 01:42:00 +0000695 // compile units. Thus all files will belong to the default compile unit.
Rafael Espindolaac4ad252013-10-05 16:42:21 +0000696
697 // FIXME: add a better feature test than hasRawTextSupport. Even better,
698 // extend .file to support this.
Rafael Espindolab4eec1d2014-02-05 18:00:21 +0000699 if (Asm->OutStreamer.hasRawTextSupport())
Manman Ren1e427202013-03-07 01:42:00 +0000700 CUID = 0;
701
Devang Patel871d0b12010-09-16 20:57:49 +0000702 // If FE did not provide a file name, then assume stdin.
703 if (FileName.empty())
Manman Ren1e427202013-03-07 01:42:00 +0000704 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patele01b75c2011-03-24 20:30:50 +0000705
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000706 // TODO: this might not belong here. See if we can factor this better.
707 if (DirName == CompilationDir)
708 DirName = "";
709
Manman Ren1e427202013-03-07 01:42:00 +0000710 // FileIDCUMap stores the current ID for the given compile unit.
711 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel871d0b12010-09-16 20:57:49 +0000712
Manman Ren1e427202013-03-07 01:42:00 +0000713 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer71b19732012-03-11 14:56:26 +0000714 SmallString<128> NamePair;
Manman Ren5b22f9f2013-04-06 01:02:38 +0000715 NamePair += utostr(CUID);
Manman Ren1e427202013-03-07 01:42:00 +0000716 NamePair += '\0';
Benjamin Kramer71b19732012-03-11 14:56:26 +0000717 NamePair += DirName;
718 NamePair += '\0'; // Zero bytes are not allowed in paths.
719 NamePair += FileName;
720
721 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
722 if (Ent.getValue() != SrcId)
723 return Ent.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +0000724
Manman Ren1e427202013-03-07 01:42:00 +0000725 FileIDCUMap[CUID] = SrcId;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000726 // Print out a .file directive to specify files for .loc directives.
Manman Ren1e427202013-03-07 01:42:00 +0000727 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendling2b128d72009-05-20 23:19:06 +0000728
729 return SrcId;
730}
731
Eric Christophera5a79422013-12-09 23:32:48 +0000732void DwarfDebug::addGnuPubAttributes(DwarfUnit *U, DIE *D) const {
David Blaikie3c842622013-12-04 21:31:26 +0000733 if (!GenerateGnuPubSections)
734 return;
735
736 addSectionLabel(Asm, U, D, dwarf::DW_AT_GNU_pubnames,
737 Asm->GetTempSymbol("gnu_pubnames", U->getUniqueID()),
738 DwarfGnuPubNamesSectionSym);
739
740 addSectionLabel(Asm, U, D, dwarf::DW_AT_GNU_pubtypes,
741 Asm->GetTempSymbol("gnu_pubtypes", U->getUniqueID()),
742 DwarfGnuPubTypesSectionSym);
743}
744
Eric Christopher4287a492013-12-09 23:57:44 +0000745// Create new DwarfCompileUnit for the given metadata node with tag
Eric Christopher48fef592012-12-20 21:58:40 +0000746// DW_TAG_compile_unit.
Eric Christopher4287a492013-12-09 23:57:44 +0000747DwarfCompileUnit *DwarfDebug::constructDwarfCompileUnit(DICompileUnit DIUnit) {
Devang Patel2d9caf92009-11-25 17:36:49 +0000748 StringRef FN = DIUnit.getFilename();
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000749 CompilationDir = DIUnit.getDirectory();
Bill Wendling2b128d72009-05-20 23:19:06 +0000750
751 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher4287a492013-12-09 23:57:44 +0000752 DwarfCompileUnit *NewCU = new DwarfCompileUnit(
753 InfoHolder.getUnits().size(), Die, DIUnit, Asm, this, &InfoHolder);
David Blaikie2666e242013-12-06 19:38:46 +0000754 InfoHolder.addUnit(NewCU);
755
Manman Ren1e427202013-03-07 01:42:00 +0000756 FileIDCUMap[NewCU->getUniqueID()] = 0;
Manman Ren1e427202013-03-07 01:42:00 +0000757
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000758 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patelf20c4f72011-04-12 22:53:02 +0000759 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
760 DIUnit.getLanguage());
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000761 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christopher52ce7182013-04-09 19:23:15 +0000762
Eric Christopher52ce7182013-04-09 19:23:15 +0000763 if (!useSplitDwarf()) {
David Blaikie2494fdb2014-02-14 22:41:51 +0000764 NewCU->initStmtList(DwarfLineSectionSym);
Eric Christophera51d3fc2013-09-27 22:50:48 +0000765
766 // If we're using split dwarf the compilation dir is going to be in the
767 // skeleton CU and so we don't need to duplicate it here.
768 if (!CompilationDir.empty())
769 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
770
David Blaikie3c842622013-12-04 21:31:26 +0000771 addGnuPubAttributes(NewCU, Die);
Eric Christopher52ce7182013-04-09 19:23:15 +0000772 }
Bill Wendling2b128d72009-05-20 23:19:06 +0000773
Bill Wendling2b128d72009-05-20 23:19:06 +0000774 if (DIUnit.isOptimized())
Eric Christopherbb69a272012-08-24 01:14:27 +0000775 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendling2b128d72009-05-20 23:19:06 +0000776
Devang Patel2d9caf92009-11-25 17:36:49 +0000777 StringRef Flags = DIUnit.getFlags();
778 if (!Flags.empty())
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000779 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher6a841382012-11-19 22:42:10 +0000780
Nick Lewycky479a8fe2011-10-17 23:27:36 +0000781 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patelf20c4f72011-04-12 22:53:02 +0000782 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000783 dwarf::DW_FORM_data1, RVer);
Bill Wendling2b128d72009-05-20 23:19:06 +0000784
Devang Patel1a0df9a2010-05-10 22:49:55 +0000785 if (!FirstCU)
786 FirstCU = NewCU;
Eric Christopher7a2cdf72013-02-05 07:31:55 +0000787
Eric Christopherd4368fd2014-01-02 21:03:28 +0000788 if (useSplitDwarf()) {
789 NewCU->initSection(Asm->getObjFileLowering().getDwarfInfoDWOSection(),
790 DwarfInfoDWOSectionSym);
Eric Christopherd8667202013-12-30 17:22:27 +0000791 NewCU->setSkeleton(constructSkeletonCU(NewCU));
Eric Christopherd4368fd2014-01-02 21:03:28 +0000792 } else
793 NewCU->initSection(Asm->getObjFileLowering().getDwarfInfoSection(),
794 DwarfInfoSectionSym);
Eric Christopherd039baa2013-12-30 03:40:32 +0000795
David Blaikie5a152402013-11-15 23:52:02 +0000796 CUMap.insert(std::make_pair(DIUnit, NewCU));
Manman Rence20d462013-10-29 22:57:10 +0000797 CUDieMap.insert(std::make_pair(Die, NewCU));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000798 return NewCU;
Devang Patel1a0df9a2010-05-10 22:49:55 +0000799}
800
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000801// Construct subprogram DIE.
Eric Christopher4287a492013-12-09 23:57:44 +0000802void DwarfDebug::constructSubprogramDIE(DwarfCompileUnit *TheCU,
803 const MDNode *N) {
Eric Christopherffbc4de2013-10-18 01:57:30 +0000804 // FIXME: We should only call this routine once, however, during LTO if a
805 // program is defined in multiple CUs we could end up calling it out of
806 // beginModule as we walk the CUs.
807
Eric Christopher4287a492013-12-09 23:57:44 +0000808 DwarfCompileUnit *&CURef = SPMap[N];
Eric Christopherffbc4de2013-10-18 01:57:30 +0000809 if (CURef)
810 return;
811 CURef = TheCU;
Rafael Espindola6cf4e832011-11-04 19:00:29 +0000812
Devang Patel80ae3492009-08-28 23:24:31 +0000813 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000814 if (!SP.isDefinition())
815 // This is a method declaration which will be handled while constructing
816 // class type.
Devang Patel0751a282009-06-26 01:49:18 +0000817 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000818
Devang Patel89543712011-08-15 17:24:54 +0000819 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000820
Eric Christopherba506db2013-09-09 20:03:20 +0000821 // Expose as a global name.
Eric Christopher2c8b7902013-10-17 02:06:06 +0000822 TheCU->addGlobalName(SP.getName(), SubprogramDie, resolve(SP.getContext()));
Bill Wendling2b128d72009-05-20 23:19:06 +0000823}
824
Eric Christopher4287a492013-12-09 23:57:44 +0000825void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit *TheCU,
David Blaikief55abea2013-04-22 06:12:31 +0000826 const MDNode *N) {
David Blaikie1fd43652013-05-07 21:35:53 +0000827 DIImportedEntity Module(N);
David Blaikie5e390e42014-02-04 01:23:52 +0000828 assert(Module.Verify());
David Blaikie684fc532013-05-06 23:33:07 +0000829 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
David Blaikie4dd2de72013-05-08 06:01:38 +0000830 constructImportedEntityDIE(TheCU, Module, D);
David Blaikie684fc532013-05-06 23:33:07 +0000831}
832
Eric Christopher4287a492013-12-09 23:57:44 +0000833void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit *TheCU,
834 const MDNode *N, DIE *Context) {
David Blaikie1fd43652013-05-07 21:35:53 +0000835 DIImportedEntity Module(N);
David Blaikie5e390e42014-02-04 01:23:52 +0000836 assert(Module.Verify());
David Blaikie4dd2de72013-05-08 06:01:38 +0000837 return constructImportedEntityDIE(TheCU, Module, Context);
David Blaikie684fc532013-05-06 23:33:07 +0000838}
839
Eric Christopher4287a492013-12-09 23:57:44 +0000840void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit *TheCU,
David Blaikie1fd43652013-05-07 21:35:53 +0000841 const DIImportedEntity &Module,
David Blaikie684fc532013-05-06 23:33:07 +0000842 DIE *Context) {
843 assert(Module.Verify() &&
844 "Use one of the MDNode * overloads to handle invalid metadata");
845 assert(Context && "Should always have a context for an imported_module");
David Blaikie1fd43652013-05-07 21:35:53 +0000846 DIE *IMDie = new DIE(Module.getTag());
David Blaikief55abea2013-04-22 06:12:31 +0000847 TheCU->insertDIE(Module, IMDie);
David Blaikie1fd43652013-05-07 21:35:53 +0000848 DIE *EntityDie;
849 DIDescriptor Entity = Module.getEntity();
850 if (Entity.isNameSpace())
851 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
852 else if (Entity.isSubprogram())
853 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
David Blaikie3b6038b2013-05-08 06:01:41 +0000854 else if (Entity.isType())
855 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
David Blaikie1fd43652013-05-07 21:35:53 +0000856 else
David Blaikie3b6038b2013-05-08 06:01:41 +0000857 EntityDie = TheCU->getDIE(Entity);
David Blaikief55abea2013-04-22 06:12:31 +0000858 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
859 Module.getContext().getDirectory(),
860 TheCU->getUniqueID());
David Blaikief2443192013-10-21 17:28:37 +0000861 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, None, FileID);
862 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, None, Module.getLineNumber());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000863 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, EntityDie);
David Blaikiee63d5d12013-05-20 22:50:35 +0000864 StringRef Name = Module.getName();
865 if (!Name.empty())
866 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
David Blaikie684fc532013-05-06 23:33:07 +0000867 Context->addChild(IMDie);
David Blaikief55abea2013-04-22 06:12:31 +0000868}
869
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000870// Emit all Dwarf sections that should come prior to the content. Create
871// global DIEs and emit initial debug info sections. This is invoked by
872// the target AsmPrinter.
Eric Christopher58f41952012-11-19 22:42:15 +0000873void DwarfDebug::beginModule() {
Devang Patel6c74a872010-04-27 19:46:33 +0000874 if (DisableDebugInfoPrinting)
875 return;
876
Eric Christopher58f41952012-11-19 22:42:15 +0000877 const Module *M = MMI->getModule();
878
Nick Lewycky019d2552011-07-29 03:49:23 +0000879 // If module has named metadata anchors then use them, otherwise scan the
880 // module using debug info finder to collect debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000881 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
David Blaikiedc69ebb2013-03-11 23:39:23 +0000882 if (!CU_Nodes)
Devang Patel07bb9ee2011-08-15 23:47:24 +0000883 return;
Manman Ren60352032013-09-05 18:48:31 +0000884 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
Devang Patele02e5852011-05-03 16:45:22 +0000885
David Blaikiedc69ebb2013-03-11 23:39:23 +0000886 // Emit initial sections so we can reference labels later.
887 emitSectionLabels();
888
889 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
890 DICompileUnit CUNode(CU_Nodes->getOperand(i));
Eric Christopher4287a492013-12-09 23:57:44 +0000891 DwarfCompileUnit *CU = constructDwarfCompileUnit(CUNode);
David Blaikie1fd43652013-05-07 21:35:53 +0000892 DIArray ImportedEntities = CUNode.getImportedEntities();
893 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
David Blaikie684fc532013-05-06 23:33:07 +0000894 ScopesWithImportedEntities.push_back(std::make_pair(
David Blaikie1fd43652013-05-07 21:35:53 +0000895 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
896 ImportedEntities.getElement(i)));
David Blaikie684fc532013-05-06 23:33:07 +0000897 std::sort(ScopesWithImportedEntities.begin(),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000898 ScopesWithImportedEntities.end(), less_first());
David Blaikiedc69ebb2013-03-11 23:39:23 +0000899 DIArray GVs = CUNode.getGlobalVariables();
900 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
David Blaikiea781b25b2013-11-17 21:55:13 +0000901 CU->createGlobalVariableDIE(DIGlobalVariable(GVs.getElement(i)));
David Blaikiedc69ebb2013-03-11 23:39:23 +0000902 DIArray SPs = CUNode.getSubprograms();
903 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
904 constructSubprogramDIE(CU, SPs.getElement(i));
905 DIArray EnumTypes = CUNode.getEnumTypes();
906 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
907 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
908 DIArray RetainedTypes = CUNode.getRetainedTypes();
909 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
910 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
David Blaikief55abea2013-04-22 06:12:31 +0000911 // Emit imported_modules last so that the relevant context is already
912 // available.
David Blaikie1fd43652013-05-07 21:35:53 +0000913 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
914 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
David Blaikiedc69ebb2013-03-11 23:39:23 +0000915 }
Eric Christopher6a841382012-11-19 22:42:10 +0000916
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000917 // Tell MMI that we have debug info.
918 MMI->setDebugInfoAvailability(true);
Eric Christopher6a841382012-11-19 22:42:10 +0000919
Bill Wendling2b128d72009-05-20 23:19:06 +0000920 // Prime section data.
Richard Mitton21101b32013-09-19 23:21:01 +0000921 SectionMap[Asm->getObjFileLowering().getTextSection()];
Bill Wendling2b128d72009-05-20 23:19:06 +0000922}
923
Eric Christopher960ac372012-11-22 00:59:49 +0000924// Attach DW_AT_inline attribute with inlined subprogram DIEs.
925void DwarfDebug::computeInlinedDIEs() {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000926 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
927 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000928 AE = InlinedSubprogramDIEs.end();
929 AI != AE; ++AI) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000930 DIE *ISP = *AI;
David Blaikief2443192013-10-21 17:28:37 +0000931 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000932 }
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000933 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000934 AE = AbstractSPDies.end();
935 AI != AE; ++AI) {
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000936 DIE *ISP = AI->second;
937 if (InlinedSubprogramDIEs.count(ISP))
938 continue;
David Blaikief2443192013-10-21 17:28:37 +0000939 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000940 }
Eric Christopher960ac372012-11-22 00:59:49 +0000941}
942
943// Collect info for variables that were optimized out.
944void DwarfDebug::collectDeadVariables() {
945 const Module *M = MMI->getModule();
Eric Christopher960ac372012-11-22 00:59:49 +0000946
947 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
948 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
949 DICompileUnit TheCU(CU_Nodes->getOperand(i));
950 DIArray Subprograms = TheCU.getSubprograms();
951 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopher735401c2012-11-27 00:13:51 +0000952 DISubprogram SP(Subprograms.getElement(i));
Eric Christophera6c38a32013-10-15 23:31:38 +0000953 if (ProcessedSPNodes.count(SP) != 0)
954 continue;
955 if (!SP.isSubprogram())
956 continue;
957 if (!SP.isDefinition())
958 continue;
Eric Christopher735401c2012-11-27 00:13:51 +0000959 DIArray Variables = SP.getVariables();
Eric Christophera6c38a32013-10-15 23:31:38 +0000960 if (Variables.getNumElements() == 0)
961 continue;
Eric Christopher960ac372012-11-22 00:59:49 +0000962
Eric Christopher735401c2012-11-27 00:13:51 +0000963 // Construct subprogram DIE and add variables DIEs.
Eric Christopher4287a492013-12-09 23:57:44 +0000964 DwarfCompileUnit *SPCU =
965 static_cast<DwarfCompileUnit *>(CUMap.lookup(TheCU));
Eric Christopher735401c2012-11-27 00:13:51 +0000966 assert(SPCU && "Unable to find Compile Unit!");
Eric Christopherc798d8a2013-10-22 00:22:39 +0000967 // FIXME: See the comment in constructSubprogramDIE about duplicate
968 // subprogram DIEs.
969 constructSubprogramDIE(SPCU, SP);
970 DIE *SPDIE = SPCU->getDIE(SP);
Eric Christopher735401c2012-11-27 00:13:51 +0000971 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
972 DIVariable DV(Variables.getElement(vi));
Eric Christophera6c38a32013-10-15 23:31:38 +0000973 if (!DV.isVariable())
974 continue;
Manman Renb3388602013-10-05 01:43:03 +0000975 DbgVariable NewVar(DV, NULL, this);
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000976 if (DIE *VariableDIE = SPCU->constructVariableDIE(NewVar, false))
Eric Christophera6c38a32013-10-15 23:31:38 +0000977 SPDIE->addChild(VariableDIE);
Eric Christopher735401c2012-11-27 00:13:51 +0000978 }
Eric Christopher960ac372012-11-22 00:59:49 +0000979 }
980 }
981 }
Eric Christopher960ac372012-11-22 00:59:49 +0000982}
983
984void DwarfDebug::finalizeModuleInfo() {
985 // Collect info for variables that were optimized out.
986 collectDeadVariables();
987
988 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
989 computeInlinedDIEs();
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000990
Eric Christopherad10cb52013-12-04 23:24:38 +0000991 // Handle anything that needs to be done on a per-unit basis after
992 // all other generation.
Eric Christophera5a79422013-12-09 23:32:48 +0000993 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
994 E = getUnits().end();
David Blaikiefd1eff52013-11-26 19:14:34 +0000995 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +0000996 DwarfUnit *TheU = *I;
Eric Christopher60eb7692013-08-12 20:27:48 +0000997 // Emit DW_AT_containing_type attribute to connect types with their
998 // vtable holding type.
David Blaikie2a80e442013-12-02 22:09:48 +0000999 TheU->constructContainingTypeDIEs();
Eric Christopher60eb7692013-08-12 20:27:48 +00001000
Eric Christopher46e23432013-12-20 04:16:18 +00001001 // Add CU specific attributes if we need to add any.
1002 if (TheU->getUnitDie()->getTag() == dwarf::DW_TAG_compile_unit) {
1003 // If we're splitting the dwarf out now that we've got the entire
Eric Christopherd8667202013-12-30 17:22:27 +00001004 // CU then add the dwo id to it.
1005 DwarfCompileUnit *SkCU =
1006 static_cast<DwarfCompileUnit *>(TheU->getSkeleton());
Eric Christopher46e23432013-12-20 04:16:18 +00001007 if (useSplitDwarf()) {
1008 // This should be a unique identifier when we want to build .dwp files.
1009 uint64_t ID = 0;
1010 if (GenerateCUHash) {
Eric Christopher420569b2014-02-20 02:50:45 +00001011 DIEHash CUHash(Asm);
Eric Christopher46e23432013-12-20 04:16:18 +00001012 ID = CUHash.computeCUSignature(*TheU->getUnitDie());
1013 }
1014 TheU->addUInt(TheU->getUnitDie(), dwarf::DW_AT_GNU_dwo_id,
1015 dwarf::DW_FORM_data8, ID);
Eric Christopher46e23432013-12-20 04:16:18 +00001016 SkCU->addUInt(SkCU->getUnitDie(), dwarf::DW_AT_GNU_dwo_id,
1017 dwarf::DW_FORM_data8, ID);
Eric Christopherd29614f2013-08-13 01:21:55 +00001018 }
Eric Christopherd8667202013-12-30 17:22:27 +00001019
Eric Christopher39cde8c2014-01-14 22:44:17 +00001020 // If we have code split among multiple sections or we've requested
1021 // it then emit a DW_AT_ranges attribute on the unit that will remain
1022 // in the .o file, otherwise add a DW_AT_low_pc.
Eric Christopherd8667202013-12-30 17:22:27 +00001023 // FIXME: Also add a high pc if we can.
Eric Christopher39cde8c2014-01-14 22:44:17 +00001024 // FIXME: We should use ranges if we have multiple compile units or
1025 // allow reordering of code ala .subsections_via_symbols in mach-o.
Eric Christopherd8667202013-12-30 17:22:27 +00001026 DwarfCompileUnit *U = SkCU ? SkCU : static_cast<DwarfCompileUnit *>(TheU);
Eric Christopher8873ada2014-01-29 22:22:56 +00001027 if (useCURanges() && TheU->getRanges().size()) {
Eric Christopherd8667202013-12-30 17:22:27 +00001028 addSectionLabel(Asm, U, U->getUnitDie(), dwarf::DW_AT_ranges,
1029 Asm->GetTempSymbol("cu_ranges", U->getUniqueID()),
1030 DwarfDebugRangeSectionSym);
Eric Christopher8873ada2014-01-29 22:22:56 +00001031
1032 // A DW_AT_low_pc attribute may also be specified in combination with
1033 // DW_AT_ranges to specify the default base address for use in location
1034 // lists (see Section 2.6.2) and range lists (see Section 2.17.3).
1035 U->addUInt(U->getUnitDie(), dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1036 0);
1037 } else
Eric Christophercf48ade2014-01-24 11:52:53 +00001038 U->addUInt(U->getUnitDie(), dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1039 0);
Eric Christopher60eb7692013-08-12 20:27:48 +00001040 }
1041 }
1042
1043 // Compute DIE offsets and sizes.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001044 InfoHolder.computeSizeAndOffsets();
1045 if (useSplitDwarf())
1046 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher960ac372012-11-22 00:59:49 +00001047}
1048
1049void DwarfDebug::endSections() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001050 // Filter labels by section.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001051 for (size_t n = 0; n < ArangeLabels.size(); n++) {
1052 const SymbolCU &SCU = ArangeLabels[n];
Richard Mitton21101b32013-09-19 23:21:01 +00001053 if (SCU.Sym->isInSection()) {
1054 // Make a note of this symbol and it's section.
1055 const MCSection *Section = &SCU.Sym->getSection();
1056 if (!Section->getKind().isMetadata())
1057 SectionMap[Section].push_back(SCU);
1058 } else {
1059 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1060 // appear in the output. This sucks as we rely on sections to build
1061 // arange spans. We can do it without, but it's icky.
1062 SectionMap[NULL].push_back(SCU);
1063 }
1064 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001065
Richard Mittonc2508242013-10-03 22:07:08 +00001066 // Build a list of sections used.
1067 std::vector<const MCSection *> Sections;
Richard Mitton21101b32013-09-19 23:21:01 +00001068 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1069 it++) {
1070 const MCSection *Section = it->first;
Richard Mittonc2508242013-10-03 22:07:08 +00001071 Sections.push_back(Section);
1072 }
1073
1074 // Sort the sections into order.
1075 // This is only done to ensure consistent output order across different runs.
1076 std::sort(Sections.begin(), Sections.end(), SectionSort);
1077
1078 // Add terminating symbols for each section.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001079 for (unsigned ID = 0; ID < Sections.size(); ID++) {
Richard Mittonc2508242013-10-03 22:07:08 +00001080 const MCSection *Section = Sections[ID];
Richard Mitton21101b32013-09-19 23:21:01 +00001081 MCSymbol *Sym = NULL;
1082
1083 if (Section) {
Richard Mittonc2508242013-10-03 22:07:08 +00001084 // We can't call MCSection::getLabelEndName, as it's only safe to do so
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001085 // if we know the section name up-front. For user-created sections, the
Eric Christopher95531b62014-01-29 22:06:21 +00001086 // resulting label may not be valid to use as a label. (section names can
1087 // use a greater set of characters on some systems)
Richard Mittonc2508242013-10-03 22:07:08 +00001088 Sym = Asm->GetTempSymbol("debug_end", ID);
Richard Mitton21101b32013-09-19 23:21:01 +00001089 Asm->OutStreamer.SwitchSection(Section);
1090 Asm->OutStreamer.EmitLabel(Sym);
1091 }
1092
1093 // Insert a final terminator.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001094 SectionMap[Section].push_back(SymbolCU(NULL, Sym));
Bill Wendling2b128d72009-05-20 23:19:06 +00001095 }
Eric Christopher1bca60d2014-01-23 22:55:47 +00001096
1097 // For now only turn on CU ranges if we've explicitly asked for it,
Eric Christopherfb8dd002014-01-29 22:06:27 +00001098 // we have -ffunction-sections enabled, we've emitted a function
1099 // into a unique section, or we're using LTO. If we're using LTO then
1100 // we can't know that any particular function in the module is correlated
1101 // to a particular CU and so we need to be conservative. At this point all
1102 // sections should be finalized except for dwarf sections.
1103 HasCURanges = DwarfCURanges || UsedNonDefaultText || (CUMap.size() > 1) ||
Eric Christopher1bca60d2014-01-23 22:55:47 +00001104 TargetMachine::getFunctionSections();
Eric Christopher960ac372012-11-22 00:59:49 +00001105}
Bill Wendling2b128d72009-05-20 23:19:06 +00001106
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001107// Emit all Dwarf sections that should come after the content.
Eric Christopher960ac372012-11-22 00:59:49 +00001108void DwarfDebug::endModule() {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001109 assert(CurFn == 0);
1110 assert(CurMI == 0);
Eric Christopher960ac372012-11-22 00:59:49 +00001111
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001112 if (!FirstCU)
1113 return;
Eric Christopher960ac372012-11-22 00:59:49 +00001114
1115 // End any existing sections.
1116 // TODO: Does this need to happen?
1117 endSections();
1118
1119 // Finalize the debug info for the module.
1120 finalizeModuleInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001121
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001122 emitDebugStr();
Eric Christopher9cd26af2013-09-20 23:22:52 +00001123
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001124 // Emit all the DIEs into a debug info section.
1125 emitDebugInfo();
Eric Christopher4c9b1192012-11-27 00:41:54 +00001126
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001127 // Corresponding abbreviations into a abbrev section.
1128 emitAbbreviations();
Eric Christopher95198f502012-11-27 22:43:42 +00001129
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001130 // Emit info into a debug loc section.
1131 emitDebugLoc();
Eric Christopher95198f502012-11-27 22:43:42 +00001132
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001133 // Emit info into a debug aranges section.
Eric Christopher02dbadb2014-02-14 01:26:55 +00001134 if (GenerateARangeSection)
1135 emitDebugARanges();
Eric Christopher95198f502012-11-27 22:43:42 +00001136
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001137 // Emit info into a debug ranges section.
1138 emitDebugRanges();
Eric Christopher95198f502012-11-27 22:43:42 +00001139
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001140 if (useSplitDwarf()) {
1141 emitDebugStrDWO();
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001142 emitDebugInfoDWO();
Eric Christopher3c5a1912012-12-19 22:02:53 +00001143 emitDebugAbbrevDWO();
Eric Christopher962c9082013-01-15 23:56:56 +00001144 // Emit DWO addresses.
1145 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
Eric Christopher95198f502012-11-27 22:43:42 +00001146 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001147
Eric Christophera876b822012-08-23 07:32:06 +00001148 // Emit info into the dwarf accelerator table sections.
Eric Christopher20b76a72012-08-23 22:36:40 +00001149 if (useDwarfAccelTables()) {
Eric Christopher4996c702011-11-07 09:24:32 +00001150 emitAccelNames();
1151 emitAccelObjC();
1152 emitAccelNamespaces();
1153 emitAccelTypes();
1154 }
Eric Christopher6a841382012-11-19 22:42:10 +00001155
Eric Christopher4b358182013-08-30 00:40:17 +00001156 // Emit the pubnames and pubtypes sections if requested.
1157 if (HasDwarfPubSections) {
David Blaikie70a33202013-09-19 17:33:35 +00001158 emitDebugPubNames(GenerateGnuPubSections);
1159 emitDebugPubTypes(GenerateGnuPubSections);
Eric Christopher4b358182013-08-30 00:40:17 +00001160 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001161
Devang Pateld0701282010-08-02 17:32:15 +00001162 // clean up.
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001163 SPMap.clear();
Eric Christopher8afd7b62012-12-10 19:51:18 +00001164
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001165 // Reset these for the next Module if we have one.
1166 FirstCU = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001167}
1168
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001169// Find abstract variable, if any, associated with Var.
Devang Patelbb23a4a2011-08-10 21:50:54 +00001170DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattner915c5f92010-04-02 19:42:39 +00001171 DebugLoc ScopeLoc) {
Devang Patelbb23a4a2011-08-10 21:50:54 +00001172 LLVMContext &Ctx = DV->getContext();
1173 // More then one inlined variable corresponds to one abstract variable.
1174 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001175 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001176 if (AbsDbgVariable)
1177 return AbsDbgVariable;
1178
Devang Patel7e623022011-08-10 20:55:27 +00001179 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001180 if (!Scope)
1181 return NULL;
1182
Manman Renb3388602013-10-05 01:43:03 +00001183 AbsDbgVariable = new DbgVariable(Var, NULL, this);
Devang Patel7e623022011-08-10 20:55:27 +00001184 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001185 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001186 return AbsDbgVariable;
1187}
1188
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001189// If Var is a current function argument then add it to CurrentFnArguments list.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001190bool DwarfDebug::addCurrentFnArgument(DbgVariable *Var, LexicalScope *Scope) {
Devang Patel7e623022011-08-10 20:55:27 +00001191 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +00001192 return false;
1193 DIVariable DV = Var->getVariable();
1194 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1195 return false;
1196 unsigned ArgNo = DV.getArgNumber();
Eric Christopher6a841382012-11-19 22:42:10 +00001197 if (ArgNo == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001198 return false;
1199
Devang Patel4ab660b2011-03-03 20:02:02 +00001200 size_t Size = CurrentFnArguments.size();
1201 if (Size == 0)
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001202 CurrentFnArguments.resize(CurFn->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001203 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001204 // arguments does the function have at source level.
1205 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001206 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001207 CurrentFnArguments[ArgNo - 1] = Var;
1208 return true;
1209}
1210
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001211// Collect variable information from side table maintained by MMI.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001212void DwarfDebug::collectVariableInfoFromMMITable(
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001213 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001214 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1215 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001216 VE = VMap.end();
1217 VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001218 const MDNode *Var = VI->first;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001219 if (!Var)
1220 continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001221 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001222 DIVariable DV(Var);
1223 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001224
Devang Patel7e623022011-08-10 20:55:27 +00001225 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001226
Devang Patelcdb7d442009-11-10 23:20:04 +00001227 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001228 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001229 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001230
Devang Patele1c53f22010-05-20 16:36:41 +00001231 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Manman Renb3388602013-10-05 01:43:03 +00001232 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
Devang Patel3e4a9652011-08-15 21:24:36 +00001233 RegVar->setFrameIndex(VP.first);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001234 if (!addCurrentFnArgument(RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001235 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001236 if (AbsDbgVariable)
Devang Patel3e4a9652011-08-15 21:24:36 +00001237 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patel475d32a2009-10-06 01:26:37 +00001238 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001239}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001240
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001241// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1242// defined reg.
Devang Patel9fc11702010-05-25 23:40:22 +00001243static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001244 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001245 return MI->getNumOperands() == 3 && MI->getOperand(0).isReg() &&
1246 MI->getOperand(0).getReg() &&
Adrian Prantl418d1d12013-07-09 20:28:37 +00001247 (MI->getOperand(1).isImm() ||
1248 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
Devang Patel9fc11702010-05-25 23:40:22 +00001249}
1250
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001251// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher6a841382012-11-19 22:42:10 +00001252static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1253 const MCSymbol *FLabel,
Devang Patel2442a892011-07-08 17:09:57 +00001254 const MCSymbol *SLabel,
1255 const MachineInstr *MI) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001256 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Devang Patel2442a892011-07-08 17:09:57 +00001257
David Blaikie0252265b2013-06-16 20:34:15 +00001258 assert(MI->getNumOperands() == 3);
Adrian Prantl418d1d12013-07-09 20:28:37 +00001259 if (MI->getOperand(0).isReg()) {
Devang Patel2442a892011-07-08 17:09:57 +00001260 MachineLocation MLoc;
Adrian Prantl418d1d12013-07-09 20:28:37 +00001261 // If the second operand is an immediate, this is a
1262 // register-indirect address.
1263 if (!MI->getOperand(1).isImm())
Adrian Prantld4c0dd42013-04-26 21:57:17 +00001264 MLoc.set(MI->getOperand(0).getReg());
1265 else
1266 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel2442a892011-07-08 17:09:57 +00001267 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1268 }
1269 if (MI->getOperand(0).isImm())
1270 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1271 if (MI->getOperand(0).isFPImm())
1272 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1273 if (MI->getOperand(0).isCImm())
1274 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1275
Craig Topperee4dab52012-02-05 08:31:47 +00001276 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel2442a892011-07-08 17:09:57 +00001277}
1278
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001279// Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001280void
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001281DwarfDebug::collectVariableInfo(SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001282
Eric Christopher270a12c2013-07-03 21:37:03 +00001283 // Grab the variable info that was squirreled away in the MMI side-table.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001284 collectVariableInfoFromMMITable(Processed);
Devang Patel490c8ab2010-05-20 19:57:06 +00001285
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001286 for (SmallVectorImpl<const MDNode *>::const_iterator
1287 UVI = UserVariables.begin(),
1288 UVE = UserVariables.end();
1289 UVI != UVE; ++UVI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001290 const MDNode *Var = *UVI;
1291 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001292 continue;
1293
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001294 // History contains relevant DBG_VALUE instructions for Var and instructions
1295 // clobbering it.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001296 SmallVectorImpl<const MachineInstr *> &History = DbgValues[Var];
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001297 if (History.empty())
1298 continue;
1299 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001300
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001301 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001302 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001303 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001304 DISubprogram(DV.getContext()).describes(CurFn->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +00001305 Scope = LScopes.getCurrentFunctionScope();
David Blaikiedc69ebb2013-03-11 23:39:23 +00001306 else if (MDNode *IA = DV.getInlinedAt())
1307 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1308 else
1309 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel490c8ab2010-05-20 19:57:06 +00001310 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001311 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001312 continue;
1313
1314 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001315 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel99819b52011-08-15 19:01:20 +00001316 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
Manman Renb3388602013-10-05 01:43:03 +00001317 DbgVariable *RegVar = new DbgVariable(DV, AbsVar, this);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001318 if (!addCurrentFnArgument(RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001319 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001320 if (AbsVar)
Devang Patel3e4a9652011-08-15 21:24:36 +00001321 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001322
Eric Christophercc10d202012-10-08 20:48:54 +00001323 // Simplify ranges that are fully coalesced.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001324 if (History.size() <= 1 ||
1325 (History.size() == 2 && MInsn->isIdenticalTo(History.back()))) {
Devang Patel3e4a9652011-08-15 21:24:36 +00001326 RegVar->setMInsn(MInsn);
Devang Patel9fc11702010-05-25 23:40:22 +00001327 continue;
1328 }
1329
Eric Christopher59cc0712013-01-28 17:33:26 +00001330 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001331 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001332
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001333 for (SmallVectorImpl<const MachineInstr *>::const_iterator
1334 HI = History.begin(),
1335 HE = History.end();
1336 HI != HE; ++HI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001337 const MachineInstr *Begin = *HI;
1338 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001339
Devang Patele7181b52011-06-01 23:00:17 +00001340 // Check if DBG_VALUE is truncating a range.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001341 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg() &&
1342 !Begin->getOperand(0).getReg())
Devang Patele7181b52011-06-01 23:00:17 +00001343 continue;
1344
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001345 // Compute the range for a register location.
1346 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1347 const MCSymbol *SLabel = 0;
1348
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001349 if (HI + 1 == HE)
1350 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001351 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001352 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001353 else {
1354 const MachineInstr *End = HI[1];
Eric Christopher6a841382012-11-19 22:42:10 +00001355 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001356 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001357 if (End->isDebugValue())
1358 SLabel = getLabelBeforeInsn(End);
1359 else {
1360 // End is a normal instruction clobbering the range.
1361 SLabel = getLabelAfterInsn(End);
1362 assert(SLabel && "Forgot label after clobber instruction");
1363 ++HI;
1364 }
1365 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001366
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001367 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001368 DotDebugLocEntries.push_back(
1369 getDebugLocEntry(Asm, FLabel, SLabel, Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001370 }
1371 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001372 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001373
1374 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001375 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1376 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1377 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1378 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001379 if (!DV || !DV.isVariable() || !Processed.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001380 continue;
1381 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001382 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patele0a94bf2010-05-14 21:01:35 +00001383 }
Devang Patel9fc11702010-05-25 23:40:22 +00001384}
Devang Patele0a94bf2010-05-14 21:01:35 +00001385
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001386// Return Label preceding the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001387MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001388 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1389 assert(Label && "Didn't insert label before instruction");
1390 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001391}
1392
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001393// Return Label immediately following the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001394MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001395 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001396}
1397
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001398// Process beginning of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001399void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001400 assert(CurMI == 0);
1401 CurMI = MI;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001402 // Check if source location changes, but ignore DBG_VALUE locations.
1403 if (!MI->isDebugValue()) {
1404 DebugLoc DL = MI->getDebugLoc();
1405 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopheraec8a822012-04-05 20:39:05 +00001406 unsigned Flags = 0;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001407 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001408 if (DL == PrologEndLoc) {
1409 Flags |= DWARF2_FLAG_PROLOGUE_END;
1410 PrologEndLoc = DebugLoc();
1411 }
Eric Christopheraec8a822012-04-05 20:39:05 +00001412 if (PrologEndLoc.isUnknown())
1413 Flags |= DWARF2_FLAG_IS_STMT;
1414
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001415 if (!DL.isUnknown()) {
1416 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001417 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001418 } else
Devang Patel34a66202011-05-11 19:22:19 +00001419 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001420 }
Devang Patel9fc11702010-05-25 23:40:22 +00001421 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001422
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001423 // Insert labels where requested.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001424 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
1425 LabelsBeforeInsn.find(MI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001426
1427 // No label needed.
1428 if (I == LabelsBeforeInsn.end())
1429 return;
1430
1431 // Label already assigned.
1432 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001433 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001434
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001435 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001436 PrevLabel = MMI->getContext().CreateTempSymbol();
1437 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001438 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001439 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001440}
1441
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001442// Process end of an instruction.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001443void DwarfDebug::endInstruction() {
1444 assert(CurMI != 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001445 // Don't create a new label after DBG_VALUE instructions.
1446 // They don't generate code.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001447 if (!CurMI->isDebugValue())
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001448 PrevLabel = 0;
1449
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001450 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001451 LabelsAfterInsn.find(CurMI);
1452 CurMI = 0;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001453
1454 // No label needed.
1455 if (I == LabelsAfterInsn.end())
1456 return;
1457
1458 // Label already assigned.
1459 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001460 return;
1461
1462 // We need a label after this instruction.
1463 if (!PrevLabel) {
1464 PrevLabel = MMI->getContext().CreateTempSymbol();
1465 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001466 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001467 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001468}
1469
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001470// Each LexicalScope has first instruction and last instruction to mark
1471// beginning and end of a scope respectively. Create an inverse map that list
1472// scopes starts (and ends) with an instruction. One instruction may start (or
1473// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001474void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001475 SmallVector<LexicalScope *, 4> WorkList;
1476 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001477 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001478 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001479
Craig Topper977e9cd2013-07-03 04:24:43 +00001480 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001481 if (!Children.empty())
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001482 for (SmallVectorImpl<LexicalScope *>::const_iterator
1483 SI = Children.begin(),
1484 SE = Children.end();
1485 SI != SE; ++SI)
Devang Patel7771b7c2010-01-20 02:05:23 +00001486 WorkList.push_back(*SI);
1487
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001488 if (S->isAbstractScope())
1489 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001490
Craig Topper977e9cd2013-07-03 04:24:43 +00001491 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001492 if (Ranges.empty())
1493 continue;
Craig Topperd8e43652013-07-03 04:17:25 +00001494 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001495 RE = Ranges.end();
1496 RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001497 assert(RI->first && "InsnRange does not have first instruction!");
1498 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001499 requestLabelBeforeInsn(RI->first);
1500 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001501 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001502 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001503}
1504
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001505// Gather pre-function debug information. Assumes being called immediately
1506// after the function entry point has been emitted.
Chris Lattner76555b52010-01-26 23:18:02 +00001507void DwarfDebug::beginFunction(const MachineFunction *MF) {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001508 CurFn = MF;
Eric Christopherfedfa442013-11-01 23:14:17 +00001509
1510 // If there's no debug info for the function we're not going to do anything.
1511 if (!MMI->hasDebugInfo())
1512 return;
1513
1514 // Grab the lexical scopes for the function, if we don't have any of those
1515 // then we're not going to be able to do anything.
Devang Patel7e623022011-08-10 20:55:27 +00001516 LScopes.initialize(*MF);
Eric Christopherfedfa442013-11-01 23:14:17 +00001517 if (LScopes.empty())
1518 return;
1519
1520 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1521
1522 // Make sure that each lexical scope will have a begin/end label.
Devang Patel7e623022011-08-10 20:55:27 +00001523 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001524
Eric Christopher4287a492013-12-09 23:57:44 +00001525 // Set DwarfDwarfCompileUnitID in MCContext to the Compile Unit this function
Eric Christopherfedfa442013-11-01 23:14:17 +00001526 // belongs to so that we add to the correct per-cu line table in the
1527 // non-asm case.
Manman Ren4e042a62013-02-05 21:52:47 +00001528 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Eric Christopher4287a492013-12-09 23:57:44 +00001529 DwarfCompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Manman Ren4e042a62013-02-05 21:52:47 +00001530 assert(TheCU && "Unable to find compile unit!");
Rafael Espindolab4eec1d2014-02-05 18:00:21 +00001531 if (Asm->OutStreamer.hasRawTextSupport())
1532 // Use a single line table if we are generating assembly.
Manman Ren9d4c7352013-05-21 00:57:22 +00001533 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1534 else
1535 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
Manman Ren4e042a62013-02-05 21:52:47 +00001536
Eric Christopher2037caf2014-01-28 00:49:26 +00001537 // Check the current section against the standard text section. If different
1538 // keep track so that we will know when we're emitting functions into multiple
1539 // sections.
1540 if (Asm->getObjFileLowering().getTextSection() != Asm->getCurrentSection())
1541 UsedNonDefaultText = true;
1542
Eric Christopherfedfa442013-11-01 23:14:17 +00001543 // Emit a label for the function so that we have a beginning address.
1544 FunctionBeginSym = Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001545 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001546 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001547
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001548 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001549 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Eric Christopherfedfa442013-11-01 23:14:17 +00001550 std::vector<const MDNode *> LiveUserVar(TRI->getNumRegs());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001551
Eric Christopherfedfa442013-11-01 23:14:17 +00001552 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end(); I != E;
1553 ++I) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001554 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001555 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1556 II != IE; ++II) {
1557 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001558
Devang Patel002d54d2010-05-26 19:37:24 +00001559 if (MI->isDebugValue()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001560 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001561
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001562 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001563 const MDNode *Var =
Eric Christopherfedfa442013-11-01 23:14:17 +00001564 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001565
1566 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001567 if (isDbgValueInDefinedReg(MI))
1568 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1569
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001570 // Check the history of this variable.
Eric Christopherfedfa442013-11-01 23:14:17 +00001571 SmallVectorImpl<const MachineInstr *> &History = DbgValues[Var];
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001572 if (History.empty()) {
1573 UserVariables.push_back(Var);
1574 // The first mention of a function argument gets the FunctionBeginSym
1575 // label, so arguments are visible when breaking at function entry.
1576 DIVariable DV(Var);
Manman Ren7504ed42013-07-08 18:33:29 +00001577 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
David Blaikie5af2aca2013-11-18 23:57:26 +00001578 getDISubprogram(DV.getContext()).describes(MF->getFunction()))
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001579 LabelsBeforeInsn[MI] = FunctionBeginSym;
1580 } else {
1581 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1582 const MachineInstr *Prev = History.back();
1583 if (Prev->isDebugValue()) {
1584 // Coalesce identical entries at the end of History.
1585 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001586 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher85a495e2012-10-08 20:48:49 +00001587 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopherfedfa442013-11-01 23:14:17 +00001588 << "\t" << *Prev << "\t"
1589 << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001590 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001591 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001592
1593 // Terminate old register assignments that don't reach MI;
1594 MachineFunction::const_iterator PrevMBB = Prev->getParent();
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +00001595 if (PrevMBB != I && (!AtBlockEntry || std::next(PrevMBB) != I) &&
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001596 isDbgValueInDefinedReg(Prev)) {
1597 // Previous register assignment needs to terminate at the end of
1598 // its basic block.
1599 MachineBasicBlock::const_iterator LastMI =
Eric Christopherfedfa442013-11-01 23:14:17 +00001600 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001601 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001602 // Drop DBG_VALUE for empty range.
Eric Christopher85a495e2012-10-08 20:48:49 +00001603 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Eric Christopherfedfa442013-11-01 23:14:17 +00001604 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001605 History.pop_back();
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +00001606 } else if (std::next(PrevMBB) != PrevMBB->getParent()->end())
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001607 // Terminate after LastMI.
1608 History.push_back(LastMI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001609 }
1610 }
1611 }
1612 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001613 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001614 // Not a DBG_VALUE instruction.
1615 if (!MI->isLabel())
1616 AtBlockEntry = false;
1617
Eric Christopher133195782012-10-04 20:46:14 +00001618 // First known non-DBG_VALUE and non-frame setup location marks
1619 // the beginning of the function body.
1620 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1621 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel34a66202011-05-11 19:22:19 +00001622 PrologEndLoc = MI->getDebugLoc();
1623
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001624 // Check if the instruction clobbers any registers with debug vars.
1625 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
Eric Christopherfedfa442013-11-01 23:14:17 +00001626 MOE = MI->operands_end();
1627 MOI != MOE; ++MOI) {
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001628 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1629 continue;
Eric Christopherfedfa442013-11-01 23:14:17 +00001630 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true); AI.isValid();
1631 ++AI) {
Jakob Stoklund Olesen54038d72012-06-01 23:28:30 +00001632 unsigned Reg = *AI;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001633 const MDNode *Var = LiveUserVar[Reg];
1634 if (!Var)
1635 continue;
1636 // Reg is now clobbered.
1637 LiveUserVar[Reg] = 0;
1638
1639 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001640 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1641 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001642 continue;
Eric Christopherfedfa442013-11-01 23:14:17 +00001643 SmallVectorImpl<const MachineInstr *> &History = HistI->second;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001644 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001645 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001646 const MachineInstr *Prev = History.back();
1647 // Sanity-check: Register assignments are terminated at the end of
1648 // their block.
1649 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1650 continue;
1651 // Is the variable still in Reg?
1652 if (!isDbgValueInDefinedReg(Prev) ||
1653 Prev->getOperand(0).getReg() != Reg)
1654 continue;
1655 // Var is clobbered. Make sure the next instruction gets a label.
1656 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001657 }
1658 }
Devang Patel002d54d2010-05-26 19:37:24 +00001659 }
Devang Patel002d54d2010-05-26 19:37:24 +00001660 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001661 }
1662
1663 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1664 I != E; ++I) {
Eric Christopherfedfa442013-11-01 23:14:17 +00001665 SmallVectorImpl<const MachineInstr *> &History = I->second;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001666 if (History.empty())
1667 continue;
1668
1669 // Make sure the final register assignments are terminated.
1670 const MachineInstr *Prev = History.back();
1671 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1672 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher6a841382012-11-19 22:42:10 +00001673 MachineBasicBlock::const_iterator LastMI =
Eric Christopherfedfa442013-11-01 23:14:17 +00001674 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001675 if (LastMI == PrevMBB->end())
1676 // Drop DBG_VALUE for empty range.
1677 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001678 else if (PrevMBB != &PrevMBB->getParent()->back()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001679 // Terminate after LastMI.
1680 History.push_back(LastMI);
1681 }
1682 }
1683 // Request labels for the full history.
1684 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1685 const MachineInstr *MI = History[i];
1686 if (MI->isDebugValue())
1687 requestLabelBeforeInsn(MI);
1688 else
1689 requestLabelAfterInsn(MI);
1690 }
1691 }
Devang Patel002d54d2010-05-26 19:37:24 +00001692
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001693 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001694 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001695
1696 // Record beginning of function.
1697 if (!PrologEndLoc.isUnknown()) {
Eric Christopherfedfa442013-11-01 23:14:17 +00001698 DebugLoc FnStartDL =
Timur Iskhodzhanovf166f6c2014-01-30 01:39:17 +00001699 PrologEndLoc.getFnDebugLoc(MF->getFunction()->getContext());
Eric Christopherfedfa442013-11-01 23:14:17 +00001700 recordSourceLine(
1701 FnStartDL.getLine(), FnStartDL.getCol(),
1702 FnStartDL.getScope(MF->getFunction()->getContext()),
1703 // We'd like to list the prologue as "not statements" but GDB behaves
1704 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
1705 DWARF2_FLAG_IS_STMT);
Devang Patel34a66202011-05-11 19:22:19 +00001706 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001707}
1708
Devang Patel7e623022011-08-10 20:55:27 +00001709void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
David Blaikie6f1a8062013-06-05 05:39:59 +00001710 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1711 DIVariable DV = Var->getVariable();
David Blaikie36d5d2f2013-06-06 21:04:51 +00001712 // Variables with positive arg numbers are parameters.
1713 if (unsigned ArgNum = DV.getArgNumber()) {
1714 // Keep all parameters in order at the start of the variable list to ensure
1715 // function types are correct (no out-of-order parameters)
1716 //
1717 // This could be improved by only doing it for optimized builds (unoptimized
1718 // builds have the right order to begin with), searching from the back (this
1719 // would catch the unoptimized case quickly), or doing a binary search
1720 // rather than linear search.
1721 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1722 while (I != Vars.end()) {
1723 unsigned CurNum = (*I)->getVariable().getArgNumber();
1724 // A local (non-parameter) variable has been found, insert immediately
1725 // before it.
1726 if (CurNum == 0)
1727 break;
1728 // A later indexed parameter has been found, insert immediately before it.
David Blaikieb272a752013-06-06 22:28:26 +00001729 if (CurNum > ArgNum)
David Blaikie36d5d2f2013-06-06 21:04:51 +00001730 break;
David Blaikieb272a752013-06-06 22:28:26 +00001731 ++I;
David Blaikie6f1a8062013-06-05 05:39:59 +00001732 }
David Blaikie36d5d2f2013-06-06 21:04:51 +00001733 Vars.insert(I, Var);
1734 return;
David Blaikie6f1a8062013-06-05 05:39:59 +00001735 }
1736
1737 Vars.push_back(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001738}
1739
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001740// Gather and emit post-function debug information.
NAKAMURA Takumib9271612013-12-03 13:15:54 +00001741void DwarfDebug::endFunction(const MachineFunction *MF) {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001742 // Every beginFunction(MF) call should be followed by an endFunction(MF) call,
1743 // though the beginFunction may not be called at all.
1744 // We should handle both cases.
1745 if (CurFn == 0)
1746 CurFn = MF;
1747 else
1748 assert(CurFn == MF);
1749 assert(CurFn != 0);
1750
1751 if (!MMI->hasDebugInfo() || LScopes.empty()) {
1752 CurFn = 0;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001753 return;
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001754 }
Devang Patel2904aa92009-11-12 19:02:56 +00001755
Devang Patel7e623022011-08-10 20:55:27 +00001756 // Define end label for subprogram.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001757 FunctionEndSym = Asm->GetTempSymbol("func_end", Asm->getFunctionNumber());
Devang Patel7e623022011-08-10 20:55:27 +00001758 // Assumes in correct section after the entry point.
1759 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Eric Christopher1a972152014-01-29 23:05:43 +00001760
Eric Christopher4287a492013-12-09 23:57:44 +00001761 // Set DwarfDwarfCompileUnitID in MCContext to default value.
Manman Ren4e042a62013-02-05 21:52:47 +00001762 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher6a841382012-11-19 22:42:10 +00001763
Devang Patel7e623022011-08-10 20:55:27 +00001764 SmallPtrSet<const MDNode *, 16> ProcessedVars;
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001765 collectVariableInfo(ProcessedVars);
Eric Christopher6a841382012-11-19 22:42:10 +00001766
Devang Patel3acc70e2011-08-15 22:04:40 +00001767 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Eric Christopher4287a492013-12-09 23:57:44 +00001768 DwarfCompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001769 assert(TheCU && "Unable to find compile unit!");
Devang Patel3acc70e2011-08-15 22:04:40 +00001770
Devang Patel7e623022011-08-10 20:55:27 +00001771 // Construct abstract scopes.
Devang Patel44403472011-08-12 18:10:19 +00001772 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1773 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1774 LexicalScope *AScope = AList[i];
1775 DISubprogram SP(AScope->getScopeNode());
Manman Ren7504ed42013-07-08 18:33:29 +00001776 if (SP.isSubprogram()) {
Devang Patel7e623022011-08-10 20:55:27 +00001777 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001778 DIArray Variables = SP.getVariables();
1779 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1780 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001781 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001782 continue;
Alexey Samsonov39602782012-07-06 08:45:08 +00001783 // Check that DbgVariable for DV wasn't created earlier, when
1784 // findAbstractVariable() was called for inlined instance of DV.
1785 LLVMContext &Ctx = DV->getContext();
1786 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1787 if (AbstractVariables.lookup(CleanDV))
1788 continue;
Devang Patel59e27c52011-08-19 23:28:12 +00001789 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001790 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001791 }
1792 }
Devang Patel44403472011-08-12 18:10:19 +00001793 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Manman Ren4213c392013-05-29 17:16:59 +00001794 constructScopeDIE(TheCU, AScope);
Bill Wendling2b128d72009-05-20 23:19:06 +00001795 }
Eric Christopher6a841382012-11-19 22:42:10 +00001796
Devang Patel3acc70e2011-08-15 22:04:40 +00001797 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001798 if (!CurFn->getTarget().Options.DisableFramePointerElim(*CurFn))
Eric Christopherbb69a272012-08-24 01:14:27 +00001799 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Patel3acc70e2011-08-15 22:04:40 +00001800
Eric Christopher1a972152014-01-29 23:05:43 +00001801 // Add the range of this function to the list of ranges for the CU.
1802 RangeSpan Span(FunctionBeginSym, FunctionEndSym);
Chandler Carruth002da5d2014-03-02 04:08:41 +00001803 TheCU->addRange(std::move(Span));
Eric Christopher1a972152014-01-29 23:05:43 +00001804
Bill Wendling2b128d72009-05-20 23:19:06 +00001805 // Clear debug info
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001806 for (ScopeVariablesMap::iterator I = ScopeVariables.begin(),
1807 E = ScopeVariables.end();
1808 I != E; ++I)
Devang Patel7e623022011-08-10 20:55:27 +00001809 DeleteContainerPointers(I->second);
1810 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001811 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001812 UserVariables.clear();
1813 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001814 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001815 LabelsBeforeInsn.clear();
1816 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001817 PrevLabel = NULL;
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001818 CurFn = 0;
Bill Wendling2b128d72009-05-20 23:19:06 +00001819}
1820
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001821// Register a source line with debug info. Returns the unique label that was
1822// emitted and which provides correspondence to the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00001823void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1824 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00001825 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00001826 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00001827 unsigned Src = 1;
Diego Novillo282450d2014-03-03 18:53:17 +00001828 unsigned Discriminator = 0;
Dan Gohman50849c62010-05-05 23:41:32 +00001829 if (S) {
1830 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00001831
Dan Gohman50849c62010-05-05 23:41:32 +00001832 if (Scope.isCompileUnit()) {
1833 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001834 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001835 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00001836 } else if (Scope.isFile()) {
1837 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00001838 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001839 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001840 } else if (Scope.isSubprogram()) {
1841 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001842 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001843 Dir = SP.getDirectory();
Eric Christopher6647b832011-10-11 22:59:11 +00001844 } else if (Scope.isLexicalBlockFile()) {
1845 DILexicalBlockFile DBF(S);
1846 Fn = DBF.getFilename();
1847 Dir = DBF.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001848 } else if (Scope.isLexicalBlock()) {
1849 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001850 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001851 Dir = DB.getDirectory();
Diego Novillo282450d2014-03-03 18:53:17 +00001852 Discriminator = DB.getDiscriminator();
Dan Gohman50849c62010-05-05 23:41:32 +00001853 } else
Craig Topperee4dab52012-02-05 08:31:47 +00001854 llvm_unreachable("Unexpected scope info");
Dan Gohman50849c62010-05-05 23:41:32 +00001855
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001856 Src = getOrCreateSourceID(
1857 Fn, Dir, Asm->OutStreamer.getContext().getDwarfCompileUnitID());
Dan Gohman50849c62010-05-05 23:41:32 +00001858 }
Diego Novillo282450d2014-03-03 18:53:17 +00001859 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0,
1860 Discriminator, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00001861}
1862
Bill Wendling806535f2009-05-20 23:22:40 +00001863//===----------------------------------------------------------------------===//
1864// Emit Methods
1865//===----------------------------------------------------------------------===//
1866
Manman Rence20d462013-10-29 22:57:10 +00001867// Compute the size and offset of a DIE. The offset is relative to start of the
1868// CU. It returns the offset after laying out the DIE.
Eric Christopherf8194852013-12-05 18:06:10 +00001869unsigned DwarfFile::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling480ff322009-05-20 23:21:38 +00001870 // Get the children.
1871 const std::vector<DIE *> &Children = Die->getChildren();
1872
Bill Wendling480ff322009-05-20 23:21:38 +00001873 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00001874 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00001875
1876 // Get the abbreviation for this DIE.
David Blaikieff3ab2c2013-12-05 01:01:41 +00001877 const DIEAbbrev &Abbrev = Die->getAbbrev();
Bill Wendling480ff322009-05-20 23:21:38 +00001878
1879 // Set DIE offset
1880 Die->setOffset(Offset);
1881
1882 // Start the size with the size of abbreviation code.
Logan Chien5b776b72014-02-22 14:00:39 +00001883 Offset += getULEB128Size(Die->getAbbrevNumber());
Bill Wendling480ff322009-05-20 23:21:38 +00001884
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001885 const SmallVectorImpl<DIEValue *> &Values = Die->getValues();
David Blaikieff3ab2c2013-12-05 01:01:41 +00001886 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
Bill Wendling480ff322009-05-20 23:21:38 +00001887
1888 // Size the DIE attribute values.
1889 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1890 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001891 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001892
1893 // Size the DIE children if any.
1894 if (!Children.empty()) {
David Blaikieff3ab2c2013-12-05 01:01:41 +00001895 assert(Abbrev.getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
Bill Wendling480ff322009-05-20 23:21:38 +00001896 "Children flag not set");
1897
1898 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001899 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling480ff322009-05-20 23:21:38 +00001900
1901 // End of children marker.
1902 Offset += sizeof(int8_t);
1903 }
1904
1905 Die->setSize(Offset - Die->getOffset());
1906 return Offset;
1907}
1908
Eric Christopherb088d2d2013-10-24 21:05:08 +00001909// Compute the size and offset for each DIE.
Eric Christopherf8194852013-12-05 18:06:10 +00001910void DwarfFile::computeSizeAndOffsets() {
Manman Rence20d462013-10-29 22:57:10 +00001911 // Offset from the first CU in the debug info section is 0 initially.
1912 unsigned SecOffset = 0;
1913
Eric Christopherb088d2d2013-10-24 21:05:08 +00001914 // Iterate over each compile unit and set the size and offsets for each
1915 // DIE within each compile unit. All offsets are CU relative.
Eric Christophera5a79422013-12-09 23:32:48 +00001916 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = CUs.begin(),
1917 E = CUs.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001918 I != E; ++I) {
Manman Rence20d462013-10-29 22:57:10 +00001919 (*I)->setDebugInfoOffset(SecOffset);
1920
1921 // CU-relative offset is reset to 0 here.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001922 unsigned Offset = sizeof(int32_t) + // Length of Unit Info
David Blaikie6b288cf2013-10-30 20:42:41 +00001923 (*I)->getHeaderSize(); // Unit-specific headers
Manman Rence20d462013-10-29 22:57:10 +00001924
1925 // EndOffset here is CU-relative, after laying out
1926 // all of the CU DIE.
David Blaikie2a80e442013-12-02 22:09:48 +00001927 unsigned EndOffset = computeSizeAndOffset((*I)->getUnitDie(), Offset);
Manman Rence20d462013-10-29 22:57:10 +00001928 SecOffset += EndOffset;
Devang Patel1a0df9a2010-05-10 22:49:55 +00001929 }
Bill Wendling480ff322009-05-20 23:21:38 +00001930}
1931
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001932// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001933void DwarfDebug::emitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001934 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001935
Bill Wendling480ff322009-05-20 23:21:38 +00001936 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001937 DwarfInfoSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001938 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Eric Christopherd8667202013-12-30 17:22:27 +00001939 if (useSplitDwarf())
1940 DwarfInfoDWOSectionSym =
1941 emitSectionSym(Asm, TLOF.getDwarfInfoDWOSection(), "section_info_dwo");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001942 DwarfAbbrevSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001943 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher3c5a1912012-12-19 22:02:53 +00001944 if (useSplitDwarf())
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001945 DwarfAbbrevDWOSectionSym = emitSectionSym(
1946 Asm, TLOF.getDwarfAbbrevDWOSection(), "section_abbrev_dwo");
David Blaikie20474102014-02-25 22:46:44 +00001947 if (GenerateARangeSection)
1948 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001949
Eric Christopher74804332013-02-07 21:19:50 +00001950 DwarfLineSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001951 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001952 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Eric Christopher261d2342013-09-23 20:55:35 +00001953 if (GenerateGnuPubSections) {
Eric Christopher39eebfa2013-09-30 23:14:16 +00001954 DwarfGnuPubNamesSectionSym =
1955 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
1956 DwarfGnuPubTypesSectionSym =
1957 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
Eric Christopher261d2342013-09-23 20:55:35 +00001958 } else if (HasDwarfPubSections) {
1959 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
1960 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Michael Gottesmanc89466f2013-09-04 04:39:38 +00001961 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00001962
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001963 DwarfStrSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001964 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher55863be2013-04-07 03:43:09 +00001965 if (useSplitDwarf()) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00001966 DwarfStrDWOSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001967 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher55863be2013-04-07 03:43:09 +00001968 DwarfAddrSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001969 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
Eric Christopher55863be2013-04-07 03:43:09 +00001970 }
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001971 DwarfDebugRangeSectionSym =
1972 emitSectionSym(Asm, TLOF.getDwarfRangesSection(), "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00001973
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001974 DwarfDebugLocSectionSym =
1975 emitSectionSym(Asm, TLOF.getDwarfLocSection(), "section_debug_loc");
Bill Wendling480ff322009-05-20 23:21:38 +00001976}
1977
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001978// Recursively emits a debug information entry.
David Blaikieff3ab2c2013-12-05 01:01:41 +00001979void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00001980 // Get the abbreviation for this DIE.
David Blaikieff3ab2c2013-12-05 01:01:41 +00001981 const DIEAbbrev &Abbrev = Die->getAbbrev();
Bill Wendling480ff322009-05-20 23:21:38 +00001982
Bill Wendling480ff322009-05-20 23:21:38 +00001983 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00001984 if (Asm->isVerbose())
David Blaikieff3ab2c2013-12-05 01:01:41 +00001985 Asm->OutStreamer.AddComment("Abbrev [" + Twine(Abbrev.getNumber()) +
1986 "] 0x" + Twine::utohexstr(Die->getOffset()) +
1987 ":0x" + Twine::utohexstr(Die->getSize()) + " " +
1988 dwarf::TagString(Abbrev.getTag()));
1989 Asm->EmitULEB128(Abbrev.getNumber());
Bill Wendling480ff322009-05-20 23:21:38 +00001990
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001991 const SmallVectorImpl<DIEValue *> &Values = Die->getValues();
David Blaikieff3ab2c2013-12-05 01:01:41 +00001992 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
Bill Wendling480ff322009-05-20 23:21:38 +00001993
1994 // Emit the DIE attribute values.
1995 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
David Blaikief2443192013-10-21 17:28:37 +00001996 dwarf::Attribute Attr = AbbrevData[i].getAttribute();
1997 dwarf::Form Form = AbbrevData[i].getForm();
Bill Wendling480ff322009-05-20 23:21:38 +00001998 assert(Form && "Too many attributes for DIE (check abbreviation)");
1999
Chris Lattner7bde8c02010-04-04 18:52:31 +00002000 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00002001 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002002
Bill Wendling480ff322009-05-20 23:21:38 +00002003 switch (Attr) {
Manman Rence20d462013-10-29 22:57:10 +00002004 case dwarf::DW_AT_abstract_origin:
2005 case dwarf::DW_AT_type:
2006 case dwarf::DW_AT_friend:
2007 case dwarf::DW_AT_specification:
2008 case dwarf::DW_AT_import:
2009 case dwarf::DW_AT_containing_type: {
2010 DIEEntry *E = cast<DIEEntry>(Values[i]);
2011 DIE *Origin = E->getEntry();
2012 unsigned Addr = Origin->getOffset();
2013 if (Form == dwarf::DW_FORM_ref_addr) {
2014 assert(!useSplitDwarf() && "TODO: dwo files can't have relocations.");
2015 // For DW_FORM_ref_addr, output the offset from beginning of debug info
2016 // section. Origin->getOffset() returns the offset from start of the
2017 // compile unit.
Eric Christopher4287a492013-12-09 23:57:44 +00002018 DwarfCompileUnit *CU = CUDieMap.lookup(Origin->getUnit());
Manman Rence20d462013-10-29 22:57:10 +00002019 assert(CU && "CUDie should belong to a CU.");
2020 Addr += CU->getDebugInfoOffset();
2021 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
David Blaikie03073f72013-12-06 22:14:48 +00002022 Asm->EmitLabelPlusOffset(CU->getSectionSym(), Addr,
Manman Rence20d462013-10-29 22:57:10 +00002023 DIEEntry::getRefAddrSize(Asm));
2024 else
David Blaikie03073f72013-12-06 22:14:48 +00002025 Asm->EmitLabelOffsetDifference(CU->getSectionSym(), Addr,
2026 CU->getSectionSym(),
Manman Ren251a1bd2013-10-29 23:14:15 +00002027 DIEEntry::getRefAddrSize(Asm));
Manman Rence20d462013-10-29 22:57:10 +00002028 } else {
Manman Ren4dbdc902013-10-31 17:54:35 +00002029 // Make sure Origin belong to the same CU.
David Blaikie409dd9c2013-11-19 23:08:21 +00002030 assert(Die->getUnit() == Origin->getUnit() &&
Manman Ren4dbdc902013-10-31 17:54:35 +00002031 "The referenced DIE should belong to the same CU in ref4");
Manman Rence20d462013-10-29 22:57:10 +00002032 Asm->EmitInt32(Addr);
2033 }
2034 break;
2035 }
Devang Patel9fc11702010-05-25 23:40:22 +00002036 case dwarf::DW_AT_location: {
Nick Lewycky33da3362012-06-22 01:25:12 +00002037 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2038 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopherd0b82ae2013-11-16 00:18:40 +00002039 Asm->EmitSectionOffset(L->getValue(), DwarfDebugLocSectionSym);
Nick Lewycky33da3362012-06-22 01:25:12 +00002040 else
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002041 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002042 } else {
Devang Patel9fc11702010-05-25 23:40:22 +00002043 Values[i]->EmitValue(Asm, Form);
Nick Lewycky33da3362012-06-22 01:25:12 +00002044 }
Devang Patel9fc11702010-05-25 23:40:22 +00002045 break;
2046 }
Devang Patela1bd5a12010-09-29 19:08:08 +00002047 case dwarf::DW_AT_accessibility: {
2048 if (Asm->isVerbose()) {
2049 DIEInteger *V = cast<DIEInteger>(Values[i]);
2050 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2051 }
2052 Values[i]->EmitValue(Asm, Form);
2053 break;
2054 }
Bill Wendling480ff322009-05-20 23:21:38 +00002055 default:
2056 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002057 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00002058 break;
2059 }
Bill Wendling480ff322009-05-20 23:21:38 +00002060 }
2061
2062 // Emit the DIE children if any.
David Blaikieff3ab2c2013-12-05 01:01:41 +00002063 if (Abbrev.getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
Bill Wendling480ff322009-05-20 23:21:38 +00002064 const std::vector<DIE *> &Children = Die->getChildren();
2065
2066 for (unsigned j = 0, M = Children.size(); j < M; ++j)
David Blaikieff3ab2c2013-12-05 01:01:41 +00002067 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00002068
David Blaikie155f8812013-12-04 21:51:05 +00002069 Asm->OutStreamer.AddComment("End Of Children Mark");
Chris Lattner566cae92010-03-09 23:52:58 +00002070 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00002071 }
2072}
2073
Eric Christophera2de8262012-12-15 00:04:07 +00002074// Emit the various dwarf units to the unit section USection with
2075// the abbreviations going into ASection.
David Blaikie03073f72013-12-06 22:14:48 +00002076void DwarfFile::emitUnits(DwarfDebug *DD, const MCSection *ASection,
2077 const MCSymbol *ASectionSym) {
Eric Christophera5a79422013-12-09 23:32:48 +00002078 for (SmallVectorImpl<DwarfUnit *>::iterator I = CUs.begin(), E = CUs.end();
2079 I != E; ++I) {
2080 DwarfUnit *TheU = *I;
David Blaikie2a80e442013-12-02 22:09:48 +00002081 DIE *Die = TheU->getUnitDie();
David Blaikie03073f72013-12-06 22:14:48 +00002082 const MCSection *USection = TheU->getSection();
2083 Asm->OutStreamer.SwitchSection(USection);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002084
Devang Patel1a0df9a2010-05-10 22:49:55 +00002085 // Emit the compile units header.
David Blaikie7d734602013-12-06 22:33:05 +00002086 Asm->OutStreamer.EmitLabel(TheU->getLabelBegin());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002087
Devang Patel1a0df9a2010-05-10 22:49:55 +00002088 // Emit size of content not including length itself
David Blaikie6b288cf2013-10-30 20:42:41 +00002089 Asm->OutStreamer.AddComment("Length of Unit");
David Blaikie2a80e442013-12-02 22:09:48 +00002090 Asm->EmitInt32(TheU->getHeaderSize() + Die->getSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002091
David Blaikie2a80e442013-12-02 22:09:48 +00002092 TheU->emitHeader(ASection, ASectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002093
David Blaikieff3ab2c2013-12-05 01:01:41 +00002094 DD->emitDIE(Die);
David Blaikie7d734602013-12-06 22:33:05 +00002095 Asm->OutStreamer.EmitLabel(TheU->getLabelEnd());
Devang Patel1a0df9a2010-05-10 22:49:55 +00002096 }
Bill Wendling480ff322009-05-20 23:21:38 +00002097}
2098
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002099// Emit the debug info section.
2100void DwarfDebug::emitDebugInfo() {
Eric Christopherf8194852013-12-05 18:06:10 +00002101 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christophera2de8262012-12-15 00:04:07 +00002102
David Blaikie03073f72013-12-06 22:14:48 +00002103 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfAbbrevSection(),
Eric Christophera2de8262012-12-15 00:04:07 +00002104 DwarfAbbrevSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002105}
2106
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002107// Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +00002108void DwarfDebug::emitAbbreviations() {
Eric Christopherf8194852013-12-05 18:06:10 +00002109 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
David Blaikie0504cda2013-12-05 07:43:55 +00002110
2111 Holder.emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
Eric Christopher3c5a1912012-12-19 22:02:53 +00002112}
Bill Wendling480ff322009-05-20 23:21:38 +00002113
Eric Christopherf8194852013-12-05 18:06:10 +00002114void DwarfFile::emitAbbrevs(const MCSection *Section) {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002115 // Check to see if it is worth the effort.
David Blaikie0504cda2013-12-05 07:43:55 +00002116 if (!Abbreviations.empty()) {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002117 // Start the debug abbrev section.
2118 Asm->OutStreamer.SwitchSection(Section);
2119
Bill Wendling480ff322009-05-20 23:21:38 +00002120 // For each abbrevation.
David Blaikie0504cda2013-12-05 07:43:55 +00002121 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
Bill Wendling480ff322009-05-20 23:21:38 +00002122 // Get abbreviation data
David Blaikie0504cda2013-12-05 07:43:55 +00002123 const DIEAbbrev *Abbrev = Abbreviations[i];
Bill Wendling480ff322009-05-20 23:21:38 +00002124
2125 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00002126 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00002127
2128 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002129 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00002130 }
2131
2132 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00002133 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00002134 }
2135}
2136
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002137// Emit the last address of the section and the end of the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +00002138void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00002139 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00002140 Asm->OutStreamer.AddComment("Extended Op");
2141 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002142
Chris Lattner566cae92010-03-09 23:52:58 +00002143 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002144 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00002145 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2146 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2147
2148 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002149
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002150 Asm->OutStreamer.EmitSymbolValue(
2151 Asm->GetTempSymbol("section_end", SectionEnd),
2152 Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002153
2154 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00002155 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2156 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002157 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00002158 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002159}
2160
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002161// Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00002162void DwarfDebug::emitAccelNames() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002163 DwarfAccelTable AT(
2164 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
Eric Christophera5a79422013-12-09 23:32:48 +00002165 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2166 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002167 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002168 DwarfUnit *TheU = *I;
David Blaikie2a80e442013-12-02 22:09:48 +00002169 const StringMap<std::vector<const DIE *> > &Names = TheU->getAccelNames();
David Blaikie2ea848b2013-11-19 22:51:04 +00002170 for (StringMap<std::vector<const DIE *> >::const_iterator
2171 GI = Names.begin(),
2172 GE = Names.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002173 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002174 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002175 const std::vector<const DIE *> &Entities = GI->second;
2176 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2177 DE = Entities.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002178 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002179 AT.AddName(Name, *DI);
Eric Christopher4996c702011-11-07 09:24:32 +00002180 }
2181 }
2182
2183 AT.FinalizeTable(Asm, "Names");
2184 Asm->OutStreamer.SwitchSection(
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002185 Asm->getObjFileLowering().getDwarfAccelNamesSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002186 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2187 Asm->OutStreamer.EmitLabel(SectionBegin);
2188
2189 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002190 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002191}
2192
Eric Christopher48fef592012-12-20 21:58:40 +00002193// Emit objective C classes and categories into a hashed accelerator table
2194// section.
Eric Christopher4996c702011-11-07 09:24:32 +00002195void DwarfDebug::emitAccelObjC() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002196 DwarfAccelTable AT(
2197 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
Eric Christophera5a79422013-12-09 23:32:48 +00002198 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2199 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002200 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002201 DwarfUnit *TheU = *I;
David Blaikie2a80e442013-12-02 22:09:48 +00002202 const StringMap<std::vector<const DIE *> > &Names = TheU->getAccelObjC();
David Blaikie2ea848b2013-11-19 22:51:04 +00002203 for (StringMap<std::vector<const DIE *> >::const_iterator
2204 GI = Names.begin(),
2205 GE = Names.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002206 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002207 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002208 const std::vector<const DIE *> &Entities = GI->second;
2209 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2210 DE = Entities.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002211 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002212 AT.AddName(Name, *DI);
Eric Christopher4996c702011-11-07 09:24:32 +00002213 }
2214 }
2215
2216 AT.FinalizeTable(Asm, "ObjC");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002217 Asm->OutStreamer.SwitchSection(
2218 Asm->getObjFileLowering().getDwarfAccelObjCSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002219 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2220 Asm->OutStreamer.EmitLabel(SectionBegin);
2221
2222 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002223 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002224}
2225
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002226// Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002227void DwarfDebug::emitAccelNamespaces() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002228 DwarfAccelTable AT(
2229 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
Eric Christophera5a79422013-12-09 23:32:48 +00002230 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2231 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002232 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002233 DwarfUnit *TheU = *I;
David Blaikie2ea848b2013-11-19 22:51:04 +00002234 const StringMap<std::vector<const DIE *> > &Names =
David Blaikie2a80e442013-12-02 22:09:48 +00002235 TheU->getAccelNamespace();
David Blaikie2ea848b2013-11-19 22:51:04 +00002236 for (StringMap<std::vector<const DIE *> >::const_iterator
2237 GI = Names.begin(),
2238 GE = Names.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002239 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002240 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002241 const std::vector<const DIE *> &Entities = GI->second;
2242 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2243 DE = Entities.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002244 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002245 AT.AddName(Name, *DI);
Eric Christopher4996c702011-11-07 09:24:32 +00002246 }
2247 }
2248
2249 AT.FinalizeTable(Asm, "namespac");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002250 Asm->OutStreamer.SwitchSection(
2251 Asm->getObjFileLowering().getDwarfAccelNamespaceSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002252 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2253 Asm->OutStreamer.EmitLabel(SectionBegin);
2254
2255 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002256 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002257}
2258
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002259// Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002260void DwarfDebug::emitAccelTypes() {
Eric Christopher21bde872012-01-06 04:35:23 +00002261 std::vector<DwarfAccelTable::Atom> Atoms;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002262 Atoms.push_back(
2263 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
2264 Atoms.push_back(
2265 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag, dwarf::DW_FORM_data2));
2266 Atoms.push_back(
2267 DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags, dwarf::DW_FORM_data1));
Eric Christopher21bde872012-01-06 04:35:23 +00002268 DwarfAccelTable AT(Atoms);
Eric Christophera5a79422013-12-09 23:32:48 +00002269 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2270 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002271 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002272 DwarfUnit *TheU = *I;
David Blaikie2ea848b2013-11-19 22:51:04 +00002273 const StringMap<std::vector<std::pair<const DIE *, unsigned> > > &Names =
David Blaikie2a80e442013-12-02 22:09:48 +00002274 TheU->getAccelTypes();
David Blaikie2ea848b2013-11-19 22:51:04 +00002275 for (StringMap<
2276 std::vector<std::pair<const DIE *, unsigned> > >::const_iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002277 GI = Names.begin(),
2278 GE = Names.end();
2279 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002280 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002281 const std::vector<std::pair<const DIE *, unsigned> > &Entities =
2282 GI->second;
2283 for (std::vector<std::pair<const DIE *, unsigned> >::const_iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002284 DI = Entities.begin(),
2285 DE = Entities.end();
2286 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002287 AT.AddName(Name, DI->first, DI->second);
Eric Christopher4996c702011-11-07 09:24:32 +00002288 }
2289 }
2290
2291 AT.FinalizeTable(Asm, "types");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002292 Asm->OutStreamer.SwitchSection(
2293 Asm->getObjFileLowering().getDwarfAccelTypesSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002294 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2295 Asm->OutStreamer.EmitLabel(SectionBegin);
2296
2297 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002298 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002299}
2300
Eric Christopherdd1a0122013-09-13 00:35:05 +00002301// Public name handling.
2302// The format for the various pubnames:
2303//
2304// dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2305// for the DIE that is named.
2306//
2307// gnu pubnames - offset/index value/name tuples where the offset is the offset
2308// into the CU and the index value is computed according to the type of value
2309// for the DIE that is named.
2310//
2311// For type units the offset is the offset of the skeleton DIE. For split dwarf
2312// it's the offset within the debug_info/debug_types dwo section, however, the
2313// reference in the pubname header doesn't change.
2314
2315/// computeIndexValue - Compute the gdb index value for the DIE and CU.
Eric Christophera5a79422013-12-09 23:32:48 +00002316static dwarf::PubIndexEntryDescriptor computeIndexValue(DwarfUnit *CU,
Eric Christopher0fe676a2013-11-21 00:48:22 +00002317 const DIE *Die) {
Eric Christopherd2b497b2013-10-16 01:37:49 +00002318 dwarf::GDBIndexEntryLinkage Linkage = dwarf::GIEL_STATIC;
2319
2320 // We could have a specification DIE that has our most of our knowledge,
2321 // look for that now.
2322 DIEValue *SpecVal = Die->findAttribute(dwarf::DW_AT_specification);
2323 if (SpecVal) {
2324 DIE *SpecDIE = cast<DIEEntry>(SpecVal)->getEntry();
2325 if (SpecDIE->findAttribute(dwarf::DW_AT_external))
2326 Linkage = dwarf::GIEL_EXTERNAL;
2327 } else if (Die->findAttribute(dwarf::DW_AT_external))
2328 Linkage = dwarf::GIEL_EXTERNAL;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002329
2330 switch (Die->getTag()) {
2331 case dwarf::DW_TAG_class_type:
2332 case dwarf::DW_TAG_structure_type:
2333 case dwarf::DW_TAG_union_type:
2334 case dwarf::DW_TAG_enumeration_type:
Eric Christopher261d2342013-09-23 20:55:35 +00002335 return dwarf::PubIndexEntryDescriptor(
2336 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2337 ? dwarf::GIEL_STATIC
2338 : dwarf::GIEL_EXTERNAL);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002339 case dwarf::DW_TAG_typedef:
2340 case dwarf::DW_TAG_base_type:
2341 case dwarf::DW_TAG_subrange_type:
David Blaikie8dec4072013-09-19 20:40:26 +00002342 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002343 case dwarf::DW_TAG_namespace:
David Blaikie8dec4072013-09-19 20:40:26 +00002344 return dwarf::GIEK_TYPE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002345 case dwarf::DW_TAG_subprogram:
Eric Christopherccac5c42013-09-23 22:59:14 +00002346 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002347 case dwarf::DW_TAG_constant:
2348 case dwarf::DW_TAG_variable:
Eric Christopherccac5c42013-09-23 22:59:14 +00002349 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002350 case dwarf::DW_TAG_enumerator:
David Blaikie8dec4072013-09-19 20:40:26 +00002351 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2352 dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002353 default:
David Blaikie8dec4072013-09-19 20:40:26 +00002354 return dwarf::GIEK_NONE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002355 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002356}
2357
Eric Christopher5f93bb92013-09-09 20:03:17 +00002358/// emitDebugPubNames - Emit visible names into a debug pubnames section.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002359///
Eric Christopherdd1a0122013-09-13 00:35:05 +00002360void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
Eric Christopherdd1a0122013-09-13 00:35:05 +00002361 const MCSection *PSec =
2362 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2363 : Asm->getObjFileLowering().getDwarfPubNamesSection();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002364
David Blaikie4f623202013-12-06 19:38:49 +00002365 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christophera5a79422013-12-09 23:32:48 +00002366 const SmallVectorImpl<DwarfUnit *> &Units = Holder.getUnits();
David Blaikie4f623202013-12-06 19:38:49 +00002367 for (unsigned i = 0; i != Units.size(); ++i) {
Eric Christophera5a79422013-12-09 23:32:48 +00002368 DwarfUnit *TheU = Units[i];
David Blaikie2a80e442013-12-02 22:09:48 +00002369 unsigned ID = TheU->getUniqueID();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002370
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002371 // Start the dwarf pubnames section.
Eric Christopher13b99d22013-09-10 21:49:37 +00002372 Asm->OutStreamer.SwitchSection(PSec);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002373
Eric Christopher39eebfa2013-09-30 23:14:16 +00002374 // Emit a label so we can reference the beginning of this pubname section.
2375 if (GnuStyle)
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002376 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames", ID));
Eric Christopher39eebfa2013-09-30 23:14:16 +00002377
Eric Christopherdd1a0122013-09-13 00:35:05 +00002378 // Emit the header.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002379 Asm->OutStreamer.AddComment("Length of Public Names Info");
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002380 MCSymbol *BeginLabel = Asm->GetTempSymbol("pubnames_begin", ID);
2381 MCSymbol *EndLabel = Asm->GetTempSymbol("pubnames_end", ID);
2382 Asm->EmitLabelDifference(EndLabel, BeginLabel, 4);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002383
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002384 Asm->OutStreamer.EmitLabel(BeginLabel);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002385
2386 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002387 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002388
2389 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
David Blaikie7d734602013-12-06 22:33:05 +00002390 Asm->EmitSectionOffset(TheU->getLabelBegin(), TheU->getSectionSym());
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002391
2392 Asm->OutStreamer.AddComment("Compilation Unit Length");
David Blaikie7d734602013-12-06 22:33:05 +00002393 Asm->EmitLabelDifference(TheU->getLabelEnd(), TheU->getLabelBegin(), 4);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002394
Eric Christopherdd1a0122013-09-13 00:35:05 +00002395 // Emit the pubnames for this compilation unit.
David Blaikie4f623202013-12-06 19:38:49 +00002396 const StringMap<const DIE *> &Globals = getUnits()[ID]->getGlobalNames();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002397 for (StringMap<const DIE *>::const_iterator GI = Globals.begin(),
2398 GE = Globals.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002399 GI != GE; ++GI) {
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002400 const char *Name = GI->getKeyData();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002401 const DIE *Entity = GI->second;
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002402
2403 Asm->OutStreamer.AddComment("DIE offset");
2404 Asm->EmitInt32(Entity->getOffset());
2405
Eric Christopherdd1a0122013-09-13 00:35:05 +00002406 if (GnuStyle) {
David Blaikie2a80e442013-12-02 22:09:48 +00002407 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheU, Entity);
David Blaikied0a869d2013-09-19 22:19:37 +00002408 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002409 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002410 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002411 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002412 }
2413
David Blaikie155f8812013-12-04 21:51:05 +00002414 Asm->OutStreamer.AddComment("External Name");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002415 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002416 }
2417
2418 Asm->OutStreamer.AddComment("End Mark");
2419 Asm->EmitInt32(0);
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002420 Asm->OutStreamer.EmitLabel(EndLabel);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002421 }
2422}
2423
Eric Christopherdd1a0122013-09-13 00:35:05 +00002424void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
Eric Christopher261d2342013-09-23 20:55:35 +00002425 const MCSection *PSec =
2426 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2427 : Asm->getObjFileLowering().getDwarfPubTypesSection();
Eric Christopher8b3737f2013-09-13 00:34:58 +00002428
David Blaikie4f623202013-12-06 19:38:49 +00002429 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christophera5a79422013-12-09 23:32:48 +00002430 const SmallVectorImpl<DwarfUnit *> &Units = Holder.getUnits();
David Blaikie4f623202013-12-06 19:38:49 +00002431 for (unsigned i = 0; i != Units.size(); ++i) {
Eric Christophera5a79422013-12-09 23:32:48 +00002432 DwarfUnit *TheU = Units[i];
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002433 unsigned ID = TheU->getUniqueID();
2434
Eric Christopher6abc9c52011-11-07 09:18:35 +00002435 // Start the dwarf pubtypes section.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002436 Asm->OutStreamer.SwitchSection(PSec);
Eric Christopher39eebfa2013-09-30 23:14:16 +00002437
2438 // Emit a label so we can reference the beginning of this pubtype section.
2439 if (GnuStyle)
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002440 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes", ID));
Eric Christopher39eebfa2013-09-30 23:14:16 +00002441
2442 // Emit the header.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002443 Asm->OutStreamer.AddComment("Length of Public Types Info");
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002444 MCSymbol *BeginLabel = Asm->GetTempSymbol("pubtypes_begin", ID);
2445 MCSymbol *EndLabel = Asm->GetTempSymbol("pubtypes_end", ID);
2446 Asm->EmitLabelDifference(EndLabel, BeginLabel, 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002447
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002448 Asm->OutStreamer.EmitLabel(BeginLabel);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002449
David Blaikie155f8812013-12-04 21:51:05 +00002450 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002451 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002452
Devang Patel1a0df9a2010-05-10 22:49:55 +00002453 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
David Blaikie7d734602013-12-06 22:33:05 +00002454 Asm->EmitSectionOffset(TheU->getLabelBegin(), TheU->getSectionSym());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002455
Devang Patel1a0df9a2010-05-10 22:49:55 +00002456 Asm->OutStreamer.AddComment("Compilation Unit Length");
David Blaikie7d734602013-12-06 22:33:05 +00002457 Asm->EmitLabelDifference(TheU->getLabelEnd(), TheU->getLabelBegin(), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002458
Eric Christopher39eebfa2013-09-30 23:14:16 +00002459 // Emit the pubtypes.
David Blaikie4f623202013-12-06 19:38:49 +00002460 const StringMap<const DIE *> &Globals = getUnits()[ID]->getGlobalTypes();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002461 for (StringMap<const DIE *>::const_iterator GI = Globals.begin(),
2462 GE = Globals.end();
Eric Christopher8b3737f2013-09-13 00:34:58 +00002463 GI != GE; ++GI) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002464 const char *Name = GI->getKeyData();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002465 const DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002466
David Blaikie155f8812013-12-04 21:51:05 +00002467 Asm->OutStreamer.AddComment("DIE offset");
Devang Patel1a0df9a2010-05-10 22:49:55 +00002468 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002469
Eric Christopherdd1a0122013-09-13 00:35:05 +00002470 if (GnuStyle) {
David Blaikie2a80e442013-12-02 22:09:48 +00002471 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheU, Entity);
David Blaikied0a869d2013-09-19 22:19:37 +00002472 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002473 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002474 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002475 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002476 }
2477
David Blaikie155f8812013-12-04 21:51:05 +00002478 Asm->OutStreamer.AddComment("External Name");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002479
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002480 // Emit the name with a terminating null byte.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002481 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002482 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002483
Devang Patel1a0df9a2010-05-10 22:49:55 +00002484 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002485 Asm->EmitInt32(0);
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002486 Asm->OutStreamer.EmitLabel(EndLabel);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002487 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002488}
2489
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002490// Emit strings into a string section.
Eric Christopherf8194852013-12-05 18:06:10 +00002491void DwarfFile::emitStrings(const MCSection *StrSection,
Eric Christophera5a79422013-12-09 23:32:48 +00002492 const MCSection *OffsetSection = NULL,
2493 const MCSymbol *StrSecSym = NULL) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002494
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002495 if (StringPool.empty())
2496 return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002497
Chris Lattner3d72a672010-03-09 23:38:23 +00002498 // Start the dwarf str section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002499 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling480ff322009-05-20 23:21:38 +00002500
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002501 // Get all of the string pool entries and put them in an array by their ID so
2502 // we can sort them.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002503 SmallVector<
2504 std::pair<unsigned, StringMapEntry<std::pair<MCSymbol *, unsigned> > *>,
2505 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002506
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002507 for (StringMap<std::pair<MCSymbol *, unsigned> >::iterator
2508 I = StringPool.begin(),
2509 E = StringPool.end();
Eric Christopher48fef592012-12-20 21:58:40 +00002510 I != E; ++I)
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002511 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002512
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002513 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002514
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002515 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002516 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002517 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002518
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002519 // Emit the string itself with a terminating null byte.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002520 Asm->OutStreamer.EmitBytes(
2521 StringRef(Entries[i].second->getKeyData(),
2522 Entries[i].second->getKeyLength() + 1));
Bill Wendling480ff322009-05-20 23:21:38 +00002523 }
Eric Christopher2cbd5762013-01-07 19:32:41 +00002524
2525 // If we've got an offset section go ahead and emit that now as well.
2526 if (OffsetSection) {
2527 Asm->OutStreamer.SwitchSection(OffsetSection);
2528 unsigned offset = 0;
Eric Christopher962c9082013-01-15 23:56:56 +00002529 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002530 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopherbf7bc492013-01-09 03:52:05 +00002531 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopher2cbd5762013-01-07 19:32:41 +00002532 offset += Entries[i].second->getKeyLength() + 1;
2533 }
2534 }
Bill Wendling480ff322009-05-20 23:21:38 +00002535}
2536
Eric Christopher65132a82013-11-19 09:11:26 +00002537// Emit addresses into the section given.
Eric Christopherf8194852013-12-05 18:06:10 +00002538void DwarfFile::emitAddresses(const MCSection *AddrSection) {
Eric Christopher962c9082013-01-15 23:56:56 +00002539
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002540 if (AddressPool.empty())
2541 return;
Eric Christopher962c9082013-01-15 23:56:56 +00002542
2543 // Start the dwarf addr section.
2544 Asm->OutStreamer.SwitchSection(AddrSection);
2545
David Blaikiece1960f2013-07-08 17:51:28 +00002546 // Order the address pool entries by ID
David Blaikieac569a62013-07-08 17:33:10 +00002547 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher962c9082013-01-15 23:56:56 +00002548
David Blaikief1a6dea2014-02-15 19:34:03 +00002549 for (AddrPool::iterator I = AddressPool.begin(), E = AddressPool.end();
Eric Christopher962c9082013-01-15 23:56:56 +00002550 I != E; ++I)
David Blaikief1a6dea2014-02-15 19:34:03 +00002551 Entries[I->second.Number] =
2552 I->second.TLS
2553 ? Asm->getObjFileLowering().getDebugThreadLocalSymbol(I->first)
2554 : MCSymbolRefExpr::Create(I->first, Asm->OutContext);
Eric Christopher962c9082013-01-15 23:56:56 +00002555
David Blaikief28703a2014-02-15 18:33:11 +00002556 for (unsigned i = 0, e = Entries.size(); i != e; ++i)
2557 Asm->OutStreamer.EmitValue(Entries[i],
2558 Asm->getDataLayout().getPointerSize());
Eric Christopher962c9082013-01-15 23:56:56 +00002559}
2560
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002561// Emit visible names into a debug str section.
2562void DwarfDebug::emitDebugStr() {
Eric Christopherf8194852013-12-05 18:06:10 +00002563 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002564 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2565}
2566
Eric Christopher9046f942013-07-02 21:36:07 +00002567// Emit locations into the debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002568void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002569 if (DotDebugLocEntries.empty())
2570 return;
2571
Eric Christopher4887c8f2013-03-29 23:34:06 +00002572 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002573 I = DotDebugLocEntries.begin(),
2574 E = DotDebugLocEntries.end();
Devang Patel116a9d72011-02-04 22:57:18 +00002575 I != E; ++I) {
2576 DotDebugLocEntry &Entry = *I;
2577 if (I + 1 != DotDebugLocEntries.end())
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002578 Entry.Merge(I + 1);
Devang Patel116a9d72011-02-04 22:57:18 +00002579 }
2580
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002581 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002582 Asm->OutStreamer.SwitchSection(
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002583 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002584 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002585 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2586 unsigned index = 1;
Eric Christopher4887c8f2013-03-29 23:34:06 +00002587 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002588 I = DotDebugLocEntries.begin(),
2589 E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002590 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002591 DotDebugLocEntry &Entry = *I;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002592 if (Entry.isMerged())
2593 continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002594 if (Entry.isEmpty()) {
Eric Christopherce0cfce2013-01-09 01:35:34 +00002595 Asm->OutStreamer.EmitIntValue(0, Size);
2596 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002597 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002598 } else {
Eric Christopher25f06422013-07-03 22:40:18 +00002599 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2600 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2601 DIVariable DV(Entry.getVariable());
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002602 Asm->OutStreamer.AddComment("Loc expr size");
2603 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2604 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2605 Asm->EmitLabelDifference(end, begin, 2);
2606 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002607 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002608 DIBasicType BTy(DV.getType());
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002609 if (BTy.Verify() && (BTy.getEncoding() == dwarf::DW_ATE_signed ||
2610 BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
Devang Patel324f8432011-06-01 22:03:25 +00002611 Asm->OutStreamer.AddComment("DW_OP_consts");
2612 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002613 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002614 } else {
2615 Asm->OutStreamer.AddComment("DW_OP_constu");
2616 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002617 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002618 }
Devang Pateled9fd452011-07-08 16:49:43 +00002619 } else if (Entry.isLocation()) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002620 MachineLocation Loc = Entry.getLoc();
Eric Christopher6a841382012-11-19 22:42:10 +00002621 if (!DV.hasComplexAddress())
Devang Pateled9fd452011-07-08 16:49:43 +00002622 // Regular entry.
Eric Christopher614a89f2013-07-03 22:40:21 +00002623 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002624 else {
2625 // Complex address entry.
2626 unsigned N = DV.getNumAddrElements();
2627 unsigned i = 0;
2628 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002629 if (Loc.getOffset()) {
Devang Pateled9fd452011-07-08 16:49:43 +00002630 i = 2;
Eric Christopher614a89f2013-07-03 22:40:21 +00002631 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002632 Asm->OutStreamer.AddComment("DW_OP_deref");
2633 Asm->EmitInt8(dwarf::DW_OP_deref);
2634 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2635 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2636 Asm->EmitSLEB128(DV.getAddrElement(1));
2637 } else {
2638 // If first address element is OpPlus then emit
2639 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher614a89f2013-07-03 22:40:21 +00002640 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2641 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002642 i = 2;
2643 }
2644 } else {
Eric Christopher614a89f2013-07-03 22:40:21 +00002645 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002646 }
Eric Christopher6a841382012-11-19 22:42:10 +00002647
Devang Pateled9fd452011-07-08 16:49:43 +00002648 // Emit remaining complex address elements.
2649 for (; i < N; ++i) {
2650 uint64_t Element = DV.getAddrElement(i);
2651 if (Element == DIBuilder::OpPlus) {
2652 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2653 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher4d250522012-05-08 18:56:00 +00002654 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002655 if (!Loc.isReg())
Eric Christopher4d250522012-05-08 18:56:00 +00002656 Asm->EmitInt8(dwarf::DW_OP_deref);
2657 } else
2658 llvm_unreachable("unknown Opcode found in complex address");
Devang Pateled9fd452011-07-08 16:49:43 +00002659 }
Devang Patel3e021532011-04-28 02:22:40 +00002660 }
Devang Patel3e021532011-04-28 02:22:40 +00002661 }
Devang Pateled9fd452011-07-08 16:49:43 +00002662 // else ... ignore constant fp. There is not any good way to
2663 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002664 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002665 }
2666 }
Bill Wendling480ff322009-05-20 23:21:38 +00002667}
2668
Richard Mitton21101b32013-09-19 23:21:01 +00002669struct SymbolCUSorter {
2670 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2671 const MCStreamer &Streamer;
2672
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002673 bool operator()(const SymbolCU &A, const SymbolCU &B) {
Richard Mitton21101b32013-09-19 23:21:01 +00002674 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2675 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2676
2677 // Symbols with no order assigned should be placed at the end.
2678 // (e.g. section end labels)
2679 if (IA == 0)
2680 IA = (unsigned)(-1);
2681 if (IB == 0)
2682 IB = (unsigned)(-1);
2683 return IA < IB;
2684 }
2685};
2686
Eric Christophera5a79422013-12-09 23:32:48 +00002687static bool CUSort(const DwarfUnit *A, const DwarfUnit *B) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002688 return (A->getUniqueID() < B->getUniqueID());
Richard Mitton21101b32013-09-19 23:21:01 +00002689}
2690
2691struct ArangeSpan {
2692 const MCSymbol *Start, *End;
2693};
2694
2695// Emit a debug aranges section, containing a CU lookup for any
2696// address we can tie back to a CU.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002697void DwarfDebug::emitDebugARanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002698 // Start the dwarf aranges section.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002699 Asm->OutStreamer.SwitchSection(
2700 Asm->getObjFileLowering().getDwarfARangesSection());
Richard Mitton21101b32013-09-19 23:21:01 +00002701
Eric Christopher4287a492013-12-09 23:57:44 +00002702 typedef DenseMap<DwarfCompileUnit *, std::vector<ArangeSpan> > SpansType;
Richard Mitton21101b32013-09-19 23:21:01 +00002703
2704 SpansType Spans;
2705
2706 // Build a list of sections used.
2707 std::vector<const MCSection *> Sections;
2708 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2709 it++) {
2710 const MCSection *Section = it->first;
2711 Sections.push_back(Section);
2712 }
2713
2714 // Sort the sections into order.
2715 // This is only done to ensure consistent output order across different runs.
2716 std::sort(Sections.begin(), Sections.end(), SectionSort);
2717
2718 // Build a set of address spans, sorted by CU.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002719 for (size_t SecIdx = 0; SecIdx < Sections.size(); SecIdx++) {
Richard Mitton21101b32013-09-19 23:21:01 +00002720 const MCSection *Section = Sections[SecIdx];
2721 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2722 if (List.size() < 2)
2723 continue;
2724
2725 // Sort the symbols by offset within the section.
2726 SymbolCUSorter sorter(Asm->OutStreamer);
2727 std::sort(List.begin(), List.end(), sorter);
2728
2729 // If we have no section (e.g. common), just write out
2730 // individual spans for each symbol.
2731 if (Section == NULL) {
2732 for (size_t n = 0; n < List.size(); n++) {
2733 const SymbolCU &Cur = List[n];
2734
2735 ArangeSpan Span;
2736 Span.Start = Cur.Sym;
2737 Span.End = NULL;
2738 if (Cur.CU)
2739 Spans[Cur.CU].push_back(Span);
2740 }
2741 } else {
2742 // Build spans between each label.
2743 const MCSymbol *StartSym = List[0].Sym;
2744 for (size_t n = 1; n < List.size(); n++) {
2745 const SymbolCU &Prev = List[n - 1];
2746 const SymbolCU &Cur = List[n];
2747
2748 // Try and build the longest span we can within the same CU.
2749 if (Cur.CU != Prev.CU) {
2750 ArangeSpan Span;
2751 Span.Start = StartSym;
2752 Span.End = Cur.Sym;
2753 Spans[Prev.CU].push_back(Span);
2754 StartSym = Cur.Sym;
2755 }
2756 }
2757 }
2758 }
2759
Richard Mitton21101b32013-09-19 23:21:01 +00002760 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2761
2762 // Build a list of CUs used.
Eric Christopher4287a492013-12-09 23:57:44 +00002763 std::vector<DwarfCompileUnit *> CUs;
Richard Mitton21101b32013-09-19 23:21:01 +00002764 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
Eric Christopher4287a492013-12-09 23:57:44 +00002765 DwarfCompileUnit *CU = it->first;
Richard Mitton21101b32013-09-19 23:21:01 +00002766 CUs.push_back(CU);
2767 }
2768
2769 // Sort the CU list (again, to ensure consistent output order).
2770 std::sort(CUs.begin(), CUs.end(), CUSort);
2771
2772 // Emit an arange table for each CU we used.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002773 for (size_t CUIdx = 0; CUIdx < CUs.size(); CUIdx++) {
Eric Christopher4287a492013-12-09 23:57:44 +00002774 DwarfCompileUnit *CU = CUs[CUIdx];
Richard Mitton21101b32013-09-19 23:21:01 +00002775 std::vector<ArangeSpan> &List = Spans[CU];
2776
2777 // Emit size of content not including length itself.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002778 unsigned ContentSize =
2779 sizeof(int16_t) + // DWARF ARange version number
2780 sizeof(int32_t) + // Offset of CU in the .debug_info section
2781 sizeof(int8_t) + // Pointer Size (in bytes)
2782 sizeof(int8_t); // Segment Size (in bytes)
Richard Mitton21101b32013-09-19 23:21:01 +00002783
2784 unsigned TupleSize = PtrSize * 2;
2785
2786 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
Benjamin Kramer8a68ab32014-01-07 19:28:14 +00002787 unsigned Padding =
2788 OffsetToAlignment(sizeof(int32_t) + ContentSize, TupleSize);
Richard Mitton21101b32013-09-19 23:21:01 +00002789
2790 ContentSize += Padding;
2791 ContentSize += (List.size() + 1) * TupleSize;
2792
2793 // For each compile unit, write the list of spans it covers.
2794 Asm->OutStreamer.AddComment("Length of ARange Set");
2795 Asm->EmitInt32(ContentSize);
2796 Asm->OutStreamer.AddComment("DWARF Arange version number");
2797 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2798 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
Eric Christopherd8667202013-12-30 17:22:27 +00002799 Asm->EmitSectionOffset(CU->getLocalLabelBegin(), CU->getLocalSectionSym());
Richard Mitton21101b32013-09-19 23:21:01 +00002800 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2801 Asm->EmitInt8(PtrSize);
2802 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2803 Asm->EmitInt8(0);
2804
Benjamin Kramer8a68ab32014-01-07 19:28:14 +00002805 Asm->OutStreamer.EmitFill(Padding, 0xff);
Richard Mitton21101b32013-09-19 23:21:01 +00002806
2807 for (unsigned n = 0; n < List.size(); n++) {
2808 const ArangeSpan &Span = List[n];
2809 Asm->EmitLabelReference(Span.Start, PtrSize);
2810
2811 // Calculate the size as being from the span start to it's end.
Richard Mitton089ed892013-09-23 17:56:20 +00002812 if (Span.End) {
Richard Mitton21101b32013-09-19 23:21:01 +00002813 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
Richard Mitton089ed892013-09-23 17:56:20 +00002814 } else {
2815 // For symbols without an end marker (e.g. common), we
2816 // write a single arange entry containing just that one symbol.
2817 uint64_t Size = SymSize[Span.Start];
2818 if (Size == 0)
2819 Size = 1;
2820
2821 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2822 }
Richard Mitton21101b32013-09-19 23:21:01 +00002823 }
2824
2825 Asm->OutStreamer.AddComment("ARange terminator");
2826 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2827 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2828 }
Bill Wendling480ff322009-05-20 23:21:38 +00002829}
2830
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002831// Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002832void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002833 // Start the dwarf ranges section.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002834 Asm->OutStreamer.SwitchSection(
2835 Asm->getObjFileLowering().getDwarfRangesSection());
Eric Christopher4751d702013-11-23 00:05:29 +00002836
Eric Christopher0f63d062013-12-03 00:45:45 +00002837 // Size for our labels.
2838 unsigned char Size = Asm->getDataLayout().getPointerSize();
2839
2840 // Grab the specific ranges for the compile units in the module.
Eric Christopher179fba12014-01-29 22:06:23 +00002841 for (MapVector<const MDNode *, DwarfCompileUnit *>::iterator
2842 I = CUMap.begin(),
2843 E = CUMap.end();
Eric Christopher0f63d062013-12-03 00:45:45 +00002844 I != E; ++I) {
Eric Christopher4287a492013-12-09 23:57:44 +00002845 DwarfCompileUnit *TheCU = I->second;
Eric Christopher0f63d062013-12-03 00:45:45 +00002846
2847 // Emit a symbol so we can find the beginning of our ranges.
David Blaikie1ab7c2d2013-12-09 17:51:30 +00002848 Asm->OutStreamer.EmitLabel(TheCU->getLabelRange());
Eric Christopher0f63d062013-12-03 00:45:45 +00002849
2850 // Iterate over the misc ranges for the compile units in the module.
Eric Christopher270ba4a2013-12-04 19:06:58 +00002851 const SmallVectorImpl<RangeSpanList> &RangeLists = TheCU->getRangeLists();
Eric Christophera5a79422013-12-09 23:32:48 +00002852 for (SmallVectorImpl<RangeSpanList>::const_iterator I = RangeLists.begin(),
2853 E = RangeLists.end();
Eric Christopher0f63d062013-12-03 00:45:45 +00002854 I != E; ++I) {
Eric Christopher270ba4a2013-12-04 19:06:58 +00002855 const RangeSpanList &List = *I;
Eric Christopher0f63d062013-12-03 00:45:45 +00002856
Eric Christopherf8790642013-12-04 22:04:50 +00002857 // Emit our symbol so we can find the beginning of the range.
2858 Asm->OutStreamer.EmitLabel(List.getSym());
Eric Christopher0f63d062013-12-03 00:45:45 +00002859
2860 for (SmallVectorImpl<RangeSpan>::const_iterator
Eric Christopher270ba4a2013-12-04 19:06:58 +00002861 RI = List.getRanges().begin(),
2862 RE = List.getRanges().end();
2863 RI != RE; ++RI) {
2864 const RangeSpan &Range = *RI;
Eric Christopher0f63d062013-12-03 00:45:45 +00002865 const MCSymbol *Begin = Range.getStart();
2866 const MCSymbol *End = Range.getEnd();
Eric Christopher565ab112013-12-20 04:34:22 +00002867 assert(Begin && "Range without a begin symbol?");
2868 assert(End && "Range without an end symbol?");
2869 Asm->OutStreamer.EmitSymbolValue(Begin, Size);
2870 Asm->OutStreamer.EmitSymbolValue(End, Size);
Eric Christopher0f63d062013-12-03 00:45:45 +00002871 }
2872
2873 // And terminate the list with two 0 values.
Eric Christopherce0cfce2013-01-09 01:35:34 +00002874 Asm->OutStreamer.EmitIntValue(0, Size);
Eric Christopher0f63d062013-12-03 00:45:45 +00002875 Asm->OutStreamer.EmitIntValue(0, Size);
2876 }
Eric Christopher46e23432013-12-20 04:16:18 +00002877
2878 // Now emit a range for the CU itself.
Eric Christophera9a1d272014-02-27 07:44:45 +00002879 if (useCURanges() && TheCU->getRanges().size()) {
Eric Christopher46e23432013-12-20 04:16:18 +00002880 Asm->OutStreamer.EmitLabel(
2881 Asm->GetTempSymbol("cu_ranges", TheCU->getUniqueID()));
2882 const SmallVectorImpl<RangeSpan> &Ranges = TheCU->getRanges();
2883 for (uint32_t i = 0, e = Ranges.size(); i != e; ++i) {
2884 RangeSpan Range = Ranges[i];
Eric Christopher46e23432013-12-20 04:16:18 +00002885 const MCSymbol *Begin = Range.getStart();
2886 const MCSymbol *End = Range.getEnd();
Eric Christopher565ab112013-12-20 04:34:22 +00002887 assert(Begin && "Range without a begin symbol?");
2888 assert(End && "Range without an end symbol?");
2889 Asm->OutStreamer.EmitSymbolValue(Begin, Size);
2890 Asm->OutStreamer.EmitSymbolValue(End, Size);
Eric Christopher46e23432013-12-20 04:16:18 +00002891 }
2892 // And terminate the list with two 0 values.
2893 Asm->OutStreamer.EmitIntValue(0, Size);
2894 Asm->OutStreamer.EmitIntValue(0, Size);
2895 }
Devang Patel12563b32010-04-16 23:33:45 +00002896 }
Bill Wendling480ff322009-05-20 23:21:38 +00002897}
2898
Eric Christopherd692c1d2012-12-11 19:42:09 +00002899// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002900
David Blaikie38fe6342014-01-09 04:28:46 +00002901void DwarfDebug::initSkeletonUnit(const DwarfUnit *U, DIE *Die,
2902 DwarfUnit *NewU) {
2903 NewU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
2904 U->getCUNode().getSplitDebugFilename());
2905
2906 // Relocate to the beginning of the addr_base section, else 0 for the
2907 // beginning of the one for this compile unit.
2908 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopherceec7b02014-01-11 00:23:18 +00002909 NewU->addSectionLabel(Die, dwarf::DW_AT_GNU_addr_base, DwarfAddrSectionSym);
David Blaikie38fe6342014-01-09 04:28:46 +00002910 else
2911 NewU->addSectionOffset(Die, dwarf::DW_AT_GNU_addr_base, 0);
2912
2913 if (!CompilationDir.empty())
2914 NewU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
2915
2916 addGnuPubAttributes(NewU, Die);
2917
2918 SkeletonHolder.addUnit(NewU);
2919}
2920
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002921// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2922// 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 +00002923// DW_AT_ranges_base, DW_AT_addr_base.
Eric Christopher5090d572013-12-10 00:40:03 +00002924// TODO: Implement DW_AT_ranges_base.
Eric Christopher4287a492013-12-09 23:57:44 +00002925DwarfCompileUnit *DwarfDebug::constructSkeletonCU(const DwarfCompileUnit *CU) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002926
2927 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher4287a492013-12-09 23:57:44 +00002928 DwarfCompileUnit *NewCU = new DwarfCompileUnit(
David Blaikief645f962014-01-09 03:23:41 +00002929 CU->getUniqueID(), Die, CU->getCUNode(), Asm, this, &SkeletonHolder);
David Blaikie1ab7c2d2013-12-09 17:51:30 +00002930 NewCU->initSection(Asm->getObjFileLowering().getDwarfInfoSection(),
2931 DwarfInfoSectionSym);
Eric Christopher4c7765f2013-01-17 03:00:04 +00002932
David Blaikie2494fdb2014-02-14 22:41:51 +00002933 NewCU->initStmtList(DwarfLineSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002934
David Blaikie38fe6342014-01-09 04:28:46 +00002935 initSkeletonUnit(CU, Die, NewCU);
Eric Christopherc8a310e2012-12-10 23:34:43 +00002936
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002937 return NewCU;
2938}
2939
David Blaikie15ed5eb2014-01-10 01:38:41 +00002940// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_dwo_name,
2941// DW_AT_addr_base.
David Blaikie15632ae2014-02-12 00:31:30 +00002942DwarfTypeUnit *DwarfDebug::constructSkeletonTU(DwarfTypeUnit *TU) {
David Blaikie60e63862014-02-14 23:58:13 +00002943 DwarfCompileUnit &CU = static_cast<DwarfCompileUnit &>(
2944 *SkeletonHolder.getUnits()[TU->getCU().getUniqueID()]);
David Blaikie15ed5eb2014-01-10 01:38:41 +00002945
2946 DIE *Die = new DIE(dwarf::DW_TAG_type_unit);
David Blaikie60e63862014-02-14 23:58:13 +00002947 DwarfTypeUnit *NewTU =
2948 new DwarfTypeUnit(TU->getUniqueID(), Die, CU, Asm, this, &SkeletonHolder);
David Blaikie15ed5eb2014-01-10 01:38:41 +00002949 NewTU->setTypeSignature(TU->getTypeSignature());
2950 NewTU->setType(NULL);
2951 NewTU->initSection(
2952 Asm->getObjFileLowering().getDwarfTypesSection(TU->getTypeSignature()));
David Blaikie60e63862014-02-14 23:58:13 +00002953 CU.applyStmtList(*Die);
David Blaikie15ed5eb2014-01-10 01:38:41 +00002954
2955 initSkeletonUnit(TU, Die, NewTU);
2956 return NewTU;
2957}
2958
Eric Christopherd692c1d2012-12-11 19:42:09 +00002959// Emit the .debug_info.dwo section for separated dwarf. This contains the
2960// compile units that would normally be in debug_info.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002961void DwarfDebug::emitDebugInfoDWO() {
Eric Christophercdf218d2012-12-10 19:51:21 +00002962 assert(useSplitDwarf() && "No split dwarf debug info?");
David Blaikie03073f72013-12-06 22:14:48 +00002963 InfoHolder.emitUnits(this,
Eric Christopher3c5a1912012-12-19 22:02:53 +00002964 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2965 DwarfAbbrevDWOSectionSym);
2966}
2967
2968// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2969// abbreviations for the .debug_info.dwo section.
2970void DwarfDebug::emitDebugAbbrevDWO() {
2971 assert(useSplitDwarf() && "No split dwarf?");
David Blaikie0504cda2013-12-05 07:43:55 +00002972 InfoHolder.emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection());
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002973}
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002974
2975// Emit the .debug_str.dwo section for separated dwarf. This contains the
2976// string section and is identical in format to traditional .debug_str
2977// sections.
2978void DwarfDebug::emitDebugStrDWO() {
2979 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002980 const MCSection *OffSec =
2981 Asm->getObjFileLowering().getDwarfStrOffDWOSection();
Eric Christopher2cbd5762013-01-07 19:32:41 +00002982 const MCSymbol *StrSym = DwarfStrSectionSym;
2983 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
2984 OffSec, StrSym);
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002985}
David Blaikie409dd9c2013-11-19 23:08:21 +00002986
David Blaikie15632ae2014-02-12 00:31:30 +00002987void DwarfDebug::addDwarfTypeUnitType(DwarfCompileUnit &CU,
David Blaikief645f962014-01-09 03:23:41 +00002988 StringRef Identifier, DIE *RefDie,
2989 DICompositeType CTy) {
David Blaikie322d79b2014-01-31 19:52:26 +00002990 // Flag the type unit reference as a declaration so that if it contains
2991 // members (implicit special members, static data member definitions, member
2992 // declarations for definitions in this CU, etc) consumers don't get confused
2993 // and think this is a full definition.
David Blaikie15632ae2014-02-12 00:31:30 +00002994 CU.addFlag(RefDie, dwarf::DW_AT_declaration);
Chandler Carruthb587ab62014-01-20 08:07:07 +00002995
David Blaikie47f615e2013-12-17 23:32:35 +00002996 const DwarfTypeUnit *&TU = DwarfTypeUnits[CTy];
Chandler Carruthb587ab62014-01-20 08:07:07 +00002997 if (TU) {
David Blaikie15632ae2014-02-12 00:31:30 +00002998 CU.addDIETypeSignature(RefDie, *TU);
Chandler Carruthb587ab62014-01-20 08:07:07 +00002999 return;
David Blaikie409dd9c2013-11-19 23:08:21 +00003000 }
3001
Chandler Carruthb587ab62014-01-20 08:07:07 +00003002 DIE *UnitDie = new DIE(dwarf::DW_TAG_type_unit);
David Blaikied696fac2014-02-12 00:32:05 +00003003 DwarfTypeUnit *NewTU = new DwarfTypeUnit(InfoHolder.getUnits().size(),
3004 UnitDie, CU, Asm, this, &InfoHolder);
Chandler Carruthb587ab62014-01-20 08:07:07 +00003005 TU = NewTU;
3006 InfoHolder.addUnit(NewTU);
3007
3008 NewTU->addUInt(UnitDie, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
David Blaikie15632ae2014-02-12 00:31:30 +00003009 CU.getLanguage());
Chandler Carruthb587ab62014-01-20 08:07:07 +00003010
3011 MD5 Hash;
3012 Hash.update(Identifier);
3013 // ... take the least significant 8 bytes and return those. Our MD5
3014 // implementation always returns its results in little endian, swap bytes
3015 // appropriately.
3016 MD5::MD5Result Result;
3017 Hash.final(Result);
3018 uint64_t Signature = *reinterpret_cast<support::ulittle64_t *>(Result + 8);
3019 NewTU->setTypeSignature(Signature);
3020 if (useSplitDwarf())
3021 NewTU->setSkeleton(constructSkeletonTU(NewTU));
David Blaikie60e63862014-02-14 23:58:13 +00003022 else
3023 CU.applyStmtList(*UnitDie);
Chandler Carruthb587ab62014-01-20 08:07:07 +00003024
3025 NewTU->setType(NewTU->createTypeDIE(CTy));
3026
3027 NewTU->initSection(
3028 useSplitDwarf()
3029 ? Asm->getObjFileLowering().getDwarfTypesDWOSection(Signature)
3030 : Asm->getObjFileLowering().getDwarfTypesSection(Signature));
3031
David Blaikie15632ae2014-02-12 00:31:30 +00003032 CU.addDIETypeSignature(RefDie, *NewTU);
David Blaikie409dd9c2013-11-19 23:08:21 +00003033}