blob: 03fb8d1fa3106129bb0d4f662748a651718959c5 [file] [log] [blame]
Bill Wendling2f921f82009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Chris Lattnerb14490d2010-03-09 00:39:24 +000013
Devang Patel80ae3492009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling2f921f82009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000016#include "DIE.h"
Devang Patel5eb43192011-04-12 17:40:32 +000017#include "DwarfCompileUnit.h"
Bill Wendling30346342010-04-05 22:59:21 +000018#include "llvm/Constants.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000019#include "llvm/Module.h"
Devang Patel2d9e5322011-01-20 00:02:16 +000020#include "llvm/Instructions.h"
David Greene829b3e82009-08-19 21:52:55 +000021#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000022#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000023#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000024#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000025#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000026#include "llvm/MC/MCSymbol.h"
Chris Lattnerf62e3ee2010-01-16 21:57:06 +000027#include "llvm/Target/Mangler.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000028#include "llvm/Target/TargetData.h"
Anton Korobeynikov2f931282011-01-10 12:39:04 +000029#include "llvm/Target/TargetFrameLowering.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000030#include "llvm/Target/TargetLoweringObjectFile.h"
Chris Lattner21dc46e2010-04-04 18:06:11 +000031#include "llvm/Target/TargetMachine.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000032#include "llvm/Target/TargetRegisterInfo.h"
Devang Patel61880932010-04-19 19:14:02 +000033#include "llvm/Target/TargetOptions.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000034#include "llvm/Analysis/DebugInfo.h"
Devang Patela5d93242011-02-24 18:49:30 +000035#include "llvm/Analysis/DIBuilder.h"
Devang Patela86114b2010-10-25 20:45:32 +000036#include "llvm/ADT/Statistic.h"
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000037#include "llvm/ADT/STLExtras.h"
Chris Lattner06fa1762009-08-24 03:52:50 +000038#include "llvm/ADT/StringExtras.h"
Devang Patel6c74a872010-04-27 19:46:33 +000039#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000040#include "llvm/Support/Debug.h"
41#include "llvm/Support/ErrorHandling.h"
Devang Patel1973df22010-01-26 21:39:14 +000042#include "llvm/Support/ValueHandle.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000043#include "llvm/Support/FormattedStream.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000044#include "llvm/Support/Timer.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000045#include "llvm/Support/Path.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000046using namespace llvm;
47
Devang Patel6c74a872010-04-27 19:46:33 +000048static cl::opt<bool> PrintDbgScope("print-dbgscope", cl::Hidden,
49 cl::desc("Print DbgScope information for each machine instruction"));
50
Jim Grosbacha8683bb2010-07-21 21:21:52 +000051static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel30265c42010-07-07 20:12:52 +000052 cl::Hidden,
Devang Patel6c74a872010-04-27 19:46:33 +000053 cl::desc("Disable debug info printing"));
54
Dan Gohman7421ae42010-05-07 01:08:53 +000055static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
Chris Lattner0ab5e2c2011-04-15 05:18:47 +000056 cl::desc("Make an absence of debug location information explicit."),
Dan Gohman7421ae42010-05-07 01:08:53 +000057 cl::init(false));
58
Bill Wendlingfcc14142010-04-07 09:28:04 +000059namespace {
60 const char *DWARFGroupName = "DWARF Emission";
61 const char *DbgTimerName = "DWARF Debug Writer";
62} // end anonymous namespace
63
Bill Wendling2f921f82009-05-15 09:23:25 +000064//===----------------------------------------------------------------------===//
65
66/// Configuration values for initial hash set sizes (log2).
67///
Bill Wendling2f921f82009-05-15 09:23:25 +000068static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +000069
70namespace llvm {
71
Devang Patelf20c4f72011-04-12 22:53:02 +000072DIType DbgVariable::getType() const {
73 DIType Ty = Var.getType();
74 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
75 // addresses instead.
76 if (Var.isBlockByrefVariable()) {
77 /* Byref variables, in Blocks, are declared by the programmer as
78 "SomeType VarName;", but the compiler creates a
79 __Block_byref_x_VarName struct, and gives the variable VarName
80 either the struct, or a pointer to the struct, as its type. This
81 is necessary for various behind-the-scenes things the compiler
82 needs to do with by-reference variables in blocks.
83
84 However, as far as the original *programmer* is concerned, the
85 variable should still have type 'SomeType', as originally declared.
86
87 The following function dives into the __Block_byref_x_VarName
88 struct to find the original type of the variable. This will be
89 passed back to the code generating the type for the Debug
90 Information Entry for the variable 'VarName'. 'VarName' will then
91 have the original type 'SomeType' in its debug information.
92
93 The original type 'SomeType' will be the type of the field named
94 'VarName' inside the __Block_byref_x_VarName struct.
95
96 NOTE: In order for this to not completely fail on the debugger
97 side, the Debug Information Entry for the variable VarName needs to
98 have a DW_AT_location that tells the debugger how to unwind through
99 the pointers and __Block_byref_x_VarName struct to find the actual
100 value of the variable. The function addBlockByrefType does this. */
101 DIType subType = Ty;
102 unsigned tag = Ty.getTag();
103
104 if (tag == dwarf::DW_TAG_pointer_type) {
105 DIDerivedType DTy = DIDerivedType(Ty);
106 subType = DTy.getTypeDerivedFrom();
107 }
108
109 DICompositeType blockStruct = DICompositeType(subType);
110 DIArray Elements = blockStruct.getTypeArray();
111
112 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
113 DIDescriptor Element = Elements.getElement(i);
114 DIDerivedType DT = DIDerivedType(Element);
115 if (getName() == DT.getName())
116 return (DT.getTypeDerivedFrom());
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000117 }
118 return Ty;
119 }
Devang Patelf20c4f72011-04-12 22:53:02 +0000120 return Ty;
121}
Bill Wendling2f921f82009-05-15 09:23:25 +0000122
123//===----------------------------------------------------------------------===//
Devang Patel6c74a872010-04-27 19:46:33 +0000124/// DbgRange - This is used to track range of instructions with identical
125/// debug info scope.
126///
127typedef std::pair<const MachineInstr *, const MachineInstr *> DbgRange;
128
129//===----------------------------------------------------------------------===//
Bill Wendling2f921f82009-05-15 09:23:25 +0000130/// DbgScope - This class is used to track scope information.
131///
Devang Patelf3d7c082009-11-16 21:53:40 +0000132class DbgScope {
Bill Wendling2f921f82009-05-15 09:23:25 +0000133 DbgScope *Parent; // Parent to this scope.
Jim Grosbach042483e2009-11-21 23:12:12 +0000134 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel1973df22010-01-26 21:39:14 +0000135 // Location at which this scope is inlined.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000136 AssertingVH<const MDNode> InlinedAtLocation;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000137 bool AbstractScope; // Abstract Scope
Devang Patel787f94c2009-10-01 18:25:23 +0000138 const MachineInstr *LastInsn; // Last instruction of this scope.
139 const MachineInstr *FirstInsn; // First instruction of this scope.
Devang Patel6c74a872010-04-27 19:46:33 +0000140 unsigned DFSIn, DFSOut;
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000141 // Scopes defined in scope. Contents not owned.
142 SmallVector<DbgScope *, 4> Scopes;
143 // Variables declared in scope. Contents owned.
144 SmallVector<DbgVariable *, 8> Variables;
Devang Patel6c74a872010-04-27 19:46:33 +0000145 SmallVector<DbgRange, 4> Ranges;
Owen Anderson9becc182009-06-24 22:53:20 +0000146 // Private state for dump()
147 mutable unsigned IndentLevel;
Bill Wendling2f921f82009-05-15 09:23:25 +0000148public:
Devang Patel32cc43c2010-05-07 20:54:48 +0000149 DbgScope(DbgScope *P, DIDescriptor D, const MDNode *I = 0)
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000150 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Devang Patel6c74a872010-04-27 19:46:33 +0000151 LastInsn(0), FirstInsn(0),
152 DFSIn(0), DFSOut(0), IndentLevel(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000153 virtual ~DbgScope();
154
155 // Accessors.
156 DbgScope *getParent() const { return Parent; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000157 void setParent(DbgScope *P) { Parent = P; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000158 DIDescriptor getDesc() const { return Desc; }
Devang Patel32cc43c2010-05-07 20:54:48 +0000159 const MDNode *getInlinedAt() const { return InlinedAtLocation; }
160 const MDNode *getScopeNode() const { return Desc; }
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000161 const SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
Devang Patel406798a2010-08-09 18:51:29 +0000162 const SmallVector<DbgVariable *, 8> &getDbgVariables() { return Variables; }
Devang Patel6c74a872010-04-27 19:46:33 +0000163 const SmallVector<DbgRange, 4> &getRanges() { return Ranges; }
164
165 /// openInsnRange - This scope covers instruction range starting from MI.
166 void openInsnRange(const MachineInstr *MI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000167 if (!FirstInsn)
Devang Patel6c74a872010-04-27 19:46:33 +0000168 FirstInsn = MI;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000169
Devang Patel6c74a872010-04-27 19:46:33 +0000170 if (Parent)
171 Parent->openInsnRange(MI);
172 }
173
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000174 /// extendInsnRange - Extend the current instruction range covered by
Devang Patel6c74a872010-04-27 19:46:33 +0000175 /// this scope.
176 void extendInsnRange(const MachineInstr *MI) {
177 assert (FirstInsn && "MI Range is not open!");
178 LastInsn = MI;
179 if (Parent)
180 Parent->extendInsnRange(MI);
181 }
182
183 /// closeInsnRange - Create a range based on FirstInsn and LastInsn collected
184 /// until now. This is used when a new scope is encountered while walking
185 /// machine instructions.
186 void closeInsnRange(DbgScope *NewScope = NULL) {
187 assert (LastInsn && "Last insn missing!");
188 Ranges.push_back(DbgRange(FirstInsn, LastInsn));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000189 FirstInsn = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +0000190 LastInsn = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000191 // If Parent dominates NewScope then do not close Parent's instruction
Devang Patel6c74a872010-04-27 19:46:33 +0000192 // range.
193 if (Parent && (!NewScope || !Parent->dominates(NewScope)))
194 Parent->closeInsnRange(NewScope);
195 }
196
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000197 void setAbstractScope() { AbstractScope = true; }
198 bool isAbstractScope() const { return AbstractScope; }
Devang Patel6c74a872010-04-27 19:46:33 +0000199
200 // Depth First Search support to walk and mainpluate DbgScope hierarchy.
201 unsigned getDFSOut() const { return DFSOut; }
202 void setDFSOut(unsigned O) { DFSOut = O; }
203 unsigned getDFSIn() const { return DFSIn; }
204 void setDFSIn(unsigned I) { DFSIn = I; }
205 bool dominates(const DbgScope *S) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000206 if (S == this)
Devang Patel6c74a872010-04-27 19:46:33 +0000207 return true;
208 if (DFSIn < S->getDFSIn() && DFSOut > S->getDFSOut())
209 return true;
210 return false;
211 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000212
Devang Patel930143b2009-11-21 02:48:08 +0000213 /// addScope - Add a scope to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000214 ///
Devang Patel930143b2009-11-21 02:48:08 +0000215 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000216
Devang Patel930143b2009-11-21 02:48:08 +0000217 /// addVariable - Add a variable to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000218 ///
Devang Patel930143b2009-11-21 02:48:08 +0000219 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000220
Bill Wendling2f921f82009-05-15 09:23:25 +0000221#ifndef NDEBUG
222 void dump() const;
223#endif
224};
Devang Patel6c74a872010-04-27 19:46:33 +0000225
Chris Lattnerf5d06362010-04-05 04:09:20 +0000226} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000227
228#ifndef NDEBUG
229void DbgScope::dump() const {
David Greenec230cb92009-12-24 00:31:35 +0000230 raw_ostream &err = dbgs();
Chris Lattner81e8e022009-08-23 00:51:00 +0000231 err.indent(IndentLevel);
Devang Patel1f9913f2011-07-14 22:30:56 +0000232 err << "DFSIn: " << DFSIn << " DFSOut: " << DFSOut << "\n";
Devang Patel32cc43c2010-05-07 20:54:48 +0000233 const MDNode *N = Desc;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000234 N->dump();
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000235 if (AbstractScope)
236 err << "Abstract Scope\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000237
238 IndentLevel += 2;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000239 if (!Scopes.empty())
240 err << "Children ...\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000241 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
242 if (Scopes[i] != this)
243 Scopes[i]->dump();
244
245 IndentLevel -= 2;
246}
247#endif
248
Bill Wendling2f921f82009-05-15 09:23:25 +0000249DbgScope::~DbgScope() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000250 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
251 delete Variables[j];
Bill Wendling2f921f82009-05-15 09:23:25 +0000252}
253
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000254DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Devang Patel1a0df9a2010-05-10 22:49:55 +0000255 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000256 AbbreviationsSet(InitAbbreviationsSetSize),
Devang Patel12563b32010-04-16 23:33:45 +0000257 CurrentFnDbgScope(0), PrevLabel(NULL) {
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000258 NextStringPoolNumber = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000259
Rafael Espindolaa7160962011-05-06 14:56:22 +0000260 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattnere58b5472010-04-04 23:10:38 +0000261 DwarfStrSectionSym = TextSectionSym = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000262 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000263 FunctionBeginSym = FunctionEndSym = 0;
Dan Gohman6e681a52010-06-18 15:56:31 +0000264 {
265 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
266 beginModule(M);
Torok Edwinf8dba242010-04-07 10:44:46 +0000267 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000268}
269DwarfDebug::~DwarfDebug() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000270}
271
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000272MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
273 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
274 if (Entry.first) return Entry.first;
275
276 Entry.second = NextStringPoolNumber++;
Chris Lattnera179b522010-04-04 19:25:43 +0000277 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000278}
279
280
Devang Patel930143b2009-11-21 02:48:08 +0000281/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling2f921f82009-05-15 09:23:25 +0000282///
Devang Patel930143b2009-11-21 02:48:08 +0000283void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000284 // Profile the node so that we can make it unique.
285 FoldingSetNodeID ID;
286 Abbrev.Profile(ID);
287
288 // Check the set for priors.
289 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
290
291 // If it's newly added.
292 if (InSet == &Abbrev) {
293 // Add to abbreviation list.
294 Abbreviations.push_back(&Abbrev);
295
296 // Assign the vector position + 1 as its number.
297 Abbrev.setNumber(Abbreviations.size());
298 } else {
299 // Assign existing abbreviation number.
300 Abbrev.setNumber(InSet->getNumber());
301 }
302}
303
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000304/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel43ef34d2010-01-05 01:46:14 +0000305/// printer to not emit usual symbol prefix before the symbol name is used then
306/// return linkage name after skipping this special LLVM prefix.
307static StringRef getRealLinkageName(StringRef LinkageName) {
308 char One = '\1';
309 if (LinkageName.startswith(StringRef(&One, 1)))
310 return LinkageName.substr(1);
311 return LinkageName;
312}
313
Devang Patel525dda02009-12-14 16:18:45 +0000314/// createSubprogramDIE - Create new DIE using SP.
Devang Patel185051c2010-09-27 23:15:27 +0000315DIE *DwarfDebug::createSubprogramDIE(DISubprogram SP) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000316 CompileUnit *SPCU = getCompileUnit(SP);
317 DIE *SPDie = SPCU->getDIE(SP);
Devang Patel525dda02009-12-14 16:18:45 +0000318 if (SPDie)
319 return SPDie;
320
321 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel1d6bbd42011-04-22 23:10:17 +0000322
323 // DW_TAG_inlined_subroutine may refer to this DIE.
324 SPCU->insertDIE(SP, SPDie);
325
326 // Add to context owner.
327 SPCU->addToContextOwner(SPDie, SP.getContext());
328
329 // Add function template parameters.
330 SPCU->addTemplateParams(*SPDie, SP.getTemplateParams());
331
Devang Patel543596d2011-05-03 21:50:34 +0000332 StringRef LinkageName = SP.getLinkageName();
333 if (!LinkageName.empty())
334 SPCU->addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
335 getRealLinkageName(LinkageName));
336
Devang Patel1d6bbd42011-04-22 23:10:17 +0000337 // If this DIE is going to refer declaration info using AT_specification
338 // then there is no need to add other attributes.
339 if (SP.getFunctionDeclaration().isSubprogram())
340 return SPDie;
341
Devang Patelf200b392010-03-02 17:58:15 +0000342 // Constructors and operators for anonymous aggregates do not have names.
Devang Pateld0fa3042010-03-02 01:26:20 +0000343 if (!SP.getName().empty())
Devang Patelf20c4f72011-04-12 22:53:02 +0000344 SPCU->addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
345 SP.getName());
Bill Wendling2f921f82009-05-15 09:23:25 +0000346
Devang Patelf20c4f72011-04-12 22:53:02 +0000347 SPCU->addSourceLine(SPDie, SP);
Bill Wendling2f921f82009-05-15 09:23:25 +0000348
Devang Patel3a24f922010-10-07 22:03:01 +0000349 if (SP.isPrototyped())
Devang Patelf20c4f72011-04-12 22:53:02 +0000350 SPCU->addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Devang Patel1d6bbd42011-04-22 23:10:17 +0000351
Bill Wendling2f921f82009-05-15 09:23:25 +0000352 // Add Return Type.
Devang Patel236526d2009-12-03 01:25:38 +0000353 DICompositeType SPTy = SP.getType();
354 DIArray Args = SPTy.getTypeArray();
Bill Wendling2f921f82009-05-15 09:23:25 +0000355 unsigned SPTag = SPTy.getTag();
Devang Pateleb57c592009-12-03 19:11:07 +0000356
Devang Patel3b548aa2010-03-08 20:52:55 +0000357 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patelf20c4f72011-04-12 22:53:02 +0000358 SPCU->addType(SPDie, SPTy);
Devang Patel236526d2009-12-03 01:25:38 +0000359 else
Devang Patelf20c4f72011-04-12 22:53:02 +0000360 SPCU->addType(SPDie, DIType(Args.getElement(0)));
Devang Patel236526d2009-12-03 01:25:38 +0000361
Devang Pateleb57c592009-12-03 19:11:07 +0000362 unsigned VK = SP.getVirtuality();
363 if (VK) {
Devang Patelf20c4f72011-04-12 22:53:02 +0000364 SPCU->addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
365 DIEBlock *Block = SPCU->getDIEBlock();
366 SPCU->addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
367 SPCU->addUInt(Block, 0, dwarf::DW_FORM_udata, SP.getVirtualIndex());
368 SPCU->addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000369 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000370 SP.getContainingType()));
Devang Pateleb57c592009-12-03 19:11:07 +0000371 }
372
Devang Patel185051c2010-09-27 23:15:27 +0000373 if (!SP.isDefinition()) {
Devang Patelf20c4f72011-04-12 22:53:02 +0000374 SPCU->addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
375
Bill Wendling2f921f82009-05-15 09:23:25 +0000376 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel236526d2009-12-03 01:25:38 +0000377 // be handled while processing variables.
378 DICompositeType SPTy = SP.getType();
379 DIArray Args = SPTy.getTypeArray();
380 unsigned SPTag = SPTy.getTag();
381
Bill Wendling2f921f82009-05-15 09:23:25 +0000382 if (SPTag == dwarf::DW_TAG_subroutine_type)
383 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
384 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000385 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patelf20c4f72011-04-12 22:53:02 +0000386 SPCU->addType(Arg, ATy);
Devang Patel6efc8e52010-02-06 01:02:37 +0000387 if (ATy.isArtificial())
Devang Patelf20c4f72011-04-12 22:53:02 +0000388 SPCU->addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel930143b2009-11-21 02:48:08 +0000389 SPDie->addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000390 }
391 }
392
Devang Patel999b4992010-02-03 19:57:19 +0000393 if (SP.isArtificial())
Devang Patelf20c4f72011-04-12 22:53:02 +0000394 SPCU->addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel999b4992010-02-03 19:57:19 +0000395
Devang Patelb4e3b902010-04-30 19:38:23 +0000396 if (!SP.isLocalToUnit())
Devang Patelf20c4f72011-04-12 22:53:02 +0000397 SPCU->addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000398
Devang Patelb4e3b902010-04-30 19:38:23 +0000399 if (SP.isOptimized())
Devang Patelf20c4f72011-04-12 22:53:02 +0000400 SPCU->addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Devang Patelb4e3b902010-04-30 19:38:23 +0000401
Jim Grosbach965a73a2010-07-21 23:03:52 +0000402 if (unsigned isa = Asm->getISAEncoding()) {
Devang Patelf20c4f72011-04-12 22:53:02 +0000403 SPCU->addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
Jim Grosbach965a73a2010-07-21 23:03:52 +0000404 }
405
Bill Wendling2f921f82009-05-15 09:23:25 +0000406 return SPDie;
407}
408
Devang Patel32cc43c2010-05-07 20:54:48 +0000409DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattner8d2fe282010-03-31 05:36:29 +0000410 assert(N && "Invalid Scope encoding!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000411
412 DbgScope *AScope = AbstractScopes.lookup(N);
413 if (AScope)
414 return AScope;
Jim Grosbach042483e2009-11-21 23:12:12 +0000415
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000416 DbgScope *Parent = NULL;
417
418 DIDescriptor Scope(N);
419 if (Scope.isLexicalBlock()) {
420 DILexicalBlock DB(N);
421 DIDescriptor ParentDesc = DB.getContext();
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000422 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000423 }
424
425 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
426
427 if (Parent)
Devang Patel930143b2009-11-21 02:48:08 +0000428 Parent->addScope(AScope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000429 AScope->setAbstractScope();
430 AbstractScopes[N] = AScope;
431 if (DIDescriptor(N).isSubprogram())
432 AbstractScopesList.push_back(AScope);
433 return AScope;
434}
Devang Patel75cc16c2009-10-01 20:31:14 +0000435
Devang Patel019922d2010-04-06 23:53:48 +0000436/// isSubprogramContext - Return true if Context is either a subprogram
437/// or another context nested inside a subprogram.
Devang Patel32cc43c2010-05-07 20:54:48 +0000438static bool isSubprogramContext(const MDNode *Context) {
Devang Patel019922d2010-04-06 23:53:48 +0000439 if (!Context)
440 return false;
441 DIDescriptor D(Context);
442 if (D.isSubprogram())
443 return true;
444 if (D.isType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000445 return isSubprogramContext(DIType(Context).getContext());
Devang Patel019922d2010-04-06 23:53:48 +0000446 return false;
447}
448
Jim Grosbach042483e2009-11-21 23:12:12 +0000449/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel930143b2009-11-21 02:48:08 +0000450/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
451/// If there are global variables in this scope then create and insert
452/// DIEs for these variables.
Devang Patel32cc43c2010-05-07 20:54:48 +0000453DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000454 CompileUnit *SPCU = getCompileUnit(SPNode);
455 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +0000456
Chris Lattner3a383cb2010-04-05 00:13:49 +0000457 assert(SPDie && "Unable to find subprogram DIE!");
458 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000459
Devang Patel1d6bbd42011-04-22 23:10:17 +0000460 DISubprogram SPDecl = SP.getFunctionDeclaration();
461 if (SPDecl.isSubprogram())
462 // Refer function declaration directly.
Devang Patelf20c4f72011-04-12 22:53:02 +0000463 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Devang Patel1d6bbd42011-04-22 23:10:17 +0000464 createSubprogramDIE(SPDecl));
465 else {
466 // There is not any need to generate specification DIE for a function
467 // defined at compile unit level. If a function is defined inside another
468 // function then gdb prefers the definition at top level and but does not
469 // expect specification DIE in parent function. So avoid creating
470 // specification DIE for a function defined inside a function.
471 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
472 !SP.getContext().isFile() &&
473 !isSubprogramContext(SP.getContext())) {
474 SPCU-> addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
475
476 // Add arguments.
477 DICompositeType SPTy = SP.getType();
478 DIArray Args = SPTy.getTypeArray();
479 unsigned SPTag = SPTy.getTag();
480 if (SPTag == dwarf::DW_TAG_subroutine_type)
481 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
482 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
483 DIType ATy = DIType(DIType(Args.getElement(i)));
484 SPCU->addType(Arg, ATy);
485 if (ATy.isArtificial())
486 SPCU->addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
487 SPDie->addChild(Arg);
488 }
489 DIE *SPDeclDie = SPDie;
490 SPDie = new DIE(dwarf::DW_TAG_subprogram);
491 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
492 SPDeclDie);
493 SPCU->addDie(SPDie);
494 }
Chris Lattner3a383cb2010-04-05 00:13:49 +0000495 }
Devang Patela37a95e2010-07-07 22:20:57 +0000496 // Pick up abstract subprogram DIE.
497 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
498 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf20c4f72011-04-12 22:53:02 +0000499 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
500 dwarf::DW_FORM_ref4, AbsSPDIE);
Devang Patela37a95e2010-07-07 22:20:57 +0000501 SPCU->addDie(SPDie);
502 }
503
Devang Patelf20c4f72011-04-12 22:53:02 +0000504 SPCU->addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
505 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
506 SPCU->addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
507 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
Chris Lattner3a383cb2010-04-05 00:13:49 +0000508 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
509 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patelf20c4f72011-04-12 22:53:02 +0000510 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +0000511
Chris Lattner3a383cb2010-04-05 00:13:49 +0000512 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000513}
514
Jim Grosbach042483e2009-11-21 23:12:12 +0000515/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel930143b2009-11-21 02:48:08 +0000516/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
517DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +0000518
519 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
520 if (Scope->isAbstractScope())
521 return ScopeDIE;
522
523 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
524 if (Ranges.empty())
525 return 0;
526
Devang Patelf20c4f72011-04-12 22:53:02 +0000527 CompileUnit *TheCU = getCompileUnit(Scope->getScopeNode());
Devang Patel6c74a872010-04-27 19:46:33 +0000528 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
529 if (Ranges.size() > 1) {
530 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000531 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +0000532 // DW_AT_ranges appropriately.
Devang Patelf20c4f72011-04-12 22:53:02 +0000533 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
534 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
Devang Patel6c74a872010-04-27 19:46:33 +0000535 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
536 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +0000537 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
538 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +0000539 }
540 DebugRangeSymbols.push_back(NULL);
541 DebugRangeSymbols.push_back(NULL);
542 return ScopeDIE;
543 }
544
Devang Patel9fc11702010-05-25 23:40:22 +0000545 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
546 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +0000547
Devang Patel9fc11702010-05-25 23:40:22 +0000548 if (End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000549
Chris Lattnere13c3722010-03-09 01:58:53 +0000550 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
551 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000552
Devang Patelf20c4f72011-04-12 22:53:02 +0000553 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
554 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000555
556 return ScopeDIE;
557}
558
Devang Patel930143b2009-11-21 02:48:08 +0000559/// constructInlinedScopeDIE - This scope represents inlined body of
560/// a function. Construct DIE to represent this concrete inlined copy
561/// of the function.
562DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +0000563
564 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000565 assert (Ranges.empty() == false
Devang Patel6c74a872010-04-27 19:46:33 +0000566 && "DbgScope does not have instruction markers!");
567
568 // FIXME : .debug_inlined section specification does not clearly state how
569 // to emit inlined scope that is split into multiple instruction ranges.
570 // For now, use first instruction range and emit low_pc/high_pc pair and
571 // corresponding .debug_inlined section entry for this pair.
572 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel9fc11702010-05-25 23:40:22 +0000573 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
574 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +0000575
Devang Patel4c6bd662010-07-08 22:39:20 +0000576 if (StartLabel == 0 || EndLabel == 0) {
Devang Patel6c74a872010-04-27 19:46:33 +0000577 assert (0 && "Unexpected Start and End labels for a inlined scope!");
578 return 0;
579 }
Chris Lattnere13c3722010-03-09 01:58:53 +0000580 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +0000581 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +0000582 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +0000583 "Invalid end label for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +0000584
Devang Patel3b548aa2010-03-08 20:52:55 +0000585 if (!Scope->getScopeNode())
Devang Patelbc97f6b2010-03-08 19:20:38 +0000586 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +0000587 DIScope DS(Scope->getScopeNode());
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000588 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000589 CompileUnit *TheCU = getCompileUnit(InlinedSP);
590 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Devang Patel73bc1722011-05-05 17:54:26 +0000591 if (!OriginDIE) {
592 DEBUG(dbgs() << "Unable to find original DIE for inlined subprogram.");
593 return NULL;
594 }
595 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Devang Patelf20c4f72011-04-12 22:53:02 +0000596 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
597 dwarf::DW_FORM_ref4, OriginDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000598
Devang Patelf20c4f72011-04-12 22:53:02 +0000599 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
600 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000601
602 InlinedSubprogramDIEs.insert(OriginDIE);
603
604 // Track the start label for this inlined function.
Devang Patel32cc43c2010-05-07 20:54:48 +0000605 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000606 I = InlineInfo.find(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000607
608 if (I == InlineInfo.end()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000609 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach00e9c612009-11-22 19:20:36 +0000610 ScopeDIE));
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000611 InlinedSPNodes.push_back(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000612 } else
Chris Lattner085b6522010-03-09 00:31:02 +0000613 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000614
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000615 DILocation DL(Scope->getInlinedAt());
Devang Patelf20c4f72011-04-12 22:53:02 +0000616 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
617 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000618
619 return ScopeDIE;
620}
621
Devang Patelf071d722011-06-24 20:46:11 +0000622/// isUnsignedDIType - Return true if type encoding is unsigned.
623static bool isUnsignedDIType(DIType Ty) {
624 DIDerivedType DTy(Ty);
625 if (DTy.Verify())
626 return isUnsignedDIType(DTy.getTypeDerivedFrom());
627
628 DIBasicType BTy(Ty);
629 if (BTy.Verify()) {
630 unsigned Encoding = BTy.getEncoding();
631 if (Encoding == dwarf::DW_ATE_unsigned ||
632 Encoding == dwarf::DW_ATE_unsigned_char)
633 return true;
634 }
635 return false;
636}
Devang Patel930143b2009-11-21 02:48:08 +0000637
638/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel9ccfb642009-12-09 18:24:21 +0000639DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000640 StringRef Name = DV->getName();
Devang Patel2d9caf92009-11-25 17:36:49 +0000641 if (Name.empty())
Devang Patel97f99fa2009-11-13 02:25:26 +0000642 return NULL;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000643
644 // Translate tag to proper Dwarf tag. The result variable is dropped for
645 // now.
646 unsigned Tag;
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000647 switch (DV->getTag()) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000648 case dwarf::DW_TAG_return_variable:
649 return NULL;
650 case dwarf::DW_TAG_arg_variable:
651 Tag = dwarf::DW_TAG_formal_parameter;
652 break;
653 case dwarf::DW_TAG_auto_variable: // fall thru
654 default:
655 Tag = dwarf::DW_TAG_variable;
656 break;
657 }
658
659 // Define variable debug information entry.
660 DIE *VariableDie = new DIE(Tag);
Devang Patel2606f4d2011-04-25 23:05:21 +0000661 CompileUnit *VariableCU = getCompileUnit(DV->getVariable());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000662 DIE *AbsDIE = NULL;
Devang Patele1c53f22010-05-20 16:36:41 +0000663 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
664 V2AVI = VarToAbstractVarMap.find(DV);
665 if (V2AVI != VarToAbstractVarMap.end())
666 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach042483e2009-11-21 23:12:12 +0000667
Devang Patele1c53f22010-05-20 16:36:41 +0000668 if (AbsDIE)
Devang Patel2606f4d2011-04-25 23:05:21 +0000669 VariableCU->addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patelf20c4f72011-04-12 22:53:02 +0000670 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000671 else {
Devang Patel2606f4d2011-04-25 23:05:21 +0000672 VariableCU->addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
673 Name);
674 VariableCU->addSourceLine(VariableDie, DV->getVariable());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000675
676 // Add variable type.
Devang Patel2606f4d2011-04-25 23:05:21 +0000677 VariableCU->addType(VariableDie, DV->getType());
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000678 }
679
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000680 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patel2606f4d2011-04-25 23:05:21 +0000681 VariableCU->addUInt(VariableDie, dwarf::DW_AT_artificial,
682 dwarf::DW_FORM_flag, 1);
Devang Patelbea08d12010-09-29 23:07:21 +0000683 else if (DIVariable(DV->getVariable()).isArtificial())
Devang Patel2606f4d2011-04-25 23:05:21 +0000684 VariableCU->addUInt(VariableDie, dwarf::DW_AT_artificial,
685 dwarf::DW_FORM_flag, 1);
Devang Patel9fc11702010-05-25 23:40:22 +0000686
687 if (Scope->isAbstractScope()) {
688 DV->setDIE(VariableDie);
689 return VariableDie;
690 }
691
692 // Add variable address.
693
694 unsigned Offset = DV->getDotDebugLocOffset();
695 if (Offset != ~0U) {
Devang Patel2606f4d2011-04-25 23:05:21 +0000696 VariableCU->addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
Devang Patel9fc11702010-05-25 23:40:22 +0000697 Asm->GetTempSymbol("debug_loc", Offset));
698 DV->setDIE(VariableDie);
699 UseDotDebugLocEntry.insert(VariableDie);
700 return VariableDie;
701 }
702
703 // Check if variable is described by a DBG_VALUE instruction.
704 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
705 DbgVariableToDbgInstMap.find(DV);
706 if (DVI != DbgVariableToDbgInstMap.end()) {
707 const MachineInstr *DVInsn = DVI->second;
Devang Patel9fc11702010-05-25 23:40:22 +0000708 bool updated = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000709 // FIXME : Handle getNumOperands != 3
Devang Patel9fc11702010-05-25 23:40:22 +0000710 if (DVInsn->getNumOperands() == 3) {
Devang Patel86ec8b32010-08-31 22:22:42 +0000711 if (DVInsn->getOperand(0).isReg()) {
712 const MachineOperand RegOp = DVInsn->getOperand(0);
713 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
714 if (DVInsn->getOperand(1).isImm() &&
715 TRI->getFrameRegister(*Asm->MF) == RegOp.getReg()) {
Devang Patel77dc5412011-04-27 22:45:24 +0000716 unsigned FrameReg = 0;
717 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
718 int Offset =
719 TFI->getFrameIndexReference(*Asm->MF,
720 DVInsn->getOperand(1).getImm(),
721 FrameReg);
722 MachineLocation Location(FrameReg, Offset);
723 VariableCU->addVariableAddress(DV, VariableDie, Location);
724
725 } else if (RegOp.getReg())
726 VariableCU->addVariableAddress(DV, VariableDie,
727 MachineLocation(RegOp.getReg()));
728 updated = true;
Devang Patel86ec8b32010-08-31 22:22:42 +0000729 }
Devang Patel9fc11702010-05-25 23:40:22 +0000730 else if (DVInsn->getOperand(0).isImm())
Devang Patel3c6aed22011-05-27 16:45:18 +0000731 updated =
732 VariableCU->addConstantValue(VariableDie, DVInsn->getOperand(0),
733 DV->getType());
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000734 else if (DVInsn->getOperand(0).isFPImm())
735 updated =
Devang Patel2606f4d2011-04-25 23:05:21 +0000736 VariableCU->addConstantFPValue(VariableDie, DVInsn->getOperand(0));
Devang Patelf071d722011-06-24 20:46:11 +0000737 else if (DVInsn->getOperand(0).isCImm())
738 updated =
739 VariableCU->addConstantValue(VariableDie,
740 DVInsn->getOperand(0).getCImm(),
741 isUnsignedDIType(DV->getType()));
Devang Patel9fc11702010-05-25 23:40:22 +0000742 } else {
Devang Patel77dc5412011-04-27 22:45:24 +0000743 VariableCU->addVariableAddress(DV, VariableDie,
744 Asm->getDebugValueLocation(DVInsn));
745 updated = true;
Devang Patel9fc11702010-05-25 23:40:22 +0000746 }
747 if (!updated) {
748 // If variableDie is not updated then DBG_VALUE instruction does not
749 // have valid variable info.
750 delete VariableDie;
751 return NULL;
752 }
753 DV->setDIE(VariableDie);
754 return VariableDie;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000755 }
Devang Patel9fc11702010-05-25 23:40:22 +0000756
757 // .. else use frame index, if available.
Devang Patel9fc11702010-05-25 23:40:22 +0000758 int FI = 0;
Devang Patel77dc5412011-04-27 22:45:24 +0000759 if (findVariableFrameIndex(DV, &FI)) {
760 unsigned FrameReg = 0;
761 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
762 int Offset =
763 TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
764 MachineLocation Location(FrameReg, Offset);
765 VariableCU->addVariableAddress(DV, VariableDie, Location);
766 }
767
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000768 DV->setDIE(VariableDie);
769 return VariableDie;
770
771}
Devang Patel930143b2009-11-21 02:48:08 +0000772
773/// constructScopeDIE - Construct a DIE for this scope.
774DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000775 if (!Scope || !Scope->getScopeNode())
776 return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000777
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000778 SmallVector <DIE *, 8> Children;
Devang Patel6c622ef2011-03-01 22:58:55 +0000779
780 // Collect arguments for current function.
781 if (Scope == CurrentFnDbgScope)
782 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
783 if (DbgVariable *ArgDV = CurrentFnArguments[i])
784 if (DIE *Arg = constructVariableDIE(ArgDV, Scope))
785 Children.push_back(Arg);
786
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000787 // Collect lexical scope childrens first.
788 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
789 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
790 if (DIE *Variable = constructVariableDIE(Variables[i], Scope))
791 Children.push_back(Variable);
792 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
793 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
794 if (DIE *Nested = constructScopeDIE(Scopes[j]))
795 Children.push_back(Nested);
Devang Patel3b548aa2010-03-08 20:52:55 +0000796 DIScope DS(Scope->getScopeNode());
797 DIE *ScopeDIE = NULL;
798 if (Scope->getInlinedAt())
799 ScopeDIE = constructInlinedScopeDIE(Scope);
800 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +0000801 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000802 if (Scope->isAbstractScope()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000803 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +0000804 // Note down abstract DIE.
805 if (ScopeDIE)
806 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
807 }
Devang Patel3b548aa2010-03-08 20:52:55 +0000808 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000809 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3b548aa2010-03-08 20:52:55 +0000810 }
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000811 else {
812 // There is no need to emit empty lexical block DIE.
813 if (Children.empty())
814 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +0000815 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000816 }
817
Devang Patel23b2ae62010-03-29 22:59:58 +0000818 if (!ScopeDIE) return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000819
Devang Patel5f1b4cd2011-02-19 01:31:27 +0000820 // Add children
821 for (SmallVector<DIE *, 8>::iterator I = Children.begin(),
822 E = Children.end(); I != E; ++I)
823 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000824
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000825 if (DS.isSubprogram())
Devang Patelf20c4f72011-04-12 22:53:02 +0000826 getCompileUnit(DS)->addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000827
Devang Patel04d2f2d2009-11-24 01:14:22 +0000828 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000829}
830
Bill Wendling2b128d72009-05-20 23:19:06 +0000831/// GetOrCreateSourceID - Look up the source id with the given directory and
832/// source file names. If none currently exists, create a new id and insert it
833/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
834/// maps as well.
Devang Patel498877d2010-07-24 00:53:22 +0000835
Devang Patele01b75c2011-03-24 20:30:50 +0000836unsigned DwarfDebug::GetOrCreateSourceID(StringRef FileName,
837 StringRef DirName) {
Devang Patel871d0b12010-09-16 20:57:49 +0000838 // If FE did not provide a file name, then assume stdin.
839 if (FileName.empty())
Devang Patele01b75c2011-03-24 20:30:50 +0000840 return GetOrCreateSourceID("<stdin>", StringRef());
841
842 // MCStream expects full path name as filename.
Benjamin Kramer440c3b72011-06-05 14:36:47 +0000843 if (!DirName.empty() && !sys::path::is_absolute(FileName)) {
844 SmallString<128> FullPathName = DirName;
845 sys::path::append(FullPathName, FileName);
Devang Patele01b75c2011-03-24 20:30:50 +0000846 // Here FullPathName will be copied into StringMap by GetOrCreateSourceID.
847 return GetOrCreateSourceID(StringRef(FullPathName), StringRef());
848 }
Devang Patel871d0b12010-09-16 20:57:49 +0000849
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000850 StringMapEntry<unsigned> &Entry = SourceIdMap.GetOrCreateValue(FileName);
851 if (Entry.getValue())
852 return Entry.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +0000853
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000854 unsigned SrcId = SourceIdMap.size();
855 Entry.setValue(SrcId);
Bill Wendling2b128d72009-05-20 23:19:06 +0000856
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000857 // Print out a .file directive to specify files for .loc directives.
Devang Patele01b75c2011-03-24 20:30:50 +0000858 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, Entry.getKey());
Bill Wendling2b128d72009-05-20 23:19:06 +0000859
860 return SrcId;
861}
862
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000863/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel1a0df9a2010-05-10 22:49:55 +0000864/// metadata node with tag DW_TAG_compile_unit.
Devang Patel32cc43c2010-05-07 20:54:48 +0000865void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +0000866 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +0000867 StringRef FN = DIUnit.getFilename();
868 StringRef Dir = DIUnit.getDirectory();
Devang Patele01b75c2011-03-24 20:30:50 +0000869 unsigned ID = GetOrCreateSourceID(FN, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +0000870
871 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patelf20c4f72011-04-12 22:53:02 +0000872 CompileUnit *NewCU = new CompileUnit(ID, Die, Asm, this);
873 NewCU->addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
874 DIUnit.getProducer());
875 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
876 DIUnit.getLanguage());
877 NewCU->addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patelbd798ce2010-04-26 22:54:28 +0000878 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
879 // simplifies debug range entries.
Devang Patelf20c4f72011-04-12 22:53:02 +0000880 NewCU->addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Pateld22ed622010-03-22 23:11:36 +0000881 // DW_AT_stmt_list is a offset of line number information for this
Devang Patel4a213872010-08-24 00:06:12 +0000882 // compile unit in debug_line section.
Rafael Espindola2fe0ee12011-05-10 20:35:05 +0000883 if(Asm->MAI->doesDwarfRequireRelocationForSectionOffset())
Rafael Espindolaa7558912011-05-04 17:44:06 +0000884 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Devang Patelf20c4f72011-04-12 22:53:02 +0000885 Asm->GetTempSymbol("section_line"));
Devang Patelea636392010-08-31 23:50:19 +0000886 else
Devang Patelf20c4f72011-04-12 22:53:02 +0000887 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +0000888
Devang Patel2d9caf92009-11-25 17:36:49 +0000889 if (!Dir.empty())
Devang Patelf20c4f72011-04-12 22:53:02 +0000890 NewCU->addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +0000891 if (DIUnit.isOptimized())
Devang Patelf20c4f72011-04-12 22:53:02 +0000892 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendling2b128d72009-05-20 23:19:06 +0000893
Devang Patel2d9caf92009-11-25 17:36:49 +0000894 StringRef Flags = DIUnit.getFlags();
895 if (!Flags.empty())
Devang Patelf20c4f72011-04-12 22:53:02 +0000896 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
897
Bill Wendling2b128d72009-05-20 23:19:06 +0000898 unsigned RVer = DIUnit.getRunTimeVersion();
899 if (RVer)
Devang Patelf20c4f72011-04-12 22:53:02 +0000900 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +0000901 dwarf::DW_FORM_data1, RVer);
902
Devang Patel1a0df9a2010-05-10 22:49:55 +0000903 if (!FirstCU)
904 FirstCU = NewCU;
905 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendling2b128d72009-05-20 23:19:06 +0000906}
907
Devang Patel1a0df9a2010-05-10 22:49:55 +0000908/// getCompielUnit - Get CompileUnit DIE.
909CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
910 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
911 DIDescriptor D(N);
912 const MDNode *CUNode = NULL;
913 if (D.isCompileUnit())
914 CUNode = N;
915 else if (D.isSubprogram())
916 CUNode = DISubprogram(N).getCompileUnit();
917 else if (D.isType())
918 CUNode = DIType(N).getCompileUnit();
919 else if (D.isGlobalVariable())
920 CUNode = DIGlobalVariable(N).getCompileUnit();
921 else if (D.isVariable())
922 CUNode = DIVariable(N).getCompileUnit();
923 else if (D.isNameSpace())
924 CUNode = DINameSpace(N).getCompileUnit();
925 else if (D.isFile())
926 CUNode = DIFile(N).getCompileUnit();
927 else
928 return FirstCU;
929
930 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
931 = CUMap.find(CUNode);
932 if (I == CUMap.end())
933 return FirstCU;
934 return I->second;
935}
936
Devang Patel2d9e5322011-01-20 00:02:16 +0000937// Return const exprssion if value is a GEP to access merged global
938// constant. e.g.
939// i8* getelementptr ({ i8, i8, i8, i8 }* @_MergedGlobals, i32 0, i32 0)
940static const ConstantExpr *getMergedGlobalExpr(const Value *V) {
941 const ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(V);
942 if (!CE || CE->getNumOperands() != 3 ||
943 CE->getOpcode() != Instruction::GetElementPtr)
944 return NULL;
945
946 // First operand points to a global value.
947 if (!isa<GlobalValue>(CE->getOperand(0)))
948 return NULL;
949
950 // Second operand is zero.
951 const ConstantInt *CI =
952 dyn_cast_or_null<ConstantInt>(CE->getOperand(1));
953 if (!CI || !CI->isZero())
954 return NULL;
955
956 // Third operand is offset.
957 if (!isa<ConstantInt>(CE->getOperand(2)))
958 return NULL;
959
960 return CE;
961}
962
Devang Patel1a0df9a2010-05-10 22:49:55 +0000963/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +0000964void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel469c12d22010-08-10 01:37:23 +0000965 DIGlobalVariable GV(N);
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000966
Devang Patelf5d53602009-09-04 23:59:07 +0000967 // If debug information is malformed then ignore it.
Devang Patel469c12d22010-08-10 01:37:23 +0000968 if (GV.Verify() == false)
Devang Patelf5d53602009-09-04 23:59:07 +0000969 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000970
971 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000972 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel469c12d22010-08-10 01:37:23 +0000973 if (TheCU->getDIE(GV))
Devang Patel0751a282009-06-26 01:49:18 +0000974 return;
Bill Wendling2b128d72009-05-20 23:19:06 +0000975
Devang Patel469c12d22010-08-10 01:37:23 +0000976 DIType GTy = GV.getType();
Devang Patelb2197462010-08-10 07:11:13 +0000977 DIE *VariableDIE = new DIE(GV.getTag());
978
979 bool isGlobalVariable = GV.getGlobal() != NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +0000980
Devang Patel469c12d22010-08-10 01:37:23 +0000981 // Add name.
Devang Patelf20c4f72011-04-12 22:53:02 +0000982 TheCU->addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
983 GV.getDisplayName());
Devang Patel469c12d22010-08-10 01:37:23 +0000984 StringRef LinkageName = GV.getLinkageName();
Devang Patelb2197462010-08-10 07:11:13 +0000985 if (!LinkageName.empty() && isGlobalVariable)
Devang Patelf20c4f72011-04-12 22:53:02 +0000986 TheCU->addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name,
987 dwarf::DW_FORM_string,
988 getRealLinkageName(LinkageName));
Devang Patel469c12d22010-08-10 01:37:23 +0000989 // Add type.
Devang Patelf20c4f72011-04-12 22:53:02 +0000990 TheCU->addType(VariableDIE, GTy);
Devang Patele9853f22011-05-31 22:56:51 +0000991
Devang Patel469c12d22010-08-10 01:37:23 +0000992 // Add scoping info.
993 if (!GV.isLocalToUnit()) {
Devang Patelf20c4f72011-04-12 22:53:02 +0000994 TheCU->addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patel469c12d22010-08-10 01:37:23 +0000995 // Expose as global.
996 TheCU->addGlobal(GV.getName(), VariableDIE);
997 }
998 // Add line number info.
Devang Patelf20c4f72011-04-12 22:53:02 +0000999 TheCU->addSourceLine(VariableDIE, GV);
Devang Patel469c12d22010-08-10 01:37:23 +00001000 // Add to map.
1001 TheCU->insertDIE(N, VariableDIE);
1002 // Add to context owner.
1003 DIDescriptor GVContext = GV.getContext();
Devang Patelf20c4f72011-04-12 22:53:02 +00001004 TheCU->addToContextOwner(VariableDIE, GVContext);
Devang Patel469c12d22010-08-10 01:37:23 +00001005 // Add location.
Devang Patelb2197462010-08-10 07:11:13 +00001006 if (isGlobalVariable) {
1007 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patelf20c4f72011-04-12 22:53:02 +00001008 TheCU->addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1009 TheCU->addLabel(Block, 0, dwarf::DW_FORM_udata,
Devang Patelb2197462010-08-10 07:11:13 +00001010 Asm->Mang->getSymbol(GV.getGlobal()));
1011 // Do not create specification DIE if context is either compile unit
1012 // or a subprogram.
1013 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
1014 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
1015 // Create specification DIE.
1016 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
Devang Patelf20c4f72011-04-12 22:53:02 +00001017 TheCU->addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
Devang Patelb2197462010-08-10 07:11:13 +00001018 dwarf::DW_FORM_ref4, VariableDIE);
Devang Patelf20c4f72011-04-12 22:53:02 +00001019 TheCU->addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1020 TheCU->addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Devang Patelb2197462010-08-10 07:11:13 +00001021 TheCU->addDie(VariableSpecDIE);
1022 } else {
Devang Patelf20c4f72011-04-12 22:53:02 +00001023 TheCU->addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
Devang Patelb2197462010-08-10 07:11:13 +00001024 }
Devang Patelf071d722011-06-24 20:46:11 +00001025 } else if (const ConstantInt *CI =
Devang Patel70eb9822011-01-06 21:39:25 +00001026 dyn_cast_or_null<ConstantInt>(GV.getConstant()))
Devang Patelf20c4f72011-04-12 22:53:02 +00001027 TheCU->addConstantValue(VariableDIE, CI, isUnsignedDIType(GTy));
Devang Patel2d9e5322011-01-20 00:02:16 +00001028 else if (const ConstantExpr *CE = getMergedGlobalExpr(N->getOperand(11))) {
1029 // GV is a merged global.
1030 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patelf20c4f72011-04-12 22:53:02 +00001031 TheCU->addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1032 TheCU->addLabel(Block, 0, dwarf::DW_FORM_udata,
1033 Asm->Mang->getSymbol(cast<GlobalValue>(CE->getOperand(0))));
Devang Patel2d9e5322011-01-20 00:02:16 +00001034 ConstantInt *CII = cast<ConstantInt>(CE->getOperand(2));
Devang Patelf20c4f72011-04-12 22:53:02 +00001035 TheCU->addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1036 TheCU->addUInt(Block, 0, dwarf::DW_FORM_udata, CII->getZExtValue());
1037 TheCU->addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1038 TheCU->addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
Devang Patel2d9e5322011-01-20 00:02:16 +00001039 }
Devang Patel70eb9822011-01-06 21:39:25 +00001040
Devang Patel0751a282009-06-26 01:49:18 +00001041 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001042}
1043
Devang Patel1a0df9a2010-05-10 22:49:55 +00001044/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00001045void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001046 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +00001047
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00001048 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001049 CompileUnit *TheCU = getCompileUnit(N);
1050 if (TheCU->getDIE(N))
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00001051 return;
1052
Bill Wendling2b128d72009-05-20 23:19:06 +00001053 if (!SP.isDefinition())
1054 // This is a method declaration which will be handled while constructing
1055 // class type.
Devang Patel0751a282009-06-26 01:49:18 +00001056 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001057
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00001058 DIE *SubprogramDie = createSubprogramDIE(SP);
1059
1060 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001061 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00001062
1063 // Add to context owner.
Devang Patelf20c4f72011-04-12 22:53:02 +00001064 TheCU->addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +00001065
Bill Wendling2b128d72009-05-20 23:19:06 +00001066 // Expose as global.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001067 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00001068
Devang Patel0751a282009-06-26 01:49:18 +00001069 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001070}
1071
Devang Patel930143b2009-11-21 02:48:08 +00001072/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbarbe22ec42009-09-19 20:40:14 +00001073/// content. Create global DIEs and emit initial debug info sections.
1074/// This is inovked by the target AsmPrinter.
Chris Lattner11980022010-04-04 07:48:20 +00001075void DwarfDebug::beginModule(Module *M) {
Devang Patel6c74a872010-04-27 19:46:33 +00001076 if (DisableDebugInfoPrinting)
1077 return;
1078
Devang Patele02e5852011-05-03 16:45:22 +00001079 // If module has named metadata anchors then use them, otherwise scan the module
1080 // using debug info finder to collect debug info.
1081 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
1082 if (CU_Nodes) {
Devang Patelc981f622011-05-04 16:34:02 +00001083
1084 NamedMDNode *GV_Nodes = M->getNamedMetadata("llvm.dbg.gv");
1085 NamedMDNode *SP_Nodes = M->getNamedMetadata("llvm.dbg.sp");
1086 if (!GV_Nodes && !SP_Nodes)
1087 // If there are not any global variables or any functions then
1088 // there is not any debug info in this module.
Devang Patele02e5852011-05-03 16:45:22 +00001089 return;
1090
Devang Patelc981f622011-05-04 16:34:02 +00001091 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i)
1092 constructCompileUnit(CU_Nodes->getOperand(i));
Devang Patele02e5852011-05-03 16:45:22 +00001093
Devang Patelc981f622011-05-04 16:34:02 +00001094 if (GV_Nodes)
1095 for (unsigned i = 0, e = GV_Nodes->getNumOperands(); i != e; ++i)
1096 constructGlobalVariableDIE(GV_Nodes->getOperand(i));
1097
1098 if (SP_Nodes)
1099 for (unsigned i = 0, e = SP_Nodes->getNumOperands(); i != e; ++i)
1100 constructSubprogramDIE(SP_Nodes->getOperand(i));
Devang Patele02e5852011-05-03 16:45:22 +00001101
1102 } else {
1103
1104 DebugInfoFinder DbgFinder;
1105 DbgFinder.processModule(*M);
1106
Devang Patelc981f622011-05-04 16:34:02 +00001107 bool HasDebugInfo = false;
Devang Patele02e5852011-05-03 16:45:22 +00001108 // Scan all the compile-units to see if there are any marked as the main unit.
1109 // if not, we do not generate debug info.
1110 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1111 E = DbgFinder.compile_unit_end(); I != E; ++I) {
1112 if (DICompileUnit(*I).isMain()) {
1113 HasDebugInfo = true;
1114 break;
1115 }
1116 }
Devang Patelc981f622011-05-04 16:34:02 +00001117 if (!HasDebugInfo) return;
Devang Patele02e5852011-05-03 16:45:22 +00001118
1119 // Create all the compile unit DIEs.
1120 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1121 E = DbgFinder.compile_unit_end(); I != E; ++I)
1122 constructCompileUnit(*I);
1123
1124 // Create DIEs for each global variable.
1125 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
1126 E = DbgFinder.global_variable_end(); I != E; ++I)
1127 constructGlobalVariableDIE(*I);
1128
1129 // Create DIEs for each subprogram.
1130 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
1131 E = DbgFinder.subprogram_end(); I != E; ++I)
1132 constructSubprogramDIE(*I);
Chris Lattner7cfa70e2010-04-05 02:19:28 +00001133 }
Devang Patele02e5852011-05-03 16:45:22 +00001134
Chris Lattner7cfa70e2010-04-05 02:19:28 +00001135 // Tell MMI that we have debug info.
1136 MMI->setDebugInfoAvailability(true);
Devang Patele02e5852011-05-03 16:45:22 +00001137
Chris Lattnerd442aa32010-04-04 23:17:54 +00001138 // Emit initial sections.
Chris Lattner7cfa70e2010-04-05 02:19:28 +00001139 EmitSectionLabels();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001140
Devang Patel8e06a5e2010-08-10 20:01:20 +00001141 //getOrCreateTypeDIE
1142 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
Devang Patelf20c4f72011-04-12 22:53:02 +00001143 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1144 DIType Ty(NMD->getOperand(i));
1145 getCompileUnit(Ty)->getOrCreateTypeDIE(Ty);
1146 }
Devang Patel8e06a5e2010-08-10 20:01:20 +00001147
Devang Patel7a554812010-09-28 18:08:20 +00001148 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
Devang Patelf20c4f72011-04-12 22:53:02 +00001149 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1150 DIType Ty(NMD->getOperand(i));
1151 getCompileUnit(Ty)->getOrCreateTypeDIE(Ty);
1152 }
Devang Patel7a554812010-09-28 18:08:20 +00001153
Bill Wendling2b128d72009-05-20 23:19:06 +00001154 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +00001155 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +00001156}
1157
Devang Patel930143b2009-11-21 02:48:08 +00001158/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendling2b128d72009-05-20 23:19:06 +00001159///
Devang Patel930143b2009-11-21 02:48:08 +00001160void DwarfDebug::endModule() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001161 if (!FirstCU) return;
Devang Patelf3b2db62010-06-28 18:25:03 +00001162 const Module *M = MMI->getModule();
Devang Pateld0701282010-08-02 17:32:15 +00001163 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patelf3b2db62010-06-28 18:25:03 +00001164 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
1165 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
1166 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
1167 DISubprogram SP(AllSPs->getOperand(SI));
1168 if (!SP.Verify()) continue;
1169
1170 // Collect info for variables that were optimized out.
Devang Patel18efced2010-07-19 17:53:55 +00001171 if (!SP.isDefinition()) continue;
Devang Patelf3b2db62010-06-28 18:25:03 +00001172 StringRef FName = SP.getLinkageName();
1173 if (FName.empty())
1174 FName = SP.getName();
Devang Patel364bf042010-11-10 22:19:21 +00001175 NamedMDNode *NMD = getFnSpecificMDNode(*(MMI->getModule()), FName);
Devang Patelf3b2db62010-06-28 18:25:03 +00001176 if (!NMD) continue;
1177 unsigned E = NMD->getNumOperands();
1178 if (!E) continue;
1179 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Pateld0701282010-08-02 17:32:15 +00001180 DeadFnScopeMap[SP] = Scope;
Devang Patelf3b2db62010-06-28 18:25:03 +00001181 for (unsigned I = 0; I != E; ++I) {
1182 DIVariable DV(NMD->getOperand(I));
1183 if (!DV.Verify()) continue;
1184 Scope->addVariable(new DbgVariable(DV));
1185 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001186
Devang Patelf3b2db62010-06-28 18:25:03 +00001187 // Construct subprogram DIE and add variables DIEs.
1188 constructSubprogramDIE(SP);
1189 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patel406798a2010-08-09 18:51:29 +00001190 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf3b2db62010-06-28 18:25:03 +00001191 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
1192 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
1193 if (VariableDIE)
1194 ScopeDIE->addChild(VariableDIE);
1195 }
1196 }
1197 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001198
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001199 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1200 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
1201 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
1202 DIE *ISP = *AI;
Devang Patelf20c4f72011-04-12 22:53:02 +00001203 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001204 }
1205
Devang Patel32cc43c2010-05-07 20:54:48 +00001206 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Pateleb57c592009-12-03 19:11:07 +00001207 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
1208 DIE *SPDie = CI->first;
Devang Patel32cc43c2010-05-07 20:54:48 +00001209 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Pateleb57c592009-12-03 19:11:07 +00001210 if (!N) continue;
Devang Patel1a0df9a2010-05-10 22:49:55 +00001211 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Pateleb57c592009-12-03 19:11:07 +00001212 if (!NDie) continue;
Devang Patelf20c4f72011-04-12 22:53:02 +00001213 getCompileUnit(N)->addDIEEntry(SPDie, dwarf::DW_AT_containing_type,
1214 dwarf::DW_FORM_ref4, NDie);
Devang Pateleb57c592009-12-03 19:11:07 +00001215 }
1216
Bill Wendling2b128d72009-05-20 23:19:06 +00001217 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001218 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnera179b522010-04-04 19:25:43 +00001219 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001220 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnera179b522010-04-04 19:25:43 +00001221 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +00001222
1223 // End text sections.
1224 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001225 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnera179b522010-04-04 19:25:43 +00001226 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendling2b128d72009-05-20 23:19:06 +00001227 }
1228
Bill Wendling2b128d72009-05-20 23:19:06 +00001229 // Compute DIE offsets and sizes.
Devang Patel930143b2009-11-21 02:48:08 +00001230 computeSizeAndOffsets();
Bill Wendling2b128d72009-05-20 23:19:06 +00001231
1232 // Emit all the DIEs into a debug info section
Devang Patel930143b2009-11-21 02:48:08 +00001233 emitDebugInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001234
1235 // Corresponding abbreviations into a abbrev section.
Devang Patel930143b2009-11-21 02:48:08 +00001236 emitAbbreviations();
Bill Wendling2b128d72009-05-20 23:19:06 +00001237
Bill Wendling2b128d72009-05-20 23:19:06 +00001238 // Emit info into a debug pubnames section.
Devang Patel930143b2009-11-21 02:48:08 +00001239 emitDebugPubNames();
Bill Wendling2b128d72009-05-20 23:19:06 +00001240
Devang Patel04d2f2d2009-11-24 01:14:22 +00001241 // Emit info into a debug pubtypes section.
1242 emitDebugPubTypes();
1243
Bill Wendling2b128d72009-05-20 23:19:06 +00001244 // Emit info into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00001245 emitDebugLoc();
Bill Wendling2b128d72009-05-20 23:19:06 +00001246
1247 // Emit info into a debug aranges section.
1248 EmitDebugARanges();
1249
1250 // Emit info into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00001251 emitDebugRanges();
Bill Wendling2b128d72009-05-20 23:19:06 +00001252
1253 // Emit info into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00001254 emitDebugMacInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001255
1256 // Emit inline info.
Devang Patel930143b2009-11-21 02:48:08 +00001257 emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001258
Chris Lattnerb7aa9522010-03-13 02:17:42 +00001259 // Emit info into a debug str section.
1260 emitDebugStr();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001261
Devang Pateld0701282010-08-02 17:32:15 +00001262 // clean up.
1263 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001264 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1265 E = CUMap.end(); I != E; ++I)
1266 delete I->second;
1267 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendling2b128d72009-05-20 23:19:06 +00001268}
1269
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001270/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001271DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattner915c5f92010-04-02 19:42:39 +00001272 DebugLoc ScopeLoc) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001273
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001274 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001275 if (AbsDbgVariable)
1276 return AbsDbgVariable;
1277
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001278 LLVMContext &Ctx = Var->getContext();
Chris Lattner915c5f92010-04-02 19:42:39 +00001279 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001280 if (!Scope)
1281 return NULL;
1282
Devang Patele1c53f22010-05-20 16:36:41 +00001283 AbsDbgVariable = new DbgVariable(Var);
Devang Patel930143b2009-11-21 02:48:08 +00001284 Scope->addVariable(AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001285 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001286 return AbsDbgVariable;
1287}
1288
Devang Patel6c622ef2011-03-01 22:58:55 +00001289/// addCurrentFnArgument - If Var is an current function argument that add
1290/// it in CurrentFnArguments list.
1291bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
1292 DbgVariable *Var, DbgScope *Scope) {
1293 if (Scope != CurrentFnDbgScope)
1294 return false;
1295 DIVariable DV = Var->getVariable();
1296 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1297 return false;
1298 unsigned ArgNo = DV.getArgNumber();
1299 if (ArgNo == 0)
1300 return false;
1301
Devang Patel4ab660b2011-03-03 20:02:02 +00001302 size_t Size = CurrentFnArguments.size();
1303 if (Size == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00001304 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00001305 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00001306 // arguments does the function have at source level.
1307 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00001308 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00001309 CurrentFnArguments[ArgNo - 1] = Var;
1310 return true;
1311}
1312
Devang Patel490c8ab2010-05-20 19:57:06 +00001313/// collectVariableInfoFromMMITable - Collect variable information from
1314/// side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001315void
Devang Patel490c8ab2010-05-20 19:57:06 +00001316DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
1317 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patel475d32a2009-10-06 01:26:37 +00001318 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1319 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1320 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00001321 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001322 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00001323 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00001324 DIVariable DV(Var);
1325 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001326
Devang Patel47711592011-07-14 23:17:49 +00001327 DbgScope *Scope = findDbgScope(VP.second);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001328
Devang Patelcdb7d442009-11-10 23:20:04 +00001329 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001330 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001331 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001332
Devang Patele1c53f22010-05-20 16:36:41 +00001333 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
1334 DbgVariable *RegVar = new DbgVariable(DV);
1335 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel6c622ef2011-03-01 22:58:55 +00001336 if (!addCurrentFnArgument(MF, RegVar, Scope))
1337 Scope->addVariable(RegVar);
Devang Patele1c53f22010-05-20 16:36:41 +00001338 if (AbsDbgVariable) {
1339 recordVariableFrameIndex(AbsDbgVariable, VP.first);
1340 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
1341 }
Devang Patel475d32a2009-10-06 01:26:37 +00001342 }
Devang Patel490c8ab2010-05-20 19:57:06 +00001343}
Devang Patela3e9c9c2010-03-15 18:33:46 +00001344
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001345/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +00001346/// DBG_VALUE instruction, is in a defined reg.
1347static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
1348 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001349 return MI->getNumOperands() == 3 &&
1350 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
1351 MI->getOperand(1).isImm() && MI->getOperand(1).getImm() == 0;
Devang Patel9fc11702010-05-25 23:40:22 +00001352}
1353
Devang Patel2442a892011-07-08 17:09:57 +00001354/// getDebugLocEntry - Get .debug_loc entry for the instraction range starting
1355/// at MI.
1356static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1357 const MCSymbol *FLabel,
1358 const MCSymbol *SLabel,
1359 const MachineInstr *MI) {
1360 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1361
1362 if (MI->getNumOperands() != 3) {
1363 MachineLocation MLoc = Asm->getDebugValueLocation(MI);
1364 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1365 }
1366 if (MI->getOperand(0).isReg() && MI->getOperand(1).isImm()) {
1367 MachineLocation MLoc;
1368 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
1369 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1370 }
1371 if (MI->getOperand(0).isImm())
1372 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1373 if (MI->getOperand(0).isFPImm())
1374 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1375 if (MI->getOperand(0).isCImm())
1376 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1377
1378 assert (0 && "Unexpected 3 operand DBG_VALUE instruction!");
1379 return DotDebugLocEntry();
1380}
1381
Devang Patel490c8ab2010-05-20 19:57:06 +00001382/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001383void
Devang Patel5c0f85c2010-06-25 22:07:34 +00001384DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1385 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001386
Devang Patel490c8ab2010-05-20 19:57:06 +00001387 /// collection info from MMI table.
1388 collectVariableInfoFromMMITable(MF, Processed);
1389
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001390 for (SmallVectorImpl<const MDNode*>::const_iterator
1391 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1392 ++UVI) {
1393 const MDNode *Var = *UVI;
1394 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00001395 continue;
1396
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001397 // History contains relevant DBG_VALUE instructions for Var and instructions
1398 // clobbering it.
1399 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1400 if (History.empty())
1401 continue;
1402 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00001403
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001404 DIVariable DV(Var);
Devang Patel447cb382011-01-11 21:42:10 +00001405 DbgScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00001406 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1407 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelfbd6c452010-05-21 00:10:20 +00001408 Scope = CurrentFnDbgScope;
Devang Patel447cb382011-01-11 21:42:10 +00001409 else
Devang Patel47711592011-07-14 23:17:49 +00001410 Scope = findDbgScope(MInsn->getDebugLoc());
Devang Patel490c8ab2010-05-20 19:57:06 +00001411 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00001412 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00001413 continue;
1414
1415 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001416 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel490c8ab2010-05-20 19:57:06 +00001417 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patel6c622ef2011-03-01 22:58:55 +00001418 if (!addCurrentFnArgument(MF, RegVar, Scope))
1419 Scope->addVariable(RegVar);
Devang Patelfbd6c452010-05-21 00:10:20 +00001420 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
1421 DbgVariableToDbgInstMap[AbsVar] = MInsn;
1422 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patela3e9c9c2010-03-15 18:33:46 +00001423 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001424
1425 // Simple ranges that are fully coalesced.
1426 if (History.size() <= 1 || (History.size() == 2 &&
1427 MInsn->isIdenticalTo(History.back()))) {
Devang Patel9fc11702010-05-25 23:40:22 +00001428 DbgVariableToDbgInstMap[RegVar] = MInsn;
1429 continue;
1430 }
1431
1432 // handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001433 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001434
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001435 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1436 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1437 const MachineInstr *Begin = *HI;
1438 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00001439
Devang Patele7181b52011-06-01 23:00:17 +00001440 // Check if DBG_VALUE is truncating a range.
1441 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1442 && !Begin->getOperand(0).getReg())
1443 continue;
1444
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001445 // Compute the range for a register location.
1446 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1447 const MCSymbol *SLabel = 0;
1448
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001449 if (HI + 1 == HE)
1450 // If Begin is the last instruction in History then its value is valid
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001451 // until the end of the function.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001452 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001453 else {
1454 const MachineInstr *End = HI[1];
Devang Patel53b050a2011-07-07 21:44:42 +00001455 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
1456 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001457 if (End->isDebugValue())
1458 SLabel = getLabelBeforeInsn(End);
1459 else {
1460 // End is a normal instruction clobbering the range.
1461 SLabel = getLabelAfterInsn(End);
1462 assert(SLabel && "Forgot label after clobber instruction");
1463 ++HI;
1464 }
1465 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001466
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001467 // The value is valid until the next DBG_VALUE or clobber.
Devang Patel2442a892011-07-08 17:09:57 +00001468 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel, Begin));
Devang Patel9fc11702010-05-25 23:40:22 +00001469 }
1470 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00001471 }
Devang Patele0a94bf2010-05-14 21:01:35 +00001472
1473 // Collect info for variables that were optimized out.
Devang Patelad517352010-06-22 01:01:58 +00001474 const Function *F = MF->getFunction();
Devang Patel364bf042010-11-10 22:19:21 +00001475 if (NamedMDNode *NMD = getFnSpecificMDNode(*(F->getParent()), F->getName())) {
Devang Patele0a94bf2010-05-14 21:01:35 +00001476 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00001477 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel490c8ab2010-05-20 19:57:06 +00001478 if (!DV || !Processed.insert(DV))
Devang Patele0a94bf2010-05-14 21:01:35 +00001479 continue;
1480 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
1481 if (Scope)
Devang Patele1c53f22010-05-20 16:36:41 +00001482 Scope->addVariable(new DbgVariable(DV));
Devang Patele0a94bf2010-05-14 21:01:35 +00001483 }
1484 }
Devang Patel9fc11702010-05-25 23:40:22 +00001485}
Devang Patele0a94bf2010-05-14 21:01:35 +00001486
Devang Patel9fc11702010-05-25 23:40:22 +00001487/// getLabelBeforeInsn - Return Label preceding the instruction.
1488const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001489 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1490 assert(Label && "Didn't insert label before instruction");
1491 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00001492}
1493
1494/// getLabelAfterInsn - Return Label immediately following the instruction.
1495const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001496 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00001497}
1498
Devang Patelb5694e72010-10-26 17:49:02 +00001499/// beginInstruction - Process beginning of an instruction.
1500void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001501 // Check if source location changes, but ignore DBG_VALUE locations.
1502 if (!MI->isDebugValue()) {
1503 DebugLoc DL = MI->getDebugLoc();
1504 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Devang Patel34a66202011-05-11 19:22:19 +00001505 unsigned Flags = DWARF2_FLAG_IS_STMT;
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001506 PrevInstLoc = DL;
Devang Patel34a66202011-05-11 19:22:19 +00001507 if (DL == PrologEndLoc) {
1508 Flags |= DWARF2_FLAG_PROLOGUE_END;
1509 PrologEndLoc = DebugLoc();
1510 }
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001511 if (!DL.isUnknown()) {
1512 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel34a66202011-05-11 19:22:19 +00001513 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001514 } else
Devang Patel34a66202011-05-11 19:22:19 +00001515 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001516 }
Devang Patel9fc11702010-05-25 23:40:22 +00001517 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001518
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001519 // Insert labels where requested.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001520 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1521 LabelsBeforeInsn.find(MI);
1522
1523 // No label needed.
1524 if (I == LabelsBeforeInsn.end())
1525 return;
1526
1527 // Label already assigned.
1528 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00001529 return;
Devang Patelbd477be2010-03-29 17:20:31 +00001530
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001531 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00001532 PrevLabel = MMI->getContext().CreateTempSymbol();
1533 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00001534 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001535 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00001536}
1537
Devang Patelb5694e72010-10-26 17:49:02 +00001538/// endInstruction - Process end of an instruction.
1539void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001540 // Don't create a new label after DBG_VALUE instructions.
1541 // They don't generate code.
1542 if (!MI->isDebugValue())
1543 PrevLabel = 0;
1544
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001545 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1546 LabelsAfterInsn.find(MI);
1547
1548 // No label needed.
1549 if (I == LabelsAfterInsn.end())
1550 return;
1551
1552 // Label already assigned.
1553 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001554 return;
1555
1556 // We need a label after this instruction.
1557 if (!PrevLabel) {
1558 PrevLabel = MMI->getContext().CreateTempSymbol();
1559 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00001560 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001561 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001562}
1563
Devang Patel6c74a872010-04-27 19:46:33 +00001564/// getOrCreateDbgScope - Create DbgScope for the scope.
Devang Patel1f9913f2011-07-14 22:30:56 +00001565DbgScope *DwarfDebug::getOrCreateDbgScope(DebugLoc DL) {
1566 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patel07d61ed2011-07-14 01:14:57 +00001567 MDNode *Scope = NULL;
1568 MDNode *InlinedAt = NULL;
1569 DL.getScopeAndInlinedAt(Scope, InlinedAt, Ctx);
1570
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001571 if (!InlinedAt) {
1572 DbgScope *WScope = DbgScopeMap.lookup(Scope);
1573 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00001574 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001575 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
1576 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Patel6c74a872010-04-27 19:46:33 +00001577 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001578 DbgScope *Parent =
Devang Patel1f9913f2011-07-14 22:30:56 +00001579 getOrCreateDbgScope(DebugLoc::getFromDILexicalBlock(Scope));
Devang Patel6c74a872010-04-27 19:46:33 +00001580 WScope->setParent(Parent);
1581 Parent->addScope(WScope);
Devang Pateld5234bb2011-07-14 01:52:45 +00001582 } else if (DIDescriptor(Scope).isSubprogram()
1583 && DISubprogram(Scope).describes(Asm->MF->getFunction()))
1584 CurrentFnDbgScope = WScope;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001585
Devang Patel6c74a872010-04-27 19:46:33 +00001586 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001587 }
1588
Devang Patel5c0f85c2010-06-25 22:07:34 +00001589 getOrCreateAbstractScope(Scope);
Evan Chengb46f3e22011-07-15 06:26:35 +00001590 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001591 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00001592 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001593
1594 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
Evan Chengb46f3e22011-07-15 06:26:35 +00001595 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
Devang Patel6c74a872010-04-27 19:46:33 +00001596 DbgScope *Parent =
Devang Patel1f9913f2011-07-14 22:30:56 +00001597 getOrCreateDbgScope(DebugLoc::getFromDILocation(InlinedAt));
Devang Patel6c74a872010-04-27 19:46:33 +00001598 WScope->setParent(Parent);
1599 Parent->addScope(WScope);
1600
Evan Chengb46f3e22011-07-15 06:26:35 +00001601 ConcreteScopes[InlinedAt] = WScope;
Devang Patel6c74a872010-04-27 19:46:33 +00001602
1603 return WScope;
Devang Patel8db360d2009-10-06 01:50:42 +00001604}
1605
Devang Patel6c74a872010-04-27 19:46:33 +00001606/// calculateDominanceGraph - Calculate dominance graph for DbgScope
1607/// hierarchy.
1608static void calculateDominanceGraph(DbgScope *Scope) {
1609 assert (Scope && "Unable to calculate scop edominance graph!");
1610 SmallVector<DbgScope *, 4> WorkStack;
1611 WorkStack.push_back(Scope);
1612 unsigned Counter = 0;
1613 while (!WorkStack.empty()) {
1614 DbgScope *WS = WorkStack.back();
1615 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
1616 bool visitedChildren = false;
1617 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
1618 SE = Children.end(); SI != SE; ++SI) {
1619 DbgScope *ChildScope = *SI;
1620 if (!ChildScope->getDFSOut()) {
1621 WorkStack.push_back(ChildScope);
1622 visitedChildren = true;
1623 ChildScope->setDFSIn(++Counter);
1624 break;
1625 }
1626 }
1627 if (!visitedChildren) {
1628 WorkStack.pop_back();
1629 WS->setDFSOut(++Counter);
1630 }
1631 }
1632}
1633
1634/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001635static
Devang Patel1f9913f2011-07-14 22:30:56 +00001636void printDbgScopeInfo(const MachineFunction *MF,
Devang Patel6c74a872010-04-27 19:46:33 +00001637 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
1638{
1639#ifndef NDEBUG
Devang Patel1f9913f2011-07-14 22:30:56 +00001640 LLVMContext &Ctx = MF->getFunction()->getContext();
Devang Patel6c74a872010-04-27 19:46:33 +00001641 unsigned PrevDFSIn = 0;
1642 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
1643 I != E; ++I) {
1644 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1645 II != IE; ++II) {
1646 const MachineInstr *MInsn = II;
Devang Patele07ebe32011-07-14 00:20:24 +00001647 MDNode *Scope = NULL;
1648 MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00001649
1650 // Check if instruction has valid location information.
Devang Patele07ebe32011-07-14 00:20:24 +00001651 DebugLoc MIDL = MInsn->getDebugLoc();
1652 if (!MIDL.isUnknown()) {
1653 MIDL.getScopeAndInlinedAt(Scope, InlinedAt, Ctx);
Devang Patel6c74a872010-04-27 19:46:33 +00001654 dbgs() << " [ ";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001655 if (InlinedAt)
Devang Patel6c74a872010-04-27 19:46:33 +00001656 dbgs() << "*";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001657 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Patel6c74a872010-04-27 19:46:33 +00001658 MI2ScopeMap.find(MInsn);
1659 if (DI != MI2ScopeMap.end()) {
1660 DbgScope *S = DI->second;
1661 dbgs() << S->getDFSIn();
1662 PrevDFSIn = S->getDFSIn();
1663 } else
1664 dbgs() << PrevDFSIn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001665 } else
Devang Patel6c74a872010-04-27 19:46:33 +00001666 dbgs() << " [ x" << PrevDFSIn;
1667 dbgs() << " ]";
1668 MInsn->dump();
1669 }
1670 dbgs() << "\n";
1671 }
1672#endif
1673}
Devang Patel930143b2009-11-21 02:48:08 +00001674/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner848c7d22010-03-31 05:39:57 +00001675/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattner76555b52010-01-26 23:18:02 +00001676bool DwarfDebug::extractScopeInformation() {
Devang Patel75cc16c2009-10-01 20:31:14 +00001677 // If scope information was extracted using .dbg intrinsics then there is not
1678 // any need to extract these information by scanning each instruction.
1679 if (!DbgScopeMap.empty())
1680 return false;
1681
Dan Gohmane9135cb2010-04-23 01:18:53 +00001682 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patel6c74a872010-04-27 19:46:33 +00001683 SmallVector<DbgRange, 4> MIRanges;
1684 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patel07d61ed2011-07-14 01:14:57 +00001685 DebugLoc PrevDL;
Devang Patel6c74a872010-04-27 19:46:33 +00001686 const MachineInstr *RangeBeginMI = NULL;
1687 const MachineInstr *PrevMI = NULL;
Chris Lattner3a383cb2010-04-05 00:13:49 +00001688 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel75cc16c2009-10-01 20:31:14 +00001689 I != E; ++I) {
1690 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1691 II != IE; ++II) {
1692 const MachineInstr *MInsn = II;
Devang Patel6c74a872010-04-27 19:46:33 +00001693
1694 // Check if instruction has valid location information.
Devang Patele07ebe32011-07-14 00:20:24 +00001695 const DebugLoc MIDL = MInsn->getDebugLoc();
1696 if (MIDL.isUnknown()) {
Devang Patel6c74a872010-04-27 19:46:33 +00001697 PrevMI = MInsn;
1698 continue;
1699 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001700
Devang Patel6c74a872010-04-27 19:46:33 +00001701 // If scope has not changed then skip this instruction.
Devang Patel07d61ed2011-07-14 01:14:57 +00001702 if (MIDL == PrevDL) {
Devang Patel6c74a872010-04-27 19:46:33 +00001703 PrevMI = MInsn;
1704 continue;
1705 }
1706
Devang Pateld12c0a22011-02-15 17:56:09 +00001707 // Ignore DBG_VALUE. It does not contribute any instruction in output.
1708 if (MInsn->isDebugValue())
1709 continue;
1710
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001711 if (RangeBeginMI) {
1712 // If we have alread seen a beginning of a instruction range and
Devang Patel6c74a872010-04-27 19:46:33 +00001713 // current instruction scope does not match scope of first instruction
1714 // in this range then create a new instruction range.
Devang Patela9195bc2011-07-14 00:04:53 +00001715 DEBUG(dbgs() << "Creating new instruction range :\n");
Devang Patel2cce0d12011-07-14 00:03:58 +00001716 DEBUG(dbgs() << "Begin Range at " << *RangeBeginMI);
1717 DEBUG(dbgs() << "End Range at " << *PrevMI);
Devang Patela9195bc2011-07-14 00:04:53 +00001718 DEBUG(dbgs() << "Next Range starting at " << *MInsn);
Devang Patel2cce0d12011-07-14 00:03:58 +00001719 DEBUG(dbgs() << "------------------------\n");
Devang Patel6c74a872010-04-27 19:46:33 +00001720 DbgRange R(RangeBeginMI, PrevMI);
Devang Patel1f9913f2011-07-14 22:30:56 +00001721 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevDL);
Devang Patel6c74a872010-04-27 19:46:33 +00001722 MIRanges.push_back(R);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001723 }
Devang Patel6c74a872010-04-27 19:46:33 +00001724
1725 // This is a beginning of a new instruction range.
1726 RangeBeginMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001727
Devang Patel6c74a872010-04-27 19:46:33 +00001728 // Reset previous markers.
1729 PrevMI = MInsn;
Devang Patel07d61ed2011-07-14 01:14:57 +00001730 PrevDL = MIDL;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001731 }
1732 }
1733
Devang Patel6c74a872010-04-27 19:46:33 +00001734 // Create last instruction range.
Devang Patel07d61ed2011-07-14 01:14:57 +00001735 if (RangeBeginMI && PrevMI && !PrevDL.isUnknown()) {
Devang Patel6c74a872010-04-27 19:46:33 +00001736 DbgRange R(RangeBeginMI, PrevMI);
1737 MIRanges.push_back(R);
Devang Patel1f9913f2011-07-14 22:30:56 +00001738 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevDL);
Devang Patel75cc16c2009-10-01 20:31:14 +00001739 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001740
Devang Patel530a0752010-01-04 20:44:00 +00001741 if (!CurrentFnDbgScope)
1742 return false;
1743
Devang Patel6c74a872010-04-27 19:46:33 +00001744 calculateDominanceGraph(CurrentFnDbgScope);
1745 if (PrintDbgScope)
Devang Patel1f9913f2011-07-14 22:30:56 +00001746 printDbgScopeInfo(Asm->MF, MI2ScopeMap);
Devang Patel6c74a872010-04-27 19:46:33 +00001747
1748 // Find ranges of instructions covered by each DbgScope;
1749 DbgScope *PrevDbgScope = NULL;
1750 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
1751 RE = MIRanges.end(); RI != RE; ++RI) {
1752 const DbgRange &R = *RI;
1753 DbgScope *S = MI2ScopeMap.lookup(R.first);
1754 assert (S && "Lost DbgScope for a machine instruction!");
1755 if (PrevDbgScope && !PrevDbgScope->dominates(S))
1756 PrevDbgScope->closeInsnRange(S);
1757 S->openInsnRange(R.first);
1758 S->extendInsnRange(R.second);
1759 PrevDbgScope = S;
1760 }
1761
1762 if (PrevDbgScope)
1763 PrevDbgScope->closeInsnRange();
Devang Patel75cc16c2009-10-01 20:31:14 +00001764
Devang Patel359b0132010-04-08 18:43:56 +00001765 identifyScopeMarkers();
Devang Patelf1d5a1e2010-04-08 15:37:09 +00001766
1767 return !DbgScopeMap.empty();
1768}
1769
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001770/// identifyScopeMarkers() -
Devang Patel6c74a872010-04-27 19:46:33 +00001771/// Each DbgScope has first instruction and last instruction to mark beginning
1772/// and end of a scope respectively. Create an inverse map that list scopes
1773/// starts (and ends) with an instruction. One instruction may start (or end)
1774/// multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00001775void DwarfDebug::identifyScopeMarkers() {
Devang Patel7771b7c2010-01-20 02:05:23 +00001776 SmallVector<DbgScope *, 4> WorkList;
1777 WorkList.push_back(CurrentFnDbgScope);
1778 while (!WorkList.empty()) {
Chris Lattner848c7d22010-03-31 05:39:57 +00001779 DbgScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001780
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001781 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001782 if (!Children.empty())
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001783 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00001784 SE = Children.end(); SI != SE; ++SI)
1785 WorkList.push_back(*SI);
1786
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001787 if (S->isAbstractScope())
1788 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001789
Devang Patel6c74a872010-04-27 19:46:33 +00001790 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
1791 if (Ranges.empty())
1792 continue;
1793 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1794 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001795 assert(RI->first && "DbgRange does not have first instruction!");
1796 assert(RI->second && "DbgRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001797 requestLabelBeforeInsn(RI->first);
1798 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001799 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001800 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001801}
1802
Devang Patel589845d2011-05-09 22:14:49 +00001803/// getScopeNode - Get MDNode for DebugLoc's scope.
1804static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1805 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1806 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1807 return DL.getScope(Ctx);
1808}
1809
Devang Patel34a66202011-05-11 19:22:19 +00001810/// getFnDebugLoc - Walk up the scope chain of given debug loc and find
1811/// line number info for the function.
1812static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1813 const MDNode *Scope = getScopeNode(DL, Ctx);
1814 DISubprogram SP = getDISubprogram(Scope);
1815 if (SP.Verify())
1816 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1817 return DebugLoc();
1818}
1819
Devang Patel930143b2009-11-21 02:48:08 +00001820/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendling2b128d72009-05-20 23:19:06 +00001821/// emitted immediately after the function entry point.
Chris Lattner76555b52010-01-26 23:18:02 +00001822void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00001823 if (!MMI->hasDebugInfo()) return;
Bill Wendlingfcc14142010-04-07 09:28:04 +00001824 if (!extractScopeInformation()) return;
Devang Patel4598eb62009-10-06 18:37:31 +00001825
Devang Patel6c74a872010-04-27 19:46:33 +00001826 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1827 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00001828 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00001829 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00001830
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001831 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1832
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001833 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001834 /// LiveUserVar - Map physreg numbers to the MDNode they contain.
1835 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1836
Devang Patel002d54d2010-05-26 19:37:24 +00001837 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001838 I != E; ++I) {
1839 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00001840 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1841 II != IE; ++II) {
1842 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001843
Devang Patel002d54d2010-05-26 19:37:24 +00001844 if (MI->isDebugValue()) {
Devang Patel002d54d2010-05-26 19:37:24 +00001845 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001846
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001847 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001848 const MDNode *Var =
1849 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001850
1851 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001852 if (isDbgValueInDefinedReg(MI))
1853 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1854
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001855 // Check the history of this variable.
1856 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1857 if (History.empty()) {
1858 UserVariables.push_back(Var);
1859 // The first mention of a function argument gets the FunctionBeginSym
1860 // label, so arguments are visible when breaking at function entry.
1861 DIVariable DV(Var);
1862 if (DV.Verify() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1863 DISubprogram(getDISubprogram(DV.getContext()))
1864 .describes(MF->getFunction()))
1865 LabelsBeforeInsn[MI] = FunctionBeginSym;
1866 } else {
1867 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1868 const MachineInstr *Prev = History.back();
1869 if (Prev->isDebugValue()) {
1870 // Coalesce identical entries at the end of History.
1871 if (History.size() >= 2 &&
Devang Patelb7a328e2011-07-07 00:14:27 +00001872 Prev->isIdenticalTo(History[History.size() - 2])) {
1873 DEBUG(dbgs() << "Coalesce identical DBG_VALUE entries:\n"
1874 << "\t" << *Prev
1875 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001876 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001877 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001878
1879 // Terminate old register assignments that don't reach MI;
1880 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1881 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1882 isDbgValueInDefinedReg(Prev)) {
1883 // Previous register assignment needs to terminate at the end of
1884 // its basic block.
1885 MachineBasicBlock::const_iterator LastMI =
1886 PrevMBB->getLastNonDebugInstr();
Devang Patelb7a328e2011-07-07 00:14:27 +00001887 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001888 // Drop DBG_VALUE for empty range.
Devang Patelb7a328e2011-07-07 00:14:27 +00001889 DEBUG(dbgs() << "Drop DBG_VALUE for empty range:\n"
1890 << "\t" << *Prev << "\n");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001891 History.pop_back();
Devang Patelb7a328e2011-07-07 00:14:27 +00001892 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001893 else {
1894 // Terminate after LastMI.
1895 History.push_back(LastMI);
1896 }
1897 }
1898 }
1899 }
1900 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00001901 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001902 // Not a DBG_VALUE instruction.
1903 if (!MI->isLabel())
1904 AtBlockEntry = false;
1905
Devang Patel34a66202011-05-11 19:22:19 +00001906 // First known non DBG_VALUE location marks beginning of function
1907 // body.
1908 if (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown())
1909 PrologEndLoc = MI->getDebugLoc();
1910
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001911 // Check if the instruction clobbers any registers with debug vars.
1912 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1913 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1914 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1915 continue;
1916 for (const unsigned *AI = TRI->getOverlaps(MOI->getReg());
1917 unsigned Reg = *AI; ++AI) {
1918 const MDNode *Var = LiveUserVar[Reg];
1919 if (!Var)
1920 continue;
1921 // Reg is now clobbered.
1922 LiveUserVar[Reg] = 0;
1923
1924 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001925 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1926 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001927 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001928 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1929 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001930 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001931 const MachineInstr *Prev = History.back();
1932 // Sanity-check: Register assignments are terminated at the end of
1933 // their block.
1934 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1935 continue;
1936 // Is the variable still in Reg?
1937 if (!isDbgValueInDefinedReg(Prev) ||
1938 Prev->getOperand(0).getReg() != Reg)
1939 continue;
1940 // Var is clobbered. Make sure the next instruction gets a label.
1941 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00001942 }
1943 }
Devang Patel002d54d2010-05-26 19:37:24 +00001944 }
Devang Patel002d54d2010-05-26 19:37:24 +00001945 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00001946 }
1947
1948 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1949 I != E; ++I) {
1950 SmallVectorImpl<const MachineInstr*> &History = I->second;
1951 if (History.empty())
1952 continue;
1953
1954 // Make sure the final register assignments are terminated.
1955 const MachineInstr *Prev = History.back();
1956 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1957 const MachineBasicBlock *PrevMBB = Prev->getParent();
1958 MachineBasicBlock::const_iterator LastMI = PrevMBB->getLastNonDebugInstr();
1959 if (LastMI == PrevMBB->end())
1960 // Drop DBG_VALUE for empty range.
1961 History.pop_back();
1962 else {
1963 // Terminate after LastMI.
1964 History.push_back(LastMI);
1965 }
1966 }
1967 // Request labels for the full history.
1968 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1969 const MachineInstr *MI = History[i];
1970 if (MI->isDebugValue())
1971 requestLabelBeforeInsn(MI);
1972 else
1973 requestLabelAfterInsn(MI);
1974 }
1975 }
Devang Patel002d54d2010-05-26 19:37:24 +00001976
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00001977 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00001978 PrevLabel = FunctionBeginSym;
Devang Patel34a66202011-05-11 19:22:19 +00001979
1980 // Record beginning of function.
1981 if (!PrologEndLoc.isUnknown()) {
1982 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1983 MF->getFunction()->getContext());
1984 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1985 FnStartDL.getScope(MF->getFunction()->getContext()),
1986 DWARF2_FLAG_IS_STMT);
1987 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001988}
1989
Devang Patel930143b2009-11-21 02:48:08 +00001990/// endFunction - Gather and emit post-function debug information.
Bill Wendling2b128d72009-05-20 23:19:06 +00001991///
Chris Lattner76555b52010-01-26 23:18:02 +00001992void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendlingfcc14142010-04-07 09:28:04 +00001993 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00001994
Devang Patel530a0752010-01-04 20:44:00 +00001995 if (CurrentFnDbgScope) {
Devang Patel4a8e6e82010-05-22 00:04:14 +00001996
Devang Patel9fc11702010-05-25 23:40:22 +00001997 // Define end label for subprogram.
1998 FunctionEndSym = Asm->GetTempSymbol("func_end",
1999 Asm->getFunctionNumber());
2000 // Assumes in correct section after the entry point.
2001 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002002
Devang Patel5c0f85c2010-06-25 22:07:34 +00002003 SmallPtrSet<const MDNode *, 16> ProcessedVars;
2004 collectVariableInfo(MF, ProcessedVars);
Devang Patel4a8e6e82010-05-22 00:04:14 +00002005
Devang Patel530a0752010-01-04 20:44:00 +00002006 // Construct abstract scopes.
2007 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel5c0f85c2010-06-25 22:07:34 +00002008 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00002009 DISubprogram SP((*AI)->getScopeNode());
2010 if (SP.Verify()) {
2011 // Collect info for variables that were optimized out.
2012 StringRef FName = SP.getLinkageName();
2013 if (FName.empty())
2014 FName = SP.getName();
Devang Patel364bf042010-11-10 22:19:21 +00002015 if (NamedMDNode *NMD =
2016 getFnSpecificMDNode(*(MF->getFunction()->getParent()), FName)) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00002017 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002018 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel5c0f85c2010-06-25 22:07:34 +00002019 if (!DV || !ProcessedVars.insert(DV))
2020 continue;
Devang Patel648df7b2010-06-30 00:11:08 +00002021 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel5c0f85c2010-06-25 22:07:34 +00002022 if (Scope)
2023 Scope->addVariable(new DbgVariable(DV));
2024 }
2025 }
2026 }
Devang Patelc5b31092010-06-30 01:40:11 +00002027 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
2028 constructScopeDIE(*AI);
Devang Patel5c0f85c2010-06-25 22:07:34 +00002029 }
Devang Patel30265c42010-07-07 20:12:52 +00002030
Devang Patel075e9b52010-05-04 06:15:30 +00002031 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002032
Devang Patel075e9b52010-05-04 06:15:30 +00002033 if (!DisableFramePointerElim(*MF))
Devang Patelf20c4f72011-04-12 22:53:02 +00002034 getCompileUnit(CurrentFnDbgScope->getScopeNode())->addUInt(CurFnDIE,
2035 dwarf::DW_AT_APPLE_omit_frame_ptr,
2036 dwarf::DW_FORM_flag, 1);
Devang Patel075e9b52010-05-04 06:15:30 +00002037
2038
Chris Lattner3a383cb2010-04-05 00:13:49 +00002039 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel530a0752010-01-04 20:44:00 +00002040 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00002041 }
2042
Bill Wendling2b128d72009-05-20 23:19:06 +00002043 // Clear debug info
Devang Patelfe189e62010-01-19 01:26:02 +00002044 CurrentFnDbgScope = NULL;
Devang Patelad45d912011-04-22 18:09:57 +00002045 DeleteContainerPointers(CurrentFnArguments);
Devang Patele1c53f22010-05-20 16:36:41 +00002046 DbgVariableToFrameIndexMap.clear();
2047 VarToAbstractVarMap.clear();
2048 DbgVariableToDbgInstMap.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002049 DeleteContainerSeconds(DbgScopeMap);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002050 UserVariables.clear();
2051 DbgValues.clear();
Devang Patelfe189e62010-01-19 01:26:02 +00002052 ConcreteScopes.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002053 DeleteContainerSeconds(AbstractScopes);
Devang Patelfe189e62010-01-19 01:26:02 +00002054 AbstractScopesList.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002055 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00002056 LabelsBeforeInsn.clear();
2057 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00002058 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00002059}
2060
Devang Patele1c53f22010-05-20 16:36:41 +00002061/// recordVariableFrameIndex - Record a variable's index.
2062void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2063 assert (V && "Invalid DbgVariable!");
2064 DbgVariableToFrameIndexMap[V] = Index;
2065}
2066
2067/// findVariableFrameIndex - Return true if frame index for the variable
2068/// is found. Update FI to hold value of the index.
2069bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
2070 assert (V && "Invalid DbgVariable!");
2071 DenseMap<const DbgVariable *, int>::iterator I =
2072 DbgVariableToFrameIndexMap.find(V);
2073 if (I == DbgVariableToFrameIndexMap.end())
2074 return false;
2075 *FI = I->second;
2076 return true;
2077}
2078
Devang Patel47711592011-07-14 23:17:49 +00002079/// findDbgScope - Find DbgScope for the debug loc.
2080DbgScope *DwarfDebug::findDbgScope(DebugLoc DL) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002081 if (DL.isUnknown())
Devang Patel47711592011-07-14 23:17:49 +00002082 return NULL;
Devang Patel490c8ab2010-05-20 19:57:06 +00002083
Devang Patel47711592011-07-14 23:17:49 +00002084 DbgScope *Scope = NULL;
2085 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Evan Chengb46f3e22011-07-15 06:26:35 +00002086 if (const MDNode *IA = DL.getInlinedAt(Ctx))
2087 Scope = ConcreteScopes.lookup(IA);
Devang Patel490c8ab2010-05-20 19:57:06 +00002088 if (Scope == 0)
2089 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002090
Devang Patel490c8ab2010-05-20 19:57:06 +00002091 return Scope;
2092}
2093
2094
Chris Lattnerba35a672010-03-09 04:54:43 +00002095/// recordSourceLine - Register a source line with debug info. Returns the
2096/// unique label that was emitted and which provides correspondence to
2097/// the source line list.
Devang Patel34a66202011-05-11 19:22:19 +00002098void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
2099 unsigned Flags) {
Devang Patel2d9caf92009-11-25 17:36:49 +00002100 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00002101 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00002102 unsigned Src = 1;
2103 if (S) {
2104 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00002105
Dan Gohman50849c62010-05-05 23:41:32 +00002106 if (Scope.isCompileUnit()) {
2107 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00002108 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00002109 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00002110 } else if (Scope.isFile()) {
2111 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00002112 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00002113 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00002114 } else if (Scope.isSubprogram()) {
2115 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00002116 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00002117 Dir = SP.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00002118 } else if (Scope.isLexicalBlock()) {
2119 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00002120 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00002121 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00002122 } else
2123 assert(0 && "Unexpected scope info");
2124
Devang Patele01b75c2011-03-24 20:30:50 +00002125 Src = GetOrCreateSourceID(Fn, Dir);
Dan Gohman50849c62010-05-05 23:41:32 +00002126 }
Devang Patel34a66202011-05-11 19:22:19 +00002127 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags,
Devang Patel17740e72011-04-18 20:26:49 +00002128 0, 0, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00002129}
2130
Bill Wendling806535f2009-05-20 23:22:40 +00002131//===----------------------------------------------------------------------===//
2132// Emit Methods
2133//===----------------------------------------------------------------------===//
2134
Devang Patel930143b2009-11-21 02:48:08 +00002135/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling480ff322009-05-20 23:21:38 +00002136///
Jim Grosbach00e9c612009-11-22 19:20:36 +00002137unsigned
2138DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling480ff322009-05-20 23:21:38 +00002139 // Get the children.
2140 const std::vector<DIE *> &Children = Die->getChildren();
2141
2142 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00002143 if (!Last && !Children.empty())
Benjamin Kramer74729ae2010-03-31 19:34:01 +00002144 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling480ff322009-05-20 23:21:38 +00002145
2146 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00002147 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00002148
2149 // Get the abbreviation for this DIE.
2150 unsigned AbbrevNumber = Die->getAbbrevNumber();
2151 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2152
2153 // Set DIE offset
2154 Die->setOffset(Offset);
2155
2156 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00002157 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00002158
2159 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2160 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2161
2162 // Size the DIE attribute values.
2163 for (unsigned i = 0, N = Values.size(); i < N; ++i)
2164 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00002165 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00002166
2167 // Size the DIE children if any.
2168 if (!Children.empty()) {
2169 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
2170 "Children flag not set");
2171
2172 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00002173 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling480ff322009-05-20 23:21:38 +00002174
2175 // End of children marker.
2176 Offset += sizeof(int8_t);
2177 }
2178
2179 Die->setSize(Offset - Die->getOffset());
2180 return Offset;
2181}
2182
Devang Patel930143b2009-11-21 02:48:08 +00002183/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling480ff322009-05-20 23:21:38 +00002184///
Devang Patel930143b2009-11-21 02:48:08 +00002185void DwarfDebug::computeSizeAndOffsets() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002186 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2187 E = CUMap.end(); I != E; ++I) {
2188 // Compute size of compile unit header.
Devang Patel28dce702011-04-12 23:10:47 +00002189 unsigned Offset =
Devang Patel1a0df9a2010-05-10 22:49:55 +00002190 sizeof(int32_t) + // Length of Compilation Unit Info
2191 sizeof(int16_t) + // DWARF version number
2192 sizeof(int32_t) + // Offset Into Abbrev. Section
2193 sizeof(int8_t); // Pointer Size (in bytes)
2194 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002195 }
Bill Wendling480ff322009-05-20 23:21:38 +00002196}
2197
Chris Lattner1fbf53b2010-04-04 23:02:02 +00002198/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
2199/// temporary label to it if SymbolStem is specified.
Chris Lattner6629ca92010-04-04 22:59:04 +00002200static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner1fbf53b2010-04-04 23:02:02 +00002201 const char *SymbolStem = 0) {
Chris Lattner6629ca92010-04-04 22:59:04 +00002202 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner1fbf53b2010-04-04 23:02:02 +00002203 if (!SymbolStem) return 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002204
Chris Lattner6629ca92010-04-04 22:59:04 +00002205 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
2206 Asm->OutStreamer.EmitLabel(TmpSym);
2207 return TmpSym;
2208}
2209
2210/// EmitSectionLabels - Emit initial Dwarf sections with a label at
2211/// the start of each one.
Chris Lattner46355d82010-04-04 22:33:59 +00002212void DwarfDebug::EmitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002213 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002214
Bill Wendling480ff322009-05-20 23:21:38 +00002215 // Dwarf sections base addresses.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002216 DwarfInfoSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00002217 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002218 DwarfAbbrevSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00002219 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00002220 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002221
Chris Lattner6629ca92010-04-04 22:59:04 +00002222 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner1fbf53b2010-04-04 23:02:02 +00002223 EmitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00002224
Devang Patel4a213872010-08-24 00:06:12 +00002225 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00002226 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
2227 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2228 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002229 DwarfStrSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00002230 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patel12563b32010-04-16 23:33:45 +00002231 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
2232 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00002233
Devang Patel9fc11702010-05-25 23:40:22 +00002234 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
2235 "section_debug_loc");
2236
Chris Lattner6629ca92010-04-04 22:59:04 +00002237 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattnere58b5472010-04-04 23:10:38 +00002238 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002239}
2240
Devang Patel930143b2009-11-21 02:48:08 +00002241/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling480ff322009-05-20 23:21:38 +00002242///
Devang Patel930143b2009-11-21 02:48:08 +00002243void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00002244 // Get the abbreviation for this DIE.
2245 unsigned AbbrevNumber = Die->getAbbrevNumber();
2246 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2247
Bill Wendling480ff322009-05-20 23:21:38 +00002248 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00002249 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00002250 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2251 Twine::utohexstr(Die->getOffset()) + ":0x" +
2252 Twine::utohexstr(Die->getSize()) + " " +
2253 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00002254 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00002255
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00002256 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00002257 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2258
2259 // Emit the DIE attribute values.
2260 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2261 unsigned Attr = AbbrevData[i].getAttribute();
2262 unsigned Form = AbbrevData[i].getForm();
2263 assert(Form && "Too many attributes for DIE (check abbreviation)");
2264
Chris Lattner7bde8c02010-04-04 18:52:31 +00002265 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00002266 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002267
Bill Wendling480ff322009-05-20 23:21:38 +00002268 switch (Attr) {
2269 case dwarf::DW_AT_sibling:
Devang Patel930143b2009-11-21 02:48:08 +00002270 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00002271 break;
2272 case dwarf::DW_AT_abstract_origin: {
2273 DIEEntry *E = cast<DIEEntry>(Values[i]);
2274 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002275 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00002276 Asm->EmitInt32(Addr);
2277 break;
2278 }
Devang Patel12563b32010-04-16 23:33:45 +00002279 case dwarf::DW_AT_ranges: {
2280 // DW_AT_range Value encodes offset in debug_range section.
2281 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00002282
2283 if (Asm->MAI->doesDwarfUsesLabelOffsetForRanges()) {
2284 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
2285 V->getValue(),
2286 4);
2287 } else {
2288 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
2289 V->getValue(),
2290 DwarfDebugRangeSectionSym,
2291 4);
2292 }
Devang Patel12563b32010-04-16 23:33:45 +00002293 break;
2294 }
Devang Patel9fc11702010-05-25 23:40:22 +00002295 case dwarf::DW_AT_location: {
2296 if (UseDotDebugLocEntry.count(Die) != 0) {
2297 DIELabel *L = cast<DIELabel>(Values[i]);
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002298 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Devang Patel9fc11702010-05-25 23:40:22 +00002299 } else
2300 Values[i]->EmitValue(Asm, Form);
2301 break;
2302 }
Devang Patela1bd5a12010-09-29 19:08:08 +00002303 case dwarf::DW_AT_accessibility: {
2304 if (Asm->isVerbose()) {
2305 DIEInteger *V = cast<DIEInteger>(Values[i]);
2306 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2307 }
2308 Values[i]->EmitValue(Asm, Form);
2309 break;
2310 }
Bill Wendling480ff322009-05-20 23:21:38 +00002311 default:
2312 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002313 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00002314 break;
2315 }
Bill Wendling480ff322009-05-20 23:21:38 +00002316 }
2317
2318 // Emit the DIE children if any.
2319 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2320 const std::vector<DIE *> &Children = Die->getChildren();
2321
2322 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00002323 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00002324
Chris Lattner7bde8c02010-04-04 18:52:31 +00002325 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00002326 Asm->OutStreamer.AddComment("End Of Children Mark");
2327 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00002328 }
2329}
2330
Devang Patel9ccfb642009-12-09 18:24:21 +00002331/// emitDebugInfo - Emit the debug info section.
Bill Wendling480ff322009-05-20 23:21:38 +00002332///
Devang Patel9ccfb642009-12-09 18:24:21 +00002333void DwarfDebug::emitDebugInfo() {
2334 // Start debug info section.
2335 Asm->OutStreamer.SwitchSection(
2336 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel1a0df9a2010-05-10 22:49:55 +00002337 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2338 E = CUMap.end(); I != E; ++I) {
2339 CompileUnit *TheCU = I->second;
2340 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002341
Devang Patel1a0df9a2010-05-10 22:49:55 +00002342 // Emit the compile units header.
2343 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
2344 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002345
Devang Patel1a0df9a2010-05-10 22:49:55 +00002346 // Emit size of content not including length itself
2347 unsigned ContentSize = Die->getSize() +
2348 sizeof(int16_t) + // DWARF version number
2349 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patele141234942011-04-13 19:41:17 +00002350 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002351
Devang Patel1a0df9a2010-05-10 22:49:55 +00002352 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2353 Asm->EmitInt32(ContentSize);
2354 Asm->OutStreamer.AddComment("DWARF version number");
2355 Asm->EmitInt16(dwarf::DWARF_VERSION);
2356 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
2357 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
2358 DwarfAbbrevSectionSym);
2359 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2360 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002361
Devang Patel1a0df9a2010-05-10 22:49:55 +00002362 emitDIE(Die);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002363 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
2364 }
Bill Wendling480ff322009-05-20 23:21:38 +00002365}
2366
Devang Patel930143b2009-11-21 02:48:08 +00002367/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling480ff322009-05-20 23:21:38 +00002368///
Devang Patel930143b2009-11-21 02:48:08 +00002369void DwarfDebug::emitAbbreviations() const {
Bill Wendling480ff322009-05-20 23:21:38 +00002370 // Check to see if it is worth the effort.
2371 if (!Abbreviations.empty()) {
2372 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002373 Asm->OutStreamer.SwitchSection(
2374 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002375
Chris Lattnera179b522010-04-04 19:25:43 +00002376 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00002377
2378 // For each abbrevation.
2379 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2380 // Get abbreviation data
2381 const DIEAbbrev *Abbrev = Abbreviations[i];
2382
2383 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00002384 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00002385
2386 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002387 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00002388 }
2389
2390 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00002391 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00002392
Chris Lattnera179b522010-04-04 19:25:43 +00002393 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00002394 }
2395}
2396
Devang Patel930143b2009-11-21 02:48:08 +00002397/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling480ff322009-05-20 23:21:38 +00002398/// the line matrix.
2399///
Devang Patel930143b2009-11-21 02:48:08 +00002400void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00002401 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00002402 Asm->OutStreamer.AddComment("Extended Op");
2403 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002404
Chris Lattner566cae92010-03-09 23:52:58 +00002405 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00002406 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00002407 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2408 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2409
2410 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002411
Chris Lattnera179b522010-04-04 19:25:43 +00002412 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattner3a383cb2010-04-05 00:13:49 +00002413 Asm->getTargetData().getPointerSize(),
2414 0/*AddrSpace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00002415
2416 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00002417 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2418 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002419 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00002420 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002421}
2422
Devang Patel9ccfb642009-12-09 18:24:21 +00002423/// emitDebugPubNames - Emit visible names into a debug pubnames section.
2424///
2425void DwarfDebug::emitDebugPubNames() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002426 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2427 E = CUMap.end(); I != E; ++I) {
2428 CompileUnit *TheCU = I->second;
2429 // Start the dwarf pubnames section.
2430 Asm->OutStreamer.SwitchSection(
2431 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002432
Devang Patel1a0df9a2010-05-10 22:49:55 +00002433 Asm->OutStreamer.AddComment("Length of Public Names Info");
2434 Asm->EmitLabelDifference(
2435 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
2436 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002437
Devang Patel1a0df9a2010-05-10 22:49:55 +00002438 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
2439 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002440
Devang Patel1a0df9a2010-05-10 22:49:55 +00002441 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002442 Asm->EmitInt16(dwarf::DWARF_VERSION);
2443
Devang Patel1a0df9a2010-05-10 22:49:55 +00002444 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002445 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00002446 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002447
Devang Patel1a0df9a2010-05-10 22:49:55 +00002448 Asm->OutStreamer.AddComment("Compilation Unit Length");
2449 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
2450 Asm->GetTempSymbol("info_begin", TheCU->getID()),
2451 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002452
Devang Patel1a0df9a2010-05-10 22:49:55 +00002453 const StringMap<DIE*> &Globals = TheCU->getGlobals();
2454 for (StringMap<DIE*>::const_iterator
2455 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2456 const char *Name = GI->getKeyData();
2457 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002458
Devang Patel1a0df9a2010-05-10 22:49:55 +00002459 Asm->OutStreamer.AddComment("DIE offset");
2460 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002461
Devang Patel1a0df9a2010-05-10 22:49:55 +00002462 if (Asm->isVerbose())
2463 Asm->OutStreamer.AddComment("External Name");
2464 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
2465 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002466
Devang Patel1a0df9a2010-05-10 22:49:55 +00002467 Asm->OutStreamer.AddComment("End Mark");
2468 Asm->EmitInt32(0);
2469 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
2470 TheCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00002471 }
Bill Wendling480ff322009-05-20 23:21:38 +00002472}
2473
Devang Patel04d2f2d2009-11-24 01:14:22 +00002474void DwarfDebug::emitDebugPubTypes() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002475 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2476 E = CUMap.end(); I != E; ++I) {
2477 CompileUnit *TheCU = I->second;
2478 // Start the dwarf pubnames section.
2479 Asm->OutStreamer.SwitchSection(
2480 Asm->getObjFileLowering().getDwarfPubTypesSection());
2481 Asm->OutStreamer.AddComment("Length of Public Types Info");
2482 Asm->EmitLabelDifference(
2483 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
2484 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002485
Devang Patel1a0df9a2010-05-10 22:49:55 +00002486 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
2487 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002488
Devang Patel1a0df9a2010-05-10 22:49:55 +00002489 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
2490 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002491
Devang Patel1a0df9a2010-05-10 22:49:55 +00002492 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2493 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
2494 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002495
Devang Patel1a0df9a2010-05-10 22:49:55 +00002496 Asm->OutStreamer.AddComment("Compilation Unit Length");
2497 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
2498 Asm->GetTempSymbol("info_begin", TheCU->getID()),
2499 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002500
Devang Patel1a0df9a2010-05-10 22:49:55 +00002501 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
2502 for (StringMap<DIE*>::const_iterator
2503 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2504 const char *Name = GI->getKeyData();
2505 DIE * Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002506
Devang Patel1a0df9a2010-05-10 22:49:55 +00002507 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
2508 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002509
Devang Patel1a0df9a2010-05-10 22:49:55 +00002510 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
2511 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
2512 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002513
Devang Patel1a0df9a2010-05-10 22:49:55 +00002514 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002515 Asm->EmitInt32(0);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002516 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
2517 TheCU->getID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00002518 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00002519}
2520
Devang Patel930143b2009-11-21 02:48:08 +00002521/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling480ff322009-05-20 23:21:38 +00002522///
Devang Patel930143b2009-11-21 02:48:08 +00002523void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00002524 // Check to see if it is worth the effort.
Chris Lattner3d72a672010-03-09 23:38:23 +00002525 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002526
Chris Lattner3d72a672010-03-09 23:38:23 +00002527 // Start the dwarf str section.
2528 Asm->OutStreamer.SwitchSection(
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002529 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002530
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002531 // Get all of the string pool entries and put them in an array by their ID so
2532 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002533 SmallVector<std::pair<unsigned,
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002534 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002535
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002536 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
2537 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
2538 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002539
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002540 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002541
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002542 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00002543 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002544 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002545
Chris Lattner3d72a672010-03-09 23:38:23 +00002546 // Emit the string itself.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002547 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00002548 }
2549}
2550
Devang Patel930143b2009-11-21 02:48:08 +00002551/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling480ff322009-05-20 23:21:38 +00002552///
Devang Patel930143b2009-11-21 02:48:08 +00002553void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002554 if (DotDebugLocEntries.empty())
2555 return;
2556
Devang Patel116a9d72011-02-04 22:57:18 +00002557 for (SmallVector<DotDebugLocEntry, 4>::iterator
2558 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2559 I != E; ++I) {
2560 DotDebugLocEntry &Entry = *I;
2561 if (I + 1 != DotDebugLocEntries.end())
2562 Entry.Merge(I+1);
2563 }
2564
Daniel Dunbarfd95b012011-03-16 22:16:39 +00002565 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002566 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00002567 Asm->getObjFileLowering().getDwarfLocSection());
2568 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002569 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2570 unsigned index = 1;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002571 for (SmallVector<DotDebugLocEntry, 4>::iterator
2572 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00002573 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00002574 DotDebugLocEntry &Entry = *I;
2575 if (Entry.isMerged()) continue;
Devang Patel9fc11702010-05-25 23:40:22 +00002576 if (Entry.isEmpty()) {
2577 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
2578 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002579 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00002580 } else {
2581 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
2582 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
Devang Patel3e021532011-04-28 02:22:40 +00002583 DIVariable DV(Entry.Variable);
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002584 Asm->OutStreamer.AddComment("Loc expr size");
2585 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2586 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2587 Asm->EmitLabelDifference(end, begin, 2);
2588 Asm->OutStreamer.EmitLabel(begin);
Devang Pateled9fd452011-07-08 16:49:43 +00002589 if (Entry.isInt()) {
Devang Patel324f8432011-06-01 22:03:25 +00002590 DIBasicType BTy(DV.getType());
2591 if (BTy.Verify() &&
2592 (BTy.getEncoding() == dwarf::DW_ATE_signed
2593 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2594 Asm->OutStreamer.AddComment("DW_OP_consts");
2595 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Pateled9fd452011-07-08 16:49:43 +00002596 Asm->EmitSLEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002597 } else {
2598 Asm->OutStreamer.AddComment("DW_OP_constu");
2599 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Pateled9fd452011-07-08 16:49:43 +00002600 Asm->EmitULEB128(Entry.getInt());
Devang Patel324f8432011-06-01 22:03:25 +00002601 }
Devang Pateled9fd452011-07-08 16:49:43 +00002602 } else if (Entry.isLocation()) {
2603 if (!DV.hasComplexAddress())
2604 // Regular entry.
Devang Patel3e021532011-04-28 02:22:40 +00002605 Asm->EmitDwarfRegOp(Entry.Loc);
Devang Pateled9fd452011-07-08 16:49:43 +00002606 else {
2607 // Complex address entry.
2608 unsigned N = DV.getNumAddrElements();
2609 unsigned i = 0;
2610 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
2611 if (Entry.Loc.getOffset()) {
2612 i = 2;
2613 Asm->EmitDwarfRegOp(Entry.Loc);
2614 Asm->OutStreamer.AddComment("DW_OP_deref");
2615 Asm->EmitInt8(dwarf::DW_OP_deref);
2616 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2617 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2618 Asm->EmitSLEB128(DV.getAddrElement(1));
2619 } else {
2620 // If first address element is OpPlus then emit
2621 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
2622 MachineLocation Loc(Entry.Loc.getReg(), DV.getAddrElement(1));
2623 Asm->EmitDwarfRegOp(Loc);
2624 i = 2;
2625 }
2626 } else {
2627 Asm->EmitDwarfRegOp(Entry.Loc);
2628 }
2629
2630 // Emit remaining complex address elements.
2631 for (; i < N; ++i) {
2632 uint64_t Element = DV.getAddrElement(i);
2633 if (Element == DIBuilder::OpPlus) {
2634 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2635 Asm->EmitULEB128(DV.getAddrElement(++i));
2636 } else if (Element == DIBuilder::OpDeref)
2637 Asm->EmitInt8(dwarf::DW_OP_deref);
2638 else llvm_unreachable("unknown Opcode found in complex address");
2639 }
Devang Patel3e021532011-04-28 02:22:40 +00002640 }
Devang Patel3e021532011-04-28 02:22:40 +00002641 }
Devang Pateled9fd452011-07-08 16:49:43 +00002642 // else ... ignore constant fp. There is not any good way to
2643 // to represent them here in dwarf.
Rafael Espindolad23bfb82011-05-27 22:05:41 +00002644 Asm->OutStreamer.EmitLabel(end);
Devang Patel9fc11702010-05-25 23:40:22 +00002645 }
2646 }
Bill Wendling480ff322009-05-20 23:21:38 +00002647}
2648
2649/// EmitDebugARanges - Emit visible names into a debug aranges section.
2650///
2651void DwarfDebug::EmitDebugARanges() {
2652 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002653 Asm->OutStreamer.SwitchSection(
2654 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002655}
2656
Devang Patel930143b2009-11-21 02:48:08 +00002657/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling480ff322009-05-20 23:21:38 +00002658///
Devang Patel930143b2009-11-21 02:48:08 +00002659void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002660 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002661 Asm->OutStreamer.SwitchSection(
Devang Patel12563b32010-04-16 23:33:45 +00002662 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Patel6c74a872010-04-27 19:46:33 +00002663 unsigned char Size = Asm->getTargetData().getPointerSize();
2664 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002665 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00002666 I != E; ++I) {
2667 if (*I)
2668 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patel12563b32010-04-16 23:33:45 +00002669 else
Devang Patel6c74a872010-04-27 19:46:33 +00002670 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel12563b32010-04-16 23:33:45 +00002671 }
Bill Wendling480ff322009-05-20 23:21:38 +00002672}
2673
Devang Patel930143b2009-11-21 02:48:08 +00002674/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling480ff322009-05-20 23:21:38 +00002675///
Devang Patel930143b2009-11-21 02:48:08 +00002676void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002677 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00002678 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00002679 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002680 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00002681 }
2682}
2683
Devang Patel930143b2009-11-21 02:48:08 +00002684/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling480ff322009-05-20 23:21:38 +00002685/// Section Header:
2686/// 1. length of section
2687/// 2. Dwarf version number
2688/// 3. address size.
2689///
2690/// Entries (one "entry" for each function that was inlined):
2691///
2692/// 1. offset into __debug_str section for MIPS linkage name, if exists;
2693/// otherwise offset into __debug_str for regular function name.
2694/// 2. offset into __debug_str section for regular function name.
2695/// 3. an unsigned LEB128 number indicating the number of distinct inlining
2696/// instances for the function.
2697///
2698/// The rest of the entry consists of a {die_offset, low_pc} pair for each
2699/// inlined instance; the die_offset points to the inlined_subroutine die in the
2700/// __debug_info section, and the low_pc is the starting address for the
2701/// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00002702void DwarfDebug::emitDebugInlineInfo() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00002703 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00002704 return;
2705
Devang Patel1a0df9a2010-05-10 22:49:55 +00002706 if (!FirstCU)
Bill Wendling480ff322009-05-20 23:21:38 +00002707 return;
2708
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002709 Asm->OutStreamer.SwitchSection(
2710 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002711
Chris Lattner566cae92010-03-09 23:52:58 +00002712 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00002713 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
2714 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00002715
Chris Lattnera179b522010-04-04 19:25:43 +00002716 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00002717
Chris Lattner566cae92010-03-09 23:52:58 +00002718 Asm->OutStreamer.AddComment("Dwarf Version");
2719 Asm->EmitInt16(dwarf::DWARF_VERSION);
2720 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattner3a383cb2010-04-05 00:13:49 +00002721 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002722
Devang Patel32cc43c2010-05-07 20:54:48 +00002723 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002724 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00002725
Devang Patel32cc43c2010-05-07 20:54:48 +00002726 const MDNode *Node = *I;
2727 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00002728 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002729 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00002730 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00002731 StringRef LName = SP.getLinkageName();
2732 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00002733
Chris Lattner566cae92010-03-09 23:52:58 +00002734 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00002735 if (LName.empty()) {
2736 Asm->OutStreamer.EmitBytes(Name, 0);
2737 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002738 } else
Chris Lattner70a4fce2010-04-04 23:25:33 +00002739 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
2740 DwarfStrSectionSym);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002741
Chris Lattner566cae92010-03-09 23:52:58 +00002742 Asm->OutStreamer.AddComment("Function name");
Chris Lattner70a4fce2010-04-04 23:25:33 +00002743 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner9efd1182010-04-04 19:09:29 +00002744 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00002745
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002746 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00002747 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner7bde8c02010-04-04 18:52:31 +00002748 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner085b6522010-03-09 00:31:02 +00002749 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00002750
Chris Lattner7bde8c02010-04-04 18:52:31 +00002751 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattner3a383cb2010-04-05 00:13:49 +00002752 Asm->OutStreamer.EmitSymbolValue(LI->first,
2753 Asm->getTargetData().getPointerSize(),0);
Bill Wendling480ff322009-05-20 23:21:38 +00002754 }
2755 }
2756
Chris Lattnera179b522010-04-04 19:25:43 +00002757 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00002758}