blob: 780fa405ef5122e1590956e9cfca6cedbe496880 [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"
Devang Patele449d1f2011-01-20 00:02:16 +000019#include "llvm/Instructions.h"
David Greeneb2c66fc2009-08-19 21:52:55 +000020#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling0310d762009-05-15 09:23:25 +000021#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000022#include "llvm/MC/MCAsmInfo.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000023#include "llvm/MC/MCSection.h"
Chris Lattner6c2f9e12009-08-19 05:49:37 +000024#include "llvm/MC/MCStreamer.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000025#include "llvm/MC/MCSymbol.h"
Chris Lattner45111d12010-01-16 21:57:06 +000026#include "llvm/Target/Mangler.h"
Bill Wendling0310d762009-05-15 09:23:25 +000027#include "llvm/Target/TargetData.h"
Anton Korobeynikov16c29b52011-01-10 12:39:04 +000028#include "llvm/Target/TargetFrameLowering.h"
Chris Lattnerf0144122009-07-28 03:13:23 +000029#include "llvm/Target/TargetLoweringObjectFile.h"
Chris Lattner9d1c1ad2010-04-04 18:06:11 +000030#include "llvm/Target/TargetMachine.h"
Chris Lattnerf0144122009-07-28 03:13:23 +000031#include "llvm/Target/TargetRegisterInfo.h"
Devang Patel2a4a3b72010-04-19 19:14:02 +000032#include "llvm/Target/TargetOptions.h"
Chris Lattner74e41f92010-04-05 05:24:55 +000033#include "llvm/Analysis/DebugInfo.h"
Devang Patel0eea95d2011-02-24 18:49:30 +000034#include "llvm/Analysis/DIBuilder.h"
Devang Patel9a31f0f2010-10-25 20:45:32 +000035#include "llvm/ADT/Statistic.h"
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +000036#include "llvm/ADT/STLExtras.h"
Chris Lattner23132b12009-08-24 03:52:50 +000037#include "llvm/ADT/StringExtras.h"
Devang Pateleac9c072010-04-27 19:46:33 +000038#include "llvm/Support/CommandLine.h"
Daniel Dunbar6e4bdfc2009-10-13 06:47:08 +000039#include "llvm/Support/Debug.h"
40#include "llvm/Support/ErrorHandling.h"
Devang Patel3139fcf2010-01-26 21:39:14 +000041#include "llvm/Support/ValueHandle.h"
Chris Lattner0ad9c912010-01-22 22:09:00 +000042#include "llvm/Support/FormattedStream.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000043#include "llvm/Support/Timer.h"
Michael J. Spencer1f6efa32010-11-29 18:16:10 +000044#include "llvm/Support/Path.h"
Bill Wendling0310d762009-05-15 09:23:25 +000045using namespace llvm;
46
Devang Pateleac9c072010-04-27 19:46:33 +000047static cl::opt<bool> PrintDbgScope("print-dbgscope", cl::Hidden,
48 cl::desc("Print DbgScope information for each machine instruction"));
49
Jim Grosbach1e20b962010-07-21 21:21:52 +000050static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel61409622010-07-07 20:12:52 +000051 cl::Hidden,
Devang Pateleac9c072010-04-27 19:46:33 +000052 cl::desc("Disable debug info printing"));
53
Dan Gohman281d65d2010-05-07 01:08:53 +000054static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
55 cl::desc("Make an absense of debug location information explicit."),
56 cl::init(false));
57
Nick Lewyckya568d662010-10-26 00:51:57 +000058#ifndef NDEBUG
Devang Patel9a31f0f2010-10-25 20:45:32 +000059STATISTIC(BlocksWithoutLineNo, "Number of blocks without any line number");
Nick Lewyckya568d662010-10-26 00:51:57 +000060#endif
Devang Patel9a31f0f2010-10-25 20:45:32 +000061
Bill Wendling5f017e82010-04-07 09:28:04 +000062namespace {
63 const char *DWARFGroupName = "DWARF Emission";
64 const char *DbgTimerName = "DWARF Debug Writer";
65} // end anonymous namespace
66
Bill Wendling0310d762009-05-15 09:23:25 +000067//===----------------------------------------------------------------------===//
68
69/// Configuration values for initial hash set sizes (log2).
70///
Bill Wendling0310d762009-05-15 09:23:25 +000071static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling0310d762009-05-15 09:23:25 +000072
73namespace llvm {
74
75//===----------------------------------------------------------------------===//
76/// CompileUnit - This dwarf writer support class manages information associate
77/// with a source file.
Nick Lewycky5f9843f2009-11-17 08:11:44 +000078class CompileUnit {
Bill Wendling0310d762009-05-15 09:23:25 +000079 /// ID - File identifier for source.
80 ///
81 unsigned ID;
82
83 /// Die - Compile unit debug information entry.
84 ///
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +000085 const OwningPtr<DIE> CUDie;
Bill Wendling0310d762009-05-15 09:23:25 +000086
Jeffrey Yasskind0f393d2010-03-11 18:29:55 +000087 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
Devang Patel6f01d9c2009-11-21 00:31:03 +000088 DIE *IndexTyDie;
89
Devang Patel869aa462010-07-07 20:49:57 +000090 /// MDNodeToDieMap - Tracks the mapping of unit level debug informaton
Bill Wendling0310d762009-05-15 09:23:25 +000091 /// variables to debug information entries.
Devang Patel869aa462010-07-07 20:49:57 +000092 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
Bill Wendling0310d762009-05-15 09:23:25 +000093
Devang Patel869aa462010-07-07 20:49:57 +000094 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug informaton
Bill Wendling0310d762009-05-15 09:23:25 +000095 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patel869aa462010-07-07 20:49:57 +000096 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
Bill Wendling0310d762009-05-15 09:23:25 +000097
98 /// Globals - A map of globally visible named entities for this unit.
99 ///
100 StringMap<DIE*> Globals;
101
Devang Patel193f7202009-11-24 01:14:22 +0000102 /// GlobalTypes - A map of globally visible types for this unit.
103 ///
104 StringMap<DIE*> GlobalTypes;
105
Bill Wendling0310d762009-05-15 09:23:25 +0000106public:
107 CompileUnit(unsigned I, DIE *D)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000108 : ID(I), CUDie(D), IndexTyDie(0) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000109
110 // Accessors.
Devang Patel193f7202009-11-24 01:14:22 +0000111 unsigned getID() const { return ID; }
Jeffrey Yasskind0f393d2010-03-11 18:29:55 +0000112 DIE* getCUDie() const { return CUDie.get(); }
Devang Patel193f7202009-11-24 01:14:22 +0000113 const StringMap<DIE*> &getGlobals() const { return Globals; }
114 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
Bill Wendling0310d762009-05-15 09:23:25 +0000115
116 /// hasContent - Return true if this compile unit has something to write out.
117 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000118 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendling0310d762009-05-15 09:23:25 +0000119
Devang Patel2c4ceb12009-11-21 02:48:08 +0000120 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendling0310d762009-05-15 09:23:25 +0000121 ///
Benjamin Kramerbbb88db2010-03-31 20:15:45 +0000122 void addGlobal(StringRef Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling0310d762009-05-15 09:23:25 +0000123
Devang Patel193f7202009-11-24 01:14:22 +0000124 /// addGlobalType - Add a new global type to the compile unit.
125 ///
Jim Grosbach1e20b962010-07-21 21:21:52 +0000126 void addGlobalType(StringRef Name, DIE *Die) {
127 GlobalTypes[Name] = Die;
Devang Patel193f7202009-11-24 01:14:22 +0000128 }
129
Devang Patel017d1212009-11-20 21:37:22 +0000130 /// getDIE - Returns the debug information entry map slot for the
Bill Wendling0310d762009-05-15 09:23:25 +0000131 /// specified debug variable.
Devang Patel869aa462010-07-07 20:49:57 +0000132 DIE *getDIE(const MDNode *N) { return MDNodeToDieMap.lookup(N); }
Jim Grosbach31ef40e2009-11-21 23:12:12 +0000133
Devang Patel017d1212009-11-20 21:37:22 +0000134 /// insertDIE - Insert DIE into the map.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000135 void insertDIE(const MDNode *N, DIE *D) {
Devang Patel869aa462010-07-07 20:49:57 +0000136 MDNodeToDieMap.insert(std::make_pair(N, D));
Devang Patel017d1212009-11-20 21:37:22 +0000137 }
Bill Wendling0310d762009-05-15 09:23:25 +0000138
Devang Patel017d1212009-11-20 21:37:22 +0000139 /// getDIEEntry - Returns the debug information entry for the speciefied
140 /// debug variable.
Jim Grosbach1e20b962010-07-21 21:21:52 +0000141 DIEEntry *getDIEEntry(const MDNode *N) {
142 DenseMap<const MDNode *, DIEEntry *>::iterator I =
143 MDNodeToDIEEntryMap.find(N);
Devang Patel869aa462010-07-07 20:49:57 +0000144 if (I == MDNodeToDIEEntryMap.end())
Devang Patel6404e4e2009-12-15 19:16:48 +0000145 return NULL;
146 return I->second;
147 }
Devang Patel017d1212009-11-20 21:37:22 +0000148
149 /// insertDIEEntry - Insert debug information entry into the map.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000150 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
Devang Patel869aa462010-07-07 20:49:57 +0000151 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
Bill Wendling0310d762009-05-15 09:23:25 +0000152 }
153
Devang Patel2c4ceb12009-11-21 02:48:08 +0000154 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendling0310d762009-05-15 09:23:25 +0000155 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000156 void addDie(DIE *Buffer) {
157 this->CUDie->addChild(Buffer);
Bill Wendling0310d762009-05-15 09:23:25 +0000158 }
Devang Patel6f01d9c2009-11-21 00:31:03 +0000159
160 // getIndexTyDie - Get an anonymous type for index type.
161 DIE *getIndexTyDie() {
162 return IndexTyDie;
163 }
164
Jim Grosbach7ab38df2009-11-22 19:20:36 +0000165 // setIndexTyDie - Set D as anonymous type for index which can be reused
166 // later.
Devang Patel6f01d9c2009-11-21 00:31:03 +0000167 void setIndexTyDie(DIE *D) {
168 IndexTyDie = D;
169 }
170
Bill Wendling0310d762009-05-15 09:23:25 +0000171};
172
173//===----------------------------------------------------------------------===//
174/// DbgVariable - This class is used to track local variable information.
175///
Devang Patelf76a3d62009-11-16 21:53:40 +0000176class DbgVariable {
Bill Wendling0310d762009-05-15 09:23:25 +0000177 DIVariable Var; // Variable Descriptor.
Devang Patelc3f5f782010-05-25 23:40:22 +0000178 DIE *TheDIE; // Variable DIE.
179 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
Bill Wendling0310d762009-05-15 09:23:25 +0000180public:
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000181 // AbsVar may be NULL.
Devang Patelc3f5f782010-05-25 23:40:22 +0000182 DbgVariable(DIVariable V) : Var(V), TheDIE(0), DotDebugLocOffset(~0U) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000183
184 // Accessors.
Devang Patel53bb5c92009-11-10 23:06:00 +0000185 DIVariable getVariable() const { return Var; }
Devang Patel53bb5c92009-11-10 23:06:00 +0000186 void setDIE(DIE *D) { TheDIE = D; }
187 DIE *getDIE() const { return TheDIE; }
Devang Patelc3f5f782010-05-25 23:40:22 +0000188 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
189 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
Devang Patel8bd11de2010-08-09 21:01:39 +0000190 StringRef getName() const { return Var.getName(); }
191 unsigned getTag() const { return Var.getTag(); }
192 bool variableHasComplexAddress() const {
193 assert(Var.Verify() && "Invalid complex DbgVariable!");
194 return Var.hasComplexAddress();
195 }
196 bool isBlockByrefVariable() const {
197 assert(Var.Verify() && "Invalid complex DbgVariable!");
198 return Var.isBlockByrefVariable();
199 }
200 unsigned getNumAddrElements() const {
201 assert(Var.Verify() && "Invalid complex DbgVariable!");
202 return Var.getNumAddrElements();
203 }
204 uint64_t getAddrElement(unsigned i) const {
205 return Var.getAddrElement(i);
206 }
207 DIType getType() const {
208 DIType Ty = Var.getType();
209 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
210 // addresses instead.
211 if (Var.isBlockByrefVariable()) {
212 /* Byref variables, in Blocks, are declared by the programmer as
213 "SomeType VarName;", but the compiler creates a
214 __Block_byref_x_VarName struct, and gives the variable VarName
215 either the struct, or a pointer to the struct, as its type. This
216 is necessary for various behind-the-scenes things the compiler
217 needs to do with by-reference variables in blocks.
218
219 However, as far as the original *programmer* is concerned, the
220 variable should still have type 'SomeType', as originally declared.
221
222 The following function dives into the __Block_byref_x_VarName
223 struct to find the original type of the variable. This will be
224 passed back to the code generating the type for the Debug
225 Information Entry for the variable 'VarName'. 'VarName' will then
226 have the original type 'SomeType' in its debug information.
227
228 The original type 'SomeType' will be the type of the field named
229 'VarName' inside the __Block_byref_x_VarName struct.
230
231 NOTE: In order for this to not completely fail on the debugger
232 side, the Debug Information Entry for the variable VarName needs to
233 have a DW_AT_location that tells the debugger how to unwind through
234 the pointers and __Block_byref_x_VarName struct to find the actual
235 value of the variable. The function addBlockByrefType does this. */
236 DIType subType = Ty;
237 unsigned tag = Ty.getTag();
238
239 if (tag == dwarf::DW_TAG_pointer_type) {
240 DIDerivedType DTy = DIDerivedType(Ty);
241 subType = DTy.getTypeDerivedFrom();
242 }
243
244 DICompositeType blockStruct = DICompositeType(subType);
245 DIArray Elements = blockStruct.getTypeArray();
246
247 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
248 DIDescriptor Element = Elements.getElement(i);
249 DIDerivedType DT = DIDerivedType(Element);
250 if (getName() == DT.getName())
251 return (DT.getTypeDerivedFrom());
252 }
253 return Ty;
254 }
255 return Ty;
256 }
Bill Wendling0310d762009-05-15 09:23:25 +0000257};
258
259//===----------------------------------------------------------------------===//
Devang Pateleac9c072010-04-27 19:46:33 +0000260/// DbgRange - This is used to track range of instructions with identical
261/// debug info scope.
262///
263typedef std::pair<const MachineInstr *, const MachineInstr *> DbgRange;
264
265//===----------------------------------------------------------------------===//
Bill Wendling0310d762009-05-15 09:23:25 +0000266/// DbgScope - This class is used to track scope information.
267///
Devang Patelf76a3d62009-11-16 21:53:40 +0000268class DbgScope {
Bill Wendling0310d762009-05-15 09:23:25 +0000269 DbgScope *Parent; // Parent to this scope.
Jim Grosbach31ef40e2009-11-21 23:12:12 +0000270 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel3139fcf2010-01-26 21:39:14 +0000271 // Location at which this scope is inlined.
Jim Grosbach1e20b962010-07-21 21:21:52 +0000272 AssertingVH<const MDNode> InlinedAtLocation;
Devang Patel53bb5c92009-11-10 23:06:00 +0000273 bool AbstractScope; // Abstract Scope
Devang Pateld38dd112009-10-01 18:25:23 +0000274 const MachineInstr *LastInsn; // Last instruction of this scope.
275 const MachineInstr *FirstInsn; // First instruction of this scope.
Devang Pateleac9c072010-04-27 19:46:33 +0000276 unsigned DFSIn, DFSOut;
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000277 // Scopes defined in scope. Contents not owned.
278 SmallVector<DbgScope *, 4> Scopes;
279 // Variables declared in scope. Contents owned.
280 SmallVector<DbgVariable *, 8> Variables;
Devang Pateleac9c072010-04-27 19:46:33 +0000281 SmallVector<DbgRange, 4> Ranges;
Owen Anderson04c05f72009-06-24 22:53:20 +0000282 // Private state for dump()
283 mutable unsigned IndentLevel;
Bill Wendling0310d762009-05-15 09:23:25 +0000284public:
Devang Patele9f8f5e2010-05-07 20:54:48 +0000285 DbgScope(DbgScope *P, DIDescriptor D, const MDNode *I = 0)
Devang Patel53bb5c92009-11-10 23:06:00 +0000286 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Devang Pateleac9c072010-04-27 19:46:33 +0000287 LastInsn(0), FirstInsn(0),
288 DFSIn(0), DFSOut(0), IndentLevel(0) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000289 virtual ~DbgScope();
290
291 // Accessors.
292 DbgScope *getParent() const { return Parent; }
Devang Patel53bb5c92009-11-10 23:06:00 +0000293 void setParent(DbgScope *P) { Parent = P; }
Bill Wendling0310d762009-05-15 09:23:25 +0000294 DIDescriptor getDesc() const { return Desc; }
Devang Patele9f8f5e2010-05-07 20:54:48 +0000295 const MDNode *getInlinedAt() const { return InlinedAtLocation; }
296 const MDNode *getScopeNode() const { return Desc; }
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000297 const SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
Devang Patele03161c2010-08-09 18:51:29 +0000298 const SmallVector<DbgVariable *, 8> &getDbgVariables() { return Variables; }
Devang Pateleac9c072010-04-27 19:46:33 +0000299 const SmallVector<DbgRange, 4> &getRanges() { return Ranges; }
300
301 /// openInsnRange - This scope covers instruction range starting from MI.
302 void openInsnRange(const MachineInstr *MI) {
Jim Grosbach1e20b962010-07-21 21:21:52 +0000303 if (!FirstInsn)
Devang Pateleac9c072010-04-27 19:46:33 +0000304 FirstInsn = MI;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000305
Devang Pateleac9c072010-04-27 19:46:33 +0000306 if (Parent)
307 Parent->openInsnRange(MI);
308 }
309
Jim Grosbach1e20b962010-07-21 21:21:52 +0000310 /// extendInsnRange - Extend the current instruction range covered by
Devang Pateleac9c072010-04-27 19:46:33 +0000311 /// this scope.
312 void extendInsnRange(const MachineInstr *MI) {
313 assert (FirstInsn && "MI Range is not open!");
314 LastInsn = MI;
315 if (Parent)
316 Parent->extendInsnRange(MI);
317 }
318
319 /// closeInsnRange - Create a range based on FirstInsn and LastInsn collected
320 /// until now. This is used when a new scope is encountered while walking
321 /// machine instructions.
322 void closeInsnRange(DbgScope *NewScope = NULL) {
323 assert (LastInsn && "Last insn missing!");
324 Ranges.push_back(DbgRange(FirstInsn, LastInsn));
Jim Grosbach1e20b962010-07-21 21:21:52 +0000325 FirstInsn = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +0000326 LastInsn = NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000327 // If Parent dominates NewScope then do not close Parent's instruction
Devang Pateleac9c072010-04-27 19:46:33 +0000328 // range.
329 if (Parent && (!NewScope || !Parent->dominates(NewScope)))
330 Parent->closeInsnRange(NewScope);
331 }
332
Devang Patel53bb5c92009-11-10 23:06:00 +0000333 void setAbstractScope() { AbstractScope = true; }
334 bool isAbstractScope() const { return AbstractScope; }
Devang Pateleac9c072010-04-27 19:46:33 +0000335
336 // Depth First Search support to walk and mainpluate DbgScope hierarchy.
337 unsigned getDFSOut() const { return DFSOut; }
338 void setDFSOut(unsigned O) { DFSOut = O; }
339 unsigned getDFSIn() const { return DFSIn; }
340 void setDFSIn(unsigned I) { DFSIn = I; }
341 bool dominates(const DbgScope *S) {
Jim Grosbach1e20b962010-07-21 21:21:52 +0000342 if (S == this)
Devang Pateleac9c072010-04-27 19:46:33 +0000343 return true;
344 if (DFSIn < S->getDFSIn() && DFSOut > S->getDFSOut())
345 return true;
346 return false;
347 }
Devang Patel53bb5c92009-11-10 23:06:00 +0000348
Devang Patel2c4ceb12009-11-21 02:48:08 +0000349 /// addScope - Add a scope to the scope.
Bill Wendling0310d762009-05-15 09:23:25 +0000350 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000351 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendling0310d762009-05-15 09:23:25 +0000352
Devang Patel2c4ceb12009-11-21 02:48:08 +0000353 /// addVariable - Add a variable to the scope.
Bill Wendling0310d762009-05-15 09:23:25 +0000354 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000355 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendling0310d762009-05-15 09:23:25 +0000356
Bill Wendling0310d762009-05-15 09:23:25 +0000357#ifndef NDEBUG
358 void dump() const;
359#endif
360};
Devang Pateleac9c072010-04-27 19:46:33 +0000361
Chris Lattnerea761862010-04-05 04:09:20 +0000362} // end llvm namespace
Bill Wendling0310d762009-05-15 09:23:25 +0000363
364#ifndef NDEBUG
365void DbgScope::dump() const {
David Greenef83adbc2009-12-24 00:31:35 +0000366 raw_ostream &err = dbgs();
Chris Lattnerc281de12009-08-23 00:51:00 +0000367 err.indent(IndentLevel);
Devang Patele9f8f5e2010-05-07 20:54:48 +0000368 const MDNode *N = Desc;
Devang Patel53bb5c92009-11-10 23:06:00 +0000369 N->dump();
Devang Patel53bb5c92009-11-10 23:06:00 +0000370 if (AbstractScope)
371 err << "Abstract Scope\n";
Bill Wendling0310d762009-05-15 09:23:25 +0000372
373 IndentLevel += 2;
Devang Patel53bb5c92009-11-10 23:06:00 +0000374 if (!Scopes.empty())
375 err << "Children ...\n";
Bill Wendling0310d762009-05-15 09:23:25 +0000376 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
377 if (Scopes[i] != this)
378 Scopes[i]->dump();
379
380 IndentLevel -= 2;
381}
382#endif
383
Bill Wendling0310d762009-05-15 09:23:25 +0000384DbgScope::~DbgScope() {
Bill Wendling0310d762009-05-15 09:23:25 +0000385 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
386 delete Variables[j];
Bill Wendling0310d762009-05-15 09:23:25 +0000387}
388
Chris Lattner49cd6642010-04-05 05:11:15 +0000389DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Devang Patel163a9f72010-05-10 22:49:55 +0000390 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbach1e20b962010-07-21 21:21:52 +0000391 AbbreviationsSet(InitAbbreviationsSetSize),
Devang Patelf2548ca2010-04-16 23:33:45 +0000392 CurrentFnDbgScope(0), PrevLabel(NULL) {
Chris Lattnerbc733f52010-03-13 02:17:42 +0000393 NextStringPoolNumber = 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000394
Chris Lattner4ad1efe2010-04-04 23:10:38 +0000395 DwarfFrameSectionSym = DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
396 DwarfStrSectionSym = TextSectionSym = 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000397 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
Devang Patelc3f5f782010-05-25 23:40:22 +0000398 FunctionBeginSym = FunctionEndSym = 0;
Devang Patelca76f6f2010-07-08 20:10:35 +0000399 DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
Dan Gohman03c3dc72010-06-18 15:56:31 +0000400 {
401 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
402 beginModule(M);
Torok Edwin9c421072010-04-07 10:44:46 +0000403 }
Bill Wendling0310d762009-05-15 09:23:25 +0000404}
405DwarfDebug::~DwarfDebug() {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000406 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
407 DIEBlocks[j]->~DIEBlock();
Bill Wendling0310d762009-05-15 09:23:25 +0000408}
409
Chris Lattnerbc733f52010-03-13 02:17:42 +0000410MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
411 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
412 if (Entry.first) return Entry.first;
413
414 Entry.second = NextStringPoolNumber++;
Chris Lattnerc0215722010-04-04 19:25:43 +0000415 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerbc733f52010-03-13 02:17:42 +0000416}
417
418
Devang Patel2c4ceb12009-11-21 02:48:08 +0000419/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling0310d762009-05-15 09:23:25 +0000420///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000421void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling0310d762009-05-15 09:23:25 +0000422 // Profile the node so that we can make it unique.
423 FoldingSetNodeID ID;
424 Abbrev.Profile(ID);
425
426 // Check the set for priors.
427 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
428
429 // If it's newly added.
430 if (InSet == &Abbrev) {
431 // Add to abbreviation list.
432 Abbreviations.push_back(&Abbrev);
433
434 // Assign the vector position + 1 as its number.
435 Abbrev.setNumber(Abbreviations.size());
436 } else {
437 // Assign existing abbreviation number.
438 Abbrev.setNumber(InSet->getNumber());
439 }
440}
441
Devang Patel2c4ceb12009-11-21 02:48:08 +0000442/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendling995f80a2009-05-20 23:24:48 +0000443/// information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000444DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000445 DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000446 return Value;
447}
448
Devang Patel2c4ceb12009-11-21 02:48:08 +0000449/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000450///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000451void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000452 unsigned Form, uint64_t Integer) {
453 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000454 DIEValue *Value = Integer == 1 ?
Devang Patelca76f6f2010-07-08 20:10:35 +0000455 DIEIntegerOne : new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000456 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000457}
458
Devang Patel2c4ceb12009-11-21 02:48:08 +0000459/// addSInt - Add an signed integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000460///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000461void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000462 unsigned Form, int64_t Integer) {
463 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000464 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000465 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000466}
467
Devang Patel69f57b12009-12-02 15:25:16 +0000468/// addString - Add a string attribute data and value. DIEString only
Jim Grosbach1e20b962010-07-21 21:21:52 +0000469/// keeps string reference.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000470void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattner4cf202b2010-01-23 03:11:46 +0000471 StringRef String) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000472 DIEValue *Value = new (DIEValueAllocator) DIEString(String);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000473 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000474}
475
Devang Patel2c4ceb12009-11-21 02:48:08 +0000476/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000477///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000478void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerb98b1bf2010-03-08 22:23:36 +0000479 const MCSymbol *Label) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000480 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000481 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000482}
483
Devang Patel2c4ceb12009-11-21 02:48:08 +0000484/// addDelta - Add a label delta attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000485///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000486void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerb98b1bf2010-03-08 22:23:36 +0000487 const MCSymbol *Hi, const MCSymbol *Lo) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000488 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000489 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000490}
491
Chris Lattner74e41f92010-04-05 05:24:55 +0000492/// addDIEEntry - Add a DIE attribute data and value.
493///
494void DwarfDebug::addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form,
495 DIE *Entry) {
496 Die->addValue(Attribute, Form, createDIEEntry(Entry));
497}
498
499
Devang Patel2c4ceb12009-11-21 02:48:08 +0000500/// addBlock - Add block data.
Bill Wendling0310d762009-05-15 09:23:25 +0000501///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000502void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000503 DIEBlock *Block) {
Chris Lattnera37d5382010-04-05 00:18:22 +0000504 Block->ComputeSize(Asm);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000505 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000506 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000507}
508
Devang Patel2c4ceb12009-11-21 02:48:08 +0000509/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000510/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000511void DwarfDebug::addSourceLine(DIE *Die, DIVariable V) {
Devang Patelc665a512010-05-07 23:33:41 +0000512 // Verify variable.
Devang Patel81625742010-08-09 20:20:05 +0000513 if (!V.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000514 return;
515
Devang Patel81625742010-08-09 20:20:05 +0000516 unsigned Line = V.getLineNumber();
Devang Patelb2bada32010-10-08 17:18:54 +0000517 if (Line == 0)
518 return;
Rafael Espindola5c055632010-11-18 02:04:25 +0000519 unsigned FileID = GetOrCreateSourceID(V.getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000520 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000521 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
522 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000523}
524
Devang Patel2c4ceb12009-11-21 02:48:08 +0000525/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000526/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000527void DwarfDebug::addSourceLine(DIE *Die, DIGlobalVariable G) {
Devang Patelc665a512010-05-07 23:33:41 +0000528 // Verify global variable.
Devang Patel81625742010-08-09 20:20:05 +0000529 if (!G.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000530 return;
531
Devang Patel81625742010-08-09 20:20:05 +0000532 unsigned Line = G.getLineNumber();
Devang Patelb2bada32010-10-08 17:18:54 +0000533 if (Line == 0)
534 return;
Rafael Espindola5c055632010-11-18 02:04:25 +0000535 unsigned FileID = GetOrCreateSourceID(G.getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000536 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000537 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
538 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000539}
Devang Patel82dfc0c2009-08-31 22:47:13 +0000540
Devang Patel2c4ceb12009-11-21 02:48:08 +0000541/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000542/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000543void DwarfDebug::addSourceLine(DIE *Die, DISubprogram SP) {
Devang Patelc665a512010-05-07 23:33:41 +0000544 // Verify subprogram.
Devang Patel81625742010-08-09 20:20:05 +0000545 if (!SP.Verify())
Devang Patel82dfc0c2009-08-31 22:47:13 +0000546 return;
Caroline Ticec6f9d622009-09-11 18:25:54 +0000547 // If the line number is 0, don't add it.
Devang Patel81625742010-08-09 20:20:05 +0000548 if (SP.getLineNumber() == 0)
Caroline Ticec6f9d622009-09-11 18:25:54 +0000549 return;
550
Devang Patel81625742010-08-09 20:20:05 +0000551 unsigned Line = SP.getLineNumber();
552 if (!SP.getContext().Verify())
Devang Patel77bf2952010-03-08 22:02:50 +0000553 return;
Rafael Espindola5c055632010-11-18 02:04:25 +0000554 unsigned FileID = GetOrCreateSourceID(SP.getFilename());
Devang Patel82dfc0c2009-08-31 22:47:13 +0000555 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000556 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
557 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patel82dfc0c2009-08-31 22:47:13 +0000558}
559
Devang Patel2c4ceb12009-11-21 02:48:08 +0000560/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000561/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000562void DwarfDebug::addSourceLine(DIE *Die, DIType Ty) {
Devang Patelc665a512010-05-07 23:33:41 +0000563 // Verify type.
Devang Patel81625742010-08-09 20:20:05 +0000564 if (!Ty.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000565 return;
566
Devang Patel81625742010-08-09 20:20:05 +0000567 unsigned Line = Ty.getLineNumber();
Devang Patelb2bada32010-10-08 17:18:54 +0000568 if (Line == 0 || !Ty.getContext().Verify())
Devang Patel77bf2952010-03-08 22:02:50 +0000569 return;
Rafael Espindola5c055632010-11-18 02:04:25 +0000570 unsigned FileID = GetOrCreateSourceID(Ty.getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000571 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000572 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
573 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000574}
575
Devang Patel6404e4e2009-12-15 19:16:48 +0000576/// addSourceLine - Add location information to specified debug information
577/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000578void DwarfDebug::addSourceLine(DIE *Die, DINameSpace NS) {
Devang Patelc665a512010-05-07 23:33:41 +0000579 // Verify namespace.
Devang Patel81625742010-08-09 20:20:05 +0000580 if (!NS.Verify())
Devang Patel6404e4e2009-12-15 19:16:48 +0000581 return;
582
Devang Patel81625742010-08-09 20:20:05 +0000583 unsigned Line = NS.getLineNumber();
Devang Patelb2bada32010-10-08 17:18:54 +0000584 if (Line == 0)
585 return;
Devang Patel81625742010-08-09 20:20:05 +0000586 StringRef FN = NS.getFilename();
Devang Patel6404e4e2009-12-15 19:16:48 +0000587
Rafael Espindola5c055632010-11-18 02:04:25 +0000588 unsigned FileID = GetOrCreateSourceID(FN);
Devang Patel6404e4e2009-12-15 19:16:48 +0000589 assert(FileID && "Invalid file id");
590 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
591 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
592}
593
Devang Patel9e3bd2c2010-08-31 06:11:28 +0000594/// addVariableAddress - Add DW_AT_location attribute for a DbgVariable based
595/// on provided frame index.
596void DwarfDebug::addVariableAddress(DbgVariable *&DV, DIE *Die, int64_t FI) {
597 MachineLocation Location;
598 unsigned FrameReg;
Anton Korobeynikov16c29b52011-01-10 12:39:04 +0000599 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
Anton Korobeynikov82f58742010-11-20 15:59:32 +0000600 int Offset = TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
Devang Patel9e3bd2c2010-08-31 06:11:28 +0000601 Location.set(FrameReg, Offset);
602
Devang Patel8bd11de2010-08-09 21:01:39 +0000603 if (DV->variableHasComplexAddress())
604 addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
605 else if (DV->isBlockByrefVariable())
606 addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
607 else
608 addAddress(Die, dwarf::DW_AT_location, Location);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000609}
610
Devang Patel2c4ceb12009-11-21 02:48:08 +0000611/// addComplexAddress - Start with the address based on the location provided,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000612/// and generate the DWARF information necessary to find the actual variable
613/// given the extra address information encoded in the DIVariable, starting from
614/// the starting location. Add the DWARF information to the die.
615///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000616void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000617 unsigned Attribute,
618 const MachineLocation &Location) {
Devang Patel8bd11de2010-08-09 21:01:39 +0000619 DIType Ty = DV->getType();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000620
621 // Decode the original location, and use that as the start of the byref
622 // variable's location.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000623 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000624 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000625 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000626
627 if (Location.isReg()) {
628 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000629 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000630 } else {
Devang Pateldacde942011-01-19 23:04:47 +0000631 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000632 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000633 }
634 } else {
635 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000636 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000637 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000638 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
639 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000640 }
641
Devang Patel2c4ceb12009-11-21 02:48:08 +0000642 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000643 }
644
Devang Patel8bd11de2010-08-09 21:01:39 +0000645 for (unsigned i = 0, N = DV->getNumAddrElements(); i < N; ++i) {
646 uint64_t Element = DV->getAddrElement(i);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000647
Devang Patel0eea95d2011-02-24 18:49:30 +0000648 if (Element == DIBuilder::OpPlus) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000649 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel8bd11de2010-08-09 21:01:39 +0000650 addUInt(Block, 0, dwarf::DW_FORM_udata, DV->getAddrElement(++i));
Devang Patel0eea95d2011-02-24 18:49:30 +0000651 } else if (Element == DIBuilder::OpDeref) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000652 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Devang Patel0eea95d2011-02-24 18:49:30 +0000653 } else llvm_unreachable("unknown DIBuilder Opcode");
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000654 }
655
656 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000657 addBlock(Die, Attribute, 0, Block);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000658}
659
Caroline Ticedc8f6042009-08-31 21:19:37 +0000660/* Byref variables, in Blocks, are declared by the programmer as "SomeType
661 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
662 gives the variable VarName either the struct, or a pointer to the struct, as
663 its type. This is necessary for various behind-the-scenes things the
664 compiler needs to do with by-reference variables in Blocks.
665
666 However, as far as the original *programmer* is concerned, the variable
667 should still have type 'SomeType', as originally declared.
668
Devang Patel2c4ceb12009-11-21 02:48:08 +0000669 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000670 struct to find the original type of the variable, which is then assigned to
671 the variable's Debug Information Entry as its real type. So far, so good.
672 However now the debugger will expect the variable VarName to have the type
673 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000674 expression that explains to the debugger how to navigate through the
Caroline Ticedc8f6042009-08-31 21:19:37 +0000675 pointers and struct to find the actual variable of type SomeType.
676
677 The following function does just that. We start by getting
678 the "normal" location for the variable. This will be the location
679 of either the struct __Block_byref_x_VarName or the pointer to the
680 struct __Block_byref_x_VarName.
681
682 The struct will look something like:
683
684 struct __Block_byref_x_VarName {
685 ... <various fields>
686 struct __Block_byref_x_VarName *forwarding;
687 ... <various other fields>
688 SomeType VarName;
689 ... <maybe more fields>
690 };
691
692 If we are given the struct directly (as our starting point) we
693 need to tell the debugger to:
694
695 1). Add the offset of the forwarding field.
696
Dan Gohmanf451cb82010-02-10 16:03:48 +0000697 2). Follow that pointer to get the real __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000698 struct to use (the real one may have been copied onto the heap).
699
700 3). Add the offset for the field VarName, to find the actual variable.
701
702 If we started with a pointer to the struct, then we need to
703 dereference that pointer first, before the other steps.
704 Translating this into DWARF ops, we will need to append the following
705 to the current location description for the variable:
706
707 DW_OP_deref -- optional, if we start with a pointer
708 DW_OP_plus_uconst <forward_fld_offset>
709 DW_OP_deref
710 DW_OP_plus_uconst <varName_fld_offset>
711
712 That is what this function does. */
713
Devang Patel2c4ceb12009-11-21 02:48:08 +0000714/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticedc8f6042009-08-31 21:19:37 +0000715/// provided, and generate the DWARF information necessary to find the
716/// actual Block variable (navigating the Block struct) based on the
717/// starting location. Add the DWARF information to the die. For
718/// more information, read large comment just above here.
719///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000720void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbar00564992009-09-19 20:40:14 +0000721 unsigned Attribute,
722 const MachineLocation &Location) {
Devang Patel8bd11de2010-08-09 21:01:39 +0000723 DIType Ty = DV->getType();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000724 DIType TmpTy = Ty;
725 unsigned Tag = Ty.getTag();
726 bool isPointer = false;
727
Devang Patel8bd11de2010-08-09 21:01:39 +0000728 StringRef varName = DV->getName();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000729
730 if (Tag == dwarf::DW_TAG_pointer_type) {
Devang Patel2db49d72010-05-07 18:11:54 +0000731 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000732 TmpTy = DTy.getTypeDerivedFrom();
733 isPointer = true;
734 }
735
Devang Patel2db49d72010-05-07 18:11:54 +0000736 DICompositeType blockStruct = DICompositeType(TmpTy);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000737
Daniel Dunbar00564992009-09-19 20:40:14 +0000738 // Find the __forwarding field and the variable field in the __Block_byref
739 // struct.
Daniel Dunbar00564992009-09-19 20:40:14 +0000740 DIArray Fields = blockStruct.getTypeArray();
741 DIDescriptor varField = DIDescriptor();
742 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000743
Daniel Dunbar00564992009-09-19 20:40:14 +0000744 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
745 DIDescriptor Element = Fields.getElement(i);
Devang Patel2db49d72010-05-07 18:11:54 +0000746 DIDerivedType DT = DIDerivedType(Element);
Devang Patel65dbc902009-11-25 17:36:49 +0000747 StringRef fieldName = DT.getName();
748 if (fieldName == "__forwarding")
Daniel Dunbar00564992009-09-19 20:40:14 +0000749 forwardingField = Element;
Devang Patel65dbc902009-11-25 17:36:49 +0000750 else if (fieldName == varName)
Daniel Dunbar00564992009-09-19 20:40:14 +0000751 varField = Element;
752 }
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000753
Daniel Dunbar00564992009-09-19 20:40:14 +0000754 // Get the offsets for the forwarding field and the variable field.
Chris Lattner1d65ba72010-03-31 06:06:37 +0000755 unsigned forwardingFieldOffset =
Devang Patel2db49d72010-05-07 18:11:54 +0000756 DIDerivedType(forwardingField).getOffsetInBits() >> 3;
Chris Lattner1d65ba72010-03-31 06:06:37 +0000757 unsigned varFieldOffset =
Devang Patel2db49d72010-05-07 18:11:54 +0000758 DIDerivedType(varField).getOffsetInBits() >> 3;
Caroline Ticedc8f6042009-08-31 21:19:37 +0000759
Mike Stump7e3720d2009-09-24 23:21:26 +0000760 // Decode the original location, and use that as the start of the byref
761 // variable's location.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000762 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Daniel Dunbar00564992009-09-19 20:40:14 +0000763 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000764 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000765
Daniel Dunbar00564992009-09-19 20:40:14 +0000766 if (Location.isReg()) {
767 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000768 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000769 else {
Devang Pateldacde942011-01-19 23:04:47 +0000770 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000771 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000772 }
773 } else {
774 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000775 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000776 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000777 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
778 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000779 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000780
Devang Patel2c4ceb12009-11-21 02:48:08 +0000781 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbar00564992009-09-19 20:40:14 +0000782 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000783
Mike Stump7e3720d2009-09-24 23:21:26 +0000784 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbar00564992009-09-19 20:40:14 +0000785 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbar00564992009-09-19 20:40:14 +0000786 if (isPointer)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000787 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000788
Daniel Dunbar00564992009-09-19 20:40:14 +0000789 // Next add the offset for the '__forwarding' field:
790 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
791 // adding the offset if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000792 if (forwardingFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000793 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
794 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000795 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000796
Daniel Dunbar00564992009-09-19 20:40:14 +0000797 // Now dereference the __forwarding field to get to the real __Block_byref
798 // struct: DW_OP_deref.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000799 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000800
Daniel Dunbar00564992009-09-19 20:40:14 +0000801 // Now that we've got the real __Block_byref... struct, add the offset
802 // for the variable's field to get to the location of the actual variable:
803 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000804 if (varFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000805 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
806 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000807 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000808
Daniel Dunbar00564992009-09-19 20:40:14 +0000809 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000810 addBlock(Die, Attribute, 0, Block);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000811}
812
Devang Patel2c4ceb12009-11-21 02:48:08 +0000813/// addAddress - Add an address attribute to a die based on the location
Bill Wendling0310d762009-05-15 09:23:25 +0000814/// provided.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000815void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000816 const MachineLocation &Location) {
Chris Lattnerd38fee82010-04-05 00:13:49 +0000817 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling0310d762009-05-15 09:23:25 +0000818 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000819 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patelbe90c3a2010-09-22 21:10:38 +0000820
Devang Patelc8821042010-11-02 17:37:00 +0000821 if (RI->getFrameRegister(*Asm->MF) == Location.getReg()
Devang Patelbe90c3a2010-09-22 21:10:38 +0000822 && Location.getOffset()) {
823 // If variable offset is based in frame register then use fbreg.
824 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
825 addSInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
826 addBlock(Die, Attribute, 0, Block);
827 return;
828 }
Bill Wendling0310d762009-05-15 09:23:25 +0000829
830 if (Location.isReg()) {
831 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000832 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000833 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000834 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
835 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000836 }
837 } else {
838 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000839 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000840 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000841 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
842 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000843 }
844
Devang Patel2c4ceb12009-11-21 02:48:08 +0000845 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling0310d762009-05-15 09:23:25 +0000846 }
847
Devang Patel2c4ceb12009-11-21 02:48:08 +0000848 addBlock(Die, Attribute, 0, Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000849}
850
Devang Patela43098d2010-04-28 01:03:09 +0000851/// addRegisterAddress - Add register location entry in variable DIE.
Devang Patel522ad742010-11-12 23:20:42 +0000852bool DwarfDebug::addRegisterAddress(DIE *Die, const MachineOperand &MO) {
Devang Patela43098d2010-04-28 01:03:09 +0000853 assert (MO.isReg() && "Invalid machine operand!");
854 if (!MO.getReg())
855 return false;
856 MachineLocation Location;
857 Location.set(MO.getReg());
858 addAddress(Die, dwarf::DW_AT_location, Location);
Devang Patela43098d2010-04-28 01:03:09 +0000859 return true;
860}
861
862/// addConstantValue - Add constant value entry in variable DIE.
Devang Patel522ad742010-11-12 23:20:42 +0000863bool DwarfDebug::addConstantValue(DIE *Die, const MachineOperand &MO) {
Devang Patela43098d2010-04-28 01:03:09 +0000864 assert (MO.isImm() && "Invalid machine operand!");
865 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
866 unsigned Imm = MO.getImm();
867 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
868 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patela43098d2010-04-28 01:03:09 +0000869 return true;
870}
871
872/// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patel522ad742010-11-12 23:20:42 +0000873bool DwarfDebug::addConstantFPValue(DIE *Die, const MachineOperand &MO) {
Devang Patela43098d2010-04-28 01:03:09 +0000874 assert (MO.isFPImm() && "Invalid machine operand!");
875 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
876 APFloat FPImm = MO.getFPImm()->getValueAPF();
Jim Grosbach1e20b962010-07-21 21:21:52 +0000877
Devang Patela43098d2010-04-28 01:03:09 +0000878 // Get the raw data form of the floating point.
879 const APInt FltVal = FPImm.bitcastToAPInt();
880 const char *FltPtr = (const char*)FltVal.getRawData();
Jim Grosbach1e20b962010-07-21 21:21:52 +0000881
Devang Patela43098d2010-04-28 01:03:09 +0000882 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
883 bool LittleEndian = Asm->getTargetData().isLittleEndian();
884 int Incr = (LittleEndian ? 1 : -1);
885 int Start = (LittleEndian ? 0 : NumBytes - 1);
886 int Stop = (LittleEndian ? NumBytes : -1);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000887
Devang Patela43098d2010-04-28 01:03:09 +0000888 // Output the constant to DWARF one byte at a time.
889 for (; Start != Stop; Start += Incr)
890 addUInt(Block, 0, dwarf::DW_FORM_data1,
891 (unsigned char)0xFF & FltPtr[Start]);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000892
Devang Patela43098d2010-04-28 01:03:09 +0000893 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000894 return true;
Devang Patela43098d2010-04-28 01:03:09 +0000895}
896
Devang Patel76a788c2011-01-06 21:39:25 +0000897/// addConstantValue - Add constant value entry in variable DIE.
898bool DwarfDebug::addConstantValue(DIE *Die, ConstantInt *CI,
899 bool Unsigned) {
900 if (CI->getBitWidth() <= 64) {
901 if (Unsigned)
902 addUInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
903 CI->getZExtValue());
904 else
905 addSInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
906 CI->getSExtValue());
907 return true;
908 }
909
910 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
911
912 // Get the raw data form of the large APInt.
913 const APInt Val = CI->getValue();
914 const char *Ptr = (const char*)Val.getRawData();
915
916 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
917 bool LittleEndian = Asm->getTargetData().isLittleEndian();
918 int Incr = (LittleEndian ? 1 : -1);
919 int Start = (LittleEndian ? 0 : NumBytes - 1);
920 int Stop = (LittleEndian ? NumBytes : -1);
921
922 // Output the constant to DWARF one byte at a time.
923 for (; Start != Stop; Start += Incr)
924 addUInt(Block, 0, dwarf::DW_FORM_data1,
925 (unsigned char)0xFF & Ptr[Start]);
926
927 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
928 return true;
929}
Devang Patela43098d2010-04-28 01:03:09 +0000930
Devang Patelc366f832009-12-10 19:14:49 +0000931/// addToContextOwner - Add Die into the list of its context owner's children.
932void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3c91b052010-03-08 20:52:55 +0000933 if (Context.isType()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000934 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
Devang Patelc366f832009-12-10 19:14:49 +0000935 ContextDIE->addChild(Die);
Devang Patel6404e4e2009-12-15 19:16:48 +0000936 } else if (Context.isNameSpace()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000937 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
Devang Patel6404e4e2009-12-15 19:16:48 +0000938 ContextDIE->addChild(Die);
Stuart Hastings215aa152010-06-11 20:08:44 +0000939 } else if (Context.isSubprogram()) {
Devang Patelee70fa72010-09-27 23:15:27 +0000940 DIE *ContextDIE = createSubprogramDIE(DISubprogram(Context));
Stuart Hastings215aa152010-06-11 20:08:44 +0000941 ContextDIE->addChild(Die);
Devang Patel163a9f72010-05-10 22:49:55 +0000942 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patelc366f832009-12-10 19:14:49 +0000943 ContextDIE->addChild(Die);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000944 else
Devang Patel163a9f72010-05-10 22:49:55 +0000945 getCompileUnit(Context)->addDie(Die);
Devang Patelc366f832009-12-10 19:14:49 +0000946}
947
Devang Patel16ced732009-12-10 18:05:33 +0000948/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
949/// given DIType.
950DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel163a9f72010-05-10 22:49:55 +0000951 CompileUnit *TypeCU = getCompileUnit(Ty);
952 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patel16ced732009-12-10 18:05:33 +0000953 if (TyDIE)
954 return TyDIE;
955
956 // Create new type.
957 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel163a9f72010-05-10 22:49:55 +0000958 TypeCU->insertDIE(Ty, TyDIE);
Devang Patel16ced732009-12-10 18:05:33 +0000959 if (Ty.isBasicType())
Devang Patel2db49d72010-05-07 18:11:54 +0000960 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000961 else if (Ty.isCompositeType())
Devang Patel2db49d72010-05-07 18:11:54 +0000962 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000963 else {
964 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patel2db49d72010-05-07 18:11:54 +0000965 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000966 }
967
Devang Patelc366f832009-12-10 19:14:49 +0000968 addToContextOwner(TyDIE, Ty.getContext());
Devang Patel16ced732009-12-10 18:05:33 +0000969 return TyDIE;
970}
971
Devang Patel2c4ceb12009-11-21 02:48:08 +0000972/// addType - Add a new type attribute to the specified entity.
Devang Patel8a241142009-12-09 18:24:21 +0000973void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel9c004872010-05-07 21:45:47 +0000974 if (!Ty.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000975 return;
976
977 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +0000978 CompileUnit *TypeCU = getCompileUnit(Ty);
979 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000980 // If it exists then use the existing value.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000981 if (Entry) {
982 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000983 return;
984 }
985
Bill Wendling0310d762009-05-15 09:23:25 +0000986 // Construct type.
Devang Patel16ced732009-12-10 18:05:33 +0000987 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000988
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000989 // Set up proxy.
990 Entry = createDIEEntry(Buffer);
Devang Patel163a9f72010-05-10 22:49:55 +0000991 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000992
Devang Patel2c4ceb12009-11-21 02:48:08 +0000993 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000994}
995
Devang Patel2c4ceb12009-11-21 02:48:08 +0000996/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel8a241142009-12-09 18:24:21 +0000997void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000998 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000999 StringRef Name = BTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +00001000 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001001 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling0310d762009-05-15 09:23:25 +00001002 BTy.getEncoding());
1003
1004 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +00001005 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001006 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001007 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel2c4ceb12009-11-21 02:48:08 +00001008 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +00001009}
1010
Devang Patel2c4ceb12009-11-21 02:48:08 +00001011/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel8a241142009-12-09 18:24:21 +00001012void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001013 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +00001014 StringRef Name = DTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +00001015 uint64_t Size = DTy.getSizeInBits() >> 3;
1016 unsigned Tag = DTy.getTag();
1017
1018 // FIXME - Workaround for templates.
1019 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
1020
1021 Buffer.setTag(Tag);
1022
1023 // Map to main type, void will not have a type.
1024 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel8a241142009-12-09 18:24:21 +00001025 addType(&Buffer, FromTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001026
1027 // Add name if not anonymous or intermediate type.
Devang Pateldeea5642009-11-30 23:56:56 +00001028 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001029 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001030
1031 // Add size if non-zero (derived types might be zero-sized.)
1032 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001033 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +00001034
1035 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patel05f6fa82009-11-23 18:43:37 +00001036 if (!DTy.isForwardDecl())
Devang Patel81625742010-08-09 20:20:05 +00001037 addSourceLine(&Buffer, DTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001038}
1039
Devang Patel2c4ceb12009-11-21 02:48:08 +00001040/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +00001041void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001042 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +00001043 StringRef Name = CTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +00001044
1045 uint64_t Size = CTy.getSizeInBits() >> 3;
1046 unsigned Tag = CTy.getTag();
1047 Buffer.setTag(Tag);
1048
1049 switch (Tag) {
1050 case dwarf::DW_TAG_vector_type:
1051 case dwarf::DW_TAG_array_type:
Devang Patel8a241142009-12-09 18:24:21 +00001052 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001053 break;
1054 case dwarf::DW_TAG_enumeration_type: {
1055 DIArray Elements = CTy.getTypeArray();
1056
1057 // Add enumerators to enumeration type.
1058 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1059 DIE *ElemDie = NULL;
Devang Patel2db49d72010-05-07 18:11:54 +00001060 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3c91b052010-03-08 20:52:55 +00001061 if (Enum.isEnumerator()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001062 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001063 Buffer.addChild(ElemDie);
Devang Patelc5254722009-10-09 17:51:49 +00001064 }
Bill Wendling0310d762009-05-15 09:23:25 +00001065 }
1066 }
1067 break;
1068 case dwarf::DW_TAG_subroutine_type: {
1069 // Add return type.
1070 DIArray Elements = CTy.getTypeArray();
1071 DIDescriptor RTy = Elements.getElement(0);
Devang Patel2db49d72010-05-07 18:11:54 +00001072 addType(&Buffer, DIType(RTy));
Bill Wendling0310d762009-05-15 09:23:25 +00001073
Devang Pateld6747df2010-10-06 20:50:40 +00001074 bool isPrototyped = true;
Bill Wendling0310d762009-05-15 09:23:25 +00001075 // Add arguments.
1076 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
Bill Wendling0310d762009-05-15 09:23:25 +00001077 DIDescriptor Ty = Elements.getElement(i);
Devang Pateld6747df2010-10-06 20:50:40 +00001078 if (Ty.isUnspecifiedParameter()) {
1079 DIE *Arg = new DIE(dwarf::DW_TAG_unspecified_parameters);
1080 Buffer.addChild(Arg);
1081 isPrototyped = false;
1082 } else {
1083 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1084 addType(Arg, DIType(Ty));
1085 Buffer.addChild(Arg);
1086 }
Bill Wendling0310d762009-05-15 09:23:25 +00001087 }
Devang Pateld6747df2010-10-06 20:50:40 +00001088 // Add prototype flag.
1089 if (isPrototyped)
1090 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001091 }
1092 break;
1093 case dwarf::DW_TAG_structure_type:
1094 case dwarf::DW_TAG_union_type:
1095 case dwarf::DW_TAG_class_type: {
1096 // Add elements to structure type.
1097 DIArray Elements = CTy.getTypeArray();
1098
1099 // A forward struct declared type may not have elements available.
Devang Patel3c91b052010-03-08 20:52:55 +00001100 unsigned N = Elements.getNumElements();
1101 if (N == 0)
Bill Wendling0310d762009-05-15 09:23:25 +00001102 break;
1103
1104 // Add elements to structure type.
Devang Patel3c91b052010-03-08 20:52:55 +00001105 for (unsigned i = 0; i < N; ++i) {
Bill Wendling0310d762009-05-15 09:23:25 +00001106 DIDescriptor Element = Elements.getElement(i);
1107 DIE *ElemDie = NULL;
Devang Patel1a301232010-09-29 21:44:16 +00001108 if (Element.isSubprogram()) {
1109 DISubprogram SP(Element);
Devang Patel2db49d72010-05-07 18:11:54 +00001110 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patel1a301232010-09-29 21:44:16 +00001111 if (SP.isProtected())
1112 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1113 dwarf::DW_ACCESS_protected);
1114 else if (SP.isPrivate())
1115 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1116 dwarf::DW_ACCESS_private);
1117 else
1118 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1119 dwarf::DW_ACCESS_public);
Devang Patel21ea1d52010-10-01 23:31:40 +00001120 if (SP.isExplicit())
1121 addUInt(ElemDie, dwarf::DW_AT_explicit, dwarf::DW_FORM_flag, 1);
Devang Patel1a301232010-09-29 21:44:16 +00001122 }
Devang Patel3c91b052010-03-08 20:52:55 +00001123 else if (Element.isVariable()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001124 DIVariable DV(Element);
Devang Patel1ee0cb92010-01-30 01:08:30 +00001125 ElemDie = new DIE(dwarf::DW_TAG_variable);
1126 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1127 DV.getName());
1128 addType(ElemDie, DV.getType());
1129 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1130 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patel81625742010-08-09 20:20:05 +00001131 addSourceLine(ElemDie, DV);
Devang Patel3c91b052010-03-08 20:52:55 +00001132 } else if (Element.isDerivedType())
Devang Patel2db49d72010-05-07 18:11:54 +00001133 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3c91b052010-03-08 20:52:55 +00001134 else
1135 continue;
Devang Patel2c4ceb12009-11-21 02:48:08 +00001136 Buffer.addChild(ElemDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001137 }
1138
Devang Patela1ba2692009-08-27 23:51:51 +00001139 if (CTy.isAppleBlockExtension())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001140 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001141
1142 unsigned RLang = CTy.getRunTimeLang();
1143 if (RLang)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001144 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling0310d762009-05-15 09:23:25 +00001145 dwarf::DW_FORM_data1, RLang);
Devang Patelb5544992010-01-26 21:16:06 +00001146
1147 DICompositeType ContainingType = CTy.getContainingType();
Devang Patel2db49d72010-05-07 18:11:54 +00001148 if (DIDescriptor(ContainingType).isCompositeType())
Jim Grosbach1e20b962010-07-21 21:21:52 +00001149 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patel2db49d72010-05-07 18:11:54 +00001150 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastings215aa152010-06-11 20:08:44 +00001151 else {
1152 DIDescriptor Context = CTy.getContext();
1153 addToContextOwner(&Buffer, Context);
1154 }
Devang Patel7e2cb112011-02-02 21:38:25 +00001155
1156 if (Tag == dwarf::DW_TAG_class_type) {
1157 DIArray TParams = CTy.getTemplateParams();
1158 unsigned N = TParams.getNumElements();
1159 // Add template parameters.
1160 for (unsigned i = 0; i < N; ++i) {
1161 DIDescriptor Element = TParams.getElement(i);
1162 if (Element.isTemplateTypeParameter())
1163 Buffer.addChild(getOrCreateTemplateTypeParameterDIE(
1164 DITemplateTypeParameter(Element)));
Devang Patele7d93872011-02-02 22:35:53 +00001165 else if (Element.isTemplateValueParameter())
1166 Buffer.addChild(getOrCreateTemplateValueParameterDIE(
1167 DITemplateValueParameter(Element)));
Devang Patel7e2cb112011-02-02 21:38:25 +00001168 }
1169 }
Bill Wendling0310d762009-05-15 09:23:25 +00001170 break;
1171 }
1172 default:
1173 break;
1174 }
1175
1176 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +00001177 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001178 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001179
Jim Grosbach1e20b962010-07-21 21:21:52 +00001180 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
Devang Patel61409622010-07-07 20:12:52 +00001181 || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1182 {
Bill Wendling0310d762009-05-15 09:23:25 +00001183 // Add size if non-zero (derived types might be zero-sized.)
1184 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001185 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +00001186 else {
1187 // Add zero size if it is not a forward declaration.
1188 if (CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001189 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001190 else
Devang Patel2c4ceb12009-11-21 02:48:08 +00001191 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling0310d762009-05-15 09:23:25 +00001192 }
1193
1194 // Add source line info if available.
1195 if (!CTy.isForwardDecl())
Devang Patel81625742010-08-09 20:20:05 +00001196 addSourceLine(&Buffer, CTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001197 }
1198}
1199
Devang Patel7e2cb112011-02-02 21:38:25 +00001200/// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
1201/// for the given DITemplateTypeParameter.
1202DIE *
1203DwarfDebug::getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP) {
1204 CompileUnit *TypeCU = getCompileUnit(TP);
1205 DIE *ParamDIE = TypeCU->getDIE(TP);
1206 if (ParamDIE)
1207 return ParamDIE;
1208
1209 ParamDIE = new DIE(dwarf::DW_TAG_template_type_parameter);
1210 addType(ParamDIE, TP.getType());
1211 addString(ParamDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string, TP.getName());
1212 return ParamDIE;
1213}
1214
Devang Patele7d93872011-02-02 22:35:53 +00001215/// getOrCreateTemplateValueParameterDIE - Find existing DIE or create new DIE
1216/// for the given DITemplateValueParameter.
1217DIE *
1218DwarfDebug::getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TPV) {
1219 CompileUnit *TVCU = getCompileUnit(TPV);
1220 DIE *ParamDIE = TVCU->getDIE(TPV);
1221 if (ParamDIE)
1222 return ParamDIE;
1223
1224 ParamDIE = new DIE(dwarf::DW_TAG_template_value_parameter);
1225 addType(ParamDIE, TPV.getType());
1226 addString(ParamDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string, TPV.getName());
1227 addUInt(ParamDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
1228 TPV.getValue());
1229 return ParamDIE;
1230}
1231
Devang Patel2c4ceb12009-11-21 02:48:08 +00001232/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1233void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling0310d762009-05-15 09:23:25 +00001234 int64_t L = SR.getLo();
1235 int64_t H = SR.getHi();
1236 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1237
Devang Patel2c4ceb12009-11-21 02:48:08 +00001238 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patel6325a532009-08-14 20:59:16 +00001239 if (L)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001240 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Pateld55224c2009-12-04 23:10:24 +00001241 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling0310d762009-05-15 09:23:25 +00001242
Devang Patel2c4ceb12009-11-21 02:48:08 +00001243 Buffer.addChild(DW_Subrange);
Bill Wendling0310d762009-05-15 09:23:25 +00001244}
1245
Devang Patel2c4ceb12009-11-21 02:48:08 +00001246/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +00001247void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling0310d762009-05-15 09:23:25 +00001248 DICompositeType *CTy) {
1249 Buffer.setTag(dwarf::DW_TAG_array_type);
1250 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001251 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001252
1253 // Emit derived type.
Devang Patel8a241142009-12-09 18:24:21 +00001254 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001255 DIArray Elements = CTy->getTypeArray();
1256
Devang Patel6f01d9c2009-11-21 00:31:03 +00001257 // Get an anonymous type for index type.
Devang Patel163a9f72010-05-10 22:49:55 +00001258 CompileUnit *TheCU = getCompileUnit(*CTy);
1259 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel6f01d9c2009-11-21 00:31:03 +00001260 if (!IdxTy) {
1261 // Construct an anonymous type for index type.
1262 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001263 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1264 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel6f01d9c2009-11-21 00:31:03 +00001265 dwarf::DW_ATE_signed);
Devang Patel163a9f72010-05-10 22:49:55 +00001266 TheCU->addDie(IdxTy);
1267 TheCU->setIndexTyDie(IdxTy);
Devang Patel6f01d9c2009-11-21 00:31:03 +00001268 }
Bill Wendling0310d762009-05-15 09:23:25 +00001269
1270 // Add subranges to array type.
1271 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1272 DIDescriptor Element = Elements.getElement(i);
1273 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patel2db49d72010-05-07 18:11:54 +00001274 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001275 }
1276}
1277
Devang Patel2c4ceb12009-11-21 02:48:08 +00001278/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3c91b052010-03-08 20:52:55 +00001279DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001280 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3c91b052010-03-08 20:52:55 +00001281 StringRef Name = ETy.getName();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001282 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3c91b052010-03-08 20:52:55 +00001283 int64_t Value = ETy.getEnumValue();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001284 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling0310d762009-05-15 09:23:25 +00001285 return Enumerator;
1286}
1287
Jim Grosbach1e20b962010-07-21 21:21:52 +00001288/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel351ca332010-01-05 01:46:14 +00001289/// printer to not emit usual symbol prefix before the symbol name is used then
1290/// return linkage name after skipping this special LLVM prefix.
1291static StringRef getRealLinkageName(StringRef LinkageName) {
1292 char One = '\1';
1293 if (LinkageName.startswith(StringRef(&One, 1)))
1294 return LinkageName.substr(1);
1295 return LinkageName;
1296}
1297
Devang Patel2c4ceb12009-11-21 02:48:08 +00001298/// createMemberDIE - Create new member DIE.
Devang Patelecbd8e82010-08-10 04:12:17 +00001299DIE *DwarfDebug::createMemberDIE(DIDerivedType DT) {
Bill Wendling0310d762009-05-15 09:23:25 +00001300 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel65dbc902009-11-25 17:36:49 +00001301 StringRef Name = DT.getName();
1302 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001303 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001304
Devang Patel8a241142009-12-09 18:24:21 +00001305 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001306
Devang Patel81625742010-08-09 20:20:05 +00001307 addSourceLine(MemberDie, DT);
Bill Wendling0310d762009-05-15 09:23:25 +00001308
Benjamin Kramer345ef342010-03-31 19:34:01 +00001309 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001310 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel33db5082009-11-04 22:06:12 +00001311
Bill Wendling0310d762009-05-15 09:23:25 +00001312 uint64_t Size = DT.getSizeInBits();
Devang Patel61ecbd12009-11-04 23:48:00 +00001313 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling0310d762009-05-15 09:23:25 +00001314
1315 if (Size != FieldSize) {
1316 // Handle bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001317 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1318 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling0310d762009-05-15 09:23:25 +00001319
1320 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling0310d762009-05-15 09:23:25 +00001321 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1322 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer3d594fd2010-01-07 17:50:57 +00001323 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling0310d762009-05-15 09:23:25 +00001324 Offset -= FieldOffset;
1325
1326 // Maybe we need to work from the other end.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001327 if (Asm->getTargetData().isLittleEndian())
1328 Offset = FieldSize - (Offset + Size);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001329 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling0310d762009-05-15 09:23:25 +00001330
Devang Patel33db5082009-11-04 22:06:12 +00001331 // Here WD_AT_data_member_location points to the anonymous
1332 // field that includes this bit field.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001333 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001334
1335 } else
1336 // This is not a bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001337 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001338
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001339 if (DT.getTag() == dwarf::DW_TAG_inheritance
1340 && DT.isVirtual()) {
1341
1342 // For C++, virtual base classes are not at fixed offset. Use following
1343 // expression to extract appropriate offset from vtable.
1344 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1345
Benjamin Kramer345ef342010-03-31 19:34:01 +00001346 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001347 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1348 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1349 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1350 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1351 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1352 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1353 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1354
Jim Grosbach1e20b962010-07-21 21:21:52 +00001355 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001356 VBaseLocationDie);
1357 } else
1358 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001359
1360 if (DT.isProtected())
Devang Patel5d11eb02009-12-03 19:11:07 +00001361 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001362 dwarf::DW_ACCESS_protected);
1363 else if (DT.isPrivate())
Devang Patel5d11eb02009-12-03 19:11:07 +00001364 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001365 dwarf::DW_ACCESS_private);
Devang Patel2a361602010-09-29 19:08:08 +00001366 // Otherwise C++ member and base classes are considered public.
1367 else if (DT.getCompileUnit().getLanguage() == dwarf::DW_LANG_C_plus_plus)
Devang Patel5d11eb02009-12-03 19:11:07 +00001368 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1369 dwarf::DW_ACCESS_public);
1370 if (DT.isVirtual())
1371 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1372 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling0310d762009-05-15 09:23:25 +00001373 return MemberDie;
1374}
1375
Devang Patelffe966c2009-12-14 16:18:45 +00001376/// createSubprogramDIE - Create new DIE using SP.
Devang Patelee70fa72010-09-27 23:15:27 +00001377DIE *DwarfDebug::createSubprogramDIE(DISubprogram SP) {
Devang Patel163a9f72010-05-10 22:49:55 +00001378 CompileUnit *SPCU = getCompileUnit(SP);
1379 DIE *SPDie = SPCU->getDIE(SP);
Devang Patelffe966c2009-12-14 16:18:45 +00001380 if (SPDie)
1381 return SPDie;
1382
1383 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel1eac3e72010-03-02 17:58:15 +00001384 // Constructors and operators for anonymous aggregates do not have names.
Devang Patel6b506cb2010-03-02 01:26:20 +00001385 if (!SP.getName().empty())
1386 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling0310d762009-05-15 09:23:25 +00001387
Devang Patel65dbc902009-11-25 17:36:49 +00001388 StringRef LinkageName = SP.getLinkageName();
Devang Patel351ca332010-01-05 01:46:14 +00001389 if (!LinkageName.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001390 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel351ca332010-01-05 01:46:14 +00001391 getRealLinkageName(LinkageName));
1392
Devang Patel81625742010-08-09 20:20:05 +00001393 addSourceLine(SPDie, SP);
Bill Wendling0310d762009-05-15 09:23:25 +00001394
Devang Patel7b172c62010-10-07 22:03:01 +00001395 if (SP.isPrototyped())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001396 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001397
1398 // Add Return Type.
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001399 DICompositeType SPTy = SP.getType();
1400 DIArray Args = SPTy.getTypeArray();
Bill Wendling0310d762009-05-15 09:23:25 +00001401 unsigned SPTag = SPTy.getTag();
Devang Patel5d11eb02009-12-03 19:11:07 +00001402
Devang Patel3c91b052010-03-08 20:52:55 +00001403 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel8a241142009-12-09 18:24:21 +00001404 addType(SPDie, SPTy);
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001405 else
Devang Patel2db49d72010-05-07 18:11:54 +00001406 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001407
Devang Patel5d11eb02009-12-03 19:11:07 +00001408 unsigned VK = SP.getVirtuality();
1409 if (VK) {
1410 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer345ef342010-03-31 19:34:01 +00001411 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel5d11eb02009-12-03 19:11:07 +00001412 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
Devang Pateld639c7c2010-12-09 00:10:40 +00001413 addUInt(Block, 0, dwarf::DW_FORM_udata, SP.getVirtualIndex());
Devang Patel5d11eb02009-12-03 19:11:07 +00001414 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001415 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patel2db49d72010-05-07 18:11:54 +00001416 SP.getContainingType()));
Devang Patel5d11eb02009-12-03 19:11:07 +00001417 }
1418
Devang Patelee70fa72010-09-27 23:15:27 +00001419 if (!SP.isDefinition()) {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001420 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001421
1422 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001423 // be handled while processing variables.
1424 DICompositeType SPTy = SP.getType();
1425 DIArray Args = SPTy.getTypeArray();
1426 unsigned SPTag = SPTy.getTag();
1427
Bill Wendling0310d762009-05-15 09:23:25 +00001428 if (SPTag == dwarf::DW_TAG_subroutine_type)
1429 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1430 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001431 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patelb4645642010-02-06 01:02:37 +00001432 addType(Arg, ATy);
1433 if (ATy.isArtificial())
1434 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001435 SPDie->addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001436 }
1437 }
1438
Devang Patel4e0d19d2010-02-03 19:57:19 +00001439 if (SP.isArtificial())
1440 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1441
Devang Patelccff8122010-04-30 19:38:23 +00001442 if (!SP.isLocalToUnit())
1443 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001444
Devang Patelccff8122010-04-30 19:38:23 +00001445 if (SP.isOptimized())
1446 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1447
Jim Grosbach91729002010-07-21 23:03:52 +00001448 if (unsigned isa = Asm->getISAEncoding()) {
1449 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1450 }
1451
Devang Patelccff8122010-04-30 19:38:23 +00001452 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel163a9f72010-05-10 22:49:55 +00001453 SPCU->insertDIE(SP, SPDie);
Devang Patelccff8122010-04-30 19:38:23 +00001454
Stuart Hastings215aa152010-06-11 20:08:44 +00001455 // Add to context owner.
1456 addToContextOwner(SPDie, SP.getContext());
1457
Bill Wendling0310d762009-05-15 09:23:25 +00001458 return SPDie;
1459}
1460
Devang Patele9f8f5e2010-05-07 20:54:48 +00001461DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattnered7a77b2010-03-31 05:36:29 +00001462 assert(N && "Invalid Scope encoding!");
Devang Patel53bb5c92009-11-10 23:06:00 +00001463
1464 DbgScope *AScope = AbstractScopes.lookup(N);
1465 if (AScope)
1466 return AScope;
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001467
Devang Patel53bb5c92009-11-10 23:06:00 +00001468 DbgScope *Parent = NULL;
1469
1470 DIDescriptor Scope(N);
1471 if (Scope.isLexicalBlock()) {
1472 DILexicalBlock DB(N);
1473 DIDescriptor ParentDesc = DB.getContext();
Devang Patel2db49d72010-05-07 18:11:54 +00001474 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patel53bb5c92009-11-10 23:06:00 +00001475 }
1476
1477 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1478
1479 if (Parent)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001480 Parent->addScope(AScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001481 AScope->setAbstractScope();
1482 AbstractScopes[N] = AScope;
1483 if (DIDescriptor(N).isSubprogram())
1484 AbstractScopesList.push_back(AScope);
1485 return AScope;
1486}
Devang Patelaf9e8472009-10-01 20:31:14 +00001487
Devang Patel5f094002010-04-06 23:53:48 +00001488/// isSubprogramContext - Return true if Context is either a subprogram
1489/// or another context nested inside a subprogram.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001490static bool isSubprogramContext(const MDNode *Context) {
Devang Patel5f094002010-04-06 23:53:48 +00001491 if (!Context)
1492 return false;
1493 DIDescriptor D(Context);
1494 if (D.isSubprogram())
1495 return true;
1496 if (D.isType())
Devang Patel2db49d72010-05-07 18:11:54 +00001497 return isSubprogramContext(DIType(Context).getContext());
Devang Patel5f094002010-04-06 23:53:48 +00001498 return false;
1499}
1500
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001501/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel2c4ceb12009-11-21 02:48:08 +00001502/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1503/// If there are global variables in this scope then create and insert
1504/// DIEs for these variables.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001505DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel163a9f72010-05-10 22:49:55 +00001506 CompileUnit *SPCU = getCompileUnit(SPNode);
1507 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patel8aa61472010-07-07 22:20:57 +00001508
Chris Lattnerd38fee82010-04-05 00:13:49 +00001509 assert(SPDie && "Unable to find subprogram DIE!");
1510 DISubprogram SP(SPNode);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001511
Chris Lattnerd38fee82010-04-05 00:13:49 +00001512 // There is not any need to generate specification DIE for a function
1513 // defined at compile unit level. If a function is defined inside another
1514 // function then gdb prefers the definition at top level and but does not
Jim Grosbach1e20b962010-07-21 21:21:52 +00001515 // expect specification DIE in parent function. So avoid creating
Chris Lattnerd38fee82010-04-05 00:13:49 +00001516 // specification DIE for a function defined inside a function.
1517 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Jim Grosbach1e20b962010-07-21 21:21:52 +00001518 !SP.getContext().isFile() &&
Devang Patel2db49d72010-05-07 18:11:54 +00001519 !isSubprogramContext(SP.getContext())) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00001520 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001521
1522 // Add arguments.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001523 DICompositeType SPTy = SP.getType();
1524 DIArray Args = SPTy.getTypeArray();
1525 unsigned SPTag = SPTy.getTag();
1526 if (SPTag == dwarf::DW_TAG_subroutine_type)
1527 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1528 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001529 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattnerd38fee82010-04-05 00:13:49 +00001530 addType(Arg, ATy);
1531 if (ATy.isArtificial())
1532 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1533 SPDie->addChild(Arg);
1534 }
1535 DIE *SPDeclDie = SPDie;
1536 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001537 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Chris Lattnerd38fee82010-04-05 00:13:49 +00001538 SPDeclDie);
Devang Patel163a9f72010-05-10 22:49:55 +00001539 SPCU->addDie(SPDie);
Chris Lattnerd38fee82010-04-05 00:13:49 +00001540 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00001541
Devang Patel8aa61472010-07-07 22:20:57 +00001542 // Pick up abstract subprogram DIE.
1543 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
1544 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1545 addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
1546 dwarf::DW_FORM_ref4, AbsSPDIE);
1547 SPCU->addDie(SPDie);
1548 }
1549
Chris Lattnerd38fee82010-04-05 00:13:49 +00001550 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1551 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1552 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1553 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1554 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1555 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1556 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +00001557
Chris Lattnerd38fee82010-04-05 00:13:49 +00001558 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +00001559}
1560
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001561/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel2c4ceb12009-11-21 02:48:08 +00001562/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1563DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001564
1565 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1566 if (Scope->isAbstractScope())
1567 return ScopeDIE;
1568
1569 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1570 if (Ranges.empty())
1571 return 0;
1572
1573 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1574 if (Ranges.size() > 1) {
1575 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbach1e20b962010-07-21 21:21:52 +00001576 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Pateleac9c072010-04-27 19:46:33 +00001577 // DW_AT_ranges appropriately.
1578 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1579 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1580 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1581 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +00001582 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1583 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +00001584 }
1585 DebugRangeSymbols.push_back(NULL);
1586 DebugRangeSymbols.push_back(NULL);
1587 return ScopeDIE;
1588 }
1589
Devang Patelc3f5f782010-05-25 23:40:22 +00001590 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1591 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001592
Devang Patelc3f5f782010-05-25 23:40:22 +00001593 if (End == 0) return 0;
Devang Patel53bb5c92009-11-10 23:06:00 +00001594
Chris Lattnerb7db7332010-03-09 01:58:53 +00001595 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1596 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbach1e20b962010-07-21 21:21:52 +00001597
Devang Pateleac9c072010-04-27 19:46:33 +00001598 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1599 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patel53bb5c92009-11-10 23:06:00 +00001600
1601 return ScopeDIE;
1602}
1603
Devang Patel2c4ceb12009-11-21 02:48:08 +00001604/// constructInlinedScopeDIE - This scope represents inlined body of
1605/// a function. Construct DIE to represent this concrete inlined copy
1606/// of the function.
1607DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001608
1609 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001610 assert (Ranges.empty() == false
Devang Pateleac9c072010-04-27 19:46:33 +00001611 && "DbgScope does not have instruction markers!");
1612
1613 // FIXME : .debug_inlined section specification does not clearly state how
1614 // to emit inlined scope that is split into multiple instruction ranges.
1615 // For now, use first instruction range and emit low_pc/high_pc pair and
1616 // corresponding .debug_inlined section entry for this pair.
1617 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patelc3f5f782010-05-25 23:40:22 +00001618 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1619 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001620
Devang Patel0afbf232010-07-08 22:39:20 +00001621 if (StartLabel == 0 || EndLabel == 0) {
Devang Pateleac9c072010-04-27 19:46:33 +00001622 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1623 return 0;
1624 }
Chris Lattnerb7db7332010-03-09 01:58:53 +00001625 assert(StartLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001626 "Invalid starting label for an inlined scope!");
Chris Lattnerb7db7332010-03-09 01:58:53 +00001627 assert(EndLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001628 "Invalid end label for an inlined scope!");
Devang Pateleac9c072010-04-27 19:46:33 +00001629
Devang Patel3c91b052010-03-08 20:52:55 +00001630 if (!Scope->getScopeNode())
Devang Patel0ef3fa62010-03-08 19:20:38 +00001631 return NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001632 DIScope DS(Scope->getScopeNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00001633 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1634
Devang Patel2db49d72010-05-07 18:11:54 +00001635 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel163a9f72010-05-10 22:49:55 +00001636 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1637 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001638 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel2c4ceb12009-11-21 02:48:08 +00001639 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001640 dwarf::DW_FORM_ref4, OriginDIE);
1641
Chris Lattner6ed0f902010-03-09 00:31:02 +00001642 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnerb7db7332010-03-09 01:58:53 +00001643 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patel53bb5c92009-11-10 23:06:00 +00001644
1645 InlinedSubprogramDIEs.insert(OriginDIE);
1646
1647 // Track the start label for this inlined function.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001648 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patel2db49d72010-05-07 18:11:54 +00001649 I = InlineInfo.find(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001650
1651 if (I == InlineInfo.end()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001652 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001653 ScopeDIE));
Devang Patel2db49d72010-05-07 18:11:54 +00001654 InlinedSPNodes.push_back(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001655 } else
Chris Lattner6ed0f902010-03-09 00:31:02 +00001656 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patel53bb5c92009-11-10 23:06:00 +00001657
Devang Patel53bb5c92009-11-10 23:06:00 +00001658 DILocation DL(Scope->getInlinedAt());
Devang Patel163a9f72010-05-10 22:49:55 +00001659 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001660 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +00001661
1662 return ScopeDIE;
1663}
1664
Devang Patel2c4ceb12009-11-21 02:48:08 +00001665
1666/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel8a241142009-12-09 18:24:21 +00001667DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel8bd11de2010-08-09 21:01:39 +00001668 StringRef Name = DV->getName();
Devang Patel65dbc902009-11-25 17:36:49 +00001669 if (Name.empty())
Devang Patel3fb6bd62009-11-13 02:25:26 +00001670 return NULL;
Devang Patel53bb5c92009-11-10 23:06:00 +00001671
1672 // Translate tag to proper Dwarf tag. The result variable is dropped for
1673 // now.
1674 unsigned Tag;
Devang Patel8bd11de2010-08-09 21:01:39 +00001675 switch (DV->getTag()) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001676 case dwarf::DW_TAG_return_variable:
1677 return NULL;
1678 case dwarf::DW_TAG_arg_variable:
1679 Tag = dwarf::DW_TAG_formal_parameter;
1680 break;
1681 case dwarf::DW_TAG_auto_variable: // fall thru
1682 default:
1683 Tag = dwarf::DW_TAG_variable;
1684 break;
1685 }
1686
1687 // Define variable debug information entry.
1688 DIE *VariableDie = new DIE(Tag);
1689
Devang Patel53bb5c92009-11-10 23:06:00 +00001690 DIE *AbsDIE = NULL;
Devang Patel26c1e562010-05-20 16:36:41 +00001691 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1692 V2AVI = VarToAbstractVarMap.find(DV);
1693 if (V2AVI != VarToAbstractVarMap.end())
1694 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001695
Devang Patel26c1e562010-05-20 16:36:41 +00001696 if (AbsDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001697 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001698 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001699 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001700 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel8bd11de2010-08-09 21:01:39 +00001701 addSourceLine(VariableDie, DV->getVariable());
Devang Patel53bb5c92009-11-10 23:06:00 +00001702
1703 // Add variable type.
Devang Patel8bd11de2010-08-09 21:01:39 +00001704 addType(VariableDie, DV->getType());
Devang Patel53bb5c92009-11-10 23:06:00 +00001705 }
1706
Devang Patel8bd11de2010-08-09 21:01:39 +00001707 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patelb4645642010-02-06 01:02:37 +00001708 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel3cf763d2010-09-29 23:07:21 +00001709 else if (DIVariable(DV->getVariable()).isArtificial())
1710 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelc3f5f782010-05-25 23:40:22 +00001711
1712 if (Scope->isAbstractScope()) {
1713 DV->setDIE(VariableDie);
1714 return VariableDie;
1715 }
1716
1717 // Add variable address.
1718
1719 unsigned Offset = DV->getDotDebugLocOffset();
1720 if (Offset != ~0U) {
1721 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1722 Asm->GetTempSymbol("debug_loc", Offset));
1723 DV->setDIE(VariableDie);
1724 UseDotDebugLocEntry.insert(VariableDie);
1725 return VariableDie;
1726 }
1727
1728 // Check if variable is described by a DBG_VALUE instruction.
1729 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1730 DbgVariableToDbgInstMap.find(DV);
1731 if (DVI != DbgVariableToDbgInstMap.end()) {
1732 const MachineInstr *DVInsn = DVI->second;
Devang Patelc3f5f782010-05-25 23:40:22 +00001733 bool updated = false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001734 // FIXME : Handle getNumOperands != 3
Devang Patelc3f5f782010-05-25 23:40:22 +00001735 if (DVInsn->getNumOperands() == 3) {
Devang Patel0b48ead2010-08-31 22:22:42 +00001736 if (DVInsn->getOperand(0).isReg()) {
1737 const MachineOperand RegOp = DVInsn->getOperand(0);
1738 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1739 if (DVInsn->getOperand(1).isImm() &&
1740 TRI->getFrameRegister(*Asm->MF) == RegOp.getReg()) {
1741 addVariableAddress(DV, VariableDie, DVInsn->getOperand(1).getImm());
1742 updated = true;
1743 } else
Devang Patel522ad742010-11-12 23:20:42 +00001744 updated = addRegisterAddress(VariableDie, RegOp);
Devang Patel0b48ead2010-08-31 22:22:42 +00001745 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001746 else if (DVInsn->getOperand(0).isImm())
Devang Patel522ad742010-11-12 23:20:42 +00001747 updated = addConstantValue(VariableDie, DVInsn->getOperand(0));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001748 else if (DVInsn->getOperand(0).isFPImm())
1749 updated =
Devang Patel522ad742010-11-12 23:20:42 +00001750 addConstantFPValue(VariableDie, DVInsn->getOperand(0));
Devang Patelc3f5f782010-05-25 23:40:22 +00001751 } else {
1752 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1753 if (Location.getReg()) {
1754 addAddress(VariableDie, dwarf::DW_AT_location, Location);
Devang Patelc3f5f782010-05-25 23:40:22 +00001755 updated = true;
1756 }
1757 }
1758 if (!updated) {
1759 // If variableDie is not updated then DBG_VALUE instruction does not
1760 // have valid variable info.
1761 delete VariableDie;
1762 return NULL;
1763 }
1764 DV->setDIE(VariableDie);
1765 return VariableDie;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001766 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001767
1768 // .. else use frame index, if available.
Devang Patelc3f5f782010-05-25 23:40:22 +00001769 int FI = 0;
Devang Patel9e3bd2c2010-08-31 06:11:28 +00001770 if (findVariableFrameIndex(DV, &FI))
1771 addVariableAddress(DV, VariableDie, FI);
1772
Devang Patel53bb5c92009-11-10 23:06:00 +00001773 DV->setDIE(VariableDie);
1774 return VariableDie;
1775
1776}
Devang Patel2c4ceb12009-11-21 02:48:08 +00001777
Devang Patel193f7202009-11-24 01:14:22 +00001778void DwarfDebug::addPubTypes(DISubprogram SP) {
1779 DICompositeType SPTy = SP.getType();
1780 unsigned SPTag = SPTy.getTag();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001781 if (SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel193f7202009-11-24 01:14:22 +00001782 return;
1783
1784 DIArray Args = SPTy.getTypeArray();
Devang Patel193f7202009-11-24 01:14:22 +00001785 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patel2db49d72010-05-07 18:11:54 +00001786 DIType ATy(Args.getElement(i));
Devang Patel9c004872010-05-07 21:45:47 +00001787 if (!ATy.Verify())
Devang Patel193f7202009-11-24 01:14:22 +00001788 continue;
1789 DICompositeType CATy = getDICompositeType(ATy);
Devang Patel2db49d72010-05-07 18:11:54 +00001790 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel50d80e32010-04-13 20:35:04 +00001791 && !CATy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001792 CompileUnit *TheCU = getCompileUnit(CATy);
1793 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1794 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001795 }
1796 }
1797}
1798
Devang Patel2c4ceb12009-11-21 02:48:08 +00001799/// constructScopeDIE - Construct a DIE for this scope.
1800DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3c91b052010-03-08 20:52:55 +00001801 if (!Scope || !Scope->getScopeNode())
1802 return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001803
Devang Patel5bc9fec2011-02-19 01:31:27 +00001804 SmallVector <DIE *, 8> Children;
1805 // Collect lexical scope childrens first.
1806 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
1807 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
1808 if (DIE *Variable = constructVariableDIE(Variables[i], Scope))
1809 Children.push_back(Variable);
1810 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
1811 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
1812 if (DIE *Nested = constructScopeDIE(Scopes[j]))
1813 Children.push_back(Nested);
Devang Patel3c91b052010-03-08 20:52:55 +00001814 DIScope DS(Scope->getScopeNode());
1815 DIE *ScopeDIE = NULL;
1816 if (Scope->getInlinedAt())
1817 ScopeDIE = constructInlinedScopeDIE(Scope);
1818 else if (DS.isSubprogram()) {
Devang Patel0dd45582010-06-28 20:53:04 +00001819 ProcessedSPNodes.insert(DS);
Devang Patel8aa61472010-07-07 22:20:57 +00001820 if (Scope->isAbstractScope()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001821 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patel8aa61472010-07-07 22:20:57 +00001822 // Note down abstract DIE.
1823 if (ScopeDIE)
1824 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
1825 }
Devang Patel3c91b052010-03-08 20:52:55 +00001826 else
Devang Patel2db49d72010-05-07 18:11:54 +00001827 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3c91b052010-03-08 20:52:55 +00001828 }
Devang Patel5bc9fec2011-02-19 01:31:27 +00001829 else {
1830 // There is no need to emit empty lexical block DIE.
1831 if (Children.empty())
1832 return NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001833 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel5bc9fec2011-02-19 01:31:27 +00001834 }
1835
Devang Patelaead63c2010-03-29 22:59:58 +00001836 if (!ScopeDIE) return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001837
Devang Patel5bc9fec2011-02-19 01:31:27 +00001838 // Add children
1839 for (SmallVector<DIE *, 8>::iterator I = Children.begin(),
1840 E = Children.end(); I != E; ++I)
1841 ScopeDIE->addChild(*I);
Devang Patel193f7202009-11-24 01:14:22 +00001842
Jim Grosbach1e20b962010-07-21 21:21:52 +00001843 if (DS.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001844 addPubTypes(DISubprogram(DS));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001845
Devang Patel193f7202009-11-24 01:14:22 +00001846 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +00001847}
1848
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001849/// GetOrCreateSourceID - Look up the source id with the given directory and
1850/// source file names. If none currently exists, create a new id and insert it
1851/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1852/// maps as well.
Devang Patel2f584852010-07-24 00:53:22 +00001853
Rafael Espindola5c055632010-11-18 02:04:25 +00001854unsigned DwarfDebug::GetOrCreateSourceID(StringRef FileName){
Devang Patel1905a182010-09-16 20:57:49 +00001855 // If FE did not provide a file name, then assume stdin.
1856 if (FileName.empty())
Rafael Espindola5c055632010-11-18 02:04:25 +00001857 return GetOrCreateSourceID("<stdin>");
Devang Patel1905a182010-09-16 20:57:49 +00001858
Rafael Espindola5c055632010-11-18 02:04:25 +00001859 StringMapEntry<unsigned> &Entry = SourceIdMap.GetOrCreateValue(FileName);
1860 if (Entry.getValue())
1861 return Entry.getValue();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001862
Rafael Espindola5c055632010-11-18 02:04:25 +00001863 unsigned SrcId = SourceIdMap.size();
1864 Entry.setValue(SrcId);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001865
Rafael Espindola5c055632010-11-18 02:04:25 +00001866 // Print out a .file directive to specify files for .loc directives.
1867 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, FileName);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001868
1869 return SrcId;
1870}
1871
Devang Patel6404e4e2009-12-15 19:16:48 +00001872/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1873DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel163a9f72010-05-10 22:49:55 +00001874 CompileUnit *TheCU = getCompileUnit(NS);
1875 DIE *NDie = TheCU->getDIE(NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001876 if (NDie)
1877 return NDie;
1878 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel163a9f72010-05-10 22:49:55 +00001879 TheCU->insertDIE(NS, NDie);
Devang Patel6404e4e2009-12-15 19:16:48 +00001880 if (!NS.getName().empty())
1881 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
Devang Patel81625742010-08-09 20:20:05 +00001882 addSourceLine(NDie, NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001883 addToContextOwner(NDie, NS.getContext());
1884 return NDie;
1885}
1886
Jim Grosbach1e20b962010-07-21 21:21:52 +00001887/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel163a9f72010-05-10 22:49:55 +00001888/// metadata node with tag DW_TAG_compile_unit.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001889void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001890 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +00001891 StringRef FN = DIUnit.getFilename();
1892 StringRef Dir = DIUnit.getDirectory();
Rafael Espindola5c055632010-11-18 02:04:25 +00001893 unsigned ID = GetOrCreateSourceID(FN);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001894
1895 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001896 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001897 DIUnit.getProducer());
Devang Patel3a4ae322011-02-23 22:37:04 +00001898 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001899 DIUnit.getLanguage());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001900 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patel5098da02010-04-26 22:54:28 +00001901 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1902 // simplifies debug range entries.
Devang Patel9b93b6b2010-06-28 22:22:47 +00001903 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Patel4a602ca2010-03-22 23:11:36 +00001904 // DW_AT_stmt_list is a offset of line number information for this
Devang Patelaf608bd2010-08-24 00:06:12 +00001905 // compile unit in debug_line section.
Devang Patelae84d5b2010-08-31 23:50:19 +00001906 if (Asm->MAI->doesDwarfUsesAbsoluteLabelForStmtList())
1907 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_addr,
1908 Asm->GetTempSymbol("section_line"));
1909 else
1910 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001911
Devang Patel65dbc902009-11-25 17:36:49 +00001912 if (!Dir.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001913 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001914 if (DIUnit.isOptimized())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001915 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001916
Devang Patel65dbc902009-11-25 17:36:49 +00001917 StringRef Flags = DIUnit.getFlags();
1918 if (!Flags.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001919 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001920
1921 unsigned RVer = DIUnit.getRunTimeVersion();
1922 if (RVer)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001923 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001924 dwarf::DW_FORM_data1, RVer);
1925
Devang Patel163a9f72010-05-10 22:49:55 +00001926 CompileUnit *NewCU = new CompileUnit(ID, Die);
1927 if (!FirstCU)
1928 FirstCU = NewCU;
1929 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001930}
1931
Devang Patel163a9f72010-05-10 22:49:55 +00001932/// getCompielUnit - Get CompileUnit DIE.
1933CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1934 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1935 DIDescriptor D(N);
1936 const MDNode *CUNode = NULL;
1937 if (D.isCompileUnit())
1938 CUNode = N;
1939 else if (D.isSubprogram())
1940 CUNode = DISubprogram(N).getCompileUnit();
1941 else if (D.isType())
1942 CUNode = DIType(N).getCompileUnit();
1943 else if (D.isGlobalVariable())
1944 CUNode = DIGlobalVariable(N).getCompileUnit();
1945 else if (D.isVariable())
1946 CUNode = DIVariable(N).getCompileUnit();
1947 else if (D.isNameSpace())
1948 CUNode = DINameSpace(N).getCompileUnit();
1949 else if (D.isFile())
1950 CUNode = DIFile(N).getCompileUnit();
1951 else
1952 return FirstCU;
1953
1954 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1955 = CUMap.find(CUNode);
1956 if (I == CUMap.end())
1957 return FirstCU;
1958 return I->second;
1959}
1960
Devang Patel0c4720c2010-08-23 18:25:56 +00001961/// isUnsignedDIType - Return true if type encoding is unsigned.
1962static bool isUnsignedDIType(DIType Ty) {
1963 DIDerivedType DTy(Ty);
1964 if (DTy.Verify())
1965 return isUnsignedDIType(DTy.getTypeDerivedFrom());
1966
1967 DIBasicType BTy(Ty);
1968 if (BTy.Verify()) {
1969 unsigned Encoding = BTy.getEncoding();
1970 if (Encoding == dwarf::DW_ATE_unsigned ||
1971 Encoding == dwarf::DW_ATE_unsigned_char)
1972 return true;
1973 }
1974 return false;
1975}
Devang Patel163a9f72010-05-10 22:49:55 +00001976
Devang Patele449d1f2011-01-20 00:02:16 +00001977// Return const exprssion if value is a GEP to access merged global
1978// constant. e.g.
1979// i8* getelementptr ({ i8, i8, i8, i8 }* @_MergedGlobals, i32 0, i32 0)
1980static const ConstantExpr *getMergedGlobalExpr(const Value *V) {
1981 const ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(V);
1982 if (!CE || CE->getNumOperands() != 3 ||
1983 CE->getOpcode() != Instruction::GetElementPtr)
1984 return NULL;
1985
1986 // First operand points to a global value.
1987 if (!isa<GlobalValue>(CE->getOperand(0)))
1988 return NULL;
1989
1990 // Second operand is zero.
1991 const ConstantInt *CI =
1992 dyn_cast_or_null<ConstantInt>(CE->getOperand(1));
1993 if (!CI || !CI->isZero())
1994 return NULL;
1995
1996 // Third operand is offset.
1997 if (!isa<ConstantInt>(CE->getOperand(2)))
1998 return NULL;
1999
2000 return CE;
2001}
2002
Devang Patel163a9f72010-05-10 22:49:55 +00002003/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00002004void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel9fa539c2010-08-10 01:37:23 +00002005 DIGlobalVariable GV(N);
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002006
Devang Patel905cf5e2009-09-04 23:59:07 +00002007 // If debug information is malformed then ignore it.
Devang Patel9fa539c2010-08-10 01:37:23 +00002008 if (GV.Verify() == false)
Devang Patel905cf5e2009-09-04 23:59:07 +00002009 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002010
2011 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00002012 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel9fa539c2010-08-10 01:37:23 +00002013 if (TheCU->getDIE(GV))
Devang Patel13e16b62009-06-26 01:49:18 +00002014 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002015
Devang Patel9fa539c2010-08-10 01:37:23 +00002016 DIType GTy = GV.getType();
Devang Patel29368072010-08-10 07:11:13 +00002017 DIE *VariableDIE = new DIE(GV.getTag());
2018
2019 bool isGlobalVariable = GV.getGlobal() != NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002020
Devang Patel9fa539c2010-08-10 01:37:23 +00002021 // Add name.
2022 addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
2023 GV.getDisplayName());
2024 StringRef LinkageName = GV.getLinkageName();
Devang Patel29368072010-08-10 07:11:13 +00002025 if (!LinkageName.empty() && isGlobalVariable)
Devang Patel9fa539c2010-08-10 01:37:23 +00002026 addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
2027 getRealLinkageName(LinkageName));
2028 // Add type.
2029 addType(VariableDIE, GTy);
Devang Patel50d80e32010-04-13 20:35:04 +00002030 if (GTy.isCompositeType() && !GTy.getName().empty()
2031 && !GTy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00002032 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattnered7a77b2010-03-31 05:36:29 +00002033 assert(Entry && "Missing global type!");
Devang Patel163a9f72010-05-10 22:49:55 +00002034 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00002035 }
Devang Patel9fa539c2010-08-10 01:37:23 +00002036 // Add scoping info.
2037 if (!GV.isLocalToUnit()) {
2038 addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
2039 // Expose as global.
2040 TheCU->addGlobal(GV.getName(), VariableDIE);
2041 }
2042 // Add line number info.
2043 addSourceLine(VariableDIE, GV);
2044 // Add to map.
2045 TheCU->insertDIE(N, VariableDIE);
2046 // Add to context owner.
2047 DIDescriptor GVContext = GV.getContext();
2048 addToContextOwner(VariableDIE, GVContext);
2049 // Add location.
Devang Patel29368072010-08-10 07:11:13 +00002050 if (isGlobalVariable) {
2051 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
2052 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
2053 addLabel(Block, 0, dwarf::DW_FORM_udata,
2054 Asm->Mang->getSymbol(GV.getGlobal()));
2055 // Do not create specification DIE if context is either compile unit
2056 // or a subprogram.
2057 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
2058 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
2059 // Create specification DIE.
2060 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
2061 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
2062 dwarf::DW_FORM_ref4, VariableDIE);
2063 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
2064 addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
2065 TheCU->addDie(VariableSpecDIE);
2066 } else {
2067 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
2068 }
Devang Patel76a788c2011-01-06 21:39:25 +00002069 } else if (ConstantInt *CI =
2070 dyn_cast_or_null<ConstantInt>(GV.getConstant()))
2071 addConstantValue(VariableDIE, CI, isUnsignedDIType(GTy));
Devang Patele449d1f2011-01-20 00:02:16 +00002072 else if (const ConstantExpr *CE = getMergedGlobalExpr(N->getOperand(11))) {
2073 // GV is a merged global.
2074 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
2075 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
2076 addLabel(Block, 0, dwarf::DW_FORM_udata,
2077 Asm->Mang->getSymbol(cast<GlobalValue>(CE->getOperand(0))));
2078 ConstantInt *CII = cast<ConstantInt>(CE->getOperand(2));
2079 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
2080 addUInt(Block, 0, dwarf::DW_FORM_udata, CII->getZExtValue());
2081 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
2082 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
2083 }
Devang Patel76a788c2011-01-06 21:39:25 +00002084
Devang Patel13e16b62009-06-26 01:49:18 +00002085 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002086}
2087
Devang Patel163a9f72010-05-10 22:49:55 +00002088/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00002089void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00002090 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002091
Stuart Hastings639336e2010-04-06 21:38:29 +00002092 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00002093 CompileUnit *TheCU = getCompileUnit(N);
2094 if (TheCU->getDIE(N))
Stuart Hastings639336e2010-04-06 21:38:29 +00002095 return;
2096
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002097 if (!SP.isDefinition())
2098 // This is a method declaration which will be handled while constructing
2099 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +00002100 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002101
Stuart Hastings639336e2010-04-06 21:38:29 +00002102 DIE *SubprogramDie = createSubprogramDIE(SP);
2103
2104 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +00002105 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002106
2107 // Add to context owner.
Devang Patel6404e4e2009-12-15 19:16:48 +00002108 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +00002109
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002110 // Expose as global.
Devang Patel163a9f72010-05-10 22:49:55 +00002111 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel193f7202009-11-24 01:14:22 +00002112
Devang Patel13e16b62009-06-26 01:49:18 +00002113 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002114}
2115
Devang Patel2c4ceb12009-11-21 02:48:08 +00002116/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbar00564992009-09-19 20:40:14 +00002117/// content. Create global DIEs and emit initial debug info sections.
2118/// This is inovked by the target AsmPrinter.
Chris Lattner75f50722010-04-04 07:48:20 +00002119void DwarfDebug::beginModule(Module *M) {
Devang Pateleac9c072010-04-27 19:46:33 +00002120 if (DisableDebugInfoPrinting)
2121 return;
2122
Devang Patel78ab9e22009-07-30 18:56:46 +00002123 DebugInfoFinder DbgFinder;
2124 DbgFinder.processModule(*M);
Devang Patel13e16b62009-06-26 01:49:18 +00002125
Chris Lattnerd850ac72010-04-05 02:19:28 +00002126 bool HasDebugInfo = false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002127
Chris Lattnerd850ac72010-04-05 02:19:28 +00002128 // Scan all the compile-units to see if there are any marked as the main unit.
2129 // if not, we do not generate debug info.
2130 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2131 E = DbgFinder.compile_unit_end(); I != E; ++I) {
2132 if (DICompileUnit(*I).isMain()) {
2133 HasDebugInfo = true;
2134 break;
2135 }
2136 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002137
Chris Lattnerd850ac72010-04-05 02:19:28 +00002138 if (!HasDebugInfo) return;
2139
2140 // Tell MMI that we have debug info.
2141 MMI->setDebugInfoAvailability(true);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002142
Chris Lattnerbe15beb2010-04-04 23:17:54 +00002143 // Emit initial sections.
Chris Lattnerd850ac72010-04-05 02:19:28 +00002144 EmitSectionLabels();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002145
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002146 // Create all the compile unit DIEs.
Devang Patel78ab9e22009-07-30 18:56:46 +00002147 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2148 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002149 constructCompileUnit(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002150
Devang Patel53bb5c92009-11-10 23:06:00 +00002151 // Create DIEs for each subprogram.
Devang Patel78ab9e22009-07-30 18:56:46 +00002152 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
2153 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002154 constructSubprogramDIE(*I);
Devang Patel13e16b62009-06-26 01:49:18 +00002155
Devang Patelc366f832009-12-10 19:14:49 +00002156 // Create DIEs for each global variable.
2157 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2158 E = DbgFinder.global_variable_end(); I != E; ++I)
2159 constructGlobalVariableDIE(*I);
2160
Devang Patele7e5a0f2010-08-10 20:01:20 +00002161 //getOrCreateTypeDIE
2162 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
2163 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2164 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2165
Devang Patel1a7ca032010-09-28 18:08:20 +00002166 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
2167 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2168 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2169
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002170 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +00002171 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002172}
2173
Devang Patel2c4ceb12009-11-21 02:48:08 +00002174/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002175///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002176void DwarfDebug::endModule() {
Devang Patel163a9f72010-05-10 22:49:55 +00002177 if (!FirstCU) return;
Devang Patel4a1cad62010-06-28 18:25:03 +00002178 const Module *M = MMI->getModule();
Devang Patele9a1cca2010-08-02 17:32:15 +00002179 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patel4a1cad62010-06-28 18:25:03 +00002180 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2181 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2182 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2183 DISubprogram SP(AllSPs->getOperand(SI));
2184 if (!SP.Verify()) continue;
2185
2186 // Collect info for variables that were optimized out.
Devang Patel8b3a6b62010-07-19 17:53:55 +00002187 if (!SP.isDefinition()) continue;
Devang Patel4a1cad62010-06-28 18:25:03 +00002188 StringRef FName = SP.getLinkageName();
2189 if (FName.empty())
2190 FName = SP.getName();
Devang Patel62367042010-11-10 22:19:21 +00002191 NamedMDNode *NMD = getFnSpecificMDNode(*(MMI->getModule()), FName);
Devang Patel4a1cad62010-06-28 18:25:03 +00002192 if (!NMD) continue;
2193 unsigned E = NMD->getNumOperands();
2194 if (!E) continue;
2195 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Patele9a1cca2010-08-02 17:32:15 +00002196 DeadFnScopeMap[SP] = Scope;
Devang Patel4a1cad62010-06-28 18:25:03 +00002197 for (unsigned I = 0; I != E; ++I) {
2198 DIVariable DV(NMD->getOperand(I));
2199 if (!DV.Verify()) continue;
2200 Scope->addVariable(new DbgVariable(DV));
2201 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002202
Devang Patel4a1cad62010-06-28 18:25:03 +00002203 // Construct subprogram DIE and add variables DIEs.
2204 constructSubprogramDIE(SP);
2205 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patele03161c2010-08-09 18:51:29 +00002206 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patel4a1cad62010-06-28 18:25:03 +00002207 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2208 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2209 if (VariableDIE)
2210 ScopeDIE->addChild(VariableDIE);
2211 }
2212 }
2213 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002214
Devang Patel53bb5c92009-11-10 23:06:00 +00002215 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2216 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2217 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2218 DIE *ISP = *AI;
Devang Patel2c4ceb12009-11-21 02:48:08 +00002219 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +00002220 }
2221
Devang Patele9f8f5e2010-05-07 20:54:48 +00002222 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Patel5d11eb02009-12-03 19:11:07 +00002223 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2224 DIE *SPDie = CI->first;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002225 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Patel5d11eb02009-12-03 19:11:07 +00002226 if (!N) continue;
Devang Patel163a9f72010-05-10 22:49:55 +00002227 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Patel5d11eb02009-12-03 19:11:07 +00002228 if (!NDie) continue;
2229 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patel5d11eb02009-12-03 19:11:07 +00002230 }
2231
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002232 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002233 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002234 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002235 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002236 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002237
2238 // End text sections.
2239 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002240 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnerc0215722010-04-04 19:25:43 +00002241 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002242 }
2243
2244 // Emit common frame information.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002245 emitCommonDebugFrame();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002246
2247 // Emit function debug frame information
2248 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2249 E = DebugFrames.end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002250 emitFunctionDebugFrame(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002251
2252 // Compute DIE offsets and sizes.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002253 computeSizeAndOffsets();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002254
2255 // Emit all the DIEs into a debug info section
Devang Patel2c4ceb12009-11-21 02:48:08 +00002256 emitDebugInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002257
2258 // Corresponding abbreviations into a abbrev section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002259 emitAbbreviations();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002260
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002261 // Emit info into a debug pubnames section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002262 emitDebugPubNames();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002263
Devang Patel193f7202009-11-24 01:14:22 +00002264 // Emit info into a debug pubtypes section.
2265 emitDebugPubTypes();
2266
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002267 // Emit info into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002268 emitDebugLoc();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002269
2270 // Emit info into a debug aranges section.
2271 EmitDebugARanges();
2272
2273 // Emit info into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002274 emitDebugRanges();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002275
2276 // Emit info into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002277 emitDebugMacInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002278
2279 // Emit inline info.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002280 emitDebugInlineInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002281
Chris Lattnerbc733f52010-03-13 02:17:42 +00002282 // Emit info into a debug str section.
2283 emitDebugStr();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002284
Devang Patele9a1cca2010-08-02 17:32:15 +00002285 // clean up.
2286 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel163a9f72010-05-10 22:49:55 +00002287 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2288 E = CUMap.end(); I != E; ++I)
2289 delete I->second;
2290 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002291}
2292
Devang Patel53bb5c92009-11-10 23:06:00 +00002293/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002294DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattnerde4845c2010-04-02 19:42:39 +00002295 DebugLoc ScopeLoc) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002296
Devang Patel2db49d72010-05-07 18:11:54 +00002297 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00002298 if (AbsDbgVariable)
2299 return AbsDbgVariable;
2300
Devang Patel2db49d72010-05-07 18:11:54 +00002301 LLVMContext &Ctx = Var->getContext();
Chris Lattnerde4845c2010-04-02 19:42:39 +00002302 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00002303 if (!Scope)
2304 return NULL;
2305
Devang Patel26c1e562010-05-20 16:36:41 +00002306 AbsDbgVariable = new DbgVariable(Var);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002307 Scope->addVariable(AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00002308 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00002309 return AbsDbgVariable;
2310}
2311
Devang Patelee432862010-05-20 19:57:06 +00002312/// collectVariableInfoFromMMITable - Collect variable information from
2313/// side table maintained by MMI.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002314void
Devang Patelee432862010-05-20 19:57:06 +00002315DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2316 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00002317 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patele717faa2009-10-06 01:26:37 +00002318 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2319 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2320 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00002321 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00002322 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00002323 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002324 DIVariable DV(Var);
2325 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00002326
Chris Lattnerde4845c2010-04-02 19:42:39 +00002327 DbgScope *Scope = 0;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002328 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattnerde4845c2010-04-02 19:42:39 +00002329 Scope = ConcreteScopes.lookup(IA);
2330 if (Scope == 0)
2331 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002332
Devang Patelfb0ee432009-11-10 23:20:04 +00002333 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00002334 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00002335 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00002336
Devang Patel26c1e562010-05-20 16:36:41 +00002337 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2338 DbgVariable *RegVar = new DbgVariable(DV);
2339 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002340 Scope->addVariable(RegVar);
Devang Patel26c1e562010-05-20 16:36:41 +00002341 if (AbsDbgVariable) {
2342 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2343 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2344 }
Devang Patele717faa2009-10-06 01:26:37 +00002345 }
Devang Patelee432862010-05-20 19:57:06 +00002346}
Devang Patel90a48ad2010-03-15 18:33:46 +00002347
Jim Grosbach1e20b962010-07-21 21:21:52 +00002348/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patelc3f5f782010-05-25 23:40:22 +00002349/// DBG_VALUE instruction, is in a defined reg.
2350static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2351 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2352 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2353 return true;
2354 return false;
2355}
2356
Devang Patelee432862010-05-20 19:57:06 +00002357/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002358void
Devang Patel78e127d2010-06-25 22:07:34 +00002359DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2360 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002361
Devang Patelee432862010-05-20 19:57:06 +00002362 /// collection info from MMI table.
2363 collectVariableInfoFromMMITable(MF, Processed);
2364
2365 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patel90a48ad2010-03-15 18:33:46 +00002366 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002367 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelee432862010-05-20 19:57:06 +00002368 I != E; ++I)
Devang Patel90a48ad2010-03-15 18:33:46 +00002369 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2370 II != IE; ++II) {
2371 const MachineInstr *MInsn = II;
Devang Patela36478f2011-01-11 21:42:10 +00002372 if (!MInsn->isDebugValue())
Devang Patel90a48ad2010-03-15 18:33:46 +00002373 continue;
Devang Patelee432862010-05-20 19:57:06 +00002374 DbgValues.push_back(MInsn);
2375 }
Devang Patel90a48ad2010-03-15 18:33:46 +00002376
Devang Patelc3f5f782010-05-25 23:40:22 +00002377 // This is a collection of DBV_VALUE instructions describing same variable.
2378 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patelee432862010-05-20 19:57:06 +00002379 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2380 E = DbgValues.end(); I != E; ++I) {
2381 const MachineInstr *MInsn = *I;
Devang Patelc3f5f782010-05-25 23:40:22 +00002382 MultipleValues.clear();
2383 if (isDbgValueInDefinedReg(MInsn))
2384 MultipleValues.push_back(MInsn);
Devang Patelee432862010-05-20 19:57:06 +00002385 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2386 if (Processed.count(DV) != 0)
2387 continue;
2388
Devang Patel354eb7e2010-06-02 19:05:13 +00002389 const MachineInstr *PrevMI = MInsn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002390 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
Devang Patelc3f5f782010-05-25 23:40:22 +00002391 ME = DbgValues.end(); MI != ME; ++MI) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002392 const MDNode *Var =
Devang Patelc3f5f782010-05-25 23:40:22 +00002393 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
Devang Patela36478f2011-01-11 21:42:10 +00002394 if (Var == DV &&
Devang Patel354eb7e2010-06-02 19:05:13 +00002395 !PrevMI->isIdenticalTo(*MI))
Devang Patelc3f5f782010-05-25 23:40:22 +00002396 MultipleValues.push_back(*MI);
Devang Patel354eb7e2010-06-02 19:05:13 +00002397 PrevMI = *MI;
Devang Patelc3f5f782010-05-25 23:40:22 +00002398 }
2399
Devang Patela36478f2011-01-11 21:42:10 +00002400 DbgScope *Scope = NULL;
Devang Pateld8720f42010-05-27 20:25:04 +00002401 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2402 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelc0c5a262010-05-21 00:10:20 +00002403 Scope = CurrentFnDbgScope;
Devang Patela36478f2011-01-11 21:42:10 +00002404 else
2405 Scope = findDbgScope(MInsn);
Devang Patelee432862010-05-20 19:57:06 +00002406 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00002407 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00002408 continue;
2409
2410 Processed.insert(DV);
Devang Patelee432862010-05-20 19:57:06 +00002411 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patelee432862010-05-20 19:57:06 +00002412 Scope->addVariable(RegVar);
Devang Patelc0c5a262010-05-21 00:10:20 +00002413 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2414 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2415 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patel90a48ad2010-03-15 18:33:46 +00002416 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002417 if (MultipleValues.size() <= 1) {
2418 DbgVariableToDbgInstMap[RegVar] = MInsn;
2419 continue;
2420 }
2421
2422 // handle multiple DBG_VALUE instructions describing one variable.
Devang Patelc3f5f782010-05-25 23:40:22 +00002423 if (DotDebugLocEntries.empty())
Devang Patel80250682010-05-26 23:55:23 +00002424 RegVar->setDotDebugLocOffset(0);
2425 else
2426 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Devang Patele2df8422010-05-26 17:29:32 +00002427 const MachineInstr *Begin = NULL;
2428 const MachineInstr *End = NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002429 for (SmallVector<const MachineInstr *, 4>::iterator
2430 MVI = MultipleValues.begin(), MVE = MultipleValues.end();
Devang Patel61409622010-07-07 20:12:52 +00002431 MVI != MVE; ++MVI) {
Devang Patele2df8422010-05-26 17:29:32 +00002432 if (!Begin) {
2433 Begin = *MVI;
2434 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002435 }
Devang Patele2df8422010-05-26 17:29:32 +00002436 End = *MVI;
Devang Patelc3f5f782010-05-25 23:40:22 +00002437 MachineLocation MLoc;
Devang Patelb2cf5812010-08-04 18:40:52 +00002438 if (Begin->getNumOperands() == 3) {
2439 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2440 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2441 } else
2442 MLoc = Asm->getDebugValueLocation(Begin);
2443
Devang Patele2df8422010-05-26 17:29:32 +00002444 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2445 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patel5573a7d2010-08-04 22:07:27 +00002446 if (MLoc.getReg())
2447 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
2448
Devang Patele2df8422010-05-26 17:29:32 +00002449 Begin = End;
2450 if (MVI + 1 == MVE) {
2451 // If End is the last instruction then its value is valid
Devang Patelc3f5f782010-05-25 23:40:22 +00002452 // until the end of the funtion.
Devang Patelb2cf5812010-08-04 18:40:52 +00002453 MachineLocation EMLoc;
2454 if (End->getNumOperands() == 3) {
2455 if (End->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2456 EMLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2457 } else
2458 EMLoc = Asm->getDebugValueLocation(End);
Devang Patel5573a7d2010-08-04 22:07:27 +00002459 if (EMLoc.getReg())
2460 DotDebugLocEntries.
2461 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, EMLoc));
Devang Patelc3f5f782010-05-25 23:40:22 +00002462 }
2463 }
2464 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00002465 }
Devang Patel98e1cac2010-05-14 21:01:35 +00002466
2467 // Collect info for variables that were optimized out.
Devang Pateld1bbc6b2010-06-22 01:01:58 +00002468 const Function *F = MF->getFunction();
Devang Patel62367042010-11-10 22:19:21 +00002469 if (NamedMDNode *NMD = getFnSpecificMDNode(*(F->getParent()), F->getName())) {
Devang Patel98e1cac2010-05-14 21:01:35 +00002470 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman872814a2010-07-21 18:54:18 +00002471 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patelee432862010-05-20 19:57:06 +00002472 if (!DV || !Processed.insert(DV))
Devang Patel98e1cac2010-05-14 21:01:35 +00002473 continue;
2474 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2475 if (Scope)
Devang Patel26c1e562010-05-20 16:36:41 +00002476 Scope->addVariable(new DbgVariable(DV));
Devang Patel98e1cac2010-05-14 21:01:35 +00002477 }
2478 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002479}
Devang Patel98e1cac2010-05-14 21:01:35 +00002480
Devang Patelc3f5f782010-05-25 23:40:22 +00002481/// getLabelBeforeInsn - Return Label preceding the instruction.
2482const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2483 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2484 LabelsBeforeInsn.find(MI);
2485 if (I == LabelsBeforeInsn.end())
2486 // FunctionBeginSym always preceeds all the instruction in current function.
2487 return FunctionBeginSym;
2488 return I->second;
2489}
2490
2491/// getLabelAfterInsn - Return Label immediately following the instruction.
2492const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2493 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2494 LabelsAfterInsn.find(MI);
2495 if (I == LabelsAfterInsn.end())
2496 return NULL;
2497 return I->second;
Devang Patele717faa2009-10-06 01:26:37 +00002498}
2499
Devang Patelcbbe2872010-10-26 17:49:02 +00002500/// beginInstruction - Process beginning of an instruction.
2501void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002502 if (InsnNeedsLabel.count(MI) == 0) {
2503 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patel553881b2010-03-29 17:20:31 +00002504 return;
Devang Patelc3f5f782010-05-25 23:40:22 +00002505 }
Devang Patelaead63c2010-03-29 22:59:58 +00002506
Devang Patelb2b31a62010-05-26 19:37:24 +00002507 // Check location.
2508 DebugLoc DL = MI->getDebugLoc();
2509 if (!DL.isUnknown()) {
2510 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2511 PrevLabel = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
Devang Pateleac9c072010-04-27 19:46:33 +00002512 PrevInstLoc = DL;
Devang Patelb2b31a62010-05-26 19:37:24 +00002513 LabelsBeforeInsn[MI] = PrevLabel;
2514 return;
Devang Pateleac9c072010-04-27 19:46:33 +00002515 }
Devang Patel553881b2010-03-29 17:20:31 +00002516
Jim Grosbach1e20b962010-07-21 21:21:52 +00002517 // If location is unknown then use temp label for this DBG_VALUE
Devang Patelb2b31a62010-05-26 19:37:24 +00002518 // instruction.
2519 if (MI->isDebugValue()) {
Devang Patel77051f52010-05-26 21:23:46 +00002520 PrevLabel = MMI->getContext().CreateTempSymbol();
2521 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00002522 LabelsBeforeInsn[MI] = PrevLabel;
2523 return;
2524 }
2525
2526 if (UnknownLocations) {
2527 PrevLabel = recordSourceLine(0, 0, 0);
2528 LabelsBeforeInsn[MI] = PrevLabel;
2529 return;
2530 }
2531
2532 assert (0 && "Instruction is not processed!");
Devang Patel0d20ac82009-10-06 01:50:42 +00002533}
2534
Devang Patelcbbe2872010-10-26 17:49:02 +00002535/// endInstruction - Process end of an instruction.
2536void DwarfDebug::endInstruction(const MachineInstr *MI) {
Devang Patel1c246352010-04-08 16:50:29 +00002537 if (InsnsEndScopeSet.count(MI) != 0) {
2538 // Emit a label if this instruction ends a scope.
2539 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2540 Asm->OutStreamer.EmitLabel(Label);
Devang Pateleac9c072010-04-27 19:46:33 +00002541 LabelsAfterInsn[MI] = Label;
Devang Patel1c246352010-04-08 16:50:29 +00002542 }
Devang Patel53bb5c92009-11-10 23:06:00 +00002543}
2544
Devang Pateleac9c072010-04-27 19:46:33 +00002545/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002546DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel61409622010-07-07 20:12:52 +00002547 const MDNode *InlinedAt) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002548 if (!InlinedAt) {
2549 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2550 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002551 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002552 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2553 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Pateleac9c072010-04-27 19:46:33 +00002554 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002555 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002556 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Pateleac9c072010-04-27 19:46:33 +00002557 WScope->setParent(Parent);
2558 Parent->addScope(WScope);
2559 }
2560
2561 if (!WScope->getParent()) {
2562 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastingscad22ad2010-06-15 23:06:30 +00002563 // We used to check only for a linkage name, but that fails
2564 // since we began omitting the linkage name for private
2565 // functions. The new way is to check for the name in metadata,
2566 // but that's not supported in old .ll test cases. Ergo, we
2567 // check both.
Stuart Hastings215aa152010-06-11 20:08:44 +00002568 if (SPName == Asm->MF->getFunction()->getName() ||
2569 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Pateleac9c072010-04-27 19:46:33 +00002570 CurrentFnDbgScope = WScope;
2571 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002572
Devang Pateleac9c072010-04-27 19:46:33 +00002573 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002574 }
2575
Devang Patel78e127d2010-06-25 22:07:34 +00002576 getOrCreateAbstractScope(Scope);
Devang Patel53bb5c92009-11-10 23:06:00 +00002577 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2578 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002579 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002580
2581 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2582 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2583 DILocation DL(InlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002584 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002585 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Pateleac9c072010-04-27 19:46:33 +00002586 WScope->setParent(Parent);
2587 Parent->addScope(WScope);
2588
2589 ConcreteScopes[InlinedAt] = WScope;
Devang Pateleac9c072010-04-27 19:46:33 +00002590
2591 return WScope;
Devang Patel0d20ac82009-10-06 01:50:42 +00002592}
2593
Devang Pateleac9c072010-04-27 19:46:33 +00002594/// hasValidLocation - Return true if debug location entry attached with
2595/// machine instruction encodes valid location info.
2596static bool hasValidLocation(LLVMContext &Ctx,
2597 const MachineInstr *MInsn,
Devang Patele9f8f5e2010-05-07 20:54:48 +00002598 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Pateleac9c072010-04-27 19:46:33 +00002599 DebugLoc DL = MInsn->getDebugLoc();
2600 if (DL.isUnknown()) return false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002601
Devang Patele9f8f5e2010-05-07 20:54:48 +00002602 const MDNode *S = DL.getScope(Ctx);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002603
Devang Pateleac9c072010-04-27 19:46:33 +00002604 // There is no need to create another DIE for compile unit. For all
2605 // other scopes, create one DbgScope now. This will be translated
2606 // into a scope DIE at the end.
2607 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002608
Devang Pateleac9c072010-04-27 19:46:33 +00002609 Scope = S;
2610 InlinedAt = DL.getInlinedAt(Ctx);
2611 return true;
2612}
2613
2614/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2615/// hierarchy.
2616static void calculateDominanceGraph(DbgScope *Scope) {
2617 assert (Scope && "Unable to calculate scop edominance graph!");
2618 SmallVector<DbgScope *, 4> WorkStack;
2619 WorkStack.push_back(Scope);
2620 unsigned Counter = 0;
2621 while (!WorkStack.empty()) {
2622 DbgScope *WS = WorkStack.back();
2623 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2624 bool visitedChildren = false;
2625 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2626 SE = Children.end(); SI != SE; ++SI) {
2627 DbgScope *ChildScope = *SI;
2628 if (!ChildScope->getDFSOut()) {
2629 WorkStack.push_back(ChildScope);
2630 visitedChildren = true;
2631 ChildScope->setDFSIn(++Counter);
2632 break;
2633 }
2634 }
2635 if (!visitedChildren) {
2636 WorkStack.pop_back();
2637 WS->setDFSOut(++Counter);
2638 }
2639 }
2640}
2641
2642/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002643static
Devang Pateleac9c072010-04-27 19:46:33 +00002644void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2645 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2646{
2647#ifndef NDEBUG
2648 unsigned PrevDFSIn = 0;
2649 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2650 I != E; ++I) {
2651 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2652 II != IE; ++II) {
2653 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002654 const MDNode *Scope = NULL;
2655 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002656
2657 // Check if instruction has valid location information.
2658 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2659 dbgs() << " [ ";
Jim Grosbach1e20b962010-07-21 21:21:52 +00002660 if (InlinedAt)
Devang Pateleac9c072010-04-27 19:46:33 +00002661 dbgs() << "*";
Jim Grosbach1e20b962010-07-21 21:21:52 +00002662 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Pateleac9c072010-04-27 19:46:33 +00002663 MI2ScopeMap.find(MInsn);
2664 if (DI != MI2ScopeMap.end()) {
2665 DbgScope *S = DI->second;
2666 dbgs() << S->getDFSIn();
2667 PrevDFSIn = S->getDFSIn();
2668 } else
2669 dbgs() << PrevDFSIn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002670 } else
Devang Pateleac9c072010-04-27 19:46:33 +00002671 dbgs() << " [ x" << PrevDFSIn;
2672 dbgs() << " ]";
2673 MInsn->dump();
2674 }
2675 dbgs() << "\n";
2676 }
2677#endif
2678}
Devang Patel2c4ceb12009-11-21 02:48:08 +00002679/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner14d750d2010-03-31 05:39:57 +00002680/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattnereec791a2010-01-26 23:18:02 +00002681bool DwarfDebug::extractScopeInformation() {
Devang Patelaf9e8472009-10-01 20:31:14 +00002682 // If scope information was extracted using .dbg intrinsics then there is not
2683 // any need to extract these information by scanning each instruction.
2684 if (!DbgScopeMap.empty())
2685 return false;
2686
Dan Gohman314bf7c2010-04-23 01:18:53 +00002687 // Scan each instruction and create scopes. First build working set of scopes.
Devang Pateleac9c072010-04-27 19:46:33 +00002688 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2689 SmallVector<DbgRange, 4> MIRanges;
2690 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002691 const MDNode *PrevScope = NULL;
2692 const MDNode *PrevInlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002693 const MachineInstr *RangeBeginMI = NULL;
2694 const MachineInstr *PrevMI = NULL;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002695 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelaf9e8472009-10-01 20:31:14 +00002696 I != E; ++I) {
2697 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2698 II != IE; ++II) {
2699 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002700 const MDNode *Scope = NULL;
2701 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002702
2703 // Check if instruction has valid location information.
2704 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2705 PrevMI = MInsn;
2706 continue;
2707 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002708
Devang Pateleac9c072010-04-27 19:46:33 +00002709 // If scope has not changed then skip this instruction.
2710 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2711 PrevMI = MInsn;
2712 continue;
2713 }
2714
Devang Pateld3526ea2011-02-15 17:56:09 +00002715 // Ignore DBG_VALUE. It does not contribute any instruction in output.
2716 if (MInsn->isDebugValue())
2717 continue;
2718
Jim Grosbach1e20b962010-07-21 21:21:52 +00002719 if (RangeBeginMI) {
2720 // If we have alread seen a beginning of a instruction range and
Devang Pateleac9c072010-04-27 19:46:33 +00002721 // current instruction scope does not match scope of first instruction
2722 // in this range then create a new instruction range.
2723 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002724 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel61409622010-07-07 20:12:52 +00002725 PrevInlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002726 MIRanges.push_back(R);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002727 }
Devang Pateleac9c072010-04-27 19:46:33 +00002728
2729 // This is a beginning of a new instruction range.
2730 RangeBeginMI = MInsn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002731
Devang Pateleac9c072010-04-27 19:46:33 +00002732 // Reset previous markers.
2733 PrevMI = MInsn;
2734 PrevScope = Scope;
2735 PrevInlinedAt = InlinedAt;
Devang Patel53bb5c92009-11-10 23:06:00 +00002736 }
2737 }
2738
Devang Pateleac9c072010-04-27 19:46:33 +00002739 // Create last instruction range.
2740 if (RangeBeginMI && PrevMI && PrevScope) {
2741 DbgRange R(RangeBeginMI, PrevMI);
2742 MIRanges.push_back(R);
2743 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patelaf9e8472009-10-01 20:31:14 +00002744 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002745
Devang Patel344130e2010-01-04 20:44:00 +00002746 if (!CurrentFnDbgScope)
2747 return false;
2748
Devang Pateleac9c072010-04-27 19:46:33 +00002749 calculateDominanceGraph(CurrentFnDbgScope);
2750 if (PrintDbgScope)
2751 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2752
2753 // Find ranges of instructions covered by each DbgScope;
2754 DbgScope *PrevDbgScope = NULL;
2755 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2756 RE = MIRanges.end(); RI != RE; ++RI) {
2757 const DbgRange &R = *RI;
2758 DbgScope *S = MI2ScopeMap.lookup(R.first);
2759 assert (S && "Lost DbgScope for a machine instruction!");
2760 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2761 PrevDbgScope->closeInsnRange(S);
2762 S->openInsnRange(R.first);
2763 S->extendInsnRange(R.second);
2764 PrevDbgScope = S;
2765 }
2766
2767 if (PrevDbgScope)
2768 PrevDbgScope->closeInsnRange();
Devang Patelaf9e8472009-10-01 20:31:14 +00002769
Devang Patele37b0c62010-04-08 18:43:56 +00002770 identifyScopeMarkers();
Devang Patel6122a4d2010-04-08 15:37:09 +00002771
2772 return !DbgScopeMap.empty();
2773}
2774
Jim Grosbach1e20b962010-07-21 21:21:52 +00002775/// identifyScopeMarkers() -
Devang Pateleac9c072010-04-27 19:46:33 +00002776/// Each DbgScope has first instruction and last instruction to mark beginning
2777/// and end of a scope respectively. Create an inverse map that list scopes
2778/// starts (and ends) with an instruction. One instruction may start (or end)
2779/// multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00002780void DwarfDebug::identifyScopeMarkers() {
Devang Patel42aafd72010-01-20 02:05:23 +00002781 SmallVector<DbgScope *, 4> WorkList;
2782 WorkList.push_back(CurrentFnDbgScope);
2783 while (!WorkList.empty()) {
Chris Lattner14d750d2010-03-31 05:39:57 +00002784 DbgScope *S = WorkList.pop_back_val();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002785
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002786 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002787 if (!Children.empty())
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002788 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00002789 SE = Children.end(); SI != SE; ++SI)
2790 WorkList.push_back(*SI);
2791
Devang Patel53bb5c92009-11-10 23:06:00 +00002792 if (S->isAbstractScope())
2793 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002794
Devang Pateleac9c072010-04-27 19:46:33 +00002795 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2796 if (Ranges.empty())
2797 continue;
2798 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2799 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002800 assert(RI->first && "DbgRange does not have first instruction!");
2801 assert(RI->second && "DbgRange does not have second instruction!");
Devang Pateleac9c072010-04-27 19:46:33 +00002802 InsnsEndScopeSet.insert(RI->second);
2803 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002804 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002805}
2806
Dan Gohman084751c2010-04-20 00:37:27 +00002807/// FindFirstDebugLoc - Find the first debug location in the function. This
2808/// is intended to be an approximation for the source position of the
2809/// beginning of the function.
2810static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2811 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2812 I != E; ++I)
2813 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2814 MBBI != MBBE; ++MBBI) {
2815 DebugLoc DL = MBBI->getDebugLoc();
2816 if (!DL.isUnknown())
2817 return DL;
2818 }
2819 return DebugLoc();
2820}
2821
Devang Patel9a31f0f2010-10-25 20:45:32 +00002822#ifndef NDEBUG
2823/// CheckLineNumbers - Count basicblocks whose instructions do not have any
2824/// line number information.
2825static void CheckLineNumbers(const MachineFunction *MF) {
2826 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2827 I != E; ++I) {
2828 bool FoundLineNo = false;
2829 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2830 II != IE; ++II) {
2831 const MachineInstr *MI = II;
2832 if (!MI->getDebugLoc().isUnknown()) {
2833 FoundLineNo = true;
2834 break;
2835 }
2836 }
Devang Patel4d7f9a02010-10-28 22:11:59 +00002837 if (!FoundLineNo && I->size())
Devang Patel9a31f0f2010-10-25 20:45:32 +00002838 ++BlocksWithoutLineNo;
2839 }
2840}
2841#endif
2842
Devang Patel2c4ceb12009-11-21 02:48:08 +00002843/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002844/// emitted immediately after the function entry point.
Chris Lattnereec791a2010-01-26 23:18:02 +00002845void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00002846 if (!MMI->hasDebugInfo()) return;
Bill Wendling5f017e82010-04-07 09:28:04 +00002847 if (!extractScopeInformation()) return;
Devang Patel60b35bd2009-10-06 18:37:31 +00002848
Devang Patel9a31f0f2010-10-25 20:45:32 +00002849#ifndef NDEBUG
2850 CheckLineNumbers(MF);
2851#endif
2852
Devang Pateleac9c072010-04-27 19:46:33 +00002853 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2854 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002855 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00002856 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002857
2858 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2859 // function.
Dan Gohman084751c2010-04-20 00:37:27 +00002860 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002861 if (FDL.isUnknown()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002862
Devang Patele9f8f5e2010-05-07 20:54:48 +00002863 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings0db42712010-07-19 23:56:30 +00002864 const MDNode *TheScope = 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002865
Chris Lattnerde4845c2010-04-02 19:42:39 +00002866 DISubprogram SP = getDISubprogram(Scope);
2867 unsigned Line, Col;
2868 if (SP.Verify()) {
2869 Line = SP.getLineNumber();
2870 Col = 0;
Stuart Hastings0db42712010-07-19 23:56:30 +00002871 TheScope = SP;
Chris Lattnerde4845c2010-04-02 19:42:39 +00002872 } else {
2873 Line = FDL.getLine();
2874 Col = FDL.getCol();
Stuart Hastings0db42712010-07-19 23:56:30 +00002875 TheScope = Scope;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002876 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002877
Stuart Hastings0db42712010-07-19 23:56:30 +00002878 recordSourceLine(Line, Col, TheScope);
Devang Patelb2b31a62010-05-26 19:37:24 +00002879
Devang Patelb9abe9f2010-06-02 16:42:51 +00002880 /// ProcessedArgs - Collection of arguments already processed.
2881 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2882
Devang Patelb2b31a62010-05-26 19:37:24 +00002883 DebugLoc PrevLoc;
2884 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2885 I != E; ++I)
2886 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2887 II != IE; ++II) {
2888 const MachineInstr *MI = II;
2889 DebugLoc DL = MI->getDebugLoc();
2890 if (MI->isDebugValue()) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002891 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2892 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2893 if (!DV.Verify()) continue;
Devang Patel55e97172010-05-27 16:47:30 +00002894 // If DBG_VALUE is for a local variable then it needs a label.
Devang Patelb7313e22010-12-06 22:48:22 +00002895 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
Devang Patelb2b31a62010-05-26 19:37:24 +00002896 InsnNeedsLabel.insert(MI);
Devang Patel55e97172010-05-27 16:47:30 +00002897 // DBG_VALUE for inlined functions argument needs a label.
Devang Patel7fb231c2010-07-01 21:38:08 +00002898 else if (!DISubprogram(getDISubprogram(DV.getContext())).
2899 describes(MF->getFunction()))
Devang Patel55e97172010-05-27 16:47:30 +00002900 InsnNeedsLabel.insert(MI);
2901 // DBG_VALUE indicating argument location change needs a label.
Devang Patelb7313e22010-12-06 22:48:22 +00002902 else if (!ProcessedArgs.insert(DV))
Devang Patelb2b31a62010-05-26 19:37:24 +00002903 InsnNeedsLabel.insert(MI);
2904 } else {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002905 // If location is unknown then instruction needs a location only if
Devang Patelb2b31a62010-05-26 19:37:24 +00002906 // UnknownLocations flag is set.
2907 if (DL.isUnknown()) {
2908 if (UnknownLocations && !PrevLoc.isUnknown())
2909 InsnNeedsLabel.insert(MI);
2910 } else if (DL != PrevLoc)
2911 // Otherwise, instruction needs a location only if it is new location.
2912 InsnNeedsLabel.insert(MI);
2913 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002914
Devang Patelb2b31a62010-05-26 19:37:24 +00002915 if (!DL.isUnknown() || UnknownLocations)
2916 PrevLoc = DL;
2917 }
2918
2919 PrevLabel = FunctionBeginSym;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002920}
2921
Devang Patel2c4ceb12009-11-21 02:48:08 +00002922/// endFunction - Gather and emit post-function debug information.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002923///
Chris Lattnereec791a2010-01-26 23:18:02 +00002924void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendling5f017e82010-04-07 09:28:04 +00002925 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00002926
Devang Patel344130e2010-01-04 20:44:00 +00002927 if (CurrentFnDbgScope) {
Devang Patel65eb4822010-05-22 00:04:14 +00002928
Devang Patelc3f5f782010-05-25 23:40:22 +00002929 // Define end label for subprogram.
2930 FunctionEndSym = Asm->GetTempSymbol("func_end",
2931 Asm->getFunctionNumber());
2932 // Assumes in correct section after the entry point.
2933 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002934
Devang Patel78e127d2010-06-25 22:07:34 +00002935 SmallPtrSet<const MDNode *, 16> ProcessedVars;
2936 collectVariableInfo(MF, ProcessedVars);
Devang Patel65eb4822010-05-22 00:04:14 +00002937
Devang Patel344130e2010-01-04 20:44:00 +00002938 // Construct abstract scopes.
2939 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel78e127d2010-06-25 22:07:34 +00002940 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel78e127d2010-06-25 22:07:34 +00002941 DISubprogram SP((*AI)->getScopeNode());
2942 if (SP.Verify()) {
2943 // Collect info for variables that were optimized out.
2944 StringRef FName = SP.getLinkageName();
2945 if (FName.empty())
2946 FName = SP.getName();
Devang Patel62367042010-11-10 22:19:21 +00002947 if (NamedMDNode *NMD =
2948 getFnSpecificMDNode(*(MF->getFunction()->getParent()), FName)) {
Devang Patel78e127d2010-06-25 22:07:34 +00002949 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman872814a2010-07-21 18:54:18 +00002950 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel78e127d2010-06-25 22:07:34 +00002951 if (!DV || !ProcessedVars.insert(DV))
2952 continue;
Devang Patel1d68d212010-06-30 00:11:08 +00002953 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel78e127d2010-06-25 22:07:34 +00002954 if (Scope)
2955 Scope->addVariable(new DbgVariable(DV));
2956 }
2957 }
2958 }
Devang Patel90e19aa2010-06-30 01:40:11 +00002959 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
2960 constructScopeDIE(*AI);
Devang Patel78e127d2010-06-25 22:07:34 +00002961 }
Devang Patel61409622010-07-07 20:12:52 +00002962
Devang Patel9c488372010-05-04 06:15:30 +00002963 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002964
Devang Patel9c488372010-05-04 06:15:30 +00002965 if (!DisableFramePointerElim(*MF))
Jim Grosbach1e20b962010-07-21 21:21:52 +00002966 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel9c488372010-05-04 06:15:30 +00002967 dwarf::DW_FORM_flag, 1);
2968
2969
Chris Lattnerd38fee82010-04-05 00:13:49 +00002970 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel344130e2010-01-04 20:44:00 +00002971 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002972 }
2973
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002974 // Clear debug info
Devang Patelf54b8522010-01-19 01:26:02 +00002975 CurrentFnDbgScope = NULL;
Devang Patelb2b31a62010-05-26 19:37:24 +00002976 InsnNeedsLabel.clear();
Devang Patel26c1e562010-05-20 16:36:41 +00002977 DbgVariableToFrameIndexMap.clear();
2978 VarToAbstractVarMap.clear();
2979 DbgVariableToDbgInstMap.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002980 DeleteContainerSeconds(DbgScopeMap);
Devang Patel51424712010-04-09 16:04:20 +00002981 InsnsEndScopeSet.clear();
Devang Patelf54b8522010-01-19 01:26:02 +00002982 ConcreteScopes.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002983 DeleteContainerSeconds(AbstractScopes);
Devang Patelf54b8522010-01-19 01:26:02 +00002984 AbstractScopesList.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002985 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00002986 LabelsBeforeInsn.clear();
2987 LabelsAfterInsn.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00002988 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002989}
2990
Devang Patel26c1e562010-05-20 16:36:41 +00002991/// recordVariableFrameIndex - Record a variable's index.
2992void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2993 assert (V && "Invalid DbgVariable!");
2994 DbgVariableToFrameIndexMap[V] = Index;
2995}
2996
2997/// findVariableFrameIndex - Return true if frame index for the variable
2998/// is found. Update FI to hold value of the index.
2999bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
3000 assert (V && "Invalid DbgVariable!");
3001 DenseMap<const DbgVariable *, int>::iterator I =
3002 DbgVariableToFrameIndexMap.find(V);
3003 if (I == DbgVariableToFrameIndexMap.end())
3004 return false;
3005 *FI = I->second;
3006 return true;
3007}
3008
Jim Grosbach1e20b962010-07-21 21:21:52 +00003009/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patelee432862010-05-20 19:57:06 +00003010/// instruction.
3011DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
3012 DbgScope *Scope = NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003013 LLVMContext &Ctx =
Devang Patelee432862010-05-20 19:57:06 +00003014 MInsn->getParent()->getParent()->getFunction()->getContext();
3015 DebugLoc DL = MInsn->getDebugLoc();
3016
Jim Grosbach1e20b962010-07-21 21:21:52 +00003017 if (DL.isUnknown())
Devang Patelee432862010-05-20 19:57:06 +00003018 return Scope;
3019
3020 if (const MDNode *IA = DL.getInlinedAt(Ctx))
3021 Scope = ConcreteScopes.lookup(IA);
3022 if (Scope == 0)
3023 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003024
Devang Patelee432862010-05-20 19:57:06 +00003025 return Scope;
3026}
3027
3028
Chris Lattnerc6087842010-03-09 04:54:43 +00003029/// recordSourceLine - Register a source line with debug info. Returns the
3030/// unique label that was emitted and which provides correspondence to
3031/// the source line list.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003032MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel61409622010-07-07 20:12:52 +00003033 const MDNode *S) {
Devang Patel65dbc902009-11-25 17:36:49 +00003034 StringRef Fn;
Devang Patelf84548d2009-10-05 18:03:19 +00003035
Dan Gohman1cc0d622010-05-05 23:41:32 +00003036 unsigned Src = 1;
3037 if (S) {
3038 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00003039
Dan Gohman1cc0d622010-05-05 23:41:32 +00003040 if (Scope.isCompileUnit()) {
3041 DICompileUnit CU(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00003042 Fn = CU.getFilename();
Devang Patel3cabc9d2010-10-28 17:30:52 +00003043 } else if (Scope.isFile()) {
3044 DIFile F(S);
Devang Patel3cabc9d2010-10-28 17:30:52 +00003045 Fn = F.getFilename();
Dan Gohman1cc0d622010-05-05 23:41:32 +00003046 } else if (Scope.isSubprogram()) {
3047 DISubprogram SP(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00003048 Fn = SP.getFilename();
3049 } else if (Scope.isLexicalBlock()) {
3050 DILexicalBlock DB(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00003051 Fn = DB.getFilename();
3052 } else
3053 assert(0 && "Unexpected scope info");
3054
Rafael Espindola5c055632010-11-18 02:04:25 +00003055 Src = GetOrCreateSourceID(Fn);
Dan Gohman1cc0d622010-05-05 23:41:32 +00003056 }
3057
Rafael Espindola5c055632010-11-18 02:04:25 +00003058 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, DWARF2_FLAG_IS_STMT,
3059 0, 0);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00003060
Rafael Espindola5c055632010-11-18 02:04:25 +00003061 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattnerc6087842010-03-09 04:54:43 +00003062 Asm->OutStreamer.EmitLabel(Label);
3063 return Label;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00003064}
3065
Bill Wendling829e67b2009-05-20 23:22:40 +00003066//===----------------------------------------------------------------------===//
3067// Emit Methods
3068//===----------------------------------------------------------------------===//
3069
Devang Patel2c4ceb12009-11-21 02:48:08 +00003070/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling94d04b82009-05-20 23:21:38 +00003071///
Jim Grosbach7ab38df2009-11-22 19:20:36 +00003072unsigned
3073DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003074 // Get the children.
3075 const std::vector<DIE *> &Children = Die->getChildren();
3076
3077 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00003078 if (!Last && !Children.empty())
Benjamin Kramer345ef342010-03-31 19:34:01 +00003079 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling94d04b82009-05-20 23:21:38 +00003080
3081 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003082 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00003083
3084 // Get the abbreviation for this DIE.
3085 unsigned AbbrevNumber = Die->getAbbrevNumber();
3086 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3087
3088 // Set DIE offset
3089 Die->setOffset(Offset);
3090
3091 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00003092 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00003093
3094 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
3095 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3096
3097 // Size the DIE attribute values.
3098 for (unsigned i = 0, N = Values.size(); i < N; ++i)
3099 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00003100 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00003101
3102 // Size the DIE children if any.
3103 if (!Children.empty()) {
3104 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
3105 "Children flag not set");
3106
3107 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00003108 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling94d04b82009-05-20 23:21:38 +00003109
3110 // End of children marker.
3111 Offset += sizeof(int8_t);
3112 }
3113
3114 Die->setSize(Offset - Die->getOffset());
3115 return Offset;
3116}
3117
Devang Patel2c4ceb12009-11-21 02:48:08 +00003118/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling94d04b82009-05-20 23:21:38 +00003119///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003120void DwarfDebug::computeSizeAndOffsets() {
Devang Patel163a9f72010-05-10 22:49:55 +00003121 unsigned PrevOffset = 0;
3122 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3123 E = CUMap.end(); I != E; ++I) {
3124 // Compute size of compile unit header.
3125 static unsigned Offset = PrevOffset +
3126 sizeof(int32_t) + // Length of Compilation Unit Info
3127 sizeof(int16_t) + // DWARF version number
3128 sizeof(int32_t) + // Offset Into Abbrev. Section
3129 sizeof(int8_t); // Pointer Size (in bytes)
3130 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
3131 PrevOffset = Offset;
3132 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003133}
3134
Chris Lattner11b8f302010-04-04 23:02:02 +00003135/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3136/// temporary label to it if SymbolStem is specified.
Chris Lattner9c69e285532010-04-04 22:59:04 +00003137static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner11b8f302010-04-04 23:02:02 +00003138 const char *SymbolStem = 0) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00003139 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner11b8f302010-04-04 23:02:02 +00003140 if (!SymbolStem) return 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003141
Chris Lattner9c69e285532010-04-04 22:59:04 +00003142 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3143 Asm->OutStreamer.EmitLabel(TmpSym);
3144 return TmpSym;
3145}
3146
3147/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3148/// the start of each one.
Chris Lattnerfa070b02010-04-04 22:33:59 +00003149void DwarfDebug::EmitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003150 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003151
Bill Wendling94d04b82009-05-20 23:21:38 +00003152 // Dwarf sections base addresses.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003153 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00003154 DwarfFrameSectionSym =
3155 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3156 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003157
Jim Grosbach1e20b962010-07-21 21:21:52 +00003158 DwarfInfoSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003159 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003160 DwarfAbbrevSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003161 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner11b8f302010-04-04 23:02:02 +00003162 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003163
Chris Lattner9c69e285532010-04-04 22:59:04 +00003164 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner11b8f302010-04-04 23:02:02 +00003165 EmitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003166
Devang Patelaf608bd2010-08-24 00:06:12 +00003167 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner11b8f302010-04-04 23:02:02 +00003168 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3169 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3170 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003171 DwarfStrSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003172 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patelf2548ca2010-04-16 23:33:45 +00003173 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3174 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00003175
Devang Patelc3f5f782010-05-25 23:40:22 +00003176 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3177 "section_debug_loc");
3178
Chris Lattner9c69e285532010-04-04 22:59:04 +00003179 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattner4ad1efe2010-04-04 23:10:38 +00003180 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003181}
3182
Devang Patel2c4ceb12009-11-21 02:48:08 +00003183/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling94d04b82009-05-20 23:21:38 +00003184///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003185void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003186 // Get the abbreviation for this DIE.
3187 unsigned AbbrevNumber = Die->getAbbrevNumber();
3188 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3189
Bill Wendling94d04b82009-05-20 23:21:38 +00003190 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00003191 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00003192 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3193 Twine::utohexstr(Die->getOffset()) + ":0x" +
3194 Twine::utohexstr(Die->getSize()) + " " +
3195 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003196 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00003197
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00003198 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling94d04b82009-05-20 23:21:38 +00003199 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3200
3201 // Emit the DIE attribute values.
3202 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3203 unsigned Attr = AbbrevData[i].getAttribute();
3204 unsigned Form = AbbrevData[i].getForm();
3205 assert(Form && "Too many attributes for DIE (check abbreviation)");
3206
Chris Lattner3f53c832010-04-04 18:52:31 +00003207 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00003208 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003209
Bill Wendling94d04b82009-05-20 23:21:38 +00003210 switch (Attr) {
3211 case dwarf::DW_AT_sibling:
Devang Patel2c4ceb12009-11-21 02:48:08 +00003212 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003213 break;
3214 case dwarf::DW_AT_abstract_origin: {
3215 DIEEntry *E = cast<DIEEntry>(Values[i]);
3216 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00003217 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00003218 Asm->EmitInt32(Addr);
3219 break;
3220 }
Devang Patelf2548ca2010-04-16 23:33:45 +00003221 case dwarf::DW_AT_ranges: {
3222 // DW_AT_range Value encodes offset in debug_range section.
3223 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelb1fcfbe2010-09-02 16:43:44 +00003224
3225 if (Asm->MAI->doesDwarfUsesLabelOffsetForRanges()) {
3226 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
3227 V->getValue(),
3228 4);
3229 } else {
3230 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3231 V->getValue(),
3232 DwarfDebugRangeSectionSym,
3233 4);
3234 }
Devang Patelf2548ca2010-04-16 23:33:45 +00003235 break;
3236 }
Devang Patelc3f5f782010-05-25 23:40:22 +00003237 case dwarf::DW_AT_location: {
3238 if (UseDotDebugLocEntry.count(Die) != 0) {
3239 DIELabel *L = cast<DIELabel>(Values[i]);
3240 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
3241 } else
3242 Values[i]->EmitValue(Asm, Form);
3243 break;
3244 }
Devang Patel2a361602010-09-29 19:08:08 +00003245 case dwarf::DW_AT_accessibility: {
3246 if (Asm->isVerbose()) {
3247 DIEInteger *V = cast<DIEInteger>(Values[i]);
3248 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
3249 }
3250 Values[i]->EmitValue(Asm, Form);
3251 break;
3252 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003253 default:
3254 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003255 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00003256 break;
3257 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003258 }
3259
3260 // Emit the DIE children if any.
3261 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3262 const std::vector<DIE *> &Children = Die->getChildren();
3263
3264 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00003265 emitDIE(Children[j]);
Bill Wendling94d04b82009-05-20 23:21:38 +00003266
Chris Lattner3f53c832010-04-04 18:52:31 +00003267 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00003268 Asm->OutStreamer.AddComment("End Of Children Mark");
3269 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003270 }
3271}
3272
Devang Patel8a241142009-12-09 18:24:21 +00003273/// emitDebugInfo - Emit the debug info section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003274///
Devang Patel8a241142009-12-09 18:24:21 +00003275void DwarfDebug::emitDebugInfo() {
3276 // Start debug info section.
3277 Asm->OutStreamer.SwitchSection(
3278 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel163a9f72010-05-10 22:49:55 +00003279 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3280 E = CUMap.end(); I != E; ++I) {
3281 CompileUnit *TheCU = I->second;
3282 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00003283
Devang Patel163a9f72010-05-10 22:49:55 +00003284 // Emit the compile units header.
3285 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3286 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003287
Devang Patel163a9f72010-05-10 22:49:55 +00003288 // Emit size of content not including length itself
3289 unsigned ContentSize = Die->getSize() +
3290 sizeof(int16_t) + // DWARF version number
3291 sizeof(int32_t) + // Offset Into Abbrev. Section
3292 sizeof(int8_t) + // Pointer Size (in bytes)
3293 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003294
Devang Patel163a9f72010-05-10 22:49:55 +00003295 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3296 Asm->EmitInt32(ContentSize);
3297 Asm->OutStreamer.AddComment("DWARF version number");
3298 Asm->EmitInt16(dwarf::DWARF_VERSION);
3299 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3300 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3301 DwarfAbbrevSectionSym);
3302 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3303 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003304
Devang Patel163a9f72010-05-10 22:49:55 +00003305 emitDIE(Die);
3306 // FIXME - extra padding for gdb bug.
3307 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3308 Asm->EmitInt8(0);
3309 Asm->EmitInt8(0);
3310 Asm->EmitInt8(0);
3311 Asm->EmitInt8(0);
3312 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3313 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003314}
3315
Devang Patel2c4ceb12009-11-21 02:48:08 +00003316/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003317///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003318void DwarfDebug::emitAbbreviations() const {
Bill Wendling94d04b82009-05-20 23:21:38 +00003319 // Check to see if it is worth the effort.
3320 if (!Abbreviations.empty()) {
3321 // Start the debug abbrev section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003322 Asm->OutStreamer.SwitchSection(
3323 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003324
Chris Lattnerc0215722010-04-04 19:25:43 +00003325 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003326
3327 // For each abbrevation.
3328 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3329 // Get abbreviation data
3330 const DIEAbbrev *Abbrev = Abbreviations[i];
3331
3332 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003333 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00003334
3335 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003336 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00003337 }
3338
3339 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003340 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00003341
Chris Lattnerc0215722010-04-04 19:25:43 +00003342 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003343 }
3344}
3345
Devang Patel2c4ceb12009-11-21 02:48:08 +00003346/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling94d04b82009-05-20 23:21:38 +00003347/// the line matrix.
3348///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003349void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003350 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00003351 Asm->OutStreamer.AddComment("Extended Op");
3352 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003353
Chris Lattner233f52b2010-03-09 23:52:58 +00003354 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003355 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003356 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3357 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3358
3359 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00003360
Chris Lattnerc0215722010-04-04 19:25:43 +00003361 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003362 Asm->getTargetData().getPointerSize(),
3363 0/*AddrSpace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003364
3365 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00003366 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3367 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00003368 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00003369 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003370}
3371
Devang Patel2c4ceb12009-11-21 02:48:08 +00003372/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003373///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003374void DwarfDebug::emitCommonDebugFrame() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003375 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003376 return;
3377
Chris Lattnerd38fee82010-04-05 00:13:49 +00003378 int stackGrowth = Asm->getTargetData().getPointerSize();
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00003379 if (Asm->TM.getFrameLowering()->getStackGrowthDirection() ==
3380 TargetFrameLowering::StackGrowsDown)
Chris Lattnerd38fee82010-04-05 00:13:49 +00003381 stackGrowth *= -1;
Bill Wendling94d04b82009-05-20 23:21:38 +00003382
3383 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003384 Asm->OutStreamer.SwitchSection(
3385 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003386
Chris Lattnerc0215722010-04-04 19:25:43 +00003387 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003388 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003389 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3390 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003391
Chris Lattnerc0215722010-04-04 19:25:43 +00003392 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003393 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling94d04b82009-05-20 23:21:38 +00003394 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner233f52b2010-03-09 23:52:58 +00003395 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling94d04b82009-05-20 23:21:38 +00003396 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner233f52b2010-03-09 23:52:58 +00003397 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003398 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003399 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3400 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner233f52b2010-03-09 23:52:58 +00003401 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003402 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00003403 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
Bill Wendling94d04b82009-05-20 23:21:38 +00003404 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling94d04b82009-05-20 23:21:38 +00003405
3406 std::vector<MachineMove> Moves;
Anton Korobeynikovd9e33852010-11-18 23:25:52 +00003407 TFI->getInitialFrameState(Moves);
Bill Wendling94d04b82009-05-20 23:21:38 +00003408
Chris Lattner02b86b92010-04-04 23:41:46 +00003409 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003410
Chris Lattner059ea132010-04-28 01:05:45 +00003411 Asm->EmitAlignment(2);
Chris Lattnerc0215722010-04-04 19:25:43 +00003412 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003413}
3414
Devang Patel2c4ceb12009-11-21 02:48:08 +00003415/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling94d04b82009-05-20 23:21:38 +00003416/// section.
Chris Lattner206d61e2010-03-13 07:26:18 +00003417void DwarfDebug::
3418emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003419 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003420 return;
3421
3422 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003423 Asm->OutStreamer.SwitchSection(
3424 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003425
Chris Lattner233f52b2010-03-09 23:52:58 +00003426 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner206d61e2010-03-13 07:26:18 +00003427 MCSymbol *DebugFrameBegin =
Chris Lattnerc0215722010-04-04 19:25:43 +00003428 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner206d61e2010-03-13 07:26:18 +00003429 MCSymbol *DebugFrameEnd =
Chris Lattnerc0215722010-04-04 19:25:43 +00003430 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnera6437182010-04-04 19:58:12 +00003431 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003432
Chris Lattner206d61e2010-03-13 07:26:18 +00003433 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling94d04b82009-05-20 23:21:38 +00003434
Chris Lattner233f52b2010-03-09 23:52:58 +00003435 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003436 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner6189ed12010-04-04 23:25:33 +00003437 DwarfFrameSectionSym);
Bill Wendling94d04b82009-05-20 23:21:38 +00003438
Chris Lattner233f52b2010-03-09 23:52:58 +00003439 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnerc0215722010-04-04 19:25:43 +00003440 MCSymbol *FuncBeginSym =
3441 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattnerfb658072010-03-13 07:40:56 +00003442 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattnerd38fee82010-04-05 00:13:49 +00003443 Asm->getTargetData().getPointerSize(),
3444 0/*AddrSpace*/);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003445
3446
Chris Lattner233f52b2010-03-09 23:52:58 +00003447 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnera6437182010-04-04 19:58:12 +00003448 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003449 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003450
Chris Lattner02b86b92010-04-04 23:41:46 +00003451 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003452
Chris Lattner059ea132010-04-28 01:05:45 +00003453 Asm->EmitAlignment(2);
Chris Lattner206d61e2010-03-13 07:26:18 +00003454 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling94d04b82009-05-20 23:21:38 +00003455}
3456
Devang Patel8a241142009-12-09 18:24:21 +00003457/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3458///
3459void DwarfDebug::emitDebugPubNames() {
Devang Patel163a9f72010-05-10 22:49:55 +00003460 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3461 E = CUMap.end(); I != E; ++I) {
3462 CompileUnit *TheCU = I->second;
3463 // Start the dwarf pubnames section.
3464 Asm->OutStreamer.SwitchSection(
3465 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003466
Devang Patel163a9f72010-05-10 22:49:55 +00003467 Asm->OutStreamer.AddComment("Length of Public Names Info");
3468 Asm->EmitLabelDifference(
3469 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3470 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003471
Devang Patel163a9f72010-05-10 22:49:55 +00003472 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3473 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003474
Devang Patel163a9f72010-05-10 22:49:55 +00003475 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003476 Asm->EmitInt16(dwarf::DWARF_VERSION);
3477
Devang Patel163a9f72010-05-10 22:49:55 +00003478 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003479 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel163a9f72010-05-10 22:49:55 +00003480 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003481
Devang Patel163a9f72010-05-10 22:49:55 +00003482 Asm->OutStreamer.AddComment("Compilation Unit Length");
3483 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3484 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3485 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003486
Devang Patel163a9f72010-05-10 22:49:55 +00003487 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3488 for (StringMap<DIE*>::const_iterator
3489 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3490 const char *Name = GI->getKeyData();
3491 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003492
Devang Patel163a9f72010-05-10 22:49:55 +00003493 Asm->OutStreamer.AddComment("DIE offset");
3494 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003495
Devang Patel163a9f72010-05-10 22:49:55 +00003496 if (Asm->isVerbose())
3497 Asm->OutStreamer.AddComment("External Name");
3498 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3499 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00003500
Devang Patel163a9f72010-05-10 22:49:55 +00003501 Asm->OutStreamer.AddComment("End Mark");
3502 Asm->EmitInt32(0);
3503 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3504 TheCU->getID()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003505 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003506}
3507
Devang Patel193f7202009-11-24 01:14:22 +00003508void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00003509 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3510 E = CUMap.end(); I != E; ++I) {
3511 CompileUnit *TheCU = I->second;
3512 // Start the dwarf pubnames section.
3513 Asm->OutStreamer.SwitchSection(
3514 Asm->getObjFileLowering().getDwarfPubTypesSection());
3515 Asm->OutStreamer.AddComment("Length of Public Types Info");
3516 Asm->EmitLabelDifference(
3517 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3518 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003519
Devang Patel163a9f72010-05-10 22:49:55 +00003520 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3521 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003522
Devang Patel163a9f72010-05-10 22:49:55 +00003523 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3524 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003525
Devang Patel163a9f72010-05-10 22:49:55 +00003526 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3527 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3528 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003529
Devang Patel163a9f72010-05-10 22:49:55 +00003530 Asm->OutStreamer.AddComment("Compilation Unit Length");
3531 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3532 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3533 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003534
Devang Patel163a9f72010-05-10 22:49:55 +00003535 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3536 for (StringMap<DIE*>::const_iterator
3537 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3538 const char *Name = GI->getKeyData();
3539 DIE * Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003540
Devang Patel163a9f72010-05-10 22:49:55 +00003541 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3542 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003543
Devang Patel163a9f72010-05-10 22:49:55 +00003544 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3545 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3546 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00003547
Devang Patel163a9f72010-05-10 22:49:55 +00003548 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003549 Asm->EmitInt32(0);
Devang Patel163a9f72010-05-10 22:49:55 +00003550 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3551 TheCU->getID()));
Devang Patel193f7202009-11-24 01:14:22 +00003552 }
Devang Patel193f7202009-11-24 01:14:22 +00003553}
3554
Devang Patel2c4ceb12009-11-21 02:48:08 +00003555/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003556///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003557void DwarfDebug::emitDebugStr() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003558 // Check to see if it is worth the effort.
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003559 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003560
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003561 // Start the dwarf str section.
3562 Asm->OutStreamer.SwitchSection(
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003563 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003564
Chris Lattnerbc733f52010-03-13 02:17:42 +00003565 // Get all of the string pool entries and put them in an array by their ID so
3566 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003567 SmallVector<std::pair<unsigned,
Chris Lattnerbc733f52010-03-13 02:17:42 +00003568 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003569
Chris Lattnerbc733f52010-03-13 02:17:42 +00003570 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3571 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3572 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003573
Chris Lattnerbc733f52010-03-13 02:17:42 +00003574 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003575
Chris Lattnerbc733f52010-03-13 02:17:42 +00003576 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003577 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003578 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003579
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003580 // Emit the string itself.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003581 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003582 }
3583}
3584
Devang Patel2c4ceb12009-11-21 02:48:08 +00003585/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003586///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003587void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00003588 if (DotDebugLocEntries.empty())
3589 return;
3590
Devang Patel6c3ea902011-02-04 22:57:18 +00003591 for (SmallVector<DotDebugLocEntry, 4>::iterator
3592 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
3593 I != E; ++I) {
3594 DotDebugLocEntry &Entry = *I;
3595 if (I + 1 != DotDebugLocEntries.end())
3596 Entry.Merge(I+1);
3597 }
3598
Bill Wendling94d04b82009-05-20 23:21:38 +00003599 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003600 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00003601 Asm->getObjFileLowering().getDwarfLocSection());
3602 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00003603 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3604 unsigned index = 1;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003605 for (SmallVector<DotDebugLocEntry, 4>::iterator
3606 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00003607 I != E; ++I, ++index) {
Devang Patel6c3ea902011-02-04 22:57:18 +00003608 DotDebugLocEntry &Entry = *I;
3609 if (Entry.isMerged()) continue;
Devang Patelc3f5f782010-05-25 23:40:22 +00003610 if (Entry.isEmpty()) {
3611 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3612 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel80250682010-05-26 23:55:23 +00003613 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00003614 } else {
3615 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3616 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3617 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3618 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patelb2cf5812010-08-04 18:40:52 +00003619 if (int Offset = Entry.Loc.getOffset()) {
3620 // If the value is at a certain offset from frame register then
3621 // use DW_OP_fbreg.
3622 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patelc3f5f782010-05-25 23:40:22 +00003623 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patelb2cf5812010-08-04 18:40:52 +00003624 Asm->EmitInt16(1 + OffsetSize);
3625 Asm->OutStreamer.AddComment(
3626 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3627 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3628 Asm->OutStreamer.AddComment("Offset");
3629 Asm->EmitSLEB128(Offset);
Devang Patelc3f5f782010-05-25 23:40:22 +00003630 } else {
Devang Patelb2cf5812010-08-04 18:40:52 +00003631 if (Reg < 32) {
3632 Asm->OutStreamer.AddComment("Loc expr size");
3633 Asm->EmitInt16(1);
3634 Asm->OutStreamer.AddComment(
Devang Patela54e0cc2010-08-04 20:32:36 +00003635 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patelb2cf5812010-08-04 18:40:52 +00003636 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3637 } else {
3638 Asm->OutStreamer.AddComment("Loc expr size");
3639 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3640 Asm->EmitInt8(dwarf::DW_OP_regx);
3641 Asm->EmitULEB128(Reg);
3642 }
Devang Patelc3f5f782010-05-25 23:40:22 +00003643 }
3644 }
3645 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003646}
3647
3648/// EmitDebugARanges - Emit visible names into a debug aranges section.
3649///
3650void DwarfDebug::EmitDebugARanges() {
3651 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003652 Asm->OutStreamer.SwitchSection(
3653 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003654}
3655
Devang Patel2c4ceb12009-11-21 02:48:08 +00003656/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003657///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003658void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003659 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003660 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00003661 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Pateleac9c072010-04-27 19:46:33 +00003662 unsigned char Size = Asm->getTargetData().getPointerSize();
3663 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00003664 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00003665 I != E; ++I) {
3666 if (*I)
3667 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003668 else
Devang Pateleac9c072010-04-27 19:46:33 +00003669 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003670 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003671}
3672
Devang Patel2c4ceb12009-11-21 02:48:08 +00003673/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003674///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003675void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003676 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00003677 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003678 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003679 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003680 }
3681}
3682
Devang Patel2c4ceb12009-11-21 02:48:08 +00003683/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling94d04b82009-05-20 23:21:38 +00003684/// Section Header:
3685/// 1. length of section
3686/// 2. Dwarf version number
3687/// 3. address size.
3688///
3689/// Entries (one "entry" for each function that was inlined):
3690///
3691/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3692/// otherwise offset into __debug_str for regular function name.
3693/// 2. offset into __debug_str section for regular function name.
3694/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3695/// instances for the function.
3696///
3697/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3698/// inlined instance; the die_offset points to the inlined_subroutine die in the
3699/// __debug_info section, and the low_pc is the starting address for the
3700/// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003701void DwarfDebug::emitDebugInlineInfo() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003702 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003703 return;
3704
Devang Patel163a9f72010-05-10 22:49:55 +00003705 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00003706 return;
3707
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003708 Asm->OutStreamer.SwitchSection(
3709 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00003710
Chris Lattner233f52b2010-03-09 23:52:58 +00003711 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003712 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3713 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003714
Chris Lattnerc0215722010-04-04 19:25:43 +00003715 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003716
Chris Lattner233f52b2010-03-09 23:52:58 +00003717 Asm->OutStreamer.AddComment("Dwarf Version");
3718 Asm->EmitInt16(dwarf::DWARF_VERSION);
3719 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003720 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003721
Devang Patele9f8f5e2010-05-07 20:54:48 +00003722 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00003723 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00003724
Devang Patele9f8f5e2010-05-07 20:54:48 +00003725 const MDNode *Node = *I;
3726 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach7ab38df2009-11-22 19:20:36 +00003727 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00003728 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00003729 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00003730 StringRef LName = SP.getLinkageName();
3731 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00003732
Chris Lattner233f52b2010-03-09 23:52:58 +00003733 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003734 if (LName.empty()) {
3735 Asm->OutStreamer.EmitBytes(Name, 0);
3736 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003737 } else
Chris Lattner6189ed12010-04-04 23:25:33 +00003738 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3739 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00003740
Chris Lattner233f52b2010-03-09 23:52:58 +00003741 Asm->OutStreamer.AddComment("Function name");
Chris Lattner6189ed12010-04-04 23:25:33 +00003742 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003743 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00003744
Devang Patel53bb5c92009-11-10 23:06:00 +00003745 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00003746 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00003747 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00003748 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003749
Chris Lattner3f53c832010-04-04 18:52:31 +00003750 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003751 Asm->OutStreamer.EmitSymbolValue(LI->first,
3752 Asm->getTargetData().getPointerSize(),0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003753 }
3754 }
3755
Chris Lattnerc0215722010-04-04 19:25:43 +00003756 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003757}