blob: c687d74589369d9066b20d0c717c09b414d6fdeb [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 Patel24bc1b52010-06-29 20:17:53 +0000391 DwarfDebugLineSectionSym = CurrentLineSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000392 FunctionBeginSym = FunctionEndSym = 0;
Devang Patel9c160e12010-07-08 20:10:35 +0000393 DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
Dan Gohman6e681a52010-06-18 15:56:31 +0000394 {
395 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
396 beginModule(M);
Torok Edwinf8dba242010-04-07 10:44:46 +0000397 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000398}
399DwarfDebug::~DwarfDebug() {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000400 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
401 DIEBlocks[j]->~DIEBlock();
Bill Wendling2f921f82009-05-15 09:23:25 +0000402}
403
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000404MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
405 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
406 if (Entry.first) return Entry.first;
407
408 Entry.second = NextStringPoolNumber++;
Chris Lattnera179b522010-04-04 19:25:43 +0000409 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000410}
411
412
Devang Patel930143b2009-11-21 02:48:08 +0000413/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling2f921f82009-05-15 09:23:25 +0000414///
Devang Patel930143b2009-11-21 02:48:08 +0000415void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000416 // Profile the node so that we can make it unique.
417 FoldingSetNodeID ID;
418 Abbrev.Profile(ID);
419
420 // Check the set for priors.
421 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
422
423 // If it's newly added.
424 if (InSet == &Abbrev) {
425 // Add to abbreviation list.
426 Abbreviations.push_back(&Abbrev);
427
428 // Assign the vector position + 1 as its number.
429 Abbrev.setNumber(Abbreviations.size());
430 } else {
431 // Assign existing abbreviation number.
432 Abbrev.setNumber(InSet->getNumber());
433 }
434}
435
Devang Patel930143b2009-11-21 02:48:08 +0000436/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendlingbcad77a2009-05-20 23:24:48 +0000437/// information entry.
Devang Patel930143b2009-11-21 02:48:08 +0000438DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000439 DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000440 return Value;
441}
442
Devang Patel930143b2009-11-21 02:48:08 +0000443/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000444///
Devang Patel930143b2009-11-21 02:48:08 +0000445void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000446 unsigned Form, uint64_t Integer) {
447 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000448 DIEValue *Value = Integer == 1 ?
Devang Patel9c160e12010-07-08 20:10:35 +0000449 DIEIntegerOne : new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000450 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000451}
452
Devang Patel930143b2009-11-21 02:48:08 +0000453/// addSInt - Add an signed integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000454///
Devang Patel930143b2009-11-21 02:48:08 +0000455void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000456 unsigned Form, int64_t Integer) {
457 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000458 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000459 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000460}
461
Devang Patel8c339592009-12-02 15:25:16 +0000462/// addString - Add a string attribute data and value. DIEString only
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000463/// keeps string reference.
Devang Patel930143b2009-11-21 02:48:08 +0000464void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerc3f23b82010-01-23 03:11:46 +0000465 StringRef String) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000466 DIEValue *Value = new (DIEValueAllocator) DIEString(String);
Devang Patel930143b2009-11-21 02:48:08 +0000467 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000468}
469
Devang Patel930143b2009-11-21 02:48:08 +0000470/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000471///
Devang Patel930143b2009-11-21 02:48:08 +0000472void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000473 const MCSymbol *Label) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000474 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
Devang Patel930143b2009-11-21 02:48:08 +0000475 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000476}
477
Devang Patel930143b2009-11-21 02:48:08 +0000478/// addDelta - Add a label delta attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000479///
Devang Patel930143b2009-11-21 02:48:08 +0000480void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000481 const MCSymbol *Hi, const MCSymbol *Lo) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000482 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
Devang Patel930143b2009-11-21 02:48:08 +0000483 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000484}
485
Chris Lattner3f3fb972010-04-05 05:24:55 +0000486/// addDIEEntry - Add a DIE attribute data and value.
487///
488void DwarfDebug::addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form,
489 DIE *Entry) {
490 Die->addValue(Attribute, Form, createDIEEntry(Entry));
491}
492
493
Devang Patel930143b2009-11-21 02:48:08 +0000494/// addBlock - Add block data.
Bill Wendling2f921f82009-05-15 09:23:25 +0000495///
Devang Patel930143b2009-11-21 02:48:08 +0000496void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling2f921f82009-05-15 09:23:25 +0000497 DIEBlock *Block) {
Chris Lattner5a00dea2010-04-05 00:18:22 +0000498 Block->ComputeSize(Asm);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000499 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
Devang Patel930143b2009-11-21 02:48:08 +0000500 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000501}
502
Devang Patel930143b2009-11-21 02:48:08 +0000503/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000504/// entry.
Devang Patelb6511a32010-08-09 20:20:05 +0000505void DwarfDebug::addSourceLine(DIE *Die, const DIVariable V) {
Devang Patel0625af22010-05-07 23:33:41 +0000506 // Verify variable.
Devang Patelb6511a32010-08-09 20:20:05 +0000507 if (!V.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000508 return;
509
Devang Patelb6511a32010-08-09 20:20:05 +0000510 unsigned Line = V.getLineNumber();
511 unsigned FileID = GetOrCreateSourceID(V.getContext().getDirectory(),
512 V.getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000513 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000514 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
515 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000516}
517
Devang Patel930143b2009-11-21 02:48:08 +0000518/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000519/// entry.
Devang Patelb6511a32010-08-09 20:20:05 +0000520void DwarfDebug::addSourceLine(DIE *Die, const DIGlobalVariable G) {
Devang Patel0625af22010-05-07 23:33:41 +0000521 // Verify global variable.
Devang Patelb6511a32010-08-09 20:20:05 +0000522 if (!G.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000523 return;
524
Devang Patelb6511a32010-08-09 20:20:05 +0000525 unsigned Line = G.getLineNumber();
526 unsigned FileID = GetOrCreateSourceID(G.getContext().getDirectory(),
527 G.getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000528 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000529 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
530 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000531}
Devang Patelb2de5fa2009-08-31 22:47:13 +0000532
Devang Patel930143b2009-11-21 02:48:08 +0000533/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000534/// entry.
Devang Patelb6511a32010-08-09 20:20:05 +0000535void DwarfDebug::addSourceLine(DIE *Die, const DISubprogram SP) {
Devang Patel0625af22010-05-07 23:33:41 +0000536 // Verify subprogram.
Devang Patelb6511a32010-08-09 20:20:05 +0000537 if (!SP.Verify())
Devang Patelb2de5fa2009-08-31 22:47:13 +0000538 return;
Caroline Tice183a5192009-09-11 18:25:54 +0000539 // If the line number is 0, don't add it.
Devang Patelb6511a32010-08-09 20:20:05 +0000540 if (SP.getLineNumber() == 0)
Caroline Tice183a5192009-09-11 18:25:54 +0000541 return;
542
Devang Patelb6511a32010-08-09 20:20:05 +0000543 unsigned Line = SP.getLineNumber();
544 if (!SP.getContext().Verify())
Devang Patel8119fe872010-03-08 22:02:50 +0000545 return;
Devang Patelb6511a32010-08-09 20:20:05 +0000546 unsigned FileID = GetOrCreateSourceID(SP.getDirectory(),
547 SP.getFilename());
Devang Patelb2de5fa2009-08-31 22:47:13 +0000548 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000549 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
550 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patelb2de5fa2009-08-31 22:47:13 +0000551}
552
Devang Patel930143b2009-11-21 02:48:08 +0000553/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000554/// entry.
Devang Patelb6511a32010-08-09 20:20:05 +0000555void DwarfDebug::addSourceLine(DIE *Die, const DIType Ty) {
Devang Patel0625af22010-05-07 23:33:41 +0000556 // Verify type.
Devang Patelb6511a32010-08-09 20:20:05 +0000557 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000558 return;
559
Devang Patelb6511a32010-08-09 20:20:05 +0000560 unsigned Line = Ty.getLineNumber();
561 if (!Ty.getContext().Verify())
Devang Patel8119fe872010-03-08 22:02:50 +0000562 return;
Devang Patelb6511a32010-08-09 20:20:05 +0000563 unsigned FileID = GetOrCreateSourceID(Ty.getContext().getDirectory(),
564 Ty.getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000565 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000566 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
567 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000568}
569
Devang Patel1f4690c2009-12-15 19:16:48 +0000570/// addSourceLine - Add location information to specified debug information
571/// entry.
Devang Patelb6511a32010-08-09 20:20:05 +0000572void DwarfDebug::addSourceLine(DIE *Die, const DINameSpace NS) {
Devang Patel0625af22010-05-07 23:33:41 +0000573 // Verify namespace.
Devang Patelb6511a32010-08-09 20:20:05 +0000574 if (!NS.Verify())
Devang Patel1f4690c2009-12-15 19:16:48 +0000575 return;
576
Devang Patelb6511a32010-08-09 20:20:05 +0000577 unsigned Line = NS.getLineNumber();
578 StringRef FN = NS.getFilename();
579 StringRef Dir = NS.getDirectory();
Devang Patel1f4690c2009-12-15 19:16:48 +0000580
581 unsigned FileID = GetOrCreateSourceID(Dir, FN);
582 assert(FileID && "Invalid file id");
583 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
584 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
585}
586
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000587/// addVariableAddress - Add DW_AT_location attribute for a DbgVariable.
588void DwarfDebug::addVariableAddress(DbgVariable *&DV, DIE *Die,
589 unsigned Attribute,
590 const MachineLocation &Location) {
591 if (DV->variableHasComplexAddress())
592 addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
593 else if (DV->isBlockByrefVariable())
594 addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
595 else
596 addAddress(Die, dwarf::DW_AT_location, Location);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000597}
598
Devang Patel930143b2009-11-21 02:48:08 +0000599/// addComplexAddress - Start with the address based on the location provided,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000600/// and generate the DWARF information necessary to find the actual variable
601/// given the extra address information encoded in the DIVariable, starting from
602/// the starting location. Add the DWARF information to the die.
603///
Devang Patel930143b2009-11-21 02:48:08 +0000604void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000605 unsigned Attribute,
606 const MachineLocation &Location) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000607 DIType Ty = DV->getType();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000608
609 // Decode the original location, and use that as the start of the byref
610 // variable's location.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000611 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000612 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000613 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000614
615 if (Location.isReg()) {
616 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000617 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000618 } else {
619 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel930143b2009-11-21 02:48:08 +0000620 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
621 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000622 }
623 } else {
624 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000625 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000626 else {
Devang Patel930143b2009-11-21 02:48:08 +0000627 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
628 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000629 }
630
Devang Patel930143b2009-11-21 02:48:08 +0000631 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump14cf8ec2009-09-30 00:08:22 +0000632 }
633
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000634 for (unsigned i = 0, N = DV->getNumAddrElements(); i < N; ++i) {
635 uint64_t Element = DV->getAddrElement(i);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000636
637 if (Element == DIFactory::OpPlus) {
Devang Patel930143b2009-11-21 02:48:08 +0000638 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000639 addUInt(Block, 0, dwarf::DW_FORM_udata, DV->getAddrElement(++i));
Mike Stump14cf8ec2009-09-30 00:08:22 +0000640 } else if (Element == DIFactory::OpDeref) {
Devang Patel930143b2009-11-21 02:48:08 +0000641 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000642 } else llvm_unreachable("unknown DIFactory Opcode");
643 }
644
645 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000646 addBlock(Die, Attribute, 0, Block);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000647}
648
Caroline Ticec87c1e22009-08-31 21:19:37 +0000649/* Byref variables, in Blocks, are declared by the programmer as "SomeType
650 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
651 gives the variable VarName either the struct, or a pointer to the struct, as
652 its type. This is necessary for various behind-the-scenes things the
653 compiler needs to do with by-reference variables in Blocks.
654
655 However, as far as the original *programmer* is concerned, the variable
656 should still have type 'SomeType', as originally declared.
657
Devang Patel930143b2009-11-21 02:48:08 +0000658 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticec87c1e22009-08-31 21:19:37 +0000659 struct to find the original type of the variable, which is then assigned to
660 the variable's Debug Information Entry as its real type. So far, so good.
661 However now the debugger will expect the variable VarName to have the type
662 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000663 expression that explains to the debugger how to navigate through the
Caroline Ticec87c1e22009-08-31 21:19:37 +0000664 pointers and struct to find the actual variable of type SomeType.
665
666 The following function does just that. We start by getting
667 the "normal" location for the variable. This will be the location
668 of either the struct __Block_byref_x_VarName or the pointer to the
669 struct __Block_byref_x_VarName.
670
671 The struct will look something like:
672
673 struct __Block_byref_x_VarName {
674 ... <various fields>
675 struct __Block_byref_x_VarName *forwarding;
676 ... <various other fields>
677 SomeType VarName;
678 ... <maybe more fields>
679 };
680
681 If we are given the struct directly (as our starting point) we
682 need to tell the debugger to:
683
684 1). Add the offset of the forwarding field.
685
Dan Gohman4a618822010-02-10 16:03:48 +0000686 2). Follow that pointer to get the real __Block_byref_x_VarName
Caroline Ticec87c1e22009-08-31 21:19:37 +0000687 struct to use (the real one may have been copied onto the heap).
688
689 3). Add the offset for the field VarName, to find the actual variable.
690
691 If we started with a pointer to the struct, then we need to
692 dereference that pointer first, before the other steps.
693 Translating this into DWARF ops, we will need to append the following
694 to the current location description for the variable:
695
696 DW_OP_deref -- optional, if we start with a pointer
697 DW_OP_plus_uconst <forward_fld_offset>
698 DW_OP_deref
699 DW_OP_plus_uconst <varName_fld_offset>
700
701 That is what this function does. */
702
Devang Patel930143b2009-11-21 02:48:08 +0000703/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticec87c1e22009-08-31 21:19:37 +0000704/// provided, and generate the DWARF information necessary to find the
705/// actual Block variable (navigating the Block struct) based on the
706/// starting location. Add the DWARF information to the die. For
707/// more information, read large comment just above here.
708///
Devang Patel930143b2009-11-21 02:48:08 +0000709void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000710 unsigned Attribute,
711 const MachineLocation &Location) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000712 DIType Ty = DV->getType();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000713 DIType TmpTy = Ty;
714 unsigned Tag = Ty.getTag();
715 bool isPointer = false;
716
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000717 StringRef varName = DV->getName();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000718
719 if (Tag == dwarf::DW_TAG_pointer_type) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000720 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000721 TmpTy = DTy.getTypeDerivedFrom();
722 isPointer = true;
723 }
724
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000725 DICompositeType blockStruct = DICompositeType(TmpTy);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000726
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000727 // Find the __forwarding field and the variable field in the __Block_byref
728 // struct.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000729 DIArray Fields = blockStruct.getTypeArray();
730 DIDescriptor varField = DIDescriptor();
731 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000732
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000733 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
734 DIDescriptor Element = Fields.getElement(i);
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000735 DIDerivedType DT = DIDerivedType(Element);
Devang Patel2d9caf92009-11-25 17:36:49 +0000736 StringRef fieldName = DT.getName();
737 if (fieldName == "__forwarding")
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000738 forwardingField = Element;
Devang Patel2d9caf92009-11-25 17:36:49 +0000739 else if (fieldName == varName)
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000740 varField = Element;
741 }
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000742
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000743 // Get the offsets for the forwarding field and the variable field.
Chris Lattner71696ef2010-03-31 06:06:37 +0000744 unsigned forwardingFieldOffset =
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000745 DIDerivedType(forwardingField).getOffsetInBits() >> 3;
Chris Lattner71696ef2010-03-31 06:06:37 +0000746 unsigned varFieldOffset =
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000747 DIDerivedType(varField).getOffsetInBits() >> 3;
Caroline Ticec87c1e22009-08-31 21:19:37 +0000748
Mike Stump944fa252009-09-24 23:21:26 +0000749 // Decode the original location, and use that as the start of the byref
750 // variable's location.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000751 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000752 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000753 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000754
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000755 if (Location.isReg()) {
756 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000757 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000758 else {
759 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel930143b2009-11-21 02:48:08 +0000760 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
761 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000762 }
763 } else {
764 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000765 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000766 else {
Devang Patel930143b2009-11-21 02:48:08 +0000767 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
768 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000769 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000770
Devang Patel930143b2009-11-21 02:48:08 +0000771 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000772 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000773
Mike Stump944fa252009-09-24 23:21:26 +0000774 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000775 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000776 if (isPointer)
Devang Patel930143b2009-11-21 02:48:08 +0000777 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000778
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000779 // Next add the offset for the '__forwarding' field:
780 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
781 // adding the offset if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000782 if (forwardingFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000783 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
784 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000785 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000786
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000787 // Now dereference the __forwarding field to get to the real __Block_byref
788 // struct: DW_OP_deref.
Devang Patel930143b2009-11-21 02:48:08 +0000789 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000790
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000791 // Now that we've got the real __Block_byref... struct, add the offset
792 // for the variable's field to get to the location of the actual variable:
793 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000794 if (varFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000795 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
796 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000797 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000798
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000799 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000800 addBlock(Die, Attribute, 0, Block);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000801}
802
Devang Patel930143b2009-11-21 02:48:08 +0000803/// addAddress - Add an address attribute to a die based on the location
Bill Wendling2f921f82009-05-15 09:23:25 +0000804/// provided.
Devang Patel930143b2009-11-21 02:48:08 +0000805void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000806 const MachineLocation &Location) {
Chris Lattner3a383cb2010-04-05 00:13:49 +0000807 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling2f921f82009-05-15 09:23:25 +0000808 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000809 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Bill Wendling2f921f82009-05-15 09:23:25 +0000810
811 if (Location.isReg()) {
812 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000813 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000814 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000815 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
816 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000817 }
818 } else {
819 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000820 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000821 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000822 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
823 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000824 }
825
Devang Patel930143b2009-11-21 02:48:08 +0000826 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling2f921f82009-05-15 09:23:25 +0000827 }
828
Devang Patel930143b2009-11-21 02:48:08 +0000829 addBlock(Die, Attribute, 0, Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000830}
831
Devang Patel173b2b92010-04-28 01:03:09 +0000832/// addRegisterAddress - Add register location entry in variable DIE.
Devang Patele1c53f22010-05-20 16:36:41 +0000833bool DwarfDebug::addRegisterAddress(DIE *Die, const MCSymbol *VS,
Devang Patel173b2b92010-04-28 01:03:09 +0000834 const MachineOperand &MO) {
835 assert (MO.isReg() && "Invalid machine operand!");
836 if (!MO.getReg())
837 return false;
838 MachineLocation Location;
839 Location.set(MO.getReg());
840 addAddress(Die, dwarf::DW_AT_location, Location);
Devang Patele1c53f22010-05-20 16:36:41 +0000841 if (VS)
Devang Patel173b2b92010-04-28 01:03:09 +0000842 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
843 return true;
844}
845
846/// addConstantValue - Add constant value entry in variable DIE.
Devang Patele1c53f22010-05-20 16:36:41 +0000847bool DwarfDebug::addConstantValue(DIE *Die, const MCSymbol *VS,
Devang Patel173b2b92010-04-28 01:03:09 +0000848 const MachineOperand &MO) {
849 assert (MO.isImm() && "Invalid machine operand!");
850 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
851 unsigned Imm = MO.getImm();
852 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
853 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patele1c53f22010-05-20 16:36:41 +0000854 if (VS)
Devang Patel173b2b92010-04-28 01:03:09 +0000855 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
856 return true;
857}
858
859/// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patele1c53f22010-05-20 16:36:41 +0000860bool DwarfDebug::addConstantFPValue(DIE *Die, const MCSymbol *VS,
Devang Patel173b2b92010-04-28 01:03:09 +0000861 const MachineOperand &MO) {
862 assert (MO.isFPImm() && "Invalid machine operand!");
863 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
864 APFloat FPImm = MO.getFPImm()->getValueAPF();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000865
Devang Patel173b2b92010-04-28 01:03:09 +0000866 // Get the raw data form of the floating point.
867 const APInt FltVal = FPImm.bitcastToAPInt();
868 const char *FltPtr = (const char*)FltVal.getRawData();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000869
Devang Patel173b2b92010-04-28 01:03:09 +0000870 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
871 bool LittleEndian = Asm->getTargetData().isLittleEndian();
872 int Incr = (LittleEndian ? 1 : -1);
873 int Start = (LittleEndian ? 0 : NumBytes - 1);
874 int Stop = (LittleEndian ? NumBytes : -1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000875
Devang Patel173b2b92010-04-28 01:03:09 +0000876 // Output the constant to DWARF one byte at a time.
877 for (; Start != Stop; Start += Incr)
878 addUInt(Block, 0, dwarf::DW_FORM_data1,
879 (unsigned char)0xFF & FltPtr[Start]);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000880
Devang Patel173b2b92010-04-28 01:03:09 +0000881 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patele1c53f22010-05-20 16:36:41 +0000882 if (VS)
883 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000884 return true;
Devang Patel173b2b92010-04-28 01:03:09 +0000885}
886
887
Devang Patel2b75ed22009-12-10 19:14:49 +0000888/// addToContextOwner - Add Die into the list of its context owner's children.
889void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000890 if (Context.isType()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000891 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
Devang Patel2b75ed22009-12-10 19:14:49 +0000892 ContextDIE->addChild(Die);
Devang Patel1f4690c2009-12-15 19:16:48 +0000893 } else if (Context.isNameSpace()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000894 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
Devang Patel1f4690c2009-12-15 19:16:48 +0000895 ContextDIE->addChild(Die);
Stuart Hastingsafe54f12010-06-11 20:08:44 +0000896 } else if (Context.isSubprogram()) {
897 DIE *ContextDIE = createSubprogramDIE(DISubprogram(Context),
898 /*MakeDecl=*/false);
899 ContextDIE->addChild(Die);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000900 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patel2b75ed22009-12-10 19:14:49 +0000901 ContextDIE->addChild(Die);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000902 else
Devang Patel1a0df9a2010-05-10 22:49:55 +0000903 getCompileUnit(Context)->addDie(Die);
Devang Patel2b75ed22009-12-10 19:14:49 +0000904}
905
Devang Patelb5b60ea2009-12-10 18:05:33 +0000906/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
907/// given DIType.
908DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000909 CompileUnit *TypeCU = getCompileUnit(Ty);
910 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000911 if (TyDIE)
912 return TyDIE;
913
914 // Create new type.
915 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000916 TypeCU->insertDIE(Ty, TyDIE);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000917 if (Ty.isBasicType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000918 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000919 else if (Ty.isCompositeType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000920 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000921 else {
922 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000923 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000924 }
925
Devang Patel2b75ed22009-12-10 19:14:49 +0000926 addToContextOwner(TyDIE, Ty.getContext());
Devang Patelb5b60ea2009-12-10 18:05:33 +0000927 return TyDIE;
928}
929
Devang Patel930143b2009-11-21 02:48:08 +0000930/// addType - Add a new type attribute to the specified entity.
Devang Patel9ccfb642009-12-09 18:24:21 +0000931void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel8d6a2b72010-05-07 21:45:47 +0000932 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000933 return;
934
935 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000936 CompileUnit *TypeCU = getCompileUnit(Ty);
937 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000938 // If it exists then use the existing value.
Devang Patel930143b2009-11-21 02:48:08 +0000939 if (Entry) {
940 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000941 return;
942 }
943
Bill Wendling2f921f82009-05-15 09:23:25 +0000944 // Construct type.
Devang Patelb5b60ea2009-12-10 18:05:33 +0000945 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000946
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000947 // Set up proxy.
948 Entry = createDIEEntry(Buffer);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000949 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000950
Devang Patel930143b2009-11-21 02:48:08 +0000951 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000952}
953
Devang Patel930143b2009-11-21 02:48:08 +0000954/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000955void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000956 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000957 StringRef Name = BTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +0000958 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +0000959 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling2f921f82009-05-15 09:23:25 +0000960 BTy.getEncoding());
961
962 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +0000963 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +0000964 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +0000965 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel930143b2009-11-21 02:48:08 +0000966 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +0000967}
968
Devang Patel930143b2009-11-21 02:48:08 +0000969/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000970void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000971 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000972 StringRef Name = DTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +0000973 uint64_t Size = DTy.getSizeInBits() >> 3;
974 unsigned Tag = DTy.getTag();
975
976 // FIXME - Workaround for templates.
977 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
978
979 Buffer.setTag(Tag);
980
981 // Map to main type, void will not have a type.
982 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel9ccfb642009-12-09 18:24:21 +0000983 addType(&Buffer, FromTy);
Bill Wendling2f921f82009-05-15 09:23:25 +0000984
985 // Add name if not anonymous or intermediate type.
Devang Patelae466ef2009-11-30 23:56:56 +0000986 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +0000987 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +0000988
989 // Add size if non-zero (derived types might be zero-sized.)
990 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +0000991 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +0000992
993 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patelb5b51592009-11-23 18:43:37 +0000994 if (!DTy.isForwardDecl())
Devang Patelb6511a32010-08-09 20:20:05 +0000995 addSourceLine(&Buffer, DTy);
Bill Wendling2f921f82009-05-15 09:23:25 +0000996}
997
Devang Patel930143b2009-11-21 02:48:08 +0000998/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000999void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001000 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +00001001 StringRef Name = CTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001002
1003 uint64_t Size = CTy.getSizeInBits() >> 3;
1004 unsigned Tag = CTy.getTag();
1005 Buffer.setTag(Tag);
1006
1007 switch (Tag) {
1008 case dwarf::DW_TAG_vector_type:
1009 case dwarf::DW_TAG_array_type:
Devang Patel9ccfb642009-12-09 18:24:21 +00001010 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001011 break;
1012 case dwarf::DW_TAG_enumeration_type: {
1013 DIArray Elements = CTy.getTypeArray();
1014
1015 // Add enumerators to enumeration type.
1016 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1017 DIE *ElemDie = NULL;
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001018 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3b548aa2010-03-08 20:52:55 +00001019 if (Enum.isEnumerator()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001020 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel930143b2009-11-21 02:48:08 +00001021 Buffer.addChild(ElemDie);
Devang Patelfafa1fe2009-10-09 17:51:49 +00001022 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001023 }
1024 }
1025 break;
1026 case dwarf::DW_TAG_subroutine_type: {
1027 // Add return type.
1028 DIArray Elements = CTy.getTypeArray();
1029 DIDescriptor RTy = Elements.getElement(0);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001030 addType(&Buffer, DIType(RTy));
Bill Wendling2f921f82009-05-15 09:23:25 +00001031
1032 // Add prototype flag.
Devang Patel930143b2009-11-21 02:48:08 +00001033 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001034
1035 // Add arguments.
1036 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1037 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1038 DIDescriptor Ty = Elements.getElement(i);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001039 addType(Arg, DIType(Ty));
Devang Patel930143b2009-11-21 02:48:08 +00001040 Buffer.addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +00001041 }
1042 }
1043 break;
1044 case dwarf::DW_TAG_structure_type:
1045 case dwarf::DW_TAG_union_type:
1046 case dwarf::DW_TAG_class_type: {
1047 // Add elements to structure type.
1048 DIArray Elements = CTy.getTypeArray();
1049
1050 // A forward struct declared type may not have elements available.
Devang Patel3b548aa2010-03-08 20:52:55 +00001051 unsigned N = Elements.getNumElements();
1052 if (N == 0)
Bill Wendling2f921f82009-05-15 09:23:25 +00001053 break;
1054
1055 // Add elements to structure type.
Devang Patel3b548aa2010-03-08 20:52:55 +00001056 for (unsigned i = 0; i < N; ++i) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001057 DIDescriptor Element = Elements.getElement(i);
1058 DIE *ElemDie = NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001059 if (Element.isSubprogram())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001060 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patel3b548aa2010-03-08 20:52:55 +00001061 else if (Element.isVariable()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001062 DIVariable DV(Element);
Devang Patel160c92d2010-01-30 01:08:30 +00001063 ElemDie = new DIE(dwarf::DW_TAG_variable);
1064 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1065 DV.getName());
1066 addType(ElemDie, DV.getType());
1067 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1068 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patelb6511a32010-08-09 20:20:05 +00001069 addSourceLine(ElemDie, DV);
Devang Patel3b548aa2010-03-08 20:52:55 +00001070 } else if (Element.isDerivedType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001071 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3b548aa2010-03-08 20:52:55 +00001072 else
1073 continue;
Devang Patel930143b2009-11-21 02:48:08 +00001074 Buffer.addChild(ElemDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001075 }
1076
Devang Patel3082c012009-08-27 23:51:51 +00001077 if (CTy.isAppleBlockExtension())
Devang Patel930143b2009-11-21 02:48:08 +00001078 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001079
1080 unsigned RLang = CTy.getRunTimeLang();
1081 if (RLang)
Devang Patel930143b2009-11-21 02:48:08 +00001082 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling2f921f82009-05-15 09:23:25 +00001083 dwarf::DW_FORM_data1, RLang);
Devang Patel303a1be2010-01-26 21:16:06 +00001084
1085 DICompositeType ContainingType = CTy.getContainingType();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001086 if (DIDescriptor(ContainingType).isCompositeType())
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001087 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001088 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001089 else {
1090 DIDescriptor Context = CTy.getContext();
1091 addToContextOwner(&Buffer, Context);
1092 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001093 break;
1094 }
1095 default:
1096 break;
1097 }
1098
1099 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +00001100 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001101 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001102
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001103 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
Devang Patel30265c42010-07-07 20:12:52 +00001104 || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1105 {
Bill Wendling2f921f82009-05-15 09:23:25 +00001106 // Add size if non-zero (derived types might be zero-sized.)
1107 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +00001108 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001109 else {
1110 // Add zero size if it is not a forward declaration.
1111 if (CTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +00001112 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001113 else
Devang Patel930143b2009-11-21 02:48:08 +00001114 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling2f921f82009-05-15 09:23:25 +00001115 }
1116
1117 // Add source line info if available.
1118 if (!CTy.isForwardDecl())
Devang Patelb6511a32010-08-09 20:20:05 +00001119 addSourceLine(&Buffer, CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001120 }
1121}
1122
Devang Patel930143b2009-11-21 02:48:08 +00001123/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1124void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling2f921f82009-05-15 09:23:25 +00001125 int64_t L = SR.getLo();
1126 int64_t H = SR.getHi();
1127 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1128
Devang Patel930143b2009-11-21 02:48:08 +00001129 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patelf691df32009-08-14 20:59:16 +00001130 if (L)
Devang Patel930143b2009-11-21 02:48:08 +00001131 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Patel8f046022009-12-04 23:10:24 +00001132 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling2f921f82009-05-15 09:23:25 +00001133
Devang Patel930143b2009-11-21 02:48:08 +00001134 Buffer.addChild(DW_Subrange);
Bill Wendling2f921f82009-05-15 09:23:25 +00001135}
1136
Devang Patel930143b2009-11-21 02:48:08 +00001137/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001138void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling2f921f82009-05-15 09:23:25 +00001139 DICompositeType *CTy) {
1140 Buffer.setTag(dwarf::DW_TAG_array_type);
1141 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel930143b2009-11-21 02:48:08 +00001142 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001143
1144 // Emit derived type.
Devang Patel9ccfb642009-12-09 18:24:21 +00001145 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001146 DIArray Elements = CTy->getTypeArray();
1147
Devang Patel92e8c652009-11-21 00:31:03 +00001148 // Get an anonymous type for index type.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001149 CompileUnit *TheCU = getCompileUnit(*CTy);
1150 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel92e8c652009-11-21 00:31:03 +00001151 if (!IdxTy) {
1152 // Construct an anonymous type for index type.
1153 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +00001154 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1155 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel92e8c652009-11-21 00:31:03 +00001156 dwarf::DW_ATE_signed);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001157 TheCU->addDie(IdxTy);
1158 TheCU->setIndexTyDie(IdxTy);
Devang Patel92e8c652009-11-21 00:31:03 +00001159 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001160
1161 // Add subranges to array type.
1162 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1163 DIDescriptor Element = Elements.getElement(i);
1164 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001165 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001166 }
1167}
1168
Devang Patel930143b2009-11-21 02:48:08 +00001169/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3b548aa2010-03-08 20:52:55 +00001170DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001171 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3b548aa2010-03-08 20:52:55 +00001172 StringRef Name = ETy.getName();
Devang Patel930143b2009-11-21 02:48:08 +00001173 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3b548aa2010-03-08 20:52:55 +00001174 int64_t Value = ETy.getEnumValue();
Devang Patel930143b2009-11-21 02:48:08 +00001175 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +00001176 return Enumerator;
1177}
1178
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001179/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel43ef34d2010-01-05 01:46:14 +00001180/// printer to not emit usual symbol prefix before the symbol name is used then
1181/// return linkage name after skipping this special LLVM prefix.
1182static StringRef getRealLinkageName(StringRef LinkageName) {
1183 char One = '\1';
1184 if (LinkageName.startswith(StringRef(&One, 1)))
1185 return LinkageName.substr(1);
1186 return LinkageName;
1187}
1188
Devang Patel930143b2009-11-21 02:48:08 +00001189/// createGlobalVariableDIE - Create new DIE using GV.
Devang Patel9ccfb642009-12-09 18:24:21 +00001190DIE *DwarfDebug::createGlobalVariableDIE(const DIGlobalVariable &GV) {
Jim Grosbach00e9c612009-11-22 19:20:36 +00001191 // If the global variable was optmized out then no need to create debug info
1192 // entry.
Devang Patelcc11371b2009-11-06 17:58:12 +00001193 if (!GV.getGlobal()) return NULL;
Devang Patel2d9caf92009-11-25 17:36:49 +00001194 if (GV.getDisplayName().empty()) return NULL;
Devang Patel06ce6502009-11-06 01:30:04 +00001195
Bill Wendling2f921f82009-05-15 09:23:25 +00001196 DIE *GVDie = new DIE(dwarf::DW_TAG_variable);
Jim Grosbach042483e2009-11-21 23:12:12 +00001197 addString(GVDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
Devang Patelb2969422009-09-29 18:40:58 +00001198 GV.getDisplayName());
1199
Devang Patel2d9caf92009-11-25 17:36:49 +00001200 StringRef LinkageName = GV.getLinkageName();
Devang Patel43ef34d2010-01-05 01:46:14 +00001201 if (!LinkageName.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001202 addString(GVDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel43ef34d2010-01-05 01:46:14 +00001203 getRealLinkageName(LinkageName));
1204
Devang Patel9ccfb642009-12-09 18:24:21 +00001205 addType(GVDie, GV.getType());
Bill Wendling2f921f82009-05-15 09:23:25 +00001206 if (!GV.isLocalToUnit())
Devang Patel930143b2009-11-21 02:48:08 +00001207 addUInt(GVDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patelb6511a32010-08-09 20:20:05 +00001208 addSourceLine(GVDie, GV);
Devang Patel4144a822009-10-05 23:22:08 +00001209
Bill Wendling2f921f82009-05-15 09:23:25 +00001210 return GVDie;
1211}
1212
Devang Patel930143b2009-11-21 02:48:08 +00001213/// createMemberDIE - Create new member DIE.
Devang Patel9ccfb642009-12-09 18:24:21 +00001214DIE *DwarfDebug::createMemberDIE(const 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 Pateleb57c592009-12-03 19:11:07 +00001281 else if (DT.getTag() == dwarf::DW_TAG_inheritance)
1282 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1283 dwarf::DW_ACCESS_public);
1284 if (DT.isVirtual())
1285 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1286 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling2f921f82009-05-15 09:23:25 +00001287 return MemberDie;
1288}
1289
Devang Patel525dda02009-12-14 16:18:45 +00001290/// createSubprogramDIE - Create new DIE using SP.
1291DIE *DwarfDebug::createSubprogramDIE(const DISubprogram &SP, bool MakeDecl) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001292 CompileUnit *SPCU = getCompileUnit(SP);
1293 DIE *SPDie = SPCU->getDIE(SP);
Devang Patel525dda02009-12-14 16:18:45 +00001294 if (SPDie)
1295 return SPDie;
1296
1297 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf200b392010-03-02 17:58:15 +00001298 // Constructors and operators for anonymous aggregates do not have names.
Devang Pateld0fa3042010-03-02 01:26:20 +00001299 if (!SP.getName().empty())
1300 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling2f921f82009-05-15 09:23:25 +00001301
Devang Patel2d9caf92009-11-25 17:36:49 +00001302 StringRef LinkageName = SP.getLinkageName();
Devang Patel43ef34d2010-01-05 01:46:14 +00001303 if (!LinkageName.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001304 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel43ef34d2010-01-05 01:46:14 +00001305 getRealLinkageName(LinkageName));
1306
Devang Patelb6511a32010-08-09 20:20:05 +00001307 addSourceLine(SPDie, SP);
Bill Wendling2f921f82009-05-15 09:23:25 +00001308
Bill Wendling2f921f82009-05-15 09:23:25 +00001309 // Add prototyped tag, if C or ObjC.
1310 unsigned Lang = SP.getCompileUnit().getLanguage();
1311 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1312 Lang == dwarf::DW_LANG_ObjC)
Devang Patel930143b2009-11-21 02:48:08 +00001313 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001314
1315 // Add Return Type.
Devang Patel236526d2009-12-03 01:25:38 +00001316 DICompositeType SPTy = SP.getType();
1317 DIArray Args = SPTy.getTypeArray();
Bill Wendling2f921f82009-05-15 09:23:25 +00001318 unsigned SPTag = SPTy.getTag();
Devang Pateleb57c592009-12-03 19:11:07 +00001319
Devang Patel3b548aa2010-03-08 20:52:55 +00001320 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel9ccfb642009-12-09 18:24:21 +00001321 addType(SPDie, SPTy);
Devang Patel236526d2009-12-03 01:25:38 +00001322 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001323 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel236526d2009-12-03 01:25:38 +00001324
Devang Pateleb57c592009-12-03 19:11:07 +00001325 unsigned VK = SP.getVirtuality();
1326 if (VK) {
1327 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001328 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Pateleb57c592009-12-03 19:11:07 +00001329 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1330 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1331 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001332 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001333 SP.getContainingType()));
Devang Pateleb57c592009-12-03 19:11:07 +00001334 }
1335
Devang Patel525dda02009-12-14 16:18:45 +00001336 if (MakeDecl || !SP.isDefinition()) {
Devang Patel930143b2009-11-21 02:48:08 +00001337 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001338
1339 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel236526d2009-12-03 01:25:38 +00001340 // be handled while processing variables.
1341 DICompositeType SPTy = SP.getType();
1342 DIArray Args = SPTy.getTypeArray();
1343 unsigned SPTag = SPTy.getTag();
1344
Bill Wendling2f921f82009-05-15 09:23:25 +00001345 if (SPTag == dwarf::DW_TAG_subroutine_type)
1346 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1347 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001348 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patel6efc8e52010-02-06 01:02:37 +00001349 addType(Arg, ATy);
1350 if (ATy.isArtificial())
1351 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel930143b2009-11-21 02:48:08 +00001352 SPDie->addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +00001353 }
1354 }
1355
Devang Patel999b4992010-02-03 19:57:19 +00001356 if (SP.isArtificial())
1357 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1358
Devang Patelb4e3b902010-04-30 19:38:23 +00001359 if (!SP.isLocalToUnit())
1360 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001361
Devang Patelb4e3b902010-04-30 19:38:23 +00001362 if (SP.isOptimized())
1363 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1364
Jim Grosbach965a73a2010-07-21 23:03:52 +00001365 if (unsigned isa = Asm->getISAEncoding()) {
1366 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1367 }
1368
Devang Patelb4e3b902010-04-30 19:38:23 +00001369 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001370 SPCU->insertDIE(SP, SPDie);
Devang Patelb4e3b902010-04-30 19:38:23 +00001371
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001372 // Add to context owner.
1373 addToContextOwner(SPDie, SP.getContext());
1374
Bill Wendling2f921f82009-05-15 09:23:25 +00001375 return SPDie;
1376}
1377
Devang Patel32cc43c2010-05-07 20:54:48 +00001378DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattner8d2fe282010-03-31 05:36:29 +00001379 assert(N && "Invalid Scope encoding!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001380
1381 DbgScope *AScope = AbstractScopes.lookup(N);
1382 if (AScope)
1383 return AScope;
Jim Grosbach042483e2009-11-21 23:12:12 +00001384
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001385 DbgScope *Parent = NULL;
1386
1387 DIDescriptor Scope(N);
1388 if (Scope.isLexicalBlock()) {
1389 DILexicalBlock DB(N);
1390 DIDescriptor ParentDesc = DB.getContext();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001391 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001392 }
1393
1394 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1395
1396 if (Parent)
Devang Patel930143b2009-11-21 02:48:08 +00001397 Parent->addScope(AScope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001398 AScope->setAbstractScope();
1399 AbstractScopes[N] = AScope;
1400 if (DIDescriptor(N).isSubprogram())
1401 AbstractScopesList.push_back(AScope);
1402 return AScope;
1403}
Devang Patel75cc16c2009-10-01 20:31:14 +00001404
Devang Patel019922d2010-04-06 23:53:48 +00001405/// isSubprogramContext - Return true if Context is either a subprogram
1406/// or another context nested inside a subprogram.
Devang Patel32cc43c2010-05-07 20:54:48 +00001407static bool isSubprogramContext(const MDNode *Context) {
Devang Patel019922d2010-04-06 23:53:48 +00001408 if (!Context)
1409 return false;
1410 DIDescriptor D(Context);
1411 if (D.isSubprogram())
1412 return true;
1413 if (D.isType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001414 return isSubprogramContext(DIType(Context).getContext());
Devang Patel019922d2010-04-06 23:53:48 +00001415 return false;
1416}
1417
Jim Grosbach042483e2009-11-21 23:12:12 +00001418/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel930143b2009-11-21 02:48:08 +00001419/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1420/// If there are global variables in this scope then create and insert
1421/// DIEs for these variables.
Devang Patel32cc43c2010-05-07 20:54:48 +00001422DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001423 CompileUnit *SPCU = getCompileUnit(SPNode);
1424 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +00001425
Chris Lattner3a383cb2010-04-05 00:13:49 +00001426 assert(SPDie && "Unable to find subprogram DIE!");
1427 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001428
Chris Lattner3a383cb2010-04-05 00:13:49 +00001429 // There is not any need to generate specification DIE for a function
1430 // defined at compile unit level. If a function is defined inside another
1431 // function then gdb prefers the definition at top level and but does not
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001432 // expect specification DIE in parent function. So avoid creating
Chris Lattner3a383cb2010-04-05 00:13:49 +00001433 // specification DIE for a function defined inside a function.
1434 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001435 !SP.getContext().isFile() &&
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001436 !isSubprogramContext(SP.getContext())) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00001437 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001438
1439 // Add arguments.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001440 DICompositeType SPTy = SP.getType();
1441 DIArray Args = SPTy.getTypeArray();
1442 unsigned SPTag = SPTy.getTag();
1443 if (SPTag == dwarf::DW_TAG_subroutine_type)
1444 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1445 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001446 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattner3a383cb2010-04-05 00:13:49 +00001447 addType(Arg, ATy);
1448 if (ATy.isArtificial())
1449 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1450 SPDie->addChild(Arg);
1451 }
1452 DIE *SPDeclDie = SPDie;
1453 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001454 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Chris Lattner3a383cb2010-04-05 00:13:49 +00001455 SPDeclDie);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001456 SPCU->addDie(SPDie);
Chris Lattner3a383cb2010-04-05 00:13:49 +00001457 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001458
Devang Patela37a95e2010-07-07 22:20:57 +00001459 // Pick up abstract subprogram DIE.
1460 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
1461 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1462 addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
1463 dwarf::DW_FORM_ref4, AbsSPDIE);
1464 SPCU->addDie(SPDie);
1465 }
1466
Chris Lattner3a383cb2010-04-05 00:13:49 +00001467 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1468 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1469 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1470 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1471 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1472 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1473 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +00001474
Chris Lattner3a383cb2010-04-05 00:13:49 +00001475 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001476}
1477
Jim Grosbach042483e2009-11-21 23:12:12 +00001478/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel930143b2009-11-21 02:48:08 +00001479/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1480DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001481
1482 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1483 if (Scope->isAbstractScope())
1484 return ScopeDIE;
1485
1486 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1487 if (Ranges.empty())
1488 return 0;
1489
1490 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1491 if (Ranges.size() > 1) {
1492 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001493 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +00001494 // DW_AT_ranges appropriately.
1495 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1496 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1497 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1498 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +00001499 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1500 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +00001501 }
1502 DebugRangeSymbols.push_back(NULL);
1503 DebugRangeSymbols.push_back(NULL);
1504 return ScopeDIE;
1505 }
1506
Devang Patel9fc11702010-05-25 23:40:22 +00001507 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1508 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001509
Devang Patel9fc11702010-05-25 23:40:22 +00001510 if (End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001511
Chris Lattnere13c3722010-03-09 01:58:53 +00001512 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1513 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001514
Devang Patel6c74a872010-04-27 19:46:33 +00001515 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1516 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001517
1518 return ScopeDIE;
1519}
1520
Devang Patel930143b2009-11-21 02:48:08 +00001521/// constructInlinedScopeDIE - This scope represents inlined body of
1522/// a function. Construct DIE to represent this concrete inlined copy
1523/// of the function.
1524DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001525
1526 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001527 assert (Ranges.empty() == false
Devang Patel6c74a872010-04-27 19:46:33 +00001528 && "DbgScope does not have instruction markers!");
1529
1530 // FIXME : .debug_inlined section specification does not clearly state how
1531 // to emit inlined scope that is split into multiple instruction ranges.
1532 // For now, use first instruction range and emit low_pc/high_pc pair and
1533 // corresponding .debug_inlined section entry for this pair.
1534 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel9fc11702010-05-25 23:40:22 +00001535 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1536 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001537
Devang Patel4c6bd662010-07-08 22:39:20 +00001538 if (StartLabel == 0 || EndLabel == 0) {
Devang Patel6c74a872010-04-27 19:46:33 +00001539 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1540 return 0;
1541 }
Chris Lattnere13c3722010-03-09 01:58:53 +00001542 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001543 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +00001544 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001545 "Invalid end label for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +00001546
Devang Patel3b548aa2010-03-08 20:52:55 +00001547 if (!Scope->getScopeNode())
Devang Patelbc97f6b2010-03-08 19:20:38 +00001548 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001549 DIScope DS(Scope->getScopeNode());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001550 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1551
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001552 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001553 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1554 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001555 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel930143b2009-11-21 02:48:08 +00001556 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001557 dwarf::DW_FORM_ref4, OriginDIE);
1558
Chris Lattner085b6522010-03-09 00:31:02 +00001559 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnere13c3722010-03-09 01:58:53 +00001560 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001561
1562 InlinedSubprogramDIEs.insert(OriginDIE);
1563
1564 // Track the start label for this inlined function.
Devang Patel32cc43c2010-05-07 20:54:48 +00001565 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001566 I = InlineInfo.find(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001567
1568 if (I == InlineInfo.end()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001569 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach00e9c612009-11-22 19:20:36 +00001570 ScopeDIE));
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001571 InlinedSPNodes.push_back(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001572 } else
Chris Lattner085b6522010-03-09 00:31:02 +00001573 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001574
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001575 DILocation DL(Scope->getInlinedAt());
Devang Patel1a0df9a2010-05-10 22:49:55 +00001576 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel930143b2009-11-21 02:48:08 +00001577 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001578
1579 return ScopeDIE;
1580}
1581
Devang Patel930143b2009-11-21 02:48:08 +00001582
1583/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel9ccfb642009-12-09 18:24:21 +00001584DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001585 StringRef Name = DV->getName();
Devang Patel2d9caf92009-11-25 17:36:49 +00001586 if (Name.empty())
Devang Patel97f99fa2009-11-13 02:25:26 +00001587 return NULL;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001588
1589 // Translate tag to proper Dwarf tag. The result variable is dropped for
1590 // now.
1591 unsigned Tag;
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001592 switch (DV->getTag()) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001593 case dwarf::DW_TAG_return_variable:
1594 return NULL;
1595 case dwarf::DW_TAG_arg_variable:
1596 Tag = dwarf::DW_TAG_formal_parameter;
1597 break;
1598 case dwarf::DW_TAG_auto_variable: // fall thru
1599 default:
1600 Tag = dwarf::DW_TAG_variable;
1601 break;
1602 }
1603
1604 // Define variable debug information entry.
1605 DIE *VariableDie = new DIE(Tag);
1606
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001607 DIE *AbsDIE = NULL;
Devang Patele1c53f22010-05-20 16:36:41 +00001608 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1609 V2AVI = VarToAbstractVarMap.find(DV);
1610 if (V2AVI != VarToAbstractVarMap.end())
1611 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach042483e2009-11-21 23:12:12 +00001612
Devang Patele1c53f22010-05-20 16:36:41 +00001613 if (AbsDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001614 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001615 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001616 else {
Devang Patel930143b2009-11-21 02:48:08 +00001617 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001618 addSourceLine(VariableDie, DV->getVariable());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001619
1620 // Add variable type.
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001621 addType(VariableDie, DV->getType());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001622 }
1623
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001624 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patel6efc8e52010-02-06 01:02:37 +00001625 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel9fc11702010-05-25 23:40:22 +00001626
1627 if (Scope->isAbstractScope()) {
1628 DV->setDIE(VariableDie);
1629 return VariableDie;
1630 }
1631
1632 // Add variable address.
1633
1634 unsigned Offset = DV->getDotDebugLocOffset();
1635 if (Offset != ~0U) {
1636 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1637 Asm->GetTempSymbol("debug_loc", Offset));
1638 DV->setDIE(VariableDie);
1639 UseDotDebugLocEntry.insert(VariableDie);
1640 return VariableDie;
1641 }
1642
1643 // Check if variable is described by a DBG_VALUE instruction.
1644 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1645 DbgVariableToDbgInstMap.find(DV);
1646 if (DVI != DbgVariableToDbgInstMap.end()) {
1647 const MachineInstr *DVInsn = DVI->second;
1648 const MCSymbol *DVLabel = findVariableLabel(DV);
1649 bool updated = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001650 // FIXME : Handle getNumOperands != 3
Devang Patel9fc11702010-05-25 23:40:22 +00001651 if (DVInsn->getNumOperands() == 3) {
1652 if (DVInsn->getOperand(0).isReg())
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001653 updated =
Devang Patel30265c42010-07-07 20:12:52 +00001654 addRegisterAddress(VariableDie, DVLabel, DVInsn->getOperand(0));
Devang Patel9fc11702010-05-25 23:40:22 +00001655 else if (DVInsn->getOperand(0).isImm())
1656 updated = addConstantValue(VariableDie, DVLabel, DVInsn->getOperand(0));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001657 else if (DVInsn->getOperand(0).isFPImm())
1658 updated =
Devang Patel30265c42010-07-07 20:12:52 +00001659 addConstantFPValue(VariableDie, DVLabel, DVInsn->getOperand(0));
Devang Patel9fc11702010-05-25 23:40:22 +00001660 } else {
1661 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1662 if (Location.getReg()) {
1663 addAddress(VariableDie, dwarf::DW_AT_location, Location);
1664 if (DVLabel)
1665 addLabel(VariableDie, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr,
1666 DVLabel);
1667 updated = true;
1668 }
1669 }
1670 if (!updated) {
1671 // If variableDie is not updated then DBG_VALUE instruction does not
1672 // have valid variable info.
1673 delete VariableDie;
1674 return NULL;
1675 }
1676 DV->setDIE(VariableDie);
1677 return VariableDie;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001678 }
Devang Patel9fc11702010-05-25 23:40:22 +00001679
1680 // .. else use frame index, if available.
1681 MachineLocation Location;
1682 unsigned FrameReg;
1683 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1684 int FI = 0;
1685 if (findVariableFrameIndex(DV, &FI)) {
1686 int Offset = RI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
1687 Location.set(FrameReg, Offset);
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001688 addVariableAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
Devang Patel9fc11702010-05-25 23:40:22 +00001689 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001690 DV->setDIE(VariableDie);
1691 return VariableDie;
1692
1693}
Devang Patel930143b2009-11-21 02:48:08 +00001694
Devang Patel04d2f2d2009-11-24 01:14:22 +00001695void DwarfDebug::addPubTypes(DISubprogram SP) {
1696 DICompositeType SPTy = SP.getType();
1697 unsigned SPTag = SPTy.getTag();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001698 if (SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel04d2f2d2009-11-24 01:14:22 +00001699 return;
1700
1701 DIArray Args = SPTy.getTypeArray();
Devang Patel04d2f2d2009-11-24 01:14:22 +00001702 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001703 DIType ATy(Args.getElement(i));
Devang Patel8d6a2b72010-05-07 21:45:47 +00001704 if (!ATy.Verify())
Devang Patel04d2f2d2009-11-24 01:14:22 +00001705 continue;
1706 DICompositeType CATy = getDICompositeType(ATy);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001707 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel12d150e2010-04-13 20:35:04 +00001708 && !CATy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001709 CompileUnit *TheCU = getCompileUnit(CATy);
1710 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1711 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00001712 }
1713 }
1714}
1715
Devang Patel930143b2009-11-21 02:48:08 +00001716/// constructScopeDIE - Construct a DIE for this scope.
1717DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +00001718 if (!Scope || !Scope->getScopeNode())
1719 return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001720
Devang Patel3b548aa2010-03-08 20:52:55 +00001721 DIScope DS(Scope->getScopeNode());
1722 DIE *ScopeDIE = NULL;
1723 if (Scope->getInlinedAt())
1724 ScopeDIE = constructInlinedScopeDIE(Scope);
1725 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +00001726 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001727 if (Scope->isAbstractScope()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001728 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001729 // Note down abstract DIE.
1730 if (ScopeDIE)
1731 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
1732 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001733 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001734 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3b548aa2010-03-08 20:52:55 +00001735 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001736 else
Devang Patel3b548aa2010-03-08 20:52:55 +00001737 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel23b2ae62010-03-29 22:59:58 +00001738 if (!ScopeDIE) return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001739
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001740 // Add variables to scope.
Devang Patel406798a2010-08-09 18:51:29 +00001741 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001742 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel9ccfb642009-12-09 18:24:21 +00001743 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach042483e2009-11-21 23:12:12 +00001744 if (VariableDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001745 ScopeDIE->addChild(VariableDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001746 }
1747
1748 // Add nested scopes.
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001749 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001750 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1751 // Define the Scope debug information entry.
Devang Patel930143b2009-11-21 02:48:08 +00001752 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach042483e2009-11-21 23:12:12 +00001753 if (NestedDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001754 ScopeDIE->addChild(NestedDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001755 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001756
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001757 if (DS.isSubprogram())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001758 addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001759
Devang Patel04d2f2d2009-11-24 01:14:22 +00001760 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001761}
1762
Bill Wendling2b128d72009-05-20 23:19:06 +00001763/// GetOrCreateSourceID - Look up the source id with the given directory and
1764/// source file names. If none currently exists, create a new id and insert it
1765/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1766/// maps as well.
Chris Lattner71696ef2010-03-31 06:06:37 +00001767unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName){
Bill Wendling2b128d72009-05-20 23:19:06 +00001768 unsigned DId;
Devang Patel84a74772010-07-27 20:51:15 +00001769 assert (DirName.empty() == false && "Invalid directory name!");
Devang Patel498877d2010-07-24 00:53:22 +00001770
Bill Wendling2b128d72009-05-20 23:19:06 +00001771 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1772 if (DI != DirectoryIdMap.end()) {
1773 DId = DI->getValue();
1774 } else {
1775 DId = DirectoryNames.size() + 1;
1776 DirectoryIdMap[DirName] = DId;
1777 DirectoryNames.push_back(DirName);
1778 }
1779
1780 unsigned FId;
1781 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1782 if (FI != SourceFileIdMap.end()) {
1783 FId = FI->getValue();
1784 } else {
1785 FId = SourceFileNames.size() + 1;
1786 SourceFileIdMap[FileName] = FId;
1787 SourceFileNames.push_back(FileName);
1788 }
1789
1790 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1791 SourceIdMap.find(std::make_pair(DId, FId));
1792 if (SI != SourceIdMap.end())
1793 return SI->second;
1794
1795 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1796 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1797 SourceIds.push_back(std::make_pair(DId, FId));
1798
1799 return SrcId;
1800}
1801
Devang Patel1f4690c2009-12-15 19:16:48 +00001802/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1803DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001804 CompileUnit *TheCU = getCompileUnit(NS);
1805 DIE *NDie = TheCU->getDIE(NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001806 if (NDie)
1807 return NDie;
1808 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001809 TheCU->insertDIE(NS, NDie);
Devang Patel1f4690c2009-12-15 19:16:48 +00001810 if (!NS.getName().empty())
1811 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
Devang Patelb6511a32010-08-09 20:20:05 +00001812 addSourceLine(NDie, NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001813 addToContextOwner(NDie, NS.getContext());
1814 return NDie;
1815}
1816
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001817/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel1a0df9a2010-05-10 22:49:55 +00001818/// metadata node with tag DW_TAG_compile_unit.
Devang Patel32cc43c2010-05-07 20:54:48 +00001819void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001820 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +00001821 StringRef FN = DIUnit.getFilename();
1822 StringRef Dir = DIUnit.getDirectory();
Devang Patelb2969422009-09-29 18:40:58 +00001823 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendling2b128d72009-05-20 23:19:06 +00001824
1825 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel930143b2009-11-21 02:48:08 +00001826 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patelb2969422009-09-29 18:40:58 +00001827 DIUnit.getProducer());
Devang Patel930143b2009-11-21 02:48:08 +00001828 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendling2b128d72009-05-20 23:19:06 +00001829 DIUnit.getLanguage());
Devang Patel930143b2009-11-21 02:48:08 +00001830 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patelbd798ce2010-04-26 22:54:28 +00001831 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1832 // simplifies debug range entries.
Devang Patel1de21ec2010-06-28 22:22:47 +00001833 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Pateld22ed622010-03-22 23:11:36 +00001834 // DW_AT_stmt_list is a offset of line number information for this
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001835 // compile unit in debug_line section. This offset is calculated
Devang Patel24bc1b52010-06-29 20:17:53 +00001836 // during endMoudle().
1837 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00001838
Devang Patel2d9caf92009-11-25 17:36:49 +00001839 if (!Dir.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001840 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +00001841 if (DIUnit.isOptimized())
Devang Patel930143b2009-11-21 02:48:08 +00001842 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendling2b128d72009-05-20 23:19:06 +00001843
Devang Patel2d9caf92009-11-25 17:36:49 +00001844 StringRef Flags = DIUnit.getFlags();
1845 if (!Flags.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001846 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendling2b128d72009-05-20 23:19:06 +00001847
1848 unsigned RVer = DIUnit.getRunTimeVersion();
1849 if (RVer)
Devang Patel930143b2009-11-21 02:48:08 +00001850 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +00001851 dwarf::DW_FORM_data1, RVer);
1852
Devang Patel1a0df9a2010-05-10 22:49:55 +00001853 CompileUnit *NewCU = new CompileUnit(ID, Die);
1854 if (!FirstCU)
1855 FirstCU = NewCU;
1856 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendling2b128d72009-05-20 23:19:06 +00001857}
1858
Devang Patel1a0df9a2010-05-10 22:49:55 +00001859/// getCompielUnit - Get CompileUnit DIE.
1860CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1861 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1862 DIDescriptor D(N);
1863 const MDNode *CUNode = NULL;
1864 if (D.isCompileUnit())
1865 CUNode = N;
1866 else if (D.isSubprogram())
1867 CUNode = DISubprogram(N).getCompileUnit();
1868 else if (D.isType())
1869 CUNode = DIType(N).getCompileUnit();
1870 else if (D.isGlobalVariable())
1871 CUNode = DIGlobalVariable(N).getCompileUnit();
1872 else if (D.isVariable())
1873 CUNode = DIVariable(N).getCompileUnit();
1874 else if (D.isNameSpace())
1875 CUNode = DINameSpace(N).getCompileUnit();
1876 else if (D.isFile())
1877 CUNode = DIFile(N).getCompileUnit();
1878 else
1879 return FirstCU;
1880
1881 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1882 = CUMap.find(CUNode);
1883 if (I == CUMap.end())
1884 return FirstCU;
1885 return I->second;
1886}
1887
1888
1889/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00001890void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001891 DIGlobalVariable DI_GV(N);
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001892
Devang Patelf5d53602009-09-04 23:59:07 +00001893 // If debug information is malformed then ignore it.
1894 if (DI_GV.Verify() == false)
1895 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001896
1897 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001898 CompileUnit *TheCU = getCompileUnit(N);
1899 if (TheCU->getDIE(DI_GV))
Devang Patel0751a282009-06-26 01:49:18 +00001900 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001901
Devang Patel9ccfb642009-12-09 18:24:21 +00001902 DIE *VariableDie = createGlobalVariableDIE(DI_GV);
Devang Patel2eec32d2009-12-10 23:25:41 +00001903 if (!VariableDie)
1904 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001905
Bill Wendling2b128d72009-05-20 23:19:06 +00001906 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001907 TheCU->insertDIE(N, VariableDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00001908
1909 // Add to context owner.
Devang Patel89880c82010-01-15 01:12:22 +00001910 DIDescriptor GVContext = DI_GV.getContext();
1911 // Do not create specification DIE if context is either compile unit
1912 // or a subprogram.
Chris Lattner71696ef2010-03-31 06:06:37 +00001913 if (DI_GV.isDefinition() && !GVContext.isCompileUnit() &&
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001914 !GVContext.isFile() &&
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001915 !isSubprogramContext(GVContext)) {
Devang Patel1f4690c2009-12-15 19:16:48 +00001916 // Create specification DIE.
1917 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1918 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1919 dwarf::DW_FORM_ref4, VariableDie);
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001920 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel1f4690c2009-12-15 19:16:48 +00001921 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
Chris Lattner8dcf41e2010-03-08 22:31:46 +00001922 addLabel(Block, 0, dwarf::DW_FORM_udata,
Chris Lattner9e4cafe2010-03-12 21:09:07 +00001923 Asm->Mang->getSymbol(DI_GV.getGlobal()));
Devang Patel1f4690c2009-12-15 19:16:48 +00001924 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
Devang Patelce25dd72010-02-09 01:58:33 +00001925 addUInt(VariableDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001926 TheCU->addDie(VariableSpecDIE);
Devang Patel1f4690c2009-12-15 19:16:48 +00001927 } else {
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001928 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel1f4690c2009-12-15 19:16:48 +00001929 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
Chris Lattner8dcf41e2010-03-08 22:31:46 +00001930 addLabel(Block, 0, dwarf::DW_FORM_udata,
Chris Lattner9e4cafe2010-03-12 21:09:07 +00001931 Asm->Mang->getSymbol(DI_GV.getGlobal()));
Devang Patel1f4690c2009-12-15 19:16:48 +00001932 addBlock(VariableDie, dwarf::DW_AT_location, 0, Block);
1933 }
Devang Patel89880c82010-01-15 01:12:22 +00001934 addToContextOwner(VariableDie, GVContext);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001935
Bill Wendling2b128d72009-05-20 23:19:06 +00001936 // Expose as global. FIXME - need to check external flag.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001937 TheCU->addGlobal(DI_GV.getName(), VariableDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00001938
1939 DIType GTy = DI_GV.getType();
Devang Patel12d150e2010-04-13 20:35:04 +00001940 if (GTy.isCompositeType() && !GTy.getName().empty()
1941 && !GTy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001942 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001943 assert(Entry && "Missing global type!");
Devang Patel1a0df9a2010-05-10 22:49:55 +00001944 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00001945 }
Devang Patel0751a282009-06-26 01:49:18 +00001946 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001947}
1948
Devang Patel1a0df9a2010-05-10 22:49:55 +00001949/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00001950void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001951 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +00001952
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00001953 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001954 CompileUnit *TheCU = getCompileUnit(N);
1955 if (TheCU->getDIE(N))
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00001956 return;
1957
Bill Wendling2b128d72009-05-20 23:19:06 +00001958 if (!SP.isDefinition())
1959 // This is a method declaration which will be handled while constructing
1960 // class type.
Devang Patel0751a282009-06-26 01:49:18 +00001961 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001962
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00001963 DIE *SubprogramDie = createSubprogramDIE(SP);
1964
1965 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001966 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00001967
1968 // Add to context owner.
Devang Patel1f4690c2009-12-15 19:16:48 +00001969 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +00001970
Bill Wendling2b128d72009-05-20 23:19:06 +00001971 // Expose as global.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001972 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00001973
Devang Patel0751a282009-06-26 01:49:18 +00001974 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001975}
1976
Devang Patel930143b2009-11-21 02:48:08 +00001977/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbarbe22ec42009-09-19 20:40:14 +00001978/// content. Create global DIEs and emit initial debug info sections.
1979/// This is inovked by the target AsmPrinter.
Chris Lattner11980022010-04-04 07:48:20 +00001980void DwarfDebug::beginModule(Module *M) {
Devang Patel6c74a872010-04-27 19:46:33 +00001981 if (DisableDebugInfoPrinting)
1982 return;
1983
Devang Patel63524442009-07-30 18:56:46 +00001984 DebugInfoFinder DbgFinder;
1985 DbgFinder.processModule(*M);
Devang Patel0751a282009-06-26 01:49:18 +00001986
Chris Lattner7cfa70e2010-04-05 02:19:28 +00001987 bool HasDebugInfo = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001988
Chris Lattner7cfa70e2010-04-05 02:19:28 +00001989 // Scan all the compile-units to see if there are any marked as the main unit.
1990 // if not, we do not generate debug info.
1991 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1992 E = DbgFinder.compile_unit_end(); I != E; ++I) {
1993 if (DICompileUnit(*I).isMain()) {
1994 HasDebugInfo = true;
1995 break;
1996 }
1997 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001998
Chris Lattner7cfa70e2010-04-05 02:19:28 +00001999 if (!HasDebugInfo) return;
2000
2001 // Tell MMI that we have debug info.
2002 MMI->setDebugInfoAvailability(true);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002003
Chris Lattnerd442aa32010-04-04 23:17:54 +00002004 // Emit initial sections.
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002005 EmitSectionLabels();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002006
Bill Wendling2b128d72009-05-20 23:19:06 +00002007 // Create all the compile unit DIEs.
Devang Patel63524442009-07-30 18:56:46 +00002008 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2009 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002010 constructCompileUnit(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002011
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002012 // Create DIEs for each subprogram.
Devang Patel63524442009-07-30 18:56:46 +00002013 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
2014 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002015 constructSubprogramDIE(*I);
Devang Patel0751a282009-06-26 01:49:18 +00002016
Devang Patel2b75ed22009-12-10 19:14:49 +00002017 // Create DIEs for each global variable.
2018 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2019 E = DbgFinder.global_variable_end(); I != E; ++I)
2020 constructGlobalVariableDIE(*I);
2021
Bill Wendling2b128d72009-05-20 23:19:06 +00002022 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +00002023 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +00002024
2025 // Print out .file directives to specify files for .loc directives. These are
2026 // printed out early so that they precede any .loc directives.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002027 if (Asm->MAI->hasDotLocAndDotFile()) {
Bill Wendling2b128d72009-05-20 23:19:06 +00002028 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
2029 // Remember source id starts at 1.
2030 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002031 // FIXME: don't use sys::path for this! This should not depend on the
2032 // host.
Bill Wendling2b128d72009-05-20 23:19:06 +00002033 sys::Path FullPath(getSourceDirectoryName(Id.first));
2034 bool AppendOk =
2035 FullPath.appendComponent(getSourceFileName(Id.second));
2036 assert(AppendOk && "Could not append filename to directory!");
2037 AppendOk = false;
Chris Lattner601ef332010-01-25 18:58:59 +00002038 Asm->OutStreamer.EmitDwarfFileDirective(i, FullPath.str());
Bill Wendling2b128d72009-05-20 23:19:06 +00002039 }
2040 }
Bill Wendling2b128d72009-05-20 23:19:06 +00002041}
2042
Devang Patel930143b2009-11-21 02:48:08 +00002043/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendling2b128d72009-05-20 23:19:06 +00002044///
Devang Patel930143b2009-11-21 02:48:08 +00002045void DwarfDebug::endModule() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002046 if (!FirstCU) return;
Devang Patelf3b2db62010-06-28 18:25:03 +00002047 const Module *M = MMI->getModule();
Devang Pateld0701282010-08-02 17:32:15 +00002048 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patelf3b2db62010-06-28 18:25:03 +00002049 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2050 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2051 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2052 DISubprogram SP(AllSPs->getOperand(SI));
2053 if (!SP.Verify()) continue;
2054
2055 // Collect info for variables that were optimized out.
Devang Patel18efced2010-07-19 17:53:55 +00002056 if (!SP.isDefinition()) continue;
Devang Patelf3b2db62010-06-28 18:25:03 +00002057 StringRef FName = SP.getLinkageName();
2058 if (FName.empty())
2059 FName = SP.getName();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002060 NamedMDNode *NMD =
Devang Patelf3b2db62010-06-28 18:25:03 +00002061 M->getNamedMetadata(Twine("llvm.dbg.lv.", getRealLinkageName(FName)));
2062 if (!NMD) continue;
2063 unsigned E = NMD->getNumOperands();
2064 if (!E) continue;
2065 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Pateld0701282010-08-02 17:32:15 +00002066 DeadFnScopeMap[SP] = Scope;
Devang Patelf3b2db62010-06-28 18:25:03 +00002067 for (unsigned I = 0; I != E; ++I) {
2068 DIVariable DV(NMD->getOperand(I));
2069 if (!DV.Verify()) continue;
2070 Scope->addVariable(new DbgVariable(DV));
2071 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002072
Devang Patelf3b2db62010-06-28 18:25:03 +00002073 // Construct subprogram DIE and add variables DIEs.
2074 constructSubprogramDIE(SP);
2075 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patel406798a2010-08-09 18:51:29 +00002076 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf3b2db62010-06-28 18:25:03 +00002077 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2078 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2079 if (VariableDIE)
2080 ScopeDIE->addChild(VariableDIE);
2081 }
2082 }
2083 }
Bill Wendling2b128d72009-05-20 23:19:06 +00002084
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002085 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2086 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2087 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2088 DIE *ISP = *AI;
Devang Patel930143b2009-11-21 02:48:08 +00002089 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002090 }
2091
Devang Patel32cc43c2010-05-07 20:54:48 +00002092 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Pateleb57c592009-12-03 19:11:07 +00002093 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2094 DIE *SPDie = CI->first;
Devang Patel32cc43c2010-05-07 20:54:48 +00002095 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Pateleb57c592009-12-03 19:11:07 +00002096 if (!N) continue;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002097 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Pateleb57c592009-12-03 19:11:07 +00002098 if (!NDie) continue;
2099 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Pateleb57c592009-12-03 19:11:07 +00002100 }
2101
Bill Wendling2b128d72009-05-20 23:19:06 +00002102 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002103 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002104 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002105 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002106 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +00002107
2108 // End text sections.
2109 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002110 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnera179b522010-04-04 19:25:43 +00002111 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendling2b128d72009-05-20 23:19:06 +00002112 }
2113
2114 // Emit common frame information.
Devang Patel930143b2009-11-21 02:48:08 +00002115 emitCommonDebugFrame();
Bill Wendling2b128d72009-05-20 23:19:06 +00002116
2117 // Emit function debug frame information
2118 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2119 E = DebugFrames.end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002120 emitFunctionDebugFrame(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002121
2122 // Compute DIE offsets and sizes.
Devang Patel930143b2009-11-21 02:48:08 +00002123 computeSizeAndOffsets();
Bill Wendling2b128d72009-05-20 23:19:06 +00002124
Devang Patel24bc1b52010-06-29 20:17:53 +00002125 // Emit source line correspondence into a debug line section.
2126 emitDebugLines();
2127
Bill Wendling2b128d72009-05-20 23:19:06 +00002128 // Emit all the DIEs into a debug info section
Devang Patel930143b2009-11-21 02:48:08 +00002129 emitDebugInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002130
2131 // Corresponding abbreviations into a abbrev section.
Devang Patel930143b2009-11-21 02:48:08 +00002132 emitAbbreviations();
Bill Wendling2b128d72009-05-20 23:19:06 +00002133
Bill Wendling2b128d72009-05-20 23:19:06 +00002134 // Emit info into a debug pubnames section.
Devang Patel930143b2009-11-21 02:48:08 +00002135 emitDebugPubNames();
Bill Wendling2b128d72009-05-20 23:19:06 +00002136
Devang Patel04d2f2d2009-11-24 01:14:22 +00002137 // Emit info into a debug pubtypes section.
2138 emitDebugPubTypes();
2139
Bill Wendling2b128d72009-05-20 23:19:06 +00002140 // Emit info into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002141 emitDebugLoc();
Bill Wendling2b128d72009-05-20 23:19:06 +00002142
2143 // Emit info into a debug aranges section.
2144 EmitDebugARanges();
2145
2146 // Emit info into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002147 emitDebugRanges();
Bill Wendling2b128d72009-05-20 23:19:06 +00002148
2149 // Emit info into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002150 emitDebugMacInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002151
2152 // Emit inline info.
Devang Patel930143b2009-11-21 02:48:08 +00002153 emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002154
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002155 // Emit info into a debug str section.
2156 emitDebugStr();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002157
Devang Pateld0701282010-08-02 17:32:15 +00002158 // clean up.
2159 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002160 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2161 E = CUMap.end(); I != E; ++I)
2162 delete I->second;
2163 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendling2b128d72009-05-20 23:19:06 +00002164}
2165
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002166/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002167DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattner915c5f92010-04-02 19:42:39 +00002168 DebugLoc ScopeLoc) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002169
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002170 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002171 if (AbsDbgVariable)
2172 return AbsDbgVariable;
2173
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002174 LLVMContext &Ctx = Var->getContext();
Chris Lattner915c5f92010-04-02 19:42:39 +00002175 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002176 if (!Scope)
2177 return NULL;
2178
Devang Patele1c53f22010-05-20 16:36:41 +00002179 AbsDbgVariable = new DbgVariable(Var);
Devang Patel930143b2009-11-21 02:48:08 +00002180 Scope->addVariable(AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002181 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002182 return AbsDbgVariable;
2183}
2184
Devang Patel490c8ab2010-05-20 19:57:06 +00002185/// collectVariableInfoFromMMITable - Collect variable information from
2186/// side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002187void
Devang Patel490c8ab2010-05-20 19:57:06 +00002188DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2189 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00002190 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patel475d32a2009-10-06 01:26:37 +00002191 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2192 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2193 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00002194 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002195 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00002196 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00002197 DIVariable DV(Var);
2198 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002199
Chris Lattner915c5f92010-04-02 19:42:39 +00002200 DbgScope *Scope = 0;
Devang Patel32cc43c2010-05-07 20:54:48 +00002201 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattner915c5f92010-04-02 19:42:39 +00002202 Scope = ConcreteScopes.lookup(IA);
2203 if (Scope == 0)
2204 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002205
Devang Patelcdb7d442009-11-10 23:20:04 +00002206 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00002207 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00002208 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002209
Devang Patele1c53f22010-05-20 16:36:41 +00002210 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2211 DbgVariable *RegVar = new DbgVariable(DV);
2212 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel930143b2009-11-21 02:48:08 +00002213 Scope->addVariable(RegVar);
Devang Patele1c53f22010-05-20 16:36:41 +00002214 if (AbsDbgVariable) {
2215 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2216 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2217 }
Devang Patel475d32a2009-10-06 01:26:37 +00002218 }
Devang Patel490c8ab2010-05-20 19:57:06 +00002219}
Devang Patela3e9c9c2010-03-15 18:33:46 +00002220
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002221/// isDbgValueInUndefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +00002222/// DBG_VALUE instruction, is in undefined reg.
2223static bool isDbgValueInUndefinedReg(const MachineInstr *MI) {
2224 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2225 if (MI->getOperand(0).isReg() && !MI->getOperand(0).getReg())
2226 return true;
2227 return false;
2228}
2229
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002230/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +00002231/// DBG_VALUE instruction, is in a defined reg.
2232static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2233 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2234 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2235 return true;
2236 return false;
2237}
2238
Devang Patel490c8ab2010-05-20 19:57:06 +00002239/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002240void
Devang Patel5c0f85c2010-06-25 22:07:34 +00002241DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2242 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002243
Devang Patel490c8ab2010-05-20 19:57:06 +00002244 /// collection info from MMI table.
2245 collectVariableInfoFromMMITable(MF, Processed);
2246
2247 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002248 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002249 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel490c8ab2010-05-20 19:57:06 +00002250 I != E; ++I)
Devang Patela3e9c9c2010-03-15 18:33:46 +00002251 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2252 II != IE; ++II) {
2253 const MachineInstr *MInsn = II;
Devang Patel9fc11702010-05-25 23:40:22 +00002254 if (!MInsn->isDebugValue() || isDbgValueInUndefinedReg(MInsn))
Devang Patela3e9c9c2010-03-15 18:33:46 +00002255 continue;
Devang Patel490c8ab2010-05-20 19:57:06 +00002256 DbgValues.push_back(MInsn);
2257 }
Devang Patela3e9c9c2010-03-15 18:33:46 +00002258
Devang Patel9fc11702010-05-25 23:40:22 +00002259 // This is a collection of DBV_VALUE instructions describing same variable.
2260 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patel490c8ab2010-05-20 19:57:06 +00002261 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2262 E = DbgValues.end(); I != E; ++I) {
2263 const MachineInstr *MInsn = *I;
Devang Patel9fc11702010-05-25 23:40:22 +00002264 MultipleValues.clear();
2265 if (isDbgValueInDefinedReg(MInsn))
2266 MultipleValues.push_back(MInsn);
Devang Patel490c8ab2010-05-20 19:57:06 +00002267 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2268 if (Processed.count(DV) != 0)
2269 continue;
2270
Devang Patelc2254f62010-06-02 19:05:13 +00002271 const MachineInstr *PrevMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002272 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
Devang Patel9fc11702010-05-25 23:40:22 +00002273 ME = DbgValues.end(); MI != ME; ++MI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002274 const MDNode *Var =
Devang Patel9fc11702010-05-25 23:40:22 +00002275 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002276 if (Var == DV && isDbgValueInDefinedReg(*MI) &&
Devang Patelc2254f62010-06-02 19:05:13 +00002277 !PrevMI->isIdenticalTo(*MI))
Devang Patel9fc11702010-05-25 23:40:22 +00002278 MultipleValues.push_back(*MI);
Devang Patelc2254f62010-06-02 19:05:13 +00002279 PrevMI = *MI;
Devang Patel9fc11702010-05-25 23:40:22 +00002280 }
2281
Devang Patel490c8ab2010-05-20 19:57:06 +00002282 DbgScope *Scope = findDbgScope(MInsn);
Devang Patel7a9dedf2010-05-27 20:25:04 +00002283 bool CurFnArg = false;
2284 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2285 DISubprogram(DV.getContext()).describes(MF->getFunction()))
2286 CurFnArg = true;
2287 if (!Scope && CurFnArg)
Devang Patelfbd6c452010-05-21 00:10:20 +00002288 Scope = CurrentFnDbgScope;
Devang Patel490c8ab2010-05-20 19:57:06 +00002289 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00002290 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00002291 continue;
2292
2293 Processed.insert(DV);
Devang Patel490c8ab2010-05-20 19:57:06 +00002294 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patel490c8ab2010-05-20 19:57:06 +00002295 Scope->addVariable(RegVar);
Devang Patel7a9dedf2010-05-27 20:25:04 +00002296 if (!CurFnArg)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002297 DbgVariableLabelsMap[RegVar] = getLabelBeforeInsn(MInsn);
Devang Patelfbd6c452010-05-21 00:10:20 +00002298 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2299 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2300 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002301 }
Devang Patel9fc11702010-05-25 23:40:22 +00002302 if (MultipleValues.size() <= 1) {
2303 DbgVariableToDbgInstMap[RegVar] = MInsn;
2304 continue;
2305 }
2306
2307 // handle multiple DBG_VALUE instructions describing one variable.
Devang Patel9fc11702010-05-25 23:40:22 +00002308 if (DotDebugLocEntries.empty())
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002309 RegVar->setDotDebugLocOffset(0);
2310 else
2311 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002312 const MachineInstr *Begin = NULL;
2313 const MachineInstr *End = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002314 for (SmallVector<const MachineInstr *, 4>::iterator
2315 MVI = MultipleValues.begin(), MVE = MultipleValues.end();
Devang Patel30265c42010-07-07 20:12:52 +00002316 MVI != MVE; ++MVI) {
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002317 if (!Begin) {
2318 Begin = *MVI;
2319 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002320 }
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002321 End = *MVI;
Devang Patel9fc11702010-05-25 23:40:22 +00002322 MachineLocation MLoc;
Devang Patel0e60e672010-08-04 18:40:52 +00002323 if (Begin->getNumOperands() == 3) {
2324 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2325 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2326 } else
2327 MLoc = Asm->getDebugValueLocation(Begin);
2328
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002329 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2330 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patel6c378ac2010-08-04 22:07:27 +00002331 if (MLoc.getReg())
2332 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
2333
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002334 Begin = End;
2335 if (MVI + 1 == MVE) {
2336 // If End is the last instruction then its value is valid
Devang Patel9fc11702010-05-25 23:40:22 +00002337 // until the end of the funtion.
Devang Patel0e60e672010-08-04 18:40:52 +00002338 MachineLocation EMLoc;
2339 if (End->getNumOperands() == 3) {
2340 if (End->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2341 EMLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2342 } else
2343 EMLoc = Asm->getDebugValueLocation(End);
Devang Patel6c378ac2010-08-04 22:07:27 +00002344 if (EMLoc.getReg())
2345 DotDebugLocEntries.
2346 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, EMLoc));
Devang Patel9fc11702010-05-25 23:40:22 +00002347 }
2348 }
2349 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00002350 }
Devang Patele0a94bf2010-05-14 21:01:35 +00002351
2352 // Collect info for variables that were optimized out.
Devang Patelad517352010-06-22 01:01:58 +00002353 const Function *F = MF->getFunction();
2354 const Module *M = F->getParent();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002355 if (NamedMDNode *NMD =
2356 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patelb6e058d2010-06-22 01:19:38 +00002357 getRealLinkageName(F->getName())))) {
Devang Patele0a94bf2010-05-14 21:01:35 +00002358 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002359 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel490c8ab2010-05-20 19:57:06 +00002360 if (!DV || !Processed.insert(DV))
Devang Patele0a94bf2010-05-14 21:01:35 +00002361 continue;
2362 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2363 if (Scope)
Devang Patele1c53f22010-05-20 16:36:41 +00002364 Scope->addVariable(new DbgVariable(DV));
Devang Patele0a94bf2010-05-14 21:01:35 +00002365 }
2366 }
Devang Patel9fc11702010-05-25 23:40:22 +00002367}
Devang Patele0a94bf2010-05-14 21:01:35 +00002368
Devang Patel9fc11702010-05-25 23:40:22 +00002369/// getLabelBeforeInsn - Return Label preceding the instruction.
2370const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2371 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2372 LabelsBeforeInsn.find(MI);
2373 if (I == LabelsBeforeInsn.end())
2374 // FunctionBeginSym always preceeds all the instruction in current function.
2375 return FunctionBeginSym;
2376 return I->second;
2377}
2378
2379/// getLabelAfterInsn - Return Label immediately following the instruction.
2380const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2381 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2382 LabelsAfterInsn.find(MI);
2383 if (I == LabelsAfterInsn.end())
2384 return NULL;
2385 return I->second;
Devang Patel475d32a2009-10-06 01:26:37 +00002386}
2387
Devang Patelbd477be2010-03-29 17:20:31 +00002388/// beginScope - Process beginning of a scope.
2389void DwarfDebug::beginScope(const MachineInstr *MI) {
Devang Patel002d54d2010-05-26 19:37:24 +00002390 if (InsnNeedsLabel.count(MI) == 0) {
2391 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patelbd477be2010-03-29 17:20:31 +00002392 return;
Devang Patel9fc11702010-05-25 23:40:22 +00002393 }
Devang Patel23b2ae62010-03-29 22:59:58 +00002394
Devang Patel002d54d2010-05-26 19:37:24 +00002395 // Check location.
2396 DebugLoc DL = MI->getDebugLoc();
2397 if (!DL.isUnknown()) {
2398 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2399 PrevLabel = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
Devang Patel6c74a872010-04-27 19:46:33 +00002400 PrevInstLoc = DL;
Devang Patel002d54d2010-05-26 19:37:24 +00002401 LabelsBeforeInsn[MI] = PrevLabel;
2402 return;
Devang Patel6c74a872010-04-27 19:46:33 +00002403 }
Devang Patelbd477be2010-03-29 17:20:31 +00002404
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002405 // If location is unknown then use temp label for this DBG_VALUE
Devang Patel002d54d2010-05-26 19:37:24 +00002406 // instruction.
2407 if (MI->isDebugValue()) {
Devang Patelacc32a52010-05-26 21:23:46 +00002408 PrevLabel = MMI->getContext().CreateTempSymbol();
2409 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00002410 LabelsBeforeInsn[MI] = PrevLabel;
2411 return;
2412 }
2413
2414 if (UnknownLocations) {
2415 PrevLabel = recordSourceLine(0, 0, 0);
2416 LabelsBeforeInsn[MI] = PrevLabel;
2417 return;
2418 }
2419
2420 assert (0 && "Instruction is not processed!");
Devang Patel8db360d2009-10-06 01:50:42 +00002421}
2422
Devang Patel930143b2009-11-21 02:48:08 +00002423/// endScope - Process end of a scope.
2424void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel3ebd8932010-04-08 16:50:29 +00002425 if (InsnsEndScopeSet.count(MI) != 0) {
2426 // Emit a label if this instruction ends a scope.
2427 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2428 Asm->OutStreamer.EmitLabel(Label);
Devang Patel6c74a872010-04-27 19:46:33 +00002429 LabelsAfterInsn[MI] = Label;
Devang Patel3ebd8932010-04-08 16:50:29 +00002430 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002431}
2432
Devang Patel6c74a872010-04-27 19:46:33 +00002433/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002434DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel30265c42010-07-07 20:12:52 +00002435 const MDNode *InlinedAt) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002436 if (!InlinedAt) {
2437 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2438 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002439 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002440 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2441 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Patel6c74a872010-04-27 19:46:33 +00002442 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002443 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002444 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Patel6c74a872010-04-27 19:46:33 +00002445 WScope->setParent(Parent);
2446 Parent->addScope(WScope);
2447 }
2448
2449 if (!WScope->getParent()) {
2450 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastings9b5005c2010-06-15 23:06:30 +00002451 // We used to check only for a linkage name, but that fails
2452 // since we began omitting the linkage name for private
2453 // functions. The new way is to check for the name in metadata,
2454 // but that's not supported in old .ll test cases. Ergo, we
2455 // check both.
Stuart Hastingsafe54f12010-06-11 20:08:44 +00002456 if (SPName == Asm->MF->getFunction()->getName() ||
2457 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Patel6c74a872010-04-27 19:46:33 +00002458 CurrentFnDbgScope = WScope;
2459 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002460
Devang Patel6c74a872010-04-27 19:46:33 +00002461 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002462 }
2463
Devang Patel5c0f85c2010-06-25 22:07:34 +00002464 getOrCreateAbstractScope(Scope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002465 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2466 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002467 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002468
2469 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2470 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2471 DILocation DL(InlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002472 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002473 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Patel6c74a872010-04-27 19:46:33 +00002474 WScope->setParent(Parent);
2475 Parent->addScope(WScope);
2476
2477 ConcreteScopes[InlinedAt] = WScope;
Devang Patel6c74a872010-04-27 19:46:33 +00002478
2479 return WScope;
Devang Patel8db360d2009-10-06 01:50:42 +00002480}
2481
Devang Patel6c74a872010-04-27 19:46:33 +00002482/// hasValidLocation - Return true if debug location entry attached with
2483/// machine instruction encodes valid location info.
2484static bool hasValidLocation(LLVMContext &Ctx,
2485 const MachineInstr *MInsn,
Devang Patel32cc43c2010-05-07 20:54:48 +00002486 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Patel6c74a872010-04-27 19:46:33 +00002487 DebugLoc DL = MInsn->getDebugLoc();
2488 if (DL.isUnknown()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002489
Devang Patel32cc43c2010-05-07 20:54:48 +00002490 const MDNode *S = DL.getScope(Ctx);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002491
Devang Patel6c74a872010-04-27 19:46:33 +00002492 // There is no need to create another DIE for compile unit. For all
2493 // other scopes, create one DbgScope now. This will be translated
2494 // into a scope DIE at the end.
2495 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002496
Devang Patel6c74a872010-04-27 19:46:33 +00002497 Scope = S;
2498 InlinedAt = DL.getInlinedAt(Ctx);
2499 return true;
2500}
2501
2502/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2503/// hierarchy.
2504static void calculateDominanceGraph(DbgScope *Scope) {
2505 assert (Scope && "Unable to calculate scop edominance graph!");
2506 SmallVector<DbgScope *, 4> WorkStack;
2507 WorkStack.push_back(Scope);
2508 unsigned Counter = 0;
2509 while (!WorkStack.empty()) {
2510 DbgScope *WS = WorkStack.back();
2511 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2512 bool visitedChildren = false;
2513 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2514 SE = Children.end(); SI != SE; ++SI) {
2515 DbgScope *ChildScope = *SI;
2516 if (!ChildScope->getDFSOut()) {
2517 WorkStack.push_back(ChildScope);
2518 visitedChildren = true;
2519 ChildScope->setDFSIn(++Counter);
2520 break;
2521 }
2522 }
2523 if (!visitedChildren) {
2524 WorkStack.pop_back();
2525 WS->setDFSOut(++Counter);
2526 }
2527 }
2528}
2529
2530/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002531static
Devang Patel6c74a872010-04-27 19:46:33 +00002532void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2533 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2534{
2535#ifndef NDEBUG
2536 unsigned PrevDFSIn = 0;
2537 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2538 I != E; ++I) {
2539 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2540 II != IE; ++II) {
2541 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002542 const MDNode *Scope = NULL;
2543 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002544
2545 // Check if instruction has valid location information.
2546 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2547 dbgs() << " [ ";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002548 if (InlinedAt)
Devang Patel6c74a872010-04-27 19:46:33 +00002549 dbgs() << "*";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002550 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Patel6c74a872010-04-27 19:46:33 +00002551 MI2ScopeMap.find(MInsn);
2552 if (DI != MI2ScopeMap.end()) {
2553 DbgScope *S = DI->second;
2554 dbgs() << S->getDFSIn();
2555 PrevDFSIn = S->getDFSIn();
2556 } else
2557 dbgs() << PrevDFSIn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002558 } else
Devang Patel6c74a872010-04-27 19:46:33 +00002559 dbgs() << " [ x" << PrevDFSIn;
2560 dbgs() << " ]";
2561 MInsn->dump();
2562 }
2563 dbgs() << "\n";
2564 }
2565#endif
2566}
Devang Patel930143b2009-11-21 02:48:08 +00002567/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner848c7d22010-03-31 05:39:57 +00002568/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattner76555b52010-01-26 23:18:02 +00002569bool DwarfDebug::extractScopeInformation() {
Devang Patel75cc16c2009-10-01 20:31:14 +00002570 // If scope information was extracted using .dbg intrinsics then there is not
2571 // any need to extract these information by scanning each instruction.
2572 if (!DbgScopeMap.empty())
2573 return false;
2574
Dan Gohmane9135cb2010-04-23 01:18:53 +00002575 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patel6c74a872010-04-27 19:46:33 +00002576 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2577 SmallVector<DbgRange, 4> MIRanges;
2578 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patel32cc43c2010-05-07 20:54:48 +00002579 const MDNode *PrevScope = NULL;
2580 const MDNode *PrevInlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002581 const MachineInstr *RangeBeginMI = NULL;
2582 const MachineInstr *PrevMI = NULL;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002583 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel75cc16c2009-10-01 20:31:14 +00002584 I != E; ++I) {
2585 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2586 II != IE; ++II) {
2587 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002588 const MDNode *Scope = NULL;
2589 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002590
2591 // Check if instruction has valid location information.
2592 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2593 PrevMI = MInsn;
2594 continue;
2595 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002596
Devang Patel6c74a872010-04-27 19:46:33 +00002597 // If scope has not changed then skip this instruction.
2598 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2599 PrevMI = MInsn;
2600 continue;
2601 }
2602
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002603 if (RangeBeginMI) {
2604 // If we have alread seen a beginning of a instruction range and
Devang Patel6c74a872010-04-27 19:46:33 +00002605 // current instruction scope does not match scope of first instruction
2606 // in this range then create a new instruction range.
2607 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002608 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel30265c42010-07-07 20:12:52 +00002609 PrevInlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002610 MIRanges.push_back(R);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002611 }
Devang Patel6c74a872010-04-27 19:46:33 +00002612
2613 // This is a beginning of a new instruction range.
2614 RangeBeginMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002615
Devang Patel6c74a872010-04-27 19:46:33 +00002616 // Reset previous markers.
2617 PrevMI = MInsn;
2618 PrevScope = Scope;
2619 PrevInlinedAt = InlinedAt;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002620 }
2621 }
2622
Devang Patel6c74a872010-04-27 19:46:33 +00002623 // Create last instruction range.
2624 if (RangeBeginMI && PrevMI && PrevScope) {
2625 DbgRange R(RangeBeginMI, PrevMI);
2626 MIRanges.push_back(R);
2627 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patel75cc16c2009-10-01 20:31:14 +00002628 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002629
Devang Patel530a0752010-01-04 20:44:00 +00002630 if (!CurrentFnDbgScope)
2631 return false;
2632
Devang Patel6c74a872010-04-27 19:46:33 +00002633 calculateDominanceGraph(CurrentFnDbgScope);
2634 if (PrintDbgScope)
2635 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2636
2637 // Find ranges of instructions covered by each DbgScope;
2638 DbgScope *PrevDbgScope = NULL;
2639 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2640 RE = MIRanges.end(); RI != RE; ++RI) {
2641 const DbgRange &R = *RI;
2642 DbgScope *S = MI2ScopeMap.lookup(R.first);
2643 assert (S && "Lost DbgScope for a machine instruction!");
2644 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2645 PrevDbgScope->closeInsnRange(S);
2646 S->openInsnRange(R.first);
2647 S->extendInsnRange(R.second);
2648 PrevDbgScope = S;
2649 }
2650
2651 if (PrevDbgScope)
2652 PrevDbgScope->closeInsnRange();
Devang Patel75cc16c2009-10-01 20:31:14 +00002653
Devang Patel359b0132010-04-08 18:43:56 +00002654 identifyScopeMarkers();
Devang Patelf1d5a1e2010-04-08 15:37:09 +00002655
2656 return !DbgScopeMap.empty();
2657}
2658
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002659/// identifyScopeMarkers() -
Devang Patel6c74a872010-04-27 19:46:33 +00002660/// Each DbgScope has first instruction and last instruction to mark beginning
2661/// and end of a scope respectively. Create an inverse map that list scopes
2662/// starts (and ends) with an instruction. One instruction may start (or end)
2663/// multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00002664void DwarfDebug::identifyScopeMarkers() {
Devang Patel7771b7c2010-01-20 02:05:23 +00002665 SmallVector<DbgScope *, 4> WorkList;
2666 WorkList.push_back(CurrentFnDbgScope);
2667 while (!WorkList.empty()) {
Chris Lattner848c7d22010-03-31 05:39:57 +00002668 DbgScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002669
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002670 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002671 if (!Children.empty())
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002672 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00002673 SE = Children.end(); SI != SE; ++SI)
2674 WorkList.push_back(*SI);
2675
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002676 if (S->isAbstractScope())
2677 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002678
Devang Patel6c74a872010-04-27 19:46:33 +00002679 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2680 if (Ranges.empty())
2681 continue;
2682 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2683 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002684 assert(RI->first && "DbgRange does not have first instruction!");
2685 assert(RI->second && "DbgRange does not have second instruction!");
Devang Patel6c74a872010-04-27 19:46:33 +00002686 InsnsEndScopeSet.insert(RI->second);
2687 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002688 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002689}
2690
Dan Gohman3df671a2010-04-20 00:37:27 +00002691/// FindFirstDebugLoc - Find the first debug location in the function. This
2692/// is intended to be an approximation for the source position of the
2693/// beginning of the function.
2694static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2695 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2696 I != E; ++I)
2697 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2698 MBBI != MBBE; ++MBBI) {
2699 DebugLoc DL = MBBI->getDebugLoc();
2700 if (!DL.isUnknown())
2701 return DL;
2702 }
2703 return DebugLoc();
2704}
2705
Devang Patel930143b2009-11-21 02:48:08 +00002706/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendling2b128d72009-05-20 23:19:06 +00002707/// emitted immediately after the function entry point.
Chris Lattner76555b52010-01-26 23:18:02 +00002708void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00002709 if (!MMI->hasDebugInfo()) return;
Bill Wendlingfcc14142010-04-07 09:28:04 +00002710 if (!extractScopeInformation()) return;
Devang Patel4598eb62009-10-06 18:37:31 +00002711
Devang Patel6c74a872010-04-27 19:46:33 +00002712 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2713 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00002714 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00002715 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00002716
2717 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2718 // function.
Dan Gohman3df671a2010-04-20 00:37:27 +00002719 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattner915c5f92010-04-02 19:42:39 +00002720 if (FDL.isUnknown()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002721
Devang Patel32cc43c2010-05-07 20:54:48 +00002722 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings61475c52010-07-19 23:56:30 +00002723 const MDNode *TheScope = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002724
Chris Lattner915c5f92010-04-02 19:42:39 +00002725 DISubprogram SP = getDISubprogram(Scope);
2726 unsigned Line, Col;
2727 if (SP.Verify()) {
2728 Line = SP.getLineNumber();
2729 Col = 0;
Stuart Hastings61475c52010-07-19 23:56:30 +00002730 TheScope = SP;
Chris Lattner915c5f92010-04-02 19:42:39 +00002731 } else {
2732 Line = FDL.getLine();
2733 Col = FDL.getCol();
Stuart Hastings61475c52010-07-19 23:56:30 +00002734 TheScope = Scope;
Bill Wendling2b128d72009-05-20 23:19:06 +00002735 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002736
Stuart Hastings61475c52010-07-19 23:56:30 +00002737 recordSourceLine(Line, Col, TheScope);
Devang Patel002d54d2010-05-26 19:37:24 +00002738
Devang Patel21ccf052010-06-02 16:42:51 +00002739 /// ProcessedArgs - Collection of arguments already processed.
2740 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2741
Devang Patel002d54d2010-05-26 19:37:24 +00002742 DebugLoc PrevLoc;
2743 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2744 I != E; ++I)
2745 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2746 II != IE; ++II) {
2747 const MachineInstr *MI = II;
2748 DebugLoc DL = MI->getDebugLoc();
2749 if (MI->isDebugValue()) {
Devang Patel002d54d2010-05-26 19:37:24 +00002750 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2751 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2752 if (!DV.Verify()) continue;
Devang Patel5e6b71c2010-05-27 16:47:30 +00002753 // If DBG_VALUE is for a local variable then it needs a label.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002754 if (DV.getTag() != dwarf::DW_TAG_arg_variable
Devang Patel42939752010-07-01 21:38:08 +00002755 && isDbgValueInUndefinedReg(MI) == false)
Devang Patel002d54d2010-05-26 19:37:24 +00002756 InsnNeedsLabel.insert(MI);
Devang Patel5e6b71c2010-05-27 16:47:30 +00002757 // DBG_VALUE for inlined functions argument needs a label.
Devang Patel42939752010-07-01 21:38:08 +00002758 else if (!DISubprogram(getDISubprogram(DV.getContext())).
2759 describes(MF->getFunction()))
Devang Patel5e6b71c2010-05-27 16:47:30 +00002760 InsnNeedsLabel.insert(MI);
2761 // DBG_VALUE indicating argument location change needs a label.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002762 else if (isDbgValueInUndefinedReg(MI) == false
2763 && !ProcessedArgs.insert(DV))
Devang Patel002d54d2010-05-26 19:37:24 +00002764 InsnNeedsLabel.insert(MI);
2765 } else {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002766 // If location is unknown then instruction needs a location only if
Devang Patel002d54d2010-05-26 19:37:24 +00002767 // UnknownLocations flag is set.
2768 if (DL.isUnknown()) {
2769 if (UnknownLocations && !PrevLoc.isUnknown())
2770 InsnNeedsLabel.insert(MI);
2771 } else if (DL != PrevLoc)
2772 // Otherwise, instruction needs a location only if it is new location.
2773 InsnNeedsLabel.insert(MI);
2774 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002775
Devang Patel002d54d2010-05-26 19:37:24 +00002776 if (!DL.isUnknown() || UnknownLocations)
2777 PrevLoc = DL;
2778 }
2779
2780 PrevLabel = FunctionBeginSym;
Bill Wendling2b128d72009-05-20 23:19:06 +00002781}
2782
Devang Patel930143b2009-11-21 02:48:08 +00002783/// endFunction - Gather and emit post-function debug information.
Bill Wendling2b128d72009-05-20 23:19:06 +00002784///
Chris Lattner76555b52010-01-26 23:18:02 +00002785void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendlingfcc14142010-04-07 09:28:04 +00002786 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00002787
Devang Patel530a0752010-01-04 20:44:00 +00002788 if (CurrentFnDbgScope) {
Devang Patel4a8e6e82010-05-22 00:04:14 +00002789
Devang Patel9fc11702010-05-25 23:40:22 +00002790 // Define end label for subprogram.
2791 FunctionEndSym = Asm->GetTempSymbol("func_end",
2792 Asm->getFunctionNumber());
2793 // Assumes in correct section after the entry point.
2794 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002795
Devang Patel5c0f85c2010-06-25 22:07:34 +00002796 SmallPtrSet<const MDNode *, 16> ProcessedVars;
2797 collectVariableInfo(MF, ProcessedVars);
Devang Patel4a8e6e82010-05-22 00:04:14 +00002798
Devang Patel530a0752010-01-04 20:44:00 +00002799 // Get function line info.
2800 if (!Lines.empty()) {
2801 // Get section line info.
2802 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2803 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2804 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2805 // Append the function info to section info.
2806 SectionLineInfos.insert(SectionLineInfos.end(),
2807 Lines.begin(), Lines.end());
2808 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002809
Devang Patel530a0752010-01-04 20:44:00 +00002810 // Construct abstract scopes.
2811 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel5c0f85c2010-06-25 22:07:34 +00002812 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00002813 DISubprogram SP((*AI)->getScopeNode());
2814 if (SP.Verify()) {
2815 // Collect info for variables that were optimized out.
2816 StringRef FName = SP.getLinkageName();
2817 if (FName.empty())
2818 FName = SP.getName();
2819 const Module *M = MF->getFunction()->getParent();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002820 if (NamedMDNode *NMD =
2821 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patel5c0f85c2010-06-25 22:07:34 +00002822 getRealLinkageName(FName)))) {
2823 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002824 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel5c0f85c2010-06-25 22:07:34 +00002825 if (!DV || !ProcessedVars.insert(DV))
2826 continue;
Devang Patel648df7b2010-06-30 00:11:08 +00002827 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel5c0f85c2010-06-25 22:07:34 +00002828 if (Scope)
2829 Scope->addVariable(new DbgVariable(DV));
2830 }
2831 }
2832 }
Devang Patelc5b31092010-06-30 01:40:11 +00002833 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
2834 constructScopeDIE(*AI);
Devang Patel5c0f85c2010-06-25 22:07:34 +00002835 }
Devang Patel30265c42010-07-07 20:12:52 +00002836
Devang Patel075e9b52010-05-04 06:15:30 +00002837 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002838
Devang Patel075e9b52010-05-04 06:15:30 +00002839 if (!DisableFramePointerElim(*MF))
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002840 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel075e9b52010-05-04 06:15:30 +00002841 dwarf::DW_FORM_flag, 1);
2842
2843
Chris Lattner3a383cb2010-04-05 00:13:49 +00002844 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel530a0752010-01-04 20:44:00 +00002845 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00002846 }
2847
Bill Wendling2b128d72009-05-20 23:19:06 +00002848 // Clear debug info
Devang Patelfe189e62010-01-19 01:26:02 +00002849 CurrentFnDbgScope = NULL;
Devang Patel002d54d2010-05-26 19:37:24 +00002850 InsnNeedsLabel.clear();
Devang Patele1c53f22010-05-20 16:36:41 +00002851 DbgVariableToFrameIndexMap.clear();
2852 VarToAbstractVarMap.clear();
2853 DbgVariableToDbgInstMap.clear();
2854 DbgVariableLabelsMap.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002855 DeleteContainerSeconds(DbgScopeMap);
Devang Patel541019d2010-04-09 16:04:20 +00002856 InsnsEndScopeSet.clear();
Devang Patelfe189e62010-01-19 01:26:02 +00002857 ConcreteScopes.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002858 DeleteContainerSeconds(AbstractScopes);
Devang Patelfe189e62010-01-19 01:26:02 +00002859 AbstractScopesList.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002860 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00002861 LabelsBeforeInsn.clear();
2862 LabelsAfterInsn.clear();
Bill Wendling2b128d72009-05-20 23:19:06 +00002863 Lines.clear();
Devang Patel12563b32010-04-16 23:33:45 +00002864 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00002865}
2866
Devang Patele1c53f22010-05-20 16:36:41 +00002867/// recordVariableFrameIndex - Record a variable's index.
2868void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2869 assert (V && "Invalid DbgVariable!");
2870 DbgVariableToFrameIndexMap[V] = Index;
2871}
2872
2873/// findVariableFrameIndex - Return true if frame index for the variable
2874/// is found. Update FI to hold value of the index.
2875bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
2876 assert (V && "Invalid DbgVariable!");
2877 DenseMap<const DbgVariable *, int>::iterator I =
2878 DbgVariableToFrameIndexMap.find(V);
2879 if (I == DbgVariableToFrameIndexMap.end())
2880 return false;
2881 *FI = I->second;
2882 return true;
2883}
2884
2885/// findVariableLabel - Find MCSymbol for the variable.
2886const MCSymbol *DwarfDebug::findVariableLabel(const DbgVariable *V) {
2887 DenseMap<const DbgVariable *, const MCSymbol *>::iterator I
2888 = DbgVariableLabelsMap.find(V);
2889 if (I == DbgVariableLabelsMap.end())
2890 return NULL;
2891 else return I->second;
2892}
2893
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002894/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patel490c8ab2010-05-20 19:57:06 +00002895/// instruction.
2896DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
2897 DbgScope *Scope = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002898 LLVMContext &Ctx =
Devang Patel490c8ab2010-05-20 19:57:06 +00002899 MInsn->getParent()->getParent()->getFunction()->getContext();
2900 DebugLoc DL = MInsn->getDebugLoc();
2901
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002902 if (DL.isUnknown())
Devang Patel490c8ab2010-05-20 19:57:06 +00002903 return Scope;
2904
2905 if (const MDNode *IA = DL.getInlinedAt(Ctx))
2906 Scope = ConcreteScopes.lookup(IA);
2907 if (Scope == 0)
2908 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002909
Devang Patel490c8ab2010-05-20 19:57:06 +00002910 return Scope;
2911}
2912
2913
Chris Lattnerba35a672010-03-09 04:54:43 +00002914/// recordSourceLine - Register a source line with debug info. Returns the
2915/// unique label that was emitted and which provides correspondence to
2916/// the source line list.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002917MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel30265c42010-07-07 20:12:52 +00002918 const MDNode *S) {
Devang Patel2d9caf92009-11-25 17:36:49 +00002919 StringRef Dir;
2920 StringRef Fn;
Devang Patel2089d162009-10-05 18:03:19 +00002921
Dan Gohman50849c62010-05-05 23:41:32 +00002922 unsigned Src = 1;
2923 if (S) {
2924 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00002925
Dan Gohman50849c62010-05-05 23:41:32 +00002926 if (Scope.isCompileUnit()) {
2927 DICompileUnit CU(S);
2928 Dir = CU.getDirectory();
2929 Fn = CU.getFilename();
2930 } else if (Scope.isSubprogram()) {
2931 DISubprogram SP(S);
2932 Dir = SP.getDirectory();
2933 Fn = SP.getFilename();
2934 } else if (Scope.isLexicalBlock()) {
2935 DILexicalBlock DB(S);
2936 Dir = DB.getDirectory();
2937 Fn = DB.getFilename();
2938 } else
2939 assert(0 && "Unexpected scope info");
2940
2941 Src = GetOrCreateSourceID(Dir, Fn);
2942 }
2943
Chris Lattner6e52e9d2010-03-14 08:36:50 +00002944 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattnerb4666f42010-03-14 08:15:55 +00002945 Lines.push_back(SrcLineInfo(Line, Col, Src, Label));
Bill Wendling2b128d72009-05-20 23:19:06 +00002946
Chris Lattnerba35a672010-03-09 04:54:43 +00002947 Asm->OutStreamer.EmitLabel(Label);
2948 return Label;
Bill Wendling2b128d72009-05-20 23:19:06 +00002949}
2950
Bill Wendling806535f2009-05-20 23:22:40 +00002951//===----------------------------------------------------------------------===//
2952// Emit Methods
2953//===----------------------------------------------------------------------===//
2954
Devang Patel930143b2009-11-21 02:48:08 +00002955/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling480ff322009-05-20 23:21:38 +00002956///
Jim Grosbach00e9c612009-11-22 19:20:36 +00002957unsigned
2958DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling480ff322009-05-20 23:21:38 +00002959 // Get the children.
2960 const std::vector<DIE *> &Children = Die->getChildren();
2961
2962 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00002963 if (!Last && !Children.empty())
Benjamin Kramer74729ae2010-03-31 19:34:01 +00002964 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling480ff322009-05-20 23:21:38 +00002965
2966 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00002967 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00002968
2969 // Get the abbreviation for this DIE.
2970 unsigned AbbrevNumber = Die->getAbbrevNumber();
2971 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2972
2973 // Set DIE offset
2974 Die->setOffset(Offset);
2975
2976 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00002977 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00002978
2979 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2980 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2981
2982 // Size the DIE attribute values.
2983 for (unsigned i = 0, N = Values.size(); i < N; ++i)
2984 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00002985 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00002986
2987 // Size the DIE children if any.
2988 if (!Children.empty()) {
2989 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
2990 "Children flag not set");
2991
2992 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00002993 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling480ff322009-05-20 23:21:38 +00002994
2995 // End of children marker.
2996 Offset += sizeof(int8_t);
2997 }
2998
2999 Die->setSize(Offset - Die->getOffset());
3000 return Offset;
3001}
3002
Devang Patel930143b2009-11-21 02:48:08 +00003003/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling480ff322009-05-20 23:21:38 +00003004///
Devang Patel930143b2009-11-21 02:48:08 +00003005void DwarfDebug::computeSizeAndOffsets() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003006 unsigned PrevOffset = 0;
3007 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3008 E = CUMap.end(); I != E; ++I) {
3009 // Compute size of compile unit header.
3010 static unsigned Offset = PrevOffset +
3011 sizeof(int32_t) + // Length of Compilation Unit Info
3012 sizeof(int16_t) + // DWARF version number
3013 sizeof(int32_t) + // Offset Into Abbrev. Section
3014 sizeof(int8_t); // Pointer Size (in bytes)
3015 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
3016 PrevOffset = Offset;
3017 }
Bill Wendling480ff322009-05-20 23:21:38 +00003018}
3019
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003020/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3021/// temporary label to it if SymbolStem is specified.
Chris Lattner6629ca92010-04-04 22:59:04 +00003022static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003023 const char *SymbolStem = 0) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003024 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003025 if (!SymbolStem) return 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003026
Chris Lattner6629ca92010-04-04 22:59:04 +00003027 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3028 Asm->OutStreamer.EmitLabel(TmpSym);
3029 return TmpSym;
3030}
3031
3032/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3033/// the start of each one.
Chris Lattner46355d82010-04-04 22:33:59 +00003034void DwarfDebug::EmitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003035 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003036
Bill Wendling480ff322009-05-20 23:21:38 +00003037 // Dwarf sections base addresses.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003038 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003039 DwarfFrameSectionSym =
3040 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3041 }
Bill Wendling480ff322009-05-20 23:21:38 +00003042
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003043 DwarfInfoSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003044 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003045 DwarfAbbrevSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003046 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003047 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003048
Chris Lattner6629ca92010-04-04 22:59:04 +00003049 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003050 EmitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003051
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003052 DwarfDebugLineSectionSym =
Devang Patel24bc1b52010-06-29 20:17:53 +00003053 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003054 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3055 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3056 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003057 DwarfStrSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003058 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patel12563b32010-04-16 23:33:45 +00003059 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3060 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00003061
Devang Patel9fc11702010-05-25 23:40:22 +00003062 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3063 "section_debug_loc");
3064
Chris Lattner6629ca92010-04-04 22:59:04 +00003065 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattnere58b5472010-04-04 23:10:38 +00003066 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003067}
3068
Devang Patel930143b2009-11-21 02:48:08 +00003069/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling480ff322009-05-20 23:21:38 +00003070///
Devang Patel930143b2009-11-21 02:48:08 +00003071void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00003072 // Get the abbreviation for this DIE.
3073 unsigned AbbrevNumber = Die->getAbbrevNumber();
3074 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3075
Bill Wendling480ff322009-05-20 23:21:38 +00003076 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00003077 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00003078 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3079 Twine::utohexstr(Die->getOffset()) + ":0x" +
3080 Twine::utohexstr(Die->getSize()) + " " +
3081 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00003082 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003083
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00003084 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00003085 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3086
3087 // Emit the DIE attribute values.
3088 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3089 unsigned Attr = AbbrevData[i].getAttribute();
3090 unsigned Form = AbbrevData[i].getForm();
3091 assert(Form && "Too many attributes for DIE (check abbreviation)");
3092
Chris Lattner7bde8c02010-04-04 18:52:31 +00003093 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00003094 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003095
Bill Wendling480ff322009-05-20 23:21:38 +00003096 switch (Attr) {
3097 case dwarf::DW_AT_sibling:
Devang Patel930143b2009-11-21 02:48:08 +00003098 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003099 break;
3100 case dwarf::DW_AT_abstract_origin: {
3101 DIEEntry *E = cast<DIEEntry>(Values[i]);
3102 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003103 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00003104 Asm->EmitInt32(Addr);
3105 break;
3106 }
Devang Patel12563b32010-04-16 23:33:45 +00003107 case dwarf::DW_AT_ranges: {
3108 // DW_AT_range Value encodes offset in debug_range section.
3109 DIEInteger *V = cast<DIEInteger>(Values[i]);
3110 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3111 V->getValue(),
3112 DwarfDebugRangeSectionSym,
3113 4);
3114 break;
3115 }
Devang Patel24bc1b52010-06-29 20:17:53 +00003116 case dwarf::DW_AT_stmt_list: {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003117 Asm->EmitLabelDifference(CurrentLineSectionSym,
Devang Patel24bc1b52010-06-29 20:17:53 +00003118 DwarfDebugLineSectionSym, 4);
3119 break;
3120 }
Devang Patel9fc11702010-05-25 23:40:22 +00003121 case dwarf::DW_AT_location: {
3122 if (UseDotDebugLocEntry.count(Die) != 0) {
3123 DIELabel *L = cast<DIELabel>(Values[i]);
3124 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
3125 } else
3126 Values[i]->EmitValue(Asm, Form);
3127 break;
3128 }
Bill Wendling480ff322009-05-20 23:21:38 +00003129 default:
3130 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003131 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00003132 break;
3133 }
Bill Wendling480ff322009-05-20 23:21:38 +00003134 }
3135
3136 // Emit the DIE children if any.
3137 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3138 const std::vector<DIE *> &Children = Die->getChildren();
3139
3140 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003141 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00003142
Chris Lattner7bde8c02010-04-04 18:52:31 +00003143 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00003144 Asm->OutStreamer.AddComment("End Of Children Mark");
3145 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003146 }
3147}
3148
Devang Patel9ccfb642009-12-09 18:24:21 +00003149/// emitDebugInfo - Emit the debug info section.
Bill Wendling480ff322009-05-20 23:21:38 +00003150///
Devang Patel9ccfb642009-12-09 18:24:21 +00003151void DwarfDebug::emitDebugInfo() {
3152 // Start debug info section.
3153 Asm->OutStreamer.SwitchSection(
3154 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel1a0df9a2010-05-10 22:49:55 +00003155 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3156 E = CUMap.end(); I != E; ++I) {
3157 CompileUnit *TheCU = I->second;
3158 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003159
Devang Patel1a0df9a2010-05-10 22:49:55 +00003160 // Emit the compile units header.
3161 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3162 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003163
Devang Patel1a0df9a2010-05-10 22:49:55 +00003164 // Emit size of content not including length itself
3165 unsigned ContentSize = Die->getSize() +
3166 sizeof(int16_t) + // DWARF version number
3167 sizeof(int32_t) + // Offset Into Abbrev. Section
3168 sizeof(int8_t) + // Pointer Size (in bytes)
3169 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003170
Devang Patel1a0df9a2010-05-10 22:49:55 +00003171 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3172 Asm->EmitInt32(ContentSize);
3173 Asm->OutStreamer.AddComment("DWARF version number");
3174 Asm->EmitInt16(dwarf::DWARF_VERSION);
3175 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3176 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3177 DwarfAbbrevSectionSym);
3178 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3179 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003180
Devang Patel1a0df9a2010-05-10 22:49:55 +00003181 emitDIE(Die);
3182 // FIXME - extra padding for gdb bug.
3183 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3184 Asm->EmitInt8(0);
3185 Asm->EmitInt8(0);
3186 Asm->EmitInt8(0);
3187 Asm->EmitInt8(0);
3188 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3189 }
Bill Wendling480ff322009-05-20 23:21:38 +00003190}
3191
Devang Patel930143b2009-11-21 02:48:08 +00003192/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling480ff322009-05-20 23:21:38 +00003193///
Devang Patel930143b2009-11-21 02:48:08 +00003194void DwarfDebug::emitAbbreviations() const {
Bill Wendling480ff322009-05-20 23:21:38 +00003195 // Check to see if it is worth the effort.
3196 if (!Abbreviations.empty()) {
3197 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003198 Asm->OutStreamer.SwitchSection(
3199 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003200
Chris Lattnera179b522010-04-04 19:25:43 +00003201 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003202
3203 // For each abbrevation.
3204 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3205 // Get abbreviation data
3206 const DIEAbbrev *Abbrev = Abbreviations[i];
3207
3208 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00003209 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00003210
3211 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003212 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00003213 }
3214
3215 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00003216 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00003217
Chris Lattnera179b522010-04-04 19:25:43 +00003218 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003219 }
3220}
3221
Devang Patel930143b2009-11-21 02:48:08 +00003222/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling480ff322009-05-20 23:21:38 +00003223/// the line matrix.
3224///
Devang Patel930143b2009-11-21 02:48:08 +00003225void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00003226 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00003227 Asm->OutStreamer.AddComment("Extended Op");
3228 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003229
Chris Lattner566cae92010-03-09 23:52:58 +00003230 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003231 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00003232 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3233 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3234
3235 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00003236
Chris Lattnera179b522010-04-04 19:25:43 +00003237 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003238 Asm->getTargetData().getPointerSize(),
3239 0/*AddrSpace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003240
3241 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00003242 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3243 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003244 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00003245 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003246}
3247
Devang Patel930143b2009-11-21 02:48:08 +00003248/// emitDebugLines - Emit source line information.
Bill Wendling480ff322009-05-20 23:21:38 +00003249///
Devang Patel930143b2009-11-21 02:48:08 +00003250void DwarfDebug::emitDebugLines() {
Bill Wendling480ff322009-05-20 23:21:38 +00003251 // If the target is using .loc/.file, the assembler will be emitting the
3252 // .debug_line table automatically.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003253 if (Asm->MAI->hasDotLocAndDotFile())
Bill Wendling480ff322009-05-20 23:21:38 +00003254 return;
3255
3256 // Minimum line delta, thus ranging from -10..(255-10).
3257 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
3258 // Maximum line delta, thus ranging from -10..(255-10).
3259 const int MaxLineDelta = 255 + MinLineDelta;
3260
3261 // Start the dwarf line section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003262 Asm->OutStreamer.SwitchSection(
3263 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003264
3265 // Construct the section header.
Devang Patel24bc1b52010-06-29 20:17:53 +00003266 CurrentLineSectionSym = Asm->GetTempSymbol("section_line_begin");
3267 Asm->OutStreamer.EmitLabel(CurrentLineSectionSym);
Chris Lattner566cae92010-03-09 23:52:58 +00003268 Asm->OutStreamer.AddComment("Length of Source Line Info");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003269 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_end"),
3270 Asm->GetTempSymbol("line_begin"), 4);
Chris Lattnera179b522010-04-04 19:25:43 +00003271 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003272
Chris Lattner566cae92010-03-09 23:52:58 +00003273 Asm->OutStreamer.AddComment("DWARF version number");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003274 Asm->EmitInt16(dwarf::DWARF_VERSION);
Bill Wendling480ff322009-05-20 23:21:38 +00003275
Chris Lattner566cae92010-03-09 23:52:58 +00003276 Asm->OutStreamer.AddComment("Prolog Length");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003277 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_prolog_end"),
3278 Asm->GetTempSymbol("line_prolog_begin"), 4);
Chris Lattnera179b522010-04-04 19:25:43 +00003279 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003280
Chris Lattner566cae92010-03-09 23:52:58 +00003281 Asm->OutStreamer.AddComment("Minimum Instruction Length");
3282 Asm->EmitInt8(1);
3283 Asm->OutStreamer.AddComment("Default is_stmt_start flag");
3284 Asm->EmitInt8(1);
3285 Asm->OutStreamer.AddComment("Line Base Value (Special Opcodes)");
3286 Asm->EmitInt8(MinLineDelta);
3287 Asm->OutStreamer.AddComment("Line Range Value (Special Opcodes)");
3288 Asm->EmitInt8(MaxLineDelta);
3289 Asm->OutStreamer.AddComment("Special Opcode Base");
3290 Asm->EmitInt8(-MinLineDelta);
Bill Wendling480ff322009-05-20 23:21:38 +00003291
3292 // Line number standard opcode encodings argument count
Chris Lattner566cae92010-03-09 23:52:58 +00003293 Asm->OutStreamer.AddComment("DW_LNS_copy arg count");
3294 Asm->EmitInt8(0);
3295 Asm->OutStreamer.AddComment("DW_LNS_advance_pc arg count");
3296 Asm->EmitInt8(1);
3297 Asm->OutStreamer.AddComment("DW_LNS_advance_line arg count");
3298 Asm->EmitInt8(1);
3299 Asm->OutStreamer.AddComment("DW_LNS_set_file arg count");
3300 Asm->EmitInt8(1);
3301 Asm->OutStreamer.AddComment("DW_LNS_set_column arg count");
3302 Asm->EmitInt8(1);
3303 Asm->OutStreamer.AddComment("DW_LNS_negate_stmt arg count");
3304 Asm->EmitInt8(0);
3305 Asm->OutStreamer.AddComment("DW_LNS_set_basic_block arg count");
3306 Asm->EmitInt8(0);
3307 Asm->OutStreamer.AddComment("DW_LNS_const_add_pc arg count");
3308 Asm->EmitInt8(0);
3309 Asm->OutStreamer.AddComment("DW_LNS_fixed_advance_pc arg count");
3310 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003311
3312 // Emit directories.
3313 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003314 const std::string &Dir = getSourceDirectoryName(DI);
Chris Lattner7bde8c02010-04-04 18:52:31 +00003315 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Directory");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003316 Asm->OutStreamer.EmitBytes(StringRef(Dir.c_str(), Dir.size()+1), 0);
Bill Wendling480ff322009-05-20 23:21:38 +00003317 }
3318
Chris Lattner566cae92010-03-09 23:52:58 +00003319 Asm->OutStreamer.AddComment("End of directories");
3320 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003321
3322 // Emit files.
3323 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
3324 // Remember source id starts at 1.
3325 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003326 const std::string &FN = getSourceFileName(Id.second);
Chris Lattner7bde8c02010-04-04 18:52:31 +00003327 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Source");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003328 Asm->OutStreamer.EmitBytes(StringRef(FN.c_str(), FN.size()+1), 0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003329
Chris Lattner9efd1182010-04-04 19:09:29 +00003330 Asm->EmitULEB128(Id.first, "Directory #");
3331 Asm->EmitULEB128(0, "Mod date");
3332 Asm->EmitULEB128(0, "File size");
Bill Wendling480ff322009-05-20 23:21:38 +00003333 }
3334
Chris Lattner566cae92010-03-09 23:52:58 +00003335 Asm->OutStreamer.AddComment("End of files");
3336 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003337
Chris Lattnera179b522010-04-04 19:25:43 +00003338 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003339
3340 // A sequence for each text section.
3341 unsigned SecSrcLinesSize = SectionSourceLines.size();
3342
3343 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
3344 // Isolate current sections line info.
3345 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
3346
Bill Wendling480ff322009-05-20 23:21:38 +00003347 // Dwarf assumes we start with first line of first source file.
3348 unsigned Source = 1;
3349 unsigned Line = 1;
3350
3351 // Construct rows of the address, source, line, column matrix.
3352 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
3353 const SrcLineInfo &LineInfo = LineInfos[i];
Chris Lattnerb4666f42010-03-14 08:15:55 +00003354 MCSymbol *Label = LineInfo.getLabel();
Chris Lattneree95d4c2010-03-14 02:20:58 +00003355 if (!Label->isDefined()) continue; // Not emitted, in dead code.
Bill Wendling480ff322009-05-20 23:21:38 +00003356
Chris Lattner3d72a672010-03-09 23:38:23 +00003357 if (Asm->isVerbose()) {
Chris Lattner7e998b72010-03-10 01:04:13 +00003358 std::pair<unsigned, unsigned> SrcID =
Bill Wendling480ff322009-05-20 23:21:38 +00003359 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner7e998b72010-03-10 01:04:13 +00003360 Asm->OutStreamer.AddComment(Twine(getSourceDirectoryName(SrcID.first)) +
Chris Lattnera26fbe42010-03-10 02:29:31 +00003361 "/" +
3362 Twine(getSourceFileName(SrcID.second)) +
Chris Lattner7e998b72010-03-10 01:04:13 +00003363 ":" + Twine(LineInfo.getLine()));
Bill Wendling480ff322009-05-20 23:21:38 +00003364 }
3365
3366 // Define the line address.
Chris Lattner566cae92010-03-09 23:52:58 +00003367 Asm->OutStreamer.AddComment("Extended Op");
3368 Asm->EmitInt8(0);
3369 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003370 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00003371
3372 Asm->OutStreamer.AddComment("DW_LNE_set_address");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003373 Asm->EmitInt8(dwarf::DW_LNE_set_address);
Chris Lattner566cae92010-03-09 23:52:58 +00003374
3375 Asm->OutStreamer.AddComment("Location label");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003376 Asm->OutStreamer.EmitSymbolValue(Label,
3377 Asm->getTargetData().getPointerSize(),
Chris Lattneree95d4c2010-03-14 02:20:58 +00003378 0/*AddrSpace*/);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003379
Bill Wendling480ff322009-05-20 23:21:38 +00003380 // If change of source, then switch to the new source.
3381 if (Source != LineInfo.getSourceID()) {
3382 Source = LineInfo.getSourceID();
Chris Lattner566cae92010-03-09 23:52:58 +00003383 Asm->OutStreamer.AddComment("DW_LNS_set_file");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003384 Asm->EmitInt8(dwarf::DW_LNS_set_file);
Chris Lattner9efd1182010-04-04 19:09:29 +00003385 Asm->EmitULEB128(Source, "New Source");
Bill Wendling480ff322009-05-20 23:21:38 +00003386 }
3387
3388 // If change of line.
3389 if (Line != LineInfo.getLine()) {
3390 // Determine offset.
3391 int Offset = LineInfo.getLine() - Line;
3392 int Delta = Offset - MinLineDelta;
3393
3394 // Update line.
3395 Line = LineInfo.getLine();
3396
3397 // If delta is small enough and in range...
3398 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
3399 // ... then use fast opcode.
Chris Lattner566cae92010-03-09 23:52:58 +00003400 Asm->OutStreamer.AddComment("Line Delta");
3401 Asm->EmitInt8(Delta - MinLineDelta);
Bill Wendling480ff322009-05-20 23:21:38 +00003402 } else {
3403 // ... otherwise use long hand.
Chris Lattner566cae92010-03-09 23:52:58 +00003404 Asm->OutStreamer.AddComment("DW_LNS_advance_line");
Bill Wendling480ff322009-05-20 23:21:38 +00003405 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
Chris Lattner9efd1182010-04-04 19:09:29 +00003406 Asm->EmitSLEB128(Offset, "Line Offset");
Chris Lattner566cae92010-03-09 23:52:58 +00003407 Asm->OutStreamer.AddComment("DW_LNS_copy");
3408 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling480ff322009-05-20 23:21:38 +00003409 }
3410 } else {
3411 // Copy the previous row (different address or source)
Chris Lattner566cae92010-03-09 23:52:58 +00003412 Asm->OutStreamer.AddComment("DW_LNS_copy");
3413 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling480ff322009-05-20 23:21:38 +00003414 }
3415 }
3416
Devang Patel930143b2009-11-21 02:48:08 +00003417 emitEndOfLineMatrix(j + 1);
Bill Wendling480ff322009-05-20 23:21:38 +00003418 }
3419
3420 if (SecSrcLinesSize == 0)
3421 // Because we're emitting a debug_line section, we still need a line
3422 // table. The linker and friends expect it to exist. If there's nothing to
3423 // put into it, emit an empty table.
Devang Patel930143b2009-11-21 02:48:08 +00003424 emitEndOfLineMatrix(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003425
Chris Lattnera179b522010-04-04 19:25:43 +00003426 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003427}
3428
Devang Patel930143b2009-11-21 02:48:08 +00003429/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling480ff322009-05-20 23:21:38 +00003430///
Devang Patel930143b2009-11-21 02:48:08 +00003431void DwarfDebug::emitCommonDebugFrame() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003432 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003433 return;
3434
Chris Lattner3a383cb2010-04-05 00:13:49 +00003435 int stackGrowth = Asm->getTargetData().getPointerSize();
3436 if (Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3437 TargetFrameInfo::StackGrowsDown)
3438 stackGrowth *= -1;
Bill Wendling480ff322009-05-20 23:21:38 +00003439
3440 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003441 Asm->OutStreamer.SwitchSection(
3442 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003443
Chris Lattnera179b522010-04-04 19:25:43 +00003444 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner566cae92010-03-09 23:52:58 +00003445 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003446 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3447 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003448
Chris Lattnera179b522010-04-04 19:25:43 +00003449 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner566cae92010-03-09 23:52:58 +00003450 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling480ff322009-05-20 23:21:38 +00003451 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner566cae92010-03-09 23:52:58 +00003452 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling480ff322009-05-20 23:21:38 +00003453 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner566cae92010-03-09 23:52:58 +00003454 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003455 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner9efd1182010-04-04 19:09:29 +00003456 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3457 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner566cae92010-03-09 23:52:58 +00003458 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003459 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling480ff322009-05-20 23:21:38 +00003460 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling480ff322009-05-20 23:21:38 +00003461
3462 std::vector<MachineMove> Moves;
3463 RI->getInitialFrameState(Moves);
3464
Chris Lattneraabc6042010-04-04 23:41:46 +00003465 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003466
Chris Lattner9e06e532010-04-28 01:05:45 +00003467 Asm->EmitAlignment(2);
Chris Lattnera179b522010-04-04 19:25:43 +00003468 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003469}
3470
Devang Patel930143b2009-11-21 02:48:08 +00003471/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling480ff322009-05-20 23:21:38 +00003472/// section.
Chris Lattner2c3f4782010-03-13 07:26:18 +00003473void DwarfDebug::
3474emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003475 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003476 return;
3477
3478 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003479 Asm->OutStreamer.SwitchSection(
3480 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003481
Chris Lattner566cae92010-03-09 23:52:58 +00003482 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner2c3f4782010-03-13 07:26:18 +00003483 MCSymbol *DebugFrameBegin =
Chris Lattnera179b522010-04-04 19:25:43 +00003484 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003485 MCSymbol *DebugFrameEnd =
Chris Lattnera179b522010-04-04 19:25:43 +00003486 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnerf1429f12010-04-04 19:58:12 +00003487 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003488
Chris Lattner2c3f4782010-03-13 07:26:18 +00003489 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling480ff322009-05-20 23:21:38 +00003490
Chris Lattner566cae92010-03-09 23:52:58 +00003491 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003492 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner70a4fce2010-04-04 23:25:33 +00003493 DwarfFrameSectionSym);
Bill Wendling480ff322009-05-20 23:21:38 +00003494
Chris Lattner566cae92010-03-09 23:52:58 +00003495 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnera179b522010-04-04 19:25:43 +00003496 MCSymbol *FuncBeginSym =
3497 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattner8811e122010-03-13 07:40:56 +00003498 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattner3a383cb2010-04-05 00:13:49 +00003499 Asm->getTargetData().getPointerSize(),
3500 0/*AddrSpace*/);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003501
3502
Chris Lattner566cae92010-03-09 23:52:58 +00003503 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003504 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003505 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003506
Chris Lattneraabc6042010-04-04 23:41:46 +00003507 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003508
Chris Lattner9e06e532010-04-28 01:05:45 +00003509 Asm->EmitAlignment(2);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003510 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling480ff322009-05-20 23:21:38 +00003511}
3512
Devang Patel9ccfb642009-12-09 18:24:21 +00003513/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3514///
3515void DwarfDebug::emitDebugPubNames() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003516 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3517 E = CUMap.end(); I != E; ++I) {
3518 CompileUnit *TheCU = I->second;
3519 // Start the dwarf pubnames section.
3520 Asm->OutStreamer.SwitchSection(
3521 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003522
Devang Patel1a0df9a2010-05-10 22:49:55 +00003523 Asm->OutStreamer.AddComment("Length of Public Names Info");
3524 Asm->EmitLabelDifference(
3525 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3526 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003527
Devang Patel1a0df9a2010-05-10 22:49:55 +00003528 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3529 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003530
Devang Patel1a0df9a2010-05-10 22:49:55 +00003531 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003532 Asm->EmitInt16(dwarf::DWARF_VERSION);
3533
Devang Patel1a0df9a2010-05-10 22:49:55 +00003534 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003535 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00003536 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003537
Devang Patel1a0df9a2010-05-10 22:49:55 +00003538 Asm->OutStreamer.AddComment("Compilation Unit Length");
3539 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3540 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3541 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003542
Devang Patel1a0df9a2010-05-10 22:49:55 +00003543 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3544 for (StringMap<DIE*>::const_iterator
3545 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3546 const char *Name = GI->getKeyData();
3547 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003548
Devang Patel1a0df9a2010-05-10 22:49:55 +00003549 Asm->OutStreamer.AddComment("DIE offset");
3550 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003551
Devang Patel1a0df9a2010-05-10 22:49:55 +00003552 if (Asm->isVerbose())
3553 Asm->OutStreamer.AddComment("External Name");
3554 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3555 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003556
Devang Patel1a0df9a2010-05-10 22:49:55 +00003557 Asm->OutStreamer.AddComment("End Mark");
3558 Asm->EmitInt32(0);
3559 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3560 TheCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00003561 }
Bill Wendling480ff322009-05-20 23:21:38 +00003562}
3563
Devang Patel04d2f2d2009-11-24 01:14:22 +00003564void DwarfDebug::emitDebugPubTypes() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003565 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3566 E = CUMap.end(); I != E; ++I) {
3567 CompileUnit *TheCU = I->second;
3568 // Start the dwarf pubnames section.
3569 Asm->OutStreamer.SwitchSection(
3570 Asm->getObjFileLowering().getDwarfPubTypesSection());
3571 Asm->OutStreamer.AddComment("Length of Public Types Info");
3572 Asm->EmitLabelDifference(
3573 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3574 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003575
Devang Patel1a0df9a2010-05-10 22:49:55 +00003576 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3577 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003578
Devang Patel1a0df9a2010-05-10 22:49:55 +00003579 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3580 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003581
Devang Patel1a0df9a2010-05-10 22:49:55 +00003582 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3583 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3584 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003585
Devang Patel1a0df9a2010-05-10 22:49:55 +00003586 Asm->OutStreamer.AddComment("Compilation Unit Length");
3587 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3588 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3589 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003590
Devang Patel1a0df9a2010-05-10 22:49:55 +00003591 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3592 for (StringMap<DIE*>::const_iterator
3593 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3594 const char *Name = GI->getKeyData();
3595 DIE * Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003596
Devang Patel1a0df9a2010-05-10 22:49:55 +00003597 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3598 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003599
Devang Patel1a0df9a2010-05-10 22:49:55 +00003600 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3601 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3602 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003603
Devang Patel1a0df9a2010-05-10 22:49:55 +00003604 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003605 Asm->EmitInt32(0);
Devang Patel1a0df9a2010-05-10 22:49:55 +00003606 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3607 TheCU->getID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00003608 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00003609}
3610
Devang Patel930143b2009-11-21 02:48:08 +00003611/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling480ff322009-05-20 23:21:38 +00003612///
Devang Patel930143b2009-11-21 02:48:08 +00003613void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00003614 // Check to see if it is worth the effort.
Chris Lattner3d72a672010-03-09 23:38:23 +00003615 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003616
Chris Lattner3d72a672010-03-09 23:38:23 +00003617 // Start the dwarf str section.
3618 Asm->OutStreamer.SwitchSection(
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003619 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003620
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003621 // Get all of the string pool entries and put them in an array by their ID so
3622 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003623 SmallVector<std::pair<unsigned,
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003624 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003625
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003626 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3627 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3628 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003629
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003630 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003631
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003632 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00003633 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003634 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003635
Chris Lattner3d72a672010-03-09 23:38:23 +00003636 // Emit the string itself.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003637 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003638 }
3639}
3640
Devang Patel930143b2009-11-21 02:48:08 +00003641/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling480ff322009-05-20 23:21:38 +00003642///
Devang Patel930143b2009-11-21 02:48:08 +00003643void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003644 if (DotDebugLocEntries.empty())
3645 return;
3646
Bill Wendling480ff322009-05-20 23:21:38 +00003647 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003648 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00003649 Asm->getObjFileLowering().getDwarfLocSection());
3650 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003651 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3652 unsigned index = 1;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003653 for (SmallVector<DotDebugLocEntry, 4>::iterator
3654 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00003655 I != E; ++I, ++index) {
Devang Patel9fc11702010-05-25 23:40:22 +00003656 DotDebugLocEntry Entry = *I;
Devang Patel9fc11702010-05-25 23:40:22 +00003657 if (Entry.isEmpty()) {
3658 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3659 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003660 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00003661 } else {
3662 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3663 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3664 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3665 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patel0e60e672010-08-04 18:40:52 +00003666 if (int Offset = Entry.Loc.getOffset()) {
3667 // If the value is at a certain offset from frame register then
3668 // use DW_OP_fbreg.
3669 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patel9fc11702010-05-25 23:40:22 +00003670 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patel0e60e672010-08-04 18:40:52 +00003671 Asm->EmitInt16(1 + OffsetSize);
3672 Asm->OutStreamer.AddComment(
3673 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3674 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3675 Asm->OutStreamer.AddComment("Offset");
3676 Asm->EmitSLEB128(Offset);
Devang Patel9fc11702010-05-25 23:40:22 +00003677 } else {
Devang Patel0e60e672010-08-04 18:40:52 +00003678 if (Reg < 32) {
3679 Asm->OutStreamer.AddComment("Loc expr size");
3680 Asm->EmitInt16(1);
3681 Asm->OutStreamer.AddComment(
Devang Patel6d21f612010-08-04 20:32:36 +00003682 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patel0e60e672010-08-04 18:40:52 +00003683 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3684 } else {
3685 Asm->OutStreamer.AddComment("Loc expr size");
3686 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3687 Asm->EmitInt8(dwarf::DW_OP_regx);
3688 Asm->EmitULEB128(Reg);
3689 }
Devang Patel9fc11702010-05-25 23:40:22 +00003690 }
3691 }
3692 }
Bill Wendling480ff322009-05-20 23:21:38 +00003693}
3694
3695/// EmitDebugARanges - Emit visible names into a debug aranges section.
3696///
3697void DwarfDebug::EmitDebugARanges() {
3698 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003699 Asm->OutStreamer.SwitchSection(
3700 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003701}
3702
Devang Patel930143b2009-11-21 02:48:08 +00003703/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling480ff322009-05-20 23:21:38 +00003704///
Devang Patel930143b2009-11-21 02:48:08 +00003705void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00003706 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003707 Asm->OutStreamer.SwitchSection(
Devang Patel12563b32010-04-16 23:33:45 +00003708 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Patel6c74a872010-04-27 19:46:33 +00003709 unsigned char Size = Asm->getTargetData().getPointerSize();
3710 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003711 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00003712 I != E; ++I) {
3713 if (*I)
3714 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patel12563b32010-04-16 23:33:45 +00003715 else
Devang Patel6c74a872010-04-27 19:46:33 +00003716 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel12563b32010-04-16 23:33:45 +00003717 }
Bill Wendling480ff322009-05-20 23:21:38 +00003718}
3719
Devang Patel930143b2009-11-21 02:48:08 +00003720/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling480ff322009-05-20 23:21:38 +00003721///
Devang Patel930143b2009-11-21 02:48:08 +00003722void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003723 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00003724 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00003725 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003726 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003727 }
3728}
3729
Devang Patel930143b2009-11-21 02:48:08 +00003730/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling480ff322009-05-20 23:21:38 +00003731/// Section Header:
3732/// 1. length of section
3733/// 2. Dwarf version number
3734/// 3. address size.
3735///
3736/// Entries (one "entry" for each function that was inlined):
3737///
3738/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3739/// otherwise offset into __debug_str for regular function name.
3740/// 2. offset into __debug_str section for regular function name.
3741/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3742/// instances for the function.
3743///
3744/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3745/// inlined instance; the die_offset points to the inlined_subroutine die in the
3746/// __debug_info section, and the low_pc is the starting address for the
3747/// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00003748void DwarfDebug::emitDebugInlineInfo() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003749 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003750 return;
3751
Devang Patel1a0df9a2010-05-10 22:49:55 +00003752 if (!FirstCU)
Bill Wendling480ff322009-05-20 23:21:38 +00003753 return;
3754
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003755 Asm->OutStreamer.SwitchSection(
3756 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003757
Chris Lattner566cae92010-03-09 23:52:58 +00003758 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003759 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3760 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003761
Chris Lattnera179b522010-04-04 19:25:43 +00003762 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003763
Chris Lattner566cae92010-03-09 23:52:58 +00003764 Asm->OutStreamer.AddComment("Dwarf Version");
3765 Asm->EmitInt16(dwarf::DWARF_VERSION);
3766 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003767 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003768
Devang Patel32cc43c2010-05-07 20:54:48 +00003769 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003770 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00003771
Devang Patel32cc43c2010-05-07 20:54:48 +00003772 const MDNode *Node = *I;
3773 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00003774 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003775 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00003776 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00003777 StringRef LName = SP.getLinkageName();
3778 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00003779
Chris Lattner566cae92010-03-09 23:52:58 +00003780 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003781 if (LName.empty()) {
3782 Asm->OutStreamer.EmitBytes(Name, 0);
3783 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003784 } else
Chris Lattner70a4fce2010-04-04 23:25:33 +00003785 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3786 DwarfStrSectionSym);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003787
Chris Lattner566cae92010-03-09 23:52:58 +00003788 Asm->OutStreamer.AddComment("Function name");
Chris Lattner70a4fce2010-04-04 23:25:33 +00003789 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner9efd1182010-04-04 19:09:29 +00003790 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00003791
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003792 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00003793 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner7bde8c02010-04-04 18:52:31 +00003794 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner085b6522010-03-09 00:31:02 +00003795 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003796
Chris Lattner7bde8c02010-04-04 18:52:31 +00003797 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003798 Asm->OutStreamer.EmitSymbolValue(LI->first,
3799 Asm->getTargetData().getPointerSize(),0);
Bill Wendling480ff322009-05-20 23:21:38 +00003800 }
3801 }
3802
Chris Lattnera179b522010-04-04 19:25:43 +00003803 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003804}