blob: 8e3c1f12ff188341fce9e747c31809632bd621c6 [file] [log] [blame]
Bill Wendling0310d762009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Chris Lattner6cde3e62010-03-09 00:39:24 +000013
Devang Patele4b27562009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling0310d762009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner74e41f92010-04-05 05:24:55 +000016#include "DIE.h"
Bill Wendling57fbba42010-04-05 22:59:21 +000017#include "llvm/Constants.h"
Bill Wendling0310d762009-05-15 09:23:25 +000018#include "llvm/Module.h"
David Greeneb2c66fc2009-08-19 21:52:55 +000019#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling0310d762009-05-15 09:23:25 +000020#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000021#include "llvm/MC/MCAsmInfo.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000022#include "llvm/MC/MCSection.h"
Chris Lattner6c2f9e12009-08-19 05:49:37 +000023#include "llvm/MC/MCStreamer.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000024#include "llvm/MC/MCSymbol.h"
Chris Lattner45111d12010-01-16 21:57:06 +000025#include "llvm/Target/Mangler.h"
Bill Wendling0310d762009-05-15 09:23:25 +000026#include "llvm/Target/TargetData.h"
27#include "llvm/Target/TargetFrameInfo.h"
Chris Lattnerf0144122009-07-28 03:13:23 +000028#include "llvm/Target/TargetLoweringObjectFile.h"
Chris Lattner9d1c1ad2010-04-04 18:06:11 +000029#include "llvm/Target/TargetMachine.h"
Chris Lattnerf0144122009-07-28 03:13:23 +000030#include "llvm/Target/TargetRegisterInfo.h"
Devang Patel2a4a3b72010-04-19 19:14:02 +000031#include "llvm/Target/TargetOptions.h"
Chris Lattner74e41f92010-04-05 05:24:55 +000032#include "llvm/Analysis/DebugInfo.h"
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +000033#include "llvm/ADT/STLExtras.h"
Chris Lattner23132b12009-08-24 03:52:50 +000034#include "llvm/ADT/StringExtras.h"
Devang Pateleac9c072010-04-27 19:46:33 +000035#include "llvm/Support/CommandLine.h"
Daniel Dunbar6e4bdfc2009-10-13 06:47:08 +000036#include "llvm/Support/Debug.h"
37#include "llvm/Support/ErrorHandling.h"
Devang Patel3139fcf2010-01-26 21:39:14 +000038#include "llvm/Support/ValueHandle.h"
Chris Lattner0ad9c912010-01-22 22:09:00 +000039#include "llvm/Support/FormattedStream.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000040#include "llvm/Support/Timer.h"
41#include "llvm/System/Path.h"
Bill Wendling0310d762009-05-15 09:23:25 +000042using namespace llvm;
43
Devang Pateleac9c072010-04-27 19:46:33 +000044static cl::opt<bool> PrintDbgScope("print-dbgscope", cl::Hidden,
45 cl::desc("Print DbgScope information for each machine instruction"));
46
Jim Grosbach1e20b962010-07-21 21:21:52 +000047static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel61409622010-07-07 20:12:52 +000048 cl::Hidden,
Devang Pateleac9c072010-04-27 19:46:33 +000049 cl::desc("Disable debug info printing"));
50
Dan Gohman281d65d2010-05-07 01:08:53 +000051static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
52 cl::desc("Make an absense of debug location information explicit."),
53 cl::init(false));
54
Bill Wendling5f017e82010-04-07 09:28:04 +000055namespace {
56 const char *DWARFGroupName = "DWARF Emission";
57 const char *DbgTimerName = "DWARF Debug Writer";
58} // end anonymous namespace
59
Bill Wendling0310d762009-05-15 09:23:25 +000060//===----------------------------------------------------------------------===//
61
62/// Configuration values for initial hash set sizes (log2).
63///
Bill Wendling0310d762009-05-15 09:23:25 +000064static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling0310d762009-05-15 09:23:25 +000065
66namespace llvm {
67
68//===----------------------------------------------------------------------===//
69/// CompileUnit - This dwarf writer support class manages information associate
70/// with a source file.
Nick Lewycky5f9843f2009-11-17 08:11:44 +000071class CompileUnit {
Bill Wendling0310d762009-05-15 09:23:25 +000072 /// ID - File identifier for source.
73 ///
74 unsigned ID;
75
76 /// Die - Compile unit debug information entry.
77 ///
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +000078 const OwningPtr<DIE> CUDie;
Bill Wendling0310d762009-05-15 09:23:25 +000079
Jeffrey Yasskind0f393d2010-03-11 18:29:55 +000080 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
Devang Patel6f01d9c2009-11-21 00:31:03 +000081 DIE *IndexTyDie;
82
Devang Patel869aa462010-07-07 20:49:57 +000083 /// MDNodeToDieMap - Tracks the mapping of unit level debug informaton
Bill Wendling0310d762009-05-15 09:23:25 +000084 /// variables to debug information entries.
Devang Patel869aa462010-07-07 20:49:57 +000085 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
Bill Wendling0310d762009-05-15 09:23:25 +000086
Devang Patel869aa462010-07-07 20:49:57 +000087 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug informaton
Bill Wendling0310d762009-05-15 09:23:25 +000088 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patel869aa462010-07-07 20:49:57 +000089 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
Bill Wendling0310d762009-05-15 09:23:25 +000090
91 /// Globals - A map of globally visible named entities for this unit.
92 ///
93 StringMap<DIE*> Globals;
94
Devang Patel193f7202009-11-24 01:14:22 +000095 /// GlobalTypes - A map of globally visible types for this unit.
96 ///
97 StringMap<DIE*> GlobalTypes;
98
Bill Wendling0310d762009-05-15 09:23:25 +000099public:
100 CompileUnit(unsigned I, DIE *D)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000101 : ID(I), CUDie(D), IndexTyDie(0) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000102
103 // Accessors.
Devang Patel193f7202009-11-24 01:14:22 +0000104 unsigned getID() const { return ID; }
Jeffrey Yasskind0f393d2010-03-11 18:29:55 +0000105 DIE* getCUDie() const { return CUDie.get(); }
Devang Patel193f7202009-11-24 01:14:22 +0000106 const StringMap<DIE*> &getGlobals() const { return Globals; }
107 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
Bill Wendling0310d762009-05-15 09:23:25 +0000108
109 /// hasContent - Return true if this compile unit has something to write out.
110 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000111 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendling0310d762009-05-15 09:23:25 +0000112
Devang Patel2c4ceb12009-11-21 02:48:08 +0000113 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendling0310d762009-05-15 09:23:25 +0000114 ///
Benjamin Kramerbbb88db2010-03-31 20:15:45 +0000115 void addGlobal(StringRef Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling0310d762009-05-15 09:23:25 +0000116
Devang Patel193f7202009-11-24 01:14:22 +0000117 /// addGlobalType - Add a new global type to the compile unit.
118 ///
Jim Grosbach1e20b962010-07-21 21:21:52 +0000119 void addGlobalType(StringRef Name, DIE *Die) {
120 GlobalTypes[Name] = Die;
Devang Patel193f7202009-11-24 01:14:22 +0000121 }
122
Devang Patel017d1212009-11-20 21:37:22 +0000123 /// getDIE - Returns the debug information entry map slot for the
Bill Wendling0310d762009-05-15 09:23:25 +0000124 /// specified debug variable.
Devang Patel869aa462010-07-07 20:49:57 +0000125 DIE *getDIE(const MDNode *N) { return MDNodeToDieMap.lookup(N); }
Jim Grosbach31ef40e2009-11-21 23:12:12 +0000126
Devang Patel017d1212009-11-20 21:37:22 +0000127 /// insertDIE - Insert DIE into the map.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000128 void insertDIE(const MDNode *N, DIE *D) {
Devang Patel869aa462010-07-07 20:49:57 +0000129 MDNodeToDieMap.insert(std::make_pair(N, D));
Devang Patel017d1212009-11-20 21:37:22 +0000130 }
Bill Wendling0310d762009-05-15 09:23:25 +0000131
Devang Patel017d1212009-11-20 21:37:22 +0000132 /// getDIEEntry - Returns the debug information entry for the speciefied
133 /// debug variable.
Jim Grosbach1e20b962010-07-21 21:21:52 +0000134 DIEEntry *getDIEEntry(const MDNode *N) {
135 DenseMap<const MDNode *, DIEEntry *>::iterator I =
136 MDNodeToDIEEntryMap.find(N);
Devang Patel869aa462010-07-07 20:49:57 +0000137 if (I == MDNodeToDIEEntryMap.end())
Devang Patel6404e4e2009-12-15 19:16:48 +0000138 return NULL;
139 return I->second;
140 }
Devang Patel017d1212009-11-20 21:37:22 +0000141
142 /// insertDIEEntry - Insert debug information entry into the map.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000143 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
Devang Patel869aa462010-07-07 20:49:57 +0000144 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
Bill Wendling0310d762009-05-15 09:23:25 +0000145 }
146
Devang Patel2c4ceb12009-11-21 02:48:08 +0000147 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendling0310d762009-05-15 09:23:25 +0000148 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000149 void addDie(DIE *Buffer) {
150 this->CUDie->addChild(Buffer);
Bill Wendling0310d762009-05-15 09:23:25 +0000151 }
Devang Patel6f01d9c2009-11-21 00:31:03 +0000152
153 // getIndexTyDie - Get an anonymous type for index type.
154 DIE *getIndexTyDie() {
155 return IndexTyDie;
156 }
157
Jim Grosbach7ab38df2009-11-22 19:20:36 +0000158 // setIndexTyDie - Set D as anonymous type for index which can be reused
159 // later.
Devang Patel6f01d9c2009-11-21 00:31:03 +0000160 void setIndexTyDie(DIE *D) {
161 IndexTyDie = D;
162 }
163
Bill Wendling0310d762009-05-15 09:23:25 +0000164};
165
166//===----------------------------------------------------------------------===//
167/// DbgVariable - This class is used to track local variable information.
168///
Devang Patelf76a3d62009-11-16 21:53:40 +0000169class DbgVariable {
Bill Wendling0310d762009-05-15 09:23:25 +0000170 DIVariable Var; // Variable Descriptor.
Devang Patelc3f5f782010-05-25 23:40:22 +0000171 DIE *TheDIE; // Variable DIE.
172 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
Bill Wendling0310d762009-05-15 09:23:25 +0000173public:
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000174 // AbsVar may be NULL.
Devang Patelc3f5f782010-05-25 23:40:22 +0000175 DbgVariable(DIVariable V) : Var(V), TheDIE(0), DotDebugLocOffset(~0U) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000176
177 // Accessors.
Devang Patel53bb5c92009-11-10 23:06:00 +0000178 DIVariable getVariable() const { return Var; }
Devang Patel53bb5c92009-11-10 23:06:00 +0000179 void setDIE(DIE *D) { TheDIE = D; }
180 DIE *getDIE() const { return TheDIE; }
Devang Patelc3f5f782010-05-25 23:40:22 +0000181 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
182 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
Devang Patel8bd11de2010-08-09 21:01:39 +0000183 StringRef getName() const { return Var.getName(); }
184 unsigned getTag() const { return Var.getTag(); }
185 bool variableHasComplexAddress() const {
186 assert(Var.Verify() && "Invalid complex DbgVariable!");
187 return Var.hasComplexAddress();
188 }
189 bool isBlockByrefVariable() const {
190 assert(Var.Verify() && "Invalid complex DbgVariable!");
191 return Var.isBlockByrefVariable();
192 }
193 unsigned getNumAddrElements() const {
194 assert(Var.Verify() && "Invalid complex DbgVariable!");
195 return Var.getNumAddrElements();
196 }
197 uint64_t getAddrElement(unsigned i) const {
198 return Var.getAddrElement(i);
199 }
200 DIType getType() const {
201 DIType Ty = Var.getType();
202 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
203 // addresses instead.
204 if (Var.isBlockByrefVariable()) {
205 /* Byref variables, in Blocks, are declared by the programmer as
206 "SomeType VarName;", but the compiler creates a
207 __Block_byref_x_VarName struct, and gives the variable VarName
208 either the struct, or a pointer to the struct, as its type. This
209 is necessary for various behind-the-scenes things the compiler
210 needs to do with by-reference variables in blocks.
211
212 However, as far as the original *programmer* is concerned, the
213 variable should still have type 'SomeType', as originally declared.
214
215 The following function dives into the __Block_byref_x_VarName
216 struct to find the original type of the variable. This will be
217 passed back to the code generating the type for the Debug
218 Information Entry for the variable 'VarName'. 'VarName' will then
219 have the original type 'SomeType' in its debug information.
220
221 The original type 'SomeType' will be the type of the field named
222 'VarName' inside the __Block_byref_x_VarName struct.
223
224 NOTE: In order for this to not completely fail on the debugger
225 side, the Debug Information Entry for the variable VarName needs to
226 have a DW_AT_location that tells the debugger how to unwind through
227 the pointers and __Block_byref_x_VarName struct to find the actual
228 value of the variable. The function addBlockByrefType does this. */
229 DIType subType = Ty;
230 unsigned tag = Ty.getTag();
231
232 if (tag == dwarf::DW_TAG_pointer_type) {
233 DIDerivedType DTy = DIDerivedType(Ty);
234 subType = DTy.getTypeDerivedFrom();
235 }
236
237 DICompositeType blockStruct = DICompositeType(subType);
238 DIArray Elements = blockStruct.getTypeArray();
239
240 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
241 DIDescriptor Element = Elements.getElement(i);
242 DIDerivedType DT = DIDerivedType(Element);
243 if (getName() == DT.getName())
244 return (DT.getTypeDerivedFrom());
245 }
246 return Ty;
247 }
248 return Ty;
249 }
Bill Wendling0310d762009-05-15 09:23:25 +0000250};
251
252//===----------------------------------------------------------------------===//
Devang Pateleac9c072010-04-27 19:46:33 +0000253/// DbgRange - This is used to track range of instructions with identical
254/// debug info scope.
255///
256typedef std::pair<const MachineInstr *, const MachineInstr *> DbgRange;
257
258//===----------------------------------------------------------------------===//
Bill Wendling0310d762009-05-15 09:23:25 +0000259/// DbgScope - This class is used to track scope information.
260///
Devang Patelf76a3d62009-11-16 21:53:40 +0000261class DbgScope {
Bill Wendling0310d762009-05-15 09:23:25 +0000262 DbgScope *Parent; // Parent to this scope.
Jim Grosbach31ef40e2009-11-21 23:12:12 +0000263 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel3139fcf2010-01-26 21:39:14 +0000264 // Location at which this scope is inlined.
Jim Grosbach1e20b962010-07-21 21:21:52 +0000265 AssertingVH<const MDNode> InlinedAtLocation;
Devang Patel53bb5c92009-11-10 23:06:00 +0000266 bool AbstractScope; // Abstract Scope
Devang Pateld38dd112009-10-01 18:25:23 +0000267 const MachineInstr *LastInsn; // Last instruction of this scope.
268 const MachineInstr *FirstInsn; // First instruction of this scope.
Devang Pateleac9c072010-04-27 19:46:33 +0000269 unsigned DFSIn, DFSOut;
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000270 // Scopes defined in scope. Contents not owned.
271 SmallVector<DbgScope *, 4> Scopes;
272 // Variables declared in scope. Contents owned.
273 SmallVector<DbgVariable *, 8> Variables;
Devang Pateleac9c072010-04-27 19:46:33 +0000274 SmallVector<DbgRange, 4> Ranges;
Owen Anderson04c05f72009-06-24 22:53:20 +0000275 // Private state for dump()
276 mutable unsigned IndentLevel;
Bill Wendling0310d762009-05-15 09:23:25 +0000277public:
Devang Patele9f8f5e2010-05-07 20:54:48 +0000278 DbgScope(DbgScope *P, DIDescriptor D, const MDNode *I = 0)
Devang Patel53bb5c92009-11-10 23:06:00 +0000279 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Devang Pateleac9c072010-04-27 19:46:33 +0000280 LastInsn(0), FirstInsn(0),
281 DFSIn(0), DFSOut(0), IndentLevel(0) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000282 virtual ~DbgScope();
283
284 // Accessors.
285 DbgScope *getParent() const { return Parent; }
Devang Patel53bb5c92009-11-10 23:06:00 +0000286 void setParent(DbgScope *P) { Parent = P; }
Bill Wendling0310d762009-05-15 09:23:25 +0000287 DIDescriptor getDesc() const { return Desc; }
Devang Patele9f8f5e2010-05-07 20:54:48 +0000288 const MDNode *getInlinedAt() const { return InlinedAtLocation; }
289 const MDNode *getScopeNode() const { return Desc; }
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000290 const SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
Devang Patele03161c2010-08-09 18:51:29 +0000291 const SmallVector<DbgVariable *, 8> &getDbgVariables() { return Variables; }
Devang Pateleac9c072010-04-27 19:46:33 +0000292 const SmallVector<DbgRange, 4> &getRanges() { return Ranges; }
293
294 /// openInsnRange - This scope covers instruction range starting from MI.
295 void openInsnRange(const MachineInstr *MI) {
Jim Grosbach1e20b962010-07-21 21:21:52 +0000296 if (!FirstInsn)
Devang Pateleac9c072010-04-27 19:46:33 +0000297 FirstInsn = MI;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000298
Devang Pateleac9c072010-04-27 19:46:33 +0000299 if (Parent)
300 Parent->openInsnRange(MI);
301 }
302
Jim Grosbach1e20b962010-07-21 21:21:52 +0000303 /// extendInsnRange - Extend the current instruction range covered by
Devang Pateleac9c072010-04-27 19:46:33 +0000304 /// this scope.
305 void extendInsnRange(const MachineInstr *MI) {
306 assert (FirstInsn && "MI Range is not open!");
307 LastInsn = MI;
308 if (Parent)
309 Parent->extendInsnRange(MI);
310 }
311
312 /// closeInsnRange - Create a range based on FirstInsn and LastInsn collected
313 /// until now. This is used when a new scope is encountered while walking
314 /// machine instructions.
315 void closeInsnRange(DbgScope *NewScope = NULL) {
316 assert (LastInsn && "Last insn missing!");
317 Ranges.push_back(DbgRange(FirstInsn, LastInsn));
Jim Grosbach1e20b962010-07-21 21:21:52 +0000318 FirstInsn = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +0000319 LastInsn = NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000320 // If Parent dominates NewScope then do not close Parent's instruction
Devang Pateleac9c072010-04-27 19:46:33 +0000321 // range.
322 if (Parent && (!NewScope || !Parent->dominates(NewScope)))
323 Parent->closeInsnRange(NewScope);
324 }
325
Devang Patel53bb5c92009-11-10 23:06:00 +0000326 void setAbstractScope() { AbstractScope = true; }
327 bool isAbstractScope() const { return AbstractScope; }
Devang Pateleac9c072010-04-27 19:46:33 +0000328
329 // Depth First Search support to walk and mainpluate DbgScope hierarchy.
330 unsigned getDFSOut() const { return DFSOut; }
331 void setDFSOut(unsigned O) { DFSOut = O; }
332 unsigned getDFSIn() const { return DFSIn; }
333 void setDFSIn(unsigned I) { DFSIn = I; }
334 bool dominates(const DbgScope *S) {
Jim Grosbach1e20b962010-07-21 21:21:52 +0000335 if (S == this)
Devang Pateleac9c072010-04-27 19:46:33 +0000336 return true;
337 if (DFSIn < S->getDFSIn() && DFSOut > S->getDFSOut())
338 return true;
339 return false;
340 }
Devang Patel53bb5c92009-11-10 23:06:00 +0000341
Devang Patel2c4ceb12009-11-21 02:48:08 +0000342 /// addScope - Add a scope to the scope.
Bill Wendling0310d762009-05-15 09:23:25 +0000343 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000344 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendling0310d762009-05-15 09:23:25 +0000345
Devang Patel2c4ceb12009-11-21 02:48:08 +0000346 /// addVariable - Add a variable to the scope.
Bill Wendling0310d762009-05-15 09:23:25 +0000347 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000348 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendling0310d762009-05-15 09:23:25 +0000349
Bill Wendling0310d762009-05-15 09:23:25 +0000350#ifndef NDEBUG
351 void dump() const;
352#endif
353};
Devang Pateleac9c072010-04-27 19:46:33 +0000354
Chris Lattnerea761862010-04-05 04:09:20 +0000355} // end llvm namespace
Bill Wendling0310d762009-05-15 09:23:25 +0000356
357#ifndef NDEBUG
358void DbgScope::dump() const {
David Greenef83adbc2009-12-24 00:31:35 +0000359 raw_ostream &err = dbgs();
Chris Lattnerc281de12009-08-23 00:51:00 +0000360 err.indent(IndentLevel);
Devang Patele9f8f5e2010-05-07 20:54:48 +0000361 const MDNode *N = Desc;
Devang Patel53bb5c92009-11-10 23:06:00 +0000362 N->dump();
Devang Patel53bb5c92009-11-10 23:06:00 +0000363 if (AbstractScope)
364 err << "Abstract Scope\n";
Bill Wendling0310d762009-05-15 09:23:25 +0000365
366 IndentLevel += 2;
Devang Patel53bb5c92009-11-10 23:06:00 +0000367 if (!Scopes.empty())
368 err << "Children ...\n";
Bill Wendling0310d762009-05-15 09:23:25 +0000369 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
370 if (Scopes[i] != this)
371 Scopes[i]->dump();
372
373 IndentLevel -= 2;
374}
375#endif
376
Bill Wendling0310d762009-05-15 09:23:25 +0000377DbgScope::~DbgScope() {
Bill Wendling0310d762009-05-15 09:23:25 +0000378 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
379 delete Variables[j];
Bill Wendling0310d762009-05-15 09:23:25 +0000380}
381
Chris Lattner49cd6642010-04-05 05:11:15 +0000382DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Devang Patel163a9f72010-05-10 22:49:55 +0000383 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbach1e20b962010-07-21 21:21:52 +0000384 AbbreviationsSet(InitAbbreviationsSetSize),
Devang Patelf2548ca2010-04-16 23:33:45 +0000385 CurrentFnDbgScope(0), PrevLabel(NULL) {
Chris Lattnerbc733f52010-03-13 02:17:42 +0000386 NextStringPoolNumber = 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000387
Chris Lattner4ad1efe2010-04-04 23:10:38 +0000388 DwarfFrameSectionSym = DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
389 DwarfStrSectionSym = TextSectionSym = 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000390 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
Devang Patelc3f5f782010-05-25 23:40:22 +0000391 FunctionBeginSym = FunctionEndSym = 0;
Devang Patelca76f6f2010-07-08 20:10:35 +0000392 DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
Dan Gohman03c3dc72010-06-18 15:56:31 +0000393 {
394 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
395 beginModule(M);
Torok Edwin9c421072010-04-07 10:44:46 +0000396 }
Bill Wendling0310d762009-05-15 09:23:25 +0000397}
398DwarfDebug::~DwarfDebug() {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000399 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
400 DIEBlocks[j]->~DIEBlock();
Bill Wendling0310d762009-05-15 09:23:25 +0000401}
402
Chris Lattnerbc733f52010-03-13 02:17:42 +0000403MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
404 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
405 if (Entry.first) return Entry.first;
406
407 Entry.second = NextStringPoolNumber++;
Chris Lattnerc0215722010-04-04 19:25:43 +0000408 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerbc733f52010-03-13 02:17:42 +0000409}
410
411
Devang Patel2c4ceb12009-11-21 02:48:08 +0000412/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling0310d762009-05-15 09:23:25 +0000413///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000414void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling0310d762009-05-15 09:23:25 +0000415 // Profile the node so that we can make it unique.
416 FoldingSetNodeID ID;
417 Abbrev.Profile(ID);
418
419 // Check the set for priors.
420 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
421
422 // If it's newly added.
423 if (InSet == &Abbrev) {
424 // Add to abbreviation list.
425 Abbreviations.push_back(&Abbrev);
426
427 // Assign the vector position + 1 as its number.
428 Abbrev.setNumber(Abbreviations.size());
429 } else {
430 // Assign existing abbreviation number.
431 Abbrev.setNumber(InSet->getNumber());
432 }
433}
434
Devang Patel2c4ceb12009-11-21 02:48:08 +0000435/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendling995f80a2009-05-20 23:24:48 +0000436/// information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000437DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000438 DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000439 return Value;
440}
441
Devang Patel2c4ceb12009-11-21 02:48:08 +0000442/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000443///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000444void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000445 unsigned Form, uint64_t Integer) {
446 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000447 DIEValue *Value = Integer == 1 ?
Devang Patelca76f6f2010-07-08 20:10:35 +0000448 DIEIntegerOne : new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000449 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000450}
451
Devang Patel2c4ceb12009-11-21 02:48:08 +0000452/// addSInt - Add an signed integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000453///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000454void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000455 unsigned Form, int64_t Integer) {
456 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000457 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000458 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000459}
460
Devang Patel69f57b12009-12-02 15:25:16 +0000461/// addString - Add a string attribute data and value. DIEString only
Jim Grosbach1e20b962010-07-21 21:21:52 +0000462/// keeps string reference.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000463void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattner4cf202b2010-01-23 03:11:46 +0000464 StringRef String) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000465 DIEValue *Value = new (DIEValueAllocator) DIEString(String);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000466 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000467}
468
Devang Patel2c4ceb12009-11-21 02:48:08 +0000469/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000470///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000471void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerb98b1bf2010-03-08 22:23:36 +0000472 const MCSymbol *Label) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000473 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000474 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000475}
476
Devang Patel2c4ceb12009-11-21 02:48:08 +0000477/// addDelta - Add a label delta attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000478///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000479void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerb98b1bf2010-03-08 22:23:36 +0000480 const MCSymbol *Hi, const MCSymbol *Lo) {
Benjamin Kramer345ef342010-03-31 19:34:01 +0000481 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000482 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000483}
484
Chris Lattner74e41f92010-04-05 05:24:55 +0000485/// addDIEEntry - Add a DIE attribute data and value.
486///
487void DwarfDebug::addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form,
488 DIE *Entry) {
489 Die->addValue(Attribute, Form, createDIEEntry(Entry));
490}
491
492
Devang Patel2c4ceb12009-11-21 02:48:08 +0000493/// addBlock - Add block data.
Bill Wendling0310d762009-05-15 09:23:25 +0000494///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000495void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000496 DIEBlock *Block) {
Chris Lattnera37d5382010-04-05 00:18:22 +0000497 Block->ComputeSize(Asm);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000498 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000499 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000500}
501
Devang Patel2c4ceb12009-11-21 02:48:08 +0000502/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000503/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000504void DwarfDebug::addSourceLine(DIE *Die, DIVariable V) {
Devang Patelc665a512010-05-07 23:33:41 +0000505 // Verify variable.
Devang Patel81625742010-08-09 20:20:05 +0000506 if (!V.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000507 return;
508
Devang Patel81625742010-08-09 20:20:05 +0000509 unsigned Line = V.getLineNumber();
510 unsigned FileID = GetOrCreateSourceID(V.getContext().getDirectory(),
511 V.getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000512 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000513 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
514 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000515}
516
Devang Patel2c4ceb12009-11-21 02:48:08 +0000517/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000518/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000519void DwarfDebug::addSourceLine(DIE *Die, DIGlobalVariable G) {
Devang Patelc665a512010-05-07 23:33:41 +0000520 // Verify global variable.
Devang Patel81625742010-08-09 20:20:05 +0000521 if (!G.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000522 return;
523
Devang Patel81625742010-08-09 20:20:05 +0000524 unsigned Line = G.getLineNumber();
525 unsigned FileID = GetOrCreateSourceID(G.getContext().getDirectory(),
526 G.getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000527 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000528 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
529 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000530}
Devang Patel82dfc0c2009-08-31 22:47:13 +0000531
Devang Patel2c4ceb12009-11-21 02:48:08 +0000532/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000533/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000534void DwarfDebug::addSourceLine(DIE *Die, DISubprogram SP) {
Devang Patelc665a512010-05-07 23:33:41 +0000535 // Verify subprogram.
Devang Patel81625742010-08-09 20:20:05 +0000536 if (!SP.Verify())
Devang Patel82dfc0c2009-08-31 22:47:13 +0000537 return;
Caroline Ticec6f9d622009-09-11 18:25:54 +0000538 // If the line number is 0, don't add it.
Devang Patel81625742010-08-09 20:20:05 +0000539 if (SP.getLineNumber() == 0)
Caroline Ticec6f9d622009-09-11 18:25:54 +0000540 return;
541
Devang Patel81625742010-08-09 20:20:05 +0000542 unsigned Line = SP.getLineNumber();
543 if (!SP.getContext().Verify())
Devang Patel77bf2952010-03-08 22:02:50 +0000544 return;
Devang Patel81625742010-08-09 20:20:05 +0000545 unsigned FileID = GetOrCreateSourceID(SP.getDirectory(),
546 SP.getFilename());
Devang Patel82dfc0c2009-08-31 22:47:13 +0000547 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000548 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
549 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patel82dfc0c2009-08-31 22:47:13 +0000550}
551
Devang Patel2c4ceb12009-11-21 02:48:08 +0000552/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000553/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000554void DwarfDebug::addSourceLine(DIE *Die, DIType Ty) {
Devang Patelc665a512010-05-07 23:33:41 +0000555 // Verify type.
Devang Patel81625742010-08-09 20:20:05 +0000556 if (!Ty.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000557 return;
558
Devang Patel81625742010-08-09 20:20:05 +0000559 unsigned Line = Ty.getLineNumber();
560 if (!Ty.getContext().Verify())
Devang Patel77bf2952010-03-08 22:02:50 +0000561 return;
Devang Patel81625742010-08-09 20:20:05 +0000562 unsigned FileID = GetOrCreateSourceID(Ty.getContext().getDirectory(),
563 Ty.getContext().getFilename());
Bill Wendling0310d762009-05-15 09:23:25 +0000564 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000565 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
566 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000567}
568
Devang Patel6404e4e2009-12-15 19:16:48 +0000569/// addSourceLine - Add location information to specified debug information
570/// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000571void DwarfDebug::addSourceLine(DIE *Die, DINameSpace NS) {
Devang Patelc665a512010-05-07 23:33:41 +0000572 // Verify namespace.
Devang Patel81625742010-08-09 20:20:05 +0000573 if (!NS.Verify())
Devang Patel6404e4e2009-12-15 19:16:48 +0000574 return;
575
Devang Patel81625742010-08-09 20:20:05 +0000576 unsigned Line = NS.getLineNumber();
577 StringRef FN = NS.getFilename();
578 StringRef Dir = NS.getDirectory();
Devang Patel6404e4e2009-12-15 19:16:48 +0000579
580 unsigned FileID = GetOrCreateSourceID(Dir, FN);
581 assert(FileID && "Invalid file id");
582 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
583 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
584}
585
Devang Patel9e3bd2c2010-08-31 06:11:28 +0000586/// addVariableAddress - Add DW_AT_location attribute for a DbgVariable based
587/// on provided frame index.
588void DwarfDebug::addVariableAddress(DbgVariable *&DV, DIE *Die, int64_t FI) {
589 MachineLocation Location;
590 unsigned FrameReg;
591 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
592 int Offset = RI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
593 Location.set(FrameReg, Offset);
594
Devang Patel8bd11de2010-08-09 21:01:39 +0000595 if (DV->variableHasComplexAddress())
596 addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
597 else if (DV->isBlockByrefVariable())
598 addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
599 else
600 addAddress(Die, dwarf::DW_AT_location, Location);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000601}
602
Devang Patel2c4ceb12009-11-21 02:48:08 +0000603/// addComplexAddress - Start with the address based on the location provided,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000604/// and generate the DWARF information necessary to find the actual variable
605/// given the extra address information encoded in the DIVariable, starting from
606/// the starting location. Add the DWARF information to the die.
607///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000608void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000609 unsigned Attribute,
610 const MachineLocation &Location) {
Devang Patel8bd11de2010-08-09 21:01:39 +0000611 DIType Ty = DV->getType();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000612
613 // Decode the original location, and use that as the start of the byref
614 // variable's location.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000615 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000616 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000617 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000618
619 if (Location.isReg()) {
620 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000621 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000622 } else {
623 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000624 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
625 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000626 }
627 } else {
628 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000629 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000630 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000631 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
632 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000633 }
634
Devang Patel2c4ceb12009-11-21 02:48:08 +0000635 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000636 }
637
Devang Patel8bd11de2010-08-09 21:01:39 +0000638 for (unsigned i = 0, N = DV->getNumAddrElements(); i < N; ++i) {
639 uint64_t Element = DV->getAddrElement(i);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000640
641 if (Element == DIFactory::OpPlus) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000642 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel8bd11de2010-08-09 21:01:39 +0000643 addUInt(Block, 0, dwarf::DW_FORM_udata, DV->getAddrElement(++i));
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000644 } else if (Element == DIFactory::OpDeref) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000645 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000646 } else llvm_unreachable("unknown DIFactory Opcode");
647 }
648
649 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000650 addBlock(Die, Attribute, 0, Block);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000651}
652
Caroline Ticedc8f6042009-08-31 21:19:37 +0000653/* Byref variables, in Blocks, are declared by the programmer as "SomeType
654 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
655 gives the variable VarName either the struct, or a pointer to the struct, as
656 its type. This is necessary for various behind-the-scenes things the
657 compiler needs to do with by-reference variables in Blocks.
658
659 However, as far as the original *programmer* is concerned, the variable
660 should still have type 'SomeType', as originally declared.
661
Devang Patel2c4ceb12009-11-21 02:48:08 +0000662 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000663 struct to find the original type of the variable, which is then assigned to
664 the variable's Debug Information Entry as its real type. So far, so good.
665 However now the debugger will expect the variable VarName to have the type
666 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000667 expression that explains to the debugger how to navigate through the
Caroline Ticedc8f6042009-08-31 21:19:37 +0000668 pointers and struct to find the actual variable of type SomeType.
669
670 The following function does just that. We start by getting
671 the "normal" location for the variable. This will be the location
672 of either the struct __Block_byref_x_VarName or the pointer to the
673 struct __Block_byref_x_VarName.
674
675 The struct will look something like:
676
677 struct __Block_byref_x_VarName {
678 ... <various fields>
679 struct __Block_byref_x_VarName *forwarding;
680 ... <various other fields>
681 SomeType VarName;
682 ... <maybe more fields>
683 };
684
685 If we are given the struct directly (as our starting point) we
686 need to tell the debugger to:
687
688 1). Add the offset of the forwarding field.
689
Dan Gohmanf451cb82010-02-10 16:03:48 +0000690 2). Follow that pointer to get the real __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000691 struct to use (the real one may have been copied onto the heap).
692
693 3). Add the offset for the field VarName, to find the actual variable.
694
695 If we started with a pointer to the struct, then we need to
696 dereference that pointer first, before the other steps.
697 Translating this into DWARF ops, we will need to append the following
698 to the current location description for the variable:
699
700 DW_OP_deref -- optional, if we start with a pointer
701 DW_OP_plus_uconst <forward_fld_offset>
702 DW_OP_deref
703 DW_OP_plus_uconst <varName_fld_offset>
704
705 That is what this function does. */
706
Devang Patel2c4ceb12009-11-21 02:48:08 +0000707/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticedc8f6042009-08-31 21:19:37 +0000708/// provided, and generate the DWARF information necessary to find the
709/// actual Block variable (navigating the Block struct) based on the
710/// starting location. Add the DWARF information to the die. For
711/// more information, read large comment just above here.
712///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000713void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbar00564992009-09-19 20:40:14 +0000714 unsigned Attribute,
715 const MachineLocation &Location) {
Devang Patel8bd11de2010-08-09 21:01:39 +0000716 DIType Ty = DV->getType();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000717 DIType TmpTy = Ty;
718 unsigned Tag = Ty.getTag();
719 bool isPointer = false;
720
Devang Patel8bd11de2010-08-09 21:01:39 +0000721 StringRef varName = DV->getName();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000722
723 if (Tag == dwarf::DW_TAG_pointer_type) {
Devang Patel2db49d72010-05-07 18:11:54 +0000724 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000725 TmpTy = DTy.getTypeDerivedFrom();
726 isPointer = true;
727 }
728
Devang Patel2db49d72010-05-07 18:11:54 +0000729 DICompositeType blockStruct = DICompositeType(TmpTy);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000730
Daniel Dunbar00564992009-09-19 20:40:14 +0000731 // Find the __forwarding field and the variable field in the __Block_byref
732 // struct.
Daniel Dunbar00564992009-09-19 20:40:14 +0000733 DIArray Fields = blockStruct.getTypeArray();
734 DIDescriptor varField = DIDescriptor();
735 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000736
Daniel Dunbar00564992009-09-19 20:40:14 +0000737 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
738 DIDescriptor Element = Fields.getElement(i);
Devang Patel2db49d72010-05-07 18:11:54 +0000739 DIDerivedType DT = DIDerivedType(Element);
Devang Patel65dbc902009-11-25 17:36:49 +0000740 StringRef fieldName = DT.getName();
741 if (fieldName == "__forwarding")
Daniel Dunbar00564992009-09-19 20:40:14 +0000742 forwardingField = Element;
Devang Patel65dbc902009-11-25 17:36:49 +0000743 else if (fieldName == varName)
Daniel Dunbar00564992009-09-19 20:40:14 +0000744 varField = Element;
745 }
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000746
Daniel Dunbar00564992009-09-19 20:40:14 +0000747 // Get the offsets for the forwarding field and the variable field.
Chris Lattner1d65ba72010-03-31 06:06:37 +0000748 unsigned forwardingFieldOffset =
Devang Patel2db49d72010-05-07 18:11:54 +0000749 DIDerivedType(forwardingField).getOffsetInBits() >> 3;
Chris Lattner1d65ba72010-03-31 06:06:37 +0000750 unsigned varFieldOffset =
Devang Patel2db49d72010-05-07 18:11:54 +0000751 DIDerivedType(varField).getOffsetInBits() >> 3;
Caroline Ticedc8f6042009-08-31 21:19:37 +0000752
Mike Stump7e3720d2009-09-24 23:21:26 +0000753 // Decode the original location, and use that as the start of the byref
754 // variable's location.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000755 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Daniel Dunbar00564992009-09-19 20:40:14 +0000756 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000757 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000758
Daniel Dunbar00564992009-09-19 20:40:14 +0000759 if (Location.isReg()) {
760 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000761 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000762 else {
763 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000764 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
765 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000766 }
767 } else {
768 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000769 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000770 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000771 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
772 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000773 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000774
Devang Patel2c4ceb12009-11-21 02:48:08 +0000775 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbar00564992009-09-19 20:40:14 +0000776 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000777
Mike Stump7e3720d2009-09-24 23:21:26 +0000778 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbar00564992009-09-19 20:40:14 +0000779 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbar00564992009-09-19 20:40:14 +0000780 if (isPointer)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000781 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000782
Daniel Dunbar00564992009-09-19 20:40:14 +0000783 // Next add the offset for the '__forwarding' field:
784 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
785 // adding the offset if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000786 if (forwardingFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000787 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
788 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000789 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000790
Daniel Dunbar00564992009-09-19 20:40:14 +0000791 // Now dereference the __forwarding field to get to the real __Block_byref
792 // struct: DW_OP_deref.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000793 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000794
Daniel Dunbar00564992009-09-19 20:40:14 +0000795 // Now that we've got the real __Block_byref... struct, add the offset
796 // for the variable's field to get to the location of the actual variable:
797 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000798 if (varFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000799 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
800 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000801 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000802
Daniel Dunbar00564992009-09-19 20:40:14 +0000803 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000804 addBlock(Die, Attribute, 0, Block);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000805}
806
Devang Patel2c4ceb12009-11-21 02:48:08 +0000807/// addAddress - Add an address attribute to a die based on the location
Bill Wendling0310d762009-05-15 09:23:25 +0000808/// provided.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000809void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000810 const MachineLocation &Location) {
Chris Lattnerd38fee82010-04-05 00:13:49 +0000811 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling0310d762009-05-15 09:23:25 +0000812 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer345ef342010-03-31 19:34:01 +0000813 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Bill Wendling0310d762009-05-15 09:23:25 +0000814
815 if (Location.isReg()) {
816 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000817 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000818 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000819 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
820 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000821 }
822 } else {
823 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000824 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000825 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000826 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
827 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000828 }
829
Devang Patel2c4ceb12009-11-21 02:48:08 +0000830 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling0310d762009-05-15 09:23:25 +0000831 }
832
Devang Patel2c4ceb12009-11-21 02:48:08 +0000833 addBlock(Die, Attribute, 0, Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000834}
835
Devang Patela43098d2010-04-28 01:03:09 +0000836/// addRegisterAddress - Add register location entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000837bool DwarfDebug::addRegisterAddress(DIE *Die, const MCSymbol *VS,
Devang Patela43098d2010-04-28 01:03:09 +0000838 const MachineOperand &MO) {
839 assert (MO.isReg() && "Invalid machine operand!");
840 if (!MO.getReg())
841 return false;
842 MachineLocation Location;
843 Location.set(MO.getReg());
844 addAddress(Die, dwarf::DW_AT_location, Location);
Devang Patel26c1e562010-05-20 16:36:41 +0000845 if (VS)
Devang Patela43098d2010-04-28 01:03:09 +0000846 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
847 return true;
848}
849
850/// addConstantValue - Add constant value entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000851bool DwarfDebug::addConstantValue(DIE *Die, const MCSymbol *VS,
Devang Patela43098d2010-04-28 01:03:09 +0000852 const MachineOperand &MO) {
853 assert (MO.isImm() && "Invalid machine operand!");
854 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
855 unsigned Imm = MO.getImm();
856 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
857 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patel26c1e562010-05-20 16:36:41 +0000858 if (VS)
Devang Patela43098d2010-04-28 01:03:09 +0000859 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
860 return true;
861}
862
863/// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000864bool DwarfDebug::addConstantFPValue(DIE *Die, const MCSymbol *VS,
Devang Patela43098d2010-04-28 01:03:09 +0000865 const MachineOperand &MO) {
866 assert (MO.isFPImm() && "Invalid machine operand!");
867 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
868 APFloat FPImm = MO.getFPImm()->getValueAPF();
Jim Grosbach1e20b962010-07-21 21:21:52 +0000869
Devang Patela43098d2010-04-28 01:03:09 +0000870 // Get the raw data form of the floating point.
871 const APInt FltVal = FPImm.bitcastToAPInt();
872 const char *FltPtr = (const char*)FltVal.getRawData();
Jim Grosbach1e20b962010-07-21 21:21:52 +0000873
Devang Patela43098d2010-04-28 01:03:09 +0000874 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
875 bool LittleEndian = Asm->getTargetData().isLittleEndian();
876 int Incr = (LittleEndian ? 1 : -1);
877 int Start = (LittleEndian ? 0 : NumBytes - 1);
878 int Stop = (LittleEndian ? NumBytes : -1);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000879
Devang Patela43098d2010-04-28 01:03:09 +0000880 // Output the constant to DWARF one byte at a time.
881 for (; Start != Stop; Start += Incr)
882 addUInt(Block, 0, dwarf::DW_FORM_data1,
883 (unsigned char)0xFF & FltPtr[Start]);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000884
Devang Patela43098d2010-04-28 01:03:09 +0000885 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patel26c1e562010-05-20 16:36:41 +0000886 if (VS)
887 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000888 return true;
Devang Patela43098d2010-04-28 01:03:09 +0000889}
890
891
Devang Patelc366f832009-12-10 19:14:49 +0000892/// addToContextOwner - Add Die into the list of its context owner's children.
893void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3c91b052010-03-08 20:52:55 +0000894 if (Context.isType()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000895 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
Devang Patelc366f832009-12-10 19:14:49 +0000896 ContextDIE->addChild(Die);
Devang Patel6404e4e2009-12-15 19:16:48 +0000897 } else if (Context.isNameSpace()) {
Devang Patel2db49d72010-05-07 18:11:54 +0000898 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
Devang Patel6404e4e2009-12-15 19:16:48 +0000899 ContextDIE->addChild(Die);
Stuart Hastings215aa152010-06-11 20:08:44 +0000900 } else if (Context.isSubprogram()) {
901 DIE *ContextDIE = createSubprogramDIE(DISubprogram(Context),
902 /*MakeDecl=*/false);
903 ContextDIE->addChild(Die);
Devang Patel163a9f72010-05-10 22:49:55 +0000904 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patelc366f832009-12-10 19:14:49 +0000905 ContextDIE->addChild(Die);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000906 else
Devang Patel163a9f72010-05-10 22:49:55 +0000907 getCompileUnit(Context)->addDie(Die);
Devang Patelc366f832009-12-10 19:14:49 +0000908}
909
Devang Patel16ced732009-12-10 18:05:33 +0000910/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
911/// given DIType.
912DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel163a9f72010-05-10 22:49:55 +0000913 CompileUnit *TypeCU = getCompileUnit(Ty);
914 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patel16ced732009-12-10 18:05:33 +0000915 if (TyDIE)
916 return TyDIE;
917
918 // Create new type.
919 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel163a9f72010-05-10 22:49:55 +0000920 TypeCU->insertDIE(Ty, TyDIE);
Devang Patel16ced732009-12-10 18:05:33 +0000921 if (Ty.isBasicType())
Devang Patel2db49d72010-05-07 18:11:54 +0000922 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000923 else if (Ty.isCompositeType())
Devang Patel2db49d72010-05-07 18:11:54 +0000924 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000925 else {
926 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patel2db49d72010-05-07 18:11:54 +0000927 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patel16ced732009-12-10 18:05:33 +0000928 }
929
Devang Patelc366f832009-12-10 19:14:49 +0000930 addToContextOwner(TyDIE, Ty.getContext());
Devang Patel16ced732009-12-10 18:05:33 +0000931 return TyDIE;
932}
933
Devang Patel2c4ceb12009-11-21 02:48:08 +0000934/// addType - Add a new type attribute to the specified entity.
Devang Patel8a241142009-12-09 18:24:21 +0000935void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel9c004872010-05-07 21:45:47 +0000936 if (!Ty.Verify())
Bill Wendling0310d762009-05-15 09:23:25 +0000937 return;
938
939 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +0000940 CompileUnit *TypeCU = getCompileUnit(Ty);
941 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000942 // If it exists then use the existing value.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000943 if (Entry) {
944 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000945 return;
946 }
947
Bill Wendling0310d762009-05-15 09:23:25 +0000948 // Construct type.
Devang Patel16ced732009-12-10 18:05:33 +0000949 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000950
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000951 // Set up proxy.
952 Entry = createDIEEntry(Buffer);
Devang Patel163a9f72010-05-10 22:49:55 +0000953 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000954
Devang Patel2c4ceb12009-11-21 02:48:08 +0000955 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000956}
957
Devang Patel2c4ceb12009-11-21 02:48:08 +0000958/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel8a241142009-12-09 18:24:21 +0000959void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000960 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000961 StringRef Name = BTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000962 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000963 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling0310d762009-05-15 09:23:25 +0000964 BTy.getEncoding());
965
966 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +0000967 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000968 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000969 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000970 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000971}
972
Devang Patel2c4ceb12009-11-21 02:48:08 +0000973/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel8a241142009-12-09 18:24:21 +0000974void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000975 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000976 StringRef Name = DTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000977 uint64_t Size = DTy.getSizeInBits() >> 3;
978 unsigned Tag = DTy.getTag();
979
980 // FIXME - Workaround for templates.
981 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
982
983 Buffer.setTag(Tag);
984
985 // Map to main type, void will not have a type.
986 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel8a241142009-12-09 18:24:21 +0000987 addType(&Buffer, FromTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000988
989 // Add name if not anonymous or intermediate type.
Devang Pateldeea5642009-11-30 23:56:56 +0000990 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000991 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000992
993 // Add size if non-zero (derived types might be zero-sized.)
994 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000995 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000996
997 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patel05f6fa82009-11-23 18:43:37 +0000998 if (!DTy.isForwardDecl())
Devang Patel81625742010-08-09 20:20:05 +0000999 addSourceLine(&Buffer, DTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001000}
1001
Devang Patel2c4ceb12009-11-21 02:48:08 +00001002/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +00001003void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001004 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +00001005 StringRef Name = CTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +00001006
1007 uint64_t Size = CTy.getSizeInBits() >> 3;
1008 unsigned Tag = CTy.getTag();
1009 Buffer.setTag(Tag);
1010
1011 switch (Tag) {
1012 case dwarf::DW_TAG_vector_type:
1013 case dwarf::DW_TAG_array_type:
Devang Patel8a241142009-12-09 18:24:21 +00001014 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001015 break;
1016 case dwarf::DW_TAG_enumeration_type: {
1017 DIArray Elements = CTy.getTypeArray();
1018
1019 // Add enumerators to enumeration type.
1020 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1021 DIE *ElemDie = NULL;
Devang Patel2db49d72010-05-07 18:11:54 +00001022 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3c91b052010-03-08 20:52:55 +00001023 if (Enum.isEnumerator()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001024 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001025 Buffer.addChild(ElemDie);
Devang Patelc5254722009-10-09 17:51:49 +00001026 }
Bill Wendling0310d762009-05-15 09:23:25 +00001027 }
1028 }
1029 break;
1030 case dwarf::DW_TAG_subroutine_type: {
1031 // Add return type.
1032 DIArray Elements = CTy.getTypeArray();
1033 DIDescriptor RTy = Elements.getElement(0);
Devang Patel2db49d72010-05-07 18:11:54 +00001034 addType(&Buffer, DIType(RTy));
Bill Wendling0310d762009-05-15 09:23:25 +00001035
1036 // Add prototype flag.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001037 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001038
1039 // Add arguments.
1040 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1041 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1042 DIDescriptor Ty = Elements.getElement(i);
Devang Patel2db49d72010-05-07 18:11:54 +00001043 addType(Arg, DIType(Ty));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001044 Buffer.addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001045 }
1046 }
1047 break;
1048 case dwarf::DW_TAG_structure_type:
1049 case dwarf::DW_TAG_union_type:
1050 case dwarf::DW_TAG_class_type: {
1051 // Add elements to structure type.
1052 DIArray Elements = CTy.getTypeArray();
1053
1054 // A forward struct declared type may not have elements available.
Devang Patel3c91b052010-03-08 20:52:55 +00001055 unsigned N = Elements.getNumElements();
1056 if (N == 0)
Bill Wendling0310d762009-05-15 09:23:25 +00001057 break;
1058
1059 // Add elements to structure type.
Devang Patel3c91b052010-03-08 20:52:55 +00001060 for (unsigned i = 0; i < N; ++i) {
Bill Wendling0310d762009-05-15 09:23:25 +00001061 DIDescriptor Element = Elements.getElement(i);
1062 DIE *ElemDie = NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001063 if (Element.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001064 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patel3c91b052010-03-08 20:52:55 +00001065 else if (Element.isVariable()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001066 DIVariable DV(Element);
Devang Patel1ee0cb92010-01-30 01:08:30 +00001067 ElemDie = new DIE(dwarf::DW_TAG_variable);
1068 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1069 DV.getName());
1070 addType(ElemDie, DV.getType());
1071 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1072 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patel81625742010-08-09 20:20:05 +00001073 addSourceLine(ElemDie, DV);
Devang Patel3c91b052010-03-08 20:52:55 +00001074 } else if (Element.isDerivedType())
Devang Patel2db49d72010-05-07 18:11:54 +00001075 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3c91b052010-03-08 20:52:55 +00001076 else
1077 continue;
Devang Patel2c4ceb12009-11-21 02:48:08 +00001078 Buffer.addChild(ElemDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001079 }
1080
Devang Patela1ba2692009-08-27 23:51:51 +00001081 if (CTy.isAppleBlockExtension())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001082 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001083
1084 unsigned RLang = CTy.getRunTimeLang();
1085 if (RLang)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001086 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling0310d762009-05-15 09:23:25 +00001087 dwarf::DW_FORM_data1, RLang);
Devang Patelb5544992010-01-26 21:16:06 +00001088
1089 DICompositeType ContainingType = CTy.getContainingType();
Devang Patel2db49d72010-05-07 18:11:54 +00001090 if (DIDescriptor(ContainingType).isCompositeType())
Jim Grosbach1e20b962010-07-21 21:21:52 +00001091 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patel2db49d72010-05-07 18:11:54 +00001092 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastings215aa152010-06-11 20:08:44 +00001093 else {
1094 DIDescriptor Context = CTy.getContext();
1095 addToContextOwner(&Buffer, Context);
1096 }
Bill Wendling0310d762009-05-15 09:23:25 +00001097 break;
1098 }
1099 default:
1100 break;
1101 }
1102
1103 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +00001104 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001105 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001106
Jim Grosbach1e20b962010-07-21 21:21:52 +00001107 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
Devang Patel61409622010-07-07 20:12:52 +00001108 || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1109 {
Bill Wendling0310d762009-05-15 09:23:25 +00001110 // Add size if non-zero (derived types might be zero-sized.)
1111 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001112 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +00001113 else {
1114 // Add zero size if it is not a forward declaration.
1115 if (CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001116 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001117 else
Devang Patel2c4ceb12009-11-21 02:48:08 +00001118 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling0310d762009-05-15 09:23:25 +00001119 }
1120
1121 // Add source line info if available.
1122 if (!CTy.isForwardDecl())
Devang Patel81625742010-08-09 20:20:05 +00001123 addSourceLine(&Buffer, CTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001124 }
1125}
1126
Devang Patel2c4ceb12009-11-21 02:48:08 +00001127/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1128void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling0310d762009-05-15 09:23:25 +00001129 int64_t L = SR.getLo();
1130 int64_t H = SR.getHi();
1131 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1132
Devang Patel2c4ceb12009-11-21 02:48:08 +00001133 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patel6325a532009-08-14 20:59:16 +00001134 if (L)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001135 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Pateld55224c2009-12-04 23:10:24 +00001136 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling0310d762009-05-15 09:23:25 +00001137
Devang Patel2c4ceb12009-11-21 02:48:08 +00001138 Buffer.addChild(DW_Subrange);
Bill Wendling0310d762009-05-15 09:23:25 +00001139}
1140
Devang Patel2c4ceb12009-11-21 02:48:08 +00001141/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +00001142void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling0310d762009-05-15 09:23:25 +00001143 DICompositeType *CTy) {
1144 Buffer.setTag(dwarf::DW_TAG_array_type);
1145 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001146 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001147
1148 // Emit derived type.
Devang Patel8a241142009-12-09 18:24:21 +00001149 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001150 DIArray Elements = CTy->getTypeArray();
1151
Devang Patel6f01d9c2009-11-21 00:31:03 +00001152 // Get an anonymous type for index type.
Devang Patel163a9f72010-05-10 22:49:55 +00001153 CompileUnit *TheCU = getCompileUnit(*CTy);
1154 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel6f01d9c2009-11-21 00:31:03 +00001155 if (!IdxTy) {
1156 // Construct an anonymous type for index type.
1157 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001158 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1159 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel6f01d9c2009-11-21 00:31:03 +00001160 dwarf::DW_ATE_signed);
Devang Patel163a9f72010-05-10 22:49:55 +00001161 TheCU->addDie(IdxTy);
1162 TheCU->setIndexTyDie(IdxTy);
Devang Patel6f01d9c2009-11-21 00:31:03 +00001163 }
Bill Wendling0310d762009-05-15 09:23:25 +00001164
1165 // Add subranges to array type.
1166 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1167 DIDescriptor Element = Elements.getElement(i);
1168 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patel2db49d72010-05-07 18:11:54 +00001169 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001170 }
1171}
1172
Devang Patel2c4ceb12009-11-21 02:48:08 +00001173/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3c91b052010-03-08 20:52:55 +00001174DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001175 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3c91b052010-03-08 20:52:55 +00001176 StringRef Name = ETy.getName();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001177 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3c91b052010-03-08 20:52:55 +00001178 int64_t Value = ETy.getEnumValue();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001179 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling0310d762009-05-15 09:23:25 +00001180 return Enumerator;
1181}
1182
Jim Grosbach1e20b962010-07-21 21:21:52 +00001183/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel351ca332010-01-05 01:46:14 +00001184/// printer to not emit usual symbol prefix before the symbol name is used then
1185/// return linkage name after skipping this special LLVM prefix.
1186static StringRef getRealLinkageName(StringRef LinkageName) {
1187 char One = '\1';
1188 if (LinkageName.startswith(StringRef(&One, 1)))
1189 return LinkageName.substr(1);
1190 return LinkageName;
1191}
1192
Devang Patel2c4ceb12009-11-21 02:48:08 +00001193/// createMemberDIE - Create new member DIE.
Devang Patelecbd8e82010-08-10 04:12:17 +00001194DIE *DwarfDebug::createMemberDIE(DIDerivedType DT) {
Bill Wendling0310d762009-05-15 09:23:25 +00001195 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel65dbc902009-11-25 17:36:49 +00001196 StringRef Name = DT.getName();
1197 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001198 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001199
Devang Patel8a241142009-12-09 18:24:21 +00001200 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001201
Devang Patel81625742010-08-09 20:20:05 +00001202 addSourceLine(MemberDie, DT);
Bill Wendling0310d762009-05-15 09:23:25 +00001203
Benjamin Kramer345ef342010-03-31 19:34:01 +00001204 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001205 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel33db5082009-11-04 22:06:12 +00001206
Bill Wendling0310d762009-05-15 09:23:25 +00001207 uint64_t Size = DT.getSizeInBits();
Devang Patel61ecbd12009-11-04 23:48:00 +00001208 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling0310d762009-05-15 09:23:25 +00001209
1210 if (Size != FieldSize) {
1211 // Handle bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001212 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1213 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling0310d762009-05-15 09:23:25 +00001214
1215 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling0310d762009-05-15 09:23:25 +00001216 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1217 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer3d594fd2010-01-07 17:50:57 +00001218 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling0310d762009-05-15 09:23:25 +00001219 Offset -= FieldOffset;
1220
1221 // Maybe we need to work from the other end.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001222 if (Asm->getTargetData().isLittleEndian())
1223 Offset = FieldSize - (Offset + Size);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001224 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling0310d762009-05-15 09:23:25 +00001225
Devang Patel33db5082009-11-04 22:06:12 +00001226 // Here WD_AT_data_member_location points to the anonymous
1227 // field that includes this bit field.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001228 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001229
1230 } else
1231 // This is not a bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001232 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001233
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001234 if (DT.getTag() == dwarf::DW_TAG_inheritance
1235 && DT.isVirtual()) {
1236
1237 // For C++, virtual base classes are not at fixed offset. Use following
1238 // expression to extract appropriate offset from vtable.
1239 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1240
Benjamin Kramer345ef342010-03-31 19:34:01 +00001241 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001242 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1243 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1244 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1245 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1246 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1247 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1248 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1249
Jim Grosbach1e20b962010-07-21 21:21:52 +00001250 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
Devang Patelc1dc8ff2010-02-03 20:08:48 +00001251 VBaseLocationDie);
1252 } else
1253 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001254
1255 if (DT.isProtected())
Devang Patel5d11eb02009-12-03 19:11:07 +00001256 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001257 dwarf::DW_ACCESS_protected);
1258 else if (DT.isPrivate())
Devang Patel5d11eb02009-12-03 19:11:07 +00001259 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001260 dwarf::DW_ACCESS_private);
Devang Patel5d11eb02009-12-03 19:11:07 +00001261 else if (DT.getTag() == dwarf::DW_TAG_inheritance)
1262 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1263 dwarf::DW_ACCESS_public);
1264 if (DT.isVirtual())
1265 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1266 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling0310d762009-05-15 09:23:25 +00001267 return MemberDie;
1268}
1269
Devang Patelffe966c2009-12-14 16:18:45 +00001270/// createSubprogramDIE - Create new DIE using SP.
Devang Patelecbd8e82010-08-10 04:12:17 +00001271DIE *DwarfDebug::createSubprogramDIE(DISubprogram SP, bool MakeDecl) {
Devang Patel163a9f72010-05-10 22:49:55 +00001272 CompileUnit *SPCU = getCompileUnit(SP);
1273 DIE *SPDie = SPCU->getDIE(SP);
Devang Patelffe966c2009-12-14 16:18:45 +00001274 if (SPDie)
1275 return SPDie;
1276
1277 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel1eac3e72010-03-02 17:58:15 +00001278 // Constructors and operators for anonymous aggregates do not have names.
Devang Patel6b506cb2010-03-02 01:26:20 +00001279 if (!SP.getName().empty())
1280 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling0310d762009-05-15 09:23:25 +00001281
Devang Patel65dbc902009-11-25 17:36:49 +00001282 StringRef LinkageName = SP.getLinkageName();
Devang Patel351ca332010-01-05 01:46:14 +00001283 if (!LinkageName.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001284 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel351ca332010-01-05 01:46:14 +00001285 getRealLinkageName(LinkageName));
1286
Devang Patel81625742010-08-09 20:20:05 +00001287 addSourceLine(SPDie, SP);
Bill Wendling0310d762009-05-15 09:23:25 +00001288
Bill Wendling0310d762009-05-15 09:23:25 +00001289 // Add prototyped tag, if C or ObjC.
1290 unsigned Lang = SP.getCompileUnit().getLanguage();
1291 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1292 Lang == dwarf::DW_LANG_ObjC)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001293 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001294
1295 // Add Return Type.
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001296 DICompositeType SPTy = SP.getType();
1297 DIArray Args = SPTy.getTypeArray();
Bill Wendling0310d762009-05-15 09:23:25 +00001298 unsigned SPTag = SPTy.getTag();
Devang Patel5d11eb02009-12-03 19:11:07 +00001299
Devang Patel3c91b052010-03-08 20:52:55 +00001300 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel8a241142009-12-09 18:24:21 +00001301 addType(SPDie, SPTy);
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001302 else
Devang Patel2db49d72010-05-07 18:11:54 +00001303 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001304
Devang Patel5d11eb02009-12-03 19:11:07 +00001305 unsigned VK = SP.getVirtuality();
1306 if (VK) {
1307 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer345ef342010-03-31 19:34:01 +00001308 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel5d11eb02009-12-03 19:11:07 +00001309 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1310 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1311 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001312 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patel2db49d72010-05-07 18:11:54 +00001313 SP.getContainingType()));
Devang Patel5d11eb02009-12-03 19:11:07 +00001314 }
1315
Devang Patelffe966c2009-12-14 16:18:45 +00001316 if (MakeDecl || !SP.isDefinition()) {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001317 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001318
1319 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001320 // be handled while processing variables.
1321 DICompositeType SPTy = SP.getType();
1322 DIArray Args = SPTy.getTypeArray();
1323 unsigned SPTag = SPTy.getTag();
1324
Bill Wendling0310d762009-05-15 09:23:25 +00001325 if (SPTag == dwarf::DW_TAG_subroutine_type)
1326 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1327 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001328 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patelb4645642010-02-06 01:02:37 +00001329 addType(Arg, ATy);
1330 if (ATy.isArtificial())
1331 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001332 SPDie->addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001333 }
1334 }
1335
Devang Patel4e0d19d2010-02-03 19:57:19 +00001336 if (SP.isArtificial())
1337 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1338
Devang Patelccff8122010-04-30 19:38:23 +00001339 if (!SP.isLocalToUnit())
1340 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001341
Devang Patelccff8122010-04-30 19:38:23 +00001342 if (SP.isOptimized())
1343 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1344
Jim Grosbach91729002010-07-21 23:03:52 +00001345 if (unsigned isa = Asm->getISAEncoding()) {
1346 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1347 }
1348
Devang Patelccff8122010-04-30 19:38:23 +00001349 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel163a9f72010-05-10 22:49:55 +00001350 SPCU->insertDIE(SP, SPDie);
Devang Patelccff8122010-04-30 19:38:23 +00001351
Stuart Hastings215aa152010-06-11 20:08:44 +00001352 // Add to context owner.
1353 addToContextOwner(SPDie, SP.getContext());
1354
Bill Wendling0310d762009-05-15 09:23:25 +00001355 return SPDie;
1356}
1357
Devang Patele9f8f5e2010-05-07 20:54:48 +00001358DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattnered7a77b2010-03-31 05:36:29 +00001359 assert(N && "Invalid Scope encoding!");
Devang Patel53bb5c92009-11-10 23:06:00 +00001360
1361 DbgScope *AScope = AbstractScopes.lookup(N);
1362 if (AScope)
1363 return AScope;
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001364
Devang Patel53bb5c92009-11-10 23:06:00 +00001365 DbgScope *Parent = NULL;
1366
1367 DIDescriptor Scope(N);
1368 if (Scope.isLexicalBlock()) {
1369 DILexicalBlock DB(N);
1370 DIDescriptor ParentDesc = DB.getContext();
Devang Patel2db49d72010-05-07 18:11:54 +00001371 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patel53bb5c92009-11-10 23:06:00 +00001372 }
1373
1374 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1375
1376 if (Parent)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001377 Parent->addScope(AScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001378 AScope->setAbstractScope();
1379 AbstractScopes[N] = AScope;
1380 if (DIDescriptor(N).isSubprogram())
1381 AbstractScopesList.push_back(AScope);
1382 return AScope;
1383}
Devang Patelaf9e8472009-10-01 20:31:14 +00001384
Devang Patel5f094002010-04-06 23:53:48 +00001385/// isSubprogramContext - Return true if Context is either a subprogram
1386/// or another context nested inside a subprogram.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001387static bool isSubprogramContext(const MDNode *Context) {
Devang Patel5f094002010-04-06 23:53:48 +00001388 if (!Context)
1389 return false;
1390 DIDescriptor D(Context);
1391 if (D.isSubprogram())
1392 return true;
1393 if (D.isType())
Devang Patel2db49d72010-05-07 18:11:54 +00001394 return isSubprogramContext(DIType(Context).getContext());
Devang Patel5f094002010-04-06 23:53:48 +00001395 return false;
1396}
1397
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001398/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel2c4ceb12009-11-21 02:48:08 +00001399/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1400/// If there are global variables in this scope then create and insert
1401/// DIEs for these variables.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001402DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel163a9f72010-05-10 22:49:55 +00001403 CompileUnit *SPCU = getCompileUnit(SPNode);
1404 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patel8aa61472010-07-07 22:20:57 +00001405
Chris Lattnerd38fee82010-04-05 00:13:49 +00001406 assert(SPDie && "Unable to find subprogram DIE!");
1407 DISubprogram SP(SPNode);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001408
Chris Lattnerd38fee82010-04-05 00:13:49 +00001409 // There is not any need to generate specification DIE for a function
1410 // defined at compile unit level. If a function is defined inside another
1411 // function then gdb prefers the definition at top level and but does not
Jim Grosbach1e20b962010-07-21 21:21:52 +00001412 // expect specification DIE in parent function. So avoid creating
Chris Lattnerd38fee82010-04-05 00:13:49 +00001413 // specification DIE for a function defined inside a function.
1414 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Jim Grosbach1e20b962010-07-21 21:21:52 +00001415 !SP.getContext().isFile() &&
Devang Patel2db49d72010-05-07 18:11:54 +00001416 !isSubprogramContext(SP.getContext())) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00001417 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001418
1419 // Add arguments.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001420 DICompositeType SPTy = SP.getType();
1421 DIArray Args = SPTy.getTypeArray();
1422 unsigned SPTag = SPTy.getTag();
1423 if (SPTag == dwarf::DW_TAG_subroutine_type)
1424 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1425 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel2db49d72010-05-07 18:11:54 +00001426 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattnerd38fee82010-04-05 00:13:49 +00001427 addType(Arg, ATy);
1428 if (ATy.isArtificial())
1429 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1430 SPDie->addChild(Arg);
1431 }
1432 DIE *SPDeclDie = SPDie;
1433 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001434 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Chris Lattnerd38fee82010-04-05 00:13:49 +00001435 SPDeclDie);
Devang Patel163a9f72010-05-10 22:49:55 +00001436 SPCU->addDie(SPDie);
Chris Lattnerd38fee82010-04-05 00:13:49 +00001437 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00001438
Devang Patel8aa61472010-07-07 22:20:57 +00001439 // Pick up abstract subprogram DIE.
1440 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
1441 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1442 addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
1443 dwarf::DW_FORM_ref4, AbsSPDIE);
1444 SPCU->addDie(SPDie);
1445 }
1446
Chris Lattnerd38fee82010-04-05 00:13:49 +00001447 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1448 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1449 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1450 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1451 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1452 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1453 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +00001454
Chris Lattnerd38fee82010-04-05 00:13:49 +00001455 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +00001456}
1457
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001458/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel2c4ceb12009-11-21 02:48:08 +00001459/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1460DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001461
1462 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1463 if (Scope->isAbstractScope())
1464 return ScopeDIE;
1465
1466 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1467 if (Ranges.empty())
1468 return 0;
1469
1470 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1471 if (Ranges.size() > 1) {
1472 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbach1e20b962010-07-21 21:21:52 +00001473 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Pateleac9c072010-04-27 19:46:33 +00001474 // DW_AT_ranges appropriately.
1475 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1476 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1477 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1478 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +00001479 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1480 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +00001481 }
1482 DebugRangeSymbols.push_back(NULL);
1483 DebugRangeSymbols.push_back(NULL);
1484 return ScopeDIE;
1485 }
1486
Devang Patelc3f5f782010-05-25 23:40:22 +00001487 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1488 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001489
Devang Patelc3f5f782010-05-25 23:40:22 +00001490 if (End == 0) return 0;
Devang Patel53bb5c92009-11-10 23:06:00 +00001491
Chris Lattnerb7db7332010-03-09 01:58:53 +00001492 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1493 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbach1e20b962010-07-21 21:21:52 +00001494
Devang Pateleac9c072010-04-27 19:46:33 +00001495 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1496 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patel53bb5c92009-11-10 23:06:00 +00001497
1498 return ScopeDIE;
1499}
1500
Devang Patel2c4ceb12009-11-21 02:48:08 +00001501/// constructInlinedScopeDIE - This scope represents inlined body of
1502/// a function. Construct DIE to represent this concrete inlined copy
1503/// of the function.
1504DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +00001505
1506 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001507 assert (Ranges.empty() == false
Devang Pateleac9c072010-04-27 19:46:33 +00001508 && "DbgScope does not have instruction markers!");
1509
1510 // FIXME : .debug_inlined section specification does not clearly state how
1511 // to emit inlined scope that is split into multiple instruction ranges.
1512 // For now, use first instruction range and emit low_pc/high_pc pair and
1513 // corresponding .debug_inlined section entry for this pair.
1514 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patelc3f5f782010-05-25 23:40:22 +00001515 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1516 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001517
Devang Patel0afbf232010-07-08 22:39:20 +00001518 if (StartLabel == 0 || EndLabel == 0) {
Devang Pateleac9c072010-04-27 19:46:33 +00001519 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1520 return 0;
1521 }
Chris Lattnerb7db7332010-03-09 01:58:53 +00001522 assert(StartLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001523 "Invalid starting label for an inlined scope!");
Chris Lattnerb7db7332010-03-09 01:58:53 +00001524 assert(EndLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +00001525 "Invalid end label for an inlined scope!");
Devang Pateleac9c072010-04-27 19:46:33 +00001526
Devang Patel3c91b052010-03-08 20:52:55 +00001527 if (!Scope->getScopeNode())
Devang Patel0ef3fa62010-03-08 19:20:38 +00001528 return NULL;
Devang Patel3c91b052010-03-08 20:52:55 +00001529 DIScope DS(Scope->getScopeNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00001530 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1531
Devang Patel2db49d72010-05-07 18:11:54 +00001532 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel163a9f72010-05-10 22:49:55 +00001533 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1534 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001535 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel2c4ceb12009-11-21 02:48:08 +00001536 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001537 dwarf::DW_FORM_ref4, OriginDIE);
1538
Chris Lattner6ed0f902010-03-09 00:31:02 +00001539 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnerb7db7332010-03-09 01:58:53 +00001540 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patel53bb5c92009-11-10 23:06:00 +00001541
1542 InlinedSubprogramDIEs.insert(OriginDIE);
1543
1544 // Track the start label for this inlined function.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001545 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patel2db49d72010-05-07 18:11:54 +00001546 I = InlineInfo.find(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001547
1548 if (I == InlineInfo.end()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001549 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001550 ScopeDIE));
Devang Patel2db49d72010-05-07 18:11:54 +00001551 InlinedSPNodes.push_back(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +00001552 } else
Chris Lattner6ed0f902010-03-09 00:31:02 +00001553 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patel53bb5c92009-11-10 23:06:00 +00001554
Devang Patel53bb5c92009-11-10 23:06:00 +00001555 DILocation DL(Scope->getInlinedAt());
Devang Patel163a9f72010-05-10 22:49:55 +00001556 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001557 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +00001558
1559 return ScopeDIE;
1560}
1561
Devang Patel2c4ceb12009-11-21 02:48:08 +00001562
1563/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel8a241142009-12-09 18:24:21 +00001564DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel8bd11de2010-08-09 21:01:39 +00001565 StringRef Name = DV->getName();
Devang Patel65dbc902009-11-25 17:36:49 +00001566 if (Name.empty())
Devang Patel3fb6bd62009-11-13 02:25:26 +00001567 return NULL;
Devang Patel53bb5c92009-11-10 23:06:00 +00001568
1569 // Translate tag to proper Dwarf tag. The result variable is dropped for
1570 // now.
1571 unsigned Tag;
Devang Patel8bd11de2010-08-09 21:01:39 +00001572 switch (DV->getTag()) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001573 case dwarf::DW_TAG_return_variable:
1574 return NULL;
1575 case dwarf::DW_TAG_arg_variable:
1576 Tag = dwarf::DW_TAG_formal_parameter;
1577 break;
1578 case dwarf::DW_TAG_auto_variable: // fall thru
1579 default:
1580 Tag = dwarf::DW_TAG_variable;
1581 break;
1582 }
1583
1584 // Define variable debug information entry.
1585 DIE *VariableDie = new DIE(Tag);
1586
Devang Patel53bb5c92009-11-10 23:06:00 +00001587 DIE *AbsDIE = NULL;
Devang Patel26c1e562010-05-20 16:36:41 +00001588 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1589 V2AVI = VarToAbstractVarMap.find(DV);
1590 if (V2AVI != VarToAbstractVarMap.end())
1591 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001592
Devang Patel26c1e562010-05-20 16:36:41 +00001593 if (AbsDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001594 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001595 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001596 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001597 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel8bd11de2010-08-09 21:01:39 +00001598 addSourceLine(VariableDie, DV->getVariable());
Devang Patel53bb5c92009-11-10 23:06:00 +00001599
1600 // Add variable type.
Devang Patel8bd11de2010-08-09 21:01:39 +00001601 addType(VariableDie, DV->getType());
Devang Patel53bb5c92009-11-10 23:06:00 +00001602 }
1603
Devang Patel8bd11de2010-08-09 21:01:39 +00001604 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patelb4645642010-02-06 01:02:37 +00001605 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelc3f5f782010-05-25 23:40:22 +00001606
1607 if (Scope->isAbstractScope()) {
1608 DV->setDIE(VariableDie);
1609 return VariableDie;
1610 }
1611
1612 // Add variable address.
1613
1614 unsigned Offset = DV->getDotDebugLocOffset();
1615 if (Offset != ~0U) {
1616 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1617 Asm->GetTempSymbol("debug_loc", Offset));
1618 DV->setDIE(VariableDie);
1619 UseDotDebugLocEntry.insert(VariableDie);
1620 return VariableDie;
1621 }
1622
1623 // Check if variable is described by a DBG_VALUE instruction.
1624 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1625 DbgVariableToDbgInstMap.find(DV);
1626 if (DVI != DbgVariableToDbgInstMap.end()) {
1627 const MachineInstr *DVInsn = DVI->second;
1628 const MCSymbol *DVLabel = findVariableLabel(DV);
1629 bool updated = false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001630 // FIXME : Handle getNumOperands != 3
Devang Patelc3f5f782010-05-25 23:40:22 +00001631 if (DVInsn->getNumOperands() == 3) {
Devang Patel0b48ead2010-08-31 22:22:42 +00001632 if (DVInsn->getOperand(0).isReg()) {
1633 const MachineOperand RegOp = DVInsn->getOperand(0);
1634 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1635 if (DVInsn->getOperand(1).isImm() &&
1636 TRI->getFrameRegister(*Asm->MF) == RegOp.getReg()) {
1637 addVariableAddress(DV, VariableDie, DVInsn->getOperand(1).getImm());
1638 updated = true;
1639 } else
1640 updated = addRegisterAddress(VariableDie, DVLabel, RegOp);
1641 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001642 else if (DVInsn->getOperand(0).isImm())
1643 updated = addConstantValue(VariableDie, DVLabel, DVInsn->getOperand(0));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001644 else if (DVInsn->getOperand(0).isFPImm())
1645 updated =
Devang Patel61409622010-07-07 20:12:52 +00001646 addConstantFPValue(VariableDie, DVLabel, DVInsn->getOperand(0));
Devang Patelc3f5f782010-05-25 23:40:22 +00001647 } else {
1648 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1649 if (Location.getReg()) {
1650 addAddress(VariableDie, dwarf::DW_AT_location, Location);
1651 if (DVLabel)
1652 addLabel(VariableDie, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr,
1653 DVLabel);
1654 updated = true;
1655 }
1656 }
1657 if (!updated) {
1658 // If variableDie is not updated then DBG_VALUE instruction does not
1659 // have valid variable info.
1660 delete VariableDie;
1661 return NULL;
1662 }
1663 DV->setDIE(VariableDie);
1664 return VariableDie;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001665 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001666
1667 // .. else use frame index, if available.
Devang Patelc3f5f782010-05-25 23:40:22 +00001668 int FI = 0;
Devang Patel9e3bd2c2010-08-31 06:11:28 +00001669 if (findVariableFrameIndex(DV, &FI))
1670 addVariableAddress(DV, VariableDie, FI);
1671
Devang Patel53bb5c92009-11-10 23:06:00 +00001672 DV->setDIE(VariableDie);
1673 return VariableDie;
1674
1675}
Devang Patel2c4ceb12009-11-21 02:48:08 +00001676
Devang Patel193f7202009-11-24 01:14:22 +00001677void DwarfDebug::addPubTypes(DISubprogram SP) {
1678 DICompositeType SPTy = SP.getType();
1679 unsigned SPTag = SPTy.getTag();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001680 if (SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel193f7202009-11-24 01:14:22 +00001681 return;
1682
1683 DIArray Args = SPTy.getTypeArray();
Devang Patel193f7202009-11-24 01:14:22 +00001684 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patel2db49d72010-05-07 18:11:54 +00001685 DIType ATy(Args.getElement(i));
Devang Patel9c004872010-05-07 21:45:47 +00001686 if (!ATy.Verify())
Devang Patel193f7202009-11-24 01:14:22 +00001687 continue;
1688 DICompositeType CATy = getDICompositeType(ATy);
Devang Patel2db49d72010-05-07 18:11:54 +00001689 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel50d80e32010-04-13 20:35:04 +00001690 && !CATy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001691 CompileUnit *TheCU = getCompileUnit(CATy);
1692 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1693 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001694 }
1695 }
1696}
1697
Devang Patel2c4ceb12009-11-21 02:48:08 +00001698/// constructScopeDIE - Construct a DIE for this scope.
1699DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3c91b052010-03-08 20:52:55 +00001700 if (!Scope || !Scope->getScopeNode())
1701 return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001702
Devang Patel3c91b052010-03-08 20:52:55 +00001703 DIScope DS(Scope->getScopeNode());
1704 DIE *ScopeDIE = NULL;
1705 if (Scope->getInlinedAt())
1706 ScopeDIE = constructInlinedScopeDIE(Scope);
1707 else if (DS.isSubprogram()) {
Devang Patel0dd45582010-06-28 20:53:04 +00001708 ProcessedSPNodes.insert(DS);
Devang Patel8aa61472010-07-07 22:20:57 +00001709 if (Scope->isAbstractScope()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001710 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patel8aa61472010-07-07 22:20:57 +00001711 // Note down abstract DIE.
1712 if (ScopeDIE)
1713 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
1714 }
Devang Patel3c91b052010-03-08 20:52:55 +00001715 else
Devang Patel2db49d72010-05-07 18:11:54 +00001716 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3c91b052010-03-08 20:52:55 +00001717 }
Devang Patelaead63c2010-03-29 22:59:58 +00001718 else
Devang Patel3c91b052010-03-08 20:52:55 +00001719 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patelaead63c2010-03-29 22:59:58 +00001720 if (!ScopeDIE) return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001721
Devang Patel53bb5c92009-11-10 23:06:00 +00001722 // Add variables to scope.
Devang Patele03161c2010-08-09 18:51:29 +00001723 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patel53bb5c92009-11-10 23:06:00 +00001724 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel8a241142009-12-09 18:24:21 +00001725 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001726 if (VariableDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001727 ScopeDIE->addChild(VariableDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001728 }
1729
1730 // Add nested scopes.
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001731 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
Devang Patel53bb5c92009-11-10 23:06:00 +00001732 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1733 // Define the Scope debug information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001734 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001735 if (NestedDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001736 ScopeDIE->addChild(NestedDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001737 }
Devang Patel193f7202009-11-24 01:14:22 +00001738
Jim Grosbach1e20b962010-07-21 21:21:52 +00001739 if (DS.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001740 addPubTypes(DISubprogram(DS));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001741
Devang Patel193f7202009-11-24 01:14:22 +00001742 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +00001743}
1744
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001745/// GetOrCreateSourceID - Look up the source id with the given directory and
1746/// source file names. If none currently exists, create a new id and insert it
1747/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1748/// maps as well.
Chris Lattner1d65ba72010-03-31 06:06:37 +00001749unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName){
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001750 unsigned DId;
Devang Patel37032352010-07-27 20:51:15 +00001751 assert (DirName.empty() == false && "Invalid directory name!");
Devang Patel2f584852010-07-24 00:53:22 +00001752
Devang Patel1905a182010-09-16 20:57:49 +00001753 // If FE did not provide a file name, then assume stdin.
1754 if (FileName.empty())
1755 return GetOrCreateSourceID(DirName, "<stdin>");
1756
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001757 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1758 if (DI != DirectoryIdMap.end()) {
1759 DId = DI->getValue();
1760 } else {
1761 DId = DirectoryNames.size() + 1;
1762 DirectoryIdMap[DirName] = DId;
1763 DirectoryNames.push_back(DirName);
1764 }
1765
1766 unsigned FId;
1767 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1768 if (FI != SourceFileIdMap.end()) {
1769 FId = FI->getValue();
1770 } else {
1771 FId = SourceFileNames.size() + 1;
1772 SourceFileIdMap[FileName] = FId;
1773 SourceFileNames.push_back(FileName);
1774 }
1775
1776 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1777 SourceIdMap.find(std::make_pair(DId, FId));
1778 if (SI != SourceIdMap.end())
1779 return SI->second;
1780
1781 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1782 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1783 SourceIds.push_back(std::make_pair(DId, FId));
1784
1785 return SrcId;
1786}
1787
Devang Patel6404e4e2009-12-15 19:16:48 +00001788/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1789DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel163a9f72010-05-10 22:49:55 +00001790 CompileUnit *TheCU = getCompileUnit(NS);
1791 DIE *NDie = TheCU->getDIE(NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001792 if (NDie)
1793 return NDie;
1794 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel163a9f72010-05-10 22:49:55 +00001795 TheCU->insertDIE(NS, NDie);
Devang Patel6404e4e2009-12-15 19:16:48 +00001796 if (!NS.getName().empty())
1797 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
Devang Patel81625742010-08-09 20:20:05 +00001798 addSourceLine(NDie, NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001799 addToContextOwner(NDie, NS.getContext());
1800 return NDie;
1801}
1802
Jim Grosbach1e20b962010-07-21 21:21:52 +00001803/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel163a9f72010-05-10 22:49:55 +00001804/// metadata node with tag DW_TAG_compile_unit.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001805void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001806 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +00001807 StringRef FN = DIUnit.getFilename();
1808 StringRef Dir = DIUnit.getDirectory();
Devang Patel5ccdd102009-09-29 18:40:58 +00001809 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001810
1811 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001812 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001813 DIUnit.getProducer());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001814 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001815 DIUnit.getLanguage());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001816 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patel5098da02010-04-26 22:54:28 +00001817 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1818 // simplifies debug range entries.
Devang Patel9b93b6b2010-06-28 22:22:47 +00001819 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Patel4a602ca2010-03-22 23:11:36 +00001820 // DW_AT_stmt_list is a offset of line number information for this
Devang Patelaf608bd2010-08-24 00:06:12 +00001821 // compile unit in debug_line section.
Devang Patelae84d5b2010-08-31 23:50:19 +00001822 if (Asm->MAI->doesDwarfUsesAbsoluteLabelForStmtList())
1823 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_addr,
1824 Asm->GetTempSymbol("section_line"));
1825 else
1826 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001827
Devang Patel65dbc902009-11-25 17:36:49 +00001828 if (!Dir.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001829 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001830 if (DIUnit.isOptimized())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001831 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001832
Devang Patel65dbc902009-11-25 17:36:49 +00001833 StringRef Flags = DIUnit.getFlags();
1834 if (!Flags.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001835 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001836
1837 unsigned RVer = DIUnit.getRunTimeVersion();
1838 if (RVer)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001839 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001840 dwarf::DW_FORM_data1, RVer);
1841
Devang Patel163a9f72010-05-10 22:49:55 +00001842 CompileUnit *NewCU = new CompileUnit(ID, Die);
1843 if (!FirstCU)
1844 FirstCU = NewCU;
1845 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001846}
1847
Devang Patel163a9f72010-05-10 22:49:55 +00001848/// getCompielUnit - Get CompileUnit DIE.
1849CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1850 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1851 DIDescriptor D(N);
1852 const MDNode *CUNode = NULL;
1853 if (D.isCompileUnit())
1854 CUNode = N;
1855 else if (D.isSubprogram())
1856 CUNode = DISubprogram(N).getCompileUnit();
1857 else if (D.isType())
1858 CUNode = DIType(N).getCompileUnit();
1859 else if (D.isGlobalVariable())
1860 CUNode = DIGlobalVariable(N).getCompileUnit();
1861 else if (D.isVariable())
1862 CUNode = DIVariable(N).getCompileUnit();
1863 else if (D.isNameSpace())
1864 CUNode = DINameSpace(N).getCompileUnit();
1865 else if (D.isFile())
1866 CUNode = DIFile(N).getCompileUnit();
1867 else
1868 return FirstCU;
1869
1870 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1871 = CUMap.find(CUNode);
1872 if (I == CUMap.end())
1873 return FirstCU;
1874 return I->second;
1875}
1876
Devang Patel0c4720c2010-08-23 18:25:56 +00001877/// isUnsignedDIType - Return true if type encoding is unsigned.
1878static bool isUnsignedDIType(DIType Ty) {
1879 DIDerivedType DTy(Ty);
1880 if (DTy.Verify())
1881 return isUnsignedDIType(DTy.getTypeDerivedFrom());
1882
1883 DIBasicType BTy(Ty);
1884 if (BTy.Verify()) {
1885 unsigned Encoding = BTy.getEncoding();
1886 if (Encoding == dwarf::DW_ATE_unsigned ||
1887 Encoding == dwarf::DW_ATE_unsigned_char)
1888 return true;
1889 }
1890 return false;
1891}
Devang Patel163a9f72010-05-10 22:49:55 +00001892
1893/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001894void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel9fa539c2010-08-10 01:37:23 +00001895 DIGlobalVariable GV(N);
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001896
Devang Patel905cf5e2009-09-04 23:59:07 +00001897 // If debug information is malformed then ignore it.
Devang Patel9fa539c2010-08-10 01:37:23 +00001898 if (GV.Verify() == false)
Devang Patel905cf5e2009-09-04 23:59:07 +00001899 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001900
1901 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00001902 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel9fa539c2010-08-10 01:37:23 +00001903 if (TheCU->getDIE(GV))
Devang Patel13e16b62009-06-26 01:49:18 +00001904 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001905
Devang Patel9fa539c2010-08-10 01:37:23 +00001906 DIType GTy = GV.getType();
Devang Patel29368072010-08-10 07:11:13 +00001907 DIE *VariableDIE = new DIE(GV.getTag());
1908
1909 bool isGlobalVariable = GV.getGlobal() != NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001910
Devang Patel9fa539c2010-08-10 01:37:23 +00001911 // Add name.
1912 addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1913 GV.getDisplayName());
1914 StringRef LinkageName = GV.getLinkageName();
Devang Patel29368072010-08-10 07:11:13 +00001915 if (!LinkageName.empty() && isGlobalVariable)
Devang Patel9fa539c2010-08-10 01:37:23 +00001916 addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
1917 getRealLinkageName(LinkageName));
1918 // Add type.
1919 addType(VariableDIE, GTy);
Devang Patel50d80e32010-04-13 20:35:04 +00001920 if (GTy.isCompositeType() && !GTy.getName().empty()
1921 && !GTy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001922 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001923 assert(Entry && "Missing global type!");
Devang Patel163a9f72010-05-10 22:49:55 +00001924 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001925 }
Devang Patel9fa539c2010-08-10 01:37:23 +00001926 // Add scoping info.
1927 if (!GV.isLocalToUnit()) {
1928 addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1929 // Expose as global.
1930 TheCU->addGlobal(GV.getName(), VariableDIE);
1931 }
1932 // Add line number info.
1933 addSourceLine(VariableDIE, GV);
1934 // Add to map.
1935 TheCU->insertDIE(N, VariableDIE);
1936 // Add to context owner.
1937 DIDescriptor GVContext = GV.getContext();
1938 addToContextOwner(VariableDIE, GVContext);
1939 // Add location.
Devang Patel29368072010-08-10 07:11:13 +00001940 if (isGlobalVariable) {
1941 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1942 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1943 addLabel(Block, 0, dwarf::DW_FORM_udata,
1944 Asm->Mang->getSymbol(GV.getGlobal()));
1945 // Do not create specification DIE if context is either compile unit
1946 // or a subprogram.
1947 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
1948 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
1949 // Create specification DIE.
1950 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1951 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1952 dwarf::DW_FORM_ref4, VariableDIE);
1953 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1954 addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1955 TheCU->addDie(VariableSpecDIE);
1956 } else {
1957 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
1958 }
1959 } else if (Constant *C = GV.getConstant()) {
1960 if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
Devang Patel0c4720c2010-08-23 18:25:56 +00001961 if (isUnsignedDIType(GTy))
Devang Patel29368072010-08-10 07:11:13 +00001962 addUInt(VariableDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
1963 CI->getZExtValue());
1964 else
1965 addSInt(VariableDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
1966 CI->getSExtValue());
Devang Patel29368072010-08-10 07:11:13 +00001967 }
Devang Patel9fa539c2010-08-10 01:37:23 +00001968 }
Devang Patel13e16b62009-06-26 01:49:18 +00001969 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001970}
1971
Devang Patel163a9f72010-05-10 22:49:55 +00001972/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001973void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001974 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001975
Stuart Hastings639336e2010-04-06 21:38:29 +00001976 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00001977 CompileUnit *TheCU = getCompileUnit(N);
1978 if (TheCU->getDIE(N))
Stuart Hastings639336e2010-04-06 21:38:29 +00001979 return;
1980
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001981 if (!SP.isDefinition())
1982 // This is a method declaration which will be handled while constructing
1983 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +00001984 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001985
Stuart Hastings639336e2010-04-06 21:38:29 +00001986 DIE *SubprogramDie = createSubprogramDIE(SP);
1987
1988 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +00001989 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001990
1991 // Add to context owner.
Devang Patel6404e4e2009-12-15 19:16:48 +00001992 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +00001993
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001994 // Expose as global.
Devang Patel163a9f72010-05-10 22:49:55 +00001995 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel193f7202009-11-24 01:14:22 +00001996
Devang Patel13e16b62009-06-26 01:49:18 +00001997 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001998}
1999
Devang Patel2c4ceb12009-11-21 02:48:08 +00002000/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbar00564992009-09-19 20:40:14 +00002001/// content. Create global DIEs and emit initial debug info sections.
2002/// This is inovked by the target AsmPrinter.
Chris Lattner75f50722010-04-04 07:48:20 +00002003void DwarfDebug::beginModule(Module *M) {
Devang Pateleac9c072010-04-27 19:46:33 +00002004 if (DisableDebugInfoPrinting)
2005 return;
2006
Devang Patel78ab9e22009-07-30 18:56:46 +00002007 DebugInfoFinder DbgFinder;
2008 DbgFinder.processModule(*M);
Devang Patel13e16b62009-06-26 01:49:18 +00002009
Chris Lattnerd850ac72010-04-05 02:19:28 +00002010 bool HasDebugInfo = false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002011
Chris Lattnerd850ac72010-04-05 02:19:28 +00002012 // Scan all the compile-units to see if there are any marked as the main unit.
2013 // if not, we do not generate debug info.
2014 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2015 E = DbgFinder.compile_unit_end(); I != E; ++I) {
2016 if (DICompileUnit(*I).isMain()) {
2017 HasDebugInfo = true;
2018 break;
2019 }
2020 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002021
Chris Lattnerd850ac72010-04-05 02:19:28 +00002022 if (!HasDebugInfo) return;
2023
2024 // Tell MMI that we have debug info.
2025 MMI->setDebugInfoAvailability(true);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002026
Chris Lattnerbe15beb2010-04-04 23:17:54 +00002027 // Emit initial sections.
Chris Lattnerd850ac72010-04-05 02:19:28 +00002028 EmitSectionLabels();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002029
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002030 // Create all the compile unit DIEs.
Devang Patel78ab9e22009-07-30 18:56:46 +00002031 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2032 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002033 constructCompileUnit(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002034
Devang Patel53bb5c92009-11-10 23:06:00 +00002035 // Create DIEs for each subprogram.
Devang Patel78ab9e22009-07-30 18:56:46 +00002036 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
2037 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002038 constructSubprogramDIE(*I);
Devang Patel13e16b62009-06-26 01:49:18 +00002039
Devang Patelc366f832009-12-10 19:14:49 +00002040 // Create DIEs for each global variable.
2041 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2042 E = DbgFinder.global_variable_end(); I != E; ++I)
2043 constructGlobalVariableDIE(*I);
2044
Devang Patele7e5a0f2010-08-10 20:01:20 +00002045 //getOrCreateTypeDIE
2046 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
2047 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2048 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2049
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002050 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +00002051 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002052
2053 // Print out .file directives to specify files for .loc directives. These are
2054 // printed out early so that they precede any .loc directives.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002055 if (Asm->MAI->hasDotLocAndDotFile()) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002056 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
2057 // Remember source id starts at 1.
2058 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
Chris Lattner0ad9c912010-01-22 22:09:00 +00002059 // FIXME: don't use sys::path for this! This should not depend on the
2060 // host.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002061 sys::Path FullPath(getSourceDirectoryName(Id.first));
2062 bool AppendOk =
2063 FullPath.appendComponent(getSourceFileName(Id.second));
2064 assert(AppendOk && "Could not append filename to directory!");
2065 AppendOk = false;
Chris Lattnera6594fc2010-01-25 18:58:59 +00002066 Asm->OutStreamer.EmitDwarfFileDirective(i, FullPath.str());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002067 }
2068 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002069}
2070
Devang Patel2c4ceb12009-11-21 02:48:08 +00002071/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002072///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002073void DwarfDebug::endModule() {
Devang Patel163a9f72010-05-10 22:49:55 +00002074 if (!FirstCU) return;
Devang Patel4a1cad62010-06-28 18:25:03 +00002075 const Module *M = MMI->getModule();
Devang Patele9a1cca2010-08-02 17:32:15 +00002076 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patel4a1cad62010-06-28 18:25:03 +00002077 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2078 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2079 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2080 DISubprogram SP(AllSPs->getOperand(SI));
2081 if (!SP.Verify()) continue;
2082
2083 // Collect info for variables that were optimized out.
Devang Patel8b3a6b62010-07-19 17:53:55 +00002084 if (!SP.isDefinition()) continue;
Devang Patel4a1cad62010-06-28 18:25:03 +00002085 StringRef FName = SP.getLinkageName();
2086 if (FName.empty())
2087 FName = SP.getName();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002088 NamedMDNode *NMD =
Devang Patel4a1cad62010-06-28 18:25:03 +00002089 M->getNamedMetadata(Twine("llvm.dbg.lv.", getRealLinkageName(FName)));
2090 if (!NMD) continue;
2091 unsigned E = NMD->getNumOperands();
2092 if (!E) continue;
2093 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Patele9a1cca2010-08-02 17:32:15 +00002094 DeadFnScopeMap[SP] = Scope;
Devang Patel4a1cad62010-06-28 18:25:03 +00002095 for (unsigned I = 0; I != E; ++I) {
2096 DIVariable DV(NMD->getOperand(I));
2097 if (!DV.Verify()) continue;
2098 Scope->addVariable(new DbgVariable(DV));
2099 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002100
Devang Patel4a1cad62010-06-28 18:25:03 +00002101 // Construct subprogram DIE and add variables DIEs.
2102 constructSubprogramDIE(SP);
2103 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patele03161c2010-08-09 18:51:29 +00002104 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patel4a1cad62010-06-28 18:25:03 +00002105 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2106 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2107 if (VariableDIE)
2108 ScopeDIE->addChild(VariableDIE);
2109 }
2110 }
2111 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002112
Devang Patel53bb5c92009-11-10 23:06:00 +00002113 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2114 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2115 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2116 DIE *ISP = *AI;
Devang Patel2c4ceb12009-11-21 02:48:08 +00002117 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +00002118 }
2119
Devang Patele9f8f5e2010-05-07 20:54:48 +00002120 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Patel5d11eb02009-12-03 19:11:07 +00002121 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2122 DIE *SPDie = CI->first;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002123 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Patel5d11eb02009-12-03 19:11:07 +00002124 if (!N) continue;
Devang Patel163a9f72010-05-10 22:49:55 +00002125 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Patel5d11eb02009-12-03 19:11:07 +00002126 if (!NDie) continue;
2127 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patel5d11eb02009-12-03 19:11:07 +00002128 }
2129
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002130 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002131 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002132 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002133 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002134 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002135
2136 // End text sections.
2137 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002138 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnerc0215722010-04-04 19:25:43 +00002139 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002140 }
2141
2142 // Emit common frame information.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002143 emitCommonDebugFrame();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002144
2145 // Emit function debug frame information
2146 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2147 E = DebugFrames.end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002148 emitFunctionDebugFrame(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002149
2150 // Compute DIE offsets and sizes.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002151 computeSizeAndOffsets();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002152
2153 // Emit all the DIEs into a debug info section
Devang Patel2c4ceb12009-11-21 02:48:08 +00002154 emitDebugInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002155
2156 // Corresponding abbreviations into a abbrev section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002157 emitAbbreviations();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002158
Devang Patelaf608bd2010-08-24 00:06:12 +00002159 // Emit source line correspondence into a debug line section.
2160 emitDebugLines();
2161
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002162 // Emit info into a debug pubnames section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002163 emitDebugPubNames();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002164
Devang Patel193f7202009-11-24 01:14:22 +00002165 // Emit info into a debug pubtypes section.
2166 emitDebugPubTypes();
2167
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002168 // Emit info into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002169 emitDebugLoc();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002170
2171 // Emit info into a debug aranges section.
2172 EmitDebugARanges();
2173
2174 // Emit info into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002175 emitDebugRanges();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002176
2177 // Emit info into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002178 emitDebugMacInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002179
2180 // Emit inline info.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002181 emitDebugInlineInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002182
Chris Lattnerbc733f52010-03-13 02:17:42 +00002183 // Emit info into a debug str section.
2184 emitDebugStr();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002185
Devang Patele9a1cca2010-08-02 17:32:15 +00002186 // clean up.
2187 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel163a9f72010-05-10 22:49:55 +00002188 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2189 E = CUMap.end(); I != E; ++I)
2190 delete I->second;
2191 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002192}
2193
Devang Patel53bb5c92009-11-10 23:06:00 +00002194/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002195DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattnerde4845c2010-04-02 19:42:39 +00002196 DebugLoc ScopeLoc) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002197
Devang Patel2db49d72010-05-07 18:11:54 +00002198 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00002199 if (AbsDbgVariable)
2200 return AbsDbgVariable;
2201
Devang Patel2db49d72010-05-07 18:11:54 +00002202 LLVMContext &Ctx = Var->getContext();
Chris Lattnerde4845c2010-04-02 19:42:39 +00002203 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00002204 if (!Scope)
2205 return NULL;
2206
Devang Patel26c1e562010-05-20 16:36:41 +00002207 AbsDbgVariable = new DbgVariable(Var);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002208 Scope->addVariable(AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00002209 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00002210 return AbsDbgVariable;
2211}
2212
Devang Patelee432862010-05-20 19:57:06 +00002213/// collectVariableInfoFromMMITable - Collect variable information from
2214/// side table maintained by MMI.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002215void
Devang Patelee432862010-05-20 19:57:06 +00002216DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2217 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00002218 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patele717faa2009-10-06 01:26:37 +00002219 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2220 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2221 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00002222 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00002223 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00002224 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002225 DIVariable DV(Var);
2226 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00002227
Chris Lattnerde4845c2010-04-02 19:42:39 +00002228 DbgScope *Scope = 0;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002229 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattnerde4845c2010-04-02 19:42:39 +00002230 Scope = ConcreteScopes.lookup(IA);
2231 if (Scope == 0)
2232 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002233
Devang Patelfb0ee432009-11-10 23:20:04 +00002234 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00002235 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00002236 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00002237
Devang Patel26c1e562010-05-20 16:36:41 +00002238 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2239 DbgVariable *RegVar = new DbgVariable(DV);
2240 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002241 Scope->addVariable(RegVar);
Devang Patel26c1e562010-05-20 16:36:41 +00002242 if (AbsDbgVariable) {
2243 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2244 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2245 }
Devang Patele717faa2009-10-06 01:26:37 +00002246 }
Devang Patelee432862010-05-20 19:57:06 +00002247}
Devang Patel90a48ad2010-03-15 18:33:46 +00002248
Jim Grosbach1e20b962010-07-21 21:21:52 +00002249/// isDbgValueInUndefinedReg - Return true if debug value, encoded by
Devang Patelc3f5f782010-05-25 23:40:22 +00002250/// DBG_VALUE instruction, is in undefined reg.
2251static bool isDbgValueInUndefinedReg(const MachineInstr *MI) {
2252 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2253 if (MI->getOperand(0).isReg() && !MI->getOperand(0).getReg())
2254 return true;
2255 return false;
2256}
2257
Jim Grosbach1e20b962010-07-21 21:21:52 +00002258/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patelc3f5f782010-05-25 23:40:22 +00002259/// DBG_VALUE instruction, is in a defined reg.
2260static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2261 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2262 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2263 return true;
2264 return false;
2265}
2266
Devang Patelee432862010-05-20 19:57:06 +00002267/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002268void
Devang Patel78e127d2010-06-25 22:07:34 +00002269DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2270 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002271
Devang Patelee432862010-05-20 19:57:06 +00002272 /// collection info from MMI table.
2273 collectVariableInfoFromMMITable(MF, Processed);
2274
2275 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patel90a48ad2010-03-15 18:33:46 +00002276 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002277 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelee432862010-05-20 19:57:06 +00002278 I != E; ++I)
Devang Patel90a48ad2010-03-15 18:33:46 +00002279 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2280 II != IE; ++II) {
2281 const MachineInstr *MInsn = II;
Devang Patelc3f5f782010-05-25 23:40:22 +00002282 if (!MInsn->isDebugValue() || isDbgValueInUndefinedReg(MInsn))
Devang Patel90a48ad2010-03-15 18:33:46 +00002283 continue;
Devang Patelee432862010-05-20 19:57:06 +00002284 DbgValues.push_back(MInsn);
2285 }
Devang Patel90a48ad2010-03-15 18:33:46 +00002286
Devang Patelc3f5f782010-05-25 23:40:22 +00002287 // This is a collection of DBV_VALUE instructions describing same variable.
2288 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patelee432862010-05-20 19:57:06 +00002289 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2290 E = DbgValues.end(); I != E; ++I) {
2291 const MachineInstr *MInsn = *I;
Devang Patelc3f5f782010-05-25 23:40:22 +00002292 MultipleValues.clear();
2293 if (isDbgValueInDefinedReg(MInsn))
2294 MultipleValues.push_back(MInsn);
Devang Patelee432862010-05-20 19:57:06 +00002295 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2296 if (Processed.count(DV) != 0)
2297 continue;
2298
Devang Patel354eb7e2010-06-02 19:05:13 +00002299 const MachineInstr *PrevMI = MInsn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002300 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
Devang Patelc3f5f782010-05-25 23:40:22 +00002301 ME = DbgValues.end(); MI != ME; ++MI) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002302 const MDNode *Var =
Devang Patelc3f5f782010-05-25 23:40:22 +00002303 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002304 if (Var == DV && isDbgValueInDefinedReg(*MI) &&
Devang Patel354eb7e2010-06-02 19:05:13 +00002305 !PrevMI->isIdenticalTo(*MI))
Devang Patelc3f5f782010-05-25 23:40:22 +00002306 MultipleValues.push_back(*MI);
Devang Patel354eb7e2010-06-02 19:05:13 +00002307 PrevMI = *MI;
Devang Patelc3f5f782010-05-25 23:40:22 +00002308 }
2309
Devang Patelee432862010-05-20 19:57:06 +00002310 DbgScope *Scope = findDbgScope(MInsn);
Devang Pateld8720f42010-05-27 20:25:04 +00002311 bool CurFnArg = false;
2312 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2313 DISubprogram(DV.getContext()).describes(MF->getFunction()))
2314 CurFnArg = true;
2315 if (!Scope && CurFnArg)
Devang Patelc0c5a262010-05-21 00:10:20 +00002316 Scope = CurrentFnDbgScope;
Devang Patelee432862010-05-20 19:57:06 +00002317 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00002318 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00002319 continue;
2320
2321 Processed.insert(DV);
Devang Patelee432862010-05-20 19:57:06 +00002322 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patelee432862010-05-20 19:57:06 +00002323 Scope->addVariable(RegVar);
Devang Pateld8720f42010-05-27 20:25:04 +00002324 if (!CurFnArg)
Jim Grosbach1e20b962010-07-21 21:21:52 +00002325 DbgVariableLabelsMap[RegVar] = getLabelBeforeInsn(MInsn);
Devang Patelc0c5a262010-05-21 00:10:20 +00002326 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2327 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2328 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patel90a48ad2010-03-15 18:33:46 +00002329 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002330 if (MultipleValues.size() <= 1) {
2331 DbgVariableToDbgInstMap[RegVar] = MInsn;
2332 continue;
2333 }
2334
2335 // handle multiple DBG_VALUE instructions describing one variable.
Devang Patelc3f5f782010-05-25 23:40:22 +00002336 if (DotDebugLocEntries.empty())
Devang Patel80250682010-05-26 23:55:23 +00002337 RegVar->setDotDebugLocOffset(0);
2338 else
2339 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Devang Patele2df8422010-05-26 17:29:32 +00002340 const MachineInstr *Begin = NULL;
2341 const MachineInstr *End = NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002342 for (SmallVector<const MachineInstr *, 4>::iterator
2343 MVI = MultipleValues.begin(), MVE = MultipleValues.end();
Devang Patel61409622010-07-07 20:12:52 +00002344 MVI != MVE; ++MVI) {
Devang Patele2df8422010-05-26 17:29:32 +00002345 if (!Begin) {
2346 Begin = *MVI;
2347 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002348 }
Devang Patele2df8422010-05-26 17:29:32 +00002349 End = *MVI;
Devang Patelc3f5f782010-05-25 23:40:22 +00002350 MachineLocation MLoc;
Devang Patelb2cf5812010-08-04 18:40:52 +00002351 if (Begin->getNumOperands() == 3) {
2352 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2353 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2354 } else
2355 MLoc = Asm->getDebugValueLocation(Begin);
2356
Devang Patele2df8422010-05-26 17:29:32 +00002357 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2358 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patel5573a7d2010-08-04 22:07:27 +00002359 if (MLoc.getReg())
2360 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
2361
Devang Patele2df8422010-05-26 17:29:32 +00002362 Begin = End;
2363 if (MVI + 1 == MVE) {
2364 // If End is the last instruction then its value is valid
Devang Patelc3f5f782010-05-25 23:40:22 +00002365 // until the end of the funtion.
Devang Patelb2cf5812010-08-04 18:40:52 +00002366 MachineLocation EMLoc;
2367 if (End->getNumOperands() == 3) {
2368 if (End->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2369 EMLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2370 } else
2371 EMLoc = Asm->getDebugValueLocation(End);
Devang Patel5573a7d2010-08-04 22:07:27 +00002372 if (EMLoc.getReg())
2373 DotDebugLocEntries.
2374 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, EMLoc));
Devang Patelc3f5f782010-05-25 23:40:22 +00002375 }
2376 }
2377 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00002378 }
Devang Patel98e1cac2010-05-14 21:01:35 +00002379
2380 // Collect info for variables that were optimized out.
Devang Pateld1bbc6b2010-06-22 01:01:58 +00002381 const Function *F = MF->getFunction();
2382 const Module *M = F->getParent();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002383 if (NamedMDNode *NMD =
2384 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patela762b092010-06-22 01:19:38 +00002385 getRealLinkageName(F->getName())))) {
Devang Patel98e1cac2010-05-14 21:01:35 +00002386 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman872814a2010-07-21 18:54:18 +00002387 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patelee432862010-05-20 19:57:06 +00002388 if (!DV || !Processed.insert(DV))
Devang Patel98e1cac2010-05-14 21:01:35 +00002389 continue;
2390 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2391 if (Scope)
Devang Patel26c1e562010-05-20 16:36:41 +00002392 Scope->addVariable(new DbgVariable(DV));
Devang Patel98e1cac2010-05-14 21:01:35 +00002393 }
2394 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002395}
Devang Patel98e1cac2010-05-14 21:01:35 +00002396
Devang Patelc3f5f782010-05-25 23:40:22 +00002397/// getLabelBeforeInsn - Return Label preceding the instruction.
2398const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2399 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2400 LabelsBeforeInsn.find(MI);
2401 if (I == LabelsBeforeInsn.end())
2402 // FunctionBeginSym always preceeds all the instruction in current function.
2403 return FunctionBeginSym;
2404 return I->second;
2405}
2406
2407/// getLabelAfterInsn - Return Label immediately following the instruction.
2408const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2409 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2410 LabelsAfterInsn.find(MI);
2411 if (I == LabelsAfterInsn.end())
2412 return NULL;
2413 return I->second;
Devang Patele717faa2009-10-06 01:26:37 +00002414}
2415
Devang Patel553881b2010-03-29 17:20:31 +00002416/// beginScope - Process beginning of a scope.
2417void DwarfDebug::beginScope(const MachineInstr *MI) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002418 if (InsnNeedsLabel.count(MI) == 0) {
2419 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patel553881b2010-03-29 17:20:31 +00002420 return;
Devang Patelc3f5f782010-05-25 23:40:22 +00002421 }
Devang Patelaead63c2010-03-29 22:59:58 +00002422
Devang Patelb2b31a62010-05-26 19:37:24 +00002423 // Check location.
2424 DebugLoc DL = MI->getDebugLoc();
2425 if (!DL.isUnknown()) {
2426 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2427 PrevLabel = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
Devang Pateleac9c072010-04-27 19:46:33 +00002428 PrevInstLoc = DL;
Devang Patelb2b31a62010-05-26 19:37:24 +00002429 LabelsBeforeInsn[MI] = PrevLabel;
2430 return;
Devang Pateleac9c072010-04-27 19:46:33 +00002431 }
Devang Patel553881b2010-03-29 17:20:31 +00002432
Jim Grosbach1e20b962010-07-21 21:21:52 +00002433 // If location is unknown then use temp label for this DBG_VALUE
Devang Patelb2b31a62010-05-26 19:37:24 +00002434 // instruction.
2435 if (MI->isDebugValue()) {
Devang Patel77051f52010-05-26 21:23:46 +00002436 PrevLabel = MMI->getContext().CreateTempSymbol();
2437 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00002438 LabelsBeforeInsn[MI] = PrevLabel;
2439 return;
2440 }
2441
2442 if (UnknownLocations) {
2443 PrevLabel = recordSourceLine(0, 0, 0);
2444 LabelsBeforeInsn[MI] = PrevLabel;
2445 return;
2446 }
2447
2448 assert (0 && "Instruction is not processed!");
Devang Patel0d20ac82009-10-06 01:50:42 +00002449}
2450
Devang Patel2c4ceb12009-11-21 02:48:08 +00002451/// endScope - Process end of a scope.
2452void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel1c246352010-04-08 16:50:29 +00002453 if (InsnsEndScopeSet.count(MI) != 0) {
2454 // Emit a label if this instruction ends a scope.
2455 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2456 Asm->OutStreamer.EmitLabel(Label);
Devang Pateleac9c072010-04-27 19:46:33 +00002457 LabelsAfterInsn[MI] = Label;
Devang Patel1c246352010-04-08 16:50:29 +00002458 }
Devang Patel53bb5c92009-11-10 23:06:00 +00002459}
2460
Devang Pateleac9c072010-04-27 19:46:33 +00002461/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002462DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel61409622010-07-07 20:12:52 +00002463 const MDNode *InlinedAt) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002464 if (!InlinedAt) {
2465 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2466 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002467 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002468 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2469 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Pateleac9c072010-04-27 19:46:33 +00002470 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002471 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002472 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Pateleac9c072010-04-27 19:46:33 +00002473 WScope->setParent(Parent);
2474 Parent->addScope(WScope);
2475 }
2476
2477 if (!WScope->getParent()) {
2478 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastingscad22ad2010-06-15 23:06:30 +00002479 // We used to check only for a linkage name, but that fails
2480 // since we began omitting the linkage name for private
2481 // functions. The new way is to check for the name in metadata,
2482 // but that's not supported in old .ll test cases. Ergo, we
2483 // check both.
Stuart Hastings215aa152010-06-11 20:08:44 +00002484 if (SPName == Asm->MF->getFunction()->getName() ||
2485 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Pateleac9c072010-04-27 19:46:33 +00002486 CurrentFnDbgScope = WScope;
2487 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002488
Devang Pateleac9c072010-04-27 19:46:33 +00002489 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002490 }
2491
Devang Patel78e127d2010-06-25 22:07:34 +00002492 getOrCreateAbstractScope(Scope);
Devang Patel53bb5c92009-11-10 23:06:00 +00002493 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2494 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002495 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002496
2497 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2498 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2499 DILocation DL(InlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002500 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002501 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Pateleac9c072010-04-27 19:46:33 +00002502 WScope->setParent(Parent);
2503 Parent->addScope(WScope);
2504
2505 ConcreteScopes[InlinedAt] = WScope;
Devang Pateleac9c072010-04-27 19:46:33 +00002506
2507 return WScope;
Devang Patel0d20ac82009-10-06 01:50:42 +00002508}
2509
Devang Pateleac9c072010-04-27 19:46:33 +00002510/// hasValidLocation - Return true if debug location entry attached with
2511/// machine instruction encodes valid location info.
2512static bool hasValidLocation(LLVMContext &Ctx,
2513 const MachineInstr *MInsn,
Devang Patele9f8f5e2010-05-07 20:54:48 +00002514 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Pateleac9c072010-04-27 19:46:33 +00002515 DebugLoc DL = MInsn->getDebugLoc();
2516 if (DL.isUnknown()) return false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002517
Devang Patele9f8f5e2010-05-07 20:54:48 +00002518 const MDNode *S = DL.getScope(Ctx);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002519
Devang Pateleac9c072010-04-27 19:46:33 +00002520 // There is no need to create another DIE for compile unit. For all
2521 // other scopes, create one DbgScope now. This will be translated
2522 // into a scope DIE at the end.
2523 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002524
Devang Pateleac9c072010-04-27 19:46:33 +00002525 Scope = S;
2526 InlinedAt = DL.getInlinedAt(Ctx);
2527 return true;
2528}
2529
2530/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2531/// hierarchy.
2532static void calculateDominanceGraph(DbgScope *Scope) {
2533 assert (Scope && "Unable to calculate scop edominance graph!");
2534 SmallVector<DbgScope *, 4> WorkStack;
2535 WorkStack.push_back(Scope);
2536 unsigned Counter = 0;
2537 while (!WorkStack.empty()) {
2538 DbgScope *WS = WorkStack.back();
2539 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2540 bool visitedChildren = false;
2541 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2542 SE = Children.end(); SI != SE; ++SI) {
2543 DbgScope *ChildScope = *SI;
2544 if (!ChildScope->getDFSOut()) {
2545 WorkStack.push_back(ChildScope);
2546 visitedChildren = true;
2547 ChildScope->setDFSIn(++Counter);
2548 break;
2549 }
2550 }
2551 if (!visitedChildren) {
2552 WorkStack.pop_back();
2553 WS->setDFSOut(++Counter);
2554 }
2555 }
2556}
2557
2558/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002559static
Devang Pateleac9c072010-04-27 19:46:33 +00002560void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2561 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2562{
2563#ifndef NDEBUG
2564 unsigned PrevDFSIn = 0;
2565 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2566 I != E; ++I) {
2567 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2568 II != IE; ++II) {
2569 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002570 const MDNode *Scope = NULL;
2571 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002572
2573 // Check if instruction has valid location information.
2574 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2575 dbgs() << " [ ";
Jim Grosbach1e20b962010-07-21 21:21:52 +00002576 if (InlinedAt)
Devang Pateleac9c072010-04-27 19:46:33 +00002577 dbgs() << "*";
Jim Grosbach1e20b962010-07-21 21:21:52 +00002578 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Pateleac9c072010-04-27 19:46:33 +00002579 MI2ScopeMap.find(MInsn);
2580 if (DI != MI2ScopeMap.end()) {
2581 DbgScope *S = DI->second;
2582 dbgs() << S->getDFSIn();
2583 PrevDFSIn = S->getDFSIn();
2584 } else
2585 dbgs() << PrevDFSIn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002586 } else
Devang Pateleac9c072010-04-27 19:46:33 +00002587 dbgs() << " [ x" << PrevDFSIn;
2588 dbgs() << " ]";
2589 MInsn->dump();
2590 }
2591 dbgs() << "\n";
2592 }
2593#endif
2594}
Devang Patel2c4ceb12009-11-21 02:48:08 +00002595/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner14d750d2010-03-31 05:39:57 +00002596/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattnereec791a2010-01-26 23:18:02 +00002597bool DwarfDebug::extractScopeInformation() {
Devang Patelaf9e8472009-10-01 20:31:14 +00002598 // If scope information was extracted using .dbg intrinsics then there is not
2599 // any need to extract these information by scanning each instruction.
2600 if (!DbgScopeMap.empty())
2601 return false;
2602
Dan Gohman314bf7c2010-04-23 01:18:53 +00002603 // Scan each instruction and create scopes. First build working set of scopes.
Devang Pateleac9c072010-04-27 19:46:33 +00002604 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2605 SmallVector<DbgRange, 4> MIRanges;
2606 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002607 const MDNode *PrevScope = NULL;
2608 const MDNode *PrevInlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002609 const MachineInstr *RangeBeginMI = NULL;
2610 const MachineInstr *PrevMI = NULL;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002611 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelaf9e8472009-10-01 20:31:14 +00002612 I != E; ++I) {
2613 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2614 II != IE; ++II) {
2615 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002616 const MDNode *Scope = NULL;
2617 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002618
2619 // Check if instruction has valid location information.
2620 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2621 PrevMI = MInsn;
2622 continue;
2623 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002624
Devang Pateleac9c072010-04-27 19:46:33 +00002625 // If scope has not changed then skip this instruction.
2626 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2627 PrevMI = MInsn;
2628 continue;
2629 }
2630
Jim Grosbach1e20b962010-07-21 21:21:52 +00002631 if (RangeBeginMI) {
2632 // If we have alread seen a beginning of a instruction range and
Devang Pateleac9c072010-04-27 19:46:33 +00002633 // current instruction scope does not match scope of first instruction
2634 // in this range then create a new instruction range.
2635 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002636 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel61409622010-07-07 20:12:52 +00002637 PrevInlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002638 MIRanges.push_back(R);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002639 }
Devang Pateleac9c072010-04-27 19:46:33 +00002640
2641 // This is a beginning of a new instruction range.
2642 RangeBeginMI = MInsn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002643
Devang Pateleac9c072010-04-27 19:46:33 +00002644 // Reset previous markers.
2645 PrevMI = MInsn;
2646 PrevScope = Scope;
2647 PrevInlinedAt = InlinedAt;
Devang Patel53bb5c92009-11-10 23:06:00 +00002648 }
2649 }
2650
Devang Pateleac9c072010-04-27 19:46:33 +00002651 // Create last instruction range.
2652 if (RangeBeginMI && PrevMI && PrevScope) {
2653 DbgRange R(RangeBeginMI, PrevMI);
2654 MIRanges.push_back(R);
2655 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patelaf9e8472009-10-01 20:31:14 +00002656 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002657
Devang Patel344130e2010-01-04 20:44:00 +00002658 if (!CurrentFnDbgScope)
2659 return false;
2660
Devang Pateleac9c072010-04-27 19:46:33 +00002661 calculateDominanceGraph(CurrentFnDbgScope);
2662 if (PrintDbgScope)
2663 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2664
2665 // Find ranges of instructions covered by each DbgScope;
2666 DbgScope *PrevDbgScope = NULL;
2667 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2668 RE = MIRanges.end(); RI != RE; ++RI) {
2669 const DbgRange &R = *RI;
2670 DbgScope *S = MI2ScopeMap.lookup(R.first);
2671 assert (S && "Lost DbgScope for a machine instruction!");
2672 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2673 PrevDbgScope->closeInsnRange(S);
2674 S->openInsnRange(R.first);
2675 S->extendInsnRange(R.second);
2676 PrevDbgScope = S;
2677 }
2678
2679 if (PrevDbgScope)
2680 PrevDbgScope->closeInsnRange();
Devang Patelaf9e8472009-10-01 20:31:14 +00002681
Devang Patele37b0c62010-04-08 18:43:56 +00002682 identifyScopeMarkers();
Devang Patel6122a4d2010-04-08 15:37:09 +00002683
2684 return !DbgScopeMap.empty();
2685}
2686
Jim Grosbach1e20b962010-07-21 21:21:52 +00002687/// identifyScopeMarkers() -
Devang Pateleac9c072010-04-27 19:46:33 +00002688/// Each DbgScope has first instruction and last instruction to mark beginning
2689/// and end of a scope respectively. Create an inverse map that list scopes
2690/// starts (and ends) with an instruction. One instruction may start (or end)
2691/// multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00002692void DwarfDebug::identifyScopeMarkers() {
Devang Patel42aafd72010-01-20 02:05:23 +00002693 SmallVector<DbgScope *, 4> WorkList;
2694 WorkList.push_back(CurrentFnDbgScope);
2695 while (!WorkList.empty()) {
Chris Lattner14d750d2010-03-31 05:39:57 +00002696 DbgScope *S = WorkList.pop_back_val();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002697
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002698 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002699 if (!Children.empty())
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002700 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00002701 SE = Children.end(); SI != SE; ++SI)
2702 WorkList.push_back(*SI);
2703
Devang Patel53bb5c92009-11-10 23:06:00 +00002704 if (S->isAbstractScope())
2705 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002706
Devang Pateleac9c072010-04-27 19:46:33 +00002707 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2708 if (Ranges.empty())
2709 continue;
2710 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2711 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002712 assert(RI->first && "DbgRange does not have first instruction!");
2713 assert(RI->second && "DbgRange does not have second instruction!");
Devang Pateleac9c072010-04-27 19:46:33 +00002714 InsnsEndScopeSet.insert(RI->second);
2715 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002716 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002717}
2718
Dan Gohman084751c2010-04-20 00:37:27 +00002719/// FindFirstDebugLoc - Find the first debug location in the function. This
2720/// is intended to be an approximation for the source position of the
2721/// beginning of the function.
2722static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2723 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2724 I != E; ++I)
2725 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2726 MBBI != MBBE; ++MBBI) {
2727 DebugLoc DL = MBBI->getDebugLoc();
2728 if (!DL.isUnknown())
2729 return DL;
2730 }
2731 return DebugLoc();
2732}
2733
Devang Patel2c4ceb12009-11-21 02:48:08 +00002734/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002735/// emitted immediately after the function entry point.
Chris Lattnereec791a2010-01-26 23:18:02 +00002736void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00002737 if (!MMI->hasDebugInfo()) return;
Bill Wendling5f017e82010-04-07 09:28:04 +00002738 if (!extractScopeInformation()) return;
Devang Patel60b35bd2009-10-06 18:37:31 +00002739
Devang Pateleac9c072010-04-27 19:46:33 +00002740 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2741 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002742 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00002743 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002744
2745 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2746 // function.
Dan Gohman084751c2010-04-20 00:37:27 +00002747 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002748 if (FDL.isUnknown()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002749
Devang Patele9f8f5e2010-05-07 20:54:48 +00002750 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings0db42712010-07-19 23:56:30 +00002751 const MDNode *TheScope = 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002752
Chris Lattnerde4845c2010-04-02 19:42:39 +00002753 DISubprogram SP = getDISubprogram(Scope);
2754 unsigned Line, Col;
2755 if (SP.Verify()) {
2756 Line = SP.getLineNumber();
2757 Col = 0;
Stuart Hastings0db42712010-07-19 23:56:30 +00002758 TheScope = SP;
Chris Lattnerde4845c2010-04-02 19:42:39 +00002759 } else {
2760 Line = FDL.getLine();
2761 Col = FDL.getCol();
Stuart Hastings0db42712010-07-19 23:56:30 +00002762 TheScope = Scope;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002763 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002764
Stuart Hastings0db42712010-07-19 23:56:30 +00002765 recordSourceLine(Line, Col, TheScope);
Devang Patelb2b31a62010-05-26 19:37:24 +00002766
Devang Patelb9abe9f2010-06-02 16:42:51 +00002767 /// ProcessedArgs - Collection of arguments already processed.
2768 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2769
Devang Patelb2b31a62010-05-26 19:37:24 +00002770 DebugLoc PrevLoc;
2771 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2772 I != E; ++I)
2773 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2774 II != IE; ++II) {
2775 const MachineInstr *MI = II;
2776 DebugLoc DL = MI->getDebugLoc();
2777 if (MI->isDebugValue()) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002778 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2779 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2780 if (!DV.Verify()) continue;
Devang Patel55e97172010-05-27 16:47:30 +00002781 // If DBG_VALUE is for a local variable then it needs a label.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002782 if (DV.getTag() != dwarf::DW_TAG_arg_variable
Devang Patel7fb231c2010-07-01 21:38:08 +00002783 && isDbgValueInUndefinedReg(MI) == false)
Devang Patelb2b31a62010-05-26 19:37:24 +00002784 InsnNeedsLabel.insert(MI);
Devang Patel55e97172010-05-27 16:47:30 +00002785 // DBG_VALUE for inlined functions argument needs a label.
Devang Patel7fb231c2010-07-01 21:38:08 +00002786 else if (!DISubprogram(getDISubprogram(DV.getContext())).
2787 describes(MF->getFunction()))
Devang Patel55e97172010-05-27 16:47:30 +00002788 InsnNeedsLabel.insert(MI);
2789 // DBG_VALUE indicating argument location change needs a label.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002790 else if (isDbgValueInUndefinedReg(MI) == false
2791 && !ProcessedArgs.insert(DV))
Devang Patelb2b31a62010-05-26 19:37:24 +00002792 InsnNeedsLabel.insert(MI);
2793 } else {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002794 // If location is unknown then instruction needs a location only if
Devang Patelb2b31a62010-05-26 19:37:24 +00002795 // UnknownLocations flag is set.
2796 if (DL.isUnknown()) {
2797 if (UnknownLocations && !PrevLoc.isUnknown())
2798 InsnNeedsLabel.insert(MI);
2799 } else if (DL != PrevLoc)
2800 // Otherwise, instruction needs a location only if it is new location.
2801 InsnNeedsLabel.insert(MI);
2802 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002803
Devang Patelb2b31a62010-05-26 19:37:24 +00002804 if (!DL.isUnknown() || UnknownLocations)
2805 PrevLoc = DL;
2806 }
2807
2808 PrevLabel = FunctionBeginSym;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002809}
2810
Devang Patel2c4ceb12009-11-21 02:48:08 +00002811/// endFunction - Gather and emit post-function debug information.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002812///
Chris Lattnereec791a2010-01-26 23:18:02 +00002813void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendling5f017e82010-04-07 09:28:04 +00002814 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00002815
Devang Patel344130e2010-01-04 20:44:00 +00002816 if (CurrentFnDbgScope) {
Devang Patel65eb4822010-05-22 00:04:14 +00002817
Devang Patelc3f5f782010-05-25 23:40:22 +00002818 // Define end label for subprogram.
2819 FunctionEndSym = Asm->GetTempSymbol("func_end",
2820 Asm->getFunctionNumber());
2821 // Assumes in correct section after the entry point.
2822 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002823
Devang Patel78e127d2010-06-25 22:07:34 +00002824 SmallPtrSet<const MDNode *, 16> ProcessedVars;
2825 collectVariableInfo(MF, ProcessedVars);
Devang Patel65eb4822010-05-22 00:04:14 +00002826
Devang Patel344130e2010-01-04 20:44:00 +00002827 // Get function line info.
2828 if (!Lines.empty()) {
2829 // Get section line info.
2830 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2831 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2832 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2833 // Append the function info to section info.
2834 SectionLineInfos.insert(SectionLineInfos.end(),
2835 Lines.begin(), Lines.end());
2836 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002837
Devang Patel344130e2010-01-04 20:44:00 +00002838 // Construct abstract scopes.
2839 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel78e127d2010-06-25 22:07:34 +00002840 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel78e127d2010-06-25 22:07:34 +00002841 DISubprogram SP((*AI)->getScopeNode());
2842 if (SP.Verify()) {
2843 // Collect info for variables that were optimized out.
2844 StringRef FName = SP.getLinkageName();
2845 if (FName.empty())
2846 FName = SP.getName();
2847 const Module *M = MF->getFunction()->getParent();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002848 if (NamedMDNode *NMD =
2849 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patel78e127d2010-06-25 22:07:34 +00002850 getRealLinkageName(FName)))) {
2851 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman872814a2010-07-21 18:54:18 +00002852 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel78e127d2010-06-25 22:07:34 +00002853 if (!DV || !ProcessedVars.insert(DV))
2854 continue;
Devang Patel1d68d212010-06-30 00:11:08 +00002855 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel78e127d2010-06-25 22:07:34 +00002856 if (Scope)
2857 Scope->addVariable(new DbgVariable(DV));
2858 }
2859 }
2860 }
Devang Patel90e19aa2010-06-30 01:40:11 +00002861 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
2862 constructScopeDIE(*AI);
Devang Patel78e127d2010-06-25 22:07:34 +00002863 }
Devang Patel61409622010-07-07 20:12:52 +00002864
Devang Patel9c488372010-05-04 06:15:30 +00002865 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002866
Devang Patel9c488372010-05-04 06:15:30 +00002867 if (!DisableFramePointerElim(*MF))
Jim Grosbach1e20b962010-07-21 21:21:52 +00002868 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel9c488372010-05-04 06:15:30 +00002869 dwarf::DW_FORM_flag, 1);
2870
2871
Chris Lattnerd38fee82010-04-05 00:13:49 +00002872 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel344130e2010-01-04 20:44:00 +00002873 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002874 }
2875
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002876 // Clear debug info
Devang Patelf54b8522010-01-19 01:26:02 +00002877 CurrentFnDbgScope = NULL;
Devang Patelb2b31a62010-05-26 19:37:24 +00002878 InsnNeedsLabel.clear();
Devang Patel26c1e562010-05-20 16:36:41 +00002879 DbgVariableToFrameIndexMap.clear();
2880 VarToAbstractVarMap.clear();
2881 DbgVariableToDbgInstMap.clear();
2882 DbgVariableLabelsMap.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002883 DeleteContainerSeconds(DbgScopeMap);
Devang Patel51424712010-04-09 16:04:20 +00002884 InsnsEndScopeSet.clear();
Devang Patelf54b8522010-01-19 01:26:02 +00002885 ConcreteScopes.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002886 DeleteContainerSeconds(AbstractScopes);
Devang Patelf54b8522010-01-19 01:26:02 +00002887 AbstractScopesList.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002888 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00002889 LabelsBeforeInsn.clear();
2890 LabelsAfterInsn.clear();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002891 Lines.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00002892 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002893}
2894
Devang Patel26c1e562010-05-20 16:36:41 +00002895/// recordVariableFrameIndex - Record a variable's index.
2896void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2897 assert (V && "Invalid DbgVariable!");
2898 DbgVariableToFrameIndexMap[V] = Index;
2899}
2900
2901/// findVariableFrameIndex - Return true if frame index for the variable
2902/// is found. Update FI to hold value of the index.
2903bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
2904 assert (V && "Invalid DbgVariable!");
2905 DenseMap<const DbgVariable *, int>::iterator I =
2906 DbgVariableToFrameIndexMap.find(V);
2907 if (I == DbgVariableToFrameIndexMap.end())
2908 return false;
2909 *FI = I->second;
2910 return true;
2911}
2912
2913/// findVariableLabel - Find MCSymbol for the variable.
2914const MCSymbol *DwarfDebug::findVariableLabel(const DbgVariable *V) {
2915 DenseMap<const DbgVariable *, const MCSymbol *>::iterator I
2916 = DbgVariableLabelsMap.find(V);
2917 if (I == DbgVariableLabelsMap.end())
2918 return NULL;
2919 else return I->second;
2920}
2921
Jim Grosbach1e20b962010-07-21 21:21:52 +00002922/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patelee432862010-05-20 19:57:06 +00002923/// instruction.
2924DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
2925 DbgScope *Scope = NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002926 LLVMContext &Ctx =
Devang Patelee432862010-05-20 19:57:06 +00002927 MInsn->getParent()->getParent()->getFunction()->getContext();
2928 DebugLoc DL = MInsn->getDebugLoc();
2929
Jim Grosbach1e20b962010-07-21 21:21:52 +00002930 if (DL.isUnknown())
Devang Patelee432862010-05-20 19:57:06 +00002931 return Scope;
2932
2933 if (const MDNode *IA = DL.getInlinedAt(Ctx))
2934 Scope = ConcreteScopes.lookup(IA);
2935 if (Scope == 0)
2936 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002937
Devang Patelee432862010-05-20 19:57:06 +00002938 return Scope;
2939}
2940
2941
Chris Lattnerc6087842010-03-09 04:54:43 +00002942/// recordSourceLine - Register a source line with debug info. Returns the
2943/// unique label that was emitted and which provides correspondence to
2944/// the source line list.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002945MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel61409622010-07-07 20:12:52 +00002946 const MDNode *S) {
Devang Patel65dbc902009-11-25 17:36:49 +00002947 StringRef Dir;
2948 StringRef Fn;
Devang Patelf84548d2009-10-05 18:03:19 +00002949
Dan Gohman1cc0d622010-05-05 23:41:32 +00002950 unsigned Src = 1;
2951 if (S) {
2952 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00002953
Dan Gohman1cc0d622010-05-05 23:41:32 +00002954 if (Scope.isCompileUnit()) {
2955 DICompileUnit CU(S);
2956 Dir = CU.getDirectory();
2957 Fn = CU.getFilename();
2958 } else if (Scope.isSubprogram()) {
2959 DISubprogram SP(S);
2960 Dir = SP.getDirectory();
2961 Fn = SP.getFilename();
2962 } else if (Scope.isLexicalBlock()) {
2963 DILexicalBlock DB(S);
2964 Dir = DB.getDirectory();
2965 Fn = DB.getFilename();
2966 } else
2967 assert(0 && "Unexpected scope info");
2968
2969 Src = GetOrCreateSourceID(Dir, Fn);
2970 }
2971
Chris Lattner63d78362010-03-14 08:36:50 +00002972 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattner25b68c62010-03-14 08:15:55 +00002973 Lines.push_back(SrcLineInfo(Line, Col, Src, Label));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002974
Chris Lattnerc6087842010-03-09 04:54:43 +00002975 Asm->OutStreamer.EmitLabel(Label);
2976 return Label;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002977}
2978
Bill Wendling829e67b2009-05-20 23:22:40 +00002979//===----------------------------------------------------------------------===//
2980// Emit Methods
2981//===----------------------------------------------------------------------===//
2982
Devang Patel2c4ceb12009-11-21 02:48:08 +00002983/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling94d04b82009-05-20 23:21:38 +00002984///
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002985unsigned
2986DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002987 // Get the children.
2988 const std::vector<DIE *> &Children = Die->getChildren();
2989
2990 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00002991 if (!Last && !Children.empty())
Benjamin Kramer345ef342010-03-31 19:34:01 +00002992 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling94d04b82009-05-20 23:21:38 +00002993
2994 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002995 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00002996
2997 // Get the abbreviation for this DIE.
2998 unsigned AbbrevNumber = Die->getAbbrevNumber();
2999 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3000
3001 // Set DIE offset
3002 Die->setOffset(Offset);
3003
3004 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00003005 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00003006
3007 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
3008 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3009
3010 // Size the DIE attribute values.
3011 for (unsigned i = 0, N = Values.size(); i < N; ++i)
3012 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00003013 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00003014
3015 // Size the DIE children if any.
3016 if (!Children.empty()) {
3017 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
3018 "Children flag not set");
3019
3020 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00003021 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling94d04b82009-05-20 23:21:38 +00003022
3023 // End of children marker.
3024 Offset += sizeof(int8_t);
3025 }
3026
3027 Die->setSize(Offset - Die->getOffset());
3028 return Offset;
3029}
3030
Devang Patel2c4ceb12009-11-21 02:48:08 +00003031/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling94d04b82009-05-20 23:21:38 +00003032///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003033void DwarfDebug::computeSizeAndOffsets() {
Devang Patel163a9f72010-05-10 22:49:55 +00003034 unsigned PrevOffset = 0;
3035 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3036 E = CUMap.end(); I != E; ++I) {
3037 // Compute size of compile unit header.
3038 static unsigned Offset = PrevOffset +
3039 sizeof(int32_t) + // Length of Compilation Unit Info
3040 sizeof(int16_t) + // DWARF version number
3041 sizeof(int32_t) + // Offset Into Abbrev. Section
3042 sizeof(int8_t); // Pointer Size (in bytes)
3043 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
3044 PrevOffset = Offset;
3045 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003046}
3047
Chris Lattner11b8f302010-04-04 23:02:02 +00003048/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3049/// temporary label to it if SymbolStem is specified.
Chris Lattner9c69e285532010-04-04 22:59:04 +00003050static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner11b8f302010-04-04 23:02:02 +00003051 const char *SymbolStem = 0) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00003052 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner11b8f302010-04-04 23:02:02 +00003053 if (!SymbolStem) return 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003054
Chris Lattner9c69e285532010-04-04 22:59:04 +00003055 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3056 Asm->OutStreamer.EmitLabel(TmpSym);
3057 return TmpSym;
3058}
3059
3060/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3061/// the start of each one.
Chris Lattnerfa070b02010-04-04 22:33:59 +00003062void DwarfDebug::EmitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003063 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003064
Bill Wendling94d04b82009-05-20 23:21:38 +00003065 // Dwarf sections base addresses.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003066 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00003067 DwarfFrameSectionSym =
3068 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3069 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003070
Jim Grosbach1e20b962010-07-21 21:21:52 +00003071 DwarfInfoSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003072 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003073 DwarfAbbrevSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003074 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner11b8f302010-04-04 23:02:02 +00003075 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003076
Chris Lattner9c69e285532010-04-04 22:59:04 +00003077 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner11b8f302010-04-04 23:02:02 +00003078 EmitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003079
Devang Patelaf608bd2010-08-24 00:06:12 +00003080 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner11b8f302010-04-04 23:02:02 +00003081 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3082 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3083 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003084 DwarfStrSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003085 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patelf2548ca2010-04-16 23:33:45 +00003086 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3087 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00003088
Devang Patelc3f5f782010-05-25 23:40:22 +00003089 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3090 "section_debug_loc");
3091
Chris Lattner9c69e285532010-04-04 22:59:04 +00003092 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattner4ad1efe2010-04-04 23:10:38 +00003093 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003094}
3095
Devang Patel2c4ceb12009-11-21 02:48:08 +00003096/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling94d04b82009-05-20 23:21:38 +00003097///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003098void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003099 // Get the abbreviation for this DIE.
3100 unsigned AbbrevNumber = Die->getAbbrevNumber();
3101 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3102
Bill Wendling94d04b82009-05-20 23:21:38 +00003103 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00003104 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00003105 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3106 Twine::utohexstr(Die->getOffset()) + ":0x" +
3107 Twine::utohexstr(Die->getSize()) + " " +
3108 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003109 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00003110
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00003111 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling94d04b82009-05-20 23:21:38 +00003112 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3113
3114 // Emit the DIE attribute values.
3115 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3116 unsigned Attr = AbbrevData[i].getAttribute();
3117 unsigned Form = AbbrevData[i].getForm();
3118 assert(Form && "Too many attributes for DIE (check abbreviation)");
3119
Chris Lattner3f53c832010-04-04 18:52:31 +00003120 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00003121 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003122
Bill Wendling94d04b82009-05-20 23:21:38 +00003123 switch (Attr) {
3124 case dwarf::DW_AT_sibling:
Devang Patel2c4ceb12009-11-21 02:48:08 +00003125 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003126 break;
3127 case dwarf::DW_AT_abstract_origin: {
3128 DIEEntry *E = cast<DIEEntry>(Values[i]);
3129 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00003130 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00003131 Asm->EmitInt32(Addr);
3132 break;
3133 }
Devang Patelf2548ca2010-04-16 23:33:45 +00003134 case dwarf::DW_AT_ranges: {
3135 // DW_AT_range Value encodes offset in debug_range section.
3136 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelb1fcfbe2010-09-02 16:43:44 +00003137
3138 if (Asm->MAI->doesDwarfUsesLabelOffsetForRanges()) {
3139 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
3140 V->getValue(),
3141 4);
3142 } else {
3143 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3144 V->getValue(),
3145 DwarfDebugRangeSectionSym,
3146 4);
3147 }
Devang Patelf2548ca2010-04-16 23:33:45 +00003148 break;
3149 }
Devang Patelc3f5f782010-05-25 23:40:22 +00003150 case dwarf::DW_AT_location: {
3151 if (UseDotDebugLocEntry.count(Die) != 0) {
3152 DIELabel *L = cast<DIELabel>(Values[i]);
3153 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
3154 } else
3155 Values[i]->EmitValue(Asm, Form);
3156 break;
3157 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003158 default:
3159 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003160 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00003161 break;
3162 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003163 }
3164
3165 // Emit the DIE children if any.
3166 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3167 const std::vector<DIE *> &Children = Die->getChildren();
3168
3169 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00003170 emitDIE(Children[j]);
Bill Wendling94d04b82009-05-20 23:21:38 +00003171
Chris Lattner3f53c832010-04-04 18:52:31 +00003172 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00003173 Asm->OutStreamer.AddComment("End Of Children Mark");
3174 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003175 }
3176}
3177
Devang Patel8a241142009-12-09 18:24:21 +00003178/// emitDebugInfo - Emit the debug info section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003179///
Devang Patel8a241142009-12-09 18:24:21 +00003180void DwarfDebug::emitDebugInfo() {
3181 // Start debug info section.
3182 Asm->OutStreamer.SwitchSection(
3183 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel163a9f72010-05-10 22:49:55 +00003184 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3185 E = CUMap.end(); I != E; ++I) {
3186 CompileUnit *TheCU = I->second;
3187 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00003188
Devang Patel163a9f72010-05-10 22:49:55 +00003189 // Emit the compile units header.
3190 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3191 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003192
Devang Patel163a9f72010-05-10 22:49:55 +00003193 // Emit size of content not including length itself
3194 unsigned ContentSize = Die->getSize() +
3195 sizeof(int16_t) + // DWARF version number
3196 sizeof(int32_t) + // Offset Into Abbrev. Section
3197 sizeof(int8_t) + // Pointer Size (in bytes)
3198 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003199
Devang Patel163a9f72010-05-10 22:49:55 +00003200 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3201 Asm->EmitInt32(ContentSize);
3202 Asm->OutStreamer.AddComment("DWARF version number");
3203 Asm->EmitInt16(dwarf::DWARF_VERSION);
3204 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3205 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3206 DwarfAbbrevSectionSym);
3207 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3208 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003209
Devang Patel163a9f72010-05-10 22:49:55 +00003210 emitDIE(Die);
3211 // FIXME - extra padding for gdb bug.
3212 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3213 Asm->EmitInt8(0);
3214 Asm->EmitInt8(0);
3215 Asm->EmitInt8(0);
3216 Asm->EmitInt8(0);
3217 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3218 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003219}
3220
Devang Patel2c4ceb12009-11-21 02:48:08 +00003221/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003222///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003223void DwarfDebug::emitAbbreviations() const {
Bill Wendling94d04b82009-05-20 23:21:38 +00003224 // Check to see if it is worth the effort.
3225 if (!Abbreviations.empty()) {
3226 // Start the debug abbrev section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003227 Asm->OutStreamer.SwitchSection(
3228 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003229
Chris Lattnerc0215722010-04-04 19:25:43 +00003230 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003231
3232 // For each abbrevation.
3233 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3234 // Get abbreviation data
3235 const DIEAbbrev *Abbrev = Abbreviations[i];
3236
3237 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003238 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00003239
3240 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003241 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00003242 }
3243
3244 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003245 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00003246
Chris Lattnerc0215722010-04-04 19:25:43 +00003247 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003248 }
3249}
3250
Devang Patel2c4ceb12009-11-21 02:48:08 +00003251/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling94d04b82009-05-20 23:21:38 +00003252/// the line matrix.
3253///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003254void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003255 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00003256 Asm->OutStreamer.AddComment("Extended Op");
3257 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003258
Chris Lattner233f52b2010-03-09 23:52:58 +00003259 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003260 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003261 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3262 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3263
3264 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00003265
Chris Lattnerc0215722010-04-04 19:25:43 +00003266 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003267 Asm->getTargetData().getPointerSize(),
3268 0/*AddrSpace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003269
3270 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00003271 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3272 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00003273 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00003274 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003275}
3276
Devang Patel2c4ceb12009-11-21 02:48:08 +00003277/// emitDebugLines - Emit source line information.
Bill Wendling94d04b82009-05-20 23:21:38 +00003278///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003279void DwarfDebug::emitDebugLines() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003280 // If the target is using .loc/.file, the assembler will be emitting the
3281 // .debug_line table automatically.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003282 if (Asm->MAI->hasDotLocAndDotFile())
Bill Wendling94d04b82009-05-20 23:21:38 +00003283 return;
3284
3285 // Minimum line delta, thus ranging from -10..(255-10).
3286 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
3287 // Maximum line delta, thus ranging from -10..(255-10).
3288 const int MaxLineDelta = 255 + MinLineDelta;
3289
3290 // Start the dwarf line section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003291 Asm->OutStreamer.SwitchSection(
3292 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003293
3294 // Construct the section header.
Chris Lattner233f52b2010-03-09 23:52:58 +00003295 Asm->OutStreamer.AddComment("Length of Source Line Info");
Chris Lattnera6437182010-04-04 19:58:12 +00003296 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_end"),
3297 Asm->GetTempSymbol("line_begin"), 4);
Chris Lattnerc0215722010-04-04 19:25:43 +00003298 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003299
Chris Lattner233f52b2010-03-09 23:52:58 +00003300 Asm->OutStreamer.AddComment("DWARF version number");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003301 Asm->EmitInt16(dwarf::DWARF_VERSION);
Bill Wendling94d04b82009-05-20 23:21:38 +00003302
Chris Lattner233f52b2010-03-09 23:52:58 +00003303 Asm->OutStreamer.AddComment("Prolog Length");
Chris Lattnera6437182010-04-04 19:58:12 +00003304 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_prolog_end"),
3305 Asm->GetTempSymbol("line_prolog_begin"), 4);
Chris Lattnerc0215722010-04-04 19:25:43 +00003306 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003307
Chris Lattner233f52b2010-03-09 23:52:58 +00003308 Asm->OutStreamer.AddComment("Minimum Instruction Length");
3309 Asm->EmitInt8(1);
3310 Asm->OutStreamer.AddComment("Default is_stmt_start flag");
3311 Asm->EmitInt8(1);
3312 Asm->OutStreamer.AddComment("Line Base Value (Special Opcodes)");
3313 Asm->EmitInt8(MinLineDelta);
3314 Asm->OutStreamer.AddComment("Line Range Value (Special Opcodes)");
3315 Asm->EmitInt8(MaxLineDelta);
3316 Asm->OutStreamer.AddComment("Special Opcode Base");
3317 Asm->EmitInt8(-MinLineDelta);
Bill Wendling94d04b82009-05-20 23:21:38 +00003318
3319 // Line number standard opcode encodings argument count
Chris Lattner233f52b2010-03-09 23:52:58 +00003320 Asm->OutStreamer.AddComment("DW_LNS_copy arg count");
3321 Asm->EmitInt8(0);
3322 Asm->OutStreamer.AddComment("DW_LNS_advance_pc arg count");
3323 Asm->EmitInt8(1);
3324 Asm->OutStreamer.AddComment("DW_LNS_advance_line arg count");
3325 Asm->EmitInt8(1);
3326 Asm->OutStreamer.AddComment("DW_LNS_set_file arg count");
3327 Asm->EmitInt8(1);
3328 Asm->OutStreamer.AddComment("DW_LNS_set_column arg count");
3329 Asm->EmitInt8(1);
3330 Asm->OutStreamer.AddComment("DW_LNS_negate_stmt arg count");
3331 Asm->EmitInt8(0);
3332 Asm->OutStreamer.AddComment("DW_LNS_set_basic_block arg count");
3333 Asm->EmitInt8(0);
3334 Asm->OutStreamer.AddComment("DW_LNS_const_add_pc arg count");
3335 Asm->EmitInt8(0);
3336 Asm->OutStreamer.AddComment("DW_LNS_fixed_advance_pc arg count");
3337 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003338
3339 // Emit directories.
3340 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
Chris Lattner4cf202b2010-01-23 03:11:46 +00003341 const std::string &Dir = getSourceDirectoryName(DI);
Chris Lattner3f53c832010-04-04 18:52:31 +00003342 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Directory");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003343 Asm->OutStreamer.EmitBytes(StringRef(Dir.c_str(), Dir.size()+1), 0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003344 }
3345
Chris Lattner233f52b2010-03-09 23:52:58 +00003346 Asm->OutStreamer.AddComment("End of directories");
3347 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003348
3349 // Emit files.
3350 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
3351 // Remember source id starts at 1.
3352 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
Chris Lattner4cf202b2010-01-23 03:11:46 +00003353 const std::string &FN = getSourceFileName(Id.second);
Chris Lattner3f53c832010-04-04 18:52:31 +00003354 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Source");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003355 Asm->OutStreamer.EmitBytes(StringRef(FN.c_str(), FN.size()+1), 0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003356
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003357 Asm->EmitULEB128(Id.first, "Directory #");
3358 Asm->EmitULEB128(0, "Mod date");
3359 Asm->EmitULEB128(0, "File size");
Bill Wendling94d04b82009-05-20 23:21:38 +00003360 }
3361
Chris Lattner233f52b2010-03-09 23:52:58 +00003362 Asm->OutStreamer.AddComment("End of files");
3363 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003364
Chris Lattnerc0215722010-04-04 19:25:43 +00003365 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003366
3367 // A sequence for each text section.
3368 unsigned SecSrcLinesSize = SectionSourceLines.size();
3369
3370 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
3371 // Isolate current sections line info.
3372 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
3373
Bill Wendling94d04b82009-05-20 23:21:38 +00003374 // Dwarf assumes we start with first line of first source file.
3375 unsigned Source = 1;
3376 unsigned Line = 1;
3377
3378 // Construct rows of the address, source, line, column matrix.
3379 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
3380 const SrcLineInfo &LineInfo = LineInfos[i];
Chris Lattner25b68c62010-03-14 08:15:55 +00003381 MCSymbol *Label = LineInfo.getLabel();
Chris Lattnerb9130602010-03-14 02:20:58 +00003382 if (!Label->isDefined()) continue; // Not emitted, in dead code.
Bill Wendling94d04b82009-05-20 23:21:38 +00003383
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003384 if (Asm->isVerbose()) {
Chris Lattner188a87d2010-03-10 01:04:13 +00003385 std::pair<unsigned, unsigned> SrcID =
Bill Wendling94d04b82009-05-20 23:21:38 +00003386 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner188a87d2010-03-10 01:04:13 +00003387 Asm->OutStreamer.AddComment(Twine(getSourceDirectoryName(SrcID.first)) +
Chris Lattner49f618a2010-03-10 02:29:31 +00003388 "/" +
3389 Twine(getSourceFileName(SrcID.second)) +
Chris Lattner188a87d2010-03-10 01:04:13 +00003390 ":" + Twine(LineInfo.getLine()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003391 }
3392
3393 // Define the line address.
Chris Lattner233f52b2010-03-09 23:52:58 +00003394 Asm->OutStreamer.AddComment("Extended Op");
3395 Asm->EmitInt8(0);
3396 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003397 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003398
3399 Asm->OutStreamer.AddComment("DW_LNE_set_address");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003400 Asm->EmitInt8(dwarf::DW_LNE_set_address);
Chris Lattner233f52b2010-03-09 23:52:58 +00003401
3402 Asm->OutStreamer.AddComment("Location label");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003403 Asm->OutStreamer.EmitSymbolValue(Label,
3404 Asm->getTargetData().getPointerSize(),
Chris Lattnerb9130602010-03-14 02:20:58 +00003405 0/*AddrSpace*/);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003406
Bill Wendling94d04b82009-05-20 23:21:38 +00003407 // If change of source, then switch to the new source.
3408 if (Source != LineInfo.getSourceID()) {
3409 Source = LineInfo.getSourceID();
Chris Lattner233f52b2010-03-09 23:52:58 +00003410 Asm->OutStreamer.AddComment("DW_LNS_set_file");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003411 Asm->EmitInt8(dwarf::DW_LNS_set_file);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003412 Asm->EmitULEB128(Source, "New Source");
Bill Wendling94d04b82009-05-20 23:21:38 +00003413 }
3414
3415 // If change of line.
3416 if (Line != LineInfo.getLine()) {
3417 // Determine offset.
3418 int Offset = LineInfo.getLine() - Line;
3419 int Delta = Offset - MinLineDelta;
3420
3421 // Update line.
3422 Line = LineInfo.getLine();
3423
3424 // If delta is small enough and in range...
3425 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
3426 // ... then use fast opcode.
Chris Lattner233f52b2010-03-09 23:52:58 +00003427 Asm->OutStreamer.AddComment("Line Delta");
3428 Asm->EmitInt8(Delta - MinLineDelta);
Bill Wendling94d04b82009-05-20 23:21:38 +00003429 } else {
3430 // ... otherwise use long hand.
Chris Lattner233f52b2010-03-09 23:52:58 +00003431 Asm->OutStreamer.AddComment("DW_LNS_advance_line");
Bill Wendling94d04b82009-05-20 23:21:38 +00003432 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003433 Asm->EmitSLEB128(Offset, "Line Offset");
Chris Lattner233f52b2010-03-09 23:52:58 +00003434 Asm->OutStreamer.AddComment("DW_LNS_copy");
3435 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling94d04b82009-05-20 23:21:38 +00003436 }
3437 } else {
3438 // Copy the previous row (different address or source)
Chris Lattner233f52b2010-03-09 23:52:58 +00003439 Asm->OutStreamer.AddComment("DW_LNS_copy");
3440 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling94d04b82009-05-20 23:21:38 +00003441 }
3442 }
3443
Devang Patel2c4ceb12009-11-21 02:48:08 +00003444 emitEndOfLineMatrix(j + 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003445 }
3446
3447 if (SecSrcLinesSize == 0)
3448 // Because we're emitting a debug_line section, we still need a line
3449 // table. The linker and friends expect it to exist. If there's nothing to
3450 // put into it, emit an empty table.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003451 emitEndOfLineMatrix(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003452
Chris Lattnerc0215722010-04-04 19:25:43 +00003453 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003454}
3455
Devang Patel2c4ceb12009-11-21 02:48:08 +00003456/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003457///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003458void DwarfDebug::emitCommonDebugFrame() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003459 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003460 return;
3461
Chris Lattnerd38fee82010-04-05 00:13:49 +00003462 int stackGrowth = Asm->getTargetData().getPointerSize();
3463 if (Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3464 TargetFrameInfo::StackGrowsDown)
3465 stackGrowth *= -1;
Bill Wendling94d04b82009-05-20 23:21:38 +00003466
3467 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003468 Asm->OutStreamer.SwitchSection(
3469 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003470
Chris Lattnerc0215722010-04-04 19:25:43 +00003471 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003472 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003473 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3474 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003475
Chris Lattnerc0215722010-04-04 19:25:43 +00003476 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003477 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling94d04b82009-05-20 23:21:38 +00003478 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner233f52b2010-03-09 23:52:58 +00003479 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling94d04b82009-05-20 23:21:38 +00003480 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner233f52b2010-03-09 23:52:58 +00003481 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003482 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003483 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3484 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner233f52b2010-03-09 23:52:58 +00003485 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003486 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling94d04b82009-05-20 23:21:38 +00003487 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling94d04b82009-05-20 23:21:38 +00003488
3489 std::vector<MachineMove> Moves;
3490 RI->getInitialFrameState(Moves);
3491
Chris Lattner02b86b92010-04-04 23:41:46 +00003492 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003493
Chris Lattner059ea132010-04-28 01:05:45 +00003494 Asm->EmitAlignment(2);
Chris Lattnerc0215722010-04-04 19:25:43 +00003495 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003496}
3497
Devang Patel2c4ceb12009-11-21 02:48:08 +00003498/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling94d04b82009-05-20 23:21:38 +00003499/// section.
Chris Lattner206d61e2010-03-13 07:26:18 +00003500void DwarfDebug::
3501emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003502 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003503 return;
3504
3505 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003506 Asm->OutStreamer.SwitchSection(
3507 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003508
Chris Lattner233f52b2010-03-09 23:52:58 +00003509 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner206d61e2010-03-13 07:26:18 +00003510 MCSymbol *DebugFrameBegin =
Chris Lattnerc0215722010-04-04 19:25:43 +00003511 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner206d61e2010-03-13 07:26:18 +00003512 MCSymbol *DebugFrameEnd =
Chris Lattnerc0215722010-04-04 19:25:43 +00003513 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnera6437182010-04-04 19:58:12 +00003514 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003515
Chris Lattner206d61e2010-03-13 07:26:18 +00003516 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling94d04b82009-05-20 23:21:38 +00003517
Chris Lattner233f52b2010-03-09 23:52:58 +00003518 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003519 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner6189ed12010-04-04 23:25:33 +00003520 DwarfFrameSectionSym);
Bill Wendling94d04b82009-05-20 23:21:38 +00003521
Chris Lattner233f52b2010-03-09 23:52:58 +00003522 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnerc0215722010-04-04 19:25:43 +00003523 MCSymbol *FuncBeginSym =
3524 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattnerfb658072010-03-13 07:40:56 +00003525 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattnerd38fee82010-04-05 00:13:49 +00003526 Asm->getTargetData().getPointerSize(),
3527 0/*AddrSpace*/);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003528
3529
Chris Lattner233f52b2010-03-09 23:52:58 +00003530 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnera6437182010-04-04 19:58:12 +00003531 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003532 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003533
Chris Lattner02b86b92010-04-04 23:41:46 +00003534 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003535
Chris Lattner059ea132010-04-28 01:05:45 +00003536 Asm->EmitAlignment(2);
Chris Lattner206d61e2010-03-13 07:26:18 +00003537 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling94d04b82009-05-20 23:21:38 +00003538}
3539
Devang Patel8a241142009-12-09 18:24:21 +00003540/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3541///
3542void DwarfDebug::emitDebugPubNames() {
Devang Patel163a9f72010-05-10 22:49:55 +00003543 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3544 E = CUMap.end(); I != E; ++I) {
3545 CompileUnit *TheCU = I->second;
3546 // Start the dwarf pubnames section.
3547 Asm->OutStreamer.SwitchSection(
3548 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003549
Devang Patel163a9f72010-05-10 22:49:55 +00003550 Asm->OutStreamer.AddComment("Length of Public Names Info");
3551 Asm->EmitLabelDifference(
3552 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3553 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003554
Devang Patel163a9f72010-05-10 22:49:55 +00003555 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3556 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003557
Devang Patel163a9f72010-05-10 22:49:55 +00003558 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003559 Asm->EmitInt16(dwarf::DWARF_VERSION);
3560
Devang Patel163a9f72010-05-10 22:49:55 +00003561 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003562 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel163a9f72010-05-10 22:49:55 +00003563 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003564
Devang Patel163a9f72010-05-10 22:49:55 +00003565 Asm->OutStreamer.AddComment("Compilation Unit Length");
3566 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3567 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3568 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003569
Devang Patel163a9f72010-05-10 22:49:55 +00003570 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3571 for (StringMap<DIE*>::const_iterator
3572 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3573 const char *Name = GI->getKeyData();
3574 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003575
Devang Patel163a9f72010-05-10 22:49:55 +00003576 Asm->OutStreamer.AddComment("DIE offset");
3577 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003578
Devang Patel163a9f72010-05-10 22:49:55 +00003579 if (Asm->isVerbose())
3580 Asm->OutStreamer.AddComment("External Name");
3581 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3582 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00003583
Devang Patel163a9f72010-05-10 22:49:55 +00003584 Asm->OutStreamer.AddComment("End Mark");
3585 Asm->EmitInt32(0);
3586 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3587 TheCU->getID()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003588 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003589}
3590
Devang Patel193f7202009-11-24 01:14:22 +00003591void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00003592 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3593 E = CUMap.end(); I != E; ++I) {
3594 CompileUnit *TheCU = I->second;
3595 // Start the dwarf pubnames section.
3596 Asm->OutStreamer.SwitchSection(
3597 Asm->getObjFileLowering().getDwarfPubTypesSection());
3598 Asm->OutStreamer.AddComment("Length of Public Types Info");
3599 Asm->EmitLabelDifference(
3600 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3601 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003602
Devang Patel163a9f72010-05-10 22:49:55 +00003603 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3604 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003605
Devang Patel163a9f72010-05-10 22:49:55 +00003606 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3607 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003608
Devang Patel163a9f72010-05-10 22:49:55 +00003609 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3610 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3611 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003612
Devang Patel163a9f72010-05-10 22:49:55 +00003613 Asm->OutStreamer.AddComment("Compilation Unit Length");
3614 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3615 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3616 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003617
Devang Patel163a9f72010-05-10 22:49:55 +00003618 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3619 for (StringMap<DIE*>::const_iterator
3620 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3621 const char *Name = GI->getKeyData();
3622 DIE * Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003623
Devang Patel163a9f72010-05-10 22:49:55 +00003624 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3625 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003626
Devang Patel163a9f72010-05-10 22:49:55 +00003627 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3628 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3629 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00003630
Devang Patel163a9f72010-05-10 22:49:55 +00003631 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003632 Asm->EmitInt32(0);
Devang Patel163a9f72010-05-10 22:49:55 +00003633 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3634 TheCU->getID()));
Devang Patel193f7202009-11-24 01:14:22 +00003635 }
Devang Patel193f7202009-11-24 01:14:22 +00003636}
3637
Devang Patel2c4ceb12009-11-21 02:48:08 +00003638/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003639///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003640void DwarfDebug::emitDebugStr() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003641 // Check to see if it is worth the effort.
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003642 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003643
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003644 // Start the dwarf str section.
3645 Asm->OutStreamer.SwitchSection(
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003646 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003647
Chris Lattnerbc733f52010-03-13 02:17:42 +00003648 // Get all of the string pool entries and put them in an array by their ID so
3649 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003650 SmallVector<std::pair<unsigned,
Chris Lattnerbc733f52010-03-13 02:17:42 +00003651 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003652
Chris Lattnerbc733f52010-03-13 02:17:42 +00003653 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3654 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3655 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003656
Chris Lattnerbc733f52010-03-13 02:17:42 +00003657 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003658
Chris Lattnerbc733f52010-03-13 02:17:42 +00003659 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003660 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003661 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003662
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003663 // Emit the string itself.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003664 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003665 }
3666}
3667
Devang Patel2c4ceb12009-11-21 02:48:08 +00003668/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003669///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003670void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00003671 if (DotDebugLocEntries.empty())
3672 return;
3673
Bill Wendling94d04b82009-05-20 23:21:38 +00003674 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003675 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00003676 Asm->getObjFileLowering().getDwarfLocSection());
3677 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00003678 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3679 unsigned index = 1;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003680 for (SmallVector<DotDebugLocEntry, 4>::iterator
3681 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00003682 I != E; ++I, ++index) {
Devang Patelc3f5f782010-05-25 23:40:22 +00003683 DotDebugLocEntry Entry = *I;
Devang Patelc3f5f782010-05-25 23:40:22 +00003684 if (Entry.isEmpty()) {
3685 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3686 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel80250682010-05-26 23:55:23 +00003687 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00003688 } else {
3689 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3690 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3691 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3692 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patelb2cf5812010-08-04 18:40:52 +00003693 if (int Offset = Entry.Loc.getOffset()) {
3694 // If the value is at a certain offset from frame register then
3695 // use DW_OP_fbreg.
3696 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patelc3f5f782010-05-25 23:40:22 +00003697 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patelb2cf5812010-08-04 18:40:52 +00003698 Asm->EmitInt16(1 + OffsetSize);
3699 Asm->OutStreamer.AddComment(
3700 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3701 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3702 Asm->OutStreamer.AddComment("Offset");
3703 Asm->EmitSLEB128(Offset);
Devang Patelc3f5f782010-05-25 23:40:22 +00003704 } else {
Devang Patelb2cf5812010-08-04 18:40:52 +00003705 if (Reg < 32) {
3706 Asm->OutStreamer.AddComment("Loc expr size");
3707 Asm->EmitInt16(1);
3708 Asm->OutStreamer.AddComment(
Devang Patela54e0cc2010-08-04 20:32:36 +00003709 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patelb2cf5812010-08-04 18:40:52 +00003710 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3711 } else {
3712 Asm->OutStreamer.AddComment("Loc expr size");
3713 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3714 Asm->EmitInt8(dwarf::DW_OP_regx);
3715 Asm->EmitULEB128(Reg);
3716 }
Devang Patelc3f5f782010-05-25 23:40:22 +00003717 }
3718 }
3719 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003720}
3721
3722/// EmitDebugARanges - Emit visible names into a debug aranges section.
3723///
3724void DwarfDebug::EmitDebugARanges() {
3725 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003726 Asm->OutStreamer.SwitchSection(
3727 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003728}
3729
Devang Patel2c4ceb12009-11-21 02:48:08 +00003730/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003731///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003732void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003733 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003734 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00003735 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Pateleac9c072010-04-27 19:46:33 +00003736 unsigned char Size = Asm->getTargetData().getPointerSize();
3737 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00003738 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00003739 I != E; ++I) {
3740 if (*I)
3741 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003742 else
Devang Pateleac9c072010-04-27 19:46:33 +00003743 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003744 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003745}
3746
Devang Patel2c4ceb12009-11-21 02:48:08 +00003747/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003748///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003749void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003750 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00003751 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003752 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003753 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003754 }
3755}
3756
Devang Patel2c4ceb12009-11-21 02:48:08 +00003757/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling94d04b82009-05-20 23:21:38 +00003758/// Section Header:
3759/// 1. length of section
3760/// 2. Dwarf version number
3761/// 3. address size.
3762///
3763/// Entries (one "entry" for each function that was inlined):
3764///
3765/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3766/// otherwise offset into __debug_str for regular function name.
3767/// 2. offset into __debug_str section for regular function name.
3768/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3769/// instances for the function.
3770///
3771/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3772/// inlined instance; the die_offset points to the inlined_subroutine die in the
3773/// __debug_info section, and the low_pc is the starting address for the
3774/// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003775void DwarfDebug::emitDebugInlineInfo() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003776 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003777 return;
3778
Devang Patel163a9f72010-05-10 22:49:55 +00003779 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00003780 return;
3781
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003782 Asm->OutStreamer.SwitchSection(
3783 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00003784
Chris Lattner233f52b2010-03-09 23:52:58 +00003785 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003786 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3787 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003788
Chris Lattnerc0215722010-04-04 19:25:43 +00003789 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003790
Chris Lattner233f52b2010-03-09 23:52:58 +00003791 Asm->OutStreamer.AddComment("Dwarf Version");
3792 Asm->EmitInt16(dwarf::DWARF_VERSION);
3793 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003794 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003795
Devang Patele9f8f5e2010-05-07 20:54:48 +00003796 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00003797 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00003798
Devang Patele9f8f5e2010-05-07 20:54:48 +00003799 const MDNode *Node = *I;
3800 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach7ab38df2009-11-22 19:20:36 +00003801 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00003802 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00003803 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00003804 StringRef LName = SP.getLinkageName();
3805 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00003806
Chris Lattner233f52b2010-03-09 23:52:58 +00003807 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003808 if (LName.empty()) {
3809 Asm->OutStreamer.EmitBytes(Name, 0);
3810 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003811 } else
Chris Lattner6189ed12010-04-04 23:25:33 +00003812 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3813 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00003814
Chris Lattner233f52b2010-03-09 23:52:58 +00003815 Asm->OutStreamer.AddComment("Function name");
Chris Lattner6189ed12010-04-04 23:25:33 +00003816 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003817 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00003818
Devang Patel53bb5c92009-11-10 23:06:00 +00003819 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00003820 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00003821 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00003822 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003823
Chris Lattner3f53c832010-04-04 18:52:31 +00003824 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003825 Asm->OutStreamer.EmitSymbolValue(LI->first,
3826 Asm->getTargetData().getPointerSize(),0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003827 }
3828 }
3829
Chris Lattnerc0215722010-04-04 19:25:43 +00003830 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003831}