blob: 897a19d91c430928a9583f1c05f48bc2463ea0f3 [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;
Torok Edwin9c421072010-04-07 10:44:46 +0000325 if (TimePassesIsEnabled) {
326 NamedRegionTimer T(DbgTimerName, DWARFGroupName);
327 beginModule(M);
328 } else {
329 beginModule(M);
330 }
Bill Wendling0310d762009-05-15 09:23:25 +0000331}
332DwarfDebug::~DwarfDebug() {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000333 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
334 DIEBlocks[j]->~DIEBlock();
Bill Wendling0310d762009-05-15 09:23:25 +0000335}
336
Chris Lattnerbc733f52010-03-13 02:17:42 +0000337MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
338 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
339 if (Entry.first) return Entry.first;
340
341 Entry.second = NextStringPoolNumber++;
Chris Lattnerc0215722010-04-04 19:25:43 +0000342 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerbc733f52010-03-13 02:17:42 +0000343}
344
345
Devang Patel2c4ceb12009-11-21 02:48:08 +0000346/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling0310d762009-05-15 09:23:25 +0000347///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000348void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling0310d762009-05-15 09:23:25 +0000349 // Profile the node so that we can make it unique.
350 FoldingSetNodeID ID;
351 Abbrev.Profile(ID);
352
353 // Check the set for priors.
354 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
355
356 // If it's newly added.
357 if (InSet == &Abbrev) {
358 // Add to abbreviation list.
359 Abbreviations.push_back(&Abbrev);
360
361 // Assign the vector position + 1 as its number.
362 Abbrev.setNumber(Abbreviations.size());
363 } else {
364 // Assign existing abbreviation number.
365 Abbrev.setNumber(InSet->getNumber());
366 }
367}
368
Devang Patel2c4ceb12009-11-21 02:48:08 +0000369/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendling995f80a2009-05-20 23:24:48 +0000370/// information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000371DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000372 DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000373 return Value;
374}
375
Devang Patel2c4ceb12009-11-21 02:48:08 +0000376/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000377///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000378void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000379 unsigned Form, uint64_t Integer) {
380 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000381 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000382 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000383}
384
Devang Patel2c4ceb12009-11-21 02:48:08 +0000385/// addSInt - Add an signed integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000386///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000387void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000388 unsigned Form, int64_t Integer) {
389 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000390 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000391 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000392}
393
Devang Patel69f57b12009-12-02 15:25:16 +0000394/// addString - Add a string attribute data and value. DIEString only
395/// keeps string reference.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000396void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattner4cf202b2010-01-23 03:11:46 +0000397 StringRef String) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000398 DIEValue *Value = new (DIEValueAllocator) DIEString(String);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000399 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000400}
401
Devang Patel2c4ceb12009-11-21 02:48:08 +0000402/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000403///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000404void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerb98b1bf2010-03-08 22:23:36 +0000405 const MCSymbol *Label) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000406 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000407 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000408}
409
Devang Patel2c4ceb12009-11-21 02:48:08 +0000410/// addDelta - Add a label delta attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000411///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000412void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerb98b1bf2010-03-08 22:23:36 +0000413 const MCSymbol *Hi, const MCSymbol *Lo) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000414 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000415 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000416}
417
Chris Lattner74e41f92010-04-05 05:24:55 +0000418/// addDIEEntry - Add a DIE attribute data and value.
419///
420void DwarfDebug::addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form,
421 DIE *Entry) {
422 Die->addValue(Attribute, Form, createDIEEntry(Entry));
423}
424
425
Devang Patel2c4ceb12009-11-21 02:48:08 +0000426/// addBlock - Add block data.
Bill Wendling0310d762009-05-15 09:23:25 +0000427///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000428void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000429 DIEBlock *Block) {
Chris Lattnera37d5382010-04-05 00:18:22 +0000430 Block->ComputeSize(Asm);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000431 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000432 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000433}
434
Devang Patel2c4ceb12009-11-21 02:48:08 +0000435/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000436/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000437void DwarfDebug::addSourceLine(DIE *Die, const DIVariable *V) {
Devang Patelc665a512010-05-07 23:33:41 +0000438 // Verify variable.
439 if (!V->Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000440 return;
441
442 unsigned Line = V->getLineNumber();
Devang Patel77bf2952010-03-08 22:02:50 +0000443 unsigned FileID = GetOrCreateSourceID(V->getContext().getDirectory(),
444 V->getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000445 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000446 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
447 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000448}
449
Devang Patel2c4ceb12009-11-21 02:48:08 +0000450/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000451/// entry.
Devang Patela49d8772010-05-07 23:19:07 +0000452void DwarfDebug::addSourceLine(DIE *Die, const DIGlobalVariable *G) {
Devang Patelc665a512010-05-07 23:33:41 +0000453 // Verify global variable.
454 if (!G->Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000455 return;
456
457 unsigned Line = G->getLineNumber();
Devang Patel77bf2952010-03-08 22:02:50 +0000458 unsigned FileID = GetOrCreateSourceID(G->getContext().getDirectory(),
459 G->getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000460 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000461 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
462 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000463}
Devang Patel82dfc0c2009-08-31 22:47:13 +0000464
Devang Patel2c4ceb12009-11-21 02:48:08 +0000465/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000466/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000467void DwarfDebug::addSourceLine(DIE *Die, const DISubprogram *SP) {
Devang Patelc665a512010-05-07 23:33:41 +0000468 // Verify subprogram.
469 if (!SP->Verify())
Devang Patel82dfc0c2009-08-31 22:47:13 +0000470 return;
Caroline Ticec6f9d622009-09-11 18:25:54 +0000471 // If the line number is 0, don't add it.
472 if (SP->getLineNumber() == 0)
473 return;
474
Devang Patel82dfc0c2009-08-31 22:47:13 +0000475 unsigned Line = SP->getLineNumber();
Devang Patel77bf2952010-03-08 22:02:50 +0000476 if (!SP->getContext().Verify())
477 return;
Devang Patel9bb59a22010-03-24 21:30:35 +0000478 unsigned FileID = GetOrCreateSourceID(SP->getDirectory(),
479 SP->getFilename());
Devang Patel82dfc0c2009-08-31 22:47:13 +0000480 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000481 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
482 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patel82dfc0c2009-08-31 22:47:13 +0000483}
484
Devang Patel2c4ceb12009-11-21 02:48:08 +0000485/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000486/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000487void DwarfDebug::addSourceLine(DIE *Die, const DIType *Ty) {
Devang Patelc665a512010-05-07 23:33:41 +0000488 // Verify type.
489 if (!Ty->Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000490 return;
491
492 unsigned Line = Ty->getLineNumber();
Devang Patel77bf2952010-03-08 22:02:50 +0000493 if (!Ty->getContext().Verify())
494 return;
495 unsigned FileID = GetOrCreateSourceID(Ty->getContext().getDirectory(),
496 Ty->getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000497 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000498 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
499 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000500}
501
Devang Patel6404e4e2009-12-15 19:16:48 +0000502/// addSourceLine - Add location information to specified debug information
503/// entry.
504void DwarfDebug::addSourceLine(DIE *Die, const DINameSpace *NS) {
Devang Patelc665a512010-05-07 23:33:41 +0000505 // Verify namespace.
506 if (!NS->Verify())
Devang Patel6404e4e2009-12-15 19:16:48 +0000507 return;
508
509 unsigned Line = NS->getLineNumber();
510 StringRef FN = NS->getFilename();
511 StringRef Dir = NS->getDirectory();
512
513 unsigned FileID = GetOrCreateSourceID(Dir, FN);
514 assert(FileID && "Invalid file id");
515 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
516 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
517}
518
Caroline Ticedc8f6042009-08-31 21:19:37 +0000519/* Byref variables, in Blocks, are declared by the programmer as
520 "SomeType VarName;", but the compiler creates a
521 __Block_byref_x_VarName struct, and gives the variable VarName
522 either the struct, or a pointer to the struct, as its type. This
523 is necessary for various behind-the-scenes things the compiler
524 needs to do with by-reference variables in blocks.
525
526 However, as far as the original *programmer* is concerned, the
527 variable should still have type 'SomeType', as originally declared.
528
529 The following function dives into the __Block_byref_x_VarName
530 struct to find the original type of the variable. This will be
531 passed back to the code generating the type for the Debug
532 Information Entry for the variable 'VarName'. 'VarName' will then
533 have the original type 'SomeType' in its debug information.
534
535 The original type 'SomeType' will be the type of the field named
536 'VarName' inside the __Block_byref_x_VarName struct.
537
538 NOTE: In order for this to not completely fail on the debugger
539 side, the Debug Information Entry for the variable VarName needs to
540 have a DW_AT_location that tells the debugger how to unwind through
541 the pointers and __Block_byref_x_VarName struct to find the actual
Devang Patel2c4ceb12009-11-21 02:48:08 +0000542 value of the variable. The function addBlockByrefType does this. */
Caroline Ticedc8f6042009-08-31 21:19:37 +0000543
544/// Find the type the programmer originally declared the variable to be
545/// and return that type.
546///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000547DIType DwarfDebug::getBlockByrefType(DIType Ty, std::string Name) {
Caroline Ticedc8f6042009-08-31 21:19:37 +0000548
549 DIType subType = Ty;
550 unsigned tag = Ty.getTag();
551
552 if (tag == dwarf::DW_TAG_pointer_type) {
Devang Patel2db49d72010-05-07 18:11:54 +0000553 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000554 subType = DTy.getTypeDerivedFrom();
555 }
556
Devang Patel2db49d72010-05-07 18:11:54 +0000557 DICompositeType blockStruct = DICompositeType(subType);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000558 DIArray Elements = blockStruct.getTypeArray();
559
Caroline Ticedc8f6042009-08-31 21:19:37 +0000560 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
561 DIDescriptor Element = Elements.getElement(i);
Devang Patel2db49d72010-05-07 18:11:54 +0000562 DIDerivedType DT = DIDerivedType(Element);
Devang Patel65dbc902009-11-25 17:36:49 +0000563 if (Name == DT.getName())
Caroline Ticedc8f6042009-08-31 21:19:37 +0000564 return (DT.getTypeDerivedFrom());
565 }
566
567 return Ty;
568}
569
Devang Patel2c4ceb12009-11-21 02:48:08 +0000570/// addComplexAddress - Start with the address based on the location provided,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000571/// and generate the DWARF information necessary to find the actual variable
572/// given the extra address information encoded in the DIVariable, starting from
573/// the starting location. Add the DWARF information to the die.
574///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000575void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000576 unsigned Attribute,
577 const MachineLocation &Location) {
578 const DIVariable &VD = DV->getVariable();
579 DIType Ty = VD.getType();
580
581 // Decode the original location, and use that as the start of the byref
582 // variable's location.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000583 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000584 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000585 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000586
587 if (Location.isReg()) {
588 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000589 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000590 } else {
591 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000592 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
593 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000594 }
595 } else {
596 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000597 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000598 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000599 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
600 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000601 }
602
Devang Patel2c4ceb12009-11-21 02:48:08 +0000603 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000604 }
605
606 for (unsigned i = 0, N = VD.getNumAddrElements(); i < N; ++i) {
607 uint64_t Element = VD.getAddrElement(i);
608
609 if (Element == DIFactory::OpPlus) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000610 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
611 addUInt(Block, 0, dwarf::DW_FORM_udata, VD.getAddrElement(++i));
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000612 } else if (Element == DIFactory::OpDeref) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000613 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000614 } else llvm_unreachable("unknown DIFactory Opcode");
615 }
616
617 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000618 addBlock(Die, Attribute, 0, Block);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000619}
620
Caroline Ticedc8f6042009-08-31 21:19:37 +0000621/* Byref variables, in Blocks, are declared by the programmer as "SomeType
622 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
623 gives the variable VarName either the struct, or a pointer to the struct, as
624 its type. This is necessary for various behind-the-scenes things the
625 compiler needs to do with by-reference variables in Blocks.
626
627 However, as far as the original *programmer* is concerned, the variable
628 should still have type 'SomeType', as originally declared.
629
Devang Patel2c4ceb12009-11-21 02:48:08 +0000630 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000631 struct to find the original type of the variable, which is then assigned to
632 the variable's Debug Information Entry as its real type. So far, so good.
633 However now the debugger will expect the variable VarName to have the type
634 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000635 expression that explains to the debugger how to navigate through the
Caroline Ticedc8f6042009-08-31 21:19:37 +0000636 pointers and struct to find the actual variable of type SomeType.
637
638 The following function does just that. We start by getting
639 the "normal" location for the variable. This will be the location
640 of either the struct __Block_byref_x_VarName or the pointer to the
641 struct __Block_byref_x_VarName.
642
643 The struct will look something like:
644
645 struct __Block_byref_x_VarName {
646 ... <various fields>
647 struct __Block_byref_x_VarName *forwarding;
648 ... <various other fields>
649 SomeType VarName;
650 ... <maybe more fields>
651 };
652
653 If we are given the struct directly (as our starting point) we
654 need to tell the debugger to:
655
656 1). Add the offset of the forwarding field.
657
Dan Gohmanf451cb82010-02-10 16:03:48 +0000658 2). Follow that pointer to get the real __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000659 struct to use (the real one may have been copied onto the heap).
660
661 3). Add the offset for the field VarName, to find the actual variable.
662
663 If we started with a pointer to the struct, then we need to
664 dereference that pointer first, before the other steps.
665 Translating this into DWARF ops, we will need to append the following
666 to the current location description for the variable:
667
668 DW_OP_deref -- optional, if we start with a pointer
669 DW_OP_plus_uconst <forward_fld_offset>
670 DW_OP_deref
671 DW_OP_plus_uconst <varName_fld_offset>
672
673 That is what this function does. */
674
Devang Patel2c4ceb12009-11-21 02:48:08 +0000675/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticedc8f6042009-08-31 21:19:37 +0000676/// provided, and generate the DWARF information necessary to find the
677/// actual Block variable (navigating the Block struct) based on the
678/// starting location. Add the DWARF information to the die. For
679/// more information, read large comment just above here.
680///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000681void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbar00564992009-09-19 20:40:14 +0000682 unsigned Attribute,
683 const MachineLocation &Location) {
Caroline Ticedc8f6042009-08-31 21:19:37 +0000684 const DIVariable &VD = DV->getVariable();
685 DIType Ty = VD.getType();
686 DIType TmpTy = Ty;
687 unsigned Tag = Ty.getTag();
688 bool isPointer = false;
689
Devang Patel65dbc902009-11-25 17:36:49 +0000690 StringRef varName = VD.getName();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000691
692 if (Tag == dwarf::DW_TAG_pointer_type) {
Devang Patel2db49d72010-05-07 18:11:54 +0000693 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000694 TmpTy = DTy.getTypeDerivedFrom();
695 isPointer = true;
696 }
697
Devang Patel2db49d72010-05-07 18:11:54 +0000698 DICompositeType blockStruct = DICompositeType(TmpTy);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000699
Daniel Dunbar00564992009-09-19 20:40:14 +0000700 // Find the __forwarding field and the variable field in the __Block_byref
701 // struct.
Daniel Dunbar00564992009-09-19 20:40:14 +0000702 DIArray Fields = blockStruct.getTypeArray();
703 DIDescriptor varField = DIDescriptor();
704 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000705
Daniel Dunbar00564992009-09-19 20:40:14 +0000706 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
707 DIDescriptor Element = Fields.getElement(i);
Devang Patel2db49d72010-05-07 18:11:54 +0000708 DIDerivedType DT = DIDerivedType(Element);
Devang Patel65dbc902009-11-25 17:36:49 +0000709 StringRef fieldName = DT.getName();
710 if (fieldName == "__forwarding")
Daniel Dunbar00564992009-09-19 20:40:14 +0000711 forwardingField = Element;
Devang Patel65dbc902009-11-25 17:36:49 +0000712 else if (fieldName == varName)
Daniel Dunbar00564992009-09-19 20:40:14 +0000713 varField = Element;
714 }
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000715
Daniel Dunbar00564992009-09-19 20:40:14 +0000716 // Get the offsets for the forwarding field and the variable field.
Chris Lattner1d65ba72010-03-31 06:06:37 +0000717 unsigned forwardingFieldOffset =
Devang Patel2db49d72010-05-07 18:11:54 +0000718 DIDerivedType(forwardingField).getOffsetInBits() >> 3;
Chris Lattner1d65ba72010-03-31 06:06:37 +0000719 unsigned varFieldOffset =
Devang Patel2db49d72010-05-07 18:11:54 +0000720 DIDerivedType(varField).getOffsetInBits() >> 3;
Caroline Ticedc8f6042009-08-31 21:19:37 +0000721
Mike Stump7e3720d2009-09-24 23:21:26 +0000722 // Decode the original location, and use that as the start of the byref
723 // variable's location.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000724 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Daniel Dunbar00564992009-09-19 20:40:14 +0000725 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000726 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000727
Daniel Dunbar00564992009-09-19 20:40:14 +0000728 if (Location.isReg()) {
729 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000730 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000731 else {
732 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000733 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
734 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000735 }
736 } else {
737 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000738 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000739 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000740 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
741 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000742 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000743
Devang Patel2c4ceb12009-11-21 02:48:08 +0000744 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbar00564992009-09-19 20:40:14 +0000745 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000746
Mike Stump7e3720d2009-09-24 23:21:26 +0000747 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbar00564992009-09-19 20:40:14 +0000748 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbar00564992009-09-19 20:40:14 +0000749 if (isPointer)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000750 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000751
Daniel Dunbar00564992009-09-19 20:40:14 +0000752 // Next add the offset for the '__forwarding' field:
753 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
754 // adding the offset if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000755 if (forwardingFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000756 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
757 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000758 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000759
Daniel Dunbar00564992009-09-19 20:40:14 +0000760 // Now dereference the __forwarding field to get to the real __Block_byref
761 // struct: DW_OP_deref.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000762 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000763
Daniel Dunbar00564992009-09-19 20:40:14 +0000764 // Now that we've got the real __Block_byref... struct, add the offset
765 // for the variable's field to get to the location of the actual variable:
766 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000767 if (varFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000768 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
769 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000770 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000771
Daniel Dunbar00564992009-09-19 20:40:14 +0000772 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000773 addBlock(Die, Attribute, 0, Block);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000774}
775
Devang Patel2c4ceb12009-11-21 02:48:08 +0000776/// addAddress - Add an address attribute to a die based on the location
Bill Wendling0310d762009-05-15 09:23:25 +0000777/// provided.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000778void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000779 const MachineLocation &Location) {
Chris Lattnerd38fee82010-04-05 00:13:49 +0000780 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling0310d762009-05-15 09:23:25 +0000781 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000782 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Bill Wendling0310d762009-05-15 09:23:25 +0000783
784 if (Location.isReg()) {
785 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000786 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000787 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000788 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
789 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000790 }
791 } else {
792 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000793 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000794 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000795 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
796 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000797 }
798
Devang Patel2c4ceb12009-11-21 02:48:08 +0000799 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling0310d762009-05-15 09:23:25 +0000800 }
801
Devang Patel2c4ceb12009-11-21 02:48:08 +0000802 addBlock(Die, Attribute, 0, Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000803}
804
Devang Patela43098d2010-04-28 01:03:09 +0000805/// addRegisterAddress - Add register location entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000806bool DwarfDebug::addRegisterAddress(DIE *Die, const MCSymbol *VS,
Devang Patela43098d2010-04-28 01:03:09 +0000807 const MachineOperand &MO) {
808 assert (MO.isReg() && "Invalid machine operand!");
809 if (!MO.getReg())
810 return false;
811 MachineLocation Location;
812 Location.set(MO.getReg());
813 addAddress(Die, dwarf::DW_AT_location, Location);
Devang Patel26c1e562010-05-20 16:36:41 +0000814 if (VS)
Devang Patela43098d2010-04-28 01:03:09 +0000815 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
816 return true;
817}
818
819/// addConstantValue - Add constant value entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000820bool DwarfDebug::addConstantValue(DIE *Die, const MCSymbol *VS,
Devang Patela43098d2010-04-28 01:03:09 +0000821 const MachineOperand &MO) {
822 assert (MO.isImm() && "Invalid machine operand!");
823 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
824 unsigned Imm = MO.getImm();
825 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
826 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patel26c1e562010-05-20 16:36:41 +0000827 if (VS)
Devang Patela43098d2010-04-28 01:03:09 +0000828 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
829 return true;
830}
831
832/// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000833bool DwarfDebug::addConstantFPValue(DIE *Die, const MCSymbol *VS,
Devang Patela43098d2010-04-28 01:03:09 +0000834 const MachineOperand &MO) {
835 assert (MO.isFPImm() && "Invalid machine operand!");
836 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
837 APFloat FPImm = MO.getFPImm()->getValueAPF();
838
839 // Get the raw data form of the floating point.
840 const APInt FltVal = FPImm.bitcastToAPInt();
841 const char *FltPtr = (const char*)FltVal.getRawData();
842
843 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
844 bool LittleEndian = Asm->getTargetData().isLittleEndian();
845 int Incr = (LittleEndian ? 1 : -1);
846 int Start = (LittleEndian ? 0 : NumBytes - 1);
847 int Stop = (LittleEndian ? NumBytes : -1);
848
849 // Output the constant to DWARF one byte at a time.
850 for (; Start != Stop; Start += Incr)
851 addUInt(Block, 0, dwarf::DW_FORM_data1,
852 (unsigned char)0xFF & FltPtr[Start]);
853
854 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patel26c1e562010-05-20 16:36:41 +0000855 if (VS)
856 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
Devang Patela43098d2010-04-28 01:03:09 +0000857 return true;
858}
859
860
Devang Patelc366f832009-12-10 19:14:49 +0000861/// addToContextOwner - Add Die into the list of its context owner's children.
862void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3c91b052010-03-08 20:52:55 +0000863 if (Context.isType()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000864 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
Devang Patelc366f832009-12-10 19:14:49 +0000865 ContextDIE->addChild(Die);
Devang Patel6404e4e2009-12-15 19:16:48 +0000866 } else if (Context.isNameSpace()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000867 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
Devang Patel6404e4e2009-12-15 19:16:48 +0000868 ContextDIE->addChild(Die);
Stuart Hastings215aa152010-06-11 20:08:44 +0000869 } else if (Context.isSubprogram()) {
870 DIE *ContextDIE = createSubprogramDIE(DISubprogram(Context),
871 /*MakeDecl=*/false);
872 ContextDIE->addChild(Die);
Devang Patel163a9f72010-05-10 22:49:55 +0000873 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patelc366f832009-12-10 19:14:49 +0000874 ContextDIE->addChild(Die);
875 else
Devang Patel163a9f72010-05-10 22:49:55 +0000876 getCompileUnit(Context)->addDie(Die);
Devang Patelc366f832009-12-10 19:14:49 +0000877}
878
Devang Patel16ced732009-12-10 18:05:33 +0000879/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
880/// given DIType.
881DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel163a9f72010-05-10 22:49:55 +0000882 CompileUnit *TypeCU = getCompileUnit(Ty);
883 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patel16ced732009-12-10 18:05:33 +0000884 if (TyDIE)
885 return TyDIE;
886
887 // Create new type.
888 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel163a9f72010-05-10 22:49:55 +0000889 TypeCU->insertDIE(Ty, TyDIE);
Devang Patel16ced732009-12-10 18:05:33 +0000890 if (Ty.isBasicType())
Devang Patel2db49d72010-05-07 18:11:54 +0000891 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000892 else if (Ty.isCompositeType())
Devang Patel2db49d72010-05-07 18:11:54 +0000893 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000894 else {
895 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patel2db49d72010-05-07 18:11:54 +0000896 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000897 }
898
Devang Patelc366f832009-12-10 19:14:49 +0000899 addToContextOwner(TyDIE, Ty.getContext());
Devang Patel16ced732009-12-10 18:05:33 +0000900 return TyDIE;
901}
902
Devang Patel2c4ceb12009-11-21 02:48:08 +0000903/// addType - Add a new type attribute to the specified entity.
Devang Patel8a241142009-12-09 18:24:21 +0000904void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel9c004872010-05-07 21:45:47 +0000905 if (!Ty.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000906 return;
907
908 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +0000909 CompileUnit *TypeCU = getCompileUnit(Ty);
910 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000911 // If it exists then use the existing value.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000912 if (Entry) {
913 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000914 return;
915 }
916
Bill Wendling0310d762009-05-15 09:23:25 +0000917 // Construct type.
Devang Patel16ced732009-12-10 18:05:33 +0000918 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000919
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000920 // Set up proxy.
921 Entry = createDIEEntry(Buffer);
Devang Patel163a9f72010-05-10 22:49:55 +0000922 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000923
Devang Patel2c4ceb12009-11-21 02:48:08 +0000924 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000925}
926
Devang Patel2c4ceb12009-11-21 02:48:08 +0000927/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel8a241142009-12-09 18:24:21 +0000928void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000929 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000930 StringRef Name = BTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000931 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000932 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling0310d762009-05-15 09:23:25 +0000933 BTy.getEncoding());
934
935 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +0000936 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000937 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000938 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000939 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000940}
941
Devang Patel2c4ceb12009-11-21 02:48:08 +0000942/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel8a241142009-12-09 18:24:21 +0000943void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000944 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000945 StringRef Name = DTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000946 uint64_t Size = DTy.getSizeInBits() >> 3;
947 unsigned Tag = DTy.getTag();
948
949 // FIXME - Workaround for templates.
950 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
951
952 Buffer.setTag(Tag);
953
954 // Map to main type, void will not have a type.
955 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel8a241142009-12-09 18:24:21 +0000956 addType(&Buffer, FromTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000957
958 // Add name if not anonymous or intermediate type.
Devang Pateldeea5642009-11-30 23:56:56 +0000959 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000960 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000961
962 // Add size if non-zero (derived types might be zero-sized.)
963 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000964 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000965
966 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patel05f6fa82009-11-23 18:43:37 +0000967 if (!DTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000968 addSourceLine(&Buffer, &DTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000969}
970
Devang Patel2c4ceb12009-11-21 02:48:08 +0000971/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +0000972void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000973 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000974 StringRef Name = CTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000975
976 uint64_t Size = CTy.getSizeInBits() >> 3;
977 unsigned Tag = CTy.getTag();
978 Buffer.setTag(Tag);
979
980 switch (Tag) {
981 case dwarf::DW_TAG_vector_type:
982 case dwarf::DW_TAG_array_type:
Devang Patel8a241142009-12-09 18:24:21 +0000983 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000984 break;
985 case dwarf::DW_TAG_enumeration_type: {
986 DIArray Elements = CTy.getTypeArray();
987
988 // Add enumerators to enumeration type.
989 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
990 DIE *ElemDie = NULL;
Devang Patel2db49d72010-05-07 18:11:54 +0000991 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3c91b052010-03-08 20:52:55 +0000992 if (Enum.isEnumerator()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000993 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel2c4ceb12009-11-21 02:48:08 +0000994 Buffer.addChild(ElemDie);
Devang Patelc5254722009-10-09 17:51:49 +0000995 }
Bill Wendling0310d762009-05-15 09:23:25 +0000996 }
997 }
998 break;
999 case dwarf::DW_TAG_subroutine_type: {
1000 // Add return type.
1001 DIArray Elements = CTy.getTypeArray();
1002 DIDescriptor RTy = Elements.getElement(0);
Devang Patel2db49d72010-05-07 18:11:54 +00001003 addType(&Buffer, DIType(RTy));
Bill Wendling0310d762009-05-15 09:23:25 +00001004
1005 // Add prototype flag.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001006 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001007
1008 // Add arguments.
1009 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1010 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1011 DIDescriptor Ty = Elements.getElement(i);
Devang Patel2db49d72010-05-07 18:11:54 +00001012 addType(Arg, DIType(Ty));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001013 Buffer.addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001014 }
1015 }
1016 break;
1017 case dwarf::DW_TAG_structure_type:
1018 case dwarf::DW_TAG_union_type:
1019 case dwarf::DW_TAG_class_type: {
1020 // Add elements to structure type.
1021 DIArray Elements = CTy.getTypeArray();
1022
1023 // A forward struct declared type may not have elements available.
Devang Patel3c91b052010-03-08 20:52:55 +00001024 unsigned N = Elements.getNumElements();
1025 if (N == 0)
Bill Wendling0310d762009-05-15 09:23:25 +00001026 break;
1027
1028 // Add elements to structure type.
Devang Patel3c91b052010-03-08 20:52:55 +00001029 for (unsigned i = 0; i < N; ++i) {
Bill Wendling0310d762009-05-15 09:23:25 +00001030 DIDescriptor Element = Elements.getElement(i);
1031 DIE *ElemDie = NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001032 if (Element.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001033 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patel3c91b052010-03-08 20:52:55 +00001034 else if (Element.isVariable()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001035 DIVariable DV(Element);
Devang Patel1ee0cb92010-01-30 01:08:30 +00001036 ElemDie = new DIE(dwarf::DW_TAG_variable);
1037 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1038 DV.getName());
1039 addType(ElemDie, DV.getType());
1040 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1041 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1042 addSourceLine(ElemDie, &DV);
Devang Patel3c91b052010-03-08 20:52:55 +00001043 } else if (Element.isDerivedType())
Devang Patel2db49d72010-05-07 18:11:54 +00001044 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3c91b052010-03-08 20:52:55 +00001045 else
1046 continue;
Devang Patel2c4ceb12009-11-21 02:48:08 +00001047 Buffer.addChild(ElemDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001048 }
1049
Devang Patela1ba2692009-08-27 23:51:51 +00001050 if (CTy.isAppleBlockExtension())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001051 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001052
1053 unsigned RLang = CTy.getRunTimeLang();
1054 if (RLang)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001055 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling0310d762009-05-15 09:23:25 +00001056 dwarf::DW_FORM_data1, RLang);
Devang Patelb5544992010-01-26 21:16:06 +00001057
1058 DICompositeType ContainingType = CTy.getContainingType();
Devang Patel2db49d72010-05-07 18:11:54 +00001059 if (DIDescriptor(ContainingType).isCompositeType())
Devang Patelb5544992010-01-26 21:16:06 +00001060 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patel2db49d72010-05-07 18:11:54 +00001061 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastings215aa152010-06-11 20:08:44 +00001062 else {
1063 DIDescriptor Context = CTy.getContext();
1064 addToContextOwner(&Buffer, Context);
1065 }
Bill Wendling0310d762009-05-15 09:23:25 +00001066 break;
1067 }
1068 default:
1069 break;
1070 }
1071
1072 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +00001073 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001074 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001075
Devang Patel8cbb6122010-01-29 18:34:58 +00001076 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type ||
Bill Wendling0310d762009-05-15 09:23:25 +00001077 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type) {
1078 // Add size if non-zero (derived types might be zero-sized.)
1079 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001080 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +00001081 else {
1082 // Add zero size if it is not a forward declaration.
1083 if (CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001084 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001085 else
Devang Patel2c4ceb12009-11-21 02:48:08 +00001086 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling0310d762009-05-15 09:23:25 +00001087 }
1088
1089 // Add source line info if available.
1090 if (!CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001091 addSourceLine(&Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001092 }
1093}
1094
Devang Patel2c4ceb12009-11-21 02:48:08 +00001095/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1096void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling0310d762009-05-15 09:23:25 +00001097 int64_t L = SR.getLo();
1098 int64_t H = SR.getHi();
1099 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1100
Devang Patel2c4ceb12009-11-21 02:48:08 +00001101 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patel6325a532009-08-14 20:59:16 +00001102 if (L)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001103 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Pateld55224c2009-12-04 23:10:24 +00001104 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling0310d762009-05-15 09:23:25 +00001105
Devang Patel2c4ceb12009-11-21 02:48:08 +00001106 Buffer.addChild(DW_Subrange);
Bill Wendling0310d762009-05-15 09:23:25 +00001107}
1108
Devang Patel2c4ceb12009-11-21 02:48:08 +00001109/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +00001110void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling0310d762009-05-15 09:23:25 +00001111 DICompositeType *CTy) {
1112 Buffer.setTag(dwarf::DW_TAG_array_type);
1113 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001114 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001115
1116 // Emit derived type.
Devang Patel8a241142009-12-09 18:24:21 +00001117 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001118 DIArray Elements = CTy->getTypeArray();
1119
Devang Patel6f01d9c2009-11-21 00:31:03 +00001120 // Get an anonymous type for index type.
Devang Patel163a9f72010-05-10 22:49:55 +00001121 CompileUnit *TheCU = getCompileUnit(*CTy);
1122 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel6f01d9c2009-11-21 00:31:03 +00001123 if (!IdxTy) {
1124 // Construct an anonymous type for index type.
1125 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001126 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1127 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel6f01d9c2009-11-21 00:31:03 +00001128 dwarf::DW_ATE_signed);
Devang Patel163a9f72010-05-10 22:49:55 +00001129 TheCU->addDie(IdxTy);
1130 TheCU->setIndexTyDie(IdxTy);
Devang Patel6f01d9c2009-11-21 00:31:03 +00001131 }
Bill Wendling0310d762009-05-15 09:23:25 +00001132
1133 // Add subranges to array type.
1134 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1135 DIDescriptor Element = Elements.getElement(i);
1136 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patel2db49d72010-05-07 18:11:54 +00001137 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001138 }
1139}
1140
Devang Patel2c4ceb12009-11-21 02:48:08 +00001141/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3c91b052010-03-08 20:52:55 +00001142DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001143 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3c91b052010-03-08 20:52:55 +00001144 StringRef Name = ETy.getName();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001145 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3c91b052010-03-08 20:52:55 +00001146 int64_t Value = ETy.getEnumValue();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001147 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling0310d762009-05-15 09:23:25 +00001148 return Enumerator;
1149}
1150
Devang Patel351ca332010-01-05 01:46:14 +00001151/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
1152/// printer to not emit usual symbol prefix before the symbol name is used then
1153/// return linkage name after skipping this special LLVM prefix.
1154static StringRef getRealLinkageName(StringRef LinkageName) {
1155 char One = '\1';
1156 if (LinkageName.startswith(StringRef(&One, 1)))
1157 return LinkageName.substr(1);
1158 return LinkageName;
1159}
1160
Devang Patel2c4ceb12009-11-21 02:48:08 +00001161/// createGlobalVariableDIE - Create new DIE using GV.
Devang Patel8a241142009-12-09 18:24:21 +00001162DIE *DwarfDebug::createGlobalVariableDIE(const DIGlobalVariable &GV) {
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001163 // If the global variable was optmized out then no need to create debug info
1164 // entry.
Devang Patel84c73e92009-11-06 17:58:12 +00001165 if (!GV.getGlobal()) return NULL;
Devang Patel65dbc902009-11-25 17:36:49 +00001166 if (GV.getDisplayName().empty()) return NULL;
Devang Patel465c3be2009-11-06 01:30:04 +00001167
Bill Wendling0310d762009-05-15 09:23:25 +00001168 DIE *GVDie = new DIE(dwarf::DW_TAG_variable);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001169 addString(GVDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001170 GV.getDisplayName());
1171
Devang Patel65dbc902009-11-25 17:36:49 +00001172 StringRef LinkageName = GV.getLinkageName();
Devang Patel351ca332010-01-05 01:46:14 +00001173 if (!LinkageName.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001174 addString(GVDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel351ca332010-01-05 01:46:14 +00001175 getRealLinkageName(LinkageName));
1176
Devang Patel8a241142009-12-09 18:24:21 +00001177 addType(GVDie, GV.getType());
Bill Wendling0310d762009-05-15 09:23:25 +00001178 if (!GV.isLocalToUnit())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001179 addUInt(GVDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1180 addSourceLine(GVDie, &GV);
Devang Patelb71a16d2009-10-05 23:22:08 +00001181
Bill Wendling0310d762009-05-15 09:23:25 +00001182 return GVDie;
1183}
1184
Devang Patel2c4ceb12009-11-21 02:48:08 +00001185/// createMemberDIE - Create new member DIE.
Devang Patel8a241142009-12-09 18:24:21 +00001186DIE *DwarfDebug::createMemberDIE(const DIDerivedType &DT) {
Bill Wendling0310d762009-05-15 09:23:25 +00001187 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel65dbc902009-11-25 17:36:49 +00001188 StringRef Name = DT.getName();
1189 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001190 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel65dbc902009-11-25 17:36:49 +00001191
Devang Patel8a241142009-12-09 18:24:21 +00001192 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001193
Devang Patel2c4ceb12009-11-21 02:48:08 +00001194 addSourceLine(MemberDie, &DT);
Bill Wendling0310d762009-05-15 09:23:25 +00001195
Benjamin Kramer345ef342010-03-31 19:34:01 +00001196 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001197 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel33db5082009-11-04 22:06:12 +00001198
Bill Wendling0310d762009-05-15 09:23:25 +00001199 uint64_t Size = DT.getSizeInBits();
Devang Patel61ecbd12009-11-04 23:48:00 +00001200 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling0310d762009-05-15 09:23:25 +00001201
1202 if (Size != FieldSize) {
1203 // Handle bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001204 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1205 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling0310d762009-05-15 09:23:25 +00001206
1207 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling0310d762009-05-15 09:23:25 +00001208 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1209 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer3d594fd2010-01-07 17:50:57 +00001210 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling0310d762009-05-15 09:23:25 +00001211 Offset -= FieldOffset;
1212
1213 // Maybe we need to work from the other end.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001214 if (Asm->getTargetData().isLittleEndian())
1215 Offset = FieldSize - (Offset + Size);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001216 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling0310d762009-05-15 09:23:25 +00001217
Devang Patel33db5082009-11-04 22:06:12 +00001218 // Here WD_AT_data_member_location points to the anonymous
1219 // field that includes this bit field.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001220 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001221
1222 } else
1223 // This is not a bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001224 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001225
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001226 if (DT.getTag() == dwarf::DW_TAG_inheritance
1227 && DT.isVirtual()) {
1228
1229 // For C++, virtual base classes are not at fixed offset. Use following
1230 // expression to extract appropriate offset from vtable.
1231 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1232
Benjamin Kramer345ef342010-03-31 19:34:01 +00001233 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001234 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1235 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1236 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1237 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1238 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1239 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1240 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1241
1242 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
1243 VBaseLocationDie);
1244 } else
1245 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001246
1247 if (DT.isProtected())
Devang Patel5d11eb02009-12-03 19:11:07 +00001248 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001249 dwarf::DW_ACCESS_protected);
1250 else if (DT.isPrivate())
Devang Patel5d11eb02009-12-03 19:11:07 +00001251 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001252 dwarf::DW_ACCESS_private);
Devang Patel5d11eb02009-12-03 19:11:07 +00001253 else if (DT.getTag() == dwarf::DW_TAG_inheritance)
1254 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1255 dwarf::DW_ACCESS_public);
1256 if (DT.isVirtual())
1257 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1258 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling0310d762009-05-15 09:23:25 +00001259 return MemberDie;
1260}
1261
Devang Patelffe966c2009-12-14 16:18:45 +00001262/// createSubprogramDIE - Create new DIE using SP.
1263DIE *DwarfDebug::createSubprogramDIE(const DISubprogram &SP, bool MakeDecl) {
Devang Patel163a9f72010-05-10 22:49:55 +00001264 CompileUnit *SPCU = getCompileUnit(SP);
1265 DIE *SPDie = SPCU->getDIE(SP);
Devang Patelffe966c2009-12-14 16:18:45 +00001266 if (SPDie)
1267 return SPDie;
1268
1269 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel1eac3e72010-03-02 17:58:15 +00001270 // Constructors and operators for anonymous aggregates do not have names.
Devang Patel6b506cb2010-03-02 01:26:20 +00001271 if (!SP.getName().empty())
1272 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling0310d762009-05-15 09:23:25 +00001273
Devang Patel65dbc902009-11-25 17:36:49 +00001274 StringRef LinkageName = SP.getLinkageName();
Devang Patel351ca332010-01-05 01:46:14 +00001275 if (!LinkageName.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001276 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel351ca332010-01-05 01:46:14 +00001277 getRealLinkageName(LinkageName));
1278
Devang Patel2c4ceb12009-11-21 02:48:08 +00001279 addSourceLine(SPDie, &SP);
Bill Wendling0310d762009-05-15 09:23:25 +00001280
Bill Wendling0310d762009-05-15 09:23:25 +00001281 // Add prototyped tag, if C or ObjC.
1282 unsigned Lang = SP.getCompileUnit().getLanguage();
1283 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1284 Lang == dwarf::DW_LANG_ObjC)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001285 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001286
1287 // Add Return Type.
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001288 DICompositeType SPTy = SP.getType();
1289 DIArray Args = SPTy.getTypeArray();
Bill Wendling0310d762009-05-15 09:23:25 +00001290 unsigned SPTag = SPTy.getTag();
Devang Patel5d11eb02009-12-03 19:11:07 +00001291
Devang Patel3c91b052010-03-08 20:52:55 +00001292 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel8a241142009-12-09 18:24:21 +00001293 addType(SPDie, SPTy);
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001294 else
Devang Patel2db49d72010-05-07 18:11:54 +00001295 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001296
Devang Patel5d11eb02009-12-03 19:11:07 +00001297 unsigned VK = SP.getVirtuality();
1298 if (VK) {
1299 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer345ef342010-03-31 19:34:01 +00001300 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel5d11eb02009-12-03 19:11:07 +00001301 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1302 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1303 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Devang Patel622b0262010-01-19 06:19:05 +00001304 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patel2db49d72010-05-07 18:11:54 +00001305 SP.getContainingType()));
Devang Patel5d11eb02009-12-03 19:11:07 +00001306 }
1307
Devang Patelffe966c2009-12-14 16:18:45 +00001308 if (MakeDecl || !SP.isDefinition()) {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001309 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001310
1311 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001312 // be handled while processing variables.
1313 DICompositeType SPTy = SP.getType();
1314 DIArray Args = SPTy.getTypeArray();
1315 unsigned SPTag = SPTy.getTag();
1316
Bill Wendling0310d762009-05-15 09:23:25 +00001317 if (SPTag == dwarf::DW_TAG_subroutine_type)
1318 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1319 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001320 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patelb4645642010-02-06 01:02:37 +00001321 addType(Arg, ATy);
1322 if (ATy.isArtificial())
1323 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001324 SPDie->addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001325 }
1326 }
1327
Devang Patel4e0d19d2010-02-03 19:57:19 +00001328 if (SP.isArtificial())
1329 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1330
Devang Patelccff8122010-04-30 19:38:23 +00001331 if (!SP.isLocalToUnit())
1332 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patel2a4a3b72010-04-19 19:14:02 +00001333
Devang Patelccff8122010-04-30 19:38:23 +00001334 if (SP.isOptimized())
1335 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1336
Devang Patelccff8122010-04-30 19:38:23 +00001337 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel163a9f72010-05-10 22:49:55 +00001338 SPCU->insertDIE(SP, SPDie);
Devang Patelccff8122010-04-30 19:38:23 +00001339
Stuart Hastings215aa152010-06-11 20:08:44 +00001340 // Add to context owner.
1341 addToContextOwner(SPDie, SP.getContext());
1342
Bill Wendling0310d762009-05-15 09:23:25 +00001343 return SPDie;
1344}
1345
Devang Patele9f8f5e2010-05-07 20:54:48 +00001346DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattnered7a77b2010-03-31 05:36:29 +00001347 assert(N && "Invalid Scope encoding!");
Devang Patel53bb5c92009-11-10 23:06:00 +00001348
1349 DbgScope *AScope = AbstractScopes.lookup(N);
1350 if (AScope)
1351 return AScope;
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001352
Devang Patel53bb5c92009-11-10 23:06:00 +00001353 DbgScope *Parent = NULL;
1354
1355 DIDescriptor Scope(N);
1356 if (Scope.isLexicalBlock()) {
1357 DILexicalBlock DB(N);
1358 DIDescriptor ParentDesc = DB.getContext();
Devang Patel2db49d72010-05-07 18:11:54 +00001359 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patel53bb5c92009-11-10 23:06:00 +00001360 }
1361
1362 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1363
1364 if (Parent)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001365 Parent->addScope(AScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001366 AScope->setAbstractScope();
1367 AbstractScopes[N] = AScope;
1368 if (DIDescriptor(N).isSubprogram())
1369 AbstractScopesList.push_back(AScope);
1370 return AScope;
1371}
Devang Patelaf9e8472009-10-01 20:31:14 +00001372
Devang Patel5f094002010-04-06 23:53:48 +00001373/// isSubprogramContext - Return true if Context is either a subprogram
1374/// or another context nested inside a subprogram.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001375static bool isSubprogramContext(const MDNode *Context) {
Devang Patel5f094002010-04-06 23:53:48 +00001376 if (!Context)
1377 return false;
1378 DIDescriptor D(Context);
1379 if (D.isSubprogram())
1380 return true;
1381 if (D.isType())
Devang Patel2db49d72010-05-07 18:11:54 +00001382 return isSubprogramContext(DIType(Context).getContext());
Devang Patel5f094002010-04-06 23:53:48 +00001383 return false;
1384}
1385
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001386/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel2c4ceb12009-11-21 02:48:08 +00001387/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1388/// If there are global variables in this scope then create and insert
1389/// DIEs for these variables.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001390DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel163a9f72010-05-10 22:49:55 +00001391 CompileUnit *SPCU = getCompileUnit(SPNode);
1392 DIE *SPDie = SPCU->getDIE(SPNode);
Chris Lattnerd38fee82010-04-05 00:13:49 +00001393 assert(SPDie && "Unable to find subprogram DIE!");
1394 DISubprogram SP(SPNode);
Chris Lattner206d61e2010-03-13 07:26:18 +00001395
Chris Lattnerd38fee82010-04-05 00:13:49 +00001396 // There is not any need to generate specification DIE for a function
1397 // defined at compile unit level. If a function is defined inside another
1398 // function then gdb prefers the definition at top level and but does not
1399 // expect specification DIE in parent function. So avoid creating
1400 // specification DIE for a function defined inside a function.
1401 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Devang Patel5f094002010-04-06 23:53:48 +00001402 !SP.getContext().isFile() &&
Devang Patel2db49d72010-05-07 18:11:54 +00001403 !isSubprogramContext(SP.getContext())) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00001404 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1405
1406 // Add arguments.
1407 DICompositeType SPTy = SP.getType();
1408 DIArray Args = SPTy.getTypeArray();
1409 unsigned SPTag = SPTy.getTag();
1410 if (SPTag == dwarf::DW_TAG_subroutine_type)
1411 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1412 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001413 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattnerd38fee82010-04-05 00:13:49 +00001414 addType(Arg, ATy);
1415 if (ATy.isArtificial())
1416 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1417 SPDie->addChild(Arg);
1418 }
1419 DIE *SPDeclDie = SPDie;
1420 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1421 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
1422 SPDeclDie);
Devang Patel163a9f72010-05-10 22:49:55 +00001423 SPCU->addDie(SPDie);
Chris Lattnerd38fee82010-04-05 00:13:49 +00001424 }
1425
1426 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1427 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1428 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1429 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1430 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1431 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1432 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +00001433
Chris Lattnerd38fee82010-04-05 00:13:49 +00001434 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +00001435}
1436
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001437/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel2c4ceb12009-11-21 02:48:08 +00001438/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1439DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001440
1441 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1442 if (Scope->isAbstractScope())
1443 return ScopeDIE;
1444
1445 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1446 if (Ranges.empty())
1447 return 0;
1448
1449 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1450 if (Ranges.size() > 1) {
1451 // .debug_range section has not been laid out yet. Emit offset in
1452 // .debug_range as a uint, size 4, for now. emitDIE will handle
1453 // DW_AT_ranges appropriately.
1454 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1455 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1456 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1457 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +00001458 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1459 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +00001460 }
1461 DebugRangeSymbols.push_back(NULL);
1462 DebugRangeSymbols.push_back(NULL);
1463 return ScopeDIE;
1464 }
1465
Devang Patelc3f5f782010-05-25 23:40:22 +00001466 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1467 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001468
Devang Patelc3f5f782010-05-25 23:40:22 +00001469 if (End == 0) return 0;
Devang Patel53bb5c92009-11-10 23:06:00 +00001470
Chris Lattnerb7db7332010-03-09 01:58:53 +00001471 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1472 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Chris Lattnera34ec2292010-03-09 01:51:43 +00001473
Devang Pateleac9c072010-04-27 19:46:33 +00001474 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1475 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patel53bb5c92009-11-10 23:06:00 +00001476
1477 return ScopeDIE;
1478}
1479
Devang Patel2c4ceb12009-11-21 02:48:08 +00001480/// constructInlinedScopeDIE - This scope represents inlined body of
1481/// a function. Construct DIE to represent this concrete inlined copy
1482/// of the function.
1483DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001484
1485 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1486 assert (Ranges.empty() == false
1487 && "DbgScope does not have instruction markers!");
1488
1489 // FIXME : .debug_inlined section specification does not clearly state how
1490 // to emit inlined scope that is split into multiple instruction ranges.
1491 // For now, use first instruction range and emit low_pc/high_pc pair and
1492 // corresponding .debug_inlined section entry for this pair.
1493 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patelc3f5f782010-05-25 23:40:22 +00001494 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1495 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001496
Devang Patelc3f5f782010-05-25 23:40:22 +00001497 if (StartLabel == FunctionBeginSym || EndLabel == 0) {
Devang Pateleac9c072010-04-27 19:46:33 +00001498 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1499 return 0;
1500 }
Chris Lattnerb7db7332010-03-09 01:58:53 +00001501 assert(StartLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001502 "Invalid starting label for an inlined scope!");
Chris Lattnerb7db7332010-03-09 01:58:53 +00001503 assert(EndLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001504 "Invalid end label for an inlined scope!");
Devang Pateleac9c072010-04-27 19:46:33 +00001505
Devang Patel3c91b052010-03-08 20:52:55 +00001506 if (!Scope->getScopeNode())
Devang Patel0ef3fa62010-03-08 19:20:38 +00001507 return NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001508 DIScope DS(Scope->getScopeNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00001509 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1510
Devang Patel2db49d72010-05-07 18:11:54 +00001511 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel163a9f72010-05-10 22:49:55 +00001512 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1513 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001514 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel2c4ceb12009-11-21 02:48:08 +00001515 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001516 dwarf::DW_FORM_ref4, OriginDIE);
1517
Chris Lattner6ed0f902010-03-09 00:31:02 +00001518 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnerb7db7332010-03-09 01:58:53 +00001519 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patel53bb5c92009-11-10 23:06:00 +00001520
1521 InlinedSubprogramDIEs.insert(OriginDIE);
1522
1523 // Track the start label for this inlined function.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001524 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patel2db49d72010-05-07 18:11:54 +00001525 I = InlineInfo.find(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001526
1527 if (I == InlineInfo.end()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001528 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001529 ScopeDIE));
Devang Patel2db49d72010-05-07 18:11:54 +00001530 InlinedSPNodes.push_back(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001531 } else
Chris Lattner6ed0f902010-03-09 00:31:02 +00001532 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patel53bb5c92009-11-10 23:06:00 +00001533
Devang Patel53bb5c92009-11-10 23:06:00 +00001534 DILocation DL(Scope->getInlinedAt());
Devang Patel163a9f72010-05-10 22:49:55 +00001535 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001536 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +00001537
1538 return ScopeDIE;
1539}
1540
Devang Patel2c4ceb12009-11-21 02:48:08 +00001541
1542/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel8a241142009-12-09 18:24:21 +00001543DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001544 // Get the descriptor.
1545 const DIVariable &VD = DV->getVariable();
Devang Patel65dbc902009-11-25 17:36:49 +00001546 StringRef Name = VD.getName();
1547 if (Name.empty())
Devang Patel3fb6bd62009-11-13 02:25:26 +00001548 return NULL;
Devang Patel53bb5c92009-11-10 23:06:00 +00001549
1550 // Translate tag to proper Dwarf tag. The result variable is dropped for
1551 // now.
1552 unsigned Tag;
1553 switch (VD.getTag()) {
1554 case dwarf::DW_TAG_return_variable:
1555 return NULL;
1556 case dwarf::DW_TAG_arg_variable:
1557 Tag = dwarf::DW_TAG_formal_parameter;
1558 break;
1559 case dwarf::DW_TAG_auto_variable: // fall thru
1560 default:
1561 Tag = dwarf::DW_TAG_variable;
1562 break;
1563 }
1564
1565 // Define variable debug information entry.
1566 DIE *VariableDie = new DIE(Tag);
1567
Devang Patel53bb5c92009-11-10 23:06:00 +00001568 DIE *AbsDIE = NULL;
Devang Patel26c1e562010-05-20 16:36:41 +00001569 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1570 V2AVI = VarToAbstractVarMap.find(DV);
1571 if (V2AVI != VarToAbstractVarMap.end())
1572 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001573
Devang Patel26c1e562010-05-20 16:36:41 +00001574 if (AbsDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001575 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001576 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001577 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001578 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
1579 addSourceLine(VariableDie, &VD);
Devang Patel53bb5c92009-11-10 23:06:00 +00001580
1581 // Add variable type.
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001582 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
Devang Patel53bb5c92009-11-10 23:06:00 +00001583 // addresses instead.
1584 if (VD.isBlockByrefVariable())
Devang Patel8a241142009-12-09 18:24:21 +00001585 addType(VariableDie, getBlockByrefType(VD.getType(), Name));
Devang Patel53bb5c92009-11-10 23:06:00 +00001586 else
Devang Patel8a241142009-12-09 18:24:21 +00001587 addType(VariableDie, VD.getType());
Devang Patel53bb5c92009-11-10 23:06:00 +00001588 }
1589
Devang Patelb4645642010-02-06 01:02:37 +00001590 if (Tag == dwarf::DW_TAG_formal_parameter && VD.getType().isArtificial())
1591 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelc3f5f782010-05-25 23:40:22 +00001592
1593 if (Scope->isAbstractScope()) {
1594 DV->setDIE(VariableDie);
1595 return VariableDie;
1596 }
1597
1598 // Add variable address.
1599
1600 unsigned Offset = DV->getDotDebugLocOffset();
1601 if (Offset != ~0U) {
1602 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1603 Asm->GetTempSymbol("debug_loc", Offset));
1604 DV->setDIE(VariableDie);
1605 UseDotDebugLocEntry.insert(VariableDie);
1606 return VariableDie;
1607 }
1608
1609 // Check if variable is described by a DBG_VALUE instruction.
1610 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1611 DbgVariableToDbgInstMap.find(DV);
1612 if (DVI != DbgVariableToDbgInstMap.end()) {
1613 const MachineInstr *DVInsn = DVI->second;
1614 const MCSymbol *DVLabel = findVariableLabel(DV);
1615 bool updated = false;
1616 // FIXME : Handle getNumOperands != 3
1617 if (DVInsn->getNumOperands() == 3) {
1618 if (DVInsn->getOperand(0).isReg())
1619 updated = addRegisterAddress(VariableDie, DVLabel, DVInsn->getOperand(0));
1620 else if (DVInsn->getOperand(0).isImm())
1621 updated = addConstantValue(VariableDie, DVLabel, DVInsn->getOperand(0));
1622 else if (DVInsn->getOperand(0).isFPImm())
1623 updated = addConstantFPValue(VariableDie, DVLabel, DVInsn->getOperand(0));
1624 } else {
1625 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1626 if (Location.getReg()) {
1627 addAddress(VariableDie, dwarf::DW_AT_location, Location);
1628 if (DVLabel)
1629 addLabel(VariableDie, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr,
1630 DVLabel);
1631 updated = true;
1632 }
1633 }
1634 if (!updated) {
1635 // If variableDie is not updated then DBG_VALUE instruction does not
1636 // have valid variable info.
1637 delete VariableDie;
1638 return NULL;
1639 }
1640 DV->setDIE(VariableDie);
1641 return VariableDie;
1642 }
1643
1644 // .. else use frame index, if available.
1645 MachineLocation Location;
1646 unsigned FrameReg;
1647 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1648 int FI = 0;
1649 if (findVariableFrameIndex(DV, &FI)) {
1650 int Offset = RI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
1651 Location.set(FrameReg, Offset);
1652
1653 if (VD.hasComplexAddress())
1654 addComplexAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
1655 else if (VD.isBlockByrefVariable())
1656 addBlockByrefAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
1657 else
1658 addAddress(VariableDie, dwarf::DW_AT_location, Location);
1659 }
Devang Patel53bb5c92009-11-10 23:06:00 +00001660 DV->setDIE(VariableDie);
1661 return VariableDie;
1662
1663}
Devang Patel2c4ceb12009-11-21 02:48:08 +00001664
Devang Patel193f7202009-11-24 01:14:22 +00001665void DwarfDebug::addPubTypes(DISubprogram SP) {
1666 DICompositeType SPTy = SP.getType();
1667 unsigned SPTag = SPTy.getTag();
1668 if (SPTag != dwarf::DW_TAG_subroutine_type)
1669 return;
1670
1671 DIArray Args = SPTy.getTypeArray();
Devang Patel193f7202009-11-24 01:14:22 +00001672 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patel2db49d72010-05-07 18:11:54 +00001673 DIType ATy(Args.getElement(i));
Devang Patel9c004872010-05-07 21:45:47 +00001674 if (!ATy.Verify())
Devang Patel193f7202009-11-24 01:14:22 +00001675 continue;
1676 DICompositeType CATy = getDICompositeType(ATy);
Devang Patel2db49d72010-05-07 18:11:54 +00001677 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel50d80e32010-04-13 20:35:04 +00001678 && !CATy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001679 CompileUnit *TheCU = getCompileUnit(CATy);
1680 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1681 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001682 }
1683 }
1684}
1685
Devang Patel2c4ceb12009-11-21 02:48:08 +00001686/// constructScopeDIE - Construct a DIE for this scope.
1687DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3c91b052010-03-08 20:52:55 +00001688 if (!Scope || !Scope->getScopeNode())
1689 return NULL;
1690
1691 DIScope DS(Scope->getScopeNode());
1692 DIE *ScopeDIE = NULL;
1693 if (Scope->getInlinedAt())
1694 ScopeDIE = constructInlinedScopeDIE(Scope);
1695 else if (DS.isSubprogram()) {
1696 if (Scope->isAbstractScope())
Devang Patel163a9f72010-05-10 22:49:55 +00001697 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patel3c91b052010-03-08 20:52:55 +00001698 else
Devang Patel2db49d72010-05-07 18:11:54 +00001699 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3c91b052010-03-08 20:52:55 +00001700 }
Devang Patelaead63c2010-03-29 22:59:58 +00001701 else
Devang Patel3c91b052010-03-08 20:52:55 +00001702 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patelaead63c2010-03-29 22:59:58 +00001703 if (!ScopeDIE) return NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001704
Devang Patel53bb5c92009-11-10 23:06:00 +00001705 // Add variables to scope.
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001706 const SmallVector<DbgVariable *, 8> &Variables = Scope->getVariables();
Devang Patel53bb5c92009-11-10 23:06:00 +00001707 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel8a241142009-12-09 18:24:21 +00001708 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001709 if (VariableDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001710 ScopeDIE->addChild(VariableDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001711 }
1712
1713 // Add nested scopes.
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001714 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
Devang Patel53bb5c92009-11-10 23:06:00 +00001715 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1716 // Define the Scope debug information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001717 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001718 if (NestedDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001719 ScopeDIE->addChild(NestedDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001720 }
Devang Patel193f7202009-11-24 01:14:22 +00001721
1722 if (DS.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001723 addPubTypes(DISubprogram(DS));
Devang Patel193f7202009-11-24 01:14:22 +00001724
1725 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +00001726}
1727
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001728/// GetOrCreateSourceID - Look up the source id with the given directory and
1729/// source file names. If none currently exists, create a new id and insert it
1730/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1731/// maps as well.
Chris Lattner1d65ba72010-03-31 06:06:37 +00001732unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName){
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001733 unsigned DId;
1734 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1735 if (DI != DirectoryIdMap.end()) {
1736 DId = DI->getValue();
1737 } else {
1738 DId = DirectoryNames.size() + 1;
1739 DirectoryIdMap[DirName] = DId;
1740 DirectoryNames.push_back(DirName);
1741 }
1742
1743 unsigned FId;
1744 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1745 if (FI != SourceFileIdMap.end()) {
1746 FId = FI->getValue();
1747 } else {
1748 FId = SourceFileNames.size() + 1;
1749 SourceFileIdMap[FileName] = FId;
1750 SourceFileNames.push_back(FileName);
1751 }
1752
1753 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1754 SourceIdMap.find(std::make_pair(DId, FId));
1755 if (SI != SourceIdMap.end())
1756 return SI->second;
1757
1758 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1759 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1760 SourceIds.push_back(std::make_pair(DId, FId));
1761
1762 return SrcId;
1763}
1764
Devang Patel6404e4e2009-12-15 19:16:48 +00001765/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1766DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel163a9f72010-05-10 22:49:55 +00001767 CompileUnit *TheCU = getCompileUnit(NS);
1768 DIE *NDie = TheCU->getDIE(NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001769 if (NDie)
1770 return NDie;
1771 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel163a9f72010-05-10 22:49:55 +00001772 TheCU->insertDIE(NS, NDie);
Devang Patel6404e4e2009-12-15 19:16:48 +00001773 if (!NS.getName().empty())
1774 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
1775 addSourceLine(NDie, &NS);
1776 addToContextOwner(NDie, NS.getContext());
1777 return NDie;
1778}
1779
Devang Patel163a9f72010-05-10 22:49:55 +00001780/// constructCompileUnit - Create new CompileUnit for the given
1781/// metadata node with tag DW_TAG_compile_unit.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001782void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001783 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +00001784 StringRef FN = DIUnit.getFilename();
1785 StringRef Dir = DIUnit.getDirectory();
Devang Patel5ccdd102009-09-29 18:40:58 +00001786 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001787
1788 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001789 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001790 DIUnit.getProducer());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001791 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001792 DIUnit.getLanguage());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001793 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patel5098da02010-04-26 22:54:28 +00001794 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1795 // simplifies debug range entries.
1796 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_data4, 0);
Devang Patel4a602ca2010-03-22 23:11:36 +00001797 // DW_AT_stmt_list is a offset of line number information for this
1798 // compile unit in debug_line section. It is always zero when only one
1799 // compile unit is emitted in one object file.
1800 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001801
Devang Patel65dbc902009-11-25 17:36:49 +00001802 if (!Dir.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001803 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001804 if (DIUnit.isOptimized())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001805 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001806
Devang Patel65dbc902009-11-25 17:36:49 +00001807 StringRef Flags = DIUnit.getFlags();
1808 if (!Flags.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001809 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001810
1811 unsigned RVer = DIUnit.getRunTimeVersion();
1812 if (RVer)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001813 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001814 dwarf::DW_FORM_data1, RVer);
1815
Devang Patel163a9f72010-05-10 22:49:55 +00001816 CompileUnit *NewCU = new CompileUnit(ID, Die);
1817 if (!FirstCU)
1818 FirstCU = NewCU;
1819 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001820}
1821
Devang Patel163a9f72010-05-10 22:49:55 +00001822/// getCompielUnit - Get CompileUnit DIE.
1823CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1824 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1825 DIDescriptor D(N);
1826 const MDNode *CUNode = NULL;
1827 if (D.isCompileUnit())
1828 CUNode = N;
1829 else if (D.isSubprogram())
1830 CUNode = DISubprogram(N).getCompileUnit();
1831 else if (D.isType())
1832 CUNode = DIType(N).getCompileUnit();
1833 else if (D.isGlobalVariable())
1834 CUNode = DIGlobalVariable(N).getCompileUnit();
1835 else if (D.isVariable())
1836 CUNode = DIVariable(N).getCompileUnit();
1837 else if (D.isNameSpace())
1838 CUNode = DINameSpace(N).getCompileUnit();
1839 else if (D.isFile())
1840 CUNode = DIFile(N).getCompileUnit();
1841 else
1842 return FirstCU;
1843
1844 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1845 = CUMap.find(CUNode);
1846 if (I == CUMap.end())
1847 return FirstCU;
1848 return I->second;
1849}
1850
1851
1852/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001853void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001854 DIGlobalVariable DI_GV(N);
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001855
Devang Patel905cf5e2009-09-04 23:59:07 +00001856 // If debug information is malformed then ignore it.
1857 if (DI_GV.Verify() == false)
1858 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001859
1860 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00001861 CompileUnit *TheCU = getCompileUnit(N);
1862 if (TheCU->getDIE(DI_GV))
Devang Patel13e16b62009-06-26 01:49:18 +00001863 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001864
Devang Patel8a241142009-12-09 18:24:21 +00001865 DIE *VariableDie = createGlobalVariableDIE(DI_GV);
Devang Pateledb45632009-12-10 23:25:41 +00001866 if (!VariableDie)
1867 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001868
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001869 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +00001870 TheCU->insertDIE(N, VariableDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001871
1872 // Add to context owner.
Devang Patelc9b16cc2010-01-15 01:12:22 +00001873 DIDescriptor GVContext = DI_GV.getContext();
1874 // Do not create specification DIE if context is either compile unit
1875 // or a subprogram.
Chris Lattner1d65ba72010-03-31 06:06:37 +00001876 if (DI_GV.isDefinition() && !GVContext.isCompileUnit() &&
Devang Patel5f094002010-04-06 23:53:48 +00001877 !GVContext.isFile() &&
Devang Patel2db49d72010-05-07 18:11:54 +00001878 !isSubprogramContext(GVContext)) {
Devang Patel6404e4e2009-12-15 19:16:48 +00001879 // Create specification DIE.
1880 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1881 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1882 dwarf::DW_FORM_ref4, VariableDie);
Benjamin Kramer345ef342010-03-31 19:34:01 +00001883 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel6404e4e2009-12-15 19:16:48 +00001884 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
Chris Lattner4faf59a2010-03-08 22:31:46 +00001885 addLabel(Block, 0, dwarf::DW_FORM_udata,
Chris Lattnerdeb0cba2010-03-12 21:09:07 +00001886 Asm->Mang->getSymbol(DI_GV.getGlobal()));
Devang Patel6404e4e2009-12-15 19:16:48 +00001887 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
Devang Patel8581e012010-02-09 01:58:33 +00001888 addUInt(VariableDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Devang Patel163a9f72010-05-10 22:49:55 +00001889 TheCU->addDie(VariableSpecDIE);
Devang Patel6404e4e2009-12-15 19:16:48 +00001890 } else {
Benjamin Kramer345ef342010-03-31 19:34:01 +00001891 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel6404e4e2009-12-15 19:16:48 +00001892 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
Chris Lattner4faf59a2010-03-08 22:31:46 +00001893 addLabel(Block, 0, dwarf::DW_FORM_udata,
Chris Lattnerdeb0cba2010-03-12 21:09:07 +00001894 Asm->Mang->getSymbol(DI_GV.getGlobal()));
Devang Patel6404e4e2009-12-15 19:16:48 +00001895 addBlock(VariableDie, dwarf::DW_AT_location, 0, Block);
1896 }
Devang Patelc9b16cc2010-01-15 01:12:22 +00001897 addToContextOwner(VariableDie, GVContext);
Devang Patelc366f832009-12-10 19:14:49 +00001898
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001899 // Expose as global. FIXME - need to check external flag.
Devang Patel163a9f72010-05-10 22:49:55 +00001900 TheCU->addGlobal(DI_GV.getName(), VariableDie);
Devang Patel193f7202009-11-24 01:14:22 +00001901
1902 DIType GTy = DI_GV.getType();
Devang Patel50d80e32010-04-13 20:35:04 +00001903 if (GTy.isCompositeType() && !GTy.getName().empty()
1904 && !GTy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001905 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001906 assert(Entry && "Missing global type!");
Devang Patel163a9f72010-05-10 22:49:55 +00001907 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001908 }
Devang Patel13e16b62009-06-26 01:49:18 +00001909 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001910}
1911
Devang Patel163a9f72010-05-10 22:49:55 +00001912/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001913void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001914 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001915
Stuart Hastings639336e2010-04-06 21:38:29 +00001916 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00001917 CompileUnit *TheCU = getCompileUnit(N);
1918 if (TheCU->getDIE(N))
Stuart Hastings639336e2010-04-06 21:38:29 +00001919 return;
1920
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001921 if (!SP.isDefinition())
1922 // This is a method declaration which will be handled while constructing
1923 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +00001924 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001925
Stuart Hastings639336e2010-04-06 21:38:29 +00001926 DIE *SubprogramDie = createSubprogramDIE(SP);
1927
1928 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +00001929 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001930
1931 // Add to context owner.
Devang Patel6404e4e2009-12-15 19:16:48 +00001932 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +00001933
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001934 // Expose as global.
Devang Patel163a9f72010-05-10 22:49:55 +00001935 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel193f7202009-11-24 01:14:22 +00001936
Devang Patel13e16b62009-06-26 01:49:18 +00001937 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001938}
1939
Devang Patel2c4ceb12009-11-21 02:48:08 +00001940/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbar00564992009-09-19 20:40:14 +00001941/// content. Create global DIEs and emit initial debug info sections.
1942/// This is inovked by the target AsmPrinter.
Chris Lattner75f50722010-04-04 07:48:20 +00001943void DwarfDebug::beginModule(Module *M) {
Devang Pateleac9c072010-04-27 19:46:33 +00001944 if (DisableDebugInfoPrinting)
1945 return;
1946
Devang Patel78ab9e22009-07-30 18:56:46 +00001947 DebugInfoFinder DbgFinder;
1948 DbgFinder.processModule(*M);
Devang Patel13e16b62009-06-26 01:49:18 +00001949
Chris Lattnerd850ac72010-04-05 02:19:28 +00001950 bool HasDebugInfo = false;
1951
1952 // Scan all the compile-units to see if there are any marked as the main unit.
1953 // if not, we do not generate debug info.
1954 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1955 E = DbgFinder.compile_unit_end(); I != E; ++I) {
1956 if (DICompileUnit(*I).isMain()) {
1957 HasDebugInfo = true;
1958 break;
1959 }
1960 }
1961
1962 if (!HasDebugInfo) return;
1963
1964 // Tell MMI that we have debug info.
1965 MMI->setDebugInfoAvailability(true);
1966
Chris Lattnerbe15beb2010-04-04 23:17:54 +00001967 // Emit initial sections.
Chris Lattnerd850ac72010-04-05 02:19:28 +00001968 EmitSectionLabels();
Chris Lattnerbe15beb2010-04-04 23:17:54 +00001969
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001970 // Create all the compile unit DIEs.
Devang Patel78ab9e22009-07-30 18:56:46 +00001971 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1972 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001973 constructCompileUnit(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001974
Devang Patel53bb5c92009-11-10 23:06:00 +00001975 // Create DIEs for each subprogram.
Devang Patel78ab9e22009-07-30 18:56:46 +00001976 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
1977 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001978 constructSubprogramDIE(*I);
Devang Patel13e16b62009-06-26 01:49:18 +00001979
Devang Patelc366f832009-12-10 19:14:49 +00001980 // Create DIEs for each global variable.
1981 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
1982 E = DbgFinder.global_variable_end(); I != E; ++I)
1983 constructGlobalVariableDIE(*I);
1984
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001985 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +00001986 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001987
1988 // Print out .file directives to specify files for .loc directives. These are
1989 // printed out early so that they precede any .loc directives.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001990 if (Asm->MAI->hasDotLocAndDotFile()) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001991 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
1992 // Remember source id starts at 1.
1993 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
Chris Lattner0ad9c912010-01-22 22:09:00 +00001994 // FIXME: don't use sys::path for this! This should not depend on the
1995 // host.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001996 sys::Path FullPath(getSourceDirectoryName(Id.first));
1997 bool AppendOk =
1998 FullPath.appendComponent(getSourceFileName(Id.second));
1999 assert(AppendOk && "Could not append filename to directory!");
2000 AppendOk = false;
Chris Lattnera6594fc2010-01-25 18:58:59 +00002001 Asm->OutStreamer.EmitDwarfFileDirective(i, FullPath.str());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002002 }
2003 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002004}
2005
Devang Patel2c4ceb12009-11-21 02:48:08 +00002006/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002007///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002008void DwarfDebug::endModule() {
Devang Patel163a9f72010-05-10 22:49:55 +00002009 if (!FirstCU) return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002010
Devang Patel53bb5c92009-11-10 23:06:00 +00002011 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2012 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2013 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2014 DIE *ISP = *AI;
Devang Patel2c4ceb12009-11-21 02:48:08 +00002015 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +00002016 }
2017
Devang Patele9f8f5e2010-05-07 20:54:48 +00002018 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Patel5d11eb02009-12-03 19:11:07 +00002019 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2020 DIE *SPDie = CI->first;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002021 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Patel5d11eb02009-12-03 19:11:07 +00002022 if (!N) continue;
Devang Patel163a9f72010-05-10 22:49:55 +00002023 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Patel5d11eb02009-12-03 19:11:07 +00002024 if (!NDie) continue;
2025 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patel5d11eb02009-12-03 19:11:07 +00002026 }
2027
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002028 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002029 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002030 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002031 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002032 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002033
2034 // End text sections.
2035 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002036 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnerc0215722010-04-04 19:25:43 +00002037 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002038 }
2039
2040 // Emit common frame information.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002041 emitCommonDebugFrame();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002042
2043 // Emit function debug frame information
2044 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2045 E = DebugFrames.end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002046 emitFunctionDebugFrame(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002047
2048 // Compute DIE offsets and sizes.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002049 computeSizeAndOffsets();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002050
2051 // Emit all the DIEs into a debug info section
Devang Patel2c4ceb12009-11-21 02:48:08 +00002052 emitDebugInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002053
2054 // Corresponding abbreviations into a abbrev section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002055 emitAbbreviations();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002056
2057 // Emit source line correspondence into a debug line section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002058 emitDebugLines();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002059
2060 // Emit info into a debug pubnames section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002061 emitDebugPubNames();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002062
Devang Patel193f7202009-11-24 01:14:22 +00002063 // Emit info into a debug pubtypes section.
2064 emitDebugPubTypes();
2065
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002066 // Emit info into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002067 emitDebugLoc();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002068
2069 // Emit info into a debug aranges section.
2070 EmitDebugARanges();
2071
2072 // Emit info into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002073 emitDebugRanges();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002074
2075 // Emit info into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002076 emitDebugMacInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002077
2078 // Emit inline info.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002079 emitDebugInlineInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002080
Chris Lattnerbc733f52010-03-13 02:17:42 +00002081 // Emit info into a debug str section.
2082 emitDebugStr();
2083
Devang Patel163a9f72010-05-10 22:49:55 +00002084 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2085 E = CUMap.end(); I != E; ++I)
2086 delete I->second;
2087 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002088}
2089
Devang Patel53bb5c92009-11-10 23:06:00 +00002090/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Devang Patel26c1e562010-05-20 16:36:41 +00002091DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattnerde4845c2010-04-02 19:42:39 +00002092 DebugLoc ScopeLoc) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002093
Devang Patel2db49d72010-05-07 18:11:54 +00002094 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00002095 if (AbsDbgVariable)
2096 return AbsDbgVariable;
2097
Devang Patel2db49d72010-05-07 18:11:54 +00002098 LLVMContext &Ctx = Var->getContext();
Chris Lattnerde4845c2010-04-02 19:42:39 +00002099 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00002100 if (!Scope)
2101 return NULL;
2102
Devang Patel26c1e562010-05-20 16:36:41 +00002103 AbsDbgVariable = new DbgVariable(Var);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002104 Scope->addVariable(AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00002105 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00002106 return AbsDbgVariable;
2107}
2108
Devang Patelee432862010-05-20 19:57:06 +00002109/// collectVariableInfoFromMMITable - Collect variable information from
2110/// side table maintained by MMI.
2111void
2112DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2113 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00002114 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patele717faa2009-10-06 01:26:37 +00002115 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2116 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2117 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00002118 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00002119 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00002120 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002121 DIVariable DV(Var);
2122 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00002123
Chris Lattnerde4845c2010-04-02 19:42:39 +00002124 DbgScope *Scope = 0;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002125 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattnerde4845c2010-04-02 19:42:39 +00002126 Scope = ConcreteScopes.lookup(IA);
2127 if (Scope == 0)
2128 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
2129
Devang Patelfb0ee432009-11-10 23:20:04 +00002130 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00002131 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00002132 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00002133
Devang Patel26c1e562010-05-20 16:36:41 +00002134 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2135 DbgVariable *RegVar = new DbgVariable(DV);
2136 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002137 Scope->addVariable(RegVar);
Devang Patel26c1e562010-05-20 16:36:41 +00002138 if (AbsDbgVariable) {
2139 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2140 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2141 }
Devang Patele717faa2009-10-06 01:26:37 +00002142 }
Devang Patelee432862010-05-20 19:57:06 +00002143}
Devang Patel90a48ad2010-03-15 18:33:46 +00002144
Devang Patelc3f5f782010-05-25 23:40:22 +00002145/// isDbgValueInUndefinedReg - Return true if debug value, encoded by
2146/// DBG_VALUE instruction, is in undefined reg.
2147static bool isDbgValueInUndefinedReg(const MachineInstr *MI) {
2148 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2149 if (MI->getOperand(0).isReg() && !MI->getOperand(0).getReg())
2150 return true;
2151 return false;
2152}
2153
2154/// isDbgValueInDefinedReg - Return true if debug value, encoded by
2155/// DBG_VALUE instruction, is in a defined reg.
2156static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2157 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2158 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2159 return true;
2160 return false;
2161}
2162
Devang Patelee432862010-05-20 19:57:06 +00002163/// collectVariableInfo - Populate DbgScope entries with variables' info.
2164void DwarfDebug::collectVariableInfo(const MachineFunction *MF) {
2165 SmallPtrSet<const MDNode *, 16> Processed;
2166
2167 /// collection info from MMI table.
2168 collectVariableInfoFromMMITable(MF, Processed);
2169
2170 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patel90a48ad2010-03-15 18:33:46 +00002171 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002172 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelee432862010-05-20 19:57:06 +00002173 I != E; ++I)
Devang Patel90a48ad2010-03-15 18:33:46 +00002174 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2175 II != IE; ++II) {
2176 const MachineInstr *MInsn = II;
Devang Patelc3f5f782010-05-25 23:40:22 +00002177 if (!MInsn->isDebugValue() || isDbgValueInUndefinedReg(MInsn))
Devang Patel90a48ad2010-03-15 18:33:46 +00002178 continue;
Devang Patelee432862010-05-20 19:57:06 +00002179 DbgValues.push_back(MInsn);
2180 }
Devang Patel90a48ad2010-03-15 18:33:46 +00002181
Devang Patelc3f5f782010-05-25 23:40:22 +00002182 // This is a collection of DBV_VALUE instructions describing same variable.
2183 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patelee432862010-05-20 19:57:06 +00002184 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2185 E = DbgValues.end(); I != E; ++I) {
2186 const MachineInstr *MInsn = *I;
Devang Patelc3f5f782010-05-25 23:40:22 +00002187 MultipleValues.clear();
2188 if (isDbgValueInDefinedReg(MInsn))
2189 MultipleValues.push_back(MInsn);
Devang Patelee432862010-05-20 19:57:06 +00002190 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2191 if (Processed.count(DV) != 0)
2192 continue;
2193
Devang Patel354eb7e2010-06-02 19:05:13 +00002194 const MachineInstr *PrevMI = MInsn;
Devang Patelc3f5f782010-05-25 23:40:22 +00002195 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
2196 ME = DbgValues.end(); MI != ME; ++MI) {
2197 const MDNode *Var =
2198 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
Devang Patel354eb7e2010-06-02 19:05:13 +00002199 if (Var == DV && isDbgValueInDefinedReg(*MI) &&
2200 !PrevMI->isIdenticalTo(*MI))
Devang Patelc3f5f782010-05-25 23:40:22 +00002201 MultipleValues.push_back(*MI);
Devang Patel354eb7e2010-06-02 19:05:13 +00002202 PrevMI = *MI;
Devang Patelc3f5f782010-05-25 23:40:22 +00002203 }
2204
Devang Patelee432862010-05-20 19:57:06 +00002205 DbgScope *Scope = findDbgScope(MInsn);
Devang Pateld8720f42010-05-27 20:25:04 +00002206 bool CurFnArg = false;
2207 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2208 DISubprogram(DV.getContext()).describes(MF->getFunction()))
2209 CurFnArg = true;
2210 if (!Scope && CurFnArg)
Devang Patelc0c5a262010-05-21 00:10:20 +00002211 Scope = CurrentFnDbgScope;
Devang Patelee432862010-05-20 19:57:06 +00002212 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00002213 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00002214 continue;
2215
2216 Processed.insert(DV);
Devang Patelee432862010-05-20 19:57:06 +00002217 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patelee432862010-05-20 19:57:06 +00002218 Scope->addVariable(RegVar);
Devang Pateld8720f42010-05-27 20:25:04 +00002219 if (!CurFnArg)
Devang Patelc3f5f782010-05-25 23:40:22 +00002220 DbgVariableLabelsMap[RegVar] = getLabelBeforeInsn(MInsn);
Devang Patelc0c5a262010-05-21 00:10:20 +00002221 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2222 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2223 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patel90a48ad2010-03-15 18:33:46 +00002224 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002225 if (MultipleValues.size() <= 1) {
2226 DbgVariableToDbgInstMap[RegVar] = MInsn;
2227 continue;
2228 }
2229
2230 // handle multiple DBG_VALUE instructions describing one variable.
Devang Patelc3f5f782010-05-25 23:40:22 +00002231 if (DotDebugLocEntries.empty())
Devang Patel80250682010-05-26 23:55:23 +00002232 RegVar->setDotDebugLocOffset(0);
2233 else
2234 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Devang Patele2df8422010-05-26 17:29:32 +00002235 const MachineInstr *Begin = NULL;
2236 const MachineInstr *End = NULL;
2237 for (SmallVector<const MachineInstr *, 4>::iterator
2238 MVI = MultipleValues.begin(), MVE = MultipleValues.end(); MVI != MVE; ++MVI) {
2239 if (!Begin) {
2240 Begin = *MVI;
2241 continue;
2242 }
2243 End = *MVI;
Devang Patelc3f5f782010-05-25 23:40:22 +00002244 MachineLocation MLoc;
Devang Patele2df8422010-05-26 17:29:32 +00002245 MLoc.set(Begin->getOperand(0).getReg(), 0);
2246 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2247 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patelc3f5f782010-05-25 23:40:22 +00002248 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
Devang Patele2df8422010-05-26 17:29:32 +00002249 Begin = End;
2250 if (MVI + 1 == MVE) {
2251 // If End is the last instruction then its value is valid
Devang Patelc3f5f782010-05-25 23:40:22 +00002252 // until the end of the funtion.
Devang Patele2df8422010-05-26 17:29:32 +00002253 MLoc.set(End->getOperand(0).getReg(), 0);
Devang Patelc3f5f782010-05-25 23:40:22 +00002254 DotDebugLocEntries.
2255 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, MLoc));
2256 }
2257 }
2258 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00002259 }
Devang Patel98e1cac2010-05-14 21:01:35 +00002260
2261 // Collect info for variables that were optimized out.
2262 if (NamedMDNode *NMD =
2263 MF->getFunction()->getParent()->getNamedMetadata("llvm.dbg.lv")) {
2264 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2265 DIVariable DV(cast_or_null<MDNode>(NMD->getOperand(i)));
Devang Patelee432862010-05-20 19:57:06 +00002266 if (!DV || !Processed.insert(DV))
Devang Patel98e1cac2010-05-14 21:01:35 +00002267 continue;
2268 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2269 if (Scope)
Devang Patel26c1e562010-05-20 16:36:41 +00002270 Scope->addVariable(new DbgVariable(DV));
Devang Patel98e1cac2010-05-14 21:01:35 +00002271 }
2272 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002273}
Devang Patel98e1cac2010-05-14 21:01:35 +00002274
Devang Patelc3f5f782010-05-25 23:40:22 +00002275/// getLabelBeforeInsn - Return Label preceding the instruction.
2276const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2277 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2278 LabelsBeforeInsn.find(MI);
2279 if (I == LabelsBeforeInsn.end())
2280 // FunctionBeginSym always preceeds all the instruction in current function.
2281 return FunctionBeginSym;
2282 return I->second;
2283}
2284
2285/// getLabelAfterInsn - Return Label immediately following the instruction.
2286const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2287 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2288 LabelsAfterInsn.find(MI);
2289 if (I == LabelsAfterInsn.end())
2290 return NULL;
2291 return I->second;
Devang Patele717faa2009-10-06 01:26:37 +00002292}
2293
Devang Patel553881b2010-03-29 17:20:31 +00002294/// beginScope - Process beginning of a scope.
2295void DwarfDebug::beginScope(const MachineInstr *MI) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002296 if (InsnNeedsLabel.count(MI) == 0) {
2297 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patel553881b2010-03-29 17:20:31 +00002298 return;
Devang Patelc3f5f782010-05-25 23:40:22 +00002299 }
Devang Patelaead63c2010-03-29 22:59:58 +00002300
Devang Patelb2b31a62010-05-26 19:37:24 +00002301 // Check location.
2302 DebugLoc DL = MI->getDebugLoc();
2303 if (!DL.isUnknown()) {
2304 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2305 PrevLabel = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
Devang Pateleac9c072010-04-27 19:46:33 +00002306 PrevInstLoc = DL;
Devang Patelb2b31a62010-05-26 19:37:24 +00002307 LabelsBeforeInsn[MI] = PrevLabel;
2308 return;
Devang Pateleac9c072010-04-27 19:46:33 +00002309 }
Devang Patel553881b2010-03-29 17:20:31 +00002310
Devang Patel77051f52010-05-26 21:23:46 +00002311 // If location is unknown then use temp label for this DBG_VALUE
Devang Patelb2b31a62010-05-26 19:37:24 +00002312 // instruction.
2313 if (MI->isDebugValue()) {
Devang Patel77051f52010-05-26 21:23:46 +00002314 PrevLabel = MMI->getContext().CreateTempSymbol();
2315 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00002316 LabelsBeforeInsn[MI] = PrevLabel;
2317 return;
2318 }
2319
2320 if (UnknownLocations) {
2321 PrevLabel = recordSourceLine(0, 0, 0);
2322 LabelsBeforeInsn[MI] = PrevLabel;
2323 return;
2324 }
2325
2326 assert (0 && "Instruction is not processed!");
Devang Patel0d20ac82009-10-06 01:50:42 +00002327}
2328
Devang Patel2c4ceb12009-11-21 02:48:08 +00002329/// endScope - Process end of a scope.
2330void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel1c246352010-04-08 16:50:29 +00002331 if (InsnsEndScopeSet.count(MI) != 0) {
2332 // Emit a label if this instruction ends a scope.
2333 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2334 Asm->OutStreamer.EmitLabel(Label);
Devang Pateleac9c072010-04-27 19:46:33 +00002335 LabelsAfterInsn[MI] = Label;
Devang Patel1c246352010-04-08 16:50:29 +00002336 }
Devang Patel53bb5c92009-11-10 23:06:00 +00002337}
2338
Devang Pateleac9c072010-04-27 19:46:33 +00002339/// getOrCreateDbgScope - Create DbgScope for the scope.
Devang Patele9f8f5e2010-05-07 20:54:48 +00002340DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope, const MDNode *InlinedAt) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002341 if (!InlinedAt) {
2342 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2343 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002344 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002345 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2346 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Pateleac9c072010-04-27 19:46:33 +00002347 if (DIDescriptor(Scope).isLexicalBlock()) {
2348 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002349 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Pateleac9c072010-04-27 19:46:33 +00002350 WScope->setParent(Parent);
2351 Parent->addScope(WScope);
2352 }
2353
2354 if (!WScope->getParent()) {
2355 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastings215aa152010-06-11 20:08:44 +00002356 if (SPName == Asm->MF->getFunction()->getName() ||
2357 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Pateleac9c072010-04-27 19:46:33 +00002358 CurrentFnDbgScope = WScope;
2359 }
2360
2361 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002362 }
2363
2364 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2365 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002366 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002367
2368 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2369 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2370 DILocation DL(InlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002371 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002372 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Pateleac9c072010-04-27 19:46:33 +00002373 WScope->setParent(Parent);
2374 Parent->addScope(WScope);
2375
2376 ConcreteScopes[InlinedAt] = WScope;
2377 getOrCreateAbstractScope(Scope);
2378
2379 return WScope;
Devang Patel0d20ac82009-10-06 01:50:42 +00002380}
2381
Devang Pateleac9c072010-04-27 19:46:33 +00002382/// hasValidLocation - Return true if debug location entry attached with
2383/// machine instruction encodes valid location info.
2384static bool hasValidLocation(LLVMContext &Ctx,
2385 const MachineInstr *MInsn,
Devang Patele9f8f5e2010-05-07 20:54:48 +00002386 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Pateleac9c072010-04-27 19:46:33 +00002387 if (MInsn->isDebugValue())
2388 return false;
2389 DebugLoc DL = MInsn->getDebugLoc();
2390 if (DL.isUnknown()) return false;
2391
Devang Patele9f8f5e2010-05-07 20:54:48 +00002392 const MDNode *S = DL.getScope(Ctx);
Devang Pateleac9c072010-04-27 19:46:33 +00002393
2394 // There is no need to create another DIE for compile unit. For all
2395 // other scopes, create one DbgScope now. This will be translated
2396 // into a scope DIE at the end.
2397 if (DIScope(S).isCompileUnit()) return false;
2398
2399 Scope = S;
2400 InlinedAt = DL.getInlinedAt(Ctx);
2401 return true;
2402}
2403
2404/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2405/// hierarchy.
2406static void calculateDominanceGraph(DbgScope *Scope) {
2407 assert (Scope && "Unable to calculate scop edominance graph!");
2408 SmallVector<DbgScope *, 4> WorkStack;
2409 WorkStack.push_back(Scope);
2410 unsigned Counter = 0;
2411 while (!WorkStack.empty()) {
2412 DbgScope *WS = WorkStack.back();
2413 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2414 bool visitedChildren = false;
2415 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2416 SE = Children.end(); SI != SE; ++SI) {
2417 DbgScope *ChildScope = *SI;
2418 if (!ChildScope->getDFSOut()) {
2419 WorkStack.push_back(ChildScope);
2420 visitedChildren = true;
2421 ChildScope->setDFSIn(++Counter);
2422 break;
2423 }
2424 }
2425 if (!visitedChildren) {
2426 WorkStack.pop_back();
2427 WS->setDFSOut(++Counter);
2428 }
2429 }
2430}
2431
2432/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
2433static
2434void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2435 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2436{
2437#ifndef NDEBUG
2438 unsigned PrevDFSIn = 0;
2439 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2440 I != E; ++I) {
2441 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2442 II != IE; ++II) {
2443 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002444 const MDNode *Scope = NULL;
2445 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002446
2447 // Check if instruction has valid location information.
2448 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2449 dbgs() << " [ ";
2450 if (InlinedAt)
2451 dbgs() << "*";
2452 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
2453 MI2ScopeMap.find(MInsn);
2454 if (DI != MI2ScopeMap.end()) {
2455 DbgScope *S = DI->second;
2456 dbgs() << S->getDFSIn();
2457 PrevDFSIn = S->getDFSIn();
2458 } else
2459 dbgs() << PrevDFSIn;
2460 } else
2461 dbgs() << " [ x" << PrevDFSIn;
2462 dbgs() << " ]";
2463 MInsn->dump();
2464 }
2465 dbgs() << "\n";
2466 }
2467#endif
2468}
Devang Patel2c4ceb12009-11-21 02:48:08 +00002469/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner14d750d2010-03-31 05:39:57 +00002470/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattnereec791a2010-01-26 23:18:02 +00002471bool DwarfDebug::extractScopeInformation() {
Devang Patelaf9e8472009-10-01 20:31:14 +00002472 // If scope information was extracted using .dbg intrinsics then there is not
2473 // any need to extract these information by scanning each instruction.
2474 if (!DbgScopeMap.empty())
2475 return false;
2476
Dan Gohman314bf7c2010-04-23 01:18:53 +00002477 // Scan each instruction and create scopes. First build working set of scopes.
Devang Pateleac9c072010-04-27 19:46:33 +00002478 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2479 SmallVector<DbgRange, 4> MIRanges;
2480 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002481 const MDNode *PrevScope = NULL;
2482 const MDNode *PrevInlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002483 const MachineInstr *RangeBeginMI = NULL;
2484 const MachineInstr *PrevMI = NULL;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002485 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelaf9e8472009-10-01 20:31:14 +00002486 I != E; ++I) {
2487 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2488 II != IE; ++II) {
2489 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002490 const MDNode *Scope = NULL;
2491 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002492
2493 // Check if instruction has valid location information.
2494 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2495 PrevMI = MInsn;
2496 continue;
2497 }
Chris Lattnerde4845c2010-04-02 19:42:39 +00002498
Devang Pateleac9c072010-04-27 19:46:33 +00002499 // If scope has not changed then skip this instruction.
2500 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2501 PrevMI = MInsn;
2502 continue;
2503 }
2504
2505 if (RangeBeginMI) {
2506 // If we have alread seen a beginning of a instruction range and
2507 // current instruction scope does not match scope of first instruction
2508 // in this range then create a new instruction range.
2509 DbgRange R(RangeBeginMI, PrevMI);
2510 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
2511 MIRanges.push_back(R);
2512 }
2513
2514 // This is a beginning of a new instruction range.
2515 RangeBeginMI = MInsn;
Chris Lattnerde4845c2010-04-02 19:42:39 +00002516
Devang Pateleac9c072010-04-27 19:46:33 +00002517 // Reset previous markers.
2518 PrevMI = MInsn;
2519 PrevScope = Scope;
2520 PrevInlinedAt = InlinedAt;
Devang Patel53bb5c92009-11-10 23:06:00 +00002521 }
2522 }
2523
Devang Pateleac9c072010-04-27 19:46:33 +00002524 // Create last instruction range.
2525 if (RangeBeginMI && PrevMI && PrevScope) {
2526 DbgRange R(RangeBeginMI, PrevMI);
2527 MIRanges.push_back(R);
2528 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patelaf9e8472009-10-01 20:31:14 +00002529 }
Devang Pateleac9c072010-04-27 19:46:33 +00002530
Devang Patel344130e2010-01-04 20:44:00 +00002531 if (!CurrentFnDbgScope)
2532 return false;
2533
Devang Pateleac9c072010-04-27 19:46:33 +00002534 calculateDominanceGraph(CurrentFnDbgScope);
2535 if (PrintDbgScope)
2536 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2537
2538 // Find ranges of instructions covered by each DbgScope;
2539 DbgScope *PrevDbgScope = NULL;
2540 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2541 RE = MIRanges.end(); RI != RE; ++RI) {
2542 const DbgRange &R = *RI;
2543 DbgScope *S = MI2ScopeMap.lookup(R.first);
2544 assert (S && "Lost DbgScope for a machine instruction!");
2545 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2546 PrevDbgScope->closeInsnRange(S);
2547 S->openInsnRange(R.first);
2548 S->extendInsnRange(R.second);
2549 PrevDbgScope = S;
2550 }
2551
2552 if (PrevDbgScope)
2553 PrevDbgScope->closeInsnRange();
Devang Patelaf9e8472009-10-01 20:31:14 +00002554
Devang Patele37b0c62010-04-08 18:43:56 +00002555 identifyScopeMarkers();
Devang Patel6122a4d2010-04-08 15:37:09 +00002556
2557 return !DbgScopeMap.empty();
2558}
2559
Devang Pateleac9c072010-04-27 19:46:33 +00002560/// identifyScopeMarkers() -
2561/// Each DbgScope has first instruction and last instruction to mark beginning
2562/// and end of a scope respectively. Create an inverse map that list scopes
2563/// starts (and ends) with an instruction. One instruction may start (or end)
2564/// multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00002565void DwarfDebug::identifyScopeMarkers() {
Devang Patel42aafd72010-01-20 02:05:23 +00002566 SmallVector<DbgScope *, 4> WorkList;
2567 WorkList.push_back(CurrentFnDbgScope);
2568 while (!WorkList.empty()) {
Chris Lattner14d750d2010-03-31 05:39:57 +00002569 DbgScope *S = WorkList.pop_back_val();
Devang Pateleac9c072010-04-27 19:46:33 +00002570
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002571 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Devang Patel42aafd72010-01-20 02:05:23 +00002572 if (!Children.empty())
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002573 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00002574 SE = Children.end(); SI != SE; ++SI)
2575 WorkList.push_back(*SI);
2576
Devang Patel53bb5c92009-11-10 23:06:00 +00002577 if (S->isAbstractScope())
2578 continue;
Devang Pateleac9c072010-04-27 19:46:33 +00002579
2580 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2581 if (Ranges.empty())
2582 continue;
2583 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2584 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel461a6462010-05-19 21:58:28 +00002585 assert(RI->first && "DbgRange does not have first instruction!");
2586 assert(RI->second && "DbgRange does not have second instruction!");
2587 InsnsBeginScopeSet.insert(RI->first);
Devang Pateleac9c072010-04-27 19:46:33 +00002588 InsnsEndScopeSet.insert(RI->second);
2589 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002590 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002591}
2592
Dan Gohman084751c2010-04-20 00:37:27 +00002593/// FindFirstDebugLoc - Find the first debug location in the function. This
2594/// is intended to be an approximation for the source position of the
2595/// beginning of the function.
2596static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2597 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2598 I != E; ++I)
2599 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2600 MBBI != MBBE; ++MBBI) {
2601 DebugLoc DL = MBBI->getDebugLoc();
2602 if (!DL.isUnknown())
2603 return DL;
2604 }
2605 return DebugLoc();
2606}
2607
Devang Patel2c4ceb12009-11-21 02:48:08 +00002608/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002609/// emitted immediately after the function entry point.
Chris Lattnereec791a2010-01-26 23:18:02 +00002610void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00002611 if (!MMI->hasDebugInfo()) return;
Bill Wendling5f017e82010-04-07 09:28:04 +00002612 if (!extractScopeInformation()) return;
Devang Patel60b35bd2009-10-06 18:37:31 +00002613
Devang Pateleac9c072010-04-27 19:46:33 +00002614 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2615 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002616 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00002617 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002618
2619 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2620 // function.
Dan Gohman084751c2010-04-20 00:37:27 +00002621 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002622 if (FDL.isUnknown()) return;
2623
Devang Patele9f8f5e2010-05-07 20:54:48 +00002624 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Chris Lattnerde4845c2010-04-02 19:42:39 +00002625
2626 DISubprogram SP = getDISubprogram(Scope);
2627 unsigned Line, Col;
2628 if (SP.Verify()) {
2629 Line = SP.getLineNumber();
2630 Col = 0;
2631 } else {
2632 Line = FDL.getLine();
2633 Col = FDL.getCol();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002634 }
Chris Lattnerde4845c2010-04-02 19:42:39 +00002635
2636 recordSourceLine(Line, Col, Scope);
Devang Patelb2b31a62010-05-26 19:37:24 +00002637
Devang Patelb9abe9f2010-06-02 16:42:51 +00002638 /// ProcessedArgs - Collection of arguments already processed.
2639 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2640
Devang Patelb2b31a62010-05-26 19:37:24 +00002641 DebugLoc PrevLoc;
2642 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2643 I != E; ++I)
2644 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2645 II != IE; ++II) {
2646 const MachineInstr *MI = II;
2647 DebugLoc DL = MI->getDebugLoc();
2648 if (MI->isDebugValue()) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002649 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2650 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2651 if (!DV.Verify()) continue;
Devang Patelf2e77672010-06-01 21:43:09 +00002652 if (isDbgValueInUndefinedReg(MI)) continue;
Devang Patel55e97172010-05-27 16:47:30 +00002653 // If DBG_VALUE is for a local variable then it needs a label.
Devang Patelb2b31a62010-05-26 19:37:24 +00002654 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
2655 InsnNeedsLabel.insert(MI);
Devang Patel55e97172010-05-27 16:47:30 +00002656 // DBG_VALUE for inlined functions argument needs a label.
2657 else if (!DISubprogram(DV.getContext()).describes(MF->getFunction()))
2658 InsnNeedsLabel.insert(MI);
2659 // DBG_VALUE indicating argument location change needs a label.
Devang Patelb2b31a62010-05-26 19:37:24 +00002660 else if (!ProcessedArgs.insert(DV))
2661 InsnNeedsLabel.insert(MI);
2662 } else {
2663 // If location is unknown then instruction needs a location only if
2664 // UnknownLocations flag is set.
2665 if (DL.isUnknown()) {
2666 if (UnknownLocations && !PrevLoc.isUnknown())
2667 InsnNeedsLabel.insert(MI);
2668 } else if (DL != PrevLoc)
2669 // Otherwise, instruction needs a location only if it is new location.
2670 InsnNeedsLabel.insert(MI);
2671 }
2672
2673 if (!DL.isUnknown() || UnknownLocations)
2674 PrevLoc = DL;
2675 }
2676
2677 PrevLabel = FunctionBeginSym;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002678}
2679
Devang Patel2c4ceb12009-11-21 02:48:08 +00002680/// endFunction - Gather and emit post-function debug information.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002681///
Chris Lattnereec791a2010-01-26 23:18:02 +00002682void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendling5f017e82010-04-07 09:28:04 +00002683 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00002684
Devang Patel344130e2010-01-04 20:44:00 +00002685 if (CurrentFnDbgScope) {
Devang Patel65eb4822010-05-22 00:04:14 +00002686
Devang Patelc3f5f782010-05-25 23:40:22 +00002687 // Define end label for subprogram.
2688 FunctionEndSym = Asm->GetTempSymbol("func_end",
2689 Asm->getFunctionNumber());
2690 // Assumes in correct section after the entry point.
2691 Asm->OutStreamer.EmitLabel(FunctionEndSym);
2692
Devang Patel65eb4822010-05-22 00:04:14 +00002693 collectVariableInfo(MF);
2694
Devang Patel344130e2010-01-04 20:44:00 +00002695 // Get function line info.
2696 if (!Lines.empty()) {
2697 // Get section line info.
2698 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2699 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2700 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2701 // Append the function info to section info.
2702 SectionLineInfos.insert(SectionLineInfos.end(),
2703 Lines.begin(), Lines.end());
2704 }
2705
2706 // Construct abstract scopes.
2707 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
2708 AE = AbstractScopesList.end(); AI != AE; ++AI)
2709 constructScopeDIE(*AI);
2710
Devang Patel9c488372010-05-04 06:15:30 +00002711 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Devang Patel344130e2010-01-04 20:44:00 +00002712
Devang Patel9c488372010-05-04 06:15:30 +00002713 if (!DisableFramePointerElim(*MF))
2714 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
2715 dwarf::DW_FORM_flag, 1);
2716
2717
Chris Lattnerd38fee82010-04-05 00:13:49 +00002718 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel344130e2010-01-04 20:44:00 +00002719 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002720 }
2721
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002722 // Clear debug info
Devang Patelf54b8522010-01-19 01:26:02 +00002723 CurrentFnDbgScope = NULL;
Devang Patelb2b31a62010-05-26 19:37:24 +00002724 InsnNeedsLabel.clear();
Devang Patel26c1e562010-05-20 16:36:41 +00002725 DbgVariableToFrameIndexMap.clear();
2726 VarToAbstractVarMap.clear();
2727 DbgVariableToDbgInstMap.clear();
2728 DbgVariableLabelsMap.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002729 DeleteContainerSeconds(DbgScopeMap);
Devang Patel461a6462010-05-19 21:58:28 +00002730 InsnsBeginScopeSet.clear();
Devang Patel51424712010-04-09 16:04:20 +00002731 InsnsEndScopeSet.clear();
Devang Patelf54b8522010-01-19 01:26:02 +00002732 ConcreteScopes.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002733 DeleteContainerSeconds(AbstractScopes);
Devang Patelf54b8522010-01-19 01:26:02 +00002734 AbstractScopesList.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002735 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00002736 LabelsBeforeInsn.clear();
2737 LabelsAfterInsn.clear();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002738 Lines.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00002739 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002740}
2741
Devang Patel26c1e562010-05-20 16:36:41 +00002742/// recordVariableFrameIndex - Record a variable's index.
2743void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2744 assert (V && "Invalid DbgVariable!");
2745 DbgVariableToFrameIndexMap[V] = Index;
2746}
2747
2748/// findVariableFrameIndex - Return true if frame index for the variable
2749/// is found. Update FI to hold value of the index.
2750bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
2751 assert (V && "Invalid DbgVariable!");
2752 DenseMap<const DbgVariable *, int>::iterator I =
2753 DbgVariableToFrameIndexMap.find(V);
2754 if (I == DbgVariableToFrameIndexMap.end())
2755 return false;
2756 *FI = I->second;
2757 return true;
2758}
2759
2760/// findVariableLabel - Find MCSymbol for the variable.
2761const MCSymbol *DwarfDebug::findVariableLabel(const DbgVariable *V) {
2762 DenseMap<const DbgVariable *, const MCSymbol *>::iterator I
2763 = DbgVariableLabelsMap.find(V);
2764 if (I == DbgVariableLabelsMap.end())
2765 return NULL;
2766 else return I->second;
2767}
2768
Devang Patelee432862010-05-20 19:57:06 +00002769/// findDbgScope - Find DbgScope for the debug loc attached with an
2770/// instruction.
2771DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
2772 DbgScope *Scope = NULL;
2773 LLVMContext &Ctx =
2774 MInsn->getParent()->getParent()->getFunction()->getContext();
2775 DebugLoc DL = MInsn->getDebugLoc();
2776
2777 if (DL.isUnknown())
2778 return Scope;
2779
2780 if (const MDNode *IA = DL.getInlinedAt(Ctx))
2781 Scope = ConcreteScopes.lookup(IA);
2782 if (Scope == 0)
2783 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
2784
2785 return Scope;
2786}
2787
2788
Chris Lattnerc6087842010-03-09 04:54:43 +00002789/// recordSourceLine - Register a source line with debug info. Returns the
2790/// unique label that was emitted and which provides correspondence to
2791/// the source line list.
Devang Patele9f8f5e2010-05-07 20:54:48 +00002792MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S) {
Devang Patel65dbc902009-11-25 17:36:49 +00002793 StringRef Dir;
2794 StringRef Fn;
Devang Patelf84548d2009-10-05 18:03:19 +00002795
Dan Gohman1cc0d622010-05-05 23:41:32 +00002796 unsigned Src = 1;
2797 if (S) {
2798 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00002799
Dan Gohman1cc0d622010-05-05 23:41:32 +00002800 if (Scope.isCompileUnit()) {
2801 DICompileUnit CU(S);
2802 Dir = CU.getDirectory();
2803 Fn = CU.getFilename();
2804 } else if (Scope.isSubprogram()) {
2805 DISubprogram SP(S);
2806 Dir = SP.getDirectory();
2807 Fn = SP.getFilename();
2808 } else if (Scope.isLexicalBlock()) {
2809 DILexicalBlock DB(S);
2810 Dir = DB.getDirectory();
2811 Fn = DB.getFilename();
2812 } else
2813 assert(0 && "Unexpected scope info");
2814
2815 Src = GetOrCreateSourceID(Dir, Fn);
2816 }
2817
Stuart Hastings215aa152010-06-11 20:08:44 +00002818#if 0
2819 if (!Lines.empty()) {
2820 SrcLineInfo lastSrcLineInfo = Lines.back();
2821 // Emitting sequential line records with the same line number (but
2822 // different addresses) seems to confuse GDB. Avoid this.
2823 if (lastSrcLineInfo.getLine() == Line)
2824 return NULL;
2825 }
2826#endif
2827
Chris Lattner63d78362010-03-14 08:36:50 +00002828 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattner25b68c62010-03-14 08:15:55 +00002829 Lines.push_back(SrcLineInfo(Line, Col, Src, Label));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002830
Chris Lattnerc6087842010-03-09 04:54:43 +00002831 Asm->OutStreamer.EmitLabel(Label);
2832 return Label;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002833}
2834
Bill Wendling829e67b2009-05-20 23:22:40 +00002835//===----------------------------------------------------------------------===//
2836// Emit Methods
2837//===----------------------------------------------------------------------===//
2838
Devang Patel2c4ceb12009-11-21 02:48:08 +00002839/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling94d04b82009-05-20 23:21:38 +00002840///
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002841unsigned
2842DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002843 // Get the children.
2844 const std::vector<DIE *> &Children = Die->getChildren();
2845
2846 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00002847 if (!Last && !Children.empty())
Benjamin Kramer345ef342010-03-31 19:34:01 +00002848 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling94d04b82009-05-20 23:21:38 +00002849
2850 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002851 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00002852
2853 // Get the abbreviation for this DIE.
2854 unsigned AbbrevNumber = Die->getAbbrevNumber();
2855 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2856
2857 // Set DIE offset
2858 Die->setOffset(Offset);
2859
2860 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00002861 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00002862
2863 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2864 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2865
2866 // Size the DIE attribute values.
2867 for (unsigned i = 0, N = Values.size(); i < N; ++i)
2868 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00002869 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00002870
2871 // Size the DIE children if any.
2872 if (!Children.empty()) {
2873 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
2874 "Children flag not set");
2875
2876 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002877 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling94d04b82009-05-20 23:21:38 +00002878
2879 // End of children marker.
2880 Offset += sizeof(int8_t);
2881 }
2882
2883 Die->setSize(Offset - Die->getOffset());
2884 return Offset;
2885}
2886
Devang Patel2c4ceb12009-11-21 02:48:08 +00002887/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling94d04b82009-05-20 23:21:38 +00002888///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002889void DwarfDebug::computeSizeAndOffsets() {
Devang Patel163a9f72010-05-10 22:49:55 +00002890 unsigned PrevOffset = 0;
2891 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2892 E = CUMap.end(); I != E; ++I) {
2893 // Compute size of compile unit header.
2894 static unsigned Offset = PrevOffset +
2895 sizeof(int32_t) + // Length of Compilation Unit Info
2896 sizeof(int16_t) + // DWARF version number
2897 sizeof(int32_t) + // Offset Into Abbrev. Section
2898 sizeof(int8_t); // Pointer Size (in bytes)
2899 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
2900 PrevOffset = Offset;
2901 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002902}
2903
Chris Lattner11b8f302010-04-04 23:02:02 +00002904/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
2905/// temporary label to it if SymbolStem is specified.
Chris Lattner9c69e285532010-04-04 22:59:04 +00002906static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner11b8f302010-04-04 23:02:02 +00002907 const char *SymbolStem = 0) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00002908 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner11b8f302010-04-04 23:02:02 +00002909 if (!SymbolStem) return 0;
2910
Chris Lattner9c69e285532010-04-04 22:59:04 +00002911 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
2912 Asm->OutStreamer.EmitLabel(TmpSym);
2913 return TmpSym;
2914}
2915
2916/// EmitSectionLabels - Emit initial Dwarf sections with a label at
2917/// the start of each one.
Chris Lattnerfa070b02010-04-04 22:33:59 +00002918void DwarfDebug::EmitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002919 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002920
Bill Wendling94d04b82009-05-20 23:21:38 +00002921 // Dwarf sections base addresses.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002922 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00002923 DwarfFrameSectionSym =
2924 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
2925 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002926
Chris Lattner9c69e285532010-04-04 22:59:04 +00002927 DwarfInfoSectionSym =
2928 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
2929 DwarfAbbrevSectionSym =
2930 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner11b8f302010-04-04 23:02:02 +00002931 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Chris Lattner9c69e285532010-04-04 22:59:04 +00002932
2933 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner11b8f302010-04-04 23:02:02 +00002934 EmitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002935
Chris Lattner11b8f302010-04-04 23:02:02 +00002936 EmitSectionSym(Asm, TLOF.getDwarfLineSection());
2937 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
2938 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2939 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Chris Lattner9c69e285532010-04-04 22:59:04 +00002940 DwarfStrSectionSym =
2941 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patelf2548ca2010-04-16 23:33:45 +00002942 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
2943 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00002944
Devang Patelc3f5f782010-05-25 23:40:22 +00002945 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
2946 "section_debug_loc");
2947
Chris Lattner9c69e285532010-04-04 22:59:04 +00002948 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattner4ad1efe2010-04-04 23:10:38 +00002949 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002950}
2951
Devang Patel2c4ceb12009-11-21 02:48:08 +00002952/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling94d04b82009-05-20 23:21:38 +00002953///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002954void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002955 // Get the abbreviation for this DIE.
2956 unsigned AbbrevNumber = Die->getAbbrevNumber();
2957 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2958
Bill Wendling94d04b82009-05-20 23:21:38 +00002959 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00002960 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00002961 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2962 Twine::utohexstr(Die->getOffset()) + ":0x" +
2963 Twine::utohexstr(Die->getSize()) + " " +
2964 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002965 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00002966
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00002967 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling94d04b82009-05-20 23:21:38 +00002968 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2969
2970 // Emit the DIE attribute values.
2971 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2972 unsigned Attr = AbbrevData[i].getAttribute();
2973 unsigned Form = AbbrevData[i].getForm();
2974 assert(Form && "Too many attributes for DIE (check abbreviation)");
2975
Chris Lattner3f53c832010-04-04 18:52:31 +00002976 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00002977 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
2978
Bill Wendling94d04b82009-05-20 23:21:38 +00002979 switch (Attr) {
2980 case dwarf::DW_AT_sibling:
Devang Patel2c4ceb12009-11-21 02:48:08 +00002981 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00002982 break;
2983 case dwarf::DW_AT_abstract_origin: {
2984 DIEEntry *E = cast<DIEEntry>(Values[i]);
2985 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00002986 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00002987 Asm->EmitInt32(Addr);
2988 break;
2989 }
Devang Patelf2548ca2010-04-16 23:33:45 +00002990 case dwarf::DW_AT_ranges: {
2991 // DW_AT_range Value encodes offset in debug_range section.
2992 DIEInteger *V = cast<DIEInteger>(Values[i]);
2993 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
2994 V->getValue(),
2995 DwarfDebugRangeSectionSym,
2996 4);
2997 break;
2998 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002999 case dwarf::DW_AT_location: {
3000 if (UseDotDebugLocEntry.count(Die) != 0) {
3001 DIELabel *L = cast<DIELabel>(Values[i]);
3002 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
3003 } else
3004 Values[i]->EmitValue(Asm, Form);
3005 break;
3006 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003007 default:
3008 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003009 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00003010 break;
3011 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003012 }
3013
3014 // Emit the DIE children if any.
3015 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3016 const std::vector<DIE *> &Children = Die->getChildren();
3017
3018 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00003019 emitDIE(Children[j]);
Bill Wendling94d04b82009-05-20 23:21:38 +00003020
Chris Lattner3f53c832010-04-04 18:52:31 +00003021 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00003022 Asm->OutStreamer.AddComment("End Of Children Mark");
3023 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003024 }
3025}
3026
Devang Patel8a241142009-12-09 18:24:21 +00003027/// emitDebugInfo - Emit the debug info section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003028///
Devang Patel8a241142009-12-09 18:24:21 +00003029void DwarfDebug::emitDebugInfo() {
3030 // Start debug info section.
3031 Asm->OutStreamer.SwitchSection(
3032 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel163a9f72010-05-10 22:49:55 +00003033 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3034 E = CUMap.end(); I != E; ++I) {
3035 CompileUnit *TheCU = I->second;
3036 DIE *Die = TheCU->getCUDie();
3037
3038 // Emit the compile units header.
3039 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3040 TheCU->getID()));
3041
3042 // Emit size of content not including length itself
3043 unsigned ContentSize = Die->getSize() +
3044 sizeof(int16_t) + // DWARF version number
3045 sizeof(int32_t) + // Offset Into Abbrev. Section
3046 sizeof(int8_t) + // Pointer Size (in bytes)
3047 sizeof(int32_t); // FIXME - extra pad for gdb bug.
3048
3049 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3050 Asm->EmitInt32(ContentSize);
3051 Asm->OutStreamer.AddComment("DWARF version number");
3052 Asm->EmitInt16(dwarf::DWARF_VERSION);
3053 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3054 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3055 DwarfAbbrevSectionSym);
3056 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3057 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
3058
3059 emitDIE(Die);
3060 // FIXME - extra padding for gdb bug.
3061 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3062 Asm->EmitInt8(0);
3063 Asm->EmitInt8(0);
3064 Asm->EmitInt8(0);
3065 Asm->EmitInt8(0);
3066 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3067 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003068}
3069
Devang Patel2c4ceb12009-11-21 02:48:08 +00003070/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003071///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003072void DwarfDebug::emitAbbreviations() const {
Bill Wendling94d04b82009-05-20 23:21:38 +00003073 // Check to see if it is worth the effort.
3074 if (!Abbreviations.empty()) {
3075 // Start the debug abbrev section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003076 Asm->OutStreamer.SwitchSection(
3077 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003078
Chris Lattnerc0215722010-04-04 19:25:43 +00003079 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003080
3081 // For each abbrevation.
3082 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3083 // Get abbreviation data
3084 const DIEAbbrev *Abbrev = Abbreviations[i];
3085
3086 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003087 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00003088
3089 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003090 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00003091 }
3092
3093 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003094 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00003095
Chris Lattnerc0215722010-04-04 19:25:43 +00003096 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003097 }
3098}
3099
Devang Patel2c4ceb12009-11-21 02:48:08 +00003100/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling94d04b82009-05-20 23:21:38 +00003101/// the line matrix.
3102///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003103void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003104 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00003105 Asm->OutStreamer.AddComment("Extended Op");
3106 Asm->EmitInt8(0);
3107
3108 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003109 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003110 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3111 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3112
3113 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00003114
Chris Lattnerc0215722010-04-04 19:25:43 +00003115 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003116 Asm->getTargetData().getPointerSize(),
3117 0/*AddrSpace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003118
3119 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00003120 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3121 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00003122 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00003123 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003124}
3125
Devang Patel2c4ceb12009-11-21 02:48:08 +00003126/// emitDebugLines - Emit source line information.
Bill Wendling94d04b82009-05-20 23:21:38 +00003127///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003128void DwarfDebug::emitDebugLines() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003129 // If the target is using .loc/.file, the assembler will be emitting the
3130 // .debug_line table automatically.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003131 if (Asm->MAI->hasDotLocAndDotFile())
Bill Wendling94d04b82009-05-20 23:21:38 +00003132 return;
3133
3134 // Minimum line delta, thus ranging from -10..(255-10).
3135 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
3136 // Maximum line delta, thus ranging from -10..(255-10).
3137 const int MaxLineDelta = 255 + MinLineDelta;
3138
3139 // Start the dwarf line section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003140 Asm->OutStreamer.SwitchSection(
3141 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003142
3143 // Construct the section header.
Chris Lattner233f52b2010-03-09 23:52:58 +00003144 Asm->OutStreamer.AddComment("Length of Source Line Info");
Chris Lattnera6437182010-04-04 19:58:12 +00003145 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_end"),
3146 Asm->GetTempSymbol("line_begin"), 4);
Chris Lattnerc0215722010-04-04 19:25:43 +00003147 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003148
Chris Lattner233f52b2010-03-09 23:52:58 +00003149 Asm->OutStreamer.AddComment("DWARF version number");
3150 Asm->EmitInt16(dwarf::DWARF_VERSION);
Bill Wendling94d04b82009-05-20 23:21:38 +00003151
Chris Lattner233f52b2010-03-09 23:52:58 +00003152 Asm->OutStreamer.AddComment("Prolog Length");
Chris Lattnera6437182010-04-04 19:58:12 +00003153 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_prolog_end"),
3154 Asm->GetTempSymbol("line_prolog_begin"), 4);
Chris Lattnerc0215722010-04-04 19:25:43 +00003155 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003156
Chris Lattner233f52b2010-03-09 23:52:58 +00003157 Asm->OutStreamer.AddComment("Minimum Instruction Length");
3158 Asm->EmitInt8(1);
3159 Asm->OutStreamer.AddComment("Default is_stmt_start flag");
3160 Asm->EmitInt8(1);
3161 Asm->OutStreamer.AddComment("Line Base Value (Special Opcodes)");
3162 Asm->EmitInt8(MinLineDelta);
3163 Asm->OutStreamer.AddComment("Line Range Value (Special Opcodes)");
3164 Asm->EmitInt8(MaxLineDelta);
3165 Asm->OutStreamer.AddComment("Special Opcode Base");
3166 Asm->EmitInt8(-MinLineDelta);
Bill Wendling94d04b82009-05-20 23:21:38 +00003167
3168 // Line number standard opcode encodings argument count
Chris Lattner233f52b2010-03-09 23:52:58 +00003169 Asm->OutStreamer.AddComment("DW_LNS_copy arg count");
3170 Asm->EmitInt8(0);
3171 Asm->OutStreamer.AddComment("DW_LNS_advance_pc arg count");
3172 Asm->EmitInt8(1);
3173 Asm->OutStreamer.AddComment("DW_LNS_advance_line arg count");
3174 Asm->EmitInt8(1);
3175 Asm->OutStreamer.AddComment("DW_LNS_set_file arg count");
3176 Asm->EmitInt8(1);
3177 Asm->OutStreamer.AddComment("DW_LNS_set_column arg count");
3178 Asm->EmitInt8(1);
3179 Asm->OutStreamer.AddComment("DW_LNS_negate_stmt arg count");
3180 Asm->EmitInt8(0);
3181 Asm->OutStreamer.AddComment("DW_LNS_set_basic_block arg count");
3182 Asm->EmitInt8(0);
3183 Asm->OutStreamer.AddComment("DW_LNS_const_add_pc arg count");
3184 Asm->EmitInt8(0);
3185 Asm->OutStreamer.AddComment("DW_LNS_fixed_advance_pc arg count");
3186 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003187
3188 // Emit directories.
3189 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
Chris Lattner4cf202b2010-01-23 03:11:46 +00003190 const std::string &Dir = getSourceDirectoryName(DI);
Chris Lattner3f53c832010-04-04 18:52:31 +00003191 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Directory");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003192 Asm->OutStreamer.EmitBytes(StringRef(Dir.c_str(), Dir.size()+1), 0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003193 }
3194
Chris Lattner233f52b2010-03-09 23:52:58 +00003195 Asm->OutStreamer.AddComment("End of directories");
3196 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003197
3198 // Emit files.
3199 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
3200 // Remember source id starts at 1.
3201 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
Chris Lattner4cf202b2010-01-23 03:11:46 +00003202 const std::string &FN = getSourceFileName(Id.second);
Chris Lattner3f53c832010-04-04 18:52:31 +00003203 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Source");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003204 Asm->OutStreamer.EmitBytes(StringRef(FN.c_str(), FN.size()+1), 0);
3205
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003206 Asm->EmitULEB128(Id.first, "Directory #");
3207 Asm->EmitULEB128(0, "Mod date");
3208 Asm->EmitULEB128(0, "File size");
Bill Wendling94d04b82009-05-20 23:21:38 +00003209 }
3210
Chris Lattner233f52b2010-03-09 23:52:58 +00003211 Asm->OutStreamer.AddComment("End of files");
3212 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003213
Chris Lattnerc0215722010-04-04 19:25:43 +00003214 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003215
3216 // A sequence for each text section.
3217 unsigned SecSrcLinesSize = SectionSourceLines.size();
3218
3219 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
3220 // Isolate current sections line info.
3221 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
3222
Bill Wendling94d04b82009-05-20 23:21:38 +00003223 // Dwarf assumes we start with first line of first source file.
3224 unsigned Source = 1;
3225 unsigned Line = 1;
3226
3227 // Construct rows of the address, source, line, column matrix.
3228 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
3229 const SrcLineInfo &LineInfo = LineInfos[i];
Chris Lattner25b68c62010-03-14 08:15:55 +00003230 MCSymbol *Label = LineInfo.getLabel();
Chris Lattnerb9130602010-03-14 02:20:58 +00003231 if (!Label->isDefined()) continue; // Not emitted, in dead code.
Bill Wendling94d04b82009-05-20 23:21:38 +00003232
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003233 if (Asm->isVerbose()) {
Chris Lattner188a87d2010-03-10 01:04:13 +00003234 std::pair<unsigned, unsigned> SrcID =
Bill Wendling94d04b82009-05-20 23:21:38 +00003235 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner188a87d2010-03-10 01:04:13 +00003236 Asm->OutStreamer.AddComment(Twine(getSourceDirectoryName(SrcID.first)) +
Chris Lattner49f618a2010-03-10 02:29:31 +00003237 "/" +
3238 Twine(getSourceFileName(SrcID.second)) +
Chris Lattner188a87d2010-03-10 01:04:13 +00003239 ":" + Twine(LineInfo.getLine()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003240 }
3241
3242 // Define the line address.
Chris Lattner233f52b2010-03-09 23:52:58 +00003243 Asm->OutStreamer.AddComment("Extended Op");
3244 Asm->EmitInt8(0);
3245 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003246 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003247
3248 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3249 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3250
3251 Asm->OutStreamer.AddComment("Location label");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003252 Asm->OutStreamer.EmitSymbolValue(Label,
3253 Asm->getTargetData().getPointerSize(),
Chris Lattnerb9130602010-03-14 02:20:58 +00003254 0/*AddrSpace*/);
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00003255
Bill Wendling94d04b82009-05-20 23:21:38 +00003256 // If change of source, then switch to the new source.
3257 if (Source != LineInfo.getSourceID()) {
3258 Source = LineInfo.getSourceID();
Chris Lattner233f52b2010-03-09 23:52:58 +00003259 Asm->OutStreamer.AddComment("DW_LNS_set_file");
3260 Asm->EmitInt8(dwarf::DW_LNS_set_file);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003261 Asm->EmitULEB128(Source, "New Source");
Bill Wendling94d04b82009-05-20 23:21:38 +00003262 }
3263
3264 // If change of line.
3265 if (Line != LineInfo.getLine()) {
3266 // Determine offset.
3267 int Offset = LineInfo.getLine() - Line;
3268 int Delta = Offset - MinLineDelta;
3269
3270 // Update line.
3271 Line = LineInfo.getLine();
3272
3273 // If delta is small enough and in range...
3274 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
3275 // ... then use fast opcode.
Chris Lattner233f52b2010-03-09 23:52:58 +00003276 Asm->OutStreamer.AddComment("Line Delta");
3277 Asm->EmitInt8(Delta - MinLineDelta);
Bill Wendling94d04b82009-05-20 23:21:38 +00003278 } else {
3279 // ... otherwise use long hand.
Chris Lattner233f52b2010-03-09 23:52:58 +00003280 Asm->OutStreamer.AddComment("DW_LNS_advance_line");
Bill Wendling94d04b82009-05-20 23:21:38 +00003281 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003282 Asm->EmitSLEB128(Offset, "Line Offset");
Chris Lattner233f52b2010-03-09 23:52:58 +00003283 Asm->OutStreamer.AddComment("DW_LNS_copy");
3284 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling94d04b82009-05-20 23:21:38 +00003285 }
3286 } else {
3287 // Copy the previous row (different address or source)
Chris Lattner233f52b2010-03-09 23:52:58 +00003288 Asm->OutStreamer.AddComment("DW_LNS_copy");
3289 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling94d04b82009-05-20 23:21:38 +00003290 }
3291 }
3292
Devang Patel2c4ceb12009-11-21 02:48:08 +00003293 emitEndOfLineMatrix(j + 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003294 }
3295
3296 if (SecSrcLinesSize == 0)
3297 // Because we're emitting a debug_line section, we still need a line
3298 // table. The linker and friends expect it to exist. If there's nothing to
3299 // put into it, emit an empty table.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003300 emitEndOfLineMatrix(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003301
Chris Lattnerc0215722010-04-04 19:25:43 +00003302 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003303}
3304
Devang Patel2c4ceb12009-11-21 02:48:08 +00003305/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003306///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003307void DwarfDebug::emitCommonDebugFrame() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003308 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003309 return;
3310
Chris Lattnerd38fee82010-04-05 00:13:49 +00003311 int stackGrowth = Asm->getTargetData().getPointerSize();
3312 if (Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3313 TargetFrameInfo::StackGrowsDown)
3314 stackGrowth *= -1;
Bill Wendling94d04b82009-05-20 23:21:38 +00003315
3316 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003317 Asm->OutStreamer.SwitchSection(
3318 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003319
Chris Lattnerc0215722010-04-04 19:25:43 +00003320 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003321 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003322 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3323 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003324
Chris Lattnerc0215722010-04-04 19:25:43 +00003325 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003326 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling94d04b82009-05-20 23:21:38 +00003327 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner233f52b2010-03-09 23:52:58 +00003328 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling94d04b82009-05-20 23:21:38 +00003329 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner233f52b2010-03-09 23:52:58 +00003330 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003331 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003332 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3333 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner233f52b2010-03-09 23:52:58 +00003334 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003335 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling94d04b82009-05-20 23:21:38 +00003336 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling94d04b82009-05-20 23:21:38 +00003337
3338 std::vector<MachineMove> Moves;
3339 RI->getInitialFrameState(Moves);
3340
Chris Lattner02b86b92010-04-04 23:41:46 +00003341 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003342
Chris Lattner059ea132010-04-28 01:05:45 +00003343 Asm->EmitAlignment(2);
Chris Lattnerc0215722010-04-04 19:25:43 +00003344 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003345}
3346
Devang Patel2c4ceb12009-11-21 02:48:08 +00003347/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling94d04b82009-05-20 23:21:38 +00003348/// section.
Chris Lattner206d61e2010-03-13 07:26:18 +00003349void DwarfDebug::
3350emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003351 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003352 return;
3353
3354 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003355 Asm->OutStreamer.SwitchSection(
3356 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003357
Chris Lattner233f52b2010-03-09 23:52:58 +00003358 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner206d61e2010-03-13 07:26:18 +00003359 MCSymbol *DebugFrameBegin =
Chris Lattnerc0215722010-04-04 19:25:43 +00003360 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner206d61e2010-03-13 07:26:18 +00003361 MCSymbol *DebugFrameEnd =
Chris Lattnerc0215722010-04-04 19:25:43 +00003362 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnera6437182010-04-04 19:58:12 +00003363 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003364
Chris Lattner206d61e2010-03-13 07:26:18 +00003365 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling94d04b82009-05-20 23:21:38 +00003366
Chris Lattner233f52b2010-03-09 23:52:58 +00003367 Asm->OutStreamer.AddComment("FDE CIE offset");
Chris Lattner6189ed12010-04-04 23:25:33 +00003368 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
3369 DwarfFrameSectionSym);
Bill Wendling94d04b82009-05-20 23:21:38 +00003370
Chris Lattner233f52b2010-03-09 23:52:58 +00003371 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnerc0215722010-04-04 19:25:43 +00003372 MCSymbol *FuncBeginSym =
3373 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattnerfb658072010-03-13 07:40:56 +00003374 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattnerd38fee82010-04-05 00:13:49 +00003375 Asm->getTargetData().getPointerSize(),
3376 0/*AddrSpace*/);
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00003377
3378
Chris Lattner233f52b2010-03-09 23:52:58 +00003379 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnera6437182010-04-04 19:58:12 +00003380 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003381 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003382
Chris Lattner02b86b92010-04-04 23:41:46 +00003383 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003384
Chris Lattner059ea132010-04-28 01:05:45 +00003385 Asm->EmitAlignment(2);
Chris Lattner206d61e2010-03-13 07:26:18 +00003386 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling94d04b82009-05-20 23:21:38 +00003387}
3388
Devang Patel8a241142009-12-09 18:24:21 +00003389/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3390///
3391void DwarfDebug::emitDebugPubNames() {
Devang Patel163a9f72010-05-10 22:49:55 +00003392 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3393 E = CUMap.end(); I != E; ++I) {
3394 CompileUnit *TheCU = I->second;
3395 // Start the dwarf pubnames section.
3396 Asm->OutStreamer.SwitchSection(
3397 Asm->getObjFileLowering().getDwarfPubNamesSection());
Chris Lattner4cf202b2010-01-23 03:11:46 +00003398
Devang Patel163a9f72010-05-10 22:49:55 +00003399 Asm->OutStreamer.AddComment("Length of Public Names Info");
3400 Asm->EmitLabelDifference(
3401 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3402 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
3403
3404 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3405 TheCU->getID()));
3406
3407 Asm->OutStreamer.AddComment("DWARF Version");
3408 Asm->EmitInt16(dwarf::DWARF_VERSION);
3409
3410 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3411 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3412 DwarfInfoSectionSym);
3413
3414 Asm->OutStreamer.AddComment("Compilation Unit Length");
3415 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3416 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3417 4);
3418
3419 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3420 for (StringMap<DIE*>::const_iterator
3421 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3422 const char *Name = GI->getKeyData();
3423 DIE *Entity = GI->second;
3424
3425 Asm->OutStreamer.AddComment("DIE offset");
3426 Asm->EmitInt32(Entity->getOffset());
3427
3428 if (Asm->isVerbose())
3429 Asm->OutStreamer.AddComment("External Name");
3430 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3431 }
3432
3433 Asm->OutStreamer.AddComment("End Mark");
3434 Asm->EmitInt32(0);
3435 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3436 TheCU->getID()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003437 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003438}
3439
Devang Patel193f7202009-11-24 01:14:22 +00003440void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00003441 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3442 E = CUMap.end(); I != E; ++I) {
3443 CompileUnit *TheCU = I->second;
3444 // Start the dwarf pubnames section.
3445 Asm->OutStreamer.SwitchSection(
3446 Asm->getObjFileLowering().getDwarfPubTypesSection());
3447 Asm->OutStreamer.AddComment("Length of Public Types Info");
3448 Asm->EmitLabelDifference(
3449 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3450 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Chris Lattner4cf202b2010-01-23 03:11:46 +00003451
Devang Patel163a9f72010-05-10 22:49:55 +00003452 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3453 TheCU->getID()));
3454
3455 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3456 Asm->EmitInt16(dwarf::DWARF_VERSION);
3457
3458 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3459 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3460 DwarfInfoSectionSym);
3461
3462 Asm->OutStreamer.AddComment("Compilation Unit Length");
3463 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3464 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3465 4);
3466
3467 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3468 for (StringMap<DIE*>::const_iterator
3469 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3470 const char *Name = GI->getKeyData();
3471 DIE * Entity = GI->second;
3472
3473 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3474 Asm->EmitInt32(Entity->getOffset());
3475
3476 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3477 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3478 }
3479
3480 Asm->OutStreamer.AddComment("End Mark");
3481 Asm->EmitInt32(0);
3482 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3483 TheCU->getID()));
Devang Patel193f7202009-11-24 01:14:22 +00003484 }
Devang Patel193f7202009-11-24 01:14:22 +00003485}
3486
Devang Patel2c4ceb12009-11-21 02:48:08 +00003487/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003488///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003489void DwarfDebug::emitDebugStr() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003490 // Check to see if it is worth the effort.
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003491 if (StringPool.empty()) return;
3492
3493 // Start the dwarf str section.
3494 Asm->OutStreamer.SwitchSection(
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003495 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003496
Chris Lattnerbc733f52010-03-13 02:17:42 +00003497 // Get all of the string pool entries and put them in an array by their ID so
3498 // we can sort them.
3499 SmallVector<std::pair<unsigned,
3500 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
3501
3502 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3503 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3504 Entries.push_back(std::make_pair(I->second.second, &*I));
3505
3506 array_pod_sort(Entries.begin(), Entries.end());
3507
3508 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003509 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003510 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003511
3512 // Emit the string itself.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003513 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003514 }
3515}
3516
Devang Patel2c4ceb12009-11-21 02:48:08 +00003517/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003518///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003519void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00003520 if (DotDebugLocEntries.empty())
3521 return;
3522
Bill Wendling94d04b82009-05-20 23:21:38 +00003523 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003524 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00003525 Asm->getObjFileLowering().getDwarfLocSection());
3526 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00003527 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3528 unsigned index = 1;
Devang Patelc3f5f782010-05-25 23:40:22 +00003529 for (SmallVector<DotDebugLocEntry, 4>::iterator I = DotDebugLocEntries.begin(),
3530 E = DotDebugLocEntries.end(); I != E; ++I, ++index) {
3531 DotDebugLocEntry Entry = *I;
Devang Patelc3f5f782010-05-25 23:40:22 +00003532 if (Entry.isEmpty()) {
3533 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3534 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel80250682010-05-26 23:55:23 +00003535 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00003536 } else {
3537 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3538 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3539 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3540 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
3541 if (Reg < 32) {
3542 Asm->OutStreamer.AddComment("Loc expr size");
3543 Asm->EmitInt16(1);
3544 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3545 } else {
3546 Asm->OutStreamer.AddComment("Loc expr size");
3547 Asm->EmitInt16(1+MCAsmInfo::getULEB128Size(Reg));
3548 Asm->EmitInt8(dwarf::DW_OP_regx);
3549 Asm->EmitULEB128(Reg);
3550 }
3551 }
3552 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003553}
3554
3555/// EmitDebugARanges - Emit visible names into a debug aranges section.
3556///
3557void DwarfDebug::EmitDebugARanges() {
3558 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003559 Asm->OutStreamer.SwitchSection(
3560 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003561}
3562
Devang Patel2c4ceb12009-11-21 02:48:08 +00003563/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003564///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003565void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003566 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003567 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00003568 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Pateleac9c072010-04-27 19:46:33 +00003569 unsigned char Size = Asm->getTargetData().getPointerSize();
3570 for (SmallVector<const MCSymbol *, 8>::iterator
3571 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
3572 I != E; ++I) {
3573 if (*I)
3574 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003575 else
Devang Pateleac9c072010-04-27 19:46:33 +00003576 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003577 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003578}
3579
Devang Patel2c4ceb12009-11-21 02:48:08 +00003580/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003581///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003582void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003583 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00003584 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003585 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003586 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003587 }
3588}
3589
Devang Patel2c4ceb12009-11-21 02:48:08 +00003590/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling94d04b82009-05-20 23:21:38 +00003591/// Section Header:
3592/// 1. length of section
3593/// 2. Dwarf version number
3594/// 3. address size.
3595///
3596/// Entries (one "entry" for each function that was inlined):
3597///
3598/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3599/// otherwise offset into __debug_str for regular function name.
3600/// 2. offset into __debug_str section for regular function name.
3601/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3602/// instances for the function.
3603///
3604/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3605/// inlined instance; the die_offset points to the inlined_subroutine die in the
3606/// __debug_info section, and the low_pc is the starting address for the
3607/// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003608void DwarfDebug::emitDebugInlineInfo() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003609 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003610 return;
3611
Devang Patel163a9f72010-05-10 22:49:55 +00003612 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00003613 return;
3614
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003615 Asm->OutStreamer.SwitchSection(
3616 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00003617
Chris Lattner233f52b2010-03-09 23:52:58 +00003618 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003619 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3620 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003621
Chris Lattnerc0215722010-04-04 19:25:43 +00003622 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003623
Chris Lattner233f52b2010-03-09 23:52:58 +00003624 Asm->OutStreamer.AddComment("Dwarf Version");
3625 Asm->EmitInt16(dwarf::DWARF_VERSION);
3626 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003627 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003628
Devang Patele9f8f5e2010-05-07 20:54:48 +00003629 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00003630 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00003631
Devang Patele9f8f5e2010-05-07 20:54:48 +00003632 const MDNode *Node = *I;
3633 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach7ab38df2009-11-22 19:20:36 +00003634 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00003635 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00003636 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00003637 StringRef LName = SP.getLinkageName();
3638 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00003639
Chris Lattner233f52b2010-03-09 23:52:58 +00003640 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003641 if (LName.empty()) {
3642 Asm->OutStreamer.EmitBytes(Name, 0);
3643 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
3644 } else
Chris Lattner6189ed12010-04-04 23:25:33 +00003645 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3646 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00003647
Chris Lattner233f52b2010-03-09 23:52:58 +00003648 Asm->OutStreamer.AddComment("Function name");
Chris Lattner6189ed12010-04-04 23:25:33 +00003649 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003650 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00003651
Devang Patel53bb5c92009-11-10 23:06:00 +00003652 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00003653 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00003654 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00003655 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003656
Chris Lattner3f53c832010-04-04 18:52:31 +00003657 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003658 Asm->OutStreamer.EmitSymbolValue(LI->first,
3659 Asm->getTargetData().getPointerSize(),0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003660 }
3661 }
3662
Chris Lattnerc0215722010-04-04 19:25:43 +00003663 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003664}