blob: 9978c829ba5e4292a2aeb68ed261f2a9f2672066 [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"
Bill Wendling2f921f82009-05-15 09:23:25 +000027#include "llvm/Target/TargetData.h"
Anton Korobeynikov2f931282011-01-10 12:39:04 +000028#include "llvm/Target/TargetFrameLowering.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000029#include "llvm/Target/TargetLoweringObjectFile.h"
Chris Lattner21dc46e2010-04-04 18:06:11 +000030#include "llvm/Target/TargetMachine.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000031#include "llvm/Target/TargetRegisterInfo.h"
Devang Patel61880932010-04-19 19:14:02 +000032#include "llvm/Target/TargetOptions.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000033#include "llvm/Analysis/DebugInfo.h"
Devang Patela5d93242011-02-24 18:49:30 +000034#include "llvm/Analysis/DIBuilder.h"
Devang Patela86114b2010-10-25 20:45:32 +000035#include "llvm/ADT/Statistic.h"
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000036#include "llvm/ADT/STLExtras.h"
Chris Lattner06fa1762009-08-24 03:52:50 +000037#include "llvm/ADT/StringExtras.h"
Devang Patel6c74a872010-04-27 19:46:33 +000038#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000039#include "llvm/Support/Debug.h"
40#include "llvm/Support/ErrorHandling.h"
Devang Patel1973df22010-01-26 21:39:14 +000041#include "llvm/Support/ValueHandle.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000042#include "llvm/Support/FormattedStream.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000043#include "llvm/Support/Timer.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000044#include "llvm/Support/Path.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000045using namespace llvm;
46
Jim Grosbacha8683bb2010-07-21 21:21:52 +000047static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel30265c42010-07-07 20:12:52 +000048 cl::Hidden,
Devang Patel6c74a872010-04-27 19:46:33 +000049 cl::desc("Disable debug info printing"));
50
Dan Gohman7421ae42010-05-07 01:08:53 +000051static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
Chris Lattner0ab5e2c2011-04-15 05:18:47 +000052 cl::desc("Make an absence of debug location information explicit."),
Dan Gohman7421ae42010-05-07 01:08:53 +000053 cl::init(false));
54
Bill Wendlingfcc14142010-04-07 09:28:04 +000055namespace {
56 const char *DWARFGroupName = "DWARF Emission";
57 const char *DbgTimerName = "DWARF Debug Writer";
58} // end anonymous namespace
59
Bill Wendling2f921f82009-05-15 09:23:25 +000060//===----------------------------------------------------------------------===//
61
62/// Configuration values for initial hash set sizes (log2).
63///
Bill Wendling2f921f82009-05-15 09:23:25 +000064static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +000065
66namespace llvm {
67
Nick Lewycky019d2552011-07-29 03:49:23 +000068DIType DbgVariable::getType() const {
Devang Patelf20c4f72011-04-12 22:53:02 +000069 DIType Ty = Var.getType();
70 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
71 // addresses instead.
72 if (Var.isBlockByrefVariable()) {
73 /* Byref variables, in Blocks, are declared by the programmer as
74 "SomeType VarName;", but the compiler creates a
75 __Block_byref_x_VarName struct, and gives the variable VarName
76 either the struct, or a pointer to the struct, as its type. This
77 is necessary for various behind-the-scenes things the compiler
78 needs to do with by-reference variables in blocks.
79
80 However, as far as the original *programmer* is concerned, the
81 variable should still have type 'SomeType', as originally declared.
82
83 The following function dives into the __Block_byref_x_VarName
84 struct to find the original type of the variable. This will be
85 passed back to the code generating the type for the Debug
86 Information Entry for the variable 'VarName'. 'VarName' will then
87 have the original type 'SomeType' in its debug information.
88
89 The original type 'SomeType' will be the type of the field named
90 'VarName' inside the __Block_byref_x_VarName struct.
91
92 NOTE: In order for this to not completely fail on the debugger
93 side, the Debug Information Entry for the variable VarName needs to
94 have a DW_AT_location that tells the debugger how to unwind through
95 the pointers and __Block_byref_x_VarName struct to find the actual
96 value of the variable. The function addBlockByrefType does this. */
97 DIType subType = Ty;
98 unsigned tag = Ty.getTag();
99
100 if (tag == dwarf::DW_TAG_pointer_type) {
101 DIDerivedType DTy = DIDerivedType(Ty);
102 subType = DTy.getTypeDerivedFrom();
103 }
104
105 DICompositeType blockStruct = DICompositeType(subType);
106 DIArray Elements = blockStruct.getTypeArray();
107
108 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
109 DIDescriptor Element = Elements.getElement(i);
110 DIDerivedType DT = DIDerivedType(Element);
111 if (getName() == DT.getName())
112 return (DT.getTypeDerivedFrom());
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000113 }
114 return Ty;
115 }
Devang Patelf20c4f72011-04-12 22:53:02 +0000116 return Ty;
117}
Bill Wendling2f921f82009-05-15 09:23:25 +0000118
Chris Lattnerf5d06362010-04-05 04:09:20 +0000119} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000120
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000121DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Devang Patel1a0df9a2010-05-10 22:49:55 +0000122 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000123 AbbreviationsSet(InitAbbreviationsSetSize),
Devang Patel7e623022011-08-10 20:55:27 +0000124 PrevLabel(NULL) {
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000125 NextStringPoolNumber = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000126
Rafael Espindolaa7160962011-05-06 14:56:22 +0000127 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattnere58b5472010-04-04 23:10:38 +0000128 DwarfStrSectionSym = TextSectionSym = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000129 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000130 FunctionBeginSym = FunctionEndSym = 0;
Dan Gohman6e681a52010-06-18 15:56:31 +0000131 {
132 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
133 beginModule(M);
Torok Edwinf8dba242010-04-07 10:44:46 +0000134 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000135}
136DwarfDebug::~DwarfDebug() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000137}
138
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000139MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
140 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
141 if (Entry.first) return Entry.first;
142
143 Entry.second = NextStringPoolNumber++;
Chris Lattnera179b522010-04-04 19:25:43 +0000144 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000145}
146
147
Devang Patel930143b2009-11-21 02:48:08 +0000148/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling2f921f82009-05-15 09:23:25 +0000149///
Devang Patel930143b2009-11-21 02:48:08 +0000150void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000151 // Profile the node so that we can make it unique.
152 FoldingSetNodeID ID;
153 Abbrev.Profile(ID);
154
155 // Check the set for priors.
156 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
157
158 // If it's newly added.
159 if (InSet == &Abbrev) {
160 // Add to abbreviation list.
161 Abbreviations.push_back(&Abbrev);
162
163 // Assign the vector position + 1 as its number.
164 Abbrev.setNumber(Abbreviations.size());
165 } else {
166 // Assign existing abbreviation number.
167 Abbrev.setNumber(InSet->getNumber());
168 }
169}
170
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000171/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel43ef34d2010-01-05 01:46:14 +0000172/// printer to not emit usual symbol prefix before the symbol name is used then
173/// return linkage name after skipping this special LLVM prefix.
174static StringRef getRealLinkageName(StringRef LinkageName) {
175 char One = '\1';
176 if (LinkageName.startswith(StringRef(&One, 1)))
177 return LinkageName.substr(1);
178 return LinkageName;
179}
180
Jim Grosbach042483e2009-11-21 23:12:12 +0000181/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel930143b2009-11-21 02:48:08 +0000182/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
183/// If there are global variables in this scope then create and insert
184/// DIEs for these variables.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000185DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
186 const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000187 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +0000188
Chris Lattner3a383cb2010-04-05 00:13:49 +0000189 assert(SPDie && "Unable to find subprogram DIE!");
190 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000191
Devang Patel1d6bbd42011-04-22 23:10:17 +0000192 DISubprogram SPDecl = SP.getFunctionDeclaration();
193 if (SPDecl.isSubprogram())
194 // Refer function declaration directly.
Devang Patelf20c4f72011-04-12 22:53:02 +0000195 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Devang Patel89543712011-08-15 17:24:54 +0000196 SPCU->getOrCreateSubprogramDIE(SPDecl));
Devang Patel1d6bbd42011-04-22 23:10:17 +0000197 else {
198 // There is not any need to generate specification DIE for a function
199 // defined at compile unit level. If a function is defined inside another
200 // function then gdb prefers the definition at top level and but does not
201 // expect specification DIE in parent function. So avoid creating
202 // specification DIE for a function defined inside a function.
203 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
204 !SP.getContext().isFile() &&
205 !isSubprogramContext(SP.getContext())) {
206 SPCU-> addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
207
208 // Add arguments.
209 DICompositeType SPTy = SP.getType();
210 DIArray Args = SPTy.getTypeArray();
211 unsigned SPTag = SPTy.getTag();
212 if (SPTag == dwarf::DW_TAG_subroutine_type)
213 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
214 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
215 DIType ATy = DIType(DIType(Args.getElement(i)));
216 SPCU->addType(Arg, ATy);
217 if (ATy.isArtificial())
218 SPCU->addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
219 SPDie->addChild(Arg);
220 }
221 DIE *SPDeclDie = SPDie;
222 SPDie = new DIE(dwarf::DW_TAG_subprogram);
223 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
224 SPDeclDie);
225 SPCU->addDie(SPDie);
226 }
Chris Lattner3a383cb2010-04-05 00:13:49 +0000227 }
Devang Patela37a95e2010-07-07 22:20:57 +0000228 // Pick up abstract subprogram DIE.
229 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
230 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf20c4f72011-04-12 22:53:02 +0000231 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
232 dwarf::DW_FORM_ref4, AbsSPDIE);
Devang Patela37a95e2010-07-07 22:20:57 +0000233 SPCU->addDie(SPDie);
234 }
235
Devang Patelf20c4f72011-04-12 22:53:02 +0000236 SPCU->addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
237 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
238 SPCU->addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
239 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
Chris Lattner3a383cb2010-04-05 00:13:49 +0000240 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
241 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000242 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000243
Chris Lattner3a383cb2010-04-05 00:13:49 +0000244 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000245}
246
Jim Grosbach042483e2009-11-21 23:12:12 +0000247/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel930143b2009-11-21 02:48:08 +0000248/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000249DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
250 LexicalScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +0000251
252 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
253 if (Scope->isAbstractScope())
254 return ScopeDIE;
255
Devang Patel7e623022011-08-10 20:55:27 +0000256 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +0000257 if (Ranges.empty())
258 return 0;
259
Devang Patel7e623022011-08-10 20:55:27 +0000260 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel6c74a872010-04-27 19:46:33 +0000261 if (Ranges.size() > 1) {
262 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000263 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +0000264 // DW_AT_ranges appropriately.
Devang Patelf20c4f72011-04-12 22:53:02 +0000265 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Devang Patel784077e2011-08-10 23:58:09 +0000266 DebugRangeSymbols.size()
267 * Asm->getTargetData().getPointerSize());
Devang Patel7e623022011-08-10 20:55:27 +0000268 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +0000269 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +0000270 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
271 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +0000272 }
273 DebugRangeSymbols.push_back(NULL);
274 DebugRangeSymbols.push_back(NULL);
275 return ScopeDIE;
276 }
277
Devang Patel9fc11702010-05-25 23:40:22 +0000278 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
279 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +0000280
Devang Patel9fc11702010-05-25 23:40:22 +0000281 if (End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000282
Chris Lattnere13c3722010-03-09 01:58:53 +0000283 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
284 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000285
Devang Patelf20c4f72011-04-12 22:53:02 +0000286 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
287 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000288
289 return ScopeDIE;
290}
291
Devang Patel930143b2009-11-21 02:48:08 +0000292/// constructInlinedScopeDIE - This scope represents inlined body of
293/// a function. Construct DIE to represent this concrete inlined copy
294/// of the function.
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000295DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
296 LexicalScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +0000297
Devang Patel7e623022011-08-10 20:55:27 +0000298 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000299 assert (Ranges.empty() == false
Devang Patel7e623022011-08-10 20:55:27 +0000300 && "LexicalScope does not have instruction markers!");
Devang Patel6c74a872010-04-27 19:46:33 +0000301
Devang Patelf098ce22011-07-27 00:34:13 +0000302 if (!Scope->getScopeNode())
303 return NULL;
304 DIScope DS(Scope->getScopeNode());
305 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patelf098ce22011-07-27 00:34:13 +0000306 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
307 if (!OriginDIE) {
308 DEBUG(dbgs() << "Unable to find original DIE for inlined subprogram.");
309 return NULL;
310 }
311
Devang Patel7e623022011-08-10 20:55:27 +0000312 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel9fc11702010-05-25 23:40:22 +0000313 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
314 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +0000315
Devang Patel4c6bd662010-07-08 22:39:20 +0000316 if (StartLabel == 0 || EndLabel == 0) {
Nick Lewycky019d2552011-07-29 03:49:23 +0000317 assert (0 && "Unexpected Start and End labels for a inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +0000318 return 0;
319 }
Chris Lattnere13c3722010-03-09 01:58:53 +0000320 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +0000321 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +0000322 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +0000323 "Invalid end label for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +0000324
Devang Patel73bc1722011-05-05 17:54:26 +0000325 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Devang Patelf20c4f72011-04-12 22:53:02 +0000326 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
327 dwarf::DW_FORM_ref4, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000328
Devang Patelf098ce22011-07-27 00:34:13 +0000329 if (Ranges.size() > 1) {
330 // .debug_range section has not been laid out yet. Emit offset in
331 // .debug_range as a uint, size 4, for now. emitDIE will handle
332 // DW_AT_ranges appropriately.
333 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Devang Patel784077e2011-08-10 23:58:09 +0000334 DebugRangeSymbols.size()
335 * Asm->getTargetData().getPointerSize());
Devang Patel7e623022011-08-10 20:55:27 +0000336 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patelf098ce22011-07-27 00:34:13 +0000337 RE = Ranges.end(); RI != RE; ++RI) {
338 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
339 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
340 }
341 DebugRangeSymbols.push_back(NULL);
342 DebugRangeSymbols.push_back(NULL);
343 } else {
Devang Patel784077e2011-08-10 23:58:09 +0000344 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
345 StartLabel);
346 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
347 EndLabel);
Devang Patelf098ce22011-07-27 00:34:13 +0000348 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000349
350 InlinedSubprogramDIEs.insert(OriginDIE);
351
352 // Track the start label for this inlined function.
Devang Patelf098ce22011-07-27 00:34:13 +0000353 //.debug_inlined section specification does not clearly state how
354 // to emit inlined scope that is split into multiple instruction ranges.
355 // For now, use first instruction range and emit low_pc/high_pc pair and
356 // corresponding .debug_inlined section entry for this pair.
Devang Patel32cc43c2010-05-07 20:54:48 +0000357 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000358 I = InlineInfo.find(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000359
360 if (I == InlineInfo.end()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000361 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach00e9c612009-11-22 19:20:36 +0000362 ScopeDIE));
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000363 InlinedSPNodes.push_back(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000364 } else
Chris Lattner085b6522010-03-09 00:31:02 +0000365 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000366
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000367 DILocation DL(Scope->getInlinedAt());
Devang Patelf20c4f72011-04-12 22:53:02 +0000368 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
369 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000370
371 return ScopeDIE;
372}
373
Devang Patel930143b2009-11-21 02:48:08 +0000374/// constructScopeDIE - Construct a DIE for this scope.
Devang Patel3acc70e2011-08-15 22:04:40 +0000375DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000376 if (!Scope || !Scope->getScopeNode())
377 return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000378
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000379 SmallVector <DIE *, 8> Children;
Devang Patel6c622ef2011-03-01 22:58:55 +0000380
381 // Collect arguments for current function.
Devang Patel7e623022011-08-10 20:55:27 +0000382 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000383 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
384 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Devang Patel3acc70e2011-08-15 22:04:40 +0000385 if (DIE *Arg =
386 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope()))
Devang Patel6c622ef2011-03-01 22:58:55 +0000387 Children.push_back(Arg);
388
Eric Christopherf84354b2011-10-03 15:49:16 +0000389 // Collect lexical scope children first.
Devang Patel7e623022011-08-10 20:55:27 +0000390 const SmallVector<DbgVariable *, 8> &Variables = ScopeVariables.lookup(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000391 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Devang Patel3acc70e2011-08-15 22:04:40 +0000392 if (DIE *Variable =
393 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope()))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000394 Children.push_back(Variable);
Devang Patel7e623022011-08-10 20:55:27 +0000395 const SmallVector<LexicalScope *, 4> &Scopes = Scope->getChildren();
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000396 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Patel3acc70e2011-08-15 22:04:40 +0000397 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000398 Children.push_back(Nested);
Devang Patel3b548aa2010-03-08 20:52:55 +0000399 DIScope DS(Scope->getScopeNode());
400 DIE *ScopeDIE = NULL;
401 if (Scope->getInlinedAt())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000402 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3b548aa2010-03-08 20:52:55 +0000403 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000404 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000405 if (Scope->isAbstractScope()) {
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000406 ScopeDIE = TheCU->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000407 // Note down abstract DIE.
408 if (ScopeDIE)
409 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
410 }
Devang Patel3b548aa2010-03-08 20:52:55 +0000411 else
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000412 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3b548aa2010-03-08 20:52:55 +0000413 }
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000414 else {
415 // There is no need to emit empty lexical block DIE.
416 if (Children.empty())
417 return NULL;
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000418 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000419 }
420
Devang Patel23b2ae62010-03-29 22:59:58 +0000421 if (!ScopeDIE) return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000422
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000423 // Add children
424 for (SmallVector<DIE *, 8>::iterator I = Children.begin(),
425 E = Children.end(); I != E; ++I)
426 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000427
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000428 if (DS.isSubprogram())
Devang Pateld2dfc5e2011-08-15 22:24:32 +0000429 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000430
Devang Patel04d2f2d2009-11-24 01:14:22 +0000431 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000432}
433
Bill Wendling2b128d72009-05-20 23:19:06 +0000434/// GetOrCreateSourceID - Look up the source id with the given directory and
435/// source file names. If none currently exists, create a new id and insert it
436/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
437/// maps as well.
Devang Patel498877d2010-07-24 00:53:22 +0000438
Devang Patele01b75c2011-03-24 20:30:50 +0000439unsigned DwarfDebug::GetOrCreateSourceID(StringRef FileName,
440 StringRef DirName) {
Devang Patel871d0b12010-09-16 20:57:49 +0000441 // If FE did not provide a file name, then assume stdin.
442 if (FileName.empty())
Devang Patele01b75c2011-03-24 20:30:50 +0000443 return GetOrCreateSourceID("<stdin>", StringRef());
444
Nick Lewycky40f8f2f2011-10-17 23:05:28 +0000445 unsigned SrcId = SourceIdMap.size()+1;
446 std::pair<std::string, std::string> SourceName =
447 std::make_pair(FileName, DirName);
448 std::pair<std::pair<std::string, std::string>, unsigned> Entry =
449 make_pair(SourceName, SrcId);
Devang Patel871d0b12010-09-16 20:57:49 +0000450
Nick Lewycky40f8f2f2011-10-17 23:05:28 +0000451 std::map<std::pair<std::string, std::string>, unsigned>::iterator I;
452 bool NewlyInserted;
453 tie(I, NewlyInserted) = SourceIdMap.insert(Entry);
454 if (!NewlyInserted)
455 return I->second;
Bill Wendling2b128d72009-05-20 23:19:06 +0000456
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000457 // Print out a .file directive to specify files for .loc directives.
Nick Lewycky40f8f2f2011-10-17 23:05:28 +0000458 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, Entry.first.second,
459 Entry.first.first);
Bill Wendling2b128d72009-05-20 23:19:06 +0000460
461 return SrcId;
462}
463
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000464/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel1a0df9a2010-05-10 22:49:55 +0000465/// metadata node with tag DW_TAG_compile_unit.
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000466CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +0000467 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +0000468 StringRef FN = DIUnit.getFilename();
469 StringRef Dir = DIUnit.getDirectory();
Devang Patele01b75c2011-03-24 20:30:50 +0000470 unsigned ID = GetOrCreateSourceID(FN, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +0000471
472 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patelf20c4f72011-04-12 22:53:02 +0000473 CompileUnit *NewCU = new CompileUnit(ID, Die, Asm, this);
474 NewCU->addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
475 DIUnit.getProducer());
476 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
477 DIUnit.getLanguage());
478 NewCU->addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patelbd798ce2010-04-26 22:54:28 +0000479 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
480 // simplifies debug range entries.
Devang Patelf20c4f72011-04-12 22:53:02 +0000481 NewCU->addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Pateld22ed622010-03-22 23:11:36 +0000482 // DW_AT_stmt_list is a offset of line number information for this
Devang Patel4a213872010-08-24 00:06:12 +0000483 // compile unit in debug_line section.
Rafael Espindola2fe0ee12011-05-10 20:35:05 +0000484 if(Asm->MAI->doesDwarfRequireRelocationForSectionOffset())
Rafael Espindolaa7558912011-05-04 17:44:06 +0000485 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Devang Patelf20c4f72011-04-12 22:53:02 +0000486 Asm->GetTempSymbol("section_line"));
Devang Patelea636392010-08-31 23:50:19 +0000487 else
Devang Patelf20c4f72011-04-12 22:53:02 +0000488 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +0000489
Devang Patel2d9caf92009-11-25 17:36:49 +0000490 if (!Dir.empty())
Devang Patelf20c4f72011-04-12 22:53:02 +0000491 NewCU->addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +0000492 if (DIUnit.isOptimized())
Devang Patelf20c4f72011-04-12 22:53:02 +0000493 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendling2b128d72009-05-20 23:19:06 +0000494
Devang Patel2d9caf92009-11-25 17:36:49 +0000495 StringRef Flags = DIUnit.getFlags();
496 if (!Flags.empty())
Devang Patel784077e2011-08-10 23:58:09 +0000497 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string,
498 Flags);
Devang Patelf20c4f72011-04-12 22:53:02 +0000499
Bill Wendling2b128d72009-05-20 23:19:06 +0000500 unsigned RVer = DIUnit.getRunTimeVersion();
501 if (RVer)
Devang Patelf20c4f72011-04-12 22:53:02 +0000502 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +0000503 dwarf::DW_FORM_data1, RVer);
504
Devang Patel1a0df9a2010-05-10 22:49:55 +0000505 if (!FirstCU)
506 FirstCU = NewCU;
507 CUMap.insert(std::make_pair(N, NewCU));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000508 return NewCU;
Devang Patel1a0df9a2010-05-10 22:49:55 +0000509}
510
Devang Patel1a0df9a2010-05-10 22:49:55 +0000511/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patel1f4f98d2011-08-15 23:36:40 +0000512void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
513 const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +0000514 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000515 if (!SP.isDefinition())
516 // This is a method declaration which will be handled while constructing
517 // class type.
Devang Patel0751a282009-06-26 01:49:18 +0000518 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000519
Devang Patel89543712011-08-15 17:24:54 +0000520 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings4bd3dd92010-04-06 21:38:29 +0000521
522 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000523 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +0000524
525 // Add to context owner.
Devang Patelf20c4f72011-04-12 22:53:02 +0000526 TheCU->addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +0000527
Bill Wendling2b128d72009-05-20 23:19:06 +0000528 // Expose as global.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000529 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000530
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000531 SPMap[N] = TheCU;
Devang Patel0751a282009-06-26 01:49:18 +0000532 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000533}
534
Devang Patel07bb9ee2011-08-15 23:47:24 +0000535/// collectInfoFromNamedMDNodes - Collect debug info from named mdnodes such
536/// as llvm.dbg.enum and llvm.dbg.ty
537void DwarfDebug::collectInfoFromNamedMDNodes(Module *M) {
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000538 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.sp"))
539 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
540 const MDNode *N = NMD->getOperand(i);
541 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
542 constructSubprogramDIE(CU, N);
543 }
544
545 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.gv"))
546 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
547 const MDNode *N = NMD->getOperand(i);
548 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
Devang Patel0ecbcbd2011-08-18 23:17:55 +0000549 CU->createGlobalVariableDIE(N);
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000550 }
551
Devang Patel07bb9ee2011-08-15 23:47:24 +0000552 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
553 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
554 DIType Ty(NMD->getOperand(i));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000555 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
556 CU->getOrCreateTypeDIE(Ty);
Devang Patel07bb9ee2011-08-15 23:47:24 +0000557 }
558
559 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
560 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
561 DIType Ty(NMD->getOperand(i));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000562 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
563 CU->getOrCreateTypeDIE(Ty);
Devang Patel07bb9ee2011-08-15 23:47:24 +0000564 }
565}
566
567/// collectLegacyDebugInfo - Collect debug info using DebugInfoFinder.
568/// FIXME - Remove this when dragon-egg and llvm-gcc switch to DIBuilder.
569bool DwarfDebug::collectLegacyDebugInfo(Module *M) {
570 DebugInfoFinder DbgFinder;
571 DbgFinder.processModule(*M);
572
573 bool HasDebugInfo = false;
574 // Scan all the compile-units to see if there are any marked as the main
575 // unit. If not, we do not generate debug info.
576 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
577 E = DbgFinder.compile_unit_end(); I != E; ++I) {
578 if (DICompileUnit(*I).isMain()) {
579 HasDebugInfo = true;
580 break;
581 }
582 }
583 if (!HasDebugInfo) return false;
584
585 // Create all the compile unit DIEs.
586 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
587 E = DbgFinder.compile_unit_end(); I != E; ++I)
588 constructCompileUnit(*I);
589
590 // Create DIEs for each global variable.
591 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
592 E = DbgFinder.global_variable_end(); I != E; ++I) {
593 const MDNode *N = *I;
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000594 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
Devang Patel0ecbcbd2011-08-18 23:17:55 +0000595 CU->createGlobalVariableDIE(N);
Devang Patel07bb9ee2011-08-15 23:47:24 +0000596 }
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000597
Devang Patel07bb9ee2011-08-15 23:47:24 +0000598 // Create DIEs for each subprogram.
599 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
600 E = DbgFinder.subprogram_end(); I != E; ++I) {
601 const MDNode *N = *I;
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000602 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
603 constructSubprogramDIE(CU, N);
Devang Patel07bb9ee2011-08-15 23:47:24 +0000604 }
605
606 return HasDebugInfo;
607}
608
Devang Patel930143b2009-11-21 02:48:08 +0000609/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000610/// content. Create global DIEs and emit initial debug info sections.
Nick Lewycky019d2552011-07-29 03:49:23 +0000611/// This is invoked by the target AsmPrinter.
Chris Lattner11980022010-04-04 07:48:20 +0000612void DwarfDebug::beginModule(Module *M) {
Devang Patel6c74a872010-04-27 19:46:33 +0000613 if (DisableDebugInfoPrinting)
614 return;
615
Nick Lewycky019d2552011-07-29 03:49:23 +0000616 // If module has named metadata anchors then use them, otherwise scan the
617 // module using debug info finder to collect debug info.
Devang Patele02e5852011-05-03 16:45:22 +0000618 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
619 if (CU_Nodes) {
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000620 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
621 DICompileUnit CUNode(CU_Nodes->getOperand(i));
622 CompileUnit *CU = constructCompileUnit(CUNode);
623 DIArray GVs = CUNode.getGlobalVariables();
624 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
Devang Patel0ecbcbd2011-08-18 23:17:55 +0000625 CU->createGlobalVariableDIE(GVs.getElement(i));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000626 DIArray SPs = CUNode.getSubprograms();
627 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
628 constructSubprogramDIE(CU, SPs.getElement(i));
629 DIArray EnumTypes = CUNode.getEnumTypes();
630 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
631 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
632 DIArray RetainedTypes = CUNode.getRetainedTypes();
633 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
634 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
635 }
Devang Patel07bb9ee2011-08-15 23:47:24 +0000636 } else if (!collectLegacyDebugInfo(M))
637 return;
Devang Patele02e5852011-05-03 16:45:22 +0000638
Devang Patel07bb9ee2011-08-15 23:47:24 +0000639 collectInfoFromNamedMDNodes(M);
Devang Patele02e5852011-05-03 16:45:22 +0000640
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000641 // Tell MMI that we have debug info.
642 MMI->setDebugInfoAvailability(true);
Devang Patele02e5852011-05-03 16:45:22 +0000643
Chris Lattnerd442aa32010-04-04 23:17:54 +0000644 // Emit initial sections.
Chris Lattner7cfa70e2010-04-05 02:19:28 +0000645 EmitSectionLabels();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000646
Bill Wendling2b128d72009-05-20 23:19:06 +0000647 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +0000648 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +0000649}
650
Devang Patel930143b2009-11-21 02:48:08 +0000651/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendling2b128d72009-05-20 23:19:06 +0000652///
Devang Patel930143b2009-11-21 02:48:08 +0000653void DwarfDebug::endModule() {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000654 if (!FirstCU) return;
Devang Patelf3b2db62010-06-28 18:25:03 +0000655 const Module *M = MMI->getModule();
Devang Patel7e623022011-08-10 20:55:27 +0000656 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
Devang Patelf3b2db62010-06-28 18:25:03 +0000657
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000658 // Collect info for variables that were optimized out.
659 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
660 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
661 DICompileUnit TheCU(CU_Nodes->getOperand(i));
662 DIArray Subprograms = TheCU.getSubprograms();
663 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
664 DISubprogram SP(Subprograms.getElement(i));
665 if (ProcessedSPNodes.count(SP) != 0) continue;
666 if (!SP.Verify()) continue;
667 if (!SP.isDefinition()) continue;
Devang Patel59e27c52011-08-19 23:28:12 +0000668 DIArray Variables = SP.getVariables();
669 if (Variables.getNumElements() == 0) continue;
670
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000671 LexicalScope *Scope =
672 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
673 DeadFnScopeMap[SP] = Scope;
674
675 // Construct subprogram DIE and add variables DIEs.
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000676 CompileUnit *SPCU = CUMap.lookup(TheCU);
677 assert (SPCU && "Unable to find Compile Unit!");
678 constructSubprogramDIE(SPCU, SP);
679 DIE *ScopeDIE = SPCU->getDIE(SP);
Devang Patel59e27c52011-08-19 23:28:12 +0000680 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
681 DIVariable DV(Variables.getElement(vi));
682 if (!DV.Verify()) continue;
683 DbgVariable *NewVar = new DbgVariable(DV, NULL);
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000684 if (DIE *VariableDIE =
Devang Patel59e27c52011-08-19 23:28:12 +0000685 SPCU->constructVariableDIE(NewVar, Scope->isAbstractScope()))
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000686 ScopeDIE->addChild(VariableDIE);
687 }
Devang Patelf3b2db62010-06-28 18:25:03 +0000688 }
689 }
690 }
Bill Wendling2b128d72009-05-20 23:19:06 +0000691
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000692 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
693 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
694 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
695 DIE *ISP = *AI;
Devang Patelf20c4f72011-04-12 22:53:02 +0000696 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000697 }
698
Devang Patel89543712011-08-15 17:24:54 +0000699 // Emit DW_AT_containing_type attribute to connect types with their
700 // vtable holding type.
701 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
702 CUE = CUMap.end(); CUI != CUE; ++CUI) {
703 CompileUnit *TheCU = CUI->second;
704 TheCU->constructContainingTypeDIEs();
Devang Pateleb57c592009-12-03 19:11:07 +0000705 }
706
Bill Wendling2b128d72009-05-20 23:19:06 +0000707 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +0000708 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnera179b522010-04-04 19:25:43 +0000709 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +0000710 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnera179b522010-04-04 19:25:43 +0000711 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +0000712
713 // End text sections.
714 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +0000715 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnera179b522010-04-04 19:25:43 +0000716 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendling2b128d72009-05-20 23:19:06 +0000717 }
718
Bill Wendling2b128d72009-05-20 23:19:06 +0000719 // Compute DIE offsets and sizes.
Devang Patel930143b2009-11-21 02:48:08 +0000720 computeSizeAndOffsets();
Bill Wendling2b128d72009-05-20 23:19:06 +0000721
722 // Emit all the DIEs into a debug info section
Devang Patel930143b2009-11-21 02:48:08 +0000723 emitDebugInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +0000724
725 // Corresponding abbreviations into a abbrev section.
Devang Patel930143b2009-11-21 02:48:08 +0000726 emitAbbreviations();
Bill Wendling2b128d72009-05-20 23:19:06 +0000727
Bill Wendling2b128d72009-05-20 23:19:06 +0000728 // Emit info into a debug pubnames section.
Devang Patel930143b2009-11-21 02:48:08 +0000729 emitDebugPubNames();
Bill Wendling2b128d72009-05-20 23:19:06 +0000730
Devang Patel04d2f2d2009-11-24 01:14:22 +0000731 // Emit info into a debug pubtypes section.
732 emitDebugPubTypes();
733
Bill Wendling2b128d72009-05-20 23:19:06 +0000734 // Emit info into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +0000735 emitDebugLoc();
Bill Wendling2b128d72009-05-20 23:19:06 +0000736
737 // Emit info into a debug aranges section.
738 EmitDebugARanges();
739
740 // Emit info into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +0000741 emitDebugRanges();
Bill Wendling2b128d72009-05-20 23:19:06 +0000742
743 // Emit info into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +0000744 emitDebugMacInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +0000745
746 // Emit inline info.
Devang Patel930143b2009-11-21 02:48:08 +0000747 emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +0000748
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000749 // Emit info into a debug str section.
750 emitDebugStr();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000751
Devang Pateld0701282010-08-02 17:32:15 +0000752 // clean up.
753 DeleteContainerSeconds(DeadFnScopeMap);
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000754 SPMap.clear();
Devang Patel1a0df9a2010-05-10 22:49:55 +0000755 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
756 E = CUMap.end(); I != E; ++I)
757 delete I->second;
758 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendling2b128d72009-05-20 23:19:06 +0000759}
760
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000761/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Devang Patelbb23a4a2011-08-10 21:50:54 +0000762DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattner915c5f92010-04-02 19:42:39 +0000763 DebugLoc ScopeLoc) {
Devang Patelbb23a4a2011-08-10 21:50:54 +0000764 LLVMContext &Ctx = DV->getContext();
765 // More then one inlined variable corresponds to one abstract variable.
766 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000767 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000768 if (AbsDbgVariable)
769 return AbsDbgVariable;
770
Devang Patel7e623022011-08-10 20:55:27 +0000771 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000772 if (!Scope)
773 return NULL;
774
Devang Patel99819b52011-08-15 19:01:20 +0000775 AbsDbgVariable = new DbgVariable(Var, NULL);
Devang Patel7e623022011-08-10 20:55:27 +0000776 addScopeVariable(Scope, AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000777 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000778 return AbsDbgVariable;
779}
780
Nick Lewycky019d2552011-07-29 03:49:23 +0000781/// addCurrentFnArgument - If Var is a current function argument then add
782/// it to CurrentFnArguments list.
Devang Patel6c622ef2011-03-01 22:58:55 +0000783bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patel7e623022011-08-10 20:55:27 +0000784 DbgVariable *Var, LexicalScope *Scope) {
785 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel6c622ef2011-03-01 22:58:55 +0000786 return false;
787 DIVariable DV = Var->getVariable();
788 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
789 return false;
790 unsigned ArgNo = DV.getArgNumber();
791 if (ArgNo == 0)
792 return false;
793
Devang Patel4ab660b2011-03-03 20:02:02 +0000794 size_t Size = CurrentFnArguments.size();
795 if (Size == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +0000796 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +0000797 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +0000798 // arguments does the function have at source level.
799 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +0000800 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +0000801 CurrentFnArguments[ArgNo - 1] = Var;
802 return true;
803}
804
Devang Patel490c8ab2010-05-20 19:57:06 +0000805/// collectVariableInfoFromMMITable - Collect variable information from
806/// side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000807void
Nick Lewycky019d2552011-07-29 03:49:23 +0000808DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patel490c8ab2010-05-20 19:57:06 +0000809 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +0000810 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
811 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
812 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +0000813 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000814 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +0000815 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +0000816 DIVariable DV(Var);
817 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000818
Devang Patel7e623022011-08-10 20:55:27 +0000819 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000820
Devang Patelcdb7d442009-11-10 23:20:04 +0000821 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +0000822 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +0000823 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000824
Devang Patele1c53f22010-05-20 16:36:41 +0000825 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Devang Patel99819b52011-08-15 19:01:20 +0000826 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable);
Devang Patel3e4a9652011-08-15 21:24:36 +0000827 RegVar->setFrameIndex(VP.first);
Devang Patel6c622ef2011-03-01 22:58:55 +0000828 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +0000829 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +0000830 if (AbsDbgVariable)
Devang Patel3e4a9652011-08-15 21:24:36 +0000831 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patel475d32a2009-10-06 01:26:37 +0000832 }
Devang Patel490c8ab2010-05-20 19:57:06 +0000833}
Devang Patela3e9c9c2010-03-15 18:33:46 +0000834
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000835/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +0000836/// DBG_VALUE instruction, is in a defined reg.
837static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
838 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +0000839 return MI->getNumOperands() == 3 &&
840 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
841 MI->getOperand(1).isImm() && MI->getOperand(1).getImm() == 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000842}
843
Nick Lewycky019d2552011-07-29 03:49:23 +0000844/// getDebugLocEntry - Get .debug_loc entry for the instruction range starting
Devang Patel2442a892011-07-08 17:09:57 +0000845/// at MI.
846static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
847 const MCSymbol *FLabel,
848 const MCSymbol *SLabel,
849 const MachineInstr *MI) {
850 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
851
852 if (MI->getNumOperands() != 3) {
853 MachineLocation MLoc = Asm->getDebugValueLocation(MI);
854 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
855 }
856 if (MI->getOperand(0).isReg() && MI->getOperand(1).isImm()) {
857 MachineLocation MLoc;
858 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
859 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
860 }
861 if (MI->getOperand(0).isImm())
862 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
863 if (MI->getOperand(0).isFPImm())
864 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
865 if (MI->getOperand(0).isCImm())
866 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
867
868 assert (0 && "Unexpected 3 operand DBG_VALUE instruction!");
869 return DotDebugLocEntry();
870}
871
Devang Patel7e623022011-08-10 20:55:27 +0000872/// collectVariableInfo - Find variables for each lexical scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000873void
Devang Patel5c0f85c2010-06-25 22:07:34 +0000874DwarfDebug::collectVariableInfo(const MachineFunction *MF,
875 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000876
Devang Patel490c8ab2010-05-20 19:57:06 +0000877 /// collection info from MMI table.
878 collectVariableInfoFromMMITable(MF, Processed);
879
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000880 for (SmallVectorImpl<const MDNode*>::const_iterator
881 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
882 ++UVI) {
883 const MDNode *Var = *UVI;
884 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +0000885 continue;
886
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000887 // History contains relevant DBG_VALUE instructions for Var and instructions
888 // clobbering it.
889 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
890 if (History.empty())
891 continue;
892 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +0000893
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000894 DIVariable DV(Var);
Devang Patel7e623022011-08-10 20:55:27 +0000895 LexicalScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +0000896 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
897 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patel7e623022011-08-10 20:55:27 +0000898 Scope = LScopes.getCurrentFunctionScope();
Devang Patel8fb9fd62011-07-20 22:18:50 +0000899 else {
900 if (DV.getVersion() <= LLVMDebugVersion9)
Devang Patel7e623022011-08-10 20:55:27 +0000901 Scope = LScopes.findLexicalScope(MInsn->getDebugLoc());
Devang Patel8fb9fd62011-07-20 22:18:50 +0000902 else {
903 if (MDNode *IA = DV.getInlinedAt())
Devang Patel7e623022011-08-10 20:55:27 +0000904 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
Devang Patel8fb9fd62011-07-20 22:18:50 +0000905 else
Devang Patel7e623022011-08-10 20:55:27 +0000906 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel8fb9fd62011-07-20 22:18:50 +0000907 }
908 }
Devang Patel490c8ab2010-05-20 19:57:06 +0000909 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +0000910 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +0000911 continue;
912
913 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000914 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel99819b52011-08-15 19:01:20 +0000915 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
916 DbgVariable *RegVar = new DbgVariable(DV, AbsVar);
Devang Patel6c622ef2011-03-01 22:58:55 +0000917 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patel7e623022011-08-10 20:55:27 +0000918 addScopeVariable(Scope, RegVar);
Devang Patel99819b52011-08-15 19:01:20 +0000919 if (AbsVar)
Devang Patel3e4a9652011-08-15 21:24:36 +0000920 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000921
922 // Simple ranges that are fully coalesced.
923 if (History.size() <= 1 || (History.size() == 2 &&
924 MInsn->isIdenticalTo(History.back()))) {
Devang Patel3e4a9652011-08-15 21:24:36 +0000925 RegVar->setMInsn(MInsn);
Devang Patel9fc11702010-05-25 23:40:22 +0000926 continue;
927 }
928
929 // handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000930 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +0000931
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000932 for (SmallVectorImpl<const MachineInstr*>::const_iterator
933 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
934 const MachineInstr *Begin = *HI;
935 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +0000936
Devang Patele7181b52011-06-01 23:00:17 +0000937 // Check if DBG_VALUE is truncating a range.
938 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
939 && !Begin->getOperand(0).getReg())
940 continue;
941
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +0000942 // Compute the range for a register location.
943 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
944 const MCSymbol *SLabel = 0;
945
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000946 if (HI + 1 == HE)
947 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +0000948 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +0000949 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000950 else {
951 const MachineInstr *End = HI[1];
Devang Patel53b050a2011-07-07 21:44:42 +0000952 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
953 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000954 if (End->isDebugValue())
955 SLabel = getLabelBeforeInsn(End);
956 else {
957 // End is a normal instruction clobbering the range.
958 SLabel = getLabelAfterInsn(End);
959 assert(SLabel && "Forgot label after clobber instruction");
960 ++HI;
961 }
962 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +0000963
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000964 // The value is valid until the next DBG_VALUE or clobber.
Devang Patel2442a892011-07-08 17:09:57 +0000965 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel, Begin));
Devang Patel9fc11702010-05-25 23:40:22 +0000966 }
967 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +0000968 }
Devang Patele0a94bf2010-05-14 21:01:35 +0000969
970 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +0000971 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
972 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
973 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
974 DIVariable DV(Variables.getElement(i));
975 if (!DV || !DV.Verify() || !Processed.insert(DV))
976 continue;
977 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
978 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patele0a94bf2010-05-14 21:01:35 +0000979 }
Devang Patel9fc11702010-05-25 23:40:22 +0000980}
Devang Patele0a94bf2010-05-14 21:01:35 +0000981
Devang Patel9fc11702010-05-25 23:40:22 +0000982/// getLabelBeforeInsn - Return Label preceding the instruction.
983const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000984 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
985 assert(Label && "Didn't insert label before instruction");
986 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +0000987}
988
989/// getLabelAfterInsn - Return Label immediately following the instruction.
990const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000991 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +0000992}
993
Devang Patelb5694e72010-10-26 17:49:02 +0000994/// beginInstruction - Process beginning of an instruction.
995void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +0000996 // Check if source location changes, but ignore DBG_VALUE locations.
997 if (!MI->isDebugValue()) {
998 DebugLoc DL = MI->getDebugLoc();
999 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Devang Patel34a66202011-05-11 19:22:19 +00001000 unsigned Flags = DWARF2_FLAG_IS_STMT;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001001 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001002 if (DL == PrologEndLoc) {
1003 Flags |= DWARF2_FLAG_PROLOGUE_END;
1004 PrologEndLoc = DebugLoc();
1005 }
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001006 if (!DL.isUnknown()) {
1007 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001008 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001009 } else
Devang Patel34a66202011-05-11 19:22:19 +00001010 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001011 }
Devang Patel9fc11702010-05-25 23:40:22 +00001012 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001013
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001014 // Insert labels where requested.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001015 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1016 LabelsBeforeInsn.find(MI);
1017
1018 // No label needed.
1019 if (I == LabelsBeforeInsn.end())
1020 return;
1021
1022 // Label already assigned.
1023 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001024 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001025
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001026 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001027 PrevLabel = MMI->getContext().CreateTempSymbol();
1028 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001029 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001030 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001031}
1032
Devang Patelb5694e72010-10-26 17:49:02 +00001033/// endInstruction - Process end of an instruction.
1034void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001035 // Don't create a new label after DBG_VALUE instructions.
1036 // They don't generate code.
1037 if (!MI->isDebugValue())
1038 PrevLabel = 0;
1039
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001040 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1041 LabelsAfterInsn.find(MI);
1042
1043 // No label needed.
1044 if (I == LabelsAfterInsn.end())
1045 return;
1046
1047 // Label already assigned.
1048 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001049 return;
1050
1051 // We need a label after this instruction.
1052 if (!PrevLabel) {
1053 PrevLabel = MMI->getContext().CreateTempSymbol();
1054 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001055 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001056 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001057}
1058
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001059/// identifyScopeMarkers() -
Devang Patel784077e2011-08-10 23:58:09 +00001060/// Each LexicalScope has first instruction and last instruction to mark
1061/// beginning and end of a scope respectively. Create an inverse map that list
1062/// scopes starts (and ends) with an instruction. One instruction may start (or
1063/// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001064void DwarfDebug::identifyScopeMarkers() {
Devang Patel7e623022011-08-10 20:55:27 +00001065 SmallVector<LexicalScope *, 4> WorkList;
1066 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel7771b7c2010-01-20 02:05:23 +00001067 while (!WorkList.empty()) {
Devang Patel7e623022011-08-10 20:55:27 +00001068 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001069
Devang Patel7e623022011-08-10 20:55:27 +00001070 const SmallVector<LexicalScope *, 4> &Children = S->getChildren();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001071 if (!Children.empty())
Devang Patel7e623022011-08-10 20:55:27 +00001072 for (SmallVector<LexicalScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00001073 SE = Children.end(); SI != SE; ++SI)
1074 WorkList.push_back(*SI);
1075
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001076 if (S->isAbstractScope())
1077 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001078
Devang Patel7e623022011-08-10 20:55:27 +00001079 const SmallVector<InsnRange, 4> &Ranges = S->getRanges();
Devang Patel6c74a872010-04-27 19:46:33 +00001080 if (Ranges.empty())
1081 continue;
Devang Patel7e623022011-08-10 20:55:27 +00001082 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patel6c74a872010-04-27 19:46:33 +00001083 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel7e623022011-08-10 20:55:27 +00001084 assert(RI->first && "InsnRange does not have first instruction!");
1085 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001086 requestLabelBeforeInsn(RI->first);
1087 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001088 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001089 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001090}
1091
Devang Patel589845d2011-05-09 22:14:49 +00001092/// getScopeNode - Get MDNode for DebugLoc's scope.
1093static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1094 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1095 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1096 return DL.getScope(Ctx);
1097}
1098
Devang Patel34a66202011-05-11 19:22:19 +00001099/// getFnDebugLoc - Walk up the scope chain of given debug loc and find
1100/// line number info for the function.
1101static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1102 const MDNode *Scope = getScopeNode(DL, Ctx);
1103 DISubprogram SP = getDISubprogram(Scope);
1104 if (SP.Verify())
1105 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1106 return DebugLoc();
1107}
1108
Devang Patel930143b2009-11-21 02:48:08 +00001109/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendling2b128d72009-05-20 23:19:06 +00001110/// emitted immediately after the function entry point.
Chris Lattner76555b52010-01-26 23:18:02 +00001111void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00001112 if (!MMI->hasDebugInfo()) return;
Devang Patel7e623022011-08-10 20:55:27 +00001113 LScopes.initialize(*MF);
1114 if (LScopes.empty()) return;
1115 identifyScopeMarkers();
Devang Patel4598eb62009-10-06 18:37:31 +00001116
Devang Patel6c74a872010-04-27 19:46:33 +00001117 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1118 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001119 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001120 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001121
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001122 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1123
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001124 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001125 /// LiveUserVar - Map physreg numbers to the MDNode they contain.
1126 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1127
Devang Patel002d54d2010-05-26 19:37:24 +00001128 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001129 I != E; ++I) {
1130 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001131 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1132 II != IE; ++II) {
1133 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001134
Devang Patel002d54d2010-05-26 19:37:24 +00001135 if (MI->isDebugValue()) {
Devang Patel002d54d2010-05-26 19:37:24 +00001136 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001137
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001138 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001139 const MDNode *Var =
1140 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001141
1142 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001143 if (isDbgValueInDefinedReg(MI))
1144 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1145
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001146 // Check the history of this variable.
1147 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1148 if (History.empty()) {
1149 UserVariables.push_back(Var);
1150 // The first mention of a function argument gets the FunctionBeginSym
1151 // label, so arguments are visible when breaking at function entry.
1152 DIVariable DV(Var);
1153 if (DV.Verify() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1154 DISubprogram(getDISubprogram(DV.getContext()))
1155 .describes(MF->getFunction()))
1156 LabelsBeforeInsn[MI] = FunctionBeginSym;
1157 } else {
1158 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1159 const MachineInstr *Prev = History.back();
1160 if (Prev->isDebugValue()) {
1161 // Coalesce identical entries at the end of History.
1162 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001163 Prev->isIdenticalTo(History[History.size() - 2])) {
1164 DEBUG(dbgs() << "Coalesce identical DBG_VALUE entries:\n"
1165 << "\t" << *Prev
1166 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001167 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001168 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001169
1170 // Terminate old register assignments that don't reach MI;
1171 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1172 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1173 isDbgValueInDefinedReg(Prev)) {
1174 // Previous register assignment needs to terminate at the end of
1175 // its basic block.
1176 MachineBasicBlock::const_iterator LastMI =
1177 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001178 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001179 // Drop DBG_VALUE for empty range.
Devang Patelb7a328e2011-07-07 00:14:27 +00001180 DEBUG(dbgs() << "Drop DBG_VALUE for empty range:\n"
1181 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001182 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001183 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001184 else {
1185 // Terminate after LastMI.
1186 History.push_back(LastMI);
1187 }
1188 }
1189 }
1190 }
1191 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001192 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001193 // Not a DBG_VALUE instruction.
1194 if (!MI->isLabel())
1195 AtBlockEntry = false;
1196
Devang Patel34a66202011-05-11 19:22:19 +00001197 // First known non DBG_VALUE location marks beginning of function
1198 // body.
1199 if (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown())
1200 PrologEndLoc = MI->getDebugLoc();
1201
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001202 // Check if the instruction clobbers any registers with debug vars.
1203 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1204 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1205 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1206 continue;
1207 for (const unsigned *AI = TRI->getOverlaps(MOI->getReg());
1208 unsigned Reg = *AI; ++AI) {
1209 const MDNode *Var = LiveUserVar[Reg];
1210 if (!Var)
1211 continue;
1212 // Reg is now clobbered.
1213 LiveUserVar[Reg] = 0;
1214
1215 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001216 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1217 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001218 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001219 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1220 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001221 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001222 const MachineInstr *Prev = History.back();
1223 // Sanity-check: Register assignments are terminated at the end of
1224 // their block.
1225 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1226 continue;
1227 // Is the variable still in Reg?
1228 if (!isDbgValueInDefinedReg(Prev) ||
1229 Prev->getOperand(0).getReg() != Reg)
1230 continue;
1231 // Var is clobbered. Make sure the next instruction gets a label.
1232 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001233 }
1234 }
Devang Patel002d54d2010-05-26 19:37:24 +00001235 }
Devang Patel002d54d2010-05-26 19:37:24 +00001236 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001237 }
1238
1239 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1240 I != E; ++I) {
1241 SmallVectorImpl<const MachineInstr*> &History = I->second;
1242 if (History.empty())
1243 continue;
1244
1245 // Make sure the final register assignments are terminated.
1246 const MachineInstr *Prev = History.back();
1247 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1248 const MachineBasicBlock *PrevMBB = Prev->getParent();
Devang Patel784077e2011-08-10 23:58:09 +00001249 MachineBasicBlock::const_iterator LastMI =
1250 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001251 if (LastMI == PrevMBB->end())
1252 // Drop DBG_VALUE for empty range.
1253 History.pop_back();
1254 else {
1255 // Terminate after LastMI.
1256 History.push_back(LastMI);
1257 }
1258 }
1259 // Request labels for the full history.
1260 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1261 const MachineInstr *MI = History[i];
1262 if (MI->isDebugValue())
1263 requestLabelBeforeInsn(MI);
1264 else
1265 requestLabelAfterInsn(MI);
1266 }
1267 }
Devang Patel002d54d2010-05-26 19:37:24 +00001268
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001269 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001270 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001271
1272 // Record beginning of function.
1273 if (!PrologEndLoc.isUnknown()) {
1274 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1275 MF->getFunction()->getContext());
1276 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1277 FnStartDL.getScope(MF->getFunction()->getContext()),
1278 DWARF2_FLAG_IS_STMT);
1279 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001280}
1281
Devang Patel7e623022011-08-10 20:55:27 +00001282void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1283// SmallVector<DbgVariable *, 8> &Vars = ScopeVariables.lookup(LS);
1284 ScopeVariables[LS].push_back(Var);
1285// Vars.push_back(Var);
1286}
1287
Devang Patel930143b2009-11-21 02:48:08 +00001288/// endFunction - Gather and emit post-function debug information.
Bill Wendling2b128d72009-05-20 23:19:06 +00001289///
Chris Lattner76555b52010-01-26 23:18:02 +00001290void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patel7e623022011-08-10 20:55:27 +00001291 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00001292
Devang Patel7e623022011-08-10 20:55:27 +00001293 // Define end label for subprogram.
1294 FunctionEndSym = Asm->GetTempSymbol("func_end",
1295 Asm->getFunctionNumber());
1296 // Assumes in correct section after the entry point.
1297 Asm->OutStreamer.EmitLabel(FunctionEndSym);
1298
1299 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1300 collectVariableInfo(MF, ProcessedVars);
1301
Devang Patel3acc70e2011-08-15 22:04:40 +00001302 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001303 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1304 assert (TheCU && "Unable to find compile unit!");
Devang Patel3acc70e2011-08-15 22:04:40 +00001305
Devang Patel7e623022011-08-10 20:55:27 +00001306 // Construct abstract scopes.
Devang Patel44403472011-08-12 18:10:19 +00001307 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1308 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1309 LexicalScope *AScope = AList[i];
1310 DISubprogram SP(AScope->getScopeNode());
Devang Patel7e623022011-08-10 20:55:27 +00001311 if (SP.Verify()) {
1312 // Collect info for variables that were optimized out.
Devang Patel59e27c52011-08-19 23:28:12 +00001313 DIArray Variables = SP.getVariables();
1314 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1315 DIVariable DV(Variables.getElement(i));
1316 if (!DV || !DV.Verify() || !ProcessedVars.insert(DV))
1317 continue;
1318 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1319 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel5c0f85c2010-06-25 22:07:34 +00001320 }
1321 }
Devang Patel44403472011-08-12 18:10:19 +00001322 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Devang Patel3acc70e2011-08-15 22:04:40 +00001323 constructScopeDIE(TheCU, AScope);
Bill Wendling2b128d72009-05-20 23:19:06 +00001324 }
Devang Patel7e623022011-08-10 20:55:27 +00001325
Devang Patel3acc70e2011-08-15 22:04:40 +00001326 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Devang Patel7e623022011-08-10 20:55:27 +00001327
Devang Patel3acc70e2011-08-15 22:04:40 +00001328 if (!DisableFramePointerElim(*MF))
Devang Patel784077e2011-08-10 23:58:09 +00001329 TheCU->addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
1330 dwarf::DW_FORM_flag, 1);
Devang Patel3acc70e2011-08-15 22:04:40 +00001331
Devang Patel7e623022011-08-10 20:55:27 +00001332 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
1333 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00001334
Bill Wendling2b128d72009-05-20 23:19:06 +00001335 // Clear debug info
Devang Patel7e623022011-08-10 20:55:27 +00001336 for (DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >::iterator
1337 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1338 DeleteContainerPointers(I->second);
1339 ScopeVariables.clear();
Devang Patelad45d912011-04-22 18:09:57 +00001340 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001341 UserVariables.clear();
1342 DbgValues.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001343 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00001344 LabelsBeforeInsn.clear();
1345 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00001346 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001347}
1348
Chris Lattnerba35a672010-03-09 04:54:43 +00001349/// recordSourceLine - Register a source line with debug info. Returns the
1350/// unique label that was emitted and which provides correspondence to
1351/// the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00001352void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1353 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00001354 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00001355 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00001356 unsigned Src = 1;
1357 if (S) {
1358 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00001359
Dan Gohman50849c62010-05-05 23:41:32 +00001360 if (Scope.isCompileUnit()) {
1361 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001362 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001363 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00001364 } else if (Scope.isFile()) {
1365 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00001366 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001367 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001368 } else if (Scope.isSubprogram()) {
1369 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001370 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001371 Dir = SP.getDirectory();
Eric Christopher6647b832011-10-11 22:59:11 +00001372 } else if (Scope.isLexicalBlockFile()) {
1373 DILexicalBlockFile DBF(S);
1374 Fn = DBF.getFilename();
1375 Dir = DBF.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001376 } else if (Scope.isLexicalBlock()) {
1377 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00001378 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00001379 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00001380 } else
1381 assert(0 && "Unexpected scope info");
1382
Devang Patele01b75c2011-03-24 20:30:50 +00001383 Src = GetOrCreateSourceID(Fn, Dir);
Dan Gohman50849c62010-05-05 23:41:32 +00001384 }
Nick Lewycky019d2552011-07-29 03:49:23 +00001385 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00001386}
1387
Bill Wendling806535f2009-05-20 23:22:40 +00001388//===----------------------------------------------------------------------===//
1389// Emit Methods
1390//===----------------------------------------------------------------------===//
1391
Devang Patel930143b2009-11-21 02:48:08 +00001392/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling480ff322009-05-20 23:21:38 +00001393///
Jim Grosbach00e9c612009-11-22 19:20:36 +00001394unsigned
1395DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling480ff322009-05-20 23:21:38 +00001396 // Get the children.
1397 const std::vector<DIE *> &Children = Die->getChildren();
1398
1399 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00001400 if (!Last && !Children.empty())
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001401 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling480ff322009-05-20 23:21:38 +00001402
1403 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00001404 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00001405
1406 // Get the abbreviation for this DIE.
1407 unsigned AbbrevNumber = Die->getAbbrevNumber();
1408 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1409
1410 // Set DIE offset
1411 Die->setOffset(Offset);
1412
1413 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00001414 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001415
1416 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
1417 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1418
1419 // Size the DIE attribute values.
1420 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1421 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00001422 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00001423
1424 // Size the DIE children if any.
1425 if (!Children.empty()) {
1426 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1427 "Children flag not set");
1428
1429 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00001430 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling480ff322009-05-20 23:21:38 +00001431
1432 // End of children marker.
1433 Offset += sizeof(int8_t);
1434 }
1435
1436 Die->setSize(Offset - Die->getOffset());
1437 return Offset;
1438}
1439
Devang Patel930143b2009-11-21 02:48:08 +00001440/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling480ff322009-05-20 23:21:38 +00001441///
Devang Patel930143b2009-11-21 02:48:08 +00001442void DwarfDebug::computeSizeAndOffsets() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001443 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1444 E = CUMap.end(); I != E; ++I) {
1445 // Compute size of compile unit header.
Devang Patel28dce702011-04-12 23:10:47 +00001446 unsigned Offset =
Devang Patel1a0df9a2010-05-10 22:49:55 +00001447 sizeof(int32_t) + // Length of Compilation Unit Info
1448 sizeof(int16_t) + // DWARF version number
1449 sizeof(int32_t) + // Offset Into Abbrev. Section
1450 sizeof(int8_t); // Pointer Size (in bytes)
1451 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001452 }
Bill Wendling480ff322009-05-20 23:21:38 +00001453}
1454
Chris Lattner1fbf53b2010-04-04 23:02:02 +00001455/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
1456/// temporary label to it if SymbolStem is specified.
Chris Lattner6629ca92010-04-04 22:59:04 +00001457static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner1fbf53b2010-04-04 23:02:02 +00001458 const char *SymbolStem = 0) {
Chris Lattner6629ca92010-04-04 22:59:04 +00001459 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner1fbf53b2010-04-04 23:02:02 +00001460 if (!SymbolStem) return 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001461
Chris Lattner6629ca92010-04-04 22:59:04 +00001462 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
1463 Asm->OutStreamer.EmitLabel(TmpSym);
1464 return TmpSym;
1465}
1466
1467/// EmitSectionLabels - Emit initial Dwarf sections with a label at
1468/// the start of each one.
Chris Lattner46355d82010-04-04 22:33:59 +00001469void DwarfDebug::EmitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001470 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001471
Bill Wendling480ff322009-05-20 23:21:38 +00001472 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001473 DwarfInfoSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00001474 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001475 DwarfAbbrevSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00001476 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00001477 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001478
Chris Lattner6629ca92010-04-04 22:59:04 +00001479 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner1fbf53b2010-04-04 23:02:02 +00001480 EmitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00001481
Devang Patel4a213872010-08-24 00:06:12 +00001482 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00001483 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
1484 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
1485 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001486 DwarfStrSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00001487 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patel12563b32010-04-16 23:33:45 +00001488 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
1489 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00001490
Devang Patel9fc11702010-05-25 23:40:22 +00001491 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
1492 "section_debug_loc");
1493
Chris Lattner6629ca92010-04-04 22:59:04 +00001494 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattnere58b5472010-04-04 23:10:38 +00001495 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00001496}
1497
Nick Lewycky019d2552011-07-29 03:49:23 +00001498/// emitDIE - Recursively emits a debug information entry.
Bill Wendling480ff322009-05-20 23:21:38 +00001499///
Devang Patel930143b2009-11-21 02:48:08 +00001500void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00001501 // Get the abbreviation for this DIE.
1502 unsigned AbbrevNumber = Die->getAbbrevNumber();
1503 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1504
Bill Wendling480ff322009-05-20 23:21:38 +00001505 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00001506 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00001507 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
1508 Twine::utohexstr(Die->getOffset()) + ":0x" +
1509 Twine::utohexstr(Die->getSize()) + " " +
1510 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00001511 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00001512
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00001513 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00001514 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1515
1516 // Emit the DIE attribute values.
1517 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1518 unsigned Attr = AbbrevData[i].getAttribute();
1519 unsigned Form = AbbrevData[i].getForm();
1520 assert(Form && "Too many attributes for DIE (check abbreviation)");
1521
Chris Lattner7bde8c02010-04-04 18:52:31 +00001522 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00001523 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001524
Bill Wendling480ff322009-05-20 23:21:38 +00001525 switch (Attr) {
1526 case dwarf::DW_AT_sibling:
Devang Patel930143b2009-11-21 02:48:08 +00001527 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00001528 break;
1529 case dwarf::DW_AT_abstract_origin: {
1530 DIEEntry *E = cast<DIEEntry>(Values[i]);
1531 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001532 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00001533 Asm->EmitInt32(Addr);
1534 break;
1535 }
Devang Patel12563b32010-04-16 23:33:45 +00001536 case dwarf::DW_AT_ranges: {
1537 // DW_AT_range Value encodes offset in debug_range section.
1538 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00001539
1540 if (Asm->MAI->doesDwarfUsesLabelOffsetForRanges()) {
1541 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
1542 V->getValue(),
1543 4);
1544 } else {
1545 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
1546 V->getValue(),
1547 DwarfDebugRangeSectionSym,
1548 4);
1549 }
Devang Patel12563b32010-04-16 23:33:45 +00001550 break;
1551 }
Devang Patel9fc11702010-05-25 23:40:22 +00001552 case dwarf::DW_AT_location: {
Devang Pateld8994442011-08-15 21:43:21 +00001553 if (DIELabel *L = dyn_cast<DIELabel>(Values[i]))
Daniel Dunbarfd95b012011-03-16 22:16:39 +00001554 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Devang Pateld8994442011-08-15 21:43:21 +00001555 else
Devang Patel9fc11702010-05-25 23:40:22 +00001556 Values[i]->EmitValue(Asm, Form);
1557 break;
1558 }
Devang Patela1bd5a12010-09-29 19:08:08 +00001559 case dwarf::DW_AT_accessibility: {
1560 if (Asm->isVerbose()) {
1561 DIEInteger *V = cast<DIEInteger>(Values[i]);
1562 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
1563 }
1564 Values[i]->EmitValue(Asm, Form);
1565 break;
1566 }
Bill Wendling480ff322009-05-20 23:21:38 +00001567 default:
1568 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001569 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00001570 break;
1571 }
Bill Wendling480ff322009-05-20 23:21:38 +00001572 }
1573
1574 // Emit the DIE children if any.
1575 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
1576 const std::vector<DIE *> &Children = Die->getChildren();
1577
1578 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00001579 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00001580
Chris Lattner7bde8c02010-04-04 18:52:31 +00001581 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00001582 Asm->OutStreamer.AddComment("End Of Children Mark");
1583 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00001584 }
1585}
1586
Devang Patel9ccfb642009-12-09 18:24:21 +00001587/// emitDebugInfo - Emit the debug info section.
Bill Wendling480ff322009-05-20 23:21:38 +00001588///
Devang Patel9ccfb642009-12-09 18:24:21 +00001589void DwarfDebug::emitDebugInfo() {
1590 // Start debug info section.
1591 Asm->OutStreamer.SwitchSection(
1592 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel1a0df9a2010-05-10 22:49:55 +00001593 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1594 E = CUMap.end(); I != E; ++I) {
1595 CompileUnit *TheCU = I->second;
1596 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001597
Devang Patel1a0df9a2010-05-10 22:49:55 +00001598 // Emit the compile units header.
1599 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
1600 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001601
Devang Patel1a0df9a2010-05-10 22:49:55 +00001602 // Emit size of content not including length itself
1603 unsigned ContentSize = Die->getSize() +
1604 sizeof(int16_t) + // DWARF version number
1605 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patele141234942011-04-13 19:41:17 +00001606 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001607
Devang Patel1a0df9a2010-05-10 22:49:55 +00001608 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
1609 Asm->EmitInt32(ContentSize);
1610 Asm->OutStreamer.AddComment("DWARF version number");
1611 Asm->EmitInt16(dwarf::DWARF_VERSION);
1612 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
1613 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
1614 DwarfAbbrevSectionSym);
1615 Asm->OutStreamer.AddComment("Address Size (in bytes)");
1616 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001617
Devang Patel1a0df9a2010-05-10 22:49:55 +00001618 emitDIE(Die);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001619 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
1620 }
Bill Wendling480ff322009-05-20 23:21:38 +00001621}
1622
Devang Patel930143b2009-11-21 02:48:08 +00001623/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling480ff322009-05-20 23:21:38 +00001624///
Devang Patel930143b2009-11-21 02:48:08 +00001625void DwarfDebug::emitAbbreviations() const {
Bill Wendling480ff322009-05-20 23:21:38 +00001626 // Check to see if it is worth the effort.
1627 if (!Abbreviations.empty()) {
1628 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001629 Asm->OutStreamer.SwitchSection(
1630 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00001631
Chris Lattnera179b522010-04-04 19:25:43 +00001632 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00001633
1634 // For each abbrevation.
1635 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
1636 // Get abbreviation data
1637 const DIEAbbrev *Abbrev = Abbreviations[i];
1638
1639 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00001640 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00001641
1642 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001643 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00001644 }
1645
1646 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00001647 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00001648
Chris Lattnera179b522010-04-04 19:25:43 +00001649 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00001650 }
1651}
1652
Devang Patel930143b2009-11-21 02:48:08 +00001653/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling480ff322009-05-20 23:21:38 +00001654/// the line matrix.
1655///
Devang Patel930143b2009-11-21 02:48:08 +00001656void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00001657 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00001658 Asm->OutStreamer.AddComment("Extended Op");
1659 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001660
Chris Lattner566cae92010-03-09 23:52:58 +00001661 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00001662 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00001663 Asm->OutStreamer.AddComment("DW_LNE_set_address");
1664 Asm->EmitInt8(dwarf::DW_LNE_set_address);
1665
1666 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00001667
Chris Lattnera179b522010-04-04 19:25:43 +00001668 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattner3a383cb2010-04-05 00:13:49 +00001669 Asm->getTargetData().getPointerSize(),
1670 0/*AddrSpace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00001671
1672 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00001673 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
1674 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00001675 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00001676 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00001677}
1678
Devang Patel9ccfb642009-12-09 18:24:21 +00001679/// emitDebugPubNames - Emit visible names into a debug pubnames section.
1680///
1681void DwarfDebug::emitDebugPubNames() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001682 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1683 E = CUMap.end(); I != E; ++I) {
1684 CompileUnit *TheCU = I->second;
1685 // Start the dwarf pubnames section.
1686 Asm->OutStreamer.SwitchSection(
1687 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001688
Devang Patel1a0df9a2010-05-10 22:49:55 +00001689 Asm->OutStreamer.AddComment("Length of Public Names Info");
1690 Asm->EmitLabelDifference(
1691 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
1692 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001693
Devang Patel1a0df9a2010-05-10 22:49:55 +00001694 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
1695 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001696
Devang Patel1a0df9a2010-05-10 22:49:55 +00001697 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001698 Asm->EmitInt16(dwarf::DWARF_VERSION);
1699
Devang Patel1a0df9a2010-05-10 22:49:55 +00001700 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001701 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00001702 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001703
Devang Patel1a0df9a2010-05-10 22:49:55 +00001704 Asm->OutStreamer.AddComment("Compilation Unit Length");
1705 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
1706 Asm->GetTempSymbol("info_begin", TheCU->getID()),
1707 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001708
Devang Patel1a0df9a2010-05-10 22:49:55 +00001709 const StringMap<DIE*> &Globals = TheCU->getGlobals();
1710 for (StringMap<DIE*>::const_iterator
1711 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
1712 const char *Name = GI->getKeyData();
1713 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001714
Devang Patel1a0df9a2010-05-10 22:49:55 +00001715 Asm->OutStreamer.AddComment("DIE offset");
1716 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001717
Devang Patel1a0df9a2010-05-10 22:49:55 +00001718 if (Asm->isVerbose())
1719 Asm->OutStreamer.AddComment("External Name");
1720 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
1721 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001722
Devang Patel1a0df9a2010-05-10 22:49:55 +00001723 Asm->OutStreamer.AddComment("End Mark");
1724 Asm->EmitInt32(0);
1725 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
Nick Lewycky019d2552011-07-29 03:49:23 +00001726 TheCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00001727 }
Bill Wendling480ff322009-05-20 23:21:38 +00001728}
1729
Devang Patel04d2f2d2009-11-24 01:14:22 +00001730void DwarfDebug::emitDebugPubTypes() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001731 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1732 E = CUMap.end(); I != E; ++I) {
1733 CompileUnit *TheCU = I->second;
1734 // Start the dwarf pubnames section.
1735 Asm->OutStreamer.SwitchSection(
1736 Asm->getObjFileLowering().getDwarfPubTypesSection());
1737 Asm->OutStreamer.AddComment("Length of Public Types Info");
1738 Asm->EmitLabelDifference(
1739 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
1740 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001741
Devang Patel1a0df9a2010-05-10 22:49:55 +00001742 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
1743 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001744
Devang Patel1a0df9a2010-05-10 22:49:55 +00001745 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
1746 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001747
Devang Patel1a0df9a2010-05-10 22:49:55 +00001748 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
1749 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
1750 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001751
Devang Patel1a0df9a2010-05-10 22:49:55 +00001752 Asm->OutStreamer.AddComment("Compilation Unit Length");
1753 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
1754 Asm->GetTempSymbol("info_begin", TheCU->getID()),
1755 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001756
Devang Patel1a0df9a2010-05-10 22:49:55 +00001757 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
1758 for (StringMap<DIE*>::const_iterator
1759 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
1760 const char *Name = GI->getKeyData();
Nick Lewycky019d2552011-07-29 03:49:23 +00001761 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001762
Devang Patel1a0df9a2010-05-10 22:49:55 +00001763 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
1764 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001765
Devang Patel1a0df9a2010-05-10 22:49:55 +00001766 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
1767 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
1768 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001769
Devang Patel1a0df9a2010-05-10 22:49:55 +00001770 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001771 Asm->EmitInt32(0);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001772 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
1773 TheCU->getID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00001774 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001775}
1776
Devang Patel930143b2009-11-21 02:48:08 +00001777/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling480ff322009-05-20 23:21:38 +00001778///
Devang Patel930143b2009-11-21 02:48:08 +00001779void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00001780 // Check to see if it is worth the effort.
Chris Lattner3d72a672010-03-09 23:38:23 +00001781 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001782
Chris Lattner3d72a672010-03-09 23:38:23 +00001783 // Start the dwarf str section.
1784 Asm->OutStreamer.SwitchSection(
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001785 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00001786
Chris Lattnerb7aa9522010-03-13 02:17:42 +00001787 // Get all of the string pool entries and put them in an array by their ID so
1788 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001789 SmallVector<std::pair<unsigned,
Chris Lattnerb7aa9522010-03-13 02:17:42 +00001790 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001791
Chris Lattnerb7aa9522010-03-13 02:17:42 +00001792 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
1793 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
1794 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001795
Chris Lattnerb7aa9522010-03-13 02:17:42 +00001796 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001797
Chris Lattnerb7aa9522010-03-13 02:17:42 +00001798 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00001799 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00001800 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001801
Chris Lattner3d72a672010-03-09 23:38:23 +00001802 // Emit the string itself.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00001803 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00001804 }
1805}
1806
Devang Patel930143b2009-11-21 02:48:08 +00001807/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling480ff322009-05-20 23:21:38 +00001808///
Devang Patel930143b2009-11-21 02:48:08 +00001809void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00001810 if (DotDebugLocEntries.empty())
1811 return;
1812
Devang Patel116a9d72011-02-04 22:57:18 +00001813 for (SmallVector<DotDebugLocEntry, 4>::iterator
1814 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
1815 I != E; ++I) {
1816 DotDebugLocEntry &Entry = *I;
1817 if (I + 1 != DotDebugLocEntries.end())
1818 Entry.Merge(I+1);
1819 }
1820
Daniel Dunbarfd95b012011-03-16 22:16:39 +00001821 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001822 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00001823 Asm->getObjFileLowering().getDwarfLocSection());
1824 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00001825 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
1826 unsigned index = 1;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001827 for (SmallVector<DotDebugLocEntry, 4>::iterator
1828 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00001829 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00001830 DotDebugLocEntry &Entry = *I;
1831 if (Entry.isMerged()) continue;
Devang Patel9fc11702010-05-25 23:40:22 +00001832 if (Entry.isEmpty()) {
1833 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
1834 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00001835 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00001836 } else {
1837 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
1838 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
Devang Patel3e021532011-04-28 02:22:40 +00001839 DIVariable DV(Entry.Variable);
Rafael Espindolad23bfb82011-05-27 22:05:41 +00001840 Asm->OutStreamer.AddComment("Loc expr size");
1841 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
1842 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
1843 Asm->EmitLabelDifference(end, begin, 2);
1844 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00001845 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00001846 DIBasicType BTy(DV.getType());
1847 if (BTy.Verify() &&
1848 (BTy.getEncoding() == dwarf::DW_ATE_signed
1849 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
1850 Asm->OutStreamer.AddComment("DW_OP_consts");
1851 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00001852 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00001853 } else {
1854 Asm->OutStreamer.AddComment("DW_OP_constu");
1855 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00001856 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00001857 }
Devang Pateled9fd452011-07-08 16:49:43 +00001858 } else if (Entry.isLocation()) {
1859 if (!DV.hasComplexAddress())
1860 // Regular entry.
Devang Patel3e021532011-04-28 02:22:40 +00001861 Asm->EmitDwarfRegOp(Entry.Loc);
Devang Pateled9fd452011-07-08 16:49:43 +00001862 else {
1863 // Complex address entry.
1864 unsigned N = DV.getNumAddrElements();
1865 unsigned i = 0;
1866 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
1867 if (Entry.Loc.getOffset()) {
1868 i = 2;
1869 Asm->EmitDwarfRegOp(Entry.Loc);
1870 Asm->OutStreamer.AddComment("DW_OP_deref");
1871 Asm->EmitInt8(dwarf::DW_OP_deref);
1872 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
1873 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
1874 Asm->EmitSLEB128(DV.getAddrElement(1));
1875 } else {
1876 // If first address element is OpPlus then emit
1877 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
1878 MachineLocation Loc(Entry.Loc.getReg(), DV.getAddrElement(1));
1879 Asm->EmitDwarfRegOp(Loc);
1880 i = 2;
1881 }
1882 } else {
1883 Asm->EmitDwarfRegOp(Entry.Loc);
1884 }
1885
1886 // Emit remaining complex address elements.
1887 for (; i < N; ++i) {
1888 uint64_t Element = DV.getAddrElement(i);
1889 if (Element == DIBuilder::OpPlus) {
1890 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
1891 Asm->EmitULEB128(DV.getAddrElement(++i));
1892 } else if (Element == DIBuilder::OpDeref)
1893 Asm->EmitInt8(dwarf::DW_OP_deref);
1894 else llvm_unreachable("unknown Opcode found in complex address");
1895 }
Devang Patel3e021532011-04-28 02:22:40 +00001896 }
Devang Patel3e021532011-04-28 02:22:40 +00001897 }
Devang Pateled9fd452011-07-08 16:49:43 +00001898 // else ... ignore constant fp. There is not any good way to
1899 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00001900 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00001901 }
1902 }
Bill Wendling480ff322009-05-20 23:21:38 +00001903}
1904
1905/// EmitDebugARanges - Emit visible names into a debug aranges section.
1906///
1907void DwarfDebug::EmitDebugARanges() {
1908 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001909 Asm->OutStreamer.SwitchSection(
1910 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00001911}
1912
Devang Patel930143b2009-11-21 02:48:08 +00001913/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling480ff322009-05-20 23:21:38 +00001914///
Devang Patel930143b2009-11-21 02:48:08 +00001915void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00001916 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001917 Asm->OutStreamer.SwitchSection(
Devang Patel12563b32010-04-16 23:33:45 +00001918 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Patel6c74a872010-04-27 19:46:33 +00001919 unsigned char Size = Asm->getTargetData().getPointerSize();
1920 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001921 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00001922 I != E; ++I) {
1923 if (*I)
1924 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patel12563b32010-04-16 23:33:45 +00001925 else
Devang Patel6c74a872010-04-27 19:46:33 +00001926 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel12563b32010-04-16 23:33:45 +00001927 }
Bill Wendling480ff322009-05-20 23:21:38 +00001928}
1929
Devang Patel930143b2009-11-21 02:48:08 +00001930/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling480ff322009-05-20 23:21:38 +00001931///
Devang Patel930143b2009-11-21 02:48:08 +00001932void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001933 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00001934 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00001935 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001936 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00001937 }
1938}
1939
Devang Patel930143b2009-11-21 02:48:08 +00001940/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling480ff322009-05-20 23:21:38 +00001941/// Section Header:
1942/// 1. length of section
1943/// 2. Dwarf version number
1944/// 3. address size.
1945///
1946/// Entries (one "entry" for each function that was inlined):
1947///
1948/// 1. offset into __debug_str section for MIPS linkage name, if exists;
1949/// otherwise offset into __debug_str for regular function name.
1950/// 2. offset into __debug_str section for regular function name.
1951/// 3. an unsigned LEB128 number indicating the number of distinct inlining
1952/// instances for the function.
1953///
1954/// The rest of the entry consists of a {die_offset, low_pc} pair for each
1955/// inlined instance; the die_offset points to the inlined_subroutine die in the
1956/// __debug_info section, and the low_pc is the starting address for the
1957/// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00001958void DwarfDebug::emitDebugInlineInfo() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00001959 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00001960 return;
1961
Devang Patel1a0df9a2010-05-10 22:49:55 +00001962 if (!FirstCU)
Bill Wendling480ff322009-05-20 23:21:38 +00001963 return;
1964
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001965 Asm->OutStreamer.SwitchSection(
1966 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00001967
Chris Lattner566cae92010-03-09 23:52:58 +00001968 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00001969 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
1970 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00001971
Chris Lattnera179b522010-04-04 19:25:43 +00001972 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00001973
Chris Lattner566cae92010-03-09 23:52:58 +00001974 Asm->OutStreamer.AddComment("Dwarf Version");
1975 Asm->EmitInt16(dwarf::DWARF_VERSION);
1976 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattner3a383cb2010-04-05 00:13:49 +00001977 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00001978
Devang Patel32cc43c2010-05-07 20:54:48 +00001979 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001980 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00001981
Devang Patel32cc43c2010-05-07 20:54:48 +00001982 const MDNode *Node = *I;
1983 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00001984 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001985 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00001986 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00001987 StringRef LName = SP.getLinkageName();
1988 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00001989
Chris Lattner566cae92010-03-09 23:52:58 +00001990 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00001991 if (LName.empty()) {
1992 Asm->OutStreamer.EmitBytes(Name, 0);
1993 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001994 } else
Chris Lattner70a4fce2010-04-04 23:25:33 +00001995 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
1996 DwarfStrSectionSym);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001997
Chris Lattner566cae92010-03-09 23:52:58 +00001998 Asm->OutStreamer.AddComment("Function name");
Chris Lattner70a4fce2010-04-04 23:25:33 +00001999 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner9efd1182010-04-04 19:09:29 +00002000 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00002001
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002002 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00002003 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner7bde8c02010-04-04 18:52:31 +00002004 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner085b6522010-03-09 00:31:02 +00002005 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00002006
Chris Lattner7bde8c02010-04-04 18:52:31 +00002007 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattner3a383cb2010-04-05 00:13:49 +00002008 Asm->OutStreamer.EmitSymbolValue(LI->first,
2009 Asm->getTargetData().getPointerSize(),0);
Bill Wendling480ff322009-05-20 23:21:38 +00002010 }
2011 }
2012
Chris Lattnera179b522010-04-04 19:25:43 +00002013 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00002014}