blob: e6ac0ebc2daf04794bfaabf6a8633c91ab693146 [file] [log] [blame]
Bill Wendling2f921f82009-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 Lattnerb14490d2010-03-09 00:39:24 +000013
Devang Patel80ae3492009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling2f921f82009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000016#include "DIE.h"
Bill Wendling30346342010-04-05 22:59:21 +000017#include "llvm/Constants.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000018#include "llvm/Module.h"
David Greene829b3e82009-08-19 21:52:55 +000019#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000020#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000021#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000022#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000023#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000024#include "llvm/MC/MCSymbol.h"
Chris Lattnerf62e3ee2010-01-16 21:57:06 +000025#include "llvm/Target/Mangler.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000026#include "llvm/Target/TargetData.h"
27#include "llvm/Target/TargetFrameInfo.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000028#include "llvm/Target/TargetLoweringObjectFile.h"
Chris Lattner21dc46e2010-04-04 18:06:11 +000029#include "llvm/Target/TargetMachine.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000030#include "llvm/Target/TargetRegisterInfo.h"
Devang Patel61880932010-04-19 19:14:02 +000031#include "llvm/Target/TargetOptions.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000032#include "llvm/Analysis/DebugInfo.h"
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000033#include "llvm/ADT/STLExtras.h"
Chris Lattner06fa1762009-08-24 03:52:50 +000034#include "llvm/ADT/StringExtras.h"
Devang Patel6c74a872010-04-27 19:46:33 +000035#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000036#include "llvm/Support/Debug.h"
37#include "llvm/Support/ErrorHandling.h"
Devang Patel1973df22010-01-26 21:39:14 +000038#include "llvm/Support/ValueHandle.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000039#include "llvm/Support/FormattedStream.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000040#include "llvm/Support/Timer.h"
41#include "llvm/System/Path.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000042using namespace llvm;
43
Devang Patel6c74a872010-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 Grosbacha8683bb2010-07-21 21:21:52 +000047static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel30265c42010-07-07 20:12:52 +000048 cl::Hidden,
Devang Patel6c74a872010-04-27 19:46:33 +000049 cl::desc("Disable debug info printing"));
50
Dan Gohman7421ae42010-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 Wendlingfcc14142010-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 Wendling2f921f82009-05-15 09:23:25 +000060//===----------------------------------------------------------------------===//
61
62/// Configuration values for initial hash set sizes (log2).
63///
Bill Wendling2f921f82009-05-15 09:23:25 +000064static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-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 Lewyckyb7993d62009-11-17 08:11:44 +000071class CompileUnit {
Bill Wendling2f921f82009-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 Yasskin35b4e4f2010-03-12 17:45:06 +000078 const OwningPtr<DIE> CUDie;
Bill Wendling2f921f82009-05-15 09:23:25 +000079
Jeffrey Yasskin0708de12010-03-11 18:29:55 +000080 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
Devang Patel92e8c652009-11-21 00:31:03 +000081 DIE *IndexTyDie;
82
Devang Patel9a0339f2010-07-07 20:49:57 +000083 /// MDNodeToDieMap - Tracks the mapping of unit level debug informaton
Bill Wendling2f921f82009-05-15 09:23:25 +000084 /// variables to debug information entries.
Devang Patel9a0339f2010-07-07 20:49:57 +000085 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
Bill Wendling2f921f82009-05-15 09:23:25 +000086
Devang Patel9a0339f2010-07-07 20:49:57 +000087 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug informaton
Bill Wendling2f921f82009-05-15 09:23:25 +000088 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patel9a0339f2010-07-07 20:49:57 +000089 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
Bill Wendling2f921f82009-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 Patel04d2f2d2009-11-24 01:14:22 +000095 /// GlobalTypes - A map of globally visible types for this unit.
96 ///
97 StringMap<DIE*> GlobalTypes;
98
Bill Wendling2f921f82009-05-15 09:23:25 +000099public:
100 CompileUnit(unsigned I, DIE *D)
Devang Patel930143b2009-11-21 02:48:08 +0000101 : ID(I), CUDie(D), IndexTyDie(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000102
103 // Accessors.
Devang Patel04d2f2d2009-11-24 01:14:22 +0000104 unsigned getID() const { return ID; }
Jeffrey Yasskin0708de12010-03-11 18:29:55 +0000105 DIE* getCUDie() const { return CUDie.get(); }
Devang Patel04d2f2d2009-11-24 01:14:22 +0000106 const StringMap<DIE*> &getGlobals() const { return Globals; }
107 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000108
109 /// hasContent - Return true if this compile unit has something to write out.
110 ///
Devang Patel930143b2009-11-21 02:48:08 +0000111 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000112
Devang Patel930143b2009-11-21 02:48:08 +0000113 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +0000114 ///
Benjamin Kramer96956ed2010-03-31 20:15:45 +0000115 void addGlobal(StringRef Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000116
Devang Patel04d2f2d2009-11-24 01:14:22 +0000117 /// addGlobalType - Add a new global type to the compile unit.
118 ///
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000119 void addGlobalType(StringRef Name, DIE *Die) {
120 GlobalTypes[Name] = Die;
Devang Patel04d2f2d2009-11-24 01:14:22 +0000121 }
122
Devang Patele064ad42009-11-20 21:37:22 +0000123 /// getDIE - Returns the debug information entry map slot for the
Bill Wendling2f921f82009-05-15 09:23:25 +0000124 /// specified debug variable.
Devang Patel9a0339f2010-07-07 20:49:57 +0000125 DIE *getDIE(const MDNode *N) { return MDNodeToDieMap.lookup(N); }
Jim Grosbach042483e2009-11-21 23:12:12 +0000126
Devang Patele064ad42009-11-20 21:37:22 +0000127 /// insertDIE - Insert DIE into the map.
Devang Patel32cc43c2010-05-07 20:54:48 +0000128 void insertDIE(const MDNode *N, DIE *D) {
Devang Patel9a0339f2010-07-07 20:49:57 +0000129 MDNodeToDieMap.insert(std::make_pair(N, D));
Devang Patele064ad42009-11-20 21:37:22 +0000130 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000131
Devang Patele064ad42009-11-20 21:37:22 +0000132 /// getDIEEntry - Returns the debug information entry for the speciefied
133 /// debug variable.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000134 DIEEntry *getDIEEntry(const MDNode *N) {
135 DenseMap<const MDNode *, DIEEntry *>::iterator I =
136 MDNodeToDIEEntryMap.find(N);
Devang Patel9a0339f2010-07-07 20:49:57 +0000137 if (I == MDNodeToDIEEntryMap.end())
Devang Patel1f4690c2009-12-15 19:16:48 +0000138 return NULL;
139 return I->second;
140 }
Devang Patele064ad42009-11-20 21:37:22 +0000141
142 /// insertDIEEntry - Insert debug information entry into the map.
Devang Patel32cc43c2010-05-07 20:54:48 +0000143 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
Devang Patel9a0339f2010-07-07 20:49:57 +0000144 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
Bill Wendling2f921f82009-05-15 09:23:25 +0000145 }
146
Devang Patel930143b2009-11-21 02:48:08 +0000147 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +0000148 ///
Devang Patel930143b2009-11-21 02:48:08 +0000149 void addDie(DIE *Buffer) {
150 this->CUDie->addChild(Buffer);
Bill Wendling2f921f82009-05-15 09:23:25 +0000151 }
Devang Patel92e8c652009-11-21 00:31:03 +0000152
153 // getIndexTyDie - Get an anonymous type for index type.
154 DIE *getIndexTyDie() {
155 return IndexTyDie;
156 }
157
Jim Grosbach00e9c612009-11-22 19:20:36 +0000158 // setIndexTyDie - Set D as anonymous type for index which can be reused
159 // later.
Devang Patel92e8c652009-11-21 00:31:03 +0000160 void setIndexTyDie(DIE *D) {
161 IndexTyDie = D;
162 }
163
Bill Wendling2f921f82009-05-15 09:23:25 +0000164};
165
166//===----------------------------------------------------------------------===//
167/// DbgVariable - This class is used to track local variable information.
168///
Devang Patelf3d7c082009-11-16 21:53:40 +0000169class DbgVariable {
Bill Wendling2f921f82009-05-15 09:23:25 +0000170 DIVariable Var; // Variable Descriptor.
Devang Patel9fc11702010-05-25 23:40:22 +0000171 DIE *TheDIE; // Variable DIE.
172 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
Bill Wendling2f921f82009-05-15 09:23:25 +0000173public:
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000174 // AbsVar may be NULL.
Devang Patel9fc11702010-05-25 23:40:22 +0000175 DbgVariable(DIVariable V) : Var(V), TheDIE(0), DotDebugLocOffset(~0U) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000176
177 // Accessors.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000178 DIVariable getVariable() const { return Var; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000179 void setDIE(DIE *D) { TheDIE = D; }
180 DIE *getDIE() const { return TheDIE; }
Devang Patel9fc11702010-05-25 23:40:22 +0000181 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
182 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
Devang Patel6d9f9fe2010-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 Wendling2f921f82009-05-15 09:23:25 +0000250};
251
252//===----------------------------------------------------------------------===//
Devang Patel6c74a872010-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 Wendling2f921f82009-05-15 09:23:25 +0000259/// DbgScope - This class is used to track scope information.
260///
Devang Patelf3d7c082009-11-16 21:53:40 +0000261class DbgScope {
Bill Wendling2f921f82009-05-15 09:23:25 +0000262 DbgScope *Parent; // Parent to this scope.
Jim Grosbach042483e2009-11-21 23:12:12 +0000263 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel1973df22010-01-26 21:39:14 +0000264 // Location at which this scope is inlined.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000265 AssertingVH<const MDNode> InlinedAtLocation;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000266 bool AbstractScope; // Abstract Scope
Devang Patel787f94c2009-10-01 18:25:23 +0000267 const MachineInstr *LastInsn; // Last instruction of this scope.
268 const MachineInstr *FirstInsn; // First instruction of this scope.
Devang Patel6c74a872010-04-27 19:46:33 +0000269 unsigned DFSIn, DFSOut;
Jeffrey Yasskin35b4e4f2010-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 Patel6c74a872010-04-27 19:46:33 +0000274 SmallVector<DbgRange, 4> Ranges;
Owen Anderson9becc182009-06-24 22:53:20 +0000275 // Private state for dump()
276 mutable unsigned IndentLevel;
Bill Wendling2f921f82009-05-15 09:23:25 +0000277public:
Devang Patel32cc43c2010-05-07 20:54:48 +0000278 DbgScope(DbgScope *P, DIDescriptor D, const MDNode *I = 0)
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000279 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Devang Patel6c74a872010-04-27 19:46:33 +0000280 LastInsn(0), FirstInsn(0),
281 DFSIn(0), DFSOut(0), IndentLevel(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000282 virtual ~DbgScope();
283
284 // Accessors.
285 DbgScope *getParent() const { return Parent; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000286 void setParent(DbgScope *P) { Parent = P; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000287 DIDescriptor getDesc() const { return Desc; }
Devang Patel32cc43c2010-05-07 20:54:48 +0000288 const MDNode *getInlinedAt() const { return InlinedAtLocation; }
289 const MDNode *getScopeNode() const { return Desc; }
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000290 const SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
Devang Patel406798a2010-08-09 18:51:29 +0000291 const SmallVector<DbgVariable *, 8> &getDbgVariables() { return Variables; }
Devang Patel6c74a872010-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 Grosbacha8683bb2010-07-21 21:21:52 +0000296 if (!FirstInsn)
Devang Patel6c74a872010-04-27 19:46:33 +0000297 FirstInsn = MI;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000298
Devang Patel6c74a872010-04-27 19:46:33 +0000299 if (Parent)
300 Parent->openInsnRange(MI);
301 }
302
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000303 /// extendInsnRange - Extend the current instruction range covered by
Devang Patel6c74a872010-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 Grosbacha8683bb2010-07-21 21:21:52 +0000318 FirstInsn = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +0000319 LastInsn = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000320 // If Parent dominates NewScope then do not close Parent's instruction
Devang Patel6c74a872010-04-27 19:46:33 +0000321 // range.
322 if (Parent && (!NewScope || !Parent->dominates(NewScope)))
323 Parent->closeInsnRange(NewScope);
324 }
325
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000326 void setAbstractScope() { AbstractScope = true; }
327 bool isAbstractScope() const { return AbstractScope; }
Devang Patel6c74a872010-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 Grosbacha8683bb2010-07-21 21:21:52 +0000335 if (S == this)
Devang Patel6c74a872010-04-27 19:46:33 +0000336 return true;
337 if (DFSIn < S->getDFSIn() && DFSOut > S->getDFSOut())
338 return true;
339 return false;
340 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000341
Devang Patel930143b2009-11-21 02:48:08 +0000342 /// addScope - Add a scope to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000343 ///
Devang Patel930143b2009-11-21 02:48:08 +0000344 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000345
Devang Patel930143b2009-11-21 02:48:08 +0000346 /// addVariable - Add a variable to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000347 ///
Devang Patel930143b2009-11-21 02:48:08 +0000348 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000349
Bill Wendling2f921f82009-05-15 09:23:25 +0000350#ifndef NDEBUG
351 void dump() const;
352#endif
353};
Devang Patel6c74a872010-04-27 19:46:33 +0000354
Chris Lattnerf5d06362010-04-05 04:09:20 +0000355} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000356
357#ifndef NDEBUG
358void DbgScope::dump() const {
David Greenec230cb92009-12-24 00:31:35 +0000359 raw_ostream &err = dbgs();
Chris Lattner81e8e022009-08-23 00:51:00 +0000360 err.indent(IndentLevel);
Devang Patel32cc43c2010-05-07 20:54:48 +0000361 const MDNode *N = Desc;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000362 N->dump();
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000363 if (AbstractScope)
364 err << "Abstract Scope\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000365
366 IndentLevel += 2;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000367 if (!Scopes.empty())
368 err << "Children ...\n";
Bill Wendling2f921f82009-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 Wendling2f921f82009-05-15 09:23:25 +0000377DbgScope::~DbgScope() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000378 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
379 delete Variables[j];
Bill Wendling2f921f82009-05-15 09:23:25 +0000380}
381
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000382DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Devang Patel1a0df9a2010-05-10 22:49:55 +0000383 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000384 AbbreviationsSet(InitAbbreviationsSetSize),
Devang Patel12563b32010-04-16 23:33:45 +0000385 CurrentFnDbgScope(0), PrevLabel(NULL) {
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000386 NextStringPoolNumber = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000387
Chris Lattnere58b5472010-04-04 23:10:38 +0000388 DwarfFrameSectionSym = DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
389 DwarfStrSectionSym = TextSectionSym = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000390 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000391 FunctionBeginSym = FunctionEndSym = 0;
Devang Patel9c160e12010-07-08 20:10:35 +0000392 DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
Dan Gohman6e681a52010-06-18 15:56:31 +0000393 {
394 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
395 beginModule(M);
Torok Edwinf8dba242010-04-07 10:44:46 +0000396 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000397}
398DwarfDebug::~DwarfDebug() {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000399 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
400 DIEBlocks[j]->~DIEBlock();
Bill Wendling2f921f82009-05-15 09:23:25 +0000401}
402
Chris Lattnerb7aa9522010-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 Lattnera179b522010-04-04 19:25:43 +0000408 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000409}
410
411
Devang Patel930143b2009-11-21 02:48:08 +0000412/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling2f921f82009-05-15 09:23:25 +0000413///
Devang Patel930143b2009-11-21 02:48:08 +0000414void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-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 Patel930143b2009-11-21 02:48:08 +0000435/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendlingbcad77a2009-05-20 23:24:48 +0000436/// information entry.
Devang Patel930143b2009-11-21 02:48:08 +0000437DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000438 DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000439 return Value;
440}
441
Devang Patel930143b2009-11-21 02:48:08 +0000442/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000443///
Devang Patel930143b2009-11-21 02:48:08 +0000444void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000445 unsigned Form, uint64_t Integer) {
446 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000447 DIEValue *Value = Integer == 1 ?
Devang Patel9c160e12010-07-08 20:10:35 +0000448 DIEIntegerOne : new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000449 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000450}
451
Devang Patel930143b2009-11-21 02:48:08 +0000452/// addSInt - Add an signed integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000453///
Devang Patel930143b2009-11-21 02:48:08 +0000454void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000455 unsigned Form, int64_t Integer) {
456 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000457 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000458 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000459}
460
Devang Patel8c339592009-12-02 15:25:16 +0000461/// addString - Add a string attribute data and value. DIEString only
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000462/// keeps string reference.
Devang Patel930143b2009-11-21 02:48:08 +0000463void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerc3f23b82010-01-23 03:11:46 +0000464 StringRef String) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000465 DIEValue *Value = new (DIEValueAllocator) DIEString(String);
Devang Patel930143b2009-11-21 02:48:08 +0000466 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000467}
468
Devang Patel930143b2009-11-21 02:48:08 +0000469/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000470///
Devang Patel930143b2009-11-21 02:48:08 +0000471void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000472 const MCSymbol *Label) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000473 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
Devang Patel930143b2009-11-21 02:48:08 +0000474 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000475}
476
Devang Patel930143b2009-11-21 02:48:08 +0000477/// addDelta - Add a label delta attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000478///
Devang Patel930143b2009-11-21 02:48:08 +0000479void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000480 const MCSymbol *Hi, const MCSymbol *Lo) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000481 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
Devang Patel930143b2009-11-21 02:48:08 +0000482 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000483}
484
Chris Lattner3f3fb972010-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 Patel930143b2009-11-21 02:48:08 +0000493/// addBlock - Add block data.
Bill Wendling2f921f82009-05-15 09:23:25 +0000494///
Devang Patel930143b2009-11-21 02:48:08 +0000495void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling2f921f82009-05-15 09:23:25 +0000496 DIEBlock *Block) {
Chris Lattner5a00dea2010-04-05 00:18:22 +0000497 Block->ComputeSize(Asm);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000498 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
Devang Patel930143b2009-11-21 02:48:08 +0000499 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000500}
501
Devang Patel930143b2009-11-21 02:48:08 +0000502/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000503/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000504void DwarfDebug::addSourceLine(DIE *Die, DIVariable V) {
Devang Patel0625af22010-05-07 23:33:41 +0000505 // Verify variable.
Devang Patelb6511a32010-08-09 20:20:05 +0000506 if (!V.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000507 return;
508
Devang Patelb6511a32010-08-09 20:20:05 +0000509 unsigned Line = V.getLineNumber();
510 unsigned FileID = GetOrCreateSourceID(V.getContext().getDirectory(),
511 V.getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000512 assert(FileID && "Invalid file id");
Devang Patel930143b2009-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 Wendling2f921f82009-05-15 09:23:25 +0000515}
516
Devang Patel930143b2009-11-21 02:48:08 +0000517/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000518/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000519void DwarfDebug::addSourceLine(DIE *Die, DIGlobalVariable G) {
Devang Patel0625af22010-05-07 23:33:41 +0000520 // Verify global variable.
Devang Patelb6511a32010-08-09 20:20:05 +0000521 if (!G.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000522 return;
523
Devang Patelb6511a32010-08-09 20:20:05 +0000524 unsigned Line = G.getLineNumber();
525 unsigned FileID = GetOrCreateSourceID(G.getContext().getDirectory(),
526 G.getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000527 assert(FileID && "Invalid file id");
Devang Patel930143b2009-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 Wendling2f921f82009-05-15 09:23:25 +0000530}
Devang Patelb2de5fa2009-08-31 22:47:13 +0000531
Devang Patel930143b2009-11-21 02:48:08 +0000532/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000533/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000534void DwarfDebug::addSourceLine(DIE *Die, DISubprogram SP) {
Devang Patel0625af22010-05-07 23:33:41 +0000535 // Verify subprogram.
Devang Patelb6511a32010-08-09 20:20:05 +0000536 if (!SP.Verify())
Devang Patelb2de5fa2009-08-31 22:47:13 +0000537 return;
Caroline Tice183a5192009-09-11 18:25:54 +0000538 // If the line number is 0, don't add it.
Devang Patelb6511a32010-08-09 20:20:05 +0000539 if (SP.getLineNumber() == 0)
Caroline Tice183a5192009-09-11 18:25:54 +0000540 return;
541
Devang Patelb6511a32010-08-09 20:20:05 +0000542 unsigned Line = SP.getLineNumber();
543 if (!SP.getContext().Verify())
Devang Patel8119fe872010-03-08 22:02:50 +0000544 return;
Devang Patelb6511a32010-08-09 20:20:05 +0000545 unsigned FileID = GetOrCreateSourceID(SP.getDirectory(),
546 SP.getFilename());
Devang Patelb2de5fa2009-08-31 22:47:13 +0000547 assert(FileID && "Invalid file id");
Devang Patel930143b2009-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 Patelb2de5fa2009-08-31 22:47:13 +0000550}
551
Devang Patel930143b2009-11-21 02:48:08 +0000552/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000553/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000554void DwarfDebug::addSourceLine(DIE *Die, DIType Ty) {
Devang Patel0625af22010-05-07 23:33:41 +0000555 // Verify type.
Devang Patelb6511a32010-08-09 20:20:05 +0000556 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000557 return;
558
Devang Patelb6511a32010-08-09 20:20:05 +0000559 unsigned Line = Ty.getLineNumber();
560 if (!Ty.getContext().Verify())
Devang Patel8119fe872010-03-08 22:02:50 +0000561 return;
Devang Patelb6511a32010-08-09 20:20:05 +0000562 unsigned FileID = GetOrCreateSourceID(Ty.getContext().getDirectory(),
563 Ty.getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000564 assert(FileID && "Invalid file id");
Devang Patel930143b2009-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 Wendling2f921f82009-05-15 09:23:25 +0000567}
568
Devang Patel1f4690c2009-12-15 19:16:48 +0000569/// addSourceLine - Add location information to specified debug information
570/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000571void DwarfDebug::addSourceLine(DIE *Die, DINameSpace NS) {
Devang Patel0625af22010-05-07 23:33:41 +0000572 // Verify namespace.
Devang Patelb6511a32010-08-09 20:20:05 +0000573 if (!NS.Verify())
Devang Patel1f4690c2009-12-15 19:16:48 +0000574 return;
575
Devang Patelb6511a32010-08-09 20:20:05 +0000576 unsigned Line = NS.getLineNumber();
577 StringRef FN = NS.getFilename();
578 StringRef Dir = NS.getDirectory();
Devang Patel1f4690c2009-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 Patel2cfc3af2010-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 Patel6d9f9fe2010-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 Ticec87c1e22009-08-31 21:19:37 +0000601}
602
Devang Patel930143b2009-11-21 02:48:08 +0000603/// addComplexAddress - Start with the address based on the location provided,
Mike Stump14cf8ec2009-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 Patel930143b2009-11-21 02:48:08 +0000608void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000609 unsigned Attribute,
610 const MachineLocation &Location) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000611 DIType Ty = DV->getType();
Mike Stump14cf8ec2009-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 Lattner3a383cb2010-04-05 00:13:49 +0000615 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000616 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000617 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000618
619 if (Location.isReg()) {
620 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000621 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000622 } else {
623 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel930143b2009-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 Stump14cf8ec2009-09-30 00:08:22 +0000626 }
627 } else {
628 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000629 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000630 else {
Devang Patel930143b2009-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 Stump14cf8ec2009-09-30 00:08:22 +0000633 }
634
Devang Patel930143b2009-11-21 02:48:08 +0000635 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump14cf8ec2009-09-30 00:08:22 +0000636 }
637
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000638 for (unsigned i = 0, N = DV->getNumAddrElements(); i < N; ++i) {
639 uint64_t Element = DV->getAddrElement(i);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000640
641 if (Element == DIFactory::OpPlus) {
Devang Patel930143b2009-11-21 02:48:08 +0000642 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000643 addUInt(Block, 0, dwarf::DW_FORM_udata, DV->getAddrElement(++i));
Mike Stump14cf8ec2009-09-30 00:08:22 +0000644 } else if (Element == DIFactory::OpDeref) {
Devang Patel930143b2009-11-21 02:48:08 +0000645 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000646 } else llvm_unreachable("unknown DIFactory Opcode");
647 }
648
649 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000650 addBlock(Die, Attribute, 0, Block);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000651}
652
Caroline Ticec87c1e22009-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 Patel930143b2009-11-21 02:48:08 +0000662 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticec87c1e22009-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 Dunbarc418d6b2009-09-19 20:40:05 +0000667 expression that explains to the debugger how to navigate through the
Caroline Ticec87c1e22009-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 Gohman4a618822010-02-10 16:03:48 +0000690 2). Follow that pointer to get the real __Block_byref_x_VarName
Caroline Ticec87c1e22009-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 Patel930143b2009-11-21 02:48:08 +0000707/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticec87c1e22009-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 Patel930143b2009-11-21 02:48:08 +0000713void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000714 unsigned Attribute,
715 const MachineLocation &Location) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000716 DIType Ty = DV->getType();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000717 DIType TmpTy = Ty;
718 unsigned Tag = Ty.getTag();
719 bool isPointer = false;
720
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000721 StringRef varName = DV->getName();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000722
723 if (Tag == dwarf::DW_TAG_pointer_type) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000724 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000725 TmpTy = DTy.getTypeDerivedFrom();
726 isPointer = true;
727 }
728
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000729 DICompositeType blockStruct = DICompositeType(TmpTy);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000730
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000731 // Find the __forwarding field and the variable field in the __Block_byref
732 // struct.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000733 DIArray Fields = blockStruct.getTypeArray();
734 DIDescriptor varField = DIDescriptor();
735 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000736
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000737 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
738 DIDescriptor Element = Fields.getElement(i);
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000739 DIDerivedType DT = DIDerivedType(Element);
Devang Patel2d9caf92009-11-25 17:36:49 +0000740 StringRef fieldName = DT.getName();
741 if (fieldName == "__forwarding")
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000742 forwardingField = Element;
Devang Patel2d9caf92009-11-25 17:36:49 +0000743 else if (fieldName == varName)
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000744 varField = Element;
745 }
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000746
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000747 // Get the offsets for the forwarding field and the variable field.
Chris Lattner71696ef2010-03-31 06:06:37 +0000748 unsigned forwardingFieldOffset =
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000749 DIDerivedType(forwardingField).getOffsetInBits() >> 3;
Chris Lattner71696ef2010-03-31 06:06:37 +0000750 unsigned varFieldOffset =
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000751 DIDerivedType(varField).getOffsetInBits() >> 3;
Caroline Ticec87c1e22009-08-31 21:19:37 +0000752
Mike Stump944fa252009-09-24 23:21:26 +0000753 // Decode the original location, and use that as the start of the byref
754 // variable's location.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000755 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000756 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000757 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000758
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000759 if (Location.isReg()) {
760 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000761 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000762 else {
763 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel930143b2009-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 Dunbarbe22ec42009-09-19 20:40:14 +0000766 }
767 } else {
768 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000769 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000770 else {
Devang Patel930143b2009-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 Dunbarbe22ec42009-09-19 20:40:14 +0000773 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000774
Devang Patel930143b2009-11-21 02:48:08 +0000775 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000776 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000777
Mike Stump944fa252009-09-24 23:21:26 +0000778 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000779 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000780 if (isPointer)
Devang Patel930143b2009-11-21 02:48:08 +0000781 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000782
Daniel Dunbarbe22ec42009-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 Dunbarbe22ec42009-09-19 20:40:14 +0000786 if (forwardingFieldOffset > 0) {
Devang Patel930143b2009-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 Dunbarbe22ec42009-09-19 20:40:14 +0000789 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000790
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000791 // Now dereference the __forwarding field to get to the real __Block_byref
792 // struct: DW_OP_deref.
Devang Patel930143b2009-11-21 02:48:08 +0000793 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000794
Daniel Dunbarbe22ec42009-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 Dunbarbe22ec42009-09-19 20:40:14 +0000798 if (varFieldOffset > 0) {
Devang Patel930143b2009-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 Dunbarbe22ec42009-09-19 20:40:14 +0000801 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000802
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000803 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000804 addBlock(Die, Attribute, 0, Block);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000805}
806
Devang Patel930143b2009-11-21 02:48:08 +0000807/// addAddress - Add an address attribute to a die based on the location
Bill Wendling2f921f82009-05-15 09:23:25 +0000808/// provided.
Devang Patel930143b2009-11-21 02:48:08 +0000809void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000810 const MachineLocation &Location) {
Chris Lattner3a383cb2010-04-05 00:13:49 +0000811 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling2f921f82009-05-15 09:23:25 +0000812 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000813 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel804fcd42010-09-22 21:10:38 +0000814 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
815
816 if (TRI->getFrameRegister(*Asm->MF) == Location.getReg()
817 && Location.getOffset()) {
818 // If variable offset is based in frame register then use fbreg.
819 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
820 addSInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
821 addBlock(Die, Attribute, 0, Block);
822 return;
823 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000824
825 if (Location.isReg()) {
826 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000827 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000828 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000829 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
830 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000831 }
832 } else {
833 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000834 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000835 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000836 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
837 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000838 }
839
Devang Patel930143b2009-11-21 02:48:08 +0000840 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling2f921f82009-05-15 09:23:25 +0000841 }
842
Devang Patel930143b2009-11-21 02:48:08 +0000843 addBlock(Die, Attribute, 0, Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000844}
845
Devang Patel173b2b92010-04-28 01:03:09 +0000846/// addRegisterAddress - Add register location entry in variable DIE.
Devang Patele1c53f22010-05-20 16:36:41 +0000847bool DwarfDebug::addRegisterAddress(DIE *Die, const MCSymbol *VS,
Devang Patel173b2b92010-04-28 01:03:09 +0000848 const MachineOperand &MO) {
849 assert (MO.isReg() && "Invalid machine operand!");
850 if (!MO.getReg())
851 return false;
852 MachineLocation Location;
853 Location.set(MO.getReg());
854 addAddress(Die, dwarf::DW_AT_location, Location);
Devang Patele1c53f22010-05-20 16:36:41 +0000855 if (VS)
Devang Patel173b2b92010-04-28 01:03:09 +0000856 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
857 return true;
858}
859
860/// addConstantValue - Add constant value entry in variable DIE.
Devang Patele1c53f22010-05-20 16:36:41 +0000861bool DwarfDebug::addConstantValue(DIE *Die, const MCSymbol *VS,
Devang Patel173b2b92010-04-28 01:03:09 +0000862 const MachineOperand &MO) {
863 assert (MO.isImm() && "Invalid machine operand!");
864 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
865 unsigned Imm = MO.getImm();
866 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
867 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patele1c53f22010-05-20 16:36:41 +0000868 if (VS)
Devang Patel173b2b92010-04-28 01:03:09 +0000869 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
870 return true;
871}
872
873/// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patele1c53f22010-05-20 16:36:41 +0000874bool DwarfDebug::addConstantFPValue(DIE *Die, const MCSymbol *VS,
Devang Patel173b2b92010-04-28 01:03:09 +0000875 const MachineOperand &MO) {
876 assert (MO.isFPImm() && "Invalid machine operand!");
877 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
878 APFloat FPImm = MO.getFPImm()->getValueAPF();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000879
Devang Patel173b2b92010-04-28 01:03:09 +0000880 // Get the raw data form of the floating point.
881 const APInt FltVal = FPImm.bitcastToAPInt();
882 const char *FltPtr = (const char*)FltVal.getRawData();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000883
Devang Patel173b2b92010-04-28 01:03:09 +0000884 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
885 bool LittleEndian = Asm->getTargetData().isLittleEndian();
886 int Incr = (LittleEndian ? 1 : -1);
887 int Start = (LittleEndian ? 0 : NumBytes - 1);
888 int Stop = (LittleEndian ? NumBytes : -1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000889
Devang Patel173b2b92010-04-28 01:03:09 +0000890 // Output the constant to DWARF one byte at a time.
891 for (; Start != Stop; Start += Incr)
892 addUInt(Block, 0, dwarf::DW_FORM_data1,
893 (unsigned char)0xFF & FltPtr[Start]);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000894
Devang Patel173b2b92010-04-28 01:03:09 +0000895 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patele1c53f22010-05-20 16:36:41 +0000896 if (VS)
897 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000898 return true;
Devang Patel173b2b92010-04-28 01:03:09 +0000899}
900
901
Devang Patel2b75ed22009-12-10 19:14:49 +0000902/// addToContextOwner - Add Die into the list of its context owner's children.
903void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000904 if (Context.isType()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000905 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
Devang Patel2b75ed22009-12-10 19:14:49 +0000906 ContextDIE->addChild(Die);
Devang Patel1f4690c2009-12-15 19:16:48 +0000907 } else if (Context.isNameSpace()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000908 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
Devang Patel1f4690c2009-12-15 19:16:48 +0000909 ContextDIE->addChild(Die);
Stuart Hastingsafe54f12010-06-11 20:08:44 +0000910 } else if (Context.isSubprogram()) {
Devang Patel185051c2010-09-27 23:15:27 +0000911 DIE *ContextDIE = createSubprogramDIE(DISubprogram(Context));
Stuart Hastingsafe54f12010-06-11 20:08:44 +0000912 ContextDIE->addChild(Die);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000913 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patel2b75ed22009-12-10 19:14:49 +0000914 ContextDIE->addChild(Die);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000915 else
Devang Patel1a0df9a2010-05-10 22:49:55 +0000916 getCompileUnit(Context)->addDie(Die);
Devang Patel2b75ed22009-12-10 19:14:49 +0000917}
918
Devang Patelb5b60ea2009-12-10 18:05:33 +0000919/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
920/// given DIType.
921DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000922 CompileUnit *TypeCU = getCompileUnit(Ty);
923 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000924 if (TyDIE)
925 return TyDIE;
926
927 // Create new type.
928 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000929 TypeCU->insertDIE(Ty, TyDIE);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000930 if (Ty.isBasicType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000931 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000932 else if (Ty.isCompositeType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000933 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000934 else {
935 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000936 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000937 }
938
Devang Patel2b75ed22009-12-10 19:14:49 +0000939 addToContextOwner(TyDIE, Ty.getContext());
Devang Patelb5b60ea2009-12-10 18:05:33 +0000940 return TyDIE;
941}
942
Devang Patel930143b2009-11-21 02:48:08 +0000943/// addType - Add a new type attribute to the specified entity.
Devang Patel9ccfb642009-12-09 18:24:21 +0000944void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel8d6a2b72010-05-07 21:45:47 +0000945 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000946 return;
947
948 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000949 CompileUnit *TypeCU = getCompileUnit(Ty);
950 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000951 // If it exists then use the existing value.
Devang Patel930143b2009-11-21 02:48:08 +0000952 if (Entry) {
953 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000954 return;
955 }
956
Bill Wendling2f921f82009-05-15 09:23:25 +0000957 // Construct type.
Devang Patelb5b60ea2009-12-10 18:05:33 +0000958 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000959
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000960 // Set up proxy.
961 Entry = createDIEEntry(Buffer);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000962 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000963
Devang Patel930143b2009-11-21 02:48:08 +0000964 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000965}
966
Devang Patel930143b2009-11-21 02:48:08 +0000967/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000968void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000969 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000970 StringRef Name = BTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +0000971 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +0000972 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling2f921f82009-05-15 09:23:25 +0000973 BTy.getEncoding());
974
975 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +0000976 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +0000977 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +0000978 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel930143b2009-11-21 02:48:08 +0000979 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +0000980}
981
Devang Patel930143b2009-11-21 02:48:08 +0000982/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000983void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000984 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000985 StringRef Name = DTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +0000986 uint64_t Size = DTy.getSizeInBits() >> 3;
987 unsigned Tag = DTy.getTag();
988
989 // FIXME - Workaround for templates.
990 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
991
992 Buffer.setTag(Tag);
993
994 // Map to main type, void will not have a type.
995 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel9ccfb642009-12-09 18:24:21 +0000996 addType(&Buffer, FromTy);
Bill Wendling2f921f82009-05-15 09:23:25 +0000997
998 // Add name if not anonymous or intermediate type.
Devang Patelae466ef2009-11-30 23:56:56 +0000999 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001000 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001001
1002 // Add size if non-zero (derived types might be zero-sized.)
1003 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +00001004 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001005
1006 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patelb5b51592009-11-23 18:43:37 +00001007 if (!DTy.isForwardDecl())
Devang Patelb6511a32010-08-09 20:20:05 +00001008 addSourceLine(&Buffer, DTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001009}
1010
Devang Patel930143b2009-11-21 02:48:08 +00001011/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001012void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001013 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +00001014 StringRef Name = CTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001015
1016 uint64_t Size = CTy.getSizeInBits() >> 3;
1017 unsigned Tag = CTy.getTag();
1018 Buffer.setTag(Tag);
1019
1020 switch (Tag) {
1021 case dwarf::DW_TAG_vector_type:
1022 case dwarf::DW_TAG_array_type:
Devang Patel9ccfb642009-12-09 18:24:21 +00001023 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001024 break;
1025 case dwarf::DW_TAG_enumeration_type: {
1026 DIArray Elements = CTy.getTypeArray();
1027
1028 // Add enumerators to enumeration type.
1029 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1030 DIE *ElemDie = NULL;
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001031 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3b548aa2010-03-08 20:52:55 +00001032 if (Enum.isEnumerator()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001033 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel930143b2009-11-21 02:48:08 +00001034 Buffer.addChild(ElemDie);
Devang Patelfafa1fe2009-10-09 17:51:49 +00001035 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001036 }
1037 }
1038 break;
1039 case dwarf::DW_TAG_subroutine_type: {
1040 // Add return type.
1041 DIArray Elements = CTy.getTypeArray();
1042 DIDescriptor RTy = Elements.getElement(0);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001043 addType(&Buffer, DIType(RTy));
Bill Wendling2f921f82009-05-15 09:23:25 +00001044
1045 // Add prototype flag.
Devang Patel930143b2009-11-21 02:48:08 +00001046 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001047
1048 // Add arguments.
1049 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1050 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1051 DIDescriptor Ty = Elements.getElement(i);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001052 addType(Arg, DIType(Ty));
Devang Patel930143b2009-11-21 02:48:08 +00001053 Buffer.addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +00001054 }
1055 }
1056 break;
1057 case dwarf::DW_TAG_structure_type:
1058 case dwarf::DW_TAG_union_type:
1059 case dwarf::DW_TAG_class_type: {
1060 // Add elements to structure type.
1061 DIArray Elements = CTy.getTypeArray();
1062
1063 // A forward struct declared type may not have elements available.
Devang Patel3b548aa2010-03-08 20:52:55 +00001064 unsigned N = Elements.getNumElements();
1065 if (N == 0)
Bill Wendling2f921f82009-05-15 09:23:25 +00001066 break;
1067
1068 // Add elements to structure type.
Devang Patel3b548aa2010-03-08 20:52:55 +00001069 for (unsigned i = 0; i < N; ++i) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001070 DIDescriptor Element = Elements.getElement(i);
1071 DIE *ElemDie = NULL;
Devang Patelcb03b142010-09-29 21:44:16 +00001072 if (Element.isSubprogram()) {
1073 DISubprogram SP(Element);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001074 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patelcb03b142010-09-29 21:44:16 +00001075 if (SP.isProtected())
1076 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1077 dwarf::DW_ACCESS_protected);
1078 else if (SP.isPrivate())
1079 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1080 dwarf::DW_ACCESS_private);
1081 else
1082 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1083 dwarf::DW_ACCESS_public);
1084 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001085 else if (Element.isVariable()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001086 DIVariable DV(Element);
Devang Patel160c92d2010-01-30 01:08:30 +00001087 ElemDie = new DIE(dwarf::DW_TAG_variable);
1088 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1089 DV.getName());
1090 addType(ElemDie, DV.getType());
1091 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1092 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patelb6511a32010-08-09 20:20:05 +00001093 addSourceLine(ElemDie, DV);
Devang Patel3b548aa2010-03-08 20:52:55 +00001094 } else if (Element.isDerivedType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001095 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3b548aa2010-03-08 20:52:55 +00001096 else
1097 continue;
Devang Patel930143b2009-11-21 02:48:08 +00001098 Buffer.addChild(ElemDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001099 }
1100
Devang Patel3082c012009-08-27 23:51:51 +00001101 if (CTy.isAppleBlockExtension())
Devang Patel930143b2009-11-21 02:48:08 +00001102 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001103
1104 unsigned RLang = CTy.getRunTimeLang();
1105 if (RLang)
Devang Patel930143b2009-11-21 02:48:08 +00001106 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling2f921f82009-05-15 09:23:25 +00001107 dwarf::DW_FORM_data1, RLang);
Devang Patel303a1be2010-01-26 21:16:06 +00001108
1109 DICompositeType ContainingType = CTy.getContainingType();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001110 if (DIDescriptor(ContainingType).isCompositeType())
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001111 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001112 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001113 else {
1114 DIDescriptor Context = CTy.getContext();
1115 addToContextOwner(&Buffer, Context);
1116 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001117 break;
1118 }
1119 default:
1120 break;
1121 }
1122
1123 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +00001124 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001125 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001126
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001127 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
Devang Patel30265c42010-07-07 20:12:52 +00001128 || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1129 {
Bill Wendling2f921f82009-05-15 09:23:25 +00001130 // Add size if non-zero (derived types might be zero-sized.)
1131 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +00001132 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001133 else {
1134 // Add zero size if it is not a forward declaration.
1135 if (CTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +00001136 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001137 else
Devang Patel930143b2009-11-21 02:48:08 +00001138 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling2f921f82009-05-15 09:23:25 +00001139 }
1140
1141 // Add source line info if available.
1142 if (!CTy.isForwardDecl())
Devang Patelb6511a32010-08-09 20:20:05 +00001143 addSourceLine(&Buffer, CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001144 }
1145}
1146
Devang Patel930143b2009-11-21 02:48:08 +00001147/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1148void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling2f921f82009-05-15 09:23:25 +00001149 int64_t L = SR.getLo();
1150 int64_t H = SR.getHi();
1151 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1152
Devang Patel930143b2009-11-21 02:48:08 +00001153 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patelf691df32009-08-14 20:59:16 +00001154 if (L)
Devang Patel930143b2009-11-21 02:48:08 +00001155 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Patel8f046022009-12-04 23:10:24 +00001156 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling2f921f82009-05-15 09:23:25 +00001157
Devang Patel930143b2009-11-21 02:48:08 +00001158 Buffer.addChild(DW_Subrange);
Bill Wendling2f921f82009-05-15 09:23:25 +00001159}
1160
Devang Patel930143b2009-11-21 02:48:08 +00001161/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001162void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling2f921f82009-05-15 09:23:25 +00001163 DICompositeType *CTy) {
1164 Buffer.setTag(dwarf::DW_TAG_array_type);
1165 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel930143b2009-11-21 02:48:08 +00001166 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001167
1168 // Emit derived type.
Devang Patel9ccfb642009-12-09 18:24:21 +00001169 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001170 DIArray Elements = CTy->getTypeArray();
1171
Devang Patel92e8c652009-11-21 00:31:03 +00001172 // Get an anonymous type for index type.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001173 CompileUnit *TheCU = getCompileUnit(*CTy);
1174 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel92e8c652009-11-21 00:31:03 +00001175 if (!IdxTy) {
1176 // Construct an anonymous type for index type.
1177 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +00001178 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1179 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel92e8c652009-11-21 00:31:03 +00001180 dwarf::DW_ATE_signed);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001181 TheCU->addDie(IdxTy);
1182 TheCU->setIndexTyDie(IdxTy);
Devang Patel92e8c652009-11-21 00:31:03 +00001183 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001184
1185 // Add subranges to array type.
1186 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1187 DIDescriptor Element = Elements.getElement(i);
1188 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001189 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001190 }
1191}
1192
Devang Patel930143b2009-11-21 02:48:08 +00001193/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3b548aa2010-03-08 20:52:55 +00001194DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001195 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3b548aa2010-03-08 20:52:55 +00001196 StringRef Name = ETy.getName();
Devang Patel930143b2009-11-21 02:48:08 +00001197 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3b548aa2010-03-08 20:52:55 +00001198 int64_t Value = ETy.getEnumValue();
Devang Patel930143b2009-11-21 02:48:08 +00001199 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +00001200 return Enumerator;
1201}
1202
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001203/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel43ef34d2010-01-05 01:46:14 +00001204/// printer to not emit usual symbol prefix before the symbol name is used then
1205/// return linkage name after skipping this special LLVM prefix.
1206static StringRef getRealLinkageName(StringRef LinkageName) {
1207 char One = '\1';
1208 if (LinkageName.startswith(StringRef(&One, 1)))
1209 return LinkageName.substr(1);
1210 return LinkageName;
1211}
1212
Devang Patel930143b2009-11-21 02:48:08 +00001213/// createMemberDIE - Create new member DIE.
Devang Patel18ba0b42010-08-10 04:12:17 +00001214DIE *DwarfDebug::createMemberDIE(DIDerivedType DT) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001215 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel2d9caf92009-11-25 17:36:49 +00001216 StringRef Name = DT.getName();
1217 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001218 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001219
Devang Patel9ccfb642009-12-09 18:24:21 +00001220 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001221
Devang Patelb6511a32010-08-09 20:20:05 +00001222 addSourceLine(MemberDie, DT);
Bill Wendling2f921f82009-05-15 09:23:25 +00001223
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001224 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel930143b2009-11-21 02:48:08 +00001225 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel67f56f02009-11-04 22:06:12 +00001226
Bill Wendling2f921f82009-05-15 09:23:25 +00001227 uint64_t Size = DT.getSizeInBits();
Devang Patelf05d5722009-11-04 23:48:00 +00001228 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling2f921f82009-05-15 09:23:25 +00001229
1230 if (Size != FieldSize) {
1231 // Handle bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001232 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1233 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling2f921f82009-05-15 09:23:25 +00001234
1235 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling2f921f82009-05-15 09:23:25 +00001236 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1237 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer2b459982010-01-07 17:50:57 +00001238 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling2f921f82009-05-15 09:23:25 +00001239 Offset -= FieldOffset;
1240
1241 // Maybe we need to work from the other end.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001242 if (Asm->getTargetData().isLittleEndian())
1243 Offset = FieldSize - (Offset + Size);
Devang Patel930143b2009-11-21 02:48:08 +00001244 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling2f921f82009-05-15 09:23:25 +00001245
Devang Patel67f56f02009-11-04 22:06:12 +00001246 // Here WD_AT_data_member_location points to the anonymous
1247 // field that includes this bit field.
Devang Patel930143b2009-11-21 02:48:08 +00001248 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001249
1250 } else
1251 // This is not a bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001252 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001253
Devang Pateld2316892010-02-03 20:08:48 +00001254 if (DT.getTag() == dwarf::DW_TAG_inheritance
1255 && DT.isVirtual()) {
1256
1257 // For C++, virtual base classes are not at fixed offset. Use following
1258 // expression to extract appropriate offset from vtable.
1259 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1260
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001261 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Pateld2316892010-02-03 20:08:48 +00001262 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1263 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1264 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1265 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1266 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1267 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1268 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1269
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001270 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
Devang Pateld2316892010-02-03 20:08:48 +00001271 VBaseLocationDie);
1272 } else
1273 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001274
1275 if (DT.isProtected())
Devang Pateleb57c592009-12-03 19:11:07 +00001276 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001277 dwarf::DW_ACCESS_protected);
1278 else if (DT.isPrivate())
Devang Pateleb57c592009-12-03 19:11:07 +00001279 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001280 dwarf::DW_ACCESS_private);
Devang Patela1bd5a12010-09-29 19:08:08 +00001281 // Otherwise C++ member and base classes are considered public.
1282 else if (DT.getCompileUnit().getLanguage() == dwarf::DW_LANG_C_plus_plus)
Devang Pateleb57c592009-12-03 19:11:07 +00001283 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1284 dwarf::DW_ACCESS_public);
1285 if (DT.isVirtual())
1286 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1287 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling2f921f82009-05-15 09:23:25 +00001288 return MemberDie;
1289}
1290
Devang Patel525dda02009-12-14 16:18:45 +00001291/// createSubprogramDIE - Create new DIE using SP.
Devang Patel185051c2010-09-27 23:15:27 +00001292DIE *DwarfDebug::createSubprogramDIE(DISubprogram SP) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001293 CompileUnit *SPCU = getCompileUnit(SP);
1294 DIE *SPDie = SPCU->getDIE(SP);
Devang Patel525dda02009-12-14 16:18:45 +00001295 if (SPDie)
1296 return SPDie;
1297
1298 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf200b392010-03-02 17:58:15 +00001299 // Constructors and operators for anonymous aggregates do not have names.
Devang Pateld0fa3042010-03-02 01:26:20 +00001300 if (!SP.getName().empty())
1301 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling2f921f82009-05-15 09:23:25 +00001302
Devang Patel2d9caf92009-11-25 17:36:49 +00001303 StringRef LinkageName = SP.getLinkageName();
Devang Patel43ef34d2010-01-05 01:46:14 +00001304 if (!LinkageName.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001305 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel43ef34d2010-01-05 01:46:14 +00001306 getRealLinkageName(LinkageName));
1307
Devang Patelb6511a32010-08-09 20:20:05 +00001308 addSourceLine(SPDie, SP);
Bill Wendling2f921f82009-05-15 09:23:25 +00001309
Bill Wendling2f921f82009-05-15 09:23:25 +00001310 // Add prototyped tag, if C or ObjC.
1311 unsigned Lang = SP.getCompileUnit().getLanguage();
1312 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1313 Lang == dwarf::DW_LANG_ObjC)
Devang Patel930143b2009-11-21 02:48:08 +00001314 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001315
1316 // Add Return Type.
Devang Patel236526d2009-12-03 01:25:38 +00001317 DICompositeType SPTy = SP.getType();
1318 DIArray Args = SPTy.getTypeArray();
Bill Wendling2f921f82009-05-15 09:23:25 +00001319 unsigned SPTag = SPTy.getTag();
Devang Pateleb57c592009-12-03 19:11:07 +00001320
Devang Patel3b548aa2010-03-08 20:52:55 +00001321 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel9ccfb642009-12-09 18:24:21 +00001322 addType(SPDie, SPTy);
Devang Patel236526d2009-12-03 01:25:38 +00001323 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001324 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel236526d2009-12-03 01:25:38 +00001325
Devang Pateleb57c592009-12-03 19:11:07 +00001326 unsigned VK = SP.getVirtuality();
1327 if (VK) {
1328 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001329 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Pateleb57c592009-12-03 19:11:07 +00001330 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1331 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1332 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001333 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001334 SP.getContainingType()));
Devang Pateleb57c592009-12-03 19:11:07 +00001335 }
1336
Devang Patel185051c2010-09-27 23:15:27 +00001337 if (!SP.isDefinition()) {
Devang Patel930143b2009-11-21 02:48:08 +00001338 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001339
1340 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel236526d2009-12-03 01:25:38 +00001341 // be handled while processing variables.
1342 DICompositeType SPTy = SP.getType();
1343 DIArray Args = SPTy.getTypeArray();
1344 unsigned SPTag = SPTy.getTag();
1345
Bill Wendling2f921f82009-05-15 09:23:25 +00001346 if (SPTag == dwarf::DW_TAG_subroutine_type)
1347 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1348 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001349 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patel6efc8e52010-02-06 01:02:37 +00001350 addType(Arg, ATy);
1351 if (ATy.isArtificial())
1352 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel930143b2009-11-21 02:48:08 +00001353 SPDie->addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +00001354 }
1355 }
1356
Devang Patel999b4992010-02-03 19:57:19 +00001357 if (SP.isArtificial())
1358 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1359
Devang Patelb4e3b902010-04-30 19:38:23 +00001360 if (!SP.isLocalToUnit())
1361 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001362
Devang Patelb4e3b902010-04-30 19:38:23 +00001363 if (SP.isOptimized())
1364 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1365
Jim Grosbach965a73a2010-07-21 23:03:52 +00001366 if (unsigned isa = Asm->getISAEncoding()) {
1367 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1368 }
1369
Devang Patelb4e3b902010-04-30 19:38:23 +00001370 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001371 SPCU->insertDIE(SP, SPDie);
Devang Patelb4e3b902010-04-30 19:38:23 +00001372
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001373 // Add to context owner.
1374 addToContextOwner(SPDie, SP.getContext());
1375
Bill Wendling2f921f82009-05-15 09:23:25 +00001376 return SPDie;
1377}
1378
Devang Patel32cc43c2010-05-07 20:54:48 +00001379DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattner8d2fe282010-03-31 05:36:29 +00001380 assert(N && "Invalid Scope encoding!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001381
1382 DbgScope *AScope = AbstractScopes.lookup(N);
1383 if (AScope)
1384 return AScope;
Jim Grosbach042483e2009-11-21 23:12:12 +00001385
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001386 DbgScope *Parent = NULL;
1387
1388 DIDescriptor Scope(N);
1389 if (Scope.isLexicalBlock()) {
1390 DILexicalBlock DB(N);
1391 DIDescriptor ParentDesc = DB.getContext();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001392 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001393 }
1394
1395 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1396
1397 if (Parent)
Devang Patel930143b2009-11-21 02:48:08 +00001398 Parent->addScope(AScope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001399 AScope->setAbstractScope();
1400 AbstractScopes[N] = AScope;
1401 if (DIDescriptor(N).isSubprogram())
1402 AbstractScopesList.push_back(AScope);
1403 return AScope;
1404}
Devang Patel75cc16c2009-10-01 20:31:14 +00001405
Devang Patel019922d2010-04-06 23:53:48 +00001406/// isSubprogramContext - Return true if Context is either a subprogram
1407/// or another context nested inside a subprogram.
Devang Patel32cc43c2010-05-07 20:54:48 +00001408static bool isSubprogramContext(const MDNode *Context) {
Devang Patel019922d2010-04-06 23:53:48 +00001409 if (!Context)
1410 return false;
1411 DIDescriptor D(Context);
1412 if (D.isSubprogram())
1413 return true;
1414 if (D.isType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001415 return isSubprogramContext(DIType(Context).getContext());
Devang Patel019922d2010-04-06 23:53:48 +00001416 return false;
1417}
1418
Jim Grosbach042483e2009-11-21 23:12:12 +00001419/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel930143b2009-11-21 02:48:08 +00001420/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1421/// If there are global variables in this scope then create and insert
1422/// DIEs for these variables.
Devang Patel32cc43c2010-05-07 20:54:48 +00001423DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001424 CompileUnit *SPCU = getCompileUnit(SPNode);
1425 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +00001426
Chris Lattner3a383cb2010-04-05 00:13:49 +00001427 assert(SPDie && "Unable to find subprogram DIE!");
1428 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001429
Chris Lattner3a383cb2010-04-05 00:13:49 +00001430 // There is not any need to generate specification DIE for a function
1431 // defined at compile unit level. If a function is defined inside another
1432 // function then gdb prefers the definition at top level and but does not
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001433 // expect specification DIE in parent function. So avoid creating
Chris Lattner3a383cb2010-04-05 00:13:49 +00001434 // specification DIE for a function defined inside a function.
1435 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001436 !SP.getContext().isFile() &&
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001437 !isSubprogramContext(SP.getContext())) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00001438 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001439
1440 // Add arguments.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001441 DICompositeType SPTy = SP.getType();
1442 DIArray Args = SPTy.getTypeArray();
1443 unsigned SPTag = SPTy.getTag();
1444 if (SPTag == dwarf::DW_TAG_subroutine_type)
1445 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1446 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001447 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattner3a383cb2010-04-05 00:13:49 +00001448 addType(Arg, ATy);
1449 if (ATy.isArtificial())
1450 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1451 SPDie->addChild(Arg);
1452 }
1453 DIE *SPDeclDie = SPDie;
1454 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001455 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Chris Lattner3a383cb2010-04-05 00:13:49 +00001456 SPDeclDie);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001457 SPCU->addDie(SPDie);
Chris Lattner3a383cb2010-04-05 00:13:49 +00001458 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001459
Devang Patela37a95e2010-07-07 22:20:57 +00001460 // Pick up abstract subprogram DIE.
1461 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
1462 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1463 addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
1464 dwarf::DW_FORM_ref4, AbsSPDIE);
1465 SPCU->addDie(SPDie);
1466 }
1467
Chris Lattner3a383cb2010-04-05 00:13:49 +00001468 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1469 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1470 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1471 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1472 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1473 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1474 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +00001475
Chris Lattner3a383cb2010-04-05 00:13:49 +00001476 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001477}
1478
Jim Grosbach042483e2009-11-21 23:12:12 +00001479/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel930143b2009-11-21 02:48:08 +00001480/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1481DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001482
1483 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1484 if (Scope->isAbstractScope())
1485 return ScopeDIE;
1486
1487 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1488 if (Ranges.empty())
1489 return 0;
1490
1491 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1492 if (Ranges.size() > 1) {
1493 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001494 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +00001495 // DW_AT_ranges appropriately.
1496 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1497 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1498 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1499 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +00001500 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1501 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +00001502 }
1503 DebugRangeSymbols.push_back(NULL);
1504 DebugRangeSymbols.push_back(NULL);
1505 return ScopeDIE;
1506 }
1507
Devang Patel9fc11702010-05-25 23:40:22 +00001508 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1509 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001510
Devang Patel9fc11702010-05-25 23:40:22 +00001511 if (End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001512
Chris Lattnere13c3722010-03-09 01:58:53 +00001513 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1514 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001515
Devang Patel6c74a872010-04-27 19:46:33 +00001516 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1517 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001518
1519 return ScopeDIE;
1520}
1521
Devang Patel930143b2009-11-21 02:48:08 +00001522/// constructInlinedScopeDIE - This scope represents inlined body of
1523/// a function. Construct DIE to represent this concrete inlined copy
1524/// of the function.
1525DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001526
1527 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001528 assert (Ranges.empty() == false
Devang Patel6c74a872010-04-27 19:46:33 +00001529 && "DbgScope does not have instruction markers!");
1530
1531 // FIXME : .debug_inlined section specification does not clearly state how
1532 // to emit inlined scope that is split into multiple instruction ranges.
1533 // For now, use first instruction range and emit low_pc/high_pc pair and
1534 // corresponding .debug_inlined section entry for this pair.
1535 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel9fc11702010-05-25 23:40:22 +00001536 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1537 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001538
Devang Patel4c6bd662010-07-08 22:39:20 +00001539 if (StartLabel == 0 || EndLabel == 0) {
Devang Patel6c74a872010-04-27 19:46:33 +00001540 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1541 return 0;
1542 }
Chris Lattnere13c3722010-03-09 01:58:53 +00001543 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001544 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +00001545 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001546 "Invalid end label for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +00001547
Devang Patel3b548aa2010-03-08 20:52:55 +00001548 if (!Scope->getScopeNode())
Devang Patelbc97f6b2010-03-08 19:20:38 +00001549 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001550 DIScope DS(Scope->getScopeNode());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001551 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1552
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001553 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001554 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1555 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001556 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel930143b2009-11-21 02:48:08 +00001557 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001558 dwarf::DW_FORM_ref4, OriginDIE);
1559
Chris Lattner085b6522010-03-09 00:31:02 +00001560 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnere13c3722010-03-09 01:58:53 +00001561 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001562
1563 InlinedSubprogramDIEs.insert(OriginDIE);
1564
1565 // Track the start label for this inlined function.
Devang Patel32cc43c2010-05-07 20:54:48 +00001566 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001567 I = InlineInfo.find(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001568
1569 if (I == InlineInfo.end()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001570 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach00e9c612009-11-22 19:20:36 +00001571 ScopeDIE));
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001572 InlinedSPNodes.push_back(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001573 } else
Chris Lattner085b6522010-03-09 00:31:02 +00001574 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001575
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001576 DILocation DL(Scope->getInlinedAt());
Devang Patel1a0df9a2010-05-10 22:49:55 +00001577 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel930143b2009-11-21 02:48:08 +00001578 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001579
1580 return ScopeDIE;
1581}
1582
Devang Patel930143b2009-11-21 02:48:08 +00001583
1584/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel9ccfb642009-12-09 18:24:21 +00001585DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001586 StringRef Name = DV->getName();
Devang Patel2d9caf92009-11-25 17:36:49 +00001587 if (Name.empty())
Devang Patel97f99fa2009-11-13 02:25:26 +00001588 return NULL;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001589
1590 // Translate tag to proper Dwarf tag. The result variable is dropped for
1591 // now.
1592 unsigned Tag;
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001593 switch (DV->getTag()) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001594 case dwarf::DW_TAG_return_variable:
1595 return NULL;
1596 case dwarf::DW_TAG_arg_variable:
1597 Tag = dwarf::DW_TAG_formal_parameter;
1598 break;
1599 case dwarf::DW_TAG_auto_variable: // fall thru
1600 default:
1601 Tag = dwarf::DW_TAG_variable;
1602 break;
1603 }
1604
1605 // Define variable debug information entry.
1606 DIE *VariableDie = new DIE(Tag);
1607
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001608 DIE *AbsDIE = NULL;
Devang Patele1c53f22010-05-20 16:36:41 +00001609 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1610 V2AVI = VarToAbstractVarMap.find(DV);
1611 if (V2AVI != VarToAbstractVarMap.end())
1612 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach042483e2009-11-21 23:12:12 +00001613
Devang Patele1c53f22010-05-20 16:36:41 +00001614 if (AbsDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001615 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001616 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001617 else {
Devang Patel930143b2009-11-21 02:48:08 +00001618 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001619 addSourceLine(VariableDie, DV->getVariable());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001620
1621 // Add variable type.
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001622 addType(VariableDie, DV->getType());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001623 }
1624
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001625 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patel6efc8e52010-02-06 01:02:37 +00001626 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelbea08d12010-09-29 23:07:21 +00001627 else if (DIVariable(DV->getVariable()).isArtificial())
1628 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel9fc11702010-05-25 23:40:22 +00001629
1630 if (Scope->isAbstractScope()) {
1631 DV->setDIE(VariableDie);
1632 return VariableDie;
1633 }
1634
1635 // Add variable address.
1636
1637 unsigned Offset = DV->getDotDebugLocOffset();
1638 if (Offset != ~0U) {
1639 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1640 Asm->GetTempSymbol("debug_loc", Offset));
1641 DV->setDIE(VariableDie);
1642 UseDotDebugLocEntry.insert(VariableDie);
1643 return VariableDie;
1644 }
1645
1646 // Check if variable is described by a DBG_VALUE instruction.
1647 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1648 DbgVariableToDbgInstMap.find(DV);
1649 if (DVI != DbgVariableToDbgInstMap.end()) {
1650 const MachineInstr *DVInsn = DVI->second;
1651 const MCSymbol *DVLabel = findVariableLabel(DV);
1652 bool updated = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001653 // FIXME : Handle getNumOperands != 3
Devang Patel9fc11702010-05-25 23:40:22 +00001654 if (DVInsn->getNumOperands() == 3) {
Devang Patel86ec8b32010-08-31 22:22:42 +00001655 if (DVInsn->getOperand(0).isReg()) {
1656 const MachineOperand RegOp = DVInsn->getOperand(0);
1657 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1658 if (DVInsn->getOperand(1).isImm() &&
1659 TRI->getFrameRegister(*Asm->MF) == RegOp.getReg()) {
1660 addVariableAddress(DV, VariableDie, DVInsn->getOperand(1).getImm());
1661 updated = true;
1662 } else
1663 updated = addRegisterAddress(VariableDie, DVLabel, RegOp);
1664 }
Devang Patel9fc11702010-05-25 23:40:22 +00001665 else if (DVInsn->getOperand(0).isImm())
1666 updated = addConstantValue(VariableDie, DVLabel, DVInsn->getOperand(0));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001667 else if (DVInsn->getOperand(0).isFPImm())
1668 updated =
Devang Patel30265c42010-07-07 20:12:52 +00001669 addConstantFPValue(VariableDie, DVLabel, DVInsn->getOperand(0));
Devang Patel9fc11702010-05-25 23:40:22 +00001670 } else {
1671 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1672 if (Location.getReg()) {
1673 addAddress(VariableDie, dwarf::DW_AT_location, Location);
1674 if (DVLabel)
1675 addLabel(VariableDie, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr,
1676 DVLabel);
1677 updated = true;
1678 }
1679 }
1680 if (!updated) {
1681 // If variableDie is not updated then DBG_VALUE instruction does not
1682 // have valid variable info.
1683 delete VariableDie;
1684 return NULL;
1685 }
1686 DV->setDIE(VariableDie);
1687 return VariableDie;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001688 }
Devang Patel9fc11702010-05-25 23:40:22 +00001689
1690 // .. else use frame index, if available.
Devang Patel9fc11702010-05-25 23:40:22 +00001691 int FI = 0;
Devang Patel2cfc3af2010-08-31 06:11:28 +00001692 if (findVariableFrameIndex(DV, &FI))
1693 addVariableAddress(DV, VariableDie, FI);
1694
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001695 DV->setDIE(VariableDie);
1696 return VariableDie;
1697
1698}
Devang Patel930143b2009-11-21 02:48:08 +00001699
Devang Patel04d2f2d2009-11-24 01:14:22 +00001700void DwarfDebug::addPubTypes(DISubprogram SP) {
1701 DICompositeType SPTy = SP.getType();
1702 unsigned SPTag = SPTy.getTag();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001703 if (SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel04d2f2d2009-11-24 01:14:22 +00001704 return;
1705
1706 DIArray Args = SPTy.getTypeArray();
Devang Patel04d2f2d2009-11-24 01:14:22 +00001707 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001708 DIType ATy(Args.getElement(i));
Devang Patel8d6a2b72010-05-07 21:45:47 +00001709 if (!ATy.Verify())
Devang Patel04d2f2d2009-11-24 01:14:22 +00001710 continue;
1711 DICompositeType CATy = getDICompositeType(ATy);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001712 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel12d150e2010-04-13 20:35:04 +00001713 && !CATy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001714 CompileUnit *TheCU = getCompileUnit(CATy);
1715 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1716 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00001717 }
1718 }
1719}
1720
Devang Patel930143b2009-11-21 02:48:08 +00001721/// constructScopeDIE - Construct a DIE for this scope.
1722DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +00001723 if (!Scope || !Scope->getScopeNode())
1724 return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001725
Devang Patel3b548aa2010-03-08 20:52:55 +00001726 DIScope DS(Scope->getScopeNode());
1727 DIE *ScopeDIE = NULL;
1728 if (Scope->getInlinedAt())
1729 ScopeDIE = constructInlinedScopeDIE(Scope);
1730 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +00001731 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001732 if (Scope->isAbstractScope()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001733 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001734 // Note down abstract DIE.
1735 if (ScopeDIE)
1736 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
1737 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001738 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001739 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3b548aa2010-03-08 20:52:55 +00001740 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001741 else
Devang Patel3b548aa2010-03-08 20:52:55 +00001742 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel23b2ae62010-03-29 22:59:58 +00001743 if (!ScopeDIE) return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001744
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001745 // Add variables to scope.
Devang Patel406798a2010-08-09 18:51:29 +00001746 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001747 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel9ccfb642009-12-09 18:24:21 +00001748 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach042483e2009-11-21 23:12:12 +00001749 if (VariableDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001750 ScopeDIE->addChild(VariableDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001751 }
1752
1753 // Add nested scopes.
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001754 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001755 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1756 // Define the Scope debug information entry.
Devang Patel930143b2009-11-21 02:48:08 +00001757 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach042483e2009-11-21 23:12:12 +00001758 if (NestedDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001759 ScopeDIE->addChild(NestedDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001760 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001761
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001762 if (DS.isSubprogram())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001763 addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001764
Devang Patel04d2f2d2009-11-24 01:14:22 +00001765 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001766}
1767
Bill Wendling2b128d72009-05-20 23:19:06 +00001768/// GetOrCreateSourceID - Look up the source id with the given directory and
1769/// source file names. If none currently exists, create a new id and insert it
1770/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1771/// maps as well.
Chris Lattner71696ef2010-03-31 06:06:37 +00001772unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName){
Bill Wendling2b128d72009-05-20 23:19:06 +00001773 unsigned DId;
Devang Patel84a74772010-07-27 20:51:15 +00001774 assert (DirName.empty() == false && "Invalid directory name!");
Devang Patel498877d2010-07-24 00:53:22 +00001775
Devang Patel871d0b12010-09-16 20:57:49 +00001776 // If FE did not provide a file name, then assume stdin.
1777 if (FileName.empty())
1778 return GetOrCreateSourceID(DirName, "<stdin>");
1779
Bill Wendling2b128d72009-05-20 23:19:06 +00001780 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1781 if (DI != DirectoryIdMap.end()) {
1782 DId = DI->getValue();
1783 } else {
1784 DId = DirectoryNames.size() + 1;
1785 DirectoryIdMap[DirName] = DId;
1786 DirectoryNames.push_back(DirName);
1787 }
1788
1789 unsigned FId;
1790 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1791 if (FI != SourceFileIdMap.end()) {
1792 FId = FI->getValue();
1793 } else {
1794 FId = SourceFileNames.size() + 1;
1795 SourceFileIdMap[FileName] = FId;
1796 SourceFileNames.push_back(FileName);
1797 }
1798
1799 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1800 SourceIdMap.find(std::make_pair(DId, FId));
1801 if (SI != SourceIdMap.end())
1802 return SI->second;
1803
1804 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1805 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1806 SourceIds.push_back(std::make_pair(DId, FId));
1807
1808 return SrcId;
1809}
1810
Devang Patel1f4690c2009-12-15 19:16:48 +00001811/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1812DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001813 CompileUnit *TheCU = getCompileUnit(NS);
1814 DIE *NDie = TheCU->getDIE(NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001815 if (NDie)
1816 return NDie;
1817 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001818 TheCU->insertDIE(NS, NDie);
Devang Patel1f4690c2009-12-15 19:16:48 +00001819 if (!NS.getName().empty())
1820 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
Devang Patelb6511a32010-08-09 20:20:05 +00001821 addSourceLine(NDie, NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001822 addToContextOwner(NDie, NS.getContext());
1823 return NDie;
1824}
1825
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001826/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel1a0df9a2010-05-10 22:49:55 +00001827/// metadata node with tag DW_TAG_compile_unit.
Devang Patel32cc43c2010-05-07 20:54:48 +00001828void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001829 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +00001830 StringRef FN = DIUnit.getFilename();
1831 StringRef Dir = DIUnit.getDirectory();
Devang Patelb2969422009-09-29 18:40:58 +00001832 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendling2b128d72009-05-20 23:19:06 +00001833
1834 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel930143b2009-11-21 02:48:08 +00001835 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patelb2969422009-09-29 18:40:58 +00001836 DIUnit.getProducer());
Devang Patel930143b2009-11-21 02:48:08 +00001837 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendling2b128d72009-05-20 23:19:06 +00001838 DIUnit.getLanguage());
Devang Patel930143b2009-11-21 02:48:08 +00001839 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patelbd798ce2010-04-26 22:54:28 +00001840 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1841 // simplifies debug range entries.
Devang Patel1de21ec2010-06-28 22:22:47 +00001842 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Pateld22ed622010-03-22 23:11:36 +00001843 // DW_AT_stmt_list is a offset of line number information for this
Devang Patel4a213872010-08-24 00:06:12 +00001844 // compile unit in debug_line section.
Devang Patelea636392010-08-31 23:50:19 +00001845 if (Asm->MAI->doesDwarfUsesAbsoluteLabelForStmtList())
1846 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_addr,
1847 Asm->GetTempSymbol("section_line"));
1848 else
1849 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00001850
Devang Patel2d9caf92009-11-25 17:36:49 +00001851 if (!Dir.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001852 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +00001853 if (DIUnit.isOptimized())
Devang Patel930143b2009-11-21 02:48:08 +00001854 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendling2b128d72009-05-20 23:19:06 +00001855
Devang Patel2d9caf92009-11-25 17:36:49 +00001856 StringRef Flags = DIUnit.getFlags();
1857 if (!Flags.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001858 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendling2b128d72009-05-20 23:19:06 +00001859
1860 unsigned RVer = DIUnit.getRunTimeVersion();
1861 if (RVer)
Devang Patel930143b2009-11-21 02:48:08 +00001862 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +00001863 dwarf::DW_FORM_data1, RVer);
1864
Devang Patel1a0df9a2010-05-10 22:49:55 +00001865 CompileUnit *NewCU = new CompileUnit(ID, Die);
1866 if (!FirstCU)
1867 FirstCU = NewCU;
1868 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendling2b128d72009-05-20 23:19:06 +00001869}
1870
Devang Patel1a0df9a2010-05-10 22:49:55 +00001871/// getCompielUnit - Get CompileUnit DIE.
1872CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1873 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1874 DIDescriptor D(N);
1875 const MDNode *CUNode = NULL;
1876 if (D.isCompileUnit())
1877 CUNode = N;
1878 else if (D.isSubprogram())
1879 CUNode = DISubprogram(N).getCompileUnit();
1880 else if (D.isType())
1881 CUNode = DIType(N).getCompileUnit();
1882 else if (D.isGlobalVariable())
1883 CUNode = DIGlobalVariable(N).getCompileUnit();
1884 else if (D.isVariable())
1885 CUNode = DIVariable(N).getCompileUnit();
1886 else if (D.isNameSpace())
1887 CUNode = DINameSpace(N).getCompileUnit();
1888 else if (D.isFile())
1889 CUNode = DIFile(N).getCompileUnit();
1890 else
1891 return FirstCU;
1892
1893 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1894 = CUMap.find(CUNode);
1895 if (I == CUMap.end())
1896 return FirstCU;
1897 return I->second;
1898}
1899
Devang Patela8652672010-08-23 18:25:56 +00001900/// isUnsignedDIType - Return true if type encoding is unsigned.
1901static bool isUnsignedDIType(DIType Ty) {
1902 DIDerivedType DTy(Ty);
1903 if (DTy.Verify())
1904 return isUnsignedDIType(DTy.getTypeDerivedFrom());
1905
1906 DIBasicType BTy(Ty);
1907 if (BTy.Verify()) {
1908 unsigned Encoding = BTy.getEncoding();
1909 if (Encoding == dwarf::DW_ATE_unsigned ||
1910 Encoding == dwarf::DW_ATE_unsigned_char)
1911 return true;
1912 }
1913 return false;
1914}
Devang Patel1a0df9a2010-05-10 22:49:55 +00001915
1916/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00001917void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel469c12d22010-08-10 01:37:23 +00001918 DIGlobalVariable GV(N);
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001919
Devang Patelf5d53602009-09-04 23:59:07 +00001920 // If debug information is malformed then ignore it.
Devang Patel469c12d22010-08-10 01:37:23 +00001921 if (GV.Verify() == false)
Devang Patelf5d53602009-09-04 23:59:07 +00001922 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001923
1924 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001925 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel469c12d22010-08-10 01:37:23 +00001926 if (TheCU->getDIE(GV))
Devang Patel0751a282009-06-26 01:49:18 +00001927 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001928
Devang Patel469c12d22010-08-10 01:37:23 +00001929 DIType GTy = GV.getType();
Devang Patelb2197462010-08-10 07:11:13 +00001930 DIE *VariableDIE = new DIE(GV.getTag());
1931
1932 bool isGlobalVariable = GV.getGlobal() != NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001933
Devang Patel469c12d22010-08-10 01:37:23 +00001934 // Add name.
1935 addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1936 GV.getDisplayName());
1937 StringRef LinkageName = GV.getLinkageName();
Devang Patelb2197462010-08-10 07:11:13 +00001938 if (!LinkageName.empty() && isGlobalVariable)
Devang Patel469c12d22010-08-10 01:37:23 +00001939 addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
1940 getRealLinkageName(LinkageName));
1941 // Add type.
1942 addType(VariableDIE, GTy);
Devang Patel12d150e2010-04-13 20:35:04 +00001943 if (GTy.isCompositeType() && !GTy.getName().empty()
1944 && !GTy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001945 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001946 assert(Entry && "Missing global type!");
Devang Patel1a0df9a2010-05-10 22:49:55 +00001947 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00001948 }
Devang Patel469c12d22010-08-10 01:37:23 +00001949 // Add scoping info.
1950 if (!GV.isLocalToUnit()) {
1951 addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1952 // Expose as global.
1953 TheCU->addGlobal(GV.getName(), VariableDIE);
1954 }
1955 // Add line number info.
1956 addSourceLine(VariableDIE, GV);
1957 // Add to map.
1958 TheCU->insertDIE(N, VariableDIE);
1959 // Add to context owner.
1960 DIDescriptor GVContext = GV.getContext();
1961 addToContextOwner(VariableDIE, GVContext);
1962 // Add location.
Devang Patelb2197462010-08-10 07:11:13 +00001963 if (isGlobalVariable) {
1964 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1965 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1966 addLabel(Block, 0, dwarf::DW_FORM_udata,
1967 Asm->Mang->getSymbol(GV.getGlobal()));
1968 // Do not create specification DIE if context is either compile unit
1969 // or a subprogram.
1970 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
1971 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
1972 // Create specification DIE.
1973 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1974 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1975 dwarf::DW_FORM_ref4, VariableDIE);
1976 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1977 addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1978 TheCU->addDie(VariableSpecDIE);
1979 } else {
1980 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
1981 }
1982 } else if (Constant *C = GV.getConstant()) {
1983 if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
Devang Patela8652672010-08-23 18:25:56 +00001984 if (isUnsignedDIType(GTy))
Devang Patelb2197462010-08-10 07:11:13 +00001985 addUInt(VariableDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
1986 CI->getZExtValue());
1987 else
1988 addSInt(VariableDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
1989 CI->getSExtValue());
Devang Patelb2197462010-08-10 07:11:13 +00001990 }
Devang Patel469c12d22010-08-10 01:37:23 +00001991 }
Devang Patel0751a282009-06-26 01:49:18 +00001992 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001993}
1994
Devang Patel1a0df9a2010-05-10 22:49:55 +00001995/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00001996void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001997 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +00001998
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00001999 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002000 CompileUnit *TheCU = getCompileUnit(N);
2001 if (TheCU->getDIE(N))
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002002 return;
2003
Bill Wendling2b128d72009-05-20 23:19:06 +00002004 if (!SP.isDefinition())
2005 // This is a method declaration which will be handled while constructing
2006 // class type.
Devang Patel0751a282009-06-26 01:49:18 +00002007 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002008
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002009 DIE *SubprogramDie = createSubprogramDIE(SP);
2010
2011 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002012 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00002013
2014 // Add to context owner.
Devang Patel1f4690c2009-12-15 19:16:48 +00002015 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +00002016
Bill Wendling2b128d72009-05-20 23:19:06 +00002017 // Expose as global.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002018 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002019
Devang Patel0751a282009-06-26 01:49:18 +00002020 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002021}
2022
Devang Patel930143b2009-11-21 02:48:08 +00002023/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbarbe22ec42009-09-19 20:40:14 +00002024/// content. Create global DIEs and emit initial debug info sections.
2025/// This is inovked by the target AsmPrinter.
Chris Lattner11980022010-04-04 07:48:20 +00002026void DwarfDebug::beginModule(Module *M) {
Devang Patel6c74a872010-04-27 19:46:33 +00002027 if (DisableDebugInfoPrinting)
2028 return;
2029
Devang Patel63524442009-07-30 18:56:46 +00002030 DebugInfoFinder DbgFinder;
2031 DbgFinder.processModule(*M);
Devang Patel0751a282009-06-26 01:49:18 +00002032
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002033 bool HasDebugInfo = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002034
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002035 // Scan all the compile-units to see if there are any marked as the main unit.
2036 // if not, we do not generate debug info.
2037 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2038 E = DbgFinder.compile_unit_end(); I != E; ++I) {
2039 if (DICompileUnit(*I).isMain()) {
2040 HasDebugInfo = true;
2041 break;
2042 }
2043 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002044
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002045 if (!HasDebugInfo) return;
2046
2047 // Tell MMI that we have debug info.
2048 MMI->setDebugInfoAvailability(true);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002049
Chris Lattnerd442aa32010-04-04 23:17:54 +00002050 // Emit initial sections.
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002051 EmitSectionLabels();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002052
Bill Wendling2b128d72009-05-20 23:19:06 +00002053 // Create all the compile unit DIEs.
Devang Patel63524442009-07-30 18:56:46 +00002054 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2055 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002056 constructCompileUnit(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002057
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002058 // Create DIEs for each subprogram.
Devang Patel63524442009-07-30 18:56:46 +00002059 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
2060 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002061 constructSubprogramDIE(*I);
Devang Patel0751a282009-06-26 01:49:18 +00002062
Devang Patel2b75ed22009-12-10 19:14:49 +00002063 // Create DIEs for each global variable.
2064 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2065 E = DbgFinder.global_variable_end(); I != E; ++I)
2066 constructGlobalVariableDIE(*I);
2067
Devang Patel8e06a5e2010-08-10 20:01:20 +00002068 //getOrCreateTypeDIE
2069 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
2070 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2071 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2072
Devang Patel7a554812010-09-28 18:08:20 +00002073 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
2074 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2075 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2076
Bill Wendling2b128d72009-05-20 23:19:06 +00002077 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +00002078 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +00002079
2080 // Print out .file directives to specify files for .loc directives. These are
2081 // printed out early so that they precede any .loc directives.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002082 if (Asm->MAI->hasDotLocAndDotFile()) {
Bill Wendling2b128d72009-05-20 23:19:06 +00002083 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
2084 // Remember source id starts at 1.
2085 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002086 // FIXME: don't use sys::path for this! This should not depend on the
2087 // host.
Bill Wendling2b128d72009-05-20 23:19:06 +00002088 sys::Path FullPath(getSourceDirectoryName(Id.first));
2089 bool AppendOk =
2090 FullPath.appendComponent(getSourceFileName(Id.second));
2091 assert(AppendOk && "Could not append filename to directory!");
2092 AppendOk = false;
Chris Lattner601ef332010-01-25 18:58:59 +00002093 Asm->OutStreamer.EmitDwarfFileDirective(i, FullPath.str());
Bill Wendling2b128d72009-05-20 23:19:06 +00002094 }
2095 }
Bill Wendling2b128d72009-05-20 23:19:06 +00002096}
2097
Devang Patel930143b2009-11-21 02:48:08 +00002098/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendling2b128d72009-05-20 23:19:06 +00002099///
Devang Patel930143b2009-11-21 02:48:08 +00002100void DwarfDebug::endModule() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002101 if (!FirstCU) return;
Devang Patelf3b2db62010-06-28 18:25:03 +00002102 const Module *M = MMI->getModule();
Devang Pateld0701282010-08-02 17:32:15 +00002103 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patelf3b2db62010-06-28 18:25:03 +00002104 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2105 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2106 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2107 DISubprogram SP(AllSPs->getOperand(SI));
2108 if (!SP.Verify()) continue;
2109
2110 // Collect info for variables that were optimized out.
Devang Patel18efced2010-07-19 17:53:55 +00002111 if (!SP.isDefinition()) continue;
Devang Patelf3b2db62010-06-28 18:25:03 +00002112 StringRef FName = SP.getLinkageName();
2113 if (FName.empty())
2114 FName = SP.getName();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002115 NamedMDNode *NMD =
Devang Patelf3b2db62010-06-28 18:25:03 +00002116 M->getNamedMetadata(Twine("llvm.dbg.lv.", getRealLinkageName(FName)));
2117 if (!NMD) continue;
2118 unsigned E = NMD->getNumOperands();
2119 if (!E) continue;
2120 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Pateld0701282010-08-02 17:32:15 +00002121 DeadFnScopeMap[SP] = Scope;
Devang Patelf3b2db62010-06-28 18:25:03 +00002122 for (unsigned I = 0; I != E; ++I) {
2123 DIVariable DV(NMD->getOperand(I));
2124 if (!DV.Verify()) continue;
2125 Scope->addVariable(new DbgVariable(DV));
2126 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002127
Devang Patelf3b2db62010-06-28 18:25:03 +00002128 // Construct subprogram DIE and add variables DIEs.
2129 constructSubprogramDIE(SP);
2130 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patel406798a2010-08-09 18:51:29 +00002131 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf3b2db62010-06-28 18:25:03 +00002132 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2133 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2134 if (VariableDIE)
2135 ScopeDIE->addChild(VariableDIE);
2136 }
2137 }
2138 }
Bill Wendling2b128d72009-05-20 23:19:06 +00002139
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002140 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2141 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2142 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2143 DIE *ISP = *AI;
Devang Patel930143b2009-11-21 02:48:08 +00002144 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002145 }
2146
Devang Patel32cc43c2010-05-07 20:54:48 +00002147 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Pateleb57c592009-12-03 19:11:07 +00002148 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2149 DIE *SPDie = CI->first;
Devang Patel32cc43c2010-05-07 20:54:48 +00002150 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Pateleb57c592009-12-03 19:11:07 +00002151 if (!N) continue;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002152 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Pateleb57c592009-12-03 19:11:07 +00002153 if (!NDie) continue;
2154 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Pateleb57c592009-12-03 19:11:07 +00002155 }
2156
Bill Wendling2b128d72009-05-20 23:19:06 +00002157 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002158 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002159 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002160 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002161 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +00002162
2163 // End text sections.
2164 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002165 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnera179b522010-04-04 19:25:43 +00002166 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendling2b128d72009-05-20 23:19:06 +00002167 }
2168
2169 // Emit common frame information.
Devang Patel930143b2009-11-21 02:48:08 +00002170 emitCommonDebugFrame();
Bill Wendling2b128d72009-05-20 23:19:06 +00002171
2172 // Emit function debug frame information
2173 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2174 E = DebugFrames.end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002175 emitFunctionDebugFrame(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002176
2177 // Compute DIE offsets and sizes.
Devang Patel930143b2009-11-21 02:48:08 +00002178 computeSizeAndOffsets();
Bill Wendling2b128d72009-05-20 23:19:06 +00002179
2180 // Emit all the DIEs into a debug info section
Devang Patel930143b2009-11-21 02:48:08 +00002181 emitDebugInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002182
2183 // Corresponding abbreviations into a abbrev section.
Devang Patel930143b2009-11-21 02:48:08 +00002184 emitAbbreviations();
Bill Wendling2b128d72009-05-20 23:19:06 +00002185
Devang Patel4a213872010-08-24 00:06:12 +00002186 // Emit source line correspondence into a debug line section.
2187 emitDebugLines();
2188
Bill Wendling2b128d72009-05-20 23:19:06 +00002189 // Emit info into a debug pubnames section.
Devang Patel930143b2009-11-21 02:48:08 +00002190 emitDebugPubNames();
Bill Wendling2b128d72009-05-20 23:19:06 +00002191
Devang Patel04d2f2d2009-11-24 01:14:22 +00002192 // Emit info into a debug pubtypes section.
2193 emitDebugPubTypes();
2194
Bill Wendling2b128d72009-05-20 23:19:06 +00002195 // Emit info into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002196 emitDebugLoc();
Bill Wendling2b128d72009-05-20 23:19:06 +00002197
2198 // Emit info into a debug aranges section.
2199 EmitDebugARanges();
2200
2201 // Emit info into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002202 emitDebugRanges();
Bill Wendling2b128d72009-05-20 23:19:06 +00002203
2204 // Emit info into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002205 emitDebugMacInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002206
2207 // Emit inline info.
Devang Patel930143b2009-11-21 02:48:08 +00002208 emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002209
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002210 // Emit info into a debug str section.
2211 emitDebugStr();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002212
Devang Pateld0701282010-08-02 17:32:15 +00002213 // clean up.
2214 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002215 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2216 E = CUMap.end(); I != E; ++I)
2217 delete I->second;
2218 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendling2b128d72009-05-20 23:19:06 +00002219}
2220
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002221/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002222DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattner915c5f92010-04-02 19:42:39 +00002223 DebugLoc ScopeLoc) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002224
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002225 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002226 if (AbsDbgVariable)
2227 return AbsDbgVariable;
2228
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002229 LLVMContext &Ctx = Var->getContext();
Chris Lattner915c5f92010-04-02 19:42:39 +00002230 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002231 if (!Scope)
2232 return NULL;
2233
Devang Patele1c53f22010-05-20 16:36:41 +00002234 AbsDbgVariable = new DbgVariable(Var);
Devang Patel930143b2009-11-21 02:48:08 +00002235 Scope->addVariable(AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002236 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002237 return AbsDbgVariable;
2238}
2239
Devang Patel490c8ab2010-05-20 19:57:06 +00002240/// collectVariableInfoFromMMITable - Collect variable information from
2241/// side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002242void
Devang Patel490c8ab2010-05-20 19:57:06 +00002243DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2244 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00002245 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patel475d32a2009-10-06 01:26:37 +00002246 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2247 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2248 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00002249 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002250 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00002251 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00002252 DIVariable DV(Var);
2253 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002254
Chris Lattner915c5f92010-04-02 19:42:39 +00002255 DbgScope *Scope = 0;
Devang Patel32cc43c2010-05-07 20:54:48 +00002256 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattner915c5f92010-04-02 19:42:39 +00002257 Scope = ConcreteScopes.lookup(IA);
2258 if (Scope == 0)
2259 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002260
Devang Patelcdb7d442009-11-10 23:20:04 +00002261 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00002262 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00002263 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002264
Devang Patele1c53f22010-05-20 16:36:41 +00002265 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2266 DbgVariable *RegVar = new DbgVariable(DV);
2267 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel930143b2009-11-21 02:48:08 +00002268 Scope->addVariable(RegVar);
Devang Patele1c53f22010-05-20 16:36:41 +00002269 if (AbsDbgVariable) {
2270 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2271 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2272 }
Devang Patel475d32a2009-10-06 01:26:37 +00002273 }
Devang Patel490c8ab2010-05-20 19:57:06 +00002274}
Devang Patela3e9c9c2010-03-15 18:33:46 +00002275
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002276/// isDbgValueInUndefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +00002277/// DBG_VALUE instruction, is in undefined reg.
2278static bool isDbgValueInUndefinedReg(const MachineInstr *MI) {
2279 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2280 if (MI->getOperand(0).isReg() && !MI->getOperand(0).getReg())
2281 return true;
2282 return false;
2283}
2284
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002285/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +00002286/// DBG_VALUE instruction, is in a defined reg.
2287static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2288 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2289 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2290 return true;
2291 return false;
2292}
2293
Devang Patel490c8ab2010-05-20 19:57:06 +00002294/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002295void
Devang Patel5c0f85c2010-06-25 22:07:34 +00002296DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2297 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002298
Devang Patel490c8ab2010-05-20 19:57:06 +00002299 /// collection info from MMI table.
2300 collectVariableInfoFromMMITable(MF, Processed);
2301
2302 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002303 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002304 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel490c8ab2010-05-20 19:57:06 +00002305 I != E; ++I)
Devang Patela3e9c9c2010-03-15 18:33:46 +00002306 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2307 II != IE; ++II) {
2308 const MachineInstr *MInsn = II;
Devang Patel9fc11702010-05-25 23:40:22 +00002309 if (!MInsn->isDebugValue() || isDbgValueInUndefinedReg(MInsn))
Devang Patela3e9c9c2010-03-15 18:33:46 +00002310 continue;
Devang Patel490c8ab2010-05-20 19:57:06 +00002311 DbgValues.push_back(MInsn);
2312 }
Devang Patela3e9c9c2010-03-15 18:33:46 +00002313
Devang Patel9fc11702010-05-25 23:40:22 +00002314 // This is a collection of DBV_VALUE instructions describing same variable.
2315 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patel490c8ab2010-05-20 19:57:06 +00002316 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2317 E = DbgValues.end(); I != E; ++I) {
2318 const MachineInstr *MInsn = *I;
Devang Patel9fc11702010-05-25 23:40:22 +00002319 MultipleValues.clear();
2320 if (isDbgValueInDefinedReg(MInsn))
2321 MultipleValues.push_back(MInsn);
Devang Patel490c8ab2010-05-20 19:57:06 +00002322 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2323 if (Processed.count(DV) != 0)
2324 continue;
2325
Devang Patelc2254f62010-06-02 19:05:13 +00002326 const MachineInstr *PrevMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002327 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
Devang Patel9fc11702010-05-25 23:40:22 +00002328 ME = DbgValues.end(); MI != ME; ++MI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002329 const MDNode *Var =
Devang Patel9fc11702010-05-25 23:40:22 +00002330 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002331 if (Var == DV && isDbgValueInDefinedReg(*MI) &&
Devang Patelc2254f62010-06-02 19:05:13 +00002332 !PrevMI->isIdenticalTo(*MI))
Devang Patel9fc11702010-05-25 23:40:22 +00002333 MultipleValues.push_back(*MI);
Devang Patelc2254f62010-06-02 19:05:13 +00002334 PrevMI = *MI;
Devang Patel9fc11702010-05-25 23:40:22 +00002335 }
2336
Devang Patel490c8ab2010-05-20 19:57:06 +00002337 DbgScope *Scope = findDbgScope(MInsn);
Devang Patel7a9dedf2010-05-27 20:25:04 +00002338 bool CurFnArg = false;
2339 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2340 DISubprogram(DV.getContext()).describes(MF->getFunction()))
2341 CurFnArg = true;
2342 if (!Scope && CurFnArg)
Devang Patelfbd6c452010-05-21 00:10:20 +00002343 Scope = CurrentFnDbgScope;
Devang Patel490c8ab2010-05-20 19:57:06 +00002344 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00002345 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00002346 continue;
2347
2348 Processed.insert(DV);
Devang Patel490c8ab2010-05-20 19:57:06 +00002349 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patel490c8ab2010-05-20 19:57:06 +00002350 Scope->addVariable(RegVar);
Devang Patel7a9dedf2010-05-27 20:25:04 +00002351 if (!CurFnArg)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002352 DbgVariableLabelsMap[RegVar] = getLabelBeforeInsn(MInsn);
Devang Patelfbd6c452010-05-21 00:10:20 +00002353 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2354 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2355 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002356 }
Devang Patel9fc11702010-05-25 23:40:22 +00002357 if (MultipleValues.size() <= 1) {
2358 DbgVariableToDbgInstMap[RegVar] = MInsn;
2359 continue;
2360 }
2361
2362 // handle multiple DBG_VALUE instructions describing one variable.
Devang Patel9fc11702010-05-25 23:40:22 +00002363 if (DotDebugLocEntries.empty())
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002364 RegVar->setDotDebugLocOffset(0);
2365 else
2366 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002367 const MachineInstr *Begin = NULL;
2368 const MachineInstr *End = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002369 for (SmallVector<const MachineInstr *, 4>::iterator
2370 MVI = MultipleValues.begin(), MVE = MultipleValues.end();
Devang Patel30265c42010-07-07 20:12:52 +00002371 MVI != MVE; ++MVI) {
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002372 if (!Begin) {
2373 Begin = *MVI;
2374 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002375 }
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002376 End = *MVI;
Devang Patel9fc11702010-05-25 23:40:22 +00002377 MachineLocation MLoc;
Devang Patel0e60e672010-08-04 18:40:52 +00002378 if (Begin->getNumOperands() == 3) {
2379 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2380 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2381 } else
2382 MLoc = Asm->getDebugValueLocation(Begin);
2383
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002384 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2385 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patel6c378ac2010-08-04 22:07:27 +00002386 if (MLoc.getReg())
2387 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
2388
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002389 Begin = End;
2390 if (MVI + 1 == MVE) {
2391 // If End is the last instruction then its value is valid
Devang Patel9fc11702010-05-25 23:40:22 +00002392 // until the end of the funtion.
Devang Patel0e60e672010-08-04 18:40:52 +00002393 MachineLocation EMLoc;
2394 if (End->getNumOperands() == 3) {
2395 if (End->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2396 EMLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2397 } else
2398 EMLoc = Asm->getDebugValueLocation(End);
Devang Patel6c378ac2010-08-04 22:07:27 +00002399 if (EMLoc.getReg())
2400 DotDebugLocEntries.
2401 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, EMLoc));
Devang Patel9fc11702010-05-25 23:40:22 +00002402 }
2403 }
2404 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00002405 }
Devang Patele0a94bf2010-05-14 21:01:35 +00002406
2407 // Collect info for variables that were optimized out.
Devang Patelad517352010-06-22 01:01:58 +00002408 const Function *F = MF->getFunction();
2409 const Module *M = F->getParent();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002410 if (NamedMDNode *NMD =
2411 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patelb6e058d2010-06-22 01:19:38 +00002412 getRealLinkageName(F->getName())))) {
Devang Patele0a94bf2010-05-14 21:01:35 +00002413 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002414 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel490c8ab2010-05-20 19:57:06 +00002415 if (!DV || !Processed.insert(DV))
Devang Patele0a94bf2010-05-14 21:01:35 +00002416 continue;
2417 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2418 if (Scope)
Devang Patele1c53f22010-05-20 16:36:41 +00002419 Scope->addVariable(new DbgVariable(DV));
Devang Patele0a94bf2010-05-14 21:01:35 +00002420 }
2421 }
Devang Patel9fc11702010-05-25 23:40:22 +00002422}
Devang Patele0a94bf2010-05-14 21:01:35 +00002423
Devang Patel9fc11702010-05-25 23:40:22 +00002424/// getLabelBeforeInsn - Return Label preceding the instruction.
2425const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2426 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2427 LabelsBeforeInsn.find(MI);
2428 if (I == LabelsBeforeInsn.end())
2429 // FunctionBeginSym always preceeds all the instruction in current function.
2430 return FunctionBeginSym;
2431 return I->second;
2432}
2433
2434/// getLabelAfterInsn - Return Label immediately following the instruction.
2435const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2436 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2437 LabelsAfterInsn.find(MI);
2438 if (I == LabelsAfterInsn.end())
2439 return NULL;
2440 return I->second;
Devang Patel475d32a2009-10-06 01:26:37 +00002441}
2442
Devang Patelbd477be2010-03-29 17:20:31 +00002443/// beginScope - Process beginning of a scope.
2444void DwarfDebug::beginScope(const MachineInstr *MI) {
Devang Patel002d54d2010-05-26 19:37:24 +00002445 if (InsnNeedsLabel.count(MI) == 0) {
2446 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patelbd477be2010-03-29 17:20:31 +00002447 return;
Devang Patel9fc11702010-05-25 23:40:22 +00002448 }
Devang Patel23b2ae62010-03-29 22:59:58 +00002449
Devang Patel002d54d2010-05-26 19:37:24 +00002450 // Check location.
2451 DebugLoc DL = MI->getDebugLoc();
2452 if (!DL.isUnknown()) {
2453 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2454 PrevLabel = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
Devang Patel6c74a872010-04-27 19:46:33 +00002455 PrevInstLoc = DL;
Devang Patel002d54d2010-05-26 19:37:24 +00002456 LabelsBeforeInsn[MI] = PrevLabel;
2457 return;
Devang Patel6c74a872010-04-27 19:46:33 +00002458 }
Devang Patelbd477be2010-03-29 17:20:31 +00002459
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002460 // If location is unknown then use temp label for this DBG_VALUE
Devang Patel002d54d2010-05-26 19:37:24 +00002461 // instruction.
2462 if (MI->isDebugValue()) {
Devang Patelacc32a52010-05-26 21:23:46 +00002463 PrevLabel = MMI->getContext().CreateTempSymbol();
2464 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00002465 LabelsBeforeInsn[MI] = PrevLabel;
2466 return;
2467 }
2468
2469 if (UnknownLocations) {
2470 PrevLabel = recordSourceLine(0, 0, 0);
2471 LabelsBeforeInsn[MI] = PrevLabel;
2472 return;
2473 }
2474
2475 assert (0 && "Instruction is not processed!");
Devang Patel8db360d2009-10-06 01:50:42 +00002476}
2477
Devang Patel930143b2009-11-21 02:48:08 +00002478/// endScope - Process end of a scope.
2479void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel3ebd8932010-04-08 16:50:29 +00002480 if (InsnsEndScopeSet.count(MI) != 0) {
2481 // Emit a label if this instruction ends a scope.
2482 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2483 Asm->OutStreamer.EmitLabel(Label);
Devang Patel6c74a872010-04-27 19:46:33 +00002484 LabelsAfterInsn[MI] = Label;
Devang Patel3ebd8932010-04-08 16:50:29 +00002485 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002486}
2487
Devang Patel6c74a872010-04-27 19:46:33 +00002488/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002489DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel30265c42010-07-07 20:12:52 +00002490 const MDNode *InlinedAt) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002491 if (!InlinedAt) {
2492 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2493 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002494 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002495 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2496 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Patel6c74a872010-04-27 19:46:33 +00002497 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002498 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002499 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Patel6c74a872010-04-27 19:46:33 +00002500 WScope->setParent(Parent);
2501 Parent->addScope(WScope);
2502 }
2503
2504 if (!WScope->getParent()) {
2505 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastings9b5005c2010-06-15 23:06:30 +00002506 // We used to check only for a linkage name, but that fails
2507 // since we began omitting the linkage name for private
2508 // functions. The new way is to check for the name in metadata,
2509 // but that's not supported in old .ll test cases. Ergo, we
2510 // check both.
Stuart Hastingsafe54f12010-06-11 20:08:44 +00002511 if (SPName == Asm->MF->getFunction()->getName() ||
2512 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Patel6c74a872010-04-27 19:46:33 +00002513 CurrentFnDbgScope = WScope;
2514 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002515
Devang Patel6c74a872010-04-27 19:46:33 +00002516 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002517 }
2518
Devang Patel5c0f85c2010-06-25 22:07:34 +00002519 getOrCreateAbstractScope(Scope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002520 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2521 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002522 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002523
2524 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2525 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2526 DILocation DL(InlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002527 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002528 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Patel6c74a872010-04-27 19:46:33 +00002529 WScope->setParent(Parent);
2530 Parent->addScope(WScope);
2531
2532 ConcreteScopes[InlinedAt] = WScope;
Devang Patel6c74a872010-04-27 19:46:33 +00002533
2534 return WScope;
Devang Patel8db360d2009-10-06 01:50:42 +00002535}
2536
Devang Patel6c74a872010-04-27 19:46:33 +00002537/// hasValidLocation - Return true if debug location entry attached with
2538/// machine instruction encodes valid location info.
2539static bool hasValidLocation(LLVMContext &Ctx,
2540 const MachineInstr *MInsn,
Devang Patel32cc43c2010-05-07 20:54:48 +00002541 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Patel6c74a872010-04-27 19:46:33 +00002542 DebugLoc DL = MInsn->getDebugLoc();
2543 if (DL.isUnknown()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002544
Devang Patel32cc43c2010-05-07 20:54:48 +00002545 const MDNode *S = DL.getScope(Ctx);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002546
Devang Patel6c74a872010-04-27 19:46:33 +00002547 // There is no need to create another DIE for compile unit. For all
2548 // other scopes, create one DbgScope now. This will be translated
2549 // into a scope DIE at the end.
2550 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002551
Devang Patel6c74a872010-04-27 19:46:33 +00002552 Scope = S;
2553 InlinedAt = DL.getInlinedAt(Ctx);
2554 return true;
2555}
2556
2557/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2558/// hierarchy.
2559static void calculateDominanceGraph(DbgScope *Scope) {
2560 assert (Scope && "Unable to calculate scop edominance graph!");
2561 SmallVector<DbgScope *, 4> WorkStack;
2562 WorkStack.push_back(Scope);
2563 unsigned Counter = 0;
2564 while (!WorkStack.empty()) {
2565 DbgScope *WS = WorkStack.back();
2566 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2567 bool visitedChildren = false;
2568 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2569 SE = Children.end(); SI != SE; ++SI) {
2570 DbgScope *ChildScope = *SI;
2571 if (!ChildScope->getDFSOut()) {
2572 WorkStack.push_back(ChildScope);
2573 visitedChildren = true;
2574 ChildScope->setDFSIn(++Counter);
2575 break;
2576 }
2577 }
2578 if (!visitedChildren) {
2579 WorkStack.pop_back();
2580 WS->setDFSOut(++Counter);
2581 }
2582 }
2583}
2584
2585/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002586static
Devang Patel6c74a872010-04-27 19:46:33 +00002587void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2588 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2589{
2590#ifndef NDEBUG
2591 unsigned PrevDFSIn = 0;
2592 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2593 I != E; ++I) {
2594 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2595 II != IE; ++II) {
2596 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002597 const MDNode *Scope = NULL;
2598 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002599
2600 // Check if instruction has valid location information.
2601 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2602 dbgs() << " [ ";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002603 if (InlinedAt)
Devang Patel6c74a872010-04-27 19:46:33 +00002604 dbgs() << "*";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002605 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Patel6c74a872010-04-27 19:46:33 +00002606 MI2ScopeMap.find(MInsn);
2607 if (DI != MI2ScopeMap.end()) {
2608 DbgScope *S = DI->second;
2609 dbgs() << S->getDFSIn();
2610 PrevDFSIn = S->getDFSIn();
2611 } else
2612 dbgs() << PrevDFSIn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002613 } else
Devang Patel6c74a872010-04-27 19:46:33 +00002614 dbgs() << " [ x" << PrevDFSIn;
2615 dbgs() << " ]";
2616 MInsn->dump();
2617 }
2618 dbgs() << "\n";
2619 }
2620#endif
2621}
Devang Patel930143b2009-11-21 02:48:08 +00002622/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner848c7d22010-03-31 05:39:57 +00002623/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattner76555b52010-01-26 23:18:02 +00002624bool DwarfDebug::extractScopeInformation() {
Devang Patel75cc16c2009-10-01 20:31:14 +00002625 // If scope information was extracted using .dbg intrinsics then there is not
2626 // any need to extract these information by scanning each instruction.
2627 if (!DbgScopeMap.empty())
2628 return false;
2629
Dan Gohmane9135cb2010-04-23 01:18:53 +00002630 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patel6c74a872010-04-27 19:46:33 +00002631 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2632 SmallVector<DbgRange, 4> MIRanges;
2633 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patel32cc43c2010-05-07 20:54:48 +00002634 const MDNode *PrevScope = NULL;
2635 const MDNode *PrevInlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002636 const MachineInstr *RangeBeginMI = NULL;
2637 const MachineInstr *PrevMI = NULL;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002638 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel75cc16c2009-10-01 20:31:14 +00002639 I != E; ++I) {
2640 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2641 II != IE; ++II) {
2642 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002643 const MDNode *Scope = NULL;
2644 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002645
2646 // Check if instruction has valid location information.
2647 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2648 PrevMI = MInsn;
2649 continue;
2650 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002651
Devang Patel6c74a872010-04-27 19:46:33 +00002652 // If scope has not changed then skip this instruction.
2653 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2654 PrevMI = MInsn;
2655 continue;
2656 }
2657
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002658 if (RangeBeginMI) {
2659 // If we have alread seen a beginning of a instruction range and
Devang Patel6c74a872010-04-27 19:46:33 +00002660 // current instruction scope does not match scope of first instruction
2661 // in this range then create a new instruction range.
2662 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002663 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel30265c42010-07-07 20:12:52 +00002664 PrevInlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002665 MIRanges.push_back(R);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002666 }
Devang Patel6c74a872010-04-27 19:46:33 +00002667
2668 // This is a beginning of a new instruction range.
2669 RangeBeginMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002670
Devang Patel6c74a872010-04-27 19:46:33 +00002671 // Reset previous markers.
2672 PrevMI = MInsn;
2673 PrevScope = Scope;
2674 PrevInlinedAt = InlinedAt;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002675 }
2676 }
2677
Devang Patel6c74a872010-04-27 19:46:33 +00002678 // Create last instruction range.
2679 if (RangeBeginMI && PrevMI && PrevScope) {
2680 DbgRange R(RangeBeginMI, PrevMI);
2681 MIRanges.push_back(R);
2682 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patel75cc16c2009-10-01 20:31:14 +00002683 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002684
Devang Patel530a0752010-01-04 20:44:00 +00002685 if (!CurrentFnDbgScope)
2686 return false;
2687
Devang Patel6c74a872010-04-27 19:46:33 +00002688 calculateDominanceGraph(CurrentFnDbgScope);
2689 if (PrintDbgScope)
2690 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2691
2692 // Find ranges of instructions covered by each DbgScope;
2693 DbgScope *PrevDbgScope = NULL;
2694 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2695 RE = MIRanges.end(); RI != RE; ++RI) {
2696 const DbgRange &R = *RI;
2697 DbgScope *S = MI2ScopeMap.lookup(R.first);
2698 assert (S && "Lost DbgScope for a machine instruction!");
2699 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2700 PrevDbgScope->closeInsnRange(S);
2701 S->openInsnRange(R.first);
2702 S->extendInsnRange(R.second);
2703 PrevDbgScope = S;
2704 }
2705
2706 if (PrevDbgScope)
2707 PrevDbgScope->closeInsnRange();
Devang Patel75cc16c2009-10-01 20:31:14 +00002708
Devang Patel359b0132010-04-08 18:43:56 +00002709 identifyScopeMarkers();
Devang Patelf1d5a1e2010-04-08 15:37:09 +00002710
2711 return !DbgScopeMap.empty();
2712}
2713
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002714/// identifyScopeMarkers() -
Devang Patel6c74a872010-04-27 19:46:33 +00002715/// Each DbgScope has first instruction and last instruction to mark beginning
2716/// and end of a scope respectively. Create an inverse map that list scopes
2717/// starts (and ends) with an instruction. One instruction may start (or end)
2718/// multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00002719void DwarfDebug::identifyScopeMarkers() {
Devang Patel7771b7c2010-01-20 02:05:23 +00002720 SmallVector<DbgScope *, 4> WorkList;
2721 WorkList.push_back(CurrentFnDbgScope);
2722 while (!WorkList.empty()) {
Chris Lattner848c7d22010-03-31 05:39:57 +00002723 DbgScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002724
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002725 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002726 if (!Children.empty())
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002727 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00002728 SE = Children.end(); SI != SE; ++SI)
2729 WorkList.push_back(*SI);
2730
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002731 if (S->isAbstractScope())
2732 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002733
Devang Patel6c74a872010-04-27 19:46:33 +00002734 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2735 if (Ranges.empty())
2736 continue;
2737 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2738 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002739 assert(RI->first && "DbgRange does not have first instruction!");
2740 assert(RI->second && "DbgRange does not have second instruction!");
Devang Patel6c74a872010-04-27 19:46:33 +00002741 InsnsEndScopeSet.insert(RI->second);
2742 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002743 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002744}
2745
Dan Gohman3df671a2010-04-20 00:37:27 +00002746/// FindFirstDebugLoc - Find the first debug location in the function. This
2747/// is intended to be an approximation for the source position of the
2748/// beginning of the function.
2749static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2750 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2751 I != E; ++I)
2752 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2753 MBBI != MBBE; ++MBBI) {
2754 DebugLoc DL = MBBI->getDebugLoc();
2755 if (!DL.isUnknown())
2756 return DL;
2757 }
2758 return DebugLoc();
2759}
2760
Devang Patel930143b2009-11-21 02:48:08 +00002761/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendling2b128d72009-05-20 23:19:06 +00002762/// emitted immediately after the function entry point.
Chris Lattner76555b52010-01-26 23:18:02 +00002763void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00002764 if (!MMI->hasDebugInfo()) return;
Bill Wendlingfcc14142010-04-07 09:28:04 +00002765 if (!extractScopeInformation()) return;
Devang Patel4598eb62009-10-06 18:37:31 +00002766
Devang Patel6c74a872010-04-27 19:46:33 +00002767 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2768 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00002769 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00002770 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00002771
2772 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2773 // function.
Dan Gohman3df671a2010-04-20 00:37:27 +00002774 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattner915c5f92010-04-02 19:42:39 +00002775 if (FDL.isUnknown()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002776
Devang Patel32cc43c2010-05-07 20:54:48 +00002777 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings61475c52010-07-19 23:56:30 +00002778 const MDNode *TheScope = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002779
Chris Lattner915c5f92010-04-02 19:42:39 +00002780 DISubprogram SP = getDISubprogram(Scope);
2781 unsigned Line, Col;
2782 if (SP.Verify()) {
2783 Line = SP.getLineNumber();
2784 Col = 0;
Stuart Hastings61475c52010-07-19 23:56:30 +00002785 TheScope = SP;
Chris Lattner915c5f92010-04-02 19:42:39 +00002786 } else {
2787 Line = FDL.getLine();
2788 Col = FDL.getCol();
Stuart Hastings61475c52010-07-19 23:56:30 +00002789 TheScope = Scope;
Bill Wendling2b128d72009-05-20 23:19:06 +00002790 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002791
Stuart Hastings61475c52010-07-19 23:56:30 +00002792 recordSourceLine(Line, Col, TheScope);
Devang Patel002d54d2010-05-26 19:37:24 +00002793
Devang Patel21ccf052010-06-02 16:42:51 +00002794 /// ProcessedArgs - Collection of arguments already processed.
2795 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2796
Devang Patel002d54d2010-05-26 19:37:24 +00002797 DebugLoc PrevLoc;
2798 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2799 I != E; ++I)
2800 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2801 II != IE; ++II) {
2802 const MachineInstr *MI = II;
2803 DebugLoc DL = MI->getDebugLoc();
2804 if (MI->isDebugValue()) {
Devang Patel002d54d2010-05-26 19:37:24 +00002805 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2806 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2807 if (!DV.Verify()) continue;
Devang Patel5e6b71c2010-05-27 16:47:30 +00002808 // If DBG_VALUE is for a local variable then it needs a label.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002809 if (DV.getTag() != dwarf::DW_TAG_arg_variable
Devang Patel42939752010-07-01 21:38:08 +00002810 && isDbgValueInUndefinedReg(MI) == false)
Devang Patel002d54d2010-05-26 19:37:24 +00002811 InsnNeedsLabel.insert(MI);
Devang Patel5e6b71c2010-05-27 16:47:30 +00002812 // DBG_VALUE for inlined functions argument needs a label.
Devang Patel42939752010-07-01 21:38:08 +00002813 else if (!DISubprogram(getDISubprogram(DV.getContext())).
2814 describes(MF->getFunction()))
Devang Patel5e6b71c2010-05-27 16:47:30 +00002815 InsnNeedsLabel.insert(MI);
2816 // DBG_VALUE indicating argument location change needs a label.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002817 else if (isDbgValueInUndefinedReg(MI) == false
2818 && !ProcessedArgs.insert(DV))
Devang Patel002d54d2010-05-26 19:37:24 +00002819 InsnNeedsLabel.insert(MI);
2820 } else {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002821 // If location is unknown then instruction needs a location only if
Devang Patel002d54d2010-05-26 19:37:24 +00002822 // UnknownLocations flag is set.
2823 if (DL.isUnknown()) {
2824 if (UnknownLocations && !PrevLoc.isUnknown())
2825 InsnNeedsLabel.insert(MI);
2826 } else if (DL != PrevLoc)
2827 // Otherwise, instruction needs a location only if it is new location.
2828 InsnNeedsLabel.insert(MI);
2829 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002830
Devang Patel002d54d2010-05-26 19:37:24 +00002831 if (!DL.isUnknown() || UnknownLocations)
2832 PrevLoc = DL;
2833 }
2834
2835 PrevLabel = FunctionBeginSym;
Bill Wendling2b128d72009-05-20 23:19:06 +00002836}
2837
Devang Patel930143b2009-11-21 02:48:08 +00002838/// endFunction - Gather and emit post-function debug information.
Bill Wendling2b128d72009-05-20 23:19:06 +00002839///
Chris Lattner76555b52010-01-26 23:18:02 +00002840void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendlingfcc14142010-04-07 09:28:04 +00002841 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00002842
Devang Patel530a0752010-01-04 20:44:00 +00002843 if (CurrentFnDbgScope) {
Devang Patel4a8e6e82010-05-22 00:04:14 +00002844
Devang Patel9fc11702010-05-25 23:40:22 +00002845 // Define end label for subprogram.
2846 FunctionEndSym = Asm->GetTempSymbol("func_end",
2847 Asm->getFunctionNumber());
2848 // Assumes in correct section after the entry point.
2849 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002850
Devang Patel5c0f85c2010-06-25 22:07:34 +00002851 SmallPtrSet<const MDNode *, 16> ProcessedVars;
2852 collectVariableInfo(MF, ProcessedVars);
Devang Patel4a8e6e82010-05-22 00:04:14 +00002853
Devang Patel530a0752010-01-04 20:44:00 +00002854 // Get function line info.
2855 if (!Lines.empty()) {
2856 // Get section line info.
2857 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2858 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2859 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2860 // Append the function info to section info.
2861 SectionLineInfos.insert(SectionLineInfos.end(),
2862 Lines.begin(), Lines.end());
2863 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002864
Devang Patel530a0752010-01-04 20:44:00 +00002865 // Construct abstract scopes.
2866 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel5c0f85c2010-06-25 22:07:34 +00002867 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00002868 DISubprogram SP((*AI)->getScopeNode());
2869 if (SP.Verify()) {
2870 // Collect info for variables that were optimized out.
2871 StringRef FName = SP.getLinkageName();
2872 if (FName.empty())
2873 FName = SP.getName();
2874 const Module *M = MF->getFunction()->getParent();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002875 if (NamedMDNode *NMD =
2876 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patel5c0f85c2010-06-25 22:07:34 +00002877 getRealLinkageName(FName)))) {
2878 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002879 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel5c0f85c2010-06-25 22:07:34 +00002880 if (!DV || !ProcessedVars.insert(DV))
2881 continue;
Devang Patel648df7b2010-06-30 00:11:08 +00002882 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel5c0f85c2010-06-25 22:07:34 +00002883 if (Scope)
2884 Scope->addVariable(new DbgVariable(DV));
2885 }
2886 }
2887 }
Devang Patelc5b31092010-06-30 01:40:11 +00002888 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
2889 constructScopeDIE(*AI);
Devang Patel5c0f85c2010-06-25 22:07:34 +00002890 }
Devang Patel30265c42010-07-07 20:12:52 +00002891
Devang Patel075e9b52010-05-04 06:15:30 +00002892 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002893
Devang Patel075e9b52010-05-04 06:15:30 +00002894 if (!DisableFramePointerElim(*MF))
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002895 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel075e9b52010-05-04 06:15:30 +00002896 dwarf::DW_FORM_flag, 1);
2897
2898
Chris Lattner3a383cb2010-04-05 00:13:49 +00002899 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel530a0752010-01-04 20:44:00 +00002900 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00002901 }
2902
Bill Wendling2b128d72009-05-20 23:19:06 +00002903 // Clear debug info
Devang Patelfe189e62010-01-19 01:26:02 +00002904 CurrentFnDbgScope = NULL;
Devang Patel002d54d2010-05-26 19:37:24 +00002905 InsnNeedsLabel.clear();
Devang Patele1c53f22010-05-20 16:36:41 +00002906 DbgVariableToFrameIndexMap.clear();
2907 VarToAbstractVarMap.clear();
2908 DbgVariableToDbgInstMap.clear();
2909 DbgVariableLabelsMap.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002910 DeleteContainerSeconds(DbgScopeMap);
Devang Patel541019d2010-04-09 16:04:20 +00002911 InsnsEndScopeSet.clear();
Devang Patelfe189e62010-01-19 01:26:02 +00002912 ConcreteScopes.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002913 DeleteContainerSeconds(AbstractScopes);
Devang Patelfe189e62010-01-19 01:26:02 +00002914 AbstractScopesList.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002915 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00002916 LabelsBeforeInsn.clear();
2917 LabelsAfterInsn.clear();
Bill Wendling2b128d72009-05-20 23:19:06 +00002918 Lines.clear();
Devang Patel12563b32010-04-16 23:33:45 +00002919 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00002920}
2921
Devang Patele1c53f22010-05-20 16:36:41 +00002922/// recordVariableFrameIndex - Record a variable's index.
2923void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2924 assert (V && "Invalid DbgVariable!");
2925 DbgVariableToFrameIndexMap[V] = Index;
2926}
2927
2928/// findVariableFrameIndex - Return true if frame index for the variable
2929/// is found. Update FI to hold value of the index.
2930bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
2931 assert (V && "Invalid DbgVariable!");
2932 DenseMap<const DbgVariable *, int>::iterator I =
2933 DbgVariableToFrameIndexMap.find(V);
2934 if (I == DbgVariableToFrameIndexMap.end())
2935 return false;
2936 *FI = I->second;
2937 return true;
2938}
2939
2940/// findVariableLabel - Find MCSymbol for the variable.
2941const MCSymbol *DwarfDebug::findVariableLabel(const DbgVariable *V) {
2942 DenseMap<const DbgVariable *, const MCSymbol *>::iterator I
2943 = DbgVariableLabelsMap.find(V);
2944 if (I == DbgVariableLabelsMap.end())
2945 return NULL;
2946 else return I->second;
2947}
2948
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002949/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patel490c8ab2010-05-20 19:57:06 +00002950/// instruction.
2951DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
2952 DbgScope *Scope = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002953 LLVMContext &Ctx =
Devang Patel490c8ab2010-05-20 19:57:06 +00002954 MInsn->getParent()->getParent()->getFunction()->getContext();
2955 DebugLoc DL = MInsn->getDebugLoc();
2956
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002957 if (DL.isUnknown())
Devang Patel490c8ab2010-05-20 19:57:06 +00002958 return Scope;
2959
2960 if (const MDNode *IA = DL.getInlinedAt(Ctx))
2961 Scope = ConcreteScopes.lookup(IA);
2962 if (Scope == 0)
2963 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002964
Devang Patel490c8ab2010-05-20 19:57:06 +00002965 return Scope;
2966}
2967
2968
Chris Lattnerba35a672010-03-09 04:54:43 +00002969/// recordSourceLine - Register a source line with debug info. Returns the
2970/// unique label that was emitted and which provides correspondence to
2971/// the source line list.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002972MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel30265c42010-07-07 20:12:52 +00002973 const MDNode *S) {
Devang Patel2d9caf92009-11-25 17:36:49 +00002974 StringRef Dir;
2975 StringRef Fn;
Devang Patel2089d162009-10-05 18:03:19 +00002976
Dan Gohman50849c62010-05-05 23:41:32 +00002977 unsigned Src = 1;
2978 if (S) {
2979 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00002980
Dan Gohman50849c62010-05-05 23:41:32 +00002981 if (Scope.isCompileUnit()) {
2982 DICompileUnit CU(S);
2983 Dir = CU.getDirectory();
2984 Fn = CU.getFilename();
2985 } else if (Scope.isSubprogram()) {
2986 DISubprogram SP(S);
2987 Dir = SP.getDirectory();
2988 Fn = SP.getFilename();
2989 } else if (Scope.isLexicalBlock()) {
2990 DILexicalBlock DB(S);
2991 Dir = DB.getDirectory();
2992 Fn = DB.getFilename();
2993 } else
2994 assert(0 && "Unexpected scope info");
2995
2996 Src = GetOrCreateSourceID(Dir, Fn);
2997 }
2998
Chris Lattner6e52e9d2010-03-14 08:36:50 +00002999 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattnerb4666f42010-03-14 08:15:55 +00003000 Lines.push_back(SrcLineInfo(Line, Col, Src, Label));
Bill Wendling2b128d72009-05-20 23:19:06 +00003001
Chris Lattnerba35a672010-03-09 04:54:43 +00003002 Asm->OutStreamer.EmitLabel(Label);
3003 return Label;
Bill Wendling2b128d72009-05-20 23:19:06 +00003004}
3005
Bill Wendling806535f2009-05-20 23:22:40 +00003006//===----------------------------------------------------------------------===//
3007// Emit Methods
3008//===----------------------------------------------------------------------===//
3009
Devang Patel930143b2009-11-21 02:48:08 +00003010/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling480ff322009-05-20 23:21:38 +00003011///
Jim Grosbach00e9c612009-11-22 19:20:36 +00003012unsigned
3013DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling480ff322009-05-20 23:21:38 +00003014 // Get the children.
3015 const std::vector<DIE *> &Children = Die->getChildren();
3016
3017 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00003018 if (!Last && !Children.empty())
Benjamin Kramer74729ae2010-03-31 19:34:01 +00003019 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling480ff322009-05-20 23:21:38 +00003020
3021 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00003022 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00003023
3024 // Get the abbreviation for this DIE.
3025 unsigned AbbrevNumber = Die->getAbbrevNumber();
3026 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3027
3028 // Set DIE offset
3029 Die->setOffset(Offset);
3030
3031 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00003032 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003033
3034 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
3035 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3036
3037 // Size the DIE attribute values.
3038 for (unsigned i = 0, N = Values.size(); i < N; ++i)
3039 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00003040 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00003041
3042 // Size the DIE children if any.
3043 if (!Children.empty()) {
3044 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
3045 "Children flag not set");
3046
3047 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003048 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling480ff322009-05-20 23:21:38 +00003049
3050 // End of children marker.
3051 Offset += sizeof(int8_t);
3052 }
3053
3054 Die->setSize(Offset - Die->getOffset());
3055 return Offset;
3056}
3057
Devang Patel930143b2009-11-21 02:48:08 +00003058/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling480ff322009-05-20 23:21:38 +00003059///
Devang Patel930143b2009-11-21 02:48:08 +00003060void DwarfDebug::computeSizeAndOffsets() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003061 unsigned PrevOffset = 0;
3062 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3063 E = CUMap.end(); I != E; ++I) {
3064 // Compute size of compile unit header.
3065 static unsigned Offset = PrevOffset +
3066 sizeof(int32_t) + // Length of Compilation Unit Info
3067 sizeof(int16_t) + // DWARF version number
3068 sizeof(int32_t) + // Offset Into Abbrev. Section
3069 sizeof(int8_t); // Pointer Size (in bytes)
3070 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
3071 PrevOffset = Offset;
3072 }
Bill Wendling480ff322009-05-20 23:21:38 +00003073}
3074
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003075/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3076/// temporary label to it if SymbolStem is specified.
Chris Lattner6629ca92010-04-04 22:59:04 +00003077static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003078 const char *SymbolStem = 0) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003079 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003080 if (!SymbolStem) return 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003081
Chris Lattner6629ca92010-04-04 22:59:04 +00003082 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3083 Asm->OutStreamer.EmitLabel(TmpSym);
3084 return TmpSym;
3085}
3086
3087/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3088/// the start of each one.
Chris Lattner46355d82010-04-04 22:33:59 +00003089void DwarfDebug::EmitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003090 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003091
Bill Wendling480ff322009-05-20 23:21:38 +00003092 // Dwarf sections base addresses.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003093 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003094 DwarfFrameSectionSym =
3095 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3096 }
Bill Wendling480ff322009-05-20 23:21:38 +00003097
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003098 DwarfInfoSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003099 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003100 DwarfAbbrevSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003101 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003102 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003103
Chris Lattner6629ca92010-04-04 22:59:04 +00003104 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003105 EmitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003106
Devang Patel4a213872010-08-24 00:06:12 +00003107 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003108 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3109 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3110 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003111 DwarfStrSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003112 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patel12563b32010-04-16 23:33:45 +00003113 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3114 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00003115
Devang Patel9fc11702010-05-25 23:40:22 +00003116 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3117 "section_debug_loc");
3118
Chris Lattner6629ca92010-04-04 22:59:04 +00003119 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattnere58b5472010-04-04 23:10:38 +00003120 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003121}
3122
Devang Patel930143b2009-11-21 02:48:08 +00003123/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling480ff322009-05-20 23:21:38 +00003124///
Devang Patel930143b2009-11-21 02:48:08 +00003125void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00003126 // Get the abbreviation for this DIE.
3127 unsigned AbbrevNumber = Die->getAbbrevNumber();
3128 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3129
Bill Wendling480ff322009-05-20 23:21:38 +00003130 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00003131 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00003132 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3133 Twine::utohexstr(Die->getOffset()) + ":0x" +
3134 Twine::utohexstr(Die->getSize()) + " " +
3135 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00003136 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003137
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00003138 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00003139 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3140
3141 // Emit the DIE attribute values.
3142 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3143 unsigned Attr = AbbrevData[i].getAttribute();
3144 unsigned Form = AbbrevData[i].getForm();
3145 assert(Form && "Too many attributes for DIE (check abbreviation)");
3146
Chris Lattner7bde8c02010-04-04 18:52:31 +00003147 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00003148 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003149
Bill Wendling480ff322009-05-20 23:21:38 +00003150 switch (Attr) {
3151 case dwarf::DW_AT_sibling:
Devang Patel930143b2009-11-21 02:48:08 +00003152 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003153 break;
3154 case dwarf::DW_AT_abstract_origin: {
3155 DIEEntry *E = cast<DIEEntry>(Values[i]);
3156 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003157 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00003158 Asm->EmitInt32(Addr);
3159 break;
3160 }
Devang Patel12563b32010-04-16 23:33:45 +00003161 case dwarf::DW_AT_ranges: {
3162 // DW_AT_range Value encodes offset in debug_range section.
3163 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00003164
3165 if (Asm->MAI->doesDwarfUsesLabelOffsetForRanges()) {
3166 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
3167 V->getValue(),
3168 4);
3169 } else {
3170 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3171 V->getValue(),
3172 DwarfDebugRangeSectionSym,
3173 4);
3174 }
Devang Patel12563b32010-04-16 23:33:45 +00003175 break;
3176 }
Devang Patel9fc11702010-05-25 23:40:22 +00003177 case dwarf::DW_AT_location: {
3178 if (UseDotDebugLocEntry.count(Die) != 0) {
3179 DIELabel *L = cast<DIELabel>(Values[i]);
3180 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
3181 } else
3182 Values[i]->EmitValue(Asm, Form);
3183 break;
3184 }
Devang Patela1bd5a12010-09-29 19:08:08 +00003185 case dwarf::DW_AT_accessibility: {
3186 if (Asm->isVerbose()) {
3187 DIEInteger *V = cast<DIEInteger>(Values[i]);
3188 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
3189 }
3190 Values[i]->EmitValue(Asm, Form);
3191 break;
3192 }
Bill Wendling480ff322009-05-20 23:21:38 +00003193 default:
3194 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003195 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00003196 break;
3197 }
Bill Wendling480ff322009-05-20 23:21:38 +00003198 }
3199
3200 // Emit the DIE children if any.
3201 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3202 const std::vector<DIE *> &Children = Die->getChildren();
3203
3204 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003205 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00003206
Chris Lattner7bde8c02010-04-04 18:52:31 +00003207 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00003208 Asm->OutStreamer.AddComment("End Of Children Mark");
3209 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003210 }
3211}
3212
Devang Patel9ccfb642009-12-09 18:24:21 +00003213/// emitDebugInfo - Emit the debug info section.
Bill Wendling480ff322009-05-20 23:21:38 +00003214///
Devang Patel9ccfb642009-12-09 18:24:21 +00003215void DwarfDebug::emitDebugInfo() {
3216 // Start debug info section.
3217 Asm->OutStreamer.SwitchSection(
3218 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel1a0df9a2010-05-10 22:49:55 +00003219 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3220 E = CUMap.end(); I != E; ++I) {
3221 CompileUnit *TheCU = I->second;
3222 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003223
Devang Patel1a0df9a2010-05-10 22:49:55 +00003224 // Emit the compile units header.
3225 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3226 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003227
Devang Patel1a0df9a2010-05-10 22:49:55 +00003228 // Emit size of content not including length itself
3229 unsigned ContentSize = Die->getSize() +
3230 sizeof(int16_t) + // DWARF version number
3231 sizeof(int32_t) + // Offset Into Abbrev. Section
3232 sizeof(int8_t) + // Pointer Size (in bytes)
3233 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003234
Devang Patel1a0df9a2010-05-10 22:49:55 +00003235 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3236 Asm->EmitInt32(ContentSize);
3237 Asm->OutStreamer.AddComment("DWARF version number");
3238 Asm->EmitInt16(dwarf::DWARF_VERSION);
3239 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3240 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3241 DwarfAbbrevSectionSym);
3242 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3243 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003244
Devang Patel1a0df9a2010-05-10 22:49:55 +00003245 emitDIE(Die);
3246 // FIXME - extra padding for gdb bug.
3247 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3248 Asm->EmitInt8(0);
3249 Asm->EmitInt8(0);
3250 Asm->EmitInt8(0);
3251 Asm->EmitInt8(0);
3252 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3253 }
Bill Wendling480ff322009-05-20 23:21:38 +00003254}
3255
Devang Patel930143b2009-11-21 02:48:08 +00003256/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling480ff322009-05-20 23:21:38 +00003257///
Devang Patel930143b2009-11-21 02:48:08 +00003258void DwarfDebug::emitAbbreviations() const {
Bill Wendling480ff322009-05-20 23:21:38 +00003259 // Check to see if it is worth the effort.
3260 if (!Abbreviations.empty()) {
3261 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003262 Asm->OutStreamer.SwitchSection(
3263 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003264
Chris Lattnera179b522010-04-04 19:25:43 +00003265 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003266
3267 // For each abbrevation.
3268 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3269 // Get abbreviation data
3270 const DIEAbbrev *Abbrev = Abbreviations[i];
3271
3272 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00003273 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00003274
3275 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003276 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00003277 }
3278
3279 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00003280 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00003281
Chris Lattnera179b522010-04-04 19:25:43 +00003282 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003283 }
3284}
3285
Devang Patel930143b2009-11-21 02:48:08 +00003286/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling480ff322009-05-20 23:21:38 +00003287/// the line matrix.
3288///
Devang Patel930143b2009-11-21 02:48:08 +00003289void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00003290 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00003291 Asm->OutStreamer.AddComment("Extended Op");
3292 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003293
Chris Lattner566cae92010-03-09 23:52:58 +00003294 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003295 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00003296 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3297 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3298
3299 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00003300
Chris Lattnera179b522010-04-04 19:25:43 +00003301 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003302 Asm->getTargetData().getPointerSize(),
3303 0/*AddrSpace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003304
3305 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00003306 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3307 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003308 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00003309 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003310}
3311
Devang Patel930143b2009-11-21 02:48:08 +00003312/// emitDebugLines - Emit source line information.
Bill Wendling480ff322009-05-20 23:21:38 +00003313///
Devang Patel930143b2009-11-21 02:48:08 +00003314void DwarfDebug::emitDebugLines() {
Bill Wendling480ff322009-05-20 23:21:38 +00003315 // If the target is using .loc/.file, the assembler will be emitting the
3316 // .debug_line table automatically.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003317 if (Asm->MAI->hasDotLocAndDotFile())
Bill Wendling480ff322009-05-20 23:21:38 +00003318 return;
3319
3320 // Minimum line delta, thus ranging from -10..(255-10).
3321 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
3322 // Maximum line delta, thus ranging from -10..(255-10).
3323 const int MaxLineDelta = 255 + MinLineDelta;
3324
3325 // Start the dwarf line section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003326 Asm->OutStreamer.SwitchSection(
3327 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003328
3329 // Construct the section header.
Chris Lattner566cae92010-03-09 23:52:58 +00003330 Asm->OutStreamer.AddComment("Length of Source Line Info");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003331 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_end"),
3332 Asm->GetTempSymbol("line_begin"), 4);
Chris Lattnera179b522010-04-04 19:25:43 +00003333 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003334
Chris Lattner566cae92010-03-09 23:52:58 +00003335 Asm->OutStreamer.AddComment("DWARF version number");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003336 Asm->EmitInt16(dwarf::DWARF_VERSION);
Bill Wendling480ff322009-05-20 23:21:38 +00003337
Chris Lattner566cae92010-03-09 23:52:58 +00003338 Asm->OutStreamer.AddComment("Prolog Length");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003339 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_prolog_end"),
3340 Asm->GetTempSymbol("line_prolog_begin"), 4);
Chris Lattnera179b522010-04-04 19:25:43 +00003341 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003342
Chris Lattner566cae92010-03-09 23:52:58 +00003343 Asm->OutStreamer.AddComment("Minimum Instruction Length");
3344 Asm->EmitInt8(1);
3345 Asm->OutStreamer.AddComment("Default is_stmt_start flag");
3346 Asm->EmitInt8(1);
3347 Asm->OutStreamer.AddComment("Line Base Value (Special Opcodes)");
3348 Asm->EmitInt8(MinLineDelta);
3349 Asm->OutStreamer.AddComment("Line Range Value (Special Opcodes)");
3350 Asm->EmitInt8(MaxLineDelta);
3351 Asm->OutStreamer.AddComment("Special Opcode Base");
3352 Asm->EmitInt8(-MinLineDelta);
Bill Wendling480ff322009-05-20 23:21:38 +00003353
3354 // Line number standard opcode encodings argument count
Chris Lattner566cae92010-03-09 23:52:58 +00003355 Asm->OutStreamer.AddComment("DW_LNS_copy arg count");
3356 Asm->EmitInt8(0);
3357 Asm->OutStreamer.AddComment("DW_LNS_advance_pc arg count");
3358 Asm->EmitInt8(1);
3359 Asm->OutStreamer.AddComment("DW_LNS_advance_line arg count");
3360 Asm->EmitInt8(1);
3361 Asm->OutStreamer.AddComment("DW_LNS_set_file arg count");
3362 Asm->EmitInt8(1);
3363 Asm->OutStreamer.AddComment("DW_LNS_set_column arg count");
3364 Asm->EmitInt8(1);
3365 Asm->OutStreamer.AddComment("DW_LNS_negate_stmt arg count");
3366 Asm->EmitInt8(0);
3367 Asm->OutStreamer.AddComment("DW_LNS_set_basic_block arg count");
3368 Asm->EmitInt8(0);
3369 Asm->OutStreamer.AddComment("DW_LNS_const_add_pc arg count");
3370 Asm->EmitInt8(0);
3371 Asm->OutStreamer.AddComment("DW_LNS_fixed_advance_pc arg count");
3372 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003373
3374 // Emit directories.
3375 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003376 const std::string &Dir = getSourceDirectoryName(DI);
Chris Lattner7bde8c02010-04-04 18:52:31 +00003377 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Directory");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003378 Asm->OutStreamer.EmitBytes(StringRef(Dir.c_str(), Dir.size()+1), 0);
Bill Wendling480ff322009-05-20 23:21:38 +00003379 }
3380
Chris Lattner566cae92010-03-09 23:52:58 +00003381 Asm->OutStreamer.AddComment("End of directories");
3382 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003383
3384 // Emit files.
3385 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
3386 // Remember source id starts at 1.
3387 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003388 const std::string &FN = getSourceFileName(Id.second);
Chris Lattner7bde8c02010-04-04 18:52:31 +00003389 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Source");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003390 Asm->OutStreamer.EmitBytes(StringRef(FN.c_str(), FN.size()+1), 0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003391
Chris Lattner9efd1182010-04-04 19:09:29 +00003392 Asm->EmitULEB128(Id.first, "Directory #");
3393 Asm->EmitULEB128(0, "Mod date");
3394 Asm->EmitULEB128(0, "File size");
Bill Wendling480ff322009-05-20 23:21:38 +00003395 }
3396
Chris Lattner566cae92010-03-09 23:52:58 +00003397 Asm->OutStreamer.AddComment("End of files");
3398 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003399
Chris Lattnera179b522010-04-04 19:25:43 +00003400 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003401
3402 // A sequence for each text section.
3403 unsigned SecSrcLinesSize = SectionSourceLines.size();
3404
3405 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
3406 // Isolate current sections line info.
3407 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
3408
Bill Wendling480ff322009-05-20 23:21:38 +00003409 // Dwarf assumes we start with first line of first source file.
3410 unsigned Source = 1;
3411 unsigned Line = 1;
3412
3413 // Construct rows of the address, source, line, column matrix.
3414 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
3415 const SrcLineInfo &LineInfo = LineInfos[i];
Chris Lattnerb4666f42010-03-14 08:15:55 +00003416 MCSymbol *Label = LineInfo.getLabel();
Chris Lattneree95d4c2010-03-14 02:20:58 +00003417 if (!Label->isDefined()) continue; // Not emitted, in dead code.
Bill Wendling480ff322009-05-20 23:21:38 +00003418
Chris Lattner3d72a672010-03-09 23:38:23 +00003419 if (Asm->isVerbose()) {
Chris Lattner7e998b72010-03-10 01:04:13 +00003420 std::pair<unsigned, unsigned> SrcID =
Bill Wendling480ff322009-05-20 23:21:38 +00003421 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner7e998b72010-03-10 01:04:13 +00003422 Asm->OutStreamer.AddComment(Twine(getSourceDirectoryName(SrcID.first)) +
Chris Lattnera26fbe42010-03-10 02:29:31 +00003423 "/" +
3424 Twine(getSourceFileName(SrcID.second)) +
Chris Lattner7e998b72010-03-10 01:04:13 +00003425 ":" + Twine(LineInfo.getLine()));
Bill Wendling480ff322009-05-20 23:21:38 +00003426 }
3427
3428 // Define the line address.
Chris Lattner566cae92010-03-09 23:52:58 +00003429 Asm->OutStreamer.AddComment("Extended Op");
3430 Asm->EmitInt8(0);
3431 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003432 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00003433
3434 Asm->OutStreamer.AddComment("DW_LNE_set_address");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003435 Asm->EmitInt8(dwarf::DW_LNE_set_address);
Chris Lattner566cae92010-03-09 23:52:58 +00003436
3437 Asm->OutStreamer.AddComment("Location label");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003438 Asm->OutStreamer.EmitSymbolValue(Label,
3439 Asm->getTargetData().getPointerSize(),
Chris Lattneree95d4c2010-03-14 02:20:58 +00003440 0/*AddrSpace*/);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003441
Bill Wendling480ff322009-05-20 23:21:38 +00003442 // If change of source, then switch to the new source.
3443 if (Source != LineInfo.getSourceID()) {
3444 Source = LineInfo.getSourceID();
Chris Lattner566cae92010-03-09 23:52:58 +00003445 Asm->OutStreamer.AddComment("DW_LNS_set_file");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003446 Asm->EmitInt8(dwarf::DW_LNS_set_file);
Chris Lattner9efd1182010-04-04 19:09:29 +00003447 Asm->EmitULEB128(Source, "New Source");
Bill Wendling480ff322009-05-20 23:21:38 +00003448 }
3449
3450 // If change of line.
3451 if (Line != LineInfo.getLine()) {
3452 // Determine offset.
3453 int Offset = LineInfo.getLine() - Line;
3454 int Delta = Offset - MinLineDelta;
3455
3456 // Update line.
3457 Line = LineInfo.getLine();
3458
3459 // If delta is small enough and in range...
3460 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
3461 // ... then use fast opcode.
Chris Lattner566cae92010-03-09 23:52:58 +00003462 Asm->OutStreamer.AddComment("Line Delta");
3463 Asm->EmitInt8(Delta - MinLineDelta);
Bill Wendling480ff322009-05-20 23:21:38 +00003464 } else {
3465 // ... otherwise use long hand.
Chris Lattner566cae92010-03-09 23:52:58 +00003466 Asm->OutStreamer.AddComment("DW_LNS_advance_line");
Bill Wendling480ff322009-05-20 23:21:38 +00003467 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
Chris Lattner9efd1182010-04-04 19:09:29 +00003468 Asm->EmitSLEB128(Offset, "Line Offset");
Chris Lattner566cae92010-03-09 23:52:58 +00003469 Asm->OutStreamer.AddComment("DW_LNS_copy");
3470 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling480ff322009-05-20 23:21:38 +00003471 }
3472 } else {
3473 // Copy the previous row (different address or source)
Chris Lattner566cae92010-03-09 23:52:58 +00003474 Asm->OutStreamer.AddComment("DW_LNS_copy");
3475 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling480ff322009-05-20 23:21:38 +00003476 }
3477 }
3478
Devang Patel930143b2009-11-21 02:48:08 +00003479 emitEndOfLineMatrix(j + 1);
Bill Wendling480ff322009-05-20 23:21:38 +00003480 }
3481
3482 if (SecSrcLinesSize == 0)
3483 // Because we're emitting a debug_line section, we still need a line
3484 // table. The linker and friends expect it to exist. If there's nothing to
3485 // put into it, emit an empty table.
Devang Patel930143b2009-11-21 02:48:08 +00003486 emitEndOfLineMatrix(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003487
Chris Lattnera179b522010-04-04 19:25:43 +00003488 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003489}
3490
Devang Patel930143b2009-11-21 02:48:08 +00003491/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling480ff322009-05-20 23:21:38 +00003492///
Devang Patel930143b2009-11-21 02:48:08 +00003493void DwarfDebug::emitCommonDebugFrame() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003494 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003495 return;
3496
Chris Lattner3a383cb2010-04-05 00:13:49 +00003497 int stackGrowth = Asm->getTargetData().getPointerSize();
3498 if (Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3499 TargetFrameInfo::StackGrowsDown)
3500 stackGrowth *= -1;
Bill Wendling480ff322009-05-20 23:21:38 +00003501
3502 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003503 Asm->OutStreamer.SwitchSection(
3504 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003505
Chris Lattnera179b522010-04-04 19:25:43 +00003506 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner566cae92010-03-09 23:52:58 +00003507 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003508 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3509 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003510
Chris Lattnera179b522010-04-04 19:25:43 +00003511 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner566cae92010-03-09 23:52:58 +00003512 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling480ff322009-05-20 23:21:38 +00003513 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner566cae92010-03-09 23:52:58 +00003514 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling480ff322009-05-20 23:21:38 +00003515 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner566cae92010-03-09 23:52:58 +00003516 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003517 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner9efd1182010-04-04 19:09:29 +00003518 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3519 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner566cae92010-03-09 23:52:58 +00003520 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003521 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling480ff322009-05-20 23:21:38 +00003522 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling480ff322009-05-20 23:21:38 +00003523
3524 std::vector<MachineMove> Moves;
3525 RI->getInitialFrameState(Moves);
3526
Chris Lattneraabc6042010-04-04 23:41:46 +00003527 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003528
Chris Lattner9e06e532010-04-28 01:05:45 +00003529 Asm->EmitAlignment(2);
Chris Lattnera179b522010-04-04 19:25:43 +00003530 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003531}
3532
Devang Patel930143b2009-11-21 02:48:08 +00003533/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling480ff322009-05-20 23:21:38 +00003534/// section.
Chris Lattner2c3f4782010-03-13 07:26:18 +00003535void DwarfDebug::
3536emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003537 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003538 return;
3539
3540 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003541 Asm->OutStreamer.SwitchSection(
3542 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003543
Chris Lattner566cae92010-03-09 23:52:58 +00003544 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner2c3f4782010-03-13 07:26:18 +00003545 MCSymbol *DebugFrameBegin =
Chris Lattnera179b522010-04-04 19:25:43 +00003546 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003547 MCSymbol *DebugFrameEnd =
Chris Lattnera179b522010-04-04 19:25:43 +00003548 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnerf1429f12010-04-04 19:58:12 +00003549 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003550
Chris Lattner2c3f4782010-03-13 07:26:18 +00003551 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling480ff322009-05-20 23:21:38 +00003552
Chris Lattner566cae92010-03-09 23:52:58 +00003553 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003554 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner70a4fce2010-04-04 23:25:33 +00003555 DwarfFrameSectionSym);
Bill Wendling480ff322009-05-20 23:21:38 +00003556
Chris Lattner566cae92010-03-09 23:52:58 +00003557 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnera179b522010-04-04 19:25:43 +00003558 MCSymbol *FuncBeginSym =
3559 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattner8811e122010-03-13 07:40:56 +00003560 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattner3a383cb2010-04-05 00:13:49 +00003561 Asm->getTargetData().getPointerSize(),
3562 0/*AddrSpace*/);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003563
3564
Chris Lattner566cae92010-03-09 23:52:58 +00003565 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003566 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003567 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003568
Chris Lattneraabc6042010-04-04 23:41:46 +00003569 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003570
Chris Lattner9e06e532010-04-28 01:05:45 +00003571 Asm->EmitAlignment(2);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003572 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling480ff322009-05-20 23:21:38 +00003573}
3574
Devang Patel9ccfb642009-12-09 18:24:21 +00003575/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3576///
3577void DwarfDebug::emitDebugPubNames() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003578 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3579 E = CUMap.end(); I != E; ++I) {
3580 CompileUnit *TheCU = I->second;
3581 // Start the dwarf pubnames section.
3582 Asm->OutStreamer.SwitchSection(
3583 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003584
Devang Patel1a0df9a2010-05-10 22:49:55 +00003585 Asm->OutStreamer.AddComment("Length of Public Names Info");
3586 Asm->EmitLabelDifference(
3587 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3588 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003589
Devang Patel1a0df9a2010-05-10 22:49:55 +00003590 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3591 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003592
Devang Patel1a0df9a2010-05-10 22:49:55 +00003593 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003594 Asm->EmitInt16(dwarf::DWARF_VERSION);
3595
Devang Patel1a0df9a2010-05-10 22:49:55 +00003596 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003597 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00003598 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003599
Devang Patel1a0df9a2010-05-10 22:49:55 +00003600 Asm->OutStreamer.AddComment("Compilation Unit Length");
3601 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3602 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3603 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003604
Devang Patel1a0df9a2010-05-10 22:49:55 +00003605 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3606 for (StringMap<DIE*>::const_iterator
3607 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3608 const char *Name = GI->getKeyData();
3609 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003610
Devang Patel1a0df9a2010-05-10 22:49:55 +00003611 Asm->OutStreamer.AddComment("DIE offset");
3612 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003613
Devang Patel1a0df9a2010-05-10 22:49:55 +00003614 if (Asm->isVerbose())
3615 Asm->OutStreamer.AddComment("External Name");
3616 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3617 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003618
Devang Patel1a0df9a2010-05-10 22:49:55 +00003619 Asm->OutStreamer.AddComment("End Mark");
3620 Asm->EmitInt32(0);
3621 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3622 TheCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00003623 }
Bill Wendling480ff322009-05-20 23:21:38 +00003624}
3625
Devang Patel04d2f2d2009-11-24 01:14:22 +00003626void DwarfDebug::emitDebugPubTypes() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003627 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3628 E = CUMap.end(); I != E; ++I) {
3629 CompileUnit *TheCU = I->second;
3630 // Start the dwarf pubnames section.
3631 Asm->OutStreamer.SwitchSection(
3632 Asm->getObjFileLowering().getDwarfPubTypesSection());
3633 Asm->OutStreamer.AddComment("Length of Public Types Info");
3634 Asm->EmitLabelDifference(
3635 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3636 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003637
Devang Patel1a0df9a2010-05-10 22:49:55 +00003638 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3639 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003640
Devang Patel1a0df9a2010-05-10 22:49:55 +00003641 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3642 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003643
Devang Patel1a0df9a2010-05-10 22:49:55 +00003644 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3645 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3646 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003647
Devang Patel1a0df9a2010-05-10 22:49:55 +00003648 Asm->OutStreamer.AddComment("Compilation Unit Length");
3649 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3650 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3651 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003652
Devang Patel1a0df9a2010-05-10 22:49:55 +00003653 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3654 for (StringMap<DIE*>::const_iterator
3655 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3656 const char *Name = GI->getKeyData();
3657 DIE * Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003658
Devang Patel1a0df9a2010-05-10 22:49:55 +00003659 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3660 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003661
Devang Patel1a0df9a2010-05-10 22:49:55 +00003662 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3663 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3664 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003665
Devang Patel1a0df9a2010-05-10 22:49:55 +00003666 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003667 Asm->EmitInt32(0);
Devang Patel1a0df9a2010-05-10 22:49:55 +00003668 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3669 TheCU->getID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00003670 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00003671}
3672
Devang Patel930143b2009-11-21 02:48:08 +00003673/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling480ff322009-05-20 23:21:38 +00003674///
Devang Patel930143b2009-11-21 02:48:08 +00003675void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00003676 // Check to see if it is worth the effort.
Chris Lattner3d72a672010-03-09 23:38:23 +00003677 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003678
Chris Lattner3d72a672010-03-09 23:38:23 +00003679 // Start the dwarf str section.
3680 Asm->OutStreamer.SwitchSection(
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003681 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003682
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003683 // Get all of the string pool entries and put them in an array by their ID so
3684 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003685 SmallVector<std::pair<unsigned,
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003686 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003687
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003688 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3689 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3690 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003691
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003692 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003693
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003694 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00003695 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003696 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003697
Chris Lattner3d72a672010-03-09 23:38:23 +00003698 // Emit the string itself.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003699 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003700 }
3701}
3702
Devang Patel930143b2009-11-21 02:48:08 +00003703/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling480ff322009-05-20 23:21:38 +00003704///
Devang Patel930143b2009-11-21 02:48:08 +00003705void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003706 if (DotDebugLocEntries.empty())
3707 return;
3708
Bill Wendling480ff322009-05-20 23:21:38 +00003709 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003710 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00003711 Asm->getObjFileLowering().getDwarfLocSection());
3712 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003713 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3714 unsigned index = 1;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003715 for (SmallVector<DotDebugLocEntry, 4>::iterator
3716 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00003717 I != E; ++I, ++index) {
Devang Patel9fc11702010-05-25 23:40:22 +00003718 DotDebugLocEntry Entry = *I;
Devang Patel9fc11702010-05-25 23:40:22 +00003719 if (Entry.isEmpty()) {
3720 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3721 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003722 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00003723 } else {
3724 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3725 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3726 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3727 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patel0e60e672010-08-04 18:40:52 +00003728 if (int Offset = Entry.Loc.getOffset()) {
3729 // If the value is at a certain offset from frame register then
3730 // use DW_OP_fbreg.
3731 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patel9fc11702010-05-25 23:40:22 +00003732 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patel0e60e672010-08-04 18:40:52 +00003733 Asm->EmitInt16(1 + OffsetSize);
3734 Asm->OutStreamer.AddComment(
3735 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3736 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3737 Asm->OutStreamer.AddComment("Offset");
3738 Asm->EmitSLEB128(Offset);
Devang Patel9fc11702010-05-25 23:40:22 +00003739 } else {
Devang Patel0e60e672010-08-04 18:40:52 +00003740 if (Reg < 32) {
3741 Asm->OutStreamer.AddComment("Loc expr size");
3742 Asm->EmitInt16(1);
3743 Asm->OutStreamer.AddComment(
Devang Patel6d21f612010-08-04 20:32:36 +00003744 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patel0e60e672010-08-04 18:40:52 +00003745 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3746 } else {
3747 Asm->OutStreamer.AddComment("Loc expr size");
3748 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3749 Asm->EmitInt8(dwarf::DW_OP_regx);
3750 Asm->EmitULEB128(Reg);
3751 }
Devang Patel9fc11702010-05-25 23:40:22 +00003752 }
3753 }
3754 }
Bill Wendling480ff322009-05-20 23:21:38 +00003755}
3756
3757/// EmitDebugARanges - Emit visible names into a debug aranges section.
3758///
3759void DwarfDebug::EmitDebugARanges() {
3760 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003761 Asm->OutStreamer.SwitchSection(
3762 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003763}
3764
Devang Patel930143b2009-11-21 02:48:08 +00003765/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling480ff322009-05-20 23:21:38 +00003766///
Devang Patel930143b2009-11-21 02:48:08 +00003767void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00003768 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003769 Asm->OutStreamer.SwitchSection(
Devang Patel12563b32010-04-16 23:33:45 +00003770 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Patel6c74a872010-04-27 19:46:33 +00003771 unsigned char Size = Asm->getTargetData().getPointerSize();
3772 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003773 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00003774 I != E; ++I) {
3775 if (*I)
3776 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patel12563b32010-04-16 23:33:45 +00003777 else
Devang Patel6c74a872010-04-27 19:46:33 +00003778 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel12563b32010-04-16 23:33:45 +00003779 }
Bill Wendling480ff322009-05-20 23:21:38 +00003780}
3781
Devang Patel930143b2009-11-21 02:48:08 +00003782/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling480ff322009-05-20 23:21:38 +00003783///
Devang Patel930143b2009-11-21 02:48:08 +00003784void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003785 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00003786 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00003787 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003788 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003789 }
3790}
3791
Devang Patel930143b2009-11-21 02:48:08 +00003792/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling480ff322009-05-20 23:21:38 +00003793/// Section Header:
3794/// 1. length of section
3795/// 2. Dwarf version number
3796/// 3. address size.
3797///
3798/// Entries (one "entry" for each function that was inlined):
3799///
3800/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3801/// otherwise offset into __debug_str for regular function name.
3802/// 2. offset into __debug_str section for regular function name.
3803/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3804/// instances for the function.
3805///
3806/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3807/// inlined instance; the die_offset points to the inlined_subroutine die in the
3808/// __debug_info section, and the low_pc is the starting address for the
3809/// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00003810void DwarfDebug::emitDebugInlineInfo() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003811 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003812 return;
3813
Devang Patel1a0df9a2010-05-10 22:49:55 +00003814 if (!FirstCU)
Bill Wendling480ff322009-05-20 23:21:38 +00003815 return;
3816
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003817 Asm->OutStreamer.SwitchSection(
3818 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003819
Chris Lattner566cae92010-03-09 23:52:58 +00003820 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003821 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3822 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003823
Chris Lattnera179b522010-04-04 19:25:43 +00003824 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003825
Chris Lattner566cae92010-03-09 23:52:58 +00003826 Asm->OutStreamer.AddComment("Dwarf Version");
3827 Asm->EmitInt16(dwarf::DWARF_VERSION);
3828 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003829 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003830
Devang Patel32cc43c2010-05-07 20:54:48 +00003831 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003832 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00003833
Devang Patel32cc43c2010-05-07 20:54:48 +00003834 const MDNode *Node = *I;
3835 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00003836 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003837 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00003838 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00003839 StringRef LName = SP.getLinkageName();
3840 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00003841
Chris Lattner566cae92010-03-09 23:52:58 +00003842 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003843 if (LName.empty()) {
3844 Asm->OutStreamer.EmitBytes(Name, 0);
3845 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003846 } else
Chris Lattner70a4fce2010-04-04 23:25:33 +00003847 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3848 DwarfStrSectionSym);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003849
Chris Lattner566cae92010-03-09 23:52:58 +00003850 Asm->OutStreamer.AddComment("Function name");
Chris Lattner70a4fce2010-04-04 23:25:33 +00003851 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner9efd1182010-04-04 19:09:29 +00003852 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00003853
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003854 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00003855 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner7bde8c02010-04-04 18:52:31 +00003856 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner085b6522010-03-09 00:31:02 +00003857 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003858
Chris Lattner7bde8c02010-04-04 18:52:31 +00003859 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003860 Asm->OutStreamer.EmitSymbolValue(LI->first,
3861 Asm->getTargetData().getPointerSize(),0);
Bill Wendling480ff322009-05-20 23:21:38 +00003862 }
3863 }
3864
Chris Lattnera179b522010-04-04 19:25:43 +00003865 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003866}