blob: 36b9d75539f4ce9dfb0099e40df5ff8004bff5d7 [file] [log] [blame]
Bill Wendling0310d762009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Chris Lattner6cde3e62010-03-09 00:39:24 +000013
Devang Patele4b27562009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling0310d762009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner74e41f92010-04-05 05:24:55 +000016#include "DIE.h"
Bill Wendling57fbba42010-04-05 22:59:21 +000017#include "llvm/Constants.h"
Bill Wendling0310d762009-05-15 09:23:25 +000018#include "llvm/Module.h"
David Greeneb2c66fc2009-08-19 21:52:55 +000019#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling0310d762009-05-15 09:23:25 +000020#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000021#include "llvm/MC/MCAsmInfo.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000022#include "llvm/MC/MCSection.h"
Chris Lattner6c2f9e12009-08-19 05:49:37 +000023#include "llvm/MC/MCStreamer.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000024#include "llvm/MC/MCSymbol.h"
Chris Lattner45111d12010-01-16 21:57:06 +000025#include "llvm/Target/Mangler.h"
Bill Wendling0310d762009-05-15 09:23:25 +000026#include "llvm/Target/TargetData.h"
27#include "llvm/Target/TargetFrameInfo.h"
Chris Lattnerf0144122009-07-28 03:13:23 +000028#include "llvm/Target/TargetLoweringObjectFile.h"
Chris Lattner9d1c1ad2010-04-04 18:06:11 +000029#include "llvm/Target/TargetMachine.h"
Chris Lattnerf0144122009-07-28 03:13:23 +000030#include "llvm/Target/TargetRegisterInfo.h"
Devang Patel2a4a3b72010-04-19 19:14:02 +000031#include "llvm/Target/TargetOptions.h"
Chris Lattner74e41f92010-04-05 05:24:55 +000032#include "llvm/Analysis/DebugInfo.h"
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +000033#include "llvm/ADT/STLExtras.h"
Chris Lattner23132b12009-08-24 03:52:50 +000034#include "llvm/ADT/StringExtras.h"
Devang Pateleac9c072010-04-27 19:46:33 +000035#include "llvm/Support/CommandLine.h"
Daniel Dunbar6e4bdfc2009-10-13 06:47:08 +000036#include "llvm/Support/Debug.h"
37#include "llvm/Support/ErrorHandling.h"
Devang Patel3139fcf2010-01-26 21:39:14 +000038#include "llvm/Support/ValueHandle.h"
Chris Lattner0ad9c912010-01-22 22:09:00 +000039#include "llvm/Support/FormattedStream.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000040#include "llvm/Support/Timer.h"
41#include "llvm/System/Path.h"
Bill Wendling0310d762009-05-15 09:23:25 +000042using namespace llvm;
43
Devang Pateleac9c072010-04-27 19:46:33 +000044static cl::opt<bool> PrintDbgScope("print-dbgscope", cl::Hidden,
45 cl::desc("Print DbgScope information for each machine instruction"));
46
Jim Grosbach1e20b962010-07-21 21:21:52 +000047static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel61409622010-07-07 20:12:52 +000048 cl::Hidden,
Devang Pateleac9c072010-04-27 19:46:33 +000049 cl::desc("Disable debug info printing"));
50
Dan Gohman281d65d2010-05-07 01:08:53 +000051static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
52 cl::desc("Make an absense of debug location information explicit."),
53 cl::init(false));
54
Bill Wendling5f017e82010-04-07 09:28:04 +000055namespace {
56 const char *DWARFGroupName = "DWARF Emission";
57 const char *DbgTimerName = "DWARF Debug Writer";
58} // end anonymous namespace
59
Bill Wendling0310d762009-05-15 09:23:25 +000060//===----------------------------------------------------------------------===//
61
62/// Configuration values for initial hash set sizes (log2).
63///
Bill Wendling0310d762009-05-15 09:23:25 +000064static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling0310d762009-05-15 09:23:25 +000065
66namespace llvm {
67
68//===----------------------------------------------------------------------===//
69/// CompileUnit - This dwarf writer support class manages information associate
70/// with a source file.
Nick Lewycky5f9843f2009-11-17 08:11:44 +000071class CompileUnit {
Bill Wendling0310d762009-05-15 09:23:25 +000072 /// ID - File identifier for source.
73 ///
74 unsigned ID;
75
76 /// Die - Compile unit debug information entry.
77 ///
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +000078 const OwningPtr<DIE> CUDie;
Bill Wendling0310d762009-05-15 09:23:25 +000079
Jeffrey Yasskind0f393d2010-03-11 18:29:55 +000080 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
Devang Patel6f01d9c2009-11-21 00:31:03 +000081 DIE *IndexTyDie;
82
Devang Patel869aa462010-07-07 20:49:57 +000083 /// MDNodeToDieMap - Tracks the mapping of unit level debug informaton
Bill Wendling0310d762009-05-15 09:23:25 +000084 /// variables to debug information entries.
Devang Patel869aa462010-07-07 20:49:57 +000085 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
Bill Wendling0310d762009-05-15 09:23:25 +000086
Devang Patel869aa462010-07-07 20:49:57 +000087 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug informaton
Bill Wendling0310d762009-05-15 09:23:25 +000088 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patel869aa462010-07-07 20:49:57 +000089 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
Bill Wendling0310d762009-05-15 09:23:25 +000090
91 /// Globals - A map of globally visible named entities for this unit.
92 ///
93 StringMap<DIE*> Globals;
94
Devang Patel193f7202009-11-24 01:14:22 +000095 /// GlobalTypes - A map of globally visible types for this unit.
96 ///
97 StringMap<DIE*> GlobalTypes;
98
Bill Wendling0310d762009-05-15 09:23:25 +000099public:
100 CompileUnit(unsigned I, DIE *D)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000101 : ID(I), CUDie(D), IndexTyDie(0) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000102
103 // Accessors.
Devang Patel193f7202009-11-24 01:14:22 +0000104 unsigned getID() const { return ID; }
Jeffrey Yasskind0f393d2010-03-11 18:29:55 +0000105 DIE* getCUDie() const { return CUDie.get(); }
Devang Patel193f7202009-11-24 01:14:22 +0000106 const StringMap<DIE*> &getGlobals() const { return Globals; }
107 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
Bill Wendling0310d762009-05-15 09:23:25 +0000108
109 /// hasContent - Return true if this compile unit has something to write out.
110 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000111 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendling0310d762009-05-15 09:23:25 +0000112
Devang Patel2c4ceb12009-11-21 02:48:08 +0000113 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendling0310d762009-05-15 09:23:25 +0000114 ///
Benjamin Kramerbbb88db2010-03-31 20:15:45 +0000115 void addGlobal(StringRef Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling0310d762009-05-15 09:23:25 +0000116
Devang Patel193f7202009-11-24 01:14:22 +0000117 /// addGlobalType - Add a new global type to the compile unit.
118 ///
Jim Grosbach1e20b962010-07-21 21:21:52 +0000119 void addGlobalType(StringRef Name, DIE *Die) {
120 GlobalTypes[Name] = Die;
Devang Patel193f7202009-11-24 01:14:22 +0000121 }
122
Devang Patel017d1212009-11-20 21:37:22 +0000123 /// getDIE - Returns the debug information entry map slot for the
Bill Wendling0310d762009-05-15 09:23:25 +0000124 /// specified debug variable.
Devang Patel869aa462010-07-07 20:49:57 +0000125 DIE *getDIE(const MDNode *N) { return MDNodeToDieMap.lookup(N); }
Jim Grosbach31ef40e2009-11-21 23:12:12 +0000126
Devang Patel017d1212009-11-20 21:37:22 +0000127 /// insertDIE - Insert DIE into the map.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000128 void insertDIE(const MDNode *N, DIE *D) {
Devang Patel869aa462010-07-07 20:49:57 +0000129 MDNodeToDieMap.insert(std::make_pair(N, D));
Devang Patel017d1212009-11-20 21:37:22 +0000130 }
Bill Wendling0310d762009-05-15 09:23:25 +0000131
Devang Patel017d1212009-11-20 21:37:22 +0000132 /// getDIEEntry - Returns the debug information entry for the speciefied
133 /// debug variable.
Jim Grosbach1e20b962010-07-21 21:21:52 +0000134 DIEEntry *getDIEEntry(const MDNode *N) {
135 DenseMap<const MDNode *, DIEEntry *>::iterator I =
136 MDNodeToDIEEntryMap.find(N);
Devang Patel869aa462010-07-07 20:49:57 +0000137 if (I == MDNodeToDIEEntryMap.end())
Devang Patel6404e4e2009-12-15 19:16:48 +0000138 return NULL;
139 return I->second;
140 }
Devang Patel017d1212009-11-20 21:37:22 +0000141
142 /// insertDIEEntry - Insert debug information entry into the map.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000143 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
Devang Patel869aa462010-07-07 20:49:57 +0000144 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
Bill Wendling0310d762009-05-15 09:23:25 +0000145 }
146
Devang Patel2c4ceb12009-11-21 02:48:08 +0000147 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendling0310d762009-05-15 09:23:25 +0000148 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000149 void addDie(DIE *Buffer) {
150 this->CUDie->addChild(Buffer);
Bill Wendling0310d762009-05-15 09:23:25 +0000151 }
Devang Patel6f01d9c2009-11-21 00:31:03 +0000152
153 // getIndexTyDie - Get an anonymous type for index type.
154 DIE *getIndexTyDie() {
155 return IndexTyDie;
156 }
157
Jim Grosbach7ab38df2009-11-22 19:20:36 +0000158 // setIndexTyDie - Set D as anonymous type for index which can be reused
159 // later.
Devang Patel6f01d9c2009-11-21 00:31:03 +0000160 void setIndexTyDie(DIE *D) {
161 IndexTyDie = D;
162 }
163
Bill Wendling0310d762009-05-15 09:23:25 +0000164};
165
166//===----------------------------------------------------------------------===//
167/// DbgVariable - This class is used to track local variable information.
168///
Devang Patelf76a3d62009-11-16 21:53:40 +0000169class DbgVariable {
Bill Wendling0310d762009-05-15 09:23:25 +0000170 DIVariable Var; // Variable Descriptor.
Devang Patelc3f5f782010-05-25 23:40:22 +0000171 DIE *TheDIE; // Variable DIE.
172 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
Bill Wendling0310d762009-05-15 09:23:25 +0000173public:
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000174 // AbsVar may be NULL.
Devang Patelc3f5f782010-05-25 23:40:22 +0000175 DbgVariable(DIVariable V) : Var(V), TheDIE(0), DotDebugLocOffset(~0U) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000176
177 // Accessors.
Devang Patel53bb5c92009-11-10 23:06:00 +0000178 DIVariable getVariable() const { return Var; }
Devang Patel53bb5c92009-11-10 23:06:00 +0000179 void setDIE(DIE *D) { TheDIE = D; }
180 DIE *getDIE() const { return TheDIE; }
Devang Patelc3f5f782010-05-25 23:40:22 +0000181 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
182 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
Devang Patel8bd11de2010-08-09 21:01:39 +0000183 StringRef getName() const { return Var.getName(); }
184 unsigned getTag() const { return Var.getTag(); }
185 bool variableHasComplexAddress() const {
186 assert(Var.Verify() && "Invalid complex DbgVariable!");
187 return Var.hasComplexAddress();
188 }
189 bool isBlockByrefVariable() const {
190 assert(Var.Verify() && "Invalid complex DbgVariable!");
191 return Var.isBlockByrefVariable();
192 }
193 unsigned getNumAddrElements() const {
194 assert(Var.Verify() && "Invalid complex DbgVariable!");
195 return Var.getNumAddrElements();
196 }
197 uint64_t getAddrElement(unsigned i) const {
198 return Var.getAddrElement(i);
199 }
200 DIType getType() const {
201 DIType Ty = Var.getType();
202 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
203 // addresses instead.
204 if (Var.isBlockByrefVariable()) {
205 /* Byref variables, in Blocks, are declared by the programmer as
206 "SomeType VarName;", but the compiler creates a
207 __Block_byref_x_VarName struct, and gives the variable VarName
208 either the struct, or a pointer to the struct, as its type. This
209 is necessary for various behind-the-scenes things the compiler
210 needs to do with by-reference variables in blocks.
211
212 However, as far as the original *programmer* is concerned, the
213 variable should still have type 'SomeType', as originally declared.
214
215 The following function dives into the __Block_byref_x_VarName
216 struct to find the original type of the variable. This will be
217 passed back to the code generating the type for the Debug
218 Information Entry for the variable 'VarName'. 'VarName' will then
219 have the original type 'SomeType' in its debug information.
220
221 The original type 'SomeType' will be the type of the field named
222 'VarName' inside the __Block_byref_x_VarName struct.
223
224 NOTE: In order for this to not completely fail on the debugger
225 side, the Debug Information Entry for the variable VarName needs to
226 have a DW_AT_location that tells the debugger how to unwind through
227 the pointers and __Block_byref_x_VarName struct to find the actual
228 value of the variable. The function addBlockByrefType does this. */
229 DIType subType = Ty;
230 unsigned tag = Ty.getTag();
231
232 if (tag == dwarf::DW_TAG_pointer_type) {
233 DIDerivedType DTy = DIDerivedType(Ty);
234 subType = DTy.getTypeDerivedFrom();
235 }
236
237 DICompositeType blockStruct = DICompositeType(subType);
238 DIArray Elements = blockStruct.getTypeArray();
239
240 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
241 DIDescriptor Element = Elements.getElement(i);
242 DIDerivedType DT = DIDerivedType(Element);
243 if (getName() == DT.getName())
244 return (DT.getTypeDerivedFrom());
245 }
246 return Ty;
247 }
248 return Ty;
249 }
Bill Wendling0310d762009-05-15 09:23:25 +0000250};
251
252//===----------------------------------------------------------------------===//
Devang Pateleac9c072010-04-27 19:46:33 +0000253/// DbgRange - This is used to track range of instructions with identical
254/// debug info scope.
255///
256typedef std::pair<const MachineInstr *, const MachineInstr *> DbgRange;
257
258//===----------------------------------------------------------------------===//
Bill Wendling0310d762009-05-15 09:23:25 +0000259/// DbgScope - This class is used to track scope information.
260///
Devang Patelf76a3d62009-11-16 21:53:40 +0000261class DbgScope {
Bill Wendling0310d762009-05-15 09:23:25 +0000262 DbgScope *Parent; // Parent to this scope.
Jim Grosbach31ef40e2009-11-21 23:12:12 +0000263 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel3139fcf2010-01-26 21:39:14 +0000264 // Location at which this scope is inlined.
Jim Grosbach1e20b962010-07-21 21:21:52 +0000265 AssertingVH<const MDNode> InlinedAtLocation;
Devang Patel53bb5c92009-11-10 23:06:00 +0000266 bool AbstractScope; // Abstract Scope
Devang Pateld38dd112009-10-01 18:25:23 +0000267 const MachineInstr *LastInsn; // Last instruction of this scope.
268 const MachineInstr *FirstInsn; // First instruction of this scope.
Devang Pateleac9c072010-04-27 19:46:33 +0000269 unsigned DFSIn, DFSOut;
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000270 // Scopes defined in scope. Contents not owned.
271 SmallVector<DbgScope *, 4> Scopes;
272 // Variables declared in scope. Contents owned.
273 SmallVector<DbgVariable *, 8> Variables;
Devang Pateleac9c072010-04-27 19:46:33 +0000274 SmallVector<DbgRange, 4> Ranges;
Owen Anderson04c05f72009-06-24 22:53:20 +0000275 // Private state for dump()
276 mutable unsigned IndentLevel;
Bill Wendling0310d762009-05-15 09:23:25 +0000277public:
Devang Patele9f8f5e2010-05-07 20:54:48 +0000278 DbgScope(DbgScope *P, DIDescriptor D, const MDNode *I = 0)
Devang Patel53bb5c92009-11-10 23:06:00 +0000279 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Devang Pateleac9c072010-04-27 19:46:33 +0000280 LastInsn(0), FirstInsn(0),
281 DFSIn(0), DFSOut(0), IndentLevel(0) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000282 virtual ~DbgScope();
283
284 // Accessors.
285 DbgScope *getParent() const { return Parent; }
Devang Patel53bb5c92009-11-10 23:06:00 +0000286 void setParent(DbgScope *P) { Parent = P; }
Bill Wendling0310d762009-05-15 09:23:25 +0000287 DIDescriptor getDesc() const { return Desc; }
Devang Patele9f8f5e2010-05-07 20:54:48 +0000288 const MDNode *getInlinedAt() const { return InlinedAtLocation; }
289 const MDNode *getScopeNode() const { return Desc; }
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000290 const SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
Devang Patele03161c2010-08-09 18:51:29 +0000291 const SmallVector<DbgVariable *, 8> &getDbgVariables() { return Variables; }
Devang Pateleac9c072010-04-27 19:46:33 +0000292 const SmallVector<DbgRange, 4> &getRanges() { return Ranges; }
293
294 /// openInsnRange - This scope covers instruction range starting from MI.
295 void openInsnRange(const MachineInstr *MI) {
Jim Grosbach1e20b962010-07-21 21:21:52 +0000296 if (!FirstInsn)
Devang Pateleac9c072010-04-27 19:46:33 +0000297 FirstInsn = MI;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000298
Devang Pateleac9c072010-04-27 19:46:33 +0000299 if (Parent)
300 Parent->openInsnRange(MI);
301 }
302
Jim Grosbach1e20b962010-07-21 21:21:52 +0000303 /// extendInsnRange - Extend the current instruction range covered by
Devang Pateleac9c072010-04-27 19:46:33 +0000304 /// this scope.
305 void extendInsnRange(const MachineInstr *MI) {
306 assert (FirstInsn && "MI Range is not open!");
307 LastInsn = MI;
308 if (Parent)
309 Parent->extendInsnRange(MI);
310 }
311
312 /// closeInsnRange - Create a range based on FirstInsn and LastInsn collected
313 /// until now. This is used when a new scope is encountered while walking
314 /// machine instructions.
315 void closeInsnRange(DbgScope *NewScope = NULL) {
316 assert (LastInsn && "Last insn missing!");
317 Ranges.push_back(DbgRange(FirstInsn, LastInsn));
Jim Grosbach1e20b962010-07-21 21:21:52 +0000318 FirstInsn = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +0000319 LastInsn = NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000320 // If Parent dominates NewScope then do not close Parent's instruction
Devang Pateleac9c072010-04-27 19:46:33 +0000321 // range.
322 if (Parent && (!NewScope || !Parent->dominates(NewScope)))
323 Parent->closeInsnRange(NewScope);
324 }
325
Devang Patel53bb5c92009-11-10 23:06:00 +0000326 void setAbstractScope() { AbstractScope = true; }
327 bool isAbstractScope() const { return AbstractScope; }
Devang Pateleac9c072010-04-27 19:46:33 +0000328
329 // Depth First Search support to walk and mainpluate DbgScope hierarchy.
330 unsigned getDFSOut() const { return DFSOut; }
331 void setDFSOut(unsigned O) { DFSOut = O; }
332 unsigned getDFSIn() const { return DFSIn; }
333 void setDFSIn(unsigned I) { DFSIn = I; }
334 bool dominates(const DbgScope *S) {
Jim Grosbach1e20b962010-07-21 21:21:52 +0000335 if (S == this)
Devang Pateleac9c072010-04-27 19:46:33 +0000336 return true;
337 if (DFSIn < S->getDFSIn() && DFSOut > S->getDFSOut())
338 return true;
339 return false;
340 }
Devang Patel53bb5c92009-11-10 23:06:00 +0000341
Devang Patel2c4ceb12009-11-21 02:48:08 +0000342 /// addScope - Add a scope to the scope.
Bill Wendling0310d762009-05-15 09:23:25 +0000343 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000344 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendling0310d762009-05-15 09:23:25 +0000345
Devang Patel2c4ceb12009-11-21 02:48:08 +0000346 /// addVariable - Add a variable to the scope.
Bill Wendling0310d762009-05-15 09:23:25 +0000347 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000348 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendling0310d762009-05-15 09:23:25 +0000349
Bill Wendling0310d762009-05-15 09:23:25 +0000350#ifndef NDEBUG
351 void dump() const;
352#endif
353};
Devang Pateleac9c072010-04-27 19:46:33 +0000354
Chris Lattnerea761862010-04-05 04:09:20 +0000355} // end llvm namespace
Bill Wendling0310d762009-05-15 09:23:25 +0000356
357#ifndef NDEBUG
358void DbgScope::dump() const {
David Greenef83adbc2009-12-24 00:31:35 +0000359 raw_ostream &err = dbgs();
Chris Lattnerc281de12009-08-23 00:51:00 +0000360 err.indent(IndentLevel);
Devang Patele9f8f5e2010-05-07 20:54:48 +0000361 const MDNode *N = Desc;
Devang Patel53bb5c92009-11-10 23:06:00 +0000362 N->dump();
Devang Patel53bb5c92009-11-10 23:06:00 +0000363 if (AbstractScope)
364 err << "Abstract Scope\n";
Bill Wendling0310d762009-05-15 09:23:25 +0000365
366 IndentLevel += 2;
Devang Patel53bb5c92009-11-10 23:06:00 +0000367 if (!Scopes.empty())
368 err << "Children ...\n";
Bill Wendling0310d762009-05-15 09:23:25 +0000369 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
370 if (Scopes[i] != this)
371 Scopes[i]->dump();
372
373 IndentLevel -= 2;
374}
375#endif
376
Bill Wendling0310d762009-05-15 09:23:25 +0000377DbgScope::~DbgScope() {
Bill Wendling0310d762009-05-15 09:23:25 +0000378 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
379 delete Variables[j];
Bill Wendling0310d762009-05-15 09:23:25 +0000380}
381
Chris Lattner49cd6642010-04-05 05:11:15 +0000382DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Devang Patel163a9f72010-05-10 22:49:55 +0000383 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbach1e20b962010-07-21 21:21:52 +0000384 AbbreviationsSet(InitAbbreviationsSetSize),
Devang Patelf2548ca2010-04-16 23:33:45 +0000385 CurrentFnDbgScope(0), PrevLabel(NULL) {
Chris Lattnerbc733f52010-03-13 02:17:42 +0000386 NextStringPoolNumber = 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000387
Chris Lattner4ad1efe2010-04-04 23:10:38 +0000388 DwarfFrameSectionSym = DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
389 DwarfStrSectionSym = TextSectionSym = 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000390 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
Devang Patelc3f5f782010-05-25 23:40:22 +0000391 FunctionBeginSym = FunctionEndSym = 0;
Devang Patelca76f6f2010-07-08 20:10:35 +0000392 DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
Dan Gohman03c3dc72010-06-18 15:56:31 +0000393 {
394 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
395 beginModule(M);
Torok Edwin9c421072010-04-07 10:44:46 +0000396 }
Bill Wendling0310d762009-05-15 09:23:25 +0000397}
398DwarfDebug::~DwarfDebug() {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000399 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
400 DIEBlocks[j]->~DIEBlock();
Bill Wendling0310d762009-05-15 09:23:25 +0000401}
402
Chris Lattnerbc733f52010-03-13 02:17:42 +0000403MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
404 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
405 if (Entry.first) return Entry.first;
406
407 Entry.second = NextStringPoolNumber++;
Chris Lattnerc0215722010-04-04 19:25:43 +0000408 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerbc733f52010-03-13 02:17:42 +0000409}
410
411
Devang Patel2c4ceb12009-11-21 02:48:08 +0000412/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling0310d762009-05-15 09:23:25 +0000413///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000414void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling0310d762009-05-15 09:23:25 +0000415 // Profile the node so that we can make it unique.
416 FoldingSetNodeID ID;
417 Abbrev.Profile(ID);
418
419 // Check the set for priors.
420 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
421
422 // If it's newly added.
423 if (InSet == &Abbrev) {
424 // Add to abbreviation list.
425 Abbreviations.push_back(&Abbrev);
426
427 // Assign the vector position + 1 as its number.
428 Abbrev.setNumber(Abbreviations.size());
429 } else {
430 // Assign existing abbreviation number.
431 Abbrev.setNumber(InSet->getNumber());
432 }
433}
434
Devang Patel2c4ceb12009-11-21 02:48:08 +0000435/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendling995f80a2009-05-20 23:24:48 +0000436/// information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000437DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000438 DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000439 return Value;
440}
441
Devang Patel2c4ceb12009-11-21 02:48:08 +0000442/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000443///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000444void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000445 unsigned Form, uint64_t Integer) {
446 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000447 DIEValue *Value = Integer == 1 ?
Devang Patelca76f6f2010-07-08 20:10:35 +0000448 DIEIntegerOne : new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000449 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000450}
451
Devang Patel2c4ceb12009-11-21 02:48:08 +0000452/// addSInt - Add an signed integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000453///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000454void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000455 unsigned Form, int64_t Integer) {
456 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000457 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000458 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000459}
460
Devang Patel69f57b12009-12-02 15:25:16 +0000461/// addString - Add a string attribute data and value. DIEString only
Jim Grosbach1e20b962010-07-21 21:21:52 +0000462/// keeps string reference.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000463void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattner4cf202b2010-01-23 03:11:46 +0000464 StringRef String) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000465 DIEValue *Value = new (DIEValueAllocator) DIEString(String);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000466 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000467}
468
Devang Patel2c4ceb12009-11-21 02:48:08 +0000469/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000470///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000471void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerb98b1bf2010-03-08 22:23:36 +0000472 const MCSymbol *Label) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000473 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000474 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000475}
476
Devang Patel2c4ceb12009-11-21 02:48:08 +0000477/// addDelta - Add a label delta attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000478///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000479void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerb98b1bf2010-03-08 22:23:36 +0000480 const MCSymbol *Hi, const MCSymbol *Lo) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000481 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000482 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000483}
484
Chris Lattner74e41f92010-04-05 05:24:55 +0000485/// addDIEEntry - Add a DIE attribute data and value.
486///
487void DwarfDebug::addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form,
488 DIE *Entry) {
489 Die->addValue(Attribute, Form, createDIEEntry(Entry));
490}
491
492
Devang Patel2c4ceb12009-11-21 02:48:08 +0000493/// addBlock - Add block data.
Bill Wendling0310d762009-05-15 09:23:25 +0000494///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000495void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000496 DIEBlock *Block) {
Chris Lattnera37d5382010-04-05 00:18:22 +0000497 Block->ComputeSize(Asm);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000498 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000499 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000500}
501
Devang Patel2c4ceb12009-11-21 02:48:08 +0000502/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000503/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000504void DwarfDebug::addSourceLine(DIE *Die, DIVariable V) {
Devang Patelc665a512010-05-07 23:33:41 +0000505 // Verify variable.
Devang Patel81625742010-08-09 20:20:05 +0000506 if (!V.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000507 return;
508
Devang Patel81625742010-08-09 20:20:05 +0000509 unsigned Line = V.getLineNumber();
510 unsigned FileID = GetOrCreateSourceID(V.getContext().getDirectory(),
511 V.getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000512 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000513 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
514 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000515}
516
Devang Patel2c4ceb12009-11-21 02:48:08 +0000517/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000518/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000519void DwarfDebug::addSourceLine(DIE *Die, DIGlobalVariable G) {
Devang Patelc665a512010-05-07 23:33:41 +0000520 // Verify global variable.
Devang Patel81625742010-08-09 20:20:05 +0000521 if (!G.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000522 return;
523
Devang Patel81625742010-08-09 20:20:05 +0000524 unsigned Line = G.getLineNumber();
525 unsigned FileID = GetOrCreateSourceID(G.getContext().getDirectory(),
526 G.getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000527 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000528 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
529 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000530}
Devang Patel82dfc0c2009-08-31 22:47:13 +0000531
Devang Patel2c4ceb12009-11-21 02:48:08 +0000532/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000533/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000534void DwarfDebug::addSourceLine(DIE *Die, DISubprogram SP) {
Devang Patelc665a512010-05-07 23:33:41 +0000535 // Verify subprogram.
Devang Patel81625742010-08-09 20:20:05 +0000536 if (!SP.Verify())
Devang Patel82dfc0c2009-08-31 22:47:13 +0000537 return;
Caroline Ticec6f9d622009-09-11 18:25:54 +0000538 // If the line number is 0, don't add it.
Devang Patel81625742010-08-09 20:20:05 +0000539 if (SP.getLineNumber() == 0)
Caroline Ticec6f9d622009-09-11 18:25:54 +0000540 return;
541
Devang Patel81625742010-08-09 20:20:05 +0000542 unsigned Line = SP.getLineNumber();
543 if (!SP.getContext().Verify())
Devang Patel77bf2952010-03-08 22:02:50 +0000544 return;
Devang Patel81625742010-08-09 20:20:05 +0000545 unsigned FileID = GetOrCreateSourceID(SP.getDirectory(),
546 SP.getFilename());
Devang Patel82dfc0c2009-08-31 22:47:13 +0000547 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000548 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
549 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patel82dfc0c2009-08-31 22:47:13 +0000550}
551
Devang Patel2c4ceb12009-11-21 02:48:08 +0000552/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000553/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000554void DwarfDebug::addSourceLine(DIE *Die, DIType Ty) {
Devang Patelc665a512010-05-07 23:33:41 +0000555 // Verify type.
Devang Patel81625742010-08-09 20:20:05 +0000556 if (!Ty.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000557 return;
558
Devang Patel81625742010-08-09 20:20:05 +0000559 unsigned Line = Ty.getLineNumber();
560 if (!Ty.getContext().Verify())
Devang Patel77bf2952010-03-08 22:02:50 +0000561 return;
Devang Patel81625742010-08-09 20:20:05 +0000562 unsigned FileID = GetOrCreateSourceID(Ty.getContext().getDirectory(),
563 Ty.getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000564 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000565 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
566 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000567}
568
Devang Patel6404e4e2009-12-15 19:16:48 +0000569/// addSourceLine - Add location information to specified debug information
570/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000571void DwarfDebug::addSourceLine(DIE *Die, DINameSpace NS) {
Devang Patelc665a512010-05-07 23:33:41 +0000572 // Verify namespace.
Devang Patel81625742010-08-09 20:20:05 +0000573 if (!NS.Verify())
Devang Patel6404e4e2009-12-15 19:16:48 +0000574 return;
575
Devang Patel81625742010-08-09 20:20:05 +0000576 unsigned Line = NS.getLineNumber();
577 StringRef FN = NS.getFilename();
578 StringRef Dir = NS.getDirectory();
Devang Patel6404e4e2009-12-15 19:16:48 +0000579
580 unsigned FileID = GetOrCreateSourceID(Dir, FN);
581 assert(FileID && "Invalid file id");
582 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
583 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
584}
585
Devang Patel9e3bd2c2010-08-31 06:11:28 +0000586/// addVariableAddress - Add DW_AT_location attribute for a DbgVariable based
587/// on provided frame index.
588void DwarfDebug::addVariableAddress(DbgVariable *&DV, DIE *Die, int64_t FI) {
589 MachineLocation Location;
590 unsigned FrameReg;
591 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
592 int Offset = RI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
593 Location.set(FrameReg, Offset);
594
Devang Patel8bd11de2010-08-09 21:01:39 +0000595 if (DV->variableHasComplexAddress())
596 addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
597 else if (DV->isBlockByrefVariable())
598 addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
599 else
600 addAddress(Die, dwarf::DW_AT_location, Location);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000601}
602
Devang Patel2c4ceb12009-11-21 02:48:08 +0000603/// addComplexAddress - Start with the address based on the location provided,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000604/// and generate the DWARF information necessary to find the actual variable
605/// given the extra address information encoded in the DIVariable, starting from
606/// the starting location. Add the DWARF information to the die.
607///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000608void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000609 unsigned Attribute,
610 const MachineLocation &Location) {
Devang Patel8bd11de2010-08-09 21:01:39 +0000611 DIType Ty = DV->getType();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000612
613 // Decode the original location, and use that as the start of the byref
614 // variable's location.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000615 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000616 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000617 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000618
619 if (Location.isReg()) {
620 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000621 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000622 } else {
623 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000624 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
625 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000626 }
627 } else {
628 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000629 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000630 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000631 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
632 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000633 }
634
Devang Patel2c4ceb12009-11-21 02:48:08 +0000635 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000636 }
637
Devang Patel8bd11de2010-08-09 21:01:39 +0000638 for (unsigned i = 0, N = DV->getNumAddrElements(); i < N; ++i) {
639 uint64_t Element = DV->getAddrElement(i);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000640
641 if (Element == DIFactory::OpPlus) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000642 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel8bd11de2010-08-09 21:01:39 +0000643 addUInt(Block, 0, dwarf::DW_FORM_udata, DV->getAddrElement(++i));
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000644 } else if (Element == DIFactory::OpDeref) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000645 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000646 } else llvm_unreachable("unknown DIFactory Opcode");
647 }
648
649 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000650 addBlock(Die, Attribute, 0, Block);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000651}
652
Caroline Ticedc8f6042009-08-31 21:19:37 +0000653/* Byref variables, in Blocks, are declared by the programmer as "SomeType
654 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
655 gives the variable VarName either the struct, or a pointer to the struct, as
656 its type. This is necessary for various behind-the-scenes things the
657 compiler needs to do with by-reference variables in Blocks.
658
659 However, as far as the original *programmer* is concerned, the variable
660 should still have type 'SomeType', as originally declared.
661
Devang Patel2c4ceb12009-11-21 02:48:08 +0000662 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000663 struct to find the original type of the variable, which is then assigned to
664 the variable's Debug Information Entry as its real type. So far, so good.
665 However now the debugger will expect the variable VarName to have the type
666 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000667 expression that explains to the debugger how to navigate through the
Caroline Ticedc8f6042009-08-31 21:19:37 +0000668 pointers and struct to find the actual variable of type SomeType.
669
670 The following function does just that. We start by getting
671 the "normal" location for the variable. This will be the location
672 of either the struct __Block_byref_x_VarName or the pointer to the
673 struct __Block_byref_x_VarName.
674
675 The struct will look something like:
676
677 struct __Block_byref_x_VarName {
678 ... <various fields>
679 struct __Block_byref_x_VarName *forwarding;
680 ... <various other fields>
681 SomeType VarName;
682 ... <maybe more fields>
683 };
684
685 If we are given the struct directly (as our starting point) we
686 need to tell the debugger to:
687
688 1). Add the offset of the forwarding field.
689
Dan Gohmanf451cb82010-02-10 16:03:48 +0000690 2). Follow that pointer to get the real __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000691 struct to use (the real one may have been copied onto the heap).
692
693 3). Add the offset for the field VarName, to find the actual variable.
694
695 If we started with a pointer to the struct, then we need to
696 dereference that pointer first, before the other steps.
697 Translating this into DWARF ops, we will need to append the following
698 to the current location description for the variable:
699
700 DW_OP_deref -- optional, if we start with a pointer
701 DW_OP_plus_uconst <forward_fld_offset>
702 DW_OP_deref
703 DW_OP_plus_uconst <varName_fld_offset>
704
705 That is what this function does. */
706
Devang Patel2c4ceb12009-11-21 02:48:08 +0000707/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticedc8f6042009-08-31 21:19:37 +0000708/// provided, and generate the DWARF information necessary to find the
709/// actual Block variable (navigating the Block struct) based on the
710/// starting location. Add the DWARF information to the die. For
711/// more information, read large comment just above here.
712///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000713void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbar00564992009-09-19 20:40:14 +0000714 unsigned Attribute,
715 const MachineLocation &Location) {
Devang Patel8bd11de2010-08-09 21:01:39 +0000716 DIType Ty = DV->getType();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000717 DIType TmpTy = Ty;
718 unsigned Tag = Ty.getTag();
719 bool isPointer = false;
720
Devang Patel8bd11de2010-08-09 21:01:39 +0000721 StringRef varName = DV->getName();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000722
723 if (Tag == dwarf::DW_TAG_pointer_type) {
Devang Patel2db49d72010-05-07 18:11:54 +0000724 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000725 TmpTy = DTy.getTypeDerivedFrom();
726 isPointer = true;
727 }
728
Devang Patel2db49d72010-05-07 18:11:54 +0000729 DICompositeType blockStruct = DICompositeType(TmpTy);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000730
Daniel Dunbar00564992009-09-19 20:40:14 +0000731 // Find the __forwarding field and the variable field in the __Block_byref
732 // struct.
Daniel Dunbar00564992009-09-19 20:40:14 +0000733 DIArray Fields = blockStruct.getTypeArray();
734 DIDescriptor varField = DIDescriptor();
735 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000736
Daniel Dunbar00564992009-09-19 20:40:14 +0000737 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
738 DIDescriptor Element = Fields.getElement(i);
Devang Patel2db49d72010-05-07 18:11:54 +0000739 DIDerivedType DT = DIDerivedType(Element);
Devang Patel65dbc902009-11-25 17:36:49 +0000740 StringRef fieldName = DT.getName();
741 if (fieldName == "__forwarding")
Daniel Dunbar00564992009-09-19 20:40:14 +0000742 forwardingField = Element;
Devang Patel65dbc902009-11-25 17:36:49 +0000743 else if (fieldName == varName)
Daniel Dunbar00564992009-09-19 20:40:14 +0000744 varField = Element;
745 }
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000746
Daniel Dunbar00564992009-09-19 20:40:14 +0000747 // Get the offsets for the forwarding field and the variable field.
Chris Lattner1d65ba72010-03-31 06:06:37 +0000748 unsigned forwardingFieldOffset =
Devang Patel2db49d72010-05-07 18:11:54 +0000749 DIDerivedType(forwardingField).getOffsetInBits() >> 3;
Chris Lattner1d65ba72010-03-31 06:06:37 +0000750 unsigned varFieldOffset =
Devang Patel2db49d72010-05-07 18:11:54 +0000751 DIDerivedType(varField).getOffsetInBits() >> 3;
Caroline Ticedc8f6042009-08-31 21:19:37 +0000752
Mike Stump7e3720d2009-09-24 23:21:26 +0000753 // Decode the original location, and use that as the start of the byref
754 // variable's location.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000755 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Daniel Dunbar00564992009-09-19 20:40:14 +0000756 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000757 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000758
Daniel Dunbar00564992009-09-19 20:40:14 +0000759 if (Location.isReg()) {
760 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000761 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000762 else {
763 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000764 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
765 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000766 }
767 } else {
768 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000769 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000770 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000771 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
772 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000773 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000774
Devang Patel2c4ceb12009-11-21 02:48:08 +0000775 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbar00564992009-09-19 20:40:14 +0000776 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000777
Mike Stump7e3720d2009-09-24 23:21:26 +0000778 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbar00564992009-09-19 20:40:14 +0000779 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbar00564992009-09-19 20:40:14 +0000780 if (isPointer)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000781 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000782
Daniel Dunbar00564992009-09-19 20:40:14 +0000783 // Next add the offset for the '__forwarding' field:
784 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
785 // adding the offset if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000786 if (forwardingFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000787 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
788 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000789 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000790
Daniel Dunbar00564992009-09-19 20:40:14 +0000791 // Now dereference the __forwarding field to get to the real __Block_byref
792 // struct: DW_OP_deref.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000793 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000794
Daniel Dunbar00564992009-09-19 20:40:14 +0000795 // Now that we've got the real __Block_byref... struct, add the offset
796 // for the variable's field to get to the location of the actual variable:
797 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000798 if (varFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000799 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
800 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000801 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000802
Daniel Dunbar00564992009-09-19 20:40:14 +0000803 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000804 addBlock(Die, Attribute, 0, Block);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000805}
806
Devang Patel2c4ceb12009-11-21 02:48:08 +0000807/// addAddress - Add an address attribute to a die based on the location
Bill Wendling0310d762009-05-15 09:23:25 +0000808/// provided.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000809void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000810 const MachineLocation &Location) {
Chris Lattnerd38fee82010-04-05 00:13:49 +0000811 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling0310d762009-05-15 09:23:25 +0000812 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000813 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patelbe90c3a2010-09-22 21:10:38 +0000814 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
815
816 if (TRI->getFrameRegister(*Asm->MF) == Location.getReg()
817 && Location.getOffset()) {
818 // If variable offset is based in frame register then use fbreg.
819 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
820 addSInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
821 addBlock(Die, Attribute, 0, Block);
822 return;
823 }
Bill Wendling0310d762009-05-15 09:23:25 +0000824
825 if (Location.isReg()) {
826 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000827 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000828 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000829 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
830 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000831 }
832 } else {
833 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000834 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + 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_bregx);
837 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000838 }
839
Devang Patel2c4ceb12009-11-21 02:48:08 +0000840 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling0310d762009-05-15 09:23:25 +0000841 }
842
Devang Patel2c4ceb12009-11-21 02:48:08 +0000843 addBlock(Die, Attribute, 0, Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000844}
845
Devang Patela43098d2010-04-28 01:03:09 +0000846/// addRegisterAddress - Add register location entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000847bool DwarfDebug::addRegisterAddress(DIE *Die, const MCSymbol *VS,
Devang Patela43098d2010-04-28 01:03:09 +0000848 const MachineOperand &MO) {
849 assert (MO.isReg() && "Invalid machine operand!");
850 if (!MO.getReg())
851 return false;
852 MachineLocation Location;
853 Location.set(MO.getReg());
854 addAddress(Die, dwarf::DW_AT_location, Location);
Devang Patel26c1e562010-05-20 16:36:41 +0000855 if (VS)
Devang Patela43098d2010-04-28 01:03:09 +0000856 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
857 return true;
858}
859
860/// addConstantValue - Add constant value entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000861bool DwarfDebug::addConstantValue(DIE *Die, const MCSymbol *VS,
Devang Patela43098d2010-04-28 01:03:09 +0000862 const MachineOperand &MO) {
863 assert (MO.isImm() && "Invalid machine operand!");
864 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
865 unsigned Imm = MO.getImm();
866 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
867 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patel26c1e562010-05-20 16:36:41 +0000868 if (VS)
Devang Patela43098d2010-04-28 01:03:09 +0000869 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
870 return true;
871}
872
873/// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000874bool DwarfDebug::addConstantFPValue(DIE *Die, const MCSymbol *VS,
Devang Patela43098d2010-04-28 01:03:09 +0000875 const MachineOperand &MO) {
876 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);
Devang Patel26c1e562010-05-20 16:36:41 +0000896 if (VS)
897 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000898 return true;
Devang Patela43098d2010-04-28 01:03:09 +0000899}
900
901
Devang Patelc366f832009-12-10 19:14:49 +0000902/// addToContextOwner - Add Die into the list of its context owner's children.
903void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3c91b052010-03-08 20:52:55 +0000904 if (Context.isType()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000905 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
Devang Patelc366f832009-12-10 19:14:49 +0000906 ContextDIE->addChild(Die);
Devang Patel6404e4e2009-12-15 19:16:48 +0000907 } else if (Context.isNameSpace()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000908 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
Devang Patel6404e4e2009-12-15 19:16:48 +0000909 ContextDIE->addChild(Die);
Stuart Hastings215aa152010-06-11 20:08:44 +0000910 } else if (Context.isSubprogram()) {
Devang Patelee70fa72010-09-27 23:15:27 +0000911 DIE *ContextDIE = createSubprogramDIE(DISubprogram(Context));
Stuart Hastings215aa152010-06-11 20:08:44 +0000912 ContextDIE->addChild(Die);
Devang Patel163a9f72010-05-10 22:49:55 +0000913 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patelc366f832009-12-10 19:14:49 +0000914 ContextDIE->addChild(Die);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000915 else
Devang Patel163a9f72010-05-10 22:49:55 +0000916 getCompileUnit(Context)->addDie(Die);
Devang Patelc366f832009-12-10 19:14:49 +0000917}
918
Devang Patel16ced732009-12-10 18:05:33 +0000919/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
920/// given DIType.
921DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel163a9f72010-05-10 22:49:55 +0000922 CompileUnit *TypeCU = getCompileUnit(Ty);
923 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patel16ced732009-12-10 18:05:33 +0000924 if (TyDIE)
925 return TyDIE;
926
927 // Create new type.
928 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel163a9f72010-05-10 22:49:55 +0000929 TypeCU->insertDIE(Ty, TyDIE);
Devang Patel16ced732009-12-10 18:05:33 +0000930 if (Ty.isBasicType())
Devang Patel2db49d72010-05-07 18:11:54 +0000931 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000932 else if (Ty.isCompositeType())
Devang Patel2db49d72010-05-07 18:11:54 +0000933 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000934 else {
935 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patel2db49d72010-05-07 18:11:54 +0000936 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000937 }
938
Devang Patelc366f832009-12-10 19:14:49 +0000939 addToContextOwner(TyDIE, Ty.getContext());
Devang Patel16ced732009-12-10 18:05:33 +0000940 return TyDIE;
941}
942
Devang Patel2c4ceb12009-11-21 02:48:08 +0000943/// addType - Add a new type attribute to the specified entity.
Devang Patel8a241142009-12-09 18:24:21 +0000944void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel9c004872010-05-07 21:45:47 +0000945 if (!Ty.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000946 return;
947
948 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +0000949 CompileUnit *TypeCU = getCompileUnit(Ty);
950 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000951 // If it exists then use the existing value.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000952 if (Entry) {
953 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000954 return;
955 }
956
Bill Wendling0310d762009-05-15 09:23:25 +0000957 // Construct type.
Devang Patel16ced732009-12-10 18:05:33 +0000958 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000959
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000960 // Set up proxy.
961 Entry = createDIEEntry(Buffer);
Devang Patel163a9f72010-05-10 22:49:55 +0000962 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000963
Devang Patel2c4ceb12009-11-21 02:48:08 +0000964 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000965}
966
Devang Patel2c4ceb12009-11-21 02:48:08 +0000967/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel8a241142009-12-09 18:24:21 +0000968void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000969 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000970 StringRef Name = BTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000971 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000972 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling0310d762009-05-15 09:23:25 +0000973 BTy.getEncoding());
974
975 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +0000976 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000977 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000978 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000979 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000980}
981
Devang Patel2c4ceb12009-11-21 02:48:08 +0000982/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel8a241142009-12-09 18:24:21 +0000983void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000984 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000985 StringRef Name = DTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000986 uint64_t Size = DTy.getSizeInBits() >> 3;
987 unsigned Tag = DTy.getTag();
988
989 // FIXME - Workaround for templates.
990 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
991
992 Buffer.setTag(Tag);
993
994 // Map to main type, void will not have a type.
995 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel8a241142009-12-09 18:24:21 +0000996 addType(&Buffer, FromTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000997
998 // Add name if not anonymous or intermediate type.
Devang Pateldeea5642009-11-30 23:56:56 +0000999 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001000 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001001
1002 // Add size if non-zero (derived types might be zero-sized.)
1003 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001004 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +00001005
1006 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patel05f6fa82009-11-23 18:43:37 +00001007 if (!DTy.isForwardDecl())
Devang Patel81625742010-08-09 20:20:05 +00001008 addSourceLine(&Buffer, DTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001009}
1010
Devang Patel2c4ceb12009-11-21 02:48:08 +00001011/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +00001012void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001013 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +00001014 StringRef Name = CTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +00001015
1016 uint64_t Size = CTy.getSizeInBits() >> 3;
1017 unsigned Tag = CTy.getTag();
1018 Buffer.setTag(Tag);
1019
1020 switch (Tag) {
1021 case dwarf::DW_TAG_vector_type:
1022 case dwarf::DW_TAG_array_type:
Devang Patel8a241142009-12-09 18:24:21 +00001023 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001024 break;
1025 case dwarf::DW_TAG_enumeration_type: {
1026 DIArray Elements = CTy.getTypeArray();
1027
1028 // Add enumerators to enumeration type.
1029 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1030 DIE *ElemDie = NULL;
Devang Patel2db49d72010-05-07 18:11:54 +00001031 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3c91b052010-03-08 20:52:55 +00001032 if (Enum.isEnumerator()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001033 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001034 Buffer.addChild(ElemDie);
Devang Patelc5254722009-10-09 17:51:49 +00001035 }
Bill Wendling0310d762009-05-15 09:23:25 +00001036 }
1037 }
1038 break;
1039 case dwarf::DW_TAG_subroutine_type: {
1040 // Add return type.
1041 DIArray Elements = CTy.getTypeArray();
1042 DIDescriptor RTy = Elements.getElement(0);
Devang Patel2db49d72010-05-07 18:11:54 +00001043 addType(&Buffer, DIType(RTy));
Bill Wendling0310d762009-05-15 09:23:25 +00001044
1045 // Add prototype flag.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001046 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001047
1048 // Add arguments.
1049 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1050 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1051 DIDescriptor Ty = Elements.getElement(i);
Devang Patel2db49d72010-05-07 18:11:54 +00001052 addType(Arg, DIType(Ty));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001053 Buffer.addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001054 }
1055 }
1056 break;
1057 case dwarf::DW_TAG_structure_type:
1058 case dwarf::DW_TAG_union_type:
1059 case dwarf::DW_TAG_class_type: {
1060 // Add elements to structure type.
1061 DIArray Elements = CTy.getTypeArray();
1062
1063 // A forward struct declared type may not have elements available.
Devang Patel3c91b052010-03-08 20:52:55 +00001064 unsigned N = Elements.getNumElements();
1065 if (N == 0)
Bill Wendling0310d762009-05-15 09:23:25 +00001066 break;
1067
1068 // Add elements to structure type.
Devang Patel3c91b052010-03-08 20:52:55 +00001069 for (unsigned i = 0; i < N; ++i) {
Bill Wendling0310d762009-05-15 09:23:25 +00001070 DIDescriptor Element = Elements.getElement(i);
1071 DIE *ElemDie = NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001072 if (Element.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001073 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patel3c91b052010-03-08 20:52:55 +00001074 else if (Element.isVariable()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001075 DIVariable DV(Element);
Devang Patel1ee0cb92010-01-30 01:08:30 +00001076 ElemDie = new DIE(dwarf::DW_TAG_variable);
1077 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1078 DV.getName());
1079 addType(ElemDie, DV.getType());
1080 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1081 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patel81625742010-08-09 20:20:05 +00001082 addSourceLine(ElemDie, DV);
Devang Patel3c91b052010-03-08 20:52:55 +00001083 } else if (Element.isDerivedType())
Devang Patel2db49d72010-05-07 18:11:54 +00001084 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3c91b052010-03-08 20:52:55 +00001085 else
1086 continue;
Devang Patel2c4ceb12009-11-21 02:48:08 +00001087 Buffer.addChild(ElemDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001088 }
1089
Devang Patela1ba2692009-08-27 23:51:51 +00001090 if (CTy.isAppleBlockExtension())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001091 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001092
1093 unsigned RLang = CTy.getRunTimeLang();
1094 if (RLang)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001095 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling0310d762009-05-15 09:23:25 +00001096 dwarf::DW_FORM_data1, RLang);
Devang Patelb5544992010-01-26 21:16:06 +00001097
1098 DICompositeType ContainingType = CTy.getContainingType();
Devang Patel2db49d72010-05-07 18:11:54 +00001099 if (DIDescriptor(ContainingType).isCompositeType())
Jim Grosbach1e20b962010-07-21 21:21:52 +00001100 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patel2db49d72010-05-07 18:11:54 +00001101 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastings215aa152010-06-11 20:08:44 +00001102 else {
1103 DIDescriptor Context = CTy.getContext();
1104 addToContextOwner(&Buffer, Context);
1105 }
Bill Wendling0310d762009-05-15 09:23:25 +00001106 break;
1107 }
1108 default:
1109 break;
1110 }
1111
1112 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +00001113 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001114 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001115
Jim Grosbach1e20b962010-07-21 21:21:52 +00001116 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
Devang Patel61409622010-07-07 20:12:52 +00001117 || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1118 {
Bill Wendling0310d762009-05-15 09:23:25 +00001119 // Add size if non-zero (derived types might be zero-sized.)
1120 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001121 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +00001122 else {
1123 // Add zero size if it is not a forward declaration.
1124 if (CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001125 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001126 else
Devang Patel2c4ceb12009-11-21 02:48:08 +00001127 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling0310d762009-05-15 09:23:25 +00001128 }
1129
1130 // Add source line info if available.
1131 if (!CTy.isForwardDecl())
Devang Patel81625742010-08-09 20:20:05 +00001132 addSourceLine(&Buffer, CTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001133 }
1134}
1135
Devang Patel2c4ceb12009-11-21 02:48:08 +00001136/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1137void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling0310d762009-05-15 09:23:25 +00001138 int64_t L = SR.getLo();
1139 int64_t H = SR.getHi();
1140 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1141
Devang Patel2c4ceb12009-11-21 02:48:08 +00001142 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patel6325a532009-08-14 20:59:16 +00001143 if (L)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001144 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Pateld55224c2009-12-04 23:10:24 +00001145 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling0310d762009-05-15 09:23:25 +00001146
Devang Patel2c4ceb12009-11-21 02:48:08 +00001147 Buffer.addChild(DW_Subrange);
Bill Wendling0310d762009-05-15 09:23:25 +00001148}
1149
Devang Patel2c4ceb12009-11-21 02:48:08 +00001150/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +00001151void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling0310d762009-05-15 09:23:25 +00001152 DICompositeType *CTy) {
1153 Buffer.setTag(dwarf::DW_TAG_array_type);
1154 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001155 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001156
1157 // Emit derived type.
Devang Patel8a241142009-12-09 18:24:21 +00001158 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001159 DIArray Elements = CTy->getTypeArray();
1160
Devang Patel6f01d9c2009-11-21 00:31:03 +00001161 // Get an anonymous type for index type.
Devang Patel163a9f72010-05-10 22:49:55 +00001162 CompileUnit *TheCU = getCompileUnit(*CTy);
1163 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel6f01d9c2009-11-21 00:31:03 +00001164 if (!IdxTy) {
1165 // Construct an anonymous type for index type.
1166 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001167 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1168 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel6f01d9c2009-11-21 00:31:03 +00001169 dwarf::DW_ATE_signed);
Devang Patel163a9f72010-05-10 22:49:55 +00001170 TheCU->addDie(IdxTy);
1171 TheCU->setIndexTyDie(IdxTy);
Devang Patel6f01d9c2009-11-21 00:31:03 +00001172 }
Bill Wendling0310d762009-05-15 09:23:25 +00001173
1174 // Add subranges to array type.
1175 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1176 DIDescriptor Element = Elements.getElement(i);
1177 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patel2db49d72010-05-07 18:11:54 +00001178 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001179 }
1180}
1181
Devang Patel2c4ceb12009-11-21 02:48:08 +00001182/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3c91b052010-03-08 20:52:55 +00001183DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001184 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3c91b052010-03-08 20:52:55 +00001185 StringRef Name = ETy.getName();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001186 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3c91b052010-03-08 20:52:55 +00001187 int64_t Value = ETy.getEnumValue();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001188 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling0310d762009-05-15 09:23:25 +00001189 return Enumerator;
1190}
1191
Jim Grosbach1e20b962010-07-21 21:21:52 +00001192/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel351ca332010-01-05 01:46:14 +00001193/// printer to not emit usual symbol prefix before the symbol name is used then
1194/// return linkage name after skipping this special LLVM prefix.
1195static StringRef getRealLinkageName(StringRef LinkageName) {
1196 char One = '\1';
1197 if (LinkageName.startswith(StringRef(&One, 1)))
1198 return LinkageName.substr(1);
1199 return LinkageName;
1200}
1201
Devang Patel2c4ceb12009-11-21 02:48:08 +00001202/// createMemberDIE - Create new member DIE.
Devang Patelecbd8e82010-08-10 04:12:17 +00001203DIE *DwarfDebug::createMemberDIE(DIDerivedType DT) {
Bill Wendling0310d762009-05-15 09:23:25 +00001204 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel65dbc902009-11-25 17:36:49 +00001205 StringRef Name = DT.getName();
1206 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001207 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001208
Devang Patel8a241142009-12-09 18:24:21 +00001209 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001210
Devang Patel81625742010-08-09 20:20:05 +00001211 addSourceLine(MemberDie, DT);
Bill Wendling0310d762009-05-15 09:23:25 +00001212
Benjamin Kramer345ef342010-03-31 19:34:01 +00001213 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001214 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel33db5082009-11-04 22:06:12 +00001215
Bill Wendling0310d762009-05-15 09:23:25 +00001216 uint64_t Size = DT.getSizeInBits();
Devang Patel61ecbd12009-11-04 23:48:00 +00001217 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling0310d762009-05-15 09:23:25 +00001218
1219 if (Size != FieldSize) {
1220 // Handle bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001221 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1222 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling0310d762009-05-15 09:23:25 +00001223
1224 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling0310d762009-05-15 09:23:25 +00001225 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1226 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer3d594fd2010-01-07 17:50:57 +00001227 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling0310d762009-05-15 09:23:25 +00001228 Offset -= FieldOffset;
1229
1230 // Maybe we need to work from the other end.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001231 if (Asm->getTargetData().isLittleEndian())
1232 Offset = FieldSize - (Offset + Size);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001233 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling0310d762009-05-15 09:23:25 +00001234
Devang Patel33db5082009-11-04 22:06:12 +00001235 // Here WD_AT_data_member_location points to the anonymous
1236 // field that includes this bit field.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001237 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001238
1239 } else
1240 // This is not a bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001241 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001242
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001243 if (DT.getTag() == dwarf::DW_TAG_inheritance
1244 && DT.isVirtual()) {
1245
1246 // For C++, virtual base classes are not at fixed offset. Use following
1247 // expression to extract appropriate offset from vtable.
1248 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1249
Benjamin Kramer345ef342010-03-31 19:34:01 +00001250 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001251 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1252 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1253 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1254 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1255 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1256 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1257 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1258
Jim Grosbach1e20b962010-07-21 21:21:52 +00001259 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001260 VBaseLocationDie);
1261 } else
1262 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001263
1264 if (DT.isProtected())
Devang Patel5d11eb02009-12-03 19:11:07 +00001265 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001266 dwarf::DW_ACCESS_protected);
1267 else if (DT.isPrivate())
Devang Patel5d11eb02009-12-03 19:11:07 +00001268 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001269 dwarf::DW_ACCESS_private);
Devang Patel2a361602010-09-29 19:08:08 +00001270 // Otherwise C++ member and base classes are considered public.
1271 else if (DT.getCompileUnit().getLanguage() == dwarf::DW_LANG_C_plus_plus)
Devang Patel5d11eb02009-12-03 19:11:07 +00001272 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1273 dwarf::DW_ACCESS_public);
1274 if (DT.isVirtual())
1275 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1276 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling0310d762009-05-15 09:23:25 +00001277 return MemberDie;
1278}
1279
Devang Patelffe966c2009-12-14 16:18:45 +00001280/// createSubprogramDIE - Create new DIE using SP.
Devang Patelee70fa72010-09-27 23:15:27 +00001281DIE *DwarfDebug::createSubprogramDIE(DISubprogram SP) {
Devang Patel163a9f72010-05-10 22:49:55 +00001282 CompileUnit *SPCU = getCompileUnit(SP);
1283 DIE *SPDie = SPCU->getDIE(SP);
Devang Patelffe966c2009-12-14 16:18:45 +00001284 if (SPDie)
1285 return SPDie;
1286
1287 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel1eac3e72010-03-02 17:58:15 +00001288 // Constructors and operators for anonymous aggregates do not have names.
Devang Patel6b506cb2010-03-02 01:26:20 +00001289 if (!SP.getName().empty())
1290 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling0310d762009-05-15 09:23:25 +00001291
Devang Patel65dbc902009-11-25 17:36:49 +00001292 StringRef LinkageName = SP.getLinkageName();
Devang Patel351ca332010-01-05 01:46:14 +00001293 if (!LinkageName.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001294 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel351ca332010-01-05 01:46:14 +00001295 getRealLinkageName(LinkageName));
1296
Devang Patel81625742010-08-09 20:20:05 +00001297 addSourceLine(SPDie, SP);
Bill Wendling0310d762009-05-15 09:23:25 +00001298
Bill Wendling0310d762009-05-15 09:23:25 +00001299 // Add prototyped tag, if C or ObjC.
1300 unsigned Lang = SP.getCompileUnit().getLanguage();
1301 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1302 Lang == dwarf::DW_LANG_ObjC)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001303 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001304
1305 // Add Return Type.
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001306 DICompositeType SPTy = SP.getType();
1307 DIArray Args = SPTy.getTypeArray();
Bill Wendling0310d762009-05-15 09:23:25 +00001308 unsigned SPTag = SPTy.getTag();
Devang Patel5d11eb02009-12-03 19:11:07 +00001309
Devang Patel3c91b052010-03-08 20:52:55 +00001310 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel8a241142009-12-09 18:24:21 +00001311 addType(SPDie, SPTy);
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001312 else
Devang Patel2db49d72010-05-07 18:11:54 +00001313 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001314
Devang Patel5d11eb02009-12-03 19:11:07 +00001315 unsigned VK = SP.getVirtuality();
1316 if (VK) {
1317 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer345ef342010-03-31 19:34:01 +00001318 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel5d11eb02009-12-03 19:11:07 +00001319 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1320 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1321 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001322 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patel2db49d72010-05-07 18:11:54 +00001323 SP.getContainingType()));
Devang Patel5d11eb02009-12-03 19:11:07 +00001324 }
1325
Devang Patelee70fa72010-09-27 23:15:27 +00001326 if (!SP.isDefinition()) {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001327 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001328
1329 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001330 // be handled while processing variables.
1331 DICompositeType SPTy = SP.getType();
1332 DIArray Args = SPTy.getTypeArray();
1333 unsigned SPTag = SPTy.getTag();
1334
Bill Wendling0310d762009-05-15 09:23:25 +00001335 if (SPTag == dwarf::DW_TAG_subroutine_type)
1336 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1337 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001338 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patelb4645642010-02-06 01:02:37 +00001339 addType(Arg, ATy);
1340 if (ATy.isArtificial())
1341 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001342 SPDie->addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001343 }
1344 }
1345
Devang Patel4e0d19d2010-02-03 19:57:19 +00001346 if (SP.isArtificial())
1347 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1348
Devang Patelccff8122010-04-30 19:38:23 +00001349 if (!SP.isLocalToUnit())
1350 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001351
Devang Patelccff8122010-04-30 19:38:23 +00001352 if (SP.isOptimized())
1353 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1354
Jim Grosbach91729002010-07-21 23:03:52 +00001355 if (unsigned isa = Asm->getISAEncoding()) {
1356 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1357 }
1358
Devang Patelccff8122010-04-30 19:38:23 +00001359 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel163a9f72010-05-10 22:49:55 +00001360 SPCU->insertDIE(SP, SPDie);
Devang Patelccff8122010-04-30 19:38:23 +00001361
Stuart Hastings215aa152010-06-11 20:08:44 +00001362 // Add to context owner.
1363 addToContextOwner(SPDie, SP.getContext());
1364
Bill Wendling0310d762009-05-15 09:23:25 +00001365 return SPDie;
1366}
1367
Devang Patele9f8f5e2010-05-07 20:54:48 +00001368DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattnered7a77b2010-03-31 05:36:29 +00001369 assert(N && "Invalid Scope encoding!");
Devang Patel53bb5c92009-11-10 23:06:00 +00001370
1371 DbgScope *AScope = AbstractScopes.lookup(N);
1372 if (AScope)
1373 return AScope;
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001374
Devang Patel53bb5c92009-11-10 23:06:00 +00001375 DbgScope *Parent = NULL;
1376
1377 DIDescriptor Scope(N);
1378 if (Scope.isLexicalBlock()) {
1379 DILexicalBlock DB(N);
1380 DIDescriptor ParentDesc = DB.getContext();
Devang Patel2db49d72010-05-07 18:11:54 +00001381 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patel53bb5c92009-11-10 23:06:00 +00001382 }
1383
1384 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1385
1386 if (Parent)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001387 Parent->addScope(AScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001388 AScope->setAbstractScope();
1389 AbstractScopes[N] = AScope;
1390 if (DIDescriptor(N).isSubprogram())
1391 AbstractScopesList.push_back(AScope);
1392 return AScope;
1393}
Devang Patelaf9e8472009-10-01 20:31:14 +00001394
Devang Patel5f094002010-04-06 23:53:48 +00001395/// isSubprogramContext - Return true if Context is either a subprogram
1396/// or another context nested inside a subprogram.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001397static bool isSubprogramContext(const MDNode *Context) {
Devang Patel5f094002010-04-06 23:53:48 +00001398 if (!Context)
1399 return false;
1400 DIDescriptor D(Context);
1401 if (D.isSubprogram())
1402 return true;
1403 if (D.isType())
Devang Patel2db49d72010-05-07 18:11:54 +00001404 return isSubprogramContext(DIType(Context).getContext());
Devang Patel5f094002010-04-06 23:53:48 +00001405 return false;
1406}
1407
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001408/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel2c4ceb12009-11-21 02:48:08 +00001409/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1410/// If there are global variables in this scope then create and insert
1411/// DIEs for these variables.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001412DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel163a9f72010-05-10 22:49:55 +00001413 CompileUnit *SPCU = getCompileUnit(SPNode);
1414 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patel8aa61472010-07-07 22:20:57 +00001415
Chris Lattnerd38fee82010-04-05 00:13:49 +00001416 assert(SPDie && "Unable to find subprogram DIE!");
1417 DISubprogram SP(SPNode);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001418
Chris Lattnerd38fee82010-04-05 00:13:49 +00001419 // There is not any need to generate specification DIE for a function
1420 // defined at compile unit level. If a function is defined inside another
1421 // function then gdb prefers the definition at top level and but does not
Jim Grosbach1e20b962010-07-21 21:21:52 +00001422 // expect specification DIE in parent function. So avoid creating
Chris Lattnerd38fee82010-04-05 00:13:49 +00001423 // specification DIE for a function defined inside a function.
1424 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Jim Grosbach1e20b962010-07-21 21:21:52 +00001425 !SP.getContext().isFile() &&
Devang Patel2db49d72010-05-07 18:11:54 +00001426 !isSubprogramContext(SP.getContext())) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00001427 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001428
1429 // Add arguments.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001430 DICompositeType SPTy = SP.getType();
1431 DIArray Args = SPTy.getTypeArray();
1432 unsigned SPTag = SPTy.getTag();
1433 if (SPTag == dwarf::DW_TAG_subroutine_type)
1434 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1435 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001436 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattnerd38fee82010-04-05 00:13:49 +00001437 addType(Arg, ATy);
1438 if (ATy.isArtificial())
1439 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1440 SPDie->addChild(Arg);
1441 }
1442 DIE *SPDeclDie = SPDie;
1443 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001444 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Chris Lattnerd38fee82010-04-05 00:13:49 +00001445 SPDeclDie);
Devang Patel163a9f72010-05-10 22:49:55 +00001446 SPCU->addDie(SPDie);
Chris Lattnerd38fee82010-04-05 00:13:49 +00001447 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00001448
Devang Patel8aa61472010-07-07 22:20:57 +00001449 // Pick up abstract subprogram DIE.
1450 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
1451 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1452 addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
1453 dwarf::DW_FORM_ref4, AbsSPDIE);
1454 SPCU->addDie(SPDie);
1455 }
1456
Chris Lattnerd38fee82010-04-05 00:13:49 +00001457 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1458 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1459 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1460 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1461 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1462 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1463 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +00001464
Chris Lattnerd38fee82010-04-05 00:13:49 +00001465 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +00001466}
1467
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001468/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel2c4ceb12009-11-21 02:48:08 +00001469/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1470DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001471
1472 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1473 if (Scope->isAbstractScope())
1474 return ScopeDIE;
1475
1476 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1477 if (Ranges.empty())
1478 return 0;
1479
1480 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1481 if (Ranges.size() > 1) {
1482 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbach1e20b962010-07-21 21:21:52 +00001483 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Pateleac9c072010-04-27 19:46:33 +00001484 // DW_AT_ranges appropriately.
1485 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1486 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1487 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1488 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +00001489 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1490 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +00001491 }
1492 DebugRangeSymbols.push_back(NULL);
1493 DebugRangeSymbols.push_back(NULL);
1494 return ScopeDIE;
1495 }
1496
Devang Patelc3f5f782010-05-25 23:40:22 +00001497 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1498 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001499
Devang Patelc3f5f782010-05-25 23:40:22 +00001500 if (End == 0) return 0;
Devang Patel53bb5c92009-11-10 23:06:00 +00001501
Chris Lattnerb7db7332010-03-09 01:58:53 +00001502 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1503 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbach1e20b962010-07-21 21:21:52 +00001504
Devang Pateleac9c072010-04-27 19:46:33 +00001505 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1506 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patel53bb5c92009-11-10 23:06:00 +00001507
1508 return ScopeDIE;
1509}
1510
Devang Patel2c4ceb12009-11-21 02:48:08 +00001511/// constructInlinedScopeDIE - This scope represents inlined body of
1512/// a function. Construct DIE to represent this concrete inlined copy
1513/// of the function.
1514DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001515
1516 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001517 assert (Ranges.empty() == false
Devang Pateleac9c072010-04-27 19:46:33 +00001518 && "DbgScope does not have instruction markers!");
1519
1520 // FIXME : .debug_inlined section specification does not clearly state how
1521 // to emit inlined scope that is split into multiple instruction ranges.
1522 // For now, use first instruction range and emit low_pc/high_pc pair and
1523 // corresponding .debug_inlined section entry for this pair.
1524 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patelc3f5f782010-05-25 23:40:22 +00001525 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1526 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001527
Devang Patel0afbf232010-07-08 22:39:20 +00001528 if (StartLabel == 0 || EndLabel == 0) {
Devang Pateleac9c072010-04-27 19:46:33 +00001529 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1530 return 0;
1531 }
Chris Lattnerb7db7332010-03-09 01:58:53 +00001532 assert(StartLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001533 "Invalid starting label for an inlined scope!");
Chris Lattnerb7db7332010-03-09 01:58:53 +00001534 assert(EndLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001535 "Invalid end label for an inlined scope!");
Devang Pateleac9c072010-04-27 19:46:33 +00001536
Devang Patel3c91b052010-03-08 20:52:55 +00001537 if (!Scope->getScopeNode())
Devang Patel0ef3fa62010-03-08 19:20:38 +00001538 return NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001539 DIScope DS(Scope->getScopeNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00001540 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1541
Devang Patel2db49d72010-05-07 18:11:54 +00001542 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel163a9f72010-05-10 22:49:55 +00001543 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1544 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001545 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel2c4ceb12009-11-21 02:48:08 +00001546 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001547 dwarf::DW_FORM_ref4, OriginDIE);
1548
Chris Lattner6ed0f902010-03-09 00:31:02 +00001549 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnerb7db7332010-03-09 01:58:53 +00001550 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patel53bb5c92009-11-10 23:06:00 +00001551
1552 InlinedSubprogramDIEs.insert(OriginDIE);
1553
1554 // Track the start label for this inlined function.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001555 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patel2db49d72010-05-07 18:11:54 +00001556 I = InlineInfo.find(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001557
1558 if (I == InlineInfo.end()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001559 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001560 ScopeDIE));
Devang Patel2db49d72010-05-07 18:11:54 +00001561 InlinedSPNodes.push_back(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001562 } else
Chris Lattner6ed0f902010-03-09 00:31:02 +00001563 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patel53bb5c92009-11-10 23:06:00 +00001564
Devang Patel53bb5c92009-11-10 23:06:00 +00001565 DILocation DL(Scope->getInlinedAt());
Devang Patel163a9f72010-05-10 22:49:55 +00001566 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001567 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +00001568
1569 return ScopeDIE;
1570}
1571
Devang Patel2c4ceb12009-11-21 02:48:08 +00001572
1573/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel8a241142009-12-09 18:24:21 +00001574DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel8bd11de2010-08-09 21:01:39 +00001575 StringRef Name = DV->getName();
Devang Patel65dbc902009-11-25 17:36:49 +00001576 if (Name.empty())
Devang Patel3fb6bd62009-11-13 02:25:26 +00001577 return NULL;
Devang Patel53bb5c92009-11-10 23:06:00 +00001578
1579 // Translate tag to proper Dwarf tag. The result variable is dropped for
1580 // now.
1581 unsigned Tag;
Devang Patel8bd11de2010-08-09 21:01:39 +00001582 switch (DV->getTag()) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001583 case dwarf::DW_TAG_return_variable:
1584 return NULL;
1585 case dwarf::DW_TAG_arg_variable:
1586 Tag = dwarf::DW_TAG_formal_parameter;
1587 break;
1588 case dwarf::DW_TAG_auto_variable: // fall thru
1589 default:
1590 Tag = dwarf::DW_TAG_variable;
1591 break;
1592 }
1593
1594 // Define variable debug information entry.
1595 DIE *VariableDie = new DIE(Tag);
1596
Devang Patel53bb5c92009-11-10 23:06:00 +00001597 DIE *AbsDIE = NULL;
Devang Patel26c1e562010-05-20 16:36:41 +00001598 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1599 V2AVI = VarToAbstractVarMap.find(DV);
1600 if (V2AVI != VarToAbstractVarMap.end())
1601 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001602
Devang Patel26c1e562010-05-20 16:36:41 +00001603 if (AbsDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001604 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001605 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001606 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001607 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel8bd11de2010-08-09 21:01:39 +00001608 addSourceLine(VariableDie, DV->getVariable());
Devang Patel53bb5c92009-11-10 23:06:00 +00001609
1610 // Add variable type.
Devang Patel8bd11de2010-08-09 21:01:39 +00001611 addType(VariableDie, DV->getType());
Devang Patel53bb5c92009-11-10 23:06:00 +00001612 }
1613
Devang Patel8bd11de2010-08-09 21:01:39 +00001614 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patelb4645642010-02-06 01:02:37 +00001615 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelc3f5f782010-05-25 23:40:22 +00001616
1617 if (Scope->isAbstractScope()) {
1618 DV->setDIE(VariableDie);
1619 return VariableDie;
1620 }
1621
1622 // Add variable address.
1623
1624 unsigned Offset = DV->getDotDebugLocOffset();
1625 if (Offset != ~0U) {
1626 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1627 Asm->GetTempSymbol("debug_loc", Offset));
1628 DV->setDIE(VariableDie);
1629 UseDotDebugLocEntry.insert(VariableDie);
1630 return VariableDie;
1631 }
1632
1633 // Check if variable is described by a DBG_VALUE instruction.
1634 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1635 DbgVariableToDbgInstMap.find(DV);
1636 if (DVI != DbgVariableToDbgInstMap.end()) {
1637 const MachineInstr *DVInsn = DVI->second;
1638 const MCSymbol *DVLabel = findVariableLabel(DV);
1639 bool updated = false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001640 // FIXME : Handle getNumOperands != 3
Devang Patelc3f5f782010-05-25 23:40:22 +00001641 if (DVInsn->getNumOperands() == 3) {
Devang Patel0b48ead2010-08-31 22:22:42 +00001642 if (DVInsn->getOperand(0).isReg()) {
1643 const MachineOperand RegOp = DVInsn->getOperand(0);
1644 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1645 if (DVInsn->getOperand(1).isImm() &&
1646 TRI->getFrameRegister(*Asm->MF) == RegOp.getReg()) {
1647 addVariableAddress(DV, VariableDie, DVInsn->getOperand(1).getImm());
1648 updated = true;
1649 } else
1650 updated = addRegisterAddress(VariableDie, DVLabel, RegOp);
1651 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001652 else if (DVInsn->getOperand(0).isImm())
1653 updated = addConstantValue(VariableDie, DVLabel, DVInsn->getOperand(0));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001654 else if (DVInsn->getOperand(0).isFPImm())
1655 updated =
Devang Patel61409622010-07-07 20:12:52 +00001656 addConstantFPValue(VariableDie, DVLabel, DVInsn->getOperand(0));
Devang Patelc3f5f782010-05-25 23:40:22 +00001657 } else {
1658 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1659 if (Location.getReg()) {
1660 addAddress(VariableDie, dwarf::DW_AT_location, Location);
1661 if (DVLabel)
1662 addLabel(VariableDie, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr,
1663 DVLabel);
1664 updated = true;
1665 }
1666 }
1667 if (!updated) {
1668 // If variableDie is not updated then DBG_VALUE instruction does not
1669 // have valid variable info.
1670 delete VariableDie;
1671 return NULL;
1672 }
1673 DV->setDIE(VariableDie);
1674 return VariableDie;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001675 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001676
1677 // .. else use frame index, if available.
Devang Patelc3f5f782010-05-25 23:40:22 +00001678 int FI = 0;
Devang Patel9e3bd2c2010-08-31 06:11:28 +00001679 if (findVariableFrameIndex(DV, &FI))
1680 addVariableAddress(DV, VariableDie, FI);
1681
Devang Patel53bb5c92009-11-10 23:06:00 +00001682 DV->setDIE(VariableDie);
1683 return VariableDie;
1684
1685}
Devang Patel2c4ceb12009-11-21 02:48:08 +00001686
Devang Patel193f7202009-11-24 01:14:22 +00001687void DwarfDebug::addPubTypes(DISubprogram SP) {
1688 DICompositeType SPTy = SP.getType();
1689 unsigned SPTag = SPTy.getTag();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001690 if (SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel193f7202009-11-24 01:14:22 +00001691 return;
1692
1693 DIArray Args = SPTy.getTypeArray();
Devang Patel193f7202009-11-24 01:14:22 +00001694 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patel2db49d72010-05-07 18:11:54 +00001695 DIType ATy(Args.getElement(i));
Devang Patel9c004872010-05-07 21:45:47 +00001696 if (!ATy.Verify())
Devang Patel193f7202009-11-24 01:14:22 +00001697 continue;
1698 DICompositeType CATy = getDICompositeType(ATy);
Devang Patel2db49d72010-05-07 18:11:54 +00001699 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel50d80e32010-04-13 20:35:04 +00001700 && !CATy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001701 CompileUnit *TheCU = getCompileUnit(CATy);
1702 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1703 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001704 }
1705 }
1706}
1707
Devang Patel2c4ceb12009-11-21 02:48:08 +00001708/// constructScopeDIE - Construct a DIE for this scope.
1709DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3c91b052010-03-08 20:52:55 +00001710 if (!Scope || !Scope->getScopeNode())
1711 return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001712
Devang Patel3c91b052010-03-08 20:52:55 +00001713 DIScope DS(Scope->getScopeNode());
1714 DIE *ScopeDIE = NULL;
1715 if (Scope->getInlinedAt())
1716 ScopeDIE = constructInlinedScopeDIE(Scope);
1717 else if (DS.isSubprogram()) {
Devang Patel0dd45582010-06-28 20:53:04 +00001718 ProcessedSPNodes.insert(DS);
Devang Patel8aa61472010-07-07 22:20:57 +00001719 if (Scope->isAbstractScope()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001720 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patel8aa61472010-07-07 22:20:57 +00001721 // Note down abstract DIE.
1722 if (ScopeDIE)
1723 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
1724 }
Devang Patel3c91b052010-03-08 20:52:55 +00001725 else
Devang Patel2db49d72010-05-07 18:11:54 +00001726 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3c91b052010-03-08 20:52:55 +00001727 }
Devang Patelaead63c2010-03-29 22:59:58 +00001728 else
Devang Patel3c91b052010-03-08 20:52:55 +00001729 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patelaead63c2010-03-29 22:59:58 +00001730 if (!ScopeDIE) return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001731
Devang Patel53bb5c92009-11-10 23:06:00 +00001732 // Add variables to scope.
Devang Patele03161c2010-08-09 18:51:29 +00001733 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patel53bb5c92009-11-10 23:06:00 +00001734 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel8a241142009-12-09 18:24:21 +00001735 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001736 if (VariableDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001737 ScopeDIE->addChild(VariableDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001738 }
1739
1740 // Add nested scopes.
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001741 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
Devang Patel53bb5c92009-11-10 23:06:00 +00001742 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1743 // Define the Scope debug information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001744 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001745 if (NestedDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001746 ScopeDIE->addChild(NestedDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001747 }
Devang Patel193f7202009-11-24 01:14:22 +00001748
Jim Grosbach1e20b962010-07-21 21:21:52 +00001749 if (DS.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001750 addPubTypes(DISubprogram(DS));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001751
Devang Patel193f7202009-11-24 01:14:22 +00001752 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +00001753}
1754
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001755/// GetOrCreateSourceID - Look up the source id with the given directory and
1756/// source file names. If none currently exists, create a new id and insert it
1757/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1758/// maps as well.
Chris Lattner1d65ba72010-03-31 06:06:37 +00001759unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName){
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001760 unsigned DId;
Devang Patel37032352010-07-27 20:51:15 +00001761 assert (DirName.empty() == false && "Invalid directory name!");
Devang Patel2f584852010-07-24 00:53:22 +00001762
Devang Patel1905a182010-09-16 20:57:49 +00001763 // If FE did not provide a file name, then assume stdin.
1764 if (FileName.empty())
1765 return GetOrCreateSourceID(DirName, "<stdin>");
1766
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001767 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1768 if (DI != DirectoryIdMap.end()) {
1769 DId = DI->getValue();
1770 } else {
1771 DId = DirectoryNames.size() + 1;
1772 DirectoryIdMap[DirName] = DId;
1773 DirectoryNames.push_back(DirName);
1774 }
1775
1776 unsigned FId;
1777 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1778 if (FI != SourceFileIdMap.end()) {
1779 FId = FI->getValue();
1780 } else {
1781 FId = SourceFileNames.size() + 1;
1782 SourceFileIdMap[FileName] = FId;
1783 SourceFileNames.push_back(FileName);
1784 }
1785
1786 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1787 SourceIdMap.find(std::make_pair(DId, FId));
1788 if (SI != SourceIdMap.end())
1789 return SI->second;
1790
1791 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1792 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1793 SourceIds.push_back(std::make_pair(DId, FId));
1794
1795 return SrcId;
1796}
1797
Devang Patel6404e4e2009-12-15 19:16:48 +00001798/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1799DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel163a9f72010-05-10 22:49:55 +00001800 CompileUnit *TheCU = getCompileUnit(NS);
1801 DIE *NDie = TheCU->getDIE(NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001802 if (NDie)
1803 return NDie;
1804 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel163a9f72010-05-10 22:49:55 +00001805 TheCU->insertDIE(NS, NDie);
Devang Patel6404e4e2009-12-15 19:16:48 +00001806 if (!NS.getName().empty())
1807 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
Devang Patel81625742010-08-09 20:20:05 +00001808 addSourceLine(NDie, NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001809 addToContextOwner(NDie, NS.getContext());
1810 return NDie;
1811}
1812
Jim Grosbach1e20b962010-07-21 21:21:52 +00001813/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel163a9f72010-05-10 22:49:55 +00001814/// metadata node with tag DW_TAG_compile_unit.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001815void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001816 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +00001817 StringRef FN = DIUnit.getFilename();
1818 StringRef Dir = DIUnit.getDirectory();
Devang Patel5ccdd102009-09-29 18:40:58 +00001819 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001820
1821 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001822 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001823 DIUnit.getProducer());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001824 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001825 DIUnit.getLanguage());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001826 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patel5098da02010-04-26 22:54:28 +00001827 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1828 // simplifies debug range entries.
Devang Patel9b93b6b2010-06-28 22:22:47 +00001829 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Patel4a602ca2010-03-22 23:11:36 +00001830 // DW_AT_stmt_list is a offset of line number information for this
Devang Patelaf608bd2010-08-24 00:06:12 +00001831 // compile unit in debug_line section.
Devang Patelae84d5b2010-08-31 23:50:19 +00001832 if (Asm->MAI->doesDwarfUsesAbsoluteLabelForStmtList())
1833 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_addr,
1834 Asm->GetTempSymbol("section_line"));
1835 else
1836 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001837
Devang Patel65dbc902009-11-25 17:36:49 +00001838 if (!Dir.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001839 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001840 if (DIUnit.isOptimized())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001841 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001842
Devang Patel65dbc902009-11-25 17:36:49 +00001843 StringRef Flags = DIUnit.getFlags();
1844 if (!Flags.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001845 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001846
1847 unsigned RVer = DIUnit.getRunTimeVersion();
1848 if (RVer)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001849 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001850 dwarf::DW_FORM_data1, RVer);
1851
Devang Patel163a9f72010-05-10 22:49:55 +00001852 CompileUnit *NewCU = new CompileUnit(ID, Die);
1853 if (!FirstCU)
1854 FirstCU = NewCU;
1855 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001856}
1857
Devang Patel163a9f72010-05-10 22:49:55 +00001858/// getCompielUnit - Get CompileUnit DIE.
1859CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1860 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1861 DIDescriptor D(N);
1862 const MDNode *CUNode = NULL;
1863 if (D.isCompileUnit())
1864 CUNode = N;
1865 else if (D.isSubprogram())
1866 CUNode = DISubprogram(N).getCompileUnit();
1867 else if (D.isType())
1868 CUNode = DIType(N).getCompileUnit();
1869 else if (D.isGlobalVariable())
1870 CUNode = DIGlobalVariable(N).getCompileUnit();
1871 else if (D.isVariable())
1872 CUNode = DIVariable(N).getCompileUnit();
1873 else if (D.isNameSpace())
1874 CUNode = DINameSpace(N).getCompileUnit();
1875 else if (D.isFile())
1876 CUNode = DIFile(N).getCompileUnit();
1877 else
1878 return FirstCU;
1879
1880 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1881 = CUMap.find(CUNode);
1882 if (I == CUMap.end())
1883 return FirstCU;
1884 return I->second;
1885}
1886
Devang Patel0c4720c2010-08-23 18:25:56 +00001887/// isUnsignedDIType - Return true if type encoding is unsigned.
1888static bool isUnsignedDIType(DIType Ty) {
1889 DIDerivedType DTy(Ty);
1890 if (DTy.Verify())
1891 return isUnsignedDIType(DTy.getTypeDerivedFrom());
1892
1893 DIBasicType BTy(Ty);
1894 if (BTy.Verify()) {
1895 unsigned Encoding = BTy.getEncoding();
1896 if (Encoding == dwarf::DW_ATE_unsigned ||
1897 Encoding == dwarf::DW_ATE_unsigned_char)
1898 return true;
1899 }
1900 return false;
1901}
Devang Patel163a9f72010-05-10 22:49:55 +00001902
1903/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001904void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel9fa539c2010-08-10 01:37:23 +00001905 DIGlobalVariable GV(N);
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001906
Devang Patel905cf5e2009-09-04 23:59:07 +00001907 // If debug information is malformed then ignore it.
Devang Patel9fa539c2010-08-10 01:37:23 +00001908 if (GV.Verify() == false)
Devang Patel905cf5e2009-09-04 23:59:07 +00001909 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001910
1911 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00001912 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel9fa539c2010-08-10 01:37:23 +00001913 if (TheCU->getDIE(GV))
Devang Patel13e16b62009-06-26 01:49:18 +00001914 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001915
Devang Patel9fa539c2010-08-10 01:37:23 +00001916 DIType GTy = GV.getType();
Devang Patel29368072010-08-10 07:11:13 +00001917 DIE *VariableDIE = new DIE(GV.getTag());
1918
1919 bool isGlobalVariable = GV.getGlobal() != NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001920
Devang Patel9fa539c2010-08-10 01:37:23 +00001921 // Add name.
1922 addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1923 GV.getDisplayName());
1924 StringRef LinkageName = GV.getLinkageName();
Devang Patel29368072010-08-10 07:11:13 +00001925 if (!LinkageName.empty() && isGlobalVariable)
Devang Patel9fa539c2010-08-10 01:37:23 +00001926 addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
1927 getRealLinkageName(LinkageName));
1928 // Add type.
1929 addType(VariableDIE, GTy);
Devang Patel50d80e32010-04-13 20:35:04 +00001930 if (GTy.isCompositeType() && !GTy.getName().empty()
1931 && !GTy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001932 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001933 assert(Entry && "Missing global type!");
Devang Patel163a9f72010-05-10 22:49:55 +00001934 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001935 }
Devang Patel9fa539c2010-08-10 01:37:23 +00001936 // Add scoping info.
1937 if (!GV.isLocalToUnit()) {
1938 addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1939 // Expose as global.
1940 TheCU->addGlobal(GV.getName(), VariableDIE);
1941 }
1942 // Add line number info.
1943 addSourceLine(VariableDIE, GV);
1944 // Add to map.
1945 TheCU->insertDIE(N, VariableDIE);
1946 // Add to context owner.
1947 DIDescriptor GVContext = GV.getContext();
1948 addToContextOwner(VariableDIE, GVContext);
1949 // Add location.
Devang Patel29368072010-08-10 07:11:13 +00001950 if (isGlobalVariable) {
1951 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1952 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1953 addLabel(Block, 0, dwarf::DW_FORM_udata,
1954 Asm->Mang->getSymbol(GV.getGlobal()));
1955 // Do not create specification DIE if context is either compile unit
1956 // or a subprogram.
1957 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
1958 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
1959 // Create specification DIE.
1960 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1961 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1962 dwarf::DW_FORM_ref4, VariableDIE);
1963 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1964 addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1965 TheCU->addDie(VariableSpecDIE);
1966 } else {
1967 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
1968 }
1969 } else if (Constant *C = GV.getConstant()) {
1970 if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
Devang Patel0c4720c2010-08-23 18:25:56 +00001971 if (isUnsignedDIType(GTy))
Devang Patel29368072010-08-10 07:11:13 +00001972 addUInt(VariableDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
1973 CI->getZExtValue());
1974 else
1975 addSInt(VariableDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
1976 CI->getSExtValue());
Devang Patel29368072010-08-10 07:11:13 +00001977 }
Devang Patel9fa539c2010-08-10 01:37:23 +00001978 }
Devang Patel13e16b62009-06-26 01:49:18 +00001979 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001980}
1981
Devang Patel163a9f72010-05-10 22:49:55 +00001982/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001983void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001984 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001985
Stuart Hastings639336e2010-04-06 21:38:29 +00001986 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00001987 CompileUnit *TheCU = getCompileUnit(N);
1988 if (TheCU->getDIE(N))
Stuart Hastings639336e2010-04-06 21:38:29 +00001989 return;
1990
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001991 if (!SP.isDefinition())
1992 // This is a method declaration which will be handled while constructing
1993 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +00001994 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001995
Stuart Hastings639336e2010-04-06 21:38:29 +00001996 DIE *SubprogramDie = createSubprogramDIE(SP);
1997
1998 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +00001999 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002000
2001 // Add to context owner.
Devang Patel6404e4e2009-12-15 19:16:48 +00002002 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +00002003
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002004 // Expose as global.
Devang Patel163a9f72010-05-10 22:49:55 +00002005 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel193f7202009-11-24 01:14:22 +00002006
Devang Patel13e16b62009-06-26 01:49:18 +00002007 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002008}
2009
Devang Patel2c4ceb12009-11-21 02:48:08 +00002010/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbar00564992009-09-19 20:40:14 +00002011/// content. Create global DIEs and emit initial debug info sections.
2012/// This is inovked by the target AsmPrinter.
Chris Lattner75f50722010-04-04 07:48:20 +00002013void DwarfDebug::beginModule(Module *M) {
Devang Pateleac9c072010-04-27 19:46:33 +00002014 if (DisableDebugInfoPrinting)
2015 return;
2016
Devang Patel78ab9e22009-07-30 18:56:46 +00002017 DebugInfoFinder DbgFinder;
2018 DbgFinder.processModule(*M);
Devang Patel13e16b62009-06-26 01:49:18 +00002019
Chris Lattnerd850ac72010-04-05 02:19:28 +00002020 bool HasDebugInfo = false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002021
Chris Lattnerd850ac72010-04-05 02:19:28 +00002022 // Scan all the compile-units to see if there are any marked as the main unit.
2023 // if not, we do not generate debug info.
2024 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2025 E = DbgFinder.compile_unit_end(); I != E; ++I) {
2026 if (DICompileUnit(*I).isMain()) {
2027 HasDebugInfo = true;
2028 break;
2029 }
2030 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002031
Chris Lattnerd850ac72010-04-05 02:19:28 +00002032 if (!HasDebugInfo) return;
2033
2034 // Tell MMI that we have debug info.
2035 MMI->setDebugInfoAvailability(true);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002036
Chris Lattnerbe15beb2010-04-04 23:17:54 +00002037 // Emit initial sections.
Chris Lattnerd850ac72010-04-05 02:19:28 +00002038 EmitSectionLabels();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002039
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002040 // Create all the compile unit DIEs.
Devang Patel78ab9e22009-07-30 18:56:46 +00002041 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2042 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002043 constructCompileUnit(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002044
Devang Patel53bb5c92009-11-10 23:06:00 +00002045 // Create DIEs for each subprogram.
Devang Patel78ab9e22009-07-30 18:56:46 +00002046 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
2047 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002048 constructSubprogramDIE(*I);
Devang Patel13e16b62009-06-26 01:49:18 +00002049
Devang Patelc366f832009-12-10 19:14:49 +00002050 // Create DIEs for each global variable.
2051 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2052 E = DbgFinder.global_variable_end(); I != E; ++I)
2053 constructGlobalVariableDIE(*I);
2054
Devang Patele7e5a0f2010-08-10 20:01:20 +00002055 //getOrCreateTypeDIE
2056 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
2057 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2058 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2059
Devang Patel1a7ca032010-09-28 18:08:20 +00002060 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
2061 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2062 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2063
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002064 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +00002065 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002066
2067 // Print out .file directives to specify files for .loc directives. These are
2068 // printed out early so that they precede any .loc directives.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002069 if (Asm->MAI->hasDotLocAndDotFile()) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002070 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
2071 // Remember source id starts at 1.
2072 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
Chris Lattner0ad9c912010-01-22 22:09:00 +00002073 // FIXME: don't use sys::path for this! This should not depend on the
2074 // host.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002075 sys::Path FullPath(getSourceDirectoryName(Id.first));
2076 bool AppendOk =
2077 FullPath.appendComponent(getSourceFileName(Id.second));
2078 assert(AppendOk && "Could not append filename to directory!");
2079 AppendOk = false;
Chris Lattnera6594fc2010-01-25 18:58:59 +00002080 Asm->OutStreamer.EmitDwarfFileDirective(i, FullPath.str());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002081 }
2082 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002083}
2084
Devang Patel2c4ceb12009-11-21 02:48:08 +00002085/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002086///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002087void DwarfDebug::endModule() {
Devang Patel163a9f72010-05-10 22:49:55 +00002088 if (!FirstCU) return;
Devang Patel4a1cad62010-06-28 18:25:03 +00002089 const Module *M = MMI->getModule();
Devang Patele9a1cca2010-08-02 17:32:15 +00002090 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patel4a1cad62010-06-28 18:25:03 +00002091 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2092 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2093 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2094 DISubprogram SP(AllSPs->getOperand(SI));
2095 if (!SP.Verify()) continue;
2096
2097 // Collect info for variables that were optimized out.
Devang Patel8b3a6b62010-07-19 17:53:55 +00002098 if (!SP.isDefinition()) continue;
Devang Patel4a1cad62010-06-28 18:25:03 +00002099 StringRef FName = SP.getLinkageName();
2100 if (FName.empty())
2101 FName = SP.getName();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002102 NamedMDNode *NMD =
Devang Patel4a1cad62010-06-28 18:25:03 +00002103 M->getNamedMetadata(Twine("llvm.dbg.lv.", getRealLinkageName(FName)));
2104 if (!NMD) continue;
2105 unsigned E = NMD->getNumOperands();
2106 if (!E) continue;
2107 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Patele9a1cca2010-08-02 17:32:15 +00002108 DeadFnScopeMap[SP] = Scope;
Devang Patel4a1cad62010-06-28 18:25:03 +00002109 for (unsigned I = 0; I != E; ++I) {
2110 DIVariable DV(NMD->getOperand(I));
2111 if (!DV.Verify()) continue;
2112 Scope->addVariable(new DbgVariable(DV));
2113 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002114
Devang Patel4a1cad62010-06-28 18:25:03 +00002115 // Construct subprogram DIE and add variables DIEs.
2116 constructSubprogramDIE(SP);
2117 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patele03161c2010-08-09 18:51:29 +00002118 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patel4a1cad62010-06-28 18:25:03 +00002119 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2120 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2121 if (VariableDIE)
2122 ScopeDIE->addChild(VariableDIE);
2123 }
2124 }
2125 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002126
Devang Patel53bb5c92009-11-10 23:06:00 +00002127 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2128 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2129 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2130 DIE *ISP = *AI;
Devang Patel2c4ceb12009-11-21 02:48:08 +00002131 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +00002132 }
2133
Devang Patele9f8f5e2010-05-07 20:54:48 +00002134 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Patel5d11eb02009-12-03 19:11:07 +00002135 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2136 DIE *SPDie = CI->first;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002137 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Patel5d11eb02009-12-03 19:11:07 +00002138 if (!N) continue;
Devang Patel163a9f72010-05-10 22:49:55 +00002139 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Patel5d11eb02009-12-03 19:11:07 +00002140 if (!NDie) continue;
2141 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patel5d11eb02009-12-03 19:11:07 +00002142 }
2143
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002144 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002145 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002146 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002147 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002148 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002149
2150 // End text sections.
2151 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002152 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnerc0215722010-04-04 19:25:43 +00002153 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002154 }
2155
2156 // Emit common frame information.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002157 emitCommonDebugFrame();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002158
2159 // Emit function debug frame information
2160 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2161 E = DebugFrames.end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002162 emitFunctionDebugFrame(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002163
2164 // Compute DIE offsets and sizes.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002165 computeSizeAndOffsets();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002166
2167 // Emit all the DIEs into a debug info section
Devang Patel2c4ceb12009-11-21 02:48:08 +00002168 emitDebugInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002169
2170 // Corresponding abbreviations into a abbrev section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002171 emitAbbreviations();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002172
Devang Patelaf608bd2010-08-24 00:06:12 +00002173 // Emit source line correspondence into a debug line section.
2174 emitDebugLines();
2175
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002176 // Emit info into a debug pubnames section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002177 emitDebugPubNames();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002178
Devang Patel193f7202009-11-24 01:14:22 +00002179 // Emit info into a debug pubtypes section.
2180 emitDebugPubTypes();
2181
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002182 // Emit info into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002183 emitDebugLoc();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002184
2185 // Emit info into a debug aranges section.
2186 EmitDebugARanges();
2187
2188 // Emit info into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002189 emitDebugRanges();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002190
2191 // Emit info into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002192 emitDebugMacInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002193
2194 // Emit inline info.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002195 emitDebugInlineInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002196
Chris Lattnerbc733f52010-03-13 02:17:42 +00002197 // Emit info into a debug str section.
2198 emitDebugStr();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002199
Devang Patele9a1cca2010-08-02 17:32:15 +00002200 // clean up.
2201 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel163a9f72010-05-10 22:49:55 +00002202 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2203 E = CUMap.end(); I != E; ++I)
2204 delete I->second;
2205 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002206}
2207
Devang Patel53bb5c92009-11-10 23:06:00 +00002208/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002209DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattnerde4845c2010-04-02 19:42:39 +00002210 DebugLoc ScopeLoc) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002211
Devang Patel2db49d72010-05-07 18:11:54 +00002212 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00002213 if (AbsDbgVariable)
2214 return AbsDbgVariable;
2215
Devang Patel2db49d72010-05-07 18:11:54 +00002216 LLVMContext &Ctx = Var->getContext();
Chris Lattnerde4845c2010-04-02 19:42:39 +00002217 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00002218 if (!Scope)
2219 return NULL;
2220
Devang Patel26c1e562010-05-20 16:36:41 +00002221 AbsDbgVariable = new DbgVariable(Var);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002222 Scope->addVariable(AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00002223 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00002224 return AbsDbgVariable;
2225}
2226
Devang Patelee432862010-05-20 19:57:06 +00002227/// collectVariableInfoFromMMITable - Collect variable information from
2228/// side table maintained by MMI.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002229void
Devang Patelee432862010-05-20 19:57:06 +00002230DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2231 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00002232 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patele717faa2009-10-06 01:26:37 +00002233 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2234 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2235 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00002236 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00002237 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00002238 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002239 DIVariable DV(Var);
2240 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00002241
Chris Lattnerde4845c2010-04-02 19:42:39 +00002242 DbgScope *Scope = 0;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002243 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattnerde4845c2010-04-02 19:42:39 +00002244 Scope = ConcreteScopes.lookup(IA);
2245 if (Scope == 0)
2246 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002247
Devang Patelfb0ee432009-11-10 23:20:04 +00002248 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00002249 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00002250 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00002251
Devang Patel26c1e562010-05-20 16:36:41 +00002252 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2253 DbgVariable *RegVar = new DbgVariable(DV);
2254 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002255 Scope->addVariable(RegVar);
Devang Patel26c1e562010-05-20 16:36:41 +00002256 if (AbsDbgVariable) {
2257 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2258 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2259 }
Devang Patele717faa2009-10-06 01:26:37 +00002260 }
Devang Patelee432862010-05-20 19:57:06 +00002261}
Devang Patel90a48ad2010-03-15 18:33:46 +00002262
Jim Grosbach1e20b962010-07-21 21:21:52 +00002263/// isDbgValueInUndefinedReg - Return true if debug value, encoded by
Devang Patelc3f5f782010-05-25 23:40:22 +00002264/// DBG_VALUE instruction, is in undefined reg.
2265static bool isDbgValueInUndefinedReg(const MachineInstr *MI) {
2266 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2267 if (MI->getOperand(0).isReg() && !MI->getOperand(0).getReg())
2268 return true;
2269 return false;
2270}
2271
Jim Grosbach1e20b962010-07-21 21:21:52 +00002272/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patelc3f5f782010-05-25 23:40:22 +00002273/// DBG_VALUE instruction, is in a defined reg.
2274static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2275 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2276 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2277 return true;
2278 return false;
2279}
2280
Devang Patelee432862010-05-20 19:57:06 +00002281/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002282void
Devang Patel78e127d2010-06-25 22:07:34 +00002283DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2284 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002285
Devang Patelee432862010-05-20 19:57:06 +00002286 /// collection info from MMI table.
2287 collectVariableInfoFromMMITable(MF, Processed);
2288
2289 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patel90a48ad2010-03-15 18:33:46 +00002290 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002291 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelee432862010-05-20 19:57:06 +00002292 I != E; ++I)
Devang Patel90a48ad2010-03-15 18:33:46 +00002293 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2294 II != IE; ++II) {
2295 const MachineInstr *MInsn = II;
Devang Patelc3f5f782010-05-25 23:40:22 +00002296 if (!MInsn->isDebugValue() || isDbgValueInUndefinedReg(MInsn))
Devang Patel90a48ad2010-03-15 18:33:46 +00002297 continue;
Devang Patelee432862010-05-20 19:57:06 +00002298 DbgValues.push_back(MInsn);
2299 }
Devang Patel90a48ad2010-03-15 18:33:46 +00002300
Devang Patelc3f5f782010-05-25 23:40:22 +00002301 // This is a collection of DBV_VALUE instructions describing same variable.
2302 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patelee432862010-05-20 19:57:06 +00002303 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2304 E = DbgValues.end(); I != E; ++I) {
2305 const MachineInstr *MInsn = *I;
Devang Patelc3f5f782010-05-25 23:40:22 +00002306 MultipleValues.clear();
2307 if (isDbgValueInDefinedReg(MInsn))
2308 MultipleValues.push_back(MInsn);
Devang Patelee432862010-05-20 19:57:06 +00002309 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2310 if (Processed.count(DV) != 0)
2311 continue;
2312
Devang Patel354eb7e2010-06-02 19:05:13 +00002313 const MachineInstr *PrevMI = MInsn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002314 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
Devang Patelc3f5f782010-05-25 23:40:22 +00002315 ME = DbgValues.end(); MI != ME; ++MI) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002316 const MDNode *Var =
Devang Patelc3f5f782010-05-25 23:40:22 +00002317 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002318 if (Var == DV && isDbgValueInDefinedReg(*MI) &&
Devang Patel354eb7e2010-06-02 19:05:13 +00002319 !PrevMI->isIdenticalTo(*MI))
Devang Patelc3f5f782010-05-25 23:40:22 +00002320 MultipleValues.push_back(*MI);
Devang Patel354eb7e2010-06-02 19:05:13 +00002321 PrevMI = *MI;
Devang Patelc3f5f782010-05-25 23:40:22 +00002322 }
2323
Devang Patelee432862010-05-20 19:57:06 +00002324 DbgScope *Scope = findDbgScope(MInsn);
Devang Pateld8720f42010-05-27 20:25:04 +00002325 bool CurFnArg = false;
2326 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2327 DISubprogram(DV.getContext()).describes(MF->getFunction()))
2328 CurFnArg = true;
2329 if (!Scope && CurFnArg)
Devang Patelc0c5a262010-05-21 00:10:20 +00002330 Scope = CurrentFnDbgScope;
Devang Patelee432862010-05-20 19:57:06 +00002331 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00002332 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00002333 continue;
2334
2335 Processed.insert(DV);
Devang Patelee432862010-05-20 19:57:06 +00002336 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patelee432862010-05-20 19:57:06 +00002337 Scope->addVariable(RegVar);
Devang Pateld8720f42010-05-27 20:25:04 +00002338 if (!CurFnArg)
Jim Grosbach1e20b962010-07-21 21:21:52 +00002339 DbgVariableLabelsMap[RegVar] = getLabelBeforeInsn(MInsn);
Devang Patelc0c5a262010-05-21 00:10:20 +00002340 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2341 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2342 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patel90a48ad2010-03-15 18:33:46 +00002343 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002344 if (MultipleValues.size() <= 1) {
2345 DbgVariableToDbgInstMap[RegVar] = MInsn;
2346 continue;
2347 }
2348
2349 // handle multiple DBG_VALUE instructions describing one variable.
Devang Patelc3f5f782010-05-25 23:40:22 +00002350 if (DotDebugLocEntries.empty())
Devang Patel80250682010-05-26 23:55:23 +00002351 RegVar->setDotDebugLocOffset(0);
2352 else
2353 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Devang Patele2df8422010-05-26 17:29:32 +00002354 const MachineInstr *Begin = NULL;
2355 const MachineInstr *End = NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002356 for (SmallVector<const MachineInstr *, 4>::iterator
2357 MVI = MultipleValues.begin(), MVE = MultipleValues.end();
Devang Patel61409622010-07-07 20:12:52 +00002358 MVI != MVE; ++MVI) {
Devang Patele2df8422010-05-26 17:29:32 +00002359 if (!Begin) {
2360 Begin = *MVI;
2361 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002362 }
Devang Patele2df8422010-05-26 17:29:32 +00002363 End = *MVI;
Devang Patelc3f5f782010-05-25 23:40:22 +00002364 MachineLocation MLoc;
Devang Patelb2cf5812010-08-04 18:40:52 +00002365 if (Begin->getNumOperands() == 3) {
2366 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2367 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2368 } else
2369 MLoc = Asm->getDebugValueLocation(Begin);
2370
Devang Patele2df8422010-05-26 17:29:32 +00002371 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2372 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patel5573a7d2010-08-04 22:07:27 +00002373 if (MLoc.getReg())
2374 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
2375
Devang Patele2df8422010-05-26 17:29:32 +00002376 Begin = End;
2377 if (MVI + 1 == MVE) {
2378 // If End is the last instruction then its value is valid
Devang Patelc3f5f782010-05-25 23:40:22 +00002379 // until the end of the funtion.
Devang Patelb2cf5812010-08-04 18:40:52 +00002380 MachineLocation EMLoc;
2381 if (End->getNumOperands() == 3) {
2382 if (End->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2383 EMLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2384 } else
2385 EMLoc = Asm->getDebugValueLocation(End);
Devang Patel5573a7d2010-08-04 22:07:27 +00002386 if (EMLoc.getReg())
2387 DotDebugLocEntries.
2388 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, EMLoc));
Devang Patelc3f5f782010-05-25 23:40:22 +00002389 }
2390 }
2391 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00002392 }
Devang Patel98e1cac2010-05-14 21:01:35 +00002393
2394 // Collect info for variables that were optimized out.
Devang Pateld1bbc6b2010-06-22 01:01:58 +00002395 const Function *F = MF->getFunction();
2396 const Module *M = F->getParent();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002397 if (NamedMDNode *NMD =
2398 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patela762b092010-06-22 01:19:38 +00002399 getRealLinkageName(F->getName())))) {
Devang Patel98e1cac2010-05-14 21:01:35 +00002400 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman872814a2010-07-21 18:54:18 +00002401 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patelee432862010-05-20 19:57:06 +00002402 if (!DV || !Processed.insert(DV))
Devang Patel98e1cac2010-05-14 21:01:35 +00002403 continue;
2404 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2405 if (Scope)
Devang Patel26c1e562010-05-20 16:36:41 +00002406 Scope->addVariable(new DbgVariable(DV));
Devang Patel98e1cac2010-05-14 21:01:35 +00002407 }
2408 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002409}
Devang Patel98e1cac2010-05-14 21:01:35 +00002410
Devang Patelc3f5f782010-05-25 23:40:22 +00002411/// getLabelBeforeInsn - Return Label preceding the instruction.
2412const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2413 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2414 LabelsBeforeInsn.find(MI);
2415 if (I == LabelsBeforeInsn.end())
2416 // FunctionBeginSym always preceeds all the instruction in current function.
2417 return FunctionBeginSym;
2418 return I->second;
2419}
2420
2421/// getLabelAfterInsn - Return Label immediately following the instruction.
2422const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2423 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2424 LabelsAfterInsn.find(MI);
2425 if (I == LabelsAfterInsn.end())
2426 return NULL;
2427 return I->second;
Devang Patele717faa2009-10-06 01:26:37 +00002428}
2429
Devang Patel553881b2010-03-29 17:20:31 +00002430/// beginScope - Process beginning of a scope.
2431void DwarfDebug::beginScope(const MachineInstr *MI) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002432 if (InsnNeedsLabel.count(MI) == 0) {
2433 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patel553881b2010-03-29 17:20:31 +00002434 return;
Devang Patelc3f5f782010-05-25 23:40:22 +00002435 }
Devang Patelaead63c2010-03-29 22:59:58 +00002436
Devang Patelb2b31a62010-05-26 19:37:24 +00002437 // Check location.
2438 DebugLoc DL = MI->getDebugLoc();
2439 if (!DL.isUnknown()) {
2440 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2441 PrevLabel = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
Devang Pateleac9c072010-04-27 19:46:33 +00002442 PrevInstLoc = DL;
Devang Patelb2b31a62010-05-26 19:37:24 +00002443 LabelsBeforeInsn[MI] = PrevLabel;
2444 return;
Devang Pateleac9c072010-04-27 19:46:33 +00002445 }
Devang Patel553881b2010-03-29 17:20:31 +00002446
Jim Grosbach1e20b962010-07-21 21:21:52 +00002447 // If location is unknown then use temp label for this DBG_VALUE
Devang Patelb2b31a62010-05-26 19:37:24 +00002448 // instruction.
2449 if (MI->isDebugValue()) {
Devang Patel77051f52010-05-26 21:23:46 +00002450 PrevLabel = MMI->getContext().CreateTempSymbol();
2451 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00002452 LabelsBeforeInsn[MI] = PrevLabel;
2453 return;
2454 }
2455
2456 if (UnknownLocations) {
2457 PrevLabel = recordSourceLine(0, 0, 0);
2458 LabelsBeforeInsn[MI] = PrevLabel;
2459 return;
2460 }
2461
2462 assert (0 && "Instruction is not processed!");
Devang Patel0d20ac82009-10-06 01:50:42 +00002463}
2464
Devang Patel2c4ceb12009-11-21 02:48:08 +00002465/// endScope - Process end of a scope.
2466void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel1c246352010-04-08 16:50:29 +00002467 if (InsnsEndScopeSet.count(MI) != 0) {
2468 // Emit a label if this instruction ends a scope.
2469 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2470 Asm->OutStreamer.EmitLabel(Label);
Devang Pateleac9c072010-04-27 19:46:33 +00002471 LabelsAfterInsn[MI] = Label;
Devang Patel1c246352010-04-08 16:50:29 +00002472 }
Devang Patel53bb5c92009-11-10 23:06:00 +00002473}
2474
Devang Pateleac9c072010-04-27 19:46:33 +00002475/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002476DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel61409622010-07-07 20:12:52 +00002477 const MDNode *InlinedAt) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002478 if (!InlinedAt) {
2479 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2480 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002481 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002482 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2483 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Pateleac9c072010-04-27 19:46:33 +00002484 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002485 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002486 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Pateleac9c072010-04-27 19:46:33 +00002487 WScope->setParent(Parent);
2488 Parent->addScope(WScope);
2489 }
2490
2491 if (!WScope->getParent()) {
2492 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastingscad22ad2010-06-15 23:06:30 +00002493 // We used to check only for a linkage name, but that fails
2494 // since we began omitting the linkage name for private
2495 // functions. The new way is to check for the name in metadata,
2496 // but that's not supported in old .ll test cases. Ergo, we
2497 // check both.
Stuart Hastings215aa152010-06-11 20:08:44 +00002498 if (SPName == Asm->MF->getFunction()->getName() ||
2499 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Pateleac9c072010-04-27 19:46:33 +00002500 CurrentFnDbgScope = WScope;
2501 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002502
Devang Pateleac9c072010-04-27 19:46:33 +00002503 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002504 }
2505
Devang Patel78e127d2010-06-25 22:07:34 +00002506 getOrCreateAbstractScope(Scope);
Devang Patel53bb5c92009-11-10 23:06:00 +00002507 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2508 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002509 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002510
2511 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2512 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2513 DILocation DL(InlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002514 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002515 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Pateleac9c072010-04-27 19:46:33 +00002516 WScope->setParent(Parent);
2517 Parent->addScope(WScope);
2518
2519 ConcreteScopes[InlinedAt] = WScope;
Devang Pateleac9c072010-04-27 19:46:33 +00002520
2521 return WScope;
Devang Patel0d20ac82009-10-06 01:50:42 +00002522}
2523
Devang Pateleac9c072010-04-27 19:46:33 +00002524/// hasValidLocation - Return true if debug location entry attached with
2525/// machine instruction encodes valid location info.
2526static bool hasValidLocation(LLVMContext &Ctx,
2527 const MachineInstr *MInsn,
Devang Patele9f8f5e2010-05-07 20:54:48 +00002528 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Pateleac9c072010-04-27 19:46:33 +00002529 DebugLoc DL = MInsn->getDebugLoc();
2530 if (DL.isUnknown()) return false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002531
Devang Patele9f8f5e2010-05-07 20:54:48 +00002532 const MDNode *S = DL.getScope(Ctx);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002533
Devang Pateleac9c072010-04-27 19:46:33 +00002534 // There is no need to create another DIE for compile unit. For all
2535 // other scopes, create one DbgScope now. This will be translated
2536 // into a scope DIE at the end.
2537 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002538
Devang Pateleac9c072010-04-27 19:46:33 +00002539 Scope = S;
2540 InlinedAt = DL.getInlinedAt(Ctx);
2541 return true;
2542}
2543
2544/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2545/// hierarchy.
2546static void calculateDominanceGraph(DbgScope *Scope) {
2547 assert (Scope && "Unable to calculate scop edominance graph!");
2548 SmallVector<DbgScope *, 4> WorkStack;
2549 WorkStack.push_back(Scope);
2550 unsigned Counter = 0;
2551 while (!WorkStack.empty()) {
2552 DbgScope *WS = WorkStack.back();
2553 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2554 bool visitedChildren = false;
2555 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2556 SE = Children.end(); SI != SE; ++SI) {
2557 DbgScope *ChildScope = *SI;
2558 if (!ChildScope->getDFSOut()) {
2559 WorkStack.push_back(ChildScope);
2560 visitedChildren = true;
2561 ChildScope->setDFSIn(++Counter);
2562 break;
2563 }
2564 }
2565 if (!visitedChildren) {
2566 WorkStack.pop_back();
2567 WS->setDFSOut(++Counter);
2568 }
2569 }
2570}
2571
2572/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002573static
Devang Pateleac9c072010-04-27 19:46:33 +00002574void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2575 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2576{
2577#ifndef NDEBUG
2578 unsigned PrevDFSIn = 0;
2579 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2580 I != E; ++I) {
2581 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2582 II != IE; ++II) {
2583 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002584 const MDNode *Scope = NULL;
2585 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002586
2587 // Check if instruction has valid location information.
2588 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2589 dbgs() << " [ ";
Jim Grosbach1e20b962010-07-21 21:21:52 +00002590 if (InlinedAt)
Devang Pateleac9c072010-04-27 19:46:33 +00002591 dbgs() << "*";
Jim Grosbach1e20b962010-07-21 21:21:52 +00002592 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Pateleac9c072010-04-27 19:46:33 +00002593 MI2ScopeMap.find(MInsn);
2594 if (DI != MI2ScopeMap.end()) {
2595 DbgScope *S = DI->second;
2596 dbgs() << S->getDFSIn();
2597 PrevDFSIn = S->getDFSIn();
2598 } else
2599 dbgs() << PrevDFSIn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002600 } else
Devang Pateleac9c072010-04-27 19:46:33 +00002601 dbgs() << " [ x" << PrevDFSIn;
2602 dbgs() << " ]";
2603 MInsn->dump();
2604 }
2605 dbgs() << "\n";
2606 }
2607#endif
2608}
Devang Patel2c4ceb12009-11-21 02:48:08 +00002609/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner14d750d2010-03-31 05:39:57 +00002610/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattnereec791a2010-01-26 23:18:02 +00002611bool DwarfDebug::extractScopeInformation() {
Devang Patelaf9e8472009-10-01 20:31:14 +00002612 // If scope information was extracted using .dbg intrinsics then there is not
2613 // any need to extract these information by scanning each instruction.
2614 if (!DbgScopeMap.empty())
2615 return false;
2616
Dan Gohman314bf7c2010-04-23 01:18:53 +00002617 // Scan each instruction and create scopes. First build working set of scopes.
Devang Pateleac9c072010-04-27 19:46:33 +00002618 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2619 SmallVector<DbgRange, 4> MIRanges;
2620 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002621 const MDNode *PrevScope = NULL;
2622 const MDNode *PrevInlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002623 const MachineInstr *RangeBeginMI = NULL;
2624 const MachineInstr *PrevMI = NULL;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002625 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelaf9e8472009-10-01 20:31:14 +00002626 I != E; ++I) {
2627 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2628 II != IE; ++II) {
2629 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002630 const MDNode *Scope = NULL;
2631 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002632
2633 // Check if instruction has valid location information.
2634 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2635 PrevMI = MInsn;
2636 continue;
2637 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002638
Devang Pateleac9c072010-04-27 19:46:33 +00002639 // If scope has not changed then skip this instruction.
2640 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2641 PrevMI = MInsn;
2642 continue;
2643 }
2644
Jim Grosbach1e20b962010-07-21 21:21:52 +00002645 if (RangeBeginMI) {
2646 // If we have alread seen a beginning of a instruction range and
Devang Pateleac9c072010-04-27 19:46:33 +00002647 // current instruction scope does not match scope of first instruction
2648 // in this range then create a new instruction range.
2649 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002650 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel61409622010-07-07 20:12:52 +00002651 PrevInlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002652 MIRanges.push_back(R);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002653 }
Devang Pateleac9c072010-04-27 19:46:33 +00002654
2655 // This is a beginning of a new instruction range.
2656 RangeBeginMI = MInsn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002657
Devang Pateleac9c072010-04-27 19:46:33 +00002658 // Reset previous markers.
2659 PrevMI = MInsn;
2660 PrevScope = Scope;
2661 PrevInlinedAt = InlinedAt;
Devang Patel53bb5c92009-11-10 23:06:00 +00002662 }
2663 }
2664
Devang Pateleac9c072010-04-27 19:46:33 +00002665 // Create last instruction range.
2666 if (RangeBeginMI && PrevMI && PrevScope) {
2667 DbgRange R(RangeBeginMI, PrevMI);
2668 MIRanges.push_back(R);
2669 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patelaf9e8472009-10-01 20:31:14 +00002670 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002671
Devang Patel344130e2010-01-04 20:44:00 +00002672 if (!CurrentFnDbgScope)
2673 return false;
2674
Devang Pateleac9c072010-04-27 19:46:33 +00002675 calculateDominanceGraph(CurrentFnDbgScope);
2676 if (PrintDbgScope)
2677 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2678
2679 // Find ranges of instructions covered by each DbgScope;
2680 DbgScope *PrevDbgScope = NULL;
2681 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2682 RE = MIRanges.end(); RI != RE; ++RI) {
2683 const DbgRange &R = *RI;
2684 DbgScope *S = MI2ScopeMap.lookup(R.first);
2685 assert (S && "Lost DbgScope for a machine instruction!");
2686 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2687 PrevDbgScope->closeInsnRange(S);
2688 S->openInsnRange(R.first);
2689 S->extendInsnRange(R.second);
2690 PrevDbgScope = S;
2691 }
2692
2693 if (PrevDbgScope)
2694 PrevDbgScope->closeInsnRange();
Devang Patelaf9e8472009-10-01 20:31:14 +00002695
Devang Patele37b0c62010-04-08 18:43:56 +00002696 identifyScopeMarkers();
Devang Patel6122a4d2010-04-08 15:37:09 +00002697
2698 return !DbgScopeMap.empty();
2699}
2700
Jim Grosbach1e20b962010-07-21 21:21:52 +00002701/// identifyScopeMarkers() -
Devang Pateleac9c072010-04-27 19:46:33 +00002702/// Each DbgScope has first instruction and last instruction to mark beginning
2703/// and end of a scope respectively. Create an inverse map that list scopes
2704/// starts (and ends) with an instruction. One instruction may start (or end)
2705/// multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00002706void DwarfDebug::identifyScopeMarkers() {
Devang Patel42aafd72010-01-20 02:05:23 +00002707 SmallVector<DbgScope *, 4> WorkList;
2708 WorkList.push_back(CurrentFnDbgScope);
2709 while (!WorkList.empty()) {
Chris Lattner14d750d2010-03-31 05:39:57 +00002710 DbgScope *S = WorkList.pop_back_val();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002711
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002712 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002713 if (!Children.empty())
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002714 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00002715 SE = Children.end(); SI != SE; ++SI)
2716 WorkList.push_back(*SI);
2717
Devang Patel53bb5c92009-11-10 23:06:00 +00002718 if (S->isAbstractScope())
2719 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002720
Devang Pateleac9c072010-04-27 19:46:33 +00002721 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2722 if (Ranges.empty())
2723 continue;
2724 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2725 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002726 assert(RI->first && "DbgRange does not have first instruction!");
2727 assert(RI->second && "DbgRange does not have second instruction!");
Devang Pateleac9c072010-04-27 19:46:33 +00002728 InsnsEndScopeSet.insert(RI->second);
2729 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002730 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002731}
2732
Dan Gohman084751c2010-04-20 00:37:27 +00002733/// FindFirstDebugLoc - Find the first debug location in the function. This
2734/// is intended to be an approximation for the source position of the
2735/// beginning of the function.
2736static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2737 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2738 I != E; ++I)
2739 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2740 MBBI != MBBE; ++MBBI) {
2741 DebugLoc DL = MBBI->getDebugLoc();
2742 if (!DL.isUnknown())
2743 return DL;
2744 }
2745 return DebugLoc();
2746}
2747
Devang Patel2c4ceb12009-11-21 02:48:08 +00002748/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002749/// emitted immediately after the function entry point.
Chris Lattnereec791a2010-01-26 23:18:02 +00002750void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00002751 if (!MMI->hasDebugInfo()) return;
Bill Wendling5f017e82010-04-07 09:28:04 +00002752 if (!extractScopeInformation()) return;
Devang Patel60b35bd2009-10-06 18:37:31 +00002753
Devang Pateleac9c072010-04-27 19:46:33 +00002754 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2755 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002756 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00002757 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002758
2759 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2760 // function.
Dan Gohman084751c2010-04-20 00:37:27 +00002761 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002762 if (FDL.isUnknown()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002763
Devang Patele9f8f5e2010-05-07 20:54:48 +00002764 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings0db42712010-07-19 23:56:30 +00002765 const MDNode *TheScope = 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002766
Chris Lattnerde4845c2010-04-02 19:42:39 +00002767 DISubprogram SP = getDISubprogram(Scope);
2768 unsigned Line, Col;
2769 if (SP.Verify()) {
2770 Line = SP.getLineNumber();
2771 Col = 0;
Stuart Hastings0db42712010-07-19 23:56:30 +00002772 TheScope = SP;
Chris Lattnerde4845c2010-04-02 19:42:39 +00002773 } else {
2774 Line = FDL.getLine();
2775 Col = FDL.getCol();
Stuart Hastings0db42712010-07-19 23:56:30 +00002776 TheScope = Scope;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002777 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002778
Stuart Hastings0db42712010-07-19 23:56:30 +00002779 recordSourceLine(Line, Col, TheScope);
Devang Patelb2b31a62010-05-26 19:37:24 +00002780
Devang Patelb9abe9f2010-06-02 16:42:51 +00002781 /// ProcessedArgs - Collection of arguments already processed.
2782 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2783
Devang Patelb2b31a62010-05-26 19:37:24 +00002784 DebugLoc PrevLoc;
2785 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2786 I != E; ++I)
2787 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2788 II != IE; ++II) {
2789 const MachineInstr *MI = II;
2790 DebugLoc DL = MI->getDebugLoc();
2791 if (MI->isDebugValue()) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002792 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2793 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2794 if (!DV.Verify()) continue;
Devang Patel55e97172010-05-27 16:47:30 +00002795 // If DBG_VALUE is for a local variable then it needs a label.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002796 if (DV.getTag() != dwarf::DW_TAG_arg_variable
Devang Patel7fb231c2010-07-01 21:38:08 +00002797 && isDbgValueInUndefinedReg(MI) == false)
Devang Patelb2b31a62010-05-26 19:37:24 +00002798 InsnNeedsLabel.insert(MI);
Devang Patel55e97172010-05-27 16:47:30 +00002799 // DBG_VALUE for inlined functions argument needs a label.
Devang Patel7fb231c2010-07-01 21:38:08 +00002800 else if (!DISubprogram(getDISubprogram(DV.getContext())).
2801 describes(MF->getFunction()))
Devang Patel55e97172010-05-27 16:47:30 +00002802 InsnNeedsLabel.insert(MI);
2803 // DBG_VALUE indicating argument location change needs a label.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002804 else if (isDbgValueInUndefinedReg(MI) == false
2805 && !ProcessedArgs.insert(DV))
Devang Patelb2b31a62010-05-26 19:37:24 +00002806 InsnNeedsLabel.insert(MI);
2807 } else {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002808 // If location is unknown then instruction needs a location only if
Devang Patelb2b31a62010-05-26 19:37:24 +00002809 // UnknownLocations flag is set.
2810 if (DL.isUnknown()) {
2811 if (UnknownLocations && !PrevLoc.isUnknown())
2812 InsnNeedsLabel.insert(MI);
2813 } else if (DL != PrevLoc)
2814 // Otherwise, instruction needs a location only if it is new location.
2815 InsnNeedsLabel.insert(MI);
2816 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002817
Devang Patelb2b31a62010-05-26 19:37:24 +00002818 if (!DL.isUnknown() || UnknownLocations)
2819 PrevLoc = DL;
2820 }
2821
2822 PrevLabel = FunctionBeginSym;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002823}
2824
Devang Patel2c4ceb12009-11-21 02:48:08 +00002825/// endFunction - Gather and emit post-function debug information.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002826///
Chris Lattnereec791a2010-01-26 23:18:02 +00002827void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendling5f017e82010-04-07 09:28:04 +00002828 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00002829
Devang Patel344130e2010-01-04 20:44:00 +00002830 if (CurrentFnDbgScope) {
Devang Patel65eb4822010-05-22 00:04:14 +00002831
Devang Patelc3f5f782010-05-25 23:40:22 +00002832 // Define end label for subprogram.
2833 FunctionEndSym = Asm->GetTempSymbol("func_end",
2834 Asm->getFunctionNumber());
2835 // Assumes in correct section after the entry point.
2836 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002837
Devang Patel78e127d2010-06-25 22:07:34 +00002838 SmallPtrSet<const MDNode *, 16> ProcessedVars;
2839 collectVariableInfo(MF, ProcessedVars);
Devang Patel65eb4822010-05-22 00:04:14 +00002840
Devang Patel344130e2010-01-04 20:44:00 +00002841 // Get function line info.
2842 if (!Lines.empty()) {
2843 // Get section line info.
2844 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2845 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2846 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2847 // Append the function info to section info.
2848 SectionLineInfos.insert(SectionLineInfos.end(),
2849 Lines.begin(), Lines.end());
2850 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002851
Devang Patel344130e2010-01-04 20:44:00 +00002852 // Construct abstract scopes.
2853 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel78e127d2010-06-25 22:07:34 +00002854 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel78e127d2010-06-25 22:07:34 +00002855 DISubprogram SP((*AI)->getScopeNode());
2856 if (SP.Verify()) {
2857 // Collect info for variables that were optimized out.
2858 StringRef FName = SP.getLinkageName();
2859 if (FName.empty())
2860 FName = SP.getName();
2861 const Module *M = MF->getFunction()->getParent();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002862 if (NamedMDNode *NMD =
2863 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patel78e127d2010-06-25 22:07:34 +00002864 getRealLinkageName(FName)))) {
2865 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman872814a2010-07-21 18:54:18 +00002866 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel78e127d2010-06-25 22:07:34 +00002867 if (!DV || !ProcessedVars.insert(DV))
2868 continue;
Devang Patel1d68d212010-06-30 00:11:08 +00002869 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel78e127d2010-06-25 22:07:34 +00002870 if (Scope)
2871 Scope->addVariable(new DbgVariable(DV));
2872 }
2873 }
2874 }
Devang Patel90e19aa2010-06-30 01:40:11 +00002875 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
2876 constructScopeDIE(*AI);
Devang Patel78e127d2010-06-25 22:07:34 +00002877 }
Devang Patel61409622010-07-07 20:12:52 +00002878
Devang Patel9c488372010-05-04 06:15:30 +00002879 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002880
Devang Patel9c488372010-05-04 06:15:30 +00002881 if (!DisableFramePointerElim(*MF))
Jim Grosbach1e20b962010-07-21 21:21:52 +00002882 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel9c488372010-05-04 06:15:30 +00002883 dwarf::DW_FORM_flag, 1);
2884
2885
Chris Lattnerd38fee82010-04-05 00:13:49 +00002886 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel344130e2010-01-04 20:44:00 +00002887 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002888 }
2889
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002890 // Clear debug info
Devang Patelf54b8522010-01-19 01:26:02 +00002891 CurrentFnDbgScope = NULL;
Devang Patelb2b31a62010-05-26 19:37:24 +00002892 InsnNeedsLabel.clear();
Devang Patel26c1e562010-05-20 16:36:41 +00002893 DbgVariableToFrameIndexMap.clear();
2894 VarToAbstractVarMap.clear();
2895 DbgVariableToDbgInstMap.clear();
2896 DbgVariableLabelsMap.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002897 DeleteContainerSeconds(DbgScopeMap);
Devang Patel51424712010-04-09 16:04:20 +00002898 InsnsEndScopeSet.clear();
Devang Patelf54b8522010-01-19 01:26:02 +00002899 ConcreteScopes.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002900 DeleteContainerSeconds(AbstractScopes);
Devang Patelf54b8522010-01-19 01:26:02 +00002901 AbstractScopesList.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002902 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00002903 LabelsBeforeInsn.clear();
2904 LabelsAfterInsn.clear();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002905 Lines.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00002906 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002907}
2908
Devang Patel26c1e562010-05-20 16:36:41 +00002909/// recordVariableFrameIndex - Record a variable's index.
2910void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2911 assert (V && "Invalid DbgVariable!");
2912 DbgVariableToFrameIndexMap[V] = Index;
2913}
2914
2915/// findVariableFrameIndex - Return true if frame index for the variable
2916/// is found. Update FI to hold value of the index.
2917bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
2918 assert (V && "Invalid DbgVariable!");
2919 DenseMap<const DbgVariable *, int>::iterator I =
2920 DbgVariableToFrameIndexMap.find(V);
2921 if (I == DbgVariableToFrameIndexMap.end())
2922 return false;
2923 *FI = I->second;
2924 return true;
2925}
2926
2927/// findVariableLabel - Find MCSymbol for the variable.
2928const MCSymbol *DwarfDebug::findVariableLabel(const DbgVariable *V) {
2929 DenseMap<const DbgVariable *, const MCSymbol *>::iterator I
2930 = DbgVariableLabelsMap.find(V);
2931 if (I == DbgVariableLabelsMap.end())
2932 return NULL;
2933 else return I->second;
2934}
2935
Jim Grosbach1e20b962010-07-21 21:21:52 +00002936/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patelee432862010-05-20 19:57:06 +00002937/// instruction.
2938DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
2939 DbgScope *Scope = NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002940 LLVMContext &Ctx =
Devang Patelee432862010-05-20 19:57:06 +00002941 MInsn->getParent()->getParent()->getFunction()->getContext();
2942 DebugLoc DL = MInsn->getDebugLoc();
2943
Jim Grosbach1e20b962010-07-21 21:21:52 +00002944 if (DL.isUnknown())
Devang Patelee432862010-05-20 19:57:06 +00002945 return Scope;
2946
2947 if (const MDNode *IA = DL.getInlinedAt(Ctx))
2948 Scope = ConcreteScopes.lookup(IA);
2949 if (Scope == 0)
2950 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002951
Devang Patelee432862010-05-20 19:57:06 +00002952 return Scope;
2953}
2954
2955
Chris Lattnerc6087842010-03-09 04:54:43 +00002956/// recordSourceLine - Register a source line with debug info. Returns the
2957/// unique label that was emitted and which provides correspondence to
2958/// the source line list.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002959MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel61409622010-07-07 20:12:52 +00002960 const MDNode *S) {
Devang Patel65dbc902009-11-25 17:36:49 +00002961 StringRef Dir;
2962 StringRef Fn;
Devang Patelf84548d2009-10-05 18:03:19 +00002963
Dan Gohman1cc0d622010-05-05 23:41:32 +00002964 unsigned Src = 1;
2965 if (S) {
2966 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00002967
Dan Gohman1cc0d622010-05-05 23:41:32 +00002968 if (Scope.isCompileUnit()) {
2969 DICompileUnit CU(S);
2970 Dir = CU.getDirectory();
2971 Fn = CU.getFilename();
2972 } else if (Scope.isSubprogram()) {
2973 DISubprogram SP(S);
2974 Dir = SP.getDirectory();
2975 Fn = SP.getFilename();
2976 } else if (Scope.isLexicalBlock()) {
2977 DILexicalBlock DB(S);
2978 Dir = DB.getDirectory();
2979 Fn = DB.getFilename();
2980 } else
2981 assert(0 && "Unexpected scope info");
2982
2983 Src = GetOrCreateSourceID(Dir, Fn);
2984 }
2985
Chris Lattner63d78362010-03-14 08:36:50 +00002986 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattner25b68c62010-03-14 08:15:55 +00002987 Lines.push_back(SrcLineInfo(Line, Col, Src, Label));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002988
Chris Lattnerc6087842010-03-09 04:54:43 +00002989 Asm->OutStreamer.EmitLabel(Label);
2990 return Label;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002991}
2992
Bill Wendling829e67b2009-05-20 23:22:40 +00002993//===----------------------------------------------------------------------===//
2994// Emit Methods
2995//===----------------------------------------------------------------------===//
2996
Devang Patel2c4ceb12009-11-21 02:48:08 +00002997/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling94d04b82009-05-20 23:21:38 +00002998///
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002999unsigned
3000DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003001 // Get the children.
3002 const std::vector<DIE *> &Children = Die->getChildren();
3003
3004 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00003005 if (!Last && !Children.empty())
Benjamin Kramer345ef342010-03-31 19:34:01 +00003006 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling94d04b82009-05-20 23:21:38 +00003007
3008 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003009 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00003010
3011 // Get the abbreviation for this DIE.
3012 unsigned AbbrevNumber = Die->getAbbrevNumber();
3013 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3014
3015 // Set DIE offset
3016 Die->setOffset(Offset);
3017
3018 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00003019 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00003020
3021 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
3022 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3023
3024 // Size the DIE attribute values.
3025 for (unsigned i = 0, N = Values.size(); i < N; ++i)
3026 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00003027 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00003028
3029 // Size the DIE children if any.
3030 if (!Children.empty()) {
3031 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
3032 "Children flag not set");
3033
3034 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00003035 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling94d04b82009-05-20 23:21:38 +00003036
3037 // End of children marker.
3038 Offset += sizeof(int8_t);
3039 }
3040
3041 Die->setSize(Offset - Die->getOffset());
3042 return Offset;
3043}
3044
Devang Patel2c4ceb12009-11-21 02:48:08 +00003045/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling94d04b82009-05-20 23:21:38 +00003046///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003047void DwarfDebug::computeSizeAndOffsets() {
Devang Patel163a9f72010-05-10 22:49:55 +00003048 unsigned PrevOffset = 0;
3049 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3050 E = CUMap.end(); I != E; ++I) {
3051 // Compute size of compile unit header.
3052 static unsigned Offset = PrevOffset +
3053 sizeof(int32_t) + // Length of Compilation Unit Info
3054 sizeof(int16_t) + // DWARF version number
3055 sizeof(int32_t) + // Offset Into Abbrev. Section
3056 sizeof(int8_t); // Pointer Size (in bytes)
3057 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
3058 PrevOffset = Offset;
3059 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003060}
3061
Chris Lattner11b8f302010-04-04 23:02:02 +00003062/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3063/// temporary label to it if SymbolStem is specified.
Chris Lattner9c69e285532010-04-04 22:59:04 +00003064static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner11b8f302010-04-04 23:02:02 +00003065 const char *SymbolStem = 0) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00003066 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner11b8f302010-04-04 23:02:02 +00003067 if (!SymbolStem) return 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003068
Chris Lattner9c69e285532010-04-04 22:59:04 +00003069 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3070 Asm->OutStreamer.EmitLabel(TmpSym);
3071 return TmpSym;
3072}
3073
3074/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3075/// the start of each one.
Chris Lattnerfa070b02010-04-04 22:33:59 +00003076void DwarfDebug::EmitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003077 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003078
Bill Wendling94d04b82009-05-20 23:21:38 +00003079 // Dwarf sections base addresses.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003080 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00003081 DwarfFrameSectionSym =
3082 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3083 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003084
Jim Grosbach1e20b962010-07-21 21:21:52 +00003085 DwarfInfoSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003086 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003087 DwarfAbbrevSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003088 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner11b8f302010-04-04 23:02:02 +00003089 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003090
Chris Lattner9c69e285532010-04-04 22:59:04 +00003091 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner11b8f302010-04-04 23:02:02 +00003092 EmitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003093
Devang Patelaf608bd2010-08-24 00:06:12 +00003094 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner11b8f302010-04-04 23:02:02 +00003095 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3096 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3097 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003098 DwarfStrSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003099 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patelf2548ca2010-04-16 23:33:45 +00003100 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3101 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00003102
Devang Patelc3f5f782010-05-25 23:40:22 +00003103 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3104 "section_debug_loc");
3105
Chris Lattner9c69e285532010-04-04 22:59:04 +00003106 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattner4ad1efe2010-04-04 23:10:38 +00003107 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003108}
3109
Devang Patel2c4ceb12009-11-21 02:48:08 +00003110/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling94d04b82009-05-20 23:21:38 +00003111///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003112void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003113 // Get the abbreviation for this DIE.
3114 unsigned AbbrevNumber = Die->getAbbrevNumber();
3115 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3116
Bill Wendling94d04b82009-05-20 23:21:38 +00003117 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00003118 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00003119 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3120 Twine::utohexstr(Die->getOffset()) + ":0x" +
3121 Twine::utohexstr(Die->getSize()) + " " +
3122 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003123 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00003124
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00003125 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling94d04b82009-05-20 23:21:38 +00003126 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3127
3128 // Emit the DIE attribute values.
3129 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3130 unsigned Attr = AbbrevData[i].getAttribute();
3131 unsigned Form = AbbrevData[i].getForm();
3132 assert(Form && "Too many attributes for DIE (check abbreviation)");
3133
Chris Lattner3f53c832010-04-04 18:52:31 +00003134 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00003135 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003136
Bill Wendling94d04b82009-05-20 23:21:38 +00003137 switch (Attr) {
3138 case dwarf::DW_AT_sibling:
Devang Patel2c4ceb12009-11-21 02:48:08 +00003139 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003140 break;
3141 case dwarf::DW_AT_abstract_origin: {
3142 DIEEntry *E = cast<DIEEntry>(Values[i]);
3143 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00003144 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00003145 Asm->EmitInt32(Addr);
3146 break;
3147 }
Devang Patelf2548ca2010-04-16 23:33:45 +00003148 case dwarf::DW_AT_ranges: {
3149 // DW_AT_range Value encodes offset in debug_range section.
3150 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelb1fcfbe2010-09-02 16:43:44 +00003151
3152 if (Asm->MAI->doesDwarfUsesLabelOffsetForRanges()) {
3153 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
3154 V->getValue(),
3155 4);
3156 } else {
3157 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3158 V->getValue(),
3159 DwarfDebugRangeSectionSym,
3160 4);
3161 }
Devang Patelf2548ca2010-04-16 23:33:45 +00003162 break;
3163 }
Devang Patelc3f5f782010-05-25 23:40:22 +00003164 case dwarf::DW_AT_location: {
3165 if (UseDotDebugLocEntry.count(Die) != 0) {
3166 DIELabel *L = cast<DIELabel>(Values[i]);
3167 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
3168 } else
3169 Values[i]->EmitValue(Asm, Form);
3170 break;
3171 }
Devang Patel2a361602010-09-29 19:08:08 +00003172 case dwarf::DW_AT_accessibility: {
3173 if (Asm->isVerbose()) {
3174 DIEInteger *V = cast<DIEInteger>(Values[i]);
3175 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
3176 }
3177 Values[i]->EmitValue(Asm, Form);
3178 break;
3179 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003180 default:
3181 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003182 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00003183 break;
3184 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003185 }
3186
3187 // Emit the DIE children if any.
3188 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3189 const std::vector<DIE *> &Children = Die->getChildren();
3190
3191 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00003192 emitDIE(Children[j]);
Bill Wendling94d04b82009-05-20 23:21:38 +00003193
Chris Lattner3f53c832010-04-04 18:52:31 +00003194 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00003195 Asm->OutStreamer.AddComment("End Of Children Mark");
3196 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003197 }
3198}
3199
Devang Patel8a241142009-12-09 18:24:21 +00003200/// emitDebugInfo - Emit the debug info section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003201///
Devang Patel8a241142009-12-09 18:24:21 +00003202void DwarfDebug::emitDebugInfo() {
3203 // Start debug info section.
3204 Asm->OutStreamer.SwitchSection(
3205 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel163a9f72010-05-10 22:49:55 +00003206 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3207 E = CUMap.end(); I != E; ++I) {
3208 CompileUnit *TheCU = I->second;
3209 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00003210
Devang Patel163a9f72010-05-10 22:49:55 +00003211 // Emit the compile units header.
3212 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3213 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003214
Devang Patel163a9f72010-05-10 22:49:55 +00003215 // Emit size of content not including length itself
3216 unsigned ContentSize = Die->getSize() +
3217 sizeof(int16_t) + // DWARF version number
3218 sizeof(int32_t) + // Offset Into Abbrev. Section
3219 sizeof(int8_t) + // Pointer Size (in bytes)
3220 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003221
Devang Patel163a9f72010-05-10 22:49:55 +00003222 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3223 Asm->EmitInt32(ContentSize);
3224 Asm->OutStreamer.AddComment("DWARF version number");
3225 Asm->EmitInt16(dwarf::DWARF_VERSION);
3226 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3227 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3228 DwarfAbbrevSectionSym);
3229 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3230 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003231
Devang Patel163a9f72010-05-10 22:49:55 +00003232 emitDIE(Die);
3233 // FIXME - extra padding for gdb bug.
3234 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3235 Asm->EmitInt8(0);
3236 Asm->EmitInt8(0);
3237 Asm->EmitInt8(0);
3238 Asm->EmitInt8(0);
3239 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3240 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003241}
3242
Devang Patel2c4ceb12009-11-21 02:48:08 +00003243/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003244///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003245void DwarfDebug::emitAbbreviations() const {
Bill Wendling94d04b82009-05-20 23:21:38 +00003246 // Check to see if it is worth the effort.
3247 if (!Abbreviations.empty()) {
3248 // Start the debug abbrev section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003249 Asm->OutStreamer.SwitchSection(
3250 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003251
Chris Lattnerc0215722010-04-04 19:25:43 +00003252 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003253
3254 // For each abbrevation.
3255 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3256 // Get abbreviation data
3257 const DIEAbbrev *Abbrev = Abbreviations[i];
3258
3259 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003260 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00003261
3262 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003263 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00003264 }
3265
3266 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003267 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00003268
Chris Lattnerc0215722010-04-04 19:25:43 +00003269 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003270 }
3271}
3272
Devang Patel2c4ceb12009-11-21 02:48:08 +00003273/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling94d04b82009-05-20 23:21:38 +00003274/// the line matrix.
3275///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003276void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003277 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00003278 Asm->OutStreamer.AddComment("Extended Op");
3279 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003280
Chris Lattner233f52b2010-03-09 23:52:58 +00003281 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003282 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003283 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3284 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3285
3286 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00003287
Chris Lattnerc0215722010-04-04 19:25:43 +00003288 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003289 Asm->getTargetData().getPointerSize(),
3290 0/*AddrSpace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003291
3292 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00003293 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3294 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00003295 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00003296 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003297}
3298
Devang Patel2c4ceb12009-11-21 02:48:08 +00003299/// emitDebugLines - Emit source line information.
Bill Wendling94d04b82009-05-20 23:21:38 +00003300///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003301void DwarfDebug::emitDebugLines() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003302 // If the target is using .loc/.file, the assembler will be emitting the
3303 // .debug_line table automatically.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003304 if (Asm->MAI->hasDotLocAndDotFile())
Bill Wendling94d04b82009-05-20 23:21:38 +00003305 return;
3306
3307 // Minimum line delta, thus ranging from -10..(255-10).
3308 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
3309 // Maximum line delta, thus ranging from -10..(255-10).
3310 const int MaxLineDelta = 255 + MinLineDelta;
3311
3312 // Start the dwarf line section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003313 Asm->OutStreamer.SwitchSection(
3314 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003315
3316 // Construct the section header.
Chris Lattner233f52b2010-03-09 23:52:58 +00003317 Asm->OutStreamer.AddComment("Length of Source Line Info");
Chris Lattnera6437182010-04-04 19:58:12 +00003318 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_end"),
3319 Asm->GetTempSymbol("line_begin"), 4);
Chris Lattnerc0215722010-04-04 19:25:43 +00003320 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003321
Chris Lattner233f52b2010-03-09 23:52:58 +00003322 Asm->OutStreamer.AddComment("DWARF version number");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003323 Asm->EmitInt16(dwarf::DWARF_VERSION);
Bill Wendling94d04b82009-05-20 23:21:38 +00003324
Chris Lattner233f52b2010-03-09 23:52:58 +00003325 Asm->OutStreamer.AddComment("Prolog Length");
Chris Lattnera6437182010-04-04 19:58:12 +00003326 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_prolog_end"),
3327 Asm->GetTempSymbol("line_prolog_begin"), 4);
Chris Lattnerc0215722010-04-04 19:25:43 +00003328 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003329
Chris Lattner233f52b2010-03-09 23:52:58 +00003330 Asm->OutStreamer.AddComment("Minimum Instruction Length");
3331 Asm->EmitInt8(1);
3332 Asm->OutStreamer.AddComment("Default is_stmt_start flag");
3333 Asm->EmitInt8(1);
3334 Asm->OutStreamer.AddComment("Line Base Value (Special Opcodes)");
3335 Asm->EmitInt8(MinLineDelta);
3336 Asm->OutStreamer.AddComment("Line Range Value (Special Opcodes)");
3337 Asm->EmitInt8(MaxLineDelta);
3338 Asm->OutStreamer.AddComment("Special Opcode Base");
3339 Asm->EmitInt8(-MinLineDelta);
Bill Wendling94d04b82009-05-20 23:21:38 +00003340
3341 // Line number standard opcode encodings argument count
Chris Lattner233f52b2010-03-09 23:52:58 +00003342 Asm->OutStreamer.AddComment("DW_LNS_copy arg count");
3343 Asm->EmitInt8(0);
3344 Asm->OutStreamer.AddComment("DW_LNS_advance_pc arg count");
3345 Asm->EmitInt8(1);
3346 Asm->OutStreamer.AddComment("DW_LNS_advance_line arg count");
3347 Asm->EmitInt8(1);
3348 Asm->OutStreamer.AddComment("DW_LNS_set_file arg count");
3349 Asm->EmitInt8(1);
3350 Asm->OutStreamer.AddComment("DW_LNS_set_column arg count");
3351 Asm->EmitInt8(1);
3352 Asm->OutStreamer.AddComment("DW_LNS_negate_stmt arg count");
3353 Asm->EmitInt8(0);
3354 Asm->OutStreamer.AddComment("DW_LNS_set_basic_block arg count");
3355 Asm->EmitInt8(0);
3356 Asm->OutStreamer.AddComment("DW_LNS_const_add_pc arg count");
3357 Asm->EmitInt8(0);
3358 Asm->OutStreamer.AddComment("DW_LNS_fixed_advance_pc arg count");
3359 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003360
3361 // Emit directories.
3362 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
Chris Lattner4cf202b2010-01-23 03:11:46 +00003363 const std::string &Dir = getSourceDirectoryName(DI);
Chris Lattner3f53c832010-04-04 18:52:31 +00003364 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Directory");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003365 Asm->OutStreamer.EmitBytes(StringRef(Dir.c_str(), Dir.size()+1), 0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003366 }
3367
Chris Lattner233f52b2010-03-09 23:52:58 +00003368 Asm->OutStreamer.AddComment("End of directories");
3369 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003370
3371 // Emit files.
3372 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
3373 // Remember source id starts at 1.
3374 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
Chris Lattner4cf202b2010-01-23 03:11:46 +00003375 const std::string &FN = getSourceFileName(Id.second);
Chris Lattner3f53c832010-04-04 18:52:31 +00003376 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Source");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003377 Asm->OutStreamer.EmitBytes(StringRef(FN.c_str(), FN.size()+1), 0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003378
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003379 Asm->EmitULEB128(Id.first, "Directory #");
3380 Asm->EmitULEB128(0, "Mod date");
3381 Asm->EmitULEB128(0, "File size");
Bill Wendling94d04b82009-05-20 23:21:38 +00003382 }
3383
Chris Lattner233f52b2010-03-09 23:52:58 +00003384 Asm->OutStreamer.AddComment("End of files");
3385 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003386
Chris Lattnerc0215722010-04-04 19:25:43 +00003387 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003388
3389 // A sequence for each text section.
3390 unsigned SecSrcLinesSize = SectionSourceLines.size();
3391
3392 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
3393 // Isolate current sections line info.
3394 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
3395
Bill Wendling94d04b82009-05-20 23:21:38 +00003396 // Dwarf assumes we start with first line of first source file.
3397 unsigned Source = 1;
3398 unsigned Line = 1;
3399
3400 // Construct rows of the address, source, line, column matrix.
3401 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
3402 const SrcLineInfo &LineInfo = LineInfos[i];
Chris Lattner25b68c62010-03-14 08:15:55 +00003403 MCSymbol *Label = LineInfo.getLabel();
Chris Lattnerb9130602010-03-14 02:20:58 +00003404 if (!Label->isDefined()) continue; // Not emitted, in dead code.
Bill Wendling94d04b82009-05-20 23:21:38 +00003405
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003406 if (Asm->isVerbose()) {
Chris Lattner188a87d2010-03-10 01:04:13 +00003407 std::pair<unsigned, unsigned> SrcID =
Bill Wendling94d04b82009-05-20 23:21:38 +00003408 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner188a87d2010-03-10 01:04:13 +00003409 Asm->OutStreamer.AddComment(Twine(getSourceDirectoryName(SrcID.first)) +
Chris Lattner49f618a2010-03-10 02:29:31 +00003410 "/" +
3411 Twine(getSourceFileName(SrcID.second)) +
Chris Lattner188a87d2010-03-10 01:04:13 +00003412 ":" + Twine(LineInfo.getLine()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003413 }
3414
3415 // Define the line address.
Chris Lattner233f52b2010-03-09 23:52:58 +00003416 Asm->OutStreamer.AddComment("Extended Op");
3417 Asm->EmitInt8(0);
3418 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003419 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003420
3421 Asm->OutStreamer.AddComment("DW_LNE_set_address");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003422 Asm->EmitInt8(dwarf::DW_LNE_set_address);
Chris Lattner233f52b2010-03-09 23:52:58 +00003423
3424 Asm->OutStreamer.AddComment("Location label");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003425 Asm->OutStreamer.EmitSymbolValue(Label,
3426 Asm->getTargetData().getPointerSize(),
Chris Lattnerb9130602010-03-14 02:20:58 +00003427 0/*AddrSpace*/);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003428
Bill Wendling94d04b82009-05-20 23:21:38 +00003429 // If change of source, then switch to the new source.
3430 if (Source != LineInfo.getSourceID()) {
3431 Source = LineInfo.getSourceID();
Chris Lattner233f52b2010-03-09 23:52:58 +00003432 Asm->OutStreamer.AddComment("DW_LNS_set_file");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003433 Asm->EmitInt8(dwarf::DW_LNS_set_file);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003434 Asm->EmitULEB128(Source, "New Source");
Bill Wendling94d04b82009-05-20 23:21:38 +00003435 }
3436
3437 // If change of line.
3438 if (Line != LineInfo.getLine()) {
3439 // Determine offset.
3440 int Offset = LineInfo.getLine() - Line;
3441 int Delta = Offset - MinLineDelta;
3442
3443 // Update line.
3444 Line = LineInfo.getLine();
3445
3446 // If delta is small enough and in range...
3447 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
3448 // ... then use fast opcode.
Chris Lattner233f52b2010-03-09 23:52:58 +00003449 Asm->OutStreamer.AddComment("Line Delta");
3450 Asm->EmitInt8(Delta - MinLineDelta);
Bill Wendling94d04b82009-05-20 23:21:38 +00003451 } else {
3452 // ... otherwise use long hand.
Chris Lattner233f52b2010-03-09 23:52:58 +00003453 Asm->OutStreamer.AddComment("DW_LNS_advance_line");
Bill Wendling94d04b82009-05-20 23:21:38 +00003454 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003455 Asm->EmitSLEB128(Offset, "Line Offset");
Chris Lattner233f52b2010-03-09 23:52:58 +00003456 Asm->OutStreamer.AddComment("DW_LNS_copy");
3457 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling94d04b82009-05-20 23:21:38 +00003458 }
3459 } else {
3460 // Copy the previous row (different address or source)
Chris Lattner233f52b2010-03-09 23:52:58 +00003461 Asm->OutStreamer.AddComment("DW_LNS_copy");
3462 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling94d04b82009-05-20 23:21:38 +00003463 }
3464 }
3465
Devang Patel2c4ceb12009-11-21 02:48:08 +00003466 emitEndOfLineMatrix(j + 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003467 }
3468
3469 if (SecSrcLinesSize == 0)
3470 // Because we're emitting a debug_line section, we still need a line
3471 // table. The linker and friends expect it to exist. If there's nothing to
3472 // put into it, emit an empty table.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003473 emitEndOfLineMatrix(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003474
Chris Lattnerc0215722010-04-04 19:25:43 +00003475 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003476}
3477
Devang Patel2c4ceb12009-11-21 02:48:08 +00003478/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003479///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003480void DwarfDebug::emitCommonDebugFrame() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003481 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003482 return;
3483
Chris Lattnerd38fee82010-04-05 00:13:49 +00003484 int stackGrowth = Asm->getTargetData().getPointerSize();
3485 if (Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3486 TargetFrameInfo::StackGrowsDown)
3487 stackGrowth *= -1;
Bill Wendling94d04b82009-05-20 23:21:38 +00003488
3489 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003490 Asm->OutStreamer.SwitchSection(
3491 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003492
Chris Lattnerc0215722010-04-04 19:25:43 +00003493 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003494 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003495 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3496 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003497
Chris Lattnerc0215722010-04-04 19:25:43 +00003498 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003499 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling94d04b82009-05-20 23:21:38 +00003500 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner233f52b2010-03-09 23:52:58 +00003501 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling94d04b82009-05-20 23:21:38 +00003502 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner233f52b2010-03-09 23:52:58 +00003503 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003504 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003505 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3506 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner233f52b2010-03-09 23:52:58 +00003507 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003508 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling94d04b82009-05-20 23:21:38 +00003509 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling94d04b82009-05-20 23:21:38 +00003510
3511 std::vector<MachineMove> Moves;
3512 RI->getInitialFrameState(Moves);
3513
Chris Lattner02b86b92010-04-04 23:41:46 +00003514 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003515
Chris Lattner059ea132010-04-28 01:05:45 +00003516 Asm->EmitAlignment(2);
Chris Lattnerc0215722010-04-04 19:25:43 +00003517 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003518}
3519
Devang Patel2c4ceb12009-11-21 02:48:08 +00003520/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling94d04b82009-05-20 23:21:38 +00003521/// section.
Chris Lattner206d61e2010-03-13 07:26:18 +00003522void DwarfDebug::
3523emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003524 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003525 return;
3526
3527 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003528 Asm->OutStreamer.SwitchSection(
3529 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003530
Chris Lattner233f52b2010-03-09 23:52:58 +00003531 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner206d61e2010-03-13 07:26:18 +00003532 MCSymbol *DebugFrameBegin =
Chris Lattnerc0215722010-04-04 19:25:43 +00003533 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner206d61e2010-03-13 07:26:18 +00003534 MCSymbol *DebugFrameEnd =
Chris Lattnerc0215722010-04-04 19:25:43 +00003535 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnera6437182010-04-04 19:58:12 +00003536 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003537
Chris Lattner206d61e2010-03-13 07:26:18 +00003538 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling94d04b82009-05-20 23:21:38 +00003539
Chris Lattner233f52b2010-03-09 23:52:58 +00003540 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003541 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner6189ed12010-04-04 23:25:33 +00003542 DwarfFrameSectionSym);
Bill Wendling94d04b82009-05-20 23:21:38 +00003543
Chris Lattner233f52b2010-03-09 23:52:58 +00003544 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnerc0215722010-04-04 19:25:43 +00003545 MCSymbol *FuncBeginSym =
3546 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattnerfb658072010-03-13 07:40:56 +00003547 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattnerd38fee82010-04-05 00:13:49 +00003548 Asm->getTargetData().getPointerSize(),
3549 0/*AddrSpace*/);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003550
3551
Chris Lattner233f52b2010-03-09 23:52:58 +00003552 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnera6437182010-04-04 19:58:12 +00003553 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003554 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003555
Chris Lattner02b86b92010-04-04 23:41:46 +00003556 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003557
Chris Lattner059ea132010-04-28 01:05:45 +00003558 Asm->EmitAlignment(2);
Chris Lattner206d61e2010-03-13 07:26:18 +00003559 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling94d04b82009-05-20 23:21:38 +00003560}
3561
Devang Patel8a241142009-12-09 18:24:21 +00003562/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3563///
3564void DwarfDebug::emitDebugPubNames() {
Devang Patel163a9f72010-05-10 22:49:55 +00003565 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3566 E = CUMap.end(); I != E; ++I) {
3567 CompileUnit *TheCU = I->second;
3568 // Start the dwarf pubnames section.
3569 Asm->OutStreamer.SwitchSection(
3570 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003571
Devang Patel163a9f72010-05-10 22:49:55 +00003572 Asm->OutStreamer.AddComment("Length of Public Names Info");
3573 Asm->EmitLabelDifference(
3574 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3575 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003576
Devang Patel163a9f72010-05-10 22:49:55 +00003577 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3578 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003579
Devang Patel163a9f72010-05-10 22:49:55 +00003580 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003581 Asm->EmitInt16(dwarf::DWARF_VERSION);
3582
Devang Patel163a9f72010-05-10 22:49:55 +00003583 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003584 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel163a9f72010-05-10 22:49:55 +00003585 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003586
Devang Patel163a9f72010-05-10 22:49:55 +00003587 Asm->OutStreamer.AddComment("Compilation Unit Length");
3588 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3589 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3590 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003591
Devang Patel163a9f72010-05-10 22:49:55 +00003592 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3593 for (StringMap<DIE*>::const_iterator
3594 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3595 const char *Name = GI->getKeyData();
3596 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003597
Devang Patel163a9f72010-05-10 22:49:55 +00003598 Asm->OutStreamer.AddComment("DIE offset");
3599 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003600
Devang Patel163a9f72010-05-10 22:49:55 +00003601 if (Asm->isVerbose())
3602 Asm->OutStreamer.AddComment("External Name");
3603 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3604 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00003605
Devang Patel163a9f72010-05-10 22:49:55 +00003606 Asm->OutStreamer.AddComment("End Mark");
3607 Asm->EmitInt32(0);
3608 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3609 TheCU->getID()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003610 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003611}
3612
Devang Patel193f7202009-11-24 01:14:22 +00003613void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00003614 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3615 E = CUMap.end(); I != E; ++I) {
3616 CompileUnit *TheCU = I->second;
3617 // Start the dwarf pubnames section.
3618 Asm->OutStreamer.SwitchSection(
3619 Asm->getObjFileLowering().getDwarfPubTypesSection());
3620 Asm->OutStreamer.AddComment("Length of Public Types Info");
3621 Asm->EmitLabelDifference(
3622 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3623 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003624
Devang Patel163a9f72010-05-10 22:49:55 +00003625 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3626 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003627
Devang Patel163a9f72010-05-10 22:49:55 +00003628 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3629 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003630
Devang Patel163a9f72010-05-10 22:49:55 +00003631 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3632 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3633 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003634
Devang Patel163a9f72010-05-10 22:49:55 +00003635 Asm->OutStreamer.AddComment("Compilation Unit Length");
3636 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3637 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3638 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003639
Devang Patel163a9f72010-05-10 22:49:55 +00003640 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3641 for (StringMap<DIE*>::const_iterator
3642 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3643 const char *Name = GI->getKeyData();
3644 DIE * Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003645
Devang Patel163a9f72010-05-10 22:49:55 +00003646 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3647 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003648
Devang Patel163a9f72010-05-10 22:49:55 +00003649 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3650 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3651 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00003652
Devang Patel163a9f72010-05-10 22:49:55 +00003653 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003654 Asm->EmitInt32(0);
Devang Patel163a9f72010-05-10 22:49:55 +00003655 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3656 TheCU->getID()));
Devang Patel193f7202009-11-24 01:14:22 +00003657 }
Devang Patel193f7202009-11-24 01:14:22 +00003658}
3659
Devang Patel2c4ceb12009-11-21 02:48:08 +00003660/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003661///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003662void DwarfDebug::emitDebugStr() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003663 // Check to see if it is worth the effort.
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003664 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003665
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003666 // Start the dwarf str section.
3667 Asm->OutStreamer.SwitchSection(
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003668 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003669
Chris Lattnerbc733f52010-03-13 02:17:42 +00003670 // Get all of the string pool entries and put them in an array by their ID so
3671 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003672 SmallVector<std::pair<unsigned,
Chris Lattnerbc733f52010-03-13 02:17:42 +00003673 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003674
Chris Lattnerbc733f52010-03-13 02:17:42 +00003675 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3676 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3677 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003678
Chris Lattnerbc733f52010-03-13 02:17:42 +00003679 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003680
Chris Lattnerbc733f52010-03-13 02:17:42 +00003681 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003682 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003683 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003684
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003685 // Emit the string itself.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003686 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003687 }
3688}
3689
Devang Patel2c4ceb12009-11-21 02:48:08 +00003690/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003691///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003692void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00003693 if (DotDebugLocEntries.empty())
3694 return;
3695
Bill Wendling94d04b82009-05-20 23:21:38 +00003696 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003697 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00003698 Asm->getObjFileLowering().getDwarfLocSection());
3699 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00003700 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3701 unsigned index = 1;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003702 for (SmallVector<DotDebugLocEntry, 4>::iterator
3703 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00003704 I != E; ++I, ++index) {
Devang Patelc3f5f782010-05-25 23:40:22 +00003705 DotDebugLocEntry Entry = *I;
Devang Patelc3f5f782010-05-25 23:40:22 +00003706 if (Entry.isEmpty()) {
3707 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3708 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel80250682010-05-26 23:55:23 +00003709 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00003710 } else {
3711 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3712 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3713 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3714 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patelb2cf5812010-08-04 18:40:52 +00003715 if (int Offset = Entry.Loc.getOffset()) {
3716 // If the value is at a certain offset from frame register then
3717 // use DW_OP_fbreg.
3718 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patelc3f5f782010-05-25 23:40:22 +00003719 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patelb2cf5812010-08-04 18:40:52 +00003720 Asm->EmitInt16(1 + OffsetSize);
3721 Asm->OutStreamer.AddComment(
3722 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3723 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3724 Asm->OutStreamer.AddComment("Offset");
3725 Asm->EmitSLEB128(Offset);
Devang Patelc3f5f782010-05-25 23:40:22 +00003726 } else {
Devang Patelb2cf5812010-08-04 18:40:52 +00003727 if (Reg < 32) {
3728 Asm->OutStreamer.AddComment("Loc expr size");
3729 Asm->EmitInt16(1);
3730 Asm->OutStreamer.AddComment(
Devang Patela54e0cc2010-08-04 20:32:36 +00003731 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patelb2cf5812010-08-04 18:40:52 +00003732 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3733 } else {
3734 Asm->OutStreamer.AddComment("Loc expr size");
3735 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3736 Asm->EmitInt8(dwarf::DW_OP_regx);
3737 Asm->EmitULEB128(Reg);
3738 }
Devang Patelc3f5f782010-05-25 23:40:22 +00003739 }
3740 }
3741 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003742}
3743
3744/// EmitDebugARanges - Emit visible names into a debug aranges section.
3745///
3746void DwarfDebug::EmitDebugARanges() {
3747 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003748 Asm->OutStreamer.SwitchSection(
3749 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003750}
3751
Devang Patel2c4ceb12009-11-21 02:48:08 +00003752/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003753///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003754void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003755 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003756 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00003757 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Pateleac9c072010-04-27 19:46:33 +00003758 unsigned char Size = Asm->getTargetData().getPointerSize();
3759 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00003760 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00003761 I != E; ++I) {
3762 if (*I)
3763 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003764 else
Devang Pateleac9c072010-04-27 19:46:33 +00003765 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003766 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003767}
3768
Devang Patel2c4ceb12009-11-21 02:48:08 +00003769/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003770///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003771void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003772 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00003773 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003774 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003775 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003776 }
3777}
3778
Devang Patel2c4ceb12009-11-21 02:48:08 +00003779/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling94d04b82009-05-20 23:21:38 +00003780/// Section Header:
3781/// 1. length of section
3782/// 2. Dwarf version number
3783/// 3. address size.
3784///
3785/// Entries (one "entry" for each function that was inlined):
3786///
3787/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3788/// otherwise offset into __debug_str for regular function name.
3789/// 2. offset into __debug_str section for regular function name.
3790/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3791/// instances for the function.
3792///
3793/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3794/// inlined instance; the die_offset points to the inlined_subroutine die in the
3795/// __debug_info section, and the low_pc is the starting address for the
3796/// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003797void DwarfDebug::emitDebugInlineInfo() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003798 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003799 return;
3800
Devang Patel163a9f72010-05-10 22:49:55 +00003801 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00003802 return;
3803
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003804 Asm->OutStreamer.SwitchSection(
3805 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00003806
Chris Lattner233f52b2010-03-09 23:52:58 +00003807 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003808 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3809 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003810
Chris Lattnerc0215722010-04-04 19:25:43 +00003811 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003812
Chris Lattner233f52b2010-03-09 23:52:58 +00003813 Asm->OutStreamer.AddComment("Dwarf Version");
3814 Asm->EmitInt16(dwarf::DWARF_VERSION);
3815 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003816 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003817
Devang Patele9f8f5e2010-05-07 20:54:48 +00003818 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00003819 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00003820
Devang Patele9f8f5e2010-05-07 20:54:48 +00003821 const MDNode *Node = *I;
3822 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach7ab38df2009-11-22 19:20:36 +00003823 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00003824 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00003825 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00003826 StringRef LName = SP.getLinkageName();
3827 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00003828
Chris Lattner233f52b2010-03-09 23:52:58 +00003829 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003830 if (LName.empty()) {
3831 Asm->OutStreamer.EmitBytes(Name, 0);
3832 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003833 } else
Chris Lattner6189ed12010-04-04 23:25:33 +00003834 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3835 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00003836
Chris Lattner233f52b2010-03-09 23:52:58 +00003837 Asm->OutStreamer.AddComment("Function name");
Chris Lattner6189ed12010-04-04 23:25:33 +00003838 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003839 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00003840
Devang Patel53bb5c92009-11-10 23:06:00 +00003841 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00003842 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00003843 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00003844 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003845
Chris Lattner3f53c832010-04-04 18:52:31 +00003846 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003847 Asm->OutStreamer.EmitSymbolValue(LI->first,
3848 Asm->getTargetData().getPointerSize(),0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003849 }
3850 }
3851
Chris Lattnerc0215722010-04-04 19:25:43 +00003852 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003853}