blob: 2c0aeb7e0144fcbfd0de9fc055b6e7b27c680954 [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();
Devang Patelb2bada32010-10-08 17:18:54 +0000510 if (Line == 0)
511 return;
Devang Patel81625742010-08-09 20:20:05 +0000512 unsigned FileID = GetOrCreateSourceID(V.getContext().getDirectory(),
513 V.getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000514 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000515 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
516 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000517}
518
Devang Patel2c4ceb12009-11-21 02:48:08 +0000519/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000520/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000521void DwarfDebug::addSourceLine(DIE *Die, DIGlobalVariable G) {
Devang Patelc665a512010-05-07 23:33:41 +0000522 // Verify global variable.
Devang Patel81625742010-08-09 20:20:05 +0000523 if (!G.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000524 return;
525
Devang Patel81625742010-08-09 20:20:05 +0000526 unsigned Line = G.getLineNumber();
Devang Patelb2bada32010-10-08 17:18:54 +0000527 if (Line == 0)
528 return;
Devang Patel81625742010-08-09 20:20:05 +0000529 unsigned FileID = GetOrCreateSourceID(G.getContext().getDirectory(),
530 G.getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000531 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000532 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
533 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000534}
Devang Patel82dfc0c2009-08-31 22:47:13 +0000535
Devang Patel2c4ceb12009-11-21 02:48:08 +0000536/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000537/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000538void DwarfDebug::addSourceLine(DIE *Die, DISubprogram SP) {
Devang Patelc665a512010-05-07 23:33:41 +0000539 // Verify subprogram.
Devang Patel81625742010-08-09 20:20:05 +0000540 if (!SP.Verify())
Devang Patel82dfc0c2009-08-31 22:47:13 +0000541 return;
Caroline Ticec6f9d622009-09-11 18:25:54 +0000542 // If the line number is 0, don't add it.
Devang Patel81625742010-08-09 20:20:05 +0000543 if (SP.getLineNumber() == 0)
Caroline Ticec6f9d622009-09-11 18:25:54 +0000544 return;
545
Devang Patel81625742010-08-09 20:20:05 +0000546 unsigned Line = SP.getLineNumber();
547 if (!SP.getContext().Verify())
Devang Patel77bf2952010-03-08 22:02:50 +0000548 return;
Devang Patel81625742010-08-09 20:20:05 +0000549 unsigned FileID = GetOrCreateSourceID(SP.getDirectory(),
550 SP.getFilename());
Devang Patel82dfc0c2009-08-31 22:47:13 +0000551 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000552 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
553 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patel82dfc0c2009-08-31 22:47:13 +0000554}
555
Devang Patel2c4ceb12009-11-21 02:48:08 +0000556/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000557/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000558void DwarfDebug::addSourceLine(DIE *Die, DIType Ty) {
Devang Patelc665a512010-05-07 23:33:41 +0000559 // Verify type.
Devang Patel81625742010-08-09 20:20:05 +0000560 if (!Ty.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000561 return;
562
Devang Patel81625742010-08-09 20:20:05 +0000563 unsigned Line = Ty.getLineNumber();
Devang Patelb2bada32010-10-08 17:18:54 +0000564 if (Line == 0 || !Ty.getContext().Verify())
Devang Patel77bf2952010-03-08 22:02:50 +0000565 return;
Devang Patel81625742010-08-09 20:20:05 +0000566 unsigned FileID = GetOrCreateSourceID(Ty.getContext().getDirectory(),
567 Ty.getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000568 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000569 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
570 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000571}
572
Devang Patel6404e4e2009-12-15 19:16:48 +0000573/// addSourceLine - Add location information to specified debug information
574/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000575void DwarfDebug::addSourceLine(DIE *Die, DINameSpace NS) {
Devang Patelc665a512010-05-07 23:33:41 +0000576 // Verify namespace.
Devang Patel81625742010-08-09 20:20:05 +0000577 if (!NS.Verify())
Devang Patel6404e4e2009-12-15 19:16:48 +0000578 return;
579
Devang Patel81625742010-08-09 20:20:05 +0000580 unsigned Line = NS.getLineNumber();
Devang Patelb2bada32010-10-08 17:18:54 +0000581 if (Line == 0)
582 return;
Devang Patel81625742010-08-09 20:20:05 +0000583 StringRef FN = NS.getFilename();
584 StringRef Dir = NS.getDirectory();
Devang Patel6404e4e2009-12-15 19:16:48 +0000585
586 unsigned FileID = GetOrCreateSourceID(Dir, FN);
587 assert(FileID && "Invalid file id");
588 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
589 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
590}
591
Devang Patel9e3bd2c2010-08-31 06:11:28 +0000592/// addVariableAddress - Add DW_AT_location attribute for a DbgVariable based
593/// on provided frame index.
594void DwarfDebug::addVariableAddress(DbgVariable *&DV, DIE *Die, int64_t FI) {
595 MachineLocation Location;
596 unsigned FrameReg;
597 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
598 int Offset = RI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
599 Location.set(FrameReg, Offset);
600
Devang Patel8bd11de2010-08-09 21:01:39 +0000601 if (DV->variableHasComplexAddress())
602 addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
603 else if (DV->isBlockByrefVariable())
604 addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
605 else
606 addAddress(Die, dwarf::DW_AT_location, Location);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000607}
608
Devang Patel2c4ceb12009-11-21 02:48:08 +0000609/// addComplexAddress - Start with the address based on the location provided,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000610/// and generate the DWARF information necessary to find the actual variable
611/// given the extra address information encoded in the DIVariable, starting from
612/// the starting location. Add the DWARF information to the die.
613///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000614void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000615 unsigned Attribute,
616 const MachineLocation &Location) {
Devang Patel8bd11de2010-08-09 21:01:39 +0000617 DIType Ty = DV->getType();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000618
619 // Decode the original location, and use that as the start of the byref
620 // variable's location.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000621 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000622 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000623 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000624
625 if (Location.isReg()) {
626 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000627 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000628 } else {
629 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000630 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
631 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000632 }
633 } else {
634 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000635 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000636 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000637 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
638 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000639 }
640
Devang Patel2c4ceb12009-11-21 02:48:08 +0000641 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000642 }
643
Devang Patel8bd11de2010-08-09 21:01:39 +0000644 for (unsigned i = 0, N = DV->getNumAddrElements(); i < N; ++i) {
645 uint64_t Element = DV->getAddrElement(i);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000646
647 if (Element == DIFactory::OpPlus) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000648 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel8bd11de2010-08-09 21:01:39 +0000649 addUInt(Block, 0, dwarf::DW_FORM_udata, DV->getAddrElement(++i));
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000650 } else if (Element == DIFactory::OpDeref) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000651 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000652 } else llvm_unreachable("unknown DIFactory Opcode");
653 }
654
655 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000656 addBlock(Die, Attribute, 0, Block);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000657}
658
Caroline Ticedc8f6042009-08-31 21:19:37 +0000659/* Byref variables, in Blocks, are declared by the programmer as "SomeType
660 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
661 gives the variable VarName either the struct, or a pointer to the struct, as
662 its type. This is necessary for various behind-the-scenes things the
663 compiler needs to do with by-reference variables in Blocks.
664
665 However, as far as the original *programmer* is concerned, the variable
666 should still have type 'SomeType', as originally declared.
667
Devang Patel2c4ceb12009-11-21 02:48:08 +0000668 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000669 struct to find the original type of the variable, which is then assigned to
670 the variable's Debug Information Entry as its real type. So far, so good.
671 However now the debugger will expect the variable VarName to have the type
672 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000673 expression that explains to the debugger how to navigate through the
Caroline Ticedc8f6042009-08-31 21:19:37 +0000674 pointers and struct to find the actual variable of type SomeType.
675
676 The following function does just that. We start by getting
677 the "normal" location for the variable. This will be the location
678 of either the struct __Block_byref_x_VarName or the pointer to the
679 struct __Block_byref_x_VarName.
680
681 The struct will look something like:
682
683 struct __Block_byref_x_VarName {
684 ... <various fields>
685 struct __Block_byref_x_VarName *forwarding;
686 ... <various other fields>
687 SomeType VarName;
688 ... <maybe more fields>
689 };
690
691 If we are given the struct directly (as our starting point) we
692 need to tell the debugger to:
693
694 1). Add the offset of the forwarding field.
695
Dan Gohmanf451cb82010-02-10 16:03:48 +0000696 2). Follow that pointer to get the real __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000697 struct to use (the real one may have been copied onto the heap).
698
699 3). Add the offset for the field VarName, to find the actual variable.
700
701 If we started with a pointer to the struct, then we need to
702 dereference that pointer first, before the other steps.
703 Translating this into DWARF ops, we will need to append the following
704 to the current location description for the variable:
705
706 DW_OP_deref -- optional, if we start with a pointer
707 DW_OP_plus_uconst <forward_fld_offset>
708 DW_OP_deref
709 DW_OP_plus_uconst <varName_fld_offset>
710
711 That is what this function does. */
712
Devang Patel2c4ceb12009-11-21 02:48:08 +0000713/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticedc8f6042009-08-31 21:19:37 +0000714/// provided, and generate the DWARF information necessary to find the
715/// actual Block variable (navigating the Block struct) based on the
716/// starting location. Add the DWARF information to the die. For
717/// more information, read large comment just above here.
718///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000719void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbar00564992009-09-19 20:40:14 +0000720 unsigned Attribute,
721 const MachineLocation &Location) {
Devang Patel8bd11de2010-08-09 21:01:39 +0000722 DIType Ty = DV->getType();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000723 DIType TmpTy = Ty;
724 unsigned Tag = Ty.getTag();
725 bool isPointer = false;
726
Devang Patel8bd11de2010-08-09 21:01:39 +0000727 StringRef varName = DV->getName();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000728
729 if (Tag == dwarf::DW_TAG_pointer_type) {
Devang Patel2db49d72010-05-07 18:11:54 +0000730 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000731 TmpTy = DTy.getTypeDerivedFrom();
732 isPointer = true;
733 }
734
Devang Patel2db49d72010-05-07 18:11:54 +0000735 DICompositeType blockStruct = DICompositeType(TmpTy);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000736
Daniel Dunbar00564992009-09-19 20:40:14 +0000737 // Find the __forwarding field and the variable field in the __Block_byref
738 // struct.
Daniel Dunbar00564992009-09-19 20:40:14 +0000739 DIArray Fields = blockStruct.getTypeArray();
740 DIDescriptor varField = DIDescriptor();
741 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000742
Daniel Dunbar00564992009-09-19 20:40:14 +0000743 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
744 DIDescriptor Element = Fields.getElement(i);
Devang Patel2db49d72010-05-07 18:11:54 +0000745 DIDerivedType DT = DIDerivedType(Element);
Devang Patel65dbc902009-11-25 17:36:49 +0000746 StringRef fieldName = DT.getName();
747 if (fieldName == "__forwarding")
Daniel Dunbar00564992009-09-19 20:40:14 +0000748 forwardingField = Element;
Devang Patel65dbc902009-11-25 17:36:49 +0000749 else if (fieldName == varName)
Daniel Dunbar00564992009-09-19 20:40:14 +0000750 varField = Element;
751 }
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000752
Daniel Dunbar00564992009-09-19 20:40:14 +0000753 // Get the offsets for the forwarding field and the variable field.
Chris Lattner1d65ba72010-03-31 06:06:37 +0000754 unsigned forwardingFieldOffset =
Devang Patel2db49d72010-05-07 18:11:54 +0000755 DIDerivedType(forwardingField).getOffsetInBits() >> 3;
Chris Lattner1d65ba72010-03-31 06:06:37 +0000756 unsigned varFieldOffset =
Devang Patel2db49d72010-05-07 18:11:54 +0000757 DIDerivedType(varField).getOffsetInBits() >> 3;
Caroline Ticedc8f6042009-08-31 21:19:37 +0000758
Mike Stump7e3720d2009-09-24 23:21:26 +0000759 // Decode the original location, and use that as the start of the byref
760 // variable's location.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000761 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Daniel Dunbar00564992009-09-19 20:40:14 +0000762 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000763 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000764
Daniel Dunbar00564992009-09-19 20:40:14 +0000765 if (Location.isReg()) {
766 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000767 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000768 else {
769 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000770 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
771 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000772 }
773 } else {
774 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000775 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000776 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000777 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
778 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000779 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000780
Devang Patel2c4ceb12009-11-21 02:48:08 +0000781 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbar00564992009-09-19 20:40:14 +0000782 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000783
Mike Stump7e3720d2009-09-24 23:21:26 +0000784 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbar00564992009-09-19 20:40:14 +0000785 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbar00564992009-09-19 20:40:14 +0000786 if (isPointer)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000787 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000788
Daniel Dunbar00564992009-09-19 20:40:14 +0000789 // Next add the offset for the '__forwarding' field:
790 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
791 // adding the offset if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000792 if (forwardingFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000793 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
794 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000795 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000796
Daniel Dunbar00564992009-09-19 20:40:14 +0000797 // Now dereference the __forwarding field to get to the real __Block_byref
798 // struct: DW_OP_deref.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000799 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000800
Daniel Dunbar00564992009-09-19 20:40:14 +0000801 // Now that we've got the real __Block_byref... struct, add the offset
802 // for the variable's field to get to the location of the actual variable:
803 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000804 if (varFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000805 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
806 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000807 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000808
Daniel Dunbar00564992009-09-19 20:40:14 +0000809 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000810 addBlock(Die, Attribute, 0, Block);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000811}
812
Devang Patel2c4ceb12009-11-21 02:48:08 +0000813/// addAddress - Add an address attribute to a die based on the location
Bill Wendling0310d762009-05-15 09:23:25 +0000814/// provided.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000815void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000816 const MachineLocation &Location) {
Chris Lattnerd38fee82010-04-05 00:13:49 +0000817 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling0310d762009-05-15 09:23:25 +0000818 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000819 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patelbe90c3a2010-09-22 21:10:38 +0000820 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
821
822 if (TRI->getFrameRegister(*Asm->MF) == Location.getReg()
823 && Location.getOffset()) {
824 // If variable offset is based in frame register then use fbreg.
825 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
826 addSInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
827 addBlock(Die, Attribute, 0, Block);
828 return;
829 }
Bill Wendling0310d762009-05-15 09:23:25 +0000830
831 if (Location.isReg()) {
832 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000833 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000834 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000835 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
836 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000837 }
838 } else {
839 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000840 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000841 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000842 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
843 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000844 }
845
Devang Patel2c4ceb12009-11-21 02:48:08 +0000846 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling0310d762009-05-15 09:23:25 +0000847 }
848
Devang Patel2c4ceb12009-11-21 02:48:08 +0000849 addBlock(Die, Attribute, 0, Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000850}
851
Devang Patela43098d2010-04-28 01:03:09 +0000852/// addRegisterAddress - Add register location entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000853bool DwarfDebug::addRegisterAddress(DIE *Die, const MCSymbol *VS,
Devang Patela43098d2010-04-28 01:03:09 +0000854 const MachineOperand &MO) {
855 assert (MO.isReg() && "Invalid machine operand!");
856 if (!MO.getReg())
857 return false;
858 MachineLocation Location;
859 Location.set(MO.getReg());
860 addAddress(Die, dwarf::DW_AT_location, Location);
Devang Patel26c1e562010-05-20 16:36:41 +0000861 if (VS)
Devang Patela43098d2010-04-28 01:03:09 +0000862 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
863 return true;
864}
865
866/// addConstantValue - Add constant value entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000867bool DwarfDebug::addConstantValue(DIE *Die, const MCSymbol *VS,
Devang Patela43098d2010-04-28 01:03:09 +0000868 const MachineOperand &MO) {
869 assert (MO.isImm() && "Invalid machine operand!");
870 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
871 unsigned Imm = MO.getImm();
872 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
873 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patel26c1e562010-05-20 16:36:41 +0000874 if (VS)
Devang Patela43098d2010-04-28 01:03:09 +0000875 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
876 return true;
877}
878
879/// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000880bool DwarfDebug::addConstantFPValue(DIE *Die, const MCSymbol *VS,
Devang Patela43098d2010-04-28 01:03:09 +0000881 const MachineOperand &MO) {
882 assert (MO.isFPImm() && "Invalid machine operand!");
883 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
884 APFloat FPImm = MO.getFPImm()->getValueAPF();
Jim Grosbach1e20b962010-07-21 21:21:52 +0000885
Devang Patela43098d2010-04-28 01:03:09 +0000886 // Get the raw data form of the floating point.
887 const APInt FltVal = FPImm.bitcastToAPInt();
888 const char *FltPtr = (const char*)FltVal.getRawData();
Jim Grosbach1e20b962010-07-21 21:21:52 +0000889
Devang Patela43098d2010-04-28 01:03:09 +0000890 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
891 bool LittleEndian = Asm->getTargetData().isLittleEndian();
892 int Incr = (LittleEndian ? 1 : -1);
893 int Start = (LittleEndian ? 0 : NumBytes - 1);
894 int Stop = (LittleEndian ? NumBytes : -1);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000895
Devang Patela43098d2010-04-28 01:03:09 +0000896 // Output the constant to DWARF one byte at a time.
897 for (; Start != Stop; Start += Incr)
898 addUInt(Block, 0, dwarf::DW_FORM_data1,
899 (unsigned char)0xFF & FltPtr[Start]);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000900
Devang Patela43098d2010-04-28 01:03:09 +0000901 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patel26c1e562010-05-20 16:36:41 +0000902 if (VS)
903 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000904 return true;
Devang Patela43098d2010-04-28 01:03:09 +0000905}
906
907
Devang Patelc366f832009-12-10 19:14:49 +0000908/// addToContextOwner - Add Die into the list of its context owner's children.
909void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3c91b052010-03-08 20:52:55 +0000910 if (Context.isType()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000911 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
Devang Patelc366f832009-12-10 19:14:49 +0000912 ContextDIE->addChild(Die);
Devang Patel6404e4e2009-12-15 19:16:48 +0000913 } else if (Context.isNameSpace()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000914 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
Devang Patel6404e4e2009-12-15 19:16:48 +0000915 ContextDIE->addChild(Die);
Stuart Hastings215aa152010-06-11 20:08:44 +0000916 } else if (Context.isSubprogram()) {
Devang Patelee70fa72010-09-27 23:15:27 +0000917 DIE *ContextDIE = createSubprogramDIE(DISubprogram(Context));
Stuart Hastings215aa152010-06-11 20:08:44 +0000918 ContextDIE->addChild(Die);
Devang Patel163a9f72010-05-10 22:49:55 +0000919 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patelc366f832009-12-10 19:14:49 +0000920 ContextDIE->addChild(Die);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000921 else
Devang Patel163a9f72010-05-10 22:49:55 +0000922 getCompileUnit(Context)->addDie(Die);
Devang Patelc366f832009-12-10 19:14:49 +0000923}
924
Devang Patel16ced732009-12-10 18:05:33 +0000925/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
926/// given DIType.
927DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel163a9f72010-05-10 22:49:55 +0000928 CompileUnit *TypeCU = getCompileUnit(Ty);
929 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patel16ced732009-12-10 18:05:33 +0000930 if (TyDIE)
931 return TyDIE;
932
933 // Create new type.
934 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel163a9f72010-05-10 22:49:55 +0000935 TypeCU->insertDIE(Ty, TyDIE);
Devang Patel16ced732009-12-10 18:05:33 +0000936 if (Ty.isBasicType())
Devang Patel2db49d72010-05-07 18:11:54 +0000937 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000938 else if (Ty.isCompositeType())
Devang Patel2db49d72010-05-07 18:11:54 +0000939 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000940 else {
941 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patel2db49d72010-05-07 18:11:54 +0000942 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000943 }
944
Devang Patelc366f832009-12-10 19:14:49 +0000945 addToContextOwner(TyDIE, Ty.getContext());
Devang Patel16ced732009-12-10 18:05:33 +0000946 return TyDIE;
947}
948
Devang Patel2c4ceb12009-11-21 02:48:08 +0000949/// addType - Add a new type attribute to the specified entity.
Devang Patel8a241142009-12-09 18:24:21 +0000950void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel9c004872010-05-07 21:45:47 +0000951 if (!Ty.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000952 return;
953
954 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +0000955 CompileUnit *TypeCU = getCompileUnit(Ty);
956 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000957 // If it exists then use the existing value.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000958 if (Entry) {
959 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000960 return;
961 }
962
Bill Wendling0310d762009-05-15 09:23:25 +0000963 // Construct type.
Devang Patel16ced732009-12-10 18:05:33 +0000964 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000965
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000966 // Set up proxy.
967 Entry = createDIEEntry(Buffer);
Devang Patel163a9f72010-05-10 22:49:55 +0000968 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000969
Devang Patel2c4ceb12009-11-21 02:48:08 +0000970 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000971}
972
Devang Patel2c4ceb12009-11-21 02:48:08 +0000973/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel8a241142009-12-09 18:24:21 +0000974void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000975 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000976 StringRef Name = BTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000977 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000978 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling0310d762009-05-15 09:23:25 +0000979 BTy.getEncoding());
980
981 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +0000982 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000983 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000984 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000985 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000986}
987
Devang Patel2c4ceb12009-11-21 02:48:08 +0000988/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel8a241142009-12-09 18:24:21 +0000989void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000990 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000991 StringRef Name = DTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000992 uint64_t Size = DTy.getSizeInBits() >> 3;
993 unsigned Tag = DTy.getTag();
994
995 // FIXME - Workaround for templates.
996 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
997
998 Buffer.setTag(Tag);
999
1000 // Map to main type, void will not have a type.
1001 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel8a241142009-12-09 18:24:21 +00001002 addType(&Buffer, FromTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001003
1004 // Add name if not anonymous or intermediate type.
Devang Pateldeea5642009-11-30 23:56:56 +00001005 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001006 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001007
1008 // Add size if non-zero (derived types might be zero-sized.)
1009 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001010 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +00001011
1012 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patel05f6fa82009-11-23 18:43:37 +00001013 if (!DTy.isForwardDecl())
Devang Patel81625742010-08-09 20:20:05 +00001014 addSourceLine(&Buffer, DTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001015}
1016
Devang Patel2c4ceb12009-11-21 02:48:08 +00001017/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +00001018void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001019 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +00001020 StringRef Name = CTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +00001021
1022 uint64_t Size = CTy.getSizeInBits() >> 3;
1023 unsigned Tag = CTy.getTag();
1024 Buffer.setTag(Tag);
1025
1026 switch (Tag) {
1027 case dwarf::DW_TAG_vector_type:
1028 case dwarf::DW_TAG_array_type:
Devang Patel8a241142009-12-09 18:24:21 +00001029 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001030 break;
1031 case dwarf::DW_TAG_enumeration_type: {
1032 DIArray Elements = CTy.getTypeArray();
1033
1034 // Add enumerators to enumeration type.
1035 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1036 DIE *ElemDie = NULL;
Devang Patel2db49d72010-05-07 18:11:54 +00001037 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3c91b052010-03-08 20:52:55 +00001038 if (Enum.isEnumerator()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001039 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001040 Buffer.addChild(ElemDie);
Devang Patelc5254722009-10-09 17:51:49 +00001041 }
Bill Wendling0310d762009-05-15 09:23:25 +00001042 }
1043 }
1044 break;
1045 case dwarf::DW_TAG_subroutine_type: {
1046 // Add return type.
1047 DIArray Elements = CTy.getTypeArray();
1048 DIDescriptor RTy = Elements.getElement(0);
Devang Patel2db49d72010-05-07 18:11:54 +00001049 addType(&Buffer, DIType(RTy));
Bill Wendling0310d762009-05-15 09:23:25 +00001050
Devang Pateld6747df2010-10-06 20:50:40 +00001051 bool isPrototyped = true;
Bill Wendling0310d762009-05-15 09:23:25 +00001052 // Add arguments.
1053 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
Bill Wendling0310d762009-05-15 09:23:25 +00001054 DIDescriptor Ty = Elements.getElement(i);
Devang Pateld6747df2010-10-06 20:50:40 +00001055 if (Ty.isUnspecifiedParameter()) {
1056 DIE *Arg = new DIE(dwarf::DW_TAG_unspecified_parameters);
1057 Buffer.addChild(Arg);
1058 isPrototyped = false;
1059 } else {
1060 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1061 addType(Arg, DIType(Ty));
1062 Buffer.addChild(Arg);
1063 }
Bill Wendling0310d762009-05-15 09:23:25 +00001064 }
Devang Pateld6747df2010-10-06 20:50:40 +00001065 // Add prototype flag.
1066 if (isPrototyped)
1067 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001068 }
1069 break;
1070 case dwarf::DW_TAG_structure_type:
1071 case dwarf::DW_TAG_union_type:
1072 case dwarf::DW_TAG_class_type: {
1073 // Add elements to structure type.
1074 DIArray Elements = CTy.getTypeArray();
1075
1076 // A forward struct declared type may not have elements available.
Devang Patel3c91b052010-03-08 20:52:55 +00001077 unsigned N = Elements.getNumElements();
1078 if (N == 0)
Bill Wendling0310d762009-05-15 09:23:25 +00001079 break;
1080
1081 // Add elements to structure type.
Devang Patel3c91b052010-03-08 20:52:55 +00001082 for (unsigned i = 0; i < N; ++i) {
Bill Wendling0310d762009-05-15 09:23:25 +00001083 DIDescriptor Element = Elements.getElement(i);
1084 DIE *ElemDie = NULL;
Devang Patel1a301232010-09-29 21:44:16 +00001085 if (Element.isSubprogram()) {
1086 DISubprogram SP(Element);
Devang Patel2db49d72010-05-07 18:11:54 +00001087 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patel1a301232010-09-29 21:44:16 +00001088 if (SP.isProtected())
1089 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1090 dwarf::DW_ACCESS_protected);
1091 else if (SP.isPrivate())
1092 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1093 dwarf::DW_ACCESS_private);
1094 else
1095 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1096 dwarf::DW_ACCESS_public);
Devang Patel21ea1d52010-10-01 23:31:40 +00001097 if (SP.isExplicit())
1098 addUInt(ElemDie, dwarf::DW_AT_explicit, dwarf::DW_FORM_flag, 1);
Devang Patel1a301232010-09-29 21:44:16 +00001099 }
Devang Patel3c91b052010-03-08 20:52:55 +00001100 else if (Element.isVariable()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001101 DIVariable DV(Element);
Devang Patel1ee0cb92010-01-30 01:08:30 +00001102 ElemDie = new DIE(dwarf::DW_TAG_variable);
1103 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1104 DV.getName());
1105 addType(ElemDie, DV.getType());
1106 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1107 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patel81625742010-08-09 20:20:05 +00001108 addSourceLine(ElemDie, DV);
Devang Patel3c91b052010-03-08 20:52:55 +00001109 } else if (Element.isDerivedType())
Devang Patel2db49d72010-05-07 18:11:54 +00001110 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3c91b052010-03-08 20:52:55 +00001111 else
1112 continue;
Devang Patel2c4ceb12009-11-21 02:48:08 +00001113 Buffer.addChild(ElemDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001114 }
1115
Devang Patela1ba2692009-08-27 23:51:51 +00001116 if (CTy.isAppleBlockExtension())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001117 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001118
1119 unsigned RLang = CTy.getRunTimeLang();
1120 if (RLang)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001121 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling0310d762009-05-15 09:23:25 +00001122 dwarf::DW_FORM_data1, RLang);
Devang Patelb5544992010-01-26 21:16:06 +00001123
1124 DICompositeType ContainingType = CTy.getContainingType();
Devang Patel2db49d72010-05-07 18:11:54 +00001125 if (DIDescriptor(ContainingType).isCompositeType())
Jim Grosbach1e20b962010-07-21 21:21:52 +00001126 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patel2db49d72010-05-07 18:11:54 +00001127 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastings215aa152010-06-11 20:08:44 +00001128 else {
1129 DIDescriptor Context = CTy.getContext();
1130 addToContextOwner(&Buffer, Context);
1131 }
Bill Wendling0310d762009-05-15 09:23:25 +00001132 break;
1133 }
1134 default:
1135 break;
1136 }
1137
1138 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +00001139 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001140 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001141
Jim Grosbach1e20b962010-07-21 21:21:52 +00001142 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
Devang Patel61409622010-07-07 20:12:52 +00001143 || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1144 {
Bill Wendling0310d762009-05-15 09:23:25 +00001145 // Add size if non-zero (derived types might be zero-sized.)
1146 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001147 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +00001148 else {
1149 // Add zero size if it is not a forward declaration.
1150 if (CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001151 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001152 else
Devang Patel2c4ceb12009-11-21 02:48:08 +00001153 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling0310d762009-05-15 09:23:25 +00001154 }
1155
1156 // Add source line info if available.
1157 if (!CTy.isForwardDecl())
Devang Patel81625742010-08-09 20:20:05 +00001158 addSourceLine(&Buffer, CTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001159 }
1160}
1161
Devang Patel2c4ceb12009-11-21 02:48:08 +00001162/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1163void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling0310d762009-05-15 09:23:25 +00001164 int64_t L = SR.getLo();
1165 int64_t H = SR.getHi();
1166 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1167
Devang Patel2c4ceb12009-11-21 02:48:08 +00001168 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patel6325a532009-08-14 20:59:16 +00001169 if (L)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001170 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Pateld55224c2009-12-04 23:10:24 +00001171 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling0310d762009-05-15 09:23:25 +00001172
Devang Patel2c4ceb12009-11-21 02:48:08 +00001173 Buffer.addChild(DW_Subrange);
Bill Wendling0310d762009-05-15 09:23:25 +00001174}
1175
Devang Patel2c4ceb12009-11-21 02:48:08 +00001176/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +00001177void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling0310d762009-05-15 09:23:25 +00001178 DICompositeType *CTy) {
1179 Buffer.setTag(dwarf::DW_TAG_array_type);
1180 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001181 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001182
1183 // Emit derived type.
Devang Patel8a241142009-12-09 18:24:21 +00001184 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001185 DIArray Elements = CTy->getTypeArray();
1186
Devang Patel6f01d9c2009-11-21 00:31:03 +00001187 // Get an anonymous type for index type.
Devang Patel163a9f72010-05-10 22:49:55 +00001188 CompileUnit *TheCU = getCompileUnit(*CTy);
1189 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel6f01d9c2009-11-21 00:31:03 +00001190 if (!IdxTy) {
1191 // Construct an anonymous type for index type.
1192 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001193 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1194 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel6f01d9c2009-11-21 00:31:03 +00001195 dwarf::DW_ATE_signed);
Devang Patel163a9f72010-05-10 22:49:55 +00001196 TheCU->addDie(IdxTy);
1197 TheCU->setIndexTyDie(IdxTy);
Devang Patel6f01d9c2009-11-21 00:31:03 +00001198 }
Bill Wendling0310d762009-05-15 09:23:25 +00001199
1200 // Add subranges to array type.
1201 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1202 DIDescriptor Element = Elements.getElement(i);
1203 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patel2db49d72010-05-07 18:11:54 +00001204 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001205 }
1206}
1207
Devang Patel2c4ceb12009-11-21 02:48:08 +00001208/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3c91b052010-03-08 20:52:55 +00001209DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001210 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3c91b052010-03-08 20:52:55 +00001211 StringRef Name = ETy.getName();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001212 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3c91b052010-03-08 20:52:55 +00001213 int64_t Value = ETy.getEnumValue();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001214 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling0310d762009-05-15 09:23:25 +00001215 return Enumerator;
1216}
1217
Jim Grosbach1e20b962010-07-21 21:21:52 +00001218/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel351ca332010-01-05 01:46:14 +00001219/// printer to not emit usual symbol prefix before the symbol name is used then
1220/// return linkage name after skipping this special LLVM prefix.
1221static StringRef getRealLinkageName(StringRef LinkageName) {
1222 char One = '\1';
1223 if (LinkageName.startswith(StringRef(&One, 1)))
1224 return LinkageName.substr(1);
1225 return LinkageName;
1226}
1227
Devang Patel2c4ceb12009-11-21 02:48:08 +00001228/// createMemberDIE - Create new member DIE.
Devang Patelecbd8e82010-08-10 04:12:17 +00001229DIE *DwarfDebug::createMemberDIE(DIDerivedType DT) {
Bill Wendling0310d762009-05-15 09:23:25 +00001230 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel65dbc902009-11-25 17:36:49 +00001231 StringRef Name = DT.getName();
1232 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001233 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001234
Devang Patel8a241142009-12-09 18:24:21 +00001235 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001236
Devang Patel81625742010-08-09 20:20:05 +00001237 addSourceLine(MemberDie, DT);
Bill Wendling0310d762009-05-15 09:23:25 +00001238
Benjamin Kramer345ef342010-03-31 19:34:01 +00001239 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001240 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel33db5082009-11-04 22:06:12 +00001241
Bill Wendling0310d762009-05-15 09:23:25 +00001242 uint64_t Size = DT.getSizeInBits();
Devang Patel61ecbd12009-11-04 23:48:00 +00001243 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling0310d762009-05-15 09:23:25 +00001244
1245 if (Size != FieldSize) {
1246 // Handle bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001247 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1248 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling0310d762009-05-15 09:23:25 +00001249
1250 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling0310d762009-05-15 09:23:25 +00001251 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1252 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer3d594fd2010-01-07 17:50:57 +00001253 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling0310d762009-05-15 09:23:25 +00001254 Offset -= FieldOffset;
1255
1256 // Maybe we need to work from the other end.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001257 if (Asm->getTargetData().isLittleEndian())
1258 Offset = FieldSize - (Offset + Size);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001259 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling0310d762009-05-15 09:23:25 +00001260
Devang Patel33db5082009-11-04 22:06:12 +00001261 // Here WD_AT_data_member_location points to the anonymous
1262 // field that includes this bit field.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001263 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001264
1265 } else
1266 // This is not a bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001267 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001268
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001269 if (DT.getTag() == dwarf::DW_TAG_inheritance
1270 && DT.isVirtual()) {
1271
1272 // For C++, virtual base classes are not at fixed offset. Use following
1273 // expression to extract appropriate offset from vtable.
1274 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1275
Benjamin Kramer345ef342010-03-31 19:34:01 +00001276 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001277 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1278 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1279 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1280 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1281 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1282 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1283 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1284
Jim Grosbach1e20b962010-07-21 21:21:52 +00001285 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001286 VBaseLocationDie);
1287 } else
1288 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001289
1290 if (DT.isProtected())
Devang Patel5d11eb02009-12-03 19:11:07 +00001291 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001292 dwarf::DW_ACCESS_protected);
1293 else if (DT.isPrivate())
Devang Patel5d11eb02009-12-03 19:11:07 +00001294 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001295 dwarf::DW_ACCESS_private);
Devang Patel2a361602010-09-29 19:08:08 +00001296 // Otherwise C++ member and base classes are considered public.
1297 else if (DT.getCompileUnit().getLanguage() == dwarf::DW_LANG_C_plus_plus)
Devang Patel5d11eb02009-12-03 19:11:07 +00001298 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1299 dwarf::DW_ACCESS_public);
1300 if (DT.isVirtual())
1301 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1302 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling0310d762009-05-15 09:23:25 +00001303 return MemberDie;
1304}
1305
Devang Patelffe966c2009-12-14 16:18:45 +00001306/// createSubprogramDIE - Create new DIE using SP.
Devang Patelee70fa72010-09-27 23:15:27 +00001307DIE *DwarfDebug::createSubprogramDIE(DISubprogram SP) {
Devang Patel163a9f72010-05-10 22:49:55 +00001308 CompileUnit *SPCU = getCompileUnit(SP);
1309 DIE *SPDie = SPCU->getDIE(SP);
Devang Patelffe966c2009-12-14 16:18:45 +00001310 if (SPDie)
1311 return SPDie;
1312
1313 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel1eac3e72010-03-02 17:58:15 +00001314 // Constructors and operators for anonymous aggregates do not have names.
Devang Patel6b506cb2010-03-02 01:26:20 +00001315 if (!SP.getName().empty())
1316 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling0310d762009-05-15 09:23:25 +00001317
Devang Patel65dbc902009-11-25 17:36:49 +00001318 StringRef LinkageName = SP.getLinkageName();
Devang Patel351ca332010-01-05 01:46:14 +00001319 if (!LinkageName.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001320 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel351ca332010-01-05 01:46:14 +00001321 getRealLinkageName(LinkageName));
1322
Devang Patel81625742010-08-09 20:20:05 +00001323 addSourceLine(SPDie, SP);
Bill Wendling0310d762009-05-15 09:23:25 +00001324
Devang Patel7b172c62010-10-07 22:03:01 +00001325 if (SP.isPrototyped())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001326 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001327
1328 // Add Return Type.
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001329 DICompositeType SPTy = SP.getType();
1330 DIArray Args = SPTy.getTypeArray();
Bill Wendling0310d762009-05-15 09:23:25 +00001331 unsigned SPTag = SPTy.getTag();
Devang Patel5d11eb02009-12-03 19:11:07 +00001332
Devang Patel3c91b052010-03-08 20:52:55 +00001333 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel8a241142009-12-09 18:24:21 +00001334 addType(SPDie, SPTy);
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001335 else
Devang Patel2db49d72010-05-07 18:11:54 +00001336 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001337
Devang Patel5d11eb02009-12-03 19:11:07 +00001338 unsigned VK = SP.getVirtuality();
1339 if (VK) {
1340 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer345ef342010-03-31 19:34:01 +00001341 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel5d11eb02009-12-03 19:11:07 +00001342 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1343 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1344 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001345 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patel2db49d72010-05-07 18:11:54 +00001346 SP.getContainingType()));
Devang Patel5d11eb02009-12-03 19:11:07 +00001347 }
1348
Devang Patelee70fa72010-09-27 23:15:27 +00001349 if (!SP.isDefinition()) {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001350 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001351
1352 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001353 // be handled while processing variables.
1354 DICompositeType SPTy = SP.getType();
1355 DIArray Args = SPTy.getTypeArray();
1356 unsigned SPTag = SPTy.getTag();
1357
Bill Wendling0310d762009-05-15 09:23:25 +00001358 if (SPTag == dwarf::DW_TAG_subroutine_type)
1359 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1360 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001361 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patelb4645642010-02-06 01:02:37 +00001362 addType(Arg, ATy);
1363 if (ATy.isArtificial())
1364 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001365 SPDie->addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001366 }
1367 }
1368
Devang Patel4e0d19d2010-02-03 19:57:19 +00001369 if (SP.isArtificial())
1370 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1371
Devang Patelccff8122010-04-30 19:38:23 +00001372 if (!SP.isLocalToUnit())
1373 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001374
Devang Patelccff8122010-04-30 19:38:23 +00001375 if (SP.isOptimized())
1376 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1377
Jim Grosbach91729002010-07-21 23:03:52 +00001378 if (unsigned isa = Asm->getISAEncoding()) {
1379 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1380 }
1381
Devang Patelccff8122010-04-30 19:38:23 +00001382 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel163a9f72010-05-10 22:49:55 +00001383 SPCU->insertDIE(SP, SPDie);
Devang Patelccff8122010-04-30 19:38:23 +00001384
Stuart Hastings215aa152010-06-11 20:08:44 +00001385 // Add to context owner.
1386 addToContextOwner(SPDie, SP.getContext());
1387
Bill Wendling0310d762009-05-15 09:23:25 +00001388 return SPDie;
1389}
1390
Devang Patele9f8f5e2010-05-07 20:54:48 +00001391DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattnered7a77b2010-03-31 05:36:29 +00001392 assert(N && "Invalid Scope encoding!");
Devang Patel53bb5c92009-11-10 23:06:00 +00001393
1394 DbgScope *AScope = AbstractScopes.lookup(N);
1395 if (AScope)
1396 return AScope;
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001397
Devang Patel53bb5c92009-11-10 23:06:00 +00001398 DbgScope *Parent = NULL;
1399
1400 DIDescriptor Scope(N);
1401 if (Scope.isLexicalBlock()) {
1402 DILexicalBlock DB(N);
1403 DIDescriptor ParentDesc = DB.getContext();
Devang Patel2db49d72010-05-07 18:11:54 +00001404 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patel53bb5c92009-11-10 23:06:00 +00001405 }
1406
1407 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1408
1409 if (Parent)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001410 Parent->addScope(AScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001411 AScope->setAbstractScope();
1412 AbstractScopes[N] = AScope;
1413 if (DIDescriptor(N).isSubprogram())
1414 AbstractScopesList.push_back(AScope);
1415 return AScope;
1416}
Devang Patelaf9e8472009-10-01 20:31:14 +00001417
Devang Patel5f094002010-04-06 23:53:48 +00001418/// isSubprogramContext - Return true if Context is either a subprogram
1419/// or another context nested inside a subprogram.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001420static bool isSubprogramContext(const MDNode *Context) {
Devang Patel5f094002010-04-06 23:53:48 +00001421 if (!Context)
1422 return false;
1423 DIDescriptor D(Context);
1424 if (D.isSubprogram())
1425 return true;
1426 if (D.isType())
Devang Patel2db49d72010-05-07 18:11:54 +00001427 return isSubprogramContext(DIType(Context).getContext());
Devang Patel5f094002010-04-06 23:53:48 +00001428 return false;
1429}
1430
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001431/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel2c4ceb12009-11-21 02:48:08 +00001432/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1433/// If there are global variables in this scope then create and insert
1434/// DIEs for these variables.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001435DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel163a9f72010-05-10 22:49:55 +00001436 CompileUnit *SPCU = getCompileUnit(SPNode);
1437 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patel8aa61472010-07-07 22:20:57 +00001438
Chris Lattnerd38fee82010-04-05 00:13:49 +00001439 assert(SPDie && "Unable to find subprogram DIE!");
1440 DISubprogram SP(SPNode);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001441
Chris Lattnerd38fee82010-04-05 00:13:49 +00001442 // There is not any need to generate specification DIE for a function
1443 // defined at compile unit level. If a function is defined inside another
1444 // function then gdb prefers the definition at top level and but does not
Jim Grosbach1e20b962010-07-21 21:21:52 +00001445 // expect specification DIE in parent function. So avoid creating
Chris Lattnerd38fee82010-04-05 00:13:49 +00001446 // specification DIE for a function defined inside a function.
1447 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Jim Grosbach1e20b962010-07-21 21:21:52 +00001448 !SP.getContext().isFile() &&
Devang Patel2db49d72010-05-07 18:11:54 +00001449 !isSubprogramContext(SP.getContext())) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00001450 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001451
1452 // Add arguments.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001453 DICompositeType SPTy = SP.getType();
1454 DIArray Args = SPTy.getTypeArray();
1455 unsigned SPTag = SPTy.getTag();
1456 if (SPTag == dwarf::DW_TAG_subroutine_type)
1457 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1458 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001459 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattnerd38fee82010-04-05 00:13:49 +00001460 addType(Arg, ATy);
1461 if (ATy.isArtificial())
1462 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1463 SPDie->addChild(Arg);
1464 }
1465 DIE *SPDeclDie = SPDie;
1466 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001467 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Chris Lattnerd38fee82010-04-05 00:13:49 +00001468 SPDeclDie);
Devang Patel163a9f72010-05-10 22:49:55 +00001469 SPCU->addDie(SPDie);
Chris Lattnerd38fee82010-04-05 00:13:49 +00001470 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00001471
Devang Patel8aa61472010-07-07 22:20:57 +00001472 // Pick up abstract subprogram DIE.
1473 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
1474 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1475 addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
1476 dwarf::DW_FORM_ref4, AbsSPDIE);
1477 SPCU->addDie(SPDie);
1478 }
1479
Chris Lattnerd38fee82010-04-05 00:13:49 +00001480 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1481 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1482 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1483 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1484 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1485 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1486 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +00001487
Chris Lattnerd38fee82010-04-05 00:13:49 +00001488 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +00001489}
1490
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001491/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel2c4ceb12009-11-21 02:48:08 +00001492/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1493DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001494
1495 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1496 if (Scope->isAbstractScope())
1497 return ScopeDIE;
1498
1499 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1500 if (Ranges.empty())
1501 return 0;
1502
1503 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1504 if (Ranges.size() > 1) {
1505 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbach1e20b962010-07-21 21:21:52 +00001506 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Pateleac9c072010-04-27 19:46:33 +00001507 // DW_AT_ranges appropriately.
1508 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1509 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1510 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1511 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +00001512 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1513 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +00001514 }
1515 DebugRangeSymbols.push_back(NULL);
1516 DebugRangeSymbols.push_back(NULL);
1517 return ScopeDIE;
1518 }
1519
Devang Patelc3f5f782010-05-25 23:40:22 +00001520 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1521 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001522
Devang Patelc3f5f782010-05-25 23:40:22 +00001523 if (End == 0) return 0;
Devang Patel53bb5c92009-11-10 23:06:00 +00001524
Chris Lattnerb7db7332010-03-09 01:58:53 +00001525 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1526 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbach1e20b962010-07-21 21:21:52 +00001527
Devang Pateleac9c072010-04-27 19:46:33 +00001528 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1529 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patel53bb5c92009-11-10 23:06:00 +00001530
1531 return ScopeDIE;
1532}
1533
Devang Patel2c4ceb12009-11-21 02:48:08 +00001534/// constructInlinedScopeDIE - This scope represents inlined body of
1535/// a function. Construct DIE to represent this concrete inlined copy
1536/// of the function.
1537DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001538
1539 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001540 assert (Ranges.empty() == false
Devang Pateleac9c072010-04-27 19:46:33 +00001541 && "DbgScope does not have instruction markers!");
1542
1543 // FIXME : .debug_inlined section specification does not clearly state how
1544 // to emit inlined scope that is split into multiple instruction ranges.
1545 // For now, use first instruction range and emit low_pc/high_pc pair and
1546 // corresponding .debug_inlined section entry for this pair.
1547 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patelc3f5f782010-05-25 23:40:22 +00001548 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1549 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001550
Devang Patel0afbf232010-07-08 22:39:20 +00001551 if (StartLabel == 0 || EndLabel == 0) {
Devang Pateleac9c072010-04-27 19:46:33 +00001552 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1553 return 0;
1554 }
Chris Lattnerb7db7332010-03-09 01:58:53 +00001555 assert(StartLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001556 "Invalid starting label for an inlined scope!");
Chris Lattnerb7db7332010-03-09 01:58:53 +00001557 assert(EndLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001558 "Invalid end label for an inlined scope!");
Devang Pateleac9c072010-04-27 19:46:33 +00001559
Devang Patel3c91b052010-03-08 20:52:55 +00001560 if (!Scope->getScopeNode())
Devang Patel0ef3fa62010-03-08 19:20:38 +00001561 return NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001562 DIScope DS(Scope->getScopeNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00001563 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1564
Devang Patel2db49d72010-05-07 18:11:54 +00001565 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel163a9f72010-05-10 22:49:55 +00001566 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1567 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001568 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel2c4ceb12009-11-21 02:48:08 +00001569 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001570 dwarf::DW_FORM_ref4, OriginDIE);
1571
Chris Lattner6ed0f902010-03-09 00:31:02 +00001572 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnerb7db7332010-03-09 01:58:53 +00001573 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patel53bb5c92009-11-10 23:06:00 +00001574
1575 InlinedSubprogramDIEs.insert(OriginDIE);
1576
1577 // Track the start label for this inlined function.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001578 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patel2db49d72010-05-07 18:11:54 +00001579 I = InlineInfo.find(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001580
1581 if (I == InlineInfo.end()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001582 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001583 ScopeDIE));
Devang Patel2db49d72010-05-07 18:11:54 +00001584 InlinedSPNodes.push_back(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001585 } else
Chris Lattner6ed0f902010-03-09 00:31:02 +00001586 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patel53bb5c92009-11-10 23:06:00 +00001587
Devang Patel53bb5c92009-11-10 23:06:00 +00001588 DILocation DL(Scope->getInlinedAt());
Devang Patel163a9f72010-05-10 22:49:55 +00001589 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001590 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +00001591
1592 return ScopeDIE;
1593}
1594
Devang Patel2c4ceb12009-11-21 02:48:08 +00001595
1596/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel8a241142009-12-09 18:24:21 +00001597DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel8bd11de2010-08-09 21:01:39 +00001598 StringRef Name = DV->getName();
Devang Patel65dbc902009-11-25 17:36:49 +00001599 if (Name.empty())
Devang Patel3fb6bd62009-11-13 02:25:26 +00001600 return NULL;
Devang Patel53bb5c92009-11-10 23:06:00 +00001601
1602 // Translate tag to proper Dwarf tag. The result variable is dropped for
1603 // now.
1604 unsigned Tag;
Devang Patel8bd11de2010-08-09 21:01:39 +00001605 switch (DV->getTag()) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001606 case dwarf::DW_TAG_return_variable:
1607 return NULL;
1608 case dwarf::DW_TAG_arg_variable:
1609 Tag = dwarf::DW_TAG_formal_parameter;
1610 break;
1611 case dwarf::DW_TAG_auto_variable: // fall thru
1612 default:
1613 Tag = dwarf::DW_TAG_variable;
1614 break;
1615 }
1616
1617 // Define variable debug information entry.
1618 DIE *VariableDie = new DIE(Tag);
1619
Devang Patel53bb5c92009-11-10 23:06:00 +00001620 DIE *AbsDIE = NULL;
Devang Patel26c1e562010-05-20 16:36:41 +00001621 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1622 V2AVI = VarToAbstractVarMap.find(DV);
1623 if (V2AVI != VarToAbstractVarMap.end())
1624 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001625
Devang Patel26c1e562010-05-20 16:36:41 +00001626 if (AbsDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001627 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001628 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001629 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001630 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel8bd11de2010-08-09 21:01:39 +00001631 addSourceLine(VariableDie, DV->getVariable());
Devang Patel53bb5c92009-11-10 23:06:00 +00001632
1633 // Add variable type.
Devang Patel8bd11de2010-08-09 21:01:39 +00001634 addType(VariableDie, DV->getType());
Devang Patel53bb5c92009-11-10 23:06:00 +00001635 }
1636
Devang Patel8bd11de2010-08-09 21:01:39 +00001637 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patelb4645642010-02-06 01:02:37 +00001638 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel3cf763d2010-09-29 23:07:21 +00001639 else if (DIVariable(DV->getVariable()).isArtificial())
1640 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelc3f5f782010-05-25 23:40:22 +00001641
1642 if (Scope->isAbstractScope()) {
1643 DV->setDIE(VariableDie);
1644 return VariableDie;
1645 }
1646
1647 // Add variable address.
1648
1649 unsigned Offset = DV->getDotDebugLocOffset();
1650 if (Offset != ~0U) {
1651 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1652 Asm->GetTempSymbol("debug_loc", Offset));
1653 DV->setDIE(VariableDie);
1654 UseDotDebugLocEntry.insert(VariableDie);
1655 return VariableDie;
1656 }
1657
1658 // Check if variable is described by a DBG_VALUE instruction.
1659 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1660 DbgVariableToDbgInstMap.find(DV);
1661 if (DVI != DbgVariableToDbgInstMap.end()) {
1662 const MachineInstr *DVInsn = DVI->second;
1663 const MCSymbol *DVLabel = findVariableLabel(DV);
1664 bool updated = false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001665 // FIXME : Handle getNumOperands != 3
Devang Patelc3f5f782010-05-25 23:40:22 +00001666 if (DVInsn->getNumOperands() == 3) {
Devang Patel0b48ead2010-08-31 22:22:42 +00001667 if (DVInsn->getOperand(0).isReg()) {
1668 const MachineOperand RegOp = DVInsn->getOperand(0);
1669 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1670 if (DVInsn->getOperand(1).isImm() &&
1671 TRI->getFrameRegister(*Asm->MF) == RegOp.getReg()) {
1672 addVariableAddress(DV, VariableDie, DVInsn->getOperand(1).getImm());
1673 updated = true;
1674 } else
1675 updated = addRegisterAddress(VariableDie, DVLabel, RegOp);
1676 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001677 else if (DVInsn->getOperand(0).isImm())
1678 updated = addConstantValue(VariableDie, DVLabel, DVInsn->getOperand(0));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001679 else if (DVInsn->getOperand(0).isFPImm())
1680 updated =
Devang Patel61409622010-07-07 20:12:52 +00001681 addConstantFPValue(VariableDie, DVLabel, DVInsn->getOperand(0));
Devang Patelc3f5f782010-05-25 23:40:22 +00001682 } else {
1683 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1684 if (Location.getReg()) {
1685 addAddress(VariableDie, dwarf::DW_AT_location, Location);
1686 if (DVLabel)
1687 addLabel(VariableDie, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr,
1688 DVLabel);
1689 updated = true;
1690 }
1691 }
1692 if (!updated) {
1693 // If variableDie is not updated then DBG_VALUE instruction does not
1694 // have valid variable info.
1695 delete VariableDie;
1696 return NULL;
1697 }
1698 DV->setDIE(VariableDie);
1699 return VariableDie;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001700 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001701
1702 // .. else use frame index, if available.
Devang Patelc3f5f782010-05-25 23:40:22 +00001703 int FI = 0;
Devang Patel9e3bd2c2010-08-31 06:11:28 +00001704 if (findVariableFrameIndex(DV, &FI))
1705 addVariableAddress(DV, VariableDie, FI);
1706
Devang Patel53bb5c92009-11-10 23:06:00 +00001707 DV->setDIE(VariableDie);
1708 return VariableDie;
1709
1710}
Devang Patel2c4ceb12009-11-21 02:48:08 +00001711
Devang Patel193f7202009-11-24 01:14:22 +00001712void DwarfDebug::addPubTypes(DISubprogram SP) {
1713 DICompositeType SPTy = SP.getType();
1714 unsigned SPTag = SPTy.getTag();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001715 if (SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel193f7202009-11-24 01:14:22 +00001716 return;
1717
1718 DIArray Args = SPTy.getTypeArray();
Devang Patel193f7202009-11-24 01:14:22 +00001719 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patel2db49d72010-05-07 18:11:54 +00001720 DIType ATy(Args.getElement(i));
Devang Patel9c004872010-05-07 21:45:47 +00001721 if (!ATy.Verify())
Devang Patel193f7202009-11-24 01:14:22 +00001722 continue;
1723 DICompositeType CATy = getDICompositeType(ATy);
Devang Patel2db49d72010-05-07 18:11:54 +00001724 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel50d80e32010-04-13 20:35:04 +00001725 && !CATy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001726 CompileUnit *TheCU = getCompileUnit(CATy);
1727 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1728 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001729 }
1730 }
1731}
1732
Devang Patel2c4ceb12009-11-21 02:48:08 +00001733/// constructScopeDIE - Construct a DIE for this scope.
1734DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3c91b052010-03-08 20:52:55 +00001735 if (!Scope || !Scope->getScopeNode())
1736 return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001737
Devang Patel3c91b052010-03-08 20:52:55 +00001738 DIScope DS(Scope->getScopeNode());
1739 DIE *ScopeDIE = NULL;
1740 if (Scope->getInlinedAt())
1741 ScopeDIE = constructInlinedScopeDIE(Scope);
1742 else if (DS.isSubprogram()) {
Devang Patel0dd45582010-06-28 20:53:04 +00001743 ProcessedSPNodes.insert(DS);
Devang Patel8aa61472010-07-07 22:20:57 +00001744 if (Scope->isAbstractScope()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001745 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patel8aa61472010-07-07 22:20:57 +00001746 // Note down abstract DIE.
1747 if (ScopeDIE)
1748 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
1749 }
Devang Patel3c91b052010-03-08 20:52:55 +00001750 else
Devang Patel2db49d72010-05-07 18:11:54 +00001751 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3c91b052010-03-08 20:52:55 +00001752 }
Devang Patelaead63c2010-03-29 22:59:58 +00001753 else
Devang Patel3c91b052010-03-08 20:52:55 +00001754 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patelaead63c2010-03-29 22:59:58 +00001755 if (!ScopeDIE) return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001756
Devang Patel53bb5c92009-11-10 23:06:00 +00001757 // Add variables to scope.
Devang Patele03161c2010-08-09 18:51:29 +00001758 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patel53bb5c92009-11-10 23:06:00 +00001759 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel8a241142009-12-09 18:24:21 +00001760 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001761 if (VariableDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001762 ScopeDIE->addChild(VariableDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001763 }
1764
1765 // Add nested scopes.
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001766 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
Devang Patel53bb5c92009-11-10 23:06:00 +00001767 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1768 // Define the Scope debug information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001769 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001770 if (NestedDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001771 ScopeDIE->addChild(NestedDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001772 }
Devang Patel193f7202009-11-24 01:14:22 +00001773
Jim Grosbach1e20b962010-07-21 21:21:52 +00001774 if (DS.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001775 addPubTypes(DISubprogram(DS));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001776
Devang Patel193f7202009-11-24 01:14:22 +00001777 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +00001778}
1779
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001780/// GetOrCreateSourceID - Look up the source id with the given directory and
1781/// source file names. If none currently exists, create a new id and insert it
1782/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1783/// maps as well.
Chris Lattner1d65ba72010-03-31 06:06:37 +00001784unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName){
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001785 unsigned DId;
Devang Patel37032352010-07-27 20:51:15 +00001786 assert (DirName.empty() == false && "Invalid directory name!");
Devang Patel2f584852010-07-24 00:53:22 +00001787
Devang Patel1905a182010-09-16 20:57:49 +00001788 // If FE did not provide a file name, then assume stdin.
1789 if (FileName.empty())
1790 return GetOrCreateSourceID(DirName, "<stdin>");
1791
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001792 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1793 if (DI != DirectoryIdMap.end()) {
1794 DId = DI->getValue();
1795 } else {
1796 DId = DirectoryNames.size() + 1;
1797 DirectoryIdMap[DirName] = DId;
1798 DirectoryNames.push_back(DirName);
1799 }
1800
1801 unsigned FId;
1802 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1803 if (FI != SourceFileIdMap.end()) {
1804 FId = FI->getValue();
1805 } else {
1806 FId = SourceFileNames.size() + 1;
1807 SourceFileIdMap[FileName] = FId;
1808 SourceFileNames.push_back(FileName);
1809 }
1810
1811 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1812 SourceIdMap.find(std::make_pair(DId, FId));
1813 if (SI != SourceIdMap.end())
1814 return SI->second;
1815
1816 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1817 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1818 SourceIds.push_back(std::make_pair(DId, FId));
1819
1820 return SrcId;
1821}
1822
Devang Patel6404e4e2009-12-15 19:16:48 +00001823/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1824DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel163a9f72010-05-10 22:49:55 +00001825 CompileUnit *TheCU = getCompileUnit(NS);
1826 DIE *NDie = TheCU->getDIE(NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001827 if (NDie)
1828 return NDie;
1829 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel163a9f72010-05-10 22:49:55 +00001830 TheCU->insertDIE(NS, NDie);
Devang Patel6404e4e2009-12-15 19:16:48 +00001831 if (!NS.getName().empty())
1832 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
Devang Patel81625742010-08-09 20:20:05 +00001833 addSourceLine(NDie, NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001834 addToContextOwner(NDie, NS.getContext());
1835 return NDie;
1836}
1837
Jim Grosbach1e20b962010-07-21 21:21:52 +00001838/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel163a9f72010-05-10 22:49:55 +00001839/// metadata node with tag DW_TAG_compile_unit.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001840void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001841 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +00001842 StringRef FN = DIUnit.getFilename();
1843 StringRef Dir = DIUnit.getDirectory();
Devang Patel5ccdd102009-09-29 18:40:58 +00001844 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001845
1846 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001847 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001848 DIUnit.getProducer());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001849 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001850 DIUnit.getLanguage());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001851 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patel5098da02010-04-26 22:54:28 +00001852 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1853 // simplifies debug range entries.
Devang Patel9b93b6b2010-06-28 22:22:47 +00001854 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Patel4a602ca2010-03-22 23:11:36 +00001855 // DW_AT_stmt_list is a offset of line number information for this
Devang Patelaf608bd2010-08-24 00:06:12 +00001856 // compile unit in debug_line section.
Devang Patelae84d5b2010-08-31 23:50:19 +00001857 if (Asm->MAI->doesDwarfUsesAbsoluteLabelForStmtList())
1858 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_addr,
1859 Asm->GetTempSymbol("section_line"));
1860 else
1861 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001862
Devang Patel65dbc902009-11-25 17:36:49 +00001863 if (!Dir.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001864 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001865 if (DIUnit.isOptimized())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001866 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001867
Devang Patel65dbc902009-11-25 17:36:49 +00001868 StringRef Flags = DIUnit.getFlags();
1869 if (!Flags.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001870 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001871
1872 unsigned RVer = DIUnit.getRunTimeVersion();
1873 if (RVer)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001874 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001875 dwarf::DW_FORM_data1, RVer);
1876
Devang Patel163a9f72010-05-10 22:49:55 +00001877 CompileUnit *NewCU = new CompileUnit(ID, Die);
1878 if (!FirstCU)
1879 FirstCU = NewCU;
1880 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001881}
1882
Devang Patel163a9f72010-05-10 22:49:55 +00001883/// getCompielUnit - Get CompileUnit DIE.
1884CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1885 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1886 DIDescriptor D(N);
1887 const MDNode *CUNode = NULL;
1888 if (D.isCompileUnit())
1889 CUNode = N;
1890 else if (D.isSubprogram())
1891 CUNode = DISubprogram(N).getCompileUnit();
1892 else if (D.isType())
1893 CUNode = DIType(N).getCompileUnit();
1894 else if (D.isGlobalVariable())
1895 CUNode = DIGlobalVariable(N).getCompileUnit();
1896 else if (D.isVariable())
1897 CUNode = DIVariable(N).getCompileUnit();
1898 else if (D.isNameSpace())
1899 CUNode = DINameSpace(N).getCompileUnit();
1900 else if (D.isFile())
1901 CUNode = DIFile(N).getCompileUnit();
1902 else
1903 return FirstCU;
1904
1905 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1906 = CUMap.find(CUNode);
1907 if (I == CUMap.end())
1908 return FirstCU;
1909 return I->second;
1910}
1911
Devang Patel0c4720c2010-08-23 18:25:56 +00001912/// isUnsignedDIType - Return true if type encoding is unsigned.
1913static bool isUnsignedDIType(DIType Ty) {
1914 DIDerivedType DTy(Ty);
1915 if (DTy.Verify())
1916 return isUnsignedDIType(DTy.getTypeDerivedFrom());
1917
1918 DIBasicType BTy(Ty);
1919 if (BTy.Verify()) {
1920 unsigned Encoding = BTy.getEncoding();
1921 if (Encoding == dwarf::DW_ATE_unsigned ||
1922 Encoding == dwarf::DW_ATE_unsigned_char)
1923 return true;
1924 }
1925 return false;
1926}
Devang Patel163a9f72010-05-10 22:49:55 +00001927
1928/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001929void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel9fa539c2010-08-10 01:37:23 +00001930 DIGlobalVariable GV(N);
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001931
Devang Patel905cf5e2009-09-04 23:59:07 +00001932 // If debug information is malformed then ignore it.
Devang Patel9fa539c2010-08-10 01:37:23 +00001933 if (GV.Verify() == false)
Devang Patel905cf5e2009-09-04 23:59:07 +00001934 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001935
1936 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00001937 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel9fa539c2010-08-10 01:37:23 +00001938 if (TheCU->getDIE(GV))
Devang Patel13e16b62009-06-26 01:49:18 +00001939 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001940
Devang Patel9fa539c2010-08-10 01:37:23 +00001941 DIType GTy = GV.getType();
Devang Patel29368072010-08-10 07:11:13 +00001942 DIE *VariableDIE = new DIE(GV.getTag());
1943
1944 bool isGlobalVariable = GV.getGlobal() != NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001945
Devang Patel9fa539c2010-08-10 01:37:23 +00001946 // Add name.
1947 addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1948 GV.getDisplayName());
1949 StringRef LinkageName = GV.getLinkageName();
Devang Patel29368072010-08-10 07:11:13 +00001950 if (!LinkageName.empty() && isGlobalVariable)
Devang Patel9fa539c2010-08-10 01:37:23 +00001951 addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
1952 getRealLinkageName(LinkageName));
1953 // Add type.
1954 addType(VariableDIE, GTy);
Devang Patel50d80e32010-04-13 20:35:04 +00001955 if (GTy.isCompositeType() && !GTy.getName().empty()
1956 && !GTy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001957 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001958 assert(Entry && "Missing global type!");
Devang Patel163a9f72010-05-10 22:49:55 +00001959 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001960 }
Devang Patel9fa539c2010-08-10 01:37:23 +00001961 // Add scoping info.
1962 if (!GV.isLocalToUnit()) {
1963 addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1964 // Expose as global.
1965 TheCU->addGlobal(GV.getName(), VariableDIE);
1966 }
1967 // Add line number info.
1968 addSourceLine(VariableDIE, GV);
1969 // Add to map.
1970 TheCU->insertDIE(N, VariableDIE);
1971 // Add to context owner.
1972 DIDescriptor GVContext = GV.getContext();
1973 addToContextOwner(VariableDIE, GVContext);
1974 // Add location.
Devang Patel29368072010-08-10 07:11:13 +00001975 if (isGlobalVariable) {
1976 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1977 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1978 addLabel(Block, 0, dwarf::DW_FORM_udata,
1979 Asm->Mang->getSymbol(GV.getGlobal()));
1980 // Do not create specification DIE if context is either compile unit
1981 // or a subprogram.
1982 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
1983 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
1984 // Create specification DIE.
1985 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1986 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1987 dwarf::DW_FORM_ref4, VariableDIE);
1988 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1989 addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1990 TheCU->addDie(VariableSpecDIE);
1991 } else {
1992 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
1993 }
1994 } else if (Constant *C = GV.getConstant()) {
1995 if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
Devang Patel0c4720c2010-08-23 18:25:56 +00001996 if (isUnsignedDIType(GTy))
Devang Patel29368072010-08-10 07:11:13 +00001997 addUInt(VariableDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
1998 CI->getZExtValue());
1999 else
2000 addSInt(VariableDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
2001 CI->getSExtValue());
Devang Patel29368072010-08-10 07:11:13 +00002002 }
Devang Patel9fa539c2010-08-10 01:37:23 +00002003 }
Devang Patel13e16b62009-06-26 01:49:18 +00002004 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002005}
2006
Devang Patel163a9f72010-05-10 22:49:55 +00002007/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00002008void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00002009 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002010
Stuart Hastings639336e2010-04-06 21:38:29 +00002011 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00002012 CompileUnit *TheCU = getCompileUnit(N);
2013 if (TheCU->getDIE(N))
Stuart Hastings639336e2010-04-06 21:38:29 +00002014 return;
2015
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002016 if (!SP.isDefinition())
2017 // This is a method declaration which will be handled while constructing
2018 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +00002019 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002020
Stuart Hastings639336e2010-04-06 21:38:29 +00002021 DIE *SubprogramDie = createSubprogramDIE(SP);
2022
2023 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +00002024 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002025
2026 // Add to context owner.
Devang Patel6404e4e2009-12-15 19:16:48 +00002027 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +00002028
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002029 // Expose as global.
Devang Patel163a9f72010-05-10 22:49:55 +00002030 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel193f7202009-11-24 01:14:22 +00002031
Devang Patel13e16b62009-06-26 01:49:18 +00002032 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002033}
2034
Devang Patel2c4ceb12009-11-21 02:48:08 +00002035/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbar00564992009-09-19 20:40:14 +00002036/// content. Create global DIEs and emit initial debug info sections.
2037/// This is inovked by the target AsmPrinter.
Chris Lattner75f50722010-04-04 07:48:20 +00002038void DwarfDebug::beginModule(Module *M) {
Devang Pateleac9c072010-04-27 19:46:33 +00002039 if (DisableDebugInfoPrinting)
2040 return;
2041
Devang Patel78ab9e22009-07-30 18:56:46 +00002042 DebugInfoFinder DbgFinder;
2043 DbgFinder.processModule(*M);
Devang Patel13e16b62009-06-26 01:49:18 +00002044
Chris Lattnerd850ac72010-04-05 02:19:28 +00002045 bool HasDebugInfo = false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002046
Chris Lattnerd850ac72010-04-05 02:19:28 +00002047 // Scan all the compile-units to see if there are any marked as the main unit.
2048 // if not, we do not generate debug info.
2049 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2050 E = DbgFinder.compile_unit_end(); I != E; ++I) {
2051 if (DICompileUnit(*I).isMain()) {
2052 HasDebugInfo = true;
2053 break;
2054 }
2055 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002056
Chris Lattnerd850ac72010-04-05 02:19:28 +00002057 if (!HasDebugInfo) return;
2058
2059 // Tell MMI that we have debug info.
2060 MMI->setDebugInfoAvailability(true);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002061
Chris Lattnerbe15beb2010-04-04 23:17:54 +00002062 // Emit initial sections.
Chris Lattnerd850ac72010-04-05 02:19:28 +00002063 EmitSectionLabels();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002064
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002065 // Create all the compile unit DIEs.
Devang Patel78ab9e22009-07-30 18:56:46 +00002066 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2067 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002068 constructCompileUnit(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002069
Devang Patel53bb5c92009-11-10 23:06:00 +00002070 // Create DIEs for each subprogram.
Devang Patel78ab9e22009-07-30 18:56:46 +00002071 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
2072 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002073 constructSubprogramDIE(*I);
Devang Patel13e16b62009-06-26 01:49:18 +00002074
Devang Patelc366f832009-12-10 19:14:49 +00002075 // Create DIEs for each global variable.
2076 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2077 E = DbgFinder.global_variable_end(); I != E; ++I)
2078 constructGlobalVariableDIE(*I);
2079
Devang Patele7e5a0f2010-08-10 20:01:20 +00002080 //getOrCreateTypeDIE
2081 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
2082 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2083 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2084
Devang Patel1a7ca032010-09-28 18:08:20 +00002085 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
2086 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2087 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2088
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002089 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +00002090 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002091
2092 // Print out .file directives to specify files for .loc directives. These are
2093 // printed out early so that they precede any .loc directives.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002094 if (Asm->MAI->hasDotLocAndDotFile()) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002095 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
2096 // Remember source id starts at 1.
2097 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
Chris Lattner0ad9c912010-01-22 22:09:00 +00002098 // FIXME: don't use sys::path for this! This should not depend on the
2099 // host.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002100 sys::Path FullPath(getSourceDirectoryName(Id.first));
2101 bool AppendOk =
2102 FullPath.appendComponent(getSourceFileName(Id.second));
2103 assert(AppendOk && "Could not append filename to directory!");
2104 AppendOk = false;
Chris Lattnera6594fc2010-01-25 18:58:59 +00002105 Asm->OutStreamer.EmitDwarfFileDirective(i, FullPath.str());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002106 }
2107 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002108}
2109
Devang Patel2c4ceb12009-11-21 02:48:08 +00002110/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002111///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002112void DwarfDebug::endModule() {
Devang Patel163a9f72010-05-10 22:49:55 +00002113 if (!FirstCU) return;
Devang Patel4a1cad62010-06-28 18:25:03 +00002114 const Module *M = MMI->getModule();
Devang Patele9a1cca2010-08-02 17:32:15 +00002115 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patel4a1cad62010-06-28 18:25:03 +00002116 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2117 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2118 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2119 DISubprogram SP(AllSPs->getOperand(SI));
2120 if (!SP.Verify()) continue;
2121
2122 // Collect info for variables that were optimized out.
Devang Patel8b3a6b62010-07-19 17:53:55 +00002123 if (!SP.isDefinition()) continue;
Devang Patel4a1cad62010-06-28 18:25:03 +00002124 StringRef FName = SP.getLinkageName();
2125 if (FName.empty())
2126 FName = SP.getName();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002127 NamedMDNode *NMD =
Devang Patel4a1cad62010-06-28 18:25:03 +00002128 M->getNamedMetadata(Twine("llvm.dbg.lv.", getRealLinkageName(FName)));
2129 if (!NMD) continue;
2130 unsigned E = NMD->getNumOperands();
2131 if (!E) continue;
2132 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Patele9a1cca2010-08-02 17:32:15 +00002133 DeadFnScopeMap[SP] = Scope;
Devang Patel4a1cad62010-06-28 18:25:03 +00002134 for (unsigned I = 0; I != E; ++I) {
2135 DIVariable DV(NMD->getOperand(I));
2136 if (!DV.Verify()) continue;
2137 Scope->addVariable(new DbgVariable(DV));
2138 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002139
Devang Patel4a1cad62010-06-28 18:25:03 +00002140 // Construct subprogram DIE and add variables DIEs.
2141 constructSubprogramDIE(SP);
2142 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patele03161c2010-08-09 18:51:29 +00002143 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patel4a1cad62010-06-28 18:25:03 +00002144 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2145 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2146 if (VariableDIE)
2147 ScopeDIE->addChild(VariableDIE);
2148 }
2149 }
2150 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002151
Devang Patel53bb5c92009-11-10 23:06:00 +00002152 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2153 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2154 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2155 DIE *ISP = *AI;
Devang Patel2c4ceb12009-11-21 02:48:08 +00002156 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +00002157 }
2158
Devang Patele9f8f5e2010-05-07 20:54:48 +00002159 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Patel5d11eb02009-12-03 19:11:07 +00002160 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2161 DIE *SPDie = CI->first;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002162 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Patel5d11eb02009-12-03 19:11:07 +00002163 if (!N) continue;
Devang Patel163a9f72010-05-10 22:49:55 +00002164 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Patel5d11eb02009-12-03 19:11:07 +00002165 if (!NDie) continue;
2166 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patel5d11eb02009-12-03 19:11:07 +00002167 }
2168
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002169 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002170 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002171 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002172 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002173 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002174
2175 // End text sections.
2176 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002177 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnerc0215722010-04-04 19:25:43 +00002178 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002179 }
2180
2181 // Emit common frame information.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002182 emitCommonDebugFrame();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002183
2184 // Emit function debug frame information
2185 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2186 E = DebugFrames.end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002187 emitFunctionDebugFrame(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002188
2189 // Compute DIE offsets and sizes.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002190 computeSizeAndOffsets();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002191
2192 // Emit all the DIEs into a debug info section
Devang Patel2c4ceb12009-11-21 02:48:08 +00002193 emitDebugInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002194
2195 // Corresponding abbreviations into a abbrev section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002196 emitAbbreviations();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002197
Devang Patelaf608bd2010-08-24 00:06:12 +00002198 // Emit source line correspondence into a debug line section.
2199 emitDebugLines();
2200
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002201 // Emit info into a debug pubnames section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002202 emitDebugPubNames();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002203
Devang Patel193f7202009-11-24 01:14:22 +00002204 // Emit info into a debug pubtypes section.
2205 emitDebugPubTypes();
2206
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002207 // Emit info into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002208 emitDebugLoc();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002209
2210 // Emit info into a debug aranges section.
2211 EmitDebugARanges();
2212
2213 // Emit info into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002214 emitDebugRanges();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002215
2216 // Emit info into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002217 emitDebugMacInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002218
2219 // Emit inline info.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002220 emitDebugInlineInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002221
Chris Lattnerbc733f52010-03-13 02:17:42 +00002222 // Emit info into a debug str section.
2223 emitDebugStr();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002224
Devang Patele9a1cca2010-08-02 17:32:15 +00002225 // clean up.
2226 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel163a9f72010-05-10 22:49:55 +00002227 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2228 E = CUMap.end(); I != E; ++I)
2229 delete I->second;
2230 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002231}
2232
Devang Patel53bb5c92009-11-10 23:06:00 +00002233/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002234DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattnerde4845c2010-04-02 19:42:39 +00002235 DebugLoc ScopeLoc) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002236
Devang Patel2db49d72010-05-07 18:11:54 +00002237 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00002238 if (AbsDbgVariable)
2239 return AbsDbgVariable;
2240
Devang Patel2db49d72010-05-07 18:11:54 +00002241 LLVMContext &Ctx = Var->getContext();
Chris Lattnerde4845c2010-04-02 19:42:39 +00002242 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00002243 if (!Scope)
2244 return NULL;
2245
Devang Patel26c1e562010-05-20 16:36:41 +00002246 AbsDbgVariable = new DbgVariable(Var);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002247 Scope->addVariable(AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00002248 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00002249 return AbsDbgVariable;
2250}
2251
Devang Patelee432862010-05-20 19:57:06 +00002252/// collectVariableInfoFromMMITable - Collect variable information from
2253/// side table maintained by MMI.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002254void
Devang Patelee432862010-05-20 19:57:06 +00002255DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2256 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00002257 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patele717faa2009-10-06 01:26:37 +00002258 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2259 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2260 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00002261 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00002262 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00002263 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002264 DIVariable DV(Var);
2265 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00002266
Chris Lattnerde4845c2010-04-02 19:42:39 +00002267 DbgScope *Scope = 0;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002268 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattnerde4845c2010-04-02 19:42:39 +00002269 Scope = ConcreteScopes.lookup(IA);
2270 if (Scope == 0)
2271 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002272
Devang Patelfb0ee432009-11-10 23:20:04 +00002273 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00002274 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00002275 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00002276
Devang Patel26c1e562010-05-20 16:36:41 +00002277 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2278 DbgVariable *RegVar = new DbgVariable(DV);
2279 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002280 Scope->addVariable(RegVar);
Devang Patel26c1e562010-05-20 16:36:41 +00002281 if (AbsDbgVariable) {
2282 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2283 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2284 }
Devang Patele717faa2009-10-06 01:26:37 +00002285 }
Devang Patelee432862010-05-20 19:57:06 +00002286}
Devang Patel90a48ad2010-03-15 18:33:46 +00002287
Jim Grosbach1e20b962010-07-21 21:21:52 +00002288/// isDbgValueInUndefinedReg - Return true if debug value, encoded by
Devang Patelc3f5f782010-05-25 23:40:22 +00002289/// DBG_VALUE instruction, is in undefined reg.
2290static bool isDbgValueInUndefinedReg(const MachineInstr *MI) {
2291 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2292 if (MI->getOperand(0).isReg() && !MI->getOperand(0).getReg())
2293 return true;
2294 return false;
2295}
2296
Jim Grosbach1e20b962010-07-21 21:21:52 +00002297/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patelc3f5f782010-05-25 23:40:22 +00002298/// DBG_VALUE instruction, is in a defined reg.
2299static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2300 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2301 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2302 return true;
2303 return false;
2304}
2305
Devang Patelee432862010-05-20 19:57:06 +00002306/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002307void
Devang Patel78e127d2010-06-25 22:07:34 +00002308DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2309 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002310
Devang Patelee432862010-05-20 19:57:06 +00002311 /// collection info from MMI table.
2312 collectVariableInfoFromMMITable(MF, Processed);
2313
2314 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patel90a48ad2010-03-15 18:33:46 +00002315 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002316 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelee432862010-05-20 19:57:06 +00002317 I != E; ++I)
Devang Patel90a48ad2010-03-15 18:33:46 +00002318 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2319 II != IE; ++II) {
2320 const MachineInstr *MInsn = II;
Devang Patelc3f5f782010-05-25 23:40:22 +00002321 if (!MInsn->isDebugValue() || isDbgValueInUndefinedReg(MInsn))
Devang Patel90a48ad2010-03-15 18:33:46 +00002322 continue;
Devang Patelee432862010-05-20 19:57:06 +00002323 DbgValues.push_back(MInsn);
2324 }
Devang Patel90a48ad2010-03-15 18:33:46 +00002325
Devang Patelc3f5f782010-05-25 23:40:22 +00002326 // This is a collection of DBV_VALUE instructions describing same variable.
2327 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patelee432862010-05-20 19:57:06 +00002328 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2329 E = DbgValues.end(); I != E; ++I) {
2330 const MachineInstr *MInsn = *I;
Devang Patelc3f5f782010-05-25 23:40:22 +00002331 MultipleValues.clear();
2332 if (isDbgValueInDefinedReg(MInsn))
2333 MultipleValues.push_back(MInsn);
Devang Patelee432862010-05-20 19:57:06 +00002334 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2335 if (Processed.count(DV) != 0)
2336 continue;
2337
Devang Patel354eb7e2010-06-02 19:05:13 +00002338 const MachineInstr *PrevMI = MInsn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002339 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
Devang Patelc3f5f782010-05-25 23:40:22 +00002340 ME = DbgValues.end(); MI != ME; ++MI) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002341 const MDNode *Var =
Devang Patelc3f5f782010-05-25 23:40:22 +00002342 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002343 if (Var == DV && isDbgValueInDefinedReg(*MI) &&
Devang Patel354eb7e2010-06-02 19:05:13 +00002344 !PrevMI->isIdenticalTo(*MI))
Devang Patelc3f5f782010-05-25 23:40:22 +00002345 MultipleValues.push_back(*MI);
Devang Patel354eb7e2010-06-02 19:05:13 +00002346 PrevMI = *MI;
Devang Patelc3f5f782010-05-25 23:40:22 +00002347 }
2348
Devang Patelee432862010-05-20 19:57:06 +00002349 DbgScope *Scope = findDbgScope(MInsn);
Devang Pateld8720f42010-05-27 20:25:04 +00002350 bool CurFnArg = false;
2351 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2352 DISubprogram(DV.getContext()).describes(MF->getFunction()))
2353 CurFnArg = true;
2354 if (!Scope && CurFnArg)
Devang Patelc0c5a262010-05-21 00:10:20 +00002355 Scope = CurrentFnDbgScope;
Devang Patelee432862010-05-20 19:57:06 +00002356 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00002357 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00002358 continue;
2359
2360 Processed.insert(DV);
Devang Patelee432862010-05-20 19:57:06 +00002361 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patelee432862010-05-20 19:57:06 +00002362 Scope->addVariable(RegVar);
Devang Pateld8720f42010-05-27 20:25:04 +00002363 if (!CurFnArg)
Jim Grosbach1e20b962010-07-21 21:21:52 +00002364 DbgVariableLabelsMap[RegVar] = getLabelBeforeInsn(MInsn);
Devang Patelc0c5a262010-05-21 00:10:20 +00002365 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2366 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2367 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patel90a48ad2010-03-15 18:33:46 +00002368 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002369 if (MultipleValues.size() <= 1) {
2370 DbgVariableToDbgInstMap[RegVar] = MInsn;
2371 continue;
2372 }
2373
2374 // handle multiple DBG_VALUE instructions describing one variable.
Devang Patelc3f5f782010-05-25 23:40:22 +00002375 if (DotDebugLocEntries.empty())
Devang Patel80250682010-05-26 23:55:23 +00002376 RegVar->setDotDebugLocOffset(0);
2377 else
2378 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Devang Patele2df8422010-05-26 17:29:32 +00002379 const MachineInstr *Begin = NULL;
2380 const MachineInstr *End = NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002381 for (SmallVector<const MachineInstr *, 4>::iterator
2382 MVI = MultipleValues.begin(), MVE = MultipleValues.end();
Devang Patel61409622010-07-07 20:12:52 +00002383 MVI != MVE; ++MVI) {
Devang Patele2df8422010-05-26 17:29:32 +00002384 if (!Begin) {
2385 Begin = *MVI;
2386 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002387 }
Devang Patele2df8422010-05-26 17:29:32 +00002388 End = *MVI;
Devang Patelc3f5f782010-05-25 23:40:22 +00002389 MachineLocation MLoc;
Devang Patelb2cf5812010-08-04 18:40:52 +00002390 if (Begin->getNumOperands() == 3) {
2391 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2392 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2393 } else
2394 MLoc = Asm->getDebugValueLocation(Begin);
2395
Devang Patele2df8422010-05-26 17:29:32 +00002396 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2397 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patel5573a7d2010-08-04 22:07:27 +00002398 if (MLoc.getReg())
2399 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
2400
Devang Patele2df8422010-05-26 17:29:32 +00002401 Begin = End;
2402 if (MVI + 1 == MVE) {
2403 // If End is the last instruction then its value is valid
Devang Patelc3f5f782010-05-25 23:40:22 +00002404 // until the end of the funtion.
Devang Patelb2cf5812010-08-04 18:40:52 +00002405 MachineLocation EMLoc;
2406 if (End->getNumOperands() == 3) {
2407 if (End->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2408 EMLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2409 } else
2410 EMLoc = Asm->getDebugValueLocation(End);
Devang Patel5573a7d2010-08-04 22:07:27 +00002411 if (EMLoc.getReg())
2412 DotDebugLocEntries.
2413 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, EMLoc));
Devang Patelc3f5f782010-05-25 23:40:22 +00002414 }
2415 }
2416 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00002417 }
Devang Patel98e1cac2010-05-14 21:01:35 +00002418
2419 // Collect info for variables that were optimized out.
Devang Pateld1bbc6b2010-06-22 01:01:58 +00002420 const Function *F = MF->getFunction();
2421 const Module *M = F->getParent();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002422 if (NamedMDNode *NMD =
2423 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patela762b092010-06-22 01:19:38 +00002424 getRealLinkageName(F->getName())))) {
Devang Patel98e1cac2010-05-14 21:01:35 +00002425 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman872814a2010-07-21 18:54:18 +00002426 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patelee432862010-05-20 19:57:06 +00002427 if (!DV || !Processed.insert(DV))
Devang Patel98e1cac2010-05-14 21:01:35 +00002428 continue;
2429 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2430 if (Scope)
Devang Patel26c1e562010-05-20 16:36:41 +00002431 Scope->addVariable(new DbgVariable(DV));
Devang Patel98e1cac2010-05-14 21:01:35 +00002432 }
2433 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002434}
Devang Patel98e1cac2010-05-14 21:01:35 +00002435
Devang Patelc3f5f782010-05-25 23:40:22 +00002436/// getLabelBeforeInsn - Return Label preceding the instruction.
2437const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2438 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2439 LabelsBeforeInsn.find(MI);
2440 if (I == LabelsBeforeInsn.end())
2441 // FunctionBeginSym always preceeds all the instruction in current function.
2442 return FunctionBeginSym;
2443 return I->second;
2444}
2445
2446/// getLabelAfterInsn - Return Label immediately following the instruction.
2447const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2448 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2449 LabelsAfterInsn.find(MI);
2450 if (I == LabelsAfterInsn.end())
2451 return NULL;
2452 return I->second;
Devang Patele717faa2009-10-06 01:26:37 +00002453}
2454
Devang Patel553881b2010-03-29 17:20:31 +00002455/// beginScope - Process beginning of a scope.
2456void DwarfDebug::beginScope(const MachineInstr *MI) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002457 if (InsnNeedsLabel.count(MI) == 0) {
2458 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patel553881b2010-03-29 17:20:31 +00002459 return;
Devang Patelc3f5f782010-05-25 23:40:22 +00002460 }
Devang Patelaead63c2010-03-29 22:59:58 +00002461
Devang Patelb2b31a62010-05-26 19:37:24 +00002462 // Check location.
2463 DebugLoc DL = MI->getDebugLoc();
2464 if (!DL.isUnknown()) {
2465 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2466 PrevLabel = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
Devang Pateleac9c072010-04-27 19:46:33 +00002467 PrevInstLoc = DL;
Devang Patelb2b31a62010-05-26 19:37:24 +00002468 LabelsBeforeInsn[MI] = PrevLabel;
2469 return;
Devang Pateleac9c072010-04-27 19:46:33 +00002470 }
Devang Patel553881b2010-03-29 17:20:31 +00002471
Jim Grosbach1e20b962010-07-21 21:21:52 +00002472 // If location is unknown then use temp label for this DBG_VALUE
Devang Patelb2b31a62010-05-26 19:37:24 +00002473 // instruction.
2474 if (MI->isDebugValue()) {
Devang Patel77051f52010-05-26 21:23:46 +00002475 PrevLabel = MMI->getContext().CreateTempSymbol();
2476 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00002477 LabelsBeforeInsn[MI] = PrevLabel;
2478 return;
2479 }
2480
2481 if (UnknownLocations) {
2482 PrevLabel = recordSourceLine(0, 0, 0);
2483 LabelsBeforeInsn[MI] = PrevLabel;
2484 return;
2485 }
2486
2487 assert (0 && "Instruction is not processed!");
Devang Patel0d20ac82009-10-06 01:50:42 +00002488}
2489
Devang Patel2c4ceb12009-11-21 02:48:08 +00002490/// endScope - Process end of a scope.
2491void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel1c246352010-04-08 16:50:29 +00002492 if (InsnsEndScopeSet.count(MI) != 0) {
2493 // Emit a label if this instruction ends a scope.
2494 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2495 Asm->OutStreamer.EmitLabel(Label);
Devang Pateleac9c072010-04-27 19:46:33 +00002496 LabelsAfterInsn[MI] = Label;
Devang Patel1c246352010-04-08 16:50:29 +00002497 }
Devang Patel53bb5c92009-11-10 23:06:00 +00002498}
2499
Devang Pateleac9c072010-04-27 19:46:33 +00002500/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002501DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel61409622010-07-07 20:12:52 +00002502 const MDNode *InlinedAt) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002503 if (!InlinedAt) {
2504 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2505 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002506 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002507 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2508 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Pateleac9c072010-04-27 19:46:33 +00002509 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002510 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002511 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Pateleac9c072010-04-27 19:46:33 +00002512 WScope->setParent(Parent);
2513 Parent->addScope(WScope);
2514 }
2515
2516 if (!WScope->getParent()) {
2517 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastingscad22ad2010-06-15 23:06:30 +00002518 // We used to check only for a linkage name, but that fails
2519 // since we began omitting the linkage name for private
2520 // functions. The new way is to check for the name in metadata,
2521 // but that's not supported in old .ll test cases. Ergo, we
2522 // check both.
Stuart Hastings215aa152010-06-11 20:08:44 +00002523 if (SPName == Asm->MF->getFunction()->getName() ||
2524 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Pateleac9c072010-04-27 19:46:33 +00002525 CurrentFnDbgScope = WScope;
2526 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002527
Devang Pateleac9c072010-04-27 19:46:33 +00002528 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002529 }
2530
Devang Patel78e127d2010-06-25 22:07:34 +00002531 getOrCreateAbstractScope(Scope);
Devang Patel53bb5c92009-11-10 23:06:00 +00002532 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2533 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002534 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002535
2536 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2537 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2538 DILocation DL(InlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002539 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002540 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Pateleac9c072010-04-27 19:46:33 +00002541 WScope->setParent(Parent);
2542 Parent->addScope(WScope);
2543
2544 ConcreteScopes[InlinedAt] = WScope;
Devang Pateleac9c072010-04-27 19:46:33 +00002545
2546 return WScope;
Devang Patel0d20ac82009-10-06 01:50:42 +00002547}
2548
Devang Pateleac9c072010-04-27 19:46:33 +00002549/// hasValidLocation - Return true if debug location entry attached with
2550/// machine instruction encodes valid location info.
2551static bool hasValidLocation(LLVMContext &Ctx,
2552 const MachineInstr *MInsn,
Devang Patele9f8f5e2010-05-07 20:54:48 +00002553 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Pateleac9c072010-04-27 19:46:33 +00002554 DebugLoc DL = MInsn->getDebugLoc();
2555 if (DL.isUnknown()) return false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002556
Devang Patele9f8f5e2010-05-07 20:54:48 +00002557 const MDNode *S = DL.getScope(Ctx);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002558
Devang Pateleac9c072010-04-27 19:46:33 +00002559 // There is no need to create another DIE for compile unit. For all
2560 // other scopes, create one DbgScope now. This will be translated
2561 // into a scope DIE at the end.
2562 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002563
Devang Pateleac9c072010-04-27 19:46:33 +00002564 Scope = S;
2565 InlinedAt = DL.getInlinedAt(Ctx);
2566 return true;
2567}
2568
2569/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2570/// hierarchy.
2571static void calculateDominanceGraph(DbgScope *Scope) {
2572 assert (Scope && "Unable to calculate scop edominance graph!");
2573 SmallVector<DbgScope *, 4> WorkStack;
2574 WorkStack.push_back(Scope);
2575 unsigned Counter = 0;
2576 while (!WorkStack.empty()) {
2577 DbgScope *WS = WorkStack.back();
2578 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2579 bool visitedChildren = false;
2580 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2581 SE = Children.end(); SI != SE; ++SI) {
2582 DbgScope *ChildScope = *SI;
2583 if (!ChildScope->getDFSOut()) {
2584 WorkStack.push_back(ChildScope);
2585 visitedChildren = true;
2586 ChildScope->setDFSIn(++Counter);
2587 break;
2588 }
2589 }
2590 if (!visitedChildren) {
2591 WorkStack.pop_back();
2592 WS->setDFSOut(++Counter);
2593 }
2594 }
2595}
2596
2597/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002598static
Devang Pateleac9c072010-04-27 19:46:33 +00002599void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2600 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2601{
2602#ifndef NDEBUG
2603 unsigned PrevDFSIn = 0;
2604 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2605 I != E; ++I) {
2606 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2607 II != IE; ++II) {
2608 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002609 const MDNode *Scope = NULL;
2610 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002611
2612 // Check if instruction has valid location information.
2613 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2614 dbgs() << " [ ";
Jim Grosbach1e20b962010-07-21 21:21:52 +00002615 if (InlinedAt)
Devang Pateleac9c072010-04-27 19:46:33 +00002616 dbgs() << "*";
Jim Grosbach1e20b962010-07-21 21:21:52 +00002617 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Pateleac9c072010-04-27 19:46:33 +00002618 MI2ScopeMap.find(MInsn);
2619 if (DI != MI2ScopeMap.end()) {
2620 DbgScope *S = DI->second;
2621 dbgs() << S->getDFSIn();
2622 PrevDFSIn = S->getDFSIn();
2623 } else
2624 dbgs() << PrevDFSIn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002625 } else
Devang Pateleac9c072010-04-27 19:46:33 +00002626 dbgs() << " [ x" << PrevDFSIn;
2627 dbgs() << " ]";
2628 MInsn->dump();
2629 }
2630 dbgs() << "\n";
2631 }
2632#endif
2633}
Devang Patel2c4ceb12009-11-21 02:48:08 +00002634/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner14d750d2010-03-31 05:39:57 +00002635/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattnereec791a2010-01-26 23:18:02 +00002636bool DwarfDebug::extractScopeInformation() {
Devang Patelaf9e8472009-10-01 20:31:14 +00002637 // If scope information was extracted using .dbg intrinsics then there is not
2638 // any need to extract these information by scanning each instruction.
2639 if (!DbgScopeMap.empty())
2640 return false;
2641
Dan Gohman314bf7c2010-04-23 01:18:53 +00002642 // Scan each instruction and create scopes. First build working set of scopes.
Devang Pateleac9c072010-04-27 19:46:33 +00002643 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2644 SmallVector<DbgRange, 4> MIRanges;
2645 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002646 const MDNode *PrevScope = NULL;
2647 const MDNode *PrevInlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002648 const MachineInstr *RangeBeginMI = NULL;
2649 const MachineInstr *PrevMI = NULL;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002650 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelaf9e8472009-10-01 20:31:14 +00002651 I != E; ++I) {
2652 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2653 II != IE; ++II) {
2654 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002655 const MDNode *Scope = NULL;
2656 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002657
2658 // Check if instruction has valid location information.
2659 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2660 PrevMI = MInsn;
2661 continue;
2662 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002663
Devang Pateleac9c072010-04-27 19:46:33 +00002664 // If scope has not changed then skip this instruction.
2665 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2666 PrevMI = MInsn;
2667 continue;
2668 }
2669
Jim Grosbach1e20b962010-07-21 21:21:52 +00002670 if (RangeBeginMI) {
2671 // If we have alread seen a beginning of a instruction range and
Devang Pateleac9c072010-04-27 19:46:33 +00002672 // current instruction scope does not match scope of first instruction
2673 // in this range then create a new instruction range.
2674 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002675 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel61409622010-07-07 20:12:52 +00002676 PrevInlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002677 MIRanges.push_back(R);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002678 }
Devang Pateleac9c072010-04-27 19:46:33 +00002679
2680 // This is a beginning of a new instruction range.
2681 RangeBeginMI = MInsn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002682
Devang Pateleac9c072010-04-27 19:46:33 +00002683 // Reset previous markers.
2684 PrevMI = MInsn;
2685 PrevScope = Scope;
2686 PrevInlinedAt = InlinedAt;
Devang Patel53bb5c92009-11-10 23:06:00 +00002687 }
2688 }
2689
Devang Pateleac9c072010-04-27 19:46:33 +00002690 // Create last instruction range.
2691 if (RangeBeginMI && PrevMI && PrevScope) {
2692 DbgRange R(RangeBeginMI, PrevMI);
2693 MIRanges.push_back(R);
2694 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patelaf9e8472009-10-01 20:31:14 +00002695 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002696
Devang Patel344130e2010-01-04 20:44:00 +00002697 if (!CurrentFnDbgScope)
2698 return false;
2699
Devang Pateleac9c072010-04-27 19:46:33 +00002700 calculateDominanceGraph(CurrentFnDbgScope);
2701 if (PrintDbgScope)
2702 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2703
2704 // Find ranges of instructions covered by each DbgScope;
2705 DbgScope *PrevDbgScope = NULL;
2706 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2707 RE = MIRanges.end(); RI != RE; ++RI) {
2708 const DbgRange &R = *RI;
2709 DbgScope *S = MI2ScopeMap.lookup(R.first);
2710 assert (S && "Lost DbgScope for a machine instruction!");
2711 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2712 PrevDbgScope->closeInsnRange(S);
2713 S->openInsnRange(R.first);
2714 S->extendInsnRange(R.second);
2715 PrevDbgScope = S;
2716 }
2717
2718 if (PrevDbgScope)
2719 PrevDbgScope->closeInsnRange();
Devang Patelaf9e8472009-10-01 20:31:14 +00002720
Devang Patele37b0c62010-04-08 18:43:56 +00002721 identifyScopeMarkers();
Devang Patel6122a4d2010-04-08 15:37:09 +00002722
2723 return !DbgScopeMap.empty();
2724}
2725
Jim Grosbach1e20b962010-07-21 21:21:52 +00002726/// identifyScopeMarkers() -
Devang Pateleac9c072010-04-27 19:46:33 +00002727/// Each DbgScope has first instruction and last instruction to mark beginning
2728/// and end of a scope respectively. Create an inverse map that list scopes
2729/// starts (and ends) with an instruction. One instruction may start (or end)
2730/// multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00002731void DwarfDebug::identifyScopeMarkers() {
Devang Patel42aafd72010-01-20 02:05:23 +00002732 SmallVector<DbgScope *, 4> WorkList;
2733 WorkList.push_back(CurrentFnDbgScope);
2734 while (!WorkList.empty()) {
Chris Lattner14d750d2010-03-31 05:39:57 +00002735 DbgScope *S = WorkList.pop_back_val();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002736
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002737 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002738 if (!Children.empty())
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002739 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00002740 SE = Children.end(); SI != SE; ++SI)
2741 WorkList.push_back(*SI);
2742
Devang Patel53bb5c92009-11-10 23:06:00 +00002743 if (S->isAbstractScope())
2744 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002745
Devang Pateleac9c072010-04-27 19:46:33 +00002746 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2747 if (Ranges.empty())
2748 continue;
2749 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2750 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002751 assert(RI->first && "DbgRange does not have first instruction!");
2752 assert(RI->second && "DbgRange does not have second instruction!");
Devang Pateleac9c072010-04-27 19:46:33 +00002753 InsnsEndScopeSet.insert(RI->second);
2754 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002755 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002756}
2757
Dan Gohman084751c2010-04-20 00:37:27 +00002758/// FindFirstDebugLoc - Find the first debug location in the function. This
2759/// is intended to be an approximation for the source position of the
2760/// beginning of the function.
2761static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2762 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2763 I != E; ++I)
2764 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2765 MBBI != MBBE; ++MBBI) {
2766 DebugLoc DL = MBBI->getDebugLoc();
2767 if (!DL.isUnknown())
2768 return DL;
2769 }
2770 return DebugLoc();
2771}
2772
Devang Patel2c4ceb12009-11-21 02:48:08 +00002773/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002774/// emitted immediately after the function entry point.
Chris Lattnereec791a2010-01-26 23:18:02 +00002775void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00002776 if (!MMI->hasDebugInfo()) return;
Bill Wendling5f017e82010-04-07 09:28:04 +00002777 if (!extractScopeInformation()) return;
Devang Patel60b35bd2009-10-06 18:37:31 +00002778
Devang Pateleac9c072010-04-27 19:46:33 +00002779 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2780 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002781 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00002782 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002783
2784 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2785 // function.
Dan Gohman084751c2010-04-20 00:37:27 +00002786 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002787 if (FDL.isUnknown()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002788
Devang Patele9f8f5e2010-05-07 20:54:48 +00002789 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings0db42712010-07-19 23:56:30 +00002790 const MDNode *TheScope = 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002791
Chris Lattnerde4845c2010-04-02 19:42:39 +00002792 DISubprogram SP = getDISubprogram(Scope);
2793 unsigned Line, Col;
2794 if (SP.Verify()) {
2795 Line = SP.getLineNumber();
2796 Col = 0;
Stuart Hastings0db42712010-07-19 23:56:30 +00002797 TheScope = SP;
Chris Lattnerde4845c2010-04-02 19:42:39 +00002798 } else {
2799 Line = FDL.getLine();
2800 Col = FDL.getCol();
Stuart Hastings0db42712010-07-19 23:56:30 +00002801 TheScope = Scope;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002802 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002803
Stuart Hastings0db42712010-07-19 23:56:30 +00002804 recordSourceLine(Line, Col, TheScope);
Devang Patelb2b31a62010-05-26 19:37:24 +00002805
Devang Patelb9abe9f2010-06-02 16:42:51 +00002806 /// ProcessedArgs - Collection of arguments already processed.
2807 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2808
Devang Patelb2b31a62010-05-26 19:37:24 +00002809 DebugLoc PrevLoc;
2810 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2811 I != E; ++I)
2812 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2813 II != IE; ++II) {
2814 const MachineInstr *MI = II;
2815 DebugLoc DL = MI->getDebugLoc();
2816 if (MI->isDebugValue()) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002817 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2818 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2819 if (!DV.Verify()) continue;
Devang Patel55e97172010-05-27 16:47:30 +00002820 // If DBG_VALUE is for a local variable then it needs a label.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002821 if (DV.getTag() != dwarf::DW_TAG_arg_variable
Devang Patel7fb231c2010-07-01 21:38:08 +00002822 && isDbgValueInUndefinedReg(MI) == false)
Devang Patelb2b31a62010-05-26 19:37:24 +00002823 InsnNeedsLabel.insert(MI);
Devang Patel55e97172010-05-27 16:47:30 +00002824 // DBG_VALUE for inlined functions argument needs a label.
Devang Patel7fb231c2010-07-01 21:38:08 +00002825 else if (!DISubprogram(getDISubprogram(DV.getContext())).
2826 describes(MF->getFunction()))
Devang Patel55e97172010-05-27 16:47:30 +00002827 InsnNeedsLabel.insert(MI);
2828 // DBG_VALUE indicating argument location change needs a label.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002829 else if (isDbgValueInUndefinedReg(MI) == false
2830 && !ProcessedArgs.insert(DV))
Devang Patelb2b31a62010-05-26 19:37:24 +00002831 InsnNeedsLabel.insert(MI);
2832 } else {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002833 // If location is unknown then instruction needs a location only if
Devang Patelb2b31a62010-05-26 19:37:24 +00002834 // UnknownLocations flag is set.
2835 if (DL.isUnknown()) {
2836 if (UnknownLocations && !PrevLoc.isUnknown())
2837 InsnNeedsLabel.insert(MI);
2838 } else if (DL != PrevLoc)
2839 // Otherwise, instruction needs a location only if it is new location.
2840 InsnNeedsLabel.insert(MI);
2841 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002842
Devang Patelb2b31a62010-05-26 19:37:24 +00002843 if (!DL.isUnknown() || UnknownLocations)
2844 PrevLoc = DL;
2845 }
2846
2847 PrevLabel = FunctionBeginSym;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002848}
2849
Devang Patel2c4ceb12009-11-21 02:48:08 +00002850/// endFunction - Gather and emit post-function debug information.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002851///
Chris Lattnereec791a2010-01-26 23:18:02 +00002852void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendling5f017e82010-04-07 09:28:04 +00002853 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00002854
Devang Patel344130e2010-01-04 20:44:00 +00002855 if (CurrentFnDbgScope) {
Devang Patel65eb4822010-05-22 00:04:14 +00002856
Devang Patelc3f5f782010-05-25 23:40:22 +00002857 // Define end label for subprogram.
2858 FunctionEndSym = Asm->GetTempSymbol("func_end",
2859 Asm->getFunctionNumber());
2860 // Assumes in correct section after the entry point.
2861 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002862
Devang Patel78e127d2010-06-25 22:07:34 +00002863 SmallPtrSet<const MDNode *, 16> ProcessedVars;
2864 collectVariableInfo(MF, ProcessedVars);
Devang Patel65eb4822010-05-22 00:04:14 +00002865
Devang Patel344130e2010-01-04 20:44:00 +00002866 // Get function line info.
2867 if (!Lines.empty()) {
2868 // Get section line info.
2869 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2870 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2871 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2872 // Append the function info to section info.
2873 SectionLineInfos.insert(SectionLineInfos.end(),
2874 Lines.begin(), Lines.end());
2875 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002876
Devang Patel344130e2010-01-04 20:44:00 +00002877 // Construct abstract scopes.
2878 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel78e127d2010-06-25 22:07:34 +00002879 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel78e127d2010-06-25 22:07:34 +00002880 DISubprogram SP((*AI)->getScopeNode());
2881 if (SP.Verify()) {
2882 // Collect info for variables that were optimized out.
2883 StringRef FName = SP.getLinkageName();
2884 if (FName.empty())
2885 FName = SP.getName();
2886 const Module *M = MF->getFunction()->getParent();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002887 if (NamedMDNode *NMD =
2888 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patel78e127d2010-06-25 22:07:34 +00002889 getRealLinkageName(FName)))) {
2890 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman872814a2010-07-21 18:54:18 +00002891 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel78e127d2010-06-25 22:07:34 +00002892 if (!DV || !ProcessedVars.insert(DV))
2893 continue;
Devang Patel1d68d212010-06-30 00:11:08 +00002894 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel78e127d2010-06-25 22:07:34 +00002895 if (Scope)
2896 Scope->addVariable(new DbgVariable(DV));
2897 }
2898 }
2899 }
Devang Patel90e19aa2010-06-30 01:40:11 +00002900 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
2901 constructScopeDIE(*AI);
Devang Patel78e127d2010-06-25 22:07:34 +00002902 }
Devang Patel61409622010-07-07 20:12:52 +00002903
Devang Patel9c488372010-05-04 06:15:30 +00002904 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002905
Devang Patel9c488372010-05-04 06:15:30 +00002906 if (!DisableFramePointerElim(*MF))
Jim Grosbach1e20b962010-07-21 21:21:52 +00002907 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel9c488372010-05-04 06:15:30 +00002908 dwarf::DW_FORM_flag, 1);
2909
2910
Chris Lattnerd38fee82010-04-05 00:13:49 +00002911 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel344130e2010-01-04 20:44:00 +00002912 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002913 }
2914
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002915 // Clear debug info
Devang Patelf54b8522010-01-19 01:26:02 +00002916 CurrentFnDbgScope = NULL;
Devang Patelb2b31a62010-05-26 19:37:24 +00002917 InsnNeedsLabel.clear();
Devang Patel26c1e562010-05-20 16:36:41 +00002918 DbgVariableToFrameIndexMap.clear();
2919 VarToAbstractVarMap.clear();
2920 DbgVariableToDbgInstMap.clear();
2921 DbgVariableLabelsMap.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002922 DeleteContainerSeconds(DbgScopeMap);
Devang Patel51424712010-04-09 16:04:20 +00002923 InsnsEndScopeSet.clear();
Devang Patelf54b8522010-01-19 01:26:02 +00002924 ConcreteScopes.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002925 DeleteContainerSeconds(AbstractScopes);
Devang Patelf54b8522010-01-19 01:26:02 +00002926 AbstractScopesList.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002927 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00002928 LabelsBeforeInsn.clear();
2929 LabelsAfterInsn.clear();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002930 Lines.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00002931 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002932}
2933
Devang Patel26c1e562010-05-20 16:36:41 +00002934/// recordVariableFrameIndex - Record a variable's index.
2935void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2936 assert (V && "Invalid DbgVariable!");
2937 DbgVariableToFrameIndexMap[V] = Index;
2938}
2939
2940/// findVariableFrameIndex - Return true if frame index for the variable
2941/// is found. Update FI to hold value of the index.
2942bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
2943 assert (V && "Invalid DbgVariable!");
2944 DenseMap<const DbgVariable *, int>::iterator I =
2945 DbgVariableToFrameIndexMap.find(V);
2946 if (I == DbgVariableToFrameIndexMap.end())
2947 return false;
2948 *FI = I->second;
2949 return true;
2950}
2951
2952/// findVariableLabel - Find MCSymbol for the variable.
2953const MCSymbol *DwarfDebug::findVariableLabel(const DbgVariable *V) {
2954 DenseMap<const DbgVariable *, const MCSymbol *>::iterator I
2955 = DbgVariableLabelsMap.find(V);
2956 if (I == DbgVariableLabelsMap.end())
2957 return NULL;
2958 else return I->second;
2959}
2960
Jim Grosbach1e20b962010-07-21 21:21:52 +00002961/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patelee432862010-05-20 19:57:06 +00002962/// instruction.
2963DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
2964 DbgScope *Scope = NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002965 LLVMContext &Ctx =
Devang Patelee432862010-05-20 19:57:06 +00002966 MInsn->getParent()->getParent()->getFunction()->getContext();
2967 DebugLoc DL = MInsn->getDebugLoc();
2968
Jim Grosbach1e20b962010-07-21 21:21:52 +00002969 if (DL.isUnknown())
Devang Patelee432862010-05-20 19:57:06 +00002970 return Scope;
2971
2972 if (const MDNode *IA = DL.getInlinedAt(Ctx))
2973 Scope = ConcreteScopes.lookup(IA);
2974 if (Scope == 0)
2975 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002976
Devang Patelee432862010-05-20 19:57:06 +00002977 return Scope;
2978}
2979
2980
Chris Lattnerc6087842010-03-09 04:54:43 +00002981/// recordSourceLine - Register a source line with debug info. Returns the
2982/// unique label that was emitted and which provides correspondence to
2983/// the source line list.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002984MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel61409622010-07-07 20:12:52 +00002985 const MDNode *S) {
Devang Patel65dbc902009-11-25 17:36:49 +00002986 StringRef Dir;
2987 StringRef Fn;
Devang Patelf84548d2009-10-05 18:03:19 +00002988
Dan Gohman1cc0d622010-05-05 23:41:32 +00002989 unsigned Src = 1;
2990 if (S) {
2991 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00002992
Dan Gohman1cc0d622010-05-05 23:41:32 +00002993 if (Scope.isCompileUnit()) {
2994 DICompileUnit CU(S);
2995 Dir = CU.getDirectory();
2996 Fn = CU.getFilename();
2997 } else if (Scope.isSubprogram()) {
2998 DISubprogram SP(S);
2999 Dir = SP.getDirectory();
3000 Fn = SP.getFilename();
3001 } else if (Scope.isLexicalBlock()) {
3002 DILexicalBlock DB(S);
3003 Dir = DB.getDirectory();
3004 Fn = DB.getFilename();
3005 } else
3006 assert(0 && "Unexpected scope info");
3007
3008 Src = GetOrCreateSourceID(Dir, Fn);
3009 }
3010
Chris Lattner63d78362010-03-14 08:36:50 +00003011 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattner25b68c62010-03-14 08:15:55 +00003012 Lines.push_back(SrcLineInfo(Line, Col, Src, Label));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00003013
Chris Lattnerc6087842010-03-09 04:54:43 +00003014 Asm->OutStreamer.EmitLabel(Label);
3015 return Label;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00003016}
3017
Bill Wendling829e67b2009-05-20 23:22:40 +00003018//===----------------------------------------------------------------------===//
3019// Emit Methods
3020//===----------------------------------------------------------------------===//
3021
Devang Patel2c4ceb12009-11-21 02:48:08 +00003022/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling94d04b82009-05-20 23:21:38 +00003023///
Jim Grosbach7ab38df2009-11-22 19:20:36 +00003024unsigned
3025DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003026 // Get the children.
3027 const std::vector<DIE *> &Children = Die->getChildren();
3028
3029 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00003030 if (!Last && !Children.empty())
Benjamin Kramer345ef342010-03-31 19:34:01 +00003031 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling94d04b82009-05-20 23:21:38 +00003032
3033 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003034 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00003035
3036 // Get the abbreviation for this DIE.
3037 unsigned AbbrevNumber = Die->getAbbrevNumber();
3038 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3039
3040 // Set DIE offset
3041 Die->setOffset(Offset);
3042
3043 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00003044 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00003045
3046 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
3047 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3048
3049 // Size the DIE attribute values.
3050 for (unsigned i = 0, N = Values.size(); i < N; ++i)
3051 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00003052 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00003053
3054 // Size the DIE children if any.
3055 if (!Children.empty()) {
3056 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
3057 "Children flag not set");
3058
3059 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00003060 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling94d04b82009-05-20 23:21:38 +00003061
3062 // End of children marker.
3063 Offset += sizeof(int8_t);
3064 }
3065
3066 Die->setSize(Offset - Die->getOffset());
3067 return Offset;
3068}
3069
Devang Patel2c4ceb12009-11-21 02:48:08 +00003070/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling94d04b82009-05-20 23:21:38 +00003071///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003072void DwarfDebug::computeSizeAndOffsets() {
Devang Patel163a9f72010-05-10 22:49:55 +00003073 unsigned PrevOffset = 0;
3074 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3075 E = CUMap.end(); I != E; ++I) {
3076 // Compute size of compile unit header.
3077 static unsigned Offset = PrevOffset +
3078 sizeof(int32_t) + // Length of Compilation Unit Info
3079 sizeof(int16_t) + // DWARF version number
3080 sizeof(int32_t) + // Offset Into Abbrev. Section
3081 sizeof(int8_t); // Pointer Size (in bytes)
3082 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
3083 PrevOffset = Offset;
3084 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003085}
3086
Chris Lattner11b8f302010-04-04 23:02:02 +00003087/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3088/// temporary label to it if SymbolStem is specified.
Chris Lattner9c69e285532010-04-04 22:59:04 +00003089static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner11b8f302010-04-04 23:02:02 +00003090 const char *SymbolStem = 0) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00003091 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner11b8f302010-04-04 23:02:02 +00003092 if (!SymbolStem) return 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003093
Chris Lattner9c69e285532010-04-04 22:59:04 +00003094 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3095 Asm->OutStreamer.EmitLabel(TmpSym);
3096 return TmpSym;
3097}
3098
3099/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3100/// the start of each one.
Chris Lattnerfa070b02010-04-04 22:33:59 +00003101void DwarfDebug::EmitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003102 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003103
Bill Wendling94d04b82009-05-20 23:21:38 +00003104 // Dwarf sections base addresses.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003105 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00003106 DwarfFrameSectionSym =
3107 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3108 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003109
Jim Grosbach1e20b962010-07-21 21:21:52 +00003110 DwarfInfoSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003111 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003112 DwarfAbbrevSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003113 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner11b8f302010-04-04 23:02:02 +00003114 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003115
Chris Lattner9c69e285532010-04-04 22:59:04 +00003116 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner11b8f302010-04-04 23:02:02 +00003117 EmitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003118
Devang Patelaf608bd2010-08-24 00:06:12 +00003119 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner11b8f302010-04-04 23:02:02 +00003120 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3121 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3122 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003123 DwarfStrSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003124 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patelf2548ca2010-04-16 23:33:45 +00003125 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3126 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00003127
Devang Patelc3f5f782010-05-25 23:40:22 +00003128 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3129 "section_debug_loc");
3130
Chris Lattner9c69e285532010-04-04 22:59:04 +00003131 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattner4ad1efe2010-04-04 23:10:38 +00003132 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003133}
3134
Devang Patel2c4ceb12009-11-21 02:48:08 +00003135/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling94d04b82009-05-20 23:21:38 +00003136///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003137void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003138 // Get the abbreviation for this DIE.
3139 unsigned AbbrevNumber = Die->getAbbrevNumber();
3140 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3141
Bill Wendling94d04b82009-05-20 23:21:38 +00003142 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00003143 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00003144 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3145 Twine::utohexstr(Die->getOffset()) + ":0x" +
3146 Twine::utohexstr(Die->getSize()) + " " +
3147 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003148 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00003149
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00003150 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling94d04b82009-05-20 23:21:38 +00003151 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3152
3153 // Emit the DIE attribute values.
3154 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3155 unsigned Attr = AbbrevData[i].getAttribute();
3156 unsigned Form = AbbrevData[i].getForm();
3157 assert(Form && "Too many attributes for DIE (check abbreviation)");
3158
Chris Lattner3f53c832010-04-04 18:52:31 +00003159 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00003160 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003161
Bill Wendling94d04b82009-05-20 23:21:38 +00003162 switch (Attr) {
3163 case dwarf::DW_AT_sibling:
Devang Patel2c4ceb12009-11-21 02:48:08 +00003164 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003165 break;
3166 case dwarf::DW_AT_abstract_origin: {
3167 DIEEntry *E = cast<DIEEntry>(Values[i]);
3168 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00003169 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00003170 Asm->EmitInt32(Addr);
3171 break;
3172 }
Devang Patelf2548ca2010-04-16 23:33:45 +00003173 case dwarf::DW_AT_ranges: {
3174 // DW_AT_range Value encodes offset in debug_range section.
3175 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelb1fcfbe2010-09-02 16:43:44 +00003176
3177 if (Asm->MAI->doesDwarfUsesLabelOffsetForRanges()) {
3178 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
3179 V->getValue(),
3180 4);
3181 } else {
3182 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3183 V->getValue(),
3184 DwarfDebugRangeSectionSym,
3185 4);
3186 }
Devang Patelf2548ca2010-04-16 23:33:45 +00003187 break;
3188 }
Devang Patelc3f5f782010-05-25 23:40:22 +00003189 case dwarf::DW_AT_location: {
3190 if (UseDotDebugLocEntry.count(Die) != 0) {
3191 DIELabel *L = cast<DIELabel>(Values[i]);
3192 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
3193 } else
3194 Values[i]->EmitValue(Asm, Form);
3195 break;
3196 }
Devang Patel2a361602010-09-29 19:08:08 +00003197 case dwarf::DW_AT_accessibility: {
3198 if (Asm->isVerbose()) {
3199 DIEInteger *V = cast<DIEInteger>(Values[i]);
3200 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
3201 }
3202 Values[i]->EmitValue(Asm, Form);
3203 break;
3204 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003205 default:
3206 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003207 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00003208 break;
3209 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003210 }
3211
3212 // Emit the DIE children if any.
3213 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3214 const std::vector<DIE *> &Children = Die->getChildren();
3215
3216 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00003217 emitDIE(Children[j]);
Bill Wendling94d04b82009-05-20 23:21:38 +00003218
Chris Lattner3f53c832010-04-04 18:52:31 +00003219 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00003220 Asm->OutStreamer.AddComment("End Of Children Mark");
3221 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003222 }
3223}
3224
Devang Patel8a241142009-12-09 18:24:21 +00003225/// emitDebugInfo - Emit the debug info section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003226///
Devang Patel8a241142009-12-09 18:24:21 +00003227void DwarfDebug::emitDebugInfo() {
3228 // Start debug info section.
3229 Asm->OutStreamer.SwitchSection(
3230 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel163a9f72010-05-10 22:49:55 +00003231 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3232 E = CUMap.end(); I != E; ++I) {
3233 CompileUnit *TheCU = I->second;
3234 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00003235
Devang Patel163a9f72010-05-10 22:49:55 +00003236 // Emit the compile units header.
3237 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3238 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003239
Devang Patel163a9f72010-05-10 22:49:55 +00003240 // Emit size of content not including length itself
3241 unsigned ContentSize = Die->getSize() +
3242 sizeof(int16_t) + // DWARF version number
3243 sizeof(int32_t) + // Offset Into Abbrev. Section
3244 sizeof(int8_t) + // Pointer Size (in bytes)
3245 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003246
Devang Patel163a9f72010-05-10 22:49:55 +00003247 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3248 Asm->EmitInt32(ContentSize);
3249 Asm->OutStreamer.AddComment("DWARF version number");
3250 Asm->EmitInt16(dwarf::DWARF_VERSION);
3251 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3252 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3253 DwarfAbbrevSectionSym);
3254 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3255 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003256
Devang Patel163a9f72010-05-10 22:49:55 +00003257 emitDIE(Die);
3258 // FIXME - extra padding for gdb bug.
3259 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3260 Asm->EmitInt8(0);
3261 Asm->EmitInt8(0);
3262 Asm->EmitInt8(0);
3263 Asm->EmitInt8(0);
3264 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3265 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003266}
3267
Devang Patel2c4ceb12009-11-21 02:48:08 +00003268/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003269///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003270void DwarfDebug::emitAbbreviations() const {
Bill Wendling94d04b82009-05-20 23:21:38 +00003271 // Check to see if it is worth the effort.
3272 if (!Abbreviations.empty()) {
3273 // Start the debug abbrev section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003274 Asm->OutStreamer.SwitchSection(
3275 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003276
Chris Lattnerc0215722010-04-04 19:25:43 +00003277 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003278
3279 // For each abbrevation.
3280 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3281 // Get abbreviation data
3282 const DIEAbbrev *Abbrev = Abbreviations[i];
3283
3284 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003285 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00003286
3287 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003288 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00003289 }
3290
3291 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003292 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00003293
Chris Lattnerc0215722010-04-04 19:25:43 +00003294 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003295 }
3296}
3297
Devang Patel2c4ceb12009-11-21 02:48:08 +00003298/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling94d04b82009-05-20 23:21:38 +00003299/// the line matrix.
3300///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003301void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003302 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00003303 Asm->OutStreamer.AddComment("Extended Op");
3304 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003305
Chris Lattner233f52b2010-03-09 23:52:58 +00003306 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003307 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003308 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3309 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3310
3311 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00003312
Chris Lattnerc0215722010-04-04 19:25:43 +00003313 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003314 Asm->getTargetData().getPointerSize(),
3315 0/*AddrSpace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003316
3317 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00003318 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3319 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00003320 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00003321 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003322}
3323
Devang Patel2c4ceb12009-11-21 02:48:08 +00003324/// emitDebugLines - Emit source line information.
Bill Wendling94d04b82009-05-20 23:21:38 +00003325///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003326void DwarfDebug::emitDebugLines() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003327 // If the target is using .loc/.file, the assembler will be emitting the
3328 // .debug_line table automatically.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003329 if (Asm->MAI->hasDotLocAndDotFile())
Bill Wendling94d04b82009-05-20 23:21:38 +00003330 return;
3331
3332 // Minimum line delta, thus ranging from -10..(255-10).
3333 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
3334 // Maximum line delta, thus ranging from -10..(255-10).
3335 const int MaxLineDelta = 255 + MinLineDelta;
3336
3337 // Start the dwarf line section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003338 Asm->OutStreamer.SwitchSection(
3339 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003340
3341 // Construct the section header.
Chris Lattner233f52b2010-03-09 23:52:58 +00003342 Asm->OutStreamer.AddComment("Length of Source Line Info");
Chris Lattnera6437182010-04-04 19:58:12 +00003343 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_end"),
3344 Asm->GetTempSymbol("line_begin"), 4);
Chris Lattnerc0215722010-04-04 19:25:43 +00003345 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003346
Chris Lattner233f52b2010-03-09 23:52:58 +00003347 Asm->OutStreamer.AddComment("DWARF version number");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003348 Asm->EmitInt16(dwarf::DWARF_VERSION);
Bill Wendling94d04b82009-05-20 23:21:38 +00003349
Chris Lattner233f52b2010-03-09 23:52:58 +00003350 Asm->OutStreamer.AddComment("Prolog Length");
Chris Lattnera6437182010-04-04 19:58:12 +00003351 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_prolog_end"),
3352 Asm->GetTempSymbol("line_prolog_begin"), 4);
Chris Lattnerc0215722010-04-04 19:25:43 +00003353 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003354
Chris Lattner233f52b2010-03-09 23:52:58 +00003355 Asm->OutStreamer.AddComment("Minimum Instruction Length");
3356 Asm->EmitInt8(1);
3357 Asm->OutStreamer.AddComment("Default is_stmt_start flag");
3358 Asm->EmitInt8(1);
3359 Asm->OutStreamer.AddComment("Line Base Value (Special Opcodes)");
3360 Asm->EmitInt8(MinLineDelta);
3361 Asm->OutStreamer.AddComment("Line Range Value (Special Opcodes)");
3362 Asm->EmitInt8(MaxLineDelta);
3363 Asm->OutStreamer.AddComment("Special Opcode Base");
3364 Asm->EmitInt8(-MinLineDelta);
Bill Wendling94d04b82009-05-20 23:21:38 +00003365
3366 // Line number standard opcode encodings argument count
Chris Lattner233f52b2010-03-09 23:52:58 +00003367 Asm->OutStreamer.AddComment("DW_LNS_copy arg count");
3368 Asm->EmitInt8(0);
3369 Asm->OutStreamer.AddComment("DW_LNS_advance_pc arg count");
3370 Asm->EmitInt8(1);
3371 Asm->OutStreamer.AddComment("DW_LNS_advance_line arg count");
3372 Asm->EmitInt8(1);
3373 Asm->OutStreamer.AddComment("DW_LNS_set_file arg count");
3374 Asm->EmitInt8(1);
3375 Asm->OutStreamer.AddComment("DW_LNS_set_column arg count");
3376 Asm->EmitInt8(1);
3377 Asm->OutStreamer.AddComment("DW_LNS_negate_stmt arg count");
3378 Asm->EmitInt8(0);
3379 Asm->OutStreamer.AddComment("DW_LNS_set_basic_block arg count");
3380 Asm->EmitInt8(0);
3381 Asm->OutStreamer.AddComment("DW_LNS_const_add_pc arg count");
3382 Asm->EmitInt8(0);
3383 Asm->OutStreamer.AddComment("DW_LNS_fixed_advance_pc arg count");
3384 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003385
3386 // Emit directories.
3387 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
Chris Lattner4cf202b2010-01-23 03:11:46 +00003388 const std::string &Dir = getSourceDirectoryName(DI);
Chris Lattner3f53c832010-04-04 18:52:31 +00003389 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Directory");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003390 Asm->OutStreamer.EmitBytes(StringRef(Dir.c_str(), Dir.size()+1), 0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003391 }
3392
Chris Lattner233f52b2010-03-09 23:52:58 +00003393 Asm->OutStreamer.AddComment("End of directories");
3394 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003395
3396 // Emit files.
3397 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
3398 // Remember source id starts at 1.
3399 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
Chris Lattner4cf202b2010-01-23 03:11:46 +00003400 const std::string &FN = getSourceFileName(Id.second);
Chris Lattner3f53c832010-04-04 18:52:31 +00003401 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Source");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003402 Asm->OutStreamer.EmitBytes(StringRef(FN.c_str(), FN.size()+1), 0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003403
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003404 Asm->EmitULEB128(Id.first, "Directory #");
3405 Asm->EmitULEB128(0, "Mod date");
3406 Asm->EmitULEB128(0, "File size");
Bill Wendling94d04b82009-05-20 23:21:38 +00003407 }
3408
Chris Lattner233f52b2010-03-09 23:52:58 +00003409 Asm->OutStreamer.AddComment("End of files");
3410 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003411
Chris Lattnerc0215722010-04-04 19:25:43 +00003412 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003413
3414 // A sequence for each text section.
3415 unsigned SecSrcLinesSize = SectionSourceLines.size();
3416
3417 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
3418 // Isolate current sections line info.
3419 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
3420
Bill Wendling94d04b82009-05-20 23:21:38 +00003421 // Dwarf assumes we start with first line of first source file.
3422 unsigned Source = 1;
3423 unsigned Line = 1;
3424
3425 // Construct rows of the address, source, line, column matrix.
3426 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
3427 const SrcLineInfo &LineInfo = LineInfos[i];
Chris Lattner25b68c62010-03-14 08:15:55 +00003428 MCSymbol *Label = LineInfo.getLabel();
Chris Lattnerb9130602010-03-14 02:20:58 +00003429 if (!Label->isDefined()) continue; // Not emitted, in dead code.
Bill Wendling94d04b82009-05-20 23:21:38 +00003430
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003431 if (Asm->isVerbose()) {
Chris Lattner188a87d2010-03-10 01:04:13 +00003432 std::pair<unsigned, unsigned> SrcID =
Bill Wendling94d04b82009-05-20 23:21:38 +00003433 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner188a87d2010-03-10 01:04:13 +00003434 Asm->OutStreamer.AddComment(Twine(getSourceDirectoryName(SrcID.first)) +
Chris Lattner49f618a2010-03-10 02:29:31 +00003435 "/" +
3436 Twine(getSourceFileName(SrcID.second)) +
Chris Lattner188a87d2010-03-10 01:04:13 +00003437 ":" + Twine(LineInfo.getLine()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003438 }
3439
3440 // Define the line address.
Chris Lattner233f52b2010-03-09 23:52:58 +00003441 Asm->OutStreamer.AddComment("Extended Op");
3442 Asm->EmitInt8(0);
3443 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003444 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003445
3446 Asm->OutStreamer.AddComment("DW_LNE_set_address");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003447 Asm->EmitInt8(dwarf::DW_LNE_set_address);
Chris Lattner233f52b2010-03-09 23:52:58 +00003448
3449 Asm->OutStreamer.AddComment("Location label");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003450 Asm->OutStreamer.EmitSymbolValue(Label,
3451 Asm->getTargetData().getPointerSize(),
Chris Lattnerb9130602010-03-14 02:20:58 +00003452 0/*AddrSpace*/);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003453
Bill Wendling94d04b82009-05-20 23:21:38 +00003454 // If change of source, then switch to the new source.
3455 if (Source != LineInfo.getSourceID()) {
3456 Source = LineInfo.getSourceID();
Chris Lattner233f52b2010-03-09 23:52:58 +00003457 Asm->OutStreamer.AddComment("DW_LNS_set_file");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003458 Asm->EmitInt8(dwarf::DW_LNS_set_file);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003459 Asm->EmitULEB128(Source, "New Source");
Bill Wendling94d04b82009-05-20 23:21:38 +00003460 }
3461
3462 // If change of line.
3463 if (Line != LineInfo.getLine()) {
3464 // Determine offset.
3465 int Offset = LineInfo.getLine() - Line;
3466 int Delta = Offset - MinLineDelta;
3467
3468 // Update line.
3469 Line = LineInfo.getLine();
3470
3471 // If delta is small enough and in range...
3472 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
3473 // ... then use fast opcode.
Chris Lattner233f52b2010-03-09 23:52:58 +00003474 Asm->OutStreamer.AddComment("Line Delta");
3475 Asm->EmitInt8(Delta - MinLineDelta);
Bill Wendling94d04b82009-05-20 23:21:38 +00003476 } else {
3477 // ... otherwise use long hand.
Chris Lattner233f52b2010-03-09 23:52:58 +00003478 Asm->OutStreamer.AddComment("DW_LNS_advance_line");
Bill Wendling94d04b82009-05-20 23:21:38 +00003479 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003480 Asm->EmitSLEB128(Offset, "Line Offset");
Chris Lattner233f52b2010-03-09 23:52:58 +00003481 Asm->OutStreamer.AddComment("DW_LNS_copy");
3482 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling94d04b82009-05-20 23:21:38 +00003483 }
3484 } else {
3485 // Copy the previous row (different address or source)
Chris Lattner233f52b2010-03-09 23:52:58 +00003486 Asm->OutStreamer.AddComment("DW_LNS_copy");
3487 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling94d04b82009-05-20 23:21:38 +00003488 }
3489 }
3490
Devang Patel2c4ceb12009-11-21 02:48:08 +00003491 emitEndOfLineMatrix(j + 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003492 }
3493
3494 if (SecSrcLinesSize == 0)
3495 // Because we're emitting a debug_line section, we still need a line
3496 // table. The linker and friends expect it to exist. If there's nothing to
3497 // put into it, emit an empty table.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003498 emitEndOfLineMatrix(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003499
Chris Lattnerc0215722010-04-04 19:25:43 +00003500 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003501}
3502
Devang Patel2c4ceb12009-11-21 02:48:08 +00003503/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003504///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003505void DwarfDebug::emitCommonDebugFrame() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003506 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003507 return;
3508
Chris Lattnerd38fee82010-04-05 00:13:49 +00003509 int stackGrowth = Asm->getTargetData().getPointerSize();
3510 if (Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3511 TargetFrameInfo::StackGrowsDown)
3512 stackGrowth *= -1;
Bill Wendling94d04b82009-05-20 23:21:38 +00003513
3514 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003515 Asm->OutStreamer.SwitchSection(
3516 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003517
Chris Lattnerc0215722010-04-04 19:25:43 +00003518 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003519 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003520 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3521 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003522
Chris Lattnerc0215722010-04-04 19:25:43 +00003523 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003524 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling94d04b82009-05-20 23:21:38 +00003525 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner233f52b2010-03-09 23:52:58 +00003526 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling94d04b82009-05-20 23:21:38 +00003527 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner233f52b2010-03-09 23:52:58 +00003528 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003529 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003530 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3531 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner233f52b2010-03-09 23:52:58 +00003532 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003533 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling94d04b82009-05-20 23:21:38 +00003534 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling94d04b82009-05-20 23:21:38 +00003535
3536 std::vector<MachineMove> Moves;
3537 RI->getInitialFrameState(Moves);
3538
Chris Lattner02b86b92010-04-04 23:41:46 +00003539 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003540
Chris Lattner059ea132010-04-28 01:05:45 +00003541 Asm->EmitAlignment(2);
Chris Lattnerc0215722010-04-04 19:25:43 +00003542 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003543}
3544
Devang Patel2c4ceb12009-11-21 02:48:08 +00003545/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling94d04b82009-05-20 23:21:38 +00003546/// section.
Chris Lattner206d61e2010-03-13 07:26:18 +00003547void DwarfDebug::
3548emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003549 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003550 return;
3551
3552 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003553 Asm->OutStreamer.SwitchSection(
3554 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003555
Chris Lattner233f52b2010-03-09 23:52:58 +00003556 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner206d61e2010-03-13 07:26:18 +00003557 MCSymbol *DebugFrameBegin =
Chris Lattnerc0215722010-04-04 19:25:43 +00003558 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner206d61e2010-03-13 07:26:18 +00003559 MCSymbol *DebugFrameEnd =
Chris Lattnerc0215722010-04-04 19:25:43 +00003560 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnera6437182010-04-04 19:58:12 +00003561 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003562
Chris Lattner206d61e2010-03-13 07:26:18 +00003563 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling94d04b82009-05-20 23:21:38 +00003564
Chris Lattner233f52b2010-03-09 23:52:58 +00003565 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003566 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner6189ed12010-04-04 23:25:33 +00003567 DwarfFrameSectionSym);
Bill Wendling94d04b82009-05-20 23:21:38 +00003568
Chris Lattner233f52b2010-03-09 23:52:58 +00003569 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnerc0215722010-04-04 19:25:43 +00003570 MCSymbol *FuncBeginSym =
3571 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattnerfb658072010-03-13 07:40:56 +00003572 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattnerd38fee82010-04-05 00:13:49 +00003573 Asm->getTargetData().getPointerSize(),
3574 0/*AddrSpace*/);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003575
3576
Chris Lattner233f52b2010-03-09 23:52:58 +00003577 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnera6437182010-04-04 19:58:12 +00003578 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003579 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003580
Chris Lattner02b86b92010-04-04 23:41:46 +00003581 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003582
Chris Lattner059ea132010-04-28 01:05:45 +00003583 Asm->EmitAlignment(2);
Chris Lattner206d61e2010-03-13 07:26:18 +00003584 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling94d04b82009-05-20 23:21:38 +00003585}
3586
Devang Patel8a241142009-12-09 18:24:21 +00003587/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3588///
3589void DwarfDebug::emitDebugPubNames() {
Devang Patel163a9f72010-05-10 22:49:55 +00003590 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3591 E = CUMap.end(); I != E; ++I) {
3592 CompileUnit *TheCU = I->second;
3593 // Start the dwarf pubnames section.
3594 Asm->OutStreamer.SwitchSection(
3595 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003596
Devang Patel163a9f72010-05-10 22:49:55 +00003597 Asm->OutStreamer.AddComment("Length of Public Names Info");
3598 Asm->EmitLabelDifference(
3599 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3600 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003601
Devang Patel163a9f72010-05-10 22:49:55 +00003602 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3603 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003604
Devang Patel163a9f72010-05-10 22:49:55 +00003605 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003606 Asm->EmitInt16(dwarf::DWARF_VERSION);
3607
Devang Patel163a9f72010-05-10 22:49:55 +00003608 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003609 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel163a9f72010-05-10 22:49:55 +00003610 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003611
Devang Patel163a9f72010-05-10 22:49:55 +00003612 Asm->OutStreamer.AddComment("Compilation Unit Length");
3613 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3614 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3615 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003616
Devang Patel163a9f72010-05-10 22:49:55 +00003617 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3618 for (StringMap<DIE*>::const_iterator
3619 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3620 const char *Name = GI->getKeyData();
3621 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003622
Devang Patel163a9f72010-05-10 22:49:55 +00003623 Asm->OutStreamer.AddComment("DIE offset");
3624 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003625
Devang Patel163a9f72010-05-10 22:49:55 +00003626 if (Asm->isVerbose())
3627 Asm->OutStreamer.AddComment("External Name");
3628 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3629 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00003630
Devang Patel163a9f72010-05-10 22:49:55 +00003631 Asm->OutStreamer.AddComment("End Mark");
3632 Asm->EmitInt32(0);
3633 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3634 TheCU->getID()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003635 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003636}
3637
Devang Patel193f7202009-11-24 01:14:22 +00003638void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00003639 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3640 E = CUMap.end(); I != E; ++I) {
3641 CompileUnit *TheCU = I->second;
3642 // Start the dwarf pubnames section.
3643 Asm->OutStreamer.SwitchSection(
3644 Asm->getObjFileLowering().getDwarfPubTypesSection());
3645 Asm->OutStreamer.AddComment("Length of Public Types Info");
3646 Asm->EmitLabelDifference(
3647 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3648 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003649
Devang Patel163a9f72010-05-10 22:49:55 +00003650 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3651 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003652
Devang Patel163a9f72010-05-10 22:49:55 +00003653 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3654 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003655
Devang Patel163a9f72010-05-10 22:49:55 +00003656 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3657 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3658 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003659
Devang Patel163a9f72010-05-10 22:49:55 +00003660 Asm->OutStreamer.AddComment("Compilation Unit Length");
3661 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3662 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3663 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003664
Devang Patel163a9f72010-05-10 22:49:55 +00003665 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3666 for (StringMap<DIE*>::const_iterator
3667 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3668 const char *Name = GI->getKeyData();
3669 DIE * Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003670
Devang Patel163a9f72010-05-10 22:49:55 +00003671 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3672 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003673
Devang Patel163a9f72010-05-10 22:49:55 +00003674 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3675 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3676 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00003677
Devang Patel163a9f72010-05-10 22:49:55 +00003678 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003679 Asm->EmitInt32(0);
Devang Patel163a9f72010-05-10 22:49:55 +00003680 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3681 TheCU->getID()));
Devang Patel193f7202009-11-24 01:14:22 +00003682 }
Devang Patel193f7202009-11-24 01:14:22 +00003683}
3684
Devang Patel2c4ceb12009-11-21 02:48:08 +00003685/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003686///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003687void DwarfDebug::emitDebugStr() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003688 // Check to see if it is worth the effort.
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003689 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003690
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003691 // Start the dwarf str section.
3692 Asm->OutStreamer.SwitchSection(
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003693 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003694
Chris Lattnerbc733f52010-03-13 02:17:42 +00003695 // Get all of the string pool entries and put them in an array by their ID so
3696 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003697 SmallVector<std::pair<unsigned,
Chris Lattnerbc733f52010-03-13 02:17:42 +00003698 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003699
Chris Lattnerbc733f52010-03-13 02:17:42 +00003700 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3701 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3702 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003703
Chris Lattnerbc733f52010-03-13 02:17:42 +00003704 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003705
Chris Lattnerbc733f52010-03-13 02:17:42 +00003706 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003707 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003708 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003709
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003710 // Emit the string itself.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003711 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003712 }
3713}
3714
Devang Patel2c4ceb12009-11-21 02:48:08 +00003715/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003716///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003717void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00003718 if (DotDebugLocEntries.empty())
3719 return;
3720
Bill Wendling94d04b82009-05-20 23:21:38 +00003721 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003722 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00003723 Asm->getObjFileLowering().getDwarfLocSection());
3724 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00003725 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3726 unsigned index = 1;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003727 for (SmallVector<DotDebugLocEntry, 4>::iterator
3728 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00003729 I != E; ++I, ++index) {
Devang Patelc3f5f782010-05-25 23:40:22 +00003730 DotDebugLocEntry Entry = *I;
Devang Patelc3f5f782010-05-25 23:40:22 +00003731 if (Entry.isEmpty()) {
3732 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3733 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel80250682010-05-26 23:55:23 +00003734 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00003735 } else {
3736 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3737 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3738 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3739 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patelb2cf5812010-08-04 18:40:52 +00003740 if (int Offset = Entry.Loc.getOffset()) {
3741 // If the value is at a certain offset from frame register then
3742 // use DW_OP_fbreg.
3743 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patelc3f5f782010-05-25 23:40:22 +00003744 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patelb2cf5812010-08-04 18:40:52 +00003745 Asm->EmitInt16(1 + OffsetSize);
3746 Asm->OutStreamer.AddComment(
3747 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3748 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3749 Asm->OutStreamer.AddComment("Offset");
3750 Asm->EmitSLEB128(Offset);
Devang Patelc3f5f782010-05-25 23:40:22 +00003751 } else {
Devang Patelb2cf5812010-08-04 18:40:52 +00003752 if (Reg < 32) {
3753 Asm->OutStreamer.AddComment("Loc expr size");
3754 Asm->EmitInt16(1);
3755 Asm->OutStreamer.AddComment(
Devang Patela54e0cc2010-08-04 20:32:36 +00003756 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patelb2cf5812010-08-04 18:40:52 +00003757 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3758 } else {
3759 Asm->OutStreamer.AddComment("Loc expr size");
3760 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3761 Asm->EmitInt8(dwarf::DW_OP_regx);
3762 Asm->EmitULEB128(Reg);
3763 }
Devang Patelc3f5f782010-05-25 23:40:22 +00003764 }
3765 }
3766 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003767}
3768
3769/// EmitDebugARanges - Emit visible names into a debug aranges section.
3770///
3771void DwarfDebug::EmitDebugARanges() {
3772 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003773 Asm->OutStreamer.SwitchSection(
3774 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003775}
3776
Devang Patel2c4ceb12009-11-21 02:48:08 +00003777/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003778///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003779void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003780 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003781 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00003782 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Pateleac9c072010-04-27 19:46:33 +00003783 unsigned char Size = Asm->getTargetData().getPointerSize();
3784 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00003785 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00003786 I != E; ++I) {
3787 if (*I)
3788 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003789 else
Devang Pateleac9c072010-04-27 19:46:33 +00003790 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003791 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003792}
3793
Devang Patel2c4ceb12009-11-21 02:48:08 +00003794/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003795///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003796void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003797 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00003798 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003799 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003800 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003801 }
3802}
3803
Devang Patel2c4ceb12009-11-21 02:48:08 +00003804/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling94d04b82009-05-20 23:21:38 +00003805/// Section Header:
3806/// 1. length of section
3807/// 2. Dwarf version number
3808/// 3. address size.
3809///
3810/// Entries (one "entry" for each function that was inlined):
3811///
3812/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3813/// otherwise offset into __debug_str for regular function name.
3814/// 2. offset into __debug_str section for regular function name.
3815/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3816/// instances for the function.
3817///
3818/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3819/// inlined instance; the die_offset points to the inlined_subroutine die in the
3820/// __debug_info section, and the low_pc is the starting address for the
3821/// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003822void DwarfDebug::emitDebugInlineInfo() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003823 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003824 return;
3825
Devang Patel163a9f72010-05-10 22:49:55 +00003826 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00003827 return;
3828
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003829 Asm->OutStreamer.SwitchSection(
3830 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00003831
Chris Lattner233f52b2010-03-09 23:52:58 +00003832 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003833 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3834 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003835
Chris Lattnerc0215722010-04-04 19:25:43 +00003836 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003837
Chris Lattner233f52b2010-03-09 23:52:58 +00003838 Asm->OutStreamer.AddComment("Dwarf Version");
3839 Asm->EmitInt16(dwarf::DWARF_VERSION);
3840 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003841 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003842
Devang Patele9f8f5e2010-05-07 20:54:48 +00003843 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00003844 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00003845
Devang Patele9f8f5e2010-05-07 20:54:48 +00003846 const MDNode *Node = *I;
3847 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach7ab38df2009-11-22 19:20:36 +00003848 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00003849 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00003850 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00003851 StringRef LName = SP.getLinkageName();
3852 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00003853
Chris Lattner233f52b2010-03-09 23:52:58 +00003854 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003855 if (LName.empty()) {
3856 Asm->OutStreamer.EmitBytes(Name, 0);
3857 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003858 } else
Chris Lattner6189ed12010-04-04 23:25:33 +00003859 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3860 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00003861
Chris Lattner233f52b2010-03-09 23:52:58 +00003862 Asm->OutStreamer.AddComment("Function name");
Chris Lattner6189ed12010-04-04 23:25:33 +00003863 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003864 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00003865
Devang Patel53bb5c92009-11-10 23:06:00 +00003866 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00003867 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00003868 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00003869 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003870
Chris Lattner3f53c832010-04-04 18:52:31 +00003871 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003872 Asm->OutStreamer.EmitSymbolValue(LI->first,
3873 Asm->getTargetData().getPointerSize(),0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003874 }
3875 }
3876
Chris Lattnerc0215722010-04-04 19:25:43 +00003877 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003878}