blob: ddda18440700d36c73d6f0d9e35ba614d46a33a8 [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 Patel1a301232010-09-29 21:44:16 +00001072 if (Element.isSubprogram()) {
1073 DISubprogram SP(Element);
Devang Patel2db49d72010-05-07 18:11:54 +00001074 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patel1a301232010-09-29 21:44:16 +00001075 if (SP.isProtected())
1076 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1077 dwarf::DW_ACCESS_protected);
1078 else if (SP.isPrivate())
1079 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1080 dwarf::DW_ACCESS_private);
1081 else
1082 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1083 dwarf::DW_ACCESS_public);
Devang Patel21ea1d52010-10-01 23:31:40 +00001084 if (SP.isExplicit())
1085 addUInt(ElemDie, dwarf::DW_AT_explicit, dwarf::DW_FORM_flag, 1);
Devang Patel1a301232010-09-29 21:44:16 +00001086 }
Devang Patel3c91b052010-03-08 20:52:55 +00001087 else if (Element.isVariable()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001088 DIVariable DV(Element);
Devang Patel1ee0cb92010-01-30 01:08:30 +00001089 ElemDie = new DIE(dwarf::DW_TAG_variable);
1090 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1091 DV.getName());
1092 addType(ElemDie, DV.getType());
1093 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1094 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patel81625742010-08-09 20:20:05 +00001095 addSourceLine(ElemDie, DV);
Devang Patel3c91b052010-03-08 20:52:55 +00001096 } else if (Element.isDerivedType())
Devang Patel2db49d72010-05-07 18:11:54 +00001097 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3c91b052010-03-08 20:52:55 +00001098 else
1099 continue;
Devang Patel2c4ceb12009-11-21 02:48:08 +00001100 Buffer.addChild(ElemDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001101 }
1102
Devang Patela1ba2692009-08-27 23:51:51 +00001103 if (CTy.isAppleBlockExtension())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001104 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001105
1106 unsigned RLang = CTy.getRunTimeLang();
1107 if (RLang)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001108 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling0310d762009-05-15 09:23:25 +00001109 dwarf::DW_FORM_data1, RLang);
Devang Patelb5544992010-01-26 21:16:06 +00001110
1111 DICompositeType ContainingType = CTy.getContainingType();
Devang Patel2db49d72010-05-07 18:11:54 +00001112 if (DIDescriptor(ContainingType).isCompositeType())
Jim Grosbach1e20b962010-07-21 21:21:52 +00001113 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patel2db49d72010-05-07 18:11:54 +00001114 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastings215aa152010-06-11 20:08:44 +00001115 else {
1116 DIDescriptor Context = CTy.getContext();
1117 addToContextOwner(&Buffer, Context);
1118 }
Bill Wendling0310d762009-05-15 09:23:25 +00001119 break;
1120 }
1121 default:
1122 break;
1123 }
1124
1125 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +00001126 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001127 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001128
Jim Grosbach1e20b962010-07-21 21:21:52 +00001129 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
Devang Patel61409622010-07-07 20:12:52 +00001130 || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1131 {
Bill Wendling0310d762009-05-15 09:23:25 +00001132 // Add size if non-zero (derived types might be zero-sized.)
1133 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001134 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +00001135 else {
1136 // Add zero size if it is not a forward declaration.
1137 if (CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001138 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001139 else
Devang Patel2c4ceb12009-11-21 02:48:08 +00001140 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling0310d762009-05-15 09:23:25 +00001141 }
1142
1143 // Add source line info if available.
1144 if (!CTy.isForwardDecl())
Devang Patel81625742010-08-09 20:20:05 +00001145 addSourceLine(&Buffer, CTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001146 }
1147}
1148
Devang Patel2c4ceb12009-11-21 02:48:08 +00001149/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1150void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling0310d762009-05-15 09:23:25 +00001151 int64_t L = SR.getLo();
1152 int64_t H = SR.getHi();
1153 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1154
Devang Patel2c4ceb12009-11-21 02:48:08 +00001155 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patel6325a532009-08-14 20:59:16 +00001156 if (L)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001157 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Pateld55224c2009-12-04 23:10:24 +00001158 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling0310d762009-05-15 09:23:25 +00001159
Devang Patel2c4ceb12009-11-21 02:48:08 +00001160 Buffer.addChild(DW_Subrange);
Bill Wendling0310d762009-05-15 09:23:25 +00001161}
1162
Devang Patel2c4ceb12009-11-21 02:48:08 +00001163/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +00001164void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling0310d762009-05-15 09:23:25 +00001165 DICompositeType *CTy) {
1166 Buffer.setTag(dwarf::DW_TAG_array_type);
1167 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001168 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001169
1170 // Emit derived type.
Devang Patel8a241142009-12-09 18:24:21 +00001171 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001172 DIArray Elements = CTy->getTypeArray();
1173
Devang Patel6f01d9c2009-11-21 00:31:03 +00001174 // Get an anonymous type for index type.
Devang Patel163a9f72010-05-10 22:49:55 +00001175 CompileUnit *TheCU = getCompileUnit(*CTy);
1176 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel6f01d9c2009-11-21 00:31:03 +00001177 if (!IdxTy) {
1178 // Construct an anonymous type for index type.
1179 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001180 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1181 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel6f01d9c2009-11-21 00:31:03 +00001182 dwarf::DW_ATE_signed);
Devang Patel163a9f72010-05-10 22:49:55 +00001183 TheCU->addDie(IdxTy);
1184 TheCU->setIndexTyDie(IdxTy);
Devang Patel6f01d9c2009-11-21 00:31:03 +00001185 }
Bill Wendling0310d762009-05-15 09:23:25 +00001186
1187 // Add subranges to array type.
1188 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1189 DIDescriptor Element = Elements.getElement(i);
1190 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patel2db49d72010-05-07 18:11:54 +00001191 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001192 }
1193}
1194
Devang Patel2c4ceb12009-11-21 02:48:08 +00001195/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3c91b052010-03-08 20:52:55 +00001196DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001197 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3c91b052010-03-08 20:52:55 +00001198 StringRef Name = ETy.getName();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001199 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3c91b052010-03-08 20:52:55 +00001200 int64_t Value = ETy.getEnumValue();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001201 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling0310d762009-05-15 09:23:25 +00001202 return Enumerator;
1203}
1204
Jim Grosbach1e20b962010-07-21 21:21:52 +00001205/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel351ca332010-01-05 01:46:14 +00001206/// printer to not emit usual symbol prefix before the symbol name is used then
1207/// return linkage name after skipping this special LLVM prefix.
1208static StringRef getRealLinkageName(StringRef LinkageName) {
1209 char One = '\1';
1210 if (LinkageName.startswith(StringRef(&One, 1)))
1211 return LinkageName.substr(1);
1212 return LinkageName;
1213}
1214
Devang Patel2c4ceb12009-11-21 02:48:08 +00001215/// createMemberDIE - Create new member DIE.
Devang Patelecbd8e82010-08-10 04:12:17 +00001216DIE *DwarfDebug::createMemberDIE(DIDerivedType DT) {
Bill Wendling0310d762009-05-15 09:23:25 +00001217 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel65dbc902009-11-25 17:36:49 +00001218 StringRef Name = DT.getName();
1219 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001220 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001221
Devang Patel8a241142009-12-09 18:24:21 +00001222 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001223
Devang Patel81625742010-08-09 20:20:05 +00001224 addSourceLine(MemberDie, DT);
Bill Wendling0310d762009-05-15 09:23:25 +00001225
Benjamin Kramer345ef342010-03-31 19:34:01 +00001226 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001227 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel33db5082009-11-04 22:06:12 +00001228
Bill Wendling0310d762009-05-15 09:23:25 +00001229 uint64_t Size = DT.getSizeInBits();
Devang Patel61ecbd12009-11-04 23:48:00 +00001230 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling0310d762009-05-15 09:23:25 +00001231
1232 if (Size != FieldSize) {
1233 // Handle bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001234 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1235 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling0310d762009-05-15 09:23:25 +00001236
1237 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling0310d762009-05-15 09:23:25 +00001238 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1239 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer3d594fd2010-01-07 17:50:57 +00001240 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling0310d762009-05-15 09:23:25 +00001241 Offset -= FieldOffset;
1242
1243 // Maybe we need to work from the other end.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001244 if (Asm->getTargetData().isLittleEndian())
1245 Offset = FieldSize - (Offset + Size);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001246 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling0310d762009-05-15 09:23:25 +00001247
Devang Patel33db5082009-11-04 22:06:12 +00001248 // Here WD_AT_data_member_location points to the anonymous
1249 // field that includes this bit field.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001250 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001251
1252 } else
1253 // This is not a bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001254 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001255
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001256 if (DT.getTag() == dwarf::DW_TAG_inheritance
1257 && DT.isVirtual()) {
1258
1259 // For C++, virtual base classes are not at fixed offset. Use following
1260 // expression to extract appropriate offset from vtable.
1261 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1262
Benjamin Kramer345ef342010-03-31 19:34:01 +00001263 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001264 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1265 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1266 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1267 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1268 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1269 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1270 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1271
Jim Grosbach1e20b962010-07-21 21:21:52 +00001272 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001273 VBaseLocationDie);
1274 } else
1275 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001276
1277 if (DT.isProtected())
Devang Patel5d11eb02009-12-03 19:11:07 +00001278 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001279 dwarf::DW_ACCESS_protected);
1280 else if (DT.isPrivate())
Devang Patel5d11eb02009-12-03 19:11:07 +00001281 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001282 dwarf::DW_ACCESS_private);
Devang Patel2a361602010-09-29 19:08:08 +00001283 // Otherwise C++ member and base classes are considered public.
1284 else if (DT.getCompileUnit().getLanguage() == dwarf::DW_LANG_C_plus_plus)
Devang Patel5d11eb02009-12-03 19:11:07 +00001285 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1286 dwarf::DW_ACCESS_public);
1287 if (DT.isVirtual())
1288 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1289 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling0310d762009-05-15 09:23:25 +00001290 return MemberDie;
1291}
1292
Devang Patelffe966c2009-12-14 16:18:45 +00001293/// createSubprogramDIE - Create new DIE using SP.
Devang Patelee70fa72010-09-27 23:15:27 +00001294DIE *DwarfDebug::createSubprogramDIE(DISubprogram SP) {
Devang Patel163a9f72010-05-10 22:49:55 +00001295 CompileUnit *SPCU = getCompileUnit(SP);
1296 DIE *SPDie = SPCU->getDIE(SP);
Devang Patelffe966c2009-12-14 16:18:45 +00001297 if (SPDie)
1298 return SPDie;
1299
1300 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel1eac3e72010-03-02 17:58:15 +00001301 // Constructors and operators for anonymous aggregates do not have names.
Devang Patel6b506cb2010-03-02 01:26:20 +00001302 if (!SP.getName().empty())
1303 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling0310d762009-05-15 09:23:25 +00001304
Devang Patel65dbc902009-11-25 17:36:49 +00001305 StringRef LinkageName = SP.getLinkageName();
Devang Patel351ca332010-01-05 01:46:14 +00001306 if (!LinkageName.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001307 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel351ca332010-01-05 01:46:14 +00001308 getRealLinkageName(LinkageName));
1309
Devang Patel81625742010-08-09 20:20:05 +00001310 addSourceLine(SPDie, SP);
Bill Wendling0310d762009-05-15 09:23:25 +00001311
Bill Wendling0310d762009-05-15 09:23:25 +00001312 // Add prototyped tag, if C or ObjC.
1313 unsigned Lang = SP.getCompileUnit().getLanguage();
1314 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1315 Lang == dwarf::DW_LANG_ObjC)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001316 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001317
1318 // Add Return Type.
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001319 DICompositeType SPTy = SP.getType();
1320 DIArray Args = SPTy.getTypeArray();
Bill Wendling0310d762009-05-15 09:23:25 +00001321 unsigned SPTag = SPTy.getTag();
Devang Patel5d11eb02009-12-03 19:11:07 +00001322
Devang Patel3c91b052010-03-08 20:52:55 +00001323 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel8a241142009-12-09 18:24:21 +00001324 addType(SPDie, SPTy);
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001325 else
Devang Patel2db49d72010-05-07 18:11:54 +00001326 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001327
Devang Patel5d11eb02009-12-03 19:11:07 +00001328 unsigned VK = SP.getVirtuality();
1329 if (VK) {
1330 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer345ef342010-03-31 19:34:01 +00001331 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel5d11eb02009-12-03 19:11:07 +00001332 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1333 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1334 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001335 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patel2db49d72010-05-07 18:11:54 +00001336 SP.getContainingType()));
Devang Patel5d11eb02009-12-03 19:11:07 +00001337 }
1338
Devang Patelee70fa72010-09-27 23:15:27 +00001339 if (!SP.isDefinition()) {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001340 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001341
1342 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001343 // be handled while processing variables.
1344 DICompositeType SPTy = SP.getType();
1345 DIArray Args = SPTy.getTypeArray();
1346 unsigned SPTag = SPTy.getTag();
1347
Bill Wendling0310d762009-05-15 09:23:25 +00001348 if (SPTag == dwarf::DW_TAG_subroutine_type)
1349 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1350 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001351 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patelb4645642010-02-06 01:02:37 +00001352 addType(Arg, ATy);
1353 if (ATy.isArtificial())
1354 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001355 SPDie->addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001356 }
1357 }
1358
Devang Patel4e0d19d2010-02-03 19:57:19 +00001359 if (SP.isArtificial())
1360 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1361
Devang Patelccff8122010-04-30 19:38:23 +00001362 if (!SP.isLocalToUnit())
1363 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001364
Devang Patelccff8122010-04-30 19:38:23 +00001365 if (SP.isOptimized())
1366 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1367
Jim Grosbach91729002010-07-21 23:03:52 +00001368 if (unsigned isa = Asm->getISAEncoding()) {
1369 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1370 }
1371
Devang Patelccff8122010-04-30 19:38:23 +00001372 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel163a9f72010-05-10 22:49:55 +00001373 SPCU->insertDIE(SP, SPDie);
Devang Patelccff8122010-04-30 19:38:23 +00001374
Stuart Hastings215aa152010-06-11 20:08:44 +00001375 // Add to context owner.
1376 addToContextOwner(SPDie, SP.getContext());
1377
Bill Wendling0310d762009-05-15 09:23:25 +00001378 return SPDie;
1379}
1380
Devang Patele9f8f5e2010-05-07 20:54:48 +00001381DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattnered7a77b2010-03-31 05:36:29 +00001382 assert(N && "Invalid Scope encoding!");
Devang Patel53bb5c92009-11-10 23:06:00 +00001383
1384 DbgScope *AScope = AbstractScopes.lookup(N);
1385 if (AScope)
1386 return AScope;
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001387
Devang Patel53bb5c92009-11-10 23:06:00 +00001388 DbgScope *Parent = NULL;
1389
1390 DIDescriptor Scope(N);
1391 if (Scope.isLexicalBlock()) {
1392 DILexicalBlock DB(N);
1393 DIDescriptor ParentDesc = DB.getContext();
Devang Patel2db49d72010-05-07 18:11:54 +00001394 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patel53bb5c92009-11-10 23:06:00 +00001395 }
1396
1397 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1398
1399 if (Parent)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001400 Parent->addScope(AScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001401 AScope->setAbstractScope();
1402 AbstractScopes[N] = AScope;
1403 if (DIDescriptor(N).isSubprogram())
1404 AbstractScopesList.push_back(AScope);
1405 return AScope;
1406}
Devang Patelaf9e8472009-10-01 20:31:14 +00001407
Devang Patel5f094002010-04-06 23:53:48 +00001408/// isSubprogramContext - Return true if Context is either a subprogram
1409/// or another context nested inside a subprogram.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001410static bool isSubprogramContext(const MDNode *Context) {
Devang Patel5f094002010-04-06 23:53:48 +00001411 if (!Context)
1412 return false;
1413 DIDescriptor D(Context);
1414 if (D.isSubprogram())
1415 return true;
1416 if (D.isType())
Devang Patel2db49d72010-05-07 18:11:54 +00001417 return isSubprogramContext(DIType(Context).getContext());
Devang Patel5f094002010-04-06 23:53:48 +00001418 return false;
1419}
1420
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001421/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel2c4ceb12009-11-21 02:48:08 +00001422/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1423/// If there are global variables in this scope then create and insert
1424/// DIEs for these variables.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001425DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel163a9f72010-05-10 22:49:55 +00001426 CompileUnit *SPCU = getCompileUnit(SPNode);
1427 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patel8aa61472010-07-07 22:20:57 +00001428
Chris Lattnerd38fee82010-04-05 00:13:49 +00001429 assert(SPDie && "Unable to find subprogram DIE!");
1430 DISubprogram SP(SPNode);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001431
Chris Lattnerd38fee82010-04-05 00:13:49 +00001432 // There is not any need to generate specification DIE for a function
1433 // defined at compile unit level. If a function is defined inside another
1434 // function then gdb prefers the definition at top level and but does not
Jim Grosbach1e20b962010-07-21 21:21:52 +00001435 // expect specification DIE in parent function. So avoid creating
Chris Lattnerd38fee82010-04-05 00:13:49 +00001436 // specification DIE for a function defined inside a function.
1437 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Jim Grosbach1e20b962010-07-21 21:21:52 +00001438 !SP.getContext().isFile() &&
Devang Patel2db49d72010-05-07 18:11:54 +00001439 !isSubprogramContext(SP.getContext())) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00001440 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001441
1442 // Add arguments.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001443 DICompositeType SPTy = SP.getType();
1444 DIArray Args = SPTy.getTypeArray();
1445 unsigned SPTag = SPTy.getTag();
1446 if (SPTag == dwarf::DW_TAG_subroutine_type)
1447 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1448 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001449 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattnerd38fee82010-04-05 00:13:49 +00001450 addType(Arg, ATy);
1451 if (ATy.isArtificial())
1452 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1453 SPDie->addChild(Arg);
1454 }
1455 DIE *SPDeclDie = SPDie;
1456 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001457 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Chris Lattnerd38fee82010-04-05 00:13:49 +00001458 SPDeclDie);
Devang Patel163a9f72010-05-10 22:49:55 +00001459 SPCU->addDie(SPDie);
Chris Lattnerd38fee82010-04-05 00:13:49 +00001460 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00001461
Devang Patel8aa61472010-07-07 22:20:57 +00001462 // Pick up abstract subprogram DIE.
1463 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
1464 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1465 addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
1466 dwarf::DW_FORM_ref4, AbsSPDIE);
1467 SPCU->addDie(SPDie);
1468 }
1469
Chris Lattnerd38fee82010-04-05 00:13:49 +00001470 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1471 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1472 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1473 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1474 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1475 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1476 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +00001477
Chris Lattnerd38fee82010-04-05 00:13:49 +00001478 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +00001479}
1480
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001481/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel2c4ceb12009-11-21 02:48:08 +00001482/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1483DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001484
1485 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1486 if (Scope->isAbstractScope())
1487 return ScopeDIE;
1488
1489 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1490 if (Ranges.empty())
1491 return 0;
1492
1493 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1494 if (Ranges.size() > 1) {
1495 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbach1e20b962010-07-21 21:21:52 +00001496 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Pateleac9c072010-04-27 19:46:33 +00001497 // DW_AT_ranges appropriately.
1498 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1499 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1500 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1501 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +00001502 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1503 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +00001504 }
1505 DebugRangeSymbols.push_back(NULL);
1506 DebugRangeSymbols.push_back(NULL);
1507 return ScopeDIE;
1508 }
1509
Devang Patelc3f5f782010-05-25 23:40:22 +00001510 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1511 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001512
Devang Patelc3f5f782010-05-25 23:40:22 +00001513 if (End == 0) return 0;
Devang Patel53bb5c92009-11-10 23:06:00 +00001514
Chris Lattnerb7db7332010-03-09 01:58:53 +00001515 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1516 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbach1e20b962010-07-21 21:21:52 +00001517
Devang Pateleac9c072010-04-27 19:46:33 +00001518 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1519 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patel53bb5c92009-11-10 23:06:00 +00001520
1521 return ScopeDIE;
1522}
1523
Devang Patel2c4ceb12009-11-21 02:48:08 +00001524/// constructInlinedScopeDIE - This scope represents inlined body of
1525/// a function. Construct DIE to represent this concrete inlined copy
1526/// of the function.
1527DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001528
1529 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001530 assert (Ranges.empty() == false
Devang Pateleac9c072010-04-27 19:46:33 +00001531 && "DbgScope does not have instruction markers!");
1532
1533 // FIXME : .debug_inlined section specification does not clearly state how
1534 // to emit inlined scope that is split into multiple instruction ranges.
1535 // For now, use first instruction range and emit low_pc/high_pc pair and
1536 // corresponding .debug_inlined section entry for this pair.
1537 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patelc3f5f782010-05-25 23:40:22 +00001538 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1539 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001540
Devang Patel0afbf232010-07-08 22:39:20 +00001541 if (StartLabel == 0 || EndLabel == 0) {
Devang Pateleac9c072010-04-27 19:46:33 +00001542 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1543 return 0;
1544 }
Chris Lattnerb7db7332010-03-09 01:58:53 +00001545 assert(StartLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001546 "Invalid starting label for an inlined scope!");
Chris Lattnerb7db7332010-03-09 01:58:53 +00001547 assert(EndLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001548 "Invalid end label for an inlined scope!");
Devang Pateleac9c072010-04-27 19:46:33 +00001549
Devang Patel3c91b052010-03-08 20:52:55 +00001550 if (!Scope->getScopeNode())
Devang Patel0ef3fa62010-03-08 19:20:38 +00001551 return NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001552 DIScope DS(Scope->getScopeNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00001553 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1554
Devang Patel2db49d72010-05-07 18:11:54 +00001555 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel163a9f72010-05-10 22:49:55 +00001556 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1557 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001558 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel2c4ceb12009-11-21 02:48:08 +00001559 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001560 dwarf::DW_FORM_ref4, OriginDIE);
1561
Chris Lattner6ed0f902010-03-09 00:31:02 +00001562 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnerb7db7332010-03-09 01:58:53 +00001563 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patel53bb5c92009-11-10 23:06:00 +00001564
1565 InlinedSubprogramDIEs.insert(OriginDIE);
1566
1567 // Track the start label for this inlined function.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001568 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patel2db49d72010-05-07 18:11:54 +00001569 I = InlineInfo.find(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001570
1571 if (I == InlineInfo.end()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001572 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001573 ScopeDIE));
Devang Patel2db49d72010-05-07 18:11:54 +00001574 InlinedSPNodes.push_back(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001575 } else
Chris Lattner6ed0f902010-03-09 00:31:02 +00001576 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patel53bb5c92009-11-10 23:06:00 +00001577
Devang Patel53bb5c92009-11-10 23:06:00 +00001578 DILocation DL(Scope->getInlinedAt());
Devang Patel163a9f72010-05-10 22:49:55 +00001579 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001580 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +00001581
1582 return ScopeDIE;
1583}
1584
Devang Patel2c4ceb12009-11-21 02:48:08 +00001585
1586/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel8a241142009-12-09 18:24:21 +00001587DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel8bd11de2010-08-09 21:01:39 +00001588 StringRef Name = DV->getName();
Devang Patel65dbc902009-11-25 17:36:49 +00001589 if (Name.empty())
Devang Patel3fb6bd62009-11-13 02:25:26 +00001590 return NULL;
Devang Patel53bb5c92009-11-10 23:06:00 +00001591
1592 // Translate tag to proper Dwarf tag. The result variable is dropped for
1593 // now.
1594 unsigned Tag;
Devang Patel8bd11de2010-08-09 21:01:39 +00001595 switch (DV->getTag()) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001596 case dwarf::DW_TAG_return_variable:
1597 return NULL;
1598 case dwarf::DW_TAG_arg_variable:
1599 Tag = dwarf::DW_TAG_formal_parameter;
1600 break;
1601 case dwarf::DW_TAG_auto_variable: // fall thru
1602 default:
1603 Tag = dwarf::DW_TAG_variable;
1604 break;
1605 }
1606
1607 // Define variable debug information entry.
1608 DIE *VariableDie = new DIE(Tag);
1609
Devang Patel53bb5c92009-11-10 23:06:00 +00001610 DIE *AbsDIE = NULL;
Devang Patel26c1e562010-05-20 16:36:41 +00001611 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1612 V2AVI = VarToAbstractVarMap.find(DV);
1613 if (V2AVI != VarToAbstractVarMap.end())
1614 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001615
Devang Patel26c1e562010-05-20 16:36:41 +00001616 if (AbsDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001617 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001618 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001619 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001620 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel8bd11de2010-08-09 21:01:39 +00001621 addSourceLine(VariableDie, DV->getVariable());
Devang Patel53bb5c92009-11-10 23:06:00 +00001622
1623 // Add variable type.
Devang Patel8bd11de2010-08-09 21:01:39 +00001624 addType(VariableDie, DV->getType());
Devang Patel53bb5c92009-11-10 23:06:00 +00001625 }
1626
Devang Patel8bd11de2010-08-09 21:01:39 +00001627 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patelb4645642010-02-06 01:02:37 +00001628 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel3cf763d2010-09-29 23:07:21 +00001629 else if (DIVariable(DV->getVariable()).isArtificial())
1630 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelc3f5f782010-05-25 23:40:22 +00001631
1632 if (Scope->isAbstractScope()) {
1633 DV->setDIE(VariableDie);
1634 return VariableDie;
1635 }
1636
1637 // Add variable address.
1638
1639 unsigned Offset = DV->getDotDebugLocOffset();
1640 if (Offset != ~0U) {
1641 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1642 Asm->GetTempSymbol("debug_loc", Offset));
1643 DV->setDIE(VariableDie);
1644 UseDotDebugLocEntry.insert(VariableDie);
1645 return VariableDie;
1646 }
1647
1648 // Check if variable is described by a DBG_VALUE instruction.
1649 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1650 DbgVariableToDbgInstMap.find(DV);
1651 if (DVI != DbgVariableToDbgInstMap.end()) {
1652 const MachineInstr *DVInsn = DVI->second;
1653 const MCSymbol *DVLabel = findVariableLabel(DV);
1654 bool updated = false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001655 // FIXME : Handle getNumOperands != 3
Devang Patelc3f5f782010-05-25 23:40:22 +00001656 if (DVInsn->getNumOperands() == 3) {
Devang Patel0b48ead2010-08-31 22:22:42 +00001657 if (DVInsn->getOperand(0).isReg()) {
1658 const MachineOperand RegOp = DVInsn->getOperand(0);
1659 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1660 if (DVInsn->getOperand(1).isImm() &&
1661 TRI->getFrameRegister(*Asm->MF) == RegOp.getReg()) {
1662 addVariableAddress(DV, VariableDie, DVInsn->getOperand(1).getImm());
1663 updated = true;
1664 } else
1665 updated = addRegisterAddress(VariableDie, DVLabel, RegOp);
1666 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001667 else if (DVInsn->getOperand(0).isImm())
1668 updated = addConstantValue(VariableDie, DVLabel, DVInsn->getOperand(0));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001669 else if (DVInsn->getOperand(0).isFPImm())
1670 updated =
Devang Patel61409622010-07-07 20:12:52 +00001671 addConstantFPValue(VariableDie, DVLabel, DVInsn->getOperand(0));
Devang Patelc3f5f782010-05-25 23:40:22 +00001672 } else {
1673 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1674 if (Location.getReg()) {
1675 addAddress(VariableDie, dwarf::DW_AT_location, Location);
1676 if (DVLabel)
1677 addLabel(VariableDie, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr,
1678 DVLabel);
1679 updated = true;
1680 }
1681 }
1682 if (!updated) {
1683 // If variableDie is not updated then DBG_VALUE instruction does not
1684 // have valid variable info.
1685 delete VariableDie;
1686 return NULL;
1687 }
1688 DV->setDIE(VariableDie);
1689 return VariableDie;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001690 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001691
1692 // .. else use frame index, if available.
Devang Patelc3f5f782010-05-25 23:40:22 +00001693 int FI = 0;
Devang Patel9e3bd2c2010-08-31 06:11:28 +00001694 if (findVariableFrameIndex(DV, &FI))
1695 addVariableAddress(DV, VariableDie, FI);
1696
Devang Patel53bb5c92009-11-10 23:06:00 +00001697 DV->setDIE(VariableDie);
1698 return VariableDie;
1699
1700}
Devang Patel2c4ceb12009-11-21 02:48:08 +00001701
Devang Patel193f7202009-11-24 01:14:22 +00001702void DwarfDebug::addPubTypes(DISubprogram SP) {
1703 DICompositeType SPTy = SP.getType();
1704 unsigned SPTag = SPTy.getTag();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001705 if (SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel193f7202009-11-24 01:14:22 +00001706 return;
1707
1708 DIArray Args = SPTy.getTypeArray();
Devang Patel193f7202009-11-24 01:14:22 +00001709 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patel2db49d72010-05-07 18:11:54 +00001710 DIType ATy(Args.getElement(i));
Devang Patel9c004872010-05-07 21:45:47 +00001711 if (!ATy.Verify())
Devang Patel193f7202009-11-24 01:14:22 +00001712 continue;
1713 DICompositeType CATy = getDICompositeType(ATy);
Devang Patel2db49d72010-05-07 18:11:54 +00001714 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel50d80e32010-04-13 20:35:04 +00001715 && !CATy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001716 CompileUnit *TheCU = getCompileUnit(CATy);
1717 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1718 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001719 }
1720 }
1721}
1722
Devang Patel2c4ceb12009-11-21 02:48:08 +00001723/// constructScopeDIE - Construct a DIE for this scope.
1724DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3c91b052010-03-08 20:52:55 +00001725 if (!Scope || !Scope->getScopeNode())
1726 return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001727
Devang Patel3c91b052010-03-08 20:52:55 +00001728 DIScope DS(Scope->getScopeNode());
1729 DIE *ScopeDIE = NULL;
1730 if (Scope->getInlinedAt())
1731 ScopeDIE = constructInlinedScopeDIE(Scope);
1732 else if (DS.isSubprogram()) {
Devang Patel0dd45582010-06-28 20:53:04 +00001733 ProcessedSPNodes.insert(DS);
Devang Patel8aa61472010-07-07 22:20:57 +00001734 if (Scope->isAbstractScope()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001735 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patel8aa61472010-07-07 22:20:57 +00001736 // Note down abstract DIE.
1737 if (ScopeDIE)
1738 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
1739 }
Devang Patel3c91b052010-03-08 20:52:55 +00001740 else
Devang Patel2db49d72010-05-07 18:11:54 +00001741 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3c91b052010-03-08 20:52:55 +00001742 }
Devang Patelaead63c2010-03-29 22:59:58 +00001743 else
Devang Patel3c91b052010-03-08 20:52:55 +00001744 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patelaead63c2010-03-29 22:59:58 +00001745 if (!ScopeDIE) return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001746
Devang Patel53bb5c92009-11-10 23:06:00 +00001747 // Add variables to scope.
Devang Patele03161c2010-08-09 18:51:29 +00001748 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patel53bb5c92009-11-10 23:06:00 +00001749 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel8a241142009-12-09 18:24:21 +00001750 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001751 if (VariableDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001752 ScopeDIE->addChild(VariableDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001753 }
1754
1755 // Add nested scopes.
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001756 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
Devang Patel53bb5c92009-11-10 23:06:00 +00001757 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1758 // Define the Scope debug information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001759 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001760 if (NestedDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001761 ScopeDIE->addChild(NestedDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001762 }
Devang Patel193f7202009-11-24 01:14:22 +00001763
Jim Grosbach1e20b962010-07-21 21:21:52 +00001764 if (DS.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001765 addPubTypes(DISubprogram(DS));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001766
Devang Patel193f7202009-11-24 01:14:22 +00001767 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +00001768}
1769
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001770/// GetOrCreateSourceID - Look up the source id with the given directory and
1771/// source file names. If none currently exists, create a new id and insert it
1772/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1773/// maps as well.
Chris Lattner1d65ba72010-03-31 06:06:37 +00001774unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName){
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001775 unsigned DId;
Devang Patel37032352010-07-27 20:51:15 +00001776 assert (DirName.empty() == false && "Invalid directory name!");
Devang Patel2f584852010-07-24 00:53:22 +00001777
Devang Patel1905a182010-09-16 20:57:49 +00001778 // If FE did not provide a file name, then assume stdin.
1779 if (FileName.empty())
1780 return GetOrCreateSourceID(DirName, "<stdin>");
1781
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001782 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1783 if (DI != DirectoryIdMap.end()) {
1784 DId = DI->getValue();
1785 } else {
1786 DId = DirectoryNames.size() + 1;
1787 DirectoryIdMap[DirName] = DId;
1788 DirectoryNames.push_back(DirName);
1789 }
1790
1791 unsigned FId;
1792 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1793 if (FI != SourceFileIdMap.end()) {
1794 FId = FI->getValue();
1795 } else {
1796 FId = SourceFileNames.size() + 1;
1797 SourceFileIdMap[FileName] = FId;
1798 SourceFileNames.push_back(FileName);
1799 }
1800
1801 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1802 SourceIdMap.find(std::make_pair(DId, FId));
1803 if (SI != SourceIdMap.end())
1804 return SI->second;
1805
1806 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1807 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1808 SourceIds.push_back(std::make_pair(DId, FId));
1809
1810 return SrcId;
1811}
1812
Devang Patel6404e4e2009-12-15 19:16:48 +00001813/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1814DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel163a9f72010-05-10 22:49:55 +00001815 CompileUnit *TheCU = getCompileUnit(NS);
1816 DIE *NDie = TheCU->getDIE(NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001817 if (NDie)
1818 return NDie;
1819 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel163a9f72010-05-10 22:49:55 +00001820 TheCU->insertDIE(NS, NDie);
Devang Patel6404e4e2009-12-15 19:16:48 +00001821 if (!NS.getName().empty())
1822 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
Devang Patel81625742010-08-09 20:20:05 +00001823 addSourceLine(NDie, NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001824 addToContextOwner(NDie, NS.getContext());
1825 return NDie;
1826}
1827
Jim Grosbach1e20b962010-07-21 21:21:52 +00001828/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel163a9f72010-05-10 22:49:55 +00001829/// metadata node with tag DW_TAG_compile_unit.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001830void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001831 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +00001832 StringRef FN = DIUnit.getFilename();
1833 StringRef Dir = DIUnit.getDirectory();
Devang Patel5ccdd102009-09-29 18:40:58 +00001834 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001835
1836 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001837 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001838 DIUnit.getProducer());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001839 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001840 DIUnit.getLanguage());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001841 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patel5098da02010-04-26 22:54:28 +00001842 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1843 // simplifies debug range entries.
Devang Patel9b93b6b2010-06-28 22:22:47 +00001844 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Patel4a602ca2010-03-22 23:11:36 +00001845 // DW_AT_stmt_list is a offset of line number information for this
Devang Patelaf608bd2010-08-24 00:06:12 +00001846 // compile unit in debug_line section.
Devang Patelae84d5b2010-08-31 23:50:19 +00001847 if (Asm->MAI->doesDwarfUsesAbsoluteLabelForStmtList())
1848 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_addr,
1849 Asm->GetTempSymbol("section_line"));
1850 else
1851 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001852
Devang Patel65dbc902009-11-25 17:36:49 +00001853 if (!Dir.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001854 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001855 if (DIUnit.isOptimized())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001856 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001857
Devang Patel65dbc902009-11-25 17:36:49 +00001858 StringRef Flags = DIUnit.getFlags();
1859 if (!Flags.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001860 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001861
1862 unsigned RVer = DIUnit.getRunTimeVersion();
1863 if (RVer)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001864 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001865 dwarf::DW_FORM_data1, RVer);
1866
Devang Patel163a9f72010-05-10 22:49:55 +00001867 CompileUnit *NewCU = new CompileUnit(ID, Die);
1868 if (!FirstCU)
1869 FirstCU = NewCU;
1870 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001871}
1872
Devang Patel163a9f72010-05-10 22:49:55 +00001873/// getCompielUnit - Get CompileUnit DIE.
1874CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1875 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1876 DIDescriptor D(N);
1877 const MDNode *CUNode = NULL;
1878 if (D.isCompileUnit())
1879 CUNode = N;
1880 else if (D.isSubprogram())
1881 CUNode = DISubprogram(N).getCompileUnit();
1882 else if (D.isType())
1883 CUNode = DIType(N).getCompileUnit();
1884 else if (D.isGlobalVariable())
1885 CUNode = DIGlobalVariable(N).getCompileUnit();
1886 else if (D.isVariable())
1887 CUNode = DIVariable(N).getCompileUnit();
1888 else if (D.isNameSpace())
1889 CUNode = DINameSpace(N).getCompileUnit();
1890 else if (D.isFile())
1891 CUNode = DIFile(N).getCompileUnit();
1892 else
1893 return FirstCU;
1894
1895 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1896 = CUMap.find(CUNode);
1897 if (I == CUMap.end())
1898 return FirstCU;
1899 return I->second;
1900}
1901
Devang Patel0c4720c2010-08-23 18:25:56 +00001902/// isUnsignedDIType - Return true if type encoding is unsigned.
1903static bool isUnsignedDIType(DIType Ty) {
1904 DIDerivedType DTy(Ty);
1905 if (DTy.Verify())
1906 return isUnsignedDIType(DTy.getTypeDerivedFrom());
1907
1908 DIBasicType BTy(Ty);
1909 if (BTy.Verify()) {
1910 unsigned Encoding = BTy.getEncoding();
1911 if (Encoding == dwarf::DW_ATE_unsigned ||
1912 Encoding == dwarf::DW_ATE_unsigned_char)
1913 return true;
1914 }
1915 return false;
1916}
Devang Patel163a9f72010-05-10 22:49:55 +00001917
1918/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001919void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel9fa539c2010-08-10 01:37:23 +00001920 DIGlobalVariable GV(N);
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001921
Devang Patel905cf5e2009-09-04 23:59:07 +00001922 // If debug information is malformed then ignore it.
Devang Patel9fa539c2010-08-10 01:37:23 +00001923 if (GV.Verify() == false)
Devang Patel905cf5e2009-09-04 23:59:07 +00001924 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001925
1926 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00001927 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel9fa539c2010-08-10 01:37:23 +00001928 if (TheCU->getDIE(GV))
Devang Patel13e16b62009-06-26 01:49:18 +00001929 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001930
Devang Patel9fa539c2010-08-10 01:37:23 +00001931 DIType GTy = GV.getType();
Devang Patel29368072010-08-10 07:11:13 +00001932 DIE *VariableDIE = new DIE(GV.getTag());
1933
1934 bool isGlobalVariable = GV.getGlobal() != NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001935
Devang Patel9fa539c2010-08-10 01:37:23 +00001936 // Add name.
1937 addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1938 GV.getDisplayName());
1939 StringRef LinkageName = GV.getLinkageName();
Devang Patel29368072010-08-10 07:11:13 +00001940 if (!LinkageName.empty() && isGlobalVariable)
Devang Patel9fa539c2010-08-10 01:37:23 +00001941 addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
1942 getRealLinkageName(LinkageName));
1943 // Add type.
1944 addType(VariableDIE, GTy);
Devang Patel50d80e32010-04-13 20:35:04 +00001945 if (GTy.isCompositeType() && !GTy.getName().empty()
1946 && !GTy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001947 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001948 assert(Entry && "Missing global type!");
Devang Patel163a9f72010-05-10 22:49:55 +00001949 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001950 }
Devang Patel9fa539c2010-08-10 01:37:23 +00001951 // Add scoping info.
1952 if (!GV.isLocalToUnit()) {
1953 addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1954 // Expose as global.
1955 TheCU->addGlobal(GV.getName(), VariableDIE);
1956 }
1957 // Add line number info.
1958 addSourceLine(VariableDIE, GV);
1959 // Add to map.
1960 TheCU->insertDIE(N, VariableDIE);
1961 // Add to context owner.
1962 DIDescriptor GVContext = GV.getContext();
1963 addToContextOwner(VariableDIE, GVContext);
1964 // Add location.
Devang Patel29368072010-08-10 07:11:13 +00001965 if (isGlobalVariable) {
1966 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1967 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1968 addLabel(Block, 0, dwarf::DW_FORM_udata,
1969 Asm->Mang->getSymbol(GV.getGlobal()));
1970 // Do not create specification DIE if context is either compile unit
1971 // or a subprogram.
1972 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
1973 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
1974 // Create specification DIE.
1975 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1976 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1977 dwarf::DW_FORM_ref4, VariableDIE);
1978 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1979 addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1980 TheCU->addDie(VariableSpecDIE);
1981 } else {
1982 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
1983 }
1984 } else if (Constant *C = GV.getConstant()) {
1985 if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
Devang Patel0c4720c2010-08-23 18:25:56 +00001986 if (isUnsignedDIType(GTy))
Devang Patel29368072010-08-10 07:11:13 +00001987 addUInt(VariableDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
1988 CI->getZExtValue());
1989 else
1990 addSInt(VariableDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
1991 CI->getSExtValue());
Devang Patel29368072010-08-10 07:11:13 +00001992 }
Devang Patel9fa539c2010-08-10 01:37:23 +00001993 }
Devang Patel13e16b62009-06-26 01:49:18 +00001994 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001995}
1996
Devang Patel163a9f72010-05-10 22:49:55 +00001997/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001998void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001999 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002000
Stuart Hastings639336e2010-04-06 21:38:29 +00002001 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00002002 CompileUnit *TheCU = getCompileUnit(N);
2003 if (TheCU->getDIE(N))
Stuart Hastings639336e2010-04-06 21:38:29 +00002004 return;
2005
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002006 if (!SP.isDefinition())
2007 // This is a method declaration which will be handled while constructing
2008 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +00002009 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002010
Stuart Hastings639336e2010-04-06 21:38:29 +00002011 DIE *SubprogramDie = createSubprogramDIE(SP);
2012
2013 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +00002014 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002015
2016 // Add to context owner.
Devang Patel6404e4e2009-12-15 19:16:48 +00002017 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +00002018
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002019 // Expose as global.
Devang Patel163a9f72010-05-10 22:49:55 +00002020 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel193f7202009-11-24 01:14:22 +00002021
Devang Patel13e16b62009-06-26 01:49:18 +00002022 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002023}
2024
Devang Patel2c4ceb12009-11-21 02:48:08 +00002025/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbar00564992009-09-19 20:40:14 +00002026/// content. Create global DIEs and emit initial debug info sections.
2027/// This is inovked by the target AsmPrinter.
Chris Lattner75f50722010-04-04 07:48:20 +00002028void DwarfDebug::beginModule(Module *M) {
Devang Pateleac9c072010-04-27 19:46:33 +00002029 if (DisableDebugInfoPrinting)
2030 return;
2031
Devang Patel78ab9e22009-07-30 18:56:46 +00002032 DebugInfoFinder DbgFinder;
2033 DbgFinder.processModule(*M);
Devang Patel13e16b62009-06-26 01:49:18 +00002034
Chris Lattnerd850ac72010-04-05 02:19:28 +00002035 bool HasDebugInfo = false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002036
Chris Lattnerd850ac72010-04-05 02:19:28 +00002037 // Scan all the compile-units to see if there are any marked as the main unit.
2038 // if not, we do not generate debug info.
2039 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2040 E = DbgFinder.compile_unit_end(); I != E; ++I) {
2041 if (DICompileUnit(*I).isMain()) {
2042 HasDebugInfo = true;
2043 break;
2044 }
2045 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002046
Chris Lattnerd850ac72010-04-05 02:19:28 +00002047 if (!HasDebugInfo) return;
2048
2049 // Tell MMI that we have debug info.
2050 MMI->setDebugInfoAvailability(true);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002051
Chris Lattnerbe15beb2010-04-04 23:17:54 +00002052 // Emit initial sections.
Chris Lattnerd850ac72010-04-05 02:19:28 +00002053 EmitSectionLabels();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002054
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002055 // Create all the compile unit DIEs.
Devang Patel78ab9e22009-07-30 18:56:46 +00002056 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2057 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002058 constructCompileUnit(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002059
Devang Patel53bb5c92009-11-10 23:06:00 +00002060 // Create DIEs for each subprogram.
Devang Patel78ab9e22009-07-30 18:56:46 +00002061 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
2062 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002063 constructSubprogramDIE(*I);
Devang Patel13e16b62009-06-26 01:49:18 +00002064
Devang Patelc366f832009-12-10 19:14:49 +00002065 // Create DIEs for each global variable.
2066 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2067 E = DbgFinder.global_variable_end(); I != E; ++I)
2068 constructGlobalVariableDIE(*I);
2069
Devang Patele7e5a0f2010-08-10 20:01:20 +00002070 //getOrCreateTypeDIE
2071 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
2072 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2073 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2074
Devang Patel1a7ca032010-09-28 18:08:20 +00002075 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
2076 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2077 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2078
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002079 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +00002080 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002081
2082 // Print out .file directives to specify files for .loc directives. These are
2083 // printed out early so that they precede any .loc directives.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002084 if (Asm->MAI->hasDotLocAndDotFile()) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002085 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
2086 // Remember source id starts at 1.
2087 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
Chris Lattner0ad9c912010-01-22 22:09:00 +00002088 // FIXME: don't use sys::path for this! This should not depend on the
2089 // host.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002090 sys::Path FullPath(getSourceDirectoryName(Id.first));
2091 bool AppendOk =
2092 FullPath.appendComponent(getSourceFileName(Id.second));
2093 assert(AppendOk && "Could not append filename to directory!");
2094 AppendOk = false;
Chris Lattnera6594fc2010-01-25 18:58:59 +00002095 Asm->OutStreamer.EmitDwarfFileDirective(i, FullPath.str());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002096 }
2097 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002098}
2099
Devang Patel2c4ceb12009-11-21 02:48:08 +00002100/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002101///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002102void DwarfDebug::endModule() {
Devang Patel163a9f72010-05-10 22:49:55 +00002103 if (!FirstCU) return;
Devang Patel4a1cad62010-06-28 18:25:03 +00002104 const Module *M = MMI->getModule();
Devang Patele9a1cca2010-08-02 17:32:15 +00002105 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patel4a1cad62010-06-28 18:25:03 +00002106 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2107 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2108 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2109 DISubprogram SP(AllSPs->getOperand(SI));
2110 if (!SP.Verify()) continue;
2111
2112 // Collect info for variables that were optimized out.
Devang Patel8b3a6b62010-07-19 17:53:55 +00002113 if (!SP.isDefinition()) continue;
Devang Patel4a1cad62010-06-28 18:25:03 +00002114 StringRef FName = SP.getLinkageName();
2115 if (FName.empty())
2116 FName = SP.getName();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002117 NamedMDNode *NMD =
Devang Patel4a1cad62010-06-28 18:25:03 +00002118 M->getNamedMetadata(Twine("llvm.dbg.lv.", getRealLinkageName(FName)));
2119 if (!NMD) continue;
2120 unsigned E = NMD->getNumOperands();
2121 if (!E) continue;
2122 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Patele9a1cca2010-08-02 17:32:15 +00002123 DeadFnScopeMap[SP] = Scope;
Devang Patel4a1cad62010-06-28 18:25:03 +00002124 for (unsigned I = 0; I != E; ++I) {
2125 DIVariable DV(NMD->getOperand(I));
2126 if (!DV.Verify()) continue;
2127 Scope->addVariable(new DbgVariable(DV));
2128 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002129
Devang Patel4a1cad62010-06-28 18:25:03 +00002130 // Construct subprogram DIE and add variables DIEs.
2131 constructSubprogramDIE(SP);
2132 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patele03161c2010-08-09 18:51:29 +00002133 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patel4a1cad62010-06-28 18:25:03 +00002134 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2135 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2136 if (VariableDIE)
2137 ScopeDIE->addChild(VariableDIE);
2138 }
2139 }
2140 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002141
Devang Patel53bb5c92009-11-10 23:06:00 +00002142 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2143 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2144 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2145 DIE *ISP = *AI;
Devang Patel2c4ceb12009-11-21 02:48:08 +00002146 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +00002147 }
2148
Devang Patele9f8f5e2010-05-07 20:54:48 +00002149 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Patel5d11eb02009-12-03 19:11:07 +00002150 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2151 DIE *SPDie = CI->first;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002152 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Patel5d11eb02009-12-03 19:11:07 +00002153 if (!N) continue;
Devang Patel163a9f72010-05-10 22:49:55 +00002154 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Patel5d11eb02009-12-03 19:11:07 +00002155 if (!NDie) continue;
2156 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patel5d11eb02009-12-03 19:11:07 +00002157 }
2158
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002159 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002160 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002161 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002162 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002163 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002164
2165 // End text sections.
2166 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002167 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnerc0215722010-04-04 19:25:43 +00002168 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002169 }
2170
2171 // Emit common frame information.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002172 emitCommonDebugFrame();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002173
2174 // Emit function debug frame information
2175 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2176 E = DebugFrames.end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002177 emitFunctionDebugFrame(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002178
2179 // Compute DIE offsets and sizes.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002180 computeSizeAndOffsets();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002181
2182 // Emit all the DIEs into a debug info section
Devang Patel2c4ceb12009-11-21 02:48:08 +00002183 emitDebugInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002184
2185 // Corresponding abbreviations into a abbrev section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002186 emitAbbreviations();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002187
Devang Patelaf608bd2010-08-24 00:06:12 +00002188 // Emit source line correspondence into a debug line section.
2189 emitDebugLines();
2190
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002191 // Emit info into a debug pubnames section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002192 emitDebugPubNames();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002193
Devang Patel193f7202009-11-24 01:14:22 +00002194 // Emit info into a debug pubtypes section.
2195 emitDebugPubTypes();
2196
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002197 // Emit info into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002198 emitDebugLoc();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002199
2200 // Emit info into a debug aranges section.
2201 EmitDebugARanges();
2202
2203 // Emit info into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002204 emitDebugRanges();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002205
2206 // Emit info into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002207 emitDebugMacInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002208
2209 // Emit inline info.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002210 emitDebugInlineInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002211
Chris Lattnerbc733f52010-03-13 02:17:42 +00002212 // Emit info into a debug str section.
2213 emitDebugStr();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002214
Devang Patele9a1cca2010-08-02 17:32:15 +00002215 // clean up.
2216 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel163a9f72010-05-10 22:49:55 +00002217 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2218 E = CUMap.end(); I != E; ++I)
2219 delete I->second;
2220 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002221}
2222
Devang Patel53bb5c92009-11-10 23:06:00 +00002223/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002224DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattnerde4845c2010-04-02 19:42:39 +00002225 DebugLoc ScopeLoc) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002226
Devang Patel2db49d72010-05-07 18:11:54 +00002227 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00002228 if (AbsDbgVariable)
2229 return AbsDbgVariable;
2230
Devang Patel2db49d72010-05-07 18:11:54 +00002231 LLVMContext &Ctx = Var->getContext();
Chris Lattnerde4845c2010-04-02 19:42:39 +00002232 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00002233 if (!Scope)
2234 return NULL;
2235
Devang Patel26c1e562010-05-20 16:36:41 +00002236 AbsDbgVariable = new DbgVariable(Var);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002237 Scope->addVariable(AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00002238 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00002239 return AbsDbgVariable;
2240}
2241
Devang Patelee432862010-05-20 19:57:06 +00002242/// collectVariableInfoFromMMITable - Collect variable information from
2243/// side table maintained by MMI.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002244void
Devang Patelee432862010-05-20 19:57:06 +00002245DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2246 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00002247 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patele717faa2009-10-06 01:26:37 +00002248 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2249 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2250 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00002251 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00002252 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00002253 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002254 DIVariable DV(Var);
2255 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00002256
Chris Lattnerde4845c2010-04-02 19:42:39 +00002257 DbgScope *Scope = 0;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002258 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattnerde4845c2010-04-02 19:42:39 +00002259 Scope = ConcreteScopes.lookup(IA);
2260 if (Scope == 0)
2261 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002262
Devang Patelfb0ee432009-11-10 23:20:04 +00002263 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00002264 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00002265 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00002266
Devang Patel26c1e562010-05-20 16:36:41 +00002267 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2268 DbgVariable *RegVar = new DbgVariable(DV);
2269 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002270 Scope->addVariable(RegVar);
Devang Patel26c1e562010-05-20 16:36:41 +00002271 if (AbsDbgVariable) {
2272 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2273 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2274 }
Devang Patele717faa2009-10-06 01:26:37 +00002275 }
Devang Patelee432862010-05-20 19:57:06 +00002276}
Devang Patel90a48ad2010-03-15 18:33:46 +00002277
Jim Grosbach1e20b962010-07-21 21:21:52 +00002278/// isDbgValueInUndefinedReg - Return true if debug value, encoded by
Devang Patelc3f5f782010-05-25 23:40:22 +00002279/// DBG_VALUE instruction, is in undefined reg.
2280static bool isDbgValueInUndefinedReg(const MachineInstr *MI) {
2281 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2282 if (MI->getOperand(0).isReg() && !MI->getOperand(0).getReg())
2283 return true;
2284 return false;
2285}
2286
Jim Grosbach1e20b962010-07-21 21:21:52 +00002287/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patelc3f5f782010-05-25 23:40:22 +00002288/// DBG_VALUE instruction, is in a defined reg.
2289static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2290 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2291 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2292 return true;
2293 return false;
2294}
2295
Devang Patelee432862010-05-20 19:57:06 +00002296/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002297void
Devang Patel78e127d2010-06-25 22:07:34 +00002298DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2299 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002300
Devang Patelee432862010-05-20 19:57:06 +00002301 /// collection info from MMI table.
2302 collectVariableInfoFromMMITable(MF, Processed);
2303
2304 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patel90a48ad2010-03-15 18:33:46 +00002305 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002306 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelee432862010-05-20 19:57:06 +00002307 I != E; ++I)
Devang Patel90a48ad2010-03-15 18:33:46 +00002308 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2309 II != IE; ++II) {
2310 const MachineInstr *MInsn = II;
Devang Patelc3f5f782010-05-25 23:40:22 +00002311 if (!MInsn->isDebugValue() || isDbgValueInUndefinedReg(MInsn))
Devang Patel90a48ad2010-03-15 18:33:46 +00002312 continue;
Devang Patelee432862010-05-20 19:57:06 +00002313 DbgValues.push_back(MInsn);
2314 }
Devang Patel90a48ad2010-03-15 18:33:46 +00002315
Devang Patelc3f5f782010-05-25 23:40:22 +00002316 // This is a collection of DBV_VALUE instructions describing same variable.
2317 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patelee432862010-05-20 19:57:06 +00002318 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2319 E = DbgValues.end(); I != E; ++I) {
2320 const MachineInstr *MInsn = *I;
Devang Patelc3f5f782010-05-25 23:40:22 +00002321 MultipleValues.clear();
2322 if (isDbgValueInDefinedReg(MInsn))
2323 MultipleValues.push_back(MInsn);
Devang Patelee432862010-05-20 19:57:06 +00002324 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2325 if (Processed.count(DV) != 0)
2326 continue;
2327
Devang Patel354eb7e2010-06-02 19:05:13 +00002328 const MachineInstr *PrevMI = MInsn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002329 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
Devang Patelc3f5f782010-05-25 23:40:22 +00002330 ME = DbgValues.end(); MI != ME; ++MI) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002331 const MDNode *Var =
Devang Patelc3f5f782010-05-25 23:40:22 +00002332 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002333 if (Var == DV && isDbgValueInDefinedReg(*MI) &&
Devang Patel354eb7e2010-06-02 19:05:13 +00002334 !PrevMI->isIdenticalTo(*MI))
Devang Patelc3f5f782010-05-25 23:40:22 +00002335 MultipleValues.push_back(*MI);
Devang Patel354eb7e2010-06-02 19:05:13 +00002336 PrevMI = *MI;
Devang Patelc3f5f782010-05-25 23:40:22 +00002337 }
2338
Devang Patelee432862010-05-20 19:57:06 +00002339 DbgScope *Scope = findDbgScope(MInsn);
Devang Pateld8720f42010-05-27 20:25:04 +00002340 bool CurFnArg = false;
2341 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2342 DISubprogram(DV.getContext()).describes(MF->getFunction()))
2343 CurFnArg = true;
2344 if (!Scope && CurFnArg)
Devang Patelc0c5a262010-05-21 00:10:20 +00002345 Scope = CurrentFnDbgScope;
Devang Patelee432862010-05-20 19:57:06 +00002346 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00002347 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00002348 continue;
2349
2350 Processed.insert(DV);
Devang Patelee432862010-05-20 19:57:06 +00002351 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patelee432862010-05-20 19:57:06 +00002352 Scope->addVariable(RegVar);
Devang Pateld8720f42010-05-27 20:25:04 +00002353 if (!CurFnArg)
Jim Grosbach1e20b962010-07-21 21:21:52 +00002354 DbgVariableLabelsMap[RegVar] = getLabelBeforeInsn(MInsn);
Devang Patelc0c5a262010-05-21 00:10:20 +00002355 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2356 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2357 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patel90a48ad2010-03-15 18:33:46 +00002358 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002359 if (MultipleValues.size() <= 1) {
2360 DbgVariableToDbgInstMap[RegVar] = MInsn;
2361 continue;
2362 }
2363
2364 // handle multiple DBG_VALUE instructions describing one variable.
Devang Patelc3f5f782010-05-25 23:40:22 +00002365 if (DotDebugLocEntries.empty())
Devang Patel80250682010-05-26 23:55:23 +00002366 RegVar->setDotDebugLocOffset(0);
2367 else
2368 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Devang Patele2df8422010-05-26 17:29:32 +00002369 const MachineInstr *Begin = NULL;
2370 const MachineInstr *End = NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002371 for (SmallVector<const MachineInstr *, 4>::iterator
2372 MVI = MultipleValues.begin(), MVE = MultipleValues.end();
Devang Patel61409622010-07-07 20:12:52 +00002373 MVI != MVE; ++MVI) {
Devang Patele2df8422010-05-26 17:29:32 +00002374 if (!Begin) {
2375 Begin = *MVI;
2376 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002377 }
Devang Patele2df8422010-05-26 17:29:32 +00002378 End = *MVI;
Devang Patelc3f5f782010-05-25 23:40:22 +00002379 MachineLocation MLoc;
Devang Patelb2cf5812010-08-04 18:40:52 +00002380 if (Begin->getNumOperands() == 3) {
2381 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2382 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2383 } else
2384 MLoc = Asm->getDebugValueLocation(Begin);
2385
Devang Patele2df8422010-05-26 17:29:32 +00002386 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2387 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patel5573a7d2010-08-04 22:07:27 +00002388 if (MLoc.getReg())
2389 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
2390
Devang Patele2df8422010-05-26 17:29:32 +00002391 Begin = End;
2392 if (MVI + 1 == MVE) {
2393 // If End is the last instruction then its value is valid
Devang Patelc3f5f782010-05-25 23:40:22 +00002394 // until the end of the funtion.
Devang Patelb2cf5812010-08-04 18:40:52 +00002395 MachineLocation EMLoc;
2396 if (End->getNumOperands() == 3) {
2397 if (End->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2398 EMLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2399 } else
2400 EMLoc = Asm->getDebugValueLocation(End);
Devang Patel5573a7d2010-08-04 22:07:27 +00002401 if (EMLoc.getReg())
2402 DotDebugLocEntries.
2403 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, EMLoc));
Devang Patelc3f5f782010-05-25 23:40:22 +00002404 }
2405 }
2406 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00002407 }
Devang Patel98e1cac2010-05-14 21:01:35 +00002408
2409 // Collect info for variables that were optimized out.
Devang Pateld1bbc6b2010-06-22 01:01:58 +00002410 const Function *F = MF->getFunction();
2411 const Module *M = F->getParent();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002412 if (NamedMDNode *NMD =
2413 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patela762b092010-06-22 01:19:38 +00002414 getRealLinkageName(F->getName())))) {
Devang Patel98e1cac2010-05-14 21:01:35 +00002415 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman872814a2010-07-21 18:54:18 +00002416 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patelee432862010-05-20 19:57:06 +00002417 if (!DV || !Processed.insert(DV))
Devang Patel98e1cac2010-05-14 21:01:35 +00002418 continue;
2419 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2420 if (Scope)
Devang Patel26c1e562010-05-20 16:36:41 +00002421 Scope->addVariable(new DbgVariable(DV));
Devang Patel98e1cac2010-05-14 21:01:35 +00002422 }
2423 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002424}
Devang Patel98e1cac2010-05-14 21:01:35 +00002425
Devang Patelc3f5f782010-05-25 23:40:22 +00002426/// getLabelBeforeInsn - Return Label preceding the instruction.
2427const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2428 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2429 LabelsBeforeInsn.find(MI);
2430 if (I == LabelsBeforeInsn.end())
2431 // FunctionBeginSym always preceeds all the instruction in current function.
2432 return FunctionBeginSym;
2433 return I->second;
2434}
2435
2436/// getLabelAfterInsn - Return Label immediately following the instruction.
2437const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2438 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2439 LabelsAfterInsn.find(MI);
2440 if (I == LabelsAfterInsn.end())
2441 return NULL;
2442 return I->second;
Devang Patele717faa2009-10-06 01:26:37 +00002443}
2444
Devang Patel553881b2010-03-29 17:20:31 +00002445/// beginScope - Process beginning of a scope.
2446void DwarfDebug::beginScope(const MachineInstr *MI) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002447 if (InsnNeedsLabel.count(MI) == 0) {
2448 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patel553881b2010-03-29 17:20:31 +00002449 return;
Devang Patelc3f5f782010-05-25 23:40:22 +00002450 }
Devang Patelaead63c2010-03-29 22:59:58 +00002451
Devang Patelb2b31a62010-05-26 19:37:24 +00002452 // Check location.
2453 DebugLoc DL = MI->getDebugLoc();
2454 if (!DL.isUnknown()) {
2455 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2456 PrevLabel = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
Devang Pateleac9c072010-04-27 19:46:33 +00002457 PrevInstLoc = DL;
Devang Patelb2b31a62010-05-26 19:37:24 +00002458 LabelsBeforeInsn[MI] = PrevLabel;
2459 return;
Devang Pateleac9c072010-04-27 19:46:33 +00002460 }
Devang Patel553881b2010-03-29 17:20:31 +00002461
Jim Grosbach1e20b962010-07-21 21:21:52 +00002462 // If location is unknown then use temp label for this DBG_VALUE
Devang Patelb2b31a62010-05-26 19:37:24 +00002463 // instruction.
2464 if (MI->isDebugValue()) {
Devang Patel77051f52010-05-26 21:23:46 +00002465 PrevLabel = MMI->getContext().CreateTempSymbol();
2466 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00002467 LabelsBeforeInsn[MI] = PrevLabel;
2468 return;
2469 }
2470
2471 if (UnknownLocations) {
2472 PrevLabel = recordSourceLine(0, 0, 0);
2473 LabelsBeforeInsn[MI] = PrevLabel;
2474 return;
2475 }
2476
2477 assert (0 && "Instruction is not processed!");
Devang Patel0d20ac82009-10-06 01:50:42 +00002478}
2479
Devang Patel2c4ceb12009-11-21 02:48:08 +00002480/// endScope - Process end of a scope.
2481void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel1c246352010-04-08 16:50:29 +00002482 if (InsnsEndScopeSet.count(MI) != 0) {
2483 // Emit a label if this instruction ends a scope.
2484 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2485 Asm->OutStreamer.EmitLabel(Label);
Devang Pateleac9c072010-04-27 19:46:33 +00002486 LabelsAfterInsn[MI] = Label;
Devang Patel1c246352010-04-08 16:50:29 +00002487 }
Devang Patel53bb5c92009-11-10 23:06:00 +00002488}
2489
Devang Pateleac9c072010-04-27 19:46:33 +00002490/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002491DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel61409622010-07-07 20:12:52 +00002492 const MDNode *InlinedAt) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002493 if (!InlinedAt) {
2494 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2495 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002496 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002497 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2498 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Pateleac9c072010-04-27 19:46:33 +00002499 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002500 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002501 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Pateleac9c072010-04-27 19:46:33 +00002502 WScope->setParent(Parent);
2503 Parent->addScope(WScope);
2504 }
2505
2506 if (!WScope->getParent()) {
2507 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastingscad22ad2010-06-15 23:06:30 +00002508 // We used to check only for a linkage name, but that fails
2509 // since we began omitting the linkage name for private
2510 // functions. The new way is to check for the name in metadata,
2511 // but that's not supported in old .ll test cases. Ergo, we
2512 // check both.
Stuart Hastings215aa152010-06-11 20:08:44 +00002513 if (SPName == Asm->MF->getFunction()->getName() ||
2514 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Pateleac9c072010-04-27 19:46:33 +00002515 CurrentFnDbgScope = WScope;
2516 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002517
Devang Pateleac9c072010-04-27 19:46:33 +00002518 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002519 }
2520
Devang Patel78e127d2010-06-25 22:07:34 +00002521 getOrCreateAbstractScope(Scope);
Devang Patel53bb5c92009-11-10 23:06:00 +00002522 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2523 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002524 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002525
2526 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2527 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2528 DILocation DL(InlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002529 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002530 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Pateleac9c072010-04-27 19:46:33 +00002531 WScope->setParent(Parent);
2532 Parent->addScope(WScope);
2533
2534 ConcreteScopes[InlinedAt] = WScope;
Devang Pateleac9c072010-04-27 19:46:33 +00002535
2536 return WScope;
Devang Patel0d20ac82009-10-06 01:50:42 +00002537}
2538
Devang Pateleac9c072010-04-27 19:46:33 +00002539/// hasValidLocation - Return true if debug location entry attached with
2540/// machine instruction encodes valid location info.
2541static bool hasValidLocation(LLVMContext &Ctx,
2542 const MachineInstr *MInsn,
Devang Patele9f8f5e2010-05-07 20:54:48 +00002543 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Pateleac9c072010-04-27 19:46:33 +00002544 DebugLoc DL = MInsn->getDebugLoc();
2545 if (DL.isUnknown()) return false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002546
Devang Patele9f8f5e2010-05-07 20:54:48 +00002547 const MDNode *S = DL.getScope(Ctx);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002548
Devang Pateleac9c072010-04-27 19:46:33 +00002549 // There is no need to create another DIE for compile unit. For all
2550 // other scopes, create one DbgScope now. This will be translated
2551 // into a scope DIE at the end.
2552 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002553
Devang Pateleac9c072010-04-27 19:46:33 +00002554 Scope = S;
2555 InlinedAt = DL.getInlinedAt(Ctx);
2556 return true;
2557}
2558
2559/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2560/// hierarchy.
2561static void calculateDominanceGraph(DbgScope *Scope) {
2562 assert (Scope && "Unable to calculate scop edominance graph!");
2563 SmallVector<DbgScope *, 4> WorkStack;
2564 WorkStack.push_back(Scope);
2565 unsigned Counter = 0;
2566 while (!WorkStack.empty()) {
2567 DbgScope *WS = WorkStack.back();
2568 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2569 bool visitedChildren = false;
2570 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2571 SE = Children.end(); SI != SE; ++SI) {
2572 DbgScope *ChildScope = *SI;
2573 if (!ChildScope->getDFSOut()) {
2574 WorkStack.push_back(ChildScope);
2575 visitedChildren = true;
2576 ChildScope->setDFSIn(++Counter);
2577 break;
2578 }
2579 }
2580 if (!visitedChildren) {
2581 WorkStack.pop_back();
2582 WS->setDFSOut(++Counter);
2583 }
2584 }
2585}
2586
2587/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002588static
Devang Pateleac9c072010-04-27 19:46:33 +00002589void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2590 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2591{
2592#ifndef NDEBUG
2593 unsigned PrevDFSIn = 0;
2594 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2595 I != E; ++I) {
2596 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2597 II != IE; ++II) {
2598 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002599 const MDNode *Scope = NULL;
2600 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002601
2602 // Check if instruction has valid location information.
2603 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2604 dbgs() << " [ ";
Jim Grosbach1e20b962010-07-21 21:21:52 +00002605 if (InlinedAt)
Devang Pateleac9c072010-04-27 19:46:33 +00002606 dbgs() << "*";
Jim Grosbach1e20b962010-07-21 21:21:52 +00002607 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Pateleac9c072010-04-27 19:46:33 +00002608 MI2ScopeMap.find(MInsn);
2609 if (DI != MI2ScopeMap.end()) {
2610 DbgScope *S = DI->second;
2611 dbgs() << S->getDFSIn();
2612 PrevDFSIn = S->getDFSIn();
2613 } else
2614 dbgs() << PrevDFSIn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002615 } else
Devang Pateleac9c072010-04-27 19:46:33 +00002616 dbgs() << " [ x" << PrevDFSIn;
2617 dbgs() << " ]";
2618 MInsn->dump();
2619 }
2620 dbgs() << "\n";
2621 }
2622#endif
2623}
Devang Patel2c4ceb12009-11-21 02:48:08 +00002624/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner14d750d2010-03-31 05:39:57 +00002625/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattnereec791a2010-01-26 23:18:02 +00002626bool DwarfDebug::extractScopeInformation() {
Devang Patelaf9e8472009-10-01 20:31:14 +00002627 // If scope information was extracted using .dbg intrinsics then there is not
2628 // any need to extract these information by scanning each instruction.
2629 if (!DbgScopeMap.empty())
2630 return false;
2631
Dan Gohman314bf7c2010-04-23 01:18:53 +00002632 // Scan each instruction and create scopes. First build working set of scopes.
Devang Pateleac9c072010-04-27 19:46:33 +00002633 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2634 SmallVector<DbgRange, 4> MIRanges;
2635 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002636 const MDNode *PrevScope = NULL;
2637 const MDNode *PrevInlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002638 const MachineInstr *RangeBeginMI = NULL;
2639 const MachineInstr *PrevMI = NULL;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002640 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelaf9e8472009-10-01 20:31:14 +00002641 I != E; ++I) {
2642 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2643 II != IE; ++II) {
2644 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002645 const MDNode *Scope = NULL;
2646 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002647
2648 // Check if instruction has valid location information.
2649 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2650 PrevMI = MInsn;
2651 continue;
2652 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002653
Devang Pateleac9c072010-04-27 19:46:33 +00002654 // If scope has not changed then skip this instruction.
2655 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2656 PrevMI = MInsn;
2657 continue;
2658 }
2659
Jim Grosbach1e20b962010-07-21 21:21:52 +00002660 if (RangeBeginMI) {
2661 // If we have alread seen a beginning of a instruction range and
Devang Pateleac9c072010-04-27 19:46:33 +00002662 // current instruction scope does not match scope of first instruction
2663 // in this range then create a new instruction range.
2664 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002665 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel61409622010-07-07 20:12:52 +00002666 PrevInlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002667 MIRanges.push_back(R);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002668 }
Devang Pateleac9c072010-04-27 19:46:33 +00002669
2670 // This is a beginning of a new instruction range.
2671 RangeBeginMI = MInsn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002672
Devang Pateleac9c072010-04-27 19:46:33 +00002673 // Reset previous markers.
2674 PrevMI = MInsn;
2675 PrevScope = Scope;
2676 PrevInlinedAt = InlinedAt;
Devang Patel53bb5c92009-11-10 23:06:00 +00002677 }
2678 }
2679
Devang Pateleac9c072010-04-27 19:46:33 +00002680 // Create last instruction range.
2681 if (RangeBeginMI && PrevMI && PrevScope) {
2682 DbgRange R(RangeBeginMI, PrevMI);
2683 MIRanges.push_back(R);
2684 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patelaf9e8472009-10-01 20:31:14 +00002685 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002686
Devang Patel344130e2010-01-04 20:44:00 +00002687 if (!CurrentFnDbgScope)
2688 return false;
2689
Devang Pateleac9c072010-04-27 19:46:33 +00002690 calculateDominanceGraph(CurrentFnDbgScope);
2691 if (PrintDbgScope)
2692 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2693
2694 // Find ranges of instructions covered by each DbgScope;
2695 DbgScope *PrevDbgScope = NULL;
2696 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2697 RE = MIRanges.end(); RI != RE; ++RI) {
2698 const DbgRange &R = *RI;
2699 DbgScope *S = MI2ScopeMap.lookup(R.first);
2700 assert (S && "Lost DbgScope for a machine instruction!");
2701 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2702 PrevDbgScope->closeInsnRange(S);
2703 S->openInsnRange(R.first);
2704 S->extendInsnRange(R.second);
2705 PrevDbgScope = S;
2706 }
2707
2708 if (PrevDbgScope)
2709 PrevDbgScope->closeInsnRange();
Devang Patelaf9e8472009-10-01 20:31:14 +00002710
Devang Patele37b0c62010-04-08 18:43:56 +00002711 identifyScopeMarkers();
Devang Patel6122a4d2010-04-08 15:37:09 +00002712
2713 return !DbgScopeMap.empty();
2714}
2715
Jim Grosbach1e20b962010-07-21 21:21:52 +00002716/// identifyScopeMarkers() -
Devang Pateleac9c072010-04-27 19:46:33 +00002717/// Each DbgScope has first instruction and last instruction to mark beginning
2718/// and end of a scope respectively. Create an inverse map that list scopes
2719/// starts (and ends) with an instruction. One instruction may start (or end)
2720/// multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00002721void DwarfDebug::identifyScopeMarkers() {
Devang Patel42aafd72010-01-20 02:05:23 +00002722 SmallVector<DbgScope *, 4> WorkList;
2723 WorkList.push_back(CurrentFnDbgScope);
2724 while (!WorkList.empty()) {
Chris Lattner14d750d2010-03-31 05:39:57 +00002725 DbgScope *S = WorkList.pop_back_val();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002726
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002727 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002728 if (!Children.empty())
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002729 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00002730 SE = Children.end(); SI != SE; ++SI)
2731 WorkList.push_back(*SI);
2732
Devang Patel53bb5c92009-11-10 23:06:00 +00002733 if (S->isAbstractScope())
2734 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002735
Devang Pateleac9c072010-04-27 19:46:33 +00002736 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2737 if (Ranges.empty())
2738 continue;
2739 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2740 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002741 assert(RI->first && "DbgRange does not have first instruction!");
2742 assert(RI->second && "DbgRange does not have second instruction!");
Devang Pateleac9c072010-04-27 19:46:33 +00002743 InsnsEndScopeSet.insert(RI->second);
2744 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002745 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002746}
2747
Dan Gohman084751c2010-04-20 00:37:27 +00002748/// FindFirstDebugLoc - Find the first debug location in the function. This
2749/// is intended to be an approximation for the source position of the
2750/// beginning of the function.
2751static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2752 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2753 I != E; ++I)
2754 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2755 MBBI != MBBE; ++MBBI) {
2756 DebugLoc DL = MBBI->getDebugLoc();
2757 if (!DL.isUnknown())
2758 return DL;
2759 }
2760 return DebugLoc();
2761}
2762
Devang Patel2c4ceb12009-11-21 02:48:08 +00002763/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002764/// emitted immediately after the function entry point.
Chris Lattnereec791a2010-01-26 23:18:02 +00002765void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00002766 if (!MMI->hasDebugInfo()) return;
Bill Wendling5f017e82010-04-07 09:28:04 +00002767 if (!extractScopeInformation()) return;
Devang Patel60b35bd2009-10-06 18:37:31 +00002768
Devang Pateleac9c072010-04-27 19:46:33 +00002769 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2770 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002771 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00002772 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002773
2774 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2775 // function.
Dan Gohman084751c2010-04-20 00:37:27 +00002776 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002777 if (FDL.isUnknown()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002778
Devang Patele9f8f5e2010-05-07 20:54:48 +00002779 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings0db42712010-07-19 23:56:30 +00002780 const MDNode *TheScope = 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002781
Chris Lattnerde4845c2010-04-02 19:42:39 +00002782 DISubprogram SP = getDISubprogram(Scope);
2783 unsigned Line, Col;
2784 if (SP.Verify()) {
2785 Line = SP.getLineNumber();
2786 Col = 0;
Stuart Hastings0db42712010-07-19 23:56:30 +00002787 TheScope = SP;
Chris Lattnerde4845c2010-04-02 19:42:39 +00002788 } else {
2789 Line = FDL.getLine();
2790 Col = FDL.getCol();
Stuart Hastings0db42712010-07-19 23:56:30 +00002791 TheScope = Scope;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002792 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002793
Stuart Hastings0db42712010-07-19 23:56:30 +00002794 recordSourceLine(Line, Col, TheScope);
Devang Patelb2b31a62010-05-26 19:37:24 +00002795
Devang Patelb9abe9f2010-06-02 16:42:51 +00002796 /// ProcessedArgs - Collection of arguments already processed.
2797 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2798
Devang Patelb2b31a62010-05-26 19:37:24 +00002799 DebugLoc PrevLoc;
2800 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2801 I != E; ++I)
2802 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2803 II != IE; ++II) {
2804 const MachineInstr *MI = II;
2805 DebugLoc DL = MI->getDebugLoc();
2806 if (MI->isDebugValue()) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002807 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2808 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2809 if (!DV.Verify()) continue;
Devang Patel55e97172010-05-27 16:47:30 +00002810 // If DBG_VALUE is for a local variable then it needs a label.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002811 if (DV.getTag() != dwarf::DW_TAG_arg_variable
Devang Patel7fb231c2010-07-01 21:38:08 +00002812 && isDbgValueInUndefinedReg(MI) == false)
Devang Patelb2b31a62010-05-26 19:37:24 +00002813 InsnNeedsLabel.insert(MI);
Devang Patel55e97172010-05-27 16:47:30 +00002814 // DBG_VALUE for inlined functions argument needs a label.
Devang Patel7fb231c2010-07-01 21:38:08 +00002815 else if (!DISubprogram(getDISubprogram(DV.getContext())).
2816 describes(MF->getFunction()))
Devang Patel55e97172010-05-27 16:47:30 +00002817 InsnNeedsLabel.insert(MI);
2818 // DBG_VALUE indicating argument location change needs a label.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002819 else if (isDbgValueInUndefinedReg(MI) == false
2820 && !ProcessedArgs.insert(DV))
Devang Patelb2b31a62010-05-26 19:37:24 +00002821 InsnNeedsLabel.insert(MI);
2822 } else {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002823 // If location is unknown then instruction needs a location only if
Devang Patelb2b31a62010-05-26 19:37:24 +00002824 // UnknownLocations flag is set.
2825 if (DL.isUnknown()) {
2826 if (UnknownLocations && !PrevLoc.isUnknown())
2827 InsnNeedsLabel.insert(MI);
2828 } else if (DL != PrevLoc)
2829 // Otherwise, instruction needs a location only if it is new location.
2830 InsnNeedsLabel.insert(MI);
2831 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002832
Devang Patelb2b31a62010-05-26 19:37:24 +00002833 if (!DL.isUnknown() || UnknownLocations)
2834 PrevLoc = DL;
2835 }
2836
2837 PrevLabel = FunctionBeginSym;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002838}
2839
Devang Patel2c4ceb12009-11-21 02:48:08 +00002840/// endFunction - Gather and emit post-function debug information.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002841///
Chris Lattnereec791a2010-01-26 23:18:02 +00002842void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendling5f017e82010-04-07 09:28:04 +00002843 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00002844
Devang Patel344130e2010-01-04 20:44:00 +00002845 if (CurrentFnDbgScope) {
Devang Patel65eb4822010-05-22 00:04:14 +00002846
Devang Patelc3f5f782010-05-25 23:40:22 +00002847 // Define end label for subprogram.
2848 FunctionEndSym = Asm->GetTempSymbol("func_end",
2849 Asm->getFunctionNumber());
2850 // Assumes in correct section after the entry point.
2851 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002852
Devang Patel78e127d2010-06-25 22:07:34 +00002853 SmallPtrSet<const MDNode *, 16> ProcessedVars;
2854 collectVariableInfo(MF, ProcessedVars);
Devang Patel65eb4822010-05-22 00:04:14 +00002855
Devang Patel344130e2010-01-04 20:44:00 +00002856 // Get function line info.
2857 if (!Lines.empty()) {
2858 // Get section line info.
2859 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2860 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2861 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2862 // Append the function info to section info.
2863 SectionLineInfos.insert(SectionLineInfos.end(),
2864 Lines.begin(), Lines.end());
2865 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002866
Devang Patel344130e2010-01-04 20:44:00 +00002867 // Construct abstract scopes.
2868 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel78e127d2010-06-25 22:07:34 +00002869 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel78e127d2010-06-25 22:07:34 +00002870 DISubprogram SP((*AI)->getScopeNode());
2871 if (SP.Verify()) {
2872 // Collect info for variables that were optimized out.
2873 StringRef FName = SP.getLinkageName();
2874 if (FName.empty())
2875 FName = SP.getName();
2876 const Module *M = MF->getFunction()->getParent();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002877 if (NamedMDNode *NMD =
2878 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patel78e127d2010-06-25 22:07:34 +00002879 getRealLinkageName(FName)))) {
2880 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman872814a2010-07-21 18:54:18 +00002881 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel78e127d2010-06-25 22:07:34 +00002882 if (!DV || !ProcessedVars.insert(DV))
2883 continue;
Devang Patel1d68d212010-06-30 00:11:08 +00002884 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel78e127d2010-06-25 22:07:34 +00002885 if (Scope)
2886 Scope->addVariable(new DbgVariable(DV));
2887 }
2888 }
2889 }
Devang Patel90e19aa2010-06-30 01:40:11 +00002890 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
2891 constructScopeDIE(*AI);
Devang Patel78e127d2010-06-25 22:07:34 +00002892 }
Devang Patel61409622010-07-07 20:12:52 +00002893
Devang Patel9c488372010-05-04 06:15:30 +00002894 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002895
Devang Patel9c488372010-05-04 06:15:30 +00002896 if (!DisableFramePointerElim(*MF))
Jim Grosbach1e20b962010-07-21 21:21:52 +00002897 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel9c488372010-05-04 06:15:30 +00002898 dwarf::DW_FORM_flag, 1);
2899
2900
Chris Lattnerd38fee82010-04-05 00:13:49 +00002901 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel344130e2010-01-04 20:44:00 +00002902 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002903 }
2904
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002905 // Clear debug info
Devang Patelf54b8522010-01-19 01:26:02 +00002906 CurrentFnDbgScope = NULL;
Devang Patelb2b31a62010-05-26 19:37:24 +00002907 InsnNeedsLabel.clear();
Devang Patel26c1e562010-05-20 16:36:41 +00002908 DbgVariableToFrameIndexMap.clear();
2909 VarToAbstractVarMap.clear();
2910 DbgVariableToDbgInstMap.clear();
2911 DbgVariableLabelsMap.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002912 DeleteContainerSeconds(DbgScopeMap);
Devang Patel51424712010-04-09 16:04:20 +00002913 InsnsEndScopeSet.clear();
Devang Patelf54b8522010-01-19 01:26:02 +00002914 ConcreteScopes.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002915 DeleteContainerSeconds(AbstractScopes);
Devang Patelf54b8522010-01-19 01:26:02 +00002916 AbstractScopesList.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002917 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00002918 LabelsBeforeInsn.clear();
2919 LabelsAfterInsn.clear();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002920 Lines.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00002921 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002922}
2923
Devang Patel26c1e562010-05-20 16:36:41 +00002924/// recordVariableFrameIndex - Record a variable's index.
2925void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2926 assert (V && "Invalid DbgVariable!");
2927 DbgVariableToFrameIndexMap[V] = Index;
2928}
2929
2930/// findVariableFrameIndex - Return true if frame index for the variable
2931/// is found. Update FI to hold value of the index.
2932bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
2933 assert (V && "Invalid DbgVariable!");
2934 DenseMap<const DbgVariable *, int>::iterator I =
2935 DbgVariableToFrameIndexMap.find(V);
2936 if (I == DbgVariableToFrameIndexMap.end())
2937 return false;
2938 *FI = I->second;
2939 return true;
2940}
2941
2942/// findVariableLabel - Find MCSymbol for the variable.
2943const MCSymbol *DwarfDebug::findVariableLabel(const DbgVariable *V) {
2944 DenseMap<const DbgVariable *, const MCSymbol *>::iterator I
2945 = DbgVariableLabelsMap.find(V);
2946 if (I == DbgVariableLabelsMap.end())
2947 return NULL;
2948 else return I->second;
2949}
2950
Jim Grosbach1e20b962010-07-21 21:21:52 +00002951/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patelee432862010-05-20 19:57:06 +00002952/// instruction.
2953DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
2954 DbgScope *Scope = NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002955 LLVMContext &Ctx =
Devang Patelee432862010-05-20 19:57:06 +00002956 MInsn->getParent()->getParent()->getFunction()->getContext();
2957 DebugLoc DL = MInsn->getDebugLoc();
2958
Jim Grosbach1e20b962010-07-21 21:21:52 +00002959 if (DL.isUnknown())
Devang Patelee432862010-05-20 19:57:06 +00002960 return Scope;
2961
2962 if (const MDNode *IA = DL.getInlinedAt(Ctx))
2963 Scope = ConcreteScopes.lookup(IA);
2964 if (Scope == 0)
2965 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002966
Devang Patelee432862010-05-20 19:57:06 +00002967 return Scope;
2968}
2969
2970
Chris Lattnerc6087842010-03-09 04:54:43 +00002971/// recordSourceLine - Register a source line with debug info. Returns the
2972/// unique label that was emitted and which provides correspondence to
2973/// the source line list.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002974MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel61409622010-07-07 20:12:52 +00002975 const MDNode *S) {
Devang Patel65dbc902009-11-25 17:36:49 +00002976 StringRef Dir;
2977 StringRef Fn;
Devang Patelf84548d2009-10-05 18:03:19 +00002978
Dan Gohman1cc0d622010-05-05 23:41:32 +00002979 unsigned Src = 1;
2980 if (S) {
2981 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00002982
Dan Gohman1cc0d622010-05-05 23:41:32 +00002983 if (Scope.isCompileUnit()) {
2984 DICompileUnit CU(S);
2985 Dir = CU.getDirectory();
2986 Fn = CU.getFilename();
2987 } else if (Scope.isSubprogram()) {
2988 DISubprogram SP(S);
2989 Dir = SP.getDirectory();
2990 Fn = SP.getFilename();
2991 } else if (Scope.isLexicalBlock()) {
2992 DILexicalBlock DB(S);
2993 Dir = DB.getDirectory();
2994 Fn = DB.getFilename();
2995 } else
2996 assert(0 && "Unexpected scope info");
2997
2998 Src = GetOrCreateSourceID(Dir, Fn);
2999 }
3000
Chris Lattner63d78362010-03-14 08:36:50 +00003001 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattner25b68c62010-03-14 08:15:55 +00003002 Lines.push_back(SrcLineInfo(Line, Col, Src, Label));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00003003
Chris Lattnerc6087842010-03-09 04:54:43 +00003004 Asm->OutStreamer.EmitLabel(Label);
3005 return Label;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00003006}
3007
Bill Wendling829e67b2009-05-20 23:22:40 +00003008//===----------------------------------------------------------------------===//
3009// Emit Methods
3010//===----------------------------------------------------------------------===//
3011
Devang Patel2c4ceb12009-11-21 02:48:08 +00003012/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling94d04b82009-05-20 23:21:38 +00003013///
Jim Grosbach7ab38df2009-11-22 19:20:36 +00003014unsigned
3015DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003016 // Get the children.
3017 const std::vector<DIE *> &Children = Die->getChildren();
3018
3019 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00003020 if (!Last && !Children.empty())
Benjamin Kramer345ef342010-03-31 19:34:01 +00003021 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling94d04b82009-05-20 23:21:38 +00003022
3023 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003024 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00003025
3026 // Get the abbreviation for this DIE.
3027 unsigned AbbrevNumber = Die->getAbbrevNumber();
3028 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3029
3030 // Set DIE offset
3031 Die->setOffset(Offset);
3032
3033 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00003034 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00003035
3036 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
3037 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3038
3039 // Size the DIE attribute values.
3040 for (unsigned i = 0, N = Values.size(); i < N; ++i)
3041 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00003042 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00003043
3044 // Size the DIE children if any.
3045 if (!Children.empty()) {
3046 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
3047 "Children flag not set");
3048
3049 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00003050 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling94d04b82009-05-20 23:21:38 +00003051
3052 // End of children marker.
3053 Offset += sizeof(int8_t);
3054 }
3055
3056 Die->setSize(Offset - Die->getOffset());
3057 return Offset;
3058}
3059
Devang Patel2c4ceb12009-11-21 02:48:08 +00003060/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling94d04b82009-05-20 23:21:38 +00003061///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003062void DwarfDebug::computeSizeAndOffsets() {
Devang Patel163a9f72010-05-10 22:49:55 +00003063 unsigned PrevOffset = 0;
3064 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3065 E = CUMap.end(); I != E; ++I) {
3066 // Compute size of compile unit header.
3067 static unsigned Offset = PrevOffset +
3068 sizeof(int32_t) + // Length of Compilation Unit Info
3069 sizeof(int16_t) + // DWARF version number
3070 sizeof(int32_t) + // Offset Into Abbrev. Section
3071 sizeof(int8_t); // Pointer Size (in bytes)
3072 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
3073 PrevOffset = Offset;
3074 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003075}
3076
Chris Lattner11b8f302010-04-04 23:02:02 +00003077/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3078/// temporary label to it if SymbolStem is specified.
Chris Lattner9c69e285532010-04-04 22:59:04 +00003079static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner11b8f302010-04-04 23:02:02 +00003080 const char *SymbolStem = 0) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00003081 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner11b8f302010-04-04 23:02:02 +00003082 if (!SymbolStem) return 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003083
Chris Lattner9c69e285532010-04-04 22:59:04 +00003084 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3085 Asm->OutStreamer.EmitLabel(TmpSym);
3086 return TmpSym;
3087}
3088
3089/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3090/// the start of each one.
Chris Lattnerfa070b02010-04-04 22:33:59 +00003091void DwarfDebug::EmitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003092 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003093
Bill Wendling94d04b82009-05-20 23:21:38 +00003094 // Dwarf sections base addresses.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003095 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00003096 DwarfFrameSectionSym =
3097 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3098 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003099
Jim Grosbach1e20b962010-07-21 21:21:52 +00003100 DwarfInfoSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003101 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003102 DwarfAbbrevSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003103 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner11b8f302010-04-04 23:02:02 +00003104 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003105
Chris Lattner9c69e285532010-04-04 22:59:04 +00003106 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner11b8f302010-04-04 23:02:02 +00003107 EmitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003108
Devang Patelaf608bd2010-08-24 00:06:12 +00003109 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner11b8f302010-04-04 23:02:02 +00003110 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3111 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3112 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003113 DwarfStrSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003114 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patelf2548ca2010-04-16 23:33:45 +00003115 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3116 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00003117
Devang Patelc3f5f782010-05-25 23:40:22 +00003118 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3119 "section_debug_loc");
3120
Chris Lattner9c69e285532010-04-04 22:59:04 +00003121 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattner4ad1efe2010-04-04 23:10:38 +00003122 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003123}
3124
Devang Patel2c4ceb12009-11-21 02:48:08 +00003125/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling94d04b82009-05-20 23:21:38 +00003126///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003127void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003128 // Get the abbreviation for this DIE.
3129 unsigned AbbrevNumber = Die->getAbbrevNumber();
3130 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3131
Bill Wendling94d04b82009-05-20 23:21:38 +00003132 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00003133 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00003134 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3135 Twine::utohexstr(Die->getOffset()) + ":0x" +
3136 Twine::utohexstr(Die->getSize()) + " " +
3137 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003138 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00003139
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00003140 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling94d04b82009-05-20 23:21:38 +00003141 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3142
3143 // Emit the DIE attribute values.
3144 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3145 unsigned Attr = AbbrevData[i].getAttribute();
3146 unsigned Form = AbbrevData[i].getForm();
3147 assert(Form && "Too many attributes for DIE (check abbreviation)");
3148
Chris Lattner3f53c832010-04-04 18:52:31 +00003149 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00003150 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003151
Bill Wendling94d04b82009-05-20 23:21:38 +00003152 switch (Attr) {
3153 case dwarf::DW_AT_sibling:
Devang Patel2c4ceb12009-11-21 02:48:08 +00003154 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003155 break;
3156 case dwarf::DW_AT_abstract_origin: {
3157 DIEEntry *E = cast<DIEEntry>(Values[i]);
3158 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00003159 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00003160 Asm->EmitInt32(Addr);
3161 break;
3162 }
Devang Patelf2548ca2010-04-16 23:33:45 +00003163 case dwarf::DW_AT_ranges: {
3164 // DW_AT_range Value encodes offset in debug_range section.
3165 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelb1fcfbe2010-09-02 16:43:44 +00003166
3167 if (Asm->MAI->doesDwarfUsesLabelOffsetForRanges()) {
3168 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
3169 V->getValue(),
3170 4);
3171 } else {
3172 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3173 V->getValue(),
3174 DwarfDebugRangeSectionSym,
3175 4);
3176 }
Devang Patelf2548ca2010-04-16 23:33:45 +00003177 break;
3178 }
Devang Patelc3f5f782010-05-25 23:40:22 +00003179 case dwarf::DW_AT_location: {
3180 if (UseDotDebugLocEntry.count(Die) != 0) {
3181 DIELabel *L = cast<DIELabel>(Values[i]);
3182 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
3183 } else
3184 Values[i]->EmitValue(Asm, Form);
3185 break;
3186 }
Devang Patel2a361602010-09-29 19:08:08 +00003187 case dwarf::DW_AT_accessibility: {
3188 if (Asm->isVerbose()) {
3189 DIEInteger *V = cast<DIEInteger>(Values[i]);
3190 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
3191 }
3192 Values[i]->EmitValue(Asm, Form);
3193 break;
3194 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003195 default:
3196 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003197 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00003198 break;
3199 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003200 }
3201
3202 // Emit the DIE children if any.
3203 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3204 const std::vector<DIE *> &Children = Die->getChildren();
3205
3206 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00003207 emitDIE(Children[j]);
Bill Wendling94d04b82009-05-20 23:21:38 +00003208
Chris Lattner3f53c832010-04-04 18:52:31 +00003209 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00003210 Asm->OutStreamer.AddComment("End Of Children Mark");
3211 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003212 }
3213}
3214
Devang Patel8a241142009-12-09 18:24:21 +00003215/// emitDebugInfo - Emit the debug info section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003216///
Devang Patel8a241142009-12-09 18:24:21 +00003217void DwarfDebug::emitDebugInfo() {
3218 // Start debug info section.
3219 Asm->OutStreamer.SwitchSection(
3220 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel163a9f72010-05-10 22:49:55 +00003221 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3222 E = CUMap.end(); I != E; ++I) {
3223 CompileUnit *TheCU = I->second;
3224 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00003225
Devang Patel163a9f72010-05-10 22:49:55 +00003226 // Emit the compile units header.
3227 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3228 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003229
Devang Patel163a9f72010-05-10 22:49:55 +00003230 // Emit size of content not including length itself
3231 unsigned ContentSize = Die->getSize() +
3232 sizeof(int16_t) + // DWARF version number
3233 sizeof(int32_t) + // Offset Into Abbrev. Section
3234 sizeof(int8_t) + // Pointer Size (in bytes)
3235 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003236
Devang Patel163a9f72010-05-10 22:49:55 +00003237 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3238 Asm->EmitInt32(ContentSize);
3239 Asm->OutStreamer.AddComment("DWARF version number");
3240 Asm->EmitInt16(dwarf::DWARF_VERSION);
3241 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3242 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3243 DwarfAbbrevSectionSym);
3244 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3245 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003246
Devang Patel163a9f72010-05-10 22:49:55 +00003247 emitDIE(Die);
3248 // FIXME - extra padding for gdb bug.
3249 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3250 Asm->EmitInt8(0);
3251 Asm->EmitInt8(0);
3252 Asm->EmitInt8(0);
3253 Asm->EmitInt8(0);
3254 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3255 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003256}
3257
Devang Patel2c4ceb12009-11-21 02:48:08 +00003258/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003259///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003260void DwarfDebug::emitAbbreviations() const {
Bill Wendling94d04b82009-05-20 23:21:38 +00003261 // Check to see if it is worth the effort.
3262 if (!Abbreviations.empty()) {
3263 // Start the debug abbrev section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003264 Asm->OutStreamer.SwitchSection(
3265 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003266
Chris Lattnerc0215722010-04-04 19:25:43 +00003267 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003268
3269 // For each abbrevation.
3270 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3271 // Get abbreviation data
3272 const DIEAbbrev *Abbrev = Abbreviations[i];
3273
3274 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003275 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00003276
3277 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003278 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00003279 }
3280
3281 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003282 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00003283
Chris Lattnerc0215722010-04-04 19:25:43 +00003284 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003285 }
3286}
3287
Devang Patel2c4ceb12009-11-21 02:48:08 +00003288/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling94d04b82009-05-20 23:21:38 +00003289/// the line matrix.
3290///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003291void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003292 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00003293 Asm->OutStreamer.AddComment("Extended Op");
3294 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003295
Chris Lattner233f52b2010-03-09 23:52:58 +00003296 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003297 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003298 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3299 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3300
3301 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00003302
Chris Lattnerc0215722010-04-04 19:25:43 +00003303 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003304 Asm->getTargetData().getPointerSize(),
3305 0/*AddrSpace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003306
3307 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00003308 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3309 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00003310 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00003311 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003312}
3313
Devang Patel2c4ceb12009-11-21 02:48:08 +00003314/// emitDebugLines - Emit source line information.
Bill Wendling94d04b82009-05-20 23:21:38 +00003315///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003316void DwarfDebug::emitDebugLines() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003317 // If the target is using .loc/.file, the assembler will be emitting the
3318 // .debug_line table automatically.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003319 if (Asm->MAI->hasDotLocAndDotFile())
Bill Wendling94d04b82009-05-20 23:21:38 +00003320 return;
3321
3322 // Minimum line delta, thus ranging from -10..(255-10).
3323 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
3324 // Maximum line delta, thus ranging from -10..(255-10).
3325 const int MaxLineDelta = 255 + MinLineDelta;
3326
3327 // Start the dwarf line section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003328 Asm->OutStreamer.SwitchSection(
3329 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003330
3331 // Construct the section header.
Chris Lattner233f52b2010-03-09 23:52:58 +00003332 Asm->OutStreamer.AddComment("Length of Source Line Info");
Chris Lattnera6437182010-04-04 19:58:12 +00003333 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_end"),
3334 Asm->GetTempSymbol("line_begin"), 4);
Chris Lattnerc0215722010-04-04 19:25:43 +00003335 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003336
Chris Lattner233f52b2010-03-09 23:52:58 +00003337 Asm->OutStreamer.AddComment("DWARF version number");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003338 Asm->EmitInt16(dwarf::DWARF_VERSION);
Bill Wendling94d04b82009-05-20 23:21:38 +00003339
Chris Lattner233f52b2010-03-09 23:52:58 +00003340 Asm->OutStreamer.AddComment("Prolog Length");
Chris Lattnera6437182010-04-04 19:58:12 +00003341 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_prolog_end"),
3342 Asm->GetTempSymbol("line_prolog_begin"), 4);
Chris Lattnerc0215722010-04-04 19:25:43 +00003343 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003344
Chris Lattner233f52b2010-03-09 23:52:58 +00003345 Asm->OutStreamer.AddComment("Minimum Instruction Length");
3346 Asm->EmitInt8(1);
3347 Asm->OutStreamer.AddComment("Default is_stmt_start flag");
3348 Asm->EmitInt8(1);
3349 Asm->OutStreamer.AddComment("Line Base Value (Special Opcodes)");
3350 Asm->EmitInt8(MinLineDelta);
3351 Asm->OutStreamer.AddComment("Line Range Value (Special Opcodes)");
3352 Asm->EmitInt8(MaxLineDelta);
3353 Asm->OutStreamer.AddComment("Special Opcode Base");
3354 Asm->EmitInt8(-MinLineDelta);
Bill Wendling94d04b82009-05-20 23:21:38 +00003355
3356 // Line number standard opcode encodings argument count
Chris Lattner233f52b2010-03-09 23:52:58 +00003357 Asm->OutStreamer.AddComment("DW_LNS_copy arg count");
3358 Asm->EmitInt8(0);
3359 Asm->OutStreamer.AddComment("DW_LNS_advance_pc arg count");
3360 Asm->EmitInt8(1);
3361 Asm->OutStreamer.AddComment("DW_LNS_advance_line arg count");
3362 Asm->EmitInt8(1);
3363 Asm->OutStreamer.AddComment("DW_LNS_set_file arg count");
3364 Asm->EmitInt8(1);
3365 Asm->OutStreamer.AddComment("DW_LNS_set_column arg count");
3366 Asm->EmitInt8(1);
3367 Asm->OutStreamer.AddComment("DW_LNS_negate_stmt arg count");
3368 Asm->EmitInt8(0);
3369 Asm->OutStreamer.AddComment("DW_LNS_set_basic_block arg count");
3370 Asm->EmitInt8(0);
3371 Asm->OutStreamer.AddComment("DW_LNS_const_add_pc arg count");
3372 Asm->EmitInt8(0);
3373 Asm->OutStreamer.AddComment("DW_LNS_fixed_advance_pc arg count");
3374 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003375
3376 // Emit directories.
3377 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
Chris Lattner4cf202b2010-01-23 03:11:46 +00003378 const std::string &Dir = getSourceDirectoryName(DI);
Chris Lattner3f53c832010-04-04 18:52:31 +00003379 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Directory");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003380 Asm->OutStreamer.EmitBytes(StringRef(Dir.c_str(), Dir.size()+1), 0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003381 }
3382
Chris Lattner233f52b2010-03-09 23:52:58 +00003383 Asm->OutStreamer.AddComment("End of directories");
3384 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003385
3386 // Emit files.
3387 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
3388 // Remember source id starts at 1.
3389 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
Chris Lattner4cf202b2010-01-23 03:11:46 +00003390 const std::string &FN = getSourceFileName(Id.second);
Chris Lattner3f53c832010-04-04 18:52:31 +00003391 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Source");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003392 Asm->OutStreamer.EmitBytes(StringRef(FN.c_str(), FN.size()+1), 0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003393
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003394 Asm->EmitULEB128(Id.first, "Directory #");
3395 Asm->EmitULEB128(0, "Mod date");
3396 Asm->EmitULEB128(0, "File size");
Bill Wendling94d04b82009-05-20 23:21:38 +00003397 }
3398
Chris Lattner233f52b2010-03-09 23:52:58 +00003399 Asm->OutStreamer.AddComment("End of files");
3400 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003401
Chris Lattnerc0215722010-04-04 19:25:43 +00003402 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003403
3404 // A sequence for each text section.
3405 unsigned SecSrcLinesSize = SectionSourceLines.size();
3406
3407 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
3408 // Isolate current sections line info.
3409 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
3410
Bill Wendling94d04b82009-05-20 23:21:38 +00003411 // Dwarf assumes we start with first line of first source file.
3412 unsigned Source = 1;
3413 unsigned Line = 1;
3414
3415 // Construct rows of the address, source, line, column matrix.
3416 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
3417 const SrcLineInfo &LineInfo = LineInfos[i];
Chris Lattner25b68c62010-03-14 08:15:55 +00003418 MCSymbol *Label = LineInfo.getLabel();
Chris Lattnerb9130602010-03-14 02:20:58 +00003419 if (!Label->isDefined()) continue; // Not emitted, in dead code.
Bill Wendling94d04b82009-05-20 23:21:38 +00003420
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003421 if (Asm->isVerbose()) {
Chris Lattner188a87d2010-03-10 01:04:13 +00003422 std::pair<unsigned, unsigned> SrcID =
Bill Wendling94d04b82009-05-20 23:21:38 +00003423 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner188a87d2010-03-10 01:04:13 +00003424 Asm->OutStreamer.AddComment(Twine(getSourceDirectoryName(SrcID.first)) +
Chris Lattner49f618a2010-03-10 02:29:31 +00003425 "/" +
3426 Twine(getSourceFileName(SrcID.second)) +
Chris Lattner188a87d2010-03-10 01:04:13 +00003427 ":" + Twine(LineInfo.getLine()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003428 }
3429
3430 // Define the line address.
Chris Lattner233f52b2010-03-09 23:52:58 +00003431 Asm->OutStreamer.AddComment("Extended Op");
3432 Asm->EmitInt8(0);
3433 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003434 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003435
3436 Asm->OutStreamer.AddComment("DW_LNE_set_address");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003437 Asm->EmitInt8(dwarf::DW_LNE_set_address);
Chris Lattner233f52b2010-03-09 23:52:58 +00003438
3439 Asm->OutStreamer.AddComment("Location label");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003440 Asm->OutStreamer.EmitSymbolValue(Label,
3441 Asm->getTargetData().getPointerSize(),
Chris Lattnerb9130602010-03-14 02:20:58 +00003442 0/*AddrSpace*/);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003443
Bill Wendling94d04b82009-05-20 23:21:38 +00003444 // If change of source, then switch to the new source.
3445 if (Source != LineInfo.getSourceID()) {
3446 Source = LineInfo.getSourceID();
Chris Lattner233f52b2010-03-09 23:52:58 +00003447 Asm->OutStreamer.AddComment("DW_LNS_set_file");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003448 Asm->EmitInt8(dwarf::DW_LNS_set_file);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003449 Asm->EmitULEB128(Source, "New Source");
Bill Wendling94d04b82009-05-20 23:21:38 +00003450 }
3451
3452 // If change of line.
3453 if (Line != LineInfo.getLine()) {
3454 // Determine offset.
3455 int Offset = LineInfo.getLine() - Line;
3456 int Delta = Offset - MinLineDelta;
3457
3458 // Update line.
3459 Line = LineInfo.getLine();
3460
3461 // If delta is small enough and in range...
3462 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
3463 // ... then use fast opcode.
Chris Lattner233f52b2010-03-09 23:52:58 +00003464 Asm->OutStreamer.AddComment("Line Delta");
3465 Asm->EmitInt8(Delta - MinLineDelta);
Bill Wendling94d04b82009-05-20 23:21:38 +00003466 } else {
3467 // ... otherwise use long hand.
Chris Lattner233f52b2010-03-09 23:52:58 +00003468 Asm->OutStreamer.AddComment("DW_LNS_advance_line");
Bill Wendling94d04b82009-05-20 23:21:38 +00003469 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003470 Asm->EmitSLEB128(Offset, "Line Offset");
Chris Lattner233f52b2010-03-09 23:52:58 +00003471 Asm->OutStreamer.AddComment("DW_LNS_copy");
3472 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling94d04b82009-05-20 23:21:38 +00003473 }
3474 } else {
3475 // Copy the previous row (different address or source)
Chris Lattner233f52b2010-03-09 23:52:58 +00003476 Asm->OutStreamer.AddComment("DW_LNS_copy");
3477 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling94d04b82009-05-20 23:21:38 +00003478 }
3479 }
3480
Devang Patel2c4ceb12009-11-21 02:48:08 +00003481 emitEndOfLineMatrix(j + 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003482 }
3483
3484 if (SecSrcLinesSize == 0)
3485 // Because we're emitting a debug_line section, we still need a line
3486 // table. The linker and friends expect it to exist. If there's nothing to
3487 // put into it, emit an empty table.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003488 emitEndOfLineMatrix(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003489
Chris Lattnerc0215722010-04-04 19:25:43 +00003490 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003491}
3492
Devang Patel2c4ceb12009-11-21 02:48:08 +00003493/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003494///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003495void DwarfDebug::emitCommonDebugFrame() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003496 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003497 return;
3498
Chris Lattnerd38fee82010-04-05 00:13:49 +00003499 int stackGrowth = Asm->getTargetData().getPointerSize();
3500 if (Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3501 TargetFrameInfo::StackGrowsDown)
3502 stackGrowth *= -1;
Bill Wendling94d04b82009-05-20 23:21:38 +00003503
3504 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003505 Asm->OutStreamer.SwitchSection(
3506 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003507
Chris Lattnerc0215722010-04-04 19:25:43 +00003508 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003509 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003510 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3511 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003512
Chris Lattnerc0215722010-04-04 19:25:43 +00003513 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003514 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling94d04b82009-05-20 23:21:38 +00003515 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner233f52b2010-03-09 23:52:58 +00003516 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling94d04b82009-05-20 23:21:38 +00003517 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner233f52b2010-03-09 23:52:58 +00003518 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003519 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003520 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3521 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner233f52b2010-03-09 23:52:58 +00003522 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003523 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling94d04b82009-05-20 23:21:38 +00003524 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling94d04b82009-05-20 23:21:38 +00003525
3526 std::vector<MachineMove> Moves;
3527 RI->getInitialFrameState(Moves);
3528
Chris Lattner02b86b92010-04-04 23:41:46 +00003529 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003530
Chris Lattner059ea132010-04-28 01:05:45 +00003531 Asm->EmitAlignment(2);
Chris Lattnerc0215722010-04-04 19:25:43 +00003532 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003533}
3534
Devang Patel2c4ceb12009-11-21 02:48:08 +00003535/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling94d04b82009-05-20 23:21:38 +00003536/// section.
Chris Lattner206d61e2010-03-13 07:26:18 +00003537void DwarfDebug::
3538emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003539 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003540 return;
3541
3542 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003543 Asm->OutStreamer.SwitchSection(
3544 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003545
Chris Lattner233f52b2010-03-09 23:52:58 +00003546 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner206d61e2010-03-13 07:26:18 +00003547 MCSymbol *DebugFrameBegin =
Chris Lattnerc0215722010-04-04 19:25:43 +00003548 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner206d61e2010-03-13 07:26:18 +00003549 MCSymbol *DebugFrameEnd =
Chris Lattnerc0215722010-04-04 19:25:43 +00003550 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnera6437182010-04-04 19:58:12 +00003551 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003552
Chris Lattner206d61e2010-03-13 07:26:18 +00003553 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling94d04b82009-05-20 23:21:38 +00003554
Chris Lattner233f52b2010-03-09 23:52:58 +00003555 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003556 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner6189ed12010-04-04 23:25:33 +00003557 DwarfFrameSectionSym);
Bill Wendling94d04b82009-05-20 23:21:38 +00003558
Chris Lattner233f52b2010-03-09 23:52:58 +00003559 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnerc0215722010-04-04 19:25:43 +00003560 MCSymbol *FuncBeginSym =
3561 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattnerfb658072010-03-13 07:40:56 +00003562 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattnerd38fee82010-04-05 00:13:49 +00003563 Asm->getTargetData().getPointerSize(),
3564 0/*AddrSpace*/);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003565
3566
Chris Lattner233f52b2010-03-09 23:52:58 +00003567 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnera6437182010-04-04 19:58:12 +00003568 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003569 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003570
Chris Lattner02b86b92010-04-04 23:41:46 +00003571 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003572
Chris Lattner059ea132010-04-28 01:05:45 +00003573 Asm->EmitAlignment(2);
Chris Lattner206d61e2010-03-13 07:26:18 +00003574 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling94d04b82009-05-20 23:21:38 +00003575}
3576
Devang Patel8a241142009-12-09 18:24:21 +00003577/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3578///
3579void DwarfDebug::emitDebugPubNames() {
Devang Patel163a9f72010-05-10 22:49:55 +00003580 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3581 E = CUMap.end(); I != E; ++I) {
3582 CompileUnit *TheCU = I->second;
3583 // Start the dwarf pubnames section.
3584 Asm->OutStreamer.SwitchSection(
3585 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003586
Devang Patel163a9f72010-05-10 22:49:55 +00003587 Asm->OutStreamer.AddComment("Length of Public Names Info");
3588 Asm->EmitLabelDifference(
3589 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3590 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003591
Devang Patel163a9f72010-05-10 22:49:55 +00003592 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3593 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003594
Devang Patel163a9f72010-05-10 22:49:55 +00003595 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003596 Asm->EmitInt16(dwarf::DWARF_VERSION);
3597
Devang Patel163a9f72010-05-10 22:49:55 +00003598 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003599 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel163a9f72010-05-10 22:49:55 +00003600 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003601
Devang Patel163a9f72010-05-10 22:49:55 +00003602 Asm->OutStreamer.AddComment("Compilation Unit Length");
3603 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3604 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3605 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003606
Devang Patel163a9f72010-05-10 22:49:55 +00003607 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3608 for (StringMap<DIE*>::const_iterator
3609 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3610 const char *Name = GI->getKeyData();
3611 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003612
Devang Patel163a9f72010-05-10 22:49:55 +00003613 Asm->OutStreamer.AddComment("DIE offset");
3614 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003615
Devang Patel163a9f72010-05-10 22:49:55 +00003616 if (Asm->isVerbose())
3617 Asm->OutStreamer.AddComment("External Name");
3618 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3619 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00003620
Devang Patel163a9f72010-05-10 22:49:55 +00003621 Asm->OutStreamer.AddComment("End Mark");
3622 Asm->EmitInt32(0);
3623 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3624 TheCU->getID()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003625 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003626}
3627
Devang Patel193f7202009-11-24 01:14:22 +00003628void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00003629 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3630 E = CUMap.end(); I != E; ++I) {
3631 CompileUnit *TheCU = I->second;
3632 // Start the dwarf pubnames section.
3633 Asm->OutStreamer.SwitchSection(
3634 Asm->getObjFileLowering().getDwarfPubTypesSection());
3635 Asm->OutStreamer.AddComment("Length of Public Types Info");
3636 Asm->EmitLabelDifference(
3637 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3638 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003639
Devang Patel163a9f72010-05-10 22:49:55 +00003640 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3641 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003642
Devang Patel163a9f72010-05-10 22:49:55 +00003643 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3644 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003645
Devang Patel163a9f72010-05-10 22:49:55 +00003646 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3647 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3648 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003649
Devang Patel163a9f72010-05-10 22:49:55 +00003650 Asm->OutStreamer.AddComment("Compilation Unit Length");
3651 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3652 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3653 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003654
Devang Patel163a9f72010-05-10 22:49:55 +00003655 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3656 for (StringMap<DIE*>::const_iterator
3657 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3658 const char *Name = GI->getKeyData();
3659 DIE * Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003660
Devang Patel163a9f72010-05-10 22:49:55 +00003661 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3662 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003663
Devang Patel163a9f72010-05-10 22:49:55 +00003664 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3665 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3666 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00003667
Devang Patel163a9f72010-05-10 22:49:55 +00003668 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003669 Asm->EmitInt32(0);
Devang Patel163a9f72010-05-10 22:49:55 +00003670 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3671 TheCU->getID()));
Devang Patel193f7202009-11-24 01:14:22 +00003672 }
Devang Patel193f7202009-11-24 01:14:22 +00003673}
3674
Devang Patel2c4ceb12009-11-21 02:48:08 +00003675/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003676///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003677void DwarfDebug::emitDebugStr() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003678 // Check to see if it is worth the effort.
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003679 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003680
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003681 // Start the dwarf str section.
3682 Asm->OutStreamer.SwitchSection(
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003683 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003684
Chris Lattnerbc733f52010-03-13 02:17:42 +00003685 // Get all of the string pool entries and put them in an array by their ID so
3686 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003687 SmallVector<std::pair<unsigned,
Chris Lattnerbc733f52010-03-13 02:17:42 +00003688 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003689
Chris Lattnerbc733f52010-03-13 02:17:42 +00003690 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3691 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3692 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003693
Chris Lattnerbc733f52010-03-13 02:17:42 +00003694 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003695
Chris Lattnerbc733f52010-03-13 02:17:42 +00003696 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003697 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003698 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003699
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003700 // Emit the string itself.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003701 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003702 }
3703}
3704
Devang Patel2c4ceb12009-11-21 02:48:08 +00003705/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003706///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003707void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00003708 if (DotDebugLocEntries.empty())
3709 return;
3710
Bill Wendling94d04b82009-05-20 23:21:38 +00003711 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003712 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00003713 Asm->getObjFileLowering().getDwarfLocSection());
3714 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00003715 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3716 unsigned index = 1;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003717 for (SmallVector<DotDebugLocEntry, 4>::iterator
3718 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00003719 I != E; ++I, ++index) {
Devang Patelc3f5f782010-05-25 23:40:22 +00003720 DotDebugLocEntry Entry = *I;
Devang Patelc3f5f782010-05-25 23:40:22 +00003721 if (Entry.isEmpty()) {
3722 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3723 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel80250682010-05-26 23:55:23 +00003724 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00003725 } else {
3726 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3727 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3728 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3729 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patelb2cf5812010-08-04 18:40:52 +00003730 if (int Offset = Entry.Loc.getOffset()) {
3731 // If the value is at a certain offset from frame register then
3732 // use DW_OP_fbreg.
3733 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patelc3f5f782010-05-25 23:40:22 +00003734 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patelb2cf5812010-08-04 18:40:52 +00003735 Asm->EmitInt16(1 + OffsetSize);
3736 Asm->OutStreamer.AddComment(
3737 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3738 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3739 Asm->OutStreamer.AddComment("Offset");
3740 Asm->EmitSLEB128(Offset);
Devang Patelc3f5f782010-05-25 23:40:22 +00003741 } else {
Devang Patelb2cf5812010-08-04 18:40:52 +00003742 if (Reg < 32) {
3743 Asm->OutStreamer.AddComment("Loc expr size");
3744 Asm->EmitInt16(1);
3745 Asm->OutStreamer.AddComment(
Devang Patela54e0cc2010-08-04 20:32:36 +00003746 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patelb2cf5812010-08-04 18:40:52 +00003747 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3748 } else {
3749 Asm->OutStreamer.AddComment("Loc expr size");
3750 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3751 Asm->EmitInt8(dwarf::DW_OP_regx);
3752 Asm->EmitULEB128(Reg);
3753 }
Devang Patelc3f5f782010-05-25 23:40:22 +00003754 }
3755 }
3756 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003757}
3758
3759/// EmitDebugARanges - Emit visible names into a debug aranges section.
3760///
3761void DwarfDebug::EmitDebugARanges() {
3762 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003763 Asm->OutStreamer.SwitchSection(
3764 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003765}
3766
Devang Patel2c4ceb12009-11-21 02:48:08 +00003767/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003768///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003769void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003770 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003771 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00003772 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Pateleac9c072010-04-27 19:46:33 +00003773 unsigned char Size = Asm->getTargetData().getPointerSize();
3774 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00003775 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00003776 I != E; ++I) {
3777 if (*I)
3778 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003779 else
Devang Pateleac9c072010-04-27 19:46:33 +00003780 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003781 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003782}
3783
Devang Patel2c4ceb12009-11-21 02:48:08 +00003784/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003785///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003786void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003787 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00003788 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003789 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003790 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003791 }
3792}
3793
Devang Patel2c4ceb12009-11-21 02:48:08 +00003794/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling94d04b82009-05-20 23:21:38 +00003795/// Section Header:
3796/// 1. length of section
3797/// 2. Dwarf version number
3798/// 3. address size.
3799///
3800/// Entries (one "entry" for each function that was inlined):
3801///
3802/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3803/// otherwise offset into __debug_str for regular function name.
3804/// 2. offset into __debug_str section for regular function name.
3805/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3806/// instances for the function.
3807///
3808/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3809/// inlined instance; the die_offset points to the inlined_subroutine die in the
3810/// __debug_info section, and the low_pc is the starting address for the
3811/// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003812void DwarfDebug::emitDebugInlineInfo() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003813 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003814 return;
3815
Devang Patel163a9f72010-05-10 22:49:55 +00003816 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00003817 return;
3818
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003819 Asm->OutStreamer.SwitchSection(
3820 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00003821
Chris Lattner233f52b2010-03-09 23:52:58 +00003822 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003823 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3824 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003825
Chris Lattnerc0215722010-04-04 19:25:43 +00003826 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003827
Chris Lattner233f52b2010-03-09 23:52:58 +00003828 Asm->OutStreamer.AddComment("Dwarf Version");
3829 Asm->EmitInt16(dwarf::DWARF_VERSION);
3830 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003831 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003832
Devang Patele9f8f5e2010-05-07 20:54:48 +00003833 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00003834 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00003835
Devang Patele9f8f5e2010-05-07 20:54:48 +00003836 const MDNode *Node = *I;
3837 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach7ab38df2009-11-22 19:20:36 +00003838 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00003839 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00003840 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00003841 StringRef LName = SP.getLinkageName();
3842 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00003843
Chris Lattner233f52b2010-03-09 23:52:58 +00003844 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003845 if (LName.empty()) {
3846 Asm->OutStreamer.EmitBytes(Name, 0);
3847 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003848 } else
Chris Lattner6189ed12010-04-04 23:25:33 +00003849 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3850 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00003851
Chris Lattner233f52b2010-03-09 23:52:58 +00003852 Asm->OutStreamer.AddComment("Function name");
Chris Lattner6189ed12010-04-04 23:25:33 +00003853 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003854 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00003855
Devang Patel53bb5c92009-11-10 23:06:00 +00003856 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00003857 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00003858 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00003859 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003860
Chris Lattner3f53c832010-04-04 18:52:31 +00003861 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003862 Asm->OutStreamer.EmitSymbolValue(LI->first,
3863 Asm->getTargetData().getPointerSize(),0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003864 }
3865 }
3866
Chris Lattnerc0215722010-04-04 19:25:43 +00003867 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003868}