blob: 9026aefc4947939f2e7e8ba20031bdfebf64abf4 [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;
Devang Patel23670e52011-03-24 20:30:50 +0000519 unsigned FileID = GetOrCreateSourceID(V.getContext().getFilename(),
520 V.getContext().getDirectory());
Bill Wendling0310d762009-05-15 09:23:25 +0000521 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000522 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
523 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000524}
525
Devang Patel2c4ceb12009-11-21 02:48:08 +0000526/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000527/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000528void DwarfDebug::addSourceLine(DIE *Die, DIGlobalVariable G) {
Devang Patelc665a512010-05-07 23:33:41 +0000529 // Verify global variable.
Devang Patel81625742010-08-09 20:20:05 +0000530 if (!G.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000531 return;
532
Devang Patel81625742010-08-09 20:20:05 +0000533 unsigned Line = G.getLineNumber();
Devang Patelb2bada32010-10-08 17:18:54 +0000534 if (Line == 0)
535 return;
Devang Patel23670e52011-03-24 20:30:50 +0000536 unsigned FileID = GetOrCreateSourceID(G.getContext().getFilename(),
537 G.getContext().getDirectory());
Bill Wendling0310d762009-05-15 09:23:25 +0000538 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000539 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
540 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000541}
Devang Patel82dfc0c2009-08-31 22:47:13 +0000542
Devang Patel2c4ceb12009-11-21 02:48:08 +0000543/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000544/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000545void DwarfDebug::addSourceLine(DIE *Die, DISubprogram SP) {
Devang Patelc665a512010-05-07 23:33:41 +0000546 // Verify subprogram.
Devang Patel81625742010-08-09 20:20:05 +0000547 if (!SP.Verify())
Devang Patel82dfc0c2009-08-31 22:47:13 +0000548 return;
Caroline Ticec6f9d622009-09-11 18:25:54 +0000549 // If the line number is 0, don't add it.
Devang Patel81625742010-08-09 20:20:05 +0000550 if (SP.getLineNumber() == 0)
Caroline Ticec6f9d622009-09-11 18:25:54 +0000551 return;
552
Devang Patel81625742010-08-09 20:20:05 +0000553 unsigned Line = SP.getLineNumber();
554 if (!SP.getContext().Verify())
Devang Patel77bf2952010-03-08 22:02:50 +0000555 return;
Devang Patel23670e52011-03-24 20:30:50 +0000556 unsigned FileID = GetOrCreateSourceID(SP.getFilename(), SP.getDirectory());
Devang Patel82dfc0c2009-08-31 22:47:13 +0000557 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000558 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
559 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patel82dfc0c2009-08-31 22:47:13 +0000560}
561
Devang Patel2c4ceb12009-11-21 02:48:08 +0000562/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000563/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000564void DwarfDebug::addSourceLine(DIE *Die, DIType Ty) {
Devang Patelc665a512010-05-07 23:33:41 +0000565 // Verify type.
Devang Patel81625742010-08-09 20:20:05 +0000566 if (!Ty.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000567 return;
568
Devang Patel81625742010-08-09 20:20:05 +0000569 unsigned Line = Ty.getLineNumber();
Devang Patelb2bada32010-10-08 17:18:54 +0000570 if (Line == 0 || !Ty.getContext().Verify())
Devang Patel77bf2952010-03-08 22:02:50 +0000571 return;
Devang Patel23670e52011-03-24 20:30:50 +0000572 unsigned FileID = GetOrCreateSourceID(Ty.getFilename(), Ty.getDirectory());
Bill Wendling0310d762009-05-15 09:23:25 +0000573 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000574 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
575 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000576}
577
Devang Patel6404e4e2009-12-15 19:16:48 +0000578/// addSourceLine - Add location information to specified debug information
579/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000580void DwarfDebug::addSourceLine(DIE *Die, DINameSpace NS) {
Devang Patelc665a512010-05-07 23:33:41 +0000581 // Verify namespace.
Devang Patel81625742010-08-09 20:20:05 +0000582 if (!NS.Verify())
Devang Patel6404e4e2009-12-15 19:16:48 +0000583 return;
584
Devang Patel81625742010-08-09 20:20:05 +0000585 unsigned Line = NS.getLineNumber();
Devang Patelb2bada32010-10-08 17:18:54 +0000586 if (Line == 0)
587 return;
Devang Patel81625742010-08-09 20:20:05 +0000588 StringRef FN = NS.getFilename();
Devang Patel6404e4e2009-12-15 19:16:48 +0000589
Devang Patel23670e52011-03-24 20:30:50 +0000590 unsigned FileID = GetOrCreateSourceID(FN, NS.getDirectory());
Devang Patel6404e4e2009-12-15 19:16:48 +0000591 assert(FileID && "Invalid file id");
592 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
593 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
594}
595
Devang Patel9e3bd2c2010-08-31 06:11:28 +0000596/// addVariableAddress - Add DW_AT_location attribute for a DbgVariable based
597/// on provided frame index.
598void DwarfDebug::addVariableAddress(DbgVariable *&DV, DIE *Die, int64_t FI) {
599 MachineLocation Location;
600 unsigned FrameReg;
Anton Korobeynikov16c29b52011-01-10 12:39:04 +0000601 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
Anton Korobeynikov82f58742010-11-20 15:59:32 +0000602 int Offset = TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
Devang Patel9e3bd2c2010-08-31 06:11:28 +0000603 Location.set(FrameReg, Offset);
604
Devang Patel8bd11de2010-08-09 21:01:39 +0000605 if (DV->variableHasComplexAddress())
606 addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
607 else if (DV->isBlockByrefVariable())
608 addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
609 else
610 addAddress(Die, dwarf::DW_AT_location, Location);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000611}
612
Devang Patel2c4ceb12009-11-21 02:48:08 +0000613/// addComplexAddress - Start with the address based on the location provided,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000614/// and generate the DWARF information necessary to find the actual variable
615/// given the extra address information encoded in the DIVariable, starting from
616/// the starting location. Add the DWARF information to the die.
617///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000618void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000619 unsigned Attribute,
620 const MachineLocation &Location) {
Devang Patel8bd11de2010-08-09 21:01:39 +0000621 DIType Ty = DV->getType();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000622
623 // Decode the original location, and use that as the start of the byref
624 // variable's location.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000625 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000626 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000627 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000628
629 if (Location.isReg()) {
630 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000631 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000632 } else {
Devang Pateldacde942011-01-19 23:04:47 +0000633 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000634 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000635 }
636 } else {
637 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000638 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000639 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000640 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
641 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000642 }
643
Devang Patel2c4ceb12009-11-21 02:48:08 +0000644 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000645 }
646
Devang Patel8bd11de2010-08-09 21:01:39 +0000647 for (unsigned i = 0, N = DV->getNumAddrElements(); i < N; ++i) {
648 uint64_t Element = DV->getAddrElement(i);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000649
Devang Patel0eea95d2011-02-24 18:49:30 +0000650 if (Element == DIBuilder::OpPlus) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000651 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel8bd11de2010-08-09 21:01:39 +0000652 addUInt(Block, 0, dwarf::DW_FORM_udata, DV->getAddrElement(++i));
Devang Patel0eea95d2011-02-24 18:49:30 +0000653 } else if (Element == DIBuilder::OpDeref) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000654 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Devang Patel0eea95d2011-02-24 18:49:30 +0000655 } else llvm_unreachable("unknown DIBuilder Opcode");
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000656 }
657
658 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000659 addBlock(Die, Attribute, 0, Block);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000660}
661
Caroline Ticedc8f6042009-08-31 21:19:37 +0000662/* Byref variables, in Blocks, are declared by the programmer as "SomeType
663 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
664 gives the variable VarName either the struct, or a pointer to the struct, as
665 its type. This is necessary for various behind-the-scenes things the
666 compiler needs to do with by-reference variables in Blocks.
667
668 However, as far as the original *programmer* is concerned, the variable
669 should still have type 'SomeType', as originally declared.
670
Devang Patel2c4ceb12009-11-21 02:48:08 +0000671 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000672 struct to find the original type of the variable, which is then assigned to
673 the variable's Debug Information Entry as its real type. So far, so good.
674 However now the debugger will expect the variable VarName to have the type
675 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000676 expression that explains to the debugger how to navigate through the
Caroline Ticedc8f6042009-08-31 21:19:37 +0000677 pointers and struct to find the actual variable of type SomeType.
678
679 The following function does just that. We start by getting
680 the "normal" location for the variable. This will be the location
681 of either the struct __Block_byref_x_VarName or the pointer to the
682 struct __Block_byref_x_VarName.
683
684 The struct will look something like:
685
686 struct __Block_byref_x_VarName {
687 ... <various fields>
688 struct __Block_byref_x_VarName *forwarding;
689 ... <various other fields>
690 SomeType VarName;
691 ... <maybe more fields>
692 };
693
694 If we are given the struct directly (as our starting point) we
695 need to tell the debugger to:
696
697 1). Add the offset of the forwarding field.
698
Dan Gohmanf451cb82010-02-10 16:03:48 +0000699 2). Follow that pointer to get the real __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000700 struct to use (the real one may have been copied onto the heap).
701
702 3). Add the offset for the field VarName, to find the actual variable.
703
704 If we started with a pointer to the struct, then we need to
705 dereference that pointer first, before the other steps.
706 Translating this into DWARF ops, we will need to append the following
707 to the current location description for the variable:
708
709 DW_OP_deref -- optional, if we start with a pointer
710 DW_OP_plus_uconst <forward_fld_offset>
711 DW_OP_deref
712 DW_OP_plus_uconst <varName_fld_offset>
713
714 That is what this function does. */
715
Devang Patel2c4ceb12009-11-21 02:48:08 +0000716/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticedc8f6042009-08-31 21:19:37 +0000717/// provided, and generate the DWARF information necessary to find the
718/// actual Block variable (navigating the Block struct) based on the
719/// starting location. Add the DWARF information to the die. For
720/// more information, read large comment just above here.
721///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000722void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbar00564992009-09-19 20:40:14 +0000723 unsigned Attribute,
724 const MachineLocation &Location) {
Devang Patel8bd11de2010-08-09 21:01:39 +0000725 DIType Ty = DV->getType();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000726 DIType TmpTy = Ty;
727 unsigned Tag = Ty.getTag();
728 bool isPointer = false;
729
Devang Patel8bd11de2010-08-09 21:01:39 +0000730 StringRef varName = DV->getName();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000731
732 if (Tag == dwarf::DW_TAG_pointer_type) {
Devang Patel2db49d72010-05-07 18:11:54 +0000733 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000734 TmpTy = DTy.getTypeDerivedFrom();
735 isPointer = true;
736 }
737
Devang Patel2db49d72010-05-07 18:11:54 +0000738 DICompositeType blockStruct = DICompositeType(TmpTy);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000739
Daniel Dunbar00564992009-09-19 20:40:14 +0000740 // Find the __forwarding field and the variable field in the __Block_byref
741 // struct.
Daniel Dunbar00564992009-09-19 20:40:14 +0000742 DIArray Fields = blockStruct.getTypeArray();
743 DIDescriptor varField = DIDescriptor();
744 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000745
Daniel Dunbar00564992009-09-19 20:40:14 +0000746 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
747 DIDescriptor Element = Fields.getElement(i);
Devang Patel2db49d72010-05-07 18:11:54 +0000748 DIDerivedType DT = DIDerivedType(Element);
Devang Patel65dbc902009-11-25 17:36:49 +0000749 StringRef fieldName = DT.getName();
750 if (fieldName == "__forwarding")
Daniel Dunbar00564992009-09-19 20:40:14 +0000751 forwardingField = Element;
Devang Patel65dbc902009-11-25 17:36:49 +0000752 else if (fieldName == varName)
Daniel Dunbar00564992009-09-19 20:40:14 +0000753 varField = Element;
754 }
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000755
Daniel Dunbar00564992009-09-19 20:40:14 +0000756 // Get the offsets for the forwarding field and the variable field.
Chris Lattner1d65ba72010-03-31 06:06:37 +0000757 unsigned forwardingFieldOffset =
Devang Patel2db49d72010-05-07 18:11:54 +0000758 DIDerivedType(forwardingField).getOffsetInBits() >> 3;
Chris Lattner1d65ba72010-03-31 06:06:37 +0000759 unsigned varFieldOffset =
Devang Patel2db49d72010-05-07 18:11:54 +0000760 DIDerivedType(varField).getOffsetInBits() >> 3;
Caroline Ticedc8f6042009-08-31 21:19:37 +0000761
Mike Stump7e3720d2009-09-24 23:21:26 +0000762 // Decode the original location, and use that as the start of the byref
763 // variable's location.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000764 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Daniel Dunbar00564992009-09-19 20:40:14 +0000765 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000766 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000767
Daniel Dunbar00564992009-09-19 20:40:14 +0000768 if (Location.isReg()) {
769 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000770 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000771 else {
Devang Pateldacde942011-01-19 23:04:47 +0000772 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000773 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000774 }
775 } else {
776 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000777 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000778 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000779 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
780 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000781 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000782
Devang Patel2c4ceb12009-11-21 02:48:08 +0000783 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbar00564992009-09-19 20:40:14 +0000784 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000785
Mike Stump7e3720d2009-09-24 23:21:26 +0000786 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbar00564992009-09-19 20:40:14 +0000787 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbar00564992009-09-19 20:40:14 +0000788 if (isPointer)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000789 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000790
Daniel Dunbar00564992009-09-19 20:40:14 +0000791 // Next add the offset for the '__forwarding' field:
792 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
793 // adding the offset if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000794 if (forwardingFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000795 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
796 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000797 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000798
Daniel Dunbar00564992009-09-19 20:40:14 +0000799 // Now dereference the __forwarding field to get to the real __Block_byref
800 // struct: DW_OP_deref.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000801 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000802
Daniel Dunbar00564992009-09-19 20:40:14 +0000803 // Now that we've got the real __Block_byref... struct, add the offset
804 // for the variable's field to get to the location of the actual variable:
805 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000806 if (varFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000807 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
808 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000809 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000810
Daniel Dunbar00564992009-09-19 20:40:14 +0000811 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000812 addBlock(Die, Attribute, 0, Block);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000813}
814
Devang Patel2c4ceb12009-11-21 02:48:08 +0000815/// addAddress - Add an address attribute to a die based on the location
Bill Wendling0310d762009-05-15 09:23:25 +0000816/// provided.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000817void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000818 const MachineLocation &Location) {
Chris Lattnerd38fee82010-04-05 00:13:49 +0000819 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling0310d762009-05-15 09:23:25 +0000820 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000821 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patelbe90c3a2010-09-22 21:10:38 +0000822
Devang Patelc8821042010-11-02 17:37:00 +0000823 if (RI->getFrameRegister(*Asm->MF) == Location.getReg()
Devang Patelbe90c3a2010-09-22 21:10:38 +0000824 && Location.getOffset()) {
825 // If variable offset is based in frame register then use fbreg.
826 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
827 addSInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
828 addBlock(Die, Attribute, 0, Block);
829 return;
830 }
Bill Wendling0310d762009-05-15 09:23:25 +0000831
832 if (Location.isReg()) {
833 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000834 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000835 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000836 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
837 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000838 }
839 } else {
840 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000841 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000842 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000843 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
844 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000845 }
846
Devang Patel2c4ceb12009-11-21 02:48:08 +0000847 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling0310d762009-05-15 09:23:25 +0000848 }
849
Devang Patel2c4ceb12009-11-21 02:48:08 +0000850 addBlock(Die, Attribute, 0, Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000851}
852
Devang Patela43098d2010-04-28 01:03:09 +0000853/// addRegisterAddress - Add register location entry in variable DIE.
Devang Patel522ad742010-11-12 23:20:42 +0000854bool DwarfDebug::addRegisterAddress(DIE *Die, const MachineOperand &MO) {
Devang Patela43098d2010-04-28 01:03:09 +0000855 assert (MO.isReg() && "Invalid machine operand!");
856 if (!MO.getReg())
857 return false;
858 MachineLocation Location;
859 Location.set(MO.getReg());
860 addAddress(Die, dwarf::DW_AT_location, Location);
Devang Patela43098d2010-04-28 01:03:09 +0000861 return true;
862}
863
864/// addConstantValue - Add constant value entry in variable DIE.
Devang Patel522ad742010-11-12 23:20:42 +0000865bool DwarfDebug::addConstantValue(DIE *Die, const MachineOperand &MO) {
Devang Patela43098d2010-04-28 01:03:09 +0000866 assert (MO.isImm() && "Invalid machine operand!");
867 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
868 unsigned Imm = MO.getImm();
869 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
870 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patela43098d2010-04-28 01:03:09 +0000871 return true;
872}
873
874/// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patel522ad742010-11-12 23:20:42 +0000875bool DwarfDebug::addConstantFPValue(DIE *Die, const MachineOperand &MO) {
Devang Patela43098d2010-04-28 01:03:09 +0000876 assert (MO.isFPImm() && "Invalid machine operand!");
877 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
878 APFloat FPImm = MO.getFPImm()->getValueAPF();
Jim Grosbach1e20b962010-07-21 21:21:52 +0000879
Devang Patela43098d2010-04-28 01:03:09 +0000880 // Get the raw data form of the floating point.
881 const APInt FltVal = FPImm.bitcastToAPInt();
882 const char *FltPtr = (const char*)FltVal.getRawData();
Jim Grosbach1e20b962010-07-21 21:21:52 +0000883
Devang Patela43098d2010-04-28 01:03:09 +0000884 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
885 bool LittleEndian = Asm->getTargetData().isLittleEndian();
886 int Incr = (LittleEndian ? 1 : -1);
887 int Start = (LittleEndian ? 0 : NumBytes - 1);
888 int Stop = (LittleEndian ? NumBytes : -1);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000889
Devang Patela43098d2010-04-28 01:03:09 +0000890 // Output the constant to DWARF one byte at a time.
891 for (; Start != Stop; Start += Incr)
892 addUInt(Block, 0, dwarf::DW_FORM_data1,
893 (unsigned char)0xFF & FltPtr[Start]);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000894
Devang Patela43098d2010-04-28 01:03:09 +0000895 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000896 return true;
Devang Patela43098d2010-04-28 01:03:09 +0000897}
898
Devang Patel76a788c2011-01-06 21:39:25 +0000899/// addConstantValue - Add constant value entry in variable DIE.
900bool DwarfDebug::addConstantValue(DIE *Die, ConstantInt *CI,
901 bool Unsigned) {
902 if (CI->getBitWidth() <= 64) {
903 if (Unsigned)
904 addUInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
905 CI->getZExtValue());
906 else
907 addSInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
908 CI->getSExtValue());
909 return true;
910 }
911
912 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
913
914 // Get the raw data form of the large APInt.
915 const APInt Val = CI->getValue();
916 const char *Ptr = (const char*)Val.getRawData();
917
918 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
919 bool LittleEndian = Asm->getTargetData().isLittleEndian();
920 int Incr = (LittleEndian ? 1 : -1);
921 int Start = (LittleEndian ? 0 : NumBytes - 1);
922 int Stop = (LittleEndian ? NumBytes : -1);
923
924 // Output the constant to DWARF one byte at a time.
925 for (; Start != Stop; Start += Incr)
926 addUInt(Block, 0, dwarf::DW_FORM_data1,
927 (unsigned char)0xFF & Ptr[Start]);
928
929 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
930 return true;
931}
Devang Patela43098d2010-04-28 01:03:09 +0000932
Devang Patelc366f832009-12-10 19:14:49 +0000933/// addToContextOwner - Add Die into the list of its context owner's children.
934void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3c91b052010-03-08 20:52:55 +0000935 if (Context.isType()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000936 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
Devang Patelc366f832009-12-10 19:14:49 +0000937 ContextDIE->addChild(Die);
Devang Patel6404e4e2009-12-15 19:16:48 +0000938 } else if (Context.isNameSpace()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000939 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
Devang Patel6404e4e2009-12-15 19:16:48 +0000940 ContextDIE->addChild(Die);
Stuart Hastings215aa152010-06-11 20:08:44 +0000941 } else if (Context.isSubprogram()) {
Devang Patelee70fa72010-09-27 23:15:27 +0000942 DIE *ContextDIE = createSubprogramDIE(DISubprogram(Context));
Stuart Hastings215aa152010-06-11 20:08:44 +0000943 ContextDIE->addChild(Die);
Devang Patel163a9f72010-05-10 22:49:55 +0000944 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patelc366f832009-12-10 19:14:49 +0000945 ContextDIE->addChild(Die);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000946 else
Devang Patel163a9f72010-05-10 22:49:55 +0000947 getCompileUnit(Context)->addDie(Die);
Devang Patelc366f832009-12-10 19:14:49 +0000948}
949
Devang Patel16ced732009-12-10 18:05:33 +0000950/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
951/// given DIType.
952DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel163a9f72010-05-10 22:49:55 +0000953 CompileUnit *TypeCU = getCompileUnit(Ty);
954 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patel16ced732009-12-10 18:05:33 +0000955 if (TyDIE)
956 return TyDIE;
957
958 // Create new type.
959 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel163a9f72010-05-10 22:49:55 +0000960 TypeCU->insertDIE(Ty, TyDIE);
Devang Patel16ced732009-12-10 18:05:33 +0000961 if (Ty.isBasicType())
Devang Patel2db49d72010-05-07 18:11:54 +0000962 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000963 else if (Ty.isCompositeType())
Devang Patel2db49d72010-05-07 18:11:54 +0000964 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000965 else {
966 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patel2db49d72010-05-07 18:11:54 +0000967 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000968 }
969
Devang Patelc366f832009-12-10 19:14:49 +0000970 addToContextOwner(TyDIE, Ty.getContext());
Devang Patel16ced732009-12-10 18:05:33 +0000971 return TyDIE;
972}
973
Devang Patel2c4ceb12009-11-21 02:48:08 +0000974/// addType - Add a new type attribute to the specified entity.
Devang Patel8a241142009-12-09 18:24:21 +0000975void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel9c004872010-05-07 21:45:47 +0000976 if (!Ty.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000977 return;
978
979 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +0000980 CompileUnit *TypeCU = getCompileUnit(Ty);
981 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000982 // If it exists then use the existing value.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000983 if (Entry) {
984 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000985 return;
986 }
987
Bill Wendling0310d762009-05-15 09:23:25 +0000988 // Construct type.
Devang Patel16ced732009-12-10 18:05:33 +0000989 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000990
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000991 // Set up proxy.
992 Entry = createDIEEntry(Buffer);
Devang Patel163a9f72010-05-10 22:49:55 +0000993 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000994
Devang Patel2c4ceb12009-11-21 02:48:08 +0000995 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000996}
997
Devang Patel2c4ceb12009-11-21 02:48:08 +0000998/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel8a241142009-12-09 18:24:21 +0000999void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001000 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +00001001 StringRef Name = BTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +00001002 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001003 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling0310d762009-05-15 09:23:25 +00001004 BTy.getEncoding());
1005
1006 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +00001007 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001008 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001009 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel2c4ceb12009-11-21 02:48:08 +00001010 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +00001011}
1012
Devang Patel2c4ceb12009-11-21 02:48:08 +00001013/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel8a241142009-12-09 18:24:21 +00001014void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001015 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +00001016 StringRef Name = DTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +00001017 uint64_t Size = DTy.getSizeInBits() >> 3;
1018 unsigned Tag = DTy.getTag();
1019
1020 // FIXME - Workaround for templates.
1021 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
1022
1023 Buffer.setTag(Tag);
1024
1025 // Map to main type, void will not have a type.
1026 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel8a241142009-12-09 18:24:21 +00001027 addType(&Buffer, FromTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001028
1029 // Add name if not anonymous or intermediate type.
Devang Pateldeea5642009-11-30 23:56:56 +00001030 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001031 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001032
1033 // Add size if non-zero (derived types might be zero-sized.)
1034 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001035 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +00001036
1037 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patel05f6fa82009-11-23 18:43:37 +00001038 if (!DTy.isForwardDecl())
Devang Patel81625742010-08-09 20:20:05 +00001039 addSourceLine(&Buffer, DTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001040}
1041
Devang Patel2c4ceb12009-11-21 02:48:08 +00001042/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +00001043void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001044 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +00001045 StringRef Name = CTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +00001046
1047 uint64_t Size = CTy.getSizeInBits() >> 3;
1048 unsigned Tag = CTy.getTag();
1049 Buffer.setTag(Tag);
1050
1051 switch (Tag) {
1052 case dwarf::DW_TAG_vector_type:
1053 case dwarf::DW_TAG_array_type:
Devang Patel8a241142009-12-09 18:24:21 +00001054 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001055 break;
1056 case dwarf::DW_TAG_enumeration_type: {
1057 DIArray Elements = CTy.getTypeArray();
1058
1059 // Add enumerators to enumeration type.
1060 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1061 DIE *ElemDie = NULL;
Devang Patel2db49d72010-05-07 18:11:54 +00001062 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3c91b052010-03-08 20:52:55 +00001063 if (Enum.isEnumerator()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001064 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001065 Buffer.addChild(ElemDie);
Devang Patelc5254722009-10-09 17:51:49 +00001066 }
Bill Wendling0310d762009-05-15 09:23:25 +00001067 }
1068 }
1069 break;
1070 case dwarf::DW_TAG_subroutine_type: {
1071 // Add return type.
1072 DIArray Elements = CTy.getTypeArray();
1073 DIDescriptor RTy = Elements.getElement(0);
Devang Patel2db49d72010-05-07 18:11:54 +00001074 addType(&Buffer, DIType(RTy));
Bill Wendling0310d762009-05-15 09:23:25 +00001075
Devang Pateld6747df2010-10-06 20:50:40 +00001076 bool isPrototyped = true;
Bill Wendling0310d762009-05-15 09:23:25 +00001077 // Add arguments.
1078 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
Bill Wendling0310d762009-05-15 09:23:25 +00001079 DIDescriptor Ty = Elements.getElement(i);
Devang Pateld6747df2010-10-06 20:50:40 +00001080 if (Ty.isUnspecifiedParameter()) {
1081 DIE *Arg = new DIE(dwarf::DW_TAG_unspecified_parameters);
1082 Buffer.addChild(Arg);
1083 isPrototyped = false;
1084 } else {
1085 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1086 addType(Arg, DIType(Ty));
1087 Buffer.addChild(Arg);
1088 }
Bill Wendling0310d762009-05-15 09:23:25 +00001089 }
Devang Pateld6747df2010-10-06 20:50:40 +00001090 // Add prototype flag.
1091 if (isPrototyped)
1092 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001093 }
1094 break;
1095 case dwarf::DW_TAG_structure_type:
1096 case dwarf::DW_TAG_union_type:
1097 case dwarf::DW_TAG_class_type: {
1098 // Add elements to structure type.
1099 DIArray Elements = CTy.getTypeArray();
1100
1101 // A forward struct declared type may not have elements available.
Devang Patel3c91b052010-03-08 20:52:55 +00001102 unsigned N = Elements.getNumElements();
1103 if (N == 0)
Bill Wendling0310d762009-05-15 09:23:25 +00001104 break;
1105
1106 // Add elements to structure type.
Devang Patel3c91b052010-03-08 20:52:55 +00001107 for (unsigned i = 0; i < N; ++i) {
Bill Wendling0310d762009-05-15 09:23:25 +00001108 DIDescriptor Element = Elements.getElement(i);
1109 DIE *ElemDie = NULL;
Devang Patel1a301232010-09-29 21:44:16 +00001110 if (Element.isSubprogram()) {
1111 DISubprogram SP(Element);
Devang Patel2db49d72010-05-07 18:11:54 +00001112 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patel1a301232010-09-29 21:44:16 +00001113 if (SP.isProtected())
1114 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1115 dwarf::DW_ACCESS_protected);
1116 else if (SP.isPrivate())
1117 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1118 dwarf::DW_ACCESS_private);
1119 else
1120 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1121 dwarf::DW_ACCESS_public);
Devang Patel21ea1d52010-10-01 23:31:40 +00001122 if (SP.isExplicit())
1123 addUInt(ElemDie, dwarf::DW_AT_explicit, dwarf::DW_FORM_flag, 1);
Devang Patel1a301232010-09-29 21:44:16 +00001124 }
Devang Patel3c91b052010-03-08 20:52:55 +00001125 else if (Element.isVariable()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001126 DIVariable DV(Element);
Devang Patel1ee0cb92010-01-30 01:08:30 +00001127 ElemDie = new DIE(dwarf::DW_TAG_variable);
1128 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1129 DV.getName());
1130 addType(ElemDie, DV.getType());
1131 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1132 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patel81625742010-08-09 20:20:05 +00001133 addSourceLine(ElemDie, DV);
Devang Patel3c91b052010-03-08 20:52:55 +00001134 } else if (Element.isDerivedType())
Devang Patel2db49d72010-05-07 18:11:54 +00001135 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3c91b052010-03-08 20:52:55 +00001136 else
1137 continue;
Devang Patel2c4ceb12009-11-21 02:48:08 +00001138 Buffer.addChild(ElemDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001139 }
1140
Devang Patela1ba2692009-08-27 23:51:51 +00001141 if (CTy.isAppleBlockExtension())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001142 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001143
1144 unsigned RLang = CTy.getRunTimeLang();
1145 if (RLang)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001146 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling0310d762009-05-15 09:23:25 +00001147 dwarf::DW_FORM_data1, RLang);
Devang Patelb5544992010-01-26 21:16:06 +00001148
1149 DICompositeType ContainingType = CTy.getContainingType();
Devang Patel2db49d72010-05-07 18:11:54 +00001150 if (DIDescriptor(ContainingType).isCompositeType())
Jim Grosbach1e20b962010-07-21 21:21:52 +00001151 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patel2db49d72010-05-07 18:11:54 +00001152 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastings215aa152010-06-11 20:08:44 +00001153 else {
1154 DIDescriptor Context = CTy.getContext();
1155 addToContextOwner(&Buffer, Context);
1156 }
Devang Patel7e2cb112011-02-02 21:38:25 +00001157
1158 if (Tag == dwarf::DW_TAG_class_type) {
1159 DIArray TParams = CTy.getTemplateParams();
1160 unsigned N = TParams.getNumElements();
1161 // Add template parameters.
1162 for (unsigned i = 0; i < N; ++i) {
1163 DIDescriptor Element = TParams.getElement(i);
1164 if (Element.isTemplateTypeParameter())
1165 Buffer.addChild(getOrCreateTemplateTypeParameterDIE(
1166 DITemplateTypeParameter(Element)));
Devang Patele7d93872011-02-02 22:35:53 +00001167 else if (Element.isTemplateValueParameter())
1168 Buffer.addChild(getOrCreateTemplateValueParameterDIE(
1169 DITemplateValueParameter(Element)));
Devang Patel7e2cb112011-02-02 21:38:25 +00001170 }
1171 }
Bill Wendling0310d762009-05-15 09:23:25 +00001172 break;
1173 }
1174 default:
1175 break;
1176 }
1177
1178 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +00001179 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001180 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001181
Jim Grosbach1e20b962010-07-21 21:21:52 +00001182 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
Devang Patel61409622010-07-07 20:12:52 +00001183 || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1184 {
Bill Wendling0310d762009-05-15 09:23:25 +00001185 // Add size if non-zero (derived types might be zero-sized.)
1186 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001187 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +00001188 else {
1189 // Add zero size if it is not a forward declaration.
1190 if (CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001191 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001192 else
Devang Patel2c4ceb12009-11-21 02:48:08 +00001193 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling0310d762009-05-15 09:23:25 +00001194 }
1195
1196 // Add source line info if available.
1197 if (!CTy.isForwardDecl())
Devang Patel81625742010-08-09 20:20:05 +00001198 addSourceLine(&Buffer, CTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001199 }
1200}
1201
Devang Patel7e2cb112011-02-02 21:38:25 +00001202/// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
1203/// for the given DITemplateTypeParameter.
1204DIE *
1205DwarfDebug::getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP) {
1206 CompileUnit *TypeCU = getCompileUnit(TP);
1207 DIE *ParamDIE = TypeCU->getDIE(TP);
1208 if (ParamDIE)
1209 return ParamDIE;
1210
1211 ParamDIE = new DIE(dwarf::DW_TAG_template_type_parameter);
1212 addType(ParamDIE, TP.getType());
1213 addString(ParamDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string, TP.getName());
1214 return ParamDIE;
1215}
1216
Devang Patele7d93872011-02-02 22:35:53 +00001217/// getOrCreateTemplateValueParameterDIE - Find existing DIE or create new DIE
1218/// for the given DITemplateValueParameter.
1219DIE *
1220DwarfDebug::getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TPV) {
1221 CompileUnit *TVCU = getCompileUnit(TPV);
1222 DIE *ParamDIE = TVCU->getDIE(TPV);
1223 if (ParamDIE)
1224 return ParamDIE;
1225
1226 ParamDIE = new DIE(dwarf::DW_TAG_template_value_parameter);
1227 addType(ParamDIE, TPV.getType());
1228 addString(ParamDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string, TPV.getName());
1229 addUInt(ParamDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
1230 TPV.getValue());
1231 return ParamDIE;
1232}
1233
Devang Patel2c4ceb12009-11-21 02:48:08 +00001234/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1235void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling0310d762009-05-15 09:23:25 +00001236 int64_t L = SR.getLo();
1237 int64_t H = SR.getHi();
1238 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1239
Devang Patel2c4ceb12009-11-21 02:48:08 +00001240 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patel6325a532009-08-14 20:59:16 +00001241 if (L)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001242 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Pateld55224c2009-12-04 23:10:24 +00001243 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling0310d762009-05-15 09:23:25 +00001244
Devang Patel2c4ceb12009-11-21 02:48:08 +00001245 Buffer.addChild(DW_Subrange);
Bill Wendling0310d762009-05-15 09:23:25 +00001246}
1247
Devang Patel2c4ceb12009-11-21 02:48:08 +00001248/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +00001249void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling0310d762009-05-15 09:23:25 +00001250 DICompositeType *CTy) {
1251 Buffer.setTag(dwarf::DW_TAG_array_type);
1252 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001253 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001254
1255 // Emit derived type.
Devang Patel8a241142009-12-09 18:24:21 +00001256 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001257 DIArray Elements = CTy->getTypeArray();
1258
Devang Patel6f01d9c2009-11-21 00:31:03 +00001259 // Get an anonymous type for index type.
Devang Patel163a9f72010-05-10 22:49:55 +00001260 CompileUnit *TheCU = getCompileUnit(*CTy);
1261 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel6f01d9c2009-11-21 00:31:03 +00001262 if (!IdxTy) {
1263 // Construct an anonymous type for index type.
1264 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001265 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1266 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel6f01d9c2009-11-21 00:31:03 +00001267 dwarf::DW_ATE_signed);
Devang Patel163a9f72010-05-10 22:49:55 +00001268 TheCU->addDie(IdxTy);
1269 TheCU->setIndexTyDie(IdxTy);
Devang Patel6f01d9c2009-11-21 00:31:03 +00001270 }
Bill Wendling0310d762009-05-15 09:23:25 +00001271
1272 // Add subranges to array type.
1273 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1274 DIDescriptor Element = Elements.getElement(i);
1275 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patel2db49d72010-05-07 18:11:54 +00001276 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001277 }
1278}
1279
Devang Patel2c4ceb12009-11-21 02:48:08 +00001280/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3c91b052010-03-08 20:52:55 +00001281DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001282 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3c91b052010-03-08 20:52:55 +00001283 StringRef Name = ETy.getName();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001284 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3c91b052010-03-08 20:52:55 +00001285 int64_t Value = ETy.getEnumValue();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001286 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling0310d762009-05-15 09:23:25 +00001287 return Enumerator;
1288}
1289
Jim Grosbach1e20b962010-07-21 21:21:52 +00001290/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel351ca332010-01-05 01:46:14 +00001291/// printer to not emit usual symbol prefix before the symbol name is used then
1292/// return linkage name after skipping this special LLVM prefix.
1293static StringRef getRealLinkageName(StringRef LinkageName) {
1294 char One = '\1';
1295 if (LinkageName.startswith(StringRef(&One, 1)))
1296 return LinkageName.substr(1);
1297 return LinkageName;
1298}
1299
Devang Patel2c4ceb12009-11-21 02:48:08 +00001300/// createMemberDIE - Create new member DIE.
Devang Patelecbd8e82010-08-10 04:12:17 +00001301DIE *DwarfDebug::createMemberDIE(DIDerivedType DT) {
Bill Wendling0310d762009-05-15 09:23:25 +00001302 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel65dbc902009-11-25 17:36:49 +00001303 StringRef Name = DT.getName();
1304 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001305 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001306
Devang Patel8a241142009-12-09 18:24:21 +00001307 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001308
Devang Patel81625742010-08-09 20:20:05 +00001309 addSourceLine(MemberDie, DT);
Bill Wendling0310d762009-05-15 09:23:25 +00001310
Benjamin Kramer345ef342010-03-31 19:34:01 +00001311 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001312 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel33db5082009-11-04 22:06:12 +00001313
Bill Wendling0310d762009-05-15 09:23:25 +00001314 uint64_t Size = DT.getSizeInBits();
Devang Patel61ecbd12009-11-04 23:48:00 +00001315 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling0310d762009-05-15 09:23:25 +00001316
1317 if (Size != FieldSize) {
1318 // Handle bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001319 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1320 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling0310d762009-05-15 09:23:25 +00001321
1322 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling0310d762009-05-15 09:23:25 +00001323 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1324 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer3d594fd2010-01-07 17:50:57 +00001325 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling0310d762009-05-15 09:23:25 +00001326 Offset -= FieldOffset;
1327
1328 // Maybe we need to work from the other end.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001329 if (Asm->getTargetData().isLittleEndian())
1330 Offset = FieldSize - (Offset + Size);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001331 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling0310d762009-05-15 09:23:25 +00001332
Devang Patel33db5082009-11-04 22:06:12 +00001333 // Here WD_AT_data_member_location points to the anonymous
1334 // field that includes this bit field.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001335 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001336
1337 } else
1338 // This is not a bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001339 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001340
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001341 if (DT.getTag() == dwarf::DW_TAG_inheritance
1342 && DT.isVirtual()) {
1343
1344 // For C++, virtual base classes are not at fixed offset. Use following
1345 // expression to extract appropriate offset from vtable.
1346 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1347
Benjamin Kramer345ef342010-03-31 19:34:01 +00001348 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001349 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1350 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1351 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1352 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1353 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1354 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1355 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1356
Jim Grosbach1e20b962010-07-21 21:21:52 +00001357 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001358 VBaseLocationDie);
1359 } else
1360 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001361
1362 if (DT.isProtected())
Devang Patel5d11eb02009-12-03 19:11:07 +00001363 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001364 dwarf::DW_ACCESS_protected);
1365 else if (DT.isPrivate())
Devang Patel5d11eb02009-12-03 19:11:07 +00001366 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001367 dwarf::DW_ACCESS_private);
Devang Patel2a361602010-09-29 19:08:08 +00001368 // Otherwise C++ member and base classes are considered public.
1369 else if (DT.getCompileUnit().getLanguage() == dwarf::DW_LANG_C_plus_plus)
Devang Patel5d11eb02009-12-03 19:11:07 +00001370 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1371 dwarf::DW_ACCESS_public);
1372 if (DT.isVirtual())
1373 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1374 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling0310d762009-05-15 09:23:25 +00001375 return MemberDie;
1376}
1377
Devang Patelffe966c2009-12-14 16:18:45 +00001378/// createSubprogramDIE - Create new DIE using SP.
Devang Patelee70fa72010-09-27 23:15:27 +00001379DIE *DwarfDebug::createSubprogramDIE(DISubprogram SP) {
Devang Patel163a9f72010-05-10 22:49:55 +00001380 CompileUnit *SPCU = getCompileUnit(SP);
1381 DIE *SPDie = SPCU->getDIE(SP);
Devang Patelffe966c2009-12-14 16:18:45 +00001382 if (SPDie)
1383 return SPDie;
1384
1385 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel1eac3e72010-03-02 17:58:15 +00001386 // Constructors and operators for anonymous aggregates do not have names.
Devang Patel6b506cb2010-03-02 01:26:20 +00001387 if (!SP.getName().empty())
1388 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling0310d762009-05-15 09:23:25 +00001389
Devang Patel65dbc902009-11-25 17:36:49 +00001390 StringRef LinkageName = SP.getLinkageName();
Devang Patel351ca332010-01-05 01:46:14 +00001391 if (!LinkageName.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001392 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel351ca332010-01-05 01:46:14 +00001393 getRealLinkageName(LinkageName));
1394
Devang Patel81625742010-08-09 20:20:05 +00001395 addSourceLine(SPDie, SP);
Bill Wendling0310d762009-05-15 09:23:25 +00001396
Devang Patel7b172c62010-10-07 22:03:01 +00001397 if (SP.isPrototyped())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001398 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001399
1400 // Add Return Type.
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001401 DICompositeType SPTy = SP.getType();
1402 DIArray Args = SPTy.getTypeArray();
Bill Wendling0310d762009-05-15 09:23:25 +00001403 unsigned SPTag = SPTy.getTag();
Devang Patel5d11eb02009-12-03 19:11:07 +00001404
Devang Patel3c91b052010-03-08 20:52:55 +00001405 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel8a241142009-12-09 18:24:21 +00001406 addType(SPDie, SPTy);
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001407 else
Devang Patel2db49d72010-05-07 18:11:54 +00001408 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001409
Devang Patel5d11eb02009-12-03 19:11:07 +00001410 unsigned VK = SP.getVirtuality();
1411 if (VK) {
1412 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer345ef342010-03-31 19:34:01 +00001413 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel5d11eb02009-12-03 19:11:07 +00001414 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
Devang Pateld639c7c2010-12-09 00:10:40 +00001415 addUInt(Block, 0, dwarf::DW_FORM_udata, SP.getVirtualIndex());
Devang Patel5d11eb02009-12-03 19:11:07 +00001416 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001417 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patel2db49d72010-05-07 18:11:54 +00001418 SP.getContainingType()));
Devang Patel5d11eb02009-12-03 19:11:07 +00001419 }
1420
Devang Patelee70fa72010-09-27 23:15:27 +00001421 if (!SP.isDefinition()) {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001422 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001423
1424 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001425 // be handled while processing variables.
1426 DICompositeType SPTy = SP.getType();
1427 DIArray Args = SPTy.getTypeArray();
1428 unsigned SPTag = SPTy.getTag();
1429
Bill Wendling0310d762009-05-15 09:23:25 +00001430 if (SPTag == dwarf::DW_TAG_subroutine_type)
1431 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1432 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001433 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patelb4645642010-02-06 01:02:37 +00001434 addType(Arg, ATy);
1435 if (ATy.isArtificial())
1436 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001437 SPDie->addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001438 }
1439 }
1440
Devang Patel4e0d19d2010-02-03 19:57:19 +00001441 if (SP.isArtificial())
1442 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1443
Devang Patelccff8122010-04-30 19:38:23 +00001444 if (!SP.isLocalToUnit())
1445 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001446
Devang Patelccff8122010-04-30 19:38:23 +00001447 if (SP.isOptimized())
1448 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1449
Jim Grosbach91729002010-07-21 23:03:52 +00001450 if (unsigned isa = Asm->getISAEncoding()) {
1451 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1452 }
1453
Devang Patelccff8122010-04-30 19:38:23 +00001454 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel163a9f72010-05-10 22:49:55 +00001455 SPCU->insertDIE(SP, SPDie);
Devang Patelccff8122010-04-30 19:38:23 +00001456
Stuart Hastings215aa152010-06-11 20:08:44 +00001457 // Add to context owner.
1458 addToContextOwner(SPDie, SP.getContext());
1459
Bill Wendling0310d762009-05-15 09:23:25 +00001460 return SPDie;
1461}
1462
Devang Patele9f8f5e2010-05-07 20:54:48 +00001463DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattnered7a77b2010-03-31 05:36:29 +00001464 assert(N && "Invalid Scope encoding!");
Devang Patel53bb5c92009-11-10 23:06:00 +00001465
1466 DbgScope *AScope = AbstractScopes.lookup(N);
1467 if (AScope)
1468 return AScope;
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001469
Devang Patel53bb5c92009-11-10 23:06:00 +00001470 DbgScope *Parent = NULL;
1471
1472 DIDescriptor Scope(N);
1473 if (Scope.isLexicalBlock()) {
1474 DILexicalBlock DB(N);
1475 DIDescriptor ParentDesc = DB.getContext();
Devang Patel2db49d72010-05-07 18:11:54 +00001476 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patel53bb5c92009-11-10 23:06:00 +00001477 }
1478
1479 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1480
1481 if (Parent)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001482 Parent->addScope(AScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001483 AScope->setAbstractScope();
1484 AbstractScopes[N] = AScope;
1485 if (DIDescriptor(N).isSubprogram())
1486 AbstractScopesList.push_back(AScope);
1487 return AScope;
1488}
Devang Patelaf9e8472009-10-01 20:31:14 +00001489
Devang Patel5f094002010-04-06 23:53:48 +00001490/// isSubprogramContext - Return true if Context is either a subprogram
1491/// or another context nested inside a subprogram.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001492static bool isSubprogramContext(const MDNode *Context) {
Devang Patel5f094002010-04-06 23:53:48 +00001493 if (!Context)
1494 return false;
1495 DIDescriptor D(Context);
1496 if (D.isSubprogram())
1497 return true;
1498 if (D.isType())
Devang Patel2db49d72010-05-07 18:11:54 +00001499 return isSubprogramContext(DIType(Context).getContext());
Devang Patel5f094002010-04-06 23:53:48 +00001500 return false;
1501}
1502
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001503/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel2c4ceb12009-11-21 02:48:08 +00001504/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1505/// If there are global variables in this scope then create and insert
1506/// DIEs for these variables.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001507DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel163a9f72010-05-10 22:49:55 +00001508 CompileUnit *SPCU = getCompileUnit(SPNode);
1509 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patel8aa61472010-07-07 22:20:57 +00001510
Chris Lattnerd38fee82010-04-05 00:13:49 +00001511 assert(SPDie && "Unable to find subprogram DIE!");
1512 DISubprogram SP(SPNode);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001513
Chris Lattnerd38fee82010-04-05 00:13:49 +00001514 // There is not any need to generate specification DIE for a function
1515 // defined at compile unit level. If a function is defined inside another
1516 // function then gdb prefers the definition at top level and but does not
Jim Grosbach1e20b962010-07-21 21:21:52 +00001517 // expect specification DIE in parent function. So avoid creating
Chris Lattnerd38fee82010-04-05 00:13:49 +00001518 // specification DIE for a function defined inside a function.
1519 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Jim Grosbach1e20b962010-07-21 21:21:52 +00001520 !SP.getContext().isFile() &&
Devang Patel2db49d72010-05-07 18:11:54 +00001521 !isSubprogramContext(SP.getContext())) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00001522 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001523
1524 // Add arguments.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001525 DICompositeType SPTy = SP.getType();
1526 DIArray Args = SPTy.getTypeArray();
1527 unsigned SPTag = SPTy.getTag();
1528 if (SPTag == dwarf::DW_TAG_subroutine_type)
1529 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1530 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001531 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattnerd38fee82010-04-05 00:13:49 +00001532 addType(Arg, ATy);
1533 if (ATy.isArtificial())
1534 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1535 SPDie->addChild(Arg);
1536 }
1537 DIE *SPDeclDie = SPDie;
1538 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001539 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Chris Lattnerd38fee82010-04-05 00:13:49 +00001540 SPDeclDie);
Devang Patel163a9f72010-05-10 22:49:55 +00001541 SPCU->addDie(SPDie);
Chris Lattnerd38fee82010-04-05 00:13:49 +00001542 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00001543
Devang Patel8aa61472010-07-07 22:20:57 +00001544 // Pick up abstract subprogram DIE.
1545 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
1546 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1547 addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
1548 dwarf::DW_FORM_ref4, AbsSPDIE);
1549 SPCU->addDie(SPDie);
1550 }
1551
Chris Lattnerd38fee82010-04-05 00:13:49 +00001552 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1553 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1554 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1555 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1556 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1557 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1558 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +00001559
Chris Lattnerd38fee82010-04-05 00:13:49 +00001560 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +00001561}
1562
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001563/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel2c4ceb12009-11-21 02:48:08 +00001564/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1565DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001566
1567 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1568 if (Scope->isAbstractScope())
1569 return ScopeDIE;
1570
1571 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1572 if (Ranges.empty())
1573 return 0;
1574
1575 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1576 if (Ranges.size() > 1) {
1577 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbach1e20b962010-07-21 21:21:52 +00001578 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Pateleac9c072010-04-27 19:46:33 +00001579 // DW_AT_ranges appropriately.
1580 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1581 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1582 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1583 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +00001584 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1585 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +00001586 }
1587 DebugRangeSymbols.push_back(NULL);
1588 DebugRangeSymbols.push_back(NULL);
1589 return ScopeDIE;
1590 }
1591
Devang Patelc3f5f782010-05-25 23:40:22 +00001592 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1593 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001594
Devang Patelc3f5f782010-05-25 23:40:22 +00001595 if (End == 0) return 0;
Devang Patel53bb5c92009-11-10 23:06:00 +00001596
Chris Lattnerb7db7332010-03-09 01:58:53 +00001597 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1598 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbach1e20b962010-07-21 21:21:52 +00001599
Devang Pateleac9c072010-04-27 19:46:33 +00001600 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1601 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patel53bb5c92009-11-10 23:06:00 +00001602
1603 return ScopeDIE;
1604}
1605
Devang Patel2c4ceb12009-11-21 02:48:08 +00001606/// constructInlinedScopeDIE - This scope represents inlined body of
1607/// a function. Construct DIE to represent this concrete inlined copy
1608/// of the function.
1609DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001610
1611 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001612 assert (Ranges.empty() == false
Devang Pateleac9c072010-04-27 19:46:33 +00001613 && "DbgScope does not have instruction markers!");
1614
1615 // FIXME : .debug_inlined section specification does not clearly state how
1616 // to emit inlined scope that is split into multiple instruction ranges.
1617 // For now, use first instruction range and emit low_pc/high_pc pair and
1618 // corresponding .debug_inlined section entry for this pair.
1619 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patelc3f5f782010-05-25 23:40:22 +00001620 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1621 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001622
Devang Patel0afbf232010-07-08 22:39:20 +00001623 if (StartLabel == 0 || EndLabel == 0) {
Devang Pateleac9c072010-04-27 19:46:33 +00001624 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1625 return 0;
1626 }
Chris Lattnerb7db7332010-03-09 01:58:53 +00001627 assert(StartLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001628 "Invalid starting label for an inlined scope!");
Chris Lattnerb7db7332010-03-09 01:58:53 +00001629 assert(EndLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001630 "Invalid end label for an inlined scope!");
Devang Pateleac9c072010-04-27 19:46:33 +00001631
Devang Patel3c91b052010-03-08 20:52:55 +00001632 if (!Scope->getScopeNode())
Devang Patel0ef3fa62010-03-08 19:20:38 +00001633 return NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001634 DIScope DS(Scope->getScopeNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00001635 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1636
Devang Patel2db49d72010-05-07 18:11:54 +00001637 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel163a9f72010-05-10 22:49:55 +00001638 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1639 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001640 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel2c4ceb12009-11-21 02:48:08 +00001641 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001642 dwarf::DW_FORM_ref4, OriginDIE);
1643
Chris Lattner6ed0f902010-03-09 00:31:02 +00001644 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnerb7db7332010-03-09 01:58:53 +00001645 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patel53bb5c92009-11-10 23:06:00 +00001646
1647 InlinedSubprogramDIEs.insert(OriginDIE);
1648
1649 // Track the start label for this inlined function.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001650 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patel2db49d72010-05-07 18:11:54 +00001651 I = InlineInfo.find(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001652
1653 if (I == InlineInfo.end()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001654 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001655 ScopeDIE));
Devang Patel2db49d72010-05-07 18:11:54 +00001656 InlinedSPNodes.push_back(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001657 } else
Chris Lattner6ed0f902010-03-09 00:31:02 +00001658 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patel53bb5c92009-11-10 23:06:00 +00001659
Devang Patel53bb5c92009-11-10 23:06:00 +00001660 DILocation DL(Scope->getInlinedAt());
Devang Patel163a9f72010-05-10 22:49:55 +00001661 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001662 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +00001663
1664 return ScopeDIE;
1665}
1666
Devang Patel2c4ceb12009-11-21 02:48:08 +00001667
1668/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel8a241142009-12-09 18:24:21 +00001669DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel8bd11de2010-08-09 21:01:39 +00001670 StringRef Name = DV->getName();
Devang Patel65dbc902009-11-25 17:36:49 +00001671 if (Name.empty())
Devang Patel3fb6bd62009-11-13 02:25:26 +00001672 return NULL;
Devang Patel53bb5c92009-11-10 23:06:00 +00001673
1674 // Translate tag to proper Dwarf tag. The result variable is dropped for
1675 // now.
1676 unsigned Tag;
Devang Patel8bd11de2010-08-09 21:01:39 +00001677 switch (DV->getTag()) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001678 case dwarf::DW_TAG_return_variable:
1679 return NULL;
1680 case dwarf::DW_TAG_arg_variable:
1681 Tag = dwarf::DW_TAG_formal_parameter;
1682 break;
1683 case dwarf::DW_TAG_auto_variable: // fall thru
1684 default:
1685 Tag = dwarf::DW_TAG_variable;
1686 break;
1687 }
1688
1689 // Define variable debug information entry.
1690 DIE *VariableDie = new DIE(Tag);
1691
Devang Patel53bb5c92009-11-10 23:06:00 +00001692 DIE *AbsDIE = NULL;
Devang Patel26c1e562010-05-20 16:36:41 +00001693 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1694 V2AVI = VarToAbstractVarMap.find(DV);
1695 if (V2AVI != VarToAbstractVarMap.end())
1696 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001697
Devang Patel26c1e562010-05-20 16:36:41 +00001698 if (AbsDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001699 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001700 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001701 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001702 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel8bd11de2010-08-09 21:01:39 +00001703 addSourceLine(VariableDie, DV->getVariable());
Devang Patel53bb5c92009-11-10 23:06:00 +00001704
1705 // Add variable type.
Devang Patel8bd11de2010-08-09 21:01:39 +00001706 addType(VariableDie, DV->getType());
Devang Patel53bb5c92009-11-10 23:06:00 +00001707 }
1708
Devang Patel8bd11de2010-08-09 21:01:39 +00001709 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patelb4645642010-02-06 01:02:37 +00001710 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel3cf763d2010-09-29 23:07:21 +00001711 else if (DIVariable(DV->getVariable()).isArtificial())
1712 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelc3f5f782010-05-25 23:40:22 +00001713
1714 if (Scope->isAbstractScope()) {
1715 DV->setDIE(VariableDie);
1716 return VariableDie;
1717 }
1718
1719 // Add variable address.
1720
1721 unsigned Offset = DV->getDotDebugLocOffset();
1722 if (Offset != ~0U) {
1723 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1724 Asm->GetTempSymbol("debug_loc", Offset));
1725 DV->setDIE(VariableDie);
1726 UseDotDebugLocEntry.insert(VariableDie);
1727 return VariableDie;
1728 }
1729
1730 // Check if variable is described by a DBG_VALUE instruction.
1731 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1732 DbgVariableToDbgInstMap.find(DV);
1733 if (DVI != DbgVariableToDbgInstMap.end()) {
1734 const MachineInstr *DVInsn = DVI->second;
Devang Patelc3f5f782010-05-25 23:40:22 +00001735 bool updated = false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001736 // FIXME : Handle getNumOperands != 3
Devang Patelc3f5f782010-05-25 23:40:22 +00001737 if (DVInsn->getNumOperands() == 3) {
Devang Patel0b48ead2010-08-31 22:22:42 +00001738 if (DVInsn->getOperand(0).isReg()) {
1739 const MachineOperand RegOp = DVInsn->getOperand(0);
1740 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1741 if (DVInsn->getOperand(1).isImm() &&
1742 TRI->getFrameRegister(*Asm->MF) == RegOp.getReg()) {
1743 addVariableAddress(DV, VariableDie, DVInsn->getOperand(1).getImm());
1744 updated = true;
1745 } else
Devang Patel522ad742010-11-12 23:20:42 +00001746 updated = addRegisterAddress(VariableDie, RegOp);
Devang Patel0b48ead2010-08-31 22:22:42 +00001747 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001748 else if (DVInsn->getOperand(0).isImm())
Devang Patel522ad742010-11-12 23:20:42 +00001749 updated = addConstantValue(VariableDie, DVInsn->getOperand(0));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001750 else if (DVInsn->getOperand(0).isFPImm())
1751 updated =
Devang Patel522ad742010-11-12 23:20:42 +00001752 addConstantFPValue(VariableDie, DVInsn->getOperand(0));
Devang Patelc3f5f782010-05-25 23:40:22 +00001753 } else {
1754 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1755 if (Location.getReg()) {
1756 addAddress(VariableDie, dwarf::DW_AT_location, Location);
Devang Patelc3f5f782010-05-25 23:40:22 +00001757 updated = true;
1758 }
1759 }
1760 if (!updated) {
1761 // If variableDie is not updated then DBG_VALUE instruction does not
1762 // have valid variable info.
1763 delete VariableDie;
1764 return NULL;
1765 }
1766 DV->setDIE(VariableDie);
1767 return VariableDie;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001768 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001769
1770 // .. else use frame index, if available.
Devang Patelc3f5f782010-05-25 23:40:22 +00001771 int FI = 0;
Devang Patel9e3bd2c2010-08-31 06:11:28 +00001772 if (findVariableFrameIndex(DV, &FI))
1773 addVariableAddress(DV, VariableDie, FI);
1774
Devang Patel53bb5c92009-11-10 23:06:00 +00001775 DV->setDIE(VariableDie);
1776 return VariableDie;
1777
1778}
Devang Patel2c4ceb12009-11-21 02:48:08 +00001779
Devang Patel193f7202009-11-24 01:14:22 +00001780void DwarfDebug::addPubTypes(DISubprogram SP) {
1781 DICompositeType SPTy = SP.getType();
1782 unsigned SPTag = SPTy.getTag();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001783 if (SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel193f7202009-11-24 01:14:22 +00001784 return;
1785
1786 DIArray Args = SPTy.getTypeArray();
Devang Patel193f7202009-11-24 01:14:22 +00001787 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patel2db49d72010-05-07 18:11:54 +00001788 DIType ATy(Args.getElement(i));
Devang Patel9c004872010-05-07 21:45:47 +00001789 if (!ATy.Verify())
Devang Patel193f7202009-11-24 01:14:22 +00001790 continue;
1791 DICompositeType CATy = getDICompositeType(ATy);
Devang Patel2db49d72010-05-07 18:11:54 +00001792 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel50d80e32010-04-13 20:35:04 +00001793 && !CATy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001794 CompileUnit *TheCU = getCompileUnit(CATy);
1795 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1796 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001797 }
1798 }
1799}
1800
Devang Patel2c4ceb12009-11-21 02:48:08 +00001801/// constructScopeDIE - Construct a DIE for this scope.
1802DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3c91b052010-03-08 20:52:55 +00001803 if (!Scope || !Scope->getScopeNode())
1804 return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001805
Devang Patel5bc9fec2011-02-19 01:31:27 +00001806 SmallVector <DIE *, 8> Children;
Devang Patel0478c152011-03-01 22:58:55 +00001807
1808 // Collect arguments for current function.
1809 if (Scope == CurrentFnDbgScope)
1810 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
1811 if (DbgVariable *ArgDV = CurrentFnArguments[i])
1812 if (DIE *Arg = constructVariableDIE(ArgDV, Scope))
1813 Children.push_back(Arg);
1814
Devang Patel5bc9fec2011-02-19 01:31:27 +00001815 // Collect lexical scope childrens first.
1816 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
1817 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
1818 if (DIE *Variable = constructVariableDIE(Variables[i], Scope))
1819 Children.push_back(Variable);
1820 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
1821 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
1822 if (DIE *Nested = constructScopeDIE(Scopes[j]))
1823 Children.push_back(Nested);
Devang Patel3c91b052010-03-08 20:52:55 +00001824 DIScope DS(Scope->getScopeNode());
1825 DIE *ScopeDIE = NULL;
1826 if (Scope->getInlinedAt())
1827 ScopeDIE = constructInlinedScopeDIE(Scope);
1828 else if (DS.isSubprogram()) {
Devang Patel0dd45582010-06-28 20:53:04 +00001829 ProcessedSPNodes.insert(DS);
Devang Patel8aa61472010-07-07 22:20:57 +00001830 if (Scope->isAbstractScope()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001831 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patel8aa61472010-07-07 22:20:57 +00001832 // Note down abstract DIE.
1833 if (ScopeDIE)
1834 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
1835 }
Devang Patel3c91b052010-03-08 20:52:55 +00001836 else
Devang Patel2db49d72010-05-07 18:11:54 +00001837 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3c91b052010-03-08 20:52:55 +00001838 }
Devang Patel5bc9fec2011-02-19 01:31:27 +00001839 else {
1840 // There is no need to emit empty lexical block DIE.
1841 if (Children.empty())
1842 return NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001843 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel5bc9fec2011-02-19 01:31:27 +00001844 }
1845
Devang Patelaead63c2010-03-29 22:59:58 +00001846 if (!ScopeDIE) return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001847
Devang Patel5bc9fec2011-02-19 01:31:27 +00001848 // Add children
1849 for (SmallVector<DIE *, 8>::iterator I = Children.begin(),
1850 E = Children.end(); I != E; ++I)
1851 ScopeDIE->addChild(*I);
Devang Patel193f7202009-11-24 01:14:22 +00001852
Jim Grosbach1e20b962010-07-21 21:21:52 +00001853 if (DS.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001854 addPubTypes(DISubprogram(DS));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001855
Devang Patel193f7202009-11-24 01:14:22 +00001856 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +00001857}
1858
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001859/// GetOrCreateSourceID - Look up the source id with the given directory and
1860/// source file names. If none currently exists, create a new id and insert it
1861/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1862/// maps as well.
Devang Patel2f584852010-07-24 00:53:22 +00001863
Devang Patel23670e52011-03-24 20:30:50 +00001864unsigned DwarfDebug::GetOrCreateSourceID(StringRef FileName,
1865 StringRef DirName) {
Devang Patel1905a182010-09-16 20:57:49 +00001866 // If FE did not provide a file name, then assume stdin.
1867 if (FileName.empty())
Devang Patel23670e52011-03-24 20:30:50 +00001868 return GetOrCreateSourceID("<stdin>", StringRef());
1869
1870 // MCStream expects full path name as filename.
1871 if (!DirName.empty() && !FileName.startswith("/")) {
1872 std::string FullPathName(DirName.data());
1873 if (!DirName.endswith("/"))
1874 FullPathName += "/";
1875 FullPathName += FileName.data();
1876 // Here FullPathName will be copied into StringMap by GetOrCreateSourceID.
1877 return GetOrCreateSourceID(StringRef(FullPathName), StringRef());
1878 }
Devang Patel1905a182010-09-16 20:57:49 +00001879
Rafael Espindola5c055632010-11-18 02:04:25 +00001880 StringMapEntry<unsigned> &Entry = SourceIdMap.GetOrCreateValue(FileName);
1881 if (Entry.getValue())
1882 return Entry.getValue();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001883
Rafael Espindola5c055632010-11-18 02:04:25 +00001884 unsigned SrcId = SourceIdMap.size();
1885 Entry.setValue(SrcId);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001886
Rafael Espindola5c055632010-11-18 02:04:25 +00001887 // Print out a .file directive to specify files for .loc directives.
Devang Patel23670e52011-03-24 20:30:50 +00001888 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, Entry.getKey());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001889
1890 return SrcId;
1891}
1892
Devang Patel6404e4e2009-12-15 19:16:48 +00001893/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1894DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel163a9f72010-05-10 22:49:55 +00001895 CompileUnit *TheCU = getCompileUnit(NS);
1896 DIE *NDie = TheCU->getDIE(NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001897 if (NDie)
1898 return NDie;
1899 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel163a9f72010-05-10 22:49:55 +00001900 TheCU->insertDIE(NS, NDie);
Devang Patel6404e4e2009-12-15 19:16:48 +00001901 if (!NS.getName().empty())
1902 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
Devang Patel81625742010-08-09 20:20:05 +00001903 addSourceLine(NDie, NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001904 addToContextOwner(NDie, NS.getContext());
1905 return NDie;
1906}
1907
Jim Grosbach1e20b962010-07-21 21:21:52 +00001908/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel163a9f72010-05-10 22:49:55 +00001909/// metadata node with tag DW_TAG_compile_unit.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001910void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001911 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +00001912 StringRef FN = DIUnit.getFilename();
1913 StringRef Dir = DIUnit.getDirectory();
Devang Patel23670e52011-03-24 20:30:50 +00001914 unsigned ID = GetOrCreateSourceID(FN, Dir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001915
1916 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001917 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001918 DIUnit.getProducer());
Devang Patel3a4ae322011-02-23 22:37:04 +00001919 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001920 DIUnit.getLanguage());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001921 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patel5098da02010-04-26 22:54:28 +00001922 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1923 // simplifies debug range entries.
Devang Patel9b93b6b2010-06-28 22:22:47 +00001924 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Patel4a602ca2010-03-22 23:11:36 +00001925 // DW_AT_stmt_list is a offset of line number information for this
Devang Patelaf608bd2010-08-24 00:06:12 +00001926 // compile unit in debug_line section.
Devang Patelae84d5b2010-08-31 23:50:19 +00001927 if (Asm->MAI->doesDwarfUsesAbsoluteLabelForStmtList())
Cameron Zwarichf754f502011-02-25 16:30:32 +00001928 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_addr,
1929 Asm->GetTempSymbol("section_line"));
Devang Patelae84d5b2010-08-31 23:50:19 +00001930 else
1931 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001932
Devang Patel65dbc902009-11-25 17:36:49 +00001933 if (!Dir.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001934 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001935 if (DIUnit.isOptimized())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001936 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001937
Devang Patel65dbc902009-11-25 17:36:49 +00001938 StringRef Flags = DIUnit.getFlags();
1939 if (!Flags.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001940 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001941
1942 unsigned RVer = DIUnit.getRunTimeVersion();
1943 if (RVer)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001944 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001945 dwarf::DW_FORM_data1, RVer);
1946
Devang Patel163a9f72010-05-10 22:49:55 +00001947 CompileUnit *NewCU = new CompileUnit(ID, Die);
1948 if (!FirstCU)
1949 FirstCU = NewCU;
1950 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001951}
1952
Devang Patel163a9f72010-05-10 22:49:55 +00001953/// getCompielUnit - Get CompileUnit DIE.
1954CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1955 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1956 DIDescriptor D(N);
1957 const MDNode *CUNode = NULL;
1958 if (D.isCompileUnit())
1959 CUNode = N;
1960 else if (D.isSubprogram())
1961 CUNode = DISubprogram(N).getCompileUnit();
1962 else if (D.isType())
1963 CUNode = DIType(N).getCompileUnit();
1964 else if (D.isGlobalVariable())
1965 CUNode = DIGlobalVariable(N).getCompileUnit();
1966 else if (D.isVariable())
1967 CUNode = DIVariable(N).getCompileUnit();
1968 else if (D.isNameSpace())
1969 CUNode = DINameSpace(N).getCompileUnit();
1970 else if (D.isFile())
1971 CUNode = DIFile(N).getCompileUnit();
1972 else
1973 return FirstCU;
1974
1975 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1976 = CUMap.find(CUNode);
1977 if (I == CUMap.end())
1978 return FirstCU;
1979 return I->second;
1980}
1981
Devang Patel0c4720c2010-08-23 18:25:56 +00001982/// isUnsignedDIType - Return true if type encoding is unsigned.
1983static bool isUnsignedDIType(DIType Ty) {
1984 DIDerivedType DTy(Ty);
1985 if (DTy.Verify())
1986 return isUnsignedDIType(DTy.getTypeDerivedFrom());
1987
1988 DIBasicType BTy(Ty);
1989 if (BTy.Verify()) {
1990 unsigned Encoding = BTy.getEncoding();
1991 if (Encoding == dwarf::DW_ATE_unsigned ||
1992 Encoding == dwarf::DW_ATE_unsigned_char)
1993 return true;
1994 }
1995 return false;
1996}
Devang Patel163a9f72010-05-10 22:49:55 +00001997
Devang Patele449d1f2011-01-20 00:02:16 +00001998// Return const exprssion if value is a GEP to access merged global
1999// constant. e.g.
2000// i8* getelementptr ({ i8, i8, i8, i8 }* @_MergedGlobals, i32 0, i32 0)
2001static const ConstantExpr *getMergedGlobalExpr(const Value *V) {
2002 const ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(V);
2003 if (!CE || CE->getNumOperands() != 3 ||
2004 CE->getOpcode() != Instruction::GetElementPtr)
2005 return NULL;
2006
2007 // First operand points to a global value.
2008 if (!isa<GlobalValue>(CE->getOperand(0)))
2009 return NULL;
2010
2011 // Second operand is zero.
2012 const ConstantInt *CI =
2013 dyn_cast_or_null<ConstantInt>(CE->getOperand(1));
2014 if (!CI || !CI->isZero())
2015 return NULL;
2016
2017 // Third operand is offset.
2018 if (!isa<ConstantInt>(CE->getOperand(2)))
2019 return NULL;
2020
2021 return CE;
2022}
2023
Devang Patel163a9f72010-05-10 22:49:55 +00002024/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00002025void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel9fa539c2010-08-10 01:37:23 +00002026 DIGlobalVariable GV(N);
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002027
Devang Patel905cf5e2009-09-04 23:59:07 +00002028 // If debug information is malformed then ignore it.
Devang Patel9fa539c2010-08-10 01:37:23 +00002029 if (GV.Verify() == false)
Devang Patel905cf5e2009-09-04 23:59:07 +00002030 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002031
2032 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00002033 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel9fa539c2010-08-10 01:37:23 +00002034 if (TheCU->getDIE(GV))
Devang Patel13e16b62009-06-26 01:49:18 +00002035 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002036
Devang Patel9fa539c2010-08-10 01:37:23 +00002037 DIType GTy = GV.getType();
Devang Patel29368072010-08-10 07:11:13 +00002038 DIE *VariableDIE = new DIE(GV.getTag());
2039
2040 bool isGlobalVariable = GV.getGlobal() != NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002041
Devang Patel9fa539c2010-08-10 01:37:23 +00002042 // Add name.
2043 addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
2044 GV.getDisplayName());
2045 StringRef LinkageName = GV.getLinkageName();
Devang Patel29368072010-08-10 07:11:13 +00002046 if (!LinkageName.empty() && isGlobalVariable)
Devang Patel9fa539c2010-08-10 01:37:23 +00002047 addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
2048 getRealLinkageName(LinkageName));
2049 // Add type.
2050 addType(VariableDIE, GTy);
Devang Patel50d80e32010-04-13 20:35:04 +00002051 if (GTy.isCompositeType() && !GTy.getName().empty()
2052 && !GTy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00002053 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattnered7a77b2010-03-31 05:36:29 +00002054 assert(Entry && "Missing global type!");
Devang Patel163a9f72010-05-10 22:49:55 +00002055 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00002056 }
Devang Patel9fa539c2010-08-10 01:37:23 +00002057 // Add scoping info.
2058 if (!GV.isLocalToUnit()) {
2059 addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
2060 // Expose as global.
2061 TheCU->addGlobal(GV.getName(), VariableDIE);
2062 }
2063 // Add line number info.
2064 addSourceLine(VariableDIE, GV);
2065 // Add to map.
2066 TheCU->insertDIE(N, VariableDIE);
2067 // Add to context owner.
2068 DIDescriptor GVContext = GV.getContext();
2069 addToContextOwner(VariableDIE, GVContext);
2070 // Add location.
Devang Patel29368072010-08-10 07:11:13 +00002071 if (isGlobalVariable) {
2072 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
2073 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
2074 addLabel(Block, 0, dwarf::DW_FORM_udata,
2075 Asm->Mang->getSymbol(GV.getGlobal()));
2076 // Do not create specification DIE if context is either compile unit
2077 // or a subprogram.
2078 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
2079 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
2080 // Create specification DIE.
2081 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
2082 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
2083 dwarf::DW_FORM_ref4, VariableDIE);
2084 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
2085 addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
2086 TheCU->addDie(VariableSpecDIE);
2087 } else {
2088 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
2089 }
Devang Patel76a788c2011-01-06 21:39:25 +00002090 } else if (ConstantInt *CI =
2091 dyn_cast_or_null<ConstantInt>(GV.getConstant()))
2092 addConstantValue(VariableDIE, CI, isUnsignedDIType(GTy));
Devang Patele449d1f2011-01-20 00:02:16 +00002093 else if (const ConstantExpr *CE = getMergedGlobalExpr(N->getOperand(11))) {
2094 // GV is a merged global.
2095 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
2096 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
2097 addLabel(Block, 0, dwarf::DW_FORM_udata,
2098 Asm->Mang->getSymbol(cast<GlobalValue>(CE->getOperand(0))));
2099 ConstantInt *CII = cast<ConstantInt>(CE->getOperand(2));
2100 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
2101 addUInt(Block, 0, dwarf::DW_FORM_udata, CII->getZExtValue());
2102 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
2103 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
2104 }
Devang Patel76a788c2011-01-06 21:39:25 +00002105
Devang Patel13e16b62009-06-26 01:49:18 +00002106 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002107}
2108
Devang Patel163a9f72010-05-10 22:49:55 +00002109/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00002110void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00002111 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002112
Stuart Hastings639336e2010-04-06 21:38:29 +00002113 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00002114 CompileUnit *TheCU = getCompileUnit(N);
2115 if (TheCU->getDIE(N))
Stuart Hastings639336e2010-04-06 21:38:29 +00002116 return;
2117
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002118 if (!SP.isDefinition())
2119 // This is a method declaration which will be handled while constructing
2120 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +00002121 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002122
Stuart Hastings639336e2010-04-06 21:38:29 +00002123 DIE *SubprogramDie = createSubprogramDIE(SP);
2124
2125 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +00002126 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002127
2128 // Add to context owner.
Devang Patel6404e4e2009-12-15 19:16:48 +00002129 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +00002130
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002131 // Expose as global.
Devang Patel163a9f72010-05-10 22:49:55 +00002132 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel193f7202009-11-24 01:14:22 +00002133
Devang Patel13e16b62009-06-26 01:49:18 +00002134 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002135}
2136
Devang Patel2c4ceb12009-11-21 02:48:08 +00002137/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbar00564992009-09-19 20:40:14 +00002138/// content. Create global DIEs and emit initial debug info sections.
2139/// This is inovked by the target AsmPrinter.
Chris Lattner75f50722010-04-04 07:48:20 +00002140void DwarfDebug::beginModule(Module *M) {
Devang Pateleac9c072010-04-27 19:46:33 +00002141 if (DisableDebugInfoPrinting)
2142 return;
2143
Devang Patel78ab9e22009-07-30 18:56:46 +00002144 DebugInfoFinder DbgFinder;
2145 DbgFinder.processModule(*M);
Devang Patel13e16b62009-06-26 01:49:18 +00002146
Chris Lattnerd850ac72010-04-05 02:19:28 +00002147 bool HasDebugInfo = false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002148
Chris Lattnerd850ac72010-04-05 02:19:28 +00002149 // Scan all the compile-units to see if there are any marked as the main unit.
2150 // if not, we do not generate debug info.
2151 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2152 E = DbgFinder.compile_unit_end(); I != E; ++I) {
2153 if (DICompileUnit(*I).isMain()) {
2154 HasDebugInfo = true;
2155 break;
2156 }
2157 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002158
Chris Lattnerd850ac72010-04-05 02:19:28 +00002159 if (!HasDebugInfo) return;
2160
2161 // Tell MMI that we have debug info.
2162 MMI->setDebugInfoAvailability(true);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002163
Chris Lattnerbe15beb2010-04-04 23:17:54 +00002164 // Emit initial sections.
Chris Lattnerd850ac72010-04-05 02:19:28 +00002165 EmitSectionLabels();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002166
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002167 // Create all the compile unit DIEs.
Devang Patel78ab9e22009-07-30 18:56:46 +00002168 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2169 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002170 constructCompileUnit(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002171
Devang Patel53bb5c92009-11-10 23:06:00 +00002172 // Create DIEs for each subprogram.
Devang Patel78ab9e22009-07-30 18:56:46 +00002173 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
2174 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002175 constructSubprogramDIE(*I);
Devang Patel13e16b62009-06-26 01:49:18 +00002176
Devang Patelc366f832009-12-10 19:14:49 +00002177 // Create DIEs for each global variable.
2178 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2179 E = DbgFinder.global_variable_end(); I != E; ++I)
2180 constructGlobalVariableDIE(*I);
2181
Devang Patele7e5a0f2010-08-10 20:01:20 +00002182 //getOrCreateTypeDIE
2183 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
2184 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2185 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2186
Devang Patel1a7ca032010-09-28 18:08:20 +00002187 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
2188 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2189 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2190
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002191 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +00002192 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002193}
2194
Devang Patel2c4ceb12009-11-21 02:48:08 +00002195/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002196///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002197void DwarfDebug::endModule() {
Devang Patel163a9f72010-05-10 22:49:55 +00002198 if (!FirstCU) return;
Devang Patel4a1cad62010-06-28 18:25:03 +00002199 const Module *M = MMI->getModule();
Devang Patele9a1cca2010-08-02 17:32:15 +00002200 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patel4a1cad62010-06-28 18:25:03 +00002201 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2202 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2203 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2204 DISubprogram SP(AllSPs->getOperand(SI));
2205 if (!SP.Verify()) continue;
2206
2207 // Collect info for variables that were optimized out.
Devang Patel8b3a6b62010-07-19 17:53:55 +00002208 if (!SP.isDefinition()) continue;
Devang Patel4a1cad62010-06-28 18:25:03 +00002209 StringRef FName = SP.getLinkageName();
2210 if (FName.empty())
2211 FName = SP.getName();
Devang Patel62367042010-11-10 22:19:21 +00002212 NamedMDNode *NMD = getFnSpecificMDNode(*(MMI->getModule()), FName);
Devang Patel4a1cad62010-06-28 18:25:03 +00002213 if (!NMD) continue;
2214 unsigned E = NMD->getNumOperands();
2215 if (!E) continue;
2216 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Patele9a1cca2010-08-02 17:32:15 +00002217 DeadFnScopeMap[SP] = Scope;
Devang Patel4a1cad62010-06-28 18:25:03 +00002218 for (unsigned I = 0; I != E; ++I) {
2219 DIVariable DV(NMD->getOperand(I));
2220 if (!DV.Verify()) continue;
2221 Scope->addVariable(new DbgVariable(DV));
2222 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002223
Devang Patel4a1cad62010-06-28 18:25:03 +00002224 // Construct subprogram DIE and add variables DIEs.
2225 constructSubprogramDIE(SP);
2226 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patele03161c2010-08-09 18:51:29 +00002227 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patel4a1cad62010-06-28 18:25:03 +00002228 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2229 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2230 if (VariableDIE)
2231 ScopeDIE->addChild(VariableDIE);
2232 }
2233 }
2234 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002235
Devang Patel53bb5c92009-11-10 23:06:00 +00002236 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2237 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2238 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2239 DIE *ISP = *AI;
Devang Patel2c4ceb12009-11-21 02:48:08 +00002240 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +00002241 }
2242
Devang Patele9f8f5e2010-05-07 20:54:48 +00002243 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Patel5d11eb02009-12-03 19:11:07 +00002244 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2245 DIE *SPDie = CI->first;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002246 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Patel5d11eb02009-12-03 19:11:07 +00002247 if (!N) continue;
Devang Patel163a9f72010-05-10 22:49:55 +00002248 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Patel5d11eb02009-12-03 19:11:07 +00002249 if (!NDie) continue;
2250 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patel5d11eb02009-12-03 19:11:07 +00002251 }
2252
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002253 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002254 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002255 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002256 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002257 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002258
2259 // End text sections.
2260 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002261 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnerc0215722010-04-04 19:25:43 +00002262 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002263 }
2264
2265 // Emit common frame information.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002266 emitCommonDebugFrame();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002267
2268 // Emit function debug frame information
2269 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2270 E = DebugFrames.end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002271 emitFunctionDebugFrame(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002272
2273 // Compute DIE offsets and sizes.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002274 computeSizeAndOffsets();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002275
2276 // Emit all the DIEs into a debug info section
Devang Patel2c4ceb12009-11-21 02:48:08 +00002277 emitDebugInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002278
2279 // Corresponding abbreviations into a abbrev section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002280 emitAbbreviations();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002281
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002282 // Emit info into a debug pubnames section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002283 emitDebugPubNames();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002284
Devang Patel193f7202009-11-24 01:14:22 +00002285 // Emit info into a debug pubtypes section.
2286 emitDebugPubTypes();
2287
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002288 // Emit info into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002289 emitDebugLoc();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002290
2291 // Emit info into a debug aranges section.
2292 EmitDebugARanges();
2293
2294 // Emit info into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002295 emitDebugRanges();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002296
2297 // Emit info into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002298 emitDebugMacInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002299
2300 // Emit inline info.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002301 emitDebugInlineInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002302
Chris Lattnerbc733f52010-03-13 02:17:42 +00002303 // Emit info into a debug str section.
2304 emitDebugStr();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002305
Devang Patele9a1cca2010-08-02 17:32:15 +00002306 // clean up.
2307 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel163a9f72010-05-10 22:49:55 +00002308 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2309 E = CUMap.end(); I != E; ++I)
2310 delete I->second;
2311 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002312}
2313
Devang Patel53bb5c92009-11-10 23:06:00 +00002314/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002315DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattnerde4845c2010-04-02 19:42:39 +00002316 DebugLoc ScopeLoc) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002317
Devang Patel2db49d72010-05-07 18:11:54 +00002318 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00002319 if (AbsDbgVariable)
2320 return AbsDbgVariable;
2321
Devang Patel2db49d72010-05-07 18:11:54 +00002322 LLVMContext &Ctx = Var->getContext();
Chris Lattnerde4845c2010-04-02 19:42:39 +00002323 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00002324 if (!Scope)
2325 return NULL;
2326
Devang Patel26c1e562010-05-20 16:36:41 +00002327 AbsDbgVariable = new DbgVariable(Var);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002328 Scope->addVariable(AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00002329 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00002330 return AbsDbgVariable;
2331}
2332
Devang Patel0478c152011-03-01 22:58:55 +00002333/// addCurrentFnArgument - If Var is an current function argument that add
2334/// it in CurrentFnArguments list.
2335bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
2336 DbgVariable *Var, DbgScope *Scope) {
2337 if (Scope != CurrentFnDbgScope)
2338 return false;
2339 DIVariable DV = Var->getVariable();
2340 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
2341 return false;
2342 unsigned ArgNo = DV.getArgNumber();
2343 if (ArgNo == 0)
2344 return false;
2345
Devang Patelcb3a6572011-03-03 20:02:02 +00002346 size_t Size = CurrentFnArguments.size();
2347 if (Size == 0)
Devang Patel0478c152011-03-01 22:58:55 +00002348 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patelbbd0f452011-03-03 21:49:41 +00002349 // llvm::Function argument size is not good indicator of how many
Devang Patel6f676be2011-03-03 20:08:10 +00002350 // arguments does the function have at source level.
2351 if (ArgNo > Size)
Devang Patelcb3a6572011-03-03 20:02:02 +00002352 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel0478c152011-03-01 22:58:55 +00002353 CurrentFnArguments[ArgNo - 1] = Var;
2354 return true;
2355}
2356
Devang Patelee432862010-05-20 19:57:06 +00002357/// collectVariableInfoFromMMITable - Collect variable information from
2358/// side table maintained by MMI.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002359void
Devang Patelee432862010-05-20 19:57:06 +00002360DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2361 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00002362 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patele717faa2009-10-06 01:26:37 +00002363 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2364 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2365 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00002366 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00002367 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00002368 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002369 DIVariable DV(Var);
2370 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00002371
Chris Lattnerde4845c2010-04-02 19:42:39 +00002372 DbgScope *Scope = 0;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002373 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattnerde4845c2010-04-02 19:42:39 +00002374 Scope = ConcreteScopes.lookup(IA);
2375 if (Scope == 0)
2376 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002377
Devang Patelfb0ee432009-11-10 23:20:04 +00002378 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00002379 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00002380 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00002381
Devang Patel26c1e562010-05-20 16:36:41 +00002382 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2383 DbgVariable *RegVar = new DbgVariable(DV);
2384 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel0478c152011-03-01 22:58:55 +00002385 if (!addCurrentFnArgument(MF, RegVar, Scope))
2386 Scope->addVariable(RegVar);
Devang Patel26c1e562010-05-20 16:36:41 +00002387 if (AbsDbgVariable) {
2388 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2389 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2390 }
Devang Patele717faa2009-10-06 01:26:37 +00002391 }
Devang Patelee432862010-05-20 19:57:06 +00002392}
Devang Patel90a48ad2010-03-15 18:33:46 +00002393
Jim Grosbach1e20b962010-07-21 21:21:52 +00002394/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patelc3f5f782010-05-25 23:40:22 +00002395/// DBG_VALUE instruction, is in a defined reg.
2396static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2397 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00002398 return MI->getNumOperands() == 3 &&
2399 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
2400 MI->getOperand(1).isImm() && MI->getOperand(1).getImm() == 0;
Devang Patelc3f5f782010-05-25 23:40:22 +00002401}
2402
Devang Patelee432862010-05-20 19:57:06 +00002403/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002404void
Devang Patel78e127d2010-06-25 22:07:34 +00002405DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2406 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002407
Devang Patelee432862010-05-20 19:57:06 +00002408 /// collection info from MMI table.
2409 collectVariableInfoFromMMITable(MF, Processed);
2410
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002411 for (SmallVectorImpl<const MDNode*>::const_iterator
2412 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
2413 ++UVI) {
2414 const MDNode *Var = *UVI;
2415 if (Processed.count(Var))
Devang Patelee432862010-05-20 19:57:06 +00002416 continue;
2417
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002418 // History contains relevant DBG_VALUE instructions for Var and instructions
2419 // clobbering it.
2420 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
2421 if (History.empty())
2422 continue;
2423 const MachineInstr *MInsn = History.front();
Devang Patelc3f5f782010-05-25 23:40:22 +00002424
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002425 DIVariable DV(Var);
Devang Patela36478f2011-01-11 21:42:10 +00002426 DbgScope *Scope = NULL;
Devang Pateld8720f42010-05-27 20:25:04 +00002427 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2428 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelc0c5a262010-05-21 00:10:20 +00002429 Scope = CurrentFnDbgScope;
Devang Patela36478f2011-01-11 21:42:10 +00002430 else
2431 Scope = findDbgScope(MInsn);
Devang Patelee432862010-05-20 19:57:06 +00002432 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00002433 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00002434 continue;
2435
2436 Processed.insert(DV);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002437 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patelee432862010-05-20 19:57:06 +00002438 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patel0478c152011-03-01 22:58:55 +00002439 if (!addCurrentFnArgument(MF, RegVar, Scope))
2440 Scope->addVariable(RegVar);
Devang Patelc0c5a262010-05-21 00:10:20 +00002441 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2442 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2443 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patel90a48ad2010-03-15 18:33:46 +00002444 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002445
2446 // Simple ranges that are fully coalesced.
2447 if (History.size() <= 1 || (History.size() == 2 &&
2448 MInsn->isIdenticalTo(History.back()))) {
Devang Patelc3f5f782010-05-25 23:40:22 +00002449 DbgVariableToDbgInstMap[RegVar] = MInsn;
2450 continue;
2451 }
2452
2453 // handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002454 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00002455
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002456 for (SmallVectorImpl<const MachineInstr*>::const_iterator
2457 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
2458 const MachineInstr *Begin = *HI;
2459 assert(Begin->isDebugValue() && "Invalid History entry");
Devang Patelc3f5f782010-05-25 23:40:22 +00002460 MachineLocation MLoc;
Devang Patelb2cf5812010-08-04 18:40:52 +00002461 if (Begin->getNumOperands() == 3) {
2462 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2463 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2464 } else
2465 MLoc = Asm->getDebugValueLocation(Begin);
2466
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002467 // FIXME: emitDebugLoc only understands registers.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00002468 if (!MLoc.getReg())
2469 continue;
Jakob Stoklund Olesene17232e2011-03-22 00:21:41 +00002470
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00002471 // Compute the range for a register location.
2472 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2473 const MCSymbol *SLabel = 0;
2474
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002475 if (HI + 1 == HE)
2476 // If Begin is the last instruction in History then its value is valid
Devang Patelc3f5f782010-05-25 23:40:22 +00002477 // until the end of the funtion.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00002478 SLabel = FunctionEndSym;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002479 else {
2480 const MachineInstr *End = HI[1];
2481 if (End->isDebugValue())
2482 SLabel = getLabelBeforeInsn(End);
2483 else {
2484 // End is a normal instruction clobbering the range.
2485 SLabel = getLabelAfterInsn(End);
2486 assert(SLabel && "Forgot label after clobber instruction");
2487 ++HI;
2488 }
2489 }
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00002490
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002491 // The value is valid until the next DBG_VALUE or clobber.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00002492 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
Devang Patelc3f5f782010-05-25 23:40:22 +00002493 }
2494 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00002495 }
Devang Patel98e1cac2010-05-14 21:01:35 +00002496
2497 // Collect info for variables that were optimized out.
Devang Pateld1bbc6b2010-06-22 01:01:58 +00002498 const Function *F = MF->getFunction();
Devang Patel62367042010-11-10 22:19:21 +00002499 if (NamedMDNode *NMD = getFnSpecificMDNode(*(F->getParent()), F->getName())) {
Devang Patel98e1cac2010-05-14 21:01:35 +00002500 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman872814a2010-07-21 18:54:18 +00002501 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patelee432862010-05-20 19:57:06 +00002502 if (!DV || !Processed.insert(DV))
Devang Patel98e1cac2010-05-14 21:01:35 +00002503 continue;
2504 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2505 if (Scope)
Devang Patel26c1e562010-05-20 16:36:41 +00002506 Scope->addVariable(new DbgVariable(DV));
Devang Patel98e1cac2010-05-14 21:01:35 +00002507 }
2508 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002509}
Devang Patel98e1cac2010-05-14 21:01:35 +00002510
Devang Patelc3f5f782010-05-25 23:40:22 +00002511/// getLabelBeforeInsn - Return Label preceding the instruction.
2512const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002513 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
2514 assert(Label && "Didn't insert label before instruction");
2515 return Label;
Devang Patelc3f5f782010-05-25 23:40:22 +00002516}
2517
2518/// getLabelAfterInsn - Return Label immediately following the instruction.
2519const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002520 return LabelsAfterInsn.lookup(MI);
Devang Patele717faa2009-10-06 01:26:37 +00002521}
2522
Devang Patelcbbe2872010-10-26 17:49:02 +00002523/// beginInstruction - Process beginning of an instruction.
2524void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00002525 // Check if source location changes, but ignore DBG_VALUE locations.
2526 if (!MI->isDebugValue()) {
2527 DebugLoc DL = MI->getDebugLoc();
2528 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
2529 PrevInstLoc = DL;
2530 if (!DL.isUnknown()) {
2531 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2532 recordSourceLine(DL.getLine(), DL.getCol(), Scope);
2533 } else
2534 recordSourceLine(0, 0, 0);
2535 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002536 }
Devang Patelaead63c2010-03-29 22:59:58 +00002537
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00002538 // Insert labels where requested.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002539 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
2540 LabelsBeforeInsn.find(MI);
2541
2542 // No label needed.
2543 if (I == LabelsBeforeInsn.end())
2544 return;
2545
2546 // Label already assigned.
2547 if (I->second)
Devang Patelb2b31a62010-05-26 19:37:24 +00002548 return;
Devang Patel553881b2010-03-29 17:20:31 +00002549
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00002550 if (!PrevLabel) {
Devang Patel77051f52010-05-26 21:23:46 +00002551 PrevLabel = MMI->getContext().CreateTempSymbol();
2552 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00002553 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002554 I->second = PrevLabel;
Devang Patel0d20ac82009-10-06 01:50:42 +00002555}
2556
Devang Patelcbbe2872010-10-26 17:49:02 +00002557/// endInstruction - Process end of an instruction.
2558void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00002559 // Don't create a new label after DBG_VALUE instructions.
2560 // They don't generate code.
2561 if (!MI->isDebugValue())
2562 PrevLabel = 0;
2563
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002564 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
2565 LabelsAfterInsn.find(MI);
2566
2567 // No label needed.
2568 if (I == LabelsAfterInsn.end())
2569 return;
2570
2571 // Label already assigned.
2572 if (I->second)
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00002573 return;
2574
2575 // We need a label after this instruction.
2576 if (!PrevLabel) {
2577 PrevLabel = MMI->getContext().CreateTempSymbol();
2578 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel1c246352010-04-08 16:50:29 +00002579 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002580 I->second = PrevLabel;
Devang Patel53bb5c92009-11-10 23:06:00 +00002581}
2582
Devang Pateleac9c072010-04-27 19:46:33 +00002583/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002584DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel61409622010-07-07 20:12:52 +00002585 const MDNode *InlinedAt) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002586 if (!InlinedAt) {
2587 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2588 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002589 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002590 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2591 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Pateleac9c072010-04-27 19:46:33 +00002592 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002593 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002594 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Pateleac9c072010-04-27 19:46:33 +00002595 WScope->setParent(Parent);
2596 Parent->addScope(WScope);
2597 }
2598
2599 if (!WScope->getParent()) {
2600 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastingscad22ad2010-06-15 23:06:30 +00002601 // We used to check only for a linkage name, but that fails
2602 // since we began omitting the linkage name for private
2603 // functions. The new way is to check for the name in metadata,
2604 // but that's not supported in old .ll test cases. Ergo, we
2605 // check both.
Stuart Hastings215aa152010-06-11 20:08:44 +00002606 if (SPName == Asm->MF->getFunction()->getName() ||
2607 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Pateleac9c072010-04-27 19:46:33 +00002608 CurrentFnDbgScope = WScope;
2609 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002610
Devang Pateleac9c072010-04-27 19:46:33 +00002611 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002612 }
2613
Devang Patel78e127d2010-06-25 22:07:34 +00002614 getOrCreateAbstractScope(Scope);
Devang Patel53bb5c92009-11-10 23:06:00 +00002615 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2616 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002617 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002618
2619 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2620 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2621 DILocation DL(InlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002622 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002623 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Pateleac9c072010-04-27 19:46:33 +00002624 WScope->setParent(Parent);
2625 Parent->addScope(WScope);
2626
2627 ConcreteScopes[InlinedAt] = WScope;
Devang Pateleac9c072010-04-27 19:46:33 +00002628
2629 return WScope;
Devang Patel0d20ac82009-10-06 01:50:42 +00002630}
2631
Devang Pateleac9c072010-04-27 19:46:33 +00002632/// hasValidLocation - Return true if debug location entry attached with
2633/// machine instruction encodes valid location info.
2634static bool hasValidLocation(LLVMContext &Ctx,
2635 const MachineInstr *MInsn,
Devang Patele9f8f5e2010-05-07 20:54:48 +00002636 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Pateleac9c072010-04-27 19:46:33 +00002637 DebugLoc DL = MInsn->getDebugLoc();
2638 if (DL.isUnknown()) return false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002639
Devang Patele9f8f5e2010-05-07 20:54:48 +00002640 const MDNode *S = DL.getScope(Ctx);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002641
Devang Pateleac9c072010-04-27 19:46:33 +00002642 // There is no need to create another DIE for compile unit. For all
2643 // other scopes, create one DbgScope now. This will be translated
2644 // into a scope DIE at the end.
2645 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002646
Devang Pateleac9c072010-04-27 19:46:33 +00002647 Scope = S;
2648 InlinedAt = DL.getInlinedAt(Ctx);
2649 return true;
2650}
2651
2652/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2653/// hierarchy.
2654static void calculateDominanceGraph(DbgScope *Scope) {
2655 assert (Scope && "Unable to calculate scop edominance graph!");
2656 SmallVector<DbgScope *, 4> WorkStack;
2657 WorkStack.push_back(Scope);
2658 unsigned Counter = 0;
2659 while (!WorkStack.empty()) {
2660 DbgScope *WS = WorkStack.back();
2661 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2662 bool visitedChildren = false;
2663 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2664 SE = Children.end(); SI != SE; ++SI) {
2665 DbgScope *ChildScope = *SI;
2666 if (!ChildScope->getDFSOut()) {
2667 WorkStack.push_back(ChildScope);
2668 visitedChildren = true;
2669 ChildScope->setDFSIn(++Counter);
2670 break;
2671 }
2672 }
2673 if (!visitedChildren) {
2674 WorkStack.pop_back();
2675 WS->setDFSOut(++Counter);
2676 }
2677 }
2678}
2679
2680/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002681static
Devang Pateleac9c072010-04-27 19:46:33 +00002682void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2683 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2684{
2685#ifndef NDEBUG
2686 unsigned PrevDFSIn = 0;
2687 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2688 I != E; ++I) {
2689 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2690 II != IE; ++II) {
2691 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002692 const MDNode *Scope = NULL;
2693 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002694
2695 // Check if instruction has valid location information.
2696 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2697 dbgs() << " [ ";
Jim Grosbach1e20b962010-07-21 21:21:52 +00002698 if (InlinedAt)
Devang Pateleac9c072010-04-27 19:46:33 +00002699 dbgs() << "*";
Jim Grosbach1e20b962010-07-21 21:21:52 +00002700 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Pateleac9c072010-04-27 19:46:33 +00002701 MI2ScopeMap.find(MInsn);
2702 if (DI != MI2ScopeMap.end()) {
2703 DbgScope *S = DI->second;
2704 dbgs() << S->getDFSIn();
2705 PrevDFSIn = S->getDFSIn();
2706 } else
2707 dbgs() << PrevDFSIn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002708 } else
Devang Pateleac9c072010-04-27 19:46:33 +00002709 dbgs() << " [ x" << PrevDFSIn;
2710 dbgs() << " ]";
2711 MInsn->dump();
2712 }
2713 dbgs() << "\n";
2714 }
2715#endif
2716}
Devang Patel2c4ceb12009-11-21 02:48:08 +00002717/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner14d750d2010-03-31 05:39:57 +00002718/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattnereec791a2010-01-26 23:18:02 +00002719bool DwarfDebug::extractScopeInformation() {
Devang Patelaf9e8472009-10-01 20:31:14 +00002720 // If scope information was extracted using .dbg intrinsics then there is not
2721 // any need to extract these information by scanning each instruction.
2722 if (!DbgScopeMap.empty())
2723 return false;
2724
Dan Gohman314bf7c2010-04-23 01:18:53 +00002725 // Scan each instruction and create scopes. First build working set of scopes.
Devang Pateleac9c072010-04-27 19:46:33 +00002726 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2727 SmallVector<DbgRange, 4> MIRanges;
2728 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002729 const MDNode *PrevScope = NULL;
2730 const MDNode *PrevInlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002731 const MachineInstr *RangeBeginMI = NULL;
2732 const MachineInstr *PrevMI = NULL;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002733 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelaf9e8472009-10-01 20:31:14 +00002734 I != E; ++I) {
2735 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2736 II != IE; ++II) {
2737 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002738 const MDNode *Scope = NULL;
2739 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002740
2741 // Check if instruction has valid location information.
2742 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2743 PrevMI = MInsn;
2744 continue;
2745 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002746
Devang Pateleac9c072010-04-27 19:46:33 +00002747 // If scope has not changed then skip this instruction.
2748 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2749 PrevMI = MInsn;
2750 continue;
2751 }
2752
Devang Pateld3526ea2011-02-15 17:56:09 +00002753 // Ignore DBG_VALUE. It does not contribute any instruction in output.
2754 if (MInsn->isDebugValue())
2755 continue;
2756
Jim Grosbach1e20b962010-07-21 21:21:52 +00002757 if (RangeBeginMI) {
2758 // If we have alread seen a beginning of a instruction range and
Devang Pateleac9c072010-04-27 19:46:33 +00002759 // current instruction scope does not match scope of first instruction
2760 // in this range then create a new instruction range.
2761 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002762 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel61409622010-07-07 20:12:52 +00002763 PrevInlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002764 MIRanges.push_back(R);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002765 }
Devang Pateleac9c072010-04-27 19:46:33 +00002766
2767 // This is a beginning of a new instruction range.
2768 RangeBeginMI = MInsn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002769
Devang Pateleac9c072010-04-27 19:46:33 +00002770 // Reset previous markers.
2771 PrevMI = MInsn;
2772 PrevScope = Scope;
2773 PrevInlinedAt = InlinedAt;
Devang Patel53bb5c92009-11-10 23:06:00 +00002774 }
2775 }
2776
Devang Pateleac9c072010-04-27 19:46:33 +00002777 // Create last instruction range.
2778 if (RangeBeginMI && PrevMI && PrevScope) {
2779 DbgRange R(RangeBeginMI, PrevMI);
2780 MIRanges.push_back(R);
2781 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patelaf9e8472009-10-01 20:31:14 +00002782 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002783
Devang Patel344130e2010-01-04 20:44:00 +00002784 if (!CurrentFnDbgScope)
2785 return false;
2786
Devang Pateleac9c072010-04-27 19:46:33 +00002787 calculateDominanceGraph(CurrentFnDbgScope);
2788 if (PrintDbgScope)
2789 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2790
2791 // Find ranges of instructions covered by each DbgScope;
2792 DbgScope *PrevDbgScope = NULL;
2793 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2794 RE = MIRanges.end(); RI != RE; ++RI) {
2795 const DbgRange &R = *RI;
2796 DbgScope *S = MI2ScopeMap.lookup(R.first);
2797 assert (S && "Lost DbgScope for a machine instruction!");
2798 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2799 PrevDbgScope->closeInsnRange(S);
2800 S->openInsnRange(R.first);
2801 S->extendInsnRange(R.second);
2802 PrevDbgScope = S;
2803 }
2804
2805 if (PrevDbgScope)
2806 PrevDbgScope->closeInsnRange();
Devang Patelaf9e8472009-10-01 20:31:14 +00002807
Devang Patele37b0c62010-04-08 18:43:56 +00002808 identifyScopeMarkers();
Devang Patel6122a4d2010-04-08 15:37:09 +00002809
2810 return !DbgScopeMap.empty();
2811}
2812
Jim Grosbach1e20b962010-07-21 21:21:52 +00002813/// identifyScopeMarkers() -
Devang Pateleac9c072010-04-27 19:46:33 +00002814/// Each DbgScope has first instruction and last instruction to mark beginning
2815/// and end of a scope respectively. Create an inverse map that list scopes
2816/// starts (and ends) with an instruction. One instruction may start (or end)
2817/// multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00002818void DwarfDebug::identifyScopeMarkers() {
Devang Patel42aafd72010-01-20 02:05:23 +00002819 SmallVector<DbgScope *, 4> WorkList;
2820 WorkList.push_back(CurrentFnDbgScope);
2821 while (!WorkList.empty()) {
Chris Lattner14d750d2010-03-31 05:39:57 +00002822 DbgScope *S = WorkList.pop_back_val();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002823
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002824 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002825 if (!Children.empty())
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002826 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00002827 SE = Children.end(); SI != SE; ++SI)
2828 WorkList.push_back(*SI);
2829
Devang Patel53bb5c92009-11-10 23:06:00 +00002830 if (S->isAbstractScope())
2831 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002832
Devang Pateleac9c072010-04-27 19:46:33 +00002833 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2834 if (Ranges.empty())
2835 continue;
2836 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2837 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002838 assert(RI->first && "DbgRange does not have first instruction!");
2839 assert(RI->second && "DbgRange does not have second instruction!");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002840 requestLabelBeforeInsn(RI->first);
2841 requestLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00002842 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002843 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002844}
2845
Dan Gohman084751c2010-04-20 00:37:27 +00002846/// FindFirstDebugLoc - Find the first debug location in the function. This
2847/// is intended to be an approximation for the source position of the
2848/// beginning of the function.
2849static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2850 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2851 I != E; ++I)
2852 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2853 MBBI != MBBE; ++MBBI) {
2854 DebugLoc DL = MBBI->getDebugLoc();
2855 if (!DL.isUnknown())
2856 return DL;
2857 }
2858 return DebugLoc();
2859}
2860
Devang Patel9a31f0f2010-10-25 20:45:32 +00002861#ifndef NDEBUG
2862/// CheckLineNumbers - Count basicblocks whose instructions do not have any
2863/// line number information.
2864static void CheckLineNumbers(const MachineFunction *MF) {
2865 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2866 I != E; ++I) {
2867 bool FoundLineNo = false;
2868 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2869 II != IE; ++II) {
2870 const MachineInstr *MI = II;
2871 if (!MI->getDebugLoc().isUnknown()) {
2872 FoundLineNo = true;
2873 break;
2874 }
2875 }
Devang Patel4d7f9a02010-10-28 22:11:59 +00002876 if (!FoundLineNo && I->size())
Devang Patel9a31f0f2010-10-25 20:45:32 +00002877 ++BlocksWithoutLineNo;
2878 }
2879}
2880#endif
2881
Devang Patel2c4ceb12009-11-21 02:48:08 +00002882/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002883/// emitted immediately after the function entry point.
Chris Lattnereec791a2010-01-26 23:18:02 +00002884void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00002885 if (!MMI->hasDebugInfo()) return;
Bill Wendling5f017e82010-04-07 09:28:04 +00002886 if (!extractScopeInformation()) return;
Devang Patel60b35bd2009-10-06 18:37:31 +00002887
Devang Patel9a31f0f2010-10-25 20:45:32 +00002888#ifndef NDEBUG
2889 CheckLineNumbers(MF);
2890#endif
2891
Devang Pateleac9c072010-04-27 19:46:33 +00002892 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2893 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002894 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00002895 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002896
2897 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2898 // function.
Dan Gohman084751c2010-04-20 00:37:27 +00002899 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002900 if (FDL.isUnknown()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002901
Devang Patele9f8f5e2010-05-07 20:54:48 +00002902 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings0db42712010-07-19 23:56:30 +00002903 const MDNode *TheScope = 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002904
Chris Lattnerde4845c2010-04-02 19:42:39 +00002905 DISubprogram SP = getDISubprogram(Scope);
2906 unsigned Line, Col;
2907 if (SP.Verify()) {
2908 Line = SP.getLineNumber();
2909 Col = 0;
Stuart Hastings0db42712010-07-19 23:56:30 +00002910 TheScope = SP;
Chris Lattnerde4845c2010-04-02 19:42:39 +00002911 } else {
2912 Line = FDL.getLine();
2913 Col = FDL.getCol();
Stuart Hastings0db42712010-07-19 23:56:30 +00002914 TheScope = Scope;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002915 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002916
Stuart Hastings0db42712010-07-19 23:56:30 +00002917 recordSourceLine(Line, Col, TheScope);
Devang Patelb2b31a62010-05-26 19:37:24 +00002918
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002919 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
2920
Devang Patelb9abe9f2010-06-02 16:42:51 +00002921 /// ProcessedArgs - Collection of arguments already processed.
2922 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2923
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00002924 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
2925
2926 /// LiveUserVar - Map physreg numbers to the MDNode they contain.
2927 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
2928
Devang Patelb2b31a62010-05-26 19:37:24 +00002929 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002930 I != E; ++I) {
2931 bool AtBlockEntry = true;
Devang Patelb2b31a62010-05-26 19:37:24 +00002932 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2933 II != IE; ++II) {
2934 const MachineInstr *MI = II;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002935
Devang Patelb2b31a62010-05-26 19:37:24 +00002936 if (MI->isDebugValue()) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002937 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00002938
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002939 // Keep track of user variables.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00002940 const MDNode *Var =
2941 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002942
2943 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00002944 if (isDbgValueInDefinedReg(MI))
2945 LiveUserVar[MI->getOperand(0).getReg()] = Var;
2946
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002947 // Check the history of this variable.
2948 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
2949 if (History.empty()) {
2950 UserVariables.push_back(Var);
2951 // The first mention of a function argument gets the FunctionBeginSym
2952 // label, so arguments are visible when breaking at function entry.
2953 DIVariable DV(Var);
2954 if (DV.Verify() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
2955 DISubprogram(getDISubprogram(DV.getContext()))
2956 .describes(MF->getFunction()))
2957 LabelsBeforeInsn[MI] = FunctionBeginSym;
2958 } else {
2959 // We have seen this variable before. Try to coalesce DBG_VALUEs.
2960 const MachineInstr *Prev = History.back();
2961 if (Prev->isDebugValue()) {
2962 // Coalesce identical entries at the end of History.
2963 if (History.size() >= 2 &&
2964 Prev->isIdenticalTo(History[History.size() - 2]))
2965 History.pop_back();
2966
2967 // Terminate old register assignments that don't reach MI;
2968 MachineFunction::const_iterator PrevMBB = Prev->getParent();
2969 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
2970 isDbgValueInDefinedReg(Prev)) {
2971 // Previous register assignment needs to terminate at the end of
2972 // its basic block.
2973 MachineBasicBlock::const_iterator LastMI =
2974 PrevMBB->getLastNonDebugInstr();
2975 if (LastMI == PrevMBB->end())
2976 // Drop DBG_VALUE for empty range.
2977 History.pop_back();
2978 else {
2979 // Terminate after LastMI.
2980 History.push_back(LastMI);
2981 }
2982 }
2983 }
2984 }
2985 History.push_back(MI);
Devang Patelb2b31a62010-05-26 19:37:24 +00002986 } else {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00002987 // Not a DBG_VALUE instruction.
2988 if (!MI->isLabel())
2989 AtBlockEntry = false;
2990
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00002991 // Check if the instruction clobbers any registers with debug vars.
2992 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
2993 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
2994 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
2995 continue;
2996 for (const unsigned *AI = TRI->getOverlaps(MOI->getReg());
2997 unsigned Reg = *AI; ++AI) {
2998 const MDNode *Var = LiveUserVar[Reg];
2999 if (!Var)
3000 continue;
3001 // Reg is now clobbered.
3002 LiveUserVar[Reg] = 0;
3003
3004 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00003005 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
3006 if (HistI == DbgValues.end())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00003007 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00003008 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
3009 if (History.empty())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00003010 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00003011 const MachineInstr *Prev = History.back();
3012 // Sanity-check: Register assignments are terminated at the end of
3013 // their block.
3014 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
3015 continue;
3016 // Is the variable still in Reg?
3017 if (!isDbgValueInDefinedReg(Prev) ||
3018 Prev->getOperand(0).getReg() != Reg)
3019 continue;
3020 // Var is clobbered. Make sure the next instruction gets a label.
3021 History.push_back(MI);
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00003022 }
3023 }
Devang Patelb2b31a62010-05-26 19:37:24 +00003024 }
Devang Patelb2b31a62010-05-26 19:37:24 +00003025 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00003026 }
3027
3028 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
3029 I != E; ++I) {
3030 SmallVectorImpl<const MachineInstr*> &History = I->second;
3031 if (History.empty())
3032 continue;
3033
3034 // Make sure the final register assignments are terminated.
3035 const MachineInstr *Prev = History.back();
3036 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
3037 const MachineBasicBlock *PrevMBB = Prev->getParent();
3038 MachineBasicBlock::const_iterator LastMI = PrevMBB->getLastNonDebugInstr();
3039 if (LastMI == PrevMBB->end())
3040 // Drop DBG_VALUE for empty range.
3041 History.pop_back();
3042 else {
3043 // Terminate after LastMI.
3044 History.push_back(LastMI);
3045 }
3046 }
3047 // Request labels for the full history.
3048 for (unsigned i = 0, e = History.size(); i != e; ++i) {
3049 const MachineInstr *MI = History[i];
3050 if (MI->isDebugValue())
3051 requestLabelBeforeInsn(MI);
3052 else
3053 requestLabelAfterInsn(MI);
3054 }
3055 }
Devang Patelb2b31a62010-05-26 19:37:24 +00003056
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00003057 PrevInstLoc = DebugLoc();
Devang Patelb2b31a62010-05-26 19:37:24 +00003058 PrevLabel = FunctionBeginSym;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00003059}
3060
Devang Patel2c4ceb12009-11-21 02:48:08 +00003061/// endFunction - Gather and emit post-function debug information.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00003062///
Chris Lattnereec791a2010-01-26 23:18:02 +00003063void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendling5f017e82010-04-07 09:28:04 +00003064 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00003065
Devang Patel344130e2010-01-04 20:44:00 +00003066 if (CurrentFnDbgScope) {
Devang Patel65eb4822010-05-22 00:04:14 +00003067
Devang Patelc3f5f782010-05-25 23:40:22 +00003068 // Define end label for subprogram.
3069 FunctionEndSym = Asm->GetTempSymbol("func_end",
3070 Asm->getFunctionNumber());
3071 // Assumes in correct section after the entry point.
3072 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003073
Devang Patel78e127d2010-06-25 22:07:34 +00003074 SmallPtrSet<const MDNode *, 16> ProcessedVars;
3075 collectVariableInfo(MF, ProcessedVars);
Devang Patel65eb4822010-05-22 00:04:14 +00003076
Devang Patel344130e2010-01-04 20:44:00 +00003077 // Construct abstract scopes.
3078 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel78e127d2010-06-25 22:07:34 +00003079 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel78e127d2010-06-25 22:07:34 +00003080 DISubprogram SP((*AI)->getScopeNode());
3081 if (SP.Verify()) {
3082 // Collect info for variables that were optimized out.
3083 StringRef FName = SP.getLinkageName();
3084 if (FName.empty())
3085 FName = SP.getName();
Devang Patel62367042010-11-10 22:19:21 +00003086 if (NamedMDNode *NMD =
3087 getFnSpecificMDNode(*(MF->getFunction()->getParent()), FName)) {
Devang Patel78e127d2010-06-25 22:07:34 +00003088 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman872814a2010-07-21 18:54:18 +00003089 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel78e127d2010-06-25 22:07:34 +00003090 if (!DV || !ProcessedVars.insert(DV))
3091 continue;
Devang Patel1d68d212010-06-30 00:11:08 +00003092 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel78e127d2010-06-25 22:07:34 +00003093 if (Scope)
3094 Scope->addVariable(new DbgVariable(DV));
3095 }
3096 }
3097 }
Devang Patel90e19aa2010-06-30 01:40:11 +00003098 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
3099 constructScopeDIE(*AI);
Devang Patel78e127d2010-06-25 22:07:34 +00003100 }
Devang Patel61409622010-07-07 20:12:52 +00003101
Devang Patel9c488372010-05-04 06:15:30 +00003102 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003103
Devang Patel9c488372010-05-04 06:15:30 +00003104 if (!DisableFramePointerElim(*MF))
Jim Grosbach1e20b962010-07-21 21:21:52 +00003105 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel9c488372010-05-04 06:15:30 +00003106 dwarf::DW_FORM_flag, 1);
3107
3108
Chris Lattnerd38fee82010-04-05 00:13:49 +00003109 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel344130e2010-01-04 20:44:00 +00003110 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00003111 }
3112
Bill Wendlingf0fb9872009-05-20 23:19:06 +00003113 // Clear debug info
Devang Patelf54b8522010-01-19 01:26:02 +00003114 CurrentFnDbgScope = NULL;
Devang Patel0478c152011-03-01 22:58:55 +00003115 CurrentFnArguments.clear();
Devang Patel26c1e562010-05-20 16:36:41 +00003116 DbgVariableToFrameIndexMap.clear();
3117 VarToAbstractVarMap.clear();
3118 DbgVariableToDbgInstMap.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00003119 DeleteContainerSeconds(DbgScopeMap);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00003120 UserVariables.clear();
3121 DbgValues.clear();
Devang Patelf54b8522010-01-19 01:26:02 +00003122 ConcreteScopes.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00003123 DeleteContainerSeconds(AbstractScopes);
Devang Patelf54b8522010-01-19 01:26:02 +00003124 AbstractScopesList.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00003125 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00003126 LabelsBeforeInsn.clear();
3127 LabelsAfterInsn.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00003128 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00003129}
3130
Devang Patel26c1e562010-05-20 16:36:41 +00003131/// recordVariableFrameIndex - Record a variable's index.
3132void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
3133 assert (V && "Invalid DbgVariable!");
3134 DbgVariableToFrameIndexMap[V] = Index;
3135}
3136
3137/// findVariableFrameIndex - Return true if frame index for the variable
3138/// is found. Update FI to hold value of the index.
3139bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
3140 assert (V && "Invalid DbgVariable!");
3141 DenseMap<const DbgVariable *, int>::iterator I =
3142 DbgVariableToFrameIndexMap.find(V);
3143 if (I == DbgVariableToFrameIndexMap.end())
3144 return false;
3145 *FI = I->second;
3146 return true;
3147}
3148
Jim Grosbach1e20b962010-07-21 21:21:52 +00003149/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patelee432862010-05-20 19:57:06 +00003150/// instruction.
3151DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
3152 DbgScope *Scope = NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003153 LLVMContext &Ctx =
Devang Patelee432862010-05-20 19:57:06 +00003154 MInsn->getParent()->getParent()->getFunction()->getContext();
3155 DebugLoc DL = MInsn->getDebugLoc();
3156
Jim Grosbach1e20b962010-07-21 21:21:52 +00003157 if (DL.isUnknown())
Devang Patelee432862010-05-20 19:57:06 +00003158 return Scope;
3159
3160 if (const MDNode *IA = DL.getInlinedAt(Ctx))
3161 Scope = ConcreteScopes.lookup(IA);
3162 if (Scope == 0)
3163 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003164
Devang Patelee432862010-05-20 19:57:06 +00003165 return Scope;
3166}
3167
3168
Chris Lattnerc6087842010-03-09 04:54:43 +00003169/// recordSourceLine - Register a source line with debug info. Returns the
3170/// unique label that was emitted and which provides correspondence to
3171/// the source line list.
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00003172void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S){
Devang Patel65dbc902009-11-25 17:36:49 +00003173 StringRef Fn;
Devang Patel23670e52011-03-24 20:30:50 +00003174 StringRef Dir;
Dan Gohman1cc0d622010-05-05 23:41:32 +00003175 unsigned Src = 1;
3176 if (S) {
3177 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00003178
Dan Gohman1cc0d622010-05-05 23:41:32 +00003179 if (Scope.isCompileUnit()) {
3180 DICompileUnit CU(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00003181 Fn = CU.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00003182 Dir = CU.getDirectory();
Devang Patel3cabc9d2010-10-28 17:30:52 +00003183 } else if (Scope.isFile()) {
3184 DIFile F(S);
Devang Patel3cabc9d2010-10-28 17:30:52 +00003185 Fn = F.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00003186 Dir = F.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00003187 } else if (Scope.isSubprogram()) {
3188 DISubprogram SP(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00003189 Fn = SP.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00003190 Dir = SP.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00003191 } else if (Scope.isLexicalBlock()) {
3192 DILexicalBlock DB(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00003193 Fn = DB.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00003194 Dir = DB.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00003195 } else
3196 assert(0 && "Unexpected scope info");
3197
Devang Patel23670e52011-03-24 20:30:50 +00003198 Src = GetOrCreateSourceID(Fn, Dir);
Dan Gohman1cc0d622010-05-05 23:41:32 +00003199 }
3200
Rafael Espindola5c055632010-11-18 02:04:25 +00003201 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, DWARF2_FLAG_IS_STMT,
3202 0, 0);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00003203}
3204
Bill Wendling829e67b2009-05-20 23:22:40 +00003205//===----------------------------------------------------------------------===//
3206// Emit Methods
3207//===----------------------------------------------------------------------===//
3208
Devang Patel2c4ceb12009-11-21 02:48:08 +00003209/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling94d04b82009-05-20 23:21:38 +00003210///
Jim Grosbach7ab38df2009-11-22 19:20:36 +00003211unsigned
3212DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003213 // Get the children.
3214 const std::vector<DIE *> &Children = Die->getChildren();
3215
3216 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00003217 if (!Last && !Children.empty())
Benjamin Kramer345ef342010-03-31 19:34:01 +00003218 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling94d04b82009-05-20 23:21:38 +00003219
3220 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003221 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00003222
3223 // Get the abbreviation for this DIE.
3224 unsigned AbbrevNumber = Die->getAbbrevNumber();
3225 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3226
3227 // Set DIE offset
3228 Die->setOffset(Offset);
3229
3230 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00003231 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00003232
3233 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
3234 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3235
3236 // Size the DIE attribute values.
3237 for (unsigned i = 0, N = Values.size(); i < N; ++i)
3238 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00003239 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00003240
3241 // Size the DIE children if any.
3242 if (!Children.empty()) {
3243 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
3244 "Children flag not set");
3245
3246 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00003247 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling94d04b82009-05-20 23:21:38 +00003248
3249 // End of children marker.
3250 Offset += sizeof(int8_t);
3251 }
3252
3253 Die->setSize(Offset - Die->getOffset());
3254 return Offset;
3255}
3256
Devang Patel2c4ceb12009-11-21 02:48:08 +00003257/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling94d04b82009-05-20 23:21:38 +00003258///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003259void DwarfDebug::computeSizeAndOffsets() {
Devang Patel163a9f72010-05-10 22:49:55 +00003260 unsigned PrevOffset = 0;
3261 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3262 E = CUMap.end(); I != E; ++I) {
3263 // Compute size of compile unit header.
3264 static unsigned Offset = PrevOffset +
3265 sizeof(int32_t) + // Length of Compilation Unit Info
3266 sizeof(int16_t) + // DWARF version number
3267 sizeof(int32_t) + // Offset Into Abbrev. Section
3268 sizeof(int8_t); // Pointer Size (in bytes)
3269 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
3270 PrevOffset = Offset;
3271 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003272}
3273
Chris Lattner11b8f302010-04-04 23:02:02 +00003274/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3275/// temporary label to it if SymbolStem is specified.
Chris Lattner9c69e285532010-04-04 22:59:04 +00003276static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner11b8f302010-04-04 23:02:02 +00003277 const char *SymbolStem = 0) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00003278 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner11b8f302010-04-04 23:02:02 +00003279 if (!SymbolStem) return 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003280
Chris Lattner9c69e285532010-04-04 22:59:04 +00003281 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3282 Asm->OutStreamer.EmitLabel(TmpSym);
3283 return TmpSym;
3284}
3285
3286/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3287/// the start of each one.
Chris Lattnerfa070b02010-04-04 22:33:59 +00003288void DwarfDebug::EmitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003289 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003290
Bill Wendling94d04b82009-05-20 23:21:38 +00003291 // Dwarf sections base addresses.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003292 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00003293 DwarfFrameSectionSym =
3294 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3295 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003296
Jim Grosbach1e20b962010-07-21 21:21:52 +00003297 DwarfInfoSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003298 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003299 DwarfAbbrevSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003300 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner11b8f302010-04-04 23:02:02 +00003301 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003302
Chris Lattner9c69e285532010-04-04 22:59:04 +00003303 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner11b8f302010-04-04 23:02:02 +00003304 EmitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003305
Devang Patelaf608bd2010-08-24 00:06:12 +00003306 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner11b8f302010-04-04 23:02:02 +00003307 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3308 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3309 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003310 DwarfStrSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003311 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patelf2548ca2010-04-16 23:33:45 +00003312 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3313 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00003314
Devang Patelc3f5f782010-05-25 23:40:22 +00003315 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3316 "section_debug_loc");
3317
Chris Lattner9c69e285532010-04-04 22:59:04 +00003318 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattner4ad1efe2010-04-04 23:10:38 +00003319 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003320}
3321
Devang Patel2c4ceb12009-11-21 02:48:08 +00003322/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling94d04b82009-05-20 23:21:38 +00003323///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003324void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003325 // Get the abbreviation for this DIE.
3326 unsigned AbbrevNumber = Die->getAbbrevNumber();
3327 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3328
Bill Wendling94d04b82009-05-20 23:21:38 +00003329 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00003330 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00003331 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3332 Twine::utohexstr(Die->getOffset()) + ":0x" +
3333 Twine::utohexstr(Die->getSize()) + " " +
3334 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003335 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00003336
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00003337 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling94d04b82009-05-20 23:21:38 +00003338 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3339
3340 // Emit the DIE attribute values.
3341 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3342 unsigned Attr = AbbrevData[i].getAttribute();
3343 unsigned Form = AbbrevData[i].getForm();
3344 assert(Form && "Too many attributes for DIE (check abbreviation)");
3345
Chris Lattner3f53c832010-04-04 18:52:31 +00003346 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00003347 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003348
Bill Wendling94d04b82009-05-20 23:21:38 +00003349 switch (Attr) {
3350 case dwarf::DW_AT_sibling:
Devang Patel2c4ceb12009-11-21 02:48:08 +00003351 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003352 break;
3353 case dwarf::DW_AT_abstract_origin: {
3354 DIEEntry *E = cast<DIEEntry>(Values[i]);
3355 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00003356 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00003357 Asm->EmitInt32(Addr);
3358 break;
3359 }
Devang Patelf2548ca2010-04-16 23:33:45 +00003360 case dwarf::DW_AT_ranges: {
3361 // DW_AT_range Value encodes offset in debug_range section.
3362 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelb1fcfbe2010-09-02 16:43:44 +00003363
3364 if (Asm->MAI->doesDwarfUsesLabelOffsetForRanges()) {
3365 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
3366 V->getValue(),
3367 4);
3368 } else {
3369 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3370 V->getValue(),
3371 DwarfDebugRangeSectionSym,
3372 4);
3373 }
Devang Patelf2548ca2010-04-16 23:33:45 +00003374 break;
3375 }
Devang Patelc3f5f782010-05-25 23:40:22 +00003376 case dwarf::DW_AT_location: {
3377 if (UseDotDebugLocEntry.count(Die) != 0) {
3378 DIELabel *L = cast<DIELabel>(Values[i]);
Daniel Dunbar83320a02011-03-16 22:16:39 +00003379 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Devang Patelc3f5f782010-05-25 23:40:22 +00003380 } else
3381 Values[i]->EmitValue(Asm, Form);
3382 break;
3383 }
Devang Patel2a361602010-09-29 19:08:08 +00003384 case dwarf::DW_AT_accessibility: {
3385 if (Asm->isVerbose()) {
3386 DIEInteger *V = cast<DIEInteger>(Values[i]);
3387 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
3388 }
3389 Values[i]->EmitValue(Asm, Form);
3390 break;
3391 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003392 default:
3393 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003394 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00003395 break;
3396 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003397 }
3398
3399 // Emit the DIE children if any.
3400 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3401 const std::vector<DIE *> &Children = Die->getChildren();
3402
3403 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00003404 emitDIE(Children[j]);
Bill Wendling94d04b82009-05-20 23:21:38 +00003405
Chris Lattner3f53c832010-04-04 18:52:31 +00003406 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00003407 Asm->OutStreamer.AddComment("End Of Children Mark");
3408 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003409 }
3410}
3411
Devang Patel8a241142009-12-09 18:24:21 +00003412/// emitDebugInfo - Emit the debug info section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003413///
Devang Patel8a241142009-12-09 18:24:21 +00003414void DwarfDebug::emitDebugInfo() {
3415 // Start debug info section.
3416 Asm->OutStreamer.SwitchSection(
3417 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel163a9f72010-05-10 22:49:55 +00003418 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3419 E = CUMap.end(); I != E; ++I) {
3420 CompileUnit *TheCU = I->second;
3421 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00003422
Devang Patel163a9f72010-05-10 22:49:55 +00003423 // Emit the compile units header.
3424 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3425 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003426
Devang Patel163a9f72010-05-10 22:49:55 +00003427 // Emit size of content not including length itself
3428 unsigned ContentSize = Die->getSize() +
3429 sizeof(int16_t) + // DWARF version number
3430 sizeof(int32_t) + // Offset Into Abbrev. Section
3431 sizeof(int8_t) + // Pointer Size (in bytes)
3432 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003433
Devang Patel163a9f72010-05-10 22:49:55 +00003434 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3435 Asm->EmitInt32(ContentSize);
3436 Asm->OutStreamer.AddComment("DWARF version number");
3437 Asm->EmitInt16(dwarf::DWARF_VERSION);
3438 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3439 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3440 DwarfAbbrevSectionSym);
3441 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3442 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003443
Devang Patel163a9f72010-05-10 22:49:55 +00003444 emitDIE(Die);
3445 // FIXME - extra padding for gdb bug.
3446 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3447 Asm->EmitInt8(0);
3448 Asm->EmitInt8(0);
3449 Asm->EmitInt8(0);
3450 Asm->EmitInt8(0);
3451 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3452 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003453}
3454
Devang Patel2c4ceb12009-11-21 02:48:08 +00003455/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003456///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003457void DwarfDebug::emitAbbreviations() const {
Bill Wendling94d04b82009-05-20 23:21:38 +00003458 // Check to see if it is worth the effort.
3459 if (!Abbreviations.empty()) {
3460 // Start the debug abbrev section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003461 Asm->OutStreamer.SwitchSection(
3462 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003463
Chris Lattnerc0215722010-04-04 19:25:43 +00003464 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003465
3466 // For each abbrevation.
3467 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3468 // Get abbreviation data
3469 const DIEAbbrev *Abbrev = Abbreviations[i];
3470
3471 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003472 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00003473
3474 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003475 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00003476 }
3477
3478 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003479 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00003480
Chris Lattnerc0215722010-04-04 19:25:43 +00003481 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003482 }
3483}
3484
Devang Patel2c4ceb12009-11-21 02:48:08 +00003485/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling94d04b82009-05-20 23:21:38 +00003486/// the line matrix.
3487///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003488void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003489 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00003490 Asm->OutStreamer.AddComment("Extended Op");
3491 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003492
Chris Lattner233f52b2010-03-09 23:52:58 +00003493 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003494 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003495 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3496 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3497
3498 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00003499
Chris Lattnerc0215722010-04-04 19:25:43 +00003500 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003501 Asm->getTargetData().getPointerSize(),
3502 0/*AddrSpace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003503
3504 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00003505 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3506 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00003507 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00003508 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003509}
3510
Devang Patel2c4ceb12009-11-21 02:48:08 +00003511/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003512///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003513void DwarfDebug::emitCommonDebugFrame() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003514 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003515 return;
3516
Chris Lattnerd38fee82010-04-05 00:13:49 +00003517 int stackGrowth = Asm->getTargetData().getPointerSize();
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00003518 if (Asm->TM.getFrameLowering()->getStackGrowthDirection() ==
3519 TargetFrameLowering::StackGrowsDown)
Chris Lattnerd38fee82010-04-05 00:13:49 +00003520 stackGrowth *= -1;
Bill Wendling94d04b82009-05-20 23:21:38 +00003521
3522 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003523 Asm->OutStreamer.SwitchSection(
3524 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003525
Chris Lattnerc0215722010-04-04 19:25:43 +00003526 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003527 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003528 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3529 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003530
Chris Lattnerc0215722010-04-04 19:25:43 +00003531 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003532 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling94d04b82009-05-20 23:21:38 +00003533 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner233f52b2010-03-09 23:52:58 +00003534 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling94d04b82009-05-20 23:21:38 +00003535 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner233f52b2010-03-09 23:52:58 +00003536 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003537 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003538 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3539 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner233f52b2010-03-09 23:52:58 +00003540 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003541 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00003542 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
Bill Wendling94d04b82009-05-20 23:21:38 +00003543 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling94d04b82009-05-20 23:21:38 +00003544
3545 std::vector<MachineMove> Moves;
Anton Korobeynikovd9e33852010-11-18 23:25:52 +00003546 TFI->getInitialFrameState(Moves);
Bill Wendling94d04b82009-05-20 23:21:38 +00003547
Chris Lattner02b86b92010-04-04 23:41:46 +00003548 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003549
Chris Lattner059ea132010-04-28 01:05:45 +00003550 Asm->EmitAlignment(2);
Chris Lattnerc0215722010-04-04 19:25:43 +00003551 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003552}
3553
Devang Patel2c4ceb12009-11-21 02:48:08 +00003554/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling94d04b82009-05-20 23:21:38 +00003555/// section.
Chris Lattner206d61e2010-03-13 07:26:18 +00003556void DwarfDebug::
3557emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003558 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003559 return;
3560
3561 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003562 Asm->OutStreamer.SwitchSection(
3563 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003564
Chris Lattner233f52b2010-03-09 23:52:58 +00003565 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner206d61e2010-03-13 07:26:18 +00003566 MCSymbol *DebugFrameBegin =
Chris Lattnerc0215722010-04-04 19:25:43 +00003567 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner206d61e2010-03-13 07:26:18 +00003568 MCSymbol *DebugFrameEnd =
Chris Lattnerc0215722010-04-04 19:25:43 +00003569 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnera6437182010-04-04 19:58:12 +00003570 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003571
Chris Lattner206d61e2010-03-13 07:26:18 +00003572 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling94d04b82009-05-20 23:21:38 +00003573
Chris Lattner233f52b2010-03-09 23:52:58 +00003574 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003575 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner6189ed12010-04-04 23:25:33 +00003576 DwarfFrameSectionSym);
Bill Wendling94d04b82009-05-20 23:21:38 +00003577
Chris Lattner233f52b2010-03-09 23:52:58 +00003578 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnerc0215722010-04-04 19:25:43 +00003579 MCSymbol *FuncBeginSym =
3580 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattnerfb658072010-03-13 07:40:56 +00003581 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattnerd38fee82010-04-05 00:13:49 +00003582 Asm->getTargetData().getPointerSize(),
3583 0/*AddrSpace*/);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003584
3585
Chris Lattner233f52b2010-03-09 23:52:58 +00003586 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnera6437182010-04-04 19:58:12 +00003587 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003588 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003589
Chris Lattner02b86b92010-04-04 23:41:46 +00003590 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003591
Chris Lattner059ea132010-04-28 01:05:45 +00003592 Asm->EmitAlignment(2);
Chris Lattner206d61e2010-03-13 07:26:18 +00003593 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling94d04b82009-05-20 23:21:38 +00003594}
3595
Devang Patel8a241142009-12-09 18:24:21 +00003596/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3597///
3598void DwarfDebug::emitDebugPubNames() {
Devang Patel163a9f72010-05-10 22:49:55 +00003599 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3600 E = CUMap.end(); I != E; ++I) {
3601 CompileUnit *TheCU = I->second;
3602 // Start the dwarf pubnames section.
3603 Asm->OutStreamer.SwitchSection(
3604 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003605
Devang Patel163a9f72010-05-10 22:49:55 +00003606 Asm->OutStreamer.AddComment("Length of Public Names Info");
3607 Asm->EmitLabelDifference(
3608 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3609 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003610
Devang Patel163a9f72010-05-10 22:49:55 +00003611 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3612 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003613
Devang Patel163a9f72010-05-10 22:49:55 +00003614 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003615 Asm->EmitInt16(dwarf::DWARF_VERSION);
3616
Devang Patel163a9f72010-05-10 22:49:55 +00003617 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003618 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel163a9f72010-05-10 22:49:55 +00003619 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003620
Devang Patel163a9f72010-05-10 22:49:55 +00003621 Asm->OutStreamer.AddComment("Compilation Unit Length");
3622 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3623 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3624 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003625
Devang Patel163a9f72010-05-10 22:49:55 +00003626 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3627 for (StringMap<DIE*>::const_iterator
3628 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3629 const char *Name = GI->getKeyData();
3630 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003631
Devang Patel163a9f72010-05-10 22:49:55 +00003632 Asm->OutStreamer.AddComment("DIE offset");
3633 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003634
Devang Patel163a9f72010-05-10 22:49:55 +00003635 if (Asm->isVerbose())
3636 Asm->OutStreamer.AddComment("External Name");
3637 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3638 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00003639
Devang Patel163a9f72010-05-10 22:49:55 +00003640 Asm->OutStreamer.AddComment("End Mark");
3641 Asm->EmitInt32(0);
3642 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3643 TheCU->getID()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003644 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003645}
3646
Devang Patel193f7202009-11-24 01:14:22 +00003647void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00003648 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3649 E = CUMap.end(); I != E; ++I) {
3650 CompileUnit *TheCU = I->second;
3651 // Start the dwarf pubnames section.
3652 Asm->OutStreamer.SwitchSection(
3653 Asm->getObjFileLowering().getDwarfPubTypesSection());
3654 Asm->OutStreamer.AddComment("Length of Public Types Info");
3655 Asm->EmitLabelDifference(
3656 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3657 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003658
Devang Patel163a9f72010-05-10 22:49:55 +00003659 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3660 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003661
Devang Patel163a9f72010-05-10 22:49:55 +00003662 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3663 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003664
Devang Patel163a9f72010-05-10 22:49:55 +00003665 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3666 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3667 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003668
Devang Patel163a9f72010-05-10 22:49:55 +00003669 Asm->OutStreamer.AddComment("Compilation Unit Length");
3670 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3671 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3672 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003673
Devang Patel163a9f72010-05-10 22:49:55 +00003674 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3675 for (StringMap<DIE*>::const_iterator
3676 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3677 const char *Name = GI->getKeyData();
3678 DIE * Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003679
Devang Patel163a9f72010-05-10 22:49:55 +00003680 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3681 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003682
Devang Patel163a9f72010-05-10 22:49:55 +00003683 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3684 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3685 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00003686
Devang Patel163a9f72010-05-10 22:49:55 +00003687 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003688 Asm->EmitInt32(0);
Devang Patel163a9f72010-05-10 22:49:55 +00003689 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3690 TheCU->getID()));
Devang Patel193f7202009-11-24 01:14:22 +00003691 }
Devang Patel193f7202009-11-24 01:14:22 +00003692}
3693
Devang Patel2c4ceb12009-11-21 02:48:08 +00003694/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003695///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003696void DwarfDebug::emitDebugStr() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003697 // Check to see if it is worth the effort.
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003698 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003699
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003700 // Start the dwarf str section.
3701 Asm->OutStreamer.SwitchSection(
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003702 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003703
Chris Lattnerbc733f52010-03-13 02:17:42 +00003704 // Get all of the string pool entries and put them in an array by their ID so
3705 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003706 SmallVector<std::pair<unsigned,
Chris Lattnerbc733f52010-03-13 02:17:42 +00003707 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003708
Chris Lattnerbc733f52010-03-13 02:17:42 +00003709 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3710 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3711 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003712
Chris Lattnerbc733f52010-03-13 02:17:42 +00003713 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003714
Chris Lattnerbc733f52010-03-13 02:17:42 +00003715 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003716 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003717 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003718
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003719 // Emit the string itself.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003720 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003721 }
3722}
3723
Devang Patel2c4ceb12009-11-21 02:48:08 +00003724/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003725///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003726void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00003727 if (DotDebugLocEntries.empty())
3728 return;
3729
Devang Patel6c3ea902011-02-04 22:57:18 +00003730 for (SmallVector<DotDebugLocEntry, 4>::iterator
3731 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
3732 I != E; ++I) {
3733 DotDebugLocEntry &Entry = *I;
3734 if (I + 1 != DotDebugLocEntries.end())
3735 Entry.Merge(I+1);
3736 }
3737
Daniel Dunbar83320a02011-03-16 22:16:39 +00003738 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003739 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00003740 Asm->getObjFileLowering().getDwarfLocSection());
3741 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00003742 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3743 unsigned index = 1;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003744 for (SmallVector<DotDebugLocEntry, 4>::iterator
3745 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00003746 I != E; ++I, ++index) {
Devang Patel6c3ea902011-02-04 22:57:18 +00003747 DotDebugLocEntry &Entry = *I;
3748 if (Entry.isMerged()) continue;
Devang Patelc3f5f782010-05-25 23:40:22 +00003749 if (Entry.isEmpty()) {
3750 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3751 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel80250682010-05-26 23:55:23 +00003752 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00003753 } else {
3754 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3755 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3756 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3757 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patelb2cf5812010-08-04 18:40:52 +00003758 if (int Offset = Entry.Loc.getOffset()) {
3759 // If the value is at a certain offset from frame register then
3760 // use DW_OP_fbreg.
3761 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patelc3f5f782010-05-25 23:40:22 +00003762 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patelb2cf5812010-08-04 18:40:52 +00003763 Asm->EmitInt16(1 + OffsetSize);
3764 Asm->OutStreamer.AddComment(
3765 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3766 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3767 Asm->OutStreamer.AddComment("Offset");
3768 Asm->EmitSLEB128(Offset);
Devang Patelc3f5f782010-05-25 23:40:22 +00003769 } else {
Devang Patelb2cf5812010-08-04 18:40:52 +00003770 if (Reg < 32) {
3771 Asm->OutStreamer.AddComment("Loc expr size");
3772 Asm->EmitInt16(1);
3773 Asm->OutStreamer.AddComment(
Devang Patela54e0cc2010-08-04 20:32:36 +00003774 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patelb2cf5812010-08-04 18:40:52 +00003775 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3776 } else {
3777 Asm->OutStreamer.AddComment("Loc expr size");
3778 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3779 Asm->EmitInt8(dwarf::DW_OP_regx);
3780 Asm->EmitULEB128(Reg);
3781 }
Devang Patelc3f5f782010-05-25 23:40:22 +00003782 }
3783 }
3784 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003785}
3786
3787/// EmitDebugARanges - Emit visible names into a debug aranges section.
3788///
3789void DwarfDebug::EmitDebugARanges() {
3790 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003791 Asm->OutStreamer.SwitchSection(
3792 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003793}
3794
Devang Patel2c4ceb12009-11-21 02:48:08 +00003795/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003796///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003797void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003798 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003799 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00003800 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Pateleac9c072010-04-27 19:46:33 +00003801 unsigned char Size = Asm->getTargetData().getPointerSize();
3802 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00003803 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00003804 I != E; ++I) {
3805 if (*I)
3806 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003807 else
Devang Pateleac9c072010-04-27 19:46:33 +00003808 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003809 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003810}
3811
Devang Patel2c4ceb12009-11-21 02:48:08 +00003812/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003813///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003814void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003815 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00003816 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003817 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003818 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003819 }
3820}
3821
Devang Patel2c4ceb12009-11-21 02:48:08 +00003822/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling94d04b82009-05-20 23:21:38 +00003823/// Section Header:
3824/// 1. length of section
3825/// 2. Dwarf version number
3826/// 3. address size.
3827///
3828/// Entries (one "entry" for each function that was inlined):
3829///
3830/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3831/// otherwise offset into __debug_str for regular function name.
3832/// 2. offset into __debug_str section for regular function name.
3833/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3834/// instances for the function.
3835///
3836/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3837/// inlined instance; the die_offset points to the inlined_subroutine die in the
3838/// __debug_info section, and the low_pc is the starting address for the
3839/// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003840void DwarfDebug::emitDebugInlineInfo() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003841 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003842 return;
3843
Devang Patel163a9f72010-05-10 22:49:55 +00003844 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00003845 return;
3846
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003847 Asm->OutStreamer.SwitchSection(
3848 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00003849
Chris Lattner233f52b2010-03-09 23:52:58 +00003850 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003851 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3852 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003853
Chris Lattnerc0215722010-04-04 19:25:43 +00003854 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003855
Chris Lattner233f52b2010-03-09 23:52:58 +00003856 Asm->OutStreamer.AddComment("Dwarf Version");
3857 Asm->EmitInt16(dwarf::DWARF_VERSION);
3858 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003859 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003860
Devang Patele9f8f5e2010-05-07 20:54:48 +00003861 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00003862 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00003863
Devang Patele9f8f5e2010-05-07 20:54:48 +00003864 const MDNode *Node = *I;
3865 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach7ab38df2009-11-22 19:20:36 +00003866 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00003867 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00003868 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00003869 StringRef LName = SP.getLinkageName();
3870 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00003871
Chris Lattner233f52b2010-03-09 23:52:58 +00003872 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003873 if (LName.empty()) {
3874 Asm->OutStreamer.EmitBytes(Name, 0);
3875 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003876 } else
Chris Lattner6189ed12010-04-04 23:25:33 +00003877 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3878 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00003879
Chris Lattner233f52b2010-03-09 23:52:58 +00003880 Asm->OutStreamer.AddComment("Function name");
Chris Lattner6189ed12010-04-04 23:25:33 +00003881 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003882 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00003883
Devang Patel53bb5c92009-11-10 23:06:00 +00003884 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00003885 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00003886 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00003887 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003888
Chris Lattner3f53c832010-04-04 18:52:31 +00003889 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003890 Asm->OutStreamer.EmitSymbolValue(LI->first,
3891 Asm->getTargetData().getPointerSize(),0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003892 }
3893 }
3894
Chris Lattnerc0215722010-04-04 19:25:43 +00003895 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003896}