blob: 46582da79e819e7d3f839e4c9bddea326503438a [file] [log] [blame]
Bill Wendling0310d762009-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 Lattner6cde3e62010-03-09 00:39:24 +000013
Devang Patele4b27562009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling0310d762009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner74e41f92010-04-05 05:24:55 +000016#include "DIE.h"
Bill Wendling57fbba42010-04-05 22:59:21 +000017#include "llvm/Constants.h"
Bill Wendling0310d762009-05-15 09:23:25 +000018#include "llvm/Module.h"
David Greeneb2c66fc2009-08-19 21:52:55 +000019#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling0310d762009-05-15 09:23:25 +000020#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000021#include "llvm/MC/MCAsmInfo.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000022#include "llvm/MC/MCSection.h"
Chris Lattner6c2f9e12009-08-19 05:49:37 +000023#include "llvm/MC/MCStreamer.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000024#include "llvm/MC/MCSymbol.h"
Chris Lattner45111d12010-01-16 21:57:06 +000025#include "llvm/Target/Mangler.h"
Bill Wendling0310d762009-05-15 09:23:25 +000026#include "llvm/Target/TargetData.h"
27#include "llvm/Target/TargetFrameInfo.h"
Chris Lattnerf0144122009-07-28 03:13:23 +000028#include "llvm/Target/TargetLoweringObjectFile.h"
Chris Lattner9d1c1ad2010-04-04 18:06:11 +000029#include "llvm/Target/TargetMachine.h"
Chris Lattnerf0144122009-07-28 03:13:23 +000030#include "llvm/Target/TargetRegisterInfo.h"
Devang Patel2a4a3b72010-04-19 19:14:02 +000031#include "llvm/Target/TargetOptions.h"
Chris Lattner74e41f92010-04-05 05:24:55 +000032#include "llvm/Analysis/DebugInfo.h"
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +000033#include "llvm/ADT/STLExtras.h"
Chris Lattner23132b12009-08-24 03:52:50 +000034#include "llvm/ADT/StringExtras.h"
Devang Pateleac9c072010-04-27 19:46:33 +000035#include "llvm/Support/CommandLine.h"
Daniel Dunbar6e4bdfc2009-10-13 06:47:08 +000036#include "llvm/Support/Debug.h"
37#include "llvm/Support/ErrorHandling.h"
Devang Patel3139fcf2010-01-26 21:39:14 +000038#include "llvm/Support/ValueHandle.h"
Chris Lattner0ad9c912010-01-22 22:09:00 +000039#include "llvm/Support/FormattedStream.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000040#include "llvm/Support/Timer.h"
41#include "llvm/System/Path.h"
Bill Wendling0310d762009-05-15 09:23:25 +000042using namespace llvm;
43
Devang Pateleac9c072010-04-27 19:46:33 +000044static cl::opt<bool> PrintDbgScope("print-dbgscope", cl::Hidden,
45 cl::desc("Print DbgScope information for each machine instruction"));
46
47static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print", cl::Hidden,
48 cl::desc("Disable debug info printing"));
49
Dan Gohman281d65d2010-05-07 01:08:53 +000050static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
51 cl::desc("Make an absense of debug location information explicit."),
52 cl::init(false));
53
Bill Wendling5f017e82010-04-07 09:28:04 +000054namespace {
55 const char *DWARFGroupName = "DWARF Emission";
56 const char *DbgTimerName = "DWARF Debug Writer";
57} // end anonymous namespace
58
Bill Wendling0310d762009-05-15 09:23:25 +000059//===----------------------------------------------------------------------===//
60
61/// Configuration values for initial hash set sizes (log2).
62///
Bill Wendling0310d762009-05-15 09:23:25 +000063static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling0310d762009-05-15 09:23:25 +000064
65namespace llvm {
66
67//===----------------------------------------------------------------------===//
68/// CompileUnit - This dwarf writer support class manages information associate
69/// with a source file.
Nick Lewycky5f9843f2009-11-17 08:11:44 +000070class CompileUnit {
Bill Wendling0310d762009-05-15 09:23:25 +000071 /// ID - File identifier for source.
72 ///
73 unsigned ID;
74
75 /// Die - Compile unit debug information entry.
76 ///
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +000077 const OwningPtr<DIE> CUDie;
Bill Wendling0310d762009-05-15 09:23:25 +000078
Jeffrey Yasskind0f393d2010-03-11 18:29:55 +000079 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
Devang Patel6f01d9c2009-11-21 00:31:03 +000080 DIE *IndexTyDie;
81
Bill Wendling0310d762009-05-15 09:23:25 +000082 /// GVToDieMap - Tracks the mapping of unit level debug informaton
83 /// variables to debug information entries.
Devang Patele4b27562009-08-28 23:24:31 +000084 /// FIXME : Rename GVToDieMap -> NodeToDieMap
Devang Patele9f8f5e2010-05-07 20:54:48 +000085 DenseMap<const MDNode *, DIE *> GVToDieMap;
Bill Wendling0310d762009-05-15 09:23:25 +000086
87 /// GVToDIEEntryMap - Tracks the mapping of unit level debug informaton
88 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patele4b27562009-08-28 23:24:31 +000089 /// FIXME : Rename
Devang Patele9f8f5e2010-05-07 20:54:48 +000090 DenseMap<const MDNode *, DIEEntry *> GVToDIEEntryMap;
Bill Wendling0310d762009-05-15 09:23:25 +000091
92 /// Globals - A map of globally visible named entities for this unit.
93 ///
94 StringMap<DIE*> Globals;
95
Devang Patel193f7202009-11-24 01:14:22 +000096 /// GlobalTypes - A map of globally visible types for this unit.
97 ///
98 StringMap<DIE*> GlobalTypes;
99
Bill Wendling0310d762009-05-15 09:23:25 +0000100public:
101 CompileUnit(unsigned I, DIE *D)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000102 : ID(I), CUDie(D), IndexTyDie(0) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000103
104 // Accessors.
Devang Patel193f7202009-11-24 01:14:22 +0000105 unsigned getID() const { return ID; }
Jeffrey Yasskind0f393d2010-03-11 18:29:55 +0000106 DIE* getCUDie() const { return CUDie.get(); }
Devang Patel193f7202009-11-24 01:14:22 +0000107 const StringMap<DIE*> &getGlobals() const { return Globals; }
108 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
Bill Wendling0310d762009-05-15 09:23:25 +0000109
110 /// hasContent - Return true if this compile unit has something to write out.
111 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000112 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendling0310d762009-05-15 09:23:25 +0000113
Devang Patel2c4ceb12009-11-21 02:48:08 +0000114 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendling0310d762009-05-15 09:23:25 +0000115 ///
Benjamin Kramerbbb88db2010-03-31 20:15:45 +0000116 void addGlobal(StringRef Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling0310d762009-05-15 09:23:25 +0000117
Devang Patel193f7202009-11-24 01:14:22 +0000118 /// addGlobalType - Add a new global type to the compile unit.
119 ///
Benjamin Kramerbbb88db2010-03-31 20:15:45 +0000120 void addGlobalType(StringRef Name, DIE *Die) {
Devang Patel193f7202009-11-24 01:14:22 +0000121 GlobalTypes[Name] = Die;
122 }
123
Devang Patel017d1212009-11-20 21:37:22 +0000124 /// getDIE - Returns the debug information entry map slot for the
Bill Wendling0310d762009-05-15 09:23:25 +0000125 /// specified debug variable.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000126 DIE *getDIE(const MDNode *N) { return GVToDieMap.lookup(N); }
Jim Grosbach31ef40e2009-11-21 23:12:12 +0000127
Devang Patel017d1212009-11-20 21:37:22 +0000128 /// insertDIE - Insert DIE into the map.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000129 void insertDIE(const MDNode *N, DIE *D) {
Devang Patel017d1212009-11-20 21:37:22 +0000130 GVToDieMap.insert(std::make_pair(N, D));
131 }
Bill Wendling0310d762009-05-15 09:23:25 +0000132
Devang Patel017d1212009-11-20 21:37:22 +0000133 /// getDIEEntry - Returns the debug information entry for the speciefied
134 /// debug variable.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000135 DIEEntry *getDIEEntry(const MDNode *N) {
136 DenseMap<const MDNode *, DIEEntry *>::iterator I = GVToDIEEntryMap.find(N);
Devang Patel6404e4e2009-12-15 19:16:48 +0000137 if (I == GVToDIEEntryMap.end())
138 return NULL;
139 return I->second;
140 }
Devang Patel017d1212009-11-20 21:37:22 +0000141
142 /// insertDIEEntry - Insert debug information entry into the map.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000143 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
Devang Patel017d1212009-11-20 21:37:22 +0000144 GVToDIEEntryMap.insert(std::make_pair(N, E));
Bill Wendling0310d762009-05-15 09:23:25 +0000145 }
146
Devang Patel2c4ceb12009-11-21 02:48:08 +0000147 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendling0310d762009-05-15 09:23:25 +0000148 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000149 void addDie(DIE *Buffer) {
150 this->CUDie->addChild(Buffer);
Bill Wendling0310d762009-05-15 09:23:25 +0000151 }
Devang Patel6f01d9c2009-11-21 00:31:03 +0000152
153 // getIndexTyDie - Get an anonymous type for index type.
154 DIE *getIndexTyDie() {
155 return IndexTyDie;
156 }
157
Jim Grosbach7ab38df2009-11-22 19:20:36 +0000158 // setIndexTyDie - Set D as anonymous type for index which can be reused
159 // later.
Devang Patel6f01d9c2009-11-21 00:31:03 +0000160 void setIndexTyDie(DIE *D) {
161 IndexTyDie = D;
162 }
163
Bill Wendling0310d762009-05-15 09:23:25 +0000164};
165
166//===----------------------------------------------------------------------===//
167/// DbgVariable - This class is used to track local variable information.
168///
Devang Patelf76a3d62009-11-16 21:53:40 +0000169class DbgVariable {
Bill Wendling0310d762009-05-15 09:23:25 +0000170 DIVariable Var; // Variable Descriptor.
Devang Patelc3f5f782010-05-25 23:40:22 +0000171 DIE *TheDIE; // Variable DIE.
172 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
Bill Wendling0310d762009-05-15 09:23:25 +0000173public:
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000174 // AbsVar may be NULL.
Devang Patelc3f5f782010-05-25 23:40:22 +0000175 DbgVariable(DIVariable V) : Var(V), TheDIE(0), DotDebugLocOffset(~0U) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000176
177 // Accessors.
Devang Patel53bb5c92009-11-10 23:06:00 +0000178 DIVariable getVariable() const { return Var; }
Devang Patel53bb5c92009-11-10 23:06:00 +0000179 void setDIE(DIE *D) { TheDIE = D; }
180 DIE *getDIE() const { return TheDIE; }
Devang Patelc3f5f782010-05-25 23:40:22 +0000181 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
182 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
Bill Wendling0310d762009-05-15 09:23:25 +0000183};
184
185//===----------------------------------------------------------------------===//
Devang Pateleac9c072010-04-27 19:46:33 +0000186/// DbgRange - This is used to track range of instructions with identical
187/// debug info scope.
188///
189typedef std::pair<const MachineInstr *, const MachineInstr *> DbgRange;
190
191//===----------------------------------------------------------------------===//
Bill Wendling0310d762009-05-15 09:23:25 +0000192/// DbgScope - This class is used to track scope information.
193///
Devang Patelf76a3d62009-11-16 21:53:40 +0000194class DbgScope {
Bill Wendling0310d762009-05-15 09:23:25 +0000195 DbgScope *Parent; // Parent to this scope.
Jim Grosbach31ef40e2009-11-21 23:12:12 +0000196 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel3139fcf2010-01-26 21:39:14 +0000197 // Location at which this scope is inlined.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000198 AssertingVH<const MDNode> InlinedAtLocation;
Devang Patel53bb5c92009-11-10 23:06:00 +0000199 bool AbstractScope; // Abstract Scope
Devang Pateld38dd112009-10-01 18:25:23 +0000200 const MachineInstr *LastInsn; // Last instruction of this scope.
201 const MachineInstr *FirstInsn; // First instruction of this scope.
Devang Pateleac9c072010-04-27 19:46:33 +0000202 unsigned DFSIn, DFSOut;
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000203 // Scopes defined in scope. Contents not owned.
204 SmallVector<DbgScope *, 4> Scopes;
205 // Variables declared in scope. Contents owned.
206 SmallVector<DbgVariable *, 8> Variables;
Devang Pateleac9c072010-04-27 19:46:33 +0000207 SmallVector<DbgRange, 4> Ranges;
Owen Anderson04c05f72009-06-24 22:53:20 +0000208 // Private state for dump()
209 mutable unsigned IndentLevel;
Bill Wendling0310d762009-05-15 09:23:25 +0000210public:
Devang Patele9f8f5e2010-05-07 20:54:48 +0000211 DbgScope(DbgScope *P, DIDescriptor D, const MDNode *I = 0)
Devang Patel53bb5c92009-11-10 23:06:00 +0000212 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Devang Pateleac9c072010-04-27 19:46:33 +0000213 LastInsn(0), FirstInsn(0),
214 DFSIn(0), DFSOut(0), IndentLevel(0) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000215 virtual ~DbgScope();
216
217 // Accessors.
218 DbgScope *getParent() const { return Parent; }
Devang Patel53bb5c92009-11-10 23:06:00 +0000219 void setParent(DbgScope *P) { Parent = P; }
Bill Wendling0310d762009-05-15 09:23:25 +0000220 DIDescriptor getDesc() const { return Desc; }
Devang Patele9f8f5e2010-05-07 20:54:48 +0000221 const MDNode *getInlinedAt() const { return InlinedAtLocation; }
222 const MDNode *getScopeNode() const { return Desc; }
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000223 const SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
224 const SmallVector<DbgVariable *, 8> &getVariables() { return Variables; }
Devang Pateleac9c072010-04-27 19:46:33 +0000225 const SmallVector<DbgRange, 4> &getRanges() { return Ranges; }
226
227 /// openInsnRange - This scope covers instruction range starting from MI.
228 void openInsnRange(const MachineInstr *MI) {
229 if (!FirstInsn)
230 FirstInsn = MI;
231
232 if (Parent)
233 Parent->openInsnRange(MI);
234 }
235
236 /// extendInsnRange - Extend the current instruction range covered by
237 /// this scope.
238 void extendInsnRange(const MachineInstr *MI) {
239 assert (FirstInsn && "MI Range is not open!");
240 LastInsn = MI;
241 if (Parent)
242 Parent->extendInsnRange(MI);
243 }
244
245 /// closeInsnRange - Create a range based on FirstInsn and LastInsn collected
246 /// until now. This is used when a new scope is encountered while walking
247 /// machine instructions.
248 void closeInsnRange(DbgScope *NewScope = NULL) {
249 assert (LastInsn && "Last insn missing!");
250 Ranges.push_back(DbgRange(FirstInsn, LastInsn));
251 FirstInsn = NULL;
252 LastInsn = NULL;
253 // If Parent dominates NewScope then do not close Parent's instruction
254 // range.
255 if (Parent && (!NewScope || !Parent->dominates(NewScope)))
256 Parent->closeInsnRange(NewScope);
257 }
258
Devang Patel53bb5c92009-11-10 23:06:00 +0000259 void setAbstractScope() { AbstractScope = true; }
260 bool isAbstractScope() const { return AbstractScope; }
Devang Pateleac9c072010-04-27 19:46:33 +0000261
262 // Depth First Search support to walk and mainpluate DbgScope hierarchy.
263 unsigned getDFSOut() const { return DFSOut; }
264 void setDFSOut(unsigned O) { DFSOut = O; }
265 unsigned getDFSIn() const { return DFSIn; }
266 void setDFSIn(unsigned I) { DFSIn = I; }
267 bool dominates(const DbgScope *S) {
268 if (S == this)
269 return true;
270 if (DFSIn < S->getDFSIn() && DFSOut > S->getDFSOut())
271 return true;
272 return false;
273 }
Devang Patel53bb5c92009-11-10 23:06:00 +0000274
Devang Patel2c4ceb12009-11-21 02:48:08 +0000275 /// addScope - Add a scope to the scope.
Bill Wendling0310d762009-05-15 09:23:25 +0000276 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000277 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendling0310d762009-05-15 09:23:25 +0000278
Devang Patel2c4ceb12009-11-21 02:48:08 +0000279 /// addVariable - Add a variable to the scope.
Bill Wendling0310d762009-05-15 09:23:25 +0000280 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000281 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendling0310d762009-05-15 09:23:25 +0000282
Bill Wendling0310d762009-05-15 09:23:25 +0000283#ifndef NDEBUG
284 void dump() const;
285#endif
286};
Devang Pateleac9c072010-04-27 19:46:33 +0000287
Chris Lattnerea761862010-04-05 04:09:20 +0000288} // end llvm namespace
Bill Wendling0310d762009-05-15 09:23:25 +0000289
290#ifndef NDEBUG
291void DbgScope::dump() const {
David Greenef83adbc2009-12-24 00:31:35 +0000292 raw_ostream &err = dbgs();
Chris Lattnerc281de12009-08-23 00:51:00 +0000293 err.indent(IndentLevel);
Devang Patele9f8f5e2010-05-07 20:54:48 +0000294 const MDNode *N = Desc;
Devang Patel53bb5c92009-11-10 23:06:00 +0000295 N->dump();
Devang Patel53bb5c92009-11-10 23:06:00 +0000296 if (AbstractScope)
297 err << "Abstract Scope\n";
Bill Wendling0310d762009-05-15 09:23:25 +0000298
299 IndentLevel += 2;
Devang Patel53bb5c92009-11-10 23:06:00 +0000300 if (!Scopes.empty())
301 err << "Children ...\n";
Bill Wendling0310d762009-05-15 09:23:25 +0000302 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
303 if (Scopes[i] != this)
304 Scopes[i]->dump();
305
306 IndentLevel -= 2;
307}
308#endif
309
Bill Wendling0310d762009-05-15 09:23:25 +0000310DbgScope::~DbgScope() {
Bill Wendling0310d762009-05-15 09:23:25 +0000311 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
312 delete Variables[j];
Bill Wendling0310d762009-05-15 09:23:25 +0000313}
314
Chris Lattner49cd6642010-04-05 05:11:15 +0000315DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Devang Patel163a9f72010-05-10 22:49:55 +0000316 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Chris Lattner994cb122010-04-05 03:52:55 +0000317 AbbreviationsSet(InitAbbreviationsSetSize),
Devang Patelf2548ca2010-04-16 23:33:45 +0000318 CurrentFnDbgScope(0), PrevLabel(NULL) {
Chris Lattnerbc733f52010-03-13 02:17:42 +0000319 NextStringPoolNumber = 0;
Chris Lattner9c69e285532010-04-04 22:59:04 +0000320
Chris Lattner4ad1efe2010-04-04 23:10:38 +0000321 DwarfFrameSectionSym = DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
322 DwarfStrSectionSym = TextSectionSym = 0;
Devang Patelc3f5f782010-05-25 23:40:22 +0000323 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
324 FunctionBeginSym = FunctionEndSym = 0;
Dan Gohman03c3dc72010-06-18 15:56:31 +0000325 {
326 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
327 beginModule(M);
Torok Edwin9c421072010-04-07 10:44:46 +0000328 }
Bill Wendling0310d762009-05-15 09:23:25 +0000329}
330DwarfDebug::~DwarfDebug() {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000331 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
332 DIEBlocks[j]->~DIEBlock();
Bill Wendling0310d762009-05-15 09:23:25 +0000333}
334
Chris Lattnerbc733f52010-03-13 02:17:42 +0000335MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
336 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
337 if (Entry.first) return Entry.first;
338
339 Entry.second = NextStringPoolNumber++;
Chris Lattnerc0215722010-04-04 19:25:43 +0000340 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerbc733f52010-03-13 02:17:42 +0000341}
342
343
Devang Patel2c4ceb12009-11-21 02:48:08 +0000344/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling0310d762009-05-15 09:23:25 +0000345///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000346void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling0310d762009-05-15 09:23:25 +0000347 // Profile the node so that we can make it unique.
348 FoldingSetNodeID ID;
349 Abbrev.Profile(ID);
350
351 // Check the set for priors.
352 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
353
354 // If it's newly added.
355 if (InSet == &Abbrev) {
356 // Add to abbreviation list.
357 Abbreviations.push_back(&Abbrev);
358
359 // Assign the vector position + 1 as its number.
360 Abbrev.setNumber(Abbreviations.size());
361 } else {
362 // Assign existing abbreviation number.
363 Abbrev.setNumber(InSet->getNumber());
364 }
365}
366
Devang Patel2c4ceb12009-11-21 02:48:08 +0000367/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendling995f80a2009-05-20 23:24:48 +0000368/// information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000369DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000370 DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000371 return Value;
372}
373
Devang Patel2c4ceb12009-11-21 02:48:08 +0000374/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000375///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000376void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000377 unsigned Form, uint64_t Integer) {
378 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000379 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000380 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000381}
382
Devang Patel2c4ceb12009-11-21 02:48:08 +0000383/// addSInt - Add an signed integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000384///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000385void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000386 unsigned Form, int64_t Integer) {
387 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000388 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000389 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000390}
391
Devang Patel69f57b12009-12-02 15:25:16 +0000392/// addString - Add a string attribute data and value. DIEString only
393/// keeps string reference.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000394void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattner4cf202b2010-01-23 03:11:46 +0000395 StringRef String) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000396 DIEValue *Value = new (DIEValueAllocator) DIEString(String);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000397 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000398}
399
Devang Patel2c4ceb12009-11-21 02:48:08 +0000400/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000401///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000402void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerb98b1bf2010-03-08 22:23:36 +0000403 const MCSymbol *Label) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000404 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000405 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000406}
407
Devang Patel2c4ceb12009-11-21 02:48:08 +0000408/// addDelta - Add a label delta attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000409///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000410void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerb98b1bf2010-03-08 22:23:36 +0000411 const MCSymbol *Hi, const MCSymbol *Lo) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000412 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000413 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000414}
415
Chris Lattner74e41f92010-04-05 05:24:55 +0000416/// addDIEEntry - Add a DIE attribute data and value.
417///
418void DwarfDebug::addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form,
419 DIE *Entry) {
420 Die->addValue(Attribute, Form, createDIEEntry(Entry));
421}
422
423
Devang Patel2c4ceb12009-11-21 02:48:08 +0000424/// addBlock - Add block data.
Bill Wendling0310d762009-05-15 09:23:25 +0000425///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000426void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000427 DIEBlock *Block) {
Chris Lattnera37d5382010-04-05 00:18:22 +0000428 Block->ComputeSize(Asm);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000429 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000430 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000431}
432
Devang Patel2c4ceb12009-11-21 02:48:08 +0000433/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000434/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000435void DwarfDebug::addSourceLine(DIE *Die, const DIVariable *V) {
Devang Patelc665a512010-05-07 23:33:41 +0000436 // Verify variable.
437 if (!V->Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000438 return;
439
440 unsigned Line = V->getLineNumber();
Devang Patel77bf2952010-03-08 22:02:50 +0000441 unsigned FileID = GetOrCreateSourceID(V->getContext().getDirectory(),
442 V->getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000443 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000444 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
445 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000446}
447
Devang Patel2c4ceb12009-11-21 02:48:08 +0000448/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000449/// entry.
Devang Patela49d8772010-05-07 23:19:07 +0000450void DwarfDebug::addSourceLine(DIE *Die, const DIGlobalVariable *G) {
Devang Patelc665a512010-05-07 23:33:41 +0000451 // Verify global variable.
452 if (!G->Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000453 return;
454
455 unsigned Line = G->getLineNumber();
Devang Patel77bf2952010-03-08 22:02:50 +0000456 unsigned FileID = GetOrCreateSourceID(G->getContext().getDirectory(),
457 G->getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000458 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000459 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
460 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000461}
Devang Patel82dfc0c2009-08-31 22:47:13 +0000462
Devang Patel2c4ceb12009-11-21 02:48:08 +0000463/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000464/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000465void DwarfDebug::addSourceLine(DIE *Die, const DISubprogram *SP) {
Devang Patelc665a512010-05-07 23:33:41 +0000466 // Verify subprogram.
467 if (!SP->Verify())
Devang Patel82dfc0c2009-08-31 22:47:13 +0000468 return;
Caroline Ticec6f9d622009-09-11 18:25:54 +0000469 // If the line number is 0, don't add it.
470 if (SP->getLineNumber() == 0)
471 return;
472
Devang Patel82dfc0c2009-08-31 22:47:13 +0000473 unsigned Line = SP->getLineNumber();
Devang Patel77bf2952010-03-08 22:02:50 +0000474 if (!SP->getContext().Verify())
475 return;
Devang Patel9bb59a22010-03-24 21:30:35 +0000476 unsigned FileID = GetOrCreateSourceID(SP->getDirectory(),
477 SP->getFilename());
Devang Patel82dfc0c2009-08-31 22:47:13 +0000478 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000479 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
480 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patel82dfc0c2009-08-31 22:47:13 +0000481}
482
Devang Patel2c4ceb12009-11-21 02:48:08 +0000483/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000484/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000485void DwarfDebug::addSourceLine(DIE *Die, const DIType *Ty) {
Devang Patelc665a512010-05-07 23:33:41 +0000486 // Verify type.
487 if (!Ty->Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000488 return;
489
490 unsigned Line = Ty->getLineNumber();
Devang Patel77bf2952010-03-08 22:02:50 +0000491 if (!Ty->getContext().Verify())
492 return;
493 unsigned FileID = GetOrCreateSourceID(Ty->getContext().getDirectory(),
494 Ty->getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000495 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000496 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
497 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000498}
499
Devang Patel6404e4e2009-12-15 19:16:48 +0000500/// addSourceLine - Add location information to specified debug information
501/// entry.
502void DwarfDebug::addSourceLine(DIE *Die, const DINameSpace *NS) {
Devang Patelc665a512010-05-07 23:33:41 +0000503 // Verify namespace.
504 if (!NS->Verify())
Devang Patel6404e4e2009-12-15 19:16:48 +0000505 return;
506
507 unsigned Line = NS->getLineNumber();
508 StringRef FN = NS->getFilename();
509 StringRef Dir = NS->getDirectory();
510
511 unsigned FileID = GetOrCreateSourceID(Dir, FN);
512 assert(FileID && "Invalid file id");
513 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
514 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
515}
516
Caroline Ticedc8f6042009-08-31 21:19:37 +0000517/* Byref variables, in Blocks, are declared by the programmer as
518 "SomeType VarName;", but the compiler creates a
519 __Block_byref_x_VarName struct, and gives the variable VarName
520 either the struct, or a pointer to the struct, as its type. This
521 is necessary for various behind-the-scenes things the compiler
522 needs to do with by-reference variables in blocks.
523
524 However, as far as the original *programmer* is concerned, the
525 variable should still have type 'SomeType', as originally declared.
526
527 The following function dives into the __Block_byref_x_VarName
528 struct to find the original type of the variable. This will be
529 passed back to the code generating the type for the Debug
530 Information Entry for the variable 'VarName'. 'VarName' will then
531 have the original type 'SomeType' in its debug information.
532
533 The original type 'SomeType' will be the type of the field named
534 'VarName' inside the __Block_byref_x_VarName struct.
535
536 NOTE: In order for this to not completely fail on the debugger
537 side, the Debug Information Entry for the variable VarName needs to
538 have a DW_AT_location that tells the debugger how to unwind through
539 the pointers and __Block_byref_x_VarName struct to find the actual
Devang Patel2c4ceb12009-11-21 02:48:08 +0000540 value of the variable. The function addBlockByrefType does this. */
Caroline Ticedc8f6042009-08-31 21:19:37 +0000541
542/// Find the type the programmer originally declared the variable to be
543/// and return that type.
544///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000545DIType DwarfDebug::getBlockByrefType(DIType Ty, std::string Name) {
Caroline Ticedc8f6042009-08-31 21:19:37 +0000546
547 DIType subType = Ty;
548 unsigned tag = Ty.getTag();
549
550 if (tag == dwarf::DW_TAG_pointer_type) {
Devang Patel2db49d72010-05-07 18:11:54 +0000551 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000552 subType = DTy.getTypeDerivedFrom();
553 }
554
Devang Patel2db49d72010-05-07 18:11:54 +0000555 DICompositeType blockStruct = DICompositeType(subType);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000556 DIArray Elements = blockStruct.getTypeArray();
557
Caroline Ticedc8f6042009-08-31 21:19:37 +0000558 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
559 DIDescriptor Element = Elements.getElement(i);
Devang Patel2db49d72010-05-07 18:11:54 +0000560 DIDerivedType DT = DIDerivedType(Element);
Devang Patel65dbc902009-11-25 17:36:49 +0000561 if (Name == DT.getName())
Caroline Ticedc8f6042009-08-31 21:19:37 +0000562 return (DT.getTypeDerivedFrom());
563 }
564
565 return Ty;
566}
567
Devang Patel2c4ceb12009-11-21 02:48:08 +0000568/// addComplexAddress - Start with the address based on the location provided,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000569/// and generate the DWARF information necessary to find the actual variable
570/// given the extra address information encoded in the DIVariable, starting from
571/// the starting location. Add the DWARF information to the die.
572///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000573void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000574 unsigned Attribute,
575 const MachineLocation &Location) {
576 const DIVariable &VD = DV->getVariable();
577 DIType Ty = VD.getType();
578
579 // Decode the original location, and use that as the start of the byref
580 // variable's location.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000581 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000582 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000583 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000584
585 if (Location.isReg()) {
586 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000587 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000588 } else {
589 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000590 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
591 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000592 }
593 } else {
594 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000595 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000596 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000597 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
598 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000599 }
600
Devang Patel2c4ceb12009-11-21 02:48:08 +0000601 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000602 }
603
604 for (unsigned i = 0, N = VD.getNumAddrElements(); i < N; ++i) {
605 uint64_t Element = VD.getAddrElement(i);
606
607 if (Element == DIFactory::OpPlus) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000608 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
609 addUInt(Block, 0, dwarf::DW_FORM_udata, VD.getAddrElement(++i));
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000610 } else if (Element == DIFactory::OpDeref) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000611 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000612 } else llvm_unreachable("unknown DIFactory Opcode");
613 }
614
615 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000616 addBlock(Die, Attribute, 0, Block);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000617}
618
Caroline Ticedc8f6042009-08-31 21:19:37 +0000619/* Byref variables, in Blocks, are declared by the programmer as "SomeType
620 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
621 gives the variable VarName either the struct, or a pointer to the struct, as
622 its type. This is necessary for various behind-the-scenes things the
623 compiler needs to do with by-reference variables in Blocks.
624
625 However, as far as the original *programmer* is concerned, the variable
626 should still have type 'SomeType', as originally declared.
627
Devang Patel2c4ceb12009-11-21 02:48:08 +0000628 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000629 struct to find the original type of the variable, which is then assigned to
630 the variable's Debug Information Entry as its real type. So far, so good.
631 However now the debugger will expect the variable VarName to have the type
632 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000633 expression that explains to the debugger how to navigate through the
Caroline Ticedc8f6042009-08-31 21:19:37 +0000634 pointers and struct to find the actual variable of type SomeType.
635
636 The following function does just that. We start by getting
637 the "normal" location for the variable. This will be the location
638 of either the struct __Block_byref_x_VarName or the pointer to the
639 struct __Block_byref_x_VarName.
640
641 The struct will look something like:
642
643 struct __Block_byref_x_VarName {
644 ... <various fields>
645 struct __Block_byref_x_VarName *forwarding;
646 ... <various other fields>
647 SomeType VarName;
648 ... <maybe more fields>
649 };
650
651 If we are given the struct directly (as our starting point) we
652 need to tell the debugger to:
653
654 1). Add the offset of the forwarding field.
655
Dan Gohmanf451cb82010-02-10 16:03:48 +0000656 2). Follow that pointer to get the real __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000657 struct to use (the real one may have been copied onto the heap).
658
659 3). Add the offset for the field VarName, to find the actual variable.
660
661 If we started with a pointer to the struct, then we need to
662 dereference that pointer first, before the other steps.
663 Translating this into DWARF ops, we will need to append the following
664 to the current location description for the variable:
665
666 DW_OP_deref -- optional, if we start with a pointer
667 DW_OP_plus_uconst <forward_fld_offset>
668 DW_OP_deref
669 DW_OP_plus_uconst <varName_fld_offset>
670
671 That is what this function does. */
672
Devang Patel2c4ceb12009-11-21 02:48:08 +0000673/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticedc8f6042009-08-31 21:19:37 +0000674/// provided, and generate the DWARF information necessary to find the
675/// actual Block variable (navigating the Block struct) based on the
676/// starting location. Add the DWARF information to the die. For
677/// more information, read large comment just above here.
678///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000679void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbar00564992009-09-19 20:40:14 +0000680 unsigned Attribute,
681 const MachineLocation &Location) {
Caroline Ticedc8f6042009-08-31 21:19:37 +0000682 const DIVariable &VD = DV->getVariable();
683 DIType Ty = VD.getType();
684 DIType TmpTy = Ty;
685 unsigned Tag = Ty.getTag();
686 bool isPointer = false;
687
Devang Patel65dbc902009-11-25 17:36:49 +0000688 StringRef varName = VD.getName();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000689
690 if (Tag == dwarf::DW_TAG_pointer_type) {
Devang Patel2db49d72010-05-07 18:11:54 +0000691 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000692 TmpTy = DTy.getTypeDerivedFrom();
693 isPointer = true;
694 }
695
Devang Patel2db49d72010-05-07 18:11:54 +0000696 DICompositeType blockStruct = DICompositeType(TmpTy);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000697
Daniel Dunbar00564992009-09-19 20:40:14 +0000698 // Find the __forwarding field and the variable field in the __Block_byref
699 // struct.
Daniel Dunbar00564992009-09-19 20:40:14 +0000700 DIArray Fields = blockStruct.getTypeArray();
701 DIDescriptor varField = DIDescriptor();
702 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000703
Daniel Dunbar00564992009-09-19 20:40:14 +0000704 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
705 DIDescriptor Element = Fields.getElement(i);
Devang Patel2db49d72010-05-07 18:11:54 +0000706 DIDerivedType DT = DIDerivedType(Element);
Devang Patel65dbc902009-11-25 17:36:49 +0000707 StringRef fieldName = DT.getName();
708 if (fieldName == "__forwarding")
Daniel Dunbar00564992009-09-19 20:40:14 +0000709 forwardingField = Element;
Devang Patel65dbc902009-11-25 17:36:49 +0000710 else if (fieldName == varName)
Daniel Dunbar00564992009-09-19 20:40:14 +0000711 varField = Element;
712 }
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000713
Daniel Dunbar00564992009-09-19 20:40:14 +0000714 // Get the offsets for the forwarding field and the variable field.
Chris Lattner1d65ba72010-03-31 06:06:37 +0000715 unsigned forwardingFieldOffset =
Devang Patel2db49d72010-05-07 18:11:54 +0000716 DIDerivedType(forwardingField).getOffsetInBits() >> 3;
Chris Lattner1d65ba72010-03-31 06:06:37 +0000717 unsigned varFieldOffset =
Devang Patel2db49d72010-05-07 18:11:54 +0000718 DIDerivedType(varField).getOffsetInBits() >> 3;
Caroline Ticedc8f6042009-08-31 21:19:37 +0000719
Mike Stump7e3720d2009-09-24 23:21:26 +0000720 // Decode the original location, and use that as the start of the byref
721 // variable's location.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000722 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Daniel Dunbar00564992009-09-19 20:40:14 +0000723 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000724 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000725
Daniel Dunbar00564992009-09-19 20:40:14 +0000726 if (Location.isReg()) {
727 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000728 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000729 else {
730 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000731 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
732 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000733 }
734 } else {
735 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000736 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000737 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000738 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
739 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000740 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000741
Devang Patel2c4ceb12009-11-21 02:48:08 +0000742 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbar00564992009-09-19 20:40:14 +0000743 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000744
Mike Stump7e3720d2009-09-24 23:21:26 +0000745 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbar00564992009-09-19 20:40:14 +0000746 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbar00564992009-09-19 20:40:14 +0000747 if (isPointer)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000748 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000749
Daniel Dunbar00564992009-09-19 20:40:14 +0000750 // Next add the offset for the '__forwarding' field:
751 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
752 // adding the offset if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000753 if (forwardingFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000754 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
755 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000756 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000757
Daniel Dunbar00564992009-09-19 20:40:14 +0000758 // Now dereference the __forwarding field to get to the real __Block_byref
759 // struct: DW_OP_deref.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000760 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000761
Daniel Dunbar00564992009-09-19 20:40:14 +0000762 // Now that we've got the real __Block_byref... struct, add the offset
763 // for the variable's field to get to the location of the actual variable:
764 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000765 if (varFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000766 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
767 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000768 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000769
Daniel Dunbar00564992009-09-19 20:40:14 +0000770 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000771 addBlock(Die, Attribute, 0, Block);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000772}
773
Devang Patel2c4ceb12009-11-21 02:48:08 +0000774/// addAddress - Add an address attribute to a die based on the location
Bill Wendling0310d762009-05-15 09:23:25 +0000775/// provided.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000776void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000777 const MachineLocation &Location) {
Chris Lattnerd38fee82010-04-05 00:13:49 +0000778 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling0310d762009-05-15 09:23:25 +0000779 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000780 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Bill Wendling0310d762009-05-15 09:23:25 +0000781
782 if (Location.isReg()) {
783 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000784 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000785 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000786 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
787 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000788 }
789 } else {
790 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000791 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000792 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000793 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
794 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000795 }
796
Devang Patel2c4ceb12009-11-21 02:48:08 +0000797 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling0310d762009-05-15 09:23:25 +0000798 }
799
Devang Patel2c4ceb12009-11-21 02:48:08 +0000800 addBlock(Die, Attribute, 0, Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000801}
802
Devang Patela43098d2010-04-28 01:03:09 +0000803/// addRegisterAddress - Add register location entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000804bool DwarfDebug::addRegisterAddress(DIE *Die, const MCSymbol *VS,
Devang Patela43098d2010-04-28 01:03:09 +0000805 const MachineOperand &MO) {
806 assert (MO.isReg() && "Invalid machine operand!");
807 if (!MO.getReg())
808 return false;
809 MachineLocation Location;
810 Location.set(MO.getReg());
811 addAddress(Die, dwarf::DW_AT_location, Location);
Devang Patel26c1e562010-05-20 16:36:41 +0000812 if (VS)
Devang Patela43098d2010-04-28 01:03:09 +0000813 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
814 return true;
815}
816
817/// addConstantValue - Add constant value entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000818bool DwarfDebug::addConstantValue(DIE *Die, const MCSymbol *VS,
Devang Patela43098d2010-04-28 01:03:09 +0000819 const MachineOperand &MO) {
820 assert (MO.isImm() && "Invalid machine operand!");
821 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
822 unsigned Imm = MO.getImm();
823 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
824 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patel26c1e562010-05-20 16:36:41 +0000825 if (VS)
Devang Patela43098d2010-04-28 01:03:09 +0000826 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
827 return true;
828}
829
830/// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000831bool DwarfDebug::addConstantFPValue(DIE *Die, const MCSymbol *VS,
Devang Patela43098d2010-04-28 01:03:09 +0000832 const MachineOperand &MO) {
833 assert (MO.isFPImm() && "Invalid machine operand!");
834 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
835 APFloat FPImm = MO.getFPImm()->getValueAPF();
836
837 // Get the raw data form of the floating point.
838 const APInt FltVal = FPImm.bitcastToAPInt();
839 const char *FltPtr = (const char*)FltVal.getRawData();
840
841 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
842 bool LittleEndian = Asm->getTargetData().isLittleEndian();
843 int Incr = (LittleEndian ? 1 : -1);
844 int Start = (LittleEndian ? 0 : NumBytes - 1);
845 int Stop = (LittleEndian ? NumBytes : -1);
846
847 // Output the constant to DWARF one byte at a time.
848 for (; Start != Stop; Start += Incr)
849 addUInt(Block, 0, dwarf::DW_FORM_data1,
850 (unsigned char)0xFF & FltPtr[Start]);
851
852 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patel26c1e562010-05-20 16:36:41 +0000853 if (VS)
854 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
Devang Patela43098d2010-04-28 01:03:09 +0000855 return true;
856}
857
858
Devang Patelc366f832009-12-10 19:14:49 +0000859/// addToContextOwner - Add Die into the list of its context owner's children.
860void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3c91b052010-03-08 20:52:55 +0000861 if (Context.isType()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000862 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
Devang Patelc366f832009-12-10 19:14:49 +0000863 ContextDIE->addChild(Die);
Devang Patel6404e4e2009-12-15 19:16:48 +0000864 } else if (Context.isNameSpace()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000865 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
Devang Patel6404e4e2009-12-15 19:16:48 +0000866 ContextDIE->addChild(Die);
Stuart Hastings215aa152010-06-11 20:08:44 +0000867 } else if (Context.isSubprogram()) {
868 DIE *ContextDIE = createSubprogramDIE(DISubprogram(Context),
869 /*MakeDecl=*/false);
870 ContextDIE->addChild(Die);
Devang Patel163a9f72010-05-10 22:49:55 +0000871 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patelc366f832009-12-10 19:14:49 +0000872 ContextDIE->addChild(Die);
873 else
Devang Patel163a9f72010-05-10 22:49:55 +0000874 getCompileUnit(Context)->addDie(Die);
Devang Patelc366f832009-12-10 19:14:49 +0000875}
876
Devang Patel16ced732009-12-10 18:05:33 +0000877/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
878/// given DIType.
879DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel163a9f72010-05-10 22:49:55 +0000880 CompileUnit *TypeCU = getCompileUnit(Ty);
881 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patel16ced732009-12-10 18:05:33 +0000882 if (TyDIE)
883 return TyDIE;
884
885 // Create new type.
886 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel163a9f72010-05-10 22:49:55 +0000887 TypeCU->insertDIE(Ty, TyDIE);
Devang Patel16ced732009-12-10 18:05:33 +0000888 if (Ty.isBasicType())
Devang Patel2db49d72010-05-07 18:11:54 +0000889 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000890 else if (Ty.isCompositeType())
Devang Patel2db49d72010-05-07 18:11:54 +0000891 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000892 else {
893 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patel2db49d72010-05-07 18:11:54 +0000894 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000895 }
896
Devang Patelc366f832009-12-10 19:14:49 +0000897 addToContextOwner(TyDIE, Ty.getContext());
Devang Patel16ced732009-12-10 18:05:33 +0000898 return TyDIE;
899}
900
Devang Patel2c4ceb12009-11-21 02:48:08 +0000901/// addType - Add a new type attribute to the specified entity.
Devang Patel8a241142009-12-09 18:24:21 +0000902void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel9c004872010-05-07 21:45:47 +0000903 if (!Ty.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000904 return;
905
906 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +0000907 CompileUnit *TypeCU = getCompileUnit(Ty);
908 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000909 // If it exists then use the existing value.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000910 if (Entry) {
911 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000912 return;
913 }
914
Bill Wendling0310d762009-05-15 09:23:25 +0000915 // Construct type.
Devang Patel16ced732009-12-10 18:05:33 +0000916 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000917
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000918 // Set up proxy.
919 Entry = createDIEEntry(Buffer);
Devang Patel163a9f72010-05-10 22:49:55 +0000920 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000921
Devang Patel2c4ceb12009-11-21 02:48:08 +0000922 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000923}
924
Devang Patel2c4ceb12009-11-21 02:48:08 +0000925/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel8a241142009-12-09 18:24:21 +0000926void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000927 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000928 StringRef Name = BTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000929 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000930 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling0310d762009-05-15 09:23:25 +0000931 BTy.getEncoding());
932
933 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +0000934 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000935 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000936 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000937 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000938}
939
Devang Patel2c4ceb12009-11-21 02:48:08 +0000940/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel8a241142009-12-09 18:24:21 +0000941void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000942 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000943 StringRef Name = DTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000944 uint64_t Size = DTy.getSizeInBits() >> 3;
945 unsigned Tag = DTy.getTag();
946
947 // FIXME - Workaround for templates.
948 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
949
950 Buffer.setTag(Tag);
951
952 // Map to main type, void will not have a type.
953 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel8a241142009-12-09 18:24:21 +0000954 addType(&Buffer, FromTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000955
956 // Add name if not anonymous or intermediate type.
Devang Pateldeea5642009-11-30 23:56:56 +0000957 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000958 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000959
960 // Add size if non-zero (derived types might be zero-sized.)
961 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000962 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000963
964 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patel05f6fa82009-11-23 18:43:37 +0000965 if (!DTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000966 addSourceLine(&Buffer, &DTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000967}
968
Devang Patel2c4ceb12009-11-21 02:48:08 +0000969/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +0000970void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000971 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000972 StringRef Name = CTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000973
974 uint64_t Size = CTy.getSizeInBits() >> 3;
975 unsigned Tag = CTy.getTag();
976 Buffer.setTag(Tag);
977
978 switch (Tag) {
979 case dwarf::DW_TAG_vector_type:
980 case dwarf::DW_TAG_array_type:
Devang Patel8a241142009-12-09 18:24:21 +0000981 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000982 break;
983 case dwarf::DW_TAG_enumeration_type: {
984 DIArray Elements = CTy.getTypeArray();
985
986 // Add enumerators to enumeration type.
987 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
988 DIE *ElemDie = NULL;
Devang Patel2db49d72010-05-07 18:11:54 +0000989 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3c91b052010-03-08 20:52:55 +0000990 if (Enum.isEnumerator()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000991 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel2c4ceb12009-11-21 02:48:08 +0000992 Buffer.addChild(ElemDie);
Devang Patelc5254722009-10-09 17:51:49 +0000993 }
Bill Wendling0310d762009-05-15 09:23:25 +0000994 }
995 }
996 break;
997 case dwarf::DW_TAG_subroutine_type: {
998 // Add return type.
999 DIArray Elements = CTy.getTypeArray();
1000 DIDescriptor RTy = Elements.getElement(0);
Devang Patel2db49d72010-05-07 18:11:54 +00001001 addType(&Buffer, DIType(RTy));
Bill Wendling0310d762009-05-15 09:23:25 +00001002
1003 // Add prototype flag.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001004 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001005
1006 // Add arguments.
1007 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1008 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1009 DIDescriptor Ty = Elements.getElement(i);
Devang Patel2db49d72010-05-07 18:11:54 +00001010 addType(Arg, DIType(Ty));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001011 Buffer.addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001012 }
1013 }
1014 break;
1015 case dwarf::DW_TAG_structure_type:
1016 case dwarf::DW_TAG_union_type:
1017 case dwarf::DW_TAG_class_type: {
1018 // Add elements to structure type.
1019 DIArray Elements = CTy.getTypeArray();
1020
1021 // A forward struct declared type may not have elements available.
Devang Patel3c91b052010-03-08 20:52:55 +00001022 unsigned N = Elements.getNumElements();
1023 if (N == 0)
Bill Wendling0310d762009-05-15 09:23:25 +00001024 break;
1025
1026 // Add elements to structure type.
Devang Patel3c91b052010-03-08 20:52:55 +00001027 for (unsigned i = 0; i < N; ++i) {
Bill Wendling0310d762009-05-15 09:23:25 +00001028 DIDescriptor Element = Elements.getElement(i);
1029 DIE *ElemDie = NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001030 if (Element.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001031 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patel3c91b052010-03-08 20:52:55 +00001032 else if (Element.isVariable()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001033 DIVariable DV(Element);
Devang Patel1ee0cb92010-01-30 01:08:30 +00001034 ElemDie = new DIE(dwarf::DW_TAG_variable);
1035 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1036 DV.getName());
1037 addType(ElemDie, DV.getType());
1038 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1039 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1040 addSourceLine(ElemDie, &DV);
Devang Patel3c91b052010-03-08 20:52:55 +00001041 } else if (Element.isDerivedType())
Devang Patel2db49d72010-05-07 18:11:54 +00001042 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3c91b052010-03-08 20:52:55 +00001043 else
1044 continue;
Devang Patel2c4ceb12009-11-21 02:48:08 +00001045 Buffer.addChild(ElemDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001046 }
1047
Devang Patela1ba2692009-08-27 23:51:51 +00001048 if (CTy.isAppleBlockExtension())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001049 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001050
1051 unsigned RLang = CTy.getRunTimeLang();
1052 if (RLang)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001053 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling0310d762009-05-15 09:23:25 +00001054 dwarf::DW_FORM_data1, RLang);
Devang Patelb5544992010-01-26 21:16:06 +00001055
1056 DICompositeType ContainingType = CTy.getContainingType();
Devang Patel2db49d72010-05-07 18:11:54 +00001057 if (DIDescriptor(ContainingType).isCompositeType())
Devang Patelb5544992010-01-26 21:16:06 +00001058 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patel2db49d72010-05-07 18:11:54 +00001059 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastings215aa152010-06-11 20:08:44 +00001060 else {
1061 DIDescriptor Context = CTy.getContext();
1062 addToContextOwner(&Buffer, Context);
1063 }
Bill Wendling0310d762009-05-15 09:23:25 +00001064 break;
1065 }
1066 default:
1067 break;
1068 }
1069
1070 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +00001071 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001072 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001073
Devang Patel8cbb6122010-01-29 18:34:58 +00001074 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type ||
Bill Wendling0310d762009-05-15 09:23:25 +00001075 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type) {
1076 // Add size if non-zero (derived types might be zero-sized.)
1077 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001078 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +00001079 else {
1080 // Add zero size if it is not a forward declaration.
1081 if (CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001082 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001083 else
Devang Patel2c4ceb12009-11-21 02:48:08 +00001084 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling0310d762009-05-15 09:23:25 +00001085 }
1086
1087 // Add source line info if available.
1088 if (!CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001089 addSourceLine(&Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001090 }
1091}
1092
Devang Patel2c4ceb12009-11-21 02:48:08 +00001093/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1094void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling0310d762009-05-15 09:23:25 +00001095 int64_t L = SR.getLo();
1096 int64_t H = SR.getHi();
1097 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1098
Devang Patel2c4ceb12009-11-21 02:48:08 +00001099 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patel6325a532009-08-14 20:59:16 +00001100 if (L)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001101 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Pateld55224c2009-12-04 23:10:24 +00001102 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling0310d762009-05-15 09:23:25 +00001103
Devang Patel2c4ceb12009-11-21 02:48:08 +00001104 Buffer.addChild(DW_Subrange);
Bill Wendling0310d762009-05-15 09:23:25 +00001105}
1106
Devang Patel2c4ceb12009-11-21 02:48:08 +00001107/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +00001108void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling0310d762009-05-15 09:23:25 +00001109 DICompositeType *CTy) {
1110 Buffer.setTag(dwarf::DW_TAG_array_type);
1111 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001112 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001113
1114 // Emit derived type.
Devang Patel8a241142009-12-09 18:24:21 +00001115 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001116 DIArray Elements = CTy->getTypeArray();
1117
Devang Patel6f01d9c2009-11-21 00:31:03 +00001118 // Get an anonymous type for index type.
Devang Patel163a9f72010-05-10 22:49:55 +00001119 CompileUnit *TheCU = getCompileUnit(*CTy);
1120 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel6f01d9c2009-11-21 00:31:03 +00001121 if (!IdxTy) {
1122 // Construct an anonymous type for index type.
1123 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001124 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1125 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel6f01d9c2009-11-21 00:31:03 +00001126 dwarf::DW_ATE_signed);
Devang Patel163a9f72010-05-10 22:49:55 +00001127 TheCU->addDie(IdxTy);
1128 TheCU->setIndexTyDie(IdxTy);
Devang Patel6f01d9c2009-11-21 00:31:03 +00001129 }
Bill Wendling0310d762009-05-15 09:23:25 +00001130
1131 // Add subranges to array type.
1132 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1133 DIDescriptor Element = Elements.getElement(i);
1134 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patel2db49d72010-05-07 18:11:54 +00001135 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001136 }
1137}
1138
Devang Patel2c4ceb12009-11-21 02:48:08 +00001139/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3c91b052010-03-08 20:52:55 +00001140DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001141 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3c91b052010-03-08 20:52:55 +00001142 StringRef Name = ETy.getName();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001143 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3c91b052010-03-08 20:52:55 +00001144 int64_t Value = ETy.getEnumValue();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001145 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling0310d762009-05-15 09:23:25 +00001146 return Enumerator;
1147}
1148
Devang Patel351ca332010-01-05 01:46:14 +00001149/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
1150/// printer to not emit usual symbol prefix before the symbol name is used then
1151/// return linkage name after skipping this special LLVM prefix.
1152static StringRef getRealLinkageName(StringRef LinkageName) {
1153 char One = '\1';
1154 if (LinkageName.startswith(StringRef(&One, 1)))
1155 return LinkageName.substr(1);
1156 return LinkageName;
1157}
1158
Devang Patel2c4ceb12009-11-21 02:48:08 +00001159/// createGlobalVariableDIE - Create new DIE using GV.
Devang Patel8a241142009-12-09 18:24:21 +00001160DIE *DwarfDebug::createGlobalVariableDIE(const DIGlobalVariable &GV) {
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001161 // If the global variable was optmized out then no need to create debug info
1162 // entry.
Devang Patel84c73e92009-11-06 17:58:12 +00001163 if (!GV.getGlobal()) return NULL;
Devang Patel65dbc902009-11-25 17:36:49 +00001164 if (GV.getDisplayName().empty()) return NULL;
Devang Patel465c3be2009-11-06 01:30:04 +00001165
Bill Wendling0310d762009-05-15 09:23:25 +00001166 DIE *GVDie = new DIE(dwarf::DW_TAG_variable);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001167 addString(GVDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001168 GV.getDisplayName());
1169
Devang Patel65dbc902009-11-25 17:36:49 +00001170 StringRef LinkageName = GV.getLinkageName();
Devang Patel351ca332010-01-05 01:46:14 +00001171 if (!LinkageName.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001172 addString(GVDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel351ca332010-01-05 01:46:14 +00001173 getRealLinkageName(LinkageName));
1174
Devang Patel8a241142009-12-09 18:24:21 +00001175 addType(GVDie, GV.getType());
Bill Wendling0310d762009-05-15 09:23:25 +00001176 if (!GV.isLocalToUnit())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001177 addUInt(GVDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1178 addSourceLine(GVDie, &GV);
Devang Patelb71a16d2009-10-05 23:22:08 +00001179
Bill Wendling0310d762009-05-15 09:23:25 +00001180 return GVDie;
1181}
1182
Devang Patel2c4ceb12009-11-21 02:48:08 +00001183/// createMemberDIE - Create new member DIE.
Devang Patel8a241142009-12-09 18:24:21 +00001184DIE *DwarfDebug::createMemberDIE(const DIDerivedType &DT) {
Bill Wendling0310d762009-05-15 09:23:25 +00001185 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel65dbc902009-11-25 17:36:49 +00001186 StringRef Name = DT.getName();
1187 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001188 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel65dbc902009-11-25 17:36:49 +00001189
Devang Patel8a241142009-12-09 18:24:21 +00001190 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001191
Devang Patel2c4ceb12009-11-21 02:48:08 +00001192 addSourceLine(MemberDie, &DT);
Bill Wendling0310d762009-05-15 09:23:25 +00001193
Benjamin Kramer345ef342010-03-31 19:34:01 +00001194 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001195 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel33db5082009-11-04 22:06:12 +00001196
Bill Wendling0310d762009-05-15 09:23:25 +00001197 uint64_t Size = DT.getSizeInBits();
Devang Patel61ecbd12009-11-04 23:48:00 +00001198 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling0310d762009-05-15 09:23:25 +00001199
1200 if (Size != FieldSize) {
1201 // Handle bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001202 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1203 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling0310d762009-05-15 09:23:25 +00001204
1205 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling0310d762009-05-15 09:23:25 +00001206 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1207 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer3d594fd2010-01-07 17:50:57 +00001208 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling0310d762009-05-15 09:23:25 +00001209 Offset -= FieldOffset;
1210
1211 // Maybe we need to work from the other end.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001212 if (Asm->getTargetData().isLittleEndian())
1213 Offset = FieldSize - (Offset + Size);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001214 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling0310d762009-05-15 09:23:25 +00001215
Devang Patel33db5082009-11-04 22:06:12 +00001216 // Here WD_AT_data_member_location points to the anonymous
1217 // field that includes this bit field.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001218 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001219
1220 } else
1221 // This is not a bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001222 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001223
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001224 if (DT.getTag() == dwarf::DW_TAG_inheritance
1225 && DT.isVirtual()) {
1226
1227 // For C++, virtual base classes are not at fixed offset. Use following
1228 // expression to extract appropriate offset from vtable.
1229 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1230
Benjamin Kramer345ef342010-03-31 19:34:01 +00001231 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001232 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1233 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1234 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1235 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1236 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1237 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1238 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1239
1240 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
1241 VBaseLocationDie);
1242 } else
1243 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001244
1245 if (DT.isProtected())
Devang Patel5d11eb02009-12-03 19:11:07 +00001246 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001247 dwarf::DW_ACCESS_protected);
1248 else if (DT.isPrivate())
Devang Patel5d11eb02009-12-03 19:11:07 +00001249 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001250 dwarf::DW_ACCESS_private);
Devang Patel5d11eb02009-12-03 19:11:07 +00001251 else if (DT.getTag() == dwarf::DW_TAG_inheritance)
1252 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1253 dwarf::DW_ACCESS_public);
1254 if (DT.isVirtual())
1255 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1256 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling0310d762009-05-15 09:23:25 +00001257 return MemberDie;
1258}
1259
Devang Patelffe966c2009-12-14 16:18:45 +00001260/// createSubprogramDIE - Create new DIE using SP.
1261DIE *DwarfDebug::createSubprogramDIE(const DISubprogram &SP, bool MakeDecl) {
Devang Patel163a9f72010-05-10 22:49:55 +00001262 CompileUnit *SPCU = getCompileUnit(SP);
1263 DIE *SPDie = SPCU->getDIE(SP);
Devang Patelffe966c2009-12-14 16:18:45 +00001264 if (SPDie)
1265 return SPDie;
1266
1267 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel1eac3e72010-03-02 17:58:15 +00001268 // Constructors and operators for anonymous aggregates do not have names.
Devang Patel6b506cb2010-03-02 01:26:20 +00001269 if (!SP.getName().empty())
1270 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling0310d762009-05-15 09:23:25 +00001271
Devang Patel65dbc902009-11-25 17:36:49 +00001272 StringRef LinkageName = SP.getLinkageName();
Devang Patel351ca332010-01-05 01:46:14 +00001273 if (!LinkageName.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001274 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel351ca332010-01-05 01:46:14 +00001275 getRealLinkageName(LinkageName));
1276
Devang Patel2c4ceb12009-11-21 02:48:08 +00001277 addSourceLine(SPDie, &SP);
Bill Wendling0310d762009-05-15 09:23:25 +00001278
Bill Wendling0310d762009-05-15 09:23:25 +00001279 // Add prototyped tag, if C or ObjC.
1280 unsigned Lang = SP.getCompileUnit().getLanguage();
1281 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1282 Lang == dwarf::DW_LANG_ObjC)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001283 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001284
1285 // Add Return Type.
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001286 DICompositeType SPTy = SP.getType();
1287 DIArray Args = SPTy.getTypeArray();
Bill Wendling0310d762009-05-15 09:23:25 +00001288 unsigned SPTag = SPTy.getTag();
Devang Patel5d11eb02009-12-03 19:11:07 +00001289
Devang Patel3c91b052010-03-08 20:52:55 +00001290 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel8a241142009-12-09 18:24:21 +00001291 addType(SPDie, SPTy);
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001292 else
Devang Patel2db49d72010-05-07 18:11:54 +00001293 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001294
Devang Patel5d11eb02009-12-03 19:11:07 +00001295 unsigned VK = SP.getVirtuality();
1296 if (VK) {
1297 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer345ef342010-03-31 19:34:01 +00001298 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel5d11eb02009-12-03 19:11:07 +00001299 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1300 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1301 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Devang Patel622b0262010-01-19 06:19:05 +00001302 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patel2db49d72010-05-07 18:11:54 +00001303 SP.getContainingType()));
Devang Patel5d11eb02009-12-03 19:11:07 +00001304 }
1305
Devang Patelffe966c2009-12-14 16:18:45 +00001306 if (MakeDecl || !SP.isDefinition()) {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001307 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001308
1309 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001310 // be handled while processing variables.
1311 DICompositeType SPTy = SP.getType();
1312 DIArray Args = SPTy.getTypeArray();
1313 unsigned SPTag = SPTy.getTag();
1314
Bill Wendling0310d762009-05-15 09:23:25 +00001315 if (SPTag == dwarf::DW_TAG_subroutine_type)
1316 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1317 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001318 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patelb4645642010-02-06 01:02:37 +00001319 addType(Arg, ATy);
1320 if (ATy.isArtificial())
1321 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001322 SPDie->addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001323 }
1324 }
1325
Devang Patel4e0d19d2010-02-03 19:57:19 +00001326 if (SP.isArtificial())
1327 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1328
Devang Patelccff8122010-04-30 19:38:23 +00001329 if (!SP.isLocalToUnit())
1330 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patel2a4a3b72010-04-19 19:14:02 +00001331
Devang Patelccff8122010-04-30 19:38:23 +00001332 if (SP.isOptimized())
1333 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1334
Devang Patelccff8122010-04-30 19:38:23 +00001335 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel163a9f72010-05-10 22:49:55 +00001336 SPCU->insertDIE(SP, SPDie);
Devang Patelccff8122010-04-30 19:38:23 +00001337
Stuart Hastings215aa152010-06-11 20:08:44 +00001338 // Add to context owner.
1339 addToContextOwner(SPDie, SP.getContext());
1340
Bill Wendling0310d762009-05-15 09:23:25 +00001341 return SPDie;
1342}
1343
Devang Patele9f8f5e2010-05-07 20:54:48 +00001344DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattnered7a77b2010-03-31 05:36:29 +00001345 assert(N && "Invalid Scope encoding!");
Devang Patel53bb5c92009-11-10 23:06:00 +00001346
1347 DbgScope *AScope = AbstractScopes.lookup(N);
1348 if (AScope)
1349 return AScope;
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001350
Devang Patel53bb5c92009-11-10 23:06:00 +00001351 DbgScope *Parent = NULL;
1352
1353 DIDescriptor Scope(N);
1354 if (Scope.isLexicalBlock()) {
1355 DILexicalBlock DB(N);
1356 DIDescriptor ParentDesc = DB.getContext();
Devang Patel2db49d72010-05-07 18:11:54 +00001357 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patel53bb5c92009-11-10 23:06:00 +00001358 }
1359
1360 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1361
1362 if (Parent)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001363 Parent->addScope(AScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001364 AScope->setAbstractScope();
1365 AbstractScopes[N] = AScope;
1366 if (DIDescriptor(N).isSubprogram())
1367 AbstractScopesList.push_back(AScope);
1368 return AScope;
1369}
Devang Patelaf9e8472009-10-01 20:31:14 +00001370
Devang Patel5f094002010-04-06 23:53:48 +00001371/// isSubprogramContext - Return true if Context is either a subprogram
1372/// or another context nested inside a subprogram.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001373static bool isSubprogramContext(const MDNode *Context) {
Devang Patel5f094002010-04-06 23:53:48 +00001374 if (!Context)
1375 return false;
1376 DIDescriptor D(Context);
1377 if (D.isSubprogram())
1378 return true;
1379 if (D.isType())
Devang Patel2db49d72010-05-07 18:11:54 +00001380 return isSubprogramContext(DIType(Context).getContext());
Devang Patel5f094002010-04-06 23:53:48 +00001381 return false;
1382}
1383
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001384/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel2c4ceb12009-11-21 02:48:08 +00001385/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1386/// If there are global variables in this scope then create and insert
1387/// DIEs for these variables.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001388DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel163a9f72010-05-10 22:49:55 +00001389 CompileUnit *SPCU = getCompileUnit(SPNode);
1390 DIE *SPDie = SPCU->getDIE(SPNode);
Chris Lattnerd38fee82010-04-05 00:13:49 +00001391 assert(SPDie && "Unable to find subprogram DIE!");
1392 DISubprogram SP(SPNode);
Chris Lattner206d61e2010-03-13 07:26:18 +00001393
Chris Lattnerd38fee82010-04-05 00:13:49 +00001394 // There is not any need to generate specification DIE for a function
1395 // defined at compile unit level. If a function is defined inside another
1396 // function then gdb prefers the definition at top level and but does not
1397 // expect specification DIE in parent function. So avoid creating
1398 // specification DIE for a function defined inside a function.
1399 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Devang Patel5f094002010-04-06 23:53:48 +00001400 !SP.getContext().isFile() &&
Devang Patel2db49d72010-05-07 18:11:54 +00001401 !isSubprogramContext(SP.getContext())) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00001402 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1403
1404 // Add arguments.
1405 DICompositeType SPTy = SP.getType();
1406 DIArray Args = SPTy.getTypeArray();
1407 unsigned SPTag = SPTy.getTag();
1408 if (SPTag == dwarf::DW_TAG_subroutine_type)
1409 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1410 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001411 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattnerd38fee82010-04-05 00:13:49 +00001412 addType(Arg, ATy);
1413 if (ATy.isArtificial())
1414 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1415 SPDie->addChild(Arg);
1416 }
1417 DIE *SPDeclDie = SPDie;
1418 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1419 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
1420 SPDeclDie);
Devang Patel163a9f72010-05-10 22:49:55 +00001421 SPCU->addDie(SPDie);
Chris Lattnerd38fee82010-04-05 00:13:49 +00001422 }
1423
1424 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1425 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1426 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1427 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1428 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1429 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1430 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +00001431
Chris Lattnerd38fee82010-04-05 00:13:49 +00001432 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +00001433}
1434
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001435/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel2c4ceb12009-11-21 02:48:08 +00001436/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1437DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001438
1439 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1440 if (Scope->isAbstractScope())
1441 return ScopeDIE;
1442
1443 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1444 if (Ranges.empty())
1445 return 0;
1446
1447 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1448 if (Ranges.size() > 1) {
1449 // .debug_range section has not been laid out yet. Emit offset in
1450 // .debug_range as a uint, size 4, for now. emitDIE will handle
1451 // DW_AT_ranges appropriately.
1452 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1453 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1454 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1455 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +00001456 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1457 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +00001458 }
1459 DebugRangeSymbols.push_back(NULL);
1460 DebugRangeSymbols.push_back(NULL);
1461 return ScopeDIE;
1462 }
1463
Devang Patelc3f5f782010-05-25 23:40:22 +00001464 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1465 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001466
Devang Patelc3f5f782010-05-25 23:40:22 +00001467 if (End == 0) return 0;
Devang Patel53bb5c92009-11-10 23:06:00 +00001468
Chris Lattnerb7db7332010-03-09 01:58:53 +00001469 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1470 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Chris Lattnera34ec2292010-03-09 01:51:43 +00001471
Devang Pateleac9c072010-04-27 19:46:33 +00001472 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1473 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patel53bb5c92009-11-10 23:06:00 +00001474
1475 return ScopeDIE;
1476}
1477
Devang Patel2c4ceb12009-11-21 02:48:08 +00001478/// constructInlinedScopeDIE - This scope represents inlined body of
1479/// a function. Construct DIE to represent this concrete inlined copy
1480/// of the function.
1481DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001482
1483 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1484 assert (Ranges.empty() == false
1485 && "DbgScope does not have instruction markers!");
1486
1487 // FIXME : .debug_inlined section specification does not clearly state how
1488 // to emit inlined scope that is split into multiple instruction ranges.
1489 // For now, use first instruction range and emit low_pc/high_pc pair and
1490 // corresponding .debug_inlined section entry for this pair.
1491 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patelc3f5f782010-05-25 23:40:22 +00001492 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1493 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001494
Devang Patelc3f5f782010-05-25 23:40:22 +00001495 if (StartLabel == FunctionBeginSym || EndLabel == 0) {
Devang Pateleac9c072010-04-27 19:46:33 +00001496 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1497 return 0;
1498 }
Chris Lattnerb7db7332010-03-09 01:58:53 +00001499 assert(StartLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001500 "Invalid starting label for an inlined scope!");
Chris Lattnerb7db7332010-03-09 01:58:53 +00001501 assert(EndLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001502 "Invalid end label for an inlined scope!");
Devang Pateleac9c072010-04-27 19:46:33 +00001503
Devang Patel3c91b052010-03-08 20:52:55 +00001504 if (!Scope->getScopeNode())
Devang Patel0ef3fa62010-03-08 19:20:38 +00001505 return NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001506 DIScope DS(Scope->getScopeNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00001507 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1508
Devang Patel2db49d72010-05-07 18:11:54 +00001509 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel163a9f72010-05-10 22:49:55 +00001510 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1511 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001512 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel2c4ceb12009-11-21 02:48:08 +00001513 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001514 dwarf::DW_FORM_ref4, OriginDIE);
1515
Chris Lattner6ed0f902010-03-09 00:31:02 +00001516 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnerb7db7332010-03-09 01:58:53 +00001517 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patel53bb5c92009-11-10 23:06:00 +00001518
1519 InlinedSubprogramDIEs.insert(OriginDIE);
1520
1521 // Track the start label for this inlined function.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001522 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patel2db49d72010-05-07 18:11:54 +00001523 I = InlineInfo.find(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001524
1525 if (I == InlineInfo.end()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001526 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001527 ScopeDIE));
Devang Patel2db49d72010-05-07 18:11:54 +00001528 InlinedSPNodes.push_back(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001529 } else
Chris Lattner6ed0f902010-03-09 00:31:02 +00001530 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patel53bb5c92009-11-10 23:06:00 +00001531
Devang Patel53bb5c92009-11-10 23:06:00 +00001532 DILocation DL(Scope->getInlinedAt());
Devang Patel163a9f72010-05-10 22:49:55 +00001533 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001534 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +00001535
1536 return ScopeDIE;
1537}
1538
Devang Patel2c4ceb12009-11-21 02:48:08 +00001539
1540/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel8a241142009-12-09 18:24:21 +00001541DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001542 // Get the descriptor.
1543 const DIVariable &VD = DV->getVariable();
Devang Patel65dbc902009-11-25 17:36:49 +00001544 StringRef Name = VD.getName();
1545 if (Name.empty())
Devang Patel3fb6bd62009-11-13 02:25:26 +00001546 return NULL;
Devang Patel53bb5c92009-11-10 23:06:00 +00001547
1548 // Translate tag to proper Dwarf tag. The result variable is dropped for
1549 // now.
1550 unsigned Tag;
1551 switch (VD.getTag()) {
1552 case dwarf::DW_TAG_return_variable:
1553 return NULL;
1554 case dwarf::DW_TAG_arg_variable:
1555 Tag = dwarf::DW_TAG_formal_parameter;
1556 break;
1557 case dwarf::DW_TAG_auto_variable: // fall thru
1558 default:
1559 Tag = dwarf::DW_TAG_variable;
1560 break;
1561 }
1562
1563 // Define variable debug information entry.
1564 DIE *VariableDie = new DIE(Tag);
1565
Devang Patel53bb5c92009-11-10 23:06:00 +00001566 DIE *AbsDIE = NULL;
Devang Patel26c1e562010-05-20 16:36:41 +00001567 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1568 V2AVI = VarToAbstractVarMap.find(DV);
1569 if (V2AVI != VarToAbstractVarMap.end())
1570 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001571
Devang Patel26c1e562010-05-20 16:36:41 +00001572 if (AbsDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001573 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001574 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001575 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001576 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
1577 addSourceLine(VariableDie, &VD);
Devang Patel53bb5c92009-11-10 23:06:00 +00001578
1579 // Add variable type.
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001580 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
Devang Patel53bb5c92009-11-10 23:06:00 +00001581 // addresses instead.
1582 if (VD.isBlockByrefVariable())
Devang Patel8a241142009-12-09 18:24:21 +00001583 addType(VariableDie, getBlockByrefType(VD.getType(), Name));
Devang Patel53bb5c92009-11-10 23:06:00 +00001584 else
Devang Patel8a241142009-12-09 18:24:21 +00001585 addType(VariableDie, VD.getType());
Devang Patel53bb5c92009-11-10 23:06:00 +00001586 }
1587
Devang Patelb4645642010-02-06 01:02:37 +00001588 if (Tag == dwarf::DW_TAG_formal_parameter && VD.getType().isArtificial())
1589 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelc3f5f782010-05-25 23:40:22 +00001590
1591 if (Scope->isAbstractScope()) {
1592 DV->setDIE(VariableDie);
1593 return VariableDie;
1594 }
1595
1596 // Add variable address.
1597
1598 unsigned Offset = DV->getDotDebugLocOffset();
1599 if (Offset != ~0U) {
1600 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1601 Asm->GetTempSymbol("debug_loc", Offset));
1602 DV->setDIE(VariableDie);
1603 UseDotDebugLocEntry.insert(VariableDie);
1604 return VariableDie;
1605 }
1606
1607 // Check if variable is described by a DBG_VALUE instruction.
1608 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1609 DbgVariableToDbgInstMap.find(DV);
1610 if (DVI != DbgVariableToDbgInstMap.end()) {
1611 const MachineInstr *DVInsn = DVI->second;
1612 const MCSymbol *DVLabel = findVariableLabel(DV);
1613 bool updated = false;
1614 // FIXME : Handle getNumOperands != 3
1615 if (DVInsn->getNumOperands() == 3) {
1616 if (DVInsn->getOperand(0).isReg())
1617 updated = addRegisterAddress(VariableDie, DVLabel, DVInsn->getOperand(0));
1618 else if (DVInsn->getOperand(0).isImm())
1619 updated = addConstantValue(VariableDie, DVLabel, DVInsn->getOperand(0));
1620 else if (DVInsn->getOperand(0).isFPImm())
1621 updated = addConstantFPValue(VariableDie, DVLabel, DVInsn->getOperand(0));
1622 } else {
1623 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1624 if (Location.getReg()) {
1625 addAddress(VariableDie, dwarf::DW_AT_location, Location);
1626 if (DVLabel)
1627 addLabel(VariableDie, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr,
1628 DVLabel);
1629 updated = true;
1630 }
1631 }
1632 if (!updated) {
1633 // If variableDie is not updated then DBG_VALUE instruction does not
1634 // have valid variable info.
1635 delete VariableDie;
1636 return NULL;
1637 }
1638 DV->setDIE(VariableDie);
1639 return VariableDie;
1640 }
1641
1642 // .. else use frame index, if available.
1643 MachineLocation Location;
1644 unsigned FrameReg;
1645 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1646 int FI = 0;
1647 if (findVariableFrameIndex(DV, &FI)) {
1648 int Offset = RI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
1649 Location.set(FrameReg, Offset);
1650
1651 if (VD.hasComplexAddress())
1652 addComplexAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
1653 else if (VD.isBlockByrefVariable())
1654 addBlockByrefAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
1655 else
1656 addAddress(VariableDie, dwarf::DW_AT_location, Location);
1657 }
Devang Patel53bb5c92009-11-10 23:06:00 +00001658 DV->setDIE(VariableDie);
1659 return VariableDie;
1660
1661}
Devang Patel2c4ceb12009-11-21 02:48:08 +00001662
Devang Patel193f7202009-11-24 01:14:22 +00001663void DwarfDebug::addPubTypes(DISubprogram SP) {
1664 DICompositeType SPTy = SP.getType();
1665 unsigned SPTag = SPTy.getTag();
1666 if (SPTag != dwarf::DW_TAG_subroutine_type)
1667 return;
1668
1669 DIArray Args = SPTy.getTypeArray();
Devang Patel193f7202009-11-24 01:14:22 +00001670 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patel2db49d72010-05-07 18:11:54 +00001671 DIType ATy(Args.getElement(i));
Devang Patel9c004872010-05-07 21:45:47 +00001672 if (!ATy.Verify())
Devang Patel193f7202009-11-24 01:14:22 +00001673 continue;
1674 DICompositeType CATy = getDICompositeType(ATy);
Devang Patel2db49d72010-05-07 18:11:54 +00001675 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel50d80e32010-04-13 20:35:04 +00001676 && !CATy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001677 CompileUnit *TheCU = getCompileUnit(CATy);
1678 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1679 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001680 }
1681 }
1682}
1683
Devang Patel2c4ceb12009-11-21 02:48:08 +00001684/// constructScopeDIE - Construct a DIE for this scope.
1685DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3c91b052010-03-08 20:52:55 +00001686 if (!Scope || !Scope->getScopeNode())
1687 return NULL;
1688
1689 DIScope DS(Scope->getScopeNode());
1690 DIE *ScopeDIE = NULL;
1691 if (Scope->getInlinedAt())
1692 ScopeDIE = constructInlinedScopeDIE(Scope);
1693 else if (DS.isSubprogram()) {
1694 if (Scope->isAbstractScope())
Devang Patel163a9f72010-05-10 22:49:55 +00001695 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patel3c91b052010-03-08 20:52:55 +00001696 else
Devang Patel2db49d72010-05-07 18:11:54 +00001697 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3c91b052010-03-08 20:52:55 +00001698 }
Devang Patelaead63c2010-03-29 22:59:58 +00001699 else
Devang Patel3c91b052010-03-08 20:52:55 +00001700 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patelaead63c2010-03-29 22:59:58 +00001701 if (!ScopeDIE) return NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001702
Devang Patel53bb5c92009-11-10 23:06:00 +00001703 // Add variables to scope.
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001704 const SmallVector<DbgVariable *, 8> &Variables = Scope->getVariables();
Devang Patel53bb5c92009-11-10 23:06:00 +00001705 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel8a241142009-12-09 18:24:21 +00001706 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001707 if (VariableDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001708 ScopeDIE->addChild(VariableDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001709 }
1710
1711 // Add nested scopes.
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001712 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
Devang Patel53bb5c92009-11-10 23:06:00 +00001713 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1714 // Define the Scope debug information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001715 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001716 if (NestedDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001717 ScopeDIE->addChild(NestedDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001718 }
Devang Patel193f7202009-11-24 01:14:22 +00001719
1720 if (DS.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001721 addPubTypes(DISubprogram(DS));
Devang Patel193f7202009-11-24 01:14:22 +00001722
1723 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +00001724}
1725
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001726/// GetOrCreateSourceID - Look up the source id with the given directory and
1727/// source file names. If none currently exists, create a new id and insert it
1728/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1729/// maps as well.
Chris Lattner1d65ba72010-03-31 06:06:37 +00001730unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName){
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001731 unsigned DId;
1732 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1733 if (DI != DirectoryIdMap.end()) {
1734 DId = DI->getValue();
1735 } else {
1736 DId = DirectoryNames.size() + 1;
1737 DirectoryIdMap[DirName] = DId;
1738 DirectoryNames.push_back(DirName);
1739 }
1740
1741 unsigned FId;
1742 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1743 if (FI != SourceFileIdMap.end()) {
1744 FId = FI->getValue();
1745 } else {
1746 FId = SourceFileNames.size() + 1;
1747 SourceFileIdMap[FileName] = FId;
1748 SourceFileNames.push_back(FileName);
1749 }
1750
1751 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1752 SourceIdMap.find(std::make_pair(DId, FId));
1753 if (SI != SourceIdMap.end())
1754 return SI->second;
1755
1756 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1757 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1758 SourceIds.push_back(std::make_pair(DId, FId));
1759
1760 return SrcId;
1761}
1762
Devang Patel6404e4e2009-12-15 19:16:48 +00001763/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1764DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel163a9f72010-05-10 22:49:55 +00001765 CompileUnit *TheCU = getCompileUnit(NS);
1766 DIE *NDie = TheCU->getDIE(NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001767 if (NDie)
1768 return NDie;
1769 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel163a9f72010-05-10 22:49:55 +00001770 TheCU->insertDIE(NS, NDie);
Devang Patel6404e4e2009-12-15 19:16:48 +00001771 if (!NS.getName().empty())
1772 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
1773 addSourceLine(NDie, &NS);
1774 addToContextOwner(NDie, NS.getContext());
1775 return NDie;
1776}
1777
Devang Patel163a9f72010-05-10 22:49:55 +00001778/// constructCompileUnit - Create new CompileUnit for the given
1779/// metadata node with tag DW_TAG_compile_unit.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001780void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001781 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +00001782 StringRef FN = DIUnit.getFilename();
1783 StringRef Dir = DIUnit.getDirectory();
Devang Patel5ccdd102009-09-29 18:40:58 +00001784 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001785
1786 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001787 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001788 DIUnit.getProducer());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001789 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001790 DIUnit.getLanguage());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001791 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patel5098da02010-04-26 22:54:28 +00001792 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1793 // simplifies debug range entries.
1794 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_data4, 0);
Devang Patel4a602ca2010-03-22 23:11:36 +00001795 // DW_AT_stmt_list is a offset of line number information for this
1796 // compile unit in debug_line section. It is always zero when only one
1797 // compile unit is emitted in one object file.
1798 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001799
Devang Patel65dbc902009-11-25 17:36:49 +00001800 if (!Dir.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001801 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001802 if (DIUnit.isOptimized())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001803 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001804
Devang Patel65dbc902009-11-25 17:36:49 +00001805 StringRef Flags = DIUnit.getFlags();
1806 if (!Flags.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001807 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001808
1809 unsigned RVer = DIUnit.getRunTimeVersion();
1810 if (RVer)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001811 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001812 dwarf::DW_FORM_data1, RVer);
1813
Devang Patel163a9f72010-05-10 22:49:55 +00001814 CompileUnit *NewCU = new CompileUnit(ID, Die);
1815 if (!FirstCU)
1816 FirstCU = NewCU;
1817 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001818}
1819
Devang Patel163a9f72010-05-10 22:49:55 +00001820/// getCompielUnit - Get CompileUnit DIE.
1821CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1822 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1823 DIDescriptor D(N);
1824 const MDNode *CUNode = NULL;
1825 if (D.isCompileUnit())
1826 CUNode = N;
1827 else if (D.isSubprogram())
1828 CUNode = DISubprogram(N).getCompileUnit();
1829 else if (D.isType())
1830 CUNode = DIType(N).getCompileUnit();
1831 else if (D.isGlobalVariable())
1832 CUNode = DIGlobalVariable(N).getCompileUnit();
1833 else if (D.isVariable())
1834 CUNode = DIVariable(N).getCompileUnit();
1835 else if (D.isNameSpace())
1836 CUNode = DINameSpace(N).getCompileUnit();
1837 else if (D.isFile())
1838 CUNode = DIFile(N).getCompileUnit();
1839 else
1840 return FirstCU;
1841
1842 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1843 = CUMap.find(CUNode);
1844 if (I == CUMap.end())
1845 return FirstCU;
1846 return I->second;
1847}
1848
1849
1850/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001851void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001852 DIGlobalVariable DI_GV(N);
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001853
Devang Patel905cf5e2009-09-04 23:59:07 +00001854 // If debug information is malformed then ignore it.
1855 if (DI_GV.Verify() == false)
1856 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001857
1858 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00001859 CompileUnit *TheCU = getCompileUnit(N);
1860 if (TheCU->getDIE(DI_GV))
Devang Patel13e16b62009-06-26 01:49:18 +00001861 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001862
Devang Patel8a241142009-12-09 18:24:21 +00001863 DIE *VariableDie = createGlobalVariableDIE(DI_GV);
Devang Pateledb45632009-12-10 23:25:41 +00001864 if (!VariableDie)
1865 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001866
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001867 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +00001868 TheCU->insertDIE(N, VariableDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001869
1870 // Add to context owner.
Devang Patelc9b16cc2010-01-15 01:12:22 +00001871 DIDescriptor GVContext = DI_GV.getContext();
1872 // Do not create specification DIE if context is either compile unit
1873 // or a subprogram.
Chris Lattner1d65ba72010-03-31 06:06:37 +00001874 if (DI_GV.isDefinition() && !GVContext.isCompileUnit() &&
Devang Patel5f094002010-04-06 23:53:48 +00001875 !GVContext.isFile() &&
Devang Patel2db49d72010-05-07 18:11:54 +00001876 !isSubprogramContext(GVContext)) {
Devang Patel6404e4e2009-12-15 19:16:48 +00001877 // Create specification DIE.
1878 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1879 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1880 dwarf::DW_FORM_ref4, VariableDie);
Benjamin Kramer345ef342010-03-31 19:34:01 +00001881 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel6404e4e2009-12-15 19:16:48 +00001882 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
Chris Lattner4faf59a2010-03-08 22:31:46 +00001883 addLabel(Block, 0, dwarf::DW_FORM_udata,
Chris Lattnerdeb0cba2010-03-12 21:09:07 +00001884 Asm->Mang->getSymbol(DI_GV.getGlobal()));
Devang Patel6404e4e2009-12-15 19:16:48 +00001885 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
Devang Patel8581e012010-02-09 01:58:33 +00001886 addUInt(VariableDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Devang Patel163a9f72010-05-10 22:49:55 +00001887 TheCU->addDie(VariableSpecDIE);
Devang Patel6404e4e2009-12-15 19:16:48 +00001888 } else {
Benjamin Kramer345ef342010-03-31 19:34:01 +00001889 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel6404e4e2009-12-15 19:16:48 +00001890 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
Chris Lattner4faf59a2010-03-08 22:31:46 +00001891 addLabel(Block, 0, dwarf::DW_FORM_udata,
Chris Lattnerdeb0cba2010-03-12 21:09:07 +00001892 Asm->Mang->getSymbol(DI_GV.getGlobal()));
Devang Patel6404e4e2009-12-15 19:16:48 +00001893 addBlock(VariableDie, dwarf::DW_AT_location, 0, Block);
1894 }
Devang Patelc9b16cc2010-01-15 01:12:22 +00001895 addToContextOwner(VariableDie, GVContext);
Devang Patelc366f832009-12-10 19:14:49 +00001896
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001897 // Expose as global. FIXME - need to check external flag.
Devang Patel163a9f72010-05-10 22:49:55 +00001898 TheCU->addGlobal(DI_GV.getName(), VariableDie);
Devang Patel193f7202009-11-24 01:14:22 +00001899
1900 DIType GTy = DI_GV.getType();
Devang Patel50d80e32010-04-13 20:35:04 +00001901 if (GTy.isCompositeType() && !GTy.getName().empty()
1902 && !GTy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001903 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001904 assert(Entry && "Missing global type!");
Devang Patel163a9f72010-05-10 22:49:55 +00001905 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001906 }
Devang Patel13e16b62009-06-26 01:49:18 +00001907 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001908}
1909
Devang Patel163a9f72010-05-10 22:49:55 +00001910/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001911void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001912 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001913
Stuart Hastings639336e2010-04-06 21:38:29 +00001914 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00001915 CompileUnit *TheCU = getCompileUnit(N);
1916 if (TheCU->getDIE(N))
Stuart Hastings639336e2010-04-06 21:38:29 +00001917 return;
1918
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001919 if (!SP.isDefinition())
1920 // This is a method declaration which will be handled while constructing
1921 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +00001922 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001923
Stuart Hastings639336e2010-04-06 21:38:29 +00001924 DIE *SubprogramDie = createSubprogramDIE(SP);
1925
1926 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +00001927 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001928
1929 // Add to context owner.
Devang Patel6404e4e2009-12-15 19:16:48 +00001930 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +00001931
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001932 // Expose as global.
Devang Patel163a9f72010-05-10 22:49:55 +00001933 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel193f7202009-11-24 01:14:22 +00001934
Devang Patel13e16b62009-06-26 01:49:18 +00001935 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001936}
1937
Devang Patel2c4ceb12009-11-21 02:48:08 +00001938/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbar00564992009-09-19 20:40:14 +00001939/// content. Create global DIEs and emit initial debug info sections.
1940/// This is inovked by the target AsmPrinter.
Chris Lattner75f50722010-04-04 07:48:20 +00001941void DwarfDebug::beginModule(Module *M) {
Devang Pateleac9c072010-04-27 19:46:33 +00001942 if (DisableDebugInfoPrinting)
1943 return;
1944
Devang Patel78ab9e22009-07-30 18:56:46 +00001945 DebugInfoFinder DbgFinder;
1946 DbgFinder.processModule(*M);
Devang Patel13e16b62009-06-26 01:49:18 +00001947
Chris Lattnerd850ac72010-04-05 02:19:28 +00001948 bool HasDebugInfo = false;
1949
1950 // Scan all the compile-units to see if there are any marked as the main unit.
1951 // if not, we do not generate debug info.
1952 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1953 E = DbgFinder.compile_unit_end(); I != E; ++I) {
1954 if (DICompileUnit(*I).isMain()) {
1955 HasDebugInfo = true;
1956 break;
1957 }
1958 }
1959
1960 if (!HasDebugInfo) return;
1961
1962 // Tell MMI that we have debug info.
1963 MMI->setDebugInfoAvailability(true);
1964
Chris Lattnerbe15beb2010-04-04 23:17:54 +00001965 // Emit initial sections.
Chris Lattnerd850ac72010-04-05 02:19:28 +00001966 EmitSectionLabels();
Chris Lattnerbe15beb2010-04-04 23:17:54 +00001967
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001968 // Create all the compile unit DIEs.
Devang Patel78ab9e22009-07-30 18:56:46 +00001969 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1970 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001971 constructCompileUnit(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001972
Devang Patel53bb5c92009-11-10 23:06:00 +00001973 // Create DIEs for each subprogram.
Devang Patel78ab9e22009-07-30 18:56:46 +00001974 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
1975 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001976 constructSubprogramDIE(*I);
Devang Patel13e16b62009-06-26 01:49:18 +00001977
Devang Patelc366f832009-12-10 19:14:49 +00001978 // Create DIEs for each global variable.
1979 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
1980 E = DbgFinder.global_variable_end(); I != E; ++I)
1981 constructGlobalVariableDIE(*I);
1982
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001983 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +00001984 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001985
1986 // Print out .file directives to specify files for .loc directives. These are
1987 // printed out early so that they precede any .loc directives.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001988 if (Asm->MAI->hasDotLocAndDotFile()) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001989 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
1990 // Remember source id starts at 1.
1991 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
Chris Lattner0ad9c912010-01-22 22:09:00 +00001992 // FIXME: don't use sys::path for this! This should not depend on the
1993 // host.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001994 sys::Path FullPath(getSourceDirectoryName(Id.first));
1995 bool AppendOk =
1996 FullPath.appendComponent(getSourceFileName(Id.second));
1997 assert(AppendOk && "Could not append filename to directory!");
1998 AppendOk = false;
Chris Lattnera6594fc2010-01-25 18:58:59 +00001999 Asm->OutStreamer.EmitDwarfFileDirective(i, FullPath.str());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002000 }
2001 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002002}
2003
Devang Patel2c4ceb12009-11-21 02:48:08 +00002004/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002005///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002006void DwarfDebug::endModule() {
Devang Patel163a9f72010-05-10 22:49:55 +00002007 if (!FirstCU) return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002008
Devang Patel53bb5c92009-11-10 23:06:00 +00002009 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2010 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2011 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2012 DIE *ISP = *AI;
Devang Patel2c4ceb12009-11-21 02:48:08 +00002013 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +00002014 }
2015
Devang Patele9f8f5e2010-05-07 20:54:48 +00002016 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Patel5d11eb02009-12-03 19:11:07 +00002017 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2018 DIE *SPDie = CI->first;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002019 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Patel5d11eb02009-12-03 19:11:07 +00002020 if (!N) continue;
Devang Patel163a9f72010-05-10 22:49:55 +00002021 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Patel5d11eb02009-12-03 19:11:07 +00002022 if (!NDie) continue;
2023 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patel5d11eb02009-12-03 19:11:07 +00002024 }
2025
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002026 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002027 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002028 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002029 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002030 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002031
2032 // End text sections.
2033 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002034 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnerc0215722010-04-04 19:25:43 +00002035 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002036 }
2037
2038 // Emit common frame information.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002039 emitCommonDebugFrame();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002040
2041 // Emit function debug frame information
2042 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2043 E = DebugFrames.end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002044 emitFunctionDebugFrame(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002045
2046 // Compute DIE offsets and sizes.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002047 computeSizeAndOffsets();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002048
2049 // Emit all the DIEs into a debug info section
Devang Patel2c4ceb12009-11-21 02:48:08 +00002050 emitDebugInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002051
2052 // Corresponding abbreviations into a abbrev section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002053 emitAbbreviations();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002054
2055 // Emit source line correspondence into a debug line section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002056 emitDebugLines();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002057
2058 // Emit info into a debug pubnames section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002059 emitDebugPubNames();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002060
Devang Patel193f7202009-11-24 01:14:22 +00002061 // Emit info into a debug pubtypes section.
2062 emitDebugPubTypes();
2063
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002064 // Emit info into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002065 emitDebugLoc();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002066
2067 // Emit info into a debug aranges section.
2068 EmitDebugARanges();
2069
2070 // Emit info into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002071 emitDebugRanges();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002072
2073 // Emit info into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002074 emitDebugMacInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002075
2076 // Emit inline info.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002077 emitDebugInlineInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002078
Chris Lattnerbc733f52010-03-13 02:17:42 +00002079 // Emit info into a debug str section.
2080 emitDebugStr();
2081
Devang Patel163a9f72010-05-10 22:49:55 +00002082 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2083 E = CUMap.end(); I != E; ++I)
2084 delete I->second;
2085 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002086}
2087
Devang Patel53bb5c92009-11-10 23:06:00 +00002088/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Devang Patel26c1e562010-05-20 16:36:41 +00002089DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattnerde4845c2010-04-02 19:42:39 +00002090 DebugLoc ScopeLoc) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002091
Devang Patel2db49d72010-05-07 18:11:54 +00002092 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00002093 if (AbsDbgVariable)
2094 return AbsDbgVariable;
2095
Devang Patel2db49d72010-05-07 18:11:54 +00002096 LLVMContext &Ctx = Var->getContext();
Chris Lattnerde4845c2010-04-02 19:42:39 +00002097 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00002098 if (!Scope)
2099 return NULL;
2100
Devang Patel26c1e562010-05-20 16:36:41 +00002101 AbsDbgVariable = new DbgVariable(Var);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002102 Scope->addVariable(AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00002103 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00002104 return AbsDbgVariable;
2105}
2106
Devang Patelee432862010-05-20 19:57:06 +00002107/// collectVariableInfoFromMMITable - Collect variable information from
2108/// side table maintained by MMI.
2109void
2110DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2111 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00002112 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patele717faa2009-10-06 01:26:37 +00002113 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2114 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2115 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00002116 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00002117 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00002118 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002119 DIVariable DV(Var);
2120 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00002121
Chris Lattnerde4845c2010-04-02 19:42:39 +00002122 DbgScope *Scope = 0;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002123 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattnerde4845c2010-04-02 19:42:39 +00002124 Scope = ConcreteScopes.lookup(IA);
2125 if (Scope == 0)
2126 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
2127
Devang Patelfb0ee432009-11-10 23:20:04 +00002128 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00002129 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00002130 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00002131
Devang Patel26c1e562010-05-20 16:36:41 +00002132 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2133 DbgVariable *RegVar = new DbgVariable(DV);
2134 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002135 Scope->addVariable(RegVar);
Devang Patel26c1e562010-05-20 16:36:41 +00002136 if (AbsDbgVariable) {
2137 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2138 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2139 }
Devang Patele717faa2009-10-06 01:26:37 +00002140 }
Devang Patelee432862010-05-20 19:57:06 +00002141}
Devang Patel90a48ad2010-03-15 18:33:46 +00002142
Devang Patelc3f5f782010-05-25 23:40:22 +00002143/// isDbgValueInUndefinedReg - Return true if debug value, encoded by
2144/// DBG_VALUE instruction, is in undefined reg.
2145static bool isDbgValueInUndefinedReg(const MachineInstr *MI) {
2146 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2147 if (MI->getOperand(0).isReg() && !MI->getOperand(0).getReg())
2148 return true;
2149 return false;
2150}
2151
2152/// isDbgValueInDefinedReg - Return true if debug value, encoded by
2153/// DBG_VALUE instruction, is in a defined reg.
2154static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2155 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2156 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2157 return true;
2158 return false;
2159}
2160
Devang Patelee432862010-05-20 19:57:06 +00002161/// collectVariableInfo - Populate DbgScope entries with variables' info.
Devang Patel78e127d2010-06-25 22:07:34 +00002162void
2163DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2164 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patelee432862010-05-20 19:57:06 +00002165
2166 /// collection info from MMI table.
2167 collectVariableInfoFromMMITable(MF, Processed);
2168
2169 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patel90a48ad2010-03-15 18:33:46 +00002170 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002171 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelee432862010-05-20 19:57:06 +00002172 I != E; ++I)
Devang Patel90a48ad2010-03-15 18:33:46 +00002173 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2174 II != IE; ++II) {
2175 const MachineInstr *MInsn = II;
Devang Patelc3f5f782010-05-25 23:40:22 +00002176 if (!MInsn->isDebugValue() || isDbgValueInUndefinedReg(MInsn))
Devang Patel90a48ad2010-03-15 18:33:46 +00002177 continue;
Devang Patelee432862010-05-20 19:57:06 +00002178 DbgValues.push_back(MInsn);
2179 }
Devang Patel90a48ad2010-03-15 18:33:46 +00002180
Devang Patelc3f5f782010-05-25 23:40:22 +00002181 // This is a collection of DBV_VALUE instructions describing same variable.
2182 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patelee432862010-05-20 19:57:06 +00002183 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2184 E = DbgValues.end(); I != E; ++I) {
2185 const MachineInstr *MInsn = *I;
Devang Patelc3f5f782010-05-25 23:40:22 +00002186 MultipleValues.clear();
2187 if (isDbgValueInDefinedReg(MInsn))
2188 MultipleValues.push_back(MInsn);
Devang Patelee432862010-05-20 19:57:06 +00002189 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2190 if (Processed.count(DV) != 0)
2191 continue;
2192
Devang Patel354eb7e2010-06-02 19:05:13 +00002193 const MachineInstr *PrevMI = MInsn;
Devang Patelc3f5f782010-05-25 23:40:22 +00002194 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
2195 ME = DbgValues.end(); MI != ME; ++MI) {
2196 const MDNode *Var =
2197 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
Devang Patel354eb7e2010-06-02 19:05:13 +00002198 if (Var == DV && isDbgValueInDefinedReg(*MI) &&
2199 !PrevMI->isIdenticalTo(*MI))
Devang Patelc3f5f782010-05-25 23:40:22 +00002200 MultipleValues.push_back(*MI);
Devang Patel354eb7e2010-06-02 19:05:13 +00002201 PrevMI = *MI;
Devang Patelc3f5f782010-05-25 23:40:22 +00002202 }
2203
Devang Patelee432862010-05-20 19:57:06 +00002204 DbgScope *Scope = findDbgScope(MInsn);
Devang Pateld8720f42010-05-27 20:25:04 +00002205 bool CurFnArg = false;
2206 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2207 DISubprogram(DV.getContext()).describes(MF->getFunction()))
2208 CurFnArg = true;
2209 if (!Scope && CurFnArg)
Devang Patelc0c5a262010-05-21 00:10:20 +00002210 Scope = CurrentFnDbgScope;
Devang Patelee432862010-05-20 19:57:06 +00002211 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00002212 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00002213 continue;
2214
2215 Processed.insert(DV);
Devang Patelee432862010-05-20 19:57:06 +00002216 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patelee432862010-05-20 19:57:06 +00002217 Scope->addVariable(RegVar);
Devang Pateld8720f42010-05-27 20:25:04 +00002218 if (!CurFnArg)
Devang Patelc3f5f782010-05-25 23:40:22 +00002219 DbgVariableLabelsMap[RegVar] = getLabelBeforeInsn(MInsn);
Devang Patelc0c5a262010-05-21 00:10:20 +00002220 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2221 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2222 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patel90a48ad2010-03-15 18:33:46 +00002223 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002224 if (MultipleValues.size() <= 1) {
2225 DbgVariableToDbgInstMap[RegVar] = MInsn;
2226 continue;
2227 }
2228
2229 // handle multiple DBG_VALUE instructions describing one variable.
Devang Patelc3f5f782010-05-25 23:40:22 +00002230 if (DotDebugLocEntries.empty())
Devang Patel80250682010-05-26 23:55:23 +00002231 RegVar->setDotDebugLocOffset(0);
2232 else
2233 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Devang Patele2df8422010-05-26 17:29:32 +00002234 const MachineInstr *Begin = NULL;
2235 const MachineInstr *End = NULL;
2236 for (SmallVector<const MachineInstr *, 4>::iterator
2237 MVI = MultipleValues.begin(), MVE = MultipleValues.end(); MVI != MVE; ++MVI) {
2238 if (!Begin) {
2239 Begin = *MVI;
2240 continue;
2241 }
2242 End = *MVI;
Devang Patelc3f5f782010-05-25 23:40:22 +00002243 MachineLocation MLoc;
Devang Patele2df8422010-05-26 17:29:32 +00002244 MLoc.set(Begin->getOperand(0).getReg(), 0);
2245 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2246 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patelc3f5f782010-05-25 23:40:22 +00002247 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
Devang Patele2df8422010-05-26 17:29:32 +00002248 Begin = End;
2249 if (MVI + 1 == MVE) {
2250 // If End is the last instruction then its value is valid
Devang Patelc3f5f782010-05-25 23:40:22 +00002251 // until the end of the funtion.
Devang Patele2df8422010-05-26 17:29:32 +00002252 MLoc.set(End->getOperand(0).getReg(), 0);
Devang Patelc3f5f782010-05-25 23:40:22 +00002253 DotDebugLocEntries.
2254 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, MLoc));
2255 }
2256 }
2257 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00002258 }
Devang Patel98e1cac2010-05-14 21:01:35 +00002259
2260 // Collect info for variables that were optimized out.
Devang Pateld1bbc6b2010-06-22 01:01:58 +00002261 const Function *F = MF->getFunction();
2262 const Module *M = F->getParent();
2263 if (NamedMDNode *NMD =
Devang Patela762b092010-06-22 01:19:38 +00002264 M->getNamedMetadata(Twine("llvm.dbg.lv.",
2265 getRealLinkageName(F->getName())))) {
Devang Patel98e1cac2010-05-14 21:01:35 +00002266 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2267 DIVariable DV(cast_or_null<MDNode>(NMD->getOperand(i)));
Devang Patelee432862010-05-20 19:57:06 +00002268 if (!DV || !Processed.insert(DV))
Devang Patel98e1cac2010-05-14 21:01:35 +00002269 continue;
2270 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2271 if (Scope)
Devang Patel26c1e562010-05-20 16:36:41 +00002272 Scope->addVariable(new DbgVariable(DV));
Devang Patel98e1cac2010-05-14 21:01:35 +00002273 }
2274 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002275}
Devang Patel98e1cac2010-05-14 21:01:35 +00002276
Devang Patelc3f5f782010-05-25 23:40:22 +00002277/// getLabelBeforeInsn - Return Label preceding the instruction.
2278const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2279 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2280 LabelsBeforeInsn.find(MI);
2281 if (I == LabelsBeforeInsn.end())
2282 // FunctionBeginSym always preceeds all the instruction in current function.
2283 return FunctionBeginSym;
2284 return I->second;
2285}
2286
2287/// getLabelAfterInsn - Return Label immediately following the instruction.
2288const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2289 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2290 LabelsAfterInsn.find(MI);
2291 if (I == LabelsAfterInsn.end())
2292 return NULL;
2293 return I->second;
Devang Patele717faa2009-10-06 01:26:37 +00002294}
2295
Devang Patel553881b2010-03-29 17:20:31 +00002296/// beginScope - Process beginning of a scope.
2297void DwarfDebug::beginScope(const MachineInstr *MI) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002298 if (InsnNeedsLabel.count(MI) == 0) {
2299 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patel553881b2010-03-29 17:20:31 +00002300 return;
Devang Patelc3f5f782010-05-25 23:40:22 +00002301 }
Devang Patelaead63c2010-03-29 22:59:58 +00002302
Devang Patelb2b31a62010-05-26 19:37:24 +00002303 // Check location.
2304 DebugLoc DL = MI->getDebugLoc();
2305 if (!DL.isUnknown()) {
2306 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2307 PrevLabel = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
Devang Pateleac9c072010-04-27 19:46:33 +00002308 PrevInstLoc = DL;
Devang Patelb2b31a62010-05-26 19:37:24 +00002309 LabelsBeforeInsn[MI] = PrevLabel;
2310 return;
Devang Pateleac9c072010-04-27 19:46:33 +00002311 }
Devang Patel553881b2010-03-29 17:20:31 +00002312
Devang Patel77051f52010-05-26 21:23:46 +00002313 // If location is unknown then use temp label for this DBG_VALUE
Devang Patelb2b31a62010-05-26 19:37:24 +00002314 // instruction.
2315 if (MI->isDebugValue()) {
Devang Patel77051f52010-05-26 21:23:46 +00002316 PrevLabel = MMI->getContext().CreateTempSymbol();
2317 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00002318 LabelsBeforeInsn[MI] = PrevLabel;
2319 return;
2320 }
2321
2322 if (UnknownLocations) {
2323 PrevLabel = recordSourceLine(0, 0, 0);
2324 LabelsBeforeInsn[MI] = PrevLabel;
2325 return;
2326 }
2327
2328 assert (0 && "Instruction is not processed!");
Devang Patel0d20ac82009-10-06 01:50:42 +00002329}
2330
Devang Patel2c4ceb12009-11-21 02:48:08 +00002331/// endScope - Process end of a scope.
2332void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel1c246352010-04-08 16:50:29 +00002333 if (InsnsEndScopeSet.count(MI) != 0) {
2334 // Emit a label if this instruction ends a scope.
2335 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2336 Asm->OutStreamer.EmitLabel(Label);
Devang Pateleac9c072010-04-27 19:46:33 +00002337 LabelsAfterInsn[MI] = Label;
Devang Patel1c246352010-04-08 16:50:29 +00002338 }
Devang Patel53bb5c92009-11-10 23:06:00 +00002339}
2340
Devang Pateleac9c072010-04-27 19:46:33 +00002341/// getOrCreateDbgScope - Create DbgScope for the scope.
Devang Patele9f8f5e2010-05-07 20:54:48 +00002342DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope, const MDNode *InlinedAt) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002343 if (!InlinedAt) {
2344 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2345 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002346 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002347 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2348 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Pateleac9c072010-04-27 19:46:33 +00002349 if (DIDescriptor(Scope).isLexicalBlock()) {
2350 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002351 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Pateleac9c072010-04-27 19:46:33 +00002352 WScope->setParent(Parent);
2353 Parent->addScope(WScope);
2354 }
2355
2356 if (!WScope->getParent()) {
2357 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastingscad22ad2010-06-15 23:06:30 +00002358 // We used to check only for a linkage name, but that fails
2359 // since we began omitting the linkage name for private
2360 // functions. The new way is to check for the name in metadata,
2361 // but that's not supported in old .ll test cases. Ergo, we
2362 // check both.
Stuart Hastings215aa152010-06-11 20:08:44 +00002363 if (SPName == Asm->MF->getFunction()->getName() ||
2364 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Pateleac9c072010-04-27 19:46:33 +00002365 CurrentFnDbgScope = WScope;
2366 }
2367
2368 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002369 }
2370
Devang Patel78e127d2010-06-25 22:07:34 +00002371 getOrCreateAbstractScope(Scope);
Devang Patel53bb5c92009-11-10 23:06:00 +00002372 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2373 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002374 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002375
2376 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2377 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2378 DILocation DL(InlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002379 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002380 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Pateleac9c072010-04-27 19:46:33 +00002381 WScope->setParent(Parent);
2382 Parent->addScope(WScope);
2383
2384 ConcreteScopes[InlinedAt] = WScope;
Devang Pateleac9c072010-04-27 19:46:33 +00002385
2386 return WScope;
Devang Patel0d20ac82009-10-06 01:50:42 +00002387}
2388
Devang Pateleac9c072010-04-27 19:46:33 +00002389/// hasValidLocation - Return true if debug location entry attached with
2390/// machine instruction encodes valid location info.
2391static bool hasValidLocation(LLVMContext &Ctx,
2392 const MachineInstr *MInsn,
Devang Patele9f8f5e2010-05-07 20:54:48 +00002393 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Pateleac9c072010-04-27 19:46:33 +00002394 DebugLoc DL = MInsn->getDebugLoc();
2395 if (DL.isUnknown()) return false;
2396
Devang Patele9f8f5e2010-05-07 20:54:48 +00002397 const MDNode *S = DL.getScope(Ctx);
Devang Pateleac9c072010-04-27 19:46:33 +00002398
2399 // There is no need to create another DIE for compile unit. For all
2400 // other scopes, create one DbgScope now. This will be translated
2401 // into a scope DIE at the end.
2402 if (DIScope(S).isCompileUnit()) return false;
2403
2404 Scope = S;
2405 InlinedAt = DL.getInlinedAt(Ctx);
2406 return true;
2407}
2408
2409/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2410/// hierarchy.
2411static void calculateDominanceGraph(DbgScope *Scope) {
2412 assert (Scope && "Unable to calculate scop edominance graph!");
2413 SmallVector<DbgScope *, 4> WorkStack;
2414 WorkStack.push_back(Scope);
2415 unsigned Counter = 0;
2416 while (!WorkStack.empty()) {
2417 DbgScope *WS = WorkStack.back();
2418 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2419 bool visitedChildren = false;
2420 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2421 SE = Children.end(); SI != SE; ++SI) {
2422 DbgScope *ChildScope = *SI;
2423 if (!ChildScope->getDFSOut()) {
2424 WorkStack.push_back(ChildScope);
2425 visitedChildren = true;
2426 ChildScope->setDFSIn(++Counter);
2427 break;
2428 }
2429 }
2430 if (!visitedChildren) {
2431 WorkStack.pop_back();
2432 WS->setDFSOut(++Counter);
2433 }
2434 }
2435}
2436
2437/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
2438static
2439void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2440 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2441{
2442#ifndef NDEBUG
2443 unsigned PrevDFSIn = 0;
2444 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2445 I != E; ++I) {
2446 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2447 II != IE; ++II) {
2448 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002449 const MDNode *Scope = NULL;
2450 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002451
2452 // Check if instruction has valid location information.
2453 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2454 dbgs() << " [ ";
2455 if (InlinedAt)
2456 dbgs() << "*";
2457 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
2458 MI2ScopeMap.find(MInsn);
2459 if (DI != MI2ScopeMap.end()) {
2460 DbgScope *S = DI->second;
2461 dbgs() << S->getDFSIn();
2462 PrevDFSIn = S->getDFSIn();
2463 } else
2464 dbgs() << PrevDFSIn;
2465 } else
2466 dbgs() << " [ x" << PrevDFSIn;
2467 dbgs() << " ]";
2468 MInsn->dump();
2469 }
2470 dbgs() << "\n";
2471 }
2472#endif
2473}
Devang Patel2c4ceb12009-11-21 02:48:08 +00002474/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner14d750d2010-03-31 05:39:57 +00002475/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattnereec791a2010-01-26 23:18:02 +00002476bool DwarfDebug::extractScopeInformation() {
Devang Patelaf9e8472009-10-01 20:31:14 +00002477 // If scope information was extracted using .dbg intrinsics then there is not
2478 // any need to extract these information by scanning each instruction.
2479 if (!DbgScopeMap.empty())
2480 return false;
2481
Dan Gohman314bf7c2010-04-23 01:18:53 +00002482 // Scan each instruction and create scopes. First build working set of scopes.
Devang Pateleac9c072010-04-27 19:46:33 +00002483 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2484 SmallVector<DbgRange, 4> MIRanges;
2485 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002486 const MDNode *PrevScope = NULL;
2487 const MDNode *PrevInlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002488 const MachineInstr *RangeBeginMI = NULL;
2489 const MachineInstr *PrevMI = NULL;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002490 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelaf9e8472009-10-01 20:31:14 +00002491 I != E; ++I) {
2492 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2493 II != IE; ++II) {
2494 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002495 const MDNode *Scope = NULL;
2496 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002497
2498 // Check if instruction has valid location information.
2499 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2500 PrevMI = MInsn;
2501 continue;
2502 }
Chris Lattnerde4845c2010-04-02 19:42:39 +00002503
Devang Pateleac9c072010-04-27 19:46:33 +00002504 // If scope has not changed then skip this instruction.
2505 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2506 PrevMI = MInsn;
2507 continue;
2508 }
2509
2510 if (RangeBeginMI) {
2511 // If we have alread seen a beginning of a instruction range and
2512 // current instruction scope does not match scope of first instruction
2513 // in this range then create a new instruction range.
2514 DbgRange R(RangeBeginMI, PrevMI);
2515 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
2516 MIRanges.push_back(R);
2517 }
2518
2519 // This is a beginning of a new instruction range.
2520 RangeBeginMI = MInsn;
Chris Lattnerde4845c2010-04-02 19:42:39 +00002521
Devang Pateleac9c072010-04-27 19:46:33 +00002522 // Reset previous markers.
2523 PrevMI = MInsn;
2524 PrevScope = Scope;
2525 PrevInlinedAt = InlinedAt;
Devang Patel53bb5c92009-11-10 23:06:00 +00002526 }
2527 }
2528
Devang Pateleac9c072010-04-27 19:46:33 +00002529 // Create last instruction range.
2530 if (RangeBeginMI && PrevMI && PrevScope) {
2531 DbgRange R(RangeBeginMI, PrevMI);
2532 MIRanges.push_back(R);
2533 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patelaf9e8472009-10-01 20:31:14 +00002534 }
Devang Pateleac9c072010-04-27 19:46:33 +00002535
Devang Patel344130e2010-01-04 20:44:00 +00002536 if (!CurrentFnDbgScope)
2537 return false;
2538
Devang Pateleac9c072010-04-27 19:46:33 +00002539 calculateDominanceGraph(CurrentFnDbgScope);
2540 if (PrintDbgScope)
2541 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2542
2543 // Find ranges of instructions covered by each DbgScope;
2544 DbgScope *PrevDbgScope = NULL;
2545 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2546 RE = MIRanges.end(); RI != RE; ++RI) {
2547 const DbgRange &R = *RI;
2548 DbgScope *S = MI2ScopeMap.lookup(R.first);
2549 assert (S && "Lost DbgScope for a machine instruction!");
2550 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2551 PrevDbgScope->closeInsnRange(S);
2552 S->openInsnRange(R.first);
2553 S->extendInsnRange(R.second);
2554 PrevDbgScope = S;
2555 }
2556
2557 if (PrevDbgScope)
2558 PrevDbgScope->closeInsnRange();
Devang Patelaf9e8472009-10-01 20:31:14 +00002559
Devang Patele37b0c62010-04-08 18:43:56 +00002560 identifyScopeMarkers();
Devang Patel6122a4d2010-04-08 15:37:09 +00002561
2562 return !DbgScopeMap.empty();
2563}
2564
Devang Pateleac9c072010-04-27 19:46:33 +00002565/// identifyScopeMarkers() -
2566/// Each DbgScope has first instruction and last instruction to mark beginning
2567/// and end of a scope respectively. Create an inverse map that list scopes
2568/// starts (and ends) with an instruction. One instruction may start (or end)
2569/// multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00002570void DwarfDebug::identifyScopeMarkers() {
Devang Patel42aafd72010-01-20 02:05:23 +00002571 SmallVector<DbgScope *, 4> WorkList;
2572 WorkList.push_back(CurrentFnDbgScope);
2573 while (!WorkList.empty()) {
Chris Lattner14d750d2010-03-31 05:39:57 +00002574 DbgScope *S = WorkList.pop_back_val();
Devang Pateleac9c072010-04-27 19:46:33 +00002575
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002576 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Devang Patel42aafd72010-01-20 02:05:23 +00002577 if (!Children.empty())
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002578 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00002579 SE = Children.end(); SI != SE; ++SI)
2580 WorkList.push_back(*SI);
2581
Devang Patel53bb5c92009-11-10 23:06:00 +00002582 if (S->isAbstractScope())
2583 continue;
Devang Pateleac9c072010-04-27 19:46:33 +00002584
2585 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2586 if (Ranges.empty())
2587 continue;
2588 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2589 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel461a6462010-05-19 21:58:28 +00002590 assert(RI->first && "DbgRange does not have first instruction!");
2591 assert(RI->second && "DbgRange does not have second instruction!");
2592 InsnsBeginScopeSet.insert(RI->first);
Devang Pateleac9c072010-04-27 19:46:33 +00002593 InsnsEndScopeSet.insert(RI->second);
2594 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002595 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002596}
2597
Dan Gohman084751c2010-04-20 00:37:27 +00002598/// FindFirstDebugLoc - Find the first debug location in the function. This
2599/// is intended to be an approximation for the source position of the
2600/// beginning of the function.
2601static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2602 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2603 I != E; ++I)
2604 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2605 MBBI != MBBE; ++MBBI) {
2606 DebugLoc DL = MBBI->getDebugLoc();
2607 if (!DL.isUnknown())
2608 return DL;
2609 }
2610 return DebugLoc();
2611}
2612
Devang Patel2c4ceb12009-11-21 02:48:08 +00002613/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002614/// emitted immediately after the function entry point.
Chris Lattnereec791a2010-01-26 23:18:02 +00002615void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00002616 if (!MMI->hasDebugInfo()) return;
Bill Wendling5f017e82010-04-07 09:28:04 +00002617 if (!extractScopeInformation()) return;
Devang Patel60b35bd2009-10-06 18:37:31 +00002618
Devang Pateleac9c072010-04-27 19:46:33 +00002619 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2620 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002621 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00002622 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002623
2624 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2625 // function.
Dan Gohman084751c2010-04-20 00:37:27 +00002626 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002627 if (FDL.isUnknown()) return;
2628
Devang Patele9f8f5e2010-05-07 20:54:48 +00002629 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Chris Lattnerde4845c2010-04-02 19:42:39 +00002630
2631 DISubprogram SP = getDISubprogram(Scope);
2632 unsigned Line, Col;
2633 if (SP.Verify()) {
2634 Line = SP.getLineNumber();
2635 Col = 0;
2636 } else {
2637 Line = FDL.getLine();
2638 Col = FDL.getCol();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002639 }
Chris Lattnerde4845c2010-04-02 19:42:39 +00002640
2641 recordSourceLine(Line, Col, Scope);
Devang Patelb2b31a62010-05-26 19:37:24 +00002642
Devang Patelb9abe9f2010-06-02 16:42:51 +00002643 /// ProcessedArgs - Collection of arguments already processed.
2644 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2645
Devang Patelb2b31a62010-05-26 19:37:24 +00002646 DebugLoc PrevLoc;
2647 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2648 I != E; ++I)
2649 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2650 II != IE; ++II) {
2651 const MachineInstr *MI = II;
2652 DebugLoc DL = MI->getDebugLoc();
2653 if (MI->isDebugValue()) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002654 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2655 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2656 if (!DV.Verify()) continue;
Devang Patel55e97172010-05-27 16:47:30 +00002657 // If DBG_VALUE is for a local variable then it needs a label.
Devang Patelb2b31a62010-05-26 19:37:24 +00002658 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
2659 InsnNeedsLabel.insert(MI);
Devang Patel55e97172010-05-27 16:47:30 +00002660 // DBG_VALUE for inlined functions argument needs a label.
2661 else if (!DISubprogram(DV.getContext()).describes(MF->getFunction()))
2662 InsnNeedsLabel.insert(MI);
2663 // DBG_VALUE indicating argument location change needs a label.
Devang Patel486ca762010-06-24 21:51:19 +00002664 else if (isDbgValueInUndefinedReg(MI) == false && !ProcessedArgs.insert(DV))
Devang Patelb2b31a62010-05-26 19:37:24 +00002665 InsnNeedsLabel.insert(MI);
2666 } else {
2667 // If location is unknown then instruction needs a location only if
2668 // UnknownLocations flag is set.
2669 if (DL.isUnknown()) {
2670 if (UnknownLocations && !PrevLoc.isUnknown())
2671 InsnNeedsLabel.insert(MI);
2672 } else if (DL != PrevLoc)
2673 // Otherwise, instruction needs a location only if it is new location.
2674 InsnNeedsLabel.insert(MI);
2675 }
2676
2677 if (!DL.isUnknown() || UnknownLocations)
2678 PrevLoc = DL;
2679 }
2680
2681 PrevLabel = FunctionBeginSym;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002682}
2683
Devang Patel2c4ceb12009-11-21 02:48:08 +00002684/// endFunction - Gather and emit post-function debug information.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002685///
Chris Lattnereec791a2010-01-26 23:18:02 +00002686void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendling5f017e82010-04-07 09:28:04 +00002687 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00002688
Devang Patel344130e2010-01-04 20:44:00 +00002689 if (CurrentFnDbgScope) {
Devang Patel65eb4822010-05-22 00:04:14 +00002690
Devang Patelc3f5f782010-05-25 23:40:22 +00002691 // Define end label for subprogram.
2692 FunctionEndSym = Asm->GetTempSymbol("func_end",
2693 Asm->getFunctionNumber());
2694 // Assumes in correct section after the entry point.
2695 Asm->OutStreamer.EmitLabel(FunctionEndSym);
2696
Devang Patel78e127d2010-06-25 22:07:34 +00002697 SmallPtrSet<const MDNode *, 16> ProcessedVars;
2698 collectVariableInfo(MF, ProcessedVars);
Devang Patel65eb4822010-05-22 00:04:14 +00002699
Devang Patel344130e2010-01-04 20:44:00 +00002700 // Get function line info.
2701 if (!Lines.empty()) {
2702 // Get section line info.
2703 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2704 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2705 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2706 // Append the function info to section info.
2707 SectionLineInfos.insert(SectionLineInfos.end(),
2708 Lines.begin(), Lines.end());
2709 }
2710
2711 // Construct abstract scopes.
2712 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel78e127d2010-06-25 22:07:34 +00002713 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel344130e2010-01-04 20:44:00 +00002714 constructScopeDIE(*AI);
Devang Patel78e127d2010-06-25 22:07:34 +00002715 DISubprogram SP((*AI)->getScopeNode());
2716 if (SP.Verify()) {
2717 // Collect info for variables that were optimized out.
2718 StringRef FName = SP.getLinkageName();
2719 if (FName.empty())
2720 FName = SP.getName();
2721 const Module *M = MF->getFunction()->getParent();
2722 if (NamedMDNode *NMD =
2723 M->getNamedMetadata(Twine("llvm.dbg.lv.",
2724 getRealLinkageName(FName)))) {
2725 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2726 DIVariable DV(cast_or_null<MDNode>(NMD->getOperand(i)));
2727 if (!DV || !ProcessedVars.insert(DV))
2728 continue;
2729 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2730 if (Scope)
2731 Scope->addVariable(new DbgVariable(DV));
2732 }
2733 }
2734 }
2735 }
Devang Patel344130e2010-01-04 20:44:00 +00002736
Devang Patel9c488372010-05-04 06:15:30 +00002737 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Devang Patel344130e2010-01-04 20:44:00 +00002738
Devang Patel9c488372010-05-04 06:15:30 +00002739 if (!DisableFramePointerElim(*MF))
2740 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
2741 dwarf::DW_FORM_flag, 1);
2742
2743
Chris Lattnerd38fee82010-04-05 00:13:49 +00002744 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel344130e2010-01-04 20:44:00 +00002745 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002746 }
2747
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002748 // Clear debug info
Devang Patelf54b8522010-01-19 01:26:02 +00002749 CurrentFnDbgScope = NULL;
Devang Patelb2b31a62010-05-26 19:37:24 +00002750 InsnNeedsLabel.clear();
Devang Patel26c1e562010-05-20 16:36:41 +00002751 DbgVariableToFrameIndexMap.clear();
2752 VarToAbstractVarMap.clear();
2753 DbgVariableToDbgInstMap.clear();
2754 DbgVariableLabelsMap.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002755 DeleteContainerSeconds(DbgScopeMap);
Devang Patel461a6462010-05-19 21:58:28 +00002756 InsnsBeginScopeSet.clear();
Devang Patel51424712010-04-09 16:04:20 +00002757 InsnsEndScopeSet.clear();
Devang Patelf54b8522010-01-19 01:26:02 +00002758 ConcreteScopes.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002759 DeleteContainerSeconds(AbstractScopes);
Devang Patelf54b8522010-01-19 01:26:02 +00002760 AbstractScopesList.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002761 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00002762 LabelsBeforeInsn.clear();
2763 LabelsAfterInsn.clear();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002764 Lines.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00002765 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002766}
2767
Devang Patel26c1e562010-05-20 16:36:41 +00002768/// recordVariableFrameIndex - Record a variable's index.
2769void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2770 assert (V && "Invalid DbgVariable!");
2771 DbgVariableToFrameIndexMap[V] = Index;
2772}
2773
2774/// findVariableFrameIndex - Return true if frame index for the variable
2775/// is found. Update FI to hold value of the index.
2776bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
2777 assert (V && "Invalid DbgVariable!");
2778 DenseMap<const DbgVariable *, int>::iterator I =
2779 DbgVariableToFrameIndexMap.find(V);
2780 if (I == DbgVariableToFrameIndexMap.end())
2781 return false;
2782 *FI = I->second;
2783 return true;
2784}
2785
2786/// findVariableLabel - Find MCSymbol for the variable.
2787const MCSymbol *DwarfDebug::findVariableLabel(const DbgVariable *V) {
2788 DenseMap<const DbgVariable *, const MCSymbol *>::iterator I
2789 = DbgVariableLabelsMap.find(V);
2790 if (I == DbgVariableLabelsMap.end())
2791 return NULL;
2792 else return I->second;
2793}
2794
Devang Patelee432862010-05-20 19:57:06 +00002795/// findDbgScope - Find DbgScope for the debug loc attached with an
2796/// instruction.
2797DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
2798 DbgScope *Scope = NULL;
2799 LLVMContext &Ctx =
2800 MInsn->getParent()->getParent()->getFunction()->getContext();
2801 DebugLoc DL = MInsn->getDebugLoc();
2802
2803 if (DL.isUnknown())
2804 return Scope;
2805
2806 if (const MDNode *IA = DL.getInlinedAt(Ctx))
2807 Scope = ConcreteScopes.lookup(IA);
2808 if (Scope == 0)
2809 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
2810
2811 return Scope;
2812}
2813
2814
Chris Lattnerc6087842010-03-09 04:54:43 +00002815/// recordSourceLine - Register a source line with debug info. Returns the
2816/// unique label that was emitted and which provides correspondence to
2817/// the source line list.
Devang Patele9f8f5e2010-05-07 20:54:48 +00002818MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S) {
Devang Patel65dbc902009-11-25 17:36:49 +00002819 StringRef Dir;
2820 StringRef Fn;
Devang Patelf84548d2009-10-05 18:03:19 +00002821
Dan Gohman1cc0d622010-05-05 23:41:32 +00002822 unsigned Src = 1;
2823 if (S) {
2824 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00002825
Dan Gohman1cc0d622010-05-05 23:41:32 +00002826 if (Scope.isCompileUnit()) {
2827 DICompileUnit CU(S);
2828 Dir = CU.getDirectory();
2829 Fn = CU.getFilename();
2830 } else if (Scope.isSubprogram()) {
2831 DISubprogram SP(S);
2832 Dir = SP.getDirectory();
2833 Fn = SP.getFilename();
2834 } else if (Scope.isLexicalBlock()) {
2835 DILexicalBlock DB(S);
2836 Dir = DB.getDirectory();
2837 Fn = DB.getFilename();
2838 } else
2839 assert(0 && "Unexpected scope info");
2840
2841 Src = GetOrCreateSourceID(Dir, Fn);
2842 }
2843
Stuart Hastings215aa152010-06-11 20:08:44 +00002844#if 0
2845 if (!Lines.empty()) {
2846 SrcLineInfo lastSrcLineInfo = Lines.back();
2847 // Emitting sequential line records with the same line number (but
2848 // different addresses) seems to confuse GDB. Avoid this.
2849 if (lastSrcLineInfo.getLine() == Line)
2850 return NULL;
2851 }
2852#endif
2853
Chris Lattner63d78362010-03-14 08:36:50 +00002854 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattner25b68c62010-03-14 08:15:55 +00002855 Lines.push_back(SrcLineInfo(Line, Col, Src, Label));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002856
Chris Lattnerc6087842010-03-09 04:54:43 +00002857 Asm->OutStreamer.EmitLabel(Label);
2858 return Label;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002859}
2860
Bill Wendling829e67b2009-05-20 23:22:40 +00002861//===----------------------------------------------------------------------===//
2862// Emit Methods
2863//===----------------------------------------------------------------------===//
2864
Devang Patel2c4ceb12009-11-21 02:48:08 +00002865/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling94d04b82009-05-20 23:21:38 +00002866///
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002867unsigned
2868DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002869 // Get the children.
2870 const std::vector<DIE *> &Children = Die->getChildren();
2871
2872 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00002873 if (!Last && !Children.empty())
Benjamin Kramer345ef342010-03-31 19:34:01 +00002874 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling94d04b82009-05-20 23:21:38 +00002875
2876 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002877 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00002878
2879 // Get the abbreviation for this DIE.
2880 unsigned AbbrevNumber = Die->getAbbrevNumber();
2881 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2882
2883 // Set DIE offset
2884 Die->setOffset(Offset);
2885
2886 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00002887 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00002888
2889 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2890 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2891
2892 // Size the DIE attribute values.
2893 for (unsigned i = 0, N = Values.size(); i < N; ++i)
2894 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00002895 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00002896
2897 // Size the DIE children if any.
2898 if (!Children.empty()) {
2899 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
2900 "Children flag not set");
2901
2902 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002903 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling94d04b82009-05-20 23:21:38 +00002904
2905 // End of children marker.
2906 Offset += sizeof(int8_t);
2907 }
2908
2909 Die->setSize(Offset - Die->getOffset());
2910 return Offset;
2911}
2912
Devang Patel2c4ceb12009-11-21 02:48:08 +00002913/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling94d04b82009-05-20 23:21:38 +00002914///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002915void DwarfDebug::computeSizeAndOffsets() {
Devang Patel163a9f72010-05-10 22:49:55 +00002916 unsigned PrevOffset = 0;
2917 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2918 E = CUMap.end(); I != E; ++I) {
2919 // Compute size of compile unit header.
2920 static unsigned Offset = PrevOffset +
2921 sizeof(int32_t) + // Length of Compilation Unit Info
2922 sizeof(int16_t) + // DWARF version number
2923 sizeof(int32_t) + // Offset Into Abbrev. Section
2924 sizeof(int8_t); // Pointer Size (in bytes)
2925 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
2926 PrevOffset = Offset;
2927 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002928}
2929
Chris Lattner11b8f302010-04-04 23:02:02 +00002930/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
2931/// temporary label to it if SymbolStem is specified.
Chris Lattner9c69e285532010-04-04 22:59:04 +00002932static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner11b8f302010-04-04 23:02:02 +00002933 const char *SymbolStem = 0) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00002934 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner11b8f302010-04-04 23:02:02 +00002935 if (!SymbolStem) return 0;
2936
Chris Lattner9c69e285532010-04-04 22:59:04 +00002937 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
2938 Asm->OutStreamer.EmitLabel(TmpSym);
2939 return TmpSym;
2940}
2941
2942/// EmitSectionLabels - Emit initial Dwarf sections with a label at
2943/// the start of each one.
Chris Lattnerfa070b02010-04-04 22:33:59 +00002944void DwarfDebug::EmitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002945 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002946
Bill Wendling94d04b82009-05-20 23:21:38 +00002947 // Dwarf sections base addresses.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002948 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00002949 DwarfFrameSectionSym =
2950 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
2951 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002952
Chris Lattner9c69e285532010-04-04 22:59:04 +00002953 DwarfInfoSectionSym =
2954 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
2955 DwarfAbbrevSectionSym =
2956 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner11b8f302010-04-04 23:02:02 +00002957 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Chris Lattner9c69e285532010-04-04 22:59:04 +00002958
2959 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner11b8f302010-04-04 23:02:02 +00002960 EmitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002961
Chris Lattner11b8f302010-04-04 23:02:02 +00002962 EmitSectionSym(Asm, TLOF.getDwarfLineSection());
2963 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
2964 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2965 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Chris Lattner9c69e285532010-04-04 22:59:04 +00002966 DwarfStrSectionSym =
2967 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patelf2548ca2010-04-16 23:33:45 +00002968 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
2969 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00002970
Devang Patelc3f5f782010-05-25 23:40:22 +00002971 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
2972 "section_debug_loc");
2973
Chris Lattner9c69e285532010-04-04 22:59:04 +00002974 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattner4ad1efe2010-04-04 23:10:38 +00002975 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002976}
2977
Devang Patel2c4ceb12009-11-21 02:48:08 +00002978/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling94d04b82009-05-20 23:21:38 +00002979///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002980void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002981 // Get the abbreviation for this DIE.
2982 unsigned AbbrevNumber = Die->getAbbrevNumber();
2983 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2984
Bill Wendling94d04b82009-05-20 23:21:38 +00002985 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00002986 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00002987 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2988 Twine::utohexstr(Die->getOffset()) + ":0x" +
2989 Twine::utohexstr(Die->getSize()) + " " +
2990 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002991 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00002992
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00002993 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling94d04b82009-05-20 23:21:38 +00002994 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2995
2996 // Emit the DIE attribute values.
2997 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2998 unsigned Attr = AbbrevData[i].getAttribute();
2999 unsigned Form = AbbrevData[i].getForm();
3000 assert(Form && "Too many attributes for DIE (check abbreviation)");
3001
Chris Lattner3f53c832010-04-04 18:52:31 +00003002 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00003003 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
3004
Bill Wendling94d04b82009-05-20 23:21:38 +00003005 switch (Attr) {
3006 case dwarf::DW_AT_sibling:
Devang Patel2c4ceb12009-11-21 02:48:08 +00003007 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003008 break;
3009 case dwarf::DW_AT_abstract_origin: {
3010 DIEEntry *E = cast<DIEEntry>(Values[i]);
3011 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00003012 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00003013 Asm->EmitInt32(Addr);
3014 break;
3015 }
Devang Patelf2548ca2010-04-16 23:33:45 +00003016 case dwarf::DW_AT_ranges: {
3017 // DW_AT_range Value encodes offset in debug_range section.
3018 DIEInteger *V = cast<DIEInteger>(Values[i]);
3019 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3020 V->getValue(),
3021 DwarfDebugRangeSectionSym,
3022 4);
3023 break;
3024 }
Devang Patelc3f5f782010-05-25 23:40:22 +00003025 case dwarf::DW_AT_location: {
3026 if (UseDotDebugLocEntry.count(Die) != 0) {
3027 DIELabel *L = cast<DIELabel>(Values[i]);
3028 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
3029 } else
3030 Values[i]->EmitValue(Asm, Form);
3031 break;
3032 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003033 default:
3034 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003035 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00003036 break;
3037 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003038 }
3039
3040 // Emit the DIE children if any.
3041 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3042 const std::vector<DIE *> &Children = Die->getChildren();
3043
3044 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00003045 emitDIE(Children[j]);
Bill Wendling94d04b82009-05-20 23:21:38 +00003046
Chris Lattner3f53c832010-04-04 18:52:31 +00003047 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00003048 Asm->OutStreamer.AddComment("End Of Children Mark");
3049 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003050 }
3051}
3052
Devang Patel8a241142009-12-09 18:24:21 +00003053/// emitDebugInfo - Emit the debug info section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003054///
Devang Patel8a241142009-12-09 18:24:21 +00003055void DwarfDebug::emitDebugInfo() {
3056 // Start debug info section.
3057 Asm->OutStreamer.SwitchSection(
3058 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel163a9f72010-05-10 22:49:55 +00003059 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3060 E = CUMap.end(); I != E; ++I) {
3061 CompileUnit *TheCU = I->second;
3062 DIE *Die = TheCU->getCUDie();
3063
3064 // Emit the compile units header.
3065 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3066 TheCU->getID()));
3067
3068 // Emit size of content not including length itself
3069 unsigned ContentSize = Die->getSize() +
3070 sizeof(int16_t) + // DWARF version number
3071 sizeof(int32_t) + // Offset Into Abbrev. Section
3072 sizeof(int8_t) + // Pointer Size (in bytes)
3073 sizeof(int32_t); // FIXME - extra pad for gdb bug.
3074
3075 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3076 Asm->EmitInt32(ContentSize);
3077 Asm->OutStreamer.AddComment("DWARF version number");
3078 Asm->EmitInt16(dwarf::DWARF_VERSION);
3079 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3080 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3081 DwarfAbbrevSectionSym);
3082 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3083 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
3084
3085 emitDIE(Die);
3086 // FIXME - extra padding for gdb bug.
3087 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3088 Asm->EmitInt8(0);
3089 Asm->EmitInt8(0);
3090 Asm->EmitInt8(0);
3091 Asm->EmitInt8(0);
3092 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3093 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003094}
3095
Devang Patel2c4ceb12009-11-21 02:48:08 +00003096/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003097///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003098void DwarfDebug::emitAbbreviations() const {
Bill Wendling94d04b82009-05-20 23:21:38 +00003099 // Check to see if it is worth the effort.
3100 if (!Abbreviations.empty()) {
3101 // Start the debug abbrev section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003102 Asm->OutStreamer.SwitchSection(
3103 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003104
Chris Lattnerc0215722010-04-04 19:25:43 +00003105 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003106
3107 // For each abbrevation.
3108 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3109 // Get abbreviation data
3110 const DIEAbbrev *Abbrev = Abbreviations[i];
3111
3112 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003113 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00003114
3115 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003116 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00003117 }
3118
3119 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003120 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00003121
Chris Lattnerc0215722010-04-04 19:25:43 +00003122 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003123 }
3124}
3125
Devang Patel2c4ceb12009-11-21 02:48:08 +00003126/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling94d04b82009-05-20 23:21:38 +00003127/// the line matrix.
3128///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003129void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003130 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00003131 Asm->OutStreamer.AddComment("Extended Op");
3132 Asm->EmitInt8(0);
3133
3134 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003135 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003136 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3137 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3138
3139 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00003140
Chris Lattnerc0215722010-04-04 19:25:43 +00003141 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003142 Asm->getTargetData().getPointerSize(),
3143 0/*AddrSpace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003144
3145 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00003146 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3147 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00003148 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00003149 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003150}
3151
Devang Patel2c4ceb12009-11-21 02:48:08 +00003152/// emitDebugLines - Emit source line information.
Bill Wendling94d04b82009-05-20 23:21:38 +00003153///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003154void DwarfDebug::emitDebugLines() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003155 // If the target is using .loc/.file, the assembler will be emitting the
3156 // .debug_line table automatically.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003157 if (Asm->MAI->hasDotLocAndDotFile())
Bill Wendling94d04b82009-05-20 23:21:38 +00003158 return;
3159
3160 // Minimum line delta, thus ranging from -10..(255-10).
3161 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
3162 // Maximum line delta, thus ranging from -10..(255-10).
3163 const int MaxLineDelta = 255 + MinLineDelta;
3164
3165 // Start the dwarf line section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003166 Asm->OutStreamer.SwitchSection(
3167 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003168
3169 // Construct the section header.
Chris Lattner233f52b2010-03-09 23:52:58 +00003170 Asm->OutStreamer.AddComment("Length of Source Line Info");
Chris Lattnera6437182010-04-04 19:58:12 +00003171 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_end"),
3172 Asm->GetTempSymbol("line_begin"), 4);
Chris Lattnerc0215722010-04-04 19:25:43 +00003173 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003174
Chris Lattner233f52b2010-03-09 23:52:58 +00003175 Asm->OutStreamer.AddComment("DWARF version number");
3176 Asm->EmitInt16(dwarf::DWARF_VERSION);
Bill Wendling94d04b82009-05-20 23:21:38 +00003177
Chris Lattner233f52b2010-03-09 23:52:58 +00003178 Asm->OutStreamer.AddComment("Prolog Length");
Chris Lattnera6437182010-04-04 19:58:12 +00003179 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_prolog_end"),
3180 Asm->GetTempSymbol("line_prolog_begin"), 4);
Chris Lattnerc0215722010-04-04 19:25:43 +00003181 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003182
Chris Lattner233f52b2010-03-09 23:52:58 +00003183 Asm->OutStreamer.AddComment("Minimum Instruction Length");
3184 Asm->EmitInt8(1);
3185 Asm->OutStreamer.AddComment("Default is_stmt_start flag");
3186 Asm->EmitInt8(1);
3187 Asm->OutStreamer.AddComment("Line Base Value (Special Opcodes)");
3188 Asm->EmitInt8(MinLineDelta);
3189 Asm->OutStreamer.AddComment("Line Range Value (Special Opcodes)");
3190 Asm->EmitInt8(MaxLineDelta);
3191 Asm->OutStreamer.AddComment("Special Opcode Base");
3192 Asm->EmitInt8(-MinLineDelta);
Bill Wendling94d04b82009-05-20 23:21:38 +00003193
3194 // Line number standard opcode encodings argument count
Chris Lattner233f52b2010-03-09 23:52:58 +00003195 Asm->OutStreamer.AddComment("DW_LNS_copy arg count");
3196 Asm->EmitInt8(0);
3197 Asm->OutStreamer.AddComment("DW_LNS_advance_pc arg count");
3198 Asm->EmitInt8(1);
3199 Asm->OutStreamer.AddComment("DW_LNS_advance_line arg count");
3200 Asm->EmitInt8(1);
3201 Asm->OutStreamer.AddComment("DW_LNS_set_file arg count");
3202 Asm->EmitInt8(1);
3203 Asm->OutStreamer.AddComment("DW_LNS_set_column arg count");
3204 Asm->EmitInt8(1);
3205 Asm->OutStreamer.AddComment("DW_LNS_negate_stmt arg count");
3206 Asm->EmitInt8(0);
3207 Asm->OutStreamer.AddComment("DW_LNS_set_basic_block arg count");
3208 Asm->EmitInt8(0);
3209 Asm->OutStreamer.AddComment("DW_LNS_const_add_pc arg count");
3210 Asm->EmitInt8(0);
3211 Asm->OutStreamer.AddComment("DW_LNS_fixed_advance_pc arg count");
3212 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003213
3214 // Emit directories.
3215 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
Chris Lattner4cf202b2010-01-23 03:11:46 +00003216 const std::string &Dir = getSourceDirectoryName(DI);
Chris Lattner3f53c832010-04-04 18:52:31 +00003217 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Directory");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003218 Asm->OutStreamer.EmitBytes(StringRef(Dir.c_str(), Dir.size()+1), 0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003219 }
3220
Chris Lattner233f52b2010-03-09 23:52:58 +00003221 Asm->OutStreamer.AddComment("End of directories");
3222 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003223
3224 // Emit files.
3225 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
3226 // Remember source id starts at 1.
3227 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
Chris Lattner4cf202b2010-01-23 03:11:46 +00003228 const std::string &FN = getSourceFileName(Id.second);
Chris Lattner3f53c832010-04-04 18:52:31 +00003229 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Source");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003230 Asm->OutStreamer.EmitBytes(StringRef(FN.c_str(), FN.size()+1), 0);
3231
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003232 Asm->EmitULEB128(Id.first, "Directory #");
3233 Asm->EmitULEB128(0, "Mod date");
3234 Asm->EmitULEB128(0, "File size");
Bill Wendling94d04b82009-05-20 23:21:38 +00003235 }
3236
Chris Lattner233f52b2010-03-09 23:52:58 +00003237 Asm->OutStreamer.AddComment("End of files");
3238 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003239
Chris Lattnerc0215722010-04-04 19:25:43 +00003240 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003241
3242 // A sequence for each text section.
3243 unsigned SecSrcLinesSize = SectionSourceLines.size();
3244
3245 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
3246 // Isolate current sections line info.
3247 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
3248
Bill Wendling94d04b82009-05-20 23:21:38 +00003249 // Dwarf assumes we start with first line of first source file.
3250 unsigned Source = 1;
3251 unsigned Line = 1;
3252
3253 // Construct rows of the address, source, line, column matrix.
3254 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
3255 const SrcLineInfo &LineInfo = LineInfos[i];
Chris Lattner25b68c62010-03-14 08:15:55 +00003256 MCSymbol *Label = LineInfo.getLabel();
Chris Lattnerb9130602010-03-14 02:20:58 +00003257 if (!Label->isDefined()) continue; // Not emitted, in dead code.
Bill Wendling94d04b82009-05-20 23:21:38 +00003258
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003259 if (Asm->isVerbose()) {
Chris Lattner188a87d2010-03-10 01:04:13 +00003260 std::pair<unsigned, unsigned> SrcID =
Bill Wendling94d04b82009-05-20 23:21:38 +00003261 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner188a87d2010-03-10 01:04:13 +00003262 Asm->OutStreamer.AddComment(Twine(getSourceDirectoryName(SrcID.first)) +
Chris Lattner49f618a2010-03-10 02:29:31 +00003263 "/" +
3264 Twine(getSourceFileName(SrcID.second)) +
Chris Lattner188a87d2010-03-10 01:04:13 +00003265 ":" + Twine(LineInfo.getLine()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003266 }
3267
3268 // Define the line address.
Chris Lattner233f52b2010-03-09 23:52:58 +00003269 Asm->OutStreamer.AddComment("Extended Op");
3270 Asm->EmitInt8(0);
3271 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003272 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003273
3274 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3275 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3276
3277 Asm->OutStreamer.AddComment("Location label");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003278 Asm->OutStreamer.EmitSymbolValue(Label,
3279 Asm->getTargetData().getPointerSize(),
Chris Lattnerb9130602010-03-14 02:20:58 +00003280 0/*AddrSpace*/);
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00003281
Bill Wendling94d04b82009-05-20 23:21:38 +00003282 // If change of source, then switch to the new source.
3283 if (Source != LineInfo.getSourceID()) {
3284 Source = LineInfo.getSourceID();
Chris Lattner233f52b2010-03-09 23:52:58 +00003285 Asm->OutStreamer.AddComment("DW_LNS_set_file");
3286 Asm->EmitInt8(dwarf::DW_LNS_set_file);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003287 Asm->EmitULEB128(Source, "New Source");
Bill Wendling94d04b82009-05-20 23:21:38 +00003288 }
3289
3290 // If change of line.
3291 if (Line != LineInfo.getLine()) {
3292 // Determine offset.
3293 int Offset = LineInfo.getLine() - Line;
3294 int Delta = Offset - MinLineDelta;
3295
3296 // Update line.
3297 Line = LineInfo.getLine();
3298
3299 // If delta is small enough and in range...
3300 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
3301 // ... then use fast opcode.
Chris Lattner233f52b2010-03-09 23:52:58 +00003302 Asm->OutStreamer.AddComment("Line Delta");
3303 Asm->EmitInt8(Delta - MinLineDelta);
Bill Wendling94d04b82009-05-20 23:21:38 +00003304 } else {
3305 // ... otherwise use long hand.
Chris Lattner233f52b2010-03-09 23:52:58 +00003306 Asm->OutStreamer.AddComment("DW_LNS_advance_line");
Bill Wendling94d04b82009-05-20 23:21:38 +00003307 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003308 Asm->EmitSLEB128(Offset, "Line Offset");
Chris Lattner233f52b2010-03-09 23:52:58 +00003309 Asm->OutStreamer.AddComment("DW_LNS_copy");
3310 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling94d04b82009-05-20 23:21:38 +00003311 }
3312 } else {
3313 // Copy the previous row (different address or source)
Chris Lattner233f52b2010-03-09 23:52:58 +00003314 Asm->OutStreamer.AddComment("DW_LNS_copy");
3315 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling94d04b82009-05-20 23:21:38 +00003316 }
3317 }
3318
Devang Patel2c4ceb12009-11-21 02:48:08 +00003319 emitEndOfLineMatrix(j + 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003320 }
3321
3322 if (SecSrcLinesSize == 0)
3323 // Because we're emitting a debug_line section, we still need a line
3324 // table. The linker and friends expect it to exist. If there's nothing to
3325 // put into it, emit an empty table.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003326 emitEndOfLineMatrix(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003327
Chris Lattnerc0215722010-04-04 19:25:43 +00003328 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003329}
3330
Devang Patel2c4ceb12009-11-21 02:48:08 +00003331/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003332///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003333void DwarfDebug::emitCommonDebugFrame() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003334 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003335 return;
3336
Chris Lattnerd38fee82010-04-05 00:13:49 +00003337 int stackGrowth = Asm->getTargetData().getPointerSize();
3338 if (Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3339 TargetFrameInfo::StackGrowsDown)
3340 stackGrowth *= -1;
Bill Wendling94d04b82009-05-20 23:21:38 +00003341
3342 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003343 Asm->OutStreamer.SwitchSection(
3344 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003345
Chris Lattnerc0215722010-04-04 19:25:43 +00003346 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003347 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003348 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3349 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003350
Chris Lattnerc0215722010-04-04 19:25:43 +00003351 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003352 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling94d04b82009-05-20 23:21:38 +00003353 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner233f52b2010-03-09 23:52:58 +00003354 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling94d04b82009-05-20 23:21:38 +00003355 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner233f52b2010-03-09 23:52:58 +00003356 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003357 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003358 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3359 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner233f52b2010-03-09 23:52:58 +00003360 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003361 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling94d04b82009-05-20 23:21:38 +00003362 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling94d04b82009-05-20 23:21:38 +00003363
3364 std::vector<MachineMove> Moves;
3365 RI->getInitialFrameState(Moves);
3366
Chris Lattner02b86b92010-04-04 23:41:46 +00003367 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003368
Chris Lattner059ea132010-04-28 01:05:45 +00003369 Asm->EmitAlignment(2);
Chris Lattnerc0215722010-04-04 19:25:43 +00003370 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003371}
3372
Devang Patel2c4ceb12009-11-21 02:48:08 +00003373/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling94d04b82009-05-20 23:21:38 +00003374/// section.
Chris Lattner206d61e2010-03-13 07:26:18 +00003375void DwarfDebug::
3376emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003377 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003378 return;
3379
3380 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003381 Asm->OutStreamer.SwitchSection(
3382 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003383
Chris Lattner233f52b2010-03-09 23:52:58 +00003384 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner206d61e2010-03-13 07:26:18 +00003385 MCSymbol *DebugFrameBegin =
Chris Lattnerc0215722010-04-04 19:25:43 +00003386 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner206d61e2010-03-13 07:26:18 +00003387 MCSymbol *DebugFrameEnd =
Chris Lattnerc0215722010-04-04 19:25:43 +00003388 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnera6437182010-04-04 19:58:12 +00003389 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003390
Chris Lattner206d61e2010-03-13 07:26:18 +00003391 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling94d04b82009-05-20 23:21:38 +00003392
Chris Lattner233f52b2010-03-09 23:52:58 +00003393 Asm->OutStreamer.AddComment("FDE CIE offset");
Chris Lattner6189ed12010-04-04 23:25:33 +00003394 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
3395 DwarfFrameSectionSym);
Bill Wendling94d04b82009-05-20 23:21:38 +00003396
Chris Lattner233f52b2010-03-09 23:52:58 +00003397 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnerc0215722010-04-04 19:25:43 +00003398 MCSymbol *FuncBeginSym =
3399 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattnerfb658072010-03-13 07:40:56 +00003400 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattnerd38fee82010-04-05 00:13:49 +00003401 Asm->getTargetData().getPointerSize(),
3402 0/*AddrSpace*/);
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00003403
3404
Chris Lattner233f52b2010-03-09 23:52:58 +00003405 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnera6437182010-04-04 19:58:12 +00003406 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003407 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003408
Chris Lattner02b86b92010-04-04 23:41:46 +00003409 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003410
Chris Lattner059ea132010-04-28 01:05:45 +00003411 Asm->EmitAlignment(2);
Chris Lattner206d61e2010-03-13 07:26:18 +00003412 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling94d04b82009-05-20 23:21:38 +00003413}
3414
Devang Patel8a241142009-12-09 18:24:21 +00003415/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3416///
3417void DwarfDebug::emitDebugPubNames() {
Devang Patel163a9f72010-05-10 22:49:55 +00003418 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3419 E = CUMap.end(); I != E; ++I) {
3420 CompileUnit *TheCU = I->second;
3421 // Start the dwarf pubnames section.
3422 Asm->OutStreamer.SwitchSection(
3423 Asm->getObjFileLowering().getDwarfPubNamesSection());
Chris Lattner4cf202b2010-01-23 03:11:46 +00003424
Devang Patel163a9f72010-05-10 22:49:55 +00003425 Asm->OutStreamer.AddComment("Length of Public Names Info");
3426 Asm->EmitLabelDifference(
3427 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3428 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
3429
3430 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3431 TheCU->getID()));
3432
3433 Asm->OutStreamer.AddComment("DWARF Version");
3434 Asm->EmitInt16(dwarf::DWARF_VERSION);
3435
3436 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3437 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3438 DwarfInfoSectionSym);
3439
3440 Asm->OutStreamer.AddComment("Compilation Unit Length");
3441 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3442 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3443 4);
3444
3445 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3446 for (StringMap<DIE*>::const_iterator
3447 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3448 const char *Name = GI->getKeyData();
3449 DIE *Entity = GI->second;
3450
3451 Asm->OutStreamer.AddComment("DIE offset");
3452 Asm->EmitInt32(Entity->getOffset());
3453
3454 if (Asm->isVerbose())
3455 Asm->OutStreamer.AddComment("External Name");
3456 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3457 }
3458
3459 Asm->OutStreamer.AddComment("End Mark");
3460 Asm->EmitInt32(0);
3461 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3462 TheCU->getID()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003463 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003464}
3465
Devang Patel193f7202009-11-24 01:14:22 +00003466void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00003467 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3468 E = CUMap.end(); I != E; ++I) {
3469 CompileUnit *TheCU = I->second;
3470 // Start the dwarf pubnames section.
3471 Asm->OutStreamer.SwitchSection(
3472 Asm->getObjFileLowering().getDwarfPubTypesSection());
3473 Asm->OutStreamer.AddComment("Length of Public Types Info");
3474 Asm->EmitLabelDifference(
3475 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3476 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Chris Lattner4cf202b2010-01-23 03:11:46 +00003477
Devang Patel163a9f72010-05-10 22:49:55 +00003478 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3479 TheCU->getID()));
3480
3481 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3482 Asm->EmitInt16(dwarf::DWARF_VERSION);
3483
3484 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3485 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3486 DwarfInfoSectionSym);
3487
3488 Asm->OutStreamer.AddComment("Compilation Unit Length");
3489 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3490 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3491 4);
3492
3493 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3494 for (StringMap<DIE*>::const_iterator
3495 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3496 const char *Name = GI->getKeyData();
3497 DIE * Entity = GI->second;
3498
3499 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3500 Asm->EmitInt32(Entity->getOffset());
3501
3502 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3503 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3504 }
3505
3506 Asm->OutStreamer.AddComment("End Mark");
3507 Asm->EmitInt32(0);
3508 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3509 TheCU->getID()));
Devang Patel193f7202009-11-24 01:14:22 +00003510 }
Devang Patel193f7202009-11-24 01:14:22 +00003511}
3512
Devang Patel2c4ceb12009-11-21 02:48:08 +00003513/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003514///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003515void DwarfDebug::emitDebugStr() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003516 // Check to see if it is worth the effort.
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003517 if (StringPool.empty()) return;
3518
3519 // Start the dwarf str section.
3520 Asm->OutStreamer.SwitchSection(
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003521 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003522
Chris Lattnerbc733f52010-03-13 02:17:42 +00003523 // Get all of the string pool entries and put them in an array by their ID so
3524 // we can sort them.
3525 SmallVector<std::pair<unsigned,
3526 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
3527
3528 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3529 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3530 Entries.push_back(std::make_pair(I->second.second, &*I));
3531
3532 array_pod_sort(Entries.begin(), Entries.end());
3533
3534 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003535 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003536 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003537
3538 // Emit the string itself.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003539 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003540 }
3541}
3542
Devang Patel2c4ceb12009-11-21 02:48:08 +00003543/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003544///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003545void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00003546 if (DotDebugLocEntries.empty())
3547 return;
3548
Bill Wendling94d04b82009-05-20 23:21:38 +00003549 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003550 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00003551 Asm->getObjFileLowering().getDwarfLocSection());
3552 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00003553 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3554 unsigned index = 1;
Devang Patelc3f5f782010-05-25 23:40:22 +00003555 for (SmallVector<DotDebugLocEntry, 4>::iterator I = DotDebugLocEntries.begin(),
3556 E = DotDebugLocEntries.end(); I != E; ++I, ++index) {
3557 DotDebugLocEntry Entry = *I;
Devang Patelc3f5f782010-05-25 23:40:22 +00003558 if (Entry.isEmpty()) {
3559 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3560 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel80250682010-05-26 23:55:23 +00003561 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00003562 } else {
3563 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3564 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3565 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3566 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
3567 if (Reg < 32) {
3568 Asm->OutStreamer.AddComment("Loc expr size");
3569 Asm->EmitInt16(1);
3570 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3571 } else {
3572 Asm->OutStreamer.AddComment("Loc expr size");
3573 Asm->EmitInt16(1+MCAsmInfo::getULEB128Size(Reg));
3574 Asm->EmitInt8(dwarf::DW_OP_regx);
3575 Asm->EmitULEB128(Reg);
3576 }
3577 }
3578 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003579}
3580
3581/// EmitDebugARanges - Emit visible names into a debug aranges section.
3582///
3583void DwarfDebug::EmitDebugARanges() {
3584 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003585 Asm->OutStreamer.SwitchSection(
3586 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003587}
3588
Devang Patel2c4ceb12009-11-21 02:48:08 +00003589/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003590///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003591void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003592 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003593 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00003594 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Pateleac9c072010-04-27 19:46:33 +00003595 unsigned char Size = Asm->getTargetData().getPointerSize();
3596 for (SmallVector<const MCSymbol *, 8>::iterator
3597 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
3598 I != E; ++I) {
3599 if (*I)
3600 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003601 else
Devang Pateleac9c072010-04-27 19:46:33 +00003602 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003603 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003604}
3605
Devang Patel2c4ceb12009-11-21 02:48:08 +00003606/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003607///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003608void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003609 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00003610 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003611 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003612 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003613 }
3614}
3615
Devang Patel2c4ceb12009-11-21 02:48:08 +00003616/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling94d04b82009-05-20 23:21:38 +00003617/// Section Header:
3618/// 1. length of section
3619/// 2. Dwarf version number
3620/// 3. address size.
3621///
3622/// Entries (one "entry" for each function that was inlined):
3623///
3624/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3625/// otherwise offset into __debug_str for regular function name.
3626/// 2. offset into __debug_str section for regular function name.
3627/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3628/// instances for the function.
3629///
3630/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3631/// inlined instance; the die_offset points to the inlined_subroutine die in the
3632/// __debug_info section, and the low_pc is the starting address for the
3633/// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003634void DwarfDebug::emitDebugInlineInfo() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003635 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003636 return;
3637
Devang Patel163a9f72010-05-10 22:49:55 +00003638 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00003639 return;
3640
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003641 Asm->OutStreamer.SwitchSection(
3642 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00003643
Chris Lattner233f52b2010-03-09 23:52:58 +00003644 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003645 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3646 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003647
Chris Lattnerc0215722010-04-04 19:25:43 +00003648 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003649
Chris Lattner233f52b2010-03-09 23:52:58 +00003650 Asm->OutStreamer.AddComment("Dwarf Version");
3651 Asm->EmitInt16(dwarf::DWARF_VERSION);
3652 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003653 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003654
Devang Patele9f8f5e2010-05-07 20:54:48 +00003655 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00003656 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00003657
Devang Patele9f8f5e2010-05-07 20:54:48 +00003658 const MDNode *Node = *I;
3659 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach7ab38df2009-11-22 19:20:36 +00003660 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00003661 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00003662 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00003663 StringRef LName = SP.getLinkageName();
3664 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00003665
Chris Lattner233f52b2010-03-09 23:52:58 +00003666 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003667 if (LName.empty()) {
3668 Asm->OutStreamer.EmitBytes(Name, 0);
3669 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
3670 } else
Chris Lattner6189ed12010-04-04 23:25:33 +00003671 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3672 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00003673
Chris Lattner233f52b2010-03-09 23:52:58 +00003674 Asm->OutStreamer.AddComment("Function name");
Chris Lattner6189ed12010-04-04 23:25:33 +00003675 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003676 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00003677
Devang Patel53bb5c92009-11-10 23:06:00 +00003678 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00003679 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00003680 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00003681 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003682
Chris Lattner3f53c832010-04-04 18:52:31 +00003683 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003684 Asm->OutStreamer.EmitSymbolValue(LI->first,
3685 Asm->getTargetData().getPointerSize(),0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003686 }
3687 }
3688
Chris Lattnerc0215722010-04-04 19:25:43 +00003689 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003690}