blob: 231f63c1bc5dbda3f847db765b4da9394413cac8 [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);
Devang Patel163a9f72010-05-10 22:49:55 +0000869 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patelc366f832009-12-10 19:14:49 +0000870 ContextDIE->addChild(Die);
871 else
Devang Patel163a9f72010-05-10 22:49:55 +0000872 getCompileUnit(Context)->addDie(Die);
Devang Patelc366f832009-12-10 19:14:49 +0000873}
874
Devang Patel16ced732009-12-10 18:05:33 +0000875/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
876/// given DIType.
877DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel163a9f72010-05-10 22:49:55 +0000878 CompileUnit *TypeCU = getCompileUnit(Ty);
879 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patel16ced732009-12-10 18:05:33 +0000880 if (TyDIE)
881 return TyDIE;
882
883 // Create new type.
884 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel163a9f72010-05-10 22:49:55 +0000885 TypeCU->insertDIE(Ty, TyDIE);
Devang Patel16ced732009-12-10 18:05:33 +0000886 if (Ty.isBasicType())
Devang Patel2db49d72010-05-07 18:11:54 +0000887 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000888 else if (Ty.isCompositeType())
Devang Patel2db49d72010-05-07 18:11:54 +0000889 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000890 else {
891 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patel2db49d72010-05-07 18:11:54 +0000892 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000893 }
894
Devang Patelc366f832009-12-10 19:14:49 +0000895 addToContextOwner(TyDIE, Ty.getContext());
Devang Patel16ced732009-12-10 18:05:33 +0000896 return TyDIE;
897}
898
Devang Patel2c4ceb12009-11-21 02:48:08 +0000899/// addType - Add a new type attribute to the specified entity.
Devang Patel8a241142009-12-09 18:24:21 +0000900void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel9c004872010-05-07 21:45:47 +0000901 if (!Ty.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000902 return;
903
904 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +0000905 CompileUnit *TypeCU = getCompileUnit(Ty);
906 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000907 // If it exists then use the existing value.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000908 if (Entry) {
909 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000910 return;
911 }
912
Bill Wendling0310d762009-05-15 09:23:25 +0000913 // Construct type.
Devang Patel16ced732009-12-10 18:05:33 +0000914 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000915
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000916 // Set up proxy.
917 Entry = createDIEEntry(Buffer);
Devang Patel163a9f72010-05-10 22:49:55 +0000918 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000919
Devang Patel2c4ceb12009-11-21 02:48:08 +0000920 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000921}
922
Devang Patel2c4ceb12009-11-21 02:48:08 +0000923/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel8a241142009-12-09 18:24:21 +0000924void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000925 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000926 StringRef Name = BTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000927 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000928 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling0310d762009-05-15 09:23:25 +0000929 BTy.getEncoding());
930
931 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +0000932 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000933 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000934 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000935 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000936}
937
Devang Patel2c4ceb12009-11-21 02:48:08 +0000938/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel8a241142009-12-09 18:24:21 +0000939void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000940 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000941 StringRef Name = DTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000942 uint64_t Size = DTy.getSizeInBits() >> 3;
943 unsigned Tag = DTy.getTag();
944
945 // FIXME - Workaround for templates.
946 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
947
948 Buffer.setTag(Tag);
949
950 // Map to main type, void will not have a type.
951 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel8a241142009-12-09 18:24:21 +0000952 addType(&Buffer, FromTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000953
954 // Add name if not anonymous or intermediate type.
Devang Pateldeea5642009-11-30 23:56:56 +0000955 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000956 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000957
958 // Add size if non-zero (derived types might be zero-sized.)
959 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000960 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000961
962 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patel05f6fa82009-11-23 18:43:37 +0000963 if (!DTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000964 addSourceLine(&Buffer, &DTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000965}
966
Devang Patel2c4ceb12009-11-21 02:48:08 +0000967/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +0000968void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000969 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000970 StringRef Name = CTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000971
972 uint64_t Size = CTy.getSizeInBits() >> 3;
973 unsigned Tag = CTy.getTag();
974 Buffer.setTag(Tag);
975
976 switch (Tag) {
977 case dwarf::DW_TAG_vector_type:
978 case dwarf::DW_TAG_array_type:
Devang Patel8a241142009-12-09 18:24:21 +0000979 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000980 break;
981 case dwarf::DW_TAG_enumeration_type: {
982 DIArray Elements = CTy.getTypeArray();
983
984 // Add enumerators to enumeration type.
985 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
986 DIE *ElemDie = NULL;
Devang Patel2db49d72010-05-07 18:11:54 +0000987 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3c91b052010-03-08 20:52:55 +0000988 if (Enum.isEnumerator()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000989 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel2c4ceb12009-11-21 02:48:08 +0000990 Buffer.addChild(ElemDie);
Devang Patelc5254722009-10-09 17:51:49 +0000991 }
Bill Wendling0310d762009-05-15 09:23:25 +0000992 }
993 }
994 break;
995 case dwarf::DW_TAG_subroutine_type: {
996 // Add return type.
997 DIArray Elements = CTy.getTypeArray();
998 DIDescriptor RTy = Elements.getElement(0);
Devang Patel2db49d72010-05-07 18:11:54 +0000999 addType(&Buffer, DIType(RTy));
Bill Wendling0310d762009-05-15 09:23:25 +00001000
1001 // Add prototype flag.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001002 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001003
1004 // Add arguments.
1005 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1006 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1007 DIDescriptor Ty = Elements.getElement(i);
Devang Patel2db49d72010-05-07 18:11:54 +00001008 addType(Arg, DIType(Ty));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001009 Buffer.addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001010 }
1011 }
1012 break;
1013 case dwarf::DW_TAG_structure_type:
1014 case dwarf::DW_TAG_union_type:
1015 case dwarf::DW_TAG_class_type: {
1016 // Add elements to structure type.
1017 DIArray Elements = CTy.getTypeArray();
1018
1019 // A forward struct declared type may not have elements available.
Devang Patel3c91b052010-03-08 20:52:55 +00001020 unsigned N = Elements.getNumElements();
1021 if (N == 0)
Bill Wendling0310d762009-05-15 09:23:25 +00001022 break;
1023
1024 // Add elements to structure type.
Devang Patel3c91b052010-03-08 20:52:55 +00001025 for (unsigned i = 0; i < N; ++i) {
Bill Wendling0310d762009-05-15 09:23:25 +00001026 DIDescriptor Element = Elements.getElement(i);
1027 DIE *ElemDie = NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001028 if (Element.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001029 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patel3c91b052010-03-08 20:52:55 +00001030 else if (Element.isVariable()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001031 DIVariable DV(Element);
Devang Patel1ee0cb92010-01-30 01:08:30 +00001032 ElemDie = new DIE(dwarf::DW_TAG_variable);
1033 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1034 DV.getName());
1035 addType(ElemDie, DV.getType());
1036 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1037 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1038 addSourceLine(ElemDie, &DV);
Devang Patel3c91b052010-03-08 20:52:55 +00001039 } else if (Element.isDerivedType())
Devang Patel2db49d72010-05-07 18:11:54 +00001040 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3c91b052010-03-08 20:52:55 +00001041 else
1042 continue;
Devang Patel2c4ceb12009-11-21 02:48:08 +00001043 Buffer.addChild(ElemDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001044 }
1045
Devang Patela1ba2692009-08-27 23:51:51 +00001046 if (CTy.isAppleBlockExtension())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001047 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001048
1049 unsigned RLang = CTy.getRunTimeLang();
1050 if (RLang)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001051 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling0310d762009-05-15 09:23:25 +00001052 dwarf::DW_FORM_data1, RLang);
Devang Patelb5544992010-01-26 21:16:06 +00001053
1054 DICompositeType ContainingType = CTy.getContainingType();
Devang Patel2db49d72010-05-07 18:11:54 +00001055 if (DIDescriptor(ContainingType).isCompositeType())
Devang Patelb5544992010-01-26 21:16:06 +00001056 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patel2db49d72010-05-07 18:11:54 +00001057 getOrCreateTypeDIE(DIType(ContainingType)));
Bill Wendling0310d762009-05-15 09:23:25 +00001058 break;
1059 }
1060 default:
1061 break;
1062 }
1063
1064 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +00001065 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001066 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001067
Devang Patel8cbb6122010-01-29 18:34:58 +00001068 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type ||
Bill Wendling0310d762009-05-15 09:23:25 +00001069 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type) {
1070 // Add size if non-zero (derived types might be zero-sized.)
1071 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001072 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +00001073 else {
1074 // Add zero size if it is not a forward declaration.
1075 if (CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001076 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001077 else
Devang Patel2c4ceb12009-11-21 02:48:08 +00001078 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling0310d762009-05-15 09:23:25 +00001079 }
1080
1081 // Add source line info if available.
1082 if (!CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001083 addSourceLine(&Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001084 }
1085}
1086
Devang Patel2c4ceb12009-11-21 02:48:08 +00001087/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1088void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling0310d762009-05-15 09:23:25 +00001089 int64_t L = SR.getLo();
1090 int64_t H = SR.getHi();
1091 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1092
Devang Patel2c4ceb12009-11-21 02:48:08 +00001093 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patel6325a532009-08-14 20:59:16 +00001094 if (L)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001095 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Pateld55224c2009-12-04 23:10:24 +00001096 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling0310d762009-05-15 09:23:25 +00001097
Devang Patel2c4ceb12009-11-21 02:48:08 +00001098 Buffer.addChild(DW_Subrange);
Bill Wendling0310d762009-05-15 09:23:25 +00001099}
1100
Devang Patel2c4ceb12009-11-21 02:48:08 +00001101/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +00001102void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling0310d762009-05-15 09:23:25 +00001103 DICompositeType *CTy) {
1104 Buffer.setTag(dwarf::DW_TAG_array_type);
1105 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001106 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001107
1108 // Emit derived type.
Devang Patel8a241142009-12-09 18:24:21 +00001109 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001110 DIArray Elements = CTy->getTypeArray();
1111
Devang Patel6f01d9c2009-11-21 00:31:03 +00001112 // Get an anonymous type for index type.
Devang Patel163a9f72010-05-10 22:49:55 +00001113 CompileUnit *TheCU = getCompileUnit(*CTy);
1114 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel6f01d9c2009-11-21 00:31:03 +00001115 if (!IdxTy) {
1116 // Construct an anonymous type for index type.
1117 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001118 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1119 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel6f01d9c2009-11-21 00:31:03 +00001120 dwarf::DW_ATE_signed);
Devang Patel163a9f72010-05-10 22:49:55 +00001121 TheCU->addDie(IdxTy);
1122 TheCU->setIndexTyDie(IdxTy);
Devang Patel6f01d9c2009-11-21 00:31:03 +00001123 }
Bill Wendling0310d762009-05-15 09:23:25 +00001124
1125 // Add subranges to array type.
1126 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1127 DIDescriptor Element = Elements.getElement(i);
1128 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patel2db49d72010-05-07 18:11:54 +00001129 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001130 }
1131}
1132
Devang Patel2c4ceb12009-11-21 02:48:08 +00001133/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3c91b052010-03-08 20:52:55 +00001134DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001135 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3c91b052010-03-08 20:52:55 +00001136 StringRef Name = ETy.getName();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001137 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3c91b052010-03-08 20:52:55 +00001138 int64_t Value = ETy.getEnumValue();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001139 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling0310d762009-05-15 09:23:25 +00001140 return Enumerator;
1141}
1142
Devang Patel351ca332010-01-05 01:46:14 +00001143/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
1144/// printer to not emit usual symbol prefix before the symbol name is used then
1145/// return linkage name after skipping this special LLVM prefix.
1146static StringRef getRealLinkageName(StringRef LinkageName) {
1147 char One = '\1';
1148 if (LinkageName.startswith(StringRef(&One, 1)))
1149 return LinkageName.substr(1);
1150 return LinkageName;
1151}
1152
Devang Patel2c4ceb12009-11-21 02:48:08 +00001153/// createGlobalVariableDIE - Create new DIE using GV.
Devang Patel8a241142009-12-09 18:24:21 +00001154DIE *DwarfDebug::createGlobalVariableDIE(const DIGlobalVariable &GV) {
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001155 // If the global variable was optmized out then no need to create debug info
1156 // entry.
Devang Patel84c73e92009-11-06 17:58:12 +00001157 if (!GV.getGlobal()) return NULL;
Devang Patel65dbc902009-11-25 17:36:49 +00001158 if (GV.getDisplayName().empty()) return NULL;
Devang Patel465c3be2009-11-06 01:30:04 +00001159
Bill Wendling0310d762009-05-15 09:23:25 +00001160 DIE *GVDie = new DIE(dwarf::DW_TAG_variable);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001161 addString(GVDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001162 GV.getDisplayName());
1163
Devang Patel65dbc902009-11-25 17:36:49 +00001164 StringRef LinkageName = GV.getLinkageName();
Devang Patel351ca332010-01-05 01:46:14 +00001165 if (!LinkageName.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001166 addString(GVDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel351ca332010-01-05 01:46:14 +00001167 getRealLinkageName(LinkageName));
1168
Devang Patel8a241142009-12-09 18:24:21 +00001169 addType(GVDie, GV.getType());
Bill Wendling0310d762009-05-15 09:23:25 +00001170 if (!GV.isLocalToUnit())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001171 addUInt(GVDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1172 addSourceLine(GVDie, &GV);
Devang Patelb71a16d2009-10-05 23:22:08 +00001173
Bill Wendling0310d762009-05-15 09:23:25 +00001174 return GVDie;
1175}
1176
Devang Patel2c4ceb12009-11-21 02:48:08 +00001177/// createMemberDIE - Create new member DIE.
Devang Patel8a241142009-12-09 18:24:21 +00001178DIE *DwarfDebug::createMemberDIE(const DIDerivedType &DT) {
Bill Wendling0310d762009-05-15 09:23:25 +00001179 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel65dbc902009-11-25 17:36:49 +00001180 StringRef Name = DT.getName();
1181 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001182 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel65dbc902009-11-25 17:36:49 +00001183
Devang Patel8a241142009-12-09 18:24:21 +00001184 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001185
Devang Patel2c4ceb12009-11-21 02:48:08 +00001186 addSourceLine(MemberDie, &DT);
Bill Wendling0310d762009-05-15 09:23:25 +00001187
Benjamin Kramer345ef342010-03-31 19:34:01 +00001188 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001189 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel33db5082009-11-04 22:06:12 +00001190
Bill Wendling0310d762009-05-15 09:23:25 +00001191 uint64_t Size = DT.getSizeInBits();
Devang Patel61ecbd12009-11-04 23:48:00 +00001192 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling0310d762009-05-15 09:23:25 +00001193
1194 if (Size != FieldSize) {
1195 // Handle bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001196 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1197 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling0310d762009-05-15 09:23:25 +00001198
1199 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling0310d762009-05-15 09:23:25 +00001200 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1201 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer3d594fd2010-01-07 17:50:57 +00001202 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling0310d762009-05-15 09:23:25 +00001203 Offset -= FieldOffset;
1204
1205 // Maybe we need to work from the other end.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001206 if (Asm->getTargetData().isLittleEndian())
1207 Offset = FieldSize - (Offset + Size);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001208 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling0310d762009-05-15 09:23:25 +00001209
Devang Patel33db5082009-11-04 22:06:12 +00001210 // Here WD_AT_data_member_location points to the anonymous
1211 // field that includes this bit field.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001212 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001213
1214 } else
1215 // This is not a bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001216 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001217
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001218 if (DT.getTag() == dwarf::DW_TAG_inheritance
1219 && DT.isVirtual()) {
1220
1221 // For C++, virtual base classes are not at fixed offset. Use following
1222 // expression to extract appropriate offset from vtable.
1223 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1224
Benjamin Kramer345ef342010-03-31 19:34:01 +00001225 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001226 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1227 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1228 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1229 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1230 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1231 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1232 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1233
1234 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
1235 VBaseLocationDie);
1236 } else
1237 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001238
1239 if (DT.isProtected())
Devang Patel5d11eb02009-12-03 19:11:07 +00001240 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001241 dwarf::DW_ACCESS_protected);
1242 else if (DT.isPrivate())
Devang Patel5d11eb02009-12-03 19:11:07 +00001243 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001244 dwarf::DW_ACCESS_private);
Devang Patel5d11eb02009-12-03 19:11:07 +00001245 else if (DT.getTag() == dwarf::DW_TAG_inheritance)
1246 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1247 dwarf::DW_ACCESS_public);
1248 if (DT.isVirtual())
1249 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1250 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling0310d762009-05-15 09:23:25 +00001251 return MemberDie;
1252}
1253
Devang Patelffe966c2009-12-14 16:18:45 +00001254/// createSubprogramDIE - Create new DIE using SP.
1255DIE *DwarfDebug::createSubprogramDIE(const DISubprogram &SP, bool MakeDecl) {
Devang Patel163a9f72010-05-10 22:49:55 +00001256 CompileUnit *SPCU = getCompileUnit(SP);
1257 DIE *SPDie = SPCU->getDIE(SP);
Devang Patelffe966c2009-12-14 16:18:45 +00001258 if (SPDie)
1259 return SPDie;
1260
1261 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel1eac3e72010-03-02 17:58:15 +00001262 // Constructors and operators for anonymous aggregates do not have names.
Devang Patel6b506cb2010-03-02 01:26:20 +00001263 if (!SP.getName().empty())
1264 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling0310d762009-05-15 09:23:25 +00001265
Devang Patel65dbc902009-11-25 17:36:49 +00001266 StringRef LinkageName = SP.getLinkageName();
Devang Patel351ca332010-01-05 01:46:14 +00001267 if (!LinkageName.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001268 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel351ca332010-01-05 01:46:14 +00001269 getRealLinkageName(LinkageName));
1270
Devang Patel2c4ceb12009-11-21 02:48:08 +00001271 addSourceLine(SPDie, &SP);
Bill Wendling0310d762009-05-15 09:23:25 +00001272
Bill Wendling0310d762009-05-15 09:23:25 +00001273 // Add prototyped tag, if C or ObjC.
1274 unsigned Lang = SP.getCompileUnit().getLanguage();
1275 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1276 Lang == dwarf::DW_LANG_ObjC)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001277 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001278
1279 // Add Return Type.
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001280 DICompositeType SPTy = SP.getType();
1281 DIArray Args = SPTy.getTypeArray();
Bill Wendling0310d762009-05-15 09:23:25 +00001282 unsigned SPTag = SPTy.getTag();
Devang Patel5d11eb02009-12-03 19:11:07 +00001283
Devang Patel3c91b052010-03-08 20:52:55 +00001284 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel8a241142009-12-09 18:24:21 +00001285 addType(SPDie, SPTy);
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001286 else
Devang Patel2db49d72010-05-07 18:11:54 +00001287 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001288
Devang Patel5d11eb02009-12-03 19:11:07 +00001289 unsigned VK = SP.getVirtuality();
1290 if (VK) {
1291 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer345ef342010-03-31 19:34:01 +00001292 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel5d11eb02009-12-03 19:11:07 +00001293 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1294 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1295 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Devang Patel622b0262010-01-19 06:19:05 +00001296 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patel2db49d72010-05-07 18:11:54 +00001297 SP.getContainingType()));
Devang Patel5d11eb02009-12-03 19:11:07 +00001298 }
1299
Devang Patelffe966c2009-12-14 16:18:45 +00001300 if (MakeDecl || !SP.isDefinition()) {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001301 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001302
1303 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001304 // be handled while processing variables.
1305 DICompositeType SPTy = SP.getType();
1306 DIArray Args = SPTy.getTypeArray();
1307 unsigned SPTag = SPTy.getTag();
1308
Bill Wendling0310d762009-05-15 09:23:25 +00001309 if (SPTag == dwarf::DW_TAG_subroutine_type)
1310 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1311 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001312 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patelb4645642010-02-06 01:02:37 +00001313 addType(Arg, ATy);
1314 if (ATy.isArtificial())
1315 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001316 SPDie->addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001317 }
1318 }
1319
Devang Patel4e0d19d2010-02-03 19:57:19 +00001320 if (SP.isArtificial())
1321 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1322
Devang Patelccff8122010-04-30 19:38:23 +00001323 if (!SP.isLocalToUnit())
1324 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patel2a4a3b72010-04-19 19:14:02 +00001325
Devang Patelccff8122010-04-30 19:38:23 +00001326 if (SP.isOptimized())
1327 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1328
Devang Patelccff8122010-04-30 19:38:23 +00001329 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel163a9f72010-05-10 22:49:55 +00001330 SPCU->insertDIE(SP, SPDie);
Devang Patelccff8122010-04-30 19:38:23 +00001331
Bill Wendling0310d762009-05-15 09:23:25 +00001332 return SPDie;
1333}
1334
Devang Patele9f8f5e2010-05-07 20:54:48 +00001335DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattnered7a77b2010-03-31 05:36:29 +00001336 assert(N && "Invalid Scope encoding!");
Devang Patel53bb5c92009-11-10 23:06:00 +00001337
1338 DbgScope *AScope = AbstractScopes.lookup(N);
1339 if (AScope)
1340 return AScope;
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001341
Devang Patel53bb5c92009-11-10 23:06:00 +00001342 DbgScope *Parent = NULL;
1343
1344 DIDescriptor Scope(N);
1345 if (Scope.isLexicalBlock()) {
1346 DILexicalBlock DB(N);
1347 DIDescriptor ParentDesc = DB.getContext();
Devang Patel2db49d72010-05-07 18:11:54 +00001348 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patel53bb5c92009-11-10 23:06:00 +00001349 }
1350
1351 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1352
1353 if (Parent)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001354 Parent->addScope(AScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001355 AScope->setAbstractScope();
1356 AbstractScopes[N] = AScope;
1357 if (DIDescriptor(N).isSubprogram())
1358 AbstractScopesList.push_back(AScope);
1359 return AScope;
1360}
Devang Patelaf9e8472009-10-01 20:31:14 +00001361
Devang Patel5f094002010-04-06 23:53:48 +00001362/// isSubprogramContext - Return true if Context is either a subprogram
1363/// or another context nested inside a subprogram.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001364static bool isSubprogramContext(const MDNode *Context) {
Devang Patel5f094002010-04-06 23:53:48 +00001365 if (!Context)
1366 return false;
1367 DIDescriptor D(Context);
1368 if (D.isSubprogram())
1369 return true;
1370 if (D.isType())
Devang Patel2db49d72010-05-07 18:11:54 +00001371 return isSubprogramContext(DIType(Context).getContext());
Devang Patel5f094002010-04-06 23:53:48 +00001372 return false;
1373}
1374
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001375/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel2c4ceb12009-11-21 02:48:08 +00001376/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1377/// If there are global variables in this scope then create and insert
1378/// DIEs for these variables.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001379DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel163a9f72010-05-10 22:49:55 +00001380 CompileUnit *SPCU = getCompileUnit(SPNode);
1381 DIE *SPDie = SPCU->getDIE(SPNode);
Chris Lattnerd38fee82010-04-05 00:13:49 +00001382 assert(SPDie && "Unable to find subprogram DIE!");
1383 DISubprogram SP(SPNode);
Chris Lattner206d61e2010-03-13 07:26:18 +00001384
Chris Lattnerd38fee82010-04-05 00:13:49 +00001385 // There is not any need to generate specification DIE for a function
1386 // defined at compile unit level. If a function is defined inside another
1387 // function then gdb prefers the definition at top level and but does not
1388 // expect specification DIE in parent function. So avoid creating
1389 // specification DIE for a function defined inside a function.
1390 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Devang Patel5f094002010-04-06 23:53:48 +00001391 !SP.getContext().isFile() &&
Devang Patel2db49d72010-05-07 18:11:54 +00001392 !isSubprogramContext(SP.getContext())) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00001393 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1394
1395 // Add arguments.
1396 DICompositeType SPTy = SP.getType();
1397 DIArray Args = SPTy.getTypeArray();
1398 unsigned SPTag = SPTy.getTag();
1399 if (SPTag == dwarf::DW_TAG_subroutine_type)
1400 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1401 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001402 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattnerd38fee82010-04-05 00:13:49 +00001403 addType(Arg, ATy);
1404 if (ATy.isArtificial())
1405 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1406 SPDie->addChild(Arg);
1407 }
1408 DIE *SPDeclDie = SPDie;
1409 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1410 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
1411 SPDeclDie);
Devang Patel163a9f72010-05-10 22:49:55 +00001412 SPCU->addDie(SPDie);
Chris Lattnerd38fee82010-04-05 00:13:49 +00001413 }
1414
1415 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1416 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1417 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1418 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1419 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1420 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1421 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +00001422
Chris Lattnerd38fee82010-04-05 00:13:49 +00001423 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +00001424}
1425
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001426/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel2c4ceb12009-11-21 02:48:08 +00001427/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1428DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001429
1430 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1431 if (Scope->isAbstractScope())
1432 return ScopeDIE;
1433
1434 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1435 if (Ranges.empty())
1436 return 0;
1437
1438 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1439 if (Ranges.size() > 1) {
1440 // .debug_range section has not been laid out yet. Emit offset in
1441 // .debug_range as a uint, size 4, for now. emitDIE will handle
1442 // DW_AT_ranges appropriately.
1443 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1444 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1445 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1446 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +00001447 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1448 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +00001449 }
1450 DebugRangeSymbols.push_back(NULL);
1451 DebugRangeSymbols.push_back(NULL);
1452 return ScopeDIE;
1453 }
1454
Devang Patelc3f5f782010-05-25 23:40:22 +00001455 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1456 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001457
Devang Patelc3f5f782010-05-25 23:40:22 +00001458 if (End == 0) return 0;
Devang Patel53bb5c92009-11-10 23:06:00 +00001459
Chris Lattnerb7db7332010-03-09 01:58:53 +00001460 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1461 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Chris Lattnera34ec2292010-03-09 01:51:43 +00001462
Devang Pateleac9c072010-04-27 19:46:33 +00001463 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1464 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patel53bb5c92009-11-10 23:06:00 +00001465
1466 return ScopeDIE;
1467}
1468
Devang Patel2c4ceb12009-11-21 02:48:08 +00001469/// constructInlinedScopeDIE - This scope represents inlined body of
1470/// a function. Construct DIE to represent this concrete inlined copy
1471/// of the function.
1472DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001473
1474 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1475 assert (Ranges.empty() == false
1476 && "DbgScope does not have instruction markers!");
1477
1478 // FIXME : .debug_inlined section specification does not clearly state how
1479 // to emit inlined scope that is split into multiple instruction ranges.
1480 // For now, use first instruction range and emit low_pc/high_pc pair and
1481 // corresponding .debug_inlined section entry for this pair.
1482 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patelc3f5f782010-05-25 23:40:22 +00001483 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1484 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001485
Devang Patelc3f5f782010-05-25 23:40:22 +00001486 if (StartLabel == FunctionBeginSym || EndLabel == 0) {
Devang Pateleac9c072010-04-27 19:46:33 +00001487 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1488 return 0;
1489 }
Chris Lattnerb7db7332010-03-09 01:58:53 +00001490 assert(StartLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001491 "Invalid starting label for an inlined scope!");
Chris Lattnerb7db7332010-03-09 01:58:53 +00001492 assert(EndLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001493 "Invalid end label for an inlined scope!");
Devang Pateleac9c072010-04-27 19:46:33 +00001494
Devang Patel3c91b052010-03-08 20:52:55 +00001495 if (!Scope->getScopeNode())
Devang Patel0ef3fa62010-03-08 19:20:38 +00001496 return NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001497 DIScope DS(Scope->getScopeNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00001498 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1499
Devang Patel2db49d72010-05-07 18:11:54 +00001500 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel163a9f72010-05-10 22:49:55 +00001501 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1502 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001503 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel2c4ceb12009-11-21 02:48:08 +00001504 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001505 dwarf::DW_FORM_ref4, OriginDIE);
1506
Chris Lattner6ed0f902010-03-09 00:31:02 +00001507 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnerb7db7332010-03-09 01:58:53 +00001508 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patel53bb5c92009-11-10 23:06:00 +00001509
1510 InlinedSubprogramDIEs.insert(OriginDIE);
1511
1512 // Track the start label for this inlined function.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001513 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patel2db49d72010-05-07 18:11:54 +00001514 I = InlineInfo.find(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001515
1516 if (I == InlineInfo.end()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001517 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001518 ScopeDIE));
Devang Patel2db49d72010-05-07 18:11:54 +00001519 InlinedSPNodes.push_back(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001520 } else
Chris Lattner6ed0f902010-03-09 00:31:02 +00001521 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patel53bb5c92009-11-10 23:06:00 +00001522
Devang Patel53bb5c92009-11-10 23:06:00 +00001523 DILocation DL(Scope->getInlinedAt());
Devang Patel163a9f72010-05-10 22:49:55 +00001524 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001525 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +00001526
1527 return ScopeDIE;
1528}
1529
Devang Patel2c4ceb12009-11-21 02:48:08 +00001530
1531/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel8a241142009-12-09 18:24:21 +00001532DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001533 // Get the descriptor.
1534 const DIVariable &VD = DV->getVariable();
Devang Patel65dbc902009-11-25 17:36:49 +00001535 StringRef Name = VD.getName();
1536 if (Name.empty())
Devang Patel3fb6bd62009-11-13 02:25:26 +00001537 return NULL;
Devang Patel53bb5c92009-11-10 23:06:00 +00001538
1539 // Translate tag to proper Dwarf tag. The result variable is dropped for
1540 // now.
1541 unsigned Tag;
1542 switch (VD.getTag()) {
1543 case dwarf::DW_TAG_return_variable:
1544 return NULL;
1545 case dwarf::DW_TAG_arg_variable:
1546 Tag = dwarf::DW_TAG_formal_parameter;
1547 break;
1548 case dwarf::DW_TAG_auto_variable: // fall thru
1549 default:
1550 Tag = dwarf::DW_TAG_variable;
1551 break;
1552 }
1553
1554 // Define variable debug information entry.
1555 DIE *VariableDie = new DIE(Tag);
1556
Devang Patel53bb5c92009-11-10 23:06:00 +00001557 DIE *AbsDIE = NULL;
Devang Patel26c1e562010-05-20 16:36:41 +00001558 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1559 V2AVI = VarToAbstractVarMap.find(DV);
1560 if (V2AVI != VarToAbstractVarMap.end())
1561 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001562
Devang Patel26c1e562010-05-20 16:36:41 +00001563 if (AbsDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001564 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001565 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001566 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001567 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
1568 addSourceLine(VariableDie, &VD);
Devang Patel53bb5c92009-11-10 23:06:00 +00001569
1570 // Add variable type.
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001571 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
Devang Patel53bb5c92009-11-10 23:06:00 +00001572 // addresses instead.
1573 if (VD.isBlockByrefVariable())
Devang Patel8a241142009-12-09 18:24:21 +00001574 addType(VariableDie, getBlockByrefType(VD.getType(), Name));
Devang Patel53bb5c92009-11-10 23:06:00 +00001575 else
Devang Patel8a241142009-12-09 18:24:21 +00001576 addType(VariableDie, VD.getType());
Devang Patel53bb5c92009-11-10 23:06:00 +00001577 }
1578
Devang Patelb4645642010-02-06 01:02:37 +00001579 if (Tag == dwarf::DW_TAG_formal_parameter && VD.getType().isArtificial())
1580 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelc3f5f782010-05-25 23:40:22 +00001581
1582 if (Scope->isAbstractScope()) {
1583 DV->setDIE(VariableDie);
1584 return VariableDie;
1585 }
1586
1587 // Add variable address.
1588
1589 unsigned Offset = DV->getDotDebugLocOffset();
1590 if (Offset != ~0U) {
1591 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1592 Asm->GetTempSymbol("debug_loc", Offset));
1593 DV->setDIE(VariableDie);
1594 UseDotDebugLocEntry.insert(VariableDie);
1595 return VariableDie;
1596 }
1597
1598 // Check if variable is described by a DBG_VALUE instruction.
1599 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1600 DbgVariableToDbgInstMap.find(DV);
1601 if (DVI != DbgVariableToDbgInstMap.end()) {
1602 const MachineInstr *DVInsn = DVI->second;
1603 const MCSymbol *DVLabel = findVariableLabel(DV);
1604 bool updated = false;
1605 // FIXME : Handle getNumOperands != 3
1606 if (DVInsn->getNumOperands() == 3) {
1607 if (DVInsn->getOperand(0).isReg())
1608 updated = addRegisterAddress(VariableDie, DVLabel, DVInsn->getOperand(0));
1609 else if (DVInsn->getOperand(0).isImm())
1610 updated = addConstantValue(VariableDie, DVLabel, DVInsn->getOperand(0));
1611 else if (DVInsn->getOperand(0).isFPImm())
1612 updated = addConstantFPValue(VariableDie, DVLabel, DVInsn->getOperand(0));
1613 } else {
1614 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1615 if (Location.getReg()) {
1616 addAddress(VariableDie, dwarf::DW_AT_location, Location);
1617 if (DVLabel)
1618 addLabel(VariableDie, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr,
1619 DVLabel);
1620 updated = true;
1621 }
1622 }
1623 if (!updated) {
1624 // If variableDie is not updated then DBG_VALUE instruction does not
1625 // have valid variable info.
1626 delete VariableDie;
1627 return NULL;
1628 }
1629 DV->setDIE(VariableDie);
1630 return VariableDie;
1631 }
1632
1633 // .. else use frame index, if available.
1634 MachineLocation Location;
1635 unsigned FrameReg;
1636 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1637 int FI = 0;
1638 if (findVariableFrameIndex(DV, &FI)) {
1639 int Offset = RI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
1640 Location.set(FrameReg, Offset);
1641
1642 if (VD.hasComplexAddress())
1643 addComplexAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
1644 else if (VD.isBlockByrefVariable())
1645 addBlockByrefAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
1646 else
1647 addAddress(VariableDie, dwarf::DW_AT_location, Location);
1648 }
Devang Patel53bb5c92009-11-10 23:06:00 +00001649 DV->setDIE(VariableDie);
1650 return VariableDie;
1651
1652}
Devang Patel2c4ceb12009-11-21 02:48:08 +00001653
Devang Patel193f7202009-11-24 01:14:22 +00001654void DwarfDebug::addPubTypes(DISubprogram SP) {
1655 DICompositeType SPTy = SP.getType();
1656 unsigned SPTag = SPTy.getTag();
1657 if (SPTag != dwarf::DW_TAG_subroutine_type)
1658 return;
1659
1660 DIArray Args = SPTy.getTypeArray();
Devang Patel193f7202009-11-24 01:14:22 +00001661 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patel2db49d72010-05-07 18:11:54 +00001662 DIType ATy(Args.getElement(i));
Devang Patel9c004872010-05-07 21:45:47 +00001663 if (!ATy.Verify())
Devang Patel193f7202009-11-24 01:14:22 +00001664 continue;
1665 DICompositeType CATy = getDICompositeType(ATy);
Devang Patel2db49d72010-05-07 18:11:54 +00001666 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel50d80e32010-04-13 20:35:04 +00001667 && !CATy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001668 CompileUnit *TheCU = getCompileUnit(CATy);
1669 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1670 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001671 }
1672 }
1673}
1674
Devang Patel2c4ceb12009-11-21 02:48:08 +00001675/// constructScopeDIE - Construct a DIE for this scope.
1676DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3c91b052010-03-08 20:52:55 +00001677 if (!Scope || !Scope->getScopeNode())
1678 return NULL;
1679
1680 DIScope DS(Scope->getScopeNode());
1681 DIE *ScopeDIE = NULL;
1682 if (Scope->getInlinedAt())
1683 ScopeDIE = constructInlinedScopeDIE(Scope);
1684 else if (DS.isSubprogram()) {
1685 if (Scope->isAbstractScope())
Devang Patel163a9f72010-05-10 22:49:55 +00001686 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patel3c91b052010-03-08 20:52:55 +00001687 else
Devang Patel2db49d72010-05-07 18:11:54 +00001688 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3c91b052010-03-08 20:52:55 +00001689 }
Devang Patelaead63c2010-03-29 22:59:58 +00001690 else
Devang Patel3c91b052010-03-08 20:52:55 +00001691 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patelaead63c2010-03-29 22:59:58 +00001692 if (!ScopeDIE) return NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001693
Devang Patel53bb5c92009-11-10 23:06:00 +00001694 // Add variables to scope.
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001695 const SmallVector<DbgVariable *, 8> &Variables = Scope->getVariables();
Devang Patel53bb5c92009-11-10 23:06:00 +00001696 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel8a241142009-12-09 18:24:21 +00001697 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001698 if (VariableDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001699 ScopeDIE->addChild(VariableDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001700 }
1701
1702 // Add nested scopes.
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001703 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
Devang Patel53bb5c92009-11-10 23:06:00 +00001704 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1705 // Define the Scope debug information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001706 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001707 if (NestedDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001708 ScopeDIE->addChild(NestedDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001709 }
Devang Patel193f7202009-11-24 01:14:22 +00001710
1711 if (DS.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001712 addPubTypes(DISubprogram(DS));
Devang Patel193f7202009-11-24 01:14:22 +00001713
1714 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +00001715}
1716
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001717/// GetOrCreateSourceID - Look up the source id with the given directory and
1718/// source file names. If none currently exists, create a new id and insert it
1719/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1720/// maps as well.
Chris Lattner1d65ba72010-03-31 06:06:37 +00001721unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName){
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001722 unsigned DId;
1723 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1724 if (DI != DirectoryIdMap.end()) {
1725 DId = DI->getValue();
1726 } else {
1727 DId = DirectoryNames.size() + 1;
1728 DirectoryIdMap[DirName] = DId;
1729 DirectoryNames.push_back(DirName);
1730 }
1731
1732 unsigned FId;
1733 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1734 if (FI != SourceFileIdMap.end()) {
1735 FId = FI->getValue();
1736 } else {
1737 FId = SourceFileNames.size() + 1;
1738 SourceFileIdMap[FileName] = FId;
1739 SourceFileNames.push_back(FileName);
1740 }
1741
1742 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1743 SourceIdMap.find(std::make_pair(DId, FId));
1744 if (SI != SourceIdMap.end())
1745 return SI->second;
1746
1747 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1748 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1749 SourceIds.push_back(std::make_pair(DId, FId));
1750
1751 return SrcId;
1752}
1753
Devang Patel6404e4e2009-12-15 19:16:48 +00001754/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1755DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel163a9f72010-05-10 22:49:55 +00001756 CompileUnit *TheCU = getCompileUnit(NS);
1757 DIE *NDie = TheCU->getDIE(NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001758 if (NDie)
1759 return NDie;
1760 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel163a9f72010-05-10 22:49:55 +00001761 TheCU->insertDIE(NS, NDie);
Devang Patel6404e4e2009-12-15 19:16:48 +00001762 if (!NS.getName().empty())
1763 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
1764 addSourceLine(NDie, &NS);
1765 addToContextOwner(NDie, NS.getContext());
1766 return NDie;
1767}
1768
Devang Patel163a9f72010-05-10 22:49:55 +00001769/// constructCompileUnit - Create new CompileUnit for the given
1770/// metadata node with tag DW_TAG_compile_unit.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001771void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001772 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +00001773 StringRef FN = DIUnit.getFilename();
1774 StringRef Dir = DIUnit.getDirectory();
Devang Patel5ccdd102009-09-29 18:40:58 +00001775 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001776
1777 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001778 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001779 DIUnit.getProducer());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001780 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001781 DIUnit.getLanguage());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001782 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patel5098da02010-04-26 22:54:28 +00001783 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1784 // simplifies debug range entries.
1785 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_data4, 0);
Devang Patel4a602ca2010-03-22 23:11:36 +00001786 // DW_AT_stmt_list is a offset of line number information for this
1787 // compile unit in debug_line section. It is always zero when only one
1788 // compile unit is emitted in one object file.
1789 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001790
Devang Patel65dbc902009-11-25 17:36:49 +00001791 if (!Dir.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001792 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001793 if (DIUnit.isOptimized())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001794 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001795
Devang Patel65dbc902009-11-25 17:36:49 +00001796 StringRef Flags = DIUnit.getFlags();
1797 if (!Flags.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001798 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001799
1800 unsigned RVer = DIUnit.getRunTimeVersion();
1801 if (RVer)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001802 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001803 dwarf::DW_FORM_data1, RVer);
1804
Devang Patel163a9f72010-05-10 22:49:55 +00001805 CompileUnit *NewCU = new CompileUnit(ID, Die);
1806 if (!FirstCU)
1807 FirstCU = NewCU;
1808 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001809}
1810
Devang Patel163a9f72010-05-10 22:49:55 +00001811/// getCompielUnit - Get CompileUnit DIE.
1812CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1813 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1814 DIDescriptor D(N);
1815 const MDNode *CUNode = NULL;
1816 if (D.isCompileUnit())
1817 CUNode = N;
1818 else if (D.isSubprogram())
1819 CUNode = DISubprogram(N).getCompileUnit();
1820 else if (D.isType())
1821 CUNode = DIType(N).getCompileUnit();
1822 else if (D.isGlobalVariable())
1823 CUNode = DIGlobalVariable(N).getCompileUnit();
1824 else if (D.isVariable())
1825 CUNode = DIVariable(N).getCompileUnit();
1826 else if (D.isNameSpace())
1827 CUNode = DINameSpace(N).getCompileUnit();
1828 else if (D.isFile())
1829 CUNode = DIFile(N).getCompileUnit();
1830 else
1831 return FirstCU;
1832
1833 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1834 = CUMap.find(CUNode);
1835 if (I == CUMap.end())
1836 return FirstCU;
1837 return I->second;
1838}
1839
1840
1841/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001842void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001843 DIGlobalVariable DI_GV(N);
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001844
Devang Patel905cf5e2009-09-04 23:59:07 +00001845 // If debug information is malformed then ignore it.
1846 if (DI_GV.Verify() == false)
1847 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001848
1849 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00001850 CompileUnit *TheCU = getCompileUnit(N);
1851 if (TheCU->getDIE(DI_GV))
Devang Patel13e16b62009-06-26 01:49:18 +00001852 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001853
Devang Patel8a241142009-12-09 18:24:21 +00001854 DIE *VariableDie = createGlobalVariableDIE(DI_GV);
Devang Pateledb45632009-12-10 23:25:41 +00001855 if (!VariableDie)
1856 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001857
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001858 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +00001859 TheCU->insertDIE(N, VariableDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001860
1861 // Add to context owner.
Devang Patelc9b16cc2010-01-15 01:12:22 +00001862 DIDescriptor GVContext = DI_GV.getContext();
1863 // Do not create specification DIE if context is either compile unit
1864 // or a subprogram.
Chris Lattner1d65ba72010-03-31 06:06:37 +00001865 if (DI_GV.isDefinition() && !GVContext.isCompileUnit() &&
Devang Patel5f094002010-04-06 23:53:48 +00001866 !GVContext.isFile() &&
Devang Patel2db49d72010-05-07 18:11:54 +00001867 !isSubprogramContext(GVContext)) {
Devang Patel6404e4e2009-12-15 19:16:48 +00001868 // Create specification DIE.
1869 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1870 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1871 dwarf::DW_FORM_ref4, VariableDie);
Benjamin Kramer345ef342010-03-31 19:34:01 +00001872 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel6404e4e2009-12-15 19:16:48 +00001873 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
Chris Lattner4faf59a2010-03-08 22:31:46 +00001874 addLabel(Block, 0, dwarf::DW_FORM_udata,
Chris Lattnerdeb0cba2010-03-12 21:09:07 +00001875 Asm->Mang->getSymbol(DI_GV.getGlobal()));
Devang Patel6404e4e2009-12-15 19:16:48 +00001876 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
Devang Patel8581e012010-02-09 01:58:33 +00001877 addUInt(VariableDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Devang Patel163a9f72010-05-10 22:49:55 +00001878 TheCU->addDie(VariableSpecDIE);
Devang Patel6404e4e2009-12-15 19:16:48 +00001879 } else {
Benjamin Kramer345ef342010-03-31 19:34:01 +00001880 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel6404e4e2009-12-15 19:16:48 +00001881 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
Chris Lattner4faf59a2010-03-08 22:31:46 +00001882 addLabel(Block, 0, dwarf::DW_FORM_udata,
Chris Lattnerdeb0cba2010-03-12 21:09:07 +00001883 Asm->Mang->getSymbol(DI_GV.getGlobal()));
Devang Patel6404e4e2009-12-15 19:16:48 +00001884 addBlock(VariableDie, dwarf::DW_AT_location, 0, Block);
1885 }
Devang Patelc9b16cc2010-01-15 01:12:22 +00001886 addToContextOwner(VariableDie, GVContext);
Devang Patelc366f832009-12-10 19:14:49 +00001887
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001888 // Expose as global. FIXME - need to check external flag.
Devang Patel163a9f72010-05-10 22:49:55 +00001889 TheCU->addGlobal(DI_GV.getName(), VariableDie);
Devang Patel193f7202009-11-24 01:14:22 +00001890
1891 DIType GTy = DI_GV.getType();
Devang Patel50d80e32010-04-13 20:35:04 +00001892 if (GTy.isCompositeType() && !GTy.getName().empty()
1893 && !GTy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001894 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001895 assert(Entry && "Missing global type!");
Devang Patel163a9f72010-05-10 22:49:55 +00001896 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001897 }
Devang Patel13e16b62009-06-26 01:49:18 +00001898 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001899}
1900
Devang Patel163a9f72010-05-10 22:49:55 +00001901/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001902void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001903 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001904
Stuart Hastings639336e2010-04-06 21:38:29 +00001905 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00001906 CompileUnit *TheCU = getCompileUnit(N);
1907 if (TheCU->getDIE(N))
Stuart Hastings639336e2010-04-06 21:38:29 +00001908 return;
1909
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001910 if (!SP.isDefinition())
1911 // This is a method declaration which will be handled while constructing
1912 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +00001913 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001914
Stuart Hastings639336e2010-04-06 21:38:29 +00001915 DIE *SubprogramDie = createSubprogramDIE(SP);
1916
1917 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +00001918 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001919
1920 // Add to context owner.
Devang Patel6404e4e2009-12-15 19:16:48 +00001921 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +00001922
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001923 // Expose as global.
Devang Patel163a9f72010-05-10 22:49:55 +00001924 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel193f7202009-11-24 01:14:22 +00001925
Devang Patel13e16b62009-06-26 01:49:18 +00001926 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001927}
1928
Devang Patel2c4ceb12009-11-21 02:48:08 +00001929/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbar00564992009-09-19 20:40:14 +00001930/// content. Create global DIEs and emit initial debug info sections.
1931/// This is inovked by the target AsmPrinter.
Chris Lattner75f50722010-04-04 07:48:20 +00001932void DwarfDebug::beginModule(Module *M) {
Devang Pateleac9c072010-04-27 19:46:33 +00001933 if (DisableDebugInfoPrinting)
1934 return;
1935
Devang Patel78ab9e22009-07-30 18:56:46 +00001936 DebugInfoFinder DbgFinder;
1937 DbgFinder.processModule(*M);
Devang Patel13e16b62009-06-26 01:49:18 +00001938
Chris Lattnerd850ac72010-04-05 02:19:28 +00001939 bool HasDebugInfo = false;
1940
1941 // Scan all the compile-units to see if there are any marked as the main unit.
1942 // if not, we do not generate debug info.
1943 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1944 E = DbgFinder.compile_unit_end(); I != E; ++I) {
1945 if (DICompileUnit(*I).isMain()) {
1946 HasDebugInfo = true;
1947 break;
1948 }
1949 }
1950
1951 if (!HasDebugInfo) return;
1952
1953 // Tell MMI that we have debug info.
1954 MMI->setDebugInfoAvailability(true);
1955
Chris Lattnerbe15beb2010-04-04 23:17:54 +00001956 // Emit initial sections.
Chris Lattnerd850ac72010-04-05 02:19:28 +00001957 EmitSectionLabels();
Chris Lattnerbe15beb2010-04-04 23:17:54 +00001958
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001959 // Create all the compile unit DIEs.
Devang Patel78ab9e22009-07-30 18:56:46 +00001960 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1961 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001962 constructCompileUnit(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001963
Devang Patel53bb5c92009-11-10 23:06:00 +00001964 // Create DIEs for each subprogram.
Devang Patel78ab9e22009-07-30 18:56:46 +00001965 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
1966 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001967 constructSubprogramDIE(*I);
Devang Patel13e16b62009-06-26 01:49:18 +00001968
Devang Patelc366f832009-12-10 19:14:49 +00001969 // Create DIEs for each global variable.
1970 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
1971 E = DbgFinder.global_variable_end(); I != E; ++I)
1972 constructGlobalVariableDIE(*I);
1973
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001974 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +00001975 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001976
1977 // Print out .file directives to specify files for .loc directives. These are
1978 // printed out early so that they precede any .loc directives.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001979 if (Asm->MAI->hasDotLocAndDotFile()) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001980 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
1981 // Remember source id starts at 1.
1982 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
Chris Lattner0ad9c912010-01-22 22:09:00 +00001983 // FIXME: don't use sys::path for this! This should not depend on the
1984 // host.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001985 sys::Path FullPath(getSourceDirectoryName(Id.first));
1986 bool AppendOk =
1987 FullPath.appendComponent(getSourceFileName(Id.second));
1988 assert(AppendOk && "Could not append filename to directory!");
1989 AppendOk = false;
Chris Lattnera6594fc2010-01-25 18:58:59 +00001990 Asm->OutStreamer.EmitDwarfFileDirective(i, FullPath.str());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001991 }
1992 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001993}
1994
Devang Patel2c4ceb12009-11-21 02:48:08 +00001995/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001996///
Devang Patel2c4ceb12009-11-21 02:48:08 +00001997void DwarfDebug::endModule() {
Devang Patel163a9f72010-05-10 22:49:55 +00001998 if (!FirstCU) return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001999
Devang Patel53bb5c92009-11-10 23:06:00 +00002000 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2001 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2002 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2003 DIE *ISP = *AI;
Devang Patel2c4ceb12009-11-21 02:48:08 +00002004 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +00002005 }
2006
Devang Patele9f8f5e2010-05-07 20:54:48 +00002007 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Patel5d11eb02009-12-03 19:11:07 +00002008 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2009 DIE *SPDie = CI->first;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002010 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Patel5d11eb02009-12-03 19:11:07 +00002011 if (!N) continue;
Devang Patel163a9f72010-05-10 22:49:55 +00002012 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Patel5d11eb02009-12-03 19:11:07 +00002013 if (!NDie) continue;
2014 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patel5d11eb02009-12-03 19:11:07 +00002015 }
2016
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002017 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002018 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002019 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002020 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002021 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002022
2023 // End text sections.
2024 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002025 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnerc0215722010-04-04 19:25:43 +00002026 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002027 }
2028
2029 // Emit common frame information.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002030 emitCommonDebugFrame();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002031
2032 // Emit function debug frame information
2033 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2034 E = DebugFrames.end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002035 emitFunctionDebugFrame(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002036
2037 // Compute DIE offsets and sizes.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002038 computeSizeAndOffsets();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002039
2040 // Emit all the DIEs into a debug info section
Devang Patel2c4ceb12009-11-21 02:48:08 +00002041 emitDebugInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002042
2043 // Corresponding abbreviations into a abbrev section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002044 emitAbbreviations();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002045
2046 // Emit source line correspondence into a debug line section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002047 emitDebugLines();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002048
2049 // Emit info into a debug pubnames section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002050 emitDebugPubNames();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002051
Devang Patel193f7202009-11-24 01:14:22 +00002052 // Emit info into a debug pubtypes section.
2053 emitDebugPubTypes();
2054
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002055 // Emit info into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002056 emitDebugLoc();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002057
2058 // Emit info into a debug aranges section.
2059 EmitDebugARanges();
2060
2061 // Emit info into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002062 emitDebugRanges();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002063
2064 // Emit info into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002065 emitDebugMacInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002066
2067 // Emit inline info.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002068 emitDebugInlineInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002069
Chris Lattnerbc733f52010-03-13 02:17:42 +00002070 // Emit info into a debug str section.
2071 emitDebugStr();
2072
Devang Patel163a9f72010-05-10 22:49:55 +00002073 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2074 E = CUMap.end(); I != E; ++I)
2075 delete I->second;
2076 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002077}
2078
Devang Patel53bb5c92009-11-10 23:06:00 +00002079/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Devang Patel26c1e562010-05-20 16:36:41 +00002080DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattnerde4845c2010-04-02 19:42:39 +00002081 DebugLoc ScopeLoc) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002082
Devang Patel2db49d72010-05-07 18:11:54 +00002083 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00002084 if (AbsDbgVariable)
2085 return AbsDbgVariable;
2086
Devang Patel2db49d72010-05-07 18:11:54 +00002087 LLVMContext &Ctx = Var->getContext();
Chris Lattnerde4845c2010-04-02 19:42:39 +00002088 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00002089 if (!Scope)
2090 return NULL;
2091
Devang Patel26c1e562010-05-20 16:36:41 +00002092 AbsDbgVariable = new DbgVariable(Var);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002093 Scope->addVariable(AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00002094 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00002095 return AbsDbgVariable;
2096}
2097
Devang Patelee432862010-05-20 19:57:06 +00002098/// collectVariableInfoFromMMITable - Collect variable information from
2099/// side table maintained by MMI.
2100void
2101DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2102 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00002103 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patele717faa2009-10-06 01:26:37 +00002104 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2105 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2106 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00002107 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00002108 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00002109 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002110 DIVariable DV(Var);
2111 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00002112
Chris Lattnerde4845c2010-04-02 19:42:39 +00002113 DbgScope *Scope = 0;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002114 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattnerde4845c2010-04-02 19:42:39 +00002115 Scope = ConcreteScopes.lookup(IA);
2116 if (Scope == 0)
2117 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
2118
Devang Patelfb0ee432009-11-10 23:20:04 +00002119 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00002120 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00002121 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00002122
Devang Patel26c1e562010-05-20 16:36:41 +00002123 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2124 DbgVariable *RegVar = new DbgVariable(DV);
2125 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002126 Scope->addVariable(RegVar);
Devang Patel26c1e562010-05-20 16:36:41 +00002127 if (AbsDbgVariable) {
2128 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2129 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2130 }
Devang Patele717faa2009-10-06 01:26:37 +00002131 }
Devang Patelee432862010-05-20 19:57:06 +00002132}
Devang Patel90a48ad2010-03-15 18:33:46 +00002133
Devang Patelc3f5f782010-05-25 23:40:22 +00002134/// isDbgValueInUndefinedReg - Return true if debug value, encoded by
2135/// DBG_VALUE instruction, is in undefined reg.
2136static bool isDbgValueInUndefinedReg(const MachineInstr *MI) {
2137 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2138 if (MI->getOperand(0).isReg() && !MI->getOperand(0).getReg())
2139 return true;
2140 return false;
2141}
2142
2143/// isDbgValueInDefinedReg - Return true if debug value, encoded by
2144/// DBG_VALUE instruction, is in a defined reg.
2145static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2146 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2147 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2148 return true;
2149 return false;
2150}
2151
Devang Patelee432862010-05-20 19:57:06 +00002152/// collectVariableInfo - Populate DbgScope entries with variables' info.
2153void DwarfDebug::collectVariableInfo(const MachineFunction *MF) {
2154 SmallPtrSet<const MDNode *, 16> Processed;
2155
2156 /// collection info from MMI table.
2157 collectVariableInfoFromMMITable(MF, Processed);
2158
2159 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patel90a48ad2010-03-15 18:33:46 +00002160 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002161 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelee432862010-05-20 19:57:06 +00002162 I != E; ++I)
Devang Patel90a48ad2010-03-15 18:33:46 +00002163 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2164 II != IE; ++II) {
2165 const MachineInstr *MInsn = II;
Devang Patelc3f5f782010-05-25 23:40:22 +00002166 if (!MInsn->isDebugValue() || isDbgValueInUndefinedReg(MInsn))
Devang Patel90a48ad2010-03-15 18:33:46 +00002167 continue;
Devang Patelee432862010-05-20 19:57:06 +00002168 DbgValues.push_back(MInsn);
2169 }
Devang Patel90a48ad2010-03-15 18:33:46 +00002170
Devang Patelc3f5f782010-05-25 23:40:22 +00002171 // This is a collection of DBV_VALUE instructions describing same variable.
2172 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patelee432862010-05-20 19:57:06 +00002173 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2174 E = DbgValues.end(); I != E; ++I) {
2175 const MachineInstr *MInsn = *I;
Devang Patelc3f5f782010-05-25 23:40:22 +00002176 MultipleValues.clear();
2177 if (isDbgValueInDefinedReg(MInsn))
2178 MultipleValues.push_back(MInsn);
Devang Patelee432862010-05-20 19:57:06 +00002179 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2180 if (Processed.count(DV) != 0)
2181 continue;
2182
Devang Patelc3f5f782010-05-25 23:40:22 +00002183 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
2184 ME = DbgValues.end(); MI != ME; ++MI) {
2185 const MDNode *Var =
2186 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
2187 if (Var == DV && isDbgValueInDefinedReg(*MI))
2188 MultipleValues.push_back(*MI);
2189 }
2190
Devang Patelee432862010-05-20 19:57:06 +00002191 DbgScope *Scope = findDbgScope(MInsn);
Devang Patelc0c5a262010-05-21 00:10:20 +00002192 if (!Scope && DV.getTag() == dwarf::DW_TAG_arg_variable)
2193 Scope = CurrentFnDbgScope;
Devang Patelee432862010-05-20 19:57:06 +00002194 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00002195 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00002196 continue;
2197
2198 Processed.insert(DV);
Devang Patelee432862010-05-20 19:57:06 +00002199 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patelee432862010-05-20 19:57:06 +00002200 Scope->addVariable(RegVar);
Devang Patel65eb4822010-05-22 00:04:14 +00002201 if (DV.getTag() != dwarf::DW_TAG_arg_variable) {
Devang Patelc0c5a262010-05-21 00:10:20 +00002202 DbgValueStartMap[MInsn] = RegVar;
Devang Patelc3f5f782010-05-25 23:40:22 +00002203 DbgVariableLabelsMap[RegVar] = getLabelBeforeInsn(MInsn);
Devang Patel65eb4822010-05-22 00:04:14 +00002204 }
Devang Patelc0c5a262010-05-21 00:10:20 +00002205 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2206 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2207 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patel90a48ad2010-03-15 18:33:46 +00002208 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002209 if (MultipleValues.size() <= 1) {
2210 DbgVariableToDbgInstMap[RegVar] = MInsn;
2211 continue;
2212 }
2213
2214 // handle multiple DBG_VALUE instructions describing one variable.
2215 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
2216 if (DotDebugLocEntries.empty())
2217 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patele2df8422010-05-26 17:29:32 +00002218 const MachineInstr *Begin = NULL;
2219 const MachineInstr *End = NULL;
2220 for (SmallVector<const MachineInstr *, 4>::iterator
2221 MVI = MultipleValues.begin(), MVE = MultipleValues.end(); MVI != MVE; ++MVI) {
2222 if (!Begin) {
2223 Begin = *MVI;
2224 continue;
2225 }
2226 End = *MVI;
2227 DbgValueStartMap[End] = RegVar;
Devang Patelc3f5f782010-05-25 23:40:22 +00002228 MachineLocation MLoc;
Devang Patele2df8422010-05-26 17:29:32 +00002229 MLoc.set(Begin->getOperand(0).getReg(), 0);
2230 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2231 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patelc3f5f782010-05-25 23:40:22 +00002232 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
Devang Patele2df8422010-05-26 17:29:32 +00002233 Begin = End;
2234 if (MVI + 1 == MVE) {
2235 // If End is the last instruction then its value is valid
Devang Patelc3f5f782010-05-25 23:40:22 +00002236 // until the end of the funtion.
Devang Patele2df8422010-05-26 17:29:32 +00002237 MLoc.set(End->getOperand(0).getReg(), 0);
Devang Patelc3f5f782010-05-25 23:40:22 +00002238 DotDebugLocEntries.
2239 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, MLoc));
2240 }
2241 }
2242 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00002243 }
Devang Patel98e1cac2010-05-14 21:01:35 +00002244
2245 // Collect info for variables that were optimized out.
2246 if (NamedMDNode *NMD =
2247 MF->getFunction()->getParent()->getNamedMetadata("llvm.dbg.lv")) {
2248 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2249 DIVariable DV(cast_or_null<MDNode>(NMD->getOperand(i)));
Devang Patelee432862010-05-20 19:57:06 +00002250 if (!DV || !Processed.insert(DV))
Devang Patel98e1cac2010-05-14 21:01:35 +00002251 continue;
2252 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2253 if (Scope)
Devang Patel26c1e562010-05-20 16:36:41 +00002254 Scope->addVariable(new DbgVariable(DV));
Devang Patel98e1cac2010-05-14 21:01:35 +00002255 }
2256 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002257}
Devang Patel98e1cac2010-05-14 21:01:35 +00002258
Devang Patelc3f5f782010-05-25 23:40:22 +00002259/// getLabelBeforeInsn - Return Label preceding the instruction.
2260const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2261 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2262 LabelsBeforeInsn.find(MI);
2263 if (I == LabelsBeforeInsn.end())
2264 // FunctionBeginSym always preceeds all the instruction in current function.
2265 return FunctionBeginSym;
2266 return I->second;
2267}
2268
2269/// getLabelAfterInsn - Return Label immediately following the instruction.
2270const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2271 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2272 LabelsAfterInsn.find(MI);
2273 if (I == LabelsAfterInsn.end())
2274 return NULL;
2275 return I->second;
Devang Patele717faa2009-10-06 01:26:37 +00002276}
2277
Devang Patel553881b2010-03-29 17:20:31 +00002278/// beginScope - Process beginning of a scope.
2279void DwarfDebug::beginScope(const MachineInstr *MI) {
Devang Patel553881b2010-03-29 17:20:31 +00002280 // Check location.
2281 DebugLoc DL = MI->getDebugLoc();
Devang Patelc3f5f782010-05-25 23:40:22 +00002282 if (DL.isUnknown() && !UnknownLocations) {
2283 if (MI->isDebugValue() && PrevLabel)
2284 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patel553881b2010-03-29 17:20:31 +00002285 return;
Devang Patelc3f5f782010-05-25 23:40:22 +00002286 }
Devang Patel379fe832010-05-21 18:49:09 +00002287
Devang Patel65eb4822010-05-22 00:04:14 +00002288 bool LocalVar = false;
Chris Lattner14d750d2010-03-31 05:39:57 +00002289 if (MI->isDebugValue()) {
Devang Patel65eb4822010-05-22 00:04:14 +00002290 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2291 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2292 if (!DV.Verify()) return;
Devang Patelc3f5f782010-05-25 23:40:22 +00002293 if (DV.getTag() != dwarf::DW_TAG_arg_variable
2294 && !isDbgValueInUndefinedReg(MI))
Devang Patel65eb4822010-05-22 00:04:14 +00002295 LocalVar = true;
Devang Patelaead63c2010-03-29 22:59:58 +00002296 }
2297
Devang Pateleac9c072010-04-27 19:46:33 +00002298 MCSymbol *Label = NULL;
2299 if (DL == PrevInstLoc)
2300 Label = PrevLabel;
Devang Patel379fe832010-05-21 18:49:09 +00002301 // Do not emit line number entry for arguments.
2302 else if (!MI->isDebugValue() || LocalVar) {
2303 const MDNode *Scope = 0;
2304 if (DL.isUnknown() == false) {
2305 Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2306 // FIXME: Should only verify each scope once!
2307 if (!DIScope(Scope).Verify())
2308 return;
2309 }
2310 // else ...
2311 // This instruction has no debug location. If the preceding instruction
2312 // did, emit debug location information to indicate that the debug
2313 // location is now unknown.
2314
Devang Pateleac9c072010-04-27 19:46:33 +00002315 Label = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
2316 PrevInstLoc = DL;
2317 PrevLabel = Label;
2318 }
Devang Patel553881b2010-03-29 17:20:31 +00002319
Devang Patel26c1e562010-05-20 16:36:41 +00002320 // If this instruction begins a scope then note down corresponding label
2321 // even if previous label is reused.
Devang Patelc3f5f782010-05-25 23:40:22 +00002322 if (Label && (InsnsBeginScopeSet.count(MI) != 0 || MI->isDebugValue()))
Devang Patel461a6462010-05-19 21:58:28 +00002323 LabelsBeforeInsn[MI] = Label;
Devang Patel0d20ac82009-10-06 01:50:42 +00002324}
2325
Devang Patel2c4ceb12009-11-21 02:48:08 +00002326/// endScope - Process end of a scope.
2327void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel1c246352010-04-08 16:50:29 +00002328 if (InsnsEndScopeSet.count(MI) != 0) {
2329 // Emit a label if this instruction ends a scope.
2330 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2331 Asm->OutStreamer.EmitLabel(Label);
Devang Pateleac9c072010-04-27 19:46:33 +00002332 LabelsAfterInsn[MI] = Label;
Devang Patel1c246352010-04-08 16:50:29 +00002333 }
Devang Patel53bb5c92009-11-10 23:06:00 +00002334}
2335
Devang Pateleac9c072010-04-27 19:46:33 +00002336/// getOrCreateDbgScope - Create DbgScope for the scope.
Devang Patele9f8f5e2010-05-07 20:54:48 +00002337DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope, const MDNode *InlinedAt) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002338 if (!InlinedAt) {
2339 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2340 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002341 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002342 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2343 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Pateleac9c072010-04-27 19:46:33 +00002344 if (DIDescriptor(Scope).isLexicalBlock()) {
2345 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002346 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Pateleac9c072010-04-27 19:46:33 +00002347 WScope->setParent(Parent);
2348 Parent->addScope(WScope);
2349 }
2350
2351 if (!WScope->getParent()) {
2352 StringRef SPName = DISubprogram(Scope).getLinkageName();
2353 if (SPName == Asm->MF->getFunction()->getName())
2354 CurrentFnDbgScope = WScope;
2355 }
2356
2357 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002358 }
2359
2360 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2361 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002362 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002363
2364 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2365 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2366 DILocation DL(InlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002367 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002368 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Pateleac9c072010-04-27 19:46:33 +00002369 WScope->setParent(Parent);
2370 Parent->addScope(WScope);
2371
2372 ConcreteScopes[InlinedAt] = WScope;
2373 getOrCreateAbstractScope(Scope);
2374
2375 return WScope;
Devang Patel0d20ac82009-10-06 01:50:42 +00002376}
2377
Devang Pateleac9c072010-04-27 19:46:33 +00002378/// hasValidLocation - Return true if debug location entry attached with
2379/// machine instruction encodes valid location info.
2380static bool hasValidLocation(LLVMContext &Ctx,
2381 const MachineInstr *MInsn,
Devang Patele9f8f5e2010-05-07 20:54:48 +00002382 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Pateleac9c072010-04-27 19:46:33 +00002383 if (MInsn->isDebugValue())
2384 return false;
2385 DebugLoc DL = MInsn->getDebugLoc();
2386 if (DL.isUnknown()) return false;
2387
Devang Patele9f8f5e2010-05-07 20:54:48 +00002388 const MDNode *S = DL.getScope(Ctx);
Devang Pateleac9c072010-04-27 19:46:33 +00002389
2390 // There is no need to create another DIE for compile unit. For all
2391 // other scopes, create one DbgScope now. This will be translated
2392 // into a scope DIE at the end.
2393 if (DIScope(S).isCompileUnit()) return false;
2394
2395 Scope = S;
2396 InlinedAt = DL.getInlinedAt(Ctx);
2397 return true;
2398}
2399
2400/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2401/// hierarchy.
2402static void calculateDominanceGraph(DbgScope *Scope) {
2403 assert (Scope && "Unable to calculate scop edominance graph!");
2404 SmallVector<DbgScope *, 4> WorkStack;
2405 WorkStack.push_back(Scope);
2406 unsigned Counter = 0;
2407 while (!WorkStack.empty()) {
2408 DbgScope *WS = WorkStack.back();
2409 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2410 bool visitedChildren = false;
2411 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2412 SE = Children.end(); SI != SE; ++SI) {
2413 DbgScope *ChildScope = *SI;
2414 if (!ChildScope->getDFSOut()) {
2415 WorkStack.push_back(ChildScope);
2416 visitedChildren = true;
2417 ChildScope->setDFSIn(++Counter);
2418 break;
2419 }
2420 }
2421 if (!visitedChildren) {
2422 WorkStack.pop_back();
2423 WS->setDFSOut(++Counter);
2424 }
2425 }
2426}
2427
2428/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
2429static
2430void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2431 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2432{
2433#ifndef NDEBUG
2434 unsigned PrevDFSIn = 0;
2435 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2436 I != E; ++I) {
2437 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2438 II != IE; ++II) {
2439 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002440 const MDNode *Scope = NULL;
2441 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002442
2443 // Check if instruction has valid location information.
2444 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2445 dbgs() << " [ ";
2446 if (InlinedAt)
2447 dbgs() << "*";
2448 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
2449 MI2ScopeMap.find(MInsn);
2450 if (DI != MI2ScopeMap.end()) {
2451 DbgScope *S = DI->second;
2452 dbgs() << S->getDFSIn();
2453 PrevDFSIn = S->getDFSIn();
2454 } else
2455 dbgs() << PrevDFSIn;
2456 } else
2457 dbgs() << " [ x" << PrevDFSIn;
2458 dbgs() << " ]";
2459 MInsn->dump();
2460 }
2461 dbgs() << "\n";
2462 }
2463#endif
2464}
Devang Patel2c4ceb12009-11-21 02:48:08 +00002465/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner14d750d2010-03-31 05:39:57 +00002466/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattnereec791a2010-01-26 23:18:02 +00002467bool DwarfDebug::extractScopeInformation() {
Devang Patelaf9e8472009-10-01 20:31:14 +00002468 // If scope information was extracted using .dbg intrinsics then there is not
2469 // any need to extract these information by scanning each instruction.
2470 if (!DbgScopeMap.empty())
2471 return false;
2472
Dan Gohman314bf7c2010-04-23 01:18:53 +00002473 // Scan each instruction and create scopes. First build working set of scopes.
Devang Pateleac9c072010-04-27 19:46:33 +00002474 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2475 SmallVector<DbgRange, 4> MIRanges;
2476 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002477 const MDNode *PrevScope = NULL;
2478 const MDNode *PrevInlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002479 const MachineInstr *RangeBeginMI = NULL;
2480 const MachineInstr *PrevMI = NULL;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002481 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelaf9e8472009-10-01 20:31:14 +00002482 I != E; ++I) {
2483 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2484 II != IE; ++II) {
2485 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002486 const MDNode *Scope = NULL;
2487 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002488
2489 // Check if instruction has valid location information.
2490 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2491 PrevMI = MInsn;
2492 continue;
2493 }
Chris Lattnerde4845c2010-04-02 19:42:39 +00002494
Devang Pateleac9c072010-04-27 19:46:33 +00002495 // If scope has not changed then skip this instruction.
2496 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2497 PrevMI = MInsn;
2498 continue;
2499 }
2500
2501 if (RangeBeginMI) {
2502 // If we have alread seen a beginning of a instruction range and
2503 // current instruction scope does not match scope of first instruction
2504 // in this range then create a new instruction range.
2505 DbgRange R(RangeBeginMI, PrevMI);
2506 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
2507 MIRanges.push_back(R);
2508 }
2509
2510 // This is a beginning of a new instruction range.
2511 RangeBeginMI = MInsn;
Chris Lattnerde4845c2010-04-02 19:42:39 +00002512
Devang Pateleac9c072010-04-27 19:46:33 +00002513 // Reset previous markers.
2514 PrevMI = MInsn;
2515 PrevScope = Scope;
2516 PrevInlinedAt = InlinedAt;
Devang Patel53bb5c92009-11-10 23:06:00 +00002517 }
2518 }
2519
Devang Pateleac9c072010-04-27 19:46:33 +00002520 // Create last instruction range.
2521 if (RangeBeginMI && PrevMI && PrevScope) {
2522 DbgRange R(RangeBeginMI, PrevMI);
2523 MIRanges.push_back(R);
2524 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patelaf9e8472009-10-01 20:31:14 +00002525 }
Devang Pateleac9c072010-04-27 19:46:33 +00002526
Devang Patel344130e2010-01-04 20:44:00 +00002527 if (!CurrentFnDbgScope)
2528 return false;
2529
Devang Pateleac9c072010-04-27 19:46:33 +00002530 calculateDominanceGraph(CurrentFnDbgScope);
2531 if (PrintDbgScope)
2532 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2533
2534 // Find ranges of instructions covered by each DbgScope;
2535 DbgScope *PrevDbgScope = NULL;
2536 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2537 RE = MIRanges.end(); RI != RE; ++RI) {
2538 const DbgRange &R = *RI;
2539 DbgScope *S = MI2ScopeMap.lookup(R.first);
2540 assert (S && "Lost DbgScope for a machine instruction!");
2541 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2542 PrevDbgScope->closeInsnRange(S);
2543 S->openInsnRange(R.first);
2544 S->extendInsnRange(R.second);
2545 PrevDbgScope = S;
2546 }
2547
2548 if (PrevDbgScope)
2549 PrevDbgScope->closeInsnRange();
Devang Patelaf9e8472009-10-01 20:31:14 +00002550
Devang Patele37b0c62010-04-08 18:43:56 +00002551 identifyScopeMarkers();
Devang Patel6122a4d2010-04-08 15:37:09 +00002552
2553 return !DbgScopeMap.empty();
2554}
2555
Devang Pateleac9c072010-04-27 19:46:33 +00002556/// identifyScopeMarkers() -
2557/// Each DbgScope has first instruction and last instruction to mark beginning
2558/// and end of a scope respectively. Create an inverse map that list scopes
2559/// starts (and ends) with an instruction. One instruction may start (or end)
2560/// multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00002561void DwarfDebug::identifyScopeMarkers() {
Devang Patel42aafd72010-01-20 02:05:23 +00002562 SmallVector<DbgScope *, 4> WorkList;
2563 WorkList.push_back(CurrentFnDbgScope);
2564 while (!WorkList.empty()) {
Chris Lattner14d750d2010-03-31 05:39:57 +00002565 DbgScope *S = WorkList.pop_back_val();
Devang Pateleac9c072010-04-27 19:46:33 +00002566
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002567 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Devang Patel42aafd72010-01-20 02:05:23 +00002568 if (!Children.empty())
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002569 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00002570 SE = Children.end(); SI != SE; ++SI)
2571 WorkList.push_back(*SI);
2572
Devang Patel53bb5c92009-11-10 23:06:00 +00002573 if (S->isAbstractScope())
2574 continue;
Devang Pateleac9c072010-04-27 19:46:33 +00002575
2576 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2577 if (Ranges.empty())
2578 continue;
2579 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2580 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel461a6462010-05-19 21:58:28 +00002581 assert(RI->first && "DbgRange does not have first instruction!");
2582 assert(RI->second && "DbgRange does not have second instruction!");
2583 InsnsBeginScopeSet.insert(RI->first);
Devang Pateleac9c072010-04-27 19:46:33 +00002584 InsnsEndScopeSet.insert(RI->second);
2585 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002586 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002587}
2588
Dan Gohman084751c2010-04-20 00:37:27 +00002589/// FindFirstDebugLoc - Find the first debug location in the function. This
2590/// is intended to be an approximation for the source position of the
2591/// beginning of the function.
2592static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2593 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2594 I != E; ++I)
2595 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2596 MBBI != MBBE; ++MBBI) {
2597 DebugLoc DL = MBBI->getDebugLoc();
2598 if (!DL.isUnknown())
2599 return DL;
2600 }
2601 return DebugLoc();
2602}
2603
Devang Patel2c4ceb12009-11-21 02:48:08 +00002604/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002605/// emitted immediately after the function entry point.
Chris Lattnereec791a2010-01-26 23:18:02 +00002606void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00002607 if (!MMI->hasDebugInfo()) return;
Bill Wendling5f017e82010-04-07 09:28:04 +00002608 if (!extractScopeInformation()) return;
Devang Patel60b35bd2009-10-06 18:37:31 +00002609
Devang Pateleac9c072010-04-27 19:46:33 +00002610 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2611 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002612 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00002613 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002614
2615 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2616 // function.
Dan Gohman084751c2010-04-20 00:37:27 +00002617 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002618 if (FDL.isUnknown()) return;
2619
Devang Patele9f8f5e2010-05-07 20:54:48 +00002620 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Chris Lattnerde4845c2010-04-02 19:42:39 +00002621
2622 DISubprogram SP = getDISubprogram(Scope);
2623 unsigned Line, Col;
2624 if (SP.Verify()) {
2625 Line = SP.getLineNumber();
2626 Col = 0;
2627 } else {
2628 Line = FDL.getLine();
2629 Col = FDL.getCol();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002630 }
Chris Lattnerde4845c2010-04-02 19:42:39 +00002631
2632 recordSourceLine(Line, Col, Scope);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002633}
2634
Devang Patel2c4ceb12009-11-21 02:48:08 +00002635/// endFunction - Gather and emit post-function debug information.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002636///
Chris Lattnereec791a2010-01-26 23:18:02 +00002637void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendling5f017e82010-04-07 09:28:04 +00002638 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00002639
Devang Patel344130e2010-01-04 20:44:00 +00002640 if (CurrentFnDbgScope) {
Devang Patel65eb4822010-05-22 00:04:14 +00002641
Devang Patelc3f5f782010-05-25 23:40:22 +00002642 // Define end label for subprogram.
2643 FunctionEndSym = Asm->GetTempSymbol("func_end",
2644 Asm->getFunctionNumber());
2645 // Assumes in correct section after the entry point.
2646 Asm->OutStreamer.EmitLabel(FunctionEndSym);
2647
Devang Patel65eb4822010-05-22 00:04:14 +00002648 collectVariableInfo(MF);
2649
Devang Patel344130e2010-01-04 20:44:00 +00002650 // Get function line info.
2651 if (!Lines.empty()) {
2652 // Get section line info.
2653 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2654 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2655 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2656 // Append the function info to section info.
2657 SectionLineInfos.insert(SectionLineInfos.end(),
2658 Lines.begin(), Lines.end());
2659 }
2660
2661 // Construct abstract scopes.
2662 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
2663 AE = AbstractScopesList.end(); AI != AE; ++AI)
2664 constructScopeDIE(*AI);
2665
Devang Patel9c488372010-05-04 06:15:30 +00002666 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Devang Patel344130e2010-01-04 20:44:00 +00002667
Devang Patel9c488372010-05-04 06:15:30 +00002668 if (!DisableFramePointerElim(*MF))
2669 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
2670 dwarf::DW_FORM_flag, 1);
2671
2672
Chris Lattnerd38fee82010-04-05 00:13:49 +00002673 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel344130e2010-01-04 20:44:00 +00002674 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002675 }
2676
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002677 // Clear debug info
Devang Patelf54b8522010-01-19 01:26:02 +00002678 CurrentFnDbgScope = NULL;
Devang Patel26c1e562010-05-20 16:36:41 +00002679 DbgVariableToFrameIndexMap.clear();
2680 VarToAbstractVarMap.clear();
2681 DbgVariableToDbgInstMap.clear();
2682 DbgVariableLabelsMap.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002683 DeleteContainerSeconds(DbgScopeMap);
Devang Patel461a6462010-05-19 21:58:28 +00002684 InsnsBeginScopeSet.clear();
Devang Patel51424712010-04-09 16:04:20 +00002685 InsnsEndScopeSet.clear();
Devang Patelaead63c2010-03-29 22:59:58 +00002686 DbgValueStartMap.clear();
Devang Patelf54b8522010-01-19 01:26:02 +00002687 ConcreteScopes.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002688 DeleteContainerSeconds(AbstractScopes);
Devang Patelf54b8522010-01-19 01:26:02 +00002689 AbstractScopesList.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002690 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00002691 LabelsBeforeInsn.clear();
2692 LabelsAfterInsn.clear();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002693 Lines.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00002694 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002695}
2696
Devang Patel26c1e562010-05-20 16:36:41 +00002697/// recordVariableFrameIndex - Record a variable's index.
2698void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2699 assert (V && "Invalid DbgVariable!");
2700 DbgVariableToFrameIndexMap[V] = Index;
2701}
2702
2703/// findVariableFrameIndex - Return true if frame index for the variable
2704/// is found. Update FI to hold value of the index.
2705bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
2706 assert (V && "Invalid DbgVariable!");
2707 DenseMap<const DbgVariable *, int>::iterator I =
2708 DbgVariableToFrameIndexMap.find(V);
2709 if (I == DbgVariableToFrameIndexMap.end())
2710 return false;
2711 *FI = I->second;
2712 return true;
2713}
2714
2715/// findVariableLabel - Find MCSymbol for the variable.
2716const MCSymbol *DwarfDebug::findVariableLabel(const DbgVariable *V) {
2717 DenseMap<const DbgVariable *, const MCSymbol *>::iterator I
2718 = DbgVariableLabelsMap.find(V);
2719 if (I == DbgVariableLabelsMap.end())
2720 return NULL;
2721 else return I->second;
2722}
2723
Devang Patelee432862010-05-20 19:57:06 +00002724/// findDbgScope - Find DbgScope for the debug loc attached with an
2725/// instruction.
2726DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
2727 DbgScope *Scope = NULL;
2728 LLVMContext &Ctx =
2729 MInsn->getParent()->getParent()->getFunction()->getContext();
2730 DebugLoc DL = MInsn->getDebugLoc();
2731
2732 if (DL.isUnknown())
2733 return Scope;
2734
2735 if (const MDNode *IA = DL.getInlinedAt(Ctx))
2736 Scope = ConcreteScopes.lookup(IA);
2737 if (Scope == 0)
2738 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
2739
2740 return Scope;
2741}
2742
2743
Chris Lattnerc6087842010-03-09 04:54:43 +00002744/// recordSourceLine - Register a source line with debug info. Returns the
2745/// unique label that was emitted and which provides correspondence to
2746/// the source line list.
Devang Patele9f8f5e2010-05-07 20:54:48 +00002747MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S) {
Devang Patel65dbc902009-11-25 17:36:49 +00002748 StringRef Dir;
2749 StringRef Fn;
Devang Patelf84548d2009-10-05 18:03:19 +00002750
Dan Gohman1cc0d622010-05-05 23:41:32 +00002751 unsigned Src = 1;
2752 if (S) {
2753 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00002754
Dan Gohman1cc0d622010-05-05 23:41:32 +00002755 if (Scope.isCompileUnit()) {
2756 DICompileUnit CU(S);
2757 Dir = CU.getDirectory();
2758 Fn = CU.getFilename();
2759 } else if (Scope.isSubprogram()) {
2760 DISubprogram SP(S);
2761 Dir = SP.getDirectory();
2762 Fn = SP.getFilename();
2763 } else if (Scope.isLexicalBlock()) {
2764 DILexicalBlock DB(S);
2765 Dir = DB.getDirectory();
2766 Fn = DB.getFilename();
2767 } else
2768 assert(0 && "Unexpected scope info");
2769
2770 Src = GetOrCreateSourceID(Dir, Fn);
2771 }
2772
Chris Lattner63d78362010-03-14 08:36:50 +00002773 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattner25b68c62010-03-14 08:15:55 +00002774 Lines.push_back(SrcLineInfo(Line, Col, Src, Label));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002775
Chris Lattnerc6087842010-03-09 04:54:43 +00002776 Asm->OutStreamer.EmitLabel(Label);
2777 return Label;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002778}
2779
Bill Wendling829e67b2009-05-20 23:22:40 +00002780//===----------------------------------------------------------------------===//
2781// Emit Methods
2782//===----------------------------------------------------------------------===//
2783
Devang Patel2c4ceb12009-11-21 02:48:08 +00002784/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling94d04b82009-05-20 23:21:38 +00002785///
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002786unsigned
2787DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002788 // Get the children.
2789 const std::vector<DIE *> &Children = Die->getChildren();
2790
2791 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00002792 if (!Last && !Children.empty())
Benjamin Kramer345ef342010-03-31 19:34:01 +00002793 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling94d04b82009-05-20 23:21:38 +00002794
2795 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002796 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00002797
2798 // Get the abbreviation for this DIE.
2799 unsigned AbbrevNumber = Die->getAbbrevNumber();
2800 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2801
2802 // Set DIE offset
2803 Die->setOffset(Offset);
2804
2805 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00002806 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00002807
2808 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2809 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2810
2811 // Size the DIE attribute values.
2812 for (unsigned i = 0, N = Values.size(); i < N; ++i)
2813 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00002814 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00002815
2816 // Size the DIE children if any.
2817 if (!Children.empty()) {
2818 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
2819 "Children flag not set");
2820
2821 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002822 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling94d04b82009-05-20 23:21:38 +00002823
2824 // End of children marker.
2825 Offset += sizeof(int8_t);
2826 }
2827
2828 Die->setSize(Offset - Die->getOffset());
2829 return Offset;
2830}
2831
Devang Patel2c4ceb12009-11-21 02:48:08 +00002832/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling94d04b82009-05-20 23:21:38 +00002833///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002834void DwarfDebug::computeSizeAndOffsets() {
Devang Patel163a9f72010-05-10 22:49:55 +00002835 unsigned PrevOffset = 0;
2836 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2837 E = CUMap.end(); I != E; ++I) {
2838 // Compute size of compile unit header.
2839 static unsigned Offset = PrevOffset +
2840 sizeof(int32_t) + // Length of Compilation Unit Info
2841 sizeof(int16_t) + // DWARF version number
2842 sizeof(int32_t) + // Offset Into Abbrev. Section
2843 sizeof(int8_t); // Pointer Size (in bytes)
2844 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
2845 PrevOffset = Offset;
2846 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002847}
2848
Chris Lattner11b8f302010-04-04 23:02:02 +00002849/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
2850/// temporary label to it if SymbolStem is specified.
Chris Lattner9c69e285532010-04-04 22:59:04 +00002851static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner11b8f302010-04-04 23:02:02 +00002852 const char *SymbolStem = 0) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00002853 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner11b8f302010-04-04 23:02:02 +00002854 if (!SymbolStem) return 0;
2855
Chris Lattner9c69e285532010-04-04 22:59:04 +00002856 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
2857 Asm->OutStreamer.EmitLabel(TmpSym);
2858 return TmpSym;
2859}
2860
2861/// EmitSectionLabels - Emit initial Dwarf sections with a label at
2862/// the start of each one.
Chris Lattnerfa070b02010-04-04 22:33:59 +00002863void DwarfDebug::EmitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002864 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002865
Bill Wendling94d04b82009-05-20 23:21:38 +00002866 // Dwarf sections base addresses.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002867 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00002868 DwarfFrameSectionSym =
2869 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
2870 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002871
Chris Lattner9c69e285532010-04-04 22:59:04 +00002872 DwarfInfoSectionSym =
2873 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
2874 DwarfAbbrevSectionSym =
2875 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner11b8f302010-04-04 23:02:02 +00002876 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Chris Lattner9c69e285532010-04-04 22:59:04 +00002877
2878 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner11b8f302010-04-04 23:02:02 +00002879 EmitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002880
Chris Lattner11b8f302010-04-04 23:02:02 +00002881 EmitSectionSym(Asm, TLOF.getDwarfLineSection());
2882 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
2883 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2884 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Chris Lattner9c69e285532010-04-04 22:59:04 +00002885 DwarfStrSectionSym =
2886 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patelf2548ca2010-04-16 23:33:45 +00002887 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
2888 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00002889
Devang Patelc3f5f782010-05-25 23:40:22 +00002890 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
2891 "section_debug_loc");
2892
Chris Lattner9c69e285532010-04-04 22:59:04 +00002893 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattner4ad1efe2010-04-04 23:10:38 +00002894 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002895}
2896
Devang Patel2c4ceb12009-11-21 02:48:08 +00002897/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling94d04b82009-05-20 23:21:38 +00002898///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002899void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002900 // Get the abbreviation for this DIE.
2901 unsigned AbbrevNumber = Die->getAbbrevNumber();
2902 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2903
Bill Wendling94d04b82009-05-20 23:21:38 +00002904 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00002905 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00002906 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2907 Twine::utohexstr(Die->getOffset()) + ":0x" +
2908 Twine::utohexstr(Die->getSize()) + " " +
2909 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002910 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00002911
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00002912 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling94d04b82009-05-20 23:21:38 +00002913 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2914
2915 // Emit the DIE attribute values.
2916 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2917 unsigned Attr = AbbrevData[i].getAttribute();
2918 unsigned Form = AbbrevData[i].getForm();
2919 assert(Form && "Too many attributes for DIE (check abbreviation)");
2920
Chris Lattner3f53c832010-04-04 18:52:31 +00002921 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00002922 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
2923
Bill Wendling94d04b82009-05-20 23:21:38 +00002924 switch (Attr) {
2925 case dwarf::DW_AT_sibling:
Devang Patel2c4ceb12009-11-21 02:48:08 +00002926 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00002927 break;
2928 case dwarf::DW_AT_abstract_origin: {
2929 DIEEntry *E = cast<DIEEntry>(Values[i]);
2930 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00002931 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00002932 Asm->EmitInt32(Addr);
2933 break;
2934 }
Devang Patelf2548ca2010-04-16 23:33:45 +00002935 case dwarf::DW_AT_ranges: {
2936 // DW_AT_range Value encodes offset in debug_range section.
2937 DIEInteger *V = cast<DIEInteger>(Values[i]);
2938 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
2939 V->getValue(),
2940 DwarfDebugRangeSectionSym,
2941 4);
2942 break;
2943 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002944 case dwarf::DW_AT_location: {
2945 if (UseDotDebugLocEntry.count(Die) != 0) {
2946 DIELabel *L = cast<DIELabel>(Values[i]);
2947 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
2948 } else
2949 Values[i]->EmitValue(Asm, Form);
2950 break;
2951 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002952 default:
2953 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002954 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00002955 break;
2956 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002957 }
2958
2959 // Emit the DIE children if any.
2960 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2961 const std::vector<DIE *> &Children = Die->getChildren();
2962
2963 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002964 emitDIE(Children[j]);
Bill Wendling94d04b82009-05-20 23:21:38 +00002965
Chris Lattner3f53c832010-04-04 18:52:31 +00002966 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00002967 Asm->OutStreamer.AddComment("End Of Children Mark");
2968 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00002969 }
2970}
2971
Devang Patel8a241142009-12-09 18:24:21 +00002972/// emitDebugInfo - Emit the debug info section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002973///
Devang Patel8a241142009-12-09 18:24:21 +00002974void DwarfDebug::emitDebugInfo() {
2975 // Start debug info section.
2976 Asm->OutStreamer.SwitchSection(
2977 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel163a9f72010-05-10 22:49:55 +00002978 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2979 E = CUMap.end(); I != E; ++I) {
2980 CompileUnit *TheCU = I->second;
2981 DIE *Die = TheCU->getCUDie();
2982
2983 // Emit the compile units header.
2984 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
2985 TheCU->getID()));
2986
2987 // Emit size of content not including length itself
2988 unsigned ContentSize = Die->getSize() +
2989 sizeof(int16_t) + // DWARF version number
2990 sizeof(int32_t) + // Offset Into Abbrev. Section
2991 sizeof(int8_t) + // Pointer Size (in bytes)
2992 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2993
2994 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2995 Asm->EmitInt32(ContentSize);
2996 Asm->OutStreamer.AddComment("DWARF version number");
2997 Asm->EmitInt16(dwarf::DWARF_VERSION);
2998 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
2999 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3000 DwarfAbbrevSectionSym);
3001 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3002 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
3003
3004 emitDIE(Die);
3005 // FIXME - extra padding for gdb bug.
3006 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3007 Asm->EmitInt8(0);
3008 Asm->EmitInt8(0);
3009 Asm->EmitInt8(0);
3010 Asm->EmitInt8(0);
3011 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3012 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003013}
3014
Devang Patel2c4ceb12009-11-21 02:48:08 +00003015/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003016///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003017void DwarfDebug::emitAbbreviations() const {
Bill Wendling94d04b82009-05-20 23:21:38 +00003018 // Check to see if it is worth the effort.
3019 if (!Abbreviations.empty()) {
3020 // Start the debug abbrev section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003021 Asm->OutStreamer.SwitchSection(
3022 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003023
Chris Lattnerc0215722010-04-04 19:25:43 +00003024 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003025
3026 // For each abbrevation.
3027 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3028 // Get abbreviation data
3029 const DIEAbbrev *Abbrev = Abbreviations[i];
3030
3031 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003032 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00003033
3034 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003035 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00003036 }
3037
3038 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003039 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00003040
Chris Lattnerc0215722010-04-04 19:25:43 +00003041 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003042 }
3043}
3044
Devang Patel2c4ceb12009-11-21 02:48:08 +00003045/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling94d04b82009-05-20 23:21:38 +00003046/// the line matrix.
3047///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003048void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003049 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00003050 Asm->OutStreamer.AddComment("Extended Op");
3051 Asm->EmitInt8(0);
3052
3053 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003054 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003055 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3056 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3057
3058 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00003059
Chris Lattnerc0215722010-04-04 19:25:43 +00003060 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003061 Asm->getTargetData().getPointerSize(),
3062 0/*AddrSpace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003063
3064 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00003065 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3066 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00003067 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00003068 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003069}
3070
Devang Patel2c4ceb12009-11-21 02:48:08 +00003071/// emitDebugLines - Emit source line information.
Bill Wendling94d04b82009-05-20 23:21:38 +00003072///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003073void DwarfDebug::emitDebugLines() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003074 // If the target is using .loc/.file, the assembler will be emitting the
3075 // .debug_line table automatically.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003076 if (Asm->MAI->hasDotLocAndDotFile())
Bill Wendling94d04b82009-05-20 23:21:38 +00003077 return;
3078
3079 // Minimum line delta, thus ranging from -10..(255-10).
3080 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
3081 // Maximum line delta, thus ranging from -10..(255-10).
3082 const int MaxLineDelta = 255 + MinLineDelta;
3083
3084 // Start the dwarf line section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003085 Asm->OutStreamer.SwitchSection(
3086 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003087
3088 // Construct the section header.
Chris Lattner233f52b2010-03-09 23:52:58 +00003089 Asm->OutStreamer.AddComment("Length of Source Line Info");
Chris Lattnera6437182010-04-04 19:58:12 +00003090 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_end"),
3091 Asm->GetTempSymbol("line_begin"), 4);
Chris Lattnerc0215722010-04-04 19:25:43 +00003092 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003093
Chris Lattner233f52b2010-03-09 23:52:58 +00003094 Asm->OutStreamer.AddComment("DWARF version number");
3095 Asm->EmitInt16(dwarf::DWARF_VERSION);
Bill Wendling94d04b82009-05-20 23:21:38 +00003096
Chris Lattner233f52b2010-03-09 23:52:58 +00003097 Asm->OutStreamer.AddComment("Prolog Length");
Chris Lattnera6437182010-04-04 19:58:12 +00003098 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_prolog_end"),
3099 Asm->GetTempSymbol("line_prolog_begin"), 4);
Chris Lattnerc0215722010-04-04 19:25:43 +00003100 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003101
Chris Lattner233f52b2010-03-09 23:52:58 +00003102 Asm->OutStreamer.AddComment("Minimum Instruction Length");
3103 Asm->EmitInt8(1);
3104 Asm->OutStreamer.AddComment("Default is_stmt_start flag");
3105 Asm->EmitInt8(1);
3106 Asm->OutStreamer.AddComment("Line Base Value (Special Opcodes)");
3107 Asm->EmitInt8(MinLineDelta);
3108 Asm->OutStreamer.AddComment("Line Range Value (Special Opcodes)");
3109 Asm->EmitInt8(MaxLineDelta);
3110 Asm->OutStreamer.AddComment("Special Opcode Base");
3111 Asm->EmitInt8(-MinLineDelta);
Bill Wendling94d04b82009-05-20 23:21:38 +00003112
3113 // Line number standard opcode encodings argument count
Chris Lattner233f52b2010-03-09 23:52:58 +00003114 Asm->OutStreamer.AddComment("DW_LNS_copy arg count");
3115 Asm->EmitInt8(0);
3116 Asm->OutStreamer.AddComment("DW_LNS_advance_pc arg count");
3117 Asm->EmitInt8(1);
3118 Asm->OutStreamer.AddComment("DW_LNS_advance_line arg count");
3119 Asm->EmitInt8(1);
3120 Asm->OutStreamer.AddComment("DW_LNS_set_file arg count");
3121 Asm->EmitInt8(1);
3122 Asm->OutStreamer.AddComment("DW_LNS_set_column arg count");
3123 Asm->EmitInt8(1);
3124 Asm->OutStreamer.AddComment("DW_LNS_negate_stmt arg count");
3125 Asm->EmitInt8(0);
3126 Asm->OutStreamer.AddComment("DW_LNS_set_basic_block arg count");
3127 Asm->EmitInt8(0);
3128 Asm->OutStreamer.AddComment("DW_LNS_const_add_pc arg count");
3129 Asm->EmitInt8(0);
3130 Asm->OutStreamer.AddComment("DW_LNS_fixed_advance_pc arg count");
3131 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003132
3133 // Emit directories.
3134 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
Chris Lattner4cf202b2010-01-23 03:11:46 +00003135 const std::string &Dir = getSourceDirectoryName(DI);
Chris Lattner3f53c832010-04-04 18:52:31 +00003136 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Directory");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003137 Asm->OutStreamer.EmitBytes(StringRef(Dir.c_str(), Dir.size()+1), 0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003138 }
3139
Chris Lattner233f52b2010-03-09 23:52:58 +00003140 Asm->OutStreamer.AddComment("End of directories");
3141 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003142
3143 // Emit files.
3144 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
3145 // Remember source id starts at 1.
3146 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
Chris Lattner4cf202b2010-01-23 03:11:46 +00003147 const std::string &FN = getSourceFileName(Id.second);
Chris Lattner3f53c832010-04-04 18:52:31 +00003148 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Source");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003149 Asm->OutStreamer.EmitBytes(StringRef(FN.c_str(), FN.size()+1), 0);
3150
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003151 Asm->EmitULEB128(Id.first, "Directory #");
3152 Asm->EmitULEB128(0, "Mod date");
3153 Asm->EmitULEB128(0, "File size");
Bill Wendling94d04b82009-05-20 23:21:38 +00003154 }
3155
Chris Lattner233f52b2010-03-09 23:52:58 +00003156 Asm->OutStreamer.AddComment("End of files");
3157 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003158
Chris Lattnerc0215722010-04-04 19:25:43 +00003159 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003160
3161 // A sequence for each text section.
3162 unsigned SecSrcLinesSize = SectionSourceLines.size();
3163
3164 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
3165 // Isolate current sections line info.
3166 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
3167
Bill Wendling94d04b82009-05-20 23:21:38 +00003168 // Dwarf assumes we start with first line of first source file.
3169 unsigned Source = 1;
3170 unsigned Line = 1;
3171
3172 // Construct rows of the address, source, line, column matrix.
3173 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
3174 const SrcLineInfo &LineInfo = LineInfos[i];
Chris Lattner25b68c62010-03-14 08:15:55 +00003175 MCSymbol *Label = LineInfo.getLabel();
Chris Lattnerb9130602010-03-14 02:20:58 +00003176 if (!Label->isDefined()) continue; // Not emitted, in dead code.
Bill Wendling94d04b82009-05-20 23:21:38 +00003177
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003178 if (Asm->isVerbose()) {
Chris Lattner188a87d2010-03-10 01:04:13 +00003179 std::pair<unsigned, unsigned> SrcID =
Bill Wendling94d04b82009-05-20 23:21:38 +00003180 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner188a87d2010-03-10 01:04:13 +00003181 Asm->OutStreamer.AddComment(Twine(getSourceDirectoryName(SrcID.first)) +
Chris Lattner49f618a2010-03-10 02:29:31 +00003182 "/" +
3183 Twine(getSourceFileName(SrcID.second)) +
Chris Lattner188a87d2010-03-10 01:04:13 +00003184 ":" + Twine(LineInfo.getLine()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003185 }
3186
3187 // Define the line address.
Chris Lattner233f52b2010-03-09 23:52:58 +00003188 Asm->OutStreamer.AddComment("Extended Op");
3189 Asm->EmitInt8(0);
3190 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003191 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003192
3193 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3194 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3195
3196 Asm->OutStreamer.AddComment("Location label");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003197 Asm->OutStreamer.EmitSymbolValue(Label,
3198 Asm->getTargetData().getPointerSize(),
Chris Lattnerb9130602010-03-14 02:20:58 +00003199 0/*AddrSpace*/);
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00003200
Bill Wendling94d04b82009-05-20 23:21:38 +00003201 // If change of source, then switch to the new source.
3202 if (Source != LineInfo.getSourceID()) {
3203 Source = LineInfo.getSourceID();
Chris Lattner233f52b2010-03-09 23:52:58 +00003204 Asm->OutStreamer.AddComment("DW_LNS_set_file");
3205 Asm->EmitInt8(dwarf::DW_LNS_set_file);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003206 Asm->EmitULEB128(Source, "New Source");
Bill Wendling94d04b82009-05-20 23:21:38 +00003207 }
3208
3209 // If change of line.
3210 if (Line != LineInfo.getLine()) {
3211 // Determine offset.
3212 int Offset = LineInfo.getLine() - Line;
3213 int Delta = Offset - MinLineDelta;
3214
3215 // Update line.
3216 Line = LineInfo.getLine();
3217
3218 // If delta is small enough and in range...
3219 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
3220 // ... then use fast opcode.
Chris Lattner233f52b2010-03-09 23:52:58 +00003221 Asm->OutStreamer.AddComment("Line Delta");
3222 Asm->EmitInt8(Delta - MinLineDelta);
Bill Wendling94d04b82009-05-20 23:21:38 +00003223 } else {
3224 // ... otherwise use long hand.
Chris Lattner233f52b2010-03-09 23:52:58 +00003225 Asm->OutStreamer.AddComment("DW_LNS_advance_line");
Bill Wendling94d04b82009-05-20 23:21:38 +00003226 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003227 Asm->EmitSLEB128(Offset, "Line Offset");
Chris Lattner233f52b2010-03-09 23:52:58 +00003228 Asm->OutStreamer.AddComment("DW_LNS_copy");
3229 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling94d04b82009-05-20 23:21:38 +00003230 }
3231 } else {
3232 // Copy the previous row (different address or source)
Chris Lattner233f52b2010-03-09 23:52:58 +00003233 Asm->OutStreamer.AddComment("DW_LNS_copy");
3234 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling94d04b82009-05-20 23:21:38 +00003235 }
3236 }
3237
Devang Patel2c4ceb12009-11-21 02:48:08 +00003238 emitEndOfLineMatrix(j + 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003239 }
3240
3241 if (SecSrcLinesSize == 0)
3242 // Because we're emitting a debug_line section, we still need a line
3243 // table. The linker and friends expect it to exist. If there's nothing to
3244 // put into it, emit an empty table.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003245 emitEndOfLineMatrix(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003246
Chris Lattnerc0215722010-04-04 19:25:43 +00003247 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003248}
3249
Devang Patel2c4ceb12009-11-21 02:48:08 +00003250/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003251///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003252void DwarfDebug::emitCommonDebugFrame() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003253 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003254 return;
3255
Chris Lattnerd38fee82010-04-05 00:13:49 +00003256 int stackGrowth = Asm->getTargetData().getPointerSize();
3257 if (Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3258 TargetFrameInfo::StackGrowsDown)
3259 stackGrowth *= -1;
Bill Wendling94d04b82009-05-20 23:21:38 +00003260
3261 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003262 Asm->OutStreamer.SwitchSection(
3263 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003264
Chris Lattnerc0215722010-04-04 19:25:43 +00003265 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003266 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003267 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3268 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003269
Chris Lattnerc0215722010-04-04 19:25:43 +00003270 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003271 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling94d04b82009-05-20 23:21:38 +00003272 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner233f52b2010-03-09 23:52:58 +00003273 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling94d04b82009-05-20 23:21:38 +00003274 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner233f52b2010-03-09 23:52:58 +00003275 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003276 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003277 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3278 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner233f52b2010-03-09 23:52:58 +00003279 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003280 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling94d04b82009-05-20 23:21:38 +00003281 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling94d04b82009-05-20 23:21:38 +00003282
3283 std::vector<MachineMove> Moves;
3284 RI->getInitialFrameState(Moves);
3285
Chris Lattner02b86b92010-04-04 23:41:46 +00003286 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003287
Chris Lattner059ea132010-04-28 01:05:45 +00003288 Asm->EmitAlignment(2);
Chris Lattnerc0215722010-04-04 19:25:43 +00003289 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003290}
3291
Devang Patel2c4ceb12009-11-21 02:48:08 +00003292/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling94d04b82009-05-20 23:21:38 +00003293/// section.
Chris Lattner206d61e2010-03-13 07:26:18 +00003294void DwarfDebug::
3295emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003296 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003297 return;
3298
3299 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003300 Asm->OutStreamer.SwitchSection(
3301 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003302
Chris Lattner233f52b2010-03-09 23:52:58 +00003303 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner206d61e2010-03-13 07:26:18 +00003304 MCSymbol *DebugFrameBegin =
Chris Lattnerc0215722010-04-04 19:25:43 +00003305 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner206d61e2010-03-13 07:26:18 +00003306 MCSymbol *DebugFrameEnd =
Chris Lattnerc0215722010-04-04 19:25:43 +00003307 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnera6437182010-04-04 19:58:12 +00003308 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003309
Chris Lattner206d61e2010-03-13 07:26:18 +00003310 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling94d04b82009-05-20 23:21:38 +00003311
Chris Lattner233f52b2010-03-09 23:52:58 +00003312 Asm->OutStreamer.AddComment("FDE CIE offset");
Chris Lattner6189ed12010-04-04 23:25:33 +00003313 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
3314 DwarfFrameSectionSym);
Bill Wendling94d04b82009-05-20 23:21:38 +00003315
Chris Lattner233f52b2010-03-09 23:52:58 +00003316 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnerc0215722010-04-04 19:25:43 +00003317 MCSymbol *FuncBeginSym =
3318 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattnerfb658072010-03-13 07:40:56 +00003319 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattnerd38fee82010-04-05 00:13:49 +00003320 Asm->getTargetData().getPointerSize(),
3321 0/*AddrSpace*/);
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00003322
3323
Chris Lattner233f52b2010-03-09 23:52:58 +00003324 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnera6437182010-04-04 19:58:12 +00003325 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003326 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003327
Chris Lattner02b86b92010-04-04 23:41:46 +00003328 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003329
Chris Lattner059ea132010-04-28 01:05:45 +00003330 Asm->EmitAlignment(2);
Chris Lattner206d61e2010-03-13 07:26:18 +00003331 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling94d04b82009-05-20 23:21:38 +00003332}
3333
Devang Patel8a241142009-12-09 18:24:21 +00003334/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3335///
3336void DwarfDebug::emitDebugPubNames() {
Devang Patel163a9f72010-05-10 22:49:55 +00003337 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3338 E = CUMap.end(); I != E; ++I) {
3339 CompileUnit *TheCU = I->second;
3340 // Start the dwarf pubnames section.
3341 Asm->OutStreamer.SwitchSection(
3342 Asm->getObjFileLowering().getDwarfPubNamesSection());
Chris Lattner4cf202b2010-01-23 03:11:46 +00003343
Devang Patel163a9f72010-05-10 22:49:55 +00003344 Asm->OutStreamer.AddComment("Length of Public Names Info");
3345 Asm->EmitLabelDifference(
3346 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3347 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
3348
3349 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3350 TheCU->getID()));
3351
3352 Asm->OutStreamer.AddComment("DWARF Version");
3353 Asm->EmitInt16(dwarf::DWARF_VERSION);
3354
3355 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3356 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3357 DwarfInfoSectionSym);
3358
3359 Asm->OutStreamer.AddComment("Compilation Unit Length");
3360 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3361 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3362 4);
3363
3364 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3365 for (StringMap<DIE*>::const_iterator
3366 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3367 const char *Name = GI->getKeyData();
3368 DIE *Entity = GI->second;
3369
3370 Asm->OutStreamer.AddComment("DIE offset");
3371 Asm->EmitInt32(Entity->getOffset());
3372
3373 if (Asm->isVerbose())
3374 Asm->OutStreamer.AddComment("External Name");
3375 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3376 }
3377
3378 Asm->OutStreamer.AddComment("End Mark");
3379 Asm->EmitInt32(0);
3380 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3381 TheCU->getID()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003382 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003383}
3384
Devang Patel193f7202009-11-24 01:14:22 +00003385void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00003386 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3387 E = CUMap.end(); I != E; ++I) {
3388 CompileUnit *TheCU = I->second;
3389 // Start the dwarf pubnames section.
3390 Asm->OutStreamer.SwitchSection(
3391 Asm->getObjFileLowering().getDwarfPubTypesSection());
3392 Asm->OutStreamer.AddComment("Length of Public Types Info");
3393 Asm->EmitLabelDifference(
3394 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3395 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Chris Lattner4cf202b2010-01-23 03:11:46 +00003396
Devang Patel163a9f72010-05-10 22:49:55 +00003397 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3398 TheCU->getID()));
3399
3400 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3401 Asm->EmitInt16(dwarf::DWARF_VERSION);
3402
3403 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3404 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3405 DwarfInfoSectionSym);
3406
3407 Asm->OutStreamer.AddComment("Compilation Unit Length");
3408 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3409 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3410 4);
3411
3412 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3413 for (StringMap<DIE*>::const_iterator
3414 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3415 const char *Name = GI->getKeyData();
3416 DIE * Entity = GI->second;
3417
3418 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3419 Asm->EmitInt32(Entity->getOffset());
3420
3421 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3422 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3423 }
3424
3425 Asm->OutStreamer.AddComment("End Mark");
3426 Asm->EmitInt32(0);
3427 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3428 TheCU->getID()));
Devang Patel193f7202009-11-24 01:14:22 +00003429 }
Devang Patel193f7202009-11-24 01:14:22 +00003430}
3431
Devang Patel2c4ceb12009-11-21 02:48:08 +00003432/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003433///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003434void DwarfDebug::emitDebugStr() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003435 // Check to see if it is worth the effort.
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003436 if (StringPool.empty()) return;
3437
3438 // Start the dwarf str section.
3439 Asm->OutStreamer.SwitchSection(
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003440 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003441
Chris Lattnerbc733f52010-03-13 02:17:42 +00003442 // Get all of the string pool entries and put them in an array by their ID so
3443 // we can sort them.
3444 SmallVector<std::pair<unsigned,
3445 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
3446
3447 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3448 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3449 Entries.push_back(std::make_pair(I->second.second, &*I));
3450
3451 array_pod_sort(Entries.begin(), Entries.end());
3452
3453 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003454 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003455 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003456
3457 // Emit the string itself.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003458 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003459 }
3460}
3461
Devang Patel2c4ceb12009-11-21 02:48:08 +00003462/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003463///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003464void DwarfDebug::emitDebugLoc() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003465 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003466 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00003467 Asm->getObjFileLowering().getDwarfLocSection());
3468 unsigned char Size = Asm->getTargetData().getPointerSize();
3469 unsigned index = 0;
3470 bool needMarker = true;
3471 for (SmallVector<DotDebugLocEntry, 4>::iterator I = DotDebugLocEntries.begin(),
3472 E = DotDebugLocEntries.end(); I != E; ++I, ++index) {
3473 DotDebugLocEntry Entry = *I;
3474 if (needMarker) {
3475 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
3476 needMarker = false;
3477 }
3478 if (Entry.isEmpty()) {
3479 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3480 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3481 needMarker = true;
3482 } else {
3483 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3484 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3485 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3486 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
3487 if (Reg < 32) {
3488 Asm->OutStreamer.AddComment("Loc expr size");
3489 Asm->EmitInt16(1);
3490 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3491 } else {
3492 Asm->OutStreamer.AddComment("Loc expr size");
3493 Asm->EmitInt16(1+MCAsmInfo::getULEB128Size(Reg));
3494 Asm->EmitInt8(dwarf::DW_OP_regx);
3495 Asm->EmitULEB128(Reg);
3496 }
3497 }
3498 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003499}
3500
3501/// EmitDebugARanges - Emit visible names into a debug aranges section.
3502///
3503void DwarfDebug::EmitDebugARanges() {
3504 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003505 Asm->OutStreamer.SwitchSection(
3506 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003507}
3508
Devang Patel2c4ceb12009-11-21 02:48:08 +00003509/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003510///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003511void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003512 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003513 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00003514 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Pateleac9c072010-04-27 19:46:33 +00003515 unsigned char Size = Asm->getTargetData().getPointerSize();
3516 for (SmallVector<const MCSymbol *, 8>::iterator
3517 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
3518 I != E; ++I) {
3519 if (*I)
3520 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003521 else
Devang Pateleac9c072010-04-27 19:46:33 +00003522 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003523 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003524}
3525
Devang Patel2c4ceb12009-11-21 02:48:08 +00003526/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003527///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003528void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003529 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00003530 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003531 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003532 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003533 }
3534}
3535
Devang Patel2c4ceb12009-11-21 02:48:08 +00003536/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling94d04b82009-05-20 23:21:38 +00003537/// Section Header:
3538/// 1. length of section
3539/// 2. Dwarf version number
3540/// 3. address size.
3541///
3542/// Entries (one "entry" for each function that was inlined):
3543///
3544/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3545/// otherwise offset into __debug_str for regular function name.
3546/// 2. offset into __debug_str section for regular function name.
3547/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3548/// instances for the function.
3549///
3550/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3551/// inlined instance; the die_offset points to the inlined_subroutine die in the
3552/// __debug_info section, and the low_pc is the starting address for the
3553/// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003554void DwarfDebug::emitDebugInlineInfo() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003555 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003556 return;
3557
Devang Patel163a9f72010-05-10 22:49:55 +00003558 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00003559 return;
3560
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003561 Asm->OutStreamer.SwitchSection(
3562 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00003563
Chris Lattner233f52b2010-03-09 23:52:58 +00003564 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003565 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3566 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003567
Chris Lattnerc0215722010-04-04 19:25:43 +00003568 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003569
Chris Lattner233f52b2010-03-09 23:52:58 +00003570 Asm->OutStreamer.AddComment("Dwarf Version");
3571 Asm->EmitInt16(dwarf::DWARF_VERSION);
3572 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003573 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003574
Devang Patele9f8f5e2010-05-07 20:54:48 +00003575 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00003576 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00003577
Devang Patele9f8f5e2010-05-07 20:54:48 +00003578 const MDNode *Node = *I;
3579 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach7ab38df2009-11-22 19:20:36 +00003580 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00003581 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00003582 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00003583 StringRef LName = SP.getLinkageName();
3584 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00003585
Chris Lattner233f52b2010-03-09 23:52:58 +00003586 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003587 if (LName.empty()) {
3588 Asm->OutStreamer.EmitBytes(Name, 0);
3589 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
3590 } else
Chris Lattner6189ed12010-04-04 23:25:33 +00003591 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3592 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00003593
Chris Lattner233f52b2010-03-09 23:52:58 +00003594 Asm->OutStreamer.AddComment("Function name");
Chris Lattner6189ed12010-04-04 23:25:33 +00003595 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003596 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00003597
Devang Patel53bb5c92009-11-10 23:06:00 +00003598 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00003599 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00003600 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00003601 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003602
Chris Lattner3f53c832010-04-04 18:52:31 +00003603 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003604 Asm->OutStreamer.EmitSymbolValue(LI->first,
3605 Asm->getTargetData().getPointerSize(),0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003606 }
3607 }
3608
Chris Lattnerc0215722010-04-04 19:25:43 +00003609 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003610}