blob: 610907255b915f484e9f4a05ff0e229cd44c56eb [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
Eric Christopher46e23432013-12-20 04:16:18 +0000425 // Add this range to the list of ranges for the CU.
426 RangeSpan Span(FunctionBeginSym, FunctionEndSym);
427 SPCU->addRange(llvm_move(Span));
428
Chris Lattner3a383cb2010-04-05 00:13:49 +0000429 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
430 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000431 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000432
Eric Christopherd9843b32011-11-10 19:25:34 +0000433 // Add name to the name table, we do this here because we're guaranteed
434 // to have concrete versions of our DW_TAG_subprogram nodes.
435 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher6a841382012-11-19 22:42:10 +0000436
Chris Lattner3a383cb2010-04-05 00:13:49 +0000437 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000438}
439
Manman Ren5b2f4b02013-09-11 19:40:28 +0000440/// Check whether we should create a DIE for the given Scope, return true
441/// if we don't create a DIE (the corresponding DIE is null).
Manman Ren2312ed32013-09-10 18:40:41 +0000442bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
443 if (Scope->isAbstractScope())
444 return false;
445
Manman Ren5b2f4b02013-09-11 19:40:28 +0000446 // We don't create a DIE if there is no Range.
Manman Ren2312ed32013-09-10 18:40:41 +0000447 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
448 if (Ranges.empty())
449 return true;
450
451 if (Ranges.size() > 1)
452 return false;
453
Manman Ren5b2f4b02013-09-11 19:40:28 +0000454 // We don't create a DIE if we have a single Range and the end label
455 // is null.
Manman Ren2312ed32013-09-10 18:40:41 +0000456 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
457 MCSymbol *End = getLabelAfterInsn(RI->second);
458 return !End;
459}
460
Eric Christophera5a79422013-12-09 23:32:48 +0000461static void addSectionLabel(AsmPrinter *Asm, DwarfUnit *U, DIE *D,
Eric Christopherc31fe2d2013-12-05 00:36:17 +0000462 dwarf::Attribute A, const MCSymbol *L,
463 const MCSymbol *Sec) {
464 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
465 U->addSectionLabel(D, A, L);
466 else
467 U->addSectionDelta(D, A, L, Sec);
468}
469
Eric Christopher4287a492013-12-09 23:57:44 +0000470void DwarfDebug::addScopeRangeList(DwarfCompileUnit *TheCU, DIE *ScopeDIE,
Eric Christopherbe2513e2013-12-03 00:45:59 +0000471 const SmallVectorImpl<InsnRange> &Range) {
472 // Emit offset in .debug_range as a relocatable label. emitDIE will handle
473 // emitting it appropriately.
Eric Christopherf8790642013-12-04 22:04:50 +0000474 MCSymbol *RangeSym = Asm->GetTempSymbol("debug_ranges", GlobalRangeCount++);
Eric Christopherc31fe2d2013-12-05 00:36:17 +0000475 addSectionLabel(Asm, TheCU, ScopeDIE, dwarf::DW_AT_ranges, RangeSym,
476 DwarfDebugRangeSectionSym);
477
Eric Christopherf8790642013-12-04 22:04:50 +0000478 RangeSpanList List(RangeSym);
Eric Christopherbe2513e2013-12-03 00:45:59 +0000479 for (SmallVectorImpl<InsnRange>::const_iterator RI = Range.begin(),
480 RE = Range.end();
481 RI != RE; ++RI) {
482 RangeSpan Span(getLabelBeforeInsn(RI->first),
483 getLabelAfterInsn(RI->second));
Eric Christopher270ba4a2013-12-04 19:06:58 +0000484 List.addRange(llvm_move(Span));
Eric Christopherbe2513e2013-12-03 00:45:59 +0000485 }
486
487 // Add the range list to the set of ranges to be emitted.
Eric Christopher270ba4a2013-12-04 19:06:58 +0000488 TheCU->addRangeList(llvm_move(List));
Eric Christopherbe2513e2013-12-03 00:45:59 +0000489}
490
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000491// Construct new DW_TAG_lexical_block for this scope and attach
492// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher4287a492013-12-09 23:57:44 +0000493DIE *DwarfDebug::constructLexicalScopeDIE(DwarfCompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000494 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000495 if (isLexicalScopeDIENull(Scope))
496 return 0;
497
Devang Patel6c74a872010-04-27 19:46:33 +0000498 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
499 if (Scope->isAbstractScope())
500 return ScopeDIE;
501
Eric Christopher0f63d062013-12-03 00:45:45 +0000502 const SmallVectorImpl<InsnRange> &ScopeRanges = Scope->getRanges();
Eric Christopherbe2513e2013-12-03 00:45:59 +0000503
Eric Christopherdc42ea82013-07-03 01:57:28 +0000504 // If we have multiple ranges, emit them into the range section.
Eric Christopher0f63d062013-12-03 00:45:45 +0000505 if (ScopeRanges.size() > 1) {
Eric Christopherbe2513e2013-12-03 00:45:59 +0000506 addScopeRangeList(TheCU, ScopeDIE, ScopeRanges);
Devang Patel6c74a872010-04-27 19:46:33 +0000507 return ScopeDIE;
508 }
509
Eric Christopherdc42ea82013-07-03 01:57:28 +0000510 // Construct the address range for this DIE.
Eric Christopher0f63d062013-12-03 00:45:45 +0000511 SmallVectorImpl<InsnRange>::const_iterator RI = ScopeRanges.begin();
Eric Christopher962c9082013-01-15 23:56:56 +0000512 MCSymbol *Start = getLabelBeforeInsn(RI->first);
513 MCSymbol *End = getLabelAfterInsn(RI->second);
Manman Ren2312ed32013-09-10 18:40:41 +0000514 assert(End && "End label should not be null!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000515
Chris Lattnere13c3722010-03-09 01:58:53 +0000516 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
517 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000518
Eric Christopher962c9082013-01-15 23:56:56 +0000519 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
520 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000521
522 return ScopeDIE;
523}
524
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000525// This scope represents inlined body of a function. Construct DIE to
526// represent this concrete inlined copy of the function.
Eric Christopher4287a492013-12-09 23:57:44 +0000527DIE *DwarfDebug::constructInlinedScopeDIE(DwarfCompileUnit *TheCU,
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000528 LexicalScope *Scope) {
Eric Christopher0f63d062013-12-03 00:45:45 +0000529 const SmallVectorImpl<InsnRange> &ScopeRanges = Scope->getRanges();
Eric Christopher1cdb63d2013-12-04 21:20:15 +0000530 assert(!ScopeRanges.empty() &&
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000531 "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000532
Devang Patelf098ce22011-07-27 00:34:13 +0000533 if (!Scope->getScopeNode())
534 return NULL;
535 DIScope DS(Scope->getScopeNode());
536 DISubprogram InlinedSP = getDISubprogram(DS);
Eric Christophere595bae2013-10-04 17:08:38 +0000537 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patelf098ce22011-07-27 00:34:13 +0000538 if (!OriginDIE) {
Bill Wendling10e0e2e2012-10-30 17:51:02 +0000539 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patelf098ce22011-07-27 00:34:13 +0000540 return NULL;
541 }
542
Devang Patel73bc1722011-05-05 17:54:26 +0000543 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Manman Ren4c4b69c2013-10-11 23:58:05 +0000544 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000545
Eric Christopherbe2513e2013-12-03 00:45:59 +0000546 // If we have multiple ranges, emit them into the range section.
547 if (ScopeRanges.size() > 1)
548 addScopeRangeList(TheCU, ScopeDIE, ScopeRanges);
549 else {
Eric Christopher0f63d062013-12-03 00:45:45 +0000550 SmallVectorImpl<InsnRange>::const_iterator RI = ScopeRanges.begin();
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000551 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
552 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
553
554 if (StartLabel == 0 || EndLabel == 0)
555 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
556
557 assert(StartLabel->isDefined() &&
558 "Invalid starting label for an inlined scope!");
559 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
560
Eric Christopher962c9082013-01-15 23:56:56 +0000561 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
562 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patelf098ce22011-07-27 00:34:13 +0000563 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000564
565 InlinedSubprogramDIEs.insert(OriginDIE);
566
Eric Christopherf94eb2b2013-07-03 02:23:53 +0000567 // Add the call site information to the DIE.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000568 DILocation DL(Scope->getInlinedAt());
David Blaikief2443192013-10-21 17:28:37 +0000569 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, None,
Manman Ren1e427202013-03-07 01:42:00 +0000570 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
571 TheCU->getUniqueID()));
David Blaikief2443192013-10-21 17:28:37 +0000572 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, None, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000573
Eric Christopher8dda5d02011-12-04 06:02:38 +0000574 // Add name to the name table, we do this here because we're guaranteed
575 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
576 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher6a841382012-11-19 22:42:10 +0000577
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000578 return ScopeDIE;
579}
580
Eric Christopher4287a492013-12-09 23:57:44 +0000581DIE *DwarfDebug::createScopeChildrenDIE(DwarfCompileUnit *TheCU,
582 LexicalScope *Scope,
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000583 SmallVectorImpl<DIE *> &Children) {
584 DIE *ObjectPointer = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +0000585
586 // Collect arguments for current function.
Devang Patel7e623022011-08-10 20:55:27 +0000587 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000588 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
589 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher6a841382012-11-19 22:42:10 +0000590 if (DIE *Arg =
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000591 TheCU->constructVariableDIE(*ArgDV, Scope->isAbstractScope())) {
Devang Patel6c622ef2011-03-01 22:58:55 +0000592 Children.push_back(Arg);
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000593 if (ArgDV->isObjectPointer())
594 ObjectPointer = Arg;
Eric Christophere3417762012-09-12 23:36:19 +0000595 }
Devang Patel6c622ef2011-03-01 22:58:55 +0000596
Eric Christopherf84354b2011-10-03 15:49:16 +0000597 // Collect lexical scope children first.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000598 const SmallVectorImpl<DbgVariable *> &Variables =
599 ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000600 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000601 if (DIE *Variable = TheCU->constructVariableDIE(*Variables[i],
602 Scope->isAbstractScope())) {
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000603 Children.push_back(Variable);
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000604 if (Variables[i]->isObjectPointer())
605 ObjectPointer = Variable;
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000606 }
Craig Topper977e9cd2013-07-03 04:24:43 +0000607 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000608 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Patel3acc70e2011-08-15 22:04:40 +0000609 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000610 Children.push_back(Nested);
Manman Ren2312ed32013-09-10 18:40:41 +0000611 return ObjectPointer;
612}
613
614// Construct a DIE for this scope.
Eric Christopher4287a492013-12-09 23:57:44 +0000615DIE *DwarfDebug::constructScopeDIE(DwarfCompileUnit *TheCU,
616 LexicalScope *Scope) {
Manman Ren2312ed32013-09-10 18:40:41 +0000617 if (!Scope || !Scope->getScopeNode())
618 return NULL;
619
620 DIScope DS(Scope->getScopeNode());
621
622 SmallVector<DIE *, 8> Children;
623 DIE *ObjectPointer = NULL;
624 bool ChildrenCreated = false;
625
Manman Ren5b2f4b02013-09-11 19:40:28 +0000626 // We try to create the scope DIE first, then the children DIEs. This will
627 // avoid creating un-used children then removing them later when we find out
628 // the scope DIE is null.
Devang Patel3b548aa2010-03-08 20:52:55 +0000629 DIE *ScopeDIE = NULL;
630 if (Scope->getInlinedAt())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000631 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3b548aa2010-03-08 20:52:55 +0000632 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000633 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000634 if (Scope->isAbstractScope()) {
Eric Christophere595bae2013-10-04 17:08:38 +0000635 ScopeDIE = TheCU->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000636 // Note down abstract DIE.
637 if (ScopeDIE)
638 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
David Blaikiee26a3772013-11-18 23:59:04 +0000639 } else
David Blaikie25bc7192013-11-15 23:13:08 +0000640 ScopeDIE = updateSubprogramScopeDIE(TheCU, DISubprogram(DS));
David Blaikiee26a3772013-11-18 23:59:04 +0000641 } else {
Manman Ren5b2f4b02013-09-11 19:40:28 +0000642 // Early exit when we know the scope DIE is going to be null.
Manman Ren2312ed32013-09-10 18:40:41 +0000643 if (isLexicalScopeDIENull(Scope))
644 return NULL;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000645
646 // We create children here when we know the scope DIE is not going to be
647 // null and the children will be added to the scope DIE.
Manman Ren2312ed32013-09-10 18:40:41 +0000648 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
649 ChildrenCreated = true;
Manman Ren5b2f4b02013-09-11 19:40:28 +0000650
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000651 // There is no need to emit empty lexical block DIE.
David Blaikie684fc532013-05-06 23:33:07 +0000652 std::pair<ImportedEntityMap::const_iterator,
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000653 ImportedEntityMap::const_iterator> Range =
654 std::equal_range(
655 ScopesWithImportedEntities.begin(),
656 ScopesWithImportedEntities.end(),
657 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode *)0),
658 less_first());
David Blaikie684fc532013-05-06 23:33:07 +0000659 if (Children.empty() && Range.first == Range.second)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000660 return NULL;
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000661 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Manman Ren2312ed32013-09-10 18:40:41 +0000662 assert(ScopeDIE && "Scope DIE should not be null.");
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000663 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
664 ++i)
David Blaikie4dd2de72013-05-08 06:01:38 +0000665 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000666 }
Eric Christopher6a841382012-11-19 22:42:10 +0000667
Benjamin Kramer892daba2013-08-24 11:55:49 +0000668 if (!ScopeDIE) {
Manman Ren2312ed32013-09-10 18:40:41 +0000669 assert(Children.empty() &&
670 "We create children only when the scope DIE is not null.");
Benjamin Kramer892daba2013-08-24 11:55:49 +0000671 return NULL;
672 }
Manman Ren2312ed32013-09-10 18:40:41 +0000673 if (!ChildrenCreated)
Manman Ren5b2f4b02013-09-11 19:40:28 +0000674 // We create children when the scope DIE is not null.
Manman Ren2312ed32013-09-10 18:40:41 +0000675 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000676
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000677 // Add children
Craig Topperd8e43652013-07-03 04:17:25 +0000678 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000679 E = Children.end();
680 I != E; ++I)
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000681 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000682
Eric Christophere3417762012-09-12 23:36:19 +0000683 if (DS.isSubprogram() && ObjectPointer != NULL)
Manman Ren4c4b69c2013-10-11 23:58:05 +0000684 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, ObjectPointer);
Eric Christophere3417762012-09-12 23:36:19 +0000685
Eric Christopherd9843b32011-11-10 19:25:34 +0000686 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000687}
688
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000689// Look up the source id with the given directory and source file names.
690// If none currently exists, create a new id and insert it in the
691// SourceIds map. This can update DirectoryNames and SourceFileNames maps
692// as well.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000693unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName, StringRef DirName,
694 unsigned CUID) {
Manman Ren1e427202013-03-07 01:42:00 +0000695 // If we use .loc in assembly, we can't separate .file entries according to
696 // compile units. Thus all files will belong to the default compile unit.
Rafael Espindolaac4ad252013-10-05 16:42:21 +0000697
698 // FIXME: add a better feature test than hasRawTextSupport. Even better,
699 // extend .file to support this.
700 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren1e427202013-03-07 01:42:00 +0000701 CUID = 0;
702
Devang Patel871d0b12010-09-16 20:57:49 +0000703 // If FE did not provide a file name, then assume stdin.
704 if (FileName.empty())
Manman Ren1e427202013-03-07 01:42:00 +0000705 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
Devang Patele01b75c2011-03-24 20:30:50 +0000706
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000707 // TODO: this might not belong here. See if we can factor this better.
708 if (DirName == CompilationDir)
709 DirName = "";
710
Manman Ren1e427202013-03-07 01:42:00 +0000711 // FileIDCUMap stores the current ID for the given compile unit.
712 unsigned SrcId = FileIDCUMap[CUID] + 1;
Devang Patel871d0b12010-09-16 20:57:49 +0000713
Manman Ren1e427202013-03-07 01:42:00 +0000714 // We look up the CUID/file/dir by concatenating them with a zero byte.
Benjamin Kramer71b19732012-03-11 14:56:26 +0000715 SmallString<128> NamePair;
Manman Ren5b22f9f2013-04-06 01:02:38 +0000716 NamePair += utostr(CUID);
Manman Ren1e427202013-03-07 01:42:00 +0000717 NamePair += '\0';
Benjamin Kramer71b19732012-03-11 14:56:26 +0000718 NamePair += DirName;
719 NamePair += '\0'; // Zero bytes are not allowed in paths.
720 NamePair += FileName;
721
722 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
723 if (Ent.getValue() != SrcId)
724 return Ent.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +0000725
Manman Ren1e427202013-03-07 01:42:00 +0000726 FileIDCUMap[CUID] = SrcId;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000727 // Print out a .file directive to specify files for .loc directives.
Manman Ren1e427202013-03-07 01:42:00 +0000728 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
Bill Wendling2b128d72009-05-20 23:19:06 +0000729
730 return SrcId;
731}
732
Eric Christophera5a79422013-12-09 23:32:48 +0000733void DwarfDebug::addGnuPubAttributes(DwarfUnit *U, DIE *D) const {
David Blaikie3c842622013-12-04 21:31:26 +0000734 if (!GenerateGnuPubSections)
735 return;
736
737 addSectionLabel(Asm, U, D, dwarf::DW_AT_GNU_pubnames,
738 Asm->GetTempSymbol("gnu_pubnames", U->getUniqueID()),
739 DwarfGnuPubNamesSectionSym);
740
741 addSectionLabel(Asm, U, D, dwarf::DW_AT_GNU_pubtypes,
742 Asm->GetTempSymbol("gnu_pubtypes", U->getUniqueID()),
743 DwarfGnuPubTypesSectionSym);
744}
745
Eric Christopher4287a492013-12-09 23:57:44 +0000746// Create new DwarfCompileUnit for the given metadata node with tag
Eric Christopher48fef592012-12-20 21:58:40 +0000747// DW_TAG_compile_unit.
Eric Christopher4287a492013-12-09 23:57:44 +0000748DwarfCompileUnit *DwarfDebug::constructDwarfCompileUnit(DICompileUnit DIUnit) {
Devang Patel2d9caf92009-11-25 17:36:49 +0000749 StringRef FN = DIUnit.getFilename();
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000750 CompilationDir = DIUnit.getDirectory();
Bill Wendling2b128d72009-05-20 23:19:06 +0000751
752 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher4287a492013-12-09 23:57:44 +0000753 DwarfCompileUnit *NewCU = new DwarfCompileUnit(
754 InfoHolder.getUnits().size(), Die, DIUnit, Asm, this, &InfoHolder);
David Blaikie2666e242013-12-06 19:38:46 +0000755 InfoHolder.addUnit(NewCU);
756
Manman Ren1e427202013-03-07 01:42:00 +0000757 FileIDCUMap[NewCU->getUniqueID()] = 0;
758 // Call this to emit a .file directive if it wasn't emitted for the source
759 // file this CU comes from yet.
760 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
761
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000762 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patelf20c4f72011-04-12 22:53:02 +0000763 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
764 DIUnit.getLanguage());
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000765 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christopher52ce7182013-04-09 19:23:15 +0000766
Manman Ren4e042a62013-02-05 21:52:47 +0000767 // Define start line table label for each Compile Unit.
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000768 MCSymbol *LineTableStartSym =
769 Asm->GetTempSymbol("line_table_start", NewCU->getUniqueID());
Manman Ren4e042a62013-02-05 21:52:47 +0000770 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
771 NewCU->getUniqueID());
772
Manman Ren9d4c7352013-05-21 00:57:22 +0000773 // Use a single line table if we are using .loc and generating assembly.
774 bool UseTheFirstCU =
Rafael Espindolaac4ad252013-10-05 16:42:21 +0000775 (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport()) ||
776 (NewCU->getUniqueID() == 0);
Manman Ren9d4c7352013-05-21 00:57:22 +0000777
Eric Christopher52ce7182013-04-09 19:23:15 +0000778 if (!useSplitDwarf()) {
Eric Christophera51d3fc2013-09-27 22:50:48 +0000779 // DW_AT_stmt_list is a offset of line number information for this
780 // compile unit in debug_line section. For split dwarf this is
781 // left in the skeleton CU and so not included.
782 // The line table entries are not always emitted in assembly, so it
783 // is not okay to use line_table_start here.
Eric Christopher52ce7182013-04-09 19:23:15 +0000784 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christophera5a79422013-12-09 23:32:48 +0000785 NewCU->addSectionLabel(Die, dwarf::DW_AT_stmt_list,
786 UseTheFirstCU ? Asm->GetTempSymbol("section_line")
787 : LineTableStartSym);
Manman Ren9d4c7352013-05-21 00:57:22 +0000788 else if (UseTheFirstCU)
Eric Christopher33ff6972013-11-21 23:46:41 +0000789 NewCU->addSectionOffset(Die, dwarf::DW_AT_stmt_list, 0);
Eric Christopher52ce7182013-04-09 19:23:15 +0000790 else
Eric Christophera5a79422013-12-09 23:32:48 +0000791 NewCU->addSectionDelta(Die, dwarf::DW_AT_stmt_list, LineTableStartSym,
792 DwarfLineSectionSym);
Eric Christophera51d3fc2013-09-27 22:50:48 +0000793
794 // If we're using split dwarf the compilation dir is going to be in the
795 // skeleton CU and so we don't need to duplicate it here.
796 if (!CompilationDir.empty())
797 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
798
David Blaikie3c842622013-12-04 21:31:26 +0000799 addGnuPubAttributes(NewCU, Die);
Eric Christopher52ce7182013-04-09 19:23:15 +0000800 }
Bill Wendling2b128d72009-05-20 23:19:06 +0000801
Bill Wendling2b128d72009-05-20 23:19:06 +0000802 if (DIUnit.isOptimized())
Eric Christopherbb69a272012-08-24 01:14:27 +0000803 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendling2b128d72009-05-20 23:19:06 +0000804
Devang Patel2d9caf92009-11-25 17:36:49 +0000805 StringRef Flags = DIUnit.getFlags();
806 if (!Flags.empty())
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +0000807 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher6a841382012-11-19 22:42:10 +0000808
Nick Lewycky479a8fe2011-10-17 23:27:36 +0000809 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patelf20c4f72011-04-12 22:53:02 +0000810 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000811 dwarf::DW_FORM_data1, RVer);
Bill Wendling2b128d72009-05-20 23:19:06 +0000812
Devang Patel1a0df9a2010-05-10 22:49:55 +0000813 if (!FirstCU)
814 FirstCU = NewCU;
Eric Christopher7a2cdf72013-02-05 07:31:55 +0000815
Eric Christopherd4368fd2014-01-02 21:03:28 +0000816 if (useSplitDwarf()) {
817 NewCU->initSection(Asm->getObjFileLowering().getDwarfInfoDWOSection(),
818 DwarfInfoDWOSectionSym);
Eric Christopherd8667202013-12-30 17:22:27 +0000819 NewCU->setSkeleton(constructSkeletonCU(NewCU));
Eric Christopherd4368fd2014-01-02 21:03:28 +0000820 } else
821 NewCU->initSection(Asm->getObjFileLowering().getDwarfInfoSection(),
822 DwarfInfoSectionSym);
Eric Christopherd039baa2013-12-30 03:40:32 +0000823
David Blaikie5a152402013-11-15 23:52:02 +0000824 CUMap.insert(std::make_pair(DIUnit, NewCU));
Manman Rence20d462013-10-29 22:57:10 +0000825 CUDieMap.insert(std::make_pair(Die, NewCU));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000826 return NewCU;
Devang Patel1a0df9a2010-05-10 22:49:55 +0000827}
828
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000829// Construct subprogram DIE.
Eric Christopher4287a492013-12-09 23:57:44 +0000830void DwarfDebug::constructSubprogramDIE(DwarfCompileUnit *TheCU,
831 const MDNode *N) {
Eric Christopherffbc4de2013-10-18 01:57:30 +0000832 // FIXME: We should only call this routine once, however, during LTO if a
833 // program is defined in multiple CUs we could end up calling it out of
834 // beginModule as we walk the CUs.
835
Eric Christopher4287a492013-12-09 23:57:44 +0000836 DwarfCompileUnit *&CURef = SPMap[N];
Eric Christopherffbc4de2013-10-18 01:57:30 +0000837 if (CURef)
838 return;
839 CURef = TheCU;
Rafael Espindola6cf4e832011-11-04 19:00:29 +0000840
Devang Patel80ae3492009-08-28 23:24:31 +0000841 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000842 if (!SP.isDefinition())
843 // This is a method declaration which will be handled while constructing
844 // class type.
Devang Patel0751a282009-06-26 01:49:18 +0000845 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000846
Devang Patel89543712011-08-15 17:24:54 +0000847 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000848
Eric Christopherba506db2013-09-09 20:03:20 +0000849 // Expose as a global name.
Eric Christopher2c8b7902013-10-17 02:06:06 +0000850 TheCU->addGlobalName(SP.getName(), SubprogramDie, resolve(SP.getContext()));
Bill Wendling2b128d72009-05-20 23:19:06 +0000851}
852
Eric Christopher4287a492013-12-09 23:57:44 +0000853void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit *TheCU,
David Blaikief55abea2013-04-22 06:12:31 +0000854 const MDNode *N) {
David Blaikie1fd43652013-05-07 21:35:53 +0000855 DIImportedEntity Module(N);
David Blaikief55abea2013-04-22 06:12:31 +0000856 if (!Module.Verify())
857 return;
David Blaikie684fc532013-05-06 23:33:07 +0000858 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
David Blaikie4dd2de72013-05-08 06:01:38 +0000859 constructImportedEntityDIE(TheCU, Module, D);
David Blaikie684fc532013-05-06 23:33:07 +0000860}
861
Eric Christopher4287a492013-12-09 23:57:44 +0000862void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit *TheCU,
863 const MDNode *N, DIE *Context) {
David Blaikie1fd43652013-05-07 21:35:53 +0000864 DIImportedEntity Module(N);
David Blaikie684fc532013-05-06 23:33:07 +0000865 if (!Module.Verify())
866 return;
David Blaikie4dd2de72013-05-08 06:01:38 +0000867 return constructImportedEntityDIE(TheCU, Module, Context);
David Blaikie684fc532013-05-06 23:33:07 +0000868}
869
Eric Christopher4287a492013-12-09 23:57:44 +0000870void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit *TheCU,
David Blaikie1fd43652013-05-07 21:35:53 +0000871 const DIImportedEntity &Module,
David Blaikie684fc532013-05-06 23:33:07 +0000872 DIE *Context) {
873 assert(Module.Verify() &&
874 "Use one of the MDNode * overloads to handle invalid metadata");
875 assert(Context && "Should always have a context for an imported_module");
David Blaikie1fd43652013-05-07 21:35:53 +0000876 DIE *IMDie = new DIE(Module.getTag());
David Blaikief55abea2013-04-22 06:12:31 +0000877 TheCU->insertDIE(Module, IMDie);
David Blaikie1fd43652013-05-07 21:35:53 +0000878 DIE *EntityDie;
879 DIDescriptor Entity = Module.getEntity();
880 if (Entity.isNameSpace())
881 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
882 else if (Entity.isSubprogram())
883 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
David Blaikie3b6038b2013-05-08 06:01:41 +0000884 else if (Entity.isType())
885 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
David Blaikie1fd43652013-05-07 21:35:53 +0000886 else
David Blaikie3b6038b2013-05-08 06:01:41 +0000887 EntityDie = TheCU->getDIE(Entity);
David Blaikief55abea2013-04-22 06:12:31 +0000888 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
889 Module.getContext().getDirectory(),
890 TheCU->getUniqueID());
David Blaikief2443192013-10-21 17:28:37 +0000891 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, None, FileID);
892 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, None, Module.getLineNumber());
Manman Ren4c4b69c2013-10-11 23:58:05 +0000893 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, EntityDie);
David Blaikiee63d5d12013-05-20 22:50:35 +0000894 StringRef Name = Module.getName();
895 if (!Name.empty())
896 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
David Blaikie684fc532013-05-06 23:33:07 +0000897 Context->addChild(IMDie);
David Blaikief55abea2013-04-22 06:12:31 +0000898}
899
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000900// Emit all Dwarf sections that should come prior to the content. Create
901// global DIEs and emit initial debug info sections. This is invoked by
902// the target AsmPrinter.
Eric Christopher58f41952012-11-19 22:42:15 +0000903void DwarfDebug::beginModule() {
Devang Patel6c74a872010-04-27 19:46:33 +0000904 if (DisableDebugInfoPrinting)
905 return;
906
Eric Christopher58f41952012-11-19 22:42:15 +0000907 const Module *M = MMI->getModule();
908
Nick Lewycky019d2552011-07-29 03:49:23 +0000909 // If module has named metadata anchors then use them, otherwise scan the
910 // module using debug info finder to collect debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000911 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
David Blaikiedc69ebb2013-03-11 23:39:23 +0000912 if (!CU_Nodes)
Devang Patel07bb9ee2011-08-15 23:47:24 +0000913 return;
Manman Ren60352032013-09-05 18:48:31 +0000914 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
Devang Patele02e5852011-05-03 16:45:22 +0000915
David Blaikiedc69ebb2013-03-11 23:39:23 +0000916 // Emit initial sections so we can reference labels later.
917 emitSectionLabels();
918
919 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
920 DICompileUnit CUNode(CU_Nodes->getOperand(i));
Eric Christopher4287a492013-12-09 23:57:44 +0000921 DwarfCompileUnit *CU = constructDwarfCompileUnit(CUNode);
David Blaikie1fd43652013-05-07 21:35:53 +0000922 DIArray ImportedEntities = CUNode.getImportedEntities();
923 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
David Blaikie684fc532013-05-06 23:33:07 +0000924 ScopesWithImportedEntities.push_back(std::make_pair(
David Blaikie1fd43652013-05-07 21:35:53 +0000925 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
926 ImportedEntities.getElement(i)));
David Blaikie684fc532013-05-06 23:33:07 +0000927 std::sort(ScopesWithImportedEntities.begin(),
Benjamin Kramerb12cf012013-08-24 12:54:27 +0000928 ScopesWithImportedEntities.end(), less_first());
David Blaikiedc69ebb2013-03-11 23:39:23 +0000929 DIArray GVs = CUNode.getGlobalVariables();
930 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
David Blaikiea781b25b2013-11-17 21:55:13 +0000931 CU->createGlobalVariableDIE(DIGlobalVariable(GVs.getElement(i)));
David Blaikiedc69ebb2013-03-11 23:39:23 +0000932 DIArray SPs = CUNode.getSubprograms();
933 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
934 constructSubprogramDIE(CU, SPs.getElement(i));
935 DIArray EnumTypes = CUNode.getEnumTypes();
936 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
937 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
938 DIArray RetainedTypes = CUNode.getRetainedTypes();
939 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
940 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
David Blaikief55abea2013-04-22 06:12:31 +0000941 // Emit imported_modules last so that the relevant context is already
942 // available.
David Blaikie1fd43652013-05-07 21:35:53 +0000943 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
944 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
David Blaikiedc69ebb2013-03-11 23:39:23 +0000945 }
Eric Christopher6a841382012-11-19 22:42:10 +0000946
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000947 // Tell MMI that we have debug info.
948 MMI->setDebugInfoAvailability(true);
Eric Christopher6a841382012-11-19 22:42:10 +0000949
Bill Wendling2b128d72009-05-20 23:19:06 +0000950 // Prime section data.
Richard Mitton21101b32013-09-19 23:21:01 +0000951 SectionMap[Asm->getObjFileLowering().getTextSection()];
Bill Wendling2b128d72009-05-20 23:19:06 +0000952}
953
Eric Christopher960ac372012-11-22 00:59:49 +0000954// Attach DW_AT_inline attribute with inlined subprogram DIEs.
955void DwarfDebug::computeInlinedDIEs() {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000956 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
957 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000958 AE = InlinedSubprogramDIEs.end();
959 AI != AE; ++AI) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000960 DIE *ISP = *AI;
David Blaikief2443192013-10-21 17:28:37 +0000961 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000962 }
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000963 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +0000964 AE = AbstractSPDies.end();
965 AI != AE; ++AI) {
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000966 DIE *ISP = AI->second;
967 if (InlinedSubprogramDIEs.count(ISP))
968 continue;
David Blaikief2443192013-10-21 17:28:37 +0000969 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
Rafael Espindolae7cc8bf2011-11-12 01:57:54 +0000970 }
Eric Christopher960ac372012-11-22 00:59:49 +0000971}
972
973// Collect info for variables that were optimized out.
974void DwarfDebug::collectDeadVariables() {
975 const Module *M = MMI->getModule();
Eric Christopher960ac372012-11-22 00:59:49 +0000976
977 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
978 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
979 DICompileUnit TheCU(CU_Nodes->getOperand(i));
980 DIArray Subprograms = TheCU.getSubprograms();
981 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopher735401c2012-11-27 00:13:51 +0000982 DISubprogram SP(Subprograms.getElement(i));
Eric Christophera6c38a32013-10-15 23:31:38 +0000983 if (ProcessedSPNodes.count(SP) != 0)
984 continue;
985 if (!SP.isSubprogram())
986 continue;
987 if (!SP.isDefinition())
988 continue;
Eric Christopher735401c2012-11-27 00:13:51 +0000989 DIArray Variables = SP.getVariables();
Eric Christophera6c38a32013-10-15 23:31:38 +0000990 if (Variables.getNumElements() == 0)
991 continue;
Eric Christopher960ac372012-11-22 00:59:49 +0000992
Eric Christopher735401c2012-11-27 00:13:51 +0000993 // Construct subprogram DIE and add variables DIEs.
Eric Christopher4287a492013-12-09 23:57:44 +0000994 DwarfCompileUnit *SPCU =
995 static_cast<DwarfCompileUnit *>(CUMap.lookup(TheCU));
Eric Christopher735401c2012-11-27 00:13:51 +0000996 assert(SPCU && "Unable to find Compile Unit!");
Eric Christopherc798d8a2013-10-22 00:22:39 +0000997 // FIXME: See the comment in constructSubprogramDIE about duplicate
998 // subprogram DIEs.
999 constructSubprogramDIE(SPCU, SP);
1000 DIE *SPDIE = SPCU->getDIE(SP);
Eric Christopher735401c2012-11-27 00:13:51 +00001001 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
1002 DIVariable DV(Variables.getElement(vi));
Eric Christophera6c38a32013-10-15 23:31:38 +00001003 if (!DV.isVariable())
1004 continue;
Manman Renb3388602013-10-05 01:43:03 +00001005 DbgVariable NewVar(DV, NULL, this);
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001006 if (DIE *VariableDIE = SPCU->constructVariableDIE(NewVar, false))
Eric Christophera6c38a32013-10-15 23:31:38 +00001007 SPDIE->addChild(VariableDIE);
Eric Christopher735401c2012-11-27 00:13:51 +00001008 }
Eric Christopher960ac372012-11-22 00:59:49 +00001009 }
1010 }
1011 }
Eric Christopher960ac372012-11-22 00:59:49 +00001012}
1013
1014void DwarfDebug::finalizeModuleInfo() {
1015 // Collect info for variables that were optimized out.
1016 collectDeadVariables();
1017
1018 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1019 computeInlinedDIEs();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001020
Eric Christopherad10cb52013-12-04 23:24:38 +00001021 // Handle anything that needs to be done on a per-unit basis after
1022 // all other generation.
Eric Christophera5a79422013-12-09 23:32:48 +00001023 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
1024 E = getUnits().end();
David Blaikiefd1eff52013-11-26 19:14:34 +00001025 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00001026 DwarfUnit *TheU = *I;
Eric Christopher60eb7692013-08-12 20:27:48 +00001027 // Emit DW_AT_containing_type attribute to connect types with their
1028 // vtable holding type.
David Blaikie2a80e442013-12-02 22:09:48 +00001029 TheU->constructContainingTypeDIEs();
Eric Christopher60eb7692013-08-12 20:27:48 +00001030
Eric Christopher46e23432013-12-20 04:16:18 +00001031 // Add CU specific attributes if we need to add any.
1032 if (TheU->getUnitDie()->getTag() == dwarf::DW_TAG_compile_unit) {
1033 // If we're splitting the dwarf out now that we've got the entire
Eric Christopherd8667202013-12-30 17:22:27 +00001034 // CU then add the dwo id to it.
1035 DwarfCompileUnit *SkCU =
1036 static_cast<DwarfCompileUnit *>(TheU->getSkeleton());
Eric Christopher46e23432013-12-20 04:16:18 +00001037 if (useSplitDwarf()) {
1038 // This should be a unique identifier when we want to build .dwp files.
1039 uint64_t ID = 0;
1040 if (GenerateCUHash) {
1041 DIEHash CUHash;
1042 ID = CUHash.computeCUSignature(*TheU->getUnitDie());
1043 }
1044 TheU->addUInt(TheU->getUnitDie(), dwarf::DW_AT_GNU_dwo_id,
1045 dwarf::DW_FORM_data8, ID);
Eric Christopher46e23432013-12-20 04:16:18 +00001046 SkCU->addUInt(SkCU->getUnitDie(), dwarf::DW_AT_GNU_dwo_id,
1047 dwarf::DW_FORM_data8, ID);
Eric Christopherd29614f2013-08-13 01:21:55 +00001048 }
Eric Christopherd8667202013-12-30 17:22:27 +00001049
Eric Christopher39cde8c2014-01-14 22:44:17 +00001050 // If we have code split among multiple sections or we've requested
1051 // it then emit a DW_AT_ranges attribute on the unit that will remain
1052 // in the .o file, otherwise add a DW_AT_low_pc.
Eric Christopherd8667202013-12-30 17:22:27 +00001053 // FIXME: Also add a high pc if we can.
Eric Christopher39cde8c2014-01-14 22:44:17 +00001054 // FIXME: We should use ranges if we have multiple compile units or
1055 // allow reordering of code ala .subsections_via_symbols in mach-o.
Eric Christopherd8667202013-12-30 17:22:27 +00001056 DwarfCompileUnit *U = SkCU ? SkCU : static_cast<DwarfCompileUnit *>(TheU);
Eric Christopher1ad84572014-01-15 00:04:29 +00001057 if (useCURanges() && TheU->getRanges().size())
Eric Christopherd8667202013-12-30 17:22:27 +00001058 addSectionLabel(Asm, U, U->getUnitDie(), dwarf::DW_AT_ranges,
1059 Asm->GetTempSymbol("cu_ranges", U->getUniqueID()),
1060 DwarfDebugRangeSectionSym);
Eric Christophercf48ade2014-01-24 11:52:53 +00001061 else
1062 U->addUInt(U->getUnitDie(), dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1063 0);
Eric Christopher60eb7692013-08-12 20:27:48 +00001064 }
1065 }
1066
1067 // Compute DIE offsets and sizes.
Eric Christopherc8a310e2012-12-10 23:34:43 +00001068 InfoHolder.computeSizeAndOffsets();
1069 if (useSplitDwarf())
1070 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher960ac372012-11-22 00:59:49 +00001071}
1072
1073void DwarfDebug::endSections() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001074 // Filter labels by section.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001075 for (size_t n = 0; n < ArangeLabels.size(); n++) {
1076 const SymbolCU &SCU = ArangeLabels[n];
Richard Mitton21101b32013-09-19 23:21:01 +00001077 if (SCU.Sym->isInSection()) {
1078 // Make a note of this symbol and it's section.
1079 const MCSection *Section = &SCU.Sym->getSection();
1080 if (!Section->getKind().isMetadata())
1081 SectionMap[Section].push_back(SCU);
1082 } else {
1083 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1084 // appear in the output. This sucks as we rely on sections to build
1085 // arange spans. We can do it without, but it's icky.
1086 SectionMap[NULL].push_back(SCU);
1087 }
1088 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001089
Richard Mittonc2508242013-10-03 22:07:08 +00001090 // Build a list of sections used.
1091 std::vector<const MCSection *> Sections;
Richard Mitton21101b32013-09-19 23:21:01 +00001092 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1093 it++) {
1094 const MCSection *Section = it->first;
Richard Mittonc2508242013-10-03 22:07:08 +00001095 Sections.push_back(Section);
1096 }
1097
1098 // Sort the sections into order.
1099 // This is only done to ensure consistent output order across different runs.
1100 std::sort(Sections.begin(), Sections.end(), SectionSort);
1101
1102 // Add terminating symbols for each section.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001103 for (unsigned ID = 0; ID < Sections.size(); ID++) {
Richard Mittonc2508242013-10-03 22:07:08 +00001104 const MCSection *Section = Sections[ID];
Richard Mitton21101b32013-09-19 23:21:01 +00001105 MCSymbol *Sym = NULL;
1106
1107 if (Section) {
Richard Mittonc2508242013-10-03 22:07:08 +00001108 // We can't call MCSection::getLabelEndName, as it's only safe to do so
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001109 // if we know the section name up-front. For user-created sections, the
Eric Christopher95531b62014-01-29 22:06:21 +00001110 // resulting label may not be valid to use as a label. (section names can
1111 // use a greater set of characters on some systems)
Richard Mittonc2508242013-10-03 22:07:08 +00001112 Sym = Asm->GetTempSymbol("debug_end", ID);
Richard Mitton21101b32013-09-19 23:21:01 +00001113 Asm->OutStreamer.SwitchSection(Section);
1114 Asm->OutStreamer.EmitLabel(Sym);
1115 }
1116
1117 // Insert a final terminator.
Alexey Samsonov4436bf02013-10-03 08:54:43 +00001118 SectionMap[Section].push_back(SymbolCU(NULL, Sym));
Bill Wendling2b128d72009-05-20 23:19:06 +00001119 }
Eric Christopher1bca60d2014-01-23 22:55:47 +00001120
1121 // For now only turn on CU ranges if we've explicitly asked for it,
1122 // we have -ffunction-sections enabled, or we've emitted a function
1123 // into a unique section. At this point all sections should be finalized
1124 // except for dwarf sections.
Eric Christopher2037caf2014-01-28 00:49:26 +00001125 HasCURanges = DwarfCURanges || UsedNonDefaultText ||
Eric Christopher1bca60d2014-01-23 22:55:47 +00001126 TargetMachine::getFunctionSections();
Eric Christopher960ac372012-11-22 00:59:49 +00001127}
Bill Wendling2b128d72009-05-20 23:19:06 +00001128
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001129// Emit all Dwarf sections that should come after the content.
Eric Christopher960ac372012-11-22 00:59:49 +00001130void DwarfDebug::endModule() {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001131 assert(CurFn == 0);
1132 assert(CurMI == 0);
Eric Christopher960ac372012-11-22 00:59:49 +00001133
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001134 if (!FirstCU)
1135 return;
Eric Christopher960ac372012-11-22 00:59:49 +00001136
1137 // End any existing sections.
1138 // TODO: Does this need to happen?
1139 endSections();
1140
1141 // Finalize the debug info for the module.
1142 finalizeModuleInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001143
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001144 emitDebugStr();
Eric Christopher9cd26af2013-09-20 23:22:52 +00001145
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001146 // Emit all the DIEs into a debug info section.
1147 emitDebugInfo();
Eric Christopher4c9b1192012-11-27 00:41:54 +00001148
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001149 // Corresponding abbreviations into a abbrev section.
1150 emitAbbreviations();
Eric Christopher95198f502012-11-27 22:43:42 +00001151
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001152 // Emit info into a debug loc section.
1153 emitDebugLoc();
Eric Christopher95198f502012-11-27 22:43:42 +00001154
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001155 // Emit info into a debug aranges section.
1156 emitDebugARanges();
Eric Christopher95198f502012-11-27 22:43:42 +00001157
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001158 // Emit info into a debug ranges section.
1159 emitDebugRanges();
Eric Christopher95198f502012-11-27 22:43:42 +00001160
Eric Christopher9a8f5ed2013-11-19 09:04:50 +00001161 if (useSplitDwarf()) {
1162 emitDebugStrDWO();
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001163 emitDebugInfoDWO();
Eric Christopher3c5a1912012-12-19 22:02:53 +00001164 emitDebugAbbrevDWO();
Eric Christopher962c9082013-01-15 23:56:56 +00001165 // Emit DWO addresses.
1166 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
Eric Christopher95198f502012-11-27 22:43:42 +00001167 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001168
Eric Christophera876b822012-08-23 07:32:06 +00001169 // Emit info into the dwarf accelerator table sections.
Eric Christopher20b76a72012-08-23 22:36:40 +00001170 if (useDwarfAccelTables()) {
Eric Christopher4996c702011-11-07 09:24:32 +00001171 emitAccelNames();
1172 emitAccelObjC();
1173 emitAccelNamespaces();
1174 emitAccelTypes();
1175 }
Eric Christopher6a841382012-11-19 22:42:10 +00001176
Eric Christopher4b358182013-08-30 00:40:17 +00001177 // Emit the pubnames and pubtypes sections if requested.
1178 if (HasDwarfPubSections) {
David Blaikie70a33202013-09-19 17:33:35 +00001179 emitDebugPubNames(GenerateGnuPubSections);
1180 emitDebugPubTypes(GenerateGnuPubSections);
Eric Christopher4b358182013-08-30 00:40:17 +00001181 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001182
Devang Pateld0701282010-08-02 17:32:15 +00001183 // clean up.
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001184 SPMap.clear();
Eric Christopher8afd7b62012-12-10 19:51:18 +00001185
Eric Christopher9c2ecd92012-11-30 23:59:06 +00001186 // Reset these for the next Module if we have one.
1187 FirstCU = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001188}
1189
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001190// Find abstract variable, if any, associated with Var.
Devang Patelbb23a4a2011-08-10 21:50:54 +00001191DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattner915c5f92010-04-02 19:42:39 +00001192 DebugLoc ScopeLoc) {
Devang Patelbb23a4a2011-08-10 21:50:54 +00001193 LLVMContext &Ctx = DV->getContext();
1194 // More then one inlined variable corresponds to one abstract variable.
1195 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001196 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001197 if (AbsDbgVariable)
1198 return AbsDbgVariable;
1199
Devang Patel7e623022011-08-10 20:55:27 +00001200 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001201 if (!Scope)
1202 return NULL;
1203
Manman Renb3388602013-10-05 01:43:03 +00001204 AbsDbgVariable = new DbgVariable(Var, NULL, this);
Devang Patel7e623022011-08-10 20:55:27 +00001205 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001206 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001207 return AbsDbgVariable;
1208}
1209
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001210// If Var is a current function argument then add it to CurrentFnArguments list.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001211bool DwarfDebug::addCurrentFnArgument(DbgVariable *Var, LexicalScope *Scope) {
Devang Patel7e623022011-08-10 20:55:27 +00001212 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +00001213 return false;
1214 DIVariable DV = Var->getVariable();
1215 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1216 return false;
1217 unsigned ArgNo = DV.getArgNumber();
Eric Christopher6a841382012-11-19 22:42:10 +00001218 if (ArgNo == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001219 return false;
1220
Devang Patel4ab660b2011-03-03 20:02:02 +00001221 size_t Size = CurrentFnArguments.size();
1222 if (Size == 0)
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001223 CurrentFnArguments.resize(CurFn->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001224 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001225 // arguments does the function have at source level.
1226 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001227 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001228 CurrentFnArguments[ArgNo - 1] = Var;
1229 return true;
1230}
1231
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001232// Collect variable information from side table maintained by MMI.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001233void DwarfDebug::collectVariableInfoFromMMITable(
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001234 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001235 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1236 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001237 VE = VMap.end();
1238 VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001239 const MDNode *Var = VI->first;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001240 if (!Var)
1241 continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001242 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001243 DIVariable DV(Var);
1244 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001245
Devang Patel7e623022011-08-10 20:55:27 +00001246 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001247
Devang Patelcdb7d442009-11-10 23:20:04 +00001248 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001249 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001250 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001251
Devang Patele1c53f22010-05-20 16:36:41 +00001252 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Manman Renb3388602013-10-05 01:43:03 +00001253 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
Devang Patel3e4a9652011-08-15 21:24:36 +00001254 RegVar->setFrameIndex(VP.first);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001255 if (!addCurrentFnArgument(RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001256 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001257 if (AbsDbgVariable)
Devang Patel3e4a9652011-08-15 21:24:36 +00001258 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patel475d32a2009-10-06 01:26:37 +00001259 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001260}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001261
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001262// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1263// defined reg.
Devang Patel9fc11702010-05-25 23:40:22 +00001264static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001265 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001266 return MI->getNumOperands() == 3 && MI->getOperand(0).isReg() &&
1267 MI->getOperand(0).getReg() &&
Adrian Prantl418d1d12013-07-09 20:28:37 +00001268 (MI->getOperand(1).isImm() ||
1269 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
Devang Patel9fc11702010-05-25 23:40:22 +00001270}
1271
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001272// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher6a841382012-11-19 22:42:10 +00001273static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1274 const MCSymbol *FLabel,
Devang Patel2442a892011-07-08 17:09:57 +00001275 const MCSymbol *SLabel,
1276 const MachineInstr *MI) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001277 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Devang Patel2442a892011-07-08 17:09:57 +00001278
David Blaikie0252265b2013-06-16 20:34:15 +00001279 assert(MI->getNumOperands() == 3);
Adrian Prantl418d1d12013-07-09 20:28:37 +00001280 if (MI->getOperand(0).isReg()) {
Devang Patel2442a892011-07-08 17:09:57 +00001281 MachineLocation MLoc;
Adrian Prantl418d1d12013-07-09 20:28:37 +00001282 // If the second operand is an immediate, this is a
1283 // register-indirect address.
1284 if (!MI->getOperand(1).isImm())
Adrian Prantld4c0dd42013-04-26 21:57:17 +00001285 MLoc.set(MI->getOperand(0).getReg());
1286 else
1287 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
Devang Patel2442a892011-07-08 17:09:57 +00001288 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1289 }
1290 if (MI->getOperand(0).isImm())
1291 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1292 if (MI->getOperand(0).isFPImm())
1293 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1294 if (MI->getOperand(0).isCImm())
1295 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1296
Craig Topperee4dab52012-02-05 08:31:47 +00001297 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel2442a892011-07-08 17:09:57 +00001298}
1299
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001300// Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001301void
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001302DwarfDebug::collectVariableInfo(SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001303
Eric Christopher270a12c2013-07-03 21:37:03 +00001304 // Grab the variable info that was squirreled away in the MMI side-table.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001305 collectVariableInfoFromMMITable(Processed);
Devang Patel490c8ab2010-05-20 19:57:06 +00001306
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001307 for (SmallVectorImpl<const MDNode *>::const_iterator
1308 UVI = UserVariables.begin(),
1309 UVE = UserVariables.end();
1310 UVI != UVE; ++UVI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001311 const MDNode *Var = *UVI;
1312 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001313 continue;
1314
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001315 // History contains relevant DBG_VALUE instructions for Var and instructions
1316 // clobbering it.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001317 SmallVectorImpl<const MachineInstr *> &History = DbgValues[Var];
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001318 if (History.empty())
1319 continue;
1320 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001321
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001322 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001323 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001324 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001325 DISubprogram(DV.getContext()).describes(CurFn->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +00001326 Scope = LScopes.getCurrentFunctionScope();
David Blaikiedc69ebb2013-03-11 23:39:23 +00001327 else if (MDNode *IA = DV.getInlinedAt())
1328 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1329 else
1330 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel490c8ab2010-05-20 19:57:06 +00001331 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001332 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001333 continue;
1334
1335 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001336 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel99819b52011-08-15 19:01:20 +00001337 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
Manman Renb3388602013-10-05 01:43:03 +00001338 DbgVariable *RegVar = new DbgVariable(DV, AbsVar, this);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001339 if (!addCurrentFnArgument(RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001340 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +00001341 if (AbsVar)
Devang Patel3e4a9652011-08-15 21:24:36 +00001342 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001343
Eric Christophercc10d202012-10-08 20:48:54 +00001344 // Simplify ranges that are fully coalesced.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001345 if (History.size() <= 1 ||
1346 (History.size() == 2 && MInsn->isIdenticalTo(History.back()))) {
Devang Patel3e4a9652011-08-15 21:24:36 +00001347 RegVar->setMInsn(MInsn);
Devang Patel9fc11702010-05-25 23:40:22 +00001348 continue;
1349 }
1350
Eric Christopher59cc0712013-01-28 17:33:26 +00001351 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001352 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001353
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001354 for (SmallVectorImpl<const MachineInstr *>::const_iterator
1355 HI = History.begin(),
1356 HE = History.end();
1357 HI != HE; ++HI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001358 const MachineInstr *Begin = *HI;
1359 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001360
Devang Patele7181b52011-06-01 23:00:17 +00001361 // Check if DBG_VALUE is truncating a range.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001362 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg() &&
1363 !Begin->getOperand(0).getReg())
Devang Patele7181b52011-06-01 23:00:17 +00001364 continue;
1365
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001366 // Compute the range for a register location.
1367 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1368 const MCSymbol *SLabel = 0;
1369
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001370 if (HI + 1 == HE)
1371 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001372 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001373 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001374 else {
1375 const MachineInstr *End = HI[1];
Eric Christopher6a841382012-11-19 22:42:10 +00001376 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001377 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001378 if (End->isDebugValue())
1379 SLabel = getLabelBeforeInsn(End);
1380 else {
1381 // End is a normal instruction clobbering the range.
1382 SLabel = getLabelAfterInsn(End);
1383 assert(SLabel && "Forgot label after clobber instruction");
1384 ++HI;
1385 }
1386 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001387
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001388 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001389 DotDebugLocEntries.push_back(
1390 getDebugLocEntry(Asm, FLabel, SLabel, Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001391 }
1392 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001393 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001394
1395 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001396 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1397 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1398 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1399 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001400 if (!DV || !DV.isVariable() || !Processed.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001401 continue;
1402 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001403 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patele0a94bf2010-05-14 21:01:35 +00001404 }
Devang Patel9fc11702010-05-25 23:40:22 +00001405}
Devang Patele0a94bf2010-05-14 21:01:35 +00001406
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001407// Return Label preceding the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001408MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001409 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1410 assert(Label && "Didn't insert label before instruction");
1411 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001412}
1413
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001414// Return Label immediately following the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +00001415MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001416 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001417}
1418
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001419// Process beginning of an instruction.
Devang Patelb5694e72010-10-26 17:49:02 +00001420void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001421 assert(CurMI == 0);
1422 CurMI = MI;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001423 // Check if source location changes, but ignore DBG_VALUE locations.
1424 if (!MI->isDebugValue()) {
1425 DebugLoc DL = MI->getDebugLoc();
1426 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopheraec8a822012-04-05 20:39:05 +00001427 unsigned Flags = 0;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001428 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001429 if (DL == PrologEndLoc) {
1430 Flags |= DWARF2_FLAG_PROLOGUE_END;
1431 PrologEndLoc = DebugLoc();
1432 }
Eric Christopheraec8a822012-04-05 20:39:05 +00001433 if (PrologEndLoc.isUnknown())
1434 Flags |= DWARF2_FLAG_IS_STMT;
1435
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001436 if (!DL.isUnknown()) {
1437 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001438 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001439 } else
Devang Patel34a66202011-05-11 19:22:19 +00001440 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001441 }
Devang Patel9fc11702010-05-25 23:40:22 +00001442 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001443
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001444 // Insert labels where requested.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001445 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
1446 LabelsBeforeInsn.find(MI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001447
1448 // No label needed.
1449 if (I == LabelsBeforeInsn.end())
1450 return;
1451
1452 // Label already assigned.
1453 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001454 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001455
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001456 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001457 PrevLabel = MMI->getContext().CreateTempSymbol();
1458 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001459 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001460 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001461}
1462
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001463// Process end of an instruction.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001464void DwarfDebug::endInstruction() {
1465 assert(CurMI != 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001466 // Don't create a new label after DBG_VALUE instructions.
1467 // They don't generate code.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001468 if (!CurMI->isDebugValue())
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001469 PrevLabel = 0;
1470
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001471 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001472 LabelsAfterInsn.find(CurMI);
1473 CurMI = 0;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001474
1475 // No label needed.
1476 if (I == LabelsAfterInsn.end())
1477 return;
1478
1479 // Label already assigned.
1480 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001481 return;
1482
1483 // We need a label after this instruction.
1484 if (!PrevLabel) {
1485 PrevLabel = MMI->getContext().CreateTempSymbol();
1486 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001487 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001488 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001489}
1490
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001491// Each LexicalScope has first instruction and last instruction to mark
1492// beginning and end of a scope respectively. Create an inverse map that list
1493// scopes starts (and ends) with an instruction. One instruction may start (or
1494// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001495void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001496 SmallVector<LexicalScope *, 4> WorkList;
1497 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001498 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001499 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001500
Craig Topper977e9cd2013-07-03 04:24:43 +00001501 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001502 if (!Children.empty())
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001503 for (SmallVectorImpl<LexicalScope *>::const_iterator
1504 SI = Children.begin(),
1505 SE = Children.end();
1506 SI != SE; ++SI)
Devang Patel7771b7c2010-01-20 02:05:23 +00001507 WorkList.push_back(*SI);
1508
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001509 if (S->isAbstractScope())
1510 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001511
Craig Topper977e9cd2013-07-03 04:24:43 +00001512 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001513 if (Ranges.empty())
1514 continue;
Craig Topperd8e43652013-07-03 04:17:25 +00001515 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001516 RE = Ranges.end();
1517 RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001518 assert(RI->first && "InsnRange does not have first instruction!");
1519 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001520 requestLabelBeforeInsn(RI->first);
1521 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001522 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001523 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001524}
1525
NAKAMURA Takumib366f012014-01-29 06:05:38 +00001526// Get MDNode for DebugLoc's scope.
1527static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1528 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1529 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1530 return DL.getScope(Ctx);
1531}
1532
1533// Walk up the scope chain of given debug loc and find line number info
1534// for the function.
1535static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1536 const MDNode *Scope = getScopeNode(DL, Ctx);
1537 DISubprogram SP = getDISubprogram(Scope);
1538 if (SP.isSubprogram()) {
1539 // Check for number of operands since the compatibility is
1540 // cheap here.
1541 if (SP->getNumOperands() > 19)
1542 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1543 else
1544 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1545 }
1546
1547 return DebugLoc();
1548}
1549
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001550// Gather pre-function debug information. Assumes being called immediately
1551// after the function entry point has been emitted.
Chris Lattner76555b52010-01-26 23:18:02 +00001552void DwarfDebug::beginFunction(const MachineFunction *MF) {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001553 CurFn = MF;
Eric Christopherfedfa442013-11-01 23:14:17 +00001554
1555 // If there's no debug info for the function we're not going to do anything.
1556 if (!MMI->hasDebugInfo())
1557 return;
1558
1559 // Grab the lexical scopes for the function, if we don't have any of those
1560 // then we're not going to be able to do anything.
Devang Patel7e623022011-08-10 20:55:27 +00001561 LScopes.initialize(*MF);
Eric Christopherfedfa442013-11-01 23:14:17 +00001562 if (LScopes.empty())
1563 return;
1564
1565 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1566
1567 // Make sure that each lexical scope will have a begin/end label.
Devang Patel7e623022011-08-10 20:55:27 +00001568 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001569
Eric Christopher4287a492013-12-09 23:57:44 +00001570 // Set DwarfDwarfCompileUnitID in MCContext to the Compile Unit this function
Eric Christopherfedfa442013-11-01 23:14:17 +00001571 // belongs to so that we add to the correct per-cu line table in the
1572 // non-asm case.
Manman Ren4e042a62013-02-05 21:52:47 +00001573 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Eric Christopher4287a492013-12-09 23:57:44 +00001574 DwarfCompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Manman Ren4e042a62013-02-05 21:52:47 +00001575 assert(TheCU && "Unable to find compile unit!");
Rafael Espindolaac4ad252013-10-05 16:42:21 +00001576 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
Manman Ren9d4c7352013-05-21 00:57:22 +00001577 // Use a single line table if we are using .loc and generating assembly.
1578 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1579 else
1580 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
Manman Ren4e042a62013-02-05 21:52:47 +00001581
Eric Christopher2037caf2014-01-28 00:49:26 +00001582 // Check the current section against the standard text section. If different
1583 // keep track so that we will know when we're emitting functions into multiple
1584 // sections.
1585 if (Asm->getObjFileLowering().getTextSection() != Asm->getCurrentSection())
1586 UsedNonDefaultText = true;
1587
Eric Christopherfedfa442013-11-01 23:14:17 +00001588 // Emit a label for the function so that we have a beginning address.
1589 FunctionBeginSym = Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001590 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001591 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001592
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001593 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001594 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Eric Christopherfedfa442013-11-01 23:14:17 +00001595 std::vector<const MDNode *> LiveUserVar(TRI->getNumRegs());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001596
Eric Christopherfedfa442013-11-01 23:14:17 +00001597 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end(); I != E;
1598 ++I) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001599 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001600 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1601 II != IE; ++II) {
1602 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001603
Devang Patel002d54d2010-05-26 19:37:24 +00001604 if (MI->isDebugValue()) {
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001605 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001606
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001607 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001608 const MDNode *Var =
Eric Christopherfedfa442013-11-01 23:14:17 +00001609 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001610
1611 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001612 if (isDbgValueInDefinedReg(MI))
1613 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1614
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001615 // Check the history of this variable.
Eric Christopherfedfa442013-11-01 23:14:17 +00001616 SmallVectorImpl<const MachineInstr *> &History = DbgValues[Var];
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001617 if (History.empty()) {
1618 UserVariables.push_back(Var);
1619 // The first mention of a function argument gets the FunctionBeginSym
1620 // label, so arguments are visible when breaking at function entry.
1621 DIVariable DV(Var);
Manman Ren7504ed42013-07-08 18:33:29 +00001622 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
David Blaikie5af2aca2013-11-18 23:57:26 +00001623 getDISubprogram(DV.getContext()).describes(MF->getFunction()))
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001624 LabelsBeforeInsn[MI] = FunctionBeginSym;
1625 } else {
1626 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1627 const MachineInstr *Prev = History.back();
1628 if (Prev->isDebugValue()) {
1629 // Coalesce identical entries at the end of History.
1630 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001631 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher85a495e2012-10-08 20:48:49 +00001632 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopherfedfa442013-11-01 23:14:17 +00001633 << "\t" << *Prev << "\t"
1634 << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001635 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001636 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001637
1638 // Terminate old register assignments that don't reach MI;
1639 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1640 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1641 isDbgValueInDefinedReg(Prev)) {
1642 // Previous register assignment needs to terminate at the end of
1643 // its basic block.
1644 MachineBasicBlock::const_iterator LastMI =
Eric Christopherfedfa442013-11-01 23:14:17 +00001645 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001646 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001647 // Drop DBG_VALUE for empty range.
Eric Christopher85a495e2012-10-08 20:48:49 +00001648 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Eric Christopherfedfa442013-11-01 23:14:17 +00001649 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001650 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001651 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001652 // Terminate after LastMI.
1653 History.push_back(LastMI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001654 }
1655 }
1656 }
1657 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001658 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001659 // Not a DBG_VALUE instruction.
1660 if (!MI->isLabel())
1661 AtBlockEntry = false;
1662
Eric Christopher133195782012-10-04 20:46:14 +00001663 // First known non-DBG_VALUE and non-frame setup location marks
1664 // the beginning of the function body.
1665 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1666 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel34a66202011-05-11 19:22:19 +00001667 PrologEndLoc = MI->getDebugLoc();
1668
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001669 // Check if the instruction clobbers any registers with debug vars.
1670 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
Eric Christopherfedfa442013-11-01 23:14:17 +00001671 MOE = MI->operands_end();
1672 MOI != MOE; ++MOI) {
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001673 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1674 continue;
Eric Christopherfedfa442013-11-01 23:14:17 +00001675 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true); AI.isValid();
1676 ++AI) {
Jakob Stoklund Olesen54038d72012-06-01 23:28:30 +00001677 unsigned Reg = *AI;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001678 const MDNode *Var = LiveUserVar[Reg];
1679 if (!Var)
1680 continue;
1681 // Reg is now clobbered.
1682 LiveUserVar[Reg] = 0;
1683
1684 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001685 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1686 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001687 continue;
Eric Christopherfedfa442013-11-01 23:14:17 +00001688 SmallVectorImpl<const MachineInstr *> &History = HistI->second;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001689 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001690 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001691 const MachineInstr *Prev = History.back();
1692 // Sanity-check: Register assignments are terminated at the end of
1693 // their block.
1694 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1695 continue;
1696 // Is the variable still in Reg?
1697 if (!isDbgValueInDefinedReg(Prev) ||
1698 Prev->getOperand(0).getReg() != Reg)
1699 continue;
1700 // Var is clobbered. Make sure the next instruction gets a label.
1701 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001702 }
1703 }
Devang Patel002d54d2010-05-26 19:37:24 +00001704 }
Devang Patel002d54d2010-05-26 19:37:24 +00001705 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001706 }
1707
1708 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1709 I != E; ++I) {
Eric Christopherfedfa442013-11-01 23:14:17 +00001710 SmallVectorImpl<const MachineInstr *> &History = I->second;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001711 if (History.empty())
1712 continue;
1713
1714 // Make sure the final register assignments are terminated.
1715 const MachineInstr *Prev = History.back();
1716 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1717 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher6a841382012-11-19 22:42:10 +00001718 MachineBasicBlock::const_iterator LastMI =
Eric Christopherfedfa442013-11-01 23:14:17 +00001719 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001720 if (LastMI == PrevMBB->end())
1721 // Drop DBG_VALUE for empty range.
1722 History.pop_back();
David Blaikieea2605d2013-06-20 00:25:24 +00001723 else if (PrevMBB != &PrevMBB->getParent()->back()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001724 // Terminate after LastMI.
1725 History.push_back(LastMI);
1726 }
1727 }
1728 // Request labels for the full history.
1729 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1730 const MachineInstr *MI = History[i];
1731 if (MI->isDebugValue())
1732 requestLabelBeforeInsn(MI);
1733 else
1734 requestLabelAfterInsn(MI);
1735 }
1736 }
Devang Patel002d54d2010-05-26 19:37:24 +00001737
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001738 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001739 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001740
1741 // Record beginning of function.
1742 if (!PrologEndLoc.isUnknown()) {
Eric Christopherfedfa442013-11-01 23:14:17 +00001743 DebugLoc FnStartDL =
NAKAMURA Takumib366f012014-01-29 06:05:38 +00001744 getFnDebugLoc(PrologEndLoc, MF->getFunction()->getContext());
Eric Christopherfedfa442013-11-01 23:14:17 +00001745 recordSourceLine(
1746 FnStartDL.getLine(), FnStartDL.getCol(),
1747 FnStartDL.getScope(MF->getFunction()->getContext()),
1748 // We'd like to list the prologue as "not statements" but GDB behaves
1749 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
1750 DWARF2_FLAG_IS_STMT);
Devang Patel34a66202011-05-11 19:22:19 +00001751 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001752}
1753
Devang Patel7e623022011-08-10 20:55:27 +00001754void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
David Blaikie6f1a8062013-06-05 05:39:59 +00001755 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1756 DIVariable DV = Var->getVariable();
David Blaikie36d5d2f2013-06-06 21:04:51 +00001757 // Variables with positive arg numbers are parameters.
1758 if (unsigned ArgNum = DV.getArgNumber()) {
1759 // Keep all parameters in order at the start of the variable list to ensure
1760 // function types are correct (no out-of-order parameters)
1761 //
1762 // This could be improved by only doing it for optimized builds (unoptimized
1763 // builds have the right order to begin with), searching from the back (this
1764 // would catch the unoptimized case quickly), or doing a binary search
1765 // rather than linear search.
1766 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1767 while (I != Vars.end()) {
1768 unsigned CurNum = (*I)->getVariable().getArgNumber();
1769 // A local (non-parameter) variable has been found, insert immediately
1770 // before it.
1771 if (CurNum == 0)
1772 break;
1773 // A later indexed parameter has been found, insert immediately before it.
David Blaikieb272a752013-06-06 22:28:26 +00001774 if (CurNum > ArgNum)
David Blaikie36d5d2f2013-06-06 21:04:51 +00001775 break;
David Blaikieb272a752013-06-06 22:28:26 +00001776 ++I;
David Blaikie6f1a8062013-06-05 05:39:59 +00001777 }
David Blaikie36d5d2f2013-06-06 21:04:51 +00001778 Vars.insert(I, Var);
1779 return;
David Blaikie6f1a8062013-06-05 05:39:59 +00001780 }
1781
1782 Vars.push_back(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001783}
1784
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001785// Gather and emit post-function debug information.
NAKAMURA Takumib9271612013-12-03 13:15:54 +00001786void DwarfDebug::endFunction(const MachineFunction *MF) {
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001787 // Every beginFunction(MF) call should be followed by an endFunction(MF) call,
1788 // though the beginFunction may not be called at all.
1789 // We should handle both cases.
1790 if (CurFn == 0)
1791 CurFn = MF;
1792 else
1793 assert(CurFn == MF);
1794 assert(CurFn != 0);
1795
1796 if (!MMI->hasDebugInfo() || LScopes.empty()) {
1797 CurFn = 0;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001798 return;
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001799 }
Devang Patel2904aa92009-11-12 19:02:56 +00001800
Devang Patel7e623022011-08-10 20:55:27 +00001801 // Define end label for subprogram.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001802 FunctionEndSym = Asm->GetTempSymbol("func_end", Asm->getFunctionNumber());
Devang Patel7e623022011-08-10 20:55:27 +00001803 // Assumes in correct section after the entry point.
1804 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Eric Christopher4287a492013-12-09 23:57:44 +00001805 // Set DwarfDwarfCompileUnitID in MCContext to default value.
Manman Ren4e042a62013-02-05 21:52:47 +00001806 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher6a841382012-11-19 22:42:10 +00001807
Devang Patel7e623022011-08-10 20:55:27 +00001808 SmallPtrSet<const MDNode *, 16> ProcessedVars;
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001809 collectVariableInfo(ProcessedVars);
Eric Christopher6a841382012-11-19 22:42:10 +00001810
Devang Patel3acc70e2011-08-15 22:04:40 +00001811 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Eric Christopher4287a492013-12-09 23:57:44 +00001812 DwarfCompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky654f5ce2011-10-26 22:55:33 +00001813 assert(TheCU && "Unable to find compile unit!");
Devang Patel3acc70e2011-08-15 22:04:40 +00001814
Devang Patel7e623022011-08-10 20:55:27 +00001815 // Construct abstract scopes.
Devang Patel44403472011-08-12 18:10:19 +00001816 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1817 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1818 LexicalScope *AScope = AList[i];
1819 DISubprogram SP(AScope->getScopeNode());
Manman Ren7504ed42013-07-08 18:33:29 +00001820 if (SP.isSubprogram()) {
Devang Patel7e623022011-08-10 20:55:27 +00001821 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001822 DIArray Variables = SP.getVariables();
1823 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1824 DIVariable DV(Variables.getElement(i));
Manman Ren7504ed42013-07-08 18:33:29 +00001825 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
Devang Patel59e27c52011-08-19 23:28:12 +00001826 continue;
Alexey Samsonov39602782012-07-06 08:45:08 +00001827 // Check that DbgVariable for DV wasn't created earlier, when
1828 // findAbstractVariable() was called for inlined instance of DV.
1829 LLVMContext &Ctx = DV->getContext();
1830 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1831 if (AbstractVariables.lookup(CleanDV))
1832 continue;
Devang Patel59e27c52011-08-19 23:28:12 +00001833 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
Manman Renb3388602013-10-05 01:43:03 +00001834 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001835 }
1836 }
Devang Patel44403472011-08-12 18:10:19 +00001837 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Manman Ren4213c392013-05-29 17:16:59 +00001838 constructScopeDIE(TheCU, AScope);
Bill Wendling2b128d72009-05-20 23:19:06 +00001839 }
Eric Christopher6a841382012-11-19 22:42:10 +00001840
Devang Patel3acc70e2011-08-15 22:04:40 +00001841 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher6a841382012-11-19 22:42:10 +00001842
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001843 if (!CurFn->getTarget().Options.DisableFramePointerElim(*CurFn))
Eric Christopherbb69a272012-08-24 01:14:27 +00001844 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Patel3acc70e2011-08-15 22:04:40 +00001845
Bill Wendling2b128d72009-05-20 23:19:06 +00001846 // Clear debug info
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001847 for (ScopeVariablesMap::iterator I = ScopeVariables.begin(),
1848 E = ScopeVariables.end();
1849 I != E; ++I)
Devang Patel7e623022011-08-10 20:55:27 +00001850 DeleteContainerPointers(I->second);
1851 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001852 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001853 UserVariables.clear();
1854 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001855 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001856 LabelsBeforeInsn.clear();
1857 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001858 PrevLabel = NULL;
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001859 CurFn = 0;
Bill Wendling2b128d72009-05-20 23:19:06 +00001860}
1861
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001862// Register a source line with debug info. Returns the unique label that was
1863// emitted and which provides correspondence to the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00001864void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1865 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00001866 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00001867 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00001868 unsigned Src = 1;
1869 if (S) {
1870 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00001871
Dan Gohman50849c62010-05-05 23:41:32 +00001872 if (Scope.isCompileUnit()) {
1873 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001874 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001875 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00001876 } else if (Scope.isFile()) {
1877 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00001878 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001879 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001880 } else if (Scope.isSubprogram()) {
1881 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001882 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001883 Dir = SP.getDirectory();
Eric Christopher6647b832011-10-11 22:59:11 +00001884 } else if (Scope.isLexicalBlockFile()) {
1885 DILexicalBlockFile DBF(S);
1886 Fn = DBF.getFilename();
1887 Dir = DBF.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001888 } else if (Scope.isLexicalBlock()) {
1889 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001890 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001891 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001892 } else
Craig Topperee4dab52012-02-05 08:31:47 +00001893 llvm_unreachable("Unexpected scope info");
Dan Gohman50849c62010-05-05 23:41:32 +00001894
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001895 Src = getOrCreateSourceID(
1896 Fn, Dir, Asm->OutStreamer.getContext().getDwarfCompileUnitID());
Dan Gohman50849c62010-05-05 23:41:32 +00001897 }
Nick Lewycky019d2552011-07-29 03:49:23 +00001898 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00001899}
1900
Bill Wendling806535f2009-05-20 23:22:40 +00001901//===----------------------------------------------------------------------===//
1902// Emit Methods
1903//===----------------------------------------------------------------------===//
1904
Manman Rence20d462013-10-29 22:57:10 +00001905// Compute the size and offset of a DIE. The offset is relative to start of the
1906// CU. It returns the offset after laying out the DIE.
Eric Christopherf8194852013-12-05 18:06:10 +00001907unsigned DwarfFile::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling480ff322009-05-20 23:21:38 +00001908 // Get the children.
1909 const std::vector<DIE *> &Children = Die->getChildren();
1910
Bill Wendling480ff322009-05-20 23:21:38 +00001911 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00001912 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00001913
1914 // Get the abbreviation for this DIE.
David Blaikieff3ab2c2013-12-05 01:01:41 +00001915 const DIEAbbrev &Abbrev = Die->getAbbrev();
Bill Wendling480ff322009-05-20 23:21:38 +00001916
1917 // Set DIE offset
1918 Die->setOffset(Offset);
1919
1920 // Start the size with the size of abbreviation code.
David Blaikieff3ab2c2013-12-05 01:01:41 +00001921 Offset += MCAsmInfo::getULEB128Size(Die->getAbbrevNumber());
Bill Wendling480ff322009-05-20 23:21:38 +00001922
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001923 const SmallVectorImpl<DIEValue *> &Values = Die->getValues();
David Blaikieff3ab2c2013-12-05 01:01:41 +00001924 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
Bill Wendling480ff322009-05-20 23:21:38 +00001925
1926 // Size the DIE attribute values.
1927 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1928 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001929 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001930
1931 // Size the DIE children if any.
1932 if (!Children.empty()) {
David Blaikieff3ab2c2013-12-05 01:01:41 +00001933 assert(Abbrev.getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
Bill Wendling480ff322009-05-20 23:21:38 +00001934 "Children flag not set");
1935
1936 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher1f0cbb82012-11-20 22:14:13 +00001937 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling480ff322009-05-20 23:21:38 +00001938
1939 // End of children marker.
1940 Offset += sizeof(int8_t);
1941 }
1942
1943 Die->setSize(Offset - Die->getOffset());
1944 return Offset;
1945}
1946
Eric Christopherb088d2d2013-10-24 21:05:08 +00001947// Compute the size and offset for each DIE.
Eric Christopherf8194852013-12-05 18:06:10 +00001948void DwarfFile::computeSizeAndOffsets() {
Manman Rence20d462013-10-29 22:57:10 +00001949 // Offset from the first CU in the debug info section is 0 initially.
1950 unsigned SecOffset = 0;
1951
Eric Christopherb088d2d2013-10-24 21:05:08 +00001952 // Iterate over each compile unit and set the size and offsets for each
1953 // DIE within each compile unit. All offsets are CU relative.
Eric Christophera5a79422013-12-09 23:32:48 +00001954 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = CUs.begin(),
1955 E = CUs.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001956 I != E; ++I) {
Manman Rence20d462013-10-29 22:57:10 +00001957 (*I)->setDebugInfoOffset(SecOffset);
1958
1959 // CU-relative offset is reset to 0 here.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001960 unsigned Offset = sizeof(int32_t) + // Length of Unit Info
David Blaikie6b288cf2013-10-30 20:42:41 +00001961 (*I)->getHeaderSize(); // Unit-specific headers
Manman Rence20d462013-10-29 22:57:10 +00001962
1963 // EndOffset here is CU-relative, after laying out
1964 // all of the CU DIE.
David Blaikie2a80e442013-12-02 22:09:48 +00001965 unsigned EndOffset = computeSizeAndOffset((*I)->getUnitDie(), Offset);
Manman Rence20d462013-10-29 22:57:10 +00001966 SecOffset += EndOffset;
Devang Patel1a0df9a2010-05-10 22:49:55 +00001967 }
Bill Wendling480ff322009-05-20 23:21:38 +00001968}
1969
Eric Christopheracdcbdb2012-11-27 22:43:45 +00001970// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001971void DwarfDebug::emitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001972 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001973
Bill Wendling480ff322009-05-20 23:21:38 +00001974 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001975 DwarfInfoSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001976 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Eric Christopherd8667202013-12-30 17:22:27 +00001977 if (useSplitDwarf())
1978 DwarfInfoDWOSectionSym =
1979 emitSectionSym(Asm, TLOF.getDwarfInfoDWOSection(), "section_info_dwo");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001980 DwarfAbbrevSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001981 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher3c5a1912012-12-19 22:02:53 +00001982 if (useSplitDwarf())
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001983 DwarfAbbrevDWOSectionSym = emitSectionSym(
1984 Asm, TLOF.getDwarfAbbrevDWOSection(), "section_abbrev_dwo");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001985 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001986
Chris Lattner6629ca92010-04-04 22:59:04 +00001987 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001988 emitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00001989
Eric Christopher74804332013-02-07 21:19:50 +00001990 DwarfLineSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00001991 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7b30f2e42012-11-21 00:34:35 +00001992 emitSectionSym(Asm, TLOF.getDwarfLocSection());
Eric Christopher261d2342013-09-23 20:55:35 +00001993 if (GenerateGnuPubSections) {
Eric Christopher39eebfa2013-09-30 23:14:16 +00001994 DwarfGnuPubNamesSectionSym =
1995 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
1996 DwarfGnuPubTypesSectionSym =
1997 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
Eric Christopher261d2342013-09-23 20:55:35 +00001998 } else if (HasDwarfPubSections) {
1999 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2000 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Michael Gottesmanc89466f2013-09-04 04:39:38 +00002001 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002002
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002003 DwarfStrSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002004 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002005 if (useSplitDwarf()) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002006 DwarfStrDWOSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002007 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher55863be2013-04-07 03:43:09 +00002008 DwarfAddrSectionSym =
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002009 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
Eric Christopher55863be2013-04-07 03:43:09 +00002010 }
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002011 DwarfDebugRangeSectionSym =
2012 emitSectionSym(Asm, TLOF.getDwarfRangesSection(), "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00002013
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002014 DwarfDebugLocSectionSym =
2015 emitSectionSym(Asm, TLOF.getDwarfLocSection(), "section_debug_loc");
Bill Wendling480ff322009-05-20 23:21:38 +00002016}
2017
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002018// Recursively emits a debug information entry.
David Blaikieff3ab2c2013-12-05 01:01:41 +00002019void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00002020 // Get the abbreviation for this DIE.
David Blaikieff3ab2c2013-12-05 01:01:41 +00002021 const DIEAbbrev &Abbrev = Die->getAbbrev();
Bill Wendling480ff322009-05-20 23:21:38 +00002022
Bill Wendling480ff322009-05-20 23:21:38 +00002023 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00002024 if (Asm->isVerbose())
David Blaikieff3ab2c2013-12-05 01:01:41 +00002025 Asm->OutStreamer.AddComment("Abbrev [" + Twine(Abbrev.getNumber()) +
2026 "] 0x" + Twine::utohexstr(Die->getOffset()) +
2027 ":0x" + Twine::utohexstr(Die->getSize()) + " " +
2028 dwarf::TagString(Abbrev.getTag()));
2029 Asm->EmitULEB128(Abbrev.getNumber());
Bill Wendling480ff322009-05-20 23:21:38 +00002030
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002031 const SmallVectorImpl<DIEValue *> &Values = Die->getValues();
David Blaikieff3ab2c2013-12-05 01:01:41 +00002032 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
Bill Wendling480ff322009-05-20 23:21:38 +00002033
2034 // Emit the DIE attribute values.
2035 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
David Blaikief2443192013-10-21 17:28:37 +00002036 dwarf::Attribute Attr = AbbrevData[i].getAttribute();
2037 dwarf::Form Form = AbbrevData[i].getForm();
Bill Wendling480ff322009-05-20 23:21:38 +00002038 assert(Form && "Too many attributes for DIE (check abbreviation)");
2039
Chris Lattner7bde8c02010-04-04 18:52:31 +00002040 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00002041 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002042
Bill Wendling480ff322009-05-20 23:21:38 +00002043 switch (Attr) {
Manman Rence20d462013-10-29 22:57:10 +00002044 case dwarf::DW_AT_abstract_origin:
2045 case dwarf::DW_AT_type:
2046 case dwarf::DW_AT_friend:
2047 case dwarf::DW_AT_specification:
2048 case dwarf::DW_AT_import:
2049 case dwarf::DW_AT_containing_type: {
2050 DIEEntry *E = cast<DIEEntry>(Values[i]);
2051 DIE *Origin = E->getEntry();
2052 unsigned Addr = Origin->getOffset();
2053 if (Form == dwarf::DW_FORM_ref_addr) {
2054 assert(!useSplitDwarf() && "TODO: dwo files can't have relocations.");
2055 // For DW_FORM_ref_addr, output the offset from beginning of debug info
2056 // section. Origin->getOffset() returns the offset from start of the
2057 // compile unit.
Eric Christopher4287a492013-12-09 23:57:44 +00002058 DwarfCompileUnit *CU = CUDieMap.lookup(Origin->getUnit());
Manman Rence20d462013-10-29 22:57:10 +00002059 assert(CU && "CUDie should belong to a CU.");
2060 Addr += CU->getDebugInfoOffset();
2061 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
David Blaikie03073f72013-12-06 22:14:48 +00002062 Asm->EmitLabelPlusOffset(CU->getSectionSym(), Addr,
Manman Rence20d462013-10-29 22:57:10 +00002063 DIEEntry::getRefAddrSize(Asm));
2064 else
David Blaikie03073f72013-12-06 22:14:48 +00002065 Asm->EmitLabelOffsetDifference(CU->getSectionSym(), Addr,
2066 CU->getSectionSym(),
Manman Ren251a1bd2013-10-29 23:14:15 +00002067 DIEEntry::getRefAddrSize(Asm));
Manman Rence20d462013-10-29 22:57:10 +00002068 } else {
Manman Ren4dbdc902013-10-31 17:54:35 +00002069 // Make sure Origin belong to the same CU.
David Blaikie409dd9c2013-11-19 23:08:21 +00002070 assert(Die->getUnit() == Origin->getUnit() &&
Manman Ren4dbdc902013-10-31 17:54:35 +00002071 "The referenced DIE should belong to the same CU in ref4");
Manman Rence20d462013-10-29 22:57:10 +00002072 Asm->EmitInt32(Addr);
2073 }
2074 break;
2075 }
Devang Patel9fc11702010-05-25 23:40:22 +00002076 case dwarf::DW_AT_location: {
Nick Lewycky33da3362012-06-22 01:25:12 +00002077 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2078 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopherd0b82ae2013-11-16 00:18:40 +00002079 Asm->EmitSectionOffset(L->getValue(), DwarfDebugLocSectionSym);
Nick Lewycky33da3362012-06-22 01:25:12 +00002080 else
Ulrich Weigand396ba8b2013-07-02 18:46:26 +00002081 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Nick Lewycky33da3362012-06-22 01:25:12 +00002082 } else {
Devang Patel9fc11702010-05-25 23:40:22 +00002083 Values[i]->EmitValue(Asm, Form);
Nick Lewycky33da3362012-06-22 01:25:12 +00002084 }
Devang Patel9fc11702010-05-25 23:40:22 +00002085 break;
2086 }
Devang Patela1bd5a12010-09-29 19:08:08 +00002087 case dwarf::DW_AT_accessibility: {
2088 if (Asm->isVerbose()) {
2089 DIEInteger *V = cast<DIEInteger>(Values[i]);
2090 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2091 }
2092 Values[i]->EmitValue(Asm, Form);
2093 break;
2094 }
Bill Wendling480ff322009-05-20 23:21:38 +00002095 default:
2096 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002097 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00002098 break;
2099 }
Bill Wendling480ff322009-05-20 23:21:38 +00002100 }
2101
2102 // Emit the DIE children if any.
David Blaikieff3ab2c2013-12-05 01:01:41 +00002103 if (Abbrev.getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
Bill Wendling480ff322009-05-20 23:21:38 +00002104 const std::vector<DIE *> &Children = Die->getChildren();
2105
2106 for (unsigned j = 0, M = Children.size(); j < M; ++j)
David Blaikieff3ab2c2013-12-05 01:01:41 +00002107 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00002108
David Blaikie155f8812013-12-04 21:51:05 +00002109 Asm->OutStreamer.AddComment("End Of Children Mark");
Chris Lattner566cae92010-03-09 23:52:58 +00002110 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00002111 }
2112}
2113
Eric Christophera2de8262012-12-15 00:04:07 +00002114// Emit the various dwarf units to the unit section USection with
2115// the abbreviations going into ASection.
David Blaikie03073f72013-12-06 22:14:48 +00002116void DwarfFile::emitUnits(DwarfDebug *DD, const MCSection *ASection,
2117 const MCSymbol *ASectionSym) {
Eric Christophera5a79422013-12-09 23:32:48 +00002118 for (SmallVectorImpl<DwarfUnit *>::iterator I = CUs.begin(), E = CUs.end();
2119 I != E; ++I) {
2120 DwarfUnit *TheU = *I;
David Blaikie2a80e442013-12-02 22:09:48 +00002121 DIE *Die = TheU->getUnitDie();
David Blaikie03073f72013-12-06 22:14:48 +00002122 const MCSection *USection = TheU->getSection();
2123 Asm->OutStreamer.SwitchSection(USection);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002124
Devang Patel1a0df9a2010-05-10 22:49:55 +00002125 // Emit the compile units header.
David Blaikie7d734602013-12-06 22:33:05 +00002126 Asm->OutStreamer.EmitLabel(TheU->getLabelBegin());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002127
Devang Patel1a0df9a2010-05-10 22:49:55 +00002128 // Emit size of content not including length itself
David Blaikie6b288cf2013-10-30 20:42:41 +00002129 Asm->OutStreamer.AddComment("Length of Unit");
David Blaikie2a80e442013-12-02 22:09:48 +00002130 Asm->EmitInt32(TheU->getHeaderSize() + Die->getSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002131
David Blaikie2a80e442013-12-02 22:09:48 +00002132 TheU->emitHeader(ASection, ASectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002133
David Blaikieff3ab2c2013-12-05 01:01:41 +00002134 DD->emitDIE(Die);
David Blaikie7d734602013-12-06 22:33:05 +00002135 Asm->OutStreamer.EmitLabel(TheU->getLabelEnd());
Devang Patel1a0df9a2010-05-10 22:49:55 +00002136 }
Bill Wendling480ff322009-05-20 23:21:38 +00002137}
2138
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002139// Emit the debug info section.
2140void DwarfDebug::emitDebugInfo() {
Eric Christopherf8194852013-12-05 18:06:10 +00002141 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christophera2de8262012-12-15 00:04:07 +00002142
David Blaikie03073f72013-12-06 22:14:48 +00002143 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfAbbrevSection(),
Eric Christophera2de8262012-12-15 00:04:07 +00002144 DwarfAbbrevSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002145}
2146
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002147// Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +00002148void DwarfDebug::emitAbbreviations() {
Eric Christopherf8194852013-12-05 18:06:10 +00002149 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
David Blaikie0504cda2013-12-05 07:43:55 +00002150
2151 Holder.emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
Eric Christopher3c5a1912012-12-19 22:02:53 +00002152}
Bill Wendling480ff322009-05-20 23:21:38 +00002153
Eric Christopherf8194852013-12-05 18:06:10 +00002154void DwarfFile::emitAbbrevs(const MCSection *Section) {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002155 // Check to see if it is worth the effort.
David Blaikie0504cda2013-12-05 07:43:55 +00002156 if (!Abbreviations.empty()) {
Eric Christopher3c5a1912012-12-19 22:02:53 +00002157 // Start the debug abbrev section.
2158 Asm->OutStreamer.SwitchSection(Section);
2159
Bill Wendling480ff322009-05-20 23:21:38 +00002160 // For each abbrevation.
David Blaikie0504cda2013-12-05 07:43:55 +00002161 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
Bill Wendling480ff322009-05-20 23:21:38 +00002162 // Get abbreviation data
David Blaikie0504cda2013-12-05 07:43:55 +00002163 const DIEAbbrev *Abbrev = Abbreviations[i];
Bill Wendling480ff322009-05-20 23:21:38 +00002164
2165 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00002166 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00002167
2168 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002169 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00002170 }
2171
2172 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00002173 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00002174 }
2175}
2176
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002177// Emit the last address of the section and the end of the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +00002178void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00002179 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00002180 Asm->OutStreamer.AddComment("Extended Op");
2181 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002182
Chris Lattner566cae92010-03-09 23:52:58 +00002183 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth5da3f052012-11-01 09:14:31 +00002184 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00002185 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2186 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2187
2188 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002189
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002190 Asm->OutStreamer.EmitSymbolValue(
2191 Asm->GetTempSymbol("section_end", SectionEnd),
2192 Asm->getDataLayout().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002193
2194 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00002195 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2196 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002197 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00002198 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002199}
2200
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002201// Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +00002202void DwarfDebug::emitAccelNames() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002203 DwarfAccelTable AT(
2204 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
Eric Christophera5a79422013-12-09 23:32:48 +00002205 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2206 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002207 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002208 DwarfUnit *TheU = *I;
David Blaikie2a80e442013-12-02 22:09:48 +00002209 const StringMap<std::vector<const DIE *> > &Names = TheU->getAccelNames();
David Blaikie2ea848b2013-11-19 22:51:04 +00002210 for (StringMap<std::vector<const DIE *> >::const_iterator
2211 GI = Names.begin(),
2212 GE = Names.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002213 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002214 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002215 const std::vector<const DIE *> &Entities = GI->second;
2216 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2217 DE = Entities.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002218 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002219 AT.AddName(Name, *DI);
Eric Christopher4996c702011-11-07 09:24:32 +00002220 }
2221 }
2222
2223 AT.FinalizeTable(Asm, "Names");
2224 Asm->OutStreamer.SwitchSection(
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002225 Asm->getObjFileLowering().getDwarfAccelNamesSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002226 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2227 Asm->OutStreamer.EmitLabel(SectionBegin);
2228
2229 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002230 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002231}
2232
Eric Christopher48fef592012-12-20 21:58:40 +00002233// Emit objective C classes and categories into a hashed accelerator table
2234// section.
Eric Christopher4996c702011-11-07 09:24:32 +00002235void DwarfDebug::emitAccelObjC() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002236 DwarfAccelTable AT(
2237 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
Eric Christophera5a79422013-12-09 23:32:48 +00002238 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2239 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002240 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002241 DwarfUnit *TheU = *I;
David Blaikie2a80e442013-12-02 22:09:48 +00002242 const StringMap<std::vector<const DIE *> > &Names = TheU->getAccelObjC();
David Blaikie2ea848b2013-11-19 22:51:04 +00002243 for (StringMap<std::vector<const DIE *> >::const_iterator
2244 GI = Names.begin(),
2245 GE = Names.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002246 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002247 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002248 const std::vector<const DIE *> &Entities = GI->second;
2249 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2250 DE = Entities.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002251 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002252 AT.AddName(Name, *DI);
Eric Christopher4996c702011-11-07 09:24:32 +00002253 }
2254 }
2255
2256 AT.FinalizeTable(Asm, "ObjC");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002257 Asm->OutStreamer.SwitchSection(
2258 Asm->getObjFileLowering().getDwarfAccelObjCSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002259 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2260 Asm->OutStreamer.EmitLabel(SectionBegin);
2261
2262 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002263 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002264}
2265
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002266// Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002267void DwarfDebug::emitAccelNamespaces() {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002268 DwarfAccelTable AT(
2269 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
Eric Christophera5a79422013-12-09 23:32:48 +00002270 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2271 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002272 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002273 DwarfUnit *TheU = *I;
David Blaikie2ea848b2013-11-19 22:51:04 +00002274 const StringMap<std::vector<const DIE *> > &Names =
David Blaikie2a80e442013-12-02 22:09:48 +00002275 TheU->getAccelNamespace();
David Blaikie2ea848b2013-11-19 22:51:04 +00002276 for (StringMap<std::vector<const DIE *> >::const_iterator
2277 GI = Names.begin(),
2278 GE = Names.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002279 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002280 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002281 const std::vector<const DIE *> &Entities = GI->second;
2282 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2283 DE = Entities.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002284 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002285 AT.AddName(Name, *DI);
Eric Christopher4996c702011-11-07 09:24:32 +00002286 }
2287 }
2288
2289 AT.FinalizeTable(Asm, "namespac");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002290 Asm->OutStreamer.SwitchSection(
2291 Asm->getObjFileLowering().getDwarfAccelNamespaceSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002292 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2293 Asm->OutStreamer.EmitLabel(SectionBegin);
2294
2295 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002296 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002297}
2298
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002299// Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +00002300void DwarfDebug::emitAccelTypes() {
Eric Christopher21bde872012-01-06 04:35:23 +00002301 std::vector<DwarfAccelTable::Atom> Atoms;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002302 Atoms.push_back(
2303 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
2304 Atoms.push_back(
2305 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag, dwarf::DW_FORM_data2));
2306 Atoms.push_back(
2307 DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags, dwarf::DW_FORM_data1));
Eric Christopher21bde872012-01-06 04:35:23 +00002308 DwarfAccelTable AT(Atoms);
Eric Christophera5a79422013-12-09 23:32:48 +00002309 for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2310 E = getUnits().end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002311 I != E; ++I) {
Eric Christophera5a79422013-12-09 23:32:48 +00002312 DwarfUnit *TheU = *I;
David Blaikie2ea848b2013-11-19 22:51:04 +00002313 const StringMap<std::vector<std::pair<const DIE *, unsigned> > > &Names =
David Blaikie2a80e442013-12-02 22:09:48 +00002314 TheU->getAccelTypes();
David Blaikie2ea848b2013-11-19 22:51:04 +00002315 for (StringMap<
2316 std::vector<std::pair<const DIE *, unsigned> > >::const_iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002317 GI = Names.begin(),
2318 GE = Names.end();
2319 GI != GE; ++GI) {
Benjamin Kramer63e39eb2013-05-11 18:24:28 +00002320 StringRef Name = GI->getKey();
David Blaikie2ea848b2013-11-19 22:51:04 +00002321 const std::vector<std::pair<const DIE *, unsigned> > &Entities =
2322 GI->second;
2323 for (std::vector<std::pair<const DIE *, unsigned> >::const_iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002324 DI = Entities.begin(),
2325 DE = Entities.end();
2326 DI != DE; ++DI)
David Blaikie2ea848b2013-11-19 22:51:04 +00002327 AT.AddName(Name, DI->first, DI->second);
Eric Christopher4996c702011-11-07 09:24:32 +00002328 }
2329 }
2330
2331 AT.FinalizeTable(Asm, "types");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002332 Asm->OutStreamer.SwitchSection(
2333 Asm->getObjFileLowering().getDwarfAccelTypesSection());
Eric Christopher4996c702011-11-07 09:24:32 +00002334 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2335 Asm->OutStreamer.EmitLabel(SectionBegin);
2336
2337 // Emit the full data.
Eric Christophere698f532012-12-20 21:58:36 +00002338 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher4996c702011-11-07 09:24:32 +00002339}
2340
Eric Christopherdd1a0122013-09-13 00:35:05 +00002341// Public name handling.
2342// The format for the various pubnames:
2343//
2344// dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2345// for the DIE that is named.
2346//
2347// gnu pubnames - offset/index value/name tuples where the offset is the offset
2348// into the CU and the index value is computed according to the type of value
2349// for the DIE that is named.
2350//
2351// For type units the offset is the offset of the skeleton DIE. For split dwarf
2352// it's the offset within the debug_info/debug_types dwo section, however, the
2353// reference in the pubname header doesn't change.
2354
2355/// computeIndexValue - Compute the gdb index value for the DIE and CU.
Eric Christophera5a79422013-12-09 23:32:48 +00002356static dwarf::PubIndexEntryDescriptor computeIndexValue(DwarfUnit *CU,
Eric Christopher0fe676a2013-11-21 00:48:22 +00002357 const DIE *Die) {
Eric Christopherd2b497b2013-10-16 01:37:49 +00002358 dwarf::GDBIndexEntryLinkage Linkage = dwarf::GIEL_STATIC;
2359
2360 // We could have a specification DIE that has our most of our knowledge,
2361 // look for that now.
2362 DIEValue *SpecVal = Die->findAttribute(dwarf::DW_AT_specification);
2363 if (SpecVal) {
2364 DIE *SpecDIE = cast<DIEEntry>(SpecVal)->getEntry();
2365 if (SpecDIE->findAttribute(dwarf::DW_AT_external))
2366 Linkage = dwarf::GIEL_EXTERNAL;
2367 } else if (Die->findAttribute(dwarf::DW_AT_external))
2368 Linkage = dwarf::GIEL_EXTERNAL;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002369
2370 switch (Die->getTag()) {
2371 case dwarf::DW_TAG_class_type:
2372 case dwarf::DW_TAG_structure_type:
2373 case dwarf::DW_TAG_union_type:
2374 case dwarf::DW_TAG_enumeration_type:
Eric Christopher261d2342013-09-23 20:55:35 +00002375 return dwarf::PubIndexEntryDescriptor(
2376 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2377 ? dwarf::GIEL_STATIC
2378 : dwarf::GIEL_EXTERNAL);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002379 case dwarf::DW_TAG_typedef:
2380 case dwarf::DW_TAG_base_type:
2381 case dwarf::DW_TAG_subrange_type:
David Blaikie8dec4072013-09-19 20:40:26 +00002382 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002383 case dwarf::DW_TAG_namespace:
David Blaikie8dec4072013-09-19 20:40:26 +00002384 return dwarf::GIEK_TYPE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002385 case dwarf::DW_TAG_subprogram:
Eric Christopherccac5c42013-09-23 22:59:14 +00002386 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002387 case dwarf::DW_TAG_constant:
2388 case dwarf::DW_TAG_variable:
Eric Christopherccac5c42013-09-23 22:59:14 +00002389 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002390 case dwarf::DW_TAG_enumerator:
David Blaikie8dec4072013-09-19 20:40:26 +00002391 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2392 dwarf::GIEL_STATIC);
Eric Christopherdd1a0122013-09-13 00:35:05 +00002393 default:
David Blaikie8dec4072013-09-19 20:40:26 +00002394 return dwarf::GIEK_NONE;
Eric Christopherdd1a0122013-09-13 00:35:05 +00002395 }
Eric Christopherdd1a0122013-09-13 00:35:05 +00002396}
2397
Eric Christopher5f93bb92013-09-09 20:03:17 +00002398/// emitDebugPubNames - Emit visible names into a debug pubnames section.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002399///
Eric Christopherdd1a0122013-09-13 00:35:05 +00002400void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
Eric Christopherdd1a0122013-09-13 00:35:05 +00002401 const MCSection *PSec =
2402 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2403 : Asm->getObjFileLowering().getDwarfPubNamesSection();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002404
David Blaikie4f623202013-12-06 19:38:49 +00002405 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christophera5a79422013-12-09 23:32:48 +00002406 const SmallVectorImpl<DwarfUnit *> &Units = Holder.getUnits();
David Blaikie4f623202013-12-06 19:38:49 +00002407 for (unsigned i = 0; i != Units.size(); ++i) {
Eric Christophera5a79422013-12-09 23:32:48 +00002408 DwarfUnit *TheU = Units[i];
David Blaikie2a80e442013-12-02 22:09:48 +00002409 unsigned ID = TheU->getUniqueID();
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002410
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002411 // Start the dwarf pubnames section.
Eric Christopher13b99d22013-09-10 21:49:37 +00002412 Asm->OutStreamer.SwitchSection(PSec);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002413
Eric Christopher39eebfa2013-09-30 23:14:16 +00002414 // Emit a label so we can reference the beginning of this pubname section.
2415 if (GnuStyle)
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002416 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames", ID));
Eric Christopher39eebfa2013-09-30 23:14:16 +00002417
Eric Christopherdd1a0122013-09-13 00:35:05 +00002418 // Emit the header.
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002419 Asm->OutStreamer.AddComment("Length of Public Names Info");
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002420 MCSymbol *BeginLabel = Asm->GetTempSymbol("pubnames_begin", ID);
2421 MCSymbol *EndLabel = Asm->GetTempSymbol("pubnames_end", ID);
2422 Asm->EmitLabelDifference(EndLabel, BeginLabel, 4);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002423
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002424 Asm->OutStreamer.EmitLabel(BeginLabel);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002425
2426 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002427 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002428
2429 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
David Blaikie7d734602013-12-06 22:33:05 +00002430 Asm->EmitSectionOffset(TheU->getLabelBegin(), TheU->getSectionSym());
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002431
2432 Asm->OutStreamer.AddComment("Compilation Unit Length");
David Blaikie7d734602013-12-06 22:33:05 +00002433 Asm->EmitLabelDifference(TheU->getLabelEnd(), TheU->getLabelBegin(), 4);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002434
Eric Christopherdd1a0122013-09-13 00:35:05 +00002435 // Emit the pubnames for this compilation unit.
David Blaikie4f623202013-12-06 19:38:49 +00002436 const StringMap<const DIE *> &Globals = getUnits()[ID]->getGlobalNames();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002437 for (StringMap<const DIE *>::const_iterator GI = Globals.begin(),
2438 GE = Globals.end();
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002439 GI != GE; ++GI) {
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002440 const char *Name = GI->getKeyData();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002441 const DIE *Entity = GI->second;
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002442
2443 Asm->OutStreamer.AddComment("DIE offset");
2444 Asm->EmitInt32(Entity->getOffset());
2445
Eric Christopherdd1a0122013-09-13 00:35:05 +00002446 if (GnuStyle) {
David Blaikie2a80e442013-12-02 22:09:48 +00002447 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheU, Entity);
David Blaikied0a869d2013-09-19 22:19:37 +00002448 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002449 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002450 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002451 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002452 }
2453
David Blaikie155f8812013-12-04 21:51:05 +00002454 Asm->OutStreamer.AddComment("External Name");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002455 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002456 }
2457
2458 Asm->OutStreamer.AddComment("End Mark");
2459 Asm->EmitInt32(0);
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002460 Asm->OutStreamer.EmitLabel(EndLabel);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +00002461 }
2462}
2463
Eric Christopherdd1a0122013-09-13 00:35:05 +00002464void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
Eric Christopher261d2342013-09-23 20:55:35 +00002465 const MCSection *PSec =
2466 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2467 : Asm->getObjFileLowering().getDwarfPubTypesSection();
Eric Christopher8b3737f2013-09-13 00:34:58 +00002468
David Blaikie4f623202013-12-06 19:38:49 +00002469 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christophera5a79422013-12-09 23:32:48 +00002470 const SmallVectorImpl<DwarfUnit *> &Units = Holder.getUnits();
David Blaikie4f623202013-12-06 19:38:49 +00002471 for (unsigned i = 0; i != Units.size(); ++i) {
Eric Christophera5a79422013-12-09 23:32:48 +00002472 DwarfUnit *TheU = Units[i];
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002473 unsigned ID = TheU->getUniqueID();
2474
Eric Christopher6abc9c52011-11-07 09:18:35 +00002475 // Start the dwarf pubtypes section.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002476 Asm->OutStreamer.SwitchSection(PSec);
Eric Christopher39eebfa2013-09-30 23:14:16 +00002477
2478 // Emit a label so we can reference the beginning of this pubtype section.
2479 if (GnuStyle)
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002480 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes", ID));
Eric Christopher39eebfa2013-09-30 23:14:16 +00002481
2482 // Emit the header.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002483 Asm->OutStreamer.AddComment("Length of Public Types Info");
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002484 MCSymbol *BeginLabel = Asm->GetTempSymbol("pubtypes_begin", ID);
2485 MCSymbol *EndLabel = Asm->GetTempSymbol("pubtypes_end", ID);
2486 Asm->EmitLabelDifference(EndLabel, BeginLabel, 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002487
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002488 Asm->OutStreamer.EmitLabel(BeginLabel);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002489
David Blaikie155f8812013-12-04 21:51:05 +00002490 Asm->OutStreamer.AddComment("DWARF Version");
David Majnemered89b5c2013-08-21 06:13:34 +00002491 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002492
Devang Patel1a0df9a2010-05-10 22:49:55 +00002493 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
David Blaikie7d734602013-12-06 22:33:05 +00002494 Asm->EmitSectionOffset(TheU->getLabelBegin(), TheU->getSectionSym());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002495
Devang Patel1a0df9a2010-05-10 22:49:55 +00002496 Asm->OutStreamer.AddComment("Compilation Unit Length");
David Blaikie7d734602013-12-06 22:33:05 +00002497 Asm->EmitLabelDifference(TheU->getLabelEnd(), TheU->getLabelBegin(), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002498
Eric Christopher39eebfa2013-09-30 23:14:16 +00002499 // Emit the pubtypes.
David Blaikie4f623202013-12-06 19:38:49 +00002500 const StringMap<const DIE *> &Globals = getUnits()[ID]->getGlobalTypes();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002501 for (StringMap<const DIE *>::const_iterator GI = Globals.begin(),
2502 GE = Globals.end();
Eric Christopher8b3737f2013-09-13 00:34:58 +00002503 GI != GE; ++GI) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002504 const char *Name = GI->getKeyData();
Eric Christopher0fe676a2013-11-21 00:48:22 +00002505 const DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002506
David Blaikie155f8812013-12-04 21:51:05 +00002507 Asm->OutStreamer.AddComment("DIE offset");
Devang Patel1a0df9a2010-05-10 22:49:55 +00002508 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002509
Eric Christopherdd1a0122013-09-13 00:35:05 +00002510 if (GnuStyle) {
David Blaikie2a80e442013-12-02 22:09:48 +00002511 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheU, Entity);
David Blaikied0a869d2013-09-19 22:19:37 +00002512 Asm->OutStreamer.AddComment(
David Blaikieefd0bcb2013-09-20 00:33:15 +00002513 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
David Blaikie404d3042013-09-19 23:01:29 +00002514 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
David Blaikied0a869d2013-09-19 22:19:37 +00002515 Asm->EmitInt8(Desc.toBits());
Eric Christopherdd1a0122013-09-13 00:35:05 +00002516 }
2517
David Blaikie155f8812013-12-04 21:51:05 +00002518 Asm->OutStreamer.AddComment("External Name");
Eric Christopher8b3737f2013-09-13 00:34:58 +00002519
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002520 // Emit the name with a terminating null byte.
Eric Christopher8b3737f2013-09-13 00:34:58 +00002521 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
Devang Patel1a0df9a2010-05-10 22:49:55 +00002522 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002523
Devang Patel1a0df9a2010-05-10 22:49:55 +00002524 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002525 Asm->EmitInt32(0);
David Blaikieb7a1c4d2013-12-04 17:55:41 +00002526 Asm->OutStreamer.EmitLabel(EndLabel);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002527 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002528}
2529
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002530// Emit strings into a string section.
Eric Christopherf8194852013-12-05 18:06:10 +00002531void DwarfFile::emitStrings(const MCSection *StrSection,
Eric Christophera5a79422013-12-09 23:32:48 +00002532 const MCSection *OffsetSection = NULL,
2533 const MCSymbol *StrSecSym = NULL) {
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002534
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002535 if (StringPool.empty())
2536 return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002537
Chris Lattner3d72a672010-03-09 23:38:23 +00002538 // Start the dwarf str section.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002539 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling480ff322009-05-20 23:21:38 +00002540
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002541 // Get all of the string pool entries and put them in an array by their ID so
2542 // we can sort them.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002543 SmallVector<
2544 std::pair<unsigned, StringMapEntry<std::pair<MCSymbol *, unsigned> > *>,
2545 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002546
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002547 for (StringMap<std::pair<MCSymbol *, unsigned> >::iterator
2548 I = StringPool.begin(),
2549 E = StringPool.end();
Eric Christopher48fef592012-12-20 21:58:40 +00002550 I != E; ++I)
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002551 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002552
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002553 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002554
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002555 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002556 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002557 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002558
Benjamin Kramer966ed1b2011-11-09 18:16:11 +00002559 // Emit the string itself with a terminating null byte.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002560 Asm->OutStreamer.EmitBytes(
2561 StringRef(Entries[i].second->getKeyData(),
2562 Entries[i].second->getKeyLength() + 1));
Bill Wendling480ff322009-05-20 23:21:38 +00002563 }
Eric Christopher2cbd5762013-01-07 19:32:41 +00002564
2565 // If we've got an offset section go ahead and emit that now as well.
2566 if (OffsetSection) {
2567 Asm->OutStreamer.SwitchSection(OffsetSection);
2568 unsigned offset = 0;
Eric Christopher962c9082013-01-15 23:56:56 +00002569 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopher2cbd5762013-01-07 19:32:41 +00002570 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopherbf7bc492013-01-09 03:52:05 +00002571 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopher2cbd5762013-01-07 19:32:41 +00002572 offset += Entries[i].second->getKeyLength() + 1;
2573 }
2574 }
Bill Wendling480ff322009-05-20 23:21:38 +00002575}
2576
Eric Christopher65132a82013-11-19 09:11:26 +00002577// Emit addresses into the section given.
Eric Christopherf8194852013-12-05 18:06:10 +00002578void DwarfFile::emitAddresses(const MCSection *AddrSection) {
Eric Christopher962c9082013-01-15 23:56:56 +00002579
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002580 if (AddressPool.empty())
2581 return;
Eric Christopher962c9082013-01-15 23:56:56 +00002582
2583 // Start the dwarf addr section.
2584 Asm->OutStreamer.SwitchSection(AddrSection);
2585
David Blaikiece1960f2013-07-08 17:51:28 +00002586 // Order the address pool entries by ID
David Blaikieac569a62013-07-08 17:33:10 +00002587 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
Eric Christopher962c9082013-01-15 23:56:56 +00002588
David Blaikiece1960f2013-07-08 17:51:28 +00002589 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2590 E = AddressPool.end();
Eric Christopher962c9082013-01-15 23:56:56 +00002591 I != E; ++I)
David Blaikieac569a62013-07-08 17:33:10 +00002592 Entries[I->second] = I->first;
Eric Christopher962c9082013-01-15 23:56:56 +00002593
2594 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002595 // Emit an expression for reference from debug information entries.
David Blaikieac569a62013-07-08 17:33:10 +00002596 if (const MCExpr *Expr = Entries[i])
Ulrich Weigand8b3d2262013-07-02 18:46:46 +00002597 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
Eric Christopher962c9082013-01-15 23:56:56 +00002598 else
2599 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2600 }
Eric Christopher962c9082013-01-15 23:56:56 +00002601}
2602
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002603// Emit visible names into a debug str section.
2604void DwarfDebug::emitDebugStr() {
Eric Christopherf8194852013-12-05 18:06:10 +00002605 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
Eric Christopher3bf29fd2012-12-27 02:14:01 +00002606 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2607}
2608
Eric Christopher9046f942013-07-02 21:36:07 +00002609// Emit locations into the debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002610void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002611 if (DotDebugLocEntries.empty())
2612 return;
2613
Eric Christopher4887c8f2013-03-29 23:34:06 +00002614 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002615 I = DotDebugLocEntries.begin(),
2616 E = DotDebugLocEntries.end();
Devang Patel116a9d72011-02-04 22:57:18 +00002617 I != E; ++I) {
2618 DotDebugLocEntry &Entry = *I;
2619 if (I + 1 != DotDebugLocEntries.end())
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002620 Entry.Merge(I + 1);
Devang Patel116a9d72011-02-04 22:57:18 +00002621 }
2622
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002623 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002624 Asm->OutStreamer.SwitchSection(
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002625 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth5da3f052012-11-01 09:14:31 +00002626 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002627 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2628 unsigned index = 1;
Eric Christopher4887c8f2013-03-29 23:34:06 +00002629 for (SmallVectorImpl<DotDebugLocEntry>::iterator
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002630 I = DotDebugLocEntries.begin(),
2631 E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002632 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002633 DotDebugLocEntry &Entry = *I;
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002634 if (Entry.isMerged())
2635 continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002636 if (Entry.isEmpty()) {
Eric Christopherce0cfce2013-01-09 01:35:34 +00002637 Asm->OutStreamer.EmitIntValue(0, Size);
2638 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002639 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002640 } else {
Eric Christopher25f06422013-07-03 22:40:18 +00002641 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2642 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2643 DIVariable DV(Entry.getVariable());
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002644 Asm->OutStreamer.AddComment("Loc expr size");
2645 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2646 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2647 Asm->EmitLabelDifference(end, begin, 2);
2648 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002649 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002650 DIBasicType BTy(DV.getType());
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002651 if (BTy.Verify() && (BTy.getEncoding() == dwarf::DW_ATE_signed ||
2652 BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
Devang Patel324f8432011-06-01 22:03:25 +00002653 Asm->OutStreamer.AddComment("DW_OP_consts");
2654 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002655 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002656 } else {
2657 Asm->OutStreamer.AddComment("DW_OP_constu");
2658 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002659 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002660 }
Devang Pateled9fd452011-07-08 16:49:43 +00002661 } else if (Entry.isLocation()) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002662 MachineLocation Loc = Entry.getLoc();
Eric Christopher6a841382012-11-19 22:42:10 +00002663 if (!DV.hasComplexAddress())
Devang Pateled9fd452011-07-08 16:49:43 +00002664 // Regular entry.
Eric Christopher614a89f2013-07-03 22:40:21 +00002665 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002666 else {
2667 // Complex address entry.
2668 unsigned N = DV.getNumAddrElements();
2669 unsigned i = 0;
2670 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002671 if (Loc.getOffset()) {
Devang Pateled9fd452011-07-08 16:49:43 +00002672 i = 2;
Eric Christopher614a89f2013-07-03 22:40:21 +00002673 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002674 Asm->OutStreamer.AddComment("DW_OP_deref");
2675 Asm->EmitInt8(dwarf::DW_OP_deref);
2676 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2677 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2678 Asm->EmitSLEB128(DV.getAddrElement(1));
2679 } else {
2680 // If first address element is OpPlus then emit
2681 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
Eric Christopher614a89f2013-07-03 22:40:21 +00002682 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2683 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002684 i = 2;
2685 }
2686 } else {
Eric Christopher614a89f2013-07-03 22:40:21 +00002687 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
Devang Pateled9fd452011-07-08 16:49:43 +00002688 }
Eric Christopher6a841382012-11-19 22:42:10 +00002689
Devang Pateled9fd452011-07-08 16:49:43 +00002690 // Emit remaining complex address elements.
2691 for (; i < N; ++i) {
2692 uint64_t Element = DV.getAddrElement(i);
2693 if (Element == DIBuilder::OpPlus) {
2694 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2695 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher4d250522012-05-08 18:56:00 +00002696 } else if (Element == DIBuilder::OpDeref) {
Eric Christopher614a89f2013-07-03 22:40:21 +00002697 if (!Loc.isReg())
Eric Christopher4d250522012-05-08 18:56:00 +00002698 Asm->EmitInt8(dwarf::DW_OP_deref);
2699 } else
2700 llvm_unreachable("unknown Opcode found in complex address");
Devang Pateled9fd452011-07-08 16:49:43 +00002701 }
Devang Patel3e021532011-04-28 02:22:40 +00002702 }
Devang Patel3e021532011-04-28 02:22:40 +00002703 }
Devang Pateled9fd452011-07-08 16:49:43 +00002704 // else ... ignore constant fp. There is not any good way to
2705 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002706 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002707 }
2708 }
Bill Wendling480ff322009-05-20 23:21:38 +00002709}
2710
Richard Mitton21101b32013-09-19 23:21:01 +00002711struct SymbolCUSorter {
2712 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2713 const MCStreamer &Streamer;
2714
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002715 bool operator()(const SymbolCU &A, const SymbolCU &B) {
Richard Mitton21101b32013-09-19 23:21:01 +00002716 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2717 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2718
2719 // Symbols with no order assigned should be placed at the end.
2720 // (e.g. section end labels)
2721 if (IA == 0)
2722 IA = (unsigned)(-1);
2723 if (IB == 0)
2724 IB = (unsigned)(-1);
2725 return IA < IB;
2726 }
2727};
2728
Eric Christophera5a79422013-12-09 23:32:48 +00002729static bool CUSort(const DwarfUnit *A, const DwarfUnit *B) {
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002730 return (A->getUniqueID() < B->getUniqueID());
Richard Mitton21101b32013-09-19 23:21:01 +00002731}
2732
2733struct ArangeSpan {
2734 const MCSymbol *Start, *End;
2735};
2736
2737// Emit a debug aranges section, containing a CU lookup for any
2738// address we can tie back to a CU.
Eric Christopher7b30f2e42012-11-21 00:34:35 +00002739void DwarfDebug::emitDebugARanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002740 // Start the dwarf aranges section.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002741 Asm->OutStreamer.SwitchSection(
2742 Asm->getObjFileLowering().getDwarfARangesSection());
Richard Mitton21101b32013-09-19 23:21:01 +00002743
Eric Christopher4287a492013-12-09 23:57:44 +00002744 typedef DenseMap<DwarfCompileUnit *, std::vector<ArangeSpan> > SpansType;
Richard Mitton21101b32013-09-19 23:21:01 +00002745
2746 SpansType Spans;
2747
2748 // Build a list of sections used.
2749 std::vector<const MCSection *> Sections;
2750 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2751 it++) {
2752 const MCSection *Section = it->first;
2753 Sections.push_back(Section);
2754 }
2755
2756 // Sort the sections into order.
2757 // This is only done to ensure consistent output order across different runs.
2758 std::sort(Sections.begin(), Sections.end(), SectionSort);
2759
2760 // Build a set of address spans, sorted by CU.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002761 for (size_t SecIdx = 0; SecIdx < Sections.size(); SecIdx++) {
Richard Mitton21101b32013-09-19 23:21:01 +00002762 const MCSection *Section = Sections[SecIdx];
2763 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2764 if (List.size() < 2)
2765 continue;
2766
2767 // Sort the symbols by offset within the section.
2768 SymbolCUSorter sorter(Asm->OutStreamer);
2769 std::sort(List.begin(), List.end(), sorter);
2770
2771 // If we have no section (e.g. common), just write out
2772 // individual spans for each symbol.
2773 if (Section == NULL) {
2774 for (size_t n = 0; n < List.size(); n++) {
2775 const SymbolCU &Cur = List[n];
2776
2777 ArangeSpan Span;
2778 Span.Start = Cur.Sym;
2779 Span.End = NULL;
2780 if (Cur.CU)
2781 Spans[Cur.CU].push_back(Span);
2782 }
2783 } else {
2784 // Build spans between each label.
2785 const MCSymbol *StartSym = List[0].Sym;
2786 for (size_t n = 1; n < List.size(); n++) {
2787 const SymbolCU &Prev = List[n - 1];
2788 const SymbolCU &Cur = List[n];
2789
2790 // Try and build the longest span we can within the same CU.
2791 if (Cur.CU != Prev.CU) {
2792 ArangeSpan Span;
2793 Span.Start = StartSym;
2794 Span.End = Cur.Sym;
2795 Spans[Prev.CU].push_back(Span);
2796 StartSym = Cur.Sym;
2797 }
2798 }
2799 }
2800 }
2801
Richard Mitton21101b32013-09-19 23:21:01 +00002802 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2803
2804 // Build a list of CUs used.
Eric Christopher4287a492013-12-09 23:57:44 +00002805 std::vector<DwarfCompileUnit *> CUs;
Richard Mitton21101b32013-09-19 23:21:01 +00002806 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
Eric Christopher4287a492013-12-09 23:57:44 +00002807 DwarfCompileUnit *CU = it->first;
Richard Mitton21101b32013-09-19 23:21:01 +00002808 CUs.push_back(CU);
2809 }
2810
2811 // Sort the CU list (again, to ensure consistent output order).
2812 std::sort(CUs.begin(), CUs.end(), CUSort);
2813
2814 // Emit an arange table for each CU we used.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002815 for (size_t CUIdx = 0; CUIdx < CUs.size(); CUIdx++) {
Eric Christopher4287a492013-12-09 23:57:44 +00002816 DwarfCompileUnit *CU = CUs[CUIdx];
Richard Mitton21101b32013-09-19 23:21:01 +00002817 std::vector<ArangeSpan> &List = Spans[CU];
2818
2819 // Emit size of content not including length itself.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002820 unsigned ContentSize =
2821 sizeof(int16_t) + // DWARF ARange version number
2822 sizeof(int32_t) + // Offset of CU in the .debug_info section
2823 sizeof(int8_t) + // Pointer Size (in bytes)
2824 sizeof(int8_t); // Segment Size (in bytes)
Richard Mitton21101b32013-09-19 23:21:01 +00002825
2826 unsigned TupleSize = PtrSize * 2;
2827
2828 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
Benjamin Kramer8a68ab32014-01-07 19:28:14 +00002829 unsigned Padding =
2830 OffsetToAlignment(sizeof(int32_t) + ContentSize, TupleSize);
Richard Mitton21101b32013-09-19 23:21:01 +00002831
2832 ContentSize += Padding;
2833 ContentSize += (List.size() + 1) * TupleSize;
2834
2835 // For each compile unit, write the list of spans it covers.
2836 Asm->OutStreamer.AddComment("Length of ARange Set");
2837 Asm->EmitInt32(ContentSize);
2838 Asm->OutStreamer.AddComment("DWARF Arange version number");
2839 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2840 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
Eric Christopherd8667202013-12-30 17:22:27 +00002841 Asm->EmitSectionOffset(CU->getLocalLabelBegin(), CU->getLocalSectionSym());
Richard Mitton21101b32013-09-19 23:21:01 +00002842 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2843 Asm->EmitInt8(PtrSize);
2844 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2845 Asm->EmitInt8(0);
2846
Benjamin Kramer8a68ab32014-01-07 19:28:14 +00002847 Asm->OutStreamer.EmitFill(Padding, 0xff);
Richard Mitton21101b32013-09-19 23:21:01 +00002848
2849 for (unsigned n = 0; n < List.size(); n++) {
2850 const ArangeSpan &Span = List[n];
2851 Asm->EmitLabelReference(Span.Start, PtrSize);
2852
2853 // Calculate the size as being from the span start to it's end.
Richard Mitton089ed892013-09-23 17:56:20 +00002854 if (Span.End) {
Richard Mitton21101b32013-09-19 23:21:01 +00002855 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
Richard Mitton089ed892013-09-23 17:56:20 +00002856 } else {
2857 // For symbols without an end marker (e.g. common), we
2858 // write a single arange entry containing just that one symbol.
2859 uint64_t Size = SymSize[Span.Start];
2860 if (Size == 0)
2861 Size = 1;
2862
2863 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2864 }
Richard Mitton21101b32013-09-19 23:21:01 +00002865 }
2866
2867 Asm->OutStreamer.AddComment("ARange terminator");
2868 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2869 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2870 }
Bill Wendling480ff322009-05-20 23:21:38 +00002871}
2872
Eric Christopheracdcbdb2012-11-27 22:43:45 +00002873// Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002874void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002875 // Start the dwarf ranges section.
Eric Christopherb4bef6d2013-11-19 09:04:36 +00002876 Asm->OutStreamer.SwitchSection(
2877 Asm->getObjFileLowering().getDwarfRangesSection());
Eric Christopher4751d702013-11-23 00:05:29 +00002878
Eric Christopher0f63d062013-12-03 00:45:45 +00002879 // Size for our labels.
2880 unsigned char Size = Asm->getDataLayout().getPointerSize();
2881
2882 // Grab the specific ranges for the compile units in the module.
Eric Christopher4287a492013-12-09 23:57:44 +00002883 for (DenseMap<const MDNode *, DwarfCompileUnit *>::iterator I = CUMap.begin(),
2884 E = CUMap.end();
Eric Christopher0f63d062013-12-03 00:45:45 +00002885 I != E; ++I) {
Eric Christopher4287a492013-12-09 23:57:44 +00002886 DwarfCompileUnit *TheCU = I->second;
Eric Christopher0f63d062013-12-03 00:45:45 +00002887
2888 // Emit a symbol so we can find the beginning of our ranges.
David Blaikie1ab7c2d2013-12-09 17:51:30 +00002889 Asm->OutStreamer.EmitLabel(TheCU->getLabelRange());
Eric Christopher0f63d062013-12-03 00:45:45 +00002890
2891 // Iterate over the misc ranges for the compile units in the module.
Eric Christopher270ba4a2013-12-04 19:06:58 +00002892 const SmallVectorImpl<RangeSpanList> &RangeLists = TheCU->getRangeLists();
Eric Christophera5a79422013-12-09 23:32:48 +00002893 for (SmallVectorImpl<RangeSpanList>::const_iterator I = RangeLists.begin(),
2894 E = RangeLists.end();
Eric Christopher0f63d062013-12-03 00:45:45 +00002895 I != E; ++I) {
Eric Christopher270ba4a2013-12-04 19:06:58 +00002896 const RangeSpanList &List = *I;
Eric Christopher0f63d062013-12-03 00:45:45 +00002897
Eric Christopherf8790642013-12-04 22:04:50 +00002898 // Emit our symbol so we can find the beginning of the range.
2899 Asm->OutStreamer.EmitLabel(List.getSym());
Eric Christopher0f63d062013-12-03 00:45:45 +00002900
2901 for (SmallVectorImpl<RangeSpan>::const_iterator
Eric Christopher270ba4a2013-12-04 19:06:58 +00002902 RI = List.getRanges().begin(),
2903 RE = List.getRanges().end();
2904 RI != RE; ++RI) {
2905 const RangeSpan &Range = *RI;
Eric Christopher0f63d062013-12-03 00:45:45 +00002906 const MCSymbol *Begin = Range.getStart();
2907 const MCSymbol *End = Range.getEnd();
Eric Christopher565ab112013-12-20 04:34:22 +00002908 assert(Begin && "Range without a begin symbol?");
2909 assert(End && "Range without an end symbol?");
2910 Asm->OutStreamer.EmitSymbolValue(Begin, Size);
2911 Asm->OutStreamer.EmitSymbolValue(End, Size);
Eric Christopher0f63d062013-12-03 00:45:45 +00002912 }
2913
2914 // And terminate the list with two 0 values.
Eric Christopherce0cfce2013-01-09 01:35:34 +00002915 Asm->OutStreamer.EmitIntValue(0, Size);
Eric Christopher0f63d062013-12-03 00:45:45 +00002916 Asm->OutStreamer.EmitIntValue(0, Size);
2917 }
Eric Christopher46e23432013-12-20 04:16:18 +00002918
2919 // Now emit a range for the CU itself.
Eric Christopher1ad84572014-01-15 00:04:29 +00002920 if (useCURanges()) {
Eric Christopher46e23432013-12-20 04:16:18 +00002921 Asm->OutStreamer.EmitLabel(
2922 Asm->GetTempSymbol("cu_ranges", TheCU->getUniqueID()));
2923 const SmallVectorImpl<RangeSpan> &Ranges = TheCU->getRanges();
2924 for (uint32_t i = 0, e = Ranges.size(); i != e; ++i) {
2925 RangeSpan Range = Ranges[i];
Eric Christopher46e23432013-12-20 04:16:18 +00002926 const MCSymbol *Begin = Range.getStart();
2927 const MCSymbol *End = Range.getEnd();
Eric Christopher565ab112013-12-20 04:34:22 +00002928 assert(Begin && "Range without a begin symbol?");
2929 assert(End && "Range without an end symbol?");
2930 Asm->OutStreamer.EmitSymbolValue(Begin, Size);
2931 Asm->OutStreamer.EmitSymbolValue(End, Size);
Eric Christopher46e23432013-12-20 04:16:18 +00002932 }
2933 // And terminate the list with two 0 values.
2934 Asm->OutStreamer.EmitIntValue(0, Size);
2935 Asm->OutStreamer.EmitIntValue(0, Size);
2936 }
Devang Patel12563b32010-04-16 23:33:45 +00002937 }
Bill Wendling480ff322009-05-20 23:21:38 +00002938}
2939
Eric Christopherd692c1d2012-12-11 19:42:09 +00002940// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002941
David Blaikie38fe6342014-01-09 04:28:46 +00002942void DwarfDebug::initSkeletonUnit(const DwarfUnit *U, DIE *Die,
2943 DwarfUnit *NewU) {
2944 NewU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
2945 U->getCUNode().getSplitDebugFilename());
2946
2947 // Relocate to the beginning of the addr_base section, else 0 for the
2948 // beginning of the one for this compile unit.
2949 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopherceec7b02014-01-11 00:23:18 +00002950 NewU->addSectionLabel(Die, dwarf::DW_AT_GNU_addr_base, DwarfAddrSectionSym);
David Blaikie38fe6342014-01-09 04:28:46 +00002951 else
2952 NewU->addSectionOffset(Die, dwarf::DW_AT_GNU_addr_base, 0);
2953
2954 if (!CompilationDir.empty())
2955 NewU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
2956
2957 addGnuPubAttributes(NewU, Die);
2958
2959 SkeletonHolder.addUnit(NewU);
2960}
2961
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002962// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2963// 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 +00002964// DW_AT_ranges_base, DW_AT_addr_base.
Eric Christopher5090d572013-12-10 00:40:03 +00002965// TODO: Implement DW_AT_ranges_base.
Eric Christopher4287a492013-12-09 23:57:44 +00002966DwarfCompileUnit *DwarfDebug::constructSkeletonCU(const DwarfCompileUnit *CU) {
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002967
2968 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eric Christopher4287a492013-12-09 23:57:44 +00002969 DwarfCompileUnit *NewCU = new DwarfCompileUnit(
David Blaikief645f962014-01-09 03:23:41 +00002970 CU->getUniqueID(), Die, CU->getCUNode(), Asm, this, &SkeletonHolder);
David Blaikie1ab7c2d2013-12-09 17:51:30 +00002971 NewCU->initSection(Asm->getObjFileLowering().getDwarfInfoSection(),
2972 DwarfInfoSectionSym);
Eric Christopher4c7765f2013-01-17 03:00:04 +00002973
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002974 // DW_AT_stmt_list is a offset of line number information for this
2975 // compile unit in debug_line section.
Eric Christopher55863be2013-04-07 03:43:09 +00002976 // FIXME: Should handle multiple compile units.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002977 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christophera5a79422013-12-09 23:32:48 +00002978 NewCU->addSectionLabel(Die, dwarf::DW_AT_stmt_list, DwarfLineSectionSym);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002979 else
Eric Christopher33ff6972013-11-21 23:46:41 +00002980 NewCU->addSectionOffset(Die, dwarf::DW_AT_stmt_list, 0);
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002981
David Blaikie38fe6342014-01-09 04:28:46 +00002982 initSkeletonUnit(CU, Die, NewCU);
Eric Christopherc8a310e2012-12-10 23:34:43 +00002983
Eric Christopher9c2ecd92012-11-30 23:59:06 +00002984 return NewCU;
2985}
2986
David Blaikie15ed5eb2014-01-10 01:38:41 +00002987// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_dwo_name,
2988// DW_AT_addr_base.
2989DwarfTypeUnit *DwarfDebug::constructSkeletonTU(const DwarfTypeUnit *TU) {
2990
2991 DIE *Die = new DIE(dwarf::DW_TAG_type_unit);
2992 DwarfTypeUnit *NewTU = new DwarfTypeUnit(
2993 TU->getUniqueID(), Die, TU->getCUNode(), Asm, this, &SkeletonHolder);
2994 NewTU->setTypeSignature(TU->getTypeSignature());
2995 NewTU->setType(NULL);
2996 NewTU->initSection(
2997 Asm->getObjFileLowering().getDwarfTypesSection(TU->getTypeSignature()));
2998
2999 initSkeletonUnit(TU, Die, NewTU);
3000 return NewTU;
3001}
3002
Eric Christopherd692c1d2012-12-11 19:42:09 +00003003// Emit the .debug_info.dwo section for separated dwarf. This contains the
3004// compile units that would normally be in debug_info.
Eric Christopher9c2ecd92012-11-30 23:59:06 +00003005void DwarfDebug::emitDebugInfoDWO() {
Eric Christophercdf218d2012-12-10 19:51:21 +00003006 assert(useSplitDwarf() && "No split dwarf debug info?");
David Blaikie03073f72013-12-06 22:14:48 +00003007 InfoHolder.emitUnits(this,
Eric Christopher3c5a1912012-12-19 22:02:53 +00003008 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
3009 DwarfAbbrevDWOSectionSym);
3010}
3011
3012// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
3013// abbreviations for the .debug_info.dwo section.
3014void DwarfDebug::emitDebugAbbrevDWO() {
3015 assert(useSplitDwarf() && "No split dwarf?");
David Blaikie0504cda2013-12-05 07:43:55 +00003016 InfoHolder.emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection());
Eric Christopher9c2ecd92012-11-30 23:59:06 +00003017}
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003018
3019// Emit the .debug_str.dwo section for separated dwarf. This contains the
3020// string section and is identical in format to traditional .debug_str
3021// sections.
3022void DwarfDebug::emitDebugStrDWO() {
3023 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherb4bef6d2013-11-19 09:04:36 +00003024 const MCSection *OffSec =
3025 Asm->getObjFileLowering().getDwarfStrOffDWOSection();
Eric Christopher2cbd5762013-01-07 19:32:41 +00003026 const MCSymbol *StrSym = DwarfStrSectionSym;
3027 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
3028 OffSec, StrSym);
Eric Christopher3bf29fd2012-12-27 02:14:01 +00003029}
David Blaikie409dd9c2013-11-19 23:08:21 +00003030
David Blaikief645f962014-01-09 03:23:41 +00003031void DwarfDebug::addDwarfTypeUnitType(DICompileUnit CUNode,
3032 StringRef Identifier, DIE *RefDie,
3033 DICompositeType CTy) {
Chandler Carruthb587ab62014-01-20 08:07:07 +00003034
David Blaikie47f615e2013-12-17 23:32:35 +00003035 const DwarfTypeUnit *&TU = DwarfTypeUnits[CTy];
Chandler Carruthb587ab62014-01-20 08:07:07 +00003036 if (TU) {
3037 CUMap.begin()->second->addDIETypeSignature(RefDie, *TU);
3038 return;
David Blaikie409dd9c2013-11-19 23:08:21 +00003039 }
3040
Chandler Carruthb587ab62014-01-20 08:07:07 +00003041 DIE *UnitDie = new DIE(dwarf::DW_TAG_type_unit);
3042 DwarfTypeUnit *NewTU = new DwarfTypeUnit(
3043 InfoHolder.getUnits().size(), UnitDie, CUNode, Asm, this, &InfoHolder);
3044 TU = NewTU;
3045 InfoHolder.addUnit(NewTU);
3046
3047 NewTU->addUInt(UnitDie, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
3048 CUNode.getLanguage());
3049
3050 MD5 Hash;
3051 Hash.update(Identifier);
3052 // ... take the least significant 8 bytes and return those. Our MD5
3053 // implementation always returns its results in little endian, swap bytes
3054 // appropriately.
3055 MD5::MD5Result Result;
3056 Hash.final(Result);
3057 uint64_t Signature = *reinterpret_cast<support::ulittle64_t *>(Result + 8);
3058 NewTU->setTypeSignature(Signature);
3059 if (useSplitDwarf())
3060 NewTU->setSkeleton(constructSkeletonTU(NewTU));
3061
3062 NewTU->setType(NewTU->createTypeDIE(CTy));
3063
3064 NewTU->initSection(
3065 useSplitDwarf()
3066 ? Asm->getObjFileLowering().getDwarfTypesDWOSection(Signature)
3067 : Asm->getObjFileLowering().getDwarfTypesSection(Signature));
3068
3069 CUMap.begin()->second->addDIETypeSignature(RefDie, *NewTU);
David Blaikie409dd9c2013-11-19 23:08:21 +00003070}