blob: 6edce5a2cd94531c99aa8d5ad97e957e52625ec7 [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
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001753 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1754 if (DI != DirectoryIdMap.end()) {
1755 DId = DI->getValue();
1756 } else {
1757 DId = DirectoryNames.size() + 1;
1758 DirectoryIdMap[DirName] = DId;
1759 DirectoryNames.push_back(DirName);
1760 }
1761
1762 unsigned FId;
1763 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1764 if (FI != SourceFileIdMap.end()) {
1765 FId = FI->getValue();
1766 } else {
1767 FId = SourceFileNames.size() + 1;
1768 SourceFileIdMap[FileName] = FId;
1769 SourceFileNames.push_back(FileName);
1770 }
1771
1772 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1773 SourceIdMap.find(std::make_pair(DId, FId));
1774 if (SI != SourceIdMap.end())
1775 return SI->second;
1776
1777 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1778 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1779 SourceIds.push_back(std::make_pair(DId, FId));
1780
1781 return SrcId;
1782}
1783
Devang Patel6404e4e2009-12-15 19:16:48 +00001784/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1785DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel163a9f72010-05-10 22:49:55 +00001786 CompileUnit *TheCU = getCompileUnit(NS);
1787 DIE *NDie = TheCU->getDIE(NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001788 if (NDie)
1789 return NDie;
1790 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel163a9f72010-05-10 22:49:55 +00001791 TheCU->insertDIE(NS, NDie);
Devang Patel6404e4e2009-12-15 19:16:48 +00001792 if (!NS.getName().empty())
1793 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
Devang Patel81625742010-08-09 20:20:05 +00001794 addSourceLine(NDie, NS);
Devang Patel6404e4e2009-12-15 19:16:48 +00001795 addToContextOwner(NDie, NS.getContext());
1796 return NDie;
1797}
1798
Jim Grosbach1e20b962010-07-21 21:21:52 +00001799/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel163a9f72010-05-10 22:49:55 +00001800/// metadata node with tag DW_TAG_compile_unit.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001801void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001802 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +00001803 StringRef FN = DIUnit.getFilename();
1804 StringRef Dir = DIUnit.getDirectory();
Devang Patel5ccdd102009-09-29 18:40:58 +00001805 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001806
1807 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001808 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001809 DIUnit.getProducer());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001810 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001811 DIUnit.getLanguage());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001812 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patel5098da02010-04-26 22:54:28 +00001813 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1814 // simplifies debug range entries.
Devang Patel9b93b6b2010-06-28 22:22:47 +00001815 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Patel4a602ca2010-03-22 23:11:36 +00001816 // DW_AT_stmt_list is a offset of line number information for this
Devang Patelaf608bd2010-08-24 00:06:12 +00001817 // compile unit in debug_line section.
Devang Patelae84d5b2010-08-31 23:50:19 +00001818 if (Asm->MAI->doesDwarfUsesAbsoluteLabelForStmtList())
1819 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_addr,
1820 Asm->GetTempSymbol("section_line"));
1821 else
1822 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001823
Devang Patel65dbc902009-11-25 17:36:49 +00001824 if (!Dir.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001825 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001826 if (DIUnit.isOptimized())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001827 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001828
Devang Patel65dbc902009-11-25 17:36:49 +00001829 StringRef Flags = DIUnit.getFlags();
1830 if (!Flags.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001831 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001832
1833 unsigned RVer = DIUnit.getRunTimeVersion();
1834 if (RVer)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001835 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001836 dwarf::DW_FORM_data1, RVer);
1837
Devang Patel163a9f72010-05-10 22:49:55 +00001838 CompileUnit *NewCU = new CompileUnit(ID, Die);
1839 if (!FirstCU)
1840 FirstCU = NewCU;
1841 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001842}
1843
Devang Patel163a9f72010-05-10 22:49:55 +00001844/// getCompielUnit - Get CompileUnit DIE.
1845CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1846 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1847 DIDescriptor D(N);
1848 const MDNode *CUNode = NULL;
1849 if (D.isCompileUnit())
1850 CUNode = N;
1851 else if (D.isSubprogram())
1852 CUNode = DISubprogram(N).getCompileUnit();
1853 else if (D.isType())
1854 CUNode = DIType(N).getCompileUnit();
1855 else if (D.isGlobalVariable())
1856 CUNode = DIGlobalVariable(N).getCompileUnit();
1857 else if (D.isVariable())
1858 CUNode = DIVariable(N).getCompileUnit();
1859 else if (D.isNameSpace())
1860 CUNode = DINameSpace(N).getCompileUnit();
1861 else if (D.isFile())
1862 CUNode = DIFile(N).getCompileUnit();
1863 else
1864 return FirstCU;
1865
1866 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1867 = CUMap.find(CUNode);
1868 if (I == CUMap.end())
1869 return FirstCU;
1870 return I->second;
1871}
1872
Devang Patel0c4720c2010-08-23 18:25:56 +00001873/// isUnsignedDIType - Return true if type encoding is unsigned.
1874static bool isUnsignedDIType(DIType Ty) {
1875 DIDerivedType DTy(Ty);
1876 if (DTy.Verify())
1877 return isUnsignedDIType(DTy.getTypeDerivedFrom());
1878
1879 DIBasicType BTy(Ty);
1880 if (BTy.Verify()) {
1881 unsigned Encoding = BTy.getEncoding();
1882 if (Encoding == dwarf::DW_ATE_unsigned ||
1883 Encoding == dwarf::DW_ATE_unsigned_char)
1884 return true;
1885 }
1886 return false;
1887}
Devang Patel163a9f72010-05-10 22:49:55 +00001888
1889/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001890void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel9fa539c2010-08-10 01:37:23 +00001891 DIGlobalVariable GV(N);
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001892
Devang Patel905cf5e2009-09-04 23:59:07 +00001893 // If debug information is malformed then ignore it.
Devang Patel9fa539c2010-08-10 01:37:23 +00001894 if (GV.Verify() == false)
Devang Patel905cf5e2009-09-04 23:59:07 +00001895 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001896
1897 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00001898 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel9fa539c2010-08-10 01:37:23 +00001899 if (TheCU->getDIE(GV))
Devang Patel13e16b62009-06-26 01:49:18 +00001900 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001901
Devang Patel9fa539c2010-08-10 01:37:23 +00001902 DIType GTy = GV.getType();
Devang Patel29368072010-08-10 07:11:13 +00001903 DIE *VariableDIE = new DIE(GV.getTag());
1904
1905 bool isGlobalVariable = GV.getGlobal() != NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001906
Devang Patel9fa539c2010-08-10 01:37:23 +00001907 // Add name.
1908 addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1909 GV.getDisplayName());
1910 StringRef LinkageName = GV.getLinkageName();
Devang Patel29368072010-08-10 07:11:13 +00001911 if (!LinkageName.empty() && isGlobalVariable)
Devang Patel9fa539c2010-08-10 01:37:23 +00001912 addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
1913 getRealLinkageName(LinkageName));
1914 // Add type.
1915 addType(VariableDIE, GTy);
Devang Patel50d80e32010-04-13 20:35:04 +00001916 if (GTy.isCompositeType() && !GTy.getName().empty()
1917 && !GTy.isForwardDecl()) {
Devang Patel163a9f72010-05-10 22:49:55 +00001918 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattnered7a77b2010-03-31 05:36:29 +00001919 assert(Entry && "Missing global type!");
Devang Patel163a9f72010-05-10 22:49:55 +00001920 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel193f7202009-11-24 01:14:22 +00001921 }
Devang Patel9fa539c2010-08-10 01:37:23 +00001922 // Add scoping info.
1923 if (!GV.isLocalToUnit()) {
1924 addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1925 // Expose as global.
1926 TheCU->addGlobal(GV.getName(), VariableDIE);
1927 }
1928 // Add line number info.
1929 addSourceLine(VariableDIE, GV);
1930 // Add to map.
1931 TheCU->insertDIE(N, VariableDIE);
1932 // Add to context owner.
1933 DIDescriptor GVContext = GV.getContext();
1934 addToContextOwner(VariableDIE, GVContext);
1935 // Add location.
Devang Patel29368072010-08-10 07:11:13 +00001936 if (isGlobalVariable) {
1937 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1938 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1939 addLabel(Block, 0, dwarf::DW_FORM_udata,
1940 Asm->Mang->getSymbol(GV.getGlobal()));
1941 // Do not create specification DIE if context is either compile unit
1942 // or a subprogram.
1943 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
1944 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
1945 // Create specification DIE.
1946 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1947 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1948 dwarf::DW_FORM_ref4, VariableDIE);
1949 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1950 addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1951 TheCU->addDie(VariableSpecDIE);
1952 } else {
1953 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
1954 }
1955 } else if (Constant *C = GV.getConstant()) {
1956 if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
Devang Patel0c4720c2010-08-23 18:25:56 +00001957 if (isUnsignedDIType(GTy))
Devang Patel29368072010-08-10 07:11:13 +00001958 addUInt(VariableDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
1959 CI->getZExtValue());
1960 else
1961 addSInt(VariableDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
1962 CI->getSExtValue());
Devang Patel29368072010-08-10 07:11:13 +00001963 }
Devang Patel9fa539c2010-08-10 01:37:23 +00001964 }
Devang Patel13e16b62009-06-26 01:49:18 +00001965 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001966}
1967
Devang Patel163a9f72010-05-10 22:49:55 +00001968/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001969void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001970 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001971
Stuart Hastings639336e2010-04-06 21:38:29 +00001972 // Check for pre-existence.
Devang Patel163a9f72010-05-10 22:49:55 +00001973 CompileUnit *TheCU = getCompileUnit(N);
1974 if (TheCU->getDIE(N))
Stuart Hastings639336e2010-04-06 21:38:29 +00001975 return;
1976
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001977 if (!SP.isDefinition())
1978 // This is a method declaration which will be handled while constructing
1979 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +00001980 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001981
Stuart Hastings639336e2010-04-06 21:38:29 +00001982 DIE *SubprogramDie = createSubprogramDIE(SP);
1983
1984 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +00001985 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001986
1987 // Add to context owner.
Devang Patel6404e4e2009-12-15 19:16:48 +00001988 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +00001989
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001990 // Expose as global.
Devang Patel163a9f72010-05-10 22:49:55 +00001991 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel193f7202009-11-24 01:14:22 +00001992
Devang Patel13e16b62009-06-26 01:49:18 +00001993 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001994}
1995
Devang Patel2c4ceb12009-11-21 02:48:08 +00001996/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbar00564992009-09-19 20:40:14 +00001997/// content. Create global DIEs and emit initial debug info sections.
1998/// This is inovked by the target AsmPrinter.
Chris Lattner75f50722010-04-04 07:48:20 +00001999void DwarfDebug::beginModule(Module *M) {
Devang Pateleac9c072010-04-27 19:46:33 +00002000 if (DisableDebugInfoPrinting)
2001 return;
2002
Devang Patel78ab9e22009-07-30 18:56:46 +00002003 DebugInfoFinder DbgFinder;
2004 DbgFinder.processModule(*M);
Devang Patel13e16b62009-06-26 01:49:18 +00002005
Chris Lattnerd850ac72010-04-05 02:19:28 +00002006 bool HasDebugInfo = false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002007
Chris Lattnerd850ac72010-04-05 02:19:28 +00002008 // Scan all the compile-units to see if there are any marked as the main unit.
2009 // if not, we do not generate debug info.
2010 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2011 E = DbgFinder.compile_unit_end(); I != E; ++I) {
2012 if (DICompileUnit(*I).isMain()) {
2013 HasDebugInfo = true;
2014 break;
2015 }
2016 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002017
Chris Lattnerd850ac72010-04-05 02:19:28 +00002018 if (!HasDebugInfo) return;
2019
2020 // Tell MMI that we have debug info.
2021 MMI->setDebugInfoAvailability(true);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002022
Chris Lattnerbe15beb2010-04-04 23:17:54 +00002023 // Emit initial sections.
Chris Lattnerd850ac72010-04-05 02:19:28 +00002024 EmitSectionLabels();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002025
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002026 // Create all the compile unit DIEs.
Devang Patel78ab9e22009-07-30 18:56:46 +00002027 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2028 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002029 constructCompileUnit(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002030
Devang Patel53bb5c92009-11-10 23:06:00 +00002031 // Create DIEs for each subprogram.
Devang Patel78ab9e22009-07-30 18:56:46 +00002032 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
2033 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002034 constructSubprogramDIE(*I);
Devang Patel13e16b62009-06-26 01:49:18 +00002035
Devang Patelc366f832009-12-10 19:14:49 +00002036 // Create DIEs for each global variable.
2037 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2038 E = DbgFinder.global_variable_end(); I != E; ++I)
2039 constructGlobalVariableDIE(*I);
2040
Devang Patele7e5a0f2010-08-10 20:01:20 +00002041 //getOrCreateTypeDIE
2042 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
2043 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2044 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2045
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002046 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +00002047 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002048
2049 // Print out .file directives to specify files for .loc directives. These are
2050 // printed out early so that they precede any .loc directives.
Chris Lattnerd38fee82010-04-05 00:13:49 +00002051 if (Asm->MAI->hasDotLocAndDotFile()) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002052 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
2053 // Remember source id starts at 1.
2054 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
Chris Lattner0ad9c912010-01-22 22:09:00 +00002055 // FIXME: don't use sys::path for this! This should not depend on the
2056 // host.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002057 sys::Path FullPath(getSourceDirectoryName(Id.first));
2058 bool AppendOk =
2059 FullPath.appendComponent(getSourceFileName(Id.second));
2060 assert(AppendOk && "Could not append filename to directory!");
2061 AppendOk = false;
Chris Lattnera6594fc2010-01-25 18:58:59 +00002062 Asm->OutStreamer.EmitDwarfFileDirective(i, FullPath.str());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002063 }
2064 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002065}
2066
Devang Patel2c4ceb12009-11-21 02:48:08 +00002067/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002068///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002069void DwarfDebug::endModule() {
Devang Patel163a9f72010-05-10 22:49:55 +00002070 if (!FirstCU) return;
Devang Patel4a1cad62010-06-28 18:25:03 +00002071 const Module *M = MMI->getModule();
Devang Patele9a1cca2010-08-02 17:32:15 +00002072 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patel4a1cad62010-06-28 18:25:03 +00002073 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2074 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2075 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2076 DISubprogram SP(AllSPs->getOperand(SI));
2077 if (!SP.Verify()) continue;
2078
2079 // Collect info for variables that were optimized out.
Devang Patel8b3a6b62010-07-19 17:53:55 +00002080 if (!SP.isDefinition()) continue;
Devang Patel4a1cad62010-06-28 18:25:03 +00002081 StringRef FName = SP.getLinkageName();
2082 if (FName.empty())
2083 FName = SP.getName();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002084 NamedMDNode *NMD =
Devang Patel4a1cad62010-06-28 18:25:03 +00002085 M->getNamedMetadata(Twine("llvm.dbg.lv.", getRealLinkageName(FName)));
2086 if (!NMD) continue;
2087 unsigned E = NMD->getNumOperands();
2088 if (!E) continue;
2089 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Patele9a1cca2010-08-02 17:32:15 +00002090 DeadFnScopeMap[SP] = Scope;
Devang Patel4a1cad62010-06-28 18:25:03 +00002091 for (unsigned I = 0; I != E; ++I) {
2092 DIVariable DV(NMD->getOperand(I));
2093 if (!DV.Verify()) continue;
2094 Scope->addVariable(new DbgVariable(DV));
2095 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002096
Devang Patel4a1cad62010-06-28 18:25:03 +00002097 // Construct subprogram DIE and add variables DIEs.
2098 constructSubprogramDIE(SP);
2099 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patele03161c2010-08-09 18:51:29 +00002100 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patel4a1cad62010-06-28 18:25:03 +00002101 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2102 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2103 if (VariableDIE)
2104 ScopeDIE->addChild(VariableDIE);
2105 }
2106 }
2107 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002108
Devang Patel53bb5c92009-11-10 23:06:00 +00002109 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2110 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2111 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2112 DIE *ISP = *AI;
Devang Patel2c4ceb12009-11-21 02:48:08 +00002113 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +00002114 }
2115
Devang Patele9f8f5e2010-05-07 20:54:48 +00002116 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Patel5d11eb02009-12-03 19:11:07 +00002117 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2118 DIE *SPDie = CI->first;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002119 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Patel5d11eb02009-12-03 19:11:07 +00002120 if (!N) continue;
Devang Patel163a9f72010-05-10 22:49:55 +00002121 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Patel5d11eb02009-12-03 19:11:07 +00002122 if (!NDie) continue;
2123 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patel5d11eb02009-12-03 19:11:07 +00002124 }
2125
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002126 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002127 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002128 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002129 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +00002130 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002131
2132 // End text sections.
2133 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002134 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnerc0215722010-04-04 19:25:43 +00002135 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002136 }
2137
2138 // Emit common frame information.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002139 emitCommonDebugFrame();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002140
2141 // Emit function debug frame information
2142 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2143 E = DebugFrames.end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002144 emitFunctionDebugFrame(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002145
2146 // Compute DIE offsets and sizes.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002147 computeSizeAndOffsets();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002148
2149 // Emit all the DIEs into a debug info section
Devang Patel2c4ceb12009-11-21 02:48:08 +00002150 emitDebugInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002151
2152 // Corresponding abbreviations into a abbrev section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002153 emitAbbreviations();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002154
Devang Patelaf608bd2010-08-24 00:06:12 +00002155 // Emit source line correspondence into a debug line section.
2156 emitDebugLines();
2157
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002158 // Emit info into a debug pubnames section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002159 emitDebugPubNames();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002160
Devang Patel193f7202009-11-24 01:14:22 +00002161 // Emit info into a debug pubtypes section.
2162 emitDebugPubTypes();
2163
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002164 // Emit info into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002165 emitDebugLoc();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002166
2167 // Emit info into a debug aranges section.
2168 EmitDebugARanges();
2169
2170 // Emit info into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002171 emitDebugRanges();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002172
2173 // Emit info into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002174 emitDebugMacInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002175
2176 // Emit inline info.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002177 emitDebugInlineInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002178
Chris Lattnerbc733f52010-03-13 02:17:42 +00002179 // Emit info into a debug str section.
2180 emitDebugStr();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002181
Devang Patele9a1cca2010-08-02 17:32:15 +00002182 // clean up.
2183 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel163a9f72010-05-10 22:49:55 +00002184 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2185 E = CUMap.end(); I != E; ++I)
2186 delete I->second;
2187 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002188}
2189
Devang Patel53bb5c92009-11-10 23:06:00 +00002190/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002191DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattnerde4845c2010-04-02 19:42:39 +00002192 DebugLoc ScopeLoc) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002193
Devang Patel2db49d72010-05-07 18:11:54 +00002194 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00002195 if (AbsDbgVariable)
2196 return AbsDbgVariable;
2197
Devang Patel2db49d72010-05-07 18:11:54 +00002198 LLVMContext &Ctx = Var->getContext();
Chris Lattnerde4845c2010-04-02 19:42:39 +00002199 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00002200 if (!Scope)
2201 return NULL;
2202
Devang Patel26c1e562010-05-20 16:36:41 +00002203 AbsDbgVariable = new DbgVariable(Var);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002204 Scope->addVariable(AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00002205 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00002206 return AbsDbgVariable;
2207}
2208
Devang Patelee432862010-05-20 19:57:06 +00002209/// collectVariableInfoFromMMITable - Collect variable information from
2210/// side table maintained by MMI.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002211void
Devang Patelee432862010-05-20 19:57:06 +00002212DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2213 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00002214 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patele717faa2009-10-06 01:26:37 +00002215 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2216 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2217 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00002218 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00002219 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00002220 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002221 DIVariable DV(Var);
2222 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00002223
Chris Lattnerde4845c2010-04-02 19:42:39 +00002224 DbgScope *Scope = 0;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002225 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattnerde4845c2010-04-02 19:42:39 +00002226 Scope = ConcreteScopes.lookup(IA);
2227 if (Scope == 0)
2228 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002229
Devang Patelfb0ee432009-11-10 23:20:04 +00002230 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00002231 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00002232 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00002233
Devang Patel26c1e562010-05-20 16:36:41 +00002234 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2235 DbgVariable *RegVar = new DbgVariable(DV);
2236 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel2c4ceb12009-11-21 02:48:08 +00002237 Scope->addVariable(RegVar);
Devang Patel26c1e562010-05-20 16:36:41 +00002238 if (AbsDbgVariable) {
2239 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2240 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2241 }
Devang Patele717faa2009-10-06 01:26:37 +00002242 }
Devang Patelee432862010-05-20 19:57:06 +00002243}
Devang Patel90a48ad2010-03-15 18:33:46 +00002244
Jim Grosbach1e20b962010-07-21 21:21:52 +00002245/// isDbgValueInUndefinedReg - Return true if debug value, encoded by
Devang Patelc3f5f782010-05-25 23:40:22 +00002246/// DBG_VALUE instruction, is in undefined reg.
2247static bool isDbgValueInUndefinedReg(const MachineInstr *MI) {
2248 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2249 if (MI->getOperand(0).isReg() && !MI->getOperand(0).getReg())
2250 return true;
2251 return false;
2252}
2253
Jim Grosbach1e20b962010-07-21 21:21:52 +00002254/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patelc3f5f782010-05-25 23:40:22 +00002255/// DBG_VALUE instruction, is in a defined reg.
2256static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2257 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2258 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2259 return true;
2260 return false;
2261}
2262
Devang Patelee432862010-05-20 19:57:06 +00002263/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002264void
Devang Patel78e127d2010-06-25 22:07:34 +00002265DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2266 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002267
Devang Patelee432862010-05-20 19:57:06 +00002268 /// collection info from MMI table.
2269 collectVariableInfoFromMMITable(MF, Processed);
2270
2271 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patel90a48ad2010-03-15 18:33:46 +00002272 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002273 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelee432862010-05-20 19:57:06 +00002274 I != E; ++I)
Devang Patel90a48ad2010-03-15 18:33:46 +00002275 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2276 II != IE; ++II) {
2277 const MachineInstr *MInsn = II;
Devang Patelc3f5f782010-05-25 23:40:22 +00002278 if (!MInsn->isDebugValue() || isDbgValueInUndefinedReg(MInsn))
Devang Patel90a48ad2010-03-15 18:33:46 +00002279 continue;
Devang Patelee432862010-05-20 19:57:06 +00002280 DbgValues.push_back(MInsn);
2281 }
Devang Patel90a48ad2010-03-15 18:33:46 +00002282
Devang Patelc3f5f782010-05-25 23:40:22 +00002283 // This is a collection of DBV_VALUE instructions describing same variable.
2284 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patelee432862010-05-20 19:57:06 +00002285 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2286 E = DbgValues.end(); I != E; ++I) {
2287 const MachineInstr *MInsn = *I;
Devang Patelc3f5f782010-05-25 23:40:22 +00002288 MultipleValues.clear();
2289 if (isDbgValueInDefinedReg(MInsn))
2290 MultipleValues.push_back(MInsn);
Devang Patelee432862010-05-20 19:57:06 +00002291 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2292 if (Processed.count(DV) != 0)
2293 continue;
2294
Devang Patel354eb7e2010-06-02 19:05:13 +00002295 const MachineInstr *PrevMI = MInsn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002296 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
Devang Patelc3f5f782010-05-25 23:40:22 +00002297 ME = DbgValues.end(); MI != ME; ++MI) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002298 const MDNode *Var =
Devang Patelc3f5f782010-05-25 23:40:22 +00002299 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002300 if (Var == DV && isDbgValueInDefinedReg(*MI) &&
Devang Patel354eb7e2010-06-02 19:05:13 +00002301 !PrevMI->isIdenticalTo(*MI))
Devang Patelc3f5f782010-05-25 23:40:22 +00002302 MultipleValues.push_back(*MI);
Devang Patel354eb7e2010-06-02 19:05:13 +00002303 PrevMI = *MI;
Devang Patelc3f5f782010-05-25 23:40:22 +00002304 }
2305
Devang Patelee432862010-05-20 19:57:06 +00002306 DbgScope *Scope = findDbgScope(MInsn);
Devang Pateld8720f42010-05-27 20:25:04 +00002307 bool CurFnArg = false;
2308 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2309 DISubprogram(DV.getContext()).describes(MF->getFunction()))
2310 CurFnArg = true;
2311 if (!Scope && CurFnArg)
Devang Patelc0c5a262010-05-21 00:10:20 +00002312 Scope = CurrentFnDbgScope;
Devang Patelee432862010-05-20 19:57:06 +00002313 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00002314 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00002315 continue;
2316
2317 Processed.insert(DV);
Devang Patelee432862010-05-20 19:57:06 +00002318 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patelee432862010-05-20 19:57:06 +00002319 Scope->addVariable(RegVar);
Devang Pateld8720f42010-05-27 20:25:04 +00002320 if (!CurFnArg)
Jim Grosbach1e20b962010-07-21 21:21:52 +00002321 DbgVariableLabelsMap[RegVar] = getLabelBeforeInsn(MInsn);
Devang Patelc0c5a262010-05-21 00:10:20 +00002322 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2323 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2324 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patel90a48ad2010-03-15 18:33:46 +00002325 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002326 if (MultipleValues.size() <= 1) {
2327 DbgVariableToDbgInstMap[RegVar] = MInsn;
2328 continue;
2329 }
2330
2331 // handle multiple DBG_VALUE instructions describing one variable.
Devang Patelc3f5f782010-05-25 23:40:22 +00002332 if (DotDebugLocEntries.empty())
Devang Patel80250682010-05-26 23:55:23 +00002333 RegVar->setDotDebugLocOffset(0);
2334 else
2335 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Devang Patele2df8422010-05-26 17:29:32 +00002336 const MachineInstr *Begin = NULL;
2337 const MachineInstr *End = NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002338 for (SmallVector<const MachineInstr *, 4>::iterator
2339 MVI = MultipleValues.begin(), MVE = MultipleValues.end();
Devang Patel61409622010-07-07 20:12:52 +00002340 MVI != MVE; ++MVI) {
Devang Patele2df8422010-05-26 17:29:32 +00002341 if (!Begin) {
2342 Begin = *MVI;
2343 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002344 }
Devang Patele2df8422010-05-26 17:29:32 +00002345 End = *MVI;
Devang Patelc3f5f782010-05-25 23:40:22 +00002346 MachineLocation MLoc;
Devang Patelb2cf5812010-08-04 18:40:52 +00002347 if (Begin->getNumOperands() == 3) {
2348 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2349 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2350 } else
2351 MLoc = Asm->getDebugValueLocation(Begin);
2352
Devang Patele2df8422010-05-26 17:29:32 +00002353 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2354 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patel5573a7d2010-08-04 22:07:27 +00002355 if (MLoc.getReg())
2356 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
2357
Devang Patele2df8422010-05-26 17:29:32 +00002358 Begin = End;
2359 if (MVI + 1 == MVE) {
2360 // If End is the last instruction then its value is valid
Devang Patelc3f5f782010-05-25 23:40:22 +00002361 // until the end of the funtion.
Devang Patelb2cf5812010-08-04 18:40:52 +00002362 MachineLocation EMLoc;
2363 if (End->getNumOperands() == 3) {
2364 if (End->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2365 EMLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2366 } else
2367 EMLoc = Asm->getDebugValueLocation(End);
Devang Patel5573a7d2010-08-04 22:07:27 +00002368 if (EMLoc.getReg())
2369 DotDebugLocEntries.
2370 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, EMLoc));
Devang Patelc3f5f782010-05-25 23:40:22 +00002371 }
2372 }
2373 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00002374 }
Devang Patel98e1cac2010-05-14 21:01:35 +00002375
2376 // Collect info for variables that were optimized out.
Devang Pateld1bbc6b2010-06-22 01:01:58 +00002377 const Function *F = MF->getFunction();
2378 const Module *M = F->getParent();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002379 if (NamedMDNode *NMD =
2380 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patela762b092010-06-22 01:19:38 +00002381 getRealLinkageName(F->getName())))) {
Devang Patel98e1cac2010-05-14 21:01:35 +00002382 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman872814a2010-07-21 18:54:18 +00002383 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patelee432862010-05-20 19:57:06 +00002384 if (!DV || !Processed.insert(DV))
Devang Patel98e1cac2010-05-14 21:01:35 +00002385 continue;
2386 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2387 if (Scope)
Devang Patel26c1e562010-05-20 16:36:41 +00002388 Scope->addVariable(new DbgVariable(DV));
Devang Patel98e1cac2010-05-14 21:01:35 +00002389 }
2390 }
Devang Patelc3f5f782010-05-25 23:40:22 +00002391}
Devang Patel98e1cac2010-05-14 21:01:35 +00002392
Devang Patelc3f5f782010-05-25 23:40:22 +00002393/// getLabelBeforeInsn - Return Label preceding the instruction.
2394const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2395 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2396 LabelsBeforeInsn.find(MI);
2397 if (I == LabelsBeforeInsn.end())
2398 // FunctionBeginSym always preceeds all the instruction in current function.
2399 return FunctionBeginSym;
2400 return I->second;
2401}
2402
2403/// getLabelAfterInsn - Return Label immediately following the instruction.
2404const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2405 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2406 LabelsAfterInsn.find(MI);
2407 if (I == LabelsAfterInsn.end())
2408 return NULL;
2409 return I->second;
Devang Patele717faa2009-10-06 01:26:37 +00002410}
2411
Devang Patel553881b2010-03-29 17:20:31 +00002412/// beginScope - Process beginning of a scope.
2413void DwarfDebug::beginScope(const MachineInstr *MI) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002414 if (InsnNeedsLabel.count(MI) == 0) {
2415 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patel553881b2010-03-29 17:20:31 +00002416 return;
Devang Patelc3f5f782010-05-25 23:40:22 +00002417 }
Devang Patelaead63c2010-03-29 22:59:58 +00002418
Devang Patelb2b31a62010-05-26 19:37:24 +00002419 // Check location.
2420 DebugLoc DL = MI->getDebugLoc();
2421 if (!DL.isUnknown()) {
2422 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2423 PrevLabel = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
Devang Pateleac9c072010-04-27 19:46:33 +00002424 PrevInstLoc = DL;
Devang Patelb2b31a62010-05-26 19:37:24 +00002425 LabelsBeforeInsn[MI] = PrevLabel;
2426 return;
Devang Pateleac9c072010-04-27 19:46:33 +00002427 }
Devang Patel553881b2010-03-29 17:20:31 +00002428
Jim Grosbach1e20b962010-07-21 21:21:52 +00002429 // If location is unknown then use temp label for this DBG_VALUE
Devang Patelb2b31a62010-05-26 19:37:24 +00002430 // instruction.
2431 if (MI->isDebugValue()) {
Devang Patel77051f52010-05-26 21:23:46 +00002432 PrevLabel = MMI->getContext().CreateTempSymbol();
2433 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00002434 LabelsBeforeInsn[MI] = PrevLabel;
2435 return;
2436 }
2437
2438 if (UnknownLocations) {
2439 PrevLabel = recordSourceLine(0, 0, 0);
2440 LabelsBeforeInsn[MI] = PrevLabel;
2441 return;
2442 }
2443
2444 assert (0 && "Instruction is not processed!");
Devang Patel0d20ac82009-10-06 01:50:42 +00002445}
2446
Devang Patel2c4ceb12009-11-21 02:48:08 +00002447/// endScope - Process end of a scope.
2448void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel1c246352010-04-08 16:50:29 +00002449 if (InsnsEndScopeSet.count(MI) != 0) {
2450 // Emit a label if this instruction ends a scope.
2451 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2452 Asm->OutStreamer.EmitLabel(Label);
Devang Pateleac9c072010-04-27 19:46:33 +00002453 LabelsAfterInsn[MI] = Label;
Devang Patel1c246352010-04-08 16:50:29 +00002454 }
Devang Patel53bb5c92009-11-10 23:06:00 +00002455}
2456
Devang Pateleac9c072010-04-27 19:46:33 +00002457/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002458DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel61409622010-07-07 20:12:52 +00002459 const MDNode *InlinedAt) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002460 if (!InlinedAt) {
2461 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2462 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002463 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002464 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2465 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Pateleac9c072010-04-27 19:46:33 +00002466 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002467 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002468 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Pateleac9c072010-04-27 19:46:33 +00002469 WScope->setParent(Parent);
2470 Parent->addScope(WScope);
2471 }
2472
2473 if (!WScope->getParent()) {
2474 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastingscad22ad2010-06-15 23:06:30 +00002475 // We used to check only for a linkage name, but that fails
2476 // since we began omitting the linkage name for private
2477 // functions. The new way is to check for the name in metadata,
2478 // but that's not supported in old .ll test cases. Ergo, we
2479 // check both.
Stuart Hastings215aa152010-06-11 20:08:44 +00002480 if (SPName == Asm->MF->getFunction()->getName() ||
2481 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Pateleac9c072010-04-27 19:46:33 +00002482 CurrentFnDbgScope = WScope;
2483 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002484
Devang Pateleac9c072010-04-27 19:46:33 +00002485 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002486 }
2487
Devang Patel78e127d2010-06-25 22:07:34 +00002488 getOrCreateAbstractScope(Scope);
Devang Patel53bb5c92009-11-10 23:06:00 +00002489 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2490 if (WScope)
Devang Pateleac9c072010-04-27 19:46:33 +00002491 return WScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00002492
2493 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2494 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2495 DILocation DL(InlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002496 DbgScope *Parent =
Devang Patel2db49d72010-05-07 18:11:54 +00002497 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Pateleac9c072010-04-27 19:46:33 +00002498 WScope->setParent(Parent);
2499 Parent->addScope(WScope);
2500
2501 ConcreteScopes[InlinedAt] = WScope;
Devang Pateleac9c072010-04-27 19:46:33 +00002502
2503 return WScope;
Devang Patel0d20ac82009-10-06 01:50:42 +00002504}
2505
Devang Pateleac9c072010-04-27 19:46:33 +00002506/// hasValidLocation - Return true if debug location entry attached with
2507/// machine instruction encodes valid location info.
2508static bool hasValidLocation(LLVMContext &Ctx,
2509 const MachineInstr *MInsn,
Devang Patele9f8f5e2010-05-07 20:54:48 +00002510 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Pateleac9c072010-04-27 19:46:33 +00002511 DebugLoc DL = MInsn->getDebugLoc();
2512 if (DL.isUnknown()) return false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002513
Devang Patele9f8f5e2010-05-07 20:54:48 +00002514 const MDNode *S = DL.getScope(Ctx);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002515
Devang Pateleac9c072010-04-27 19:46:33 +00002516 // There is no need to create another DIE for compile unit. For all
2517 // other scopes, create one DbgScope now. This will be translated
2518 // into a scope DIE at the end.
2519 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002520
Devang Pateleac9c072010-04-27 19:46:33 +00002521 Scope = S;
2522 InlinedAt = DL.getInlinedAt(Ctx);
2523 return true;
2524}
2525
2526/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2527/// hierarchy.
2528static void calculateDominanceGraph(DbgScope *Scope) {
2529 assert (Scope && "Unable to calculate scop edominance graph!");
2530 SmallVector<DbgScope *, 4> WorkStack;
2531 WorkStack.push_back(Scope);
2532 unsigned Counter = 0;
2533 while (!WorkStack.empty()) {
2534 DbgScope *WS = WorkStack.back();
2535 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2536 bool visitedChildren = false;
2537 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2538 SE = Children.end(); SI != SE; ++SI) {
2539 DbgScope *ChildScope = *SI;
2540 if (!ChildScope->getDFSOut()) {
2541 WorkStack.push_back(ChildScope);
2542 visitedChildren = true;
2543 ChildScope->setDFSIn(++Counter);
2544 break;
2545 }
2546 }
2547 if (!visitedChildren) {
2548 WorkStack.pop_back();
2549 WS->setDFSOut(++Counter);
2550 }
2551 }
2552}
2553
2554/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002555static
Devang Pateleac9c072010-04-27 19:46:33 +00002556void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2557 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2558{
2559#ifndef NDEBUG
2560 unsigned PrevDFSIn = 0;
2561 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2562 I != E; ++I) {
2563 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2564 II != IE; ++II) {
2565 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002566 const MDNode *Scope = NULL;
2567 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002568
2569 // Check if instruction has valid location information.
2570 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2571 dbgs() << " [ ";
Jim Grosbach1e20b962010-07-21 21:21:52 +00002572 if (InlinedAt)
Devang Pateleac9c072010-04-27 19:46:33 +00002573 dbgs() << "*";
Jim Grosbach1e20b962010-07-21 21:21:52 +00002574 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Pateleac9c072010-04-27 19:46:33 +00002575 MI2ScopeMap.find(MInsn);
2576 if (DI != MI2ScopeMap.end()) {
2577 DbgScope *S = DI->second;
2578 dbgs() << S->getDFSIn();
2579 PrevDFSIn = S->getDFSIn();
2580 } else
2581 dbgs() << PrevDFSIn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002582 } else
Devang Pateleac9c072010-04-27 19:46:33 +00002583 dbgs() << " [ x" << PrevDFSIn;
2584 dbgs() << " ]";
2585 MInsn->dump();
2586 }
2587 dbgs() << "\n";
2588 }
2589#endif
2590}
Devang Patel2c4ceb12009-11-21 02:48:08 +00002591/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner14d750d2010-03-31 05:39:57 +00002592/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattnereec791a2010-01-26 23:18:02 +00002593bool DwarfDebug::extractScopeInformation() {
Devang Patelaf9e8472009-10-01 20:31:14 +00002594 // If scope information was extracted using .dbg intrinsics then there is not
2595 // any need to extract these information by scanning each instruction.
2596 if (!DbgScopeMap.empty())
2597 return false;
2598
Dan Gohman314bf7c2010-04-23 01:18:53 +00002599 // Scan each instruction and create scopes. First build working set of scopes.
Devang Pateleac9c072010-04-27 19:46:33 +00002600 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2601 SmallVector<DbgRange, 4> MIRanges;
2602 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002603 const MDNode *PrevScope = NULL;
2604 const MDNode *PrevInlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002605 const MachineInstr *RangeBeginMI = NULL;
2606 const MachineInstr *PrevMI = NULL;
Chris Lattnerd38fee82010-04-05 00:13:49 +00002607 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patelaf9e8472009-10-01 20:31:14 +00002608 I != E; ++I) {
2609 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2610 II != IE; ++II) {
2611 const MachineInstr *MInsn = II;
Devang Patele9f8f5e2010-05-07 20:54:48 +00002612 const MDNode *Scope = NULL;
2613 const MDNode *InlinedAt = NULL;
Devang Pateleac9c072010-04-27 19:46:33 +00002614
2615 // Check if instruction has valid location information.
2616 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2617 PrevMI = MInsn;
2618 continue;
2619 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002620
Devang Pateleac9c072010-04-27 19:46:33 +00002621 // If scope has not changed then skip this instruction.
2622 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2623 PrevMI = MInsn;
2624 continue;
2625 }
2626
Jim Grosbach1e20b962010-07-21 21:21:52 +00002627 if (RangeBeginMI) {
2628 // If we have alread seen a beginning of a instruction range and
Devang Pateleac9c072010-04-27 19:46:33 +00002629 // current instruction scope does not match scope of first instruction
2630 // in this range then create a new instruction range.
2631 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002632 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel61409622010-07-07 20:12:52 +00002633 PrevInlinedAt);
Devang Pateleac9c072010-04-27 19:46:33 +00002634 MIRanges.push_back(R);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002635 }
Devang Pateleac9c072010-04-27 19:46:33 +00002636
2637 // This is a beginning of a new instruction range.
2638 RangeBeginMI = MInsn;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002639
Devang Pateleac9c072010-04-27 19:46:33 +00002640 // Reset previous markers.
2641 PrevMI = MInsn;
2642 PrevScope = Scope;
2643 PrevInlinedAt = InlinedAt;
Devang Patel53bb5c92009-11-10 23:06:00 +00002644 }
2645 }
2646
Devang Pateleac9c072010-04-27 19:46:33 +00002647 // Create last instruction range.
2648 if (RangeBeginMI && PrevMI && PrevScope) {
2649 DbgRange R(RangeBeginMI, PrevMI);
2650 MIRanges.push_back(R);
2651 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patelaf9e8472009-10-01 20:31:14 +00002652 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002653
Devang Patel344130e2010-01-04 20:44:00 +00002654 if (!CurrentFnDbgScope)
2655 return false;
2656
Devang Pateleac9c072010-04-27 19:46:33 +00002657 calculateDominanceGraph(CurrentFnDbgScope);
2658 if (PrintDbgScope)
2659 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2660
2661 // Find ranges of instructions covered by each DbgScope;
2662 DbgScope *PrevDbgScope = NULL;
2663 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2664 RE = MIRanges.end(); RI != RE; ++RI) {
2665 const DbgRange &R = *RI;
2666 DbgScope *S = MI2ScopeMap.lookup(R.first);
2667 assert (S && "Lost DbgScope for a machine instruction!");
2668 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2669 PrevDbgScope->closeInsnRange(S);
2670 S->openInsnRange(R.first);
2671 S->extendInsnRange(R.second);
2672 PrevDbgScope = S;
2673 }
2674
2675 if (PrevDbgScope)
2676 PrevDbgScope->closeInsnRange();
Devang Patelaf9e8472009-10-01 20:31:14 +00002677
Devang Patele37b0c62010-04-08 18:43:56 +00002678 identifyScopeMarkers();
Devang Patel6122a4d2010-04-08 15:37:09 +00002679
2680 return !DbgScopeMap.empty();
2681}
2682
Jim Grosbach1e20b962010-07-21 21:21:52 +00002683/// identifyScopeMarkers() -
Devang Pateleac9c072010-04-27 19:46:33 +00002684/// Each DbgScope has first instruction and last instruction to mark beginning
2685/// and end of a scope respectively. Create an inverse map that list scopes
2686/// starts (and ends) with an instruction. One instruction may start (or end)
2687/// multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00002688void DwarfDebug::identifyScopeMarkers() {
Devang Patel42aafd72010-01-20 02:05:23 +00002689 SmallVector<DbgScope *, 4> WorkList;
2690 WorkList.push_back(CurrentFnDbgScope);
2691 while (!WorkList.empty()) {
Chris Lattner14d750d2010-03-31 05:39:57 +00002692 DbgScope *S = WorkList.pop_back_val();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002693
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002694 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002695 if (!Children.empty())
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002696 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00002697 SE = Children.end(); SI != SE; ++SI)
2698 WorkList.push_back(*SI);
2699
Devang Patel53bb5c92009-11-10 23:06:00 +00002700 if (S->isAbstractScope())
2701 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002702
Devang Pateleac9c072010-04-27 19:46:33 +00002703 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2704 if (Ranges.empty())
2705 continue;
2706 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2707 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002708 assert(RI->first && "DbgRange does not have first instruction!");
2709 assert(RI->second && "DbgRange does not have second instruction!");
Devang Pateleac9c072010-04-27 19:46:33 +00002710 InsnsEndScopeSet.insert(RI->second);
2711 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002712 }
Devang Patelaf9e8472009-10-01 20:31:14 +00002713}
2714
Dan Gohman084751c2010-04-20 00:37:27 +00002715/// FindFirstDebugLoc - Find the first debug location in the function. This
2716/// is intended to be an approximation for the source position of the
2717/// beginning of the function.
2718static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2719 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2720 I != E; ++I)
2721 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2722 MBBI != MBBE; ++MBBI) {
2723 DebugLoc DL = MBBI->getDebugLoc();
2724 if (!DL.isUnknown())
2725 return DL;
2726 }
2727 return DebugLoc();
2728}
2729
Devang Patel2c4ceb12009-11-21 02:48:08 +00002730/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002731/// emitted immediately after the function entry point.
Chris Lattnereec791a2010-01-26 23:18:02 +00002732void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00002733 if (!MMI->hasDebugInfo()) return;
Bill Wendling5f017e82010-04-07 09:28:04 +00002734 if (!extractScopeInformation()) return;
Devang Patel60b35bd2009-10-06 18:37:31 +00002735
Devang Pateleac9c072010-04-27 19:46:33 +00002736 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2737 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002738 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00002739 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002740
2741 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2742 // function.
Dan Gohman084751c2010-04-20 00:37:27 +00002743 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattnerde4845c2010-04-02 19:42:39 +00002744 if (FDL.isUnknown()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002745
Devang Patele9f8f5e2010-05-07 20:54:48 +00002746 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings0db42712010-07-19 23:56:30 +00002747 const MDNode *TheScope = 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002748
Chris Lattnerde4845c2010-04-02 19:42:39 +00002749 DISubprogram SP = getDISubprogram(Scope);
2750 unsigned Line, Col;
2751 if (SP.Verify()) {
2752 Line = SP.getLineNumber();
2753 Col = 0;
Stuart Hastings0db42712010-07-19 23:56:30 +00002754 TheScope = SP;
Chris Lattnerde4845c2010-04-02 19:42:39 +00002755 } else {
2756 Line = FDL.getLine();
2757 Col = FDL.getCol();
Stuart Hastings0db42712010-07-19 23:56:30 +00002758 TheScope = Scope;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002759 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002760
Stuart Hastings0db42712010-07-19 23:56:30 +00002761 recordSourceLine(Line, Col, TheScope);
Devang Patelb2b31a62010-05-26 19:37:24 +00002762
Devang Patelb9abe9f2010-06-02 16:42:51 +00002763 /// ProcessedArgs - Collection of arguments already processed.
2764 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2765
Devang Patelb2b31a62010-05-26 19:37:24 +00002766 DebugLoc PrevLoc;
2767 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2768 I != E; ++I)
2769 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2770 II != IE; ++II) {
2771 const MachineInstr *MI = II;
2772 DebugLoc DL = MI->getDebugLoc();
2773 if (MI->isDebugValue()) {
Devang Patelb2b31a62010-05-26 19:37:24 +00002774 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2775 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2776 if (!DV.Verify()) continue;
Devang Patel55e97172010-05-27 16:47:30 +00002777 // If DBG_VALUE is for a local variable then it needs a label.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002778 if (DV.getTag() != dwarf::DW_TAG_arg_variable
Devang Patel7fb231c2010-07-01 21:38:08 +00002779 && isDbgValueInUndefinedReg(MI) == false)
Devang Patelb2b31a62010-05-26 19:37:24 +00002780 InsnNeedsLabel.insert(MI);
Devang Patel55e97172010-05-27 16:47:30 +00002781 // DBG_VALUE for inlined functions argument needs a label.
Devang Patel7fb231c2010-07-01 21:38:08 +00002782 else if (!DISubprogram(getDISubprogram(DV.getContext())).
2783 describes(MF->getFunction()))
Devang Patel55e97172010-05-27 16:47:30 +00002784 InsnNeedsLabel.insert(MI);
2785 // DBG_VALUE indicating argument location change needs a label.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002786 else if (isDbgValueInUndefinedReg(MI) == false
2787 && !ProcessedArgs.insert(DV))
Devang Patelb2b31a62010-05-26 19:37:24 +00002788 InsnNeedsLabel.insert(MI);
2789 } else {
Jim Grosbach1e20b962010-07-21 21:21:52 +00002790 // If location is unknown then instruction needs a location only if
Devang Patelb2b31a62010-05-26 19:37:24 +00002791 // UnknownLocations flag is set.
2792 if (DL.isUnknown()) {
2793 if (UnknownLocations && !PrevLoc.isUnknown())
2794 InsnNeedsLabel.insert(MI);
2795 } else if (DL != PrevLoc)
2796 // Otherwise, instruction needs a location only if it is new location.
2797 InsnNeedsLabel.insert(MI);
2798 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002799
Devang Patelb2b31a62010-05-26 19:37:24 +00002800 if (!DL.isUnknown() || UnknownLocations)
2801 PrevLoc = DL;
2802 }
2803
2804 PrevLabel = FunctionBeginSym;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002805}
2806
Devang Patel2c4ceb12009-11-21 02:48:08 +00002807/// endFunction - Gather and emit post-function debug information.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002808///
Chris Lattnereec791a2010-01-26 23:18:02 +00002809void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendling5f017e82010-04-07 09:28:04 +00002810 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00002811
Devang Patel344130e2010-01-04 20:44:00 +00002812 if (CurrentFnDbgScope) {
Devang Patel65eb4822010-05-22 00:04:14 +00002813
Devang Patelc3f5f782010-05-25 23:40:22 +00002814 // Define end label for subprogram.
2815 FunctionEndSym = Asm->GetTempSymbol("func_end",
2816 Asm->getFunctionNumber());
2817 // Assumes in correct section after the entry point.
2818 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002819
Devang Patel78e127d2010-06-25 22:07:34 +00002820 SmallPtrSet<const MDNode *, 16> ProcessedVars;
2821 collectVariableInfo(MF, ProcessedVars);
Devang Patel65eb4822010-05-22 00:04:14 +00002822
Devang Patel344130e2010-01-04 20:44:00 +00002823 // Get function line info.
2824 if (!Lines.empty()) {
2825 // Get section line info.
2826 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2827 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2828 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2829 // Append the function info to section info.
2830 SectionLineInfos.insert(SectionLineInfos.end(),
2831 Lines.begin(), Lines.end());
2832 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002833
Devang Patel344130e2010-01-04 20:44:00 +00002834 // Construct abstract scopes.
2835 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel78e127d2010-06-25 22:07:34 +00002836 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel78e127d2010-06-25 22:07:34 +00002837 DISubprogram SP((*AI)->getScopeNode());
2838 if (SP.Verify()) {
2839 // Collect info for variables that were optimized out.
2840 StringRef FName = SP.getLinkageName();
2841 if (FName.empty())
2842 FName = SP.getName();
2843 const Module *M = MF->getFunction()->getParent();
Jim Grosbach1e20b962010-07-21 21:21:52 +00002844 if (NamedMDNode *NMD =
2845 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patel78e127d2010-06-25 22:07:34 +00002846 getRealLinkageName(FName)))) {
2847 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman872814a2010-07-21 18:54:18 +00002848 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel78e127d2010-06-25 22:07:34 +00002849 if (!DV || !ProcessedVars.insert(DV))
2850 continue;
Devang Patel1d68d212010-06-30 00:11:08 +00002851 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel78e127d2010-06-25 22:07:34 +00002852 if (Scope)
2853 Scope->addVariable(new DbgVariable(DV));
2854 }
2855 }
2856 }
Devang Patel90e19aa2010-06-30 01:40:11 +00002857 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
2858 constructScopeDIE(*AI);
Devang Patel78e127d2010-06-25 22:07:34 +00002859 }
Devang Patel61409622010-07-07 20:12:52 +00002860
Devang Patel9c488372010-05-04 06:15:30 +00002861 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002862
Devang Patel9c488372010-05-04 06:15:30 +00002863 if (!DisableFramePointerElim(*MF))
Jim Grosbach1e20b962010-07-21 21:21:52 +00002864 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel9c488372010-05-04 06:15:30 +00002865 dwarf::DW_FORM_flag, 1);
2866
2867
Chris Lattnerd38fee82010-04-05 00:13:49 +00002868 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel344130e2010-01-04 20:44:00 +00002869 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002870 }
2871
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002872 // Clear debug info
Devang Patelf54b8522010-01-19 01:26:02 +00002873 CurrentFnDbgScope = NULL;
Devang Patelb2b31a62010-05-26 19:37:24 +00002874 InsnNeedsLabel.clear();
Devang Patel26c1e562010-05-20 16:36:41 +00002875 DbgVariableToFrameIndexMap.clear();
2876 VarToAbstractVarMap.clear();
2877 DbgVariableToDbgInstMap.clear();
2878 DbgVariableLabelsMap.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002879 DeleteContainerSeconds(DbgScopeMap);
Devang Patel51424712010-04-09 16:04:20 +00002880 InsnsEndScopeSet.clear();
Devang Patelf54b8522010-01-19 01:26:02 +00002881 ConcreteScopes.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002882 DeleteContainerSeconds(AbstractScopes);
Devang Patelf54b8522010-01-19 01:26:02 +00002883 AbstractScopesList.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00002884 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00002885 LabelsBeforeInsn.clear();
2886 LabelsAfterInsn.clear();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002887 Lines.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00002888 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002889}
2890
Devang Patel26c1e562010-05-20 16:36:41 +00002891/// recordVariableFrameIndex - Record a variable's index.
2892void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2893 assert (V && "Invalid DbgVariable!");
2894 DbgVariableToFrameIndexMap[V] = Index;
2895}
2896
2897/// findVariableFrameIndex - Return true if frame index for the variable
2898/// is found. Update FI to hold value of the index.
2899bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
2900 assert (V && "Invalid DbgVariable!");
2901 DenseMap<const DbgVariable *, int>::iterator I =
2902 DbgVariableToFrameIndexMap.find(V);
2903 if (I == DbgVariableToFrameIndexMap.end())
2904 return false;
2905 *FI = I->second;
2906 return true;
2907}
2908
2909/// findVariableLabel - Find MCSymbol for the variable.
2910const MCSymbol *DwarfDebug::findVariableLabel(const DbgVariable *V) {
2911 DenseMap<const DbgVariable *, const MCSymbol *>::iterator I
2912 = DbgVariableLabelsMap.find(V);
2913 if (I == DbgVariableLabelsMap.end())
2914 return NULL;
2915 else return I->second;
2916}
2917
Jim Grosbach1e20b962010-07-21 21:21:52 +00002918/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patelee432862010-05-20 19:57:06 +00002919/// instruction.
2920DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
2921 DbgScope *Scope = NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002922 LLVMContext &Ctx =
Devang Patelee432862010-05-20 19:57:06 +00002923 MInsn->getParent()->getParent()->getFunction()->getContext();
2924 DebugLoc DL = MInsn->getDebugLoc();
2925
Jim Grosbach1e20b962010-07-21 21:21:52 +00002926 if (DL.isUnknown())
Devang Patelee432862010-05-20 19:57:06 +00002927 return Scope;
2928
2929 if (const MDNode *IA = DL.getInlinedAt(Ctx))
2930 Scope = ConcreteScopes.lookup(IA);
2931 if (Scope == 0)
2932 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002933
Devang Patelee432862010-05-20 19:57:06 +00002934 return Scope;
2935}
2936
2937
Chris Lattnerc6087842010-03-09 04:54:43 +00002938/// recordSourceLine - Register a source line with debug info. Returns the
2939/// unique label that was emitted and which provides correspondence to
2940/// the source line list.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002941MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel61409622010-07-07 20:12:52 +00002942 const MDNode *S) {
Devang Patel65dbc902009-11-25 17:36:49 +00002943 StringRef Dir;
2944 StringRef Fn;
Devang Patelf84548d2009-10-05 18:03:19 +00002945
Dan Gohman1cc0d622010-05-05 23:41:32 +00002946 unsigned Src = 1;
2947 if (S) {
2948 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00002949
Dan Gohman1cc0d622010-05-05 23:41:32 +00002950 if (Scope.isCompileUnit()) {
2951 DICompileUnit CU(S);
2952 Dir = CU.getDirectory();
2953 Fn = CU.getFilename();
2954 } else if (Scope.isSubprogram()) {
2955 DISubprogram SP(S);
2956 Dir = SP.getDirectory();
2957 Fn = SP.getFilename();
2958 } else if (Scope.isLexicalBlock()) {
2959 DILexicalBlock DB(S);
2960 Dir = DB.getDirectory();
2961 Fn = DB.getFilename();
2962 } else
2963 assert(0 && "Unexpected scope info");
2964
2965 Src = GetOrCreateSourceID(Dir, Fn);
2966 }
2967
Chris Lattner63d78362010-03-14 08:36:50 +00002968 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattner25b68c62010-03-14 08:15:55 +00002969 Lines.push_back(SrcLineInfo(Line, Col, Src, Label));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002970
Chris Lattnerc6087842010-03-09 04:54:43 +00002971 Asm->OutStreamer.EmitLabel(Label);
2972 return Label;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002973}
2974
Bill Wendling829e67b2009-05-20 23:22:40 +00002975//===----------------------------------------------------------------------===//
2976// Emit Methods
2977//===----------------------------------------------------------------------===//
2978
Devang Patel2c4ceb12009-11-21 02:48:08 +00002979/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling94d04b82009-05-20 23:21:38 +00002980///
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002981unsigned
2982DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002983 // Get the children.
2984 const std::vector<DIE *> &Children = Die->getChildren();
2985
2986 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00002987 if (!Last && !Children.empty())
Benjamin Kramer345ef342010-03-31 19:34:01 +00002988 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling94d04b82009-05-20 23:21:38 +00002989
2990 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002991 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00002992
2993 // Get the abbreviation for this DIE.
2994 unsigned AbbrevNumber = Die->getAbbrevNumber();
2995 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2996
2997 // Set DIE offset
2998 Die->setOffset(Offset);
2999
3000 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00003001 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00003002
3003 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
3004 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3005
3006 // Size the DIE attribute values.
3007 for (unsigned i = 0, N = Values.size(); i < N; ++i)
3008 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00003009 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00003010
3011 // Size the DIE children if any.
3012 if (!Children.empty()) {
3013 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
3014 "Children flag not set");
3015
3016 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00003017 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling94d04b82009-05-20 23:21:38 +00003018
3019 // End of children marker.
3020 Offset += sizeof(int8_t);
3021 }
3022
3023 Die->setSize(Offset - Die->getOffset());
3024 return Offset;
3025}
3026
Devang Patel2c4ceb12009-11-21 02:48:08 +00003027/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling94d04b82009-05-20 23:21:38 +00003028///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003029void DwarfDebug::computeSizeAndOffsets() {
Devang Patel163a9f72010-05-10 22:49:55 +00003030 unsigned PrevOffset = 0;
3031 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3032 E = CUMap.end(); I != E; ++I) {
3033 // Compute size of compile unit header.
3034 static unsigned Offset = PrevOffset +
3035 sizeof(int32_t) + // Length of Compilation Unit Info
3036 sizeof(int16_t) + // DWARF version number
3037 sizeof(int32_t) + // Offset Into Abbrev. Section
3038 sizeof(int8_t); // Pointer Size (in bytes)
3039 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
3040 PrevOffset = Offset;
3041 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003042}
3043
Chris Lattner11b8f302010-04-04 23:02:02 +00003044/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3045/// temporary label to it if SymbolStem is specified.
Chris Lattner9c69e285532010-04-04 22:59:04 +00003046static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner11b8f302010-04-04 23:02:02 +00003047 const char *SymbolStem = 0) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00003048 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner11b8f302010-04-04 23:02:02 +00003049 if (!SymbolStem) return 0;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003050
Chris Lattner9c69e285532010-04-04 22:59:04 +00003051 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3052 Asm->OutStreamer.EmitLabel(TmpSym);
3053 return TmpSym;
3054}
3055
3056/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3057/// the start of each one.
Chris Lattnerfa070b02010-04-04 22:33:59 +00003058void DwarfDebug::EmitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003059 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003060
Bill Wendling94d04b82009-05-20 23:21:38 +00003061 // Dwarf sections base addresses.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003062 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner9c69e285532010-04-04 22:59:04 +00003063 DwarfFrameSectionSym =
3064 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3065 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003066
Jim Grosbach1e20b962010-07-21 21:21:52 +00003067 DwarfInfoSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003068 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003069 DwarfAbbrevSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003070 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner11b8f302010-04-04 23:02:02 +00003071 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003072
Chris Lattner9c69e285532010-04-04 22:59:04 +00003073 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner11b8f302010-04-04 23:02:02 +00003074 EmitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003075
Devang Patelaf608bd2010-08-24 00:06:12 +00003076 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner11b8f302010-04-04 23:02:02 +00003077 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3078 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3079 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003080 DwarfStrSectionSym =
Chris Lattner9c69e285532010-04-04 22:59:04 +00003081 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patelf2548ca2010-04-16 23:33:45 +00003082 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3083 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00003084
Devang Patelc3f5f782010-05-25 23:40:22 +00003085 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3086 "section_debug_loc");
3087
Chris Lattner9c69e285532010-04-04 22:59:04 +00003088 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattner4ad1efe2010-04-04 23:10:38 +00003089 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003090}
3091
Devang Patel2c4ceb12009-11-21 02:48:08 +00003092/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling94d04b82009-05-20 23:21:38 +00003093///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003094void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003095 // Get the abbreviation for this DIE.
3096 unsigned AbbrevNumber = Die->getAbbrevNumber();
3097 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3098
Bill Wendling94d04b82009-05-20 23:21:38 +00003099 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00003100 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00003101 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3102 Twine::utohexstr(Die->getOffset()) + ":0x" +
3103 Twine::utohexstr(Die->getSize()) + " " +
3104 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003105 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00003106
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00003107 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling94d04b82009-05-20 23:21:38 +00003108 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3109
3110 // Emit the DIE attribute values.
3111 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3112 unsigned Attr = AbbrevData[i].getAttribute();
3113 unsigned Form = AbbrevData[i].getForm();
3114 assert(Form && "Too many attributes for DIE (check abbreviation)");
3115
Chris Lattner3f53c832010-04-04 18:52:31 +00003116 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00003117 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003118
Bill Wendling94d04b82009-05-20 23:21:38 +00003119 switch (Attr) {
3120 case dwarf::DW_AT_sibling:
Devang Patel2c4ceb12009-11-21 02:48:08 +00003121 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003122 break;
3123 case dwarf::DW_AT_abstract_origin: {
3124 DIEEntry *E = cast<DIEEntry>(Values[i]);
3125 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00003126 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00003127 Asm->EmitInt32(Addr);
3128 break;
3129 }
Devang Patelf2548ca2010-04-16 23:33:45 +00003130 case dwarf::DW_AT_ranges: {
3131 // DW_AT_range Value encodes offset in debug_range section.
3132 DIEInteger *V = cast<DIEInteger>(Values[i]);
3133 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3134 V->getValue(),
3135 DwarfDebugRangeSectionSym,
3136 4);
3137 break;
3138 }
Devang Patelc3f5f782010-05-25 23:40:22 +00003139 case dwarf::DW_AT_location: {
3140 if (UseDotDebugLocEntry.count(Die) != 0) {
3141 DIELabel *L = cast<DIELabel>(Values[i]);
3142 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
3143 } else
3144 Values[i]->EmitValue(Asm, Form);
3145 break;
3146 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003147 default:
3148 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003149 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00003150 break;
3151 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003152 }
3153
3154 // Emit the DIE children if any.
3155 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3156 const std::vector<DIE *> &Children = Die->getChildren();
3157
3158 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00003159 emitDIE(Children[j]);
Bill Wendling94d04b82009-05-20 23:21:38 +00003160
Chris Lattner3f53c832010-04-04 18:52:31 +00003161 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00003162 Asm->OutStreamer.AddComment("End Of Children Mark");
3163 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003164 }
3165}
3166
Devang Patel8a241142009-12-09 18:24:21 +00003167/// emitDebugInfo - Emit the debug info section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003168///
Devang Patel8a241142009-12-09 18:24:21 +00003169void DwarfDebug::emitDebugInfo() {
3170 // Start debug info section.
3171 Asm->OutStreamer.SwitchSection(
3172 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel163a9f72010-05-10 22:49:55 +00003173 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3174 E = CUMap.end(); I != E; ++I) {
3175 CompileUnit *TheCU = I->second;
3176 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00003177
Devang Patel163a9f72010-05-10 22:49:55 +00003178 // Emit the compile units header.
3179 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3180 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003181
Devang Patel163a9f72010-05-10 22:49:55 +00003182 // Emit size of content not including length itself
3183 unsigned ContentSize = Die->getSize() +
3184 sizeof(int16_t) + // DWARF version number
3185 sizeof(int32_t) + // Offset Into Abbrev. Section
3186 sizeof(int8_t) + // Pointer Size (in bytes)
3187 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003188
Devang Patel163a9f72010-05-10 22:49:55 +00003189 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3190 Asm->EmitInt32(ContentSize);
3191 Asm->OutStreamer.AddComment("DWARF version number");
3192 Asm->EmitInt16(dwarf::DWARF_VERSION);
3193 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3194 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3195 DwarfAbbrevSectionSym);
3196 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3197 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003198
Devang Patel163a9f72010-05-10 22:49:55 +00003199 emitDIE(Die);
3200 // FIXME - extra padding for gdb bug.
3201 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3202 Asm->EmitInt8(0);
3203 Asm->EmitInt8(0);
3204 Asm->EmitInt8(0);
3205 Asm->EmitInt8(0);
3206 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3207 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003208}
3209
Devang Patel2c4ceb12009-11-21 02:48:08 +00003210/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003211///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003212void DwarfDebug::emitAbbreviations() const {
Bill Wendling94d04b82009-05-20 23:21:38 +00003213 // Check to see if it is worth the effort.
3214 if (!Abbreviations.empty()) {
3215 // Start the debug abbrev section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003216 Asm->OutStreamer.SwitchSection(
3217 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003218
Chris Lattnerc0215722010-04-04 19:25:43 +00003219 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003220
3221 // For each abbrevation.
3222 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3223 // Get abbreviation data
3224 const DIEAbbrev *Abbrev = Abbreviations[i];
3225
3226 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003227 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00003228
3229 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003230 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00003231 }
3232
3233 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003234 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00003235
Chris Lattnerc0215722010-04-04 19:25:43 +00003236 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003237 }
3238}
3239
Devang Patel2c4ceb12009-11-21 02:48:08 +00003240/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling94d04b82009-05-20 23:21:38 +00003241/// the line matrix.
3242///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003243void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003244 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00003245 Asm->OutStreamer.AddComment("Extended Op");
3246 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003247
Chris Lattner233f52b2010-03-09 23:52:58 +00003248 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003249 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003250 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3251 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3252
3253 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00003254
Chris Lattnerc0215722010-04-04 19:25:43 +00003255 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003256 Asm->getTargetData().getPointerSize(),
3257 0/*AddrSpace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003258
3259 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00003260 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3261 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00003262 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00003263 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003264}
3265
Devang Patel2c4ceb12009-11-21 02:48:08 +00003266/// emitDebugLines - Emit source line information.
Bill Wendling94d04b82009-05-20 23:21:38 +00003267///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003268void DwarfDebug::emitDebugLines() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003269 // If the target is using .loc/.file, the assembler will be emitting the
3270 // .debug_line table automatically.
Chris Lattnerd38fee82010-04-05 00:13:49 +00003271 if (Asm->MAI->hasDotLocAndDotFile())
Bill Wendling94d04b82009-05-20 23:21:38 +00003272 return;
3273
3274 // Minimum line delta, thus ranging from -10..(255-10).
3275 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
3276 // Maximum line delta, thus ranging from -10..(255-10).
3277 const int MaxLineDelta = 255 + MinLineDelta;
3278
3279 // Start the dwarf line section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003280 Asm->OutStreamer.SwitchSection(
3281 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003282
3283 // Construct the section header.
Chris Lattner233f52b2010-03-09 23:52:58 +00003284 Asm->OutStreamer.AddComment("Length of Source Line Info");
Chris Lattnera6437182010-04-04 19:58:12 +00003285 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_end"),
3286 Asm->GetTempSymbol("line_begin"), 4);
Chris Lattnerc0215722010-04-04 19:25:43 +00003287 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003288
Chris Lattner233f52b2010-03-09 23:52:58 +00003289 Asm->OutStreamer.AddComment("DWARF version number");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003290 Asm->EmitInt16(dwarf::DWARF_VERSION);
Bill Wendling94d04b82009-05-20 23:21:38 +00003291
Chris Lattner233f52b2010-03-09 23:52:58 +00003292 Asm->OutStreamer.AddComment("Prolog Length");
Chris Lattnera6437182010-04-04 19:58:12 +00003293 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_prolog_end"),
3294 Asm->GetTempSymbol("line_prolog_begin"), 4);
Chris Lattnerc0215722010-04-04 19:25:43 +00003295 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_begin"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003296
Chris Lattner233f52b2010-03-09 23:52:58 +00003297 Asm->OutStreamer.AddComment("Minimum Instruction Length");
3298 Asm->EmitInt8(1);
3299 Asm->OutStreamer.AddComment("Default is_stmt_start flag");
3300 Asm->EmitInt8(1);
3301 Asm->OutStreamer.AddComment("Line Base Value (Special Opcodes)");
3302 Asm->EmitInt8(MinLineDelta);
3303 Asm->OutStreamer.AddComment("Line Range Value (Special Opcodes)");
3304 Asm->EmitInt8(MaxLineDelta);
3305 Asm->OutStreamer.AddComment("Special Opcode Base");
3306 Asm->EmitInt8(-MinLineDelta);
Bill Wendling94d04b82009-05-20 23:21:38 +00003307
3308 // Line number standard opcode encodings argument count
Chris Lattner233f52b2010-03-09 23:52:58 +00003309 Asm->OutStreamer.AddComment("DW_LNS_copy arg count");
3310 Asm->EmitInt8(0);
3311 Asm->OutStreamer.AddComment("DW_LNS_advance_pc arg count");
3312 Asm->EmitInt8(1);
3313 Asm->OutStreamer.AddComment("DW_LNS_advance_line arg count");
3314 Asm->EmitInt8(1);
3315 Asm->OutStreamer.AddComment("DW_LNS_set_file arg count");
3316 Asm->EmitInt8(1);
3317 Asm->OutStreamer.AddComment("DW_LNS_set_column arg count");
3318 Asm->EmitInt8(1);
3319 Asm->OutStreamer.AddComment("DW_LNS_negate_stmt arg count");
3320 Asm->EmitInt8(0);
3321 Asm->OutStreamer.AddComment("DW_LNS_set_basic_block arg count");
3322 Asm->EmitInt8(0);
3323 Asm->OutStreamer.AddComment("DW_LNS_const_add_pc arg count");
3324 Asm->EmitInt8(0);
3325 Asm->OutStreamer.AddComment("DW_LNS_fixed_advance_pc arg count");
3326 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003327
3328 // Emit directories.
3329 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
Chris Lattner4cf202b2010-01-23 03:11:46 +00003330 const std::string &Dir = getSourceDirectoryName(DI);
Chris Lattner3f53c832010-04-04 18:52:31 +00003331 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Directory");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003332 Asm->OutStreamer.EmitBytes(StringRef(Dir.c_str(), Dir.size()+1), 0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003333 }
3334
Chris Lattner233f52b2010-03-09 23:52:58 +00003335 Asm->OutStreamer.AddComment("End of directories");
3336 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003337
3338 // Emit files.
3339 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
3340 // Remember source id starts at 1.
3341 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
Chris Lattner4cf202b2010-01-23 03:11:46 +00003342 const std::string &FN = getSourceFileName(Id.second);
Chris Lattner3f53c832010-04-04 18:52:31 +00003343 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Source");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003344 Asm->OutStreamer.EmitBytes(StringRef(FN.c_str(), FN.size()+1), 0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003345
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003346 Asm->EmitULEB128(Id.first, "Directory #");
3347 Asm->EmitULEB128(0, "Mod date");
3348 Asm->EmitULEB128(0, "File size");
Bill Wendling94d04b82009-05-20 23:21:38 +00003349 }
3350
Chris Lattner233f52b2010-03-09 23:52:58 +00003351 Asm->OutStreamer.AddComment("End of files");
3352 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003353
Chris Lattnerc0215722010-04-04 19:25:43 +00003354 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003355
3356 // A sequence for each text section.
3357 unsigned SecSrcLinesSize = SectionSourceLines.size();
3358
3359 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
3360 // Isolate current sections line info.
3361 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
3362
Bill Wendling94d04b82009-05-20 23:21:38 +00003363 // Dwarf assumes we start with first line of first source file.
3364 unsigned Source = 1;
3365 unsigned Line = 1;
3366
3367 // Construct rows of the address, source, line, column matrix.
3368 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
3369 const SrcLineInfo &LineInfo = LineInfos[i];
Chris Lattner25b68c62010-03-14 08:15:55 +00003370 MCSymbol *Label = LineInfo.getLabel();
Chris Lattnerb9130602010-03-14 02:20:58 +00003371 if (!Label->isDefined()) continue; // Not emitted, in dead code.
Bill Wendling94d04b82009-05-20 23:21:38 +00003372
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003373 if (Asm->isVerbose()) {
Chris Lattner188a87d2010-03-10 01:04:13 +00003374 std::pair<unsigned, unsigned> SrcID =
Bill Wendling94d04b82009-05-20 23:21:38 +00003375 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner188a87d2010-03-10 01:04:13 +00003376 Asm->OutStreamer.AddComment(Twine(getSourceDirectoryName(SrcID.first)) +
Chris Lattner49f618a2010-03-10 02:29:31 +00003377 "/" +
3378 Twine(getSourceFileName(SrcID.second)) +
Chris Lattner188a87d2010-03-10 01:04:13 +00003379 ":" + Twine(LineInfo.getLine()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003380 }
3381
3382 // Define the line address.
Chris Lattner233f52b2010-03-09 23:52:58 +00003383 Asm->OutStreamer.AddComment("Extended Op");
3384 Asm->EmitInt8(0);
3385 Asm->OutStreamer.AddComment("Op size");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003386 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00003387
3388 Asm->OutStreamer.AddComment("DW_LNE_set_address");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003389 Asm->EmitInt8(dwarf::DW_LNE_set_address);
Chris Lattner233f52b2010-03-09 23:52:58 +00003390
3391 Asm->OutStreamer.AddComment("Location label");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003392 Asm->OutStreamer.EmitSymbolValue(Label,
3393 Asm->getTargetData().getPointerSize(),
Chris Lattnerb9130602010-03-14 02:20:58 +00003394 0/*AddrSpace*/);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003395
Bill Wendling94d04b82009-05-20 23:21:38 +00003396 // If change of source, then switch to the new source.
3397 if (Source != LineInfo.getSourceID()) {
3398 Source = LineInfo.getSourceID();
Chris Lattner233f52b2010-03-09 23:52:58 +00003399 Asm->OutStreamer.AddComment("DW_LNS_set_file");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003400 Asm->EmitInt8(dwarf::DW_LNS_set_file);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003401 Asm->EmitULEB128(Source, "New Source");
Bill Wendling94d04b82009-05-20 23:21:38 +00003402 }
3403
3404 // If change of line.
3405 if (Line != LineInfo.getLine()) {
3406 // Determine offset.
3407 int Offset = LineInfo.getLine() - Line;
3408 int Delta = Offset - MinLineDelta;
3409
3410 // Update line.
3411 Line = LineInfo.getLine();
3412
3413 // If delta is small enough and in range...
3414 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
3415 // ... then use fast opcode.
Chris Lattner233f52b2010-03-09 23:52:58 +00003416 Asm->OutStreamer.AddComment("Line Delta");
3417 Asm->EmitInt8(Delta - MinLineDelta);
Bill Wendling94d04b82009-05-20 23:21:38 +00003418 } else {
3419 // ... otherwise use long hand.
Chris Lattner233f52b2010-03-09 23:52:58 +00003420 Asm->OutStreamer.AddComment("DW_LNS_advance_line");
Bill Wendling94d04b82009-05-20 23:21:38 +00003421 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003422 Asm->EmitSLEB128(Offset, "Line Offset");
Chris Lattner233f52b2010-03-09 23:52:58 +00003423 Asm->OutStreamer.AddComment("DW_LNS_copy");
3424 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling94d04b82009-05-20 23:21:38 +00003425 }
3426 } else {
3427 // Copy the previous row (different address or source)
Chris Lattner233f52b2010-03-09 23:52:58 +00003428 Asm->OutStreamer.AddComment("DW_LNS_copy");
3429 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling94d04b82009-05-20 23:21:38 +00003430 }
3431 }
3432
Devang Patel2c4ceb12009-11-21 02:48:08 +00003433 emitEndOfLineMatrix(j + 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003434 }
3435
3436 if (SecSrcLinesSize == 0)
3437 // Because we're emitting a debug_line section, we still need a line
3438 // table. The linker and friends expect it to exist. If there's nothing to
3439 // put into it, emit an empty table.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003440 emitEndOfLineMatrix(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00003441
Chris Lattnerc0215722010-04-04 19:25:43 +00003442 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003443}
3444
Devang Patel2c4ceb12009-11-21 02:48:08 +00003445/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003446///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003447void DwarfDebug::emitCommonDebugFrame() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003448 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003449 return;
3450
Chris Lattnerd38fee82010-04-05 00:13:49 +00003451 int stackGrowth = Asm->getTargetData().getPointerSize();
3452 if (Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3453 TargetFrameInfo::StackGrowsDown)
3454 stackGrowth *= -1;
Bill Wendling94d04b82009-05-20 23:21:38 +00003455
3456 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003457 Asm->OutStreamer.SwitchSection(
3458 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003459
Chris Lattnerc0215722010-04-04 19:25:43 +00003460 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003461 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003462 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3463 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003464
Chris Lattnerc0215722010-04-04 19:25:43 +00003465 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner233f52b2010-03-09 23:52:58 +00003466 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling94d04b82009-05-20 23:21:38 +00003467 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner233f52b2010-03-09 23:52:58 +00003468 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling94d04b82009-05-20 23:21:38 +00003469 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner233f52b2010-03-09 23:52:58 +00003470 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003471 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003472 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3473 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner233f52b2010-03-09 23:52:58 +00003474 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003475 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling94d04b82009-05-20 23:21:38 +00003476 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling94d04b82009-05-20 23:21:38 +00003477
3478 std::vector<MachineMove> Moves;
3479 RI->getInitialFrameState(Moves);
3480
Chris Lattner02b86b92010-04-04 23:41:46 +00003481 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003482
Chris Lattner059ea132010-04-28 01:05:45 +00003483 Asm->EmitAlignment(2);
Chris Lattnerc0215722010-04-04 19:25:43 +00003484 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling94d04b82009-05-20 23:21:38 +00003485}
3486
Devang Patel2c4ceb12009-11-21 02:48:08 +00003487/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling94d04b82009-05-20 23:21:38 +00003488/// section.
Chris Lattner206d61e2010-03-13 07:26:18 +00003489void DwarfDebug::
3490emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003491 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003492 return;
3493
3494 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003495 Asm->OutStreamer.SwitchSection(
3496 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003497
Chris Lattner233f52b2010-03-09 23:52:58 +00003498 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner206d61e2010-03-13 07:26:18 +00003499 MCSymbol *DebugFrameBegin =
Chris Lattnerc0215722010-04-04 19:25:43 +00003500 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner206d61e2010-03-13 07:26:18 +00003501 MCSymbol *DebugFrameEnd =
Chris Lattnerc0215722010-04-04 19:25:43 +00003502 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnera6437182010-04-04 19:58:12 +00003503 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003504
Chris Lattner206d61e2010-03-13 07:26:18 +00003505 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling94d04b82009-05-20 23:21:38 +00003506
Chris Lattner233f52b2010-03-09 23:52:58 +00003507 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003508 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner6189ed12010-04-04 23:25:33 +00003509 DwarfFrameSectionSym);
Bill Wendling94d04b82009-05-20 23:21:38 +00003510
Chris Lattner233f52b2010-03-09 23:52:58 +00003511 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnerc0215722010-04-04 19:25:43 +00003512 MCSymbol *FuncBeginSym =
3513 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattnerfb658072010-03-13 07:40:56 +00003514 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattnerd38fee82010-04-05 00:13:49 +00003515 Asm->getTargetData().getPointerSize(),
3516 0/*AddrSpace*/);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003517
3518
Chris Lattner233f52b2010-03-09 23:52:58 +00003519 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnera6437182010-04-04 19:58:12 +00003520 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattnerd38fee82010-04-05 00:13:49 +00003521 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003522
Chris Lattner02b86b92010-04-04 23:41:46 +00003523 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00003524
Chris Lattner059ea132010-04-28 01:05:45 +00003525 Asm->EmitAlignment(2);
Chris Lattner206d61e2010-03-13 07:26:18 +00003526 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling94d04b82009-05-20 23:21:38 +00003527}
3528
Devang Patel8a241142009-12-09 18:24:21 +00003529/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3530///
3531void DwarfDebug::emitDebugPubNames() {
Devang Patel163a9f72010-05-10 22:49:55 +00003532 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3533 E = CUMap.end(); I != E; ++I) {
3534 CompileUnit *TheCU = I->second;
3535 // Start the dwarf pubnames section.
3536 Asm->OutStreamer.SwitchSection(
3537 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003538
Devang Patel163a9f72010-05-10 22:49:55 +00003539 Asm->OutStreamer.AddComment("Length of Public Names Info");
3540 Asm->EmitLabelDifference(
3541 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3542 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003543
Devang Patel163a9f72010-05-10 22:49:55 +00003544 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3545 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003546
Devang Patel163a9f72010-05-10 22:49:55 +00003547 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003548 Asm->EmitInt16(dwarf::DWARF_VERSION);
3549
Devang Patel163a9f72010-05-10 22:49:55 +00003550 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003551 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel163a9f72010-05-10 22:49:55 +00003552 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003553
Devang Patel163a9f72010-05-10 22:49:55 +00003554 Asm->OutStreamer.AddComment("Compilation Unit Length");
3555 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3556 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3557 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003558
Devang Patel163a9f72010-05-10 22:49:55 +00003559 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3560 for (StringMap<DIE*>::const_iterator
3561 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3562 const char *Name = GI->getKeyData();
3563 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003564
Devang Patel163a9f72010-05-10 22:49:55 +00003565 Asm->OutStreamer.AddComment("DIE offset");
3566 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003567
Devang Patel163a9f72010-05-10 22:49:55 +00003568 if (Asm->isVerbose())
3569 Asm->OutStreamer.AddComment("External Name");
3570 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3571 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00003572
Devang Patel163a9f72010-05-10 22:49:55 +00003573 Asm->OutStreamer.AddComment("End Mark");
3574 Asm->EmitInt32(0);
3575 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3576 TheCU->getID()));
Bill Wendling94d04b82009-05-20 23:21:38 +00003577 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003578}
3579
Devang Patel193f7202009-11-24 01:14:22 +00003580void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00003581 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3582 E = CUMap.end(); I != E; ++I) {
3583 CompileUnit *TheCU = I->second;
3584 // Start the dwarf pubnames section.
3585 Asm->OutStreamer.SwitchSection(
3586 Asm->getObjFileLowering().getDwarfPubTypesSection());
3587 Asm->OutStreamer.AddComment("Length of Public Types Info");
3588 Asm->EmitLabelDifference(
3589 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3590 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003591
Devang Patel163a9f72010-05-10 22:49:55 +00003592 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3593 TheCU->getID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003594
Devang Patel163a9f72010-05-10 22:49:55 +00003595 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3596 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003597
Devang Patel163a9f72010-05-10 22:49:55 +00003598 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3599 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3600 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003601
Devang Patel163a9f72010-05-10 22:49:55 +00003602 Asm->OutStreamer.AddComment("Compilation Unit Length");
3603 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3604 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3605 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003606
Devang Patel163a9f72010-05-10 22:49:55 +00003607 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3608 for (StringMap<DIE*>::const_iterator
3609 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3610 const char *Name = GI->getKeyData();
3611 DIE * Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003612
Devang Patel163a9f72010-05-10 22:49:55 +00003613 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3614 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003615
Devang Patel163a9f72010-05-10 22:49:55 +00003616 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3617 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3618 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00003619
Devang Patel163a9f72010-05-10 22:49:55 +00003620 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00003621 Asm->EmitInt32(0);
Devang Patel163a9f72010-05-10 22:49:55 +00003622 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3623 TheCU->getID()));
Devang Patel193f7202009-11-24 01:14:22 +00003624 }
Devang Patel193f7202009-11-24 01:14:22 +00003625}
3626
Devang Patel2c4ceb12009-11-21 02:48:08 +00003627/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003628///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003629void DwarfDebug::emitDebugStr() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003630 // Check to see if it is worth the effort.
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003631 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003632
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003633 // Start the dwarf str section.
3634 Asm->OutStreamer.SwitchSection(
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003635 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003636
Chris Lattnerbc733f52010-03-13 02:17:42 +00003637 // Get all of the string pool entries and put them in an array by their ID so
3638 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003639 SmallVector<std::pair<unsigned,
Chris Lattnerbc733f52010-03-13 02:17:42 +00003640 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003641
Chris Lattnerbc733f52010-03-13 02:17:42 +00003642 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3643 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3644 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00003645
Chris Lattnerbc733f52010-03-13 02:17:42 +00003646 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00003647
Chris Lattnerbc733f52010-03-13 02:17:42 +00003648 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003649 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003650 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00003651
Chris Lattner0d9d70f2010-03-09 23:38:23 +00003652 // Emit the string itself.
Chris Lattnerbc733f52010-03-13 02:17:42 +00003653 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling94d04b82009-05-20 23:21:38 +00003654 }
3655}
3656
Devang Patel2c4ceb12009-11-21 02:48:08 +00003657/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003658///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003659void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00003660 if (DotDebugLocEntries.empty())
3661 return;
3662
Bill Wendling94d04b82009-05-20 23:21:38 +00003663 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003664 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00003665 Asm->getObjFileLowering().getDwarfLocSection());
3666 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00003667 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3668 unsigned index = 1;
Jim Grosbach1e20b962010-07-21 21:21:52 +00003669 for (SmallVector<DotDebugLocEntry, 4>::iterator
3670 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00003671 I != E; ++I, ++index) {
Devang Patelc3f5f782010-05-25 23:40:22 +00003672 DotDebugLocEntry Entry = *I;
Devang Patelc3f5f782010-05-25 23:40:22 +00003673 if (Entry.isEmpty()) {
3674 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3675 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel80250682010-05-26 23:55:23 +00003676 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00003677 } else {
3678 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3679 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3680 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3681 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patelb2cf5812010-08-04 18:40:52 +00003682 if (int Offset = Entry.Loc.getOffset()) {
3683 // If the value is at a certain offset from frame register then
3684 // use DW_OP_fbreg.
3685 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patelc3f5f782010-05-25 23:40:22 +00003686 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patelb2cf5812010-08-04 18:40:52 +00003687 Asm->EmitInt16(1 + OffsetSize);
3688 Asm->OutStreamer.AddComment(
3689 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3690 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3691 Asm->OutStreamer.AddComment("Offset");
3692 Asm->EmitSLEB128(Offset);
Devang Patelc3f5f782010-05-25 23:40:22 +00003693 } else {
Devang Patelb2cf5812010-08-04 18:40:52 +00003694 if (Reg < 32) {
3695 Asm->OutStreamer.AddComment("Loc expr size");
3696 Asm->EmitInt16(1);
3697 Asm->OutStreamer.AddComment(
Devang Patela54e0cc2010-08-04 20:32:36 +00003698 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patelb2cf5812010-08-04 18:40:52 +00003699 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3700 } else {
3701 Asm->OutStreamer.AddComment("Loc expr size");
3702 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3703 Asm->EmitInt8(dwarf::DW_OP_regx);
3704 Asm->EmitULEB128(Reg);
3705 }
Devang Patelc3f5f782010-05-25 23:40:22 +00003706 }
3707 }
3708 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003709}
3710
3711/// EmitDebugARanges - Emit visible names into a debug aranges section.
3712///
3713void DwarfDebug::EmitDebugARanges() {
3714 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003715 Asm->OutStreamer.SwitchSection(
3716 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003717}
3718
Devang Patel2c4ceb12009-11-21 02:48:08 +00003719/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003720///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003721void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00003722 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003723 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00003724 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Pateleac9c072010-04-27 19:46:33 +00003725 unsigned char Size = Asm->getTargetData().getPointerSize();
3726 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00003727 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00003728 I != E; ++I) {
3729 if (*I)
3730 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003731 else
Devang Pateleac9c072010-04-27 19:46:33 +00003732 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patelf2548ca2010-04-16 23:33:45 +00003733 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003734}
3735
Devang Patel2c4ceb12009-11-21 02:48:08 +00003736/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling94d04b82009-05-20 23:21:38 +00003737///
Devang Patel2c4ceb12009-11-21 02:48:08 +00003738void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003739 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00003740 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003741 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003742 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003743 }
3744}
3745
Devang Patel2c4ceb12009-11-21 02:48:08 +00003746/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling94d04b82009-05-20 23:21:38 +00003747/// Section Header:
3748/// 1. length of section
3749/// 2. Dwarf version number
3750/// 3. address size.
3751///
3752/// Entries (one "entry" for each function that was inlined):
3753///
3754/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3755/// otherwise offset into __debug_str for regular function name.
3756/// 2. offset into __debug_str section for regular function name.
3757/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3758/// instances for the function.
3759///
3760/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3761/// inlined instance; the die_offset points to the inlined_subroutine die in the
3762/// __debug_info section, and the low_pc is the starting address for the
3763/// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00003764void DwarfDebug::emitDebugInlineInfo() {
Chris Lattnerd38fee82010-04-05 00:13:49 +00003765 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003766 return;
3767
Devang Patel163a9f72010-05-10 22:49:55 +00003768 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00003769 return;
3770
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003771 Asm->OutStreamer.SwitchSection(
3772 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00003773
Chris Lattner233f52b2010-03-09 23:52:58 +00003774 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00003775 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3776 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00003777
Chris Lattnerc0215722010-04-04 19:25:43 +00003778 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003779
Chris Lattner233f52b2010-03-09 23:52:58 +00003780 Asm->OutStreamer.AddComment("Dwarf Version");
3781 Asm->EmitInt16(dwarf::DWARF_VERSION);
3782 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003783 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00003784
Devang Patele9f8f5e2010-05-07 20:54:48 +00003785 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00003786 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00003787
Devang Patele9f8f5e2010-05-07 20:54:48 +00003788 const MDNode *Node = *I;
3789 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach7ab38df2009-11-22 19:20:36 +00003790 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00003791 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00003792 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00003793 StringRef LName = SP.getLinkageName();
3794 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00003795
Chris Lattner233f52b2010-03-09 23:52:58 +00003796 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattner4cf202b2010-01-23 03:11:46 +00003797 if (LName.empty()) {
3798 Asm->OutStreamer.EmitBytes(Name, 0);
3799 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbach1e20b962010-07-21 21:21:52 +00003800 } else
Chris Lattner6189ed12010-04-04 23:25:33 +00003801 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3802 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00003803
Chris Lattner233f52b2010-03-09 23:52:58 +00003804 Asm->OutStreamer.AddComment("Function name");
Chris Lattner6189ed12010-04-04 23:25:33 +00003805 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00003806 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00003807
Devang Patel53bb5c92009-11-10 23:06:00 +00003808 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00003809 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00003810 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00003811 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00003812
Chris Lattner3f53c832010-04-04 18:52:31 +00003813 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00003814 Asm->OutStreamer.EmitSymbolValue(LI->first,
3815 Asm->getTargetData().getPointerSize(),0);
Bill Wendling94d04b82009-05-20 23:21:38 +00003816 }
3817 }
3818
Chris Lattnerc0215722010-04-04 19:25:43 +00003819 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00003820}