blob: 475b6704c280aad33ebcfc73044ab473927d59ea [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"
Devang Patel5eb43192011-04-12 17:40:32 +000017#include "DwarfCompileUnit.h"
Bill Wendling30346342010-04-05 22:59:21 +000018#include "llvm/Constants.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000019#include "llvm/Module.h"
Devang Patel2d9e5322011-01-20 00:02:16 +000020#include "llvm/Instructions.h"
David Greene829b3e82009-08-19 21:52:55 +000021#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000022#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000023#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000024#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000025#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000026#include "llvm/MC/MCSymbol.h"
Chris Lattnerf62e3ee2010-01-16 21:57:06 +000027#include "llvm/Target/Mangler.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000028#include "llvm/Target/TargetData.h"
Anton Korobeynikov2f931282011-01-10 12:39:04 +000029#include "llvm/Target/TargetFrameLowering.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000030#include "llvm/Target/TargetLoweringObjectFile.h"
Chris Lattner21dc46e2010-04-04 18:06:11 +000031#include "llvm/Target/TargetMachine.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000032#include "llvm/Target/TargetRegisterInfo.h"
Devang Patel61880932010-04-19 19:14:02 +000033#include "llvm/Target/TargetOptions.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000034#include "llvm/Analysis/DebugInfo.h"
Devang Patela5d93242011-02-24 18:49:30 +000035#include "llvm/Analysis/DIBuilder.h"
Devang Patela86114b2010-10-25 20:45:32 +000036#include "llvm/ADT/Statistic.h"
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000037#include "llvm/ADT/STLExtras.h"
Chris Lattner06fa1762009-08-24 03:52:50 +000038#include "llvm/ADT/StringExtras.h"
Devang Patel6c74a872010-04-27 19:46:33 +000039#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000040#include "llvm/Support/Debug.h"
41#include "llvm/Support/ErrorHandling.h"
Devang Patel1973df22010-01-26 21:39:14 +000042#include "llvm/Support/ValueHandle.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000043#include "llvm/Support/FormattedStream.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000044#include "llvm/Support/Timer.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000045#include "llvm/Support/Path.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000046using namespace llvm;
47
Jim Grosbacha8683bb2010-07-21 21:21:52 +000048static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel30265c42010-07-07 20:12:52 +000049 cl::Hidden,
Devang Patel6c74a872010-04-27 19:46:33 +000050 cl::desc("Disable debug info printing"));
51
Dan Gohman7421ae42010-05-07 01:08:53 +000052static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
Chris Lattner0ab5e2c2011-04-15 05:18:47 +000053 cl::desc("Make an absence of debug location information explicit."),
Dan Gohman7421ae42010-05-07 01:08:53 +000054 cl::init(false));
55
Bill Wendlingfcc14142010-04-07 09:28:04 +000056namespace {
57 const char *DWARFGroupName = "DWARF Emission";
58 const char *DbgTimerName = "DWARF Debug Writer";
59} // end anonymous namespace
60
Bill Wendling2f921f82009-05-15 09:23:25 +000061//===----------------------------------------------------------------------===//
62
63/// Configuration values for initial hash set sizes (log2).
64///
Bill Wendling2f921f82009-05-15 09:23:25 +000065static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +000066
67namespace llvm {
68
Nick Lewycky019d2552011-07-29 03:49:23 +000069DIType DbgVariable::getType() const {
Devang Patelf20c4f72011-04-12 22:53:02 +000070 DIType Ty = Var.getType();
71 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
72 // addresses instead.
73 if (Var.isBlockByrefVariable()) {
74 /* Byref variables, in Blocks, are declared by the programmer as
75 "SomeType VarName;", but the compiler creates a
76 __Block_byref_x_VarName struct, and gives the variable VarName
77 either the struct, or a pointer to the struct, as its type. This
78 is necessary for various behind-the-scenes things the compiler
79 needs to do with by-reference variables in blocks.
80
81 However, as far as the original *programmer* is concerned, the
82 variable should still have type 'SomeType', as originally declared.
83
84 The following function dives into the __Block_byref_x_VarName
85 struct to find the original type of the variable. This will be
86 passed back to the code generating the type for the Debug
87 Information Entry for the variable 'VarName'. 'VarName' will then
88 have the original type 'SomeType' in its debug information.
89
90 The original type 'SomeType' will be the type of the field named
91 'VarName' inside the __Block_byref_x_VarName struct.
92
93 NOTE: In order for this to not completely fail on the debugger
94 side, the Debug Information Entry for the variable VarName needs to
95 have a DW_AT_location that tells the debugger how to unwind through
96 the pointers and __Block_byref_x_VarName struct to find the actual
97 value of the variable. The function addBlockByrefType does this. */
98 DIType subType = Ty;
99 unsigned tag = Ty.getTag();
100
101 if (tag == dwarf::DW_TAG_pointer_type) {
102 DIDerivedType DTy = DIDerivedType(Ty);
103 subType = DTy.getTypeDerivedFrom();
104 }
105
106 DICompositeType blockStruct = DICompositeType(subType);
107 DIArray Elements = blockStruct.getTypeArray();
108
109 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
110 DIDescriptor Element = Elements.getElement(i);
111 DIDerivedType DT = DIDerivedType(Element);
112 if (getName() == DT.getName())
113 return (DT.getTypeDerivedFrom());
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000114 }
115 return Ty;
116 }
Devang Patelf20c4f72011-04-12 22:53:02 +0000117 return Ty;
118}
Bill Wendling2f921f82009-05-15 09:23:25 +0000119
Chris Lattnerf5d06362010-04-05 04:09:20 +0000120} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000121
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000122DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Devang Patel1a0df9a2010-05-10 22:49:55 +0000123 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000124 AbbreviationsSet(InitAbbreviationsSetSize),
Devang Patel7e623022011-08-10 20:55:27 +0000125 PrevLabel(NULL) {
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000126 NextStringPoolNumber = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000127
Rafael Espindolaa7160962011-05-06 14:56:22 +0000128 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattnere58b5472010-04-04 23:10:38 +0000129 DwarfStrSectionSym = TextSectionSym = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000130 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000131 FunctionBeginSym = FunctionEndSym = 0;
Dan Gohman6e681a52010-06-18 15:56:31 +0000132 {
133 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
134 beginModule(M);
Torok Edwinf8dba242010-04-07 10:44:46 +0000135 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000136}
137DwarfDebug::~DwarfDebug() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000138}
139
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000140MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
141 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
142 if (Entry.first) return Entry.first;
143
144 Entry.second = NextStringPoolNumber++;
Chris Lattnera179b522010-04-04 19:25:43 +0000145 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000146}
147
148
Devang Patel930143b2009-11-21 02:48:08 +0000149/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling2f921f82009-05-15 09:23:25 +0000150///
Devang Patel930143b2009-11-21 02:48:08 +0000151void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000152 // Profile the node so that we can make it unique.
153 FoldingSetNodeID ID;
154 Abbrev.Profile(ID);
155
156 // Check the set for priors.
157 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
158
159 // If it's newly added.
160 if (InSet == &Abbrev) {
161 // Add to abbreviation list.
162 Abbreviations.push_back(&Abbrev);
163
164 // Assign the vector position + 1 as its number.
165 Abbrev.setNumber(Abbreviations.size());
166 } else {
167 // Assign existing abbreviation number.
168 Abbrev.setNumber(InSet->getNumber());
169 }
170}
171
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000172/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel43ef34d2010-01-05 01:46:14 +0000173/// printer to not emit usual symbol prefix before the symbol name is used then
174/// return linkage name after skipping this special LLVM prefix.
175static StringRef getRealLinkageName(StringRef LinkageName) {
176 char One = '\1';
177 if (LinkageName.startswith(StringRef(&One, 1)))
178 return LinkageName.substr(1);
179 return LinkageName;
180}
181
Devang Patel525dda02009-12-14 16:18:45 +0000182/// createSubprogramDIE - Create new DIE using SP.
Devang Patel185051c2010-09-27 23:15:27 +0000183DIE *DwarfDebug::createSubprogramDIE(DISubprogram SP) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000184 CompileUnit *SPCU = getCompileUnit(SP);
185 DIE *SPDie = SPCU->getDIE(SP);
Devang Patel525dda02009-12-14 16:18:45 +0000186 if (SPDie)
187 return SPDie;
188
189 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel1d6bbd42011-04-22 23:10:17 +0000190
191 // DW_TAG_inlined_subroutine may refer to this DIE.
192 SPCU->insertDIE(SP, SPDie);
193
194 // Add to context owner.
195 SPCU->addToContextOwner(SPDie, SP.getContext());
196
197 // Add function template parameters.
198 SPCU->addTemplateParams(*SPDie, SP.getTemplateParams());
199
Devang Patel543596d2011-05-03 21:50:34 +0000200 StringRef LinkageName = SP.getLinkageName();
201 if (!LinkageName.empty())
202 SPCU->addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
203 getRealLinkageName(LinkageName));
204
Devang Patel1d6bbd42011-04-22 23:10:17 +0000205 // If this DIE is going to refer declaration info using AT_specification
206 // then there is no need to add other attributes.
207 if (SP.getFunctionDeclaration().isSubprogram())
208 return SPDie;
209
Devang Patelf200b392010-03-02 17:58:15 +0000210 // Constructors and operators for anonymous aggregates do not have names.
Devang Pateld0fa3042010-03-02 01:26:20 +0000211 if (!SP.getName().empty())
Devang Patelf20c4f72011-04-12 22:53:02 +0000212 SPCU->addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
213 SP.getName());
Bill Wendling2f921f82009-05-15 09:23:25 +0000214
Devang Patelf20c4f72011-04-12 22:53:02 +0000215 SPCU->addSourceLine(SPDie, SP);
Bill Wendling2f921f82009-05-15 09:23:25 +0000216
Devang Patel3a24f922010-10-07 22:03:01 +0000217 if (SP.isPrototyped())
Devang Patelf20c4f72011-04-12 22:53:02 +0000218 SPCU->addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Devang Patel1d6bbd42011-04-22 23:10:17 +0000219
Bill Wendling2f921f82009-05-15 09:23:25 +0000220 // Add Return Type.
Devang Patel236526d2009-12-03 01:25:38 +0000221 DICompositeType SPTy = SP.getType();
222 DIArray Args = SPTy.getTypeArray();
Bill Wendling2f921f82009-05-15 09:23:25 +0000223 unsigned SPTag = SPTy.getTag();
Devang Pateleb57c592009-12-03 19:11:07 +0000224
Devang Patel3b548aa2010-03-08 20:52:55 +0000225 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patelf20c4f72011-04-12 22:53:02 +0000226 SPCU->addType(SPDie, SPTy);
Devang Patel236526d2009-12-03 01:25:38 +0000227 else
Devang Patelf20c4f72011-04-12 22:53:02 +0000228 SPCU->addType(SPDie, DIType(Args.getElement(0)));
Devang Patel236526d2009-12-03 01:25:38 +0000229
Devang Pateleb57c592009-12-03 19:11:07 +0000230 unsigned VK = SP.getVirtuality();
231 if (VK) {
Devang Patelf20c4f72011-04-12 22:53:02 +0000232 SPCU->addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
233 DIEBlock *Block = SPCU->getDIEBlock();
234 SPCU->addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
235 SPCU->addUInt(Block, 0, dwarf::DW_FORM_udata, SP.getVirtualIndex());
236 SPCU->addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000237 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000238 SP.getContainingType()));
Devang Pateleb57c592009-12-03 19:11:07 +0000239 }
240
Devang Patel185051c2010-09-27 23:15:27 +0000241 if (!SP.isDefinition()) {
Devang Patelf20c4f72011-04-12 22:53:02 +0000242 SPCU->addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
243
Bill Wendling2f921f82009-05-15 09:23:25 +0000244 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel236526d2009-12-03 01:25:38 +0000245 // be handled while processing variables.
246 DICompositeType SPTy = SP.getType();
247 DIArray Args = SPTy.getTypeArray();
248 unsigned SPTag = SPTy.getTag();
249
Bill Wendling2f921f82009-05-15 09:23:25 +0000250 if (SPTag == dwarf::DW_TAG_subroutine_type)
251 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
252 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000253 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patelf20c4f72011-04-12 22:53:02 +0000254 SPCU->addType(Arg, ATy);
Devang Patel6efc8e52010-02-06 01:02:37 +0000255 if (ATy.isArtificial())
Devang Patelf20c4f72011-04-12 22:53:02 +0000256 SPCU->addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel930143b2009-11-21 02:48:08 +0000257 SPDie->addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000258 }
259 }
260
Devang Patel999b4992010-02-03 19:57:19 +0000261 if (SP.isArtificial())
Devang Patelf20c4f72011-04-12 22:53:02 +0000262 SPCU->addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel999b4992010-02-03 19:57:19 +0000263
Devang Patelb4e3b902010-04-30 19:38:23 +0000264 if (!SP.isLocalToUnit())
Devang Patelf20c4f72011-04-12 22:53:02 +0000265 SPCU->addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000266
Devang Patelb4e3b902010-04-30 19:38:23 +0000267 if (SP.isOptimized())
Devang Patelf20c4f72011-04-12 22:53:02 +0000268 SPCU->addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Devang Patelb4e3b902010-04-30 19:38:23 +0000269
Jim Grosbach965a73a2010-07-21 23:03:52 +0000270 if (unsigned isa = Asm->getISAEncoding()) {
Devang Patelf20c4f72011-04-12 22:53:02 +0000271 SPCU->addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
Jim Grosbach965a73a2010-07-21 23:03:52 +0000272 }
273
Bill Wendling2f921f82009-05-15 09:23:25 +0000274 return SPDie;
275}
276
Devang Patel019922d2010-04-06 23:53:48 +0000277/// isSubprogramContext - Return true if Context is either a subprogram
278/// or another context nested inside a subprogram.
Devang Patel32cc43c2010-05-07 20:54:48 +0000279static bool isSubprogramContext(const MDNode *Context) {
Devang Patel019922d2010-04-06 23:53:48 +0000280 if (!Context)
281 return false;
282 DIDescriptor D(Context);
283 if (D.isSubprogram())
284 return true;
285 if (D.isType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000286 return isSubprogramContext(DIType(Context).getContext());
Devang Patel019922d2010-04-06 23:53:48 +0000287 return false;
288}
289
Jim Grosbach042483e2009-11-21 23:12:12 +0000290/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel930143b2009-11-21 02:48:08 +0000291/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
292/// If there are global variables in this scope then create and insert
293/// DIEs for these variables.
Devang Patel32cc43c2010-05-07 20:54:48 +0000294DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000295 CompileUnit *SPCU = getCompileUnit(SPNode);
296 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +0000297
Chris Lattner3a383cb2010-04-05 00:13:49 +0000298 assert(SPDie && "Unable to find subprogram DIE!");
299 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000300
Devang Patel1d6bbd42011-04-22 23:10:17 +0000301 DISubprogram SPDecl = SP.getFunctionDeclaration();
302 if (SPDecl.isSubprogram())
303 // Refer function declaration directly.
Devang Patelf20c4f72011-04-12 22:53:02 +0000304 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Devang Patel1d6bbd42011-04-22 23:10:17 +0000305 createSubprogramDIE(SPDecl));
306 else {
307 // There is not any need to generate specification DIE for a function
308 // defined at compile unit level. If a function is defined inside another
309 // function then gdb prefers the definition at top level and but does not
310 // expect specification DIE in parent function. So avoid creating
311 // specification DIE for a function defined inside a function.
312 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
313 !SP.getContext().isFile() &&
314 !isSubprogramContext(SP.getContext())) {
315 SPCU-> addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
316
317 // Add arguments.
318 DICompositeType SPTy = SP.getType();
319 DIArray Args = SPTy.getTypeArray();
320 unsigned SPTag = SPTy.getTag();
321 if (SPTag == dwarf::DW_TAG_subroutine_type)
322 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
323 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
324 DIType ATy = DIType(DIType(Args.getElement(i)));
325 SPCU->addType(Arg, ATy);
326 if (ATy.isArtificial())
327 SPCU->addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
328 SPDie->addChild(Arg);
329 }
330 DIE *SPDeclDie = SPDie;
331 SPDie = new DIE(dwarf::DW_TAG_subprogram);
332 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
333 SPDeclDie);
334 SPCU->addDie(SPDie);
335 }
Chris Lattner3a383cb2010-04-05 00:13:49 +0000336 }
Devang Patela37a95e2010-07-07 22:20:57 +0000337 // Pick up abstract subprogram DIE.
338 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
339 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf20c4f72011-04-12 22:53:02 +0000340 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
341 dwarf::DW_FORM_ref4, AbsSPDIE);
Devang Patela37a95e2010-07-07 22:20:57 +0000342 SPCU->addDie(SPDie);
343 }
344
Devang Patelf20c4f72011-04-12 22:53:02 +0000345 SPCU->addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
346 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
347 SPCU->addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
348 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
Chris Lattner3a383cb2010-04-05 00:13:49 +0000349 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
350 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000351 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000352
Chris Lattner3a383cb2010-04-05 00:13:49 +0000353 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000354}
355
Jim Grosbach042483e2009-11-21 23:12:12 +0000356/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel930143b2009-11-21 02:48:08 +0000357/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
Devang Patel7e623022011-08-10 20:55:27 +0000358DIE *DwarfDebug::constructLexicalScopeDIE(LexicalScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +0000359
360 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
361 if (Scope->isAbstractScope())
362 return ScopeDIE;
363
Devang Patel7e623022011-08-10 20:55:27 +0000364 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +0000365 if (Ranges.empty())
366 return 0;
367
Devang Patelf20c4f72011-04-12 22:53:02 +0000368 CompileUnit *TheCU = getCompileUnit(Scope->getScopeNode());
Devang Patel7e623022011-08-10 20:55:27 +0000369 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel6c74a872010-04-27 19:46:33 +0000370 if (Ranges.size() > 1) {
371 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000372 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +0000373 // DW_AT_ranges appropriately.
Devang Patelf20c4f72011-04-12 22:53:02 +0000374 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
375 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
Devang Patel7e623022011-08-10 20:55:27 +0000376 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +0000377 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +0000378 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
379 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +0000380 }
381 DebugRangeSymbols.push_back(NULL);
382 DebugRangeSymbols.push_back(NULL);
383 return ScopeDIE;
384 }
385
Devang Patel9fc11702010-05-25 23:40:22 +0000386 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
387 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +0000388
Devang Patel9fc11702010-05-25 23:40:22 +0000389 if (End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000390
Chris Lattnere13c3722010-03-09 01:58:53 +0000391 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
392 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000393
Devang Patelf20c4f72011-04-12 22:53:02 +0000394 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
395 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000396
397 return ScopeDIE;
398}
399
Devang Patel930143b2009-11-21 02:48:08 +0000400/// constructInlinedScopeDIE - This scope represents inlined body of
401/// a function. Construct DIE to represent this concrete inlined copy
402/// of the function.
Devang Patel7e623022011-08-10 20:55:27 +0000403DIE *DwarfDebug::constructInlinedScopeDIE(LexicalScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +0000404
Devang Patel7e623022011-08-10 20:55:27 +0000405 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000406 assert (Ranges.empty() == false
Devang Patel7e623022011-08-10 20:55:27 +0000407 && "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000408
Devang Patelf098ce22011-07-27 00:34:13 +0000409 if (!Scope->getScopeNode())
410 return NULL;
411 DIScope DS(Scope->getScopeNode());
412 DISubprogram InlinedSP = getDISubprogram(DS);
413 CompileUnit *TheCU = getCompileUnit(InlinedSP);
414 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
415 if (!OriginDIE) {
416 DEBUG(dbgs() << "Unable to find original DIE for inlined subprogram.");
417 return NULL;
418 }
419
Devang Patel7e623022011-08-10 20:55:27 +0000420 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel9fc11702010-05-25 23:40:22 +0000421 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
422 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +0000423
Devang Patel4c6bd662010-07-08 22:39:20 +0000424 if (StartLabel == 0 || EndLabel == 0) {
Nick Lewycky019d2552011-07-29 03:49:23 +0000425 assert (0 && "Unexpected Start and End labels for a inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +0000426 return 0;
427 }
Chris Lattnere13c3722010-03-09 01:58:53 +0000428 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +0000429 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +0000430 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +0000431 "Invalid end label for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +0000432
Devang Patel73bc1722011-05-05 17:54:26 +0000433 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Devang Patelf20c4f72011-04-12 22:53:02 +0000434 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
435 dwarf::DW_FORM_ref4, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000436
Devang Patelf098ce22011-07-27 00:34:13 +0000437 if (Ranges.size() > 1) {
438 // .debug_range section has not been laid out yet. Emit offset in
439 // .debug_range as a uint, size 4, for now. emitDIE will handle
440 // DW_AT_ranges appropriately.
441 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
442 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
Devang Patel7e623022011-08-10 20:55:27 +0000443 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patelf098ce22011-07-27 00:34:13 +0000444 RE = Ranges.end(); RI != RE; ++RI) {
445 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
446 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
447 }
448 DebugRangeSymbols.push_back(NULL);
449 DebugRangeSymbols.push_back(NULL);
450 } else {
451 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
452 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
453 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000454
455 InlinedSubprogramDIEs.insert(OriginDIE);
456
457 // Track the start label for this inlined function.
Devang Patelf098ce22011-07-27 00:34:13 +0000458 //.debug_inlined section specification does not clearly state how
459 // to emit inlined scope that is split into multiple instruction ranges.
460 // For now, use first instruction range and emit low_pc/high_pc pair and
461 // corresponding .debug_inlined section entry for this pair.
Devang Patel32cc43c2010-05-07 20:54:48 +0000462 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000463 I = InlineInfo.find(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000464
465 if (I == InlineInfo.end()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000466 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach00e9c612009-11-22 19:20:36 +0000467 ScopeDIE));
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000468 InlinedSPNodes.push_back(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000469 } else
Chris Lattner085b6522010-03-09 00:31:02 +0000470 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000471
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000472 DILocation DL(Scope->getInlinedAt());
Devang Patelf20c4f72011-04-12 22:53:02 +0000473 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
474 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000475
476 return ScopeDIE;
477}
478
Devang Patelf071d722011-06-24 20:46:11 +0000479/// isUnsignedDIType - Return true if type encoding is unsigned.
480static bool isUnsignedDIType(DIType Ty) {
481 DIDerivedType DTy(Ty);
482 if (DTy.Verify())
483 return isUnsignedDIType(DTy.getTypeDerivedFrom());
484
485 DIBasicType BTy(Ty);
486 if (BTy.Verify()) {
487 unsigned Encoding = BTy.getEncoding();
488 if (Encoding == dwarf::DW_ATE_unsigned ||
489 Encoding == dwarf::DW_ATE_unsigned_char)
490 return true;
491 }
492 return false;
493}
Devang Patel930143b2009-11-21 02:48:08 +0000494
495/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel7e623022011-08-10 20:55:27 +0000496DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, LexicalScope *Scope) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000497 StringRef Name = DV->getName();
Devang Patel2d9caf92009-11-25 17:36:49 +0000498 if (Name.empty())
Devang Patel97f99fa2009-11-13 02:25:26 +0000499 return NULL;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000500
501 // Translate tag to proper Dwarf tag. The result variable is dropped for
502 // now.
503 unsigned Tag;
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000504 switch (DV->getTag()) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000505 case dwarf::DW_TAG_return_variable:
506 return NULL;
507 case dwarf::DW_TAG_arg_variable:
508 Tag = dwarf::DW_TAG_formal_parameter;
509 break;
510 case dwarf::DW_TAG_auto_variable: // fall thru
511 default:
512 Tag = dwarf::DW_TAG_variable;
513 break;
514 }
515
516 // Define variable debug information entry.
517 DIE *VariableDie = new DIE(Tag);
Devang Patel2606f4d2011-04-25 23:05:21 +0000518 CompileUnit *VariableCU = getCompileUnit(DV->getVariable());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000519 DIE *AbsDIE = NULL;
Devang Patele1c53f22010-05-20 16:36:41 +0000520 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
521 V2AVI = VarToAbstractVarMap.find(DV);
522 if (V2AVI != VarToAbstractVarMap.end())
523 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach042483e2009-11-21 23:12:12 +0000524
Devang Patele1c53f22010-05-20 16:36:41 +0000525 if (AbsDIE)
Devang Patel2606f4d2011-04-25 23:05:21 +0000526 VariableCU->addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patelf20c4f72011-04-12 22:53:02 +0000527 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000528 else {
Devang Patel2606f4d2011-04-25 23:05:21 +0000529 VariableCU->addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
530 Name);
531 VariableCU->addSourceLine(VariableDie, DV->getVariable());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000532
533 // Add variable type.
Devang Patel2606f4d2011-04-25 23:05:21 +0000534 VariableCU->addType(VariableDie, DV->getType());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000535 }
536
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000537 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patel2606f4d2011-04-25 23:05:21 +0000538 VariableCU->addUInt(VariableDie, dwarf::DW_AT_artificial,
539 dwarf::DW_FORM_flag, 1);
Devang Patelbea08d12010-09-29 23:07:21 +0000540 else if (DIVariable(DV->getVariable()).isArtificial())
Devang Patel2606f4d2011-04-25 23:05:21 +0000541 VariableCU->addUInt(VariableDie, dwarf::DW_AT_artificial,
542 dwarf::DW_FORM_flag, 1);
Devang Patel9fc11702010-05-25 23:40:22 +0000543
544 if (Scope->isAbstractScope()) {
545 DV->setDIE(VariableDie);
546 return VariableDie;
547 }
548
549 // Add variable address.
550
551 unsigned Offset = DV->getDotDebugLocOffset();
552 if (Offset != ~0U) {
Devang Patel2606f4d2011-04-25 23:05:21 +0000553 VariableCU->addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
Devang Patel9fc11702010-05-25 23:40:22 +0000554 Asm->GetTempSymbol("debug_loc", Offset));
555 DV->setDIE(VariableDie);
556 UseDotDebugLocEntry.insert(VariableDie);
557 return VariableDie;
558 }
559
560 // Check if variable is described by a DBG_VALUE instruction.
561 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
562 DbgVariableToDbgInstMap.find(DV);
563 if (DVI != DbgVariableToDbgInstMap.end()) {
564 const MachineInstr *DVInsn = DVI->second;
Devang Patel9fc11702010-05-25 23:40:22 +0000565 bool updated = false;
Devang Patel9fc11702010-05-25 23:40:22 +0000566 if (DVInsn->getNumOperands() == 3) {
Devang Patel86ec8b32010-08-31 22:22:42 +0000567 if (DVInsn->getOperand(0).isReg()) {
568 const MachineOperand RegOp = DVInsn->getOperand(0);
569 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
570 if (DVInsn->getOperand(1).isImm() &&
571 TRI->getFrameRegister(*Asm->MF) == RegOp.getReg()) {
Devang Patel77dc5412011-04-27 22:45:24 +0000572 unsigned FrameReg = 0;
573 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
574 int Offset =
575 TFI->getFrameIndexReference(*Asm->MF,
576 DVInsn->getOperand(1).getImm(),
577 FrameReg);
578 MachineLocation Location(FrameReg, Offset);
579 VariableCU->addVariableAddress(DV, VariableDie, Location);
580
581 } else if (RegOp.getReg())
582 VariableCU->addVariableAddress(DV, VariableDie,
583 MachineLocation(RegOp.getReg()));
584 updated = true;
Devang Patel86ec8b32010-08-31 22:22:42 +0000585 }
Devang Patel9fc11702010-05-25 23:40:22 +0000586 else if (DVInsn->getOperand(0).isImm())
Devang Patel3c6aed22011-05-27 16:45:18 +0000587 updated =
588 VariableCU->addConstantValue(VariableDie, DVInsn->getOperand(0),
589 DV->getType());
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000590 else if (DVInsn->getOperand(0).isFPImm())
591 updated =
Devang Patel2606f4d2011-04-25 23:05:21 +0000592 VariableCU->addConstantFPValue(VariableDie, DVInsn->getOperand(0));
Devang Patelf071d722011-06-24 20:46:11 +0000593 else if (DVInsn->getOperand(0).isCImm())
594 updated =
595 VariableCU->addConstantValue(VariableDie,
596 DVInsn->getOperand(0).getCImm(),
597 isUnsignedDIType(DV->getType()));
Devang Patel9fc11702010-05-25 23:40:22 +0000598 } else {
Devang Patel77dc5412011-04-27 22:45:24 +0000599 VariableCU->addVariableAddress(DV, VariableDie,
600 Asm->getDebugValueLocation(DVInsn));
601 updated = true;
Devang Patel9fc11702010-05-25 23:40:22 +0000602 }
603 if (!updated) {
604 // If variableDie is not updated then DBG_VALUE instruction does not
605 // have valid variable info.
606 delete VariableDie;
607 return NULL;
608 }
609 DV->setDIE(VariableDie);
610 return VariableDie;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000611 }
Devang Patel9fc11702010-05-25 23:40:22 +0000612
613 // .. else use frame index, if available.
Devang Patel9fc11702010-05-25 23:40:22 +0000614 int FI = 0;
Devang Patel77dc5412011-04-27 22:45:24 +0000615 if (findVariableFrameIndex(DV, &FI)) {
616 unsigned FrameReg = 0;
617 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
618 int Offset =
619 TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
620 MachineLocation Location(FrameReg, Offset);
621 VariableCU->addVariableAddress(DV, VariableDie, Location);
622 }
623
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000624 DV->setDIE(VariableDie);
625 return VariableDie;
626
627}
Devang Patel930143b2009-11-21 02:48:08 +0000628
629/// constructScopeDIE - Construct a DIE for this scope.
Devang Patel7e623022011-08-10 20:55:27 +0000630DIE *DwarfDebug::constructScopeDIE(LexicalScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000631 if (!Scope || !Scope->getScopeNode())
632 return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000633
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000634 SmallVector <DIE *, 8> Children;
Devang Patel6c622ef2011-03-01 22:58:55 +0000635
636 // Collect arguments for current function.
Devang Patel7e623022011-08-10 20:55:27 +0000637 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000638 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
639 if (DbgVariable *ArgDV = CurrentFnArguments[i])
640 if (DIE *Arg = constructVariableDIE(ArgDV, Scope))
641 Children.push_back(Arg);
642
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000643 // Collect lexical scope childrens first.
Devang Patel7e623022011-08-10 20:55:27 +0000644 const SmallVector<DbgVariable *, 8> &Variables = ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000645 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
646 if (DIE *Variable = constructVariableDIE(Variables[i], Scope))
647 Children.push_back(Variable);
Devang Patel7e623022011-08-10 20:55:27 +0000648 const SmallVector<LexicalScope *, 4> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000649 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
650 if (DIE *Nested = constructScopeDIE(Scopes[j]))
651 Children.push_back(Nested);
Devang Patel3b548aa2010-03-08 20:52:55 +0000652 DIScope DS(Scope->getScopeNode());
653 DIE *ScopeDIE = NULL;
654 if (Scope->getInlinedAt())
655 ScopeDIE = constructInlinedScopeDIE(Scope);
656 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000657 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000658 if (Scope->isAbstractScope()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000659 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000660 // Note down abstract DIE.
661 if (ScopeDIE)
662 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
663 }
Devang Patel3b548aa2010-03-08 20:52:55 +0000664 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000665 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3b548aa2010-03-08 20:52:55 +0000666 }
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000667 else {
668 // There is no need to emit empty lexical block DIE.
669 if (Children.empty())
670 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +0000671 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000672 }
673
Devang Patel23b2ae62010-03-29 22:59:58 +0000674 if (!ScopeDIE) return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000675
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000676 // Add children
677 for (SmallVector<DIE *, 8>::iterator I = Children.begin(),
678 E = Children.end(); I != E; ++I)
679 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000680
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000681 if (DS.isSubprogram())
Devang Patelf20c4f72011-04-12 22:53:02 +0000682 getCompileUnit(DS)->addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000683
Devang Patel04d2f2d2009-11-24 01:14:22 +0000684 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000685}
686
Bill Wendling2b128d72009-05-20 23:19:06 +0000687/// GetOrCreateSourceID - Look up the source id with the given directory and
688/// source file names. If none currently exists, create a new id and insert it
689/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
690/// maps as well.
Devang Patel498877d2010-07-24 00:53:22 +0000691
Devang Patele01b75c2011-03-24 20:30:50 +0000692unsigned DwarfDebug::GetOrCreateSourceID(StringRef FileName,
693 StringRef DirName) {
Devang Patel871d0b12010-09-16 20:57:49 +0000694 // If FE did not provide a file name, then assume stdin.
695 if (FileName.empty())
Devang Patele01b75c2011-03-24 20:30:50 +0000696 return GetOrCreateSourceID("<stdin>", StringRef());
697
698 // MCStream expects full path name as filename.
Benjamin Kramer440c3b72011-06-05 14:36:47 +0000699 if (!DirName.empty() && !sys::path::is_absolute(FileName)) {
700 SmallString<128> FullPathName = DirName;
701 sys::path::append(FullPathName, FileName);
Devang Patele01b75c2011-03-24 20:30:50 +0000702 // Here FullPathName will be copied into StringMap by GetOrCreateSourceID.
703 return GetOrCreateSourceID(StringRef(FullPathName), StringRef());
704 }
Devang Patel871d0b12010-09-16 20:57:49 +0000705
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000706 StringMapEntry<unsigned> &Entry = SourceIdMap.GetOrCreateValue(FileName);
707 if (Entry.getValue())
708 return Entry.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +0000709
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000710 unsigned SrcId = SourceIdMap.size();
711 Entry.setValue(SrcId);
Bill Wendling2b128d72009-05-20 23:19:06 +0000712
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000713 // Print out a .file directive to specify files for .loc directives.
Devang Patele01b75c2011-03-24 20:30:50 +0000714 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, Entry.getKey());
Bill Wendling2b128d72009-05-20 23:19:06 +0000715
716 return SrcId;
717}
718
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000719/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel1a0df9a2010-05-10 22:49:55 +0000720/// metadata node with tag DW_TAG_compile_unit.
Devang Patel32cc43c2010-05-07 20:54:48 +0000721void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +0000722 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +0000723 StringRef FN = DIUnit.getFilename();
724 StringRef Dir = DIUnit.getDirectory();
Devang Patele01b75c2011-03-24 20:30:50 +0000725 unsigned ID = GetOrCreateSourceID(FN, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +0000726
727 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patelf20c4f72011-04-12 22:53:02 +0000728 CompileUnit *NewCU = new CompileUnit(ID, Die, Asm, this);
729 NewCU->addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
730 DIUnit.getProducer());
731 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
732 DIUnit.getLanguage());
733 NewCU->addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patelbd798ce2010-04-26 22:54:28 +0000734 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
735 // simplifies debug range entries.
Devang Patelf20c4f72011-04-12 22:53:02 +0000736 NewCU->addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Pateld22ed622010-03-22 23:11:36 +0000737 // DW_AT_stmt_list is a offset of line number information for this
Devang Patel4a213872010-08-24 00:06:12 +0000738 // compile unit in debug_line section.
Rafael Espindola2fe0ee12011-05-10 20:35:05 +0000739 if(Asm->MAI->doesDwarfRequireRelocationForSectionOffset())
Rafael Espindolaa7558912011-05-04 17:44:06 +0000740 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Devang Patelf20c4f72011-04-12 22:53:02 +0000741 Asm->GetTempSymbol("section_line"));
Devang Patelea636392010-08-31 23:50:19 +0000742 else
Devang Patelf20c4f72011-04-12 22:53:02 +0000743 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +0000744
Devang Patel2d9caf92009-11-25 17:36:49 +0000745 if (!Dir.empty())
Devang Patelf20c4f72011-04-12 22:53:02 +0000746 NewCU->addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +0000747 if (DIUnit.isOptimized())
Devang Patelf20c4f72011-04-12 22:53:02 +0000748 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendling2b128d72009-05-20 23:19:06 +0000749
Devang Patel2d9caf92009-11-25 17:36:49 +0000750 StringRef Flags = DIUnit.getFlags();
751 if (!Flags.empty())
Devang Patelf20c4f72011-04-12 22:53:02 +0000752 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
753
Bill Wendling2b128d72009-05-20 23:19:06 +0000754 unsigned RVer = DIUnit.getRunTimeVersion();
755 if (RVer)
Devang Patelf20c4f72011-04-12 22:53:02 +0000756 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +0000757 dwarf::DW_FORM_data1, RVer);
758
Devang Patel1a0df9a2010-05-10 22:49:55 +0000759 if (!FirstCU)
760 FirstCU = NewCU;
761 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendling2b128d72009-05-20 23:19:06 +0000762}
763
Nick Lewycky019d2552011-07-29 03:49:23 +0000764/// getCompileUnit - Get CompileUnit DIE.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000765CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
766 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
767 DIDescriptor D(N);
768 const MDNode *CUNode = NULL;
769 if (D.isCompileUnit())
770 CUNode = N;
771 else if (D.isSubprogram())
772 CUNode = DISubprogram(N).getCompileUnit();
773 else if (D.isType())
774 CUNode = DIType(N).getCompileUnit();
775 else if (D.isGlobalVariable())
776 CUNode = DIGlobalVariable(N).getCompileUnit();
777 else if (D.isVariable())
778 CUNode = DIVariable(N).getCompileUnit();
779 else if (D.isNameSpace())
780 CUNode = DINameSpace(N).getCompileUnit();
781 else if (D.isFile())
782 CUNode = DIFile(N).getCompileUnit();
783 else
784 return FirstCU;
785
786 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
787 = CUMap.find(CUNode);
788 if (I == CUMap.end())
789 return FirstCU;
790 return I->second;
791}
792
Nick Lewycky019d2552011-07-29 03:49:23 +0000793// Return const expression if value is a GEP to access merged global
Devang Patel2d9e5322011-01-20 00:02:16 +0000794// constant. e.g.
795// i8* getelementptr ({ i8, i8, i8, i8 }* @_MergedGlobals, i32 0, i32 0)
796static const ConstantExpr *getMergedGlobalExpr(const Value *V) {
797 const ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(V);
798 if (!CE || CE->getNumOperands() != 3 ||
Bob Wilson0a8d5c62011-08-03 19:42:51 +0000799 CE->getOpcode() != Instruction::GetElementPtr)
Devang Patel2d9e5322011-01-20 00:02:16 +0000800 return NULL;
801
Bob Wilson0a8d5c62011-08-03 19:42:51 +0000802 // First operand points to a global struct.
803 Value *Ptr = CE->getOperand(0);
804 if (!isa<GlobalValue>(Ptr) ||
805 !isa<StructType>(cast<PointerType>(Ptr->getType())->getElementType()))
Devang Patel2d9e5322011-01-20 00:02:16 +0000806 return NULL;
807
808 // Second operand is zero.
Nick Lewycky019d2552011-07-29 03:49:23 +0000809 const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(CE->getOperand(1));
Devang Patel2d9e5322011-01-20 00:02:16 +0000810 if (!CI || !CI->isZero())
811 return NULL;
812
813 // Third operand is offset.
814 if (!isa<ConstantInt>(CE->getOperand(2)))
815 return NULL;
816
817 return CE;
818}
819
Devang Patel1a0df9a2010-05-10 22:49:55 +0000820/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +0000821void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel469c12d22010-08-10 01:37:23 +0000822 DIGlobalVariable GV(N);
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000823
Devang Patelf5d53602009-09-04 23:59:07 +0000824 // If debug information is malformed then ignore it.
Devang Patel469c12d22010-08-10 01:37:23 +0000825 if (GV.Verify() == false)
Devang Patelf5d53602009-09-04 23:59:07 +0000826 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000827
828 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000829 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel469c12d22010-08-10 01:37:23 +0000830 if (TheCU->getDIE(GV))
Devang Patel0751a282009-06-26 01:49:18 +0000831 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000832
Devang Patel469c12d22010-08-10 01:37:23 +0000833 DIType GTy = GV.getType();
Devang Patelb2197462010-08-10 07:11:13 +0000834 DIE *VariableDIE = new DIE(GV.getTag());
835
836 bool isGlobalVariable = GV.getGlobal() != NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +0000837
Devang Patel469c12d22010-08-10 01:37:23 +0000838 // Add name.
Devang Patelf20c4f72011-04-12 22:53:02 +0000839 TheCU->addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
840 GV.getDisplayName());
Devang Patel469c12d22010-08-10 01:37:23 +0000841 StringRef LinkageName = GV.getLinkageName();
Devang Patelb2197462010-08-10 07:11:13 +0000842 if (!LinkageName.empty() && isGlobalVariable)
Devang Patelf20c4f72011-04-12 22:53:02 +0000843 TheCU->addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name,
844 dwarf::DW_FORM_string,
845 getRealLinkageName(LinkageName));
Devang Patel469c12d22010-08-10 01:37:23 +0000846 // Add type.
Devang Patelf20c4f72011-04-12 22:53:02 +0000847 TheCU->addType(VariableDIE, GTy);
Devang Patele9853f22011-05-31 22:56:51 +0000848
Devang Patel469c12d22010-08-10 01:37:23 +0000849 // Add scoping info.
850 if (!GV.isLocalToUnit()) {
Devang Patelf20c4f72011-04-12 22:53:02 +0000851 TheCU->addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patel469c12d22010-08-10 01:37:23 +0000852 // Expose as global.
853 TheCU->addGlobal(GV.getName(), VariableDIE);
854 }
855 // Add line number info.
Devang Patelf20c4f72011-04-12 22:53:02 +0000856 TheCU->addSourceLine(VariableDIE, GV);
Devang Patel469c12d22010-08-10 01:37:23 +0000857 // Add to map.
858 TheCU->insertDIE(N, VariableDIE);
859 // Add to context owner.
860 DIDescriptor GVContext = GV.getContext();
Devang Patelf20c4f72011-04-12 22:53:02 +0000861 TheCU->addToContextOwner(VariableDIE, GVContext);
Devang Patel469c12d22010-08-10 01:37:23 +0000862 // Add location.
Devang Patelb2197462010-08-10 07:11:13 +0000863 if (isGlobalVariable) {
864 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patelf20c4f72011-04-12 22:53:02 +0000865 TheCU->addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
866 TheCU->addLabel(Block, 0, dwarf::DW_FORM_udata,
Devang Patelb2197462010-08-10 07:11:13 +0000867 Asm->Mang->getSymbol(GV.getGlobal()));
868 // Do not create specification DIE if context is either compile unit
869 // or a subprogram.
870 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
871 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
872 // Create specification DIE.
873 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
Devang Patelf20c4f72011-04-12 22:53:02 +0000874 TheCU->addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
Devang Patelb2197462010-08-10 07:11:13 +0000875 dwarf::DW_FORM_ref4, VariableDIE);
Devang Patelf20c4f72011-04-12 22:53:02 +0000876 TheCU->addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
877 TheCU->addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Devang Patelb2197462010-08-10 07:11:13 +0000878 TheCU->addDie(VariableSpecDIE);
879 } else {
Devang Patelf20c4f72011-04-12 22:53:02 +0000880 TheCU->addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
Devang Patelb2197462010-08-10 07:11:13 +0000881 }
Devang Patelf071d722011-06-24 20:46:11 +0000882 } else if (const ConstantInt *CI =
Devang Patel70eb9822011-01-06 21:39:25 +0000883 dyn_cast_or_null<ConstantInt>(GV.getConstant()))
Devang Patelf20c4f72011-04-12 22:53:02 +0000884 TheCU->addConstantValue(VariableDIE, CI, isUnsignedDIType(GTy));
Devang Patel2d9e5322011-01-20 00:02:16 +0000885 else if (const ConstantExpr *CE = getMergedGlobalExpr(N->getOperand(11))) {
886 // GV is a merged global.
887 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Bob Wilson0a8d5c62011-08-03 19:42:51 +0000888 Value *Ptr = CE->getOperand(0);
Devang Patelf20c4f72011-04-12 22:53:02 +0000889 TheCU->addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
890 TheCU->addLabel(Block, 0, dwarf::DW_FORM_udata,
Bob Wilson0a8d5c62011-08-03 19:42:51 +0000891 Asm->Mang->getSymbol(cast<GlobalValue>(Ptr)));
Devang Patelf20c4f72011-04-12 22:53:02 +0000892 TheCU->addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
Bob Wilson0a8d5c62011-08-03 19:42:51 +0000893 SmallVector<Value*, 3> Idx(CE->op_begin()+1, CE->op_end());
Devang Pateldc9cbaa2011-08-03 01:25:46 +0000894 TheCU->addUInt(Block, 0, dwarf::DW_FORM_udata,
Bob Wilson0a8d5c62011-08-03 19:42:51 +0000895 Asm->getTargetData().getIndexedOffset(Ptr->getType(), Idx));
Devang Patelf20c4f72011-04-12 22:53:02 +0000896 TheCU->addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
897 TheCU->addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
Devang Patel2d9e5322011-01-20 00:02:16 +0000898 }
Devang Patel70eb9822011-01-06 21:39:25 +0000899
Devang Patel0751a282009-06-26 01:49:18 +0000900 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000901}
902
Devang Patel1a0df9a2010-05-10 22:49:55 +0000903/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +0000904void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +0000905 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000906
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000907 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000908 CompileUnit *TheCU = getCompileUnit(N);
909 if (TheCU->getDIE(N))
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000910 return;
911
Bill Wendling2b128d72009-05-20 23:19:06 +0000912 if (!SP.isDefinition())
913 // This is a method declaration which will be handled while constructing
914 // class type.
Devang Patel0751a282009-06-26 01:49:18 +0000915 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000916
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000917 DIE *SubprogramDie = createSubprogramDIE(SP);
918
919 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000920 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +0000921
922 // Add to context owner.
Devang Patelf20c4f72011-04-12 22:53:02 +0000923 TheCU->addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +0000924
Bill Wendling2b128d72009-05-20 23:19:06 +0000925 // Expose as global.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000926 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000927
Devang Patel0751a282009-06-26 01:49:18 +0000928 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000929}
930
Devang Patel930143b2009-11-21 02:48:08 +0000931/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000932/// content. Create global DIEs and emit initial debug info sections.
Nick Lewycky019d2552011-07-29 03:49:23 +0000933/// This is invoked by the target AsmPrinter.
Chris Lattner11980022010-04-04 07:48:20 +0000934void DwarfDebug::beginModule(Module *M) {
Devang Patel6c74a872010-04-27 19:46:33 +0000935 if (DisableDebugInfoPrinting)
936 return;
937
Nick Lewycky019d2552011-07-29 03:49:23 +0000938 // If module has named metadata anchors then use them, otherwise scan the
939 // module using debug info finder to collect debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000940 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
941 if (CU_Nodes) {
Devang Patelc981f622011-05-04 16:34:02 +0000942
943 NamedMDNode *GV_Nodes = M->getNamedMetadata("llvm.dbg.gv");
944 NamedMDNode *SP_Nodes = M->getNamedMetadata("llvm.dbg.sp");
945 if (!GV_Nodes && !SP_Nodes)
946 // If there are not any global variables or any functions then
947 // there is not any debug info in this module.
Devang Patele02e5852011-05-03 16:45:22 +0000948 return;
949
Devang Patelc981f622011-05-04 16:34:02 +0000950 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i)
951 constructCompileUnit(CU_Nodes->getOperand(i));
Devang Patele02e5852011-05-03 16:45:22 +0000952
Devang Patelc981f622011-05-04 16:34:02 +0000953 if (GV_Nodes)
954 for (unsigned i = 0, e = GV_Nodes->getNumOperands(); i != e; ++i)
955 constructGlobalVariableDIE(GV_Nodes->getOperand(i));
956
957 if (SP_Nodes)
958 for (unsigned i = 0, e = SP_Nodes->getNumOperands(); i != e; ++i)
959 constructSubprogramDIE(SP_Nodes->getOperand(i));
Devang Patele02e5852011-05-03 16:45:22 +0000960
961 } else {
962
963 DebugInfoFinder DbgFinder;
964 DbgFinder.processModule(*M);
965
Devang Patelc981f622011-05-04 16:34:02 +0000966 bool HasDebugInfo = false;
Nick Lewycky019d2552011-07-29 03:49:23 +0000967 // Scan all the compile-units to see if there are any marked as the main
968 // unit. If not, we do not generate debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000969 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
970 E = DbgFinder.compile_unit_end(); I != E; ++I) {
971 if (DICompileUnit(*I).isMain()) {
972 HasDebugInfo = true;
973 break;
974 }
975 }
Devang Patelc981f622011-05-04 16:34:02 +0000976 if (!HasDebugInfo) return;
Devang Patele02e5852011-05-03 16:45:22 +0000977
978 // Create all the compile unit DIEs.
979 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
980 E = DbgFinder.compile_unit_end(); I != E; ++I)
981 constructCompileUnit(*I);
982
983 // Create DIEs for each global variable.
984 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
985 E = DbgFinder.global_variable_end(); I != E; ++I)
986 constructGlobalVariableDIE(*I);
987
988 // Create DIEs for each subprogram.
989 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
990 E = DbgFinder.subprogram_end(); I != E; ++I)
991 constructSubprogramDIE(*I);
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000992 }
Devang Patele02e5852011-05-03 16:45:22 +0000993
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000994 // Tell MMI that we have debug info.
995 MMI->setDebugInfoAvailability(true);
Devang Patele02e5852011-05-03 16:45:22 +0000996
Chris Lattnerd442aa32010-04-04 23:17:54 +0000997 // Emit initial sections.
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000998 EmitSectionLabels();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000999
Devang Patel8e06a5e2010-08-10 20:01:20 +00001000 //getOrCreateTypeDIE
1001 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
Devang Patelf20c4f72011-04-12 22:53:02 +00001002 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1003 DIType Ty(NMD->getOperand(i));
1004 getCompileUnit(Ty)->getOrCreateTypeDIE(Ty);
1005 }
Devang Patel8e06a5e2010-08-10 20:01:20 +00001006
Devang Patel7a554812010-09-28 18:08:20 +00001007 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
Devang Patelf20c4f72011-04-12 22:53:02 +00001008 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1009 DIType Ty(NMD->getOperand(i));
1010 getCompileUnit(Ty)->getOrCreateTypeDIE(Ty);
1011 }
Devang Patel7a554812010-09-28 18:08:20 +00001012
Bill Wendling2b128d72009-05-20 23:19:06 +00001013 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +00001014 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +00001015}
1016
Devang Patel930143b2009-11-21 02:48:08 +00001017/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendling2b128d72009-05-20 23:19:06 +00001018///
Devang Patel930143b2009-11-21 02:48:08 +00001019void DwarfDebug::endModule() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001020 if (!FirstCU) return;
Devang Patelf3b2db62010-06-28 18:25:03 +00001021 const Module *M = MMI->getModule();
Devang Patel7e623022011-08-10 20:55:27 +00001022 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
Devang Patelf3b2db62010-06-28 18:25:03 +00001023 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
1024 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
1025 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
1026 DISubprogram SP(AllSPs->getOperand(SI));
1027 if (!SP.Verify()) continue;
1028
1029 // Collect info for variables that were optimized out.
Devang Patel18efced2010-07-19 17:53:55 +00001030 if (!SP.isDefinition()) continue;
Devang Patelf3b2db62010-06-28 18:25:03 +00001031 StringRef FName = SP.getLinkageName();
1032 if (FName.empty())
1033 FName = SP.getName();
Devang Patel364bf042010-11-10 22:19:21 +00001034 NamedMDNode *NMD = getFnSpecificMDNode(*(MMI->getModule()), FName);
Devang Patelf3b2db62010-06-28 18:25:03 +00001035 if (!NMD) continue;
1036 unsigned E = NMD->getNumOperands();
1037 if (!E) continue;
Devang Patel7e623022011-08-10 20:55:27 +00001038 LexicalScope *Scope = new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
Devang Pateld0701282010-08-02 17:32:15 +00001039 DeadFnScopeMap[SP] = Scope;
Devang Patel7e623022011-08-10 20:55:27 +00001040 SmallVector<DbgVariable *, 8> Variables;
Devang Patelf3b2db62010-06-28 18:25:03 +00001041 for (unsigned I = 0; I != E; ++I) {
1042 DIVariable DV(NMD->getOperand(I));
1043 if (!DV.Verify()) continue;
Devang Patel7e623022011-08-10 20:55:27 +00001044 Variables.push_back(new DbgVariable(DV));
Devang Patelf3b2db62010-06-28 18:25:03 +00001045 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001046
Devang Patelf3b2db62010-06-28 18:25:03 +00001047 // Construct subprogram DIE and add variables DIEs.
1048 constructSubprogramDIE(SP);
1049 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patelf3b2db62010-06-28 18:25:03 +00001050 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel7e623022011-08-10 20:55:27 +00001051 if (DIE *VariableDIE = constructVariableDIE(Variables[i], Scope))
Devang Patelf3b2db62010-06-28 18:25:03 +00001052 ScopeDIE->addChild(VariableDIE);
1053 }
1054 }
1055 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001056
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001057 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1058 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
1059 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
1060 DIE *ISP = *AI;
Devang Patelf20c4f72011-04-12 22:53:02 +00001061 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001062 }
1063
Devang Patel32cc43c2010-05-07 20:54:48 +00001064 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Pateleb57c592009-12-03 19:11:07 +00001065 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
1066 DIE *SPDie = CI->first;
Devang Patel32cc43c2010-05-07 20:54:48 +00001067 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Pateleb57c592009-12-03 19:11:07 +00001068 if (!N) continue;
Devang Patel1a0df9a2010-05-10 22:49:55 +00001069 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Pateleb57c592009-12-03 19:11:07 +00001070 if (!NDie) continue;
Devang Patelf20c4f72011-04-12 22:53:02 +00001071 getCompileUnit(N)->addDIEEntry(SPDie, dwarf::DW_AT_containing_type,
1072 dwarf::DW_FORM_ref4, NDie);
Devang Pateleb57c592009-12-03 19:11:07 +00001073 }
1074
Bill Wendling2b128d72009-05-20 23:19:06 +00001075 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001076 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnera179b522010-04-04 19:25:43 +00001077 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001078 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnera179b522010-04-04 19:25:43 +00001079 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +00001080
1081 // End text sections.
1082 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001083 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnera179b522010-04-04 19:25:43 +00001084 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendling2b128d72009-05-20 23:19:06 +00001085 }
1086
Bill Wendling2b128d72009-05-20 23:19:06 +00001087 // Compute DIE offsets and sizes.
Devang Patel930143b2009-11-21 02:48:08 +00001088 computeSizeAndOffsets();
Bill Wendling2b128d72009-05-20 23:19:06 +00001089
1090 // Emit all the DIEs into a debug info section
Devang Patel930143b2009-11-21 02:48:08 +00001091 emitDebugInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001092
1093 // Corresponding abbreviations into a abbrev section.
Devang Patel930143b2009-11-21 02:48:08 +00001094 emitAbbreviations();
Bill Wendling2b128d72009-05-20 23:19:06 +00001095
Bill Wendling2b128d72009-05-20 23:19:06 +00001096 // Emit info into a debug pubnames section.
Devang Patel930143b2009-11-21 02:48:08 +00001097 emitDebugPubNames();
Bill Wendling2b128d72009-05-20 23:19:06 +00001098
Devang Patel04d2f2d2009-11-24 01:14:22 +00001099 // Emit info into a debug pubtypes section.
1100 emitDebugPubTypes();
1101
Bill Wendling2b128d72009-05-20 23:19:06 +00001102 // Emit info into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00001103 emitDebugLoc();
Bill Wendling2b128d72009-05-20 23:19:06 +00001104
1105 // Emit info into a debug aranges section.
1106 EmitDebugARanges();
1107
1108 // Emit info into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00001109 emitDebugRanges();
Bill Wendling2b128d72009-05-20 23:19:06 +00001110
1111 // Emit info into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00001112 emitDebugMacInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001113
1114 // Emit inline info.
Devang Patel930143b2009-11-21 02:48:08 +00001115 emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001116
Chris Lattnerb7aa9522010-03-13 02:17:42 +00001117 // Emit info into a debug str section.
1118 emitDebugStr();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001119
Devang Pateld0701282010-08-02 17:32:15 +00001120 // clean up.
1121 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001122 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1123 E = CUMap.end(); I != E; ++I)
1124 delete I->second;
1125 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendling2b128d72009-05-20 23:19:06 +00001126}
1127
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001128/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Devang Patele30746c2011-08-10 21:16:49 +00001129DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattner915c5f92010-04-02 19:42:39 +00001130 DebugLoc ScopeLoc) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001131
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001132 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001133 if (AbsDbgVariable)
1134 return AbsDbgVariable;
1135
Devang Patele30746c2011-08-10 21:16:49 +00001136 LLVMContext &Ctx = Var->getContext();
Devang Patel7e623022011-08-10 20:55:27 +00001137 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001138 if (!Scope)
1139 return NULL;
1140
Devang Patele1c53f22010-05-20 16:36:41 +00001141 AbsDbgVariable = new DbgVariable(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001142 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001143 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001144 return AbsDbgVariable;
1145}
1146
Nick Lewycky019d2552011-07-29 03:49:23 +00001147/// addCurrentFnArgument - If Var is a current function argument then add
1148/// it to CurrentFnArguments list.
Devang Patel6c622ef2011-03-01 22:58:55 +00001149bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patel7e623022011-08-10 20:55:27 +00001150 DbgVariable *Var, LexicalScope *Scope) {
1151 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +00001152 return false;
1153 DIVariable DV = Var->getVariable();
1154 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1155 return false;
1156 unsigned ArgNo = DV.getArgNumber();
1157 if (ArgNo == 0)
1158 return false;
1159
Devang Patel4ab660b2011-03-03 20:02:02 +00001160 size_t Size = CurrentFnArguments.size();
1161 if (Size == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001162 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001163 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001164 // arguments does the function have at source level.
1165 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001166 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001167 CurrentFnArguments[ArgNo - 1] = Var;
1168 return true;
1169}
1170
Devang Patel490c8ab2010-05-20 19:57:06 +00001171/// collectVariableInfoFromMMITable - Collect variable information from
1172/// side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001173void
Nick Lewycky019d2552011-07-29 03:49:23 +00001174DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patel490c8ab2010-05-20 19:57:06 +00001175 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001176 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1177 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1178 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001179 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001180 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001181 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001182 DIVariable DV(Var);
1183 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001184
Devang Patel7e623022011-08-10 20:55:27 +00001185 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001186
Devang Patelcdb7d442009-11-10 23:20:04 +00001187 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001188 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001189 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001190
Devang Patele1c53f22010-05-20 16:36:41 +00001191 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
1192 DbgVariable *RegVar = new DbgVariable(DV);
1193 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel6c622ef2011-03-01 22:58:55 +00001194 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001195 addScopeVariable(Scope, RegVar);
Devang Patele1c53f22010-05-20 16:36:41 +00001196 if (AbsDbgVariable) {
1197 recordVariableFrameIndex(AbsDbgVariable, VP.first);
1198 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
1199 }
Devang Patel475d32a2009-10-06 01:26:37 +00001200 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001201}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001202
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001203/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +00001204/// DBG_VALUE instruction, is in a defined reg.
1205static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
1206 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001207 return MI->getNumOperands() == 3 &&
1208 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
1209 MI->getOperand(1).isImm() && MI->getOperand(1).getImm() == 0;
Devang Patel9fc11702010-05-25 23:40:22 +00001210}
1211
Nick Lewycky019d2552011-07-29 03:49:23 +00001212/// getDebugLocEntry - Get .debug_loc entry for the instruction range starting
Devang Patel2442a892011-07-08 17:09:57 +00001213/// at MI.
1214static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1215 const MCSymbol *FLabel,
1216 const MCSymbol *SLabel,
1217 const MachineInstr *MI) {
1218 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1219
1220 if (MI->getNumOperands() != 3) {
1221 MachineLocation MLoc = Asm->getDebugValueLocation(MI);
1222 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1223 }
1224 if (MI->getOperand(0).isReg() && MI->getOperand(1).isImm()) {
1225 MachineLocation MLoc;
1226 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
1227 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1228 }
1229 if (MI->getOperand(0).isImm())
1230 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1231 if (MI->getOperand(0).isFPImm())
1232 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1233 if (MI->getOperand(0).isCImm())
1234 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1235
1236 assert (0 && "Unexpected 3 operand DBG_VALUE instruction!");
1237 return DotDebugLocEntry();
1238}
1239
Devang Patel7e623022011-08-10 20:55:27 +00001240/// collectVariableInfo - Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001241void
Devang Patel5c0f85c2010-06-25 22:07:34 +00001242DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1243 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001244
Devang Patel490c8ab2010-05-20 19:57:06 +00001245 /// collection info from MMI table.
1246 collectVariableInfoFromMMITable(MF, Processed);
1247
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001248 for (SmallVectorImpl<const MDNode*>::const_iterator
1249 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1250 ++UVI) {
1251 const MDNode *Var = *UVI;
1252 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001253 continue;
1254
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001255 // History contains relevant DBG_VALUE instructions for Var and instructions
1256 // clobbering it.
1257 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1258 if (History.empty())
1259 continue;
1260 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001261
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001262 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +00001263 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001264 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1265 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +00001266 Scope = LScopes.getCurrentFunctionScope();
Devang Patel8fb9fd62011-07-20 22:18:50 +00001267 else {
1268 if (DV.getVersion() <= LLVMDebugVersion9)
Devang Patel7e623022011-08-10 20:55:27 +00001269 Scope = LScopes.findLexicalScope(MInsn->getDebugLoc());
Devang Patel8fb9fd62011-07-20 22:18:50 +00001270 else {
1271 if (MDNode *IA = DV.getInlinedAt())
Devang Patel7e623022011-08-10 20:55:27 +00001272 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
Devang Patel8fb9fd62011-07-20 22:18:50 +00001273 else
Devang Patel7e623022011-08-10 20:55:27 +00001274 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel8fb9fd62011-07-20 22:18:50 +00001275 }
1276 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001277 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001278 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001279 continue;
1280
1281 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001282 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel490c8ab2010-05-20 19:57:06 +00001283 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patel6c622ef2011-03-01 22:58:55 +00001284 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +00001285 addScopeVariable(Scope, RegVar);
Devang Patelfbd6c452010-05-21 00:10:20 +00001286 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
1287 DbgVariableToDbgInstMap[AbsVar] = MInsn;
1288 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patela3e9c9c2010-03-15 18:33:46 +00001289 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001290
1291 // Simple ranges that are fully coalesced.
1292 if (History.size() <= 1 || (History.size() == 2 &&
1293 MInsn->isIdenticalTo(History.back()))) {
Devang Patel9fc11702010-05-25 23:40:22 +00001294 DbgVariableToDbgInstMap[RegVar] = MInsn;
1295 continue;
1296 }
1297
1298 // handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001299 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001300
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001301 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1302 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1303 const MachineInstr *Begin = *HI;
1304 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001305
Devang Patele7181b52011-06-01 23:00:17 +00001306 // Check if DBG_VALUE is truncating a range.
1307 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1308 && !Begin->getOperand(0).getReg())
1309 continue;
1310
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001311 // Compute the range for a register location.
1312 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1313 const MCSymbol *SLabel = 0;
1314
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001315 if (HI + 1 == HE)
1316 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001317 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001318 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001319 else {
1320 const MachineInstr *End = HI[1];
Devang Patel53b050a2011-07-07 21:44:42 +00001321 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
1322 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001323 if (End->isDebugValue())
1324 SLabel = getLabelBeforeInsn(End);
1325 else {
1326 // End is a normal instruction clobbering the range.
1327 SLabel = getLabelAfterInsn(End);
1328 assert(SLabel && "Forgot label after clobber instruction");
1329 ++HI;
1330 }
1331 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001332
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001333 // The value is valid until the next DBG_VALUE or clobber.
Devang Patel2442a892011-07-08 17:09:57 +00001334 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel, Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001335 }
1336 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001337 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001338
1339 // Collect info for variables that were optimized out.
Devang Patelad517352010-06-22 01:01:58 +00001340 const Function *F = MF->getFunction();
Devang Patel364bf042010-11-10 22:19:21 +00001341 if (NamedMDNode *NMD = getFnSpecificMDNode(*(F->getParent()), F->getName())) {
Devang Patele0a94bf2010-05-14 21:01:35 +00001342 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00001343 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel490c8ab2010-05-20 19:57:06 +00001344 if (!DV || !Processed.insert(DV))
Devang Patele0a94bf2010-05-14 21:01:35 +00001345 continue;
Devang Patel7e623022011-08-10 20:55:27 +00001346 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1347 addScopeVariable(Scope, new DbgVariable(DV));
Devang Patele0a94bf2010-05-14 21:01:35 +00001348 }
1349 }
Devang Patel9fc11702010-05-25 23:40:22 +00001350}
Devang Patele0a94bf2010-05-14 21:01:35 +00001351
Devang Patel9fc11702010-05-25 23:40:22 +00001352/// getLabelBeforeInsn - Return Label preceding the instruction.
1353const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001354 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1355 assert(Label && "Didn't insert label before instruction");
1356 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001357}
1358
1359/// getLabelAfterInsn - Return Label immediately following the instruction.
1360const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001361 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001362}
1363
Devang Patelb5694e72010-10-26 17:49:02 +00001364/// beginInstruction - Process beginning of an instruction.
1365void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001366 // Check if source location changes, but ignore DBG_VALUE locations.
1367 if (!MI->isDebugValue()) {
1368 DebugLoc DL = MI->getDebugLoc();
1369 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Devang Patel34a66202011-05-11 19:22:19 +00001370 unsigned Flags = DWARF2_FLAG_IS_STMT;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001371 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001372 if (DL == PrologEndLoc) {
1373 Flags |= DWARF2_FLAG_PROLOGUE_END;
1374 PrologEndLoc = DebugLoc();
1375 }
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001376 if (!DL.isUnknown()) {
1377 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001378 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001379 } else
Devang Patel34a66202011-05-11 19:22:19 +00001380 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001381 }
Devang Patel9fc11702010-05-25 23:40:22 +00001382 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001383
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001384 // Insert labels where requested.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001385 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1386 LabelsBeforeInsn.find(MI);
1387
1388 // No label needed.
1389 if (I == LabelsBeforeInsn.end())
1390 return;
1391
1392 // Label already assigned.
1393 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001394 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001395
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001396 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001397 PrevLabel = MMI->getContext().CreateTempSymbol();
1398 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001399 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001400 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001401}
1402
Devang Patelb5694e72010-10-26 17:49:02 +00001403/// endInstruction - Process end of an instruction.
1404void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001405 // Don't create a new label after DBG_VALUE instructions.
1406 // They don't generate code.
1407 if (!MI->isDebugValue())
1408 PrevLabel = 0;
1409
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001410 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1411 LabelsAfterInsn.find(MI);
1412
1413 // No label needed.
1414 if (I == LabelsAfterInsn.end())
1415 return;
1416
1417 // Label already assigned.
1418 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001419 return;
1420
1421 // We need a label after this instruction.
1422 if (!PrevLabel) {
1423 PrevLabel = MMI->getContext().CreateTempSymbol();
1424 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001425 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001426 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001427}
1428
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001429/// identifyScopeMarkers() -
Devang Patel7e623022011-08-10 20:55:27 +00001430/// Each LexicalScope has first instruction and last instruction to mark beginning
Devang Patel6c74a872010-04-27 19:46:33 +00001431/// and end of a scope respectively. Create an inverse map that list scopes
1432/// starts (and ends) with an instruction. One instruction may start (or end)
1433/// multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001434void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001435 SmallVector<LexicalScope *, 4> WorkList;
1436 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001437 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001438 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001439
Devang Patel7e623022011-08-10 20:55:27 +00001440 const SmallVector<LexicalScope *, 4> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001441 if (!Children.empty())
Devang Patel7e623022011-08-10 20:55:27 +00001442 for (SmallVector<LexicalScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00001443 SE = Children.end(); SI != SE; ++SI)
1444 WorkList.push_back(*SI);
1445
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001446 if (S->isAbstractScope())
1447 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001448
Devang Patel7e623022011-08-10 20:55:27 +00001449 const SmallVector<InsnRange, 4> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001450 if (Ranges.empty())
1451 continue;
Devang Patel7e623022011-08-10 20:55:27 +00001452 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +00001453 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001454 assert(RI->first && "InsnRange does not have first instruction!");
1455 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001456 requestLabelBeforeInsn(RI->first);
1457 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001458 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001459 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001460}
1461
Devang Patel589845d2011-05-09 22:14:49 +00001462/// getScopeNode - Get MDNode for DebugLoc's scope.
1463static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1464 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1465 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1466 return DL.getScope(Ctx);
1467}
1468
Devang Patel34a66202011-05-11 19:22:19 +00001469/// getFnDebugLoc - Walk up the scope chain of given debug loc and find
1470/// line number info for the function.
1471static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1472 const MDNode *Scope = getScopeNode(DL, Ctx);
1473 DISubprogram SP = getDISubprogram(Scope);
1474 if (SP.Verify())
1475 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1476 return DebugLoc();
1477}
1478
Devang Patel930143b2009-11-21 02:48:08 +00001479/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendling2b128d72009-05-20 23:19:06 +00001480/// emitted immediately after the function entry point.
Chris Lattner76555b52010-01-26 23:18:02 +00001481void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00001482 if (!MMI->hasDebugInfo()) return;
Devang Patel7e623022011-08-10 20:55:27 +00001483 LScopes.initialize(*MF);
1484 if (LScopes.empty()) return;
1485 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001486
Devang Patel6c74a872010-04-27 19:46:33 +00001487 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1488 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001489 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001490 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001491
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001492 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1493
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001494 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001495 /// LiveUserVar - Map physreg numbers to the MDNode they contain.
1496 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1497
Devang Patel002d54d2010-05-26 19:37:24 +00001498 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001499 I != E; ++I) {
1500 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001501 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1502 II != IE; ++II) {
1503 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001504
Devang Patel002d54d2010-05-26 19:37:24 +00001505 if (MI->isDebugValue()) {
Devang Patel002d54d2010-05-26 19:37:24 +00001506 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001507
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001508 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001509 const MDNode *Var =
1510 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001511
1512 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001513 if (isDbgValueInDefinedReg(MI))
1514 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1515
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001516 // Check the history of this variable.
1517 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1518 if (History.empty()) {
1519 UserVariables.push_back(Var);
1520 // The first mention of a function argument gets the FunctionBeginSym
1521 // label, so arguments are visible when breaking at function entry.
1522 DIVariable DV(Var);
1523 if (DV.Verify() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1524 DISubprogram(getDISubprogram(DV.getContext()))
1525 .describes(MF->getFunction()))
1526 LabelsBeforeInsn[MI] = FunctionBeginSym;
1527 } else {
1528 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1529 const MachineInstr *Prev = History.back();
1530 if (Prev->isDebugValue()) {
1531 // Coalesce identical entries at the end of History.
1532 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001533 Prev->isIdenticalTo(History[History.size() - 2])) {
1534 DEBUG(dbgs() << "Coalesce identical DBG_VALUE entries:\n"
1535 << "\t" << *Prev
1536 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001537 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001538 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001539
1540 // Terminate old register assignments that don't reach MI;
1541 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1542 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1543 isDbgValueInDefinedReg(Prev)) {
1544 // Previous register assignment needs to terminate at the end of
1545 // its basic block.
1546 MachineBasicBlock::const_iterator LastMI =
1547 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001548 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001549 // Drop DBG_VALUE for empty range.
Devang Patelb7a328e2011-07-07 00:14:27 +00001550 DEBUG(dbgs() << "Drop DBG_VALUE for empty range:\n"
1551 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001552 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001553 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001554 else {
1555 // Terminate after LastMI.
1556 History.push_back(LastMI);
1557 }
1558 }
1559 }
1560 }
1561 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001562 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001563 // Not a DBG_VALUE instruction.
1564 if (!MI->isLabel())
1565 AtBlockEntry = false;
1566
Devang Patel34a66202011-05-11 19:22:19 +00001567 // First known non DBG_VALUE location marks beginning of function
1568 // body.
1569 if (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown())
1570 PrologEndLoc = MI->getDebugLoc();
1571
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001572 // Check if the instruction clobbers any registers with debug vars.
1573 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1574 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1575 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1576 continue;
1577 for (const unsigned *AI = TRI->getOverlaps(MOI->getReg());
1578 unsigned Reg = *AI; ++AI) {
1579 const MDNode *Var = LiveUserVar[Reg];
1580 if (!Var)
1581 continue;
1582 // Reg is now clobbered.
1583 LiveUserVar[Reg] = 0;
1584
1585 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001586 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1587 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001588 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001589 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1590 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001591 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001592 const MachineInstr *Prev = History.back();
1593 // Sanity-check: Register assignments are terminated at the end of
1594 // their block.
1595 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1596 continue;
1597 // Is the variable still in Reg?
1598 if (!isDbgValueInDefinedReg(Prev) ||
1599 Prev->getOperand(0).getReg() != Reg)
1600 continue;
1601 // Var is clobbered. Make sure the next instruction gets a label.
1602 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001603 }
1604 }
Devang Patel002d54d2010-05-26 19:37:24 +00001605 }
Devang Patel002d54d2010-05-26 19:37:24 +00001606 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001607 }
1608
1609 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1610 I != E; ++I) {
1611 SmallVectorImpl<const MachineInstr*> &History = I->second;
1612 if (History.empty())
1613 continue;
1614
1615 // Make sure the final register assignments are terminated.
1616 const MachineInstr *Prev = History.back();
1617 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1618 const MachineBasicBlock *PrevMBB = Prev->getParent();
1619 MachineBasicBlock::const_iterator LastMI = PrevMBB->getLastNonDebugInstr();
1620 if (LastMI == PrevMBB->end())
1621 // Drop DBG_VALUE for empty range.
1622 History.pop_back();
1623 else {
1624 // Terminate after LastMI.
1625 History.push_back(LastMI);
1626 }
1627 }
1628 // Request labels for the full history.
1629 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1630 const MachineInstr *MI = History[i];
1631 if (MI->isDebugValue())
1632 requestLabelBeforeInsn(MI);
1633 else
1634 requestLabelAfterInsn(MI);
1635 }
1636 }
Devang Patel002d54d2010-05-26 19:37:24 +00001637
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001638 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001639 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001640
1641 // Record beginning of function.
1642 if (!PrologEndLoc.isUnknown()) {
1643 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1644 MF->getFunction()->getContext());
1645 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1646 FnStartDL.getScope(MF->getFunction()->getContext()),
1647 DWARF2_FLAG_IS_STMT);
1648 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001649}
1650
Devang Patel7e623022011-08-10 20:55:27 +00001651void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1652// SmallVector<DbgVariable *, 8> &Vars = ScopeVariables.lookup(LS);
1653 ScopeVariables[LS].push_back(Var);
1654// Vars.push_back(Var);
1655}
1656
Devang Patel930143b2009-11-21 02:48:08 +00001657/// endFunction - Gather and emit post-function debug information.
Bill Wendling2b128d72009-05-20 23:19:06 +00001658///
Chris Lattner76555b52010-01-26 23:18:02 +00001659void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patel7e623022011-08-10 20:55:27 +00001660 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00001661
Devang Patel7e623022011-08-10 20:55:27 +00001662 // Define end label for subprogram.
1663 FunctionEndSym = Asm->GetTempSymbol("func_end",
1664 Asm->getFunctionNumber());
1665 // Assumes in correct section after the entry point.
1666 Asm->OutStreamer.EmitLabel(FunctionEndSym);
1667
1668 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1669 collectVariableInfo(MF, ProcessedVars);
1670
1671 // Construct abstract scopes.
1672 SmallVector<LexicalScope *, 4> &AList = LScopes.getAbstractScopesList();
1673 for (SmallVector<LexicalScope *, 4>::iterator AI = AList.begin(),
1674 AE = AList.end(); AI != AE; ++AI) {
1675 DISubprogram SP((*AI)->getScopeNode());
1676 if (SP.Verify()) {
1677 // Collect info for variables that were optimized out.
1678 StringRef FName = SP.getLinkageName();
1679 if (FName.empty())
1680 FName = SP.getName();
1681 if (NamedMDNode *NMD =
1682 getFnSpecificMDNode(*(MF->getFunction()->getParent()), FName)) {
1683 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00001684 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001685 if (!DV || !ProcessedVars.insert(DV))
1686 continue;
Devang Patel7e623022011-08-10 20:55:27 +00001687 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1688 addScopeVariable(Scope, new DbgVariable(DV));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001689 }
1690 }
1691 }
Devang Patel7e623022011-08-10 20:55:27 +00001692 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
1693 constructScopeDIE(*AI);
Bill Wendling2b128d72009-05-20 23:19:06 +00001694 }
Devang Patel7e623022011-08-10 20:55:27 +00001695
1696 DIE *CurFnDIE = constructScopeDIE(LScopes.getCurrentFunctionScope());
1697
1698 if (!DisableFramePointerElim(*MF)) {
1699 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1700 getCompileUnit(FnScope->getScopeNode())->addUInt(CurFnDIE,
1701 dwarf::DW_AT_APPLE_omit_frame_ptr,
1702 dwarf::DW_FORM_flag, 1);
1703 }
1704 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
1705 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00001706
Bill Wendling2b128d72009-05-20 23:19:06 +00001707 // Clear debug info
Devang Patel7e623022011-08-10 20:55:27 +00001708 for (DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >::iterator
1709 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1710 DeleteContainerPointers(I->second);
1711 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001712 DeleteContainerPointers(CurrentFnArguments);
Devang Patele1c53f22010-05-20 16:36:41 +00001713 DbgVariableToFrameIndexMap.clear();
1714 VarToAbstractVarMap.clear();
1715 DbgVariableToDbgInstMap.clear();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001716 UserVariables.clear();
1717 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001718 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001719 LabelsBeforeInsn.clear();
1720 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001721 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001722}
1723
Devang Patele1c53f22010-05-20 16:36:41 +00001724/// recordVariableFrameIndex - Record a variable's index.
1725void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
1726 assert (V && "Invalid DbgVariable!");
1727 DbgVariableToFrameIndexMap[V] = Index;
1728}
1729
1730/// findVariableFrameIndex - Return true if frame index for the variable
1731/// is found. Update FI to hold value of the index.
1732bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
1733 assert (V && "Invalid DbgVariable!");
1734 DenseMap<const DbgVariable *, int>::iterator I =
1735 DbgVariableToFrameIndexMap.find(V);
1736 if (I == DbgVariableToFrameIndexMap.end())
1737 return false;
1738 *FI = I->second;
1739 return true;
1740}
1741
Chris Lattnerba35a672010-03-09 04:54:43 +00001742/// recordSourceLine - Register a source line with debug info. Returns the
1743/// unique label that was emitted and which provides correspondence to
1744/// the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00001745void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1746 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00001747 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00001748 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00001749 unsigned Src = 1;
1750 if (S) {
1751 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00001752
Dan Gohman50849c62010-05-05 23:41:32 +00001753 if (Scope.isCompileUnit()) {
1754 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001755 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001756 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00001757 } else if (Scope.isFile()) {
1758 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00001759 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001760 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001761 } else if (Scope.isSubprogram()) {
1762 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001763 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001764 Dir = SP.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001765 } else if (Scope.isLexicalBlock()) {
1766 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001767 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001768 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001769 } else
1770 assert(0 && "Unexpected scope info");
1771
Devang Patele01b75c2011-03-24 20:30:50 +00001772 Src = GetOrCreateSourceID(Fn, Dir);
Dan Gohman50849c62010-05-05 23:41:32 +00001773 }
Nick Lewycky019d2552011-07-29 03:49:23 +00001774 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00001775}
1776
Bill Wendling806535f2009-05-20 23:22:40 +00001777//===----------------------------------------------------------------------===//
1778// Emit Methods
1779//===----------------------------------------------------------------------===//
1780
Devang Patel930143b2009-11-21 02:48:08 +00001781/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling480ff322009-05-20 23:21:38 +00001782///
Jim Grosbach00e9c612009-11-22 19:20:36 +00001783unsigned
1784DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling480ff322009-05-20 23:21:38 +00001785 // Get the children.
1786 const std::vector<DIE *> &Children = Die->getChildren();
1787
1788 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00001789 if (!Last && !Children.empty())
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001790 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling480ff322009-05-20 23:21:38 +00001791
1792 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00001793 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00001794
1795 // Get the abbreviation for this DIE.
1796 unsigned AbbrevNumber = Die->getAbbrevNumber();
1797 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1798
1799 // Set DIE offset
1800 Die->setOffset(Offset);
1801
1802 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00001803 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001804
1805 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
1806 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1807
1808 // Size the DIE attribute values.
1809 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1810 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001811 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001812
1813 // Size the DIE children if any.
1814 if (!Children.empty()) {
1815 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1816 "Children flag not set");
1817
1818 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00001819 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling480ff322009-05-20 23:21:38 +00001820
1821 // End of children marker.
1822 Offset += sizeof(int8_t);
1823 }
1824
1825 Die->setSize(Offset - Die->getOffset());
1826 return Offset;
1827}
1828
Devang Patel930143b2009-11-21 02:48:08 +00001829/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling480ff322009-05-20 23:21:38 +00001830///
Devang Patel930143b2009-11-21 02:48:08 +00001831void DwarfDebug::computeSizeAndOffsets() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001832 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1833 E = CUMap.end(); I != E; ++I) {
1834 // Compute size of compile unit header.
Devang Patel28dce702011-04-12 23:10:47 +00001835 unsigned Offset =
Devang Patel1a0df9a2010-05-10 22:49:55 +00001836 sizeof(int32_t) + // Length of Compilation Unit Info
1837 sizeof(int16_t) + // DWARF version number
1838 sizeof(int32_t) + // Offset Into Abbrev. Section
1839 sizeof(int8_t); // Pointer Size (in bytes)
1840 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001841 }
Bill Wendling480ff322009-05-20 23:21:38 +00001842}
1843
Chris Lattner1fbf53b2010-04-04 23:02:02 +00001844/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
1845/// temporary label to it if SymbolStem is specified.
Chris Lattner6629ca92010-04-04 22:59:04 +00001846static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner1fbf53b2010-04-04 23:02:02 +00001847 const char *SymbolStem = 0) {
Chris Lattner6629ca92010-04-04 22:59:04 +00001848 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner1fbf53b2010-04-04 23:02:02 +00001849 if (!SymbolStem) return 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001850
Chris Lattner6629ca92010-04-04 22:59:04 +00001851 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
1852 Asm->OutStreamer.EmitLabel(TmpSym);
1853 return TmpSym;
1854}
1855
1856/// EmitSectionLabels - Emit initial Dwarf sections with a label at
1857/// the start of each one.
Chris Lattner46355d82010-04-04 22:33:59 +00001858void DwarfDebug::EmitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001859 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001860
Bill Wendling480ff322009-05-20 23:21:38 +00001861 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001862 DwarfInfoSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00001863 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001864 DwarfAbbrevSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00001865 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00001866 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001867
Chris Lattner6629ca92010-04-04 22:59:04 +00001868 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner1fbf53b2010-04-04 23:02:02 +00001869 EmitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00001870
Devang Patel4a213872010-08-24 00:06:12 +00001871 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00001872 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
1873 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
1874 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001875 DwarfStrSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00001876 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patel12563b32010-04-16 23:33:45 +00001877 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
1878 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00001879
Devang Patel9fc11702010-05-25 23:40:22 +00001880 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
1881 "section_debug_loc");
1882
Chris Lattner6629ca92010-04-04 22:59:04 +00001883 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattnere58b5472010-04-04 23:10:38 +00001884 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00001885}
1886
Nick Lewycky019d2552011-07-29 03:49:23 +00001887/// emitDIE - Recursively emits a debug information entry.
Bill Wendling480ff322009-05-20 23:21:38 +00001888///
Devang Patel930143b2009-11-21 02:48:08 +00001889void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00001890 // Get the abbreviation for this DIE.
1891 unsigned AbbrevNumber = Die->getAbbrevNumber();
1892 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1893
Bill Wendling480ff322009-05-20 23:21:38 +00001894 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00001895 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00001896 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
1897 Twine::utohexstr(Die->getOffset()) + ":0x" +
1898 Twine::utohexstr(Die->getSize()) + " " +
1899 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00001900 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001901
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00001902 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00001903 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1904
1905 // Emit the DIE attribute values.
1906 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1907 unsigned Attr = AbbrevData[i].getAttribute();
1908 unsigned Form = AbbrevData[i].getForm();
1909 assert(Form && "Too many attributes for DIE (check abbreviation)");
1910
Chris Lattner7bde8c02010-04-04 18:52:31 +00001911 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00001912 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001913
Bill Wendling480ff322009-05-20 23:21:38 +00001914 switch (Attr) {
1915 case dwarf::DW_AT_sibling:
Devang Patel930143b2009-11-21 02:48:08 +00001916 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00001917 break;
1918 case dwarf::DW_AT_abstract_origin: {
1919 DIEEntry *E = cast<DIEEntry>(Values[i]);
1920 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001921 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00001922 Asm->EmitInt32(Addr);
1923 break;
1924 }
Devang Patel12563b32010-04-16 23:33:45 +00001925 case dwarf::DW_AT_ranges: {
1926 // DW_AT_range Value encodes offset in debug_range section.
1927 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00001928
1929 if (Asm->MAI->doesDwarfUsesLabelOffsetForRanges()) {
1930 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
1931 V->getValue(),
1932 4);
1933 } else {
1934 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
1935 V->getValue(),
1936 DwarfDebugRangeSectionSym,
1937 4);
1938 }
Devang Patel12563b32010-04-16 23:33:45 +00001939 break;
1940 }
Devang Patel9fc11702010-05-25 23:40:22 +00001941 case dwarf::DW_AT_location: {
1942 if (UseDotDebugLocEntry.count(Die) != 0) {
1943 DIELabel *L = cast<DIELabel>(Values[i]);
Daniel Dunbarfd95b012011-03-16 22:16:39 +00001944 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Devang Patel9fc11702010-05-25 23:40:22 +00001945 } else
1946 Values[i]->EmitValue(Asm, Form);
1947 break;
1948 }
Devang Patela1bd5a12010-09-29 19:08:08 +00001949 case dwarf::DW_AT_accessibility: {
1950 if (Asm->isVerbose()) {
1951 DIEInteger *V = cast<DIEInteger>(Values[i]);
1952 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
1953 }
1954 Values[i]->EmitValue(Asm, Form);
1955 break;
1956 }
Bill Wendling480ff322009-05-20 23:21:38 +00001957 default:
1958 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001959 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00001960 break;
1961 }
Bill Wendling480ff322009-05-20 23:21:38 +00001962 }
1963
1964 // Emit the DIE children if any.
1965 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
1966 const std::vector<DIE *> &Children = Die->getChildren();
1967
1968 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00001969 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00001970
Chris Lattner7bde8c02010-04-04 18:52:31 +00001971 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00001972 Asm->OutStreamer.AddComment("End Of Children Mark");
1973 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00001974 }
1975}
1976
Devang Patel9ccfb642009-12-09 18:24:21 +00001977/// emitDebugInfo - Emit the debug info section.
Bill Wendling480ff322009-05-20 23:21:38 +00001978///
Devang Patel9ccfb642009-12-09 18:24:21 +00001979void DwarfDebug::emitDebugInfo() {
1980 // Start debug info section.
1981 Asm->OutStreamer.SwitchSection(
1982 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel1a0df9a2010-05-10 22:49:55 +00001983 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1984 E = CUMap.end(); I != E; ++I) {
1985 CompileUnit *TheCU = I->second;
1986 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001987
Devang Patel1a0df9a2010-05-10 22:49:55 +00001988 // Emit the compile units header.
1989 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
1990 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001991
Devang Patel1a0df9a2010-05-10 22:49:55 +00001992 // Emit size of content not including length itself
1993 unsigned ContentSize = Die->getSize() +
1994 sizeof(int16_t) + // DWARF version number
1995 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patele141234942011-04-13 19:41:17 +00001996 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001997
Devang Patel1a0df9a2010-05-10 22:49:55 +00001998 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
1999 Asm->EmitInt32(ContentSize);
2000 Asm->OutStreamer.AddComment("DWARF version number");
2001 Asm->EmitInt16(dwarf::DWARF_VERSION);
2002 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
2003 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
2004 DwarfAbbrevSectionSym);
2005 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2006 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002007
Devang Patel1a0df9a2010-05-10 22:49:55 +00002008 emitDIE(Die);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002009 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
2010 }
Bill Wendling480ff322009-05-20 23:21:38 +00002011}
2012
Devang Patel930143b2009-11-21 02:48:08 +00002013/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling480ff322009-05-20 23:21:38 +00002014///
Devang Patel930143b2009-11-21 02:48:08 +00002015void DwarfDebug::emitAbbreviations() const {
Bill Wendling480ff322009-05-20 23:21:38 +00002016 // Check to see if it is worth the effort.
2017 if (!Abbreviations.empty()) {
2018 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002019 Asm->OutStreamer.SwitchSection(
2020 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002021
Chris Lattnera179b522010-04-04 19:25:43 +00002022 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00002023
2024 // For each abbrevation.
2025 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2026 // Get abbreviation data
2027 const DIEAbbrev *Abbrev = Abbreviations[i];
2028
2029 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00002030 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00002031
2032 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002033 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00002034 }
2035
2036 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00002037 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00002038
Chris Lattnera179b522010-04-04 19:25:43 +00002039 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00002040 }
2041}
2042
Devang Patel930143b2009-11-21 02:48:08 +00002043/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling480ff322009-05-20 23:21:38 +00002044/// the line matrix.
2045///
Devang Patel930143b2009-11-21 02:48:08 +00002046void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00002047 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00002048 Asm->OutStreamer.AddComment("Extended Op");
2049 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002050
Chris Lattner566cae92010-03-09 23:52:58 +00002051 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00002052 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00002053 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2054 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2055
2056 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002057
Chris Lattnera179b522010-04-04 19:25:43 +00002058 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattner3a383cb2010-04-05 00:13:49 +00002059 Asm->getTargetData().getPointerSize(),
2060 0/*AddrSpace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00002061
2062 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00002063 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2064 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002065 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00002066 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002067}
2068
Devang Patel9ccfb642009-12-09 18:24:21 +00002069/// emitDebugPubNames - Emit visible names into a debug pubnames section.
2070///
2071void DwarfDebug::emitDebugPubNames() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002072 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2073 E = CUMap.end(); I != E; ++I) {
2074 CompileUnit *TheCU = I->second;
2075 // Start the dwarf pubnames section.
2076 Asm->OutStreamer.SwitchSection(
2077 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002078
Devang Patel1a0df9a2010-05-10 22:49:55 +00002079 Asm->OutStreamer.AddComment("Length of Public Names Info");
2080 Asm->EmitLabelDifference(
2081 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
2082 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002083
Devang Patel1a0df9a2010-05-10 22:49:55 +00002084 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
2085 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002086
Devang Patel1a0df9a2010-05-10 22:49:55 +00002087 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002088 Asm->EmitInt16(dwarf::DWARF_VERSION);
2089
Devang Patel1a0df9a2010-05-10 22:49:55 +00002090 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002091 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00002092 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002093
Devang Patel1a0df9a2010-05-10 22:49:55 +00002094 Asm->OutStreamer.AddComment("Compilation Unit Length");
2095 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
2096 Asm->GetTempSymbol("info_begin", TheCU->getID()),
2097 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002098
Devang Patel1a0df9a2010-05-10 22:49:55 +00002099 const StringMap<DIE*> &Globals = TheCU->getGlobals();
2100 for (StringMap<DIE*>::const_iterator
2101 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2102 const char *Name = GI->getKeyData();
2103 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002104
Devang Patel1a0df9a2010-05-10 22:49:55 +00002105 Asm->OutStreamer.AddComment("DIE offset");
2106 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002107
Devang Patel1a0df9a2010-05-10 22:49:55 +00002108 if (Asm->isVerbose())
2109 Asm->OutStreamer.AddComment("External Name");
2110 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
2111 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002112
Devang Patel1a0df9a2010-05-10 22:49:55 +00002113 Asm->OutStreamer.AddComment("End Mark");
2114 Asm->EmitInt32(0);
2115 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
Nick Lewycky019d2552011-07-29 03:49:23 +00002116 TheCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00002117 }
Bill Wendling480ff322009-05-20 23:21:38 +00002118}
2119
Devang Patel04d2f2d2009-11-24 01:14:22 +00002120void DwarfDebug::emitDebugPubTypes() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002121 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2122 E = CUMap.end(); I != E; ++I) {
2123 CompileUnit *TheCU = I->second;
2124 // Start the dwarf pubnames section.
2125 Asm->OutStreamer.SwitchSection(
2126 Asm->getObjFileLowering().getDwarfPubTypesSection());
2127 Asm->OutStreamer.AddComment("Length of Public Types Info");
2128 Asm->EmitLabelDifference(
2129 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
2130 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002131
Devang Patel1a0df9a2010-05-10 22:49:55 +00002132 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
2133 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002134
Devang Patel1a0df9a2010-05-10 22:49:55 +00002135 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
2136 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002137
Devang Patel1a0df9a2010-05-10 22:49:55 +00002138 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2139 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
2140 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002141
Devang Patel1a0df9a2010-05-10 22:49:55 +00002142 Asm->OutStreamer.AddComment("Compilation Unit Length");
2143 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
2144 Asm->GetTempSymbol("info_begin", TheCU->getID()),
2145 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002146
Devang Patel1a0df9a2010-05-10 22:49:55 +00002147 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
2148 for (StringMap<DIE*>::const_iterator
2149 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2150 const char *Name = GI->getKeyData();
Nick Lewycky019d2552011-07-29 03:49:23 +00002151 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002152
Devang Patel1a0df9a2010-05-10 22:49:55 +00002153 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
2154 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002155
Devang Patel1a0df9a2010-05-10 22:49:55 +00002156 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
2157 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
2158 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002159
Devang Patel1a0df9a2010-05-10 22:49:55 +00002160 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002161 Asm->EmitInt32(0);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002162 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
2163 TheCU->getID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00002164 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002165}
2166
Devang Patel930143b2009-11-21 02:48:08 +00002167/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling480ff322009-05-20 23:21:38 +00002168///
Devang Patel930143b2009-11-21 02:48:08 +00002169void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00002170 // Check to see if it is worth the effort.
Chris Lattner3d72a672010-03-09 23:38:23 +00002171 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002172
Chris Lattner3d72a672010-03-09 23:38:23 +00002173 // Start the dwarf str section.
2174 Asm->OutStreamer.SwitchSection(
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002175 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002176
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002177 // Get all of the string pool entries and put them in an array by their ID so
2178 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002179 SmallVector<std::pair<unsigned,
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002180 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002181
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002182 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
2183 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
2184 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002185
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002186 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002187
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002188 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002189 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002190 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002191
Chris Lattner3d72a672010-03-09 23:38:23 +00002192 // Emit the string itself.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002193 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00002194 }
2195}
2196
Devang Patel930143b2009-11-21 02:48:08 +00002197/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling480ff322009-05-20 23:21:38 +00002198///
Devang Patel930143b2009-11-21 02:48:08 +00002199void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002200 if (DotDebugLocEntries.empty())
2201 return;
2202
Devang Patel116a9d72011-02-04 22:57:18 +00002203 for (SmallVector<DotDebugLocEntry, 4>::iterator
2204 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2205 I != E; ++I) {
2206 DotDebugLocEntry &Entry = *I;
2207 if (I + 1 != DotDebugLocEntries.end())
2208 Entry.Merge(I+1);
2209 }
2210
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002211 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002212 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00002213 Asm->getObjFileLowering().getDwarfLocSection());
2214 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002215 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2216 unsigned index = 1;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002217 for (SmallVector<DotDebugLocEntry, 4>::iterator
2218 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002219 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002220 DotDebugLocEntry &Entry = *I;
2221 if (Entry.isMerged()) continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002222 if (Entry.isEmpty()) {
2223 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
2224 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002225 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002226 } else {
2227 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
2228 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
Devang Patel3e021532011-04-28 02:22:40 +00002229 DIVariable DV(Entry.Variable);
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002230 Asm->OutStreamer.AddComment("Loc expr size");
2231 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2232 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2233 Asm->EmitLabelDifference(end, begin, 2);
2234 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002235 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002236 DIBasicType BTy(DV.getType());
2237 if (BTy.Verify() &&
2238 (BTy.getEncoding() == dwarf::DW_ATE_signed
2239 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2240 Asm->OutStreamer.AddComment("DW_OP_consts");
2241 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002242 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002243 } else {
2244 Asm->OutStreamer.AddComment("DW_OP_constu");
2245 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002246 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002247 }
Devang Pateled9fd452011-07-08 16:49:43 +00002248 } else if (Entry.isLocation()) {
2249 if (!DV.hasComplexAddress())
2250 // Regular entry.
Devang Patel3e021532011-04-28 02:22:40 +00002251 Asm->EmitDwarfRegOp(Entry.Loc);
Devang Pateled9fd452011-07-08 16:49:43 +00002252 else {
2253 // Complex address entry.
2254 unsigned N = DV.getNumAddrElements();
2255 unsigned i = 0;
2256 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
2257 if (Entry.Loc.getOffset()) {
2258 i = 2;
2259 Asm->EmitDwarfRegOp(Entry.Loc);
2260 Asm->OutStreamer.AddComment("DW_OP_deref");
2261 Asm->EmitInt8(dwarf::DW_OP_deref);
2262 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2263 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2264 Asm->EmitSLEB128(DV.getAddrElement(1));
2265 } else {
2266 // If first address element is OpPlus then emit
2267 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
2268 MachineLocation Loc(Entry.Loc.getReg(), DV.getAddrElement(1));
2269 Asm->EmitDwarfRegOp(Loc);
2270 i = 2;
2271 }
2272 } else {
2273 Asm->EmitDwarfRegOp(Entry.Loc);
2274 }
2275
2276 // Emit remaining complex address elements.
2277 for (; i < N; ++i) {
2278 uint64_t Element = DV.getAddrElement(i);
2279 if (Element == DIBuilder::OpPlus) {
2280 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2281 Asm->EmitULEB128(DV.getAddrElement(++i));
2282 } else if (Element == DIBuilder::OpDeref)
2283 Asm->EmitInt8(dwarf::DW_OP_deref);
2284 else llvm_unreachable("unknown Opcode found in complex address");
2285 }
Devang Patel3e021532011-04-28 02:22:40 +00002286 }
Devang Patel3e021532011-04-28 02:22:40 +00002287 }
Devang Pateled9fd452011-07-08 16:49:43 +00002288 // else ... ignore constant fp. There is not any good way to
2289 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002290 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002291 }
2292 }
Bill Wendling480ff322009-05-20 23:21:38 +00002293}
2294
2295/// EmitDebugARanges - Emit visible names into a debug aranges section.
2296///
2297void DwarfDebug::EmitDebugARanges() {
2298 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002299 Asm->OutStreamer.SwitchSection(
2300 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002301}
2302
Devang Patel930143b2009-11-21 02:48:08 +00002303/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling480ff322009-05-20 23:21:38 +00002304///
Devang Patel930143b2009-11-21 02:48:08 +00002305void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002306 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002307 Asm->OutStreamer.SwitchSection(
Devang Patel12563b32010-04-16 23:33:45 +00002308 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Patel6c74a872010-04-27 19:46:33 +00002309 unsigned char Size = Asm->getTargetData().getPointerSize();
2310 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002311 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00002312 I != E; ++I) {
2313 if (*I)
2314 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patel12563b32010-04-16 23:33:45 +00002315 else
Devang Patel6c74a872010-04-27 19:46:33 +00002316 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel12563b32010-04-16 23:33:45 +00002317 }
Bill Wendling480ff322009-05-20 23:21:38 +00002318}
2319
Devang Patel930143b2009-11-21 02:48:08 +00002320/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling480ff322009-05-20 23:21:38 +00002321///
Devang Patel930143b2009-11-21 02:48:08 +00002322void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002323 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00002324 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00002325 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002326 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00002327 }
2328}
2329
Devang Patel930143b2009-11-21 02:48:08 +00002330/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling480ff322009-05-20 23:21:38 +00002331/// Section Header:
2332/// 1. length of section
2333/// 2. Dwarf version number
2334/// 3. address size.
2335///
2336/// Entries (one "entry" for each function that was inlined):
2337///
2338/// 1. offset into __debug_str section for MIPS linkage name, if exists;
2339/// otherwise offset into __debug_str for regular function name.
2340/// 2. offset into __debug_str section for regular function name.
2341/// 3. an unsigned LEB128 number indicating the number of distinct inlining
2342/// instances for the function.
2343///
2344/// The rest of the entry consists of a {die_offset, low_pc} pair for each
2345/// inlined instance; the die_offset points to the inlined_subroutine die in the
2346/// __debug_info section, and the low_pc is the starting address for the
2347/// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00002348void DwarfDebug::emitDebugInlineInfo() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00002349 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00002350 return;
2351
Devang Patel1a0df9a2010-05-10 22:49:55 +00002352 if (!FirstCU)
Bill Wendling480ff322009-05-20 23:21:38 +00002353 return;
2354
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002355 Asm->OutStreamer.SwitchSection(
2356 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002357
Chris Lattner566cae92010-03-09 23:52:58 +00002358 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00002359 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
2360 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00002361
Chris Lattnera179b522010-04-04 19:25:43 +00002362 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00002363
Chris Lattner566cae92010-03-09 23:52:58 +00002364 Asm->OutStreamer.AddComment("Dwarf Version");
2365 Asm->EmitInt16(dwarf::DWARF_VERSION);
2366 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattner3a383cb2010-04-05 00:13:49 +00002367 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002368
Devang Patel32cc43c2010-05-07 20:54:48 +00002369 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002370 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00002371
Devang Patel32cc43c2010-05-07 20:54:48 +00002372 const MDNode *Node = *I;
2373 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00002374 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002375 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00002376 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00002377 StringRef LName = SP.getLinkageName();
2378 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00002379
Chris Lattner566cae92010-03-09 23:52:58 +00002380 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00002381 if (LName.empty()) {
2382 Asm->OutStreamer.EmitBytes(Name, 0);
2383 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002384 } else
Chris Lattner70a4fce2010-04-04 23:25:33 +00002385 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
2386 DwarfStrSectionSym);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002387
Chris Lattner566cae92010-03-09 23:52:58 +00002388 Asm->OutStreamer.AddComment("Function name");
Chris Lattner70a4fce2010-04-04 23:25:33 +00002389 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner9efd1182010-04-04 19:09:29 +00002390 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00002391
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002392 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00002393 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner7bde8c02010-04-04 18:52:31 +00002394 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner085b6522010-03-09 00:31:02 +00002395 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00002396
Chris Lattner7bde8c02010-04-04 18:52:31 +00002397 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattner3a383cb2010-04-05 00:13:49 +00002398 Asm->OutStreamer.EmitSymbolValue(LI->first,
2399 Asm->getTargetData().getPointerSize(),0);
Bill Wendling480ff322009-05-20 23:21:38 +00002400 }
2401 }
2402
Chris Lattnera179b522010-04-04 19:25:43 +00002403 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00002404}