blob: 8637c4d6519f9d06351e69400ead76fa1c76a3c7 [file] [log] [blame]
Bill Wendling2f921f82009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Chris Lattnerb14490d2010-03-09 00:39:24 +000013
Devang Patel80ae3492009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling2f921f82009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000016#include "DIE.h"
Eric Christopher45731982013-08-08 23:45:55 +000017#include "DIEHash.h"
Eric Christopher4996c702011-11-07 09:24:32 +000018#include "DwarfAccelTable.h"
David Blaikie2c86a722013-12-02 19:33:15 +000019#include "DwarfUnit.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000020#include "llvm/ADT/STLExtras.h"
21#include "llvm/ADT/Statistic.h"
22#include "llvm/ADT/StringExtras.h"
23#include "llvm/ADT/Triple.h"
David Greene829b3e82009-08-19 21:52:55 +000024#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000025#include "llvm/CodeGen/MachineModuleInfo.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000026#include "llvm/DIBuilder.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000027#include "llvm/DebugInfo.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000028#include "llvm/IR/Constants.h"
29#include "llvm/IR/DataLayout.h"
30#include "llvm/IR/Instructions.h"
31#include "llvm/IR/Module.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000032#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000033#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000034#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000035#include "llvm/MC/MCSymbol.h"
Devang Patel6c74a872010-04-27 19:46:33 +000036#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000037#include "llvm/Support/Debug.h"
David Majnemered89b5c2013-08-21 06:13:34 +000038#include "llvm/Support/Dwarf.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000039#include "llvm/Support/ErrorHandling.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000040#include "llvm/Support/FormattedStream.h"
Eric Christopher67646432013-07-26 17:02:41 +000041#include "llvm/Support/MD5.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000042#include "llvm/Support/Path.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000043#include "llvm/Support/Timer.h"
44#include "llvm/Support/ValueHandle.h"
45#include "llvm/Target/TargetFrameLowering.h"
46#include "llvm/Target/TargetLoweringObjectFile.h"
47#include "llvm/Target/TargetMachine.h"
48#include "llvm/Target/TargetOptions.h"
49#include "llvm/Target/TargetRegisterInfo.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000050using namespace llvm;
51
Eric Christopher7f2b5512013-07-23 22:16:41 +000052static cl::opt<bool>
53DisableDebugInfoPrinting("disable-debug-info-print", cl::Hidden,
54 cl::desc("Disable debug info printing"));
Devang Patel6c74a872010-04-27 19:46:33 +000055
Eric Christopher7f2b5512013-07-23 22:16:41 +000056static cl::opt<bool> UnknownLocations(
57 "use-unknown-locations", cl::Hidden,
58 cl::desc("Make an absence of debug location information explicit."),
59 cl::init(false));
Dan Gohman7421ae42010-05-07 01:08:53 +000060
Eric Christopherb4bef6d2013-11-19 09:04:36 +000061static cl::opt<bool> GenerateCUHash("generate-cu-hash", cl::Hidden,
62 cl::desc("Add the CU hash as the dwo_id."),
63 cl::init(false));
Eric Christopherd29614f2013-08-13 01:21:55 +000064
Eric Christopherdd1a0122013-09-13 00:35:05 +000065static cl::opt<bool>
66GenerateGnuPubSections("generate-gnu-dwarf-pub-sections", cl::Hidden,
67 cl::desc("Generate GNU-style pubnames and pubtypes"),
68 cl::init(false));
69
Eric Christopher20b76a72012-08-23 22:36:40 +000070namespace {
Eric Christopherf07ee3a2014-01-27 23:50:03 +000071enum DefaultOnOff { Default, Enable, Disable };
Eric Christopher20b76a72012-08-23 22:36:40 +000072}
Eric Christopher4996c702011-11-07 09:24:32 +000073
Eric Christopher7f2b5512013-07-23 22:16:41 +000074static cl::opt<DefaultOnOff>
75DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
76 cl::desc("Output prototype dwarf accelerator tables."),
77 cl::values(clEnumVal(Default, "Default for platform"),
78 clEnumVal(Enable, "Enabled"),
79 clEnumVal(Disable, "Disabled"), clEnumValEnd),
80 cl::init(Default));
Eric Christopher20b76a72012-08-23 22:36:40 +000081
Eric Christopher7f2b5512013-07-23 22:16:41 +000082static cl::opt<DefaultOnOff>
Eric Christopher7f2b5512013-07-23 22:16:41 +000083SplitDwarf("split-dwarf", cl::Hidden,
Eric Christopher5d008fe2013-12-04 23:24:28 +000084 cl::desc("Output DWARF5 split debug info."),
Eric Christopher7f2b5512013-07-23 22:16:41 +000085 cl::values(clEnumVal(Default, "Default for platform"),
86 clEnumVal(Enable, "Enabled"),
87 clEnumVal(Disable, "Disabled"), clEnumValEnd),
88 cl::init(Default));
Eric Christopher29424312012-11-12 22:22:20 +000089
Eric Christopher7da24882013-08-19 21:07:38 +000090static cl::opt<DefaultOnOff>
Eric Christopher4d36ca02013-08-26 23:24:35 +000091DwarfPubSections("generate-dwarf-pub-sections", cl::Hidden,
92 cl::desc("Generate DWARF pubnames and pubtypes sections"),
93 cl::values(clEnumVal(Default, "Default for platform"),
94 clEnumVal(Enable, "Enabled"),
95 clEnumVal(Disable, "Disabled"), clEnumValEnd),
96 cl::init(Default));
Eric Christopher7da24882013-08-19 21:07:38 +000097
Eric Christopher33ff6972013-11-21 23:46:41 +000098static cl::opt<unsigned>
99DwarfVersionNumber("dwarf-version", cl::Hidden,
Eric Christophera5a79422013-12-09 23:32:48 +0000100 cl::desc("Generate DWARF for dwarf version."), cl::init(0));
Eric Christopher33ff6972013-11-21 23:46:41 +0000101
Eric Christopher46e23432013-12-20 04:16:18 +0000102static cl::opt<bool>
103DwarfCURanges("generate-dwarf-cu-ranges", cl::Hidden,
104 cl::desc("Generate DW_AT_ranges for compile units"),
105 cl::init(false));
106
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000107static const char *const DWARFGroupName = "DWARF Emission";
108static const char *const DbgTimerName = "DWARF Debug Writer";
Bill Wendlingfcc14142010-04-07 09:28:04 +0000109
Bill Wendling2f921f82009-05-15 09:23:25 +0000110//===----------------------------------------------------------------------===//
111
Bill Wendling2f921f82009-05-15 09:23:25 +0000112namespace llvm {
113
Manman Renbe5576f2013-10-08 19:07:44 +0000114/// resolve - Look in the DwarfDebug map for the MDNode that
115/// corresponds to the reference.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000116template <typename T> T DbgVariable::resolve(DIRef<T> Ref) const {
Manman Renbe5576f2013-10-08 19:07:44 +0000117 return DD->resolve(Ref);
118}
119
Nick Lewycky019d2552011-07-29 03:49:23 +0000120DIType DbgVariable::getType() const {
Devang Patelf20c4f72011-04-12 22:53:02 +0000121 DIType Ty = Var.getType();
122 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
123 // addresses instead.
124 if (Var.isBlockByrefVariable()) {
125 /* Byref variables, in Blocks, are declared by the programmer as
126 "SomeType VarName;", but the compiler creates a
127 __Block_byref_x_VarName struct, and gives the variable VarName
128 either the struct, or a pointer to the struct, as its type. This
129 is necessary for various behind-the-scenes things the compiler
130 needs to do with by-reference variables in blocks.
Eric Christopher6a841382012-11-19 22:42:10 +0000131
Devang Patelf20c4f72011-04-12 22:53:02 +0000132 However, as far as the original *programmer* is concerned, the
133 variable should still have type 'SomeType', as originally declared.
Eric Christopher6a841382012-11-19 22:42:10 +0000134
Devang Patelf20c4f72011-04-12 22:53:02 +0000135 The following function dives into the __Block_byref_x_VarName
136 struct to find the original type of the variable. This will be
137 passed back to the code generating the type for the Debug
138 Information Entry for the variable 'VarName'. 'VarName' will then
139 have the original type 'SomeType' in its debug information.
Eric Christopher6a841382012-11-19 22:42:10 +0000140
Devang Patelf20c4f72011-04-12 22:53:02 +0000141 The original type 'SomeType' will be the type of the field named
142 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher6a841382012-11-19 22:42:10 +0000143
Devang Patelf20c4f72011-04-12 22:53:02 +0000144 NOTE: In order for this to not completely fail on the debugger
145 side, the Debug Information Entry for the variable VarName needs to
146 have a DW_AT_location that tells the debugger how to unwind through
147 the pointers and __Block_byref_x_VarName struct to find the actual
148 value of the variable. The function addBlockByrefType does this. */
149 DIType subType = Ty;
Eric Christopher31b05762013-08-08 01:41:00 +0000150 uint16_t tag = Ty.getTag();
Eric Christopher6a841382012-11-19 22:42:10 +0000151
Eric Christopher9adc55f2013-09-04 19:53:21 +0000152 if (tag == dwarf::DW_TAG_pointer_type)
Manman Renbe5576f2013-10-08 19:07:44 +0000153 subType = resolve(DIDerivedType(Ty).getTypeDerivedFrom());
Eric Christopher6a841382012-11-19 22:42:10 +0000154
Eric Christopher9adc55f2013-09-04 19:53:21 +0000155 DIArray Elements = DICompositeType(subType).getTypeArray();
Devang Patelf20c4f72011-04-12 22:53:02 +0000156 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
David Blaikie5af2aca2013-11-18 23:57:26 +0000157 DIDerivedType DT(Elements.getElement(i));
Devang Patelf20c4f72011-04-12 22:53:02 +0000158 if (getName() == DT.getName())
Manman Renbe5576f2013-10-08 19:07:44 +0000159 return (resolve(DT.getTypeDerivedFrom()));
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000160 }
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000161 }
Devang Patelf20c4f72011-04-12 22:53:02 +0000162 return Ty;
163}
Bill Wendling2f921f82009-05-15 09:23:25 +0000164
Chris Lattnerf5d06362010-04-05 04:09:20 +0000165} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000166
Eric Christopher942f22c2014-01-11 00:28:12 +0000167/// Return Dwarf Version by checking module flags.
168static unsigned getDwarfVersionFromModule(const Module *M) {
Manman Ren8bfde892013-07-16 23:21:16 +0000169 Value *Val = M->getModuleFlag("Dwarf Version");
170 if (!Val)
Eric Christophere31e0722013-09-04 22:21:24 +0000171 return dwarf::DWARF_VERSION;
Manman Ren8bfde892013-07-16 23:21:16 +0000172 return cast<ConstantInt>(Val)->getZExtValue();
Manman Renac8062b2013-07-02 23:40:10 +0000173}
174
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000175DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
David Blaikie0504cda2013-12-05 07:43:55 +0000176 : Asm(A), MMI(Asm->MMI), FirstCU(0), SourceIdMap(DIEValueAllocator),
David Blaikie2666e242013-12-06 19:38:46 +0000177 PrevLabel(NULL), GlobalRangeCount(0),
Eric Christopher1bca60d2014-01-23 22:55:47 +0000178 InfoHolder(A, "info_string", DIEValueAllocator), HasCURanges(false),
Eric Christopher2037caf2014-01-28 00:49:26 +0000179 UsedNonDefaultText(false),
David Blaikie0504cda2013-12-05 07:43:55 +0000180 SkeletonHolder(A, "skel_string", DIEValueAllocator) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000181
Eric Christopher50effa02014-01-03 02:16:44 +0000182 DwarfInfoSectionSym = DwarfAbbrevSectionSym = DwarfStrSectionSym = 0;
Eric Christopher74804332013-02-07 21:19:50 +0000183 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
Eric Christopher55863be2013-04-07 03:43:09 +0000184 DwarfAddrSectionSym = 0;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000185 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000186 FunctionBeginSym = FunctionEndSym = 0;
Eric Christophera5a79422013-12-09 23:32:48 +0000187 CurFn = 0;
188 CurMI = 0;
Eric Christopherad9fe892012-04-02 17:58:52 +0000189
Adrian Prantl5bf1d002013-10-15 20:26:37 +0000190 // Turn on accelerator tables for Darwin by default, pubnames by
191 // default for non-Darwin, and handle split dwarf.
Eric Christopher203e12b2013-04-27 01:07:52 +0000192 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
Eric Christopher4977f212012-08-23 22:36:36 +0000193
Eric Christopher574b5c82013-08-19 21:41:38 +0000194 if (DwarfAccelTables == Default)
195 HasDwarfAccelTables = IsDarwin;
196 else
Eric Christopher5297df02013-08-26 20:58:35 +0000197 HasDwarfAccelTables = DwarfAccelTables == Enable;
Eric Christopher20b76a72012-08-23 22:36:40 +0000198
Eric Christophercdf218d2012-12-10 19:51:21 +0000199 if (SplitDwarf == Default)
200 HasSplitDwarf = false;
Eric Christopher29424312012-11-12 22:22:20 +0000201 else
Eric Christopher574b5c82013-08-19 21:41:38 +0000202 HasSplitDwarf = SplitDwarf == Enable;
Eric Christopher29424312012-11-12 22:22:20 +0000203
Eric Christopher4d36ca02013-08-26 23:24:35 +0000204 if (DwarfPubSections == Default)
205 HasDwarfPubSections = !IsDarwin;
Eric Christopher574b5c82013-08-19 21:41:38 +0000206 else
Eric Christopher4d36ca02013-08-26 23:24:35 +0000207 HasDwarfPubSections = DwarfPubSections == Enable;
Eric Christopher7da24882013-08-19 21:07:38 +0000208
Eric Christopher942f22c2014-01-11 00:28:12 +0000209 DwarfVersion = DwarfVersionNumber
210 ? DwarfVersionNumber
211 : getDwarfVersionFromModule(MMI->getModule());
Manman Renac8062b2013-07-02 23:40:10 +0000212
Dan Gohman6e681a52010-06-18 15:56:31 +0000213 {
214 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopher58f41952012-11-19 22:42:15 +0000215 beginModule();
Torok Edwinf8dba242010-04-07 10:44:46 +0000216 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000217}
Bill Wendling2f921f82009-05-15 09:23:25 +0000218
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000219// Switch to the specified MCSection and emit an assembler
220// temporary label to it if SymbolStem is specified.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000221static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christophera7b61892011-11-07 09:18:38 +0000222 const char *SymbolStem = 0) {
223 Asm->OutStreamer.SwitchSection(Section);
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000224 if (!SymbolStem)
225 return 0;
Eric Christophera7b61892011-11-07 09:18:38 +0000226
227 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
228 Asm->OutStreamer.EmitLabel(TmpSym);
229 return TmpSym;
230}
231
Eric Christopherf8194852013-12-05 18:06:10 +0000232DwarfFile::~DwarfFile() {
Eric Christophera5a79422013-12-09 23:32:48 +0000233 for (SmallVectorImpl<DwarfUnit *>::iterator I = CUs.begin(), E = CUs.end();
234 I != E; ++I)
David Blaikie72f1a3e2013-11-23 01:17:34 +0000235 delete *I;
236}
237
Eric Christopherf8194852013-12-05 18:06:10 +0000238MCSymbol *DwarfFile::getStringPoolSym() {
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000239 return Asm->GetTempSymbol(StringPref);
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000240}
241
Eric Christopherf8194852013-12-05 18:06:10 +0000242MCSymbol *DwarfFile::getStringPoolEntry(StringRef Str) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000243 std::pair<MCSymbol *, unsigned> &Entry =
244 StringPool.GetOrCreateValue(Str).getValue();
245 if (Entry.first)
246 return Entry.first;
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000247
248 Entry.second = NextStringPoolNumber++;
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000249 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000250}
251
Eric Christopherf8194852013-12-05 18:06:10 +0000252unsigned DwarfFile::getStringPoolIndex(StringRef Str) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000253 std::pair<MCSymbol *, unsigned> &Entry =
254 StringPool.GetOrCreateValue(Str).getValue();
255 if (Entry.first)
256 return Entry.second;
Eric Christopher2cbd5762013-01-07 19:32:41 +0000257
258 Entry.second = NextStringPoolNumber++;
259 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
260 return Entry.second;
261}
262
Eric Christopherf8194852013-12-05 18:06:10 +0000263unsigned DwarfFile::getAddrPoolIndex(const MCSymbol *Sym) {
David Blaikie8466ca82013-07-01 23:55:52 +0000264 return getAddrPoolIndex(MCSymbolRefExpr::Create(Sym, Asm->OutContext));
265}
266
Eric Christopherf8194852013-12-05 18:06:10 +0000267unsigned DwarfFile::getAddrPoolIndex(const MCExpr *Sym) {
Ulrich Weigand8b3d2262013-07-02 18:46:46 +0000268 std::pair<DenseMap<const MCExpr *, unsigned>::iterator, bool> P =
David Blaikieb8ef7852013-06-28 18:47:19 +0000269 AddressPool.insert(std::make_pair(Sym, NextAddrPoolNumber));
David Blaikiea67de2b2013-06-28 18:55:13 +0000270 if (P.second)
271 ++NextAddrPoolNumber;
David Blaikieb8ef7852013-06-28 18:47:19 +0000272 return P.first->second;
Eric Christopher962c9082013-01-15 23:56:56 +0000273}
274
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000275// Define a unique number for the abbreviation.
276//
Eric Christopherf8194852013-12-05 18:06:10 +0000277void DwarfFile::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000278 // Check the set for priors.
David Blaikie0504cda2013-12-05 07:43:55 +0000279 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000280
281 // If it's newly added.
282 if (InSet == &Abbrev) {
283 // Add to abbreviation list.
David Blaikie2d4e1122013-10-30 17:14:24 +0000284 Abbreviations.push_back(&Abbrev);
Bill Wendling2f921f82009-05-15 09:23:25 +0000285
286 // Assign the vector position + 1 as its number.
David Blaikie2d4e1122013-10-30 17:14:24 +0000287 Abbrev.setNumber(Abbreviations.size());
Bill Wendling2f921f82009-05-15 09:23:25 +0000288 } else {
289 // Assign existing abbreviation number.
290 Abbrev.setNumber(InSet->getNumber());
291 }
292}
293
Eric Christopherd9843b32011-11-10 19:25:34 +0000294static bool isObjCClass(StringRef Name) {
295 return Name.startswith("+") || Name.startswith("-");
296}
297
298static bool hasObjCCategory(StringRef Name) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000299 if (!isObjCClass(Name))
300 return false;
Eric Christopherd9843b32011-11-10 19:25:34 +0000301
Benjamin Kramer260de742013-08-24 12:15:54 +0000302 return Name.find(") ") != StringRef::npos;
Eric Christopherd9843b32011-11-10 19:25:34 +0000303}
304
305static void getObjCClassCategory(StringRef In, StringRef &Class,
306 StringRef &Category) {
307 if (!hasObjCCategory(In)) {
308 Class = In.slice(In.find('[') + 1, In.find(' '));
309 Category = "";
310 return;
311 }
312
313 Class = In.slice(In.find('[') + 1, In.find('('));
314 Category = In.slice(In.find('[') + 1, In.find(' '));
315 return;
316}
317
318static StringRef getObjCMethodName(StringRef In) {
319 return In.slice(In.find(' ') + 1, In.find(']'));
320}
321
Richard Mittonc2508242013-10-03 22:07:08 +0000322// Helper for sorting sections into a stable output order.
323static bool SectionSort(const MCSection *A, const MCSection *B) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000324 std::string LA = (A ? A->getLabelBeginName() : "");
325 std::string LB = (B ? B->getLabelBeginName() : "");
326 return LA < LB;
Richard Mittonc2508242013-10-03 22:07:08 +0000327}
328
Eric Christopherd9843b32011-11-10 19:25:34 +0000329// Add the various names to the Dwarf accelerator table names.
Eric Christopher9cd26af2013-09-20 23:22:52 +0000330// TODO: Determine whether or not we should add names for programs
331// that do not have a DW_AT_name or DW_AT_linkage_name field - this
332// is only slightly different than the lookup of non-standard ObjC names.
Eric Christophera5a79422013-12-09 23:32:48 +0000333static void addSubprogramNames(DwarfUnit *TheU, DISubprogram SP, DIE *Die) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000334 if (!SP.isDefinition())
335 return;
David Blaikie2a80e442013-12-02 22:09:48 +0000336 TheU->addAccelName(SP.getName(), Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000337
338 // If the linkage name is different than the name, go ahead and output
339 // that as well into the name table.
340 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
David Blaikie2a80e442013-12-02 22:09:48 +0000341 TheU->addAccelName(SP.getLinkageName(), Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000342
343 // If this is an Objective-C selector name add it to the ObjC accelerator
344 // too.
345 if (isObjCClass(SP.getName())) {
346 StringRef Class, Category;
347 getObjCClassCategory(SP.getName(), Class, Category);
David Blaikie2a80e442013-12-02 22:09:48 +0000348 TheU->addAccelObjC(Class, Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000349 if (Category != "")
David Blaikie2a80e442013-12-02 22:09:48 +0000350 TheU->addAccelObjC(Category, Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000351 // Also add the base method name to the name table.
David Blaikie2a80e442013-12-02 22:09:48 +0000352 TheU->addAccelName(getObjCMethodName(SP.getName()), Die);
Eric Christopherd9843b32011-11-10 19:25:34 +0000353 }
354}
355
Manman Ren3eb9dff2013-09-09 19:05:21 +0000356/// isSubprogramContext - Return true if Context is either a subprogram
357/// or another context nested inside a subprogram.
358bool DwarfDebug::isSubprogramContext(const MDNode *Context) {
359 if (!Context)
360 return false;
361 DIDescriptor D(Context);
362 if (D.isSubprogram())
363 return true;
364 if (D.isType())
Manman Ren116868e2013-09-09 19:47:11 +0000365 return isSubprogramContext(resolve(DIType(Context).getContext()));
Manman Ren3eb9dff2013-09-09 19:05:21 +0000366 return false;
367}
368
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000369// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
370// and DW_AT_high_pc attributes. If there are global variables in this
371// scope then create and insert DIEs for these variables.
Eric Christopher4287a492013-12-09 23:57:44 +0000372DIE *DwarfDebug::updateSubprogramScopeDIE(DwarfCompileUnit *SPCU,
373 DISubprogram SP) {
David Blaikie25bc7192013-11-15 23:13:08 +0000374 DIE *SPDie = SPCU->getDIE(SP);
Devang Patela37a95e2010-07-07 22:20:57 +0000375
Chris Lattner3a383cb2010-04-05 00:13:49 +0000376 assert(SPDie && "Unable to find subprogram DIE!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000377
Bill Wendlingf720bf62012-11-07 05:19:04 +0000378 // If we're updating an abstract DIE, then we will be adding the children and
379 // object pointer later on. But what we don't want to do is process the
380 // concrete DIE twice.
David Blaikie25bc7192013-11-15 23:13:08 +0000381 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SP)) {
Bill Wendlingf720bf62012-11-07 05:19:04 +0000382 // Pick up abstract subprogram DIE.
David Blaikie2a80e442013-12-02 22:09:48 +0000383 SPDie =
384 SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram, *SPCU->getUnitDie());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000385 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin, AbsSPDIE);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000386 } else {
387 DISubprogram SPDecl = SP.getFunctionDeclaration();
388 if (!SPDecl.isSubprogram()) {
389 // There is not any need to generate specification DIE for a function
390 // defined at compile unit level. If a function is defined inside another
391 // function then gdb prefers the definition at top level and but does not
392 // expect specification DIE in parent function. So avoid creating
393 // specification DIE for a function defined inside a function.
Manman Renc50fa112013-10-10 18:40:01 +0000394 DIScope SPContext = resolve(SP.getContext());
395 if (SP.isDefinition() && !SPContext.isCompileUnit() &&
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000396 !SPContext.isFile() && !isSubprogramContext(SPContext)) {
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000397 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
398
399 // Add arguments.
400 DICompositeType SPTy = SP.getType();
401 DIArray Args = SPTy.getTypeArray();
Eric Christopher31b05762013-08-08 01:41:00 +0000402 uint16_t SPTag = SPTy.getTag();
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000403 if (SPTag == dwarf::DW_TAG_subroutine_type)
404 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
Manman Ren4a841a82013-10-29 01:03:01 +0000405 DIE *Arg =
406 SPCU->createAndAddDIE(dwarf::DW_TAG_formal_parameter, *SPDie);
David Blaikie5af2aca2013-11-18 23:57:26 +0000407 DIType ATy(Args.getElement(i));
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000408 SPCU->addType(Arg, ATy);
409 if (ATy.isArtificial())
410 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
411 if (ATy.isObjectPointer())
Manman Ren4c4b69c2013-10-11 23:58:05 +0000412 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer, Arg);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000413 }
414 DIE *SPDeclDie = SPDie;
David Blaikie2a80e442013-12-02 22:09:48 +0000415 SPDie = SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram,
416 *SPCU->getUnitDie());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000417 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, SPDeclDie);
Bill Wendlingd9bb9b62012-11-07 04:42:18 +0000418 }
419 }
Devang Patela37a95e2010-07-07 22:20:57 +0000420 }
421
David Blaikieb7a1c4d2013-12-04 17:55:41 +0000422 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc, FunctionBeginSym);
423 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc, FunctionEndSym);
Eric Christopher0f63d062013-12-03 00:45:45 +0000424
Chris Lattner3a383cb2010-04-05 00:13:49 +0000425 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
426 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000427 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000428
Eric Christopherd9843b32011-11-10 19:25:34 +0000429 // Add name to the name table, we do this here because we're guaranteed
430 // to have concrete versions of our DW_TAG_subprogram nodes.
431 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher6a841382012-11-19 22:42:10 +0000432
Chris Lattner3a383cb2010-04-05 00:13:49 +0000433 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000434}
435
Manman Ren5b2f4b02013-09-11 19:40:28 +0000436/// Check whether we should create a DIE for the given Scope, return true
437/// if we don't create a DIE (the corresponding DIE is null).
Manman Ren2312ed32013-09-10 18:40:41 +0000438bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
439 if (Scope->isAbstractScope())
440 return false;
441
Manman Ren5b2f4b02013-09-11 19:40:28 +0000442 // We don't create a DIE if there is no Range.
Manman Ren2312ed32013-09-10 18:40:41 +0000443 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
444 if (Ranges.empty())
445 return true;
446
447 if (Ranges.size() > 1)
448 return false;
449
Manman Ren5b2f4b02013-09-11 19:40:28 +0000450 // We don't create a DIE if we have a single Range and the end label
451 // is null.
Manman Ren2312ed32013-09-10 18:40:41 +0000452 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
453 MCSymbol *End = getLabelAfterInsn(RI->second);
454 return !End;
455}
456
Eric Christophera5a79422013-12-09 23:32:48 +0000457static void addSectionLabel(AsmPrinter *Asm, DwarfUnit *U, DIE *D,
Eric Christopherc31fe2d2013-12-05 00:36:17 +0000458 dwarf::Attribute A, const MCSymbol *L,
459 const MCSymbol *Sec) {
460 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
461 U->addSectionLabel(D, A, L);
462 else
463 U->addSectionDelta(D, A, L, Sec);
464}
465
Eric Christopher4287a492013-12-09 23:57:44 +0000466void DwarfDebug::addScopeRangeList(DwarfCompileUnit *TheCU, DIE *ScopeDIE,
Eric Christopherbe2513e2013-12-03 00:45:59 +0000467 const SmallVectorImpl<InsnRange> &Range) {
468 // Emit offset in .debug_range as a relocatable label. emitDIE will handle
469 // emitting it appropriately.
Eric Christopherf8790642013-12-04 22:04:50 +0000470 MCSymbol *RangeSym = Asm->GetTempSymbol("debug_ranges", GlobalRangeCount++);
Eric Christopherc31fe2d2013-12-05 00:36:17 +0000471 addSectionLabel(Asm, TheCU, ScopeDIE, dwarf::DW_AT_ranges, RangeSym,
472 DwarfDebugRangeSectionSym);
473
Eric Christopherf8790642013-12-04 22:04:50 +0000474 RangeSpanList List(RangeSym);
Eric Christopherbe2513e2013-12-03 00:45:59 +0000475 for (SmallVectorImpl<InsnRange>::const_iterator RI = Range.begin(),
476 RE = Range.end();
477 RI != RE; ++RI) {
478 RangeSpan Span(getLabelBeforeInsn(RI->first),
479 getLabelAfterInsn(RI->second));
Eric Christopher270ba4a2013-12-04 19:06:58 +0000480 List.addRange(llvm_move(Span));
Eric Christopherbe2513e2013-12-03 00:45:59 +0000481 }
482
483 // Add the range list to the set of ranges to be emitted.
Eric Christopher270ba4a2013-12-04 19:06:58 +0000484 TheCU->addRangeList(llvm_move(List));
Eric Christopherbe2513e2013-12-03 00:45:59 +0000485}
486
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000487// Construct new DW_TAG_lexical_block for this scope and attach
488// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher4287a492013-12-09 23:57:44 +0000489DIE *DwarfDebug::constructLexicalScopeDIE(DwarfCompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000490 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000491 if (isLexicalScopeDIENull(Scope))
492 return 0;
493
Devang Patel6c74a872010-04-27 19:46:33 +0000494 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
495 if (Scope->isAbstractScope())
496 return ScopeDIE;
497
Eric Christopher0f63d062013-12-03 00:45:45 +0000498 const SmallVectorImpl<InsnRange> &ScopeRanges = Scope->getRanges();
Eric Christopherbe2513e2013-12-03 00:45:59 +0000499
Eric Christopherdc42ea82013-07-03 01:57:28 +0000500 // If we have multiple ranges, emit them into the range section.
Eric Christopher0f63d062013-12-03 00:45:45 +0000501 if (ScopeRanges.size() > 1) {
Eric Christopherbe2513e2013-12-03 00:45:59 +0000502 addScopeRangeList(TheCU, ScopeDIE, ScopeRanges);
Devang Patel6c74a872010-04-27 19:46:33 +0000503 return ScopeDIE;
504 }
505
Eric Christopherdc42ea82013-07-03 01:57:28 +0000506 // Construct the address range for this DIE.
Eric Christopher0f63d062013-12-03 00:45:45 +0000507 SmallVectorImpl<InsnRange>::const_iterator RI = ScopeRanges.begin();
Eric Christopher962c9082013-01-15 23:56:56 +0000508 MCSymbol *Start = getLabelBeforeInsn(RI->first);
509 MCSymbol *End = getLabelAfterInsn(RI->second);
Manman Ren2312ed32013-09-10 18:40:41 +0000510 assert(End && "End label should not be null!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000511
Chris Lattnere13c3722010-03-09 01:58:53 +0000512 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
513 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000514
Eric Christopher962c9082013-01-15 23:56:56 +0000515 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
516 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000517
518 return ScopeDIE;
519}
520
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000521// This scope represents inlined body of a function. Construct DIE to
522// represent this concrete inlined copy of the function.
Eric Christopher4287a492013-12-09 23:57:44 +0000523DIE *DwarfDebug::constructInlinedScopeDIE(DwarfCompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000524 LexicalScope *Scope) {
Eric Christopher0f63d062013-12-03 00:45:45 +0000525 const SmallVectorImpl<InsnRange> &ScopeRanges = Scope->getRanges();
Eric Christopher1cdb63d2013-12-04 21:20:15 +0000526 assert(!ScopeRanges.empty() &&
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000527 "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000528
Devang Patelf098ce22011-07-27 00:34:13 +0000529 if (!Scope->getScopeNode())
530 return NULL;
531 DIScope DS(Scope->getScopeNode());
532 DISubprogram InlinedSP = getDISubprogram(DS);
Eric Christophere595bae2013-10-04 17:08:38 +0000533 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patelf098ce22011-07-27 00:34:13 +0000534 if (!OriginDIE) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000535 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patelf098ce22011-07-27 00:34:13 +0000536 return NULL;
537 }
538
Devang Patel73bc1722011-05-05 17:54:26 +0000539 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Manman Ren4c4b69c2013-10-11 23:58:05 +0000540 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000541
Eric Christopherbe2513e2013-12-03 00:45:59 +0000542 // If we have multiple ranges, emit them into the range section.
543 if (ScopeRanges.size() > 1)
544 addScopeRangeList(TheCU, ScopeDIE, ScopeRanges);
545 else {
Eric Christopher0f63d062013-12-03 00:45:45 +0000546 SmallVectorImpl<InsnRange>::const_iterator RI = ScopeRanges.begin();
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000547 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
548 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
549
550 if (StartLabel == 0 || EndLabel == 0)
551 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
552
553 assert(StartLabel->isDefined() &&
554 "Invalid starting label for an inlined scope!");
555 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
556
Eric Christopher962c9082013-01-15 23:56:56 +0000557 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
558 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patelf098ce22011-07-27 00:34:13 +0000559 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000560
561 InlinedSubprogramDIEs.insert(OriginDIE);
562
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000563 // Add the call site information to the DIE.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000564 DILocation DL(Scope->getInlinedAt());
David Blaikief2443192013-10-21 17:28:37 +0000565 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, None,
Manman Ren1e427202013-03-07 01:42:00 +0000566 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
567 TheCU->getUniqueID()));
David Blaikief2443192013-10-21 17:28:37 +0000568 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, None, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000569
Eric Christopher8dda5d02011-12-04 06:02:38 +0000570 // Add name to the name table, we do this here because we're guaranteed
571 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
572 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher6a841382012-11-19 22:42:10 +0000573
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000574 return ScopeDIE;
575}
576
Eric Christopher4287a492013-12-09 23:57:44 +0000577DIE *DwarfDebug::createScopeChildrenDIE(DwarfCompileUnit *TheCU,
578 LexicalScope *Scope,
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000579 SmallVectorImpl<DIE *> &Children) {
580 DIE *ObjectPointer = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +0000581
582 // Collect arguments for current function.
Devang Patel7e623022011-08-10 20:55:27 +0000583 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000584 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
585 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher6a841382012-11-19 22:42:10 +0000586 if (DIE *Arg =
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000587 TheCU->constructVariableDIE(*ArgDV, Scope->isAbstractScope())) {
Devang Patel6c622ef2011-03-01 22:58:55 +0000588 Children.push_back(Arg);
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000589 if (ArgDV->isObjectPointer())
590 ObjectPointer = Arg;
Eric Christophere3417762012-09-12 23:36:19 +0000591 }
Devang Patel6c622ef2011-03-01 22:58:55 +0000592
Eric Christopherf84354b2011-10-03 15:49:16 +0000593 // Collect lexical scope children first.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000594 const SmallVectorImpl<DbgVariable *> &Variables =
595 ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000596 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000597 if (DIE *Variable = TheCU->constructVariableDIE(*Variables[i],
598 Scope->isAbstractScope())) {
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000599 Children.push_back(Variable);
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000600 if (Variables[i]->isObjectPointer())
601 ObjectPointer = Variable;
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000602 }
Craig Topper977e9cd2013-07-03 04:24:43 +0000603 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000604 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Patel3acc70e2011-08-15 22:04:40 +0000605 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000606 Children.push_back(Nested);
Manman Ren2312ed32013-09-10 18:40:41 +0000607 return ObjectPointer;
608}
609
610// Construct a DIE for this scope.
Eric Christopher4287a492013-12-09 23:57:44 +0000611DIE *DwarfDebug::constructScopeDIE(DwarfCompileUnit *TheCU,
612 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000613 if (!Scope || !Scope->getScopeNode())
614 return NULL;
615
616 DIScope DS(Scope->getScopeNode());
617
618 SmallVector<DIE *, 8> Children;
619 DIE *ObjectPointer = NULL;
620 bool ChildrenCreated = false;
621
Manman Ren5b2f4b02013-09-11 19:40:28 +0000622 // We try to create the scope DIE first, then the children DIEs. This will
623 // avoid creating un-used children then removing them later when we find out
624 // the scope DIE is null.
Devang Patel3b548aa2010-03-08 20:52:55 +0000625 DIE *ScopeDIE = NULL;
626 if (Scope->getInlinedAt())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000627 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3b548aa2010-03-08 20:52:55 +0000628 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000629 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000630 if (Scope->isAbstractScope()) {
Eric Christophere595bae2013-10-04 17:08:38 +0000631 ScopeDIE = TheCU->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000632 // Note down abstract DIE.
633 if (ScopeDIE)
634 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
David Blaikiee26a3772013-11-18 23:59:04 +0000635 } else
David Blaikie25bc7192013-11-15 23:13:08 +0000636 ScopeDIE = updateSubprogramScopeDIE(TheCU, DISubprogram(DS));
David Blaikiee26a3772013-11-18 23:59:04 +0000637 } else {
Manman Ren5b2f4b02013-09-11 19:40:28 +0000638 // Early exit when we know the scope DIE is going to be null.
Manman Ren2312ed32013-09-10 18:40:41 +0000639 if (isLexicalScopeDIENull(Scope))
640 return NULL;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000641
642 // We create children here when we know the scope DIE is not going to be
643 // null and the children will be added to the scope DIE.
Manman Ren2312ed32013-09-10 18:40:41 +0000644 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
645 ChildrenCreated = true;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000646
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000647 // There is no need to emit empty lexical block DIE.
David Blaikie684fc532013-05-06 23:33:07 +0000648 std::pair<ImportedEntityMap::const_iterator,
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000649 ImportedEntityMap::const_iterator> Range =
650 std::equal_range(
651 ScopesWithImportedEntities.begin(),
652 ScopesWithImportedEntities.end(),
653 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode *)0),
654 less_first());
David Blaikie684fc532013-05-06 23:33:07 +0000655 if (Children.empty() && Range.first == Range.second)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000656 return NULL;
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000657 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Manman Ren2312ed32013-09-10 18:40:41 +0000658 assert(ScopeDIE && "Scope DIE should not be null.");
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000659 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
660 ++i)
David Blaikie4dd2de72013-05-08 06:01:38 +0000661 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000662 }
Eric Christopher6a841382012-11-19 22:42:10 +0000663
Benjamin Kramer892daba2013-08-24 11:55:49 +0000664 if (!ScopeDIE) {
Manman Ren2312ed32013-09-10 18:40:41 +0000665 assert(Children.empty() &&
666 "We create children only when the scope DIE is not null.");
Benjamin Kramer892daba2013-08-24 11:55:49 +0000667 return NULL;
668 }
Manman Ren2312ed32013-09-10 18:40:41 +0000669 if (!ChildrenCreated)
Manman Ren5b2f4b02013-09-11 19:40:28 +0000670 // We create children when the scope DIE is not null.
Manman Ren2312ed32013-09-10 18:40:41 +0000671 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000672
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000673 // Add children
Craig Topperd8e43652013-07-03 04:17:25 +0000674 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000675 E = Children.end();
676 I != E; ++I)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000677 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000678
Eric Christophere3417762012-09-12 23:36:19 +0000679 if (DS.isSubprogram() && ObjectPointer != NULL)
Manman Ren4c4b69c2013-10-11 23:58:05 +0000680 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, ObjectPointer);
Eric Christophere3417762012-09-12 23:36:19 +0000681
Eric Christopherd9843b32011-11-10 19:25:34 +0000682 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000683}
684
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000685// Look up the source id with the given directory and source file names.
686// If none currently exists, create a new id and insert it in the
687// SourceIds map. This can update DirectoryNames and SourceFileNames maps
688// as well.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000689unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName, StringRef DirName,
690 unsigned CUID) {
Rafael Espindolab4eec1d2014-02-05 18:00:21 +0000691 // If we print assembly, we can't separate .file entries according to
Manman Ren1e427202013-03-07 01:42:00 +0000692 // compile units. Thus all files will belong to the default compile unit.
Rafael Espindolaac4ad252013-10-05 16:42:21 +0000693
694 // FIXME: add a better feature test than hasRawTextSupport. Even better,
695 // extend .file to support this.
Rafael Espindolab4eec1d2014-02-05 18:00:21 +0000696 if (Asm->OutStreamer.hasRawTextSupport())
Manman Ren1e427202013-03-07 01:42:00 +0000697 CUID = 0;
698
Devang Patel871d0b12010-09-16 20:57:49 +0000699 // If FE did not provide a file name, then assume stdin.
700 if (FileName.empty())
Manman Ren1e427202013-03-07 01:42:00 +0000701 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patele01b75c2011-03-24 20:30:50 +0000702
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000703 // TODO: this might not belong here. See if we can factor this better.
704 if (DirName == CompilationDir)
705 DirName = "";
706
Manman Ren1e427202013-03-07 01:42:00 +0000707 // FileIDCUMap stores the current ID for the given compile unit.
708 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel871d0b12010-09-16 20:57:49 +0000709
Manman Ren1e427202013-03-07 01:42:00 +0000710 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer71b19732012-03-11 14:56:26 +0000711 SmallString<128> NamePair;
Manman Ren5b22f9f2013-04-06 01:02:38 +0000712 NamePair += utostr(CUID);
Manman Ren1e427202013-03-07 01:42:00 +0000713 NamePair += '\0';
Benjamin Kramer71b19732012-03-11 14:56:26 +0000714 NamePair += DirName;
715 NamePair += '\0'; // Zero bytes are not allowed in paths.
716 NamePair += FileName;
717
718 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
719 if (Ent.getValue() != SrcId)
720 return Ent.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +0000721
Manman Ren1e427202013-03-07 01:42:00 +0000722 FileIDCUMap[CUID] = SrcId;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000723 // Print out a .file directive to specify files for .loc directives.
Manman Ren1e427202013-03-07 01:42:00 +0000724 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendling2b128d72009-05-20 23:19:06 +0000725
726 return SrcId;
727}
728
Eric Christophera5a79422013-12-09 23:32:48 +0000729void DwarfDebug::addGnuPubAttributes(DwarfUnit *U, DIE *D) const {
David Blaikie3c842622013-12-04 21:31:26 +0000730 if (!GenerateGnuPubSections)
731 return;
732
733 addSectionLabel(Asm, U, D, dwarf::DW_AT_GNU_pubnames,
734 Asm->GetTempSymbol("gnu_pubnames", U->getUniqueID()),
735 DwarfGnuPubNamesSectionSym);
736
737 addSectionLabel(Asm, U, D, dwarf::DW_AT_GNU_pubtypes,
738 Asm->GetTempSymbol("gnu_pubtypes", U->getUniqueID()),
739 DwarfGnuPubTypesSectionSym);
740}
741
Eric Christopher4287a492013-12-09 23:57:44 +0000742// Create new DwarfCompileUnit for the given metadata node with tag
Eric Christopher48fef592012-12-20 21:58:40 +0000743// DW_TAG_compile_unit.
Eric Christopher4287a492013-12-09 23:57:44 +0000744DwarfCompileUnit *DwarfDebug::constructDwarfCompileUnit(DICompileUnit DIUnit) {
Devang Patel2d9caf92009-11-25 17:36:49 +0000745 StringRef FN = DIUnit.getFilename();
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000746 CompilationDir = DIUnit.getDirectory();
Bill Wendling2b128d72009-05-20 23:19:06 +0000747
748 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher4287a492013-12-09 23:57:44 +0000749 DwarfCompileUnit *NewCU = new DwarfCompileUnit(
750 InfoHolder.getUnits().size(), Die, DIUnit, Asm, this, &InfoHolder);
David Blaikie2666e242013-12-06 19:38:46 +0000751 InfoHolder.addUnit(NewCU);
752
Manman Ren1e427202013-03-07 01:42:00 +0000753 FileIDCUMap[NewCU->getUniqueID()] = 0;
754 // Call this to emit a .file directive if it wasn't emitted for the source
755 // file this CU comes from yet.
756 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
757
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
Manman Ren4e042a62013-02-05 21:52:47 +0000763 // Define start line table label for each Compile Unit.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000764 MCSymbol *LineTableStartSym =
765 Asm->GetTempSymbol("line_table_start", NewCU->getUniqueID());
Manman Ren4e042a62013-02-05 21:52:47 +0000766 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
767 NewCU->getUniqueID());
768
Rafael Espindolab4eec1d2014-02-05 18:00:21 +0000769 // Use a single line table if we are generating assembly.
Manman Ren9d4c7352013-05-21 00:57:22 +0000770 bool UseTheFirstCU =
Rafael Espindolab4eec1d2014-02-05 18:00:21 +0000771 Asm->OutStreamer.hasRawTextSupport() || (NewCU->getUniqueID() == 0);
Manman Ren9d4c7352013-05-21 00:57:22 +0000772
Eric Christopher52ce7182013-04-09 19:23:15 +0000773 if (!useSplitDwarf()) {
Eric Christophera51d3fc2013-09-27 22:50:48 +0000774 // DW_AT_stmt_list is a offset of line number information for this
775 // compile unit in debug_line section. For split dwarf this is
776 // left in the skeleton CU and so not included.
777 // The line table entries are not always emitted in assembly, so it
778 // is not okay to use line_table_start here.
Eric Christopher52ce7182013-04-09 19:23:15 +0000779 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christophera5a79422013-12-09 23:32:48 +0000780 NewCU->addSectionLabel(Die, dwarf::DW_AT_stmt_list,
781 UseTheFirstCU ? Asm->GetTempSymbol("section_line")
782 : LineTableStartSym);
Manman Ren9d4c7352013-05-21 00:57:22 +0000783 else if (UseTheFirstCU)
Eric Christopher33ff6972013-11-21 23:46:41 +0000784 NewCU->addSectionOffset(Die, dwarf::DW_AT_stmt_list, 0);
Eric Christopher52ce7182013-04-09 19:23:15 +0000785 else
Eric Christophera5a79422013-12-09 23:32:48 +0000786 NewCU->addSectionDelta(Die, dwarf::DW_AT_stmt_list, LineTableStartSym,
787 DwarfLineSectionSym);
Eric Christophera51d3fc2013-09-27 22:50:48 +0000788
789 // If we're using split dwarf the compilation dir is going to be in the
790 // skeleton CU and so we don't need to duplicate it here.
791 if (!CompilationDir.empty())
792 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
793
David Blaikie3c842622013-12-04 21:31:26 +0000794 addGnuPubAttributes(NewCU, Die);
Eric Christopher52ce7182013-04-09 19:23:15 +0000795 }
Bill Wendling2b128d72009-05-20 23:19:06 +0000796
Bill Wendling2b128d72009-05-20 23:19:06 +0000797 if (DIUnit.isOptimized())
Eric Christopherbb69a272012-08-24 01:14:27 +0000798 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendling2b128d72009-05-20 23:19:06 +0000799
Devang Patel2d9caf92009-11-25 17:36:49 +0000800 StringRef Flags = DIUnit.getFlags();
801 if (!Flags.empty())
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000802 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher6a841382012-11-19 22:42:10 +0000803
Nick Lewycky479a8fe2011-10-17 23:27:36 +0000804 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patelf20c4f72011-04-12 22:53:02 +0000805 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000806 dwarf::DW_FORM_data1, RVer);
Bill Wendling2b128d72009-05-20 23:19:06 +0000807
Devang Patel1a0df9a2010-05-10 22:49:55 +0000808 if (!FirstCU)
809 FirstCU = NewCU;
Eric Christopher7a2cdf72013-02-05 07:31:55 +0000810
Eric Christopherd4368fd2014-01-02 21:03:28 +0000811 if (useSplitDwarf()) {
812 NewCU->initSection(Asm->getObjFileLowering().getDwarfInfoDWOSection(),
813 DwarfInfoDWOSectionSym);
Eric Christopherd8667202013-12-30 17:22:27 +0000814 NewCU->setSkeleton(constructSkeletonCU(NewCU));
Eric Christopherd4368fd2014-01-02 21:03:28 +0000815 } else
816 NewCU->initSection(Asm->getObjFileLowering().getDwarfInfoSection(),
817 DwarfInfoSectionSym);
Eric Christopherd039baa2013-12-30 03:40:32 +0000818
David Blaikie5a152402013-11-15 23:52:02 +0000819 CUMap.insert(std::make_pair(DIUnit, NewCU));
Manman Rence20d462013-10-29 22:57:10 +0000820 CUDieMap.insert(std::make_pair(Die, NewCU));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000821 return NewCU;
Devang Patel1a0df9a2010-05-10 22:49:55 +0000822}
823
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000824// Construct subprogram DIE.
Eric Christopher4287a492013-12-09 23:57:44 +0000825void DwarfDebug::constructSubprogramDIE(DwarfCompileUnit *TheCU,
826 const MDNode *N) {
Eric Christopherffbc4de2013-10-18 01:57:30 +0000827 // FIXME: We should only call this routine once, however, during LTO if a
828 // program is defined in multiple CUs we could end up calling it out of
829 // beginModule as we walk the CUs.
830
Eric Christopher4287a492013-12-09 23:57:44 +0000831 DwarfCompileUnit *&CURef = SPMap[N];
Eric Christopherffbc4de2013-10-18 01:57:30 +0000832 if (CURef)
833 return;
834 CURef = TheCU;
Rafael Espindola6cf4e832011-11-04 19:00:29 +0000835
Devang Patel80ae3492009-08-28 23:24:31 +0000836 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000837 if (!SP.isDefinition())
838 // This is a method declaration which will be handled while constructing
839 // class type.
Devang Patel0751a282009-06-26 01:49:18 +0000840 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000841
Devang Patel89543712011-08-15 17:24:54 +0000842 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000843
Eric Christopherba506db2013-09-09 20:03:20 +0000844 // Expose as a global name.
Eric Christopher2c8b7902013-10-17 02:06:06 +0000845 TheCU->addGlobalName(SP.getName(), SubprogramDie, resolve(SP.getContext()));
Bill Wendling2b128d72009-05-20 23:19:06 +0000846}
847
Eric Christopher4287a492013-12-09 23:57:44 +0000848void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit *TheCU,
David Blaikief55abea2013-04-22 06:12:31 +0000849 const MDNode *N) {
David Blaikie1fd43652013-05-07 21:35:53 +0000850 DIImportedEntity Module(N);
David Blaikie5e390e42014-02-04 01:23:52 +0000851 assert(Module.Verify());
David Blaikie684fc532013-05-06 23:33:07 +0000852 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
David Blaikie4dd2de72013-05-08 06:01:38 +0000853 constructImportedEntityDIE(TheCU, Module, D);
David Blaikie684fc532013-05-06 23:33:07 +0000854}
855
Eric Christopher4287a492013-12-09 23:57:44 +0000856void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit *TheCU,
857 const MDNode *N, DIE *Context) {
David Blaikie1fd43652013-05-07 21:35:53 +0000858 DIImportedEntity Module(N);
David Blaikie5e390e42014-02-04 01:23:52 +0000859 assert(Module.Verify());
David Blaikie4dd2de72013-05-08 06:01:38 +0000860 return constructImportedEntityDIE(TheCU, Module, Context);
David Blaikie684fc532013-05-06 23:33:07 +0000861}
862
Eric Christopher4287a492013-12-09 23:57:44 +0000863void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit *TheCU,
David Blaikie1fd43652013-05-07 21:35:53 +0000864 const DIImportedEntity &Module,
David Blaikie684fc532013-05-06 23:33:07 +0000865 DIE *Context) {
866 assert(Module.Verify() &&
867 "Use one of the MDNode * overloads to handle invalid metadata");
868 assert(Context && "Should always have a context for an imported_module");
David Blaikie1fd43652013-05-07 21:35:53 +0000869 DIE *IMDie = new DIE(Module.getTag());
David Blaikief55abea2013-04-22 06:12:31 +0000870 TheCU->insertDIE(Module, IMDie);
David Blaikie1fd43652013-05-07 21:35:53 +0000871 DIE *EntityDie;
872 DIDescriptor Entity = Module.getEntity();
873 if (Entity.isNameSpace())
874 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
875 else if (Entity.isSubprogram())
876 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
David Blaikie3b6038b2013-05-08 06:01:41 +0000877 else if (Entity.isType())
878 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
David Blaikie1fd43652013-05-07 21:35:53 +0000879 else
David Blaikie3b6038b2013-05-08 06:01:41 +0000880 EntityDie = TheCU->getDIE(Entity);
David Blaikief55abea2013-04-22 06:12:31 +0000881 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
882 Module.getContext().getDirectory(),
883 TheCU->getUniqueID());
David Blaikief2443192013-10-21 17:28:37 +0000884 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, None, FileID);
885 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, None, Module.getLineNumber());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000886 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, EntityDie);
David Blaikiee63d5d12013-05-20 22:50:35 +0000887 StringRef Name = Module.getName();
888 if (!Name.empty())
889 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
David Blaikie684fc532013-05-06 23:33:07 +0000890 Context->addChild(IMDie);
David Blaikief55abea2013-04-22 06:12:31 +0000891}
892
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000893// Emit all Dwarf sections that should come prior to the content. Create
894// global DIEs and emit initial debug info sections. This is invoked by
895// the target AsmPrinter.
Eric Christopher58f41952012-11-19 22:42:15 +0000896void DwarfDebug::beginModule() {
Devang Patel6c74a872010-04-27 19:46:33 +0000897 if (DisableDebugInfoPrinting)
898 return;
899
Eric Christopher58f41952012-11-19 22:42:15 +0000900 const Module *M = MMI->getModule();
901
Nick Lewycky019d2552011-07-29 03:49:23 +0000902 // If module has named metadata anchors then use them, otherwise scan the
903 // module using debug info finder to collect debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000904 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
David Blaikiedc69ebb2013-03-11 23:39:23 +0000905 if (!CU_Nodes)
Devang Patel07bb9ee2011-08-15 23:47:24 +0000906 return;
Manman Ren60352032013-09-05 18:48:31 +0000907 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
Devang Patele02e5852011-05-03 16:45:22 +0000908
David Blaikiedc69ebb2013-03-11 23:39:23 +0000909 // Emit initial sections so we can reference labels later.
910 emitSectionLabels();
911
912 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
913 DICompileUnit CUNode(CU_Nodes->getOperand(i));
Eric Christopher4287a492013-12-09 23:57:44 +0000914 DwarfCompileUnit *CU = constructDwarfCompileUnit(CUNode);
David Blaikie1fd43652013-05-07 21:35:53 +0000915 DIArray ImportedEntities = CUNode.getImportedEntities();
916 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
David Blaikie684fc532013-05-06 23:33:07 +0000917 ScopesWithImportedEntities.push_back(std::make_pair(
David Blaikie1fd43652013-05-07 21:35:53 +0000918 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
919 ImportedEntities.getElement(i)));
David Blaikie684fc532013-05-06 23:33:07 +0000920 std::sort(ScopesWithImportedEntities.begin(),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000921 ScopesWithImportedEntities.end(), less_first());
David Blaikiedc69ebb2013-03-11 23:39:23 +0000922 DIArray GVs = CUNode.getGlobalVariables();
923 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
David Blaikiea781b25b2013-11-17 21:55:13 +0000924 CU->createGlobalVariableDIE(DIGlobalVariable(GVs.getElement(i)));
David Blaikiedc69ebb2013-03-11 23:39:23 +0000925 DIArray SPs = CUNode.getSubprograms();
926 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
927 constructSubprogramDIE(CU, SPs.getElement(i));
928 DIArray EnumTypes = CUNode.getEnumTypes();
929 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
930 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
931 DIArray RetainedTypes = CUNode.getRetainedTypes();
932 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
933 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
David Blaikief55abea2013-04-22 06:12:31 +0000934 // Emit imported_modules last so that the relevant context is already
935 // available.
David Blaikie1fd43652013-05-07 21:35:53 +0000936 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
937 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
David Blaikiedc69ebb2013-03-11 23:39:23 +0000938 }
Eric Christopher6a841382012-11-19 22:42:10 +0000939
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000940 // Tell MMI that we have debug info.
941 MMI->setDebugInfoAvailability(true);
Eric Christopher6a841382012-11-19 22:42:10 +0000942
Bill Wendling2b128d72009-05-20 23:19:06 +0000943 // Prime section data.
Richard Mitton21101b32013-09-19 23:21:01 +0000944 SectionMap[Asm->getObjFileLowering().getTextSection()];
Bill Wendling2b128d72009-05-20 23:19:06 +0000945}
946
Eric Christopher960ac372012-11-22 00:59:49 +0000947// Attach DW_AT_inline attribute with inlined subprogram DIEs.
948void DwarfDebug::computeInlinedDIEs() {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000949 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
950 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000951 AE = InlinedSubprogramDIEs.end();
952 AI != AE; ++AI) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000953 DIE *ISP = *AI;
David Blaikief2443192013-10-21 17:28:37 +0000954 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000955 }
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000956 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000957 AE = AbstractSPDies.end();
958 AI != AE; ++AI) {
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000959 DIE *ISP = AI->second;
960 if (InlinedSubprogramDIEs.count(ISP))
961 continue;
David Blaikief2443192013-10-21 17:28:37 +0000962 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000963 }
Eric Christopher960ac372012-11-22 00:59:49 +0000964}
965
966// Collect info for variables that were optimized out.
967void DwarfDebug::collectDeadVariables() {
968 const Module *M = MMI->getModule();
Eric Christopher960ac372012-11-22 00:59:49 +0000969
970 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
971 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
972 DICompileUnit TheCU(CU_Nodes->getOperand(i));
973 DIArray Subprograms = TheCU.getSubprograms();
974 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopher735401c2012-11-27 00:13:51 +0000975 DISubprogram SP(Subprograms.getElement(i));
Eric Christophera6c38a32013-10-15 23:31:38 +0000976 if (ProcessedSPNodes.count(SP) != 0)
977 continue;
978 if (!SP.isSubprogram())
979 continue;
980 if (!SP.isDefinition())
981 continue;
Eric Christopher735401c2012-11-27 00:13:51 +0000982 DIArray Variables = SP.getVariables();
Eric Christophera6c38a32013-10-15 23:31:38 +0000983 if (Variables.getNumElements() == 0)
984 continue;
Eric Christopher960ac372012-11-22 00:59:49 +0000985
Eric Christopher735401c2012-11-27 00:13:51 +0000986 // Construct subprogram DIE and add variables DIEs.
Eric Christopher4287a492013-12-09 23:57:44 +0000987 DwarfCompileUnit *SPCU =
988 static_cast<DwarfCompileUnit *>(CUMap.lookup(TheCU));
Eric Christopher735401c2012-11-27 00:13:51 +0000989 assert(SPCU && "Unable to find Compile Unit!");
Eric Christopherc798d8a2013-10-22 00:22:39 +0000990 // FIXME: See the comment in constructSubprogramDIE about duplicate
991 // subprogram DIEs.
992 constructSubprogramDIE(SPCU, SP);
993 DIE *SPDIE = SPCU->getDIE(SP);
Eric Christopher735401c2012-11-27 00:13:51 +0000994 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
995 DIVariable DV(Variables.getElement(vi));
Eric Christophera6c38a32013-10-15 23:31:38 +0000996 if (!DV.isVariable())
997 continue;
Manman Renb3388602013-10-05 01:43:03 +0000998 DbgVariable NewVar(DV, NULL, this);
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000999 if (DIE *VariableDIE = SPCU->constructVariableDIE(NewVar, false))
Eric Christophera6c38a32013-10-15 23:31:38 +00001000 SPDIE->addChild(VariableDIE);
Eric Christopher735401c2012-11-27 00:13:51 +00001001 }
Eric Christopher960ac372012-11-22 00:59:49 +00001002 }
1003 }
1004 }
Eric Christopher960ac372012-11-22 00:59:49 +00001005}
1006
1007void DwarfDebug::finalizeModuleInfo() {
1008 // Collect info for variables that were optimized out.
1009 collectDeadVariables();
1010
1011 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1012 computeInlinedDIEs();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001013
Eric Christopherad10cb52013-12-04 23:24:38 +00001014 // Handle anything that needs to be done on a per-unit basis after
1015 // all other generation.
Eric Christophera5a79422013-12-09 23:32:48 +00001016 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
1017 E = getUnits().end();
David Blaikiefd1eff52013-11-26 19:14:34 +00001018 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00001019 DwarfUnit *TheU = *I;
Eric Christopher60eb7692013-08-12 20:27:48 +00001020 // Emit DW_AT_containing_type attribute to connect types with their
1021 // vtable holding type.
David Blaikie2a80e442013-12-02 22:09:48 +00001022 TheU->constructContainingTypeDIEs();
Eric Christopher60eb7692013-08-12 20:27:48 +00001023
Eric Christopher46e23432013-12-20 04:16:18 +00001024 // Add CU specific attributes if we need to add any.
1025 if (TheU->getUnitDie()->getTag() == dwarf::DW_TAG_compile_unit) {
1026 // If we're splitting the dwarf out now that we've got the entire
Eric Christopherd8667202013-12-30 17:22:27 +00001027 // CU then add the dwo id to it.
1028 DwarfCompileUnit *SkCU =
1029 static_cast<DwarfCompileUnit *>(TheU->getSkeleton());
Eric Christopher46e23432013-12-20 04:16:18 +00001030 if (useSplitDwarf()) {
1031 // This should be a unique identifier when we want to build .dwp files.
1032 uint64_t ID = 0;
1033 if (GenerateCUHash) {
1034 DIEHash CUHash;
1035 ID = CUHash.computeCUSignature(*TheU->getUnitDie());
1036 }
1037 TheU->addUInt(TheU->getUnitDie(), dwarf::DW_AT_GNU_dwo_id,
1038 dwarf::DW_FORM_data8, ID);
Eric Christopher46e23432013-12-20 04:16:18 +00001039 SkCU->addUInt(SkCU->getUnitDie(), dwarf::DW_AT_GNU_dwo_id,
1040 dwarf::DW_FORM_data8, ID);
Eric Christopherd29614f2013-08-13 01:21:55 +00001041 }
Eric Christopherd8667202013-12-30 17:22:27 +00001042
Eric Christopher39cde8c2014-01-14 22:44:17 +00001043 // If we have code split among multiple sections or we've requested
1044 // it then emit a DW_AT_ranges attribute on the unit that will remain
1045 // in the .o file, otherwise add a DW_AT_low_pc.
Eric Christopherd8667202013-12-30 17:22:27 +00001046 // FIXME: Also add a high pc if we can.
Eric Christopher39cde8c2014-01-14 22:44:17 +00001047 // FIXME: We should use ranges if we have multiple compile units or
1048 // allow reordering of code ala .subsections_via_symbols in mach-o.
Eric Christopherd8667202013-12-30 17:22:27 +00001049 DwarfCompileUnit *U = SkCU ? SkCU : static_cast<DwarfCompileUnit *>(TheU);
Eric Christopher8873ada2014-01-29 22:22:56 +00001050 if (useCURanges() && TheU->getRanges().size()) {
Eric Christopherd8667202013-12-30 17:22:27 +00001051 addSectionLabel(Asm, U, U->getUnitDie(), dwarf::DW_AT_ranges,
1052 Asm->GetTempSymbol("cu_ranges", U->getUniqueID()),
1053 DwarfDebugRangeSectionSym);
Eric Christopher8873ada2014-01-29 22:22:56 +00001054
1055 // A DW_AT_low_pc attribute may also be specified in combination with
1056 // DW_AT_ranges to specify the default base address for use in location
1057 // lists (see Section 2.6.2) and range lists (see Section 2.17.3).
1058 U->addUInt(U->getUnitDie(), dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1059 0);
1060 } else
Eric Christophercf48ade2014-01-24 11:52:53 +00001061 U->addUInt(U->getUnitDie(), dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1062 0);
Eric Christopher60eb7692013-08-12 20:27:48 +00001063 }
1064 }
1065
1066 // Compute DIE offsets and sizes.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001067 InfoHolder.computeSizeAndOffsets();
1068 if (useSplitDwarf())
1069 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher960ac372012-11-22 00:59:49 +00001070}
1071
1072void DwarfDebug::endSections() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001073 // Filter labels by section.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001074 for (size_t n = 0; n < ArangeLabels.size(); n++) {
1075 const SymbolCU &SCU = ArangeLabels[n];
Richard Mitton21101b32013-09-19 23:21:01 +00001076 if (SCU.Sym->isInSection()) {
1077 // Make a note of this symbol and it's section.
1078 const MCSection *Section = &SCU.Sym->getSection();
1079 if (!Section->getKind().isMetadata())
1080 SectionMap[Section].push_back(SCU);
1081 } else {
1082 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1083 // appear in the output. This sucks as we rely on sections to build
1084 // arange spans. We can do it without, but it's icky.
1085 SectionMap[NULL].push_back(SCU);
1086 }
1087 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001088
Richard Mittonc2508242013-10-03 22:07:08 +00001089 // Build a list of sections used.
1090 std::vector<const MCSection *> Sections;
Richard Mitton21101b32013-09-19 23:21:01 +00001091 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1092 it++) {
1093 const MCSection *Section = it->first;
Richard Mittonc2508242013-10-03 22:07:08 +00001094 Sections.push_back(Section);
1095 }
1096
1097 // Sort the sections into order.
1098 // This is only done to ensure consistent output order across different runs.
1099 std::sort(Sections.begin(), Sections.end(), SectionSort);
1100
1101 // Add terminating symbols for each section.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001102 for (unsigned ID = 0; ID < Sections.size(); ID++) {
Richard Mittonc2508242013-10-03 22:07:08 +00001103 const MCSection *Section = Sections[ID];
Richard Mitton21101b32013-09-19 23:21:01 +00001104 MCSymbol *Sym = NULL;
1105
1106 if (Section) {
Richard Mittonc2508242013-10-03 22:07:08 +00001107 // We can't call MCSection::getLabelEndName, as it's only safe to do so
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001108 // if we know the section name up-front. For user-created sections, the
Eric Christopher95531b62014-01-29 22:06:21 +00001109 // resulting label may not be valid to use as a label. (section names can
1110 // use a greater set of characters on some systems)
Richard Mittonc2508242013-10-03 22:07:08 +00001111 Sym = Asm->GetTempSymbol("debug_end", ID);
Richard Mitton21101b32013-09-19 23:21:01 +00001112 Asm->OutStreamer.SwitchSection(Section);
1113 Asm->OutStreamer.EmitLabel(Sym);
1114 }
1115
1116 // Insert a final terminator.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001117 SectionMap[Section].push_back(SymbolCU(NULL, Sym));
Bill Wendling2b128d72009-05-20 23:19:06 +00001118 }
Eric Christopher1bca60d2014-01-23 22:55:47 +00001119
1120 // For now only turn on CU ranges if we've explicitly asked for it,
Eric Christopherfb8dd002014-01-29 22:06:27 +00001121 // we have -ffunction-sections enabled, we've emitted a function
1122 // into a unique section, or we're using LTO. If we're using LTO then
1123 // we can't know that any particular function in the module is correlated
1124 // to a particular CU and so we need to be conservative. At this point all
1125 // sections should be finalized except for dwarf sections.
1126 HasCURanges = DwarfCURanges || UsedNonDefaultText || (CUMap.size() > 1) ||
Eric Christopher1bca60d2014-01-23 22:55:47 +00001127 TargetMachine::getFunctionSections();
Eric Christopher960ac372012-11-22 00:59:49 +00001128}
Bill Wendling2b128d72009-05-20 23:19:06 +00001129
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001130// Emit all Dwarf sections that should come after the content.
Eric Christopher960ac372012-11-22 00:59:49 +00001131void DwarfDebug::endModule() {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001132 assert(CurFn == 0);
1133 assert(CurMI == 0);
Eric Christopher960ac372012-11-22 00:59:49 +00001134
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001135 if (!FirstCU)
1136 return;
Eric Christopher960ac372012-11-22 00:59:49 +00001137
1138 // End any existing sections.
1139 // TODO: Does this need to happen?
1140 endSections();
1141
1142 // Finalize the debug info for the module.
1143 finalizeModuleInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001144
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001145 emitDebugStr();
Eric Christopher9cd26af2013-09-20 23:22:52 +00001146
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001147 // Emit all the DIEs into a debug info section.
1148 emitDebugInfo();
Eric Christopher4c9b1192012-11-27 00:41:54 +00001149
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001150 // Corresponding abbreviations into a abbrev section.
1151 emitAbbreviations();
Eric Christopher95198f502012-11-27 22:43:42 +00001152
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001153 // Emit info into a debug loc section.
1154 emitDebugLoc();
Eric Christopher95198f502012-11-27 22:43:42 +00001155
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001156 // Emit info into a debug aranges section.
1157 emitDebugARanges();
Eric Christopher95198f502012-11-27 22:43:42 +00001158
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001159 // Emit info into a debug ranges section.
1160 emitDebugRanges();
Eric Christopher95198f502012-11-27 22:43:42 +00001161
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001162 if (useSplitDwarf()) {
1163 emitDebugStrDWO();
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001164 emitDebugInfoDWO();
Eric Christopher3c5a1912012-12-19 22:02:53 +00001165 emitDebugAbbrevDWO();
Eric Christopher962c9082013-01-15 23:56:56 +00001166 // Emit DWO addresses.
1167 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
Eric Christopher95198f502012-11-27 22:43:42 +00001168 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001169
Eric Christophera876b822012-08-23 07:32:06 +00001170 // Emit info into the dwarf accelerator table sections.
Eric Christopher20b76a72012-08-23 22:36:40 +00001171 if (useDwarfAccelTables()) {
Eric Christopher4996c702011-11-07 09:24:32 +00001172 emitAccelNames();
1173 emitAccelObjC();
1174 emitAccelNamespaces();
1175 emitAccelTypes();
1176 }
Eric Christopher6a841382012-11-19 22:42:10 +00001177
Eric Christopher4b358182013-08-30 00:40:17 +00001178 // Emit the pubnames and pubtypes sections if requested.
1179 if (HasDwarfPubSections) {
David Blaikie70a33202013-09-19 17:33:35 +00001180 emitDebugPubNames(GenerateGnuPubSections);
1181 emitDebugPubTypes(GenerateGnuPubSections);
Eric Christopher4b358182013-08-30 00:40:17 +00001182 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001183
Devang Pateld0701282010-08-02 17:32:15 +00001184 // clean up.
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001185 SPMap.clear();
Eric Christopher8afd7b62012-12-10 19:51:18 +00001186
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001187 // Reset these for the next Module if we have one.
1188 FirstCU = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001189}
1190
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001191// Find abstract variable, if any, associated with Var.
Devang Patelbb23a4a2011-08-10 21:50:54 +00001192DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattner915c5f92010-04-02 19:42:39 +00001193 DebugLoc ScopeLoc) {
Devang Patelbb23a4a2011-08-10 21:50:54 +00001194 LLVMContext &Ctx = DV->getContext();
1195 // More then one inlined variable corresponds to one abstract variable.
1196 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001197 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001198 if (AbsDbgVariable)
1199 return AbsDbgVariable;
1200
Devang Patel7e623022011-08-10 20:55:27 +00001201 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001202 if (!Scope)
1203 return NULL;
1204
Manman Renb3388602013-10-05 01:43:03 +00001205 AbsDbgVariable = new DbgVariable(Var, NULL, this);
Devang Patel7e623022011-08-10 20:55:27 +00001206 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001207 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001208 return AbsDbgVariable;
1209}
1210
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001211// If Var is a current function argument then add it to CurrentFnArguments list.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001212bool DwarfDebug::addCurrentFnArgument(DbgVariable *Var, LexicalScope *Scope) {
Devang Patel7e623022011-08-10 20:55:27 +00001213 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +00001214 return false;
1215 DIVariable DV = Var->getVariable();
1216 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1217 return false;
1218 unsigned ArgNo = DV.getArgNumber();
Eric Christopher6a841382012-11-19 22:42:10 +00001219 if (ArgNo == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001220 return false;
1221
Devang Patel4ab660b2011-03-03 20:02:02 +00001222 size_t Size = CurrentFnArguments.size();
1223 if (Size == 0)
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001224 CurrentFnArguments.resize(CurFn->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001225 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001226 // arguments does the function have at source level.
1227 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001228 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001229 CurrentFnArguments[ArgNo - 1] = Var;
1230 return true;
1231}
1232
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001233// Collect variable information from side table maintained by MMI.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001234void DwarfDebug::collectVariableInfoFromMMITable(
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001235 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001236 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1237 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001238 VE = VMap.end();
1239 VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001240 const MDNode *Var = VI->first;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001241 if (!Var)
1242 continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001243 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001244 DIVariable DV(Var);
1245 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001246
Devang Patel7e623022011-08-10 20:55:27 +00001247 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001248
Devang Patelcdb7d442009-11-10 23:20:04 +00001249 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001250 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001251 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001252
Devang Patele1c53f22010-05-20 16:36:41 +00001253 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Manman Renb3388602013-10-05 01:43:03 +00001254 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
Devang Patel3e4a9652011-08-15 21:24:36 +00001255 RegVar->setFrameIndex(VP.first);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001256 if (!addCurrentFnArgument(RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001257 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001258 if (AbsDbgVariable)
Devang Patel3e4a9652011-08-15 21:24:36 +00001259 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patel475d32a2009-10-06 01:26:37 +00001260 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001261}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001262
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001263// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1264// defined reg.
Devang Patel9fc11702010-05-25 23:40:22 +00001265static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001266 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001267 return MI->getNumOperands() == 3 && MI->getOperand(0).isReg() &&
1268 MI->getOperand(0).getReg() &&
Adrian Prantl418d1d12013-07-09 20:28:37 +00001269 (MI->getOperand(1).isImm() ||
1270 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
Devang Patel9fc11702010-05-25 23:40:22 +00001271}
1272
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001273// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher6a841382012-11-19 22:42:10 +00001274static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1275 const MCSymbol *FLabel,
Devang Patel2442a892011-07-08 17:09:57 +00001276 const MCSymbol *SLabel,
1277 const MachineInstr *MI) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001278 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Devang Patel2442a892011-07-08 17:09:57 +00001279
David Blaikie0252265b2013-06-16 20:34:15 +00001280 assert(MI->getNumOperands() == 3);
Adrian Prantl418d1d12013-07-09 20:28:37 +00001281 if (MI->getOperand(0).isReg()) {
Devang Patel2442a892011-07-08 17:09:57 +00001282 MachineLocation MLoc;
Adrian Prantl418d1d12013-07-09 20:28:37 +00001283 // If the second operand is an immediate, this is a
1284 // register-indirect address.
1285 if (!MI->getOperand(1).isImm())
Adrian Prantld4c0dd42013-04-26 21:57:17 +00001286 MLoc.set(MI->getOperand(0).getReg());
1287 else
1288 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel2442a892011-07-08 17:09:57 +00001289 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1290 }
1291 if (MI->getOperand(0).isImm())
1292 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1293 if (MI->getOperand(0).isFPImm())
1294 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1295 if (MI->getOperand(0).isCImm())
1296 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1297
Craig Topperee4dab52012-02-05 08:31:47 +00001298 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel2442a892011-07-08 17:09:57 +00001299}
1300
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001301// Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001302void
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001303DwarfDebug::collectVariableInfo(SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001304
Eric Christopher270a12c2013-07-03 21:37:03 +00001305 // Grab the variable info that was squirreled away in the MMI side-table.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001306 collectVariableInfoFromMMITable(Processed);
Devang Patel490c8ab2010-05-20 19:57:06 +00001307
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001308 for (SmallVectorImpl<const MDNode *>::const_iterator
1309 UVI = UserVariables.begin(),
1310 UVE = UserVariables.end();
1311 UVI != UVE; ++UVI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001312 const MDNode *Var = *UVI;
1313 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001314 continue;
1315
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001316 // History contains relevant DBG_VALUE instructions for Var and instructions
1317 // clobbering it.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001318 SmallVectorImpl<const MachineInstr *> &History = DbgValues[Var];
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001319 if (History.empty())
1320 continue;
1321 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001322
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001323 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001324 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001325 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001326 DISubprogram(DV.getContext()).describes(CurFn->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +00001327 Scope = LScopes.getCurrentFunctionScope();
David Blaikiedc69ebb2013-03-11 23:39:23 +00001328 else if (MDNode *IA = DV.getInlinedAt())
1329 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1330 else
1331 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel490c8ab2010-05-20 19:57:06 +00001332 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001333 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001334 continue;
1335
1336 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001337 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel99819b52011-08-15 19:01:20 +00001338 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
Manman Renb3388602013-10-05 01:43:03 +00001339 DbgVariable *RegVar = new DbgVariable(DV, AbsVar, this);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001340 if (!addCurrentFnArgument(RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001341 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001342 if (AbsVar)
Devang Patel3e4a9652011-08-15 21:24:36 +00001343 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001344
Eric Christophercc10d202012-10-08 20:48:54 +00001345 // Simplify ranges that are fully coalesced.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001346 if (History.size() <= 1 ||
1347 (History.size() == 2 && MInsn->isIdenticalTo(History.back()))) {
Devang Patel3e4a9652011-08-15 21:24:36 +00001348 RegVar->setMInsn(MInsn);
Devang Patel9fc11702010-05-25 23:40:22 +00001349 continue;
1350 }
1351
Eric Christopher59cc0712013-01-28 17:33:26 +00001352 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001353 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001354
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001355 for (SmallVectorImpl<const MachineInstr *>::const_iterator
1356 HI = History.begin(),
1357 HE = History.end();
1358 HI != HE; ++HI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001359 const MachineInstr *Begin = *HI;
1360 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001361
Devang Patele7181b52011-06-01 23:00:17 +00001362 // Check if DBG_VALUE is truncating a range.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001363 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg() &&
1364 !Begin->getOperand(0).getReg())
Devang Patele7181b52011-06-01 23:00:17 +00001365 continue;
1366
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001367 // Compute the range for a register location.
1368 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1369 const MCSymbol *SLabel = 0;
1370
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001371 if (HI + 1 == HE)
1372 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001373 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001374 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001375 else {
1376 const MachineInstr *End = HI[1];
Eric Christopher6a841382012-11-19 22:42:10 +00001377 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001378 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001379 if (End->isDebugValue())
1380 SLabel = getLabelBeforeInsn(End);
1381 else {
1382 // End is a normal instruction clobbering the range.
1383 SLabel = getLabelAfterInsn(End);
1384 assert(SLabel && "Forgot label after clobber instruction");
1385 ++HI;
1386 }
1387 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001388
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001389 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001390 DotDebugLocEntries.push_back(
1391 getDebugLocEntry(Asm, FLabel, SLabel, Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001392 }
1393 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001394 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001395
1396 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001397 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1398 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1399 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1400 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001401 if (!DV || !DV.isVariable() || !Processed.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001402 continue;
1403 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001404 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patele0a94bf2010-05-14 21:01:35 +00001405 }
Devang Patel9fc11702010-05-25 23:40:22 +00001406}
Devang Patele0a94bf2010-05-14 21:01:35 +00001407
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001408// Return Label preceding the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001409MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001410 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1411 assert(Label && "Didn't insert label before instruction");
1412 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001413}
1414
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001415// Return Label immediately following the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001416MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001417 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001418}
1419
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001420// Process beginning of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001421void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001422 assert(CurMI == 0);
1423 CurMI = MI;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001424 // Check if source location changes, but ignore DBG_VALUE locations.
1425 if (!MI->isDebugValue()) {
1426 DebugLoc DL = MI->getDebugLoc();
1427 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopheraec8a822012-04-05 20:39:05 +00001428 unsigned Flags = 0;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001429 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001430 if (DL == PrologEndLoc) {
1431 Flags |= DWARF2_FLAG_PROLOGUE_END;
1432 PrologEndLoc = DebugLoc();
1433 }
Eric Christopheraec8a822012-04-05 20:39:05 +00001434 if (PrologEndLoc.isUnknown())
1435 Flags |= DWARF2_FLAG_IS_STMT;
1436
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001437 if (!DL.isUnknown()) {
1438 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001439 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001440 } else
Devang Patel34a66202011-05-11 19:22:19 +00001441 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001442 }
Devang Patel9fc11702010-05-25 23:40:22 +00001443 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001444
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001445 // Insert labels where requested.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001446 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
1447 LabelsBeforeInsn.find(MI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001448
1449 // No label needed.
1450 if (I == LabelsBeforeInsn.end())
1451 return;
1452
1453 // Label already assigned.
1454 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001455 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001456
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001457 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001458 PrevLabel = MMI->getContext().CreateTempSymbol();
1459 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001460 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001461 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001462}
1463
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001464// Process end of an instruction.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001465void DwarfDebug::endInstruction() {
1466 assert(CurMI != 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001467 // Don't create a new label after DBG_VALUE instructions.
1468 // They don't generate code.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001469 if (!CurMI->isDebugValue())
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001470 PrevLabel = 0;
1471
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001472 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001473 LabelsAfterInsn.find(CurMI);
1474 CurMI = 0;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001475
1476 // No label needed.
1477 if (I == LabelsAfterInsn.end())
1478 return;
1479
1480 // Label already assigned.
1481 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001482 return;
1483
1484 // We need a label after this instruction.
1485 if (!PrevLabel) {
1486 PrevLabel = MMI->getContext().CreateTempSymbol();
1487 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001488 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001489 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001490}
1491
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001492// Each LexicalScope has first instruction and last instruction to mark
1493// beginning and end of a scope respectively. Create an inverse map that list
1494// scopes starts (and ends) with an instruction. One instruction may start (or
1495// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001496void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001497 SmallVector<LexicalScope *, 4> WorkList;
1498 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001499 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001500 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001501
Craig Topper977e9cd2013-07-03 04:24:43 +00001502 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001503 if (!Children.empty())
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001504 for (SmallVectorImpl<LexicalScope *>::const_iterator
1505 SI = Children.begin(),
1506 SE = Children.end();
1507 SI != SE; ++SI)
Devang Patel7771b7c2010-01-20 02:05:23 +00001508 WorkList.push_back(*SI);
1509
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001510 if (S->isAbstractScope())
1511 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001512
Craig Topper977e9cd2013-07-03 04:24:43 +00001513 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001514 if (Ranges.empty())
1515 continue;
Craig Topperd8e43652013-07-03 04:17:25 +00001516 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001517 RE = Ranges.end();
1518 RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001519 assert(RI->first && "InsnRange does not have first instruction!");
1520 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001521 requestLabelBeforeInsn(RI->first);
1522 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001523 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001524 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001525}
1526
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001527// Gather pre-function debug information. Assumes being called immediately
1528// after the function entry point has been emitted.
Chris Lattner76555b52010-01-26 23:18:02 +00001529void DwarfDebug::beginFunction(const MachineFunction *MF) {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001530 CurFn = MF;
Eric Christopherfedfa442013-11-01 23:14:17 +00001531
1532 // If there's no debug info for the function we're not going to do anything.
1533 if (!MMI->hasDebugInfo())
1534 return;
1535
1536 // Grab the lexical scopes for the function, if we don't have any of those
1537 // then we're not going to be able to do anything.
Devang Patel7e623022011-08-10 20:55:27 +00001538 LScopes.initialize(*MF);
Eric Christopherfedfa442013-11-01 23:14:17 +00001539 if (LScopes.empty())
1540 return;
1541
1542 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1543
1544 // Make sure that each lexical scope will have a begin/end label.
Devang Patel7e623022011-08-10 20:55:27 +00001545 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001546
Eric Christopher4287a492013-12-09 23:57:44 +00001547 // Set DwarfDwarfCompileUnitID in MCContext to the Compile Unit this function
Eric Christopherfedfa442013-11-01 23:14:17 +00001548 // belongs to so that we add to the correct per-cu line table in the
1549 // non-asm case.
Manman Ren4e042a62013-02-05 21:52:47 +00001550 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Eric Christopher4287a492013-12-09 23:57:44 +00001551 DwarfCompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Manman Ren4e042a62013-02-05 21:52:47 +00001552 assert(TheCU && "Unable to find compile unit!");
Rafael Espindolab4eec1d2014-02-05 18:00:21 +00001553 if (Asm->OutStreamer.hasRawTextSupport())
1554 // Use a single line table if we are generating assembly.
Manman Ren9d4c7352013-05-21 00:57:22 +00001555 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1556 else
1557 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
Manman Ren4e042a62013-02-05 21:52:47 +00001558
Eric Christopher2037caf2014-01-28 00:49:26 +00001559 // Check the current section against the standard text section. If different
1560 // keep track so that we will know when we're emitting functions into multiple
1561 // sections.
1562 if (Asm->getObjFileLowering().getTextSection() != Asm->getCurrentSection())
1563 UsedNonDefaultText = true;
1564
Eric Christopherfedfa442013-11-01 23:14:17 +00001565 // Emit a label for the function so that we have a beginning address.
1566 FunctionBeginSym = Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001567 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001568 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001569
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001570 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001571 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Eric Christopherfedfa442013-11-01 23:14:17 +00001572 std::vector<const MDNode *> LiveUserVar(TRI->getNumRegs());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001573
Eric Christopherfedfa442013-11-01 23:14:17 +00001574 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end(); I != E;
1575 ++I) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001576 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001577 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1578 II != IE; ++II) {
1579 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001580
Devang Patel002d54d2010-05-26 19:37:24 +00001581 if (MI->isDebugValue()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001582 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001583
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001584 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001585 const MDNode *Var =
Eric Christopherfedfa442013-11-01 23:14:17 +00001586 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001587
1588 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001589 if (isDbgValueInDefinedReg(MI))
1590 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1591
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001592 // Check the history of this variable.
Eric Christopherfedfa442013-11-01 23:14:17 +00001593 SmallVectorImpl<const MachineInstr *> &History = DbgValues[Var];
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001594 if (History.empty()) {
1595 UserVariables.push_back(Var);
1596 // The first mention of a function argument gets the FunctionBeginSym
1597 // label, so arguments are visible when breaking at function entry.
1598 DIVariable DV(Var);
Manman Ren7504ed42013-07-08 18:33:29 +00001599 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
David Blaikie5af2aca2013-11-18 23:57:26 +00001600 getDISubprogram(DV.getContext()).describes(MF->getFunction()))
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001601 LabelsBeforeInsn[MI] = FunctionBeginSym;
1602 } else {
1603 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1604 const MachineInstr *Prev = History.back();
1605 if (Prev->isDebugValue()) {
1606 // Coalesce identical entries at the end of History.
1607 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001608 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher85a495e2012-10-08 20:48:49 +00001609 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopherfedfa442013-11-01 23:14:17 +00001610 << "\t" << *Prev << "\t"
1611 << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001612 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001613 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001614
1615 // Terminate old register assignments that don't reach MI;
1616 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1617 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1618 isDbgValueInDefinedReg(Prev)) {
1619 // Previous register assignment needs to terminate at the end of
1620 // its basic block.
1621 MachineBasicBlock::const_iterator LastMI =
Eric Christopherfedfa442013-11-01 23:14:17 +00001622 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001623 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001624 // Drop DBG_VALUE for empty range.
Eric Christopher85a495e2012-10-08 20:48:49 +00001625 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Eric Christopherfedfa442013-11-01 23:14:17 +00001626 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001627 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001628 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001629 // Terminate after LastMI.
1630 History.push_back(LastMI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001631 }
1632 }
1633 }
1634 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001635 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001636 // Not a DBG_VALUE instruction.
1637 if (!MI->isLabel())
1638 AtBlockEntry = false;
1639
Eric Christopher133195782012-10-04 20:46:14 +00001640 // First known non-DBG_VALUE and non-frame setup location marks
1641 // the beginning of the function body.
1642 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1643 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel34a66202011-05-11 19:22:19 +00001644 PrologEndLoc = MI->getDebugLoc();
1645
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001646 // Check if the instruction clobbers any registers with debug vars.
1647 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
Eric Christopherfedfa442013-11-01 23:14:17 +00001648 MOE = MI->operands_end();
1649 MOI != MOE; ++MOI) {
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001650 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1651 continue;
Eric Christopherfedfa442013-11-01 23:14:17 +00001652 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true); AI.isValid();
1653 ++AI) {
Jakob Stoklund Olesen54038d72012-06-01 23:28:30 +00001654 unsigned Reg = *AI;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001655 const MDNode *Var = LiveUserVar[Reg];
1656 if (!Var)
1657 continue;
1658 // Reg is now clobbered.
1659 LiveUserVar[Reg] = 0;
1660
1661 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001662 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1663 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001664 continue;
Eric Christopherfedfa442013-11-01 23:14:17 +00001665 SmallVectorImpl<const MachineInstr *> &History = HistI->second;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001666 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001667 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001668 const MachineInstr *Prev = History.back();
1669 // Sanity-check: Register assignments are terminated at the end of
1670 // their block.
1671 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1672 continue;
1673 // Is the variable still in Reg?
1674 if (!isDbgValueInDefinedReg(Prev) ||
1675 Prev->getOperand(0).getReg() != Reg)
1676 continue;
1677 // Var is clobbered. Make sure the next instruction gets a label.
1678 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001679 }
1680 }
Devang Patel002d54d2010-05-26 19:37:24 +00001681 }
Devang Patel002d54d2010-05-26 19:37:24 +00001682 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001683 }
1684
1685 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1686 I != E; ++I) {
Eric Christopherfedfa442013-11-01 23:14:17 +00001687 SmallVectorImpl<const MachineInstr *> &History = I->second;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001688 if (History.empty())
1689 continue;
1690
1691 // Make sure the final register assignments are terminated.
1692 const MachineInstr *Prev = History.back();
1693 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1694 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher6a841382012-11-19 22:42:10 +00001695 MachineBasicBlock::const_iterator LastMI =
Eric Christopherfedfa442013-11-01 23:14:17 +00001696 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001697 if (LastMI == PrevMBB->end())
1698 // Drop DBG_VALUE for empty range.
1699 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001700 else if (PrevMBB != &PrevMBB->getParent()->back()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001701 // Terminate after LastMI.
1702 History.push_back(LastMI);
1703 }
1704 }
1705 // Request labels for the full history.
1706 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1707 const MachineInstr *MI = History[i];
1708 if (MI->isDebugValue())
1709 requestLabelBeforeInsn(MI);
1710 else
1711 requestLabelAfterInsn(MI);
1712 }
1713 }
Devang Patel002d54d2010-05-26 19:37:24 +00001714
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001715 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001716 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001717
1718 // Record beginning of function.
1719 if (!PrologEndLoc.isUnknown()) {
Eric Christopherfedfa442013-11-01 23:14:17 +00001720 DebugLoc FnStartDL =
Timur Iskhodzhanovf166f6c2014-01-30 01:39:17 +00001721 PrologEndLoc.getFnDebugLoc(MF->getFunction()->getContext());
Eric Christopherfedfa442013-11-01 23:14:17 +00001722 recordSourceLine(
1723 FnStartDL.getLine(), FnStartDL.getCol(),
1724 FnStartDL.getScope(MF->getFunction()->getContext()),
1725 // We'd like to list the prologue as "not statements" but GDB behaves
1726 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
1727 DWARF2_FLAG_IS_STMT);
Devang Patel34a66202011-05-11 19:22:19 +00001728 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001729}
1730
Devang Patel7e623022011-08-10 20:55:27 +00001731void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
David Blaikie6f1a8062013-06-05 05:39:59 +00001732 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1733 DIVariable DV = Var->getVariable();
David Blaikie36d5d2f2013-06-06 21:04:51 +00001734 // Variables with positive arg numbers are parameters.
1735 if (unsigned ArgNum = DV.getArgNumber()) {
1736 // Keep all parameters in order at the start of the variable list to ensure
1737 // function types are correct (no out-of-order parameters)
1738 //
1739 // This could be improved by only doing it for optimized builds (unoptimized
1740 // builds have the right order to begin with), searching from the back (this
1741 // would catch the unoptimized case quickly), or doing a binary search
1742 // rather than linear search.
1743 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1744 while (I != Vars.end()) {
1745 unsigned CurNum = (*I)->getVariable().getArgNumber();
1746 // A local (non-parameter) variable has been found, insert immediately
1747 // before it.
1748 if (CurNum == 0)
1749 break;
1750 // A later indexed parameter has been found, insert immediately before it.
David Blaikieb272a752013-06-06 22:28:26 +00001751 if (CurNum > ArgNum)
David Blaikie36d5d2f2013-06-06 21:04:51 +00001752 break;
David Blaikieb272a752013-06-06 22:28:26 +00001753 ++I;
David Blaikie6f1a8062013-06-05 05:39:59 +00001754 }
David Blaikie36d5d2f2013-06-06 21:04:51 +00001755 Vars.insert(I, Var);
1756 return;
David Blaikie6f1a8062013-06-05 05:39:59 +00001757 }
1758
1759 Vars.push_back(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001760}
1761
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001762// Gather and emit post-function debug information.
NAKAMURA Takumib9271612013-12-03 13:15:54 +00001763void DwarfDebug::endFunction(const MachineFunction *MF) {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001764 // Every beginFunction(MF) call should be followed by an endFunction(MF) call,
1765 // though the beginFunction may not be called at all.
1766 // We should handle both cases.
1767 if (CurFn == 0)
1768 CurFn = MF;
1769 else
1770 assert(CurFn == MF);
1771 assert(CurFn != 0);
1772
1773 if (!MMI->hasDebugInfo() || LScopes.empty()) {
1774 CurFn = 0;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001775 return;
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001776 }
Devang Patel2904aa92009-11-12 19:02:56 +00001777
Devang Patel7e623022011-08-10 20:55:27 +00001778 // Define end label for subprogram.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001779 FunctionEndSym = Asm->GetTempSymbol("func_end", Asm->getFunctionNumber());
Devang Patel7e623022011-08-10 20:55:27 +00001780 // Assumes in correct section after the entry point.
1781 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Eric Christopher1a972152014-01-29 23:05:43 +00001782
Eric Christopher4287a492013-12-09 23:57:44 +00001783 // Set DwarfDwarfCompileUnitID in MCContext to default value.
Manman Ren4e042a62013-02-05 21:52:47 +00001784 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher6a841382012-11-19 22:42:10 +00001785
Devang Patel7e623022011-08-10 20:55:27 +00001786 SmallPtrSet<const MDNode *, 16> ProcessedVars;
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001787 collectVariableInfo(ProcessedVars);
Eric Christopher6a841382012-11-19 22:42:10 +00001788
Devang Patel3acc70e2011-08-15 22:04:40 +00001789 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Eric Christopher4287a492013-12-09 23:57:44 +00001790 DwarfCompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001791 assert(TheCU && "Unable to find compile unit!");
Devang Patel3acc70e2011-08-15 22:04:40 +00001792
Devang Patel7e623022011-08-10 20:55:27 +00001793 // Construct abstract scopes.
Devang Patel44403472011-08-12 18:10:19 +00001794 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1795 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1796 LexicalScope *AScope = AList[i];
1797 DISubprogram SP(AScope->getScopeNode());
Manman Ren7504ed42013-07-08 18:33:29 +00001798 if (SP.isSubprogram()) {
Devang Patel7e623022011-08-10 20:55:27 +00001799 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001800 DIArray Variables = SP.getVariables();
1801 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1802 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001803 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001804 continue;
Alexey Samsonov39602782012-07-06 08:45:08 +00001805 // Check that DbgVariable for DV wasn't created earlier, when
1806 // findAbstractVariable() was called for inlined instance of DV.
1807 LLVMContext &Ctx = DV->getContext();
1808 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1809 if (AbstractVariables.lookup(CleanDV))
1810 continue;
Devang Patel59e27c52011-08-19 23:28:12 +00001811 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001812 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001813 }
1814 }
Devang Patel44403472011-08-12 18:10:19 +00001815 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Manman Ren4213c392013-05-29 17:16:59 +00001816 constructScopeDIE(TheCU, AScope);
Bill Wendling2b128d72009-05-20 23:19:06 +00001817 }
Eric Christopher6a841382012-11-19 22:42:10 +00001818
Devang Patel3acc70e2011-08-15 22:04:40 +00001819 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001820 if (!CurFn->getTarget().Options.DisableFramePointerElim(*CurFn))
Eric Christopherbb69a272012-08-24 01:14:27 +00001821 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Patel3acc70e2011-08-15 22:04:40 +00001822
Eric Christopher1a972152014-01-29 23:05:43 +00001823 // Add the range of this function to the list of ranges for the CU.
1824 RangeSpan Span(FunctionBeginSym, FunctionEndSym);
1825 TheCU->addRange(llvm_move(Span));
1826
Bill Wendling2b128d72009-05-20 23:19:06 +00001827 // Clear debug info
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001828 for (ScopeVariablesMap::iterator I = ScopeVariables.begin(),
1829 E = ScopeVariables.end();
1830 I != E; ++I)
Devang Patel7e623022011-08-10 20:55:27 +00001831 DeleteContainerPointers(I->second);
1832 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001833 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001834 UserVariables.clear();
1835 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001836 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001837 LabelsBeforeInsn.clear();
1838 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001839 PrevLabel = NULL;
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001840 CurFn = 0;
Bill Wendling2b128d72009-05-20 23:19:06 +00001841}
1842
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001843// Register a source line with debug info. Returns the unique label that was
1844// emitted and which provides correspondence to the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00001845void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1846 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00001847 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00001848 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00001849 unsigned Src = 1;
1850 if (S) {
1851 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00001852
Dan Gohman50849c62010-05-05 23:41:32 +00001853 if (Scope.isCompileUnit()) {
1854 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001855 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001856 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00001857 } else if (Scope.isFile()) {
1858 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00001859 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001860 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001861 } else if (Scope.isSubprogram()) {
1862 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001863 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001864 Dir = SP.getDirectory();
Eric Christopher6647b832011-10-11 22:59:11 +00001865 } else if (Scope.isLexicalBlockFile()) {
1866 DILexicalBlockFile DBF(S);
1867 Fn = DBF.getFilename();
1868 Dir = DBF.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001869 } else if (Scope.isLexicalBlock()) {
1870 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001871 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001872 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001873 } else
Craig Topperee4dab52012-02-05 08:31:47 +00001874 llvm_unreachable("Unexpected scope info");
Dan Gohman50849c62010-05-05 23:41:32 +00001875
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001876 Src = getOrCreateSourceID(
1877 Fn, Dir, Asm->OutStreamer.getContext().getDwarfCompileUnitID());
Dan Gohman50849c62010-05-05 23:41:32 +00001878 }
Nick Lewycky019d2552011-07-29 03:49:23 +00001879 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00001880}
1881
Bill Wendling806535f2009-05-20 23:22:40 +00001882//===----------------------------------------------------------------------===//
1883// Emit Methods
1884//===----------------------------------------------------------------------===//
1885
Manman Rence20d462013-10-29 22:57:10 +00001886// Compute the size and offset of a DIE. The offset is relative to start of the
1887// CU. It returns the offset after laying out the DIE.
Eric Christopherf8194852013-12-05 18:06:10 +00001888unsigned DwarfFile::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling480ff322009-05-20 23:21:38 +00001889 // Get the children.
1890 const std::vector<DIE *> &Children = Die->getChildren();
1891
Bill Wendling480ff322009-05-20 23:21:38 +00001892 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00001893 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00001894
1895 // Get the abbreviation for this DIE.
David Blaikieff3ab2c2013-12-05 01:01:41 +00001896 const DIEAbbrev &Abbrev = Die->getAbbrev();
Bill Wendling480ff322009-05-20 23:21:38 +00001897
1898 // Set DIE offset
1899 Die->setOffset(Offset);
1900
1901 // Start the size with the size of abbreviation code.
David Blaikieff3ab2c2013-12-05 01:01:41 +00001902 Offset += MCAsmInfo::getULEB128Size(Die->getAbbrevNumber());
Bill Wendling480ff322009-05-20 23:21:38 +00001903
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001904 const SmallVectorImpl<DIEValue *> &Values = Die->getValues();
David Blaikieff3ab2c2013-12-05 01:01:41 +00001905 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
Bill Wendling480ff322009-05-20 23:21:38 +00001906
1907 // Size the DIE attribute values.
1908 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1909 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001910 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001911
1912 // Size the DIE children if any.
1913 if (!Children.empty()) {
David Blaikieff3ab2c2013-12-05 01:01:41 +00001914 assert(Abbrev.getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
Bill Wendling480ff322009-05-20 23:21:38 +00001915 "Children flag not set");
1916
1917 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001918 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling480ff322009-05-20 23:21:38 +00001919
1920 // End of children marker.
1921 Offset += sizeof(int8_t);
1922 }
1923
1924 Die->setSize(Offset - Die->getOffset());
1925 return Offset;
1926}
1927
Eric Christopherb088d2d2013-10-24 21:05:08 +00001928// Compute the size and offset for each DIE.
Eric Christopherf8194852013-12-05 18:06:10 +00001929void DwarfFile::computeSizeAndOffsets() {
Manman Rence20d462013-10-29 22:57:10 +00001930 // Offset from the first CU in the debug info section is 0 initially.
1931 unsigned SecOffset = 0;
1932
Eric Christopherb088d2d2013-10-24 21:05:08 +00001933 // Iterate over each compile unit and set the size and offsets for each
1934 // DIE within each compile unit. All offsets are CU relative.
Eric Christophera5a79422013-12-09 23:32:48 +00001935 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = CUs.begin(),
1936 E = CUs.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001937 I != E; ++I) {
Manman Rence20d462013-10-29 22:57:10 +00001938 (*I)->setDebugInfoOffset(SecOffset);
1939
1940 // CU-relative offset is reset to 0 here.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001941 unsigned Offset = sizeof(int32_t) + // Length of Unit Info
David Blaikie6b288cf2013-10-30 20:42:41 +00001942 (*I)->getHeaderSize(); // Unit-specific headers
Manman Rence20d462013-10-29 22:57:10 +00001943
1944 // EndOffset here is CU-relative, after laying out
1945 // all of the CU DIE.
David Blaikie2a80e442013-12-02 22:09:48 +00001946 unsigned EndOffset = computeSizeAndOffset((*I)->getUnitDie(), Offset);
Manman Rence20d462013-10-29 22:57:10 +00001947 SecOffset += EndOffset;
Devang Patel1a0df9a2010-05-10 22:49:55 +00001948 }
Bill Wendling480ff322009-05-20 23:21:38 +00001949}
1950
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001951// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001952void DwarfDebug::emitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001953 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001954
Bill Wendling480ff322009-05-20 23:21:38 +00001955 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001956 DwarfInfoSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001957 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Eric Christopherd8667202013-12-30 17:22:27 +00001958 if (useSplitDwarf())
1959 DwarfInfoDWOSectionSym =
1960 emitSectionSym(Asm, TLOF.getDwarfInfoDWOSection(), "section_info_dwo");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001961 DwarfAbbrevSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001962 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher3c5a1912012-12-19 22:02:53 +00001963 if (useSplitDwarf())
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001964 DwarfAbbrevDWOSectionSym = emitSectionSym(
1965 Asm, TLOF.getDwarfAbbrevDWOSection(), "section_abbrev_dwo");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001966 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001967
Chris Lattner6629ca92010-04-04 22:59:04 +00001968 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001969 emitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00001970
Eric Christopher74804332013-02-07 21:19:50 +00001971 DwarfLineSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001972 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001973 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Eric Christopher261d2342013-09-23 20:55:35 +00001974 if (GenerateGnuPubSections) {
Eric Christopher39eebfa2013-09-30 23:14:16 +00001975 DwarfGnuPubNamesSectionSym =
1976 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
1977 DwarfGnuPubTypesSectionSym =
1978 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
Eric Christopher261d2342013-09-23 20:55:35 +00001979 } else if (HasDwarfPubSections) {
1980 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
1981 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Michael Gottesmanc89466f2013-09-04 04:39:38 +00001982 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00001983
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001984 DwarfStrSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001985 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher55863be2013-04-07 03:43:09 +00001986 if (useSplitDwarf()) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00001987 DwarfStrDWOSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001988 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher55863be2013-04-07 03:43:09 +00001989 DwarfAddrSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001990 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
Eric Christopher55863be2013-04-07 03:43:09 +00001991 }
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001992 DwarfDebugRangeSectionSym =
1993 emitSectionSym(Asm, TLOF.getDwarfRangesSection(), "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00001994
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001995 DwarfDebugLocSectionSym =
1996 emitSectionSym(Asm, TLOF.getDwarfLocSection(), "section_debug_loc");
Bill Wendling480ff322009-05-20 23:21:38 +00001997}
1998
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001999// Recursively emits a debug information entry.
David Blaikieff3ab2c2013-12-05 01:01:41 +00002000void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00002001 // Get the abbreviation for this DIE.
David Blaikieff3ab2c2013-12-05 01:01:41 +00002002 const DIEAbbrev &Abbrev = Die->getAbbrev();
Bill Wendling480ff322009-05-20 23:21:38 +00002003
Bill Wendling480ff322009-05-20 23:21:38 +00002004 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00002005 if (Asm->isVerbose())
David Blaikieff3ab2c2013-12-05 01:01:41 +00002006 Asm->OutStreamer.AddComment("Abbrev [" + Twine(Abbrev.getNumber()) +
2007 "] 0x" + Twine::utohexstr(Die->getOffset()) +
2008 ":0x" + Twine::utohexstr(Die->getSize()) + " " +
2009 dwarf::TagString(Abbrev.getTag()));
2010 Asm->EmitULEB128(Abbrev.getNumber());
Bill Wendling480ff322009-05-20 23:21:38 +00002011
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002012 const SmallVectorImpl<DIEValue *> &Values = Die->getValues();
David Blaikieff3ab2c2013-12-05 01:01:41 +00002013 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
Bill Wendling480ff322009-05-20 23:21:38 +00002014
2015 // Emit the DIE attribute values.
2016 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
David Blaikief2443192013-10-21 17:28:37 +00002017 dwarf::Attribute Attr = AbbrevData[i].getAttribute();
2018 dwarf::Form Form = AbbrevData[i].getForm();
Bill Wendling480ff322009-05-20 23:21:38 +00002019 assert(Form && "Too many attributes for DIE (check abbreviation)");
2020
Chris Lattner7bde8c02010-04-04 18:52:31 +00002021 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00002022 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002023
Bill Wendling480ff322009-05-20 23:21:38 +00002024 switch (Attr) {
Manman Rence20d462013-10-29 22:57:10 +00002025 case dwarf::DW_AT_abstract_origin:
2026 case dwarf::DW_AT_type:
2027 case dwarf::DW_AT_friend:
2028 case dwarf::DW_AT_specification:
2029 case dwarf::DW_AT_import:
2030 case dwarf::DW_AT_containing_type: {
2031 DIEEntry *E = cast<DIEEntry>(Values[i]);
2032 DIE *Origin = E->getEntry();
2033 unsigned Addr = Origin->getOffset();
2034 if (Form == dwarf::DW_FORM_ref_addr) {
2035 assert(!useSplitDwarf() && "TODO: dwo files can't have relocations.");
2036 // For DW_FORM_ref_addr, output the offset from beginning of debug info
2037 // section. Origin->getOffset() returns the offset from start of the
2038 // compile unit.
Eric Christopher4287a492013-12-09 23:57:44 +00002039 DwarfCompileUnit *CU = CUDieMap.lookup(Origin->getUnit());
Manman Rence20d462013-10-29 22:57:10 +00002040 assert(CU && "CUDie should belong to a CU.");
2041 Addr += CU->getDebugInfoOffset();
2042 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
David Blaikie03073f72013-12-06 22:14:48 +00002043 Asm->EmitLabelPlusOffset(CU->getSectionSym(), Addr,
Manman Rence20d462013-10-29 22:57:10 +00002044 DIEEntry::getRefAddrSize(Asm));
2045 else
David Blaikie03073f72013-12-06 22:14:48 +00002046 Asm->EmitLabelOffsetDifference(CU->getSectionSym(), Addr,
2047 CU->getSectionSym(),
Manman Ren251a1bd2013-10-29 23:14:15 +00002048 DIEEntry::getRefAddrSize(Asm));
Manman Rence20d462013-10-29 22:57:10 +00002049 } else {
Manman Ren4dbdc902013-10-31 17:54:35 +00002050 // Make sure Origin belong to the same CU.
David Blaikie409dd9c2013-11-19 23:08:21 +00002051 assert(Die->getUnit() == Origin->getUnit() &&
Manman Ren4dbdc902013-10-31 17:54:35 +00002052 "The referenced DIE should belong to the same CU in ref4");
Manman Rence20d462013-10-29 22:57:10 +00002053 Asm->EmitInt32(Addr);
2054 }
2055 break;
2056 }
Devang Patel9fc11702010-05-25 23:40:22 +00002057 case dwarf::DW_AT_location: {
Nick Lewycky33da3362012-06-22 01:25:12 +00002058 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2059 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopherd0b82ae2013-11-16 00:18:40 +00002060 Asm->EmitSectionOffset(L->getValue(), DwarfDebugLocSectionSym);
Nick Lewycky33da3362012-06-22 01:25:12 +00002061 else
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002062 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002063 } else {
Devang Patel9fc11702010-05-25 23:40:22 +00002064 Values[i]->EmitValue(Asm, Form);
Nick Lewycky33da3362012-06-22 01:25:12 +00002065 }
Devang Patel9fc11702010-05-25 23:40:22 +00002066 break;
2067 }
Devang Patela1bd5a12010-09-29 19:08:08 +00002068 case dwarf::DW_AT_accessibility: {
2069 if (Asm->isVerbose()) {
2070 DIEInteger *V = cast<DIEInteger>(Values[i]);
2071 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2072 }
2073 Values[i]->EmitValue(Asm, Form);
2074 break;
2075 }
Bill Wendling480ff322009-05-20 23:21:38 +00002076 default:
2077 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002078 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00002079 break;
2080 }
Bill Wendling480ff322009-05-20 23:21:38 +00002081 }
2082
2083 // Emit the DIE children if any.
David Blaikieff3ab2c2013-12-05 01:01:41 +00002084 if (Abbrev.getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
Bill Wendling480ff322009-05-20 23:21:38 +00002085 const std::vector<DIE *> &Children = Die->getChildren();
2086
2087 for (unsigned j = 0, M = Children.size(); j < M; ++j)
David Blaikieff3ab2c2013-12-05 01:01:41 +00002088 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00002089
David Blaikie155f8812013-12-04 21:51:05 +00002090 Asm->OutStreamer.AddComment("End Of Children Mark");
Chris Lattner566cae92010-03-09 23:52:58 +00002091 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00002092 }
2093}
2094
Eric Christophera2de8262012-12-15 00:04:07 +00002095// Emit the various dwarf units to the unit section USection with
2096// the abbreviations going into ASection.
David Blaikie03073f72013-12-06 22:14:48 +00002097void DwarfFile::emitUnits(DwarfDebug *DD, const MCSection *ASection,
2098 const MCSymbol *ASectionSym) {
Eric Christophera5a79422013-12-09 23:32:48 +00002099 for (SmallVectorImpl<DwarfUnit *>::iterator I = CUs.begin(), E = CUs.end();
2100 I != E; ++I) {
2101 DwarfUnit *TheU = *I;
David Blaikie2a80e442013-12-02 22:09:48 +00002102 DIE *Die = TheU->getUnitDie();
David Blaikie03073f72013-12-06 22:14:48 +00002103 const MCSection *USection = TheU->getSection();
2104 Asm->OutStreamer.SwitchSection(USection);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002105
Devang Patel1a0df9a2010-05-10 22:49:55 +00002106 // Emit the compile units header.
David Blaikie7d734602013-12-06 22:33:05 +00002107 Asm->OutStreamer.EmitLabel(TheU->getLabelBegin());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002108
Devang Patel1a0df9a2010-05-10 22:49:55 +00002109 // Emit size of content not including length itself
David Blaikie6b288cf2013-10-30 20:42:41 +00002110 Asm->OutStreamer.AddComment("Length of Unit");
David Blaikie2a80e442013-12-02 22:09:48 +00002111 Asm->EmitInt32(TheU->getHeaderSize() + Die->getSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002112
David Blaikie2a80e442013-12-02 22:09:48 +00002113 TheU->emitHeader(ASection, ASectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002114
David Blaikieff3ab2c2013-12-05 01:01:41 +00002115 DD->emitDIE(Die);
David Blaikie7d734602013-12-06 22:33:05 +00002116 Asm->OutStreamer.EmitLabel(TheU->getLabelEnd());
Devang Patel1a0df9a2010-05-10 22:49:55 +00002117 }
Bill Wendling480ff322009-05-20 23:21:38 +00002118}
2119
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002120// Emit the debug info section.
2121void DwarfDebug::emitDebugInfo() {
Eric Christopherf8194852013-12-05 18:06:10 +00002122 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christophera2de8262012-12-15 00:04:07 +00002123
David Blaikie03073f72013-12-06 22:14:48 +00002124 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfAbbrevSection(),
Eric Christophera2de8262012-12-15 00:04:07 +00002125 DwarfAbbrevSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002126}
2127
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002128// Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +00002129void DwarfDebug::emitAbbreviations() {
Eric Christopherf8194852013-12-05 18:06:10 +00002130 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
David Blaikie0504cda2013-12-05 07:43:55 +00002131
2132 Holder.emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
Eric Christopher3c5a1912012-12-19 22:02:53 +00002133}
Bill Wendling480ff322009-05-20 23:21:38 +00002134
Eric Christopherf8194852013-12-05 18:06:10 +00002135void DwarfFile::emitAbbrevs(const MCSection *Section) {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002136 // Check to see if it is worth the effort.
David Blaikie0504cda2013-12-05 07:43:55 +00002137 if (!Abbreviations.empty()) {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002138 // Start the debug abbrev section.
2139 Asm->OutStreamer.SwitchSection(Section);
2140
Bill Wendling480ff322009-05-20 23:21:38 +00002141 // For each abbrevation.
David Blaikie0504cda2013-12-05 07:43:55 +00002142 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
Bill Wendling480ff322009-05-20 23:21:38 +00002143 // Get abbreviation data
David Blaikie0504cda2013-12-05 07:43:55 +00002144 const DIEAbbrev *Abbrev = Abbreviations[i];
Bill Wendling480ff322009-05-20 23:21:38 +00002145
2146 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00002147 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00002148
2149 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002150 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00002151 }
2152
2153 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00002154 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00002155 }
2156}
2157
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002158// Emit the last address of the section and the end of the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +00002159void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00002160 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00002161 Asm->OutStreamer.AddComment("Extended Op");
2162 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002163
Chris Lattner566cae92010-03-09 23:52:58 +00002164 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002165 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00002166 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2167 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2168
2169 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002170
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002171 Asm->OutStreamer.EmitSymbolValue(
2172 Asm->GetTempSymbol("section_end", SectionEnd),
2173 Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002174
2175 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00002176 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2177 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002178 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00002179 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002180}
2181
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002182// Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00002183void DwarfDebug::emitAccelNames() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002184 DwarfAccelTable AT(
2185 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
Eric Christophera5a79422013-12-09 23:32:48 +00002186 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2187 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002188 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002189 DwarfUnit *TheU = *I;
David Blaikie2a80e442013-12-02 22:09:48 +00002190 const StringMap<std::vector<const DIE *> > &Names = TheU->getAccelNames();
David Blaikie2ea848b2013-11-19 22:51:04 +00002191 for (StringMap<std::vector<const DIE *> >::const_iterator
2192 GI = Names.begin(),
2193 GE = Names.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002194 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002195 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002196 const std::vector<const DIE *> &Entities = GI->second;
2197 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2198 DE = Entities.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002199 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002200 AT.AddName(Name, *DI);
Eric Christopher4996c702011-11-07 09:24:32 +00002201 }
2202 }
2203
2204 AT.FinalizeTable(Asm, "Names");
2205 Asm->OutStreamer.SwitchSection(
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002206 Asm->getObjFileLowering().getDwarfAccelNamesSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002207 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2208 Asm->OutStreamer.EmitLabel(SectionBegin);
2209
2210 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002211 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002212}
2213
Eric Christopher48fef592012-12-20 21:58:40 +00002214// Emit objective C classes and categories into a hashed accelerator table
2215// section.
Eric Christopher4996c702011-11-07 09:24:32 +00002216void DwarfDebug::emitAccelObjC() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002217 DwarfAccelTable AT(
2218 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
Eric Christophera5a79422013-12-09 23:32:48 +00002219 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2220 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002221 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002222 DwarfUnit *TheU = *I;
David Blaikie2a80e442013-12-02 22:09:48 +00002223 const StringMap<std::vector<const DIE *> > &Names = TheU->getAccelObjC();
David Blaikie2ea848b2013-11-19 22:51:04 +00002224 for (StringMap<std::vector<const DIE *> >::const_iterator
2225 GI = Names.begin(),
2226 GE = Names.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002227 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002228 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002229 const std::vector<const DIE *> &Entities = GI->second;
2230 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2231 DE = Entities.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002232 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002233 AT.AddName(Name, *DI);
Eric Christopher4996c702011-11-07 09:24:32 +00002234 }
2235 }
2236
2237 AT.FinalizeTable(Asm, "ObjC");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002238 Asm->OutStreamer.SwitchSection(
2239 Asm->getObjFileLowering().getDwarfAccelObjCSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002240 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2241 Asm->OutStreamer.EmitLabel(SectionBegin);
2242
2243 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002244 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002245}
2246
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002247// Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002248void DwarfDebug::emitAccelNamespaces() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002249 DwarfAccelTable AT(
2250 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
Eric Christophera5a79422013-12-09 23:32:48 +00002251 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2252 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002253 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002254 DwarfUnit *TheU = *I;
David Blaikie2ea848b2013-11-19 22:51:04 +00002255 const StringMap<std::vector<const DIE *> > &Names =
David Blaikie2a80e442013-12-02 22:09:48 +00002256 TheU->getAccelNamespace();
David Blaikie2ea848b2013-11-19 22:51:04 +00002257 for (StringMap<std::vector<const DIE *> >::const_iterator
2258 GI = Names.begin(),
2259 GE = Names.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002260 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002261 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002262 const std::vector<const DIE *> &Entities = GI->second;
2263 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2264 DE = Entities.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002265 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002266 AT.AddName(Name, *DI);
Eric Christopher4996c702011-11-07 09:24:32 +00002267 }
2268 }
2269
2270 AT.FinalizeTable(Asm, "namespac");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002271 Asm->OutStreamer.SwitchSection(
2272 Asm->getObjFileLowering().getDwarfAccelNamespaceSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002273 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2274 Asm->OutStreamer.EmitLabel(SectionBegin);
2275
2276 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002277 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002278}
2279
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002280// Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002281void DwarfDebug::emitAccelTypes() {
Eric Christopher21bde872012-01-06 04:35:23 +00002282 std::vector<DwarfAccelTable::Atom> Atoms;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002283 Atoms.push_back(
2284 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
2285 Atoms.push_back(
2286 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag, dwarf::DW_FORM_data2));
2287 Atoms.push_back(
2288 DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags, dwarf::DW_FORM_data1));
Eric Christopher21bde872012-01-06 04:35:23 +00002289 DwarfAccelTable AT(Atoms);
Eric Christophera5a79422013-12-09 23:32:48 +00002290 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2291 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002292 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002293 DwarfUnit *TheU = *I;
David Blaikie2ea848b2013-11-19 22:51:04 +00002294 const StringMap<std::vector<std::pair<const DIE *, unsigned> > > &Names =
David Blaikie2a80e442013-12-02 22:09:48 +00002295 TheU->getAccelTypes();
David Blaikie2ea848b2013-11-19 22:51:04 +00002296 for (StringMap<
2297 std::vector<std::pair<const DIE *, unsigned> > >::const_iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002298 GI = Names.begin(),
2299 GE = Names.end();
2300 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002301 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002302 const std::vector<std::pair<const DIE *, unsigned> > &Entities =
2303 GI->second;
2304 for (std::vector<std::pair<const DIE *, unsigned> >::const_iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002305 DI = Entities.begin(),
2306 DE = Entities.end();
2307 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002308 AT.AddName(Name, DI->first, DI->second);
Eric Christopher4996c702011-11-07 09:24:32 +00002309 }
2310 }
2311
2312 AT.FinalizeTable(Asm, "types");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002313 Asm->OutStreamer.SwitchSection(
2314 Asm->getObjFileLowering().getDwarfAccelTypesSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002315 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2316 Asm->OutStreamer.EmitLabel(SectionBegin);
2317
2318 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002319 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002320}
2321
Eric Christopherdd1a0122013-09-13 00:35:05 +00002322// Public name handling.
2323// The format for the various pubnames:
2324//
2325// dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2326// for the DIE that is named.
2327//
2328// gnu pubnames - offset/index value/name tuples where the offset is the offset
2329// into the CU and the index value is computed according to the type of value
2330// for the DIE that is named.
2331//
2332// For type units the offset is the offset of the skeleton DIE. For split dwarf
2333// it's the offset within the debug_info/debug_types dwo section, however, the
2334// reference in the pubname header doesn't change.
2335
2336/// computeIndexValue - Compute the gdb index value for the DIE and CU.
Eric Christophera5a79422013-12-09 23:32:48 +00002337static dwarf::PubIndexEntryDescriptor computeIndexValue(DwarfUnit *CU,
Eric Christopher0fe676a2013-11-21 00:48:22 +00002338 const DIE *Die) {
Eric Christopherd2b497b2013-10-16 01:37:49 +00002339 dwarf::GDBIndexEntryLinkage Linkage = dwarf::GIEL_STATIC;
2340
2341 // We could have a specification DIE that has our most of our knowledge,
2342 // look for that now.
2343 DIEValue *SpecVal = Die->findAttribute(dwarf::DW_AT_specification);
2344 if (SpecVal) {
2345 DIE *SpecDIE = cast<DIEEntry>(SpecVal)->getEntry();
2346 if (SpecDIE->findAttribute(dwarf::DW_AT_external))
2347 Linkage = dwarf::GIEL_EXTERNAL;
2348 } else if (Die->findAttribute(dwarf::DW_AT_external))
2349 Linkage = dwarf::GIEL_EXTERNAL;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002350
2351 switch (Die->getTag()) {
2352 case dwarf::DW_TAG_class_type:
2353 case dwarf::DW_TAG_structure_type:
2354 case dwarf::DW_TAG_union_type:
2355 case dwarf::DW_TAG_enumeration_type:
Eric Christopher261d2342013-09-23 20:55:35 +00002356 return dwarf::PubIndexEntryDescriptor(
2357 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2358 ? dwarf::GIEL_STATIC
2359 : dwarf::GIEL_EXTERNAL);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002360 case dwarf::DW_TAG_typedef:
2361 case dwarf::DW_TAG_base_type:
2362 case dwarf::DW_TAG_subrange_type:
David Blaikie8dec4072013-09-19 20:40:26 +00002363 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002364 case dwarf::DW_TAG_namespace:
David Blaikie8dec4072013-09-19 20:40:26 +00002365 return dwarf::GIEK_TYPE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002366 case dwarf::DW_TAG_subprogram:
Eric Christopherccac5c42013-09-23 22:59:14 +00002367 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002368 case dwarf::DW_TAG_constant:
2369 case dwarf::DW_TAG_variable:
Eric Christopherccac5c42013-09-23 22:59:14 +00002370 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002371 case dwarf::DW_TAG_enumerator:
David Blaikie8dec4072013-09-19 20:40:26 +00002372 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2373 dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002374 default:
David Blaikie8dec4072013-09-19 20:40:26 +00002375 return dwarf::GIEK_NONE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002376 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002377}
2378
Eric Christopher5f93bb92013-09-09 20:03:17 +00002379/// emitDebugPubNames - Emit visible names into a debug pubnames section.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002380///
Eric Christopherdd1a0122013-09-13 00:35:05 +00002381void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
Eric Christopherdd1a0122013-09-13 00:35:05 +00002382 const MCSection *PSec =
2383 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2384 : Asm->getObjFileLowering().getDwarfPubNamesSection();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002385
David Blaikie4f623202013-12-06 19:38:49 +00002386 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christophera5a79422013-12-09 23:32:48 +00002387 const SmallVectorImpl<DwarfUnit *> &Units = Holder.getUnits();
David Blaikie4f623202013-12-06 19:38:49 +00002388 for (unsigned i = 0; i != Units.size(); ++i) {
Eric Christophera5a79422013-12-09 23:32:48 +00002389 DwarfUnit *TheU = Units[i];
David Blaikie2a80e442013-12-02 22:09:48 +00002390 unsigned ID = TheU->getUniqueID();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002391
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002392 // Start the dwarf pubnames section.
Eric Christopher13b99d22013-09-10 21:49:37 +00002393 Asm->OutStreamer.SwitchSection(PSec);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002394
Eric Christopher39eebfa2013-09-30 23:14:16 +00002395 // Emit a label so we can reference the beginning of this pubname section.
2396 if (GnuStyle)
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002397 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames", ID));
Eric Christopher39eebfa2013-09-30 23:14:16 +00002398
Eric Christopherdd1a0122013-09-13 00:35:05 +00002399 // Emit the header.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002400 Asm->OutStreamer.AddComment("Length of Public Names Info");
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002401 MCSymbol *BeginLabel = Asm->GetTempSymbol("pubnames_begin", ID);
2402 MCSymbol *EndLabel = Asm->GetTempSymbol("pubnames_end", ID);
2403 Asm->EmitLabelDifference(EndLabel, BeginLabel, 4);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002404
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002405 Asm->OutStreamer.EmitLabel(BeginLabel);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002406
2407 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002408 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002409
2410 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
David Blaikie7d734602013-12-06 22:33:05 +00002411 Asm->EmitSectionOffset(TheU->getLabelBegin(), TheU->getSectionSym());
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002412
2413 Asm->OutStreamer.AddComment("Compilation Unit Length");
David Blaikie7d734602013-12-06 22:33:05 +00002414 Asm->EmitLabelDifference(TheU->getLabelEnd(), TheU->getLabelBegin(), 4);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002415
Eric Christopherdd1a0122013-09-13 00:35:05 +00002416 // Emit the pubnames for this compilation unit.
David Blaikie4f623202013-12-06 19:38:49 +00002417 const StringMap<const DIE *> &Globals = getUnits()[ID]->getGlobalNames();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002418 for (StringMap<const DIE *>::const_iterator GI = Globals.begin(),
2419 GE = Globals.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002420 GI != GE; ++GI) {
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002421 const char *Name = GI->getKeyData();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002422 const DIE *Entity = GI->second;
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002423
2424 Asm->OutStreamer.AddComment("DIE offset");
2425 Asm->EmitInt32(Entity->getOffset());
2426
Eric Christopherdd1a0122013-09-13 00:35:05 +00002427 if (GnuStyle) {
David Blaikie2a80e442013-12-02 22:09:48 +00002428 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheU, Entity);
David Blaikied0a869d2013-09-19 22:19:37 +00002429 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002430 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002431 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002432 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002433 }
2434
David Blaikie155f8812013-12-04 21:51:05 +00002435 Asm->OutStreamer.AddComment("External Name");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002436 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002437 }
2438
2439 Asm->OutStreamer.AddComment("End Mark");
2440 Asm->EmitInt32(0);
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002441 Asm->OutStreamer.EmitLabel(EndLabel);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002442 }
2443}
2444
Eric Christopherdd1a0122013-09-13 00:35:05 +00002445void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
Eric Christopher261d2342013-09-23 20:55:35 +00002446 const MCSection *PSec =
2447 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2448 : Asm->getObjFileLowering().getDwarfPubTypesSection();
Eric Christopher8b3737f2013-09-13 00:34:58 +00002449
David Blaikie4f623202013-12-06 19:38:49 +00002450 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christophera5a79422013-12-09 23:32:48 +00002451 const SmallVectorImpl<DwarfUnit *> &Units = Holder.getUnits();
David Blaikie4f623202013-12-06 19:38:49 +00002452 for (unsigned i = 0; i != Units.size(); ++i) {
Eric Christophera5a79422013-12-09 23:32:48 +00002453 DwarfUnit *TheU = Units[i];
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002454 unsigned ID = TheU->getUniqueID();
2455
Eric Christopher6abc9c52011-11-07 09:18:35 +00002456 // Start the dwarf pubtypes section.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002457 Asm->OutStreamer.SwitchSection(PSec);
Eric Christopher39eebfa2013-09-30 23:14:16 +00002458
2459 // Emit a label so we can reference the beginning of this pubtype section.
2460 if (GnuStyle)
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002461 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes", ID));
Eric Christopher39eebfa2013-09-30 23:14:16 +00002462
2463 // Emit the header.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002464 Asm->OutStreamer.AddComment("Length of Public Types Info");
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002465 MCSymbol *BeginLabel = Asm->GetTempSymbol("pubtypes_begin", ID);
2466 MCSymbol *EndLabel = Asm->GetTempSymbol("pubtypes_end", ID);
2467 Asm->EmitLabelDifference(EndLabel, BeginLabel, 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002468
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002469 Asm->OutStreamer.EmitLabel(BeginLabel);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002470
David Blaikie155f8812013-12-04 21:51:05 +00002471 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002472 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002473
Devang Patel1a0df9a2010-05-10 22:49:55 +00002474 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
David Blaikie7d734602013-12-06 22:33:05 +00002475 Asm->EmitSectionOffset(TheU->getLabelBegin(), TheU->getSectionSym());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002476
Devang Patel1a0df9a2010-05-10 22:49:55 +00002477 Asm->OutStreamer.AddComment("Compilation Unit Length");
David Blaikie7d734602013-12-06 22:33:05 +00002478 Asm->EmitLabelDifference(TheU->getLabelEnd(), TheU->getLabelBegin(), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002479
Eric Christopher39eebfa2013-09-30 23:14:16 +00002480 // Emit the pubtypes.
David Blaikie4f623202013-12-06 19:38:49 +00002481 const StringMap<const DIE *> &Globals = getUnits()[ID]->getGlobalTypes();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002482 for (StringMap<const DIE *>::const_iterator GI = Globals.begin(),
2483 GE = Globals.end();
Eric Christopher8b3737f2013-09-13 00:34:58 +00002484 GI != GE; ++GI) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002485 const char *Name = GI->getKeyData();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002486 const DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002487
David Blaikie155f8812013-12-04 21:51:05 +00002488 Asm->OutStreamer.AddComment("DIE offset");
Devang Patel1a0df9a2010-05-10 22:49:55 +00002489 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002490
Eric Christopherdd1a0122013-09-13 00:35:05 +00002491 if (GnuStyle) {
David Blaikie2a80e442013-12-02 22:09:48 +00002492 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheU, Entity);
David Blaikied0a869d2013-09-19 22:19:37 +00002493 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002494 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002495 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002496 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002497 }
2498
David Blaikie155f8812013-12-04 21:51:05 +00002499 Asm->OutStreamer.AddComment("External Name");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002500
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002501 // Emit the name with a terminating null byte.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002502 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002503 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002504
Devang Patel1a0df9a2010-05-10 22:49:55 +00002505 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002506 Asm->EmitInt32(0);
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002507 Asm->OutStreamer.EmitLabel(EndLabel);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002508 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002509}
2510
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002511// Emit strings into a string section.
Eric Christopherf8194852013-12-05 18:06:10 +00002512void DwarfFile::emitStrings(const MCSection *StrSection,
Eric Christophera5a79422013-12-09 23:32:48 +00002513 const MCSection *OffsetSection = NULL,
2514 const MCSymbol *StrSecSym = NULL) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002515
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002516 if (StringPool.empty())
2517 return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002518
Chris Lattner3d72a672010-03-09 23:38:23 +00002519 // Start the dwarf str section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002520 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling480ff322009-05-20 23:21:38 +00002521
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002522 // Get all of the string pool entries and put them in an array by their ID so
2523 // we can sort them.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002524 SmallVector<
2525 std::pair<unsigned, StringMapEntry<std::pair<MCSymbol *, unsigned> > *>,
2526 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002527
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002528 for (StringMap<std::pair<MCSymbol *, unsigned> >::iterator
2529 I = StringPool.begin(),
2530 E = StringPool.end();
Eric Christopher48fef592012-12-20 21:58:40 +00002531 I != E; ++I)
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002532 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002533
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002534 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002535
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002536 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002537 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002538 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002539
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002540 // Emit the string itself with a terminating null byte.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002541 Asm->OutStreamer.EmitBytes(
2542 StringRef(Entries[i].second->getKeyData(),
2543 Entries[i].second->getKeyLength() + 1));
Bill Wendling480ff322009-05-20 23:21:38 +00002544 }
Eric Christopher2cbd5762013-01-07 19:32:41 +00002545
2546 // If we've got an offset section go ahead and emit that now as well.
2547 if (OffsetSection) {
2548 Asm->OutStreamer.SwitchSection(OffsetSection);
2549 unsigned offset = 0;
Eric Christopher962c9082013-01-15 23:56:56 +00002550 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002551 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopherbf7bc492013-01-09 03:52:05 +00002552 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopher2cbd5762013-01-07 19:32:41 +00002553 offset += Entries[i].second->getKeyLength() + 1;
2554 }
2555 }
Bill Wendling480ff322009-05-20 23:21:38 +00002556}
2557
Eric Christopher65132a82013-11-19 09:11:26 +00002558// Emit addresses into the section given.
Eric Christopherf8194852013-12-05 18:06:10 +00002559void DwarfFile::emitAddresses(const MCSection *AddrSection) {
Eric Christopher962c9082013-01-15 23:56:56 +00002560
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002561 if (AddressPool.empty())
2562 return;
Eric Christopher962c9082013-01-15 23:56:56 +00002563
2564 // Start the dwarf addr section.
2565 Asm->OutStreamer.SwitchSection(AddrSection);
2566
David Blaikiece1960f2013-07-08 17:51:28 +00002567 // Order the address pool entries by ID
David Blaikieac569a62013-07-08 17:33:10 +00002568 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher962c9082013-01-15 23:56:56 +00002569
David Blaikiece1960f2013-07-08 17:51:28 +00002570 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2571 E = AddressPool.end();
Eric Christopher962c9082013-01-15 23:56:56 +00002572 I != E; ++I)
David Blaikieac569a62013-07-08 17:33:10 +00002573 Entries[I->second] = I->first;
Eric Christopher962c9082013-01-15 23:56:56 +00002574
2575 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002576 // Emit an expression for reference from debug information entries.
David Blaikieac569a62013-07-08 17:33:10 +00002577 if (const MCExpr *Expr = Entries[i])
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002578 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
Eric Christopher962c9082013-01-15 23:56:56 +00002579 else
2580 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2581 }
Eric Christopher962c9082013-01-15 23:56:56 +00002582}
2583
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002584// Emit visible names into a debug str section.
2585void DwarfDebug::emitDebugStr() {
Eric Christopherf8194852013-12-05 18:06:10 +00002586 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002587 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2588}
2589
Eric Christopher9046f942013-07-02 21:36:07 +00002590// Emit locations into the debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002591void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002592 if (DotDebugLocEntries.empty())
2593 return;
2594
Eric Christopher4887c8f2013-03-29 23:34:06 +00002595 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002596 I = DotDebugLocEntries.begin(),
2597 E = DotDebugLocEntries.end();
Devang Patel116a9d72011-02-04 22:57:18 +00002598 I != E; ++I) {
2599 DotDebugLocEntry &Entry = *I;
2600 if (I + 1 != DotDebugLocEntries.end())
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002601 Entry.Merge(I + 1);
Devang Patel116a9d72011-02-04 22:57:18 +00002602 }
2603
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002604 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002605 Asm->OutStreamer.SwitchSection(
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002606 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002607 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002608 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2609 unsigned index = 1;
Eric Christopher4887c8f2013-03-29 23:34:06 +00002610 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002611 I = DotDebugLocEntries.begin(),
2612 E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002613 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002614 DotDebugLocEntry &Entry = *I;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002615 if (Entry.isMerged())
2616 continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002617 if (Entry.isEmpty()) {
Eric Christopherce0cfce2013-01-09 01:35:34 +00002618 Asm->OutStreamer.EmitIntValue(0, Size);
2619 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002620 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002621 } else {
Eric Christopher25f06422013-07-03 22:40:18 +00002622 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2623 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2624 DIVariable DV(Entry.getVariable());
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002625 Asm->OutStreamer.AddComment("Loc expr size");
2626 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2627 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2628 Asm->EmitLabelDifference(end, begin, 2);
2629 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002630 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002631 DIBasicType BTy(DV.getType());
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002632 if (BTy.Verify() && (BTy.getEncoding() == dwarf::DW_ATE_signed ||
2633 BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
Devang Patel324f8432011-06-01 22:03:25 +00002634 Asm->OutStreamer.AddComment("DW_OP_consts");
2635 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002636 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002637 } else {
2638 Asm->OutStreamer.AddComment("DW_OP_constu");
2639 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002640 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002641 }
Devang Pateled9fd452011-07-08 16:49:43 +00002642 } else if (Entry.isLocation()) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002643 MachineLocation Loc = Entry.getLoc();
Eric Christopher6a841382012-11-19 22:42:10 +00002644 if (!DV.hasComplexAddress())
Devang Pateled9fd452011-07-08 16:49:43 +00002645 // Regular entry.
Eric Christopher614a89f2013-07-03 22:40:21 +00002646 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002647 else {
2648 // Complex address entry.
2649 unsigned N = DV.getNumAddrElements();
2650 unsigned i = 0;
2651 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002652 if (Loc.getOffset()) {
Devang Pateled9fd452011-07-08 16:49:43 +00002653 i = 2;
Eric Christopher614a89f2013-07-03 22:40:21 +00002654 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002655 Asm->OutStreamer.AddComment("DW_OP_deref");
2656 Asm->EmitInt8(dwarf::DW_OP_deref);
2657 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2658 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2659 Asm->EmitSLEB128(DV.getAddrElement(1));
2660 } else {
2661 // If first address element is OpPlus then emit
2662 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher614a89f2013-07-03 22:40:21 +00002663 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2664 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002665 i = 2;
2666 }
2667 } else {
Eric Christopher614a89f2013-07-03 22:40:21 +00002668 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002669 }
Eric Christopher6a841382012-11-19 22:42:10 +00002670
Devang Pateled9fd452011-07-08 16:49:43 +00002671 // Emit remaining complex address elements.
2672 for (; i < N; ++i) {
2673 uint64_t Element = DV.getAddrElement(i);
2674 if (Element == DIBuilder::OpPlus) {
2675 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2676 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher4d250522012-05-08 18:56:00 +00002677 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002678 if (!Loc.isReg())
Eric Christopher4d250522012-05-08 18:56:00 +00002679 Asm->EmitInt8(dwarf::DW_OP_deref);
2680 } else
2681 llvm_unreachable("unknown Opcode found in complex address");
Devang Pateled9fd452011-07-08 16:49:43 +00002682 }
Devang Patel3e021532011-04-28 02:22:40 +00002683 }
Devang Patel3e021532011-04-28 02:22:40 +00002684 }
Devang Pateled9fd452011-07-08 16:49:43 +00002685 // else ... ignore constant fp. There is not any good way to
2686 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002687 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002688 }
2689 }
Bill Wendling480ff322009-05-20 23:21:38 +00002690}
2691
Richard Mitton21101b32013-09-19 23:21:01 +00002692struct SymbolCUSorter {
2693 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2694 const MCStreamer &Streamer;
2695
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002696 bool operator()(const SymbolCU &A, const SymbolCU &B) {
Richard Mitton21101b32013-09-19 23:21:01 +00002697 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2698 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2699
2700 // Symbols with no order assigned should be placed at the end.
2701 // (e.g. section end labels)
2702 if (IA == 0)
2703 IA = (unsigned)(-1);
2704 if (IB == 0)
2705 IB = (unsigned)(-1);
2706 return IA < IB;
2707 }
2708};
2709
Eric Christophera5a79422013-12-09 23:32:48 +00002710static bool CUSort(const DwarfUnit *A, const DwarfUnit *B) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002711 return (A->getUniqueID() < B->getUniqueID());
Richard Mitton21101b32013-09-19 23:21:01 +00002712}
2713
2714struct ArangeSpan {
2715 const MCSymbol *Start, *End;
2716};
2717
2718// Emit a debug aranges section, containing a CU lookup for any
2719// address we can tie back to a CU.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002720void DwarfDebug::emitDebugARanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002721 // Start the dwarf aranges section.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002722 Asm->OutStreamer.SwitchSection(
2723 Asm->getObjFileLowering().getDwarfARangesSection());
Richard Mitton21101b32013-09-19 23:21:01 +00002724
Eric Christopher4287a492013-12-09 23:57:44 +00002725 typedef DenseMap<DwarfCompileUnit *, std::vector<ArangeSpan> > SpansType;
Richard Mitton21101b32013-09-19 23:21:01 +00002726
2727 SpansType Spans;
2728
2729 // Build a list of sections used.
2730 std::vector<const MCSection *> Sections;
2731 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2732 it++) {
2733 const MCSection *Section = it->first;
2734 Sections.push_back(Section);
2735 }
2736
2737 // Sort the sections into order.
2738 // This is only done to ensure consistent output order across different runs.
2739 std::sort(Sections.begin(), Sections.end(), SectionSort);
2740
2741 // Build a set of address spans, sorted by CU.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002742 for (size_t SecIdx = 0; SecIdx < Sections.size(); SecIdx++) {
Richard Mitton21101b32013-09-19 23:21:01 +00002743 const MCSection *Section = Sections[SecIdx];
2744 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2745 if (List.size() < 2)
2746 continue;
2747
2748 // Sort the symbols by offset within the section.
2749 SymbolCUSorter sorter(Asm->OutStreamer);
2750 std::sort(List.begin(), List.end(), sorter);
2751
2752 // If we have no section (e.g. common), just write out
2753 // individual spans for each symbol.
2754 if (Section == NULL) {
2755 for (size_t n = 0; n < List.size(); n++) {
2756 const SymbolCU &Cur = List[n];
2757
2758 ArangeSpan Span;
2759 Span.Start = Cur.Sym;
2760 Span.End = NULL;
2761 if (Cur.CU)
2762 Spans[Cur.CU].push_back(Span);
2763 }
2764 } else {
2765 // Build spans between each label.
2766 const MCSymbol *StartSym = List[0].Sym;
2767 for (size_t n = 1; n < List.size(); n++) {
2768 const SymbolCU &Prev = List[n - 1];
2769 const SymbolCU &Cur = List[n];
2770
2771 // Try and build the longest span we can within the same CU.
2772 if (Cur.CU != Prev.CU) {
2773 ArangeSpan Span;
2774 Span.Start = StartSym;
2775 Span.End = Cur.Sym;
2776 Spans[Prev.CU].push_back(Span);
2777 StartSym = Cur.Sym;
2778 }
2779 }
2780 }
2781 }
2782
Richard Mitton21101b32013-09-19 23:21:01 +00002783 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2784
2785 // Build a list of CUs used.
Eric Christopher4287a492013-12-09 23:57:44 +00002786 std::vector<DwarfCompileUnit *> CUs;
Richard Mitton21101b32013-09-19 23:21:01 +00002787 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
Eric Christopher4287a492013-12-09 23:57:44 +00002788 DwarfCompileUnit *CU = it->first;
Richard Mitton21101b32013-09-19 23:21:01 +00002789 CUs.push_back(CU);
2790 }
2791
2792 // Sort the CU list (again, to ensure consistent output order).
2793 std::sort(CUs.begin(), CUs.end(), CUSort);
2794
2795 // Emit an arange table for each CU we used.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002796 for (size_t CUIdx = 0; CUIdx < CUs.size(); CUIdx++) {
Eric Christopher4287a492013-12-09 23:57:44 +00002797 DwarfCompileUnit *CU = CUs[CUIdx];
Richard Mitton21101b32013-09-19 23:21:01 +00002798 std::vector<ArangeSpan> &List = Spans[CU];
2799
2800 // Emit size of content not including length itself.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002801 unsigned ContentSize =
2802 sizeof(int16_t) + // DWARF ARange version number
2803 sizeof(int32_t) + // Offset of CU in the .debug_info section
2804 sizeof(int8_t) + // Pointer Size (in bytes)
2805 sizeof(int8_t); // Segment Size (in bytes)
Richard Mitton21101b32013-09-19 23:21:01 +00002806
2807 unsigned TupleSize = PtrSize * 2;
2808
2809 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
Benjamin Kramer8a68ab32014-01-07 19:28:14 +00002810 unsigned Padding =
2811 OffsetToAlignment(sizeof(int32_t) + ContentSize, TupleSize);
Richard Mitton21101b32013-09-19 23:21:01 +00002812
2813 ContentSize += Padding;
2814 ContentSize += (List.size() + 1) * TupleSize;
2815
2816 // For each compile unit, write the list of spans it covers.
2817 Asm->OutStreamer.AddComment("Length of ARange Set");
2818 Asm->EmitInt32(ContentSize);
2819 Asm->OutStreamer.AddComment("DWARF Arange version number");
2820 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2821 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
Eric Christopherd8667202013-12-30 17:22:27 +00002822 Asm->EmitSectionOffset(CU->getLocalLabelBegin(), CU->getLocalSectionSym());
Richard Mitton21101b32013-09-19 23:21:01 +00002823 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2824 Asm->EmitInt8(PtrSize);
2825 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2826 Asm->EmitInt8(0);
2827
Benjamin Kramer8a68ab32014-01-07 19:28:14 +00002828 Asm->OutStreamer.EmitFill(Padding, 0xff);
Richard Mitton21101b32013-09-19 23:21:01 +00002829
2830 for (unsigned n = 0; n < List.size(); n++) {
2831 const ArangeSpan &Span = List[n];
2832 Asm->EmitLabelReference(Span.Start, PtrSize);
2833
2834 // Calculate the size as being from the span start to it's end.
Richard Mitton089ed892013-09-23 17:56:20 +00002835 if (Span.End) {
Richard Mitton21101b32013-09-19 23:21:01 +00002836 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
Richard Mitton089ed892013-09-23 17:56:20 +00002837 } else {
2838 // For symbols without an end marker (e.g. common), we
2839 // write a single arange entry containing just that one symbol.
2840 uint64_t Size = SymSize[Span.Start];
2841 if (Size == 0)
2842 Size = 1;
2843
2844 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2845 }
Richard Mitton21101b32013-09-19 23:21:01 +00002846 }
2847
2848 Asm->OutStreamer.AddComment("ARange terminator");
2849 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2850 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2851 }
Bill Wendling480ff322009-05-20 23:21:38 +00002852}
2853
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002854// Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002855void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002856 // Start the dwarf ranges section.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002857 Asm->OutStreamer.SwitchSection(
2858 Asm->getObjFileLowering().getDwarfRangesSection());
Eric Christopher4751d702013-11-23 00:05:29 +00002859
Eric Christopher0f63d062013-12-03 00:45:45 +00002860 // Size for our labels.
2861 unsigned char Size = Asm->getDataLayout().getPointerSize();
2862
2863 // Grab the specific ranges for the compile units in the module.
Eric Christopher179fba12014-01-29 22:06:23 +00002864 for (MapVector<const MDNode *, DwarfCompileUnit *>::iterator
2865 I = CUMap.begin(),
2866 E = CUMap.end();
Eric Christopher0f63d062013-12-03 00:45:45 +00002867 I != E; ++I) {
Eric Christopher4287a492013-12-09 23:57:44 +00002868 DwarfCompileUnit *TheCU = I->second;
Eric Christopher0f63d062013-12-03 00:45:45 +00002869
2870 // Emit a symbol so we can find the beginning of our ranges.
David Blaikie1ab7c2d2013-12-09 17:51:30 +00002871 Asm->OutStreamer.EmitLabel(TheCU->getLabelRange());
Eric Christopher0f63d062013-12-03 00:45:45 +00002872
2873 // Iterate over the misc ranges for the compile units in the module.
Eric Christopher270ba4a2013-12-04 19:06:58 +00002874 const SmallVectorImpl<RangeSpanList> &RangeLists = TheCU->getRangeLists();
Eric Christophera5a79422013-12-09 23:32:48 +00002875 for (SmallVectorImpl<RangeSpanList>::const_iterator I = RangeLists.begin(),
2876 E = RangeLists.end();
Eric Christopher0f63d062013-12-03 00:45:45 +00002877 I != E; ++I) {
Eric Christopher270ba4a2013-12-04 19:06:58 +00002878 const RangeSpanList &List = *I;
Eric Christopher0f63d062013-12-03 00:45:45 +00002879
Eric Christopherf8790642013-12-04 22:04:50 +00002880 // Emit our symbol so we can find the beginning of the range.
2881 Asm->OutStreamer.EmitLabel(List.getSym());
Eric Christopher0f63d062013-12-03 00:45:45 +00002882
2883 for (SmallVectorImpl<RangeSpan>::const_iterator
Eric Christopher270ba4a2013-12-04 19:06:58 +00002884 RI = List.getRanges().begin(),
2885 RE = List.getRanges().end();
2886 RI != RE; ++RI) {
2887 const RangeSpan &Range = *RI;
Eric Christopher0f63d062013-12-03 00:45:45 +00002888 const MCSymbol *Begin = Range.getStart();
2889 const MCSymbol *End = Range.getEnd();
Eric Christopher565ab112013-12-20 04:34:22 +00002890 assert(Begin && "Range without a begin symbol?");
2891 assert(End && "Range without an end symbol?");
2892 Asm->OutStreamer.EmitSymbolValue(Begin, Size);
2893 Asm->OutStreamer.EmitSymbolValue(End, Size);
Eric Christopher0f63d062013-12-03 00:45:45 +00002894 }
2895
2896 // And terminate the list with two 0 values.
Eric Christopherce0cfce2013-01-09 01:35:34 +00002897 Asm->OutStreamer.EmitIntValue(0, Size);
Eric Christopher0f63d062013-12-03 00:45:45 +00002898 Asm->OutStreamer.EmitIntValue(0, Size);
2899 }
Eric Christopher46e23432013-12-20 04:16:18 +00002900
2901 // Now emit a range for the CU itself.
Eric Christopher1ad84572014-01-15 00:04:29 +00002902 if (useCURanges()) {
Eric Christopher46e23432013-12-20 04:16:18 +00002903 Asm->OutStreamer.EmitLabel(
2904 Asm->GetTempSymbol("cu_ranges", TheCU->getUniqueID()));
2905 const SmallVectorImpl<RangeSpan> &Ranges = TheCU->getRanges();
2906 for (uint32_t i = 0, e = Ranges.size(); i != e; ++i) {
2907 RangeSpan Range = Ranges[i];
Eric Christopher46e23432013-12-20 04:16:18 +00002908 const MCSymbol *Begin = Range.getStart();
2909 const MCSymbol *End = Range.getEnd();
Eric Christopher565ab112013-12-20 04:34:22 +00002910 assert(Begin && "Range without a begin symbol?");
2911 assert(End && "Range without an end symbol?");
2912 Asm->OutStreamer.EmitSymbolValue(Begin, Size);
2913 Asm->OutStreamer.EmitSymbolValue(End, Size);
Eric Christopher46e23432013-12-20 04:16:18 +00002914 }
2915 // And terminate the list with two 0 values.
2916 Asm->OutStreamer.EmitIntValue(0, Size);
2917 Asm->OutStreamer.EmitIntValue(0, Size);
2918 }
Devang Patel12563b32010-04-16 23:33:45 +00002919 }
Bill Wendling480ff322009-05-20 23:21:38 +00002920}
2921
Eric Christopherd692c1d2012-12-11 19:42:09 +00002922// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002923
David Blaikie38fe6342014-01-09 04:28:46 +00002924void DwarfDebug::initSkeletonUnit(const DwarfUnit *U, DIE *Die,
2925 DwarfUnit *NewU) {
2926 NewU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
2927 U->getCUNode().getSplitDebugFilename());
2928
2929 // Relocate to the beginning of the addr_base section, else 0 for the
2930 // beginning of the one for this compile unit.
2931 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopherceec7b02014-01-11 00:23:18 +00002932 NewU->addSectionLabel(Die, dwarf::DW_AT_GNU_addr_base, DwarfAddrSectionSym);
David Blaikie38fe6342014-01-09 04:28:46 +00002933 else
2934 NewU->addSectionOffset(Die, dwarf::DW_AT_GNU_addr_base, 0);
2935
2936 if (!CompilationDir.empty())
2937 NewU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
2938
2939 addGnuPubAttributes(NewU, Die);
2940
2941 SkeletonHolder.addUnit(NewU);
2942}
2943
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002944// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2945// 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 +00002946// DW_AT_ranges_base, DW_AT_addr_base.
Eric Christopher5090d572013-12-10 00:40:03 +00002947// TODO: Implement DW_AT_ranges_base.
Eric Christopher4287a492013-12-09 23:57:44 +00002948DwarfCompileUnit *DwarfDebug::constructSkeletonCU(const DwarfCompileUnit *CU) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002949
2950 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher4287a492013-12-09 23:57:44 +00002951 DwarfCompileUnit *NewCU = new DwarfCompileUnit(
David Blaikief645f962014-01-09 03:23:41 +00002952 CU->getUniqueID(), Die, CU->getCUNode(), Asm, this, &SkeletonHolder);
David Blaikie1ab7c2d2013-12-09 17:51:30 +00002953 NewCU->initSection(Asm->getObjFileLowering().getDwarfInfoSection(),
2954 DwarfInfoSectionSym);
Eric Christopher4c7765f2013-01-17 03:00:04 +00002955
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002956 // DW_AT_stmt_list is a offset of line number information for this
2957 // compile unit in debug_line section.
Eric Christopher55863be2013-04-07 03:43:09 +00002958 // FIXME: Should handle multiple compile units.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002959 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christophera5a79422013-12-09 23:32:48 +00002960 NewCU->addSectionLabel(Die, dwarf::DW_AT_stmt_list, DwarfLineSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002961 else
Eric Christopher33ff6972013-11-21 23:46:41 +00002962 NewCU->addSectionOffset(Die, dwarf::DW_AT_stmt_list, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002963
David Blaikie38fe6342014-01-09 04:28:46 +00002964 initSkeletonUnit(CU, Die, NewCU);
Eric Christopherc8a310e2012-12-10 23:34:43 +00002965
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002966 return NewCU;
2967}
2968
David Blaikie15ed5eb2014-01-10 01:38:41 +00002969// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_dwo_name,
2970// DW_AT_addr_base.
2971DwarfTypeUnit *DwarfDebug::constructSkeletonTU(const DwarfTypeUnit *TU) {
2972
2973 DIE *Die = new DIE(dwarf::DW_TAG_type_unit);
2974 DwarfTypeUnit *NewTU = new DwarfTypeUnit(
2975 TU->getUniqueID(), Die, TU->getCUNode(), Asm, this, &SkeletonHolder);
2976 NewTU->setTypeSignature(TU->getTypeSignature());
2977 NewTU->setType(NULL);
2978 NewTU->initSection(
2979 Asm->getObjFileLowering().getDwarfTypesSection(TU->getTypeSignature()));
2980
2981 initSkeletonUnit(TU, Die, NewTU);
2982 return NewTU;
2983}
2984
Eric Christopherd692c1d2012-12-11 19:42:09 +00002985// Emit the .debug_info.dwo section for separated dwarf. This contains the
2986// compile units that would normally be in debug_info.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002987void DwarfDebug::emitDebugInfoDWO() {
Eric Christophercdf218d2012-12-10 19:51:21 +00002988 assert(useSplitDwarf() && "No split dwarf debug info?");
David Blaikie03073f72013-12-06 22:14:48 +00002989 InfoHolder.emitUnits(this,
Eric Christopher3c5a1912012-12-19 22:02:53 +00002990 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2991 DwarfAbbrevDWOSectionSym);
2992}
2993
2994// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2995// abbreviations for the .debug_info.dwo section.
2996void DwarfDebug::emitDebugAbbrevDWO() {
2997 assert(useSplitDwarf() && "No split dwarf?");
David Blaikie0504cda2013-12-05 07:43:55 +00002998 InfoHolder.emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection());
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002999}
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003000
3001// Emit the .debug_str.dwo section for separated dwarf. This contains the
3002// string section and is identical in format to traditional .debug_str
3003// sections.
3004void DwarfDebug::emitDebugStrDWO() {
3005 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00003006 const MCSection *OffSec =
3007 Asm->getObjFileLowering().getDwarfStrOffDWOSection();
Eric Christopher2cbd5762013-01-07 19:32:41 +00003008 const MCSymbol *StrSym = DwarfStrSectionSym;
3009 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
3010 OffSec, StrSym);
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003011}
David Blaikie409dd9c2013-11-19 23:08:21 +00003012
David Blaikief645f962014-01-09 03:23:41 +00003013void DwarfDebug::addDwarfTypeUnitType(DICompileUnit CUNode,
3014 StringRef Identifier, DIE *RefDie,
3015 DICompositeType CTy) {
David Blaikie322d79b2014-01-31 19:52:26 +00003016 // Flag the type unit reference as a declaration so that if it contains
3017 // members (implicit special members, static data member definitions, member
3018 // declarations for definitions in this CU, etc) consumers don't get confused
3019 // and think this is a full definition.
3020 CUMap.begin()->second->addFlag(RefDie, dwarf::DW_AT_declaration);
Chandler Carruthb587ab62014-01-20 08:07:07 +00003021
David Blaikie47f615e2013-12-17 23:32:35 +00003022 const DwarfTypeUnit *&TU = DwarfTypeUnits[CTy];
Chandler Carruthb587ab62014-01-20 08:07:07 +00003023 if (TU) {
3024 CUMap.begin()->second->addDIETypeSignature(RefDie, *TU);
3025 return;
David Blaikie409dd9c2013-11-19 23:08:21 +00003026 }
3027
Chandler Carruthb587ab62014-01-20 08:07:07 +00003028 DIE *UnitDie = new DIE(dwarf::DW_TAG_type_unit);
3029 DwarfTypeUnit *NewTU = new DwarfTypeUnit(
3030 InfoHolder.getUnits().size(), UnitDie, CUNode, Asm, this, &InfoHolder);
3031 TU = NewTU;
3032 InfoHolder.addUnit(NewTU);
3033
3034 NewTU->addUInt(UnitDie, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
3035 CUNode.getLanguage());
3036
3037 MD5 Hash;
3038 Hash.update(Identifier);
3039 // ... take the least significant 8 bytes and return those. Our MD5
3040 // implementation always returns its results in little endian, swap bytes
3041 // appropriately.
3042 MD5::MD5Result Result;
3043 Hash.final(Result);
3044 uint64_t Signature = *reinterpret_cast<support::ulittle64_t *>(Result + 8);
3045 NewTU->setTypeSignature(Signature);
3046 if (useSplitDwarf())
3047 NewTU->setSkeleton(constructSkeletonTU(NewTU));
3048
3049 NewTU->setType(NewTU->createTypeDIE(CTy));
3050
3051 NewTU->initSection(
3052 useSplitDwarf()
3053 ? Asm->getObjFileLowering().getDwarfTypesDWOSection(Signature)
3054 : Asm->getObjFileLowering().getDwarfTypesSection(Signature));
3055
3056 CUMap.begin()->second->addDIETypeSignature(RefDie, *NewTU);
David Blaikie409dd9c2013-11-19 23:08:21 +00003057}