blob: c48cab7d7d14f75acda80b4ee4b3b391ea41b6b0 [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 Patelb1e07b32010-08-10 04:09:06 +0000505void DwarfDebug::addSourceLine(DIE *Die, 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 Patelb1e07b32010-08-10 04:09:06 +0000520void DwarfDebug::addSourceLine(DIE *Die, 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 Patelb1e07b32010-08-10 04:09:06 +0000535void DwarfDebug::addSourceLine(DIE *Die, 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 Patelb1e07b32010-08-10 04:09:06 +0000555void DwarfDebug::addSourceLine(DIE *Die, 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 Patelb1e07b32010-08-10 04:09:06 +0000572void DwarfDebug::addSourceLine(DIE *Die, 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/// createMemberDIE - Create new member DIE.
Devang Patel9ccfb642009-12-09 18:24:21 +00001190DIE *DwarfDebug::createMemberDIE(const DIDerivedType &DT) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001191 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel2d9caf92009-11-25 17:36:49 +00001192 StringRef Name = DT.getName();
1193 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001194 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001195
Devang Patel9ccfb642009-12-09 18:24:21 +00001196 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001197
Devang Patelb6511a32010-08-09 20:20:05 +00001198 addSourceLine(MemberDie, DT);
Bill Wendling2f921f82009-05-15 09:23:25 +00001199
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001200 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel930143b2009-11-21 02:48:08 +00001201 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel67f56f02009-11-04 22:06:12 +00001202
Bill Wendling2f921f82009-05-15 09:23:25 +00001203 uint64_t Size = DT.getSizeInBits();
Devang Patelf05d5722009-11-04 23:48:00 +00001204 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling2f921f82009-05-15 09:23:25 +00001205
1206 if (Size != FieldSize) {
1207 // Handle bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001208 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1209 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling2f921f82009-05-15 09:23:25 +00001210
1211 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling2f921f82009-05-15 09:23:25 +00001212 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1213 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer2b459982010-01-07 17:50:57 +00001214 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling2f921f82009-05-15 09:23:25 +00001215 Offset -= FieldOffset;
1216
1217 // Maybe we need to work from the other end.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001218 if (Asm->getTargetData().isLittleEndian())
1219 Offset = FieldSize - (Offset + Size);
Devang Patel930143b2009-11-21 02:48:08 +00001220 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling2f921f82009-05-15 09:23:25 +00001221
Devang Patel67f56f02009-11-04 22:06:12 +00001222 // Here WD_AT_data_member_location points to the anonymous
1223 // field that includes this bit field.
Devang Patel930143b2009-11-21 02:48:08 +00001224 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001225
1226 } else
1227 // This is not a bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001228 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001229
Devang Pateld2316892010-02-03 20:08:48 +00001230 if (DT.getTag() == dwarf::DW_TAG_inheritance
1231 && DT.isVirtual()) {
1232
1233 // For C++, virtual base classes are not at fixed offset. Use following
1234 // expression to extract appropriate offset from vtable.
1235 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1236
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001237 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Pateld2316892010-02-03 20:08:48 +00001238 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1239 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1240 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1241 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1242 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1243 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1244 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1245
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001246 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
Devang Pateld2316892010-02-03 20:08:48 +00001247 VBaseLocationDie);
1248 } else
1249 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001250
1251 if (DT.isProtected())
Devang Pateleb57c592009-12-03 19:11:07 +00001252 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001253 dwarf::DW_ACCESS_protected);
1254 else if (DT.isPrivate())
Devang Pateleb57c592009-12-03 19:11:07 +00001255 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001256 dwarf::DW_ACCESS_private);
Devang Pateleb57c592009-12-03 19:11:07 +00001257 else if (DT.getTag() == dwarf::DW_TAG_inheritance)
1258 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1259 dwarf::DW_ACCESS_public);
1260 if (DT.isVirtual())
1261 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1262 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling2f921f82009-05-15 09:23:25 +00001263 return MemberDie;
1264}
1265
Devang Patel525dda02009-12-14 16:18:45 +00001266/// createSubprogramDIE - Create new DIE using SP.
1267DIE *DwarfDebug::createSubprogramDIE(const DISubprogram &SP, bool MakeDecl) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001268 CompileUnit *SPCU = getCompileUnit(SP);
1269 DIE *SPDie = SPCU->getDIE(SP);
Devang Patel525dda02009-12-14 16:18:45 +00001270 if (SPDie)
1271 return SPDie;
1272
1273 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf200b392010-03-02 17:58:15 +00001274 // Constructors and operators for anonymous aggregates do not have names.
Devang Pateld0fa3042010-03-02 01:26:20 +00001275 if (!SP.getName().empty())
1276 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling2f921f82009-05-15 09:23:25 +00001277
Devang Patel2d9caf92009-11-25 17:36:49 +00001278 StringRef LinkageName = SP.getLinkageName();
Devang Patel43ef34d2010-01-05 01:46:14 +00001279 if (!LinkageName.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001280 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel43ef34d2010-01-05 01:46:14 +00001281 getRealLinkageName(LinkageName));
1282
Devang Patelb6511a32010-08-09 20:20:05 +00001283 addSourceLine(SPDie, SP);
Bill Wendling2f921f82009-05-15 09:23:25 +00001284
Bill Wendling2f921f82009-05-15 09:23:25 +00001285 // Add prototyped tag, if C or ObjC.
1286 unsigned Lang = SP.getCompileUnit().getLanguage();
1287 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1288 Lang == dwarf::DW_LANG_ObjC)
Devang Patel930143b2009-11-21 02:48:08 +00001289 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001290
1291 // Add Return Type.
Devang Patel236526d2009-12-03 01:25:38 +00001292 DICompositeType SPTy = SP.getType();
1293 DIArray Args = SPTy.getTypeArray();
Bill Wendling2f921f82009-05-15 09:23:25 +00001294 unsigned SPTag = SPTy.getTag();
Devang Pateleb57c592009-12-03 19:11:07 +00001295
Devang Patel3b548aa2010-03-08 20:52:55 +00001296 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel9ccfb642009-12-09 18:24:21 +00001297 addType(SPDie, SPTy);
Devang Patel236526d2009-12-03 01:25:38 +00001298 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001299 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel236526d2009-12-03 01:25:38 +00001300
Devang Pateleb57c592009-12-03 19:11:07 +00001301 unsigned VK = SP.getVirtuality();
1302 if (VK) {
1303 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001304 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Pateleb57c592009-12-03 19:11:07 +00001305 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1306 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1307 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001308 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001309 SP.getContainingType()));
Devang Pateleb57c592009-12-03 19:11:07 +00001310 }
1311
Devang Patel525dda02009-12-14 16:18:45 +00001312 if (MakeDecl || !SP.isDefinition()) {
Devang Patel930143b2009-11-21 02:48:08 +00001313 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001314
1315 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel236526d2009-12-03 01:25:38 +00001316 // be handled while processing variables.
1317 DICompositeType SPTy = SP.getType();
1318 DIArray Args = SPTy.getTypeArray();
1319 unsigned SPTag = SPTy.getTag();
1320
Bill Wendling2f921f82009-05-15 09:23:25 +00001321 if (SPTag == dwarf::DW_TAG_subroutine_type)
1322 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1323 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001324 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patel6efc8e52010-02-06 01:02:37 +00001325 addType(Arg, ATy);
1326 if (ATy.isArtificial())
1327 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel930143b2009-11-21 02:48:08 +00001328 SPDie->addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +00001329 }
1330 }
1331
Devang Patel999b4992010-02-03 19:57:19 +00001332 if (SP.isArtificial())
1333 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1334
Devang Patelb4e3b902010-04-30 19:38:23 +00001335 if (!SP.isLocalToUnit())
1336 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001337
Devang Patelb4e3b902010-04-30 19:38:23 +00001338 if (SP.isOptimized())
1339 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1340
Jim Grosbach965a73a2010-07-21 23:03:52 +00001341 if (unsigned isa = Asm->getISAEncoding()) {
1342 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1343 }
1344
Devang Patelb4e3b902010-04-30 19:38:23 +00001345 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001346 SPCU->insertDIE(SP, SPDie);
Devang Patelb4e3b902010-04-30 19:38:23 +00001347
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001348 // Add to context owner.
1349 addToContextOwner(SPDie, SP.getContext());
1350
Bill Wendling2f921f82009-05-15 09:23:25 +00001351 return SPDie;
1352}
1353
Devang Patel32cc43c2010-05-07 20:54:48 +00001354DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattner8d2fe282010-03-31 05:36:29 +00001355 assert(N && "Invalid Scope encoding!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001356
1357 DbgScope *AScope = AbstractScopes.lookup(N);
1358 if (AScope)
1359 return AScope;
Jim Grosbach042483e2009-11-21 23:12:12 +00001360
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001361 DbgScope *Parent = NULL;
1362
1363 DIDescriptor Scope(N);
1364 if (Scope.isLexicalBlock()) {
1365 DILexicalBlock DB(N);
1366 DIDescriptor ParentDesc = DB.getContext();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001367 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001368 }
1369
1370 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1371
1372 if (Parent)
Devang Patel930143b2009-11-21 02:48:08 +00001373 Parent->addScope(AScope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001374 AScope->setAbstractScope();
1375 AbstractScopes[N] = AScope;
1376 if (DIDescriptor(N).isSubprogram())
1377 AbstractScopesList.push_back(AScope);
1378 return AScope;
1379}
Devang Patel75cc16c2009-10-01 20:31:14 +00001380
Devang Patel019922d2010-04-06 23:53:48 +00001381/// isSubprogramContext - Return true if Context is either a subprogram
1382/// or another context nested inside a subprogram.
Devang Patel32cc43c2010-05-07 20:54:48 +00001383static bool isSubprogramContext(const MDNode *Context) {
Devang Patel019922d2010-04-06 23:53:48 +00001384 if (!Context)
1385 return false;
1386 DIDescriptor D(Context);
1387 if (D.isSubprogram())
1388 return true;
1389 if (D.isType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001390 return isSubprogramContext(DIType(Context).getContext());
Devang Patel019922d2010-04-06 23:53:48 +00001391 return false;
1392}
1393
Jim Grosbach042483e2009-11-21 23:12:12 +00001394/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel930143b2009-11-21 02:48:08 +00001395/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1396/// If there are global variables in this scope then create and insert
1397/// DIEs for these variables.
Devang Patel32cc43c2010-05-07 20:54:48 +00001398DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001399 CompileUnit *SPCU = getCompileUnit(SPNode);
1400 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +00001401
Chris Lattner3a383cb2010-04-05 00:13:49 +00001402 assert(SPDie && "Unable to find subprogram DIE!");
1403 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001404
Chris Lattner3a383cb2010-04-05 00:13:49 +00001405 // There is not any need to generate specification DIE for a function
1406 // defined at compile unit level. If a function is defined inside another
1407 // function then gdb prefers the definition at top level and but does not
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001408 // expect specification DIE in parent function. So avoid creating
Chris Lattner3a383cb2010-04-05 00:13:49 +00001409 // specification DIE for a function defined inside a function.
1410 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001411 !SP.getContext().isFile() &&
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001412 !isSubprogramContext(SP.getContext())) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00001413 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001414
1415 // Add arguments.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001416 DICompositeType SPTy = SP.getType();
1417 DIArray Args = SPTy.getTypeArray();
1418 unsigned SPTag = SPTy.getTag();
1419 if (SPTag == dwarf::DW_TAG_subroutine_type)
1420 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1421 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001422 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattner3a383cb2010-04-05 00:13:49 +00001423 addType(Arg, ATy);
1424 if (ATy.isArtificial())
1425 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1426 SPDie->addChild(Arg);
1427 }
1428 DIE *SPDeclDie = SPDie;
1429 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001430 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Chris Lattner3a383cb2010-04-05 00:13:49 +00001431 SPDeclDie);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001432 SPCU->addDie(SPDie);
Chris Lattner3a383cb2010-04-05 00:13:49 +00001433 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001434
Devang Patela37a95e2010-07-07 22:20:57 +00001435 // Pick up abstract subprogram DIE.
1436 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
1437 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1438 addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
1439 dwarf::DW_FORM_ref4, AbsSPDIE);
1440 SPCU->addDie(SPDie);
1441 }
1442
Chris Lattner3a383cb2010-04-05 00:13:49 +00001443 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1444 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1445 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1446 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1447 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1448 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1449 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +00001450
Chris Lattner3a383cb2010-04-05 00:13:49 +00001451 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001452}
1453
Jim Grosbach042483e2009-11-21 23:12:12 +00001454/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel930143b2009-11-21 02:48:08 +00001455/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1456DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001457
1458 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1459 if (Scope->isAbstractScope())
1460 return ScopeDIE;
1461
1462 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1463 if (Ranges.empty())
1464 return 0;
1465
1466 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1467 if (Ranges.size() > 1) {
1468 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001469 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +00001470 // DW_AT_ranges appropriately.
1471 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1472 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1473 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1474 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +00001475 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1476 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +00001477 }
1478 DebugRangeSymbols.push_back(NULL);
1479 DebugRangeSymbols.push_back(NULL);
1480 return ScopeDIE;
1481 }
1482
Devang Patel9fc11702010-05-25 23:40:22 +00001483 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1484 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001485
Devang Patel9fc11702010-05-25 23:40:22 +00001486 if (End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001487
Chris Lattnere13c3722010-03-09 01:58:53 +00001488 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1489 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001490
Devang Patel6c74a872010-04-27 19:46:33 +00001491 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1492 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001493
1494 return ScopeDIE;
1495}
1496
Devang Patel930143b2009-11-21 02:48:08 +00001497/// constructInlinedScopeDIE - This scope represents inlined body of
1498/// a function. Construct DIE to represent this concrete inlined copy
1499/// of the function.
1500DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001501
1502 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001503 assert (Ranges.empty() == false
Devang Patel6c74a872010-04-27 19:46:33 +00001504 && "DbgScope does not have instruction markers!");
1505
1506 // FIXME : .debug_inlined section specification does not clearly state how
1507 // to emit inlined scope that is split into multiple instruction ranges.
1508 // For now, use first instruction range and emit low_pc/high_pc pair and
1509 // corresponding .debug_inlined section entry for this pair.
1510 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel9fc11702010-05-25 23:40:22 +00001511 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1512 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001513
Devang Patel4c6bd662010-07-08 22:39:20 +00001514 if (StartLabel == 0 || EndLabel == 0) {
Devang Patel6c74a872010-04-27 19:46:33 +00001515 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1516 return 0;
1517 }
Chris Lattnere13c3722010-03-09 01:58:53 +00001518 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001519 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +00001520 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001521 "Invalid end label for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +00001522
Devang Patel3b548aa2010-03-08 20:52:55 +00001523 if (!Scope->getScopeNode())
Devang Patelbc97f6b2010-03-08 19:20:38 +00001524 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001525 DIScope DS(Scope->getScopeNode());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001526 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1527
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001528 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001529 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1530 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001531 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel930143b2009-11-21 02:48:08 +00001532 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001533 dwarf::DW_FORM_ref4, OriginDIE);
1534
Chris Lattner085b6522010-03-09 00:31:02 +00001535 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnere13c3722010-03-09 01:58:53 +00001536 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001537
1538 InlinedSubprogramDIEs.insert(OriginDIE);
1539
1540 // Track the start label for this inlined function.
Devang Patel32cc43c2010-05-07 20:54:48 +00001541 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001542 I = InlineInfo.find(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001543
1544 if (I == InlineInfo.end()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001545 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach00e9c612009-11-22 19:20:36 +00001546 ScopeDIE));
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001547 InlinedSPNodes.push_back(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001548 } else
Chris Lattner085b6522010-03-09 00:31:02 +00001549 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001550
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001551 DILocation DL(Scope->getInlinedAt());
Devang Patel1a0df9a2010-05-10 22:49:55 +00001552 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel930143b2009-11-21 02:48:08 +00001553 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001554
1555 return ScopeDIE;
1556}
1557
Devang Patel930143b2009-11-21 02:48:08 +00001558
1559/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel9ccfb642009-12-09 18:24:21 +00001560DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001561 StringRef Name = DV->getName();
Devang Patel2d9caf92009-11-25 17:36:49 +00001562 if (Name.empty())
Devang Patel97f99fa2009-11-13 02:25:26 +00001563 return NULL;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001564
1565 // Translate tag to proper Dwarf tag. The result variable is dropped for
1566 // now.
1567 unsigned Tag;
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001568 switch (DV->getTag()) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001569 case dwarf::DW_TAG_return_variable:
1570 return NULL;
1571 case dwarf::DW_TAG_arg_variable:
1572 Tag = dwarf::DW_TAG_formal_parameter;
1573 break;
1574 case dwarf::DW_TAG_auto_variable: // fall thru
1575 default:
1576 Tag = dwarf::DW_TAG_variable;
1577 break;
1578 }
1579
1580 // Define variable debug information entry.
1581 DIE *VariableDie = new DIE(Tag);
1582
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001583 DIE *AbsDIE = NULL;
Devang Patele1c53f22010-05-20 16:36:41 +00001584 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1585 V2AVI = VarToAbstractVarMap.find(DV);
1586 if (V2AVI != VarToAbstractVarMap.end())
1587 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach042483e2009-11-21 23:12:12 +00001588
Devang Patele1c53f22010-05-20 16:36:41 +00001589 if (AbsDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001590 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001591 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001592 else {
Devang Patel930143b2009-11-21 02:48:08 +00001593 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001594 addSourceLine(VariableDie, DV->getVariable());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001595
1596 // Add variable type.
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001597 addType(VariableDie, DV->getType());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001598 }
1599
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001600 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patel6efc8e52010-02-06 01:02:37 +00001601 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel9fc11702010-05-25 23:40:22 +00001602
1603 if (Scope->isAbstractScope()) {
1604 DV->setDIE(VariableDie);
1605 return VariableDie;
1606 }
1607
1608 // Add variable address.
1609
1610 unsigned Offset = DV->getDotDebugLocOffset();
1611 if (Offset != ~0U) {
1612 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1613 Asm->GetTempSymbol("debug_loc", Offset));
1614 DV->setDIE(VariableDie);
1615 UseDotDebugLocEntry.insert(VariableDie);
1616 return VariableDie;
1617 }
1618
1619 // Check if variable is described by a DBG_VALUE instruction.
1620 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1621 DbgVariableToDbgInstMap.find(DV);
1622 if (DVI != DbgVariableToDbgInstMap.end()) {
1623 const MachineInstr *DVInsn = DVI->second;
1624 const MCSymbol *DVLabel = findVariableLabel(DV);
1625 bool updated = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001626 // FIXME : Handle getNumOperands != 3
Devang Patel9fc11702010-05-25 23:40:22 +00001627 if (DVInsn->getNumOperands() == 3) {
1628 if (DVInsn->getOperand(0).isReg())
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001629 updated =
Devang Patel30265c42010-07-07 20:12:52 +00001630 addRegisterAddress(VariableDie, DVLabel, DVInsn->getOperand(0));
Devang Patel9fc11702010-05-25 23:40:22 +00001631 else if (DVInsn->getOperand(0).isImm())
1632 updated = addConstantValue(VariableDie, DVLabel, DVInsn->getOperand(0));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001633 else if (DVInsn->getOperand(0).isFPImm())
1634 updated =
Devang Patel30265c42010-07-07 20:12:52 +00001635 addConstantFPValue(VariableDie, DVLabel, DVInsn->getOperand(0));
Devang Patel9fc11702010-05-25 23:40:22 +00001636 } else {
1637 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1638 if (Location.getReg()) {
1639 addAddress(VariableDie, dwarf::DW_AT_location, Location);
1640 if (DVLabel)
1641 addLabel(VariableDie, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr,
1642 DVLabel);
1643 updated = true;
1644 }
1645 }
1646 if (!updated) {
1647 // If variableDie is not updated then DBG_VALUE instruction does not
1648 // have valid variable info.
1649 delete VariableDie;
1650 return NULL;
1651 }
1652 DV->setDIE(VariableDie);
1653 return VariableDie;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001654 }
Devang Patel9fc11702010-05-25 23:40:22 +00001655
1656 // .. else use frame index, if available.
1657 MachineLocation Location;
1658 unsigned FrameReg;
1659 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1660 int FI = 0;
1661 if (findVariableFrameIndex(DV, &FI)) {
1662 int Offset = RI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
1663 Location.set(FrameReg, Offset);
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001664 addVariableAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
Devang Patel9fc11702010-05-25 23:40:22 +00001665 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001666 DV->setDIE(VariableDie);
1667 return VariableDie;
1668
1669}
Devang Patel930143b2009-11-21 02:48:08 +00001670
Devang Patel04d2f2d2009-11-24 01:14:22 +00001671void DwarfDebug::addPubTypes(DISubprogram SP) {
1672 DICompositeType SPTy = SP.getType();
1673 unsigned SPTag = SPTy.getTag();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001674 if (SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel04d2f2d2009-11-24 01:14:22 +00001675 return;
1676
1677 DIArray Args = SPTy.getTypeArray();
Devang Patel04d2f2d2009-11-24 01:14:22 +00001678 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001679 DIType ATy(Args.getElement(i));
Devang Patel8d6a2b72010-05-07 21:45:47 +00001680 if (!ATy.Verify())
Devang Patel04d2f2d2009-11-24 01:14:22 +00001681 continue;
1682 DICompositeType CATy = getDICompositeType(ATy);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001683 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel12d150e2010-04-13 20:35:04 +00001684 && !CATy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001685 CompileUnit *TheCU = getCompileUnit(CATy);
1686 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1687 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00001688 }
1689 }
1690}
1691
Devang Patel930143b2009-11-21 02:48:08 +00001692/// constructScopeDIE - Construct a DIE for this scope.
1693DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +00001694 if (!Scope || !Scope->getScopeNode())
1695 return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001696
Devang Patel3b548aa2010-03-08 20:52:55 +00001697 DIScope DS(Scope->getScopeNode());
1698 DIE *ScopeDIE = NULL;
1699 if (Scope->getInlinedAt())
1700 ScopeDIE = constructInlinedScopeDIE(Scope);
1701 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +00001702 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001703 if (Scope->isAbstractScope()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001704 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001705 // Note down abstract DIE.
1706 if (ScopeDIE)
1707 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
1708 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001709 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001710 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3b548aa2010-03-08 20:52:55 +00001711 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001712 else
Devang Patel3b548aa2010-03-08 20:52:55 +00001713 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel23b2ae62010-03-29 22:59:58 +00001714 if (!ScopeDIE) return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001715
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001716 // Add variables to scope.
Devang Patel406798a2010-08-09 18:51:29 +00001717 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001718 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel9ccfb642009-12-09 18:24:21 +00001719 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach042483e2009-11-21 23:12:12 +00001720 if (VariableDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001721 ScopeDIE->addChild(VariableDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001722 }
1723
1724 // Add nested scopes.
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001725 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001726 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1727 // Define the Scope debug information entry.
Devang Patel930143b2009-11-21 02:48:08 +00001728 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach042483e2009-11-21 23:12:12 +00001729 if (NestedDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001730 ScopeDIE->addChild(NestedDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001731 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001732
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001733 if (DS.isSubprogram())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001734 addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001735
Devang Patel04d2f2d2009-11-24 01:14:22 +00001736 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001737}
1738
Bill Wendling2b128d72009-05-20 23:19:06 +00001739/// GetOrCreateSourceID - Look up the source id with the given directory and
1740/// source file names. If none currently exists, create a new id and insert it
1741/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1742/// maps as well.
Chris Lattner71696ef2010-03-31 06:06:37 +00001743unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName){
Bill Wendling2b128d72009-05-20 23:19:06 +00001744 unsigned DId;
Devang Patel84a74772010-07-27 20:51:15 +00001745 assert (DirName.empty() == false && "Invalid directory name!");
Devang Patel498877d2010-07-24 00:53:22 +00001746
Bill Wendling2b128d72009-05-20 23:19:06 +00001747 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1748 if (DI != DirectoryIdMap.end()) {
1749 DId = DI->getValue();
1750 } else {
1751 DId = DirectoryNames.size() + 1;
1752 DirectoryIdMap[DirName] = DId;
1753 DirectoryNames.push_back(DirName);
1754 }
1755
1756 unsigned FId;
1757 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1758 if (FI != SourceFileIdMap.end()) {
1759 FId = FI->getValue();
1760 } else {
1761 FId = SourceFileNames.size() + 1;
1762 SourceFileIdMap[FileName] = FId;
1763 SourceFileNames.push_back(FileName);
1764 }
1765
1766 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1767 SourceIdMap.find(std::make_pair(DId, FId));
1768 if (SI != SourceIdMap.end())
1769 return SI->second;
1770
1771 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1772 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1773 SourceIds.push_back(std::make_pair(DId, FId));
1774
1775 return SrcId;
1776}
1777
Devang Patel1f4690c2009-12-15 19:16:48 +00001778/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1779DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001780 CompileUnit *TheCU = getCompileUnit(NS);
1781 DIE *NDie = TheCU->getDIE(NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001782 if (NDie)
1783 return NDie;
1784 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001785 TheCU->insertDIE(NS, NDie);
Devang Patel1f4690c2009-12-15 19:16:48 +00001786 if (!NS.getName().empty())
1787 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
Devang Patelb6511a32010-08-09 20:20:05 +00001788 addSourceLine(NDie, NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001789 addToContextOwner(NDie, NS.getContext());
1790 return NDie;
1791}
1792
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001793/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel1a0df9a2010-05-10 22:49:55 +00001794/// metadata node with tag DW_TAG_compile_unit.
Devang Patel32cc43c2010-05-07 20:54:48 +00001795void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001796 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +00001797 StringRef FN = DIUnit.getFilename();
1798 StringRef Dir = DIUnit.getDirectory();
Devang Patelb2969422009-09-29 18:40:58 +00001799 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendling2b128d72009-05-20 23:19:06 +00001800
1801 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel930143b2009-11-21 02:48:08 +00001802 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patelb2969422009-09-29 18:40:58 +00001803 DIUnit.getProducer());
Devang Patel930143b2009-11-21 02:48:08 +00001804 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendling2b128d72009-05-20 23:19:06 +00001805 DIUnit.getLanguage());
Devang Patel930143b2009-11-21 02:48:08 +00001806 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patelbd798ce2010-04-26 22:54:28 +00001807 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1808 // simplifies debug range entries.
Devang Patel1de21ec2010-06-28 22:22:47 +00001809 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Pateld22ed622010-03-22 23:11:36 +00001810 // DW_AT_stmt_list is a offset of line number information for this
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001811 // compile unit in debug_line section. This offset is calculated
Devang Patel24bc1b52010-06-29 20:17:53 +00001812 // during endMoudle().
1813 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00001814
Devang Patel2d9caf92009-11-25 17:36:49 +00001815 if (!Dir.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001816 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +00001817 if (DIUnit.isOptimized())
Devang Patel930143b2009-11-21 02:48:08 +00001818 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendling2b128d72009-05-20 23:19:06 +00001819
Devang Patel2d9caf92009-11-25 17:36:49 +00001820 StringRef Flags = DIUnit.getFlags();
1821 if (!Flags.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001822 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendling2b128d72009-05-20 23:19:06 +00001823
1824 unsigned RVer = DIUnit.getRunTimeVersion();
1825 if (RVer)
Devang Patel930143b2009-11-21 02:48:08 +00001826 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +00001827 dwarf::DW_FORM_data1, RVer);
1828
Devang Patel1a0df9a2010-05-10 22:49:55 +00001829 CompileUnit *NewCU = new CompileUnit(ID, Die);
1830 if (!FirstCU)
1831 FirstCU = NewCU;
1832 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendling2b128d72009-05-20 23:19:06 +00001833}
1834
Devang Patel1a0df9a2010-05-10 22:49:55 +00001835/// getCompielUnit - Get CompileUnit DIE.
1836CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1837 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1838 DIDescriptor D(N);
1839 const MDNode *CUNode = NULL;
1840 if (D.isCompileUnit())
1841 CUNode = N;
1842 else if (D.isSubprogram())
1843 CUNode = DISubprogram(N).getCompileUnit();
1844 else if (D.isType())
1845 CUNode = DIType(N).getCompileUnit();
1846 else if (D.isGlobalVariable())
1847 CUNode = DIGlobalVariable(N).getCompileUnit();
1848 else if (D.isVariable())
1849 CUNode = DIVariable(N).getCompileUnit();
1850 else if (D.isNameSpace())
1851 CUNode = DINameSpace(N).getCompileUnit();
1852 else if (D.isFile())
1853 CUNode = DIFile(N).getCompileUnit();
1854 else
1855 return FirstCU;
1856
1857 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1858 = CUMap.find(CUNode);
1859 if (I == CUMap.end())
1860 return FirstCU;
1861 return I->second;
1862}
1863
1864
1865/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00001866void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel469c12d22010-08-10 01:37:23 +00001867 DIGlobalVariable GV(N);
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001868
Devang Patelf5d53602009-09-04 23:59:07 +00001869 // If debug information is malformed then ignore it.
Devang Patel469c12d22010-08-10 01:37:23 +00001870 if (GV.Verify() == false)
Devang Patelf5d53602009-09-04 23:59:07 +00001871 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001872
1873 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001874 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel469c12d22010-08-10 01:37:23 +00001875 if (TheCU->getDIE(GV))
Devang Patel0751a282009-06-26 01:49:18 +00001876 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001877
Devang Patel469c12d22010-08-10 01:37:23 +00001878 DIType GTy = GV.getType();
1879 DIE *VariableDIE = new DIE(dwarf::DW_TAG_variable);
Bill Wendling2b128d72009-05-20 23:19:06 +00001880
Devang Patel469c12d22010-08-10 01:37:23 +00001881 // Add name.
1882 addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1883 GV.getDisplayName());
1884 StringRef LinkageName = GV.getLinkageName();
1885 if (!LinkageName.empty())
1886 addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
1887 getRealLinkageName(LinkageName));
1888 // Add type.
1889 addType(VariableDIE, GTy);
Devang Patel12d150e2010-04-13 20:35:04 +00001890 if (GTy.isCompositeType() && !GTy.getName().empty()
1891 && !GTy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001892 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001893 assert(Entry && "Missing global type!");
Devang Patel1a0df9a2010-05-10 22:49:55 +00001894 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00001895 }
Devang Patel469c12d22010-08-10 01:37:23 +00001896 // Add scoping info.
1897 if (!GV.isLocalToUnit()) {
1898 addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1899 // Expose as global.
1900 TheCU->addGlobal(GV.getName(), VariableDIE);
1901 }
1902 // Add line number info.
1903 addSourceLine(VariableDIE, GV);
1904 // Add to map.
1905 TheCU->insertDIE(N, VariableDIE);
1906 // Add to context owner.
1907 DIDescriptor GVContext = GV.getContext();
1908 addToContextOwner(VariableDIE, GVContext);
1909 // Add location.
1910 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1911 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1912 addLabel(Block, 0, dwarf::DW_FORM_udata,
1913 Asm->Mang->getSymbol(GV.getGlobal()));
1914 // Do not create specification DIE if context is either compile unit
1915 // or a subprogram.
1916 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
1917 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
1918 // Create specification DIE.
1919 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1920 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1921 dwarf::DW_FORM_ref4, VariableDIE);
1922 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1923 addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1924 TheCU->addDie(VariableSpecDIE);
1925 } else {
1926 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
1927 }
1928
Devang Patel0751a282009-06-26 01:49:18 +00001929 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001930}
1931
Devang Patel1a0df9a2010-05-10 22:49:55 +00001932/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00001933void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001934 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +00001935
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00001936 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001937 CompileUnit *TheCU = getCompileUnit(N);
1938 if (TheCU->getDIE(N))
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00001939 return;
1940
Bill Wendling2b128d72009-05-20 23:19:06 +00001941 if (!SP.isDefinition())
1942 // This is a method declaration which will be handled while constructing
1943 // class type.
Devang Patel0751a282009-06-26 01:49:18 +00001944 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001945
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00001946 DIE *SubprogramDie = createSubprogramDIE(SP);
1947
1948 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001949 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00001950
1951 // Add to context owner.
Devang Patel1f4690c2009-12-15 19:16:48 +00001952 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +00001953
Bill Wendling2b128d72009-05-20 23:19:06 +00001954 // Expose as global.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001955 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00001956
Devang Patel0751a282009-06-26 01:49:18 +00001957 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001958}
1959
Devang Patel930143b2009-11-21 02:48:08 +00001960/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbarbe22ec42009-09-19 20:40:14 +00001961/// content. Create global DIEs and emit initial debug info sections.
1962/// This is inovked by the target AsmPrinter.
Chris Lattner11980022010-04-04 07:48:20 +00001963void DwarfDebug::beginModule(Module *M) {
Devang Patel6c74a872010-04-27 19:46:33 +00001964 if (DisableDebugInfoPrinting)
1965 return;
1966
Devang Patel63524442009-07-30 18:56:46 +00001967 DebugInfoFinder DbgFinder;
1968 DbgFinder.processModule(*M);
Devang Patel0751a282009-06-26 01:49:18 +00001969
Chris Lattner7cfa70e2010-04-05 02:19:28 +00001970 bool HasDebugInfo = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001971
Chris Lattner7cfa70e2010-04-05 02:19:28 +00001972 // Scan all the compile-units to see if there are any marked as the main unit.
1973 // if not, we do not generate debug info.
1974 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1975 E = DbgFinder.compile_unit_end(); I != E; ++I) {
1976 if (DICompileUnit(*I).isMain()) {
1977 HasDebugInfo = true;
1978 break;
1979 }
1980 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001981
Chris Lattner7cfa70e2010-04-05 02:19:28 +00001982 if (!HasDebugInfo) return;
1983
1984 // Tell MMI that we have debug info.
1985 MMI->setDebugInfoAvailability(true);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001986
Chris Lattnerd442aa32010-04-04 23:17:54 +00001987 // Emit initial sections.
Chris Lattner7cfa70e2010-04-05 02:19:28 +00001988 EmitSectionLabels();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001989
Bill Wendling2b128d72009-05-20 23:19:06 +00001990 // Create all the compile unit DIEs.
Devang Patel63524442009-07-30 18:56:46 +00001991 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1992 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00001993 constructCompileUnit(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00001994
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001995 // Create DIEs for each subprogram.
Devang Patel63524442009-07-30 18:56:46 +00001996 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
1997 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00001998 constructSubprogramDIE(*I);
Devang Patel0751a282009-06-26 01:49:18 +00001999
Devang Patel2b75ed22009-12-10 19:14:49 +00002000 // Create DIEs for each global variable.
2001 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2002 E = DbgFinder.global_variable_end(); I != E; ++I)
2003 constructGlobalVariableDIE(*I);
2004
Bill Wendling2b128d72009-05-20 23:19:06 +00002005 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +00002006 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +00002007
2008 // Print out .file directives to specify files for .loc directives. These are
2009 // printed out early so that they precede any .loc directives.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002010 if (Asm->MAI->hasDotLocAndDotFile()) {
Bill Wendling2b128d72009-05-20 23:19:06 +00002011 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
2012 // Remember source id starts at 1.
2013 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002014 // FIXME: don't use sys::path for this! This should not depend on the
2015 // host.
Bill Wendling2b128d72009-05-20 23:19:06 +00002016 sys::Path FullPath(getSourceDirectoryName(Id.first));
2017 bool AppendOk =
2018 FullPath.appendComponent(getSourceFileName(Id.second));
2019 assert(AppendOk && "Could not append filename to directory!");
2020 AppendOk = false;
Chris Lattner601ef332010-01-25 18:58:59 +00002021 Asm->OutStreamer.EmitDwarfFileDirective(i, FullPath.str());
Bill Wendling2b128d72009-05-20 23:19:06 +00002022 }
2023 }
Bill Wendling2b128d72009-05-20 23:19:06 +00002024}
2025
Devang Patel930143b2009-11-21 02:48:08 +00002026/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendling2b128d72009-05-20 23:19:06 +00002027///
Devang Patel930143b2009-11-21 02:48:08 +00002028void DwarfDebug::endModule() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002029 if (!FirstCU) return;
Devang Patelf3b2db62010-06-28 18:25:03 +00002030 const Module *M = MMI->getModule();
Devang Pateld0701282010-08-02 17:32:15 +00002031 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patelf3b2db62010-06-28 18:25:03 +00002032 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2033 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2034 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2035 DISubprogram SP(AllSPs->getOperand(SI));
2036 if (!SP.Verify()) continue;
2037
2038 // Collect info for variables that were optimized out.
Devang Patel18efced2010-07-19 17:53:55 +00002039 if (!SP.isDefinition()) continue;
Devang Patelf3b2db62010-06-28 18:25:03 +00002040 StringRef FName = SP.getLinkageName();
2041 if (FName.empty())
2042 FName = SP.getName();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002043 NamedMDNode *NMD =
Devang Patelf3b2db62010-06-28 18:25:03 +00002044 M->getNamedMetadata(Twine("llvm.dbg.lv.", getRealLinkageName(FName)));
2045 if (!NMD) continue;
2046 unsigned E = NMD->getNumOperands();
2047 if (!E) continue;
2048 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Pateld0701282010-08-02 17:32:15 +00002049 DeadFnScopeMap[SP] = Scope;
Devang Patelf3b2db62010-06-28 18:25:03 +00002050 for (unsigned I = 0; I != E; ++I) {
2051 DIVariable DV(NMD->getOperand(I));
2052 if (!DV.Verify()) continue;
2053 Scope->addVariable(new DbgVariable(DV));
2054 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002055
Devang Patelf3b2db62010-06-28 18:25:03 +00002056 // Construct subprogram DIE and add variables DIEs.
2057 constructSubprogramDIE(SP);
2058 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patel406798a2010-08-09 18:51:29 +00002059 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf3b2db62010-06-28 18:25:03 +00002060 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2061 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2062 if (VariableDIE)
2063 ScopeDIE->addChild(VariableDIE);
2064 }
2065 }
2066 }
Bill Wendling2b128d72009-05-20 23:19:06 +00002067
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002068 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2069 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2070 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2071 DIE *ISP = *AI;
Devang Patel930143b2009-11-21 02:48:08 +00002072 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002073 }
2074
Devang Patel32cc43c2010-05-07 20:54:48 +00002075 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Pateleb57c592009-12-03 19:11:07 +00002076 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2077 DIE *SPDie = CI->first;
Devang Patel32cc43c2010-05-07 20:54:48 +00002078 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Pateleb57c592009-12-03 19:11:07 +00002079 if (!N) continue;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002080 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Pateleb57c592009-12-03 19:11:07 +00002081 if (!NDie) continue;
2082 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Pateleb57c592009-12-03 19:11:07 +00002083 }
2084
Bill Wendling2b128d72009-05-20 23:19:06 +00002085 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002086 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002087 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002088 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002089 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +00002090
2091 // End text sections.
2092 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002093 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnera179b522010-04-04 19:25:43 +00002094 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendling2b128d72009-05-20 23:19:06 +00002095 }
2096
2097 // Emit common frame information.
Devang Patel930143b2009-11-21 02:48:08 +00002098 emitCommonDebugFrame();
Bill Wendling2b128d72009-05-20 23:19:06 +00002099
2100 // Emit function debug frame information
2101 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2102 E = DebugFrames.end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002103 emitFunctionDebugFrame(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002104
2105 // Compute DIE offsets and sizes.
Devang Patel930143b2009-11-21 02:48:08 +00002106 computeSizeAndOffsets();
Bill Wendling2b128d72009-05-20 23:19:06 +00002107
Devang Patel24bc1b52010-06-29 20:17:53 +00002108 // Emit source line correspondence into a debug line section.
2109 emitDebugLines();
2110
Bill Wendling2b128d72009-05-20 23:19:06 +00002111 // Emit all the DIEs into a debug info section
Devang Patel930143b2009-11-21 02:48:08 +00002112 emitDebugInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002113
2114 // Corresponding abbreviations into a abbrev section.
Devang Patel930143b2009-11-21 02:48:08 +00002115 emitAbbreviations();
Bill Wendling2b128d72009-05-20 23:19:06 +00002116
Bill Wendling2b128d72009-05-20 23:19:06 +00002117 // Emit info into a debug pubnames section.
Devang Patel930143b2009-11-21 02:48:08 +00002118 emitDebugPubNames();
Bill Wendling2b128d72009-05-20 23:19:06 +00002119
Devang Patel04d2f2d2009-11-24 01:14:22 +00002120 // Emit info into a debug pubtypes section.
2121 emitDebugPubTypes();
2122
Bill Wendling2b128d72009-05-20 23:19:06 +00002123 // Emit info into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002124 emitDebugLoc();
Bill Wendling2b128d72009-05-20 23:19:06 +00002125
2126 // Emit info into a debug aranges section.
2127 EmitDebugARanges();
2128
2129 // Emit info into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002130 emitDebugRanges();
Bill Wendling2b128d72009-05-20 23:19:06 +00002131
2132 // Emit info into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002133 emitDebugMacInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002134
2135 // Emit inline info.
Devang Patel930143b2009-11-21 02:48:08 +00002136 emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002137
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002138 // Emit info into a debug str section.
2139 emitDebugStr();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002140
Devang Pateld0701282010-08-02 17:32:15 +00002141 // clean up.
2142 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002143 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2144 E = CUMap.end(); I != E; ++I)
2145 delete I->second;
2146 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendling2b128d72009-05-20 23:19:06 +00002147}
2148
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002149/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002150DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattner915c5f92010-04-02 19:42:39 +00002151 DebugLoc ScopeLoc) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002152
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002153 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002154 if (AbsDbgVariable)
2155 return AbsDbgVariable;
2156
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002157 LLVMContext &Ctx = Var->getContext();
Chris Lattner915c5f92010-04-02 19:42:39 +00002158 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002159 if (!Scope)
2160 return NULL;
2161
Devang Patele1c53f22010-05-20 16:36:41 +00002162 AbsDbgVariable = new DbgVariable(Var);
Devang Patel930143b2009-11-21 02:48:08 +00002163 Scope->addVariable(AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002164 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002165 return AbsDbgVariable;
2166}
2167
Devang Patel490c8ab2010-05-20 19:57:06 +00002168/// collectVariableInfoFromMMITable - Collect variable information from
2169/// side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002170void
Devang Patel490c8ab2010-05-20 19:57:06 +00002171DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2172 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00002173 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patel475d32a2009-10-06 01:26:37 +00002174 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2175 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2176 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00002177 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002178 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00002179 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00002180 DIVariable DV(Var);
2181 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002182
Chris Lattner915c5f92010-04-02 19:42:39 +00002183 DbgScope *Scope = 0;
Devang Patel32cc43c2010-05-07 20:54:48 +00002184 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattner915c5f92010-04-02 19:42:39 +00002185 Scope = ConcreteScopes.lookup(IA);
2186 if (Scope == 0)
2187 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002188
Devang Patelcdb7d442009-11-10 23:20:04 +00002189 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00002190 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00002191 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002192
Devang Patele1c53f22010-05-20 16:36:41 +00002193 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2194 DbgVariable *RegVar = new DbgVariable(DV);
2195 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel930143b2009-11-21 02:48:08 +00002196 Scope->addVariable(RegVar);
Devang Patele1c53f22010-05-20 16:36:41 +00002197 if (AbsDbgVariable) {
2198 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2199 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2200 }
Devang Patel475d32a2009-10-06 01:26:37 +00002201 }
Devang Patel490c8ab2010-05-20 19:57:06 +00002202}
Devang Patela3e9c9c2010-03-15 18:33:46 +00002203
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002204/// isDbgValueInUndefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +00002205/// DBG_VALUE instruction, is in undefined reg.
2206static bool isDbgValueInUndefinedReg(const MachineInstr *MI) {
2207 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2208 if (MI->getOperand(0).isReg() && !MI->getOperand(0).getReg())
2209 return true;
2210 return false;
2211}
2212
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002213/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +00002214/// DBG_VALUE instruction, is in a defined reg.
2215static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2216 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2217 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2218 return true;
2219 return false;
2220}
2221
Devang Patel490c8ab2010-05-20 19:57:06 +00002222/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002223void
Devang Patel5c0f85c2010-06-25 22:07:34 +00002224DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2225 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002226
Devang Patel490c8ab2010-05-20 19:57:06 +00002227 /// collection info from MMI table.
2228 collectVariableInfoFromMMITable(MF, Processed);
2229
2230 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002231 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002232 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel490c8ab2010-05-20 19:57:06 +00002233 I != E; ++I)
Devang Patela3e9c9c2010-03-15 18:33:46 +00002234 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2235 II != IE; ++II) {
2236 const MachineInstr *MInsn = II;
Devang Patel9fc11702010-05-25 23:40:22 +00002237 if (!MInsn->isDebugValue() || isDbgValueInUndefinedReg(MInsn))
Devang Patela3e9c9c2010-03-15 18:33:46 +00002238 continue;
Devang Patel490c8ab2010-05-20 19:57:06 +00002239 DbgValues.push_back(MInsn);
2240 }
Devang Patela3e9c9c2010-03-15 18:33:46 +00002241
Devang Patel9fc11702010-05-25 23:40:22 +00002242 // This is a collection of DBV_VALUE instructions describing same variable.
2243 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patel490c8ab2010-05-20 19:57:06 +00002244 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2245 E = DbgValues.end(); I != E; ++I) {
2246 const MachineInstr *MInsn = *I;
Devang Patel9fc11702010-05-25 23:40:22 +00002247 MultipleValues.clear();
2248 if (isDbgValueInDefinedReg(MInsn))
2249 MultipleValues.push_back(MInsn);
Devang Patel490c8ab2010-05-20 19:57:06 +00002250 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2251 if (Processed.count(DV) != 0)
2252 continue;
2253
Devang Patelc2254f62010-06-02 19:05:13 +00002254 const MachineInstr *PrevMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002255 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
Devang Patel9fc11702010-05-25 23:40:22 +00002256 ME = DbgValues.end(); MI != ME; ++MI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002257 const MDNode *Var =
Devang Patel9fc11702010-05-25 23:40:22 +00002258 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002259 if (Var == DV && isDbgValueInDefinedReg(*MI) &&
Devang Patelc2254f62010-06-02 19:05:13 +00002260 !PrevMI->isIdenticalTo(*MI))
Devang Patel9fc11702010-05-25 23:40:22 +00002261 MultipleValues.push_back(*MI);
Devang Patelc2254f62010-06-02 19:05:13 +00002262 PrevMI = *MI;
Devang Patel9fc11702010-05-25 23:40:22 +00002263 }
2264
Devang Patel490c8ab2010-05-20 19:57:06 +00002265 DbgScope *Scope = findDbgScope(MInsn);
Devang Patel7a9dedf2010-05-27 20:25:04 +00002266 bool CurFnArg = false;
2267 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2268 DISubprogram(DV.getContext()).describes(MF->getFunction()))
2269 CurFnArg = true;
2270 if (!Scope && CurFnArg)
Devang Patelfbd6c452010-05-21 00:10:20 +00002271 Scope = CurrentFnDbgScope;
Devang Patel490c8ab2010-05-20 19:57:06 +00002272 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00002273 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00002274 continue;
2275
2276 Processed.insert(DV);
Devang Patel490c8ab2010-05-20 19:57:06 +00002277 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patel490c8ab2010-05-20 19:57:06 +00002278 Scope->addVariable(RegVar);
Devang Patel7a9dedf2010-05-27 20:25:04 +00002279 if (!CurFnArg)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002280 DbgVariableLabelsMap[RegVar] = getLabelBeforeInsn(MInsn);
Devang Patelfbd6c452010-05-21 00:10:20 +00002281 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2282 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2283 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002284 }
Devang Patel9fc11702010-05-25 23:40:22 +00002285 if (MultipleValues.size() <= 1) {
2286 DbgVariableToDbgInstMap[RegVar] = MInsn;
2287 continue;
2288 }
2289
2290 // handle multiple DBG_VALUE instructions describing one variable.
Devang Patel9fc11702010-05-25 23:40:22 +00002291 if (DotDebugLocEntries.empty())
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002292 RegVar->setDotDebugLocOffset(0);
2293 else
2294 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002295 const MachineInstr *Begin = NULL;
2296 const MachineInstr *End = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002297 for (SmallVector<const MachineInstr *, 4>::iterator
2298 MVI = MultipleValues.begin(), MVE = MultipleValues.end();
Devang Patel30265c42010-07-07 20:12:52 +00002299 MVI != MVE; ++MVI) {
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002300 if (!Begin) {
2301 Begin = *MVI;
2302 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002303 }
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002304 End = *MVI;
Devang Patel9fc11702010-05-25 23:40:22 +00002305 MachineLocation MLoc;
Devang Patel0e60e672010-08-04 18:40:52 +00002306 if (Begin->getNumOperands() == 3) {
2307 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2308 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2309 } else
2310 MLoc = Asm->getDebugValueLocation(Begin);
2311
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002312 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2313 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patel6c378ac2010-08-04 22:07:27 +00002314 if (MLoc.getReg())
2315 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
2316
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002317 Begin = End;
2318 if (MVI + 1 == MVE) {
2319 // If End is the last instruction then its value is valid
Devang Patel9fc11702010-05-25 23:40:22 +00002320 // until the end of the funtion.
Devang Patel0e60e672010-08-04 18:40:52 +00002321 MachineLocation EMLoc;
2322 if (End->getNumOperands() == 3) {
2323 if (End->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2324 EMLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2325 } else
2326 EMLoc = Asm->getDebugValueLocation(End);
Devang Patel6c378ac2010-08-04 22:07:27 +00002327 if (EMLoc.getReg())
2328 DotDebugLocEntries.
2329 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, EMLoc));
Devang Patel9fc11702010-05-25 23:40:22 +00002330 }
2331 }
2332 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00002333 }
Devang Patele0a94bf2010-05-14 21:01:35 +00002334
2335 // Collect info for variables that were optimized out.
Devang Patelad517352010-06-22 01:01:58 +00002336 const Function *F = MF->getFunction();
2337 const Module *M = F->getParent();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002338 if (NamedMDNode *NMD =
2339 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patelb6e058d2010-06-22 01:19:38 +00002340 getRealLinkageName(F->getName())))) {
Devang Patele0a94bf2010-05-14 21:01:35 +00002341 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002342 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel490c8ab2010-05-20 19:57:06 +00002343 if (!DV || !Processed.insert(DV))
Devang Patele0a94bf2010-05-14 21:01:35 +00002344 continue;
2345 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2346 if (Scope)
Devang Patele1c53f22010-05-20 16:36:41 +00002347 Scope->addVariable(new DbgVariable(DV));
Devang Patele0a94bf2010-05-14 21:01:35 +00002348 }
2349 }
Devang Patel9fc11702010-05-25 23:40:22 +00002350}
Devang Patele0a94bf2010-05-14 21:01:35 +00002351
Devang Patel9fc11702010-05-25 23:40:22 +00002352/// getLabelBeforeInsn - Return Label preceding the instruction.
2353const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2354 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2355 LabelsBeforeInsn.find(MI);
2356 if (I == LabelsBeforeInsn.end())
2357 // FunctionBeginSym always preceeds all the instruction in current function.
2358 return FunctionBeginSym;
2359 return I->second;
2360}
2361
2362/// getLabelAfterInsn - Return Label immediately following the instruction.
2363const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2364 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2365 LabelsAfterInsn.find(MI);
2366 if (I == LabelsAfterInsn.end())
2367 return NULL;
2368 return I->second;
Devang Patel475d32a2009-10-06 01:26:37 +00002369}
2370
Devang Patelbd477be2010-03-29 17:20:31 +00002371/// beginScope - Process beginning of a scope.
2372void DwarfDebug::beginScope(const MachineInstr *MI) {
Devang Patel002d54d2010-05-26 19:37:24 +00002373 if (InsnNeedsLabel.count(MI) == 0) {
2374 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patelbd477be2010-03-29 17:20:31 +00002375 return;
Devang Patel9fc11702010-05-25 23:40:22 +00002376 }
Devang Patel23b2ae62010-03-29 22:59:58 +00002377
Devang Patel002d54d2010-05-26 19:37:24 +00002378 // Check location.
2379 DebugLoc DL = MI->getDebugLoc();
2380 if (!DL.isUnknown()) {
2381 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2382 PrevLabel = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
Devang Patel6c74a872010-04-27 19:46:33 +00002383 PrevInstLoc = DL;
Devang Patel002d54d2010-05-26 19:37:24 +00002384 LabelsBeforeInsn[MI] = PrevLabel;
2385 return;
Devang Patel6c74a872010-04-27 19:46:33 +00002386 }
Devang Patelbd477be2010-03-29 17:20:31 +00002387
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002388 // If location is unknown then use temp label for this DBG_VALUE
Devang Patel002d54d2010-05-26 19:37:24 +00002389 // instruction.
2390 if (MI->isDebugValue()) {
Devang Patelacc32a52010-05-26 21:23:46 +00002391 PrevLabel = MMI->getContext().CreateTempSymbol();
2392 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00002393 LabelsBeforeInsn[MI] = PrevLabel;
2394 return;
2395 }
2396
2397 if (UnknownLocations) {
2398 PrevLabel = recordSourceLine(0, 0, 0);
2399 LabelsBeforeInsn[MI] = PrevLabel;
2400 return;
2401 }
2402
2403 assert (0 && "Instruction is not processed!");
Devang Patel8db360d2009-10-06 01:50:42 +00002404}
2405
Devang Patel930143b2009-11-21 02:48:08 +00002406/// endScope - Process end of a scope.
2407void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel3ebd8932010-04-08 16:50:29 +00002408 if (InsnsEndScopeSet.count(MI) != 0) {
2409 // Emit a label if this instruction ends a scope.
2410 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2411 Asm->OutStreamer.EmitLabel(Label);
Devang Patel6c74a872010-04-27 19:46:33 +00002412 LabelsAfterInsn[MI] = Label;
Devang Patel3ebd8932010-04-08 16:50:29 +00002413 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002414}
2415
Devang Patel6c74a872010-04-27 19:46:33 +00002416/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002417DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel30265c42010-07-07 20:12:52 +00002418 const MDNode *InlinedAt) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002419 if (!InlinedAt) {
2420 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2421 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002422 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002423 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2424 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Patel6c74a872010-04-27 19:46:33 +00002425 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002426 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002427 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Patel6c74a872010-04-27 19:46:33 +00002428 WScope->setParent(Parent);
2429 Parent->addScope(WScope);
2430 }
2431
2432 if (!WScope->getParent()) {
2433 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastings9b5005c2010-06-15 23:06:30 +00002434 // We used to check only for a linkage name, but that fails
2435 // since we began omitting the linkage name for private
2436 // functions. The new way is to check for the name in metadata,
2437 // but that's not supported in old .ll test cases. Ergo, we
2438 // check both.
Stuart Hastingsafe54f12010-06-11 20:08:44 +00002439 if (SPName == Asm->MF->getFunction()->getName() ||
2440 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Patel6c74a872010-04-27 19:46:33 +00002441 CurrentFnDbgScope = WScope;
2442 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002443
Devang Patel6c74a872010-04-27 19:46:33 +00002444 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002445 }
2446
Devang Patel5c0f85c2010-06-25 22:07:34 +00002447 getOrCreateAbstractScope(Scope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002448 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2449 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002450 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002451
2452 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2453 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2454 DILocation DL(InlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002455 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002456 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Patel6c74a872010-04-27 19:46:33 +00002457 WScope->setParent(Parent);
2458 Parent->addScope(WScope);
2459
2460 ConcreteScopes[InlinedAt] = WScope;
Devang Patel6c74a872010-04-27 19:46:33 +00002461
2462 return WScope;
Devang Patel8db360d2009-10-06 01:50:42 +00002463}
2464
Devang Patel6c74a872010-04-27 19:46:33 +00002465/// hasValidLocation - Return true if debug location entry attached with
2466/// machine instruction encodes valid location info.
2467static bool hasValidLocation(LLVMContext &Ctx,
2468 const MachineInstr *MInsn,
Devang Patel32cc43c2010-05-07 20:54:48 +00002469 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Patel6c74a872010-04-27 19:46:33 +00002470 DebugLoc DL = MInsn->getDebugLoc();
2471 if (DL.isUnknown()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002472
Devang Patel32cc43c2010-05-07 20:54:48 +00002473 const MDNode *S = DL.getScope(Ctx);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002474
Devang Patel6c74a872010-04-27 19:46:33 +00002475 // There is no need to create another DIE for compile unit. For all
2476 // other scopes, create one DbgScope now. This will be translated
2477 // into a scope DIE at the end.
2478 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002479
Devang Patel6c74a872010-04-27 19:46:33 +00002480 Scope = S;
2481 InlinedAt = DL.getInlinedAt(Ctx);
2482 return true;
2483}
2484
2485/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2486/// hierarchy.
2487static void calculateDominanceGraph(DbgScope *Scope) {
2488 assert (Scope && "Unable to calculate scop edominance graph!");
2489 SmallVector<DbgScope *, 4> WorkStack;
2490 WorkStack.push_back(Scope);
2491 unsigned Counter = 0;
2492 while (!WorkStack.empty()) {
2493 DbgScope *WS = WorkStack.back();
2494 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2495 bool visitedChildren = false;
2496 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2497 SE = Children.end(); SI != SE; ++SI) {
2498 DbgScope *ChildScope = *SI;
2499 if (!ChildScope->getDFSOut()) {
2500 WorkStack.push_back(ChildScope);
2501 visitedChildren = true;
2502 ChildScope->setDFSIn(++Counter);
2503 break;
2504 }
2505 }
2506 if (!visitedChildren) {
2507 WorkStack.pop_back();
2508 WS->setDFSOut(++Counter);
2509 }
2510 }
2511}
2512
2513/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002514static
Devang Patel6c74a872010-04-27 19:46:33 +00002515void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2516 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2517{
2518#ifndef NDEBUG
2519 unsigned PrevDFSIn = 0;
2520 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2521 I != E; ++I) {
2522 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2523 II != IE; ++II) {
2524 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002525 const MDNode *Scope = NULL;
2526 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002527
2528 // Check if instruction has valid location information.
2529 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2530 dbgs() << " [ ";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002531 if (InlinedAt)
Devang Patel6c74a872010-04-27 19:46:33 +00002532 dbgs() << "*";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002533 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Patel6c74a872010-04-27 19:46:33 +00002534 MI2ScopeMap.find(MInsn);
2535 if (DI != MI2ScopeMap.end()) {
2536 DbgScope *S = DI->second;
2537 dbgs() << S->getDFSIn();
2538 PrevDFSIn = S->getDFSIn();
2539 } else
2540 dbgs() << PrevDFSIn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002541 } else
Devang Patel6c74a872010-04-27 19:46:33 +00002542 dbgs() << " [ x" << PrevDFSIn;
2543 dbgs() << " ]";
2544 MInsn->dump();
2545 }
2546 dbgs() << "\n";
2547 }
2548#endif
2549}
Devang Patel930143b2009-11-21 02:48:08 +00002550/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner848c7d22010-03-31 05:39:57 +00002551/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattner76555b52010-01-26 23:18:02 +00002552bool DwarfDebug::extractScopeInformation() {
Devang Patel75cc16c2009-10-01 20:31:14 +00002553 // If scope information was extracted using .dbg intrinsics then there is not
2554 // any need to extract these information by scanning each instruction.
2555 if (!DbgScopeMap.empty())
2556 return false;
2557
Dan Gohmane9135cb2010-04-23 01:18:53 +00002558 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patel6c74a872010-04-27 19:46:33 +00002559 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2560 SmallVector<DbgRange, 4> MIRanges;
2561 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patel32cc43c2010-05-07 20:54:48 +00002562 const MDNode *PrevScope = NULL;
2563 const MDNode *PrevInlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002564 const MachineInstr *RangeBeginMI = NULL;
2565 const MachineInstr *PrevMI = NULL;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002566 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel75cc16c2009-10-01 20:31:14 +00002567 I != E; ++I) {
2568 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2569 II != IE; ++II) {
2570 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002571 const MDNode *Scope = NULL;
2572 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002573
2574 // Check if instruction has valid location information.
2575 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2576 PrevMI = MInsn;
2577 continue;
2578 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002579
Devang Patel6c74a872010-04-27 19:46:33 +00002580 // If scope has not changed then skip this instruction.
2581 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2582 PrevMI = MInsn;
2583 continue;
2584 }
2585
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002586 if (RangeBeginMI) {
2587 // If we have alread seen a beginning of a instruction range and
Devang Patel6c74a872010-04-27 19:46:33 +00002588 // current instruction scope does not match scope of first instruction
2589 // in this range then create a new instruction range.
2590 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002591 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel30265c42010-07-07 20:12:52 +00002592 PrevInlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002593 MIRanges.push_back(R);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002594 }
Devang Patel6c74a872010-04-27 19:46:33 +00002595
2596 // This is a beginning of a new instruction range.
2597 RangeBeginMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002598
Devang Patel6c74a872010-04-27 19:46:33 +00002599 // Reset previous markers.
2600 PrevMI = MInsn;
2601 PrevScope = Scope;
2602 PrevInlinedAt = InlinedAt;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002603 }
2604 }
2605
Devang Patel6c74a872010-04-27 19:46:33 +00002606 // Create last instruction range.
2607 if (RangeBeginMI && PrevMI && PrevScope) {
2608 DbgRange R(RangeBeginMI, PrevMI);
2609 MIRanges.push_back(R);
2610 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patel75cc16c2009-10-01 20:31:14 +00002611 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002612
Devang Patel530a0752010-01-04 20:44:00 +00002613 if (!CurrentFnDbgScope)
2614 return false;
2615
Devang Patel6c74a872010-04-27 19:46:33 +00002616 calculateDominanceGraph(CurrentFnDbgScope);
2617 if (PrintDbgScope)
2618 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2619
2620 // Find ranges of instructions covered by each DbgScope;
2621 DbgScope *PrevDbgScope = NULL;
2622 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2623 RE = MIRanges.end(); RI != RE; ++RI) {
2624 const DbgRange &R = *RI;
2625 DbgScope *S = MI2ScopeMap.lookup(R.first);
2626 assert (S && "Lost DbgScope for a machine instruction!");
2627 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2628 PrevDbgScope->closeInsnRange(S);
2629 S->openInsnRange(R.first);
2630 S->extendInsnRange(R.second);
2631 PrevDbgScope = S;
2632 }
2633
2634 if (PrevDbgScope)
2635 PrevDbgScope->closeInsnRange();
Devang Patel75cc16c2009-10-01 20:31:14 +00002636
Devang Patel359b0132010-04-08 18:43:56 +00002637 identifyScopeMarkers();
Devang Patelf1d5a1e2010-04-08 15:37:09 +00002638
2639 return !DbgScopeMap.empty();
2640}
2641
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002642/// identifyScopeMarkers() -
Devang Patel6c74a872010-04-27 19:46:33 +00002643/// Each DbgScope has first instruction and last instruction to mark beginning
2644/// and end of a scope respectively. Create an inverse map that list scopes
2645/// starts (and ends) with an instruction. One instruction may start (or end)
2646/// multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00002647void DwarfDebug::identifyScopeMarkers() {
Devang Patel7771b7c2010-01-20 02:05:23 +00002648 SmallVector<DbgScope *, 4> WorkList;
2649 WorkList.push_back(CurrentFnDbgScope);
2650 while (!WorkList.empty()) {
Chris Lattner848c7d22010-03-31 05:39:57 +00002651 DbgScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002652
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002653 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002654 if (!Children.empty())
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002655 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00002656 SE = Children.end(); SI != SE; ++SI)
2657 WorkList.push_back(*SI);
2658
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002659 if (S->isAbstractScope())
2660 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002661
Devang Patel6c74a872010-04-27 19:46:33 +00002662 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2663 if (Ranges.empty())
2664 continue;
2665 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2666 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002667 assert(RI->first && "DbgRange does not have first instruction!");
2668 assert(RI->second && "DbgRange does not have second instruction!");
Devang Patel6c74a872010-04-27 19:46:33 +00002669 InsnsEndScopeSet.insert(RI->second);
2670 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002671 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002672}
2673
Dan Gohman3df671a2010-04-20 00:37:27 +00002674/// FindFirstDebugLoc - Find the first debug location in the function. This
2675/// is intended to be an approximation for the source position of the
2676/// beginning of the function.
2677static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2678 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2679 I != E; ++I)
2680 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2681 MBBI != MBBE; ++MBBI) {
2682 DebugLoc DL = MBBI->getDebugLoc();
2683 if (!DL.isUnknown())
2684 return DL;
2685 }
2686 return DebugLoc();
2687}
2688
Devang Patel930143b2009-11-21 02:48:08 +00002689/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendling2b128d72009-05-20 23:19:06 +00002690/// emitted immediately after the function entry point.
Chris Lattner76555b52010-01-26 23:18:02 +00002691void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00002692 if (!MMI->hasDebugInfo()) return;
Bill Wendlingfcc14142010-04-07 09:28:04 +00002693 if (!extractScopeInformation()) return;
Devang Patel4598eb62009-10-06 18:37:31 +00002694
Devang Patel6c74a872010-04-27 19:46:33 +00002695 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2696 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00002697 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00002698 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00002699
2700 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2701 // function.
Dan Gohman3df671a2010-04-20 00:37:27 +00002702 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattner915c5f92010-04-02 19:42:39 +00002703 if (FDL.isUnknown()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002704
Devang Patel32cc43c2010-05-07 20:54:48 +00002705 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings61475c52010-07-19 23:56:30 +00002706 const MDNode *TheScope = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002707
Chris Lattner915c5f92010-04-02 19:42:39 +00002708 DISubprogram SP = getDISubprogram(Scope);
2709 unsigned Line, Col;
2710 if (SP.Verify()) {
2711 Line = SP.getLineNumber();
2712 Col = 0;
Stuart Hastings61475c52010-07-19 23:56:30 +00002713 TheScope = SP;
Chris Lattner915c5f92010-04-02 19:42:39 +00002714 } else {
2715 Line = FDL.getLine();
2716 Col = FDL.getCol();
Stuart Hastings61475c52010-07-19 23:56:30 +00002717 TheScope = Scope;
Bill Wendling2b128d72009-05-20 23:19:06 +00002718 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002719
Stuart Hastings61475c52010-07-19 23:56:30 +00002720 recordSourceLine(Line, Col, TheScope);
Devang Patel002d54d2010-05-26 19:37:24 +00002721
Devang Patel21ccf052010-06-02 16:42:51 +00002722 /// ProcessedArgs - Collection of arguments already processed.
2723 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2724
Devang Patel002d54d2010-05-26 19:37:24 +00002725 DebugLoc PrevLoc;
2726 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2727 I != E; ++I)
2728 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2729 II != IE; ++II) {
2730 const MachineInstr *MI = II;
2731 DebugLoc DL = MI->getDebugLoc();
2732 if (MI->isDebugValue()) {
Devang Patel002d54d2010-05-26 19:37:24 +00002733 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2734 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2735 if (!DV.Verify()) continue;
Devang Patel5e6b71c2010-05-27 16:47:30 +00002736 // If DBG_VALUE is for a local variable then it needs a label.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002737 if (DV.getTag() != dwarf::DW_TAG_arg_variable
Devang Patel42939752010-07-01 21:38:08 +00002738 && isDbgValueInUndefinedReg(MI) == false)
Devang Patel002d54d2010-05-26 19:37:24 +00002739 InsnNeedsLabel.insert(MI);
Devang Patel5e6b71c2010-05-27 16:47:30 +00002740 // DBG_VALUE for inlined functions argument needs a label.
Devang Patel42939752010-07-01 21:38:08 +00002741 else if (!DISubprogram(getDISubprogram(DV.getContext())).
2742 describes(MF->getFunction()))
Devang Patel5e6b71c2010-05-27 16:47:30 +00002743 InsnNeedsLabel.insert(MI);
2744 // DBG_VALUE indicating argument location change needs a label.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002745 else if (isDbgValueInUndefinedReg(MI) == false
2746 && !ProcessedArgs.insert(DV))
Devang Patel002d54d2010-05-26 19:37:24 +00002747 InsnNeedsLabel.insert(MI);
2748 } else {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002749 // If location is unknown then instruction needs a location only if
Devang Patel002d54d2010-05-26 19:37:24 +00002750 // UnknownLocations flag is set.
2751 if (DL.isUnknown()) {
2752 if (UnknownLocations && !PrevLoc.isUnknown())
2753 InsnNeedsLabel.insert(MI);
2754 } else if (DL != PrevLoc)
2755 // Otherwise, instruction needs a location only if it is new location.
2756 InsnNeedsLabel.insert(MI);
2757 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002758
Devang Patel002d54d2010-05-26 19:37:24 +00002759 if (!DL.isUnknown() || UnknownLocations)
2760 PrevLoc = DL;
2761 }
2762
2763 PrevLabel = FunctionBeginSym;
Bill Wendling2b128d72009-05-20 23:19:06 +00002764}
2765
Devang Patel930143b2009-11-21 02:48:08 +00002766/// endFunction - Gather and emit post-function debug information.
Bill Wendling2b128d72009-05-20 23:19:06 +00002767///
Chris Lattner76555b52010-01-26 23:18:02 +00002768void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendlingfcc14142010-04-07 09:28:04 +00002769 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00002770
Devang Patel530a0752010-01-04 20:44:00 +00002771 if (CurrentFnDbgScope) {
Devang Patel4a8e6e82010-05-22 00:04:14 +00002772
Devang Patel9fc11702010-05-25 23:40:22 +00002773 // Define end label for subprogram.
2774 FunctionEndSym = Asm->GetTempSymbol("func_end",
2775 Asm->getFunctionNumber());
2776 // Assumes in correct section after the entry point.
2777 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002778
Devang Patel5c0f85c2010-06-25 22:07:34 +00002779 SmallPtrSet<const MDNode *, 16> ProcessedVars;
2780 collectVariableInfo(MF, ProcessedVars);
Devang Patel4a8e6e82010-05-22 00:04:14 +00002781
Devang Patel530a0752010-01-04 20:44:00 +00002782 // Get function line info.
2783 if (!Lines.empty()) {
2784 // Get section line info.
2785 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2786 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2787 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2788 // Append the function info to section info.
2789 SectionLineInfos.insert(SectionLineInfos.end(),
2790 Lines.begin(), Lines.end());
2791 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002792
Devang Patel530a0752010-01-04 20:44:00 +00002793 // Construct abstract scopes.
2794 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel5c0f85c2010-06-25 22:07:34 +00002795 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00002796 DISubprogram SP((*AI)->getScopeNode());
2797 if (SP.Verify()) {
2798 // Collect info for variables that were optimized out.
2799 StringRef FName = SP.getLinkageName();
2800 if (FName.empty())
2801 FName = SP.getName();
2802 const Module *M = MF->getFunction()->getParent();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002803 if (NamedMDNode *NMD =
2804 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patel5c0f85c2010-06-25 22:07:34 +00002805 getRealLinkageName(FName)))) {
2806 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002807 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel5c0f85c2010-06-25 22:07:34 +00002808 if (!DV || !ProcessedVars.insert(DV))
2809 continue;
Devang Patel648df7b2010-06-30 00:11:08 +00002810 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel5c0f85c2010-06-25 22:07:34 +00002811 if (Scope)
2812 Scope->addVariable(new DbgVariable(DV));
2813 }
2814 }
2815 }
Devang Patelc5b31092010-06-30 01:40:11 +00002816 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
2817 constructScopeDIE(*AI);
Devang Patel5c0f85c2010-06-25 22:07:34 +00002818 }
Devang Patel30265c42010-07-07 20:12:52 +00002819
Devang Patel075e9b52010-05-04 06:15:30 +00002820 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002821
Devang Patel075e9b52010-05-04 06:15:30 +00002822 if (!DisableFramePointerElim(*MF))
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002823 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel075e9b52010-05-04 06:15:30 +00002824 dwarf::DW_FORM_flag, 1);
2825
2826
Chris Lattner3a383cb2010-04-05 00:13:49 +00002827 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel530a0752010-01-04 20:44:00 +00002828 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00002829 }
2830
Bill Wendling2b128d72009-05-20 23:19:06 +00002831 // Clear debug info
Devang Patelfe189e62010-01-19 01:26:02 +00002832 CurrentFnDbgScope = NULL;
Devang Patel002d54d2010-05-26 19:37:24 +00002833 InsnNeedsLabel.clear();
Devang Patele1c53f22010-05-20 16:36:41 +00002834 DbgVariableToFrameIndexMap.clear();
2835 VarToAbstractVarMap.clear();
2836 DbgVariableToDbgInstMap.clear();
2837 DbgVariableLabelsMap.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002838 DeleteContainerSeconds(DbgScopeMap);
Devang Patel541019d2010-04-09 16:04:20 +00002839 InsnsEndScopeSet.clear();
Devang Patelfe189e62010-01-19 01:26:02 +00002840 ConcreteScopes.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002841 DeleteContainerSeconds(AbstractScopes);
Devang Patelfe189e62010-01-19 01:26:02 +00002842 AbstractScopesList.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002843 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00002844 LabelsBeforeInsn.clear();
2845 LabelsAfterInsn.clear();
Bill Wendling2b128d72009-05-20 23:19:06 +00002846 Lines.clear();
Devang Patel12563b32010-04-16 23:33:45 +00002847 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00002848}
2849
Devang Patele1c53f22010-05-20 16:36:41 +00002850/// recordVariableFrameIndex - Record a variable's index.
2851void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2852 assert (V && "Invalid DbgVariable!");
2853 DbgVariableToFrameIndexMap[V] = Index;
2854}
2855
2856/// findVariableFrameIndex - Return true if frame index for the variable
2857/// is found. Update FI to hold value of the index.
2858bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
2859 assert (V && "Invalid DbgVariable!");
2860 DenseMap<const DbgVariable *, int>::iterator I =
2861 DbgVariableToFrameIndexMap.find(V);
2862 if (I == DbgVariableToFrameIndexMap.end())
2863 return false;
2864 *FI = I->second;
2865 return true;
2866}
2867
2868/// findVariableLabel - Find MCSymbol for the variable.
2869const MCSymbol *DwarfDebug::findVariableLabel(const DbgVariable *V) {
2870 DenseMap<const DbgVariable *, const MCSymbol *>::iterator I
2871 = DbgVariableLabelsMap.find(V);
2872 if (I == DbgVariableLabelsMap.end())
2873 return NULL;
2874 else return I->second;
2875}
2876
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002877/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patel490c8ab2010-05-20 19:57:06 +00002878/// instruction.
2879DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
2880 DbgScope *Scope = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002881 LLVMContext &Ctx =
Devang Patel490c8ab2010-05-20 19:57:06 +00002882 MInsn->getParent()->getParent()->getFunction()->getContext();
2883 DebugLoc DL = MInsn->getDebugLoc();
2884
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002885 if (DL.isUnknown())
Devang Patel490c8ab2010-05-20 19:57:06 +00002886 return Scope;
2887
2888 if (const MDNode *IA = DL.getInlinedAt(Ctx))
2889 Scope = ConcreteScopes.lookup(IA);
2890 if (Scope == 0)
2891 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002892
Devang Patel490c8ab2010-05-20 19:57:06 +00002893 return Scope;
2894}
2895
2896
Chris Lattnerba35a672010-03-09 04:54:43 +00002897/// recordSourceLine - Register a source line with debug info. Returns the
2898/// unique label that was emitted and which provides correspondence to
2899/// the source line list.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002900MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel30265c42010-07-07 20:12:52 +00002901 const MDNode *S) {
Devang Patel2d9caf92009-11-25 17:36:49 +00002902 StringRef Dir;
2903 StringRef Fn;
Devang Patel2089d162009-10-05 18:03:19 +00002904
Dan Gohman50849c62010-05-05 23:41:32 +00002905 unsigned Src = 1;
2906 if (S) {
2907 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00002908
Dan Gohman50849c62010-05-05 23:41:32 +00002909 if (Scope.isCompileUnit()) {
2910 DICompileUnit CU(S);
2911 Dir = CU.getDirectory();
2912 Fn = CU.getFilename();
2913 } else if (Scope.isSubprogram()) {
2914 DISubprogram SP(S);
2915 Dir = SP.getDirectory();
2916 Fn = SP.getFilename();
2917 } else if (Scope.isLexicalBlock()) {
2918 DILexicalBlock DB(S);
2919 Dir = DB.getDirectory();
2920 Fn = DB.getFilename();
2921 } else
2922 assert(0 && "Unexpected scope info");
2923
2924 Src = GetOrCreateSourceID(Dir, Fn);
2925 }
2926
Chris Lattner6e52e9d2010-03-14 08:36:50 +00002927 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattnerb4666f42010-03-14 08:15:55 +00002928 Lines.push_back(SrcLineInfo(Line, Col, Src, Label));
Bill Wendling2b128d72009-05-20 23:19:06 +00002929
Chris Lattnerba35a672010-03-09 04:54:43 +00002930 Asm->OutStreamer.EmitLabel(Label);
2931 return Label;
Bill Wendling2b128d72009-05-20 23:19:06 +00002932}
2933
Bill Wendling806535f2009-05-20 23:22:40 +00002934//===----------------------------------------------------------------------===//
2935// Emit Methods
2936//===----------------------------------------------------------------------===//
2937
Devang Patel930143b2009-11-21 02:48:08 +00002938/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling480ff322009-05-20 23:21:38 +00002939///
Jim Grosbach00e9c612009-11-22 19:20:36 +00002940unsigned
2941DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling480ff322009-05-20 23:21:38 +00002942 // Get the children.
2943 const std::vector<DIE *> &Children = Die->getChildren();
2944
2945 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00002946 if (!Last && !Children.empty())
Benjamin Kramer74729ae2010-03-31 19:34:01 +00002947 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling480ff322009-05-20 23:21:38 +00002948
2949 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00002950 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00002951
2952 // Get the abbreviation for this DIE.
2953 unsigned AbbrevNumber = Die->getAbbrevNumber();
2954 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2955
2956 // Set DIE offset
2957 Die->setOffset(Offset);
2958
2959 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00002960 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00002961
2962 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2963 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2964
2965 // Size the DIE attribute values.
2966 for (unsigned i = 0, N = Values.size(); i < N; ++i)
2967 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00002968 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00002969
2970 // Size the DIE children if any.
2971 if (!Children.empty()) {
2972 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
2973 "Children flag not set");
2974
2975 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00002976 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling480ff322009-05-20 23:21:38 +00002977
2978 // End of children marker.
2979 Offset += sizeof(int8_t);
2980 }
2981
2982 Die->setSize(Offset - Die->getOffset());
2983 return Offset;
2984}
2985
Devang Patel930143b2009-11-21 02:48:08 +00002986/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling480ff322009-05-20 23:21:38 +00002987///
Devang Patel930143b2009-11-21 02:48:08 +00002988void DwarfDebug::computeSizeAndOffsets() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002989 unsigned PrevOffset = 0;
2990 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2991 E = CUMap.end(); I != E; ++I) {
2992 // Compute size of compile unit header.
2993 static unsigned Offset = PrevOffset +
2994 sizeof(int32_t) + // Length of Compilation Unit Info
2995 sizeof(int16_t) + // DWARF version number
2996 sizeof(int32_t) + // Offset Into Abbrev. Section
2997 sizeof(int8_t); // Pointer Size (in bytes)
2998 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
2999 PrevOffset = Offset;
3000 }
Bill Wendling480ff322009-05-20 23:21:38 +00003001}
3002
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003003/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3004/// temporary label to it if SymbolStem is specified.
Chris Lattner6629ca92010-04-04 22:59:04 +00003005static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003006 const char *SymbolStem = 0) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003007 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003008 if (!SymbolStem) return 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003009
Chris Lattner6629ca92010-04-04 22:59:04 +00003010 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3011 Asm->OutStreamer.EmitLabel(TmpSym);
3012 return TmpSym;
3013}
3014
3015/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3016/// the start of each one.
Chris Lattner46355d82010-04-04 22:33:59 +00003017void DwarfDebug::EmitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003018 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003019
Bill Wendling480ff322009-05-20 23:21:38 +00003020 // Dwarf sections base addresses.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003021 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003022 DwarfFrameSectionSym =
3023 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3024 }
Bill Wendling480ff322009-05-20 23:21:38 +00003025
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003026 DwarfInfoSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003027 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003028 DwarfAbbrevSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003029 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003030 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003031
Chris Lattner6629ca92010-04-04 22:59:04 +00003032 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003033 EmitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003034
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003035 DwarfDebugLineSectionSym =
Devang Patel24bc1b52010-06-29 20:17:53 +00003036 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003037 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3038 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3039 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003040 DwarfStrSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003041 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patel12563b32010-04-16 23:33:45 +00003042 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3043 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00003044
Devang Patel9fc11702010-05-25 23:40:22 +00003045 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3046 "section_debug_loc");
3047
Chris Lattner6629ca92010-04-04 22:59:04 +00003048 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattnere58b5472010-04-04 23:10:38 +00003049 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003050}
3051
Devang Patel930143b2009-11-21 02:48:08 +00003052/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling480ff322009-05-20 23:21:38 +00003053///
Devang Patel930143b2009-11-21 02:48:08 +00003054void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00003055 // Get the abbreviation for this DIE.
3056 unsigned AbbrevNumber = Die->getAbbrevNumber();
3057 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3058
Bill Wendling480ff322009-05-20 23:21:38 +00003059 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00003060 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00003061 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3062 Twine::utohexstr(Die->getOffset()) + ":0x" +
3063 Twine::utohexstr(Die->getSize()) + " " +
3064 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00003065 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003066
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00003067 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00003068 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3069
3070 // Emit the DIE attribute values.
3071 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3072 unsigned Attr = AbbrevData[i].getAttribute();
3073 unsigned Form = AbbrevData[i].getForm();
3074 assert(Form && "Too many attributes for DIE (check abbreviation)");
3075
Chris Lattner7bde8c02010-04-04 18:52:31 +00003076 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00003077 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003078
Bill Wendling480ff322009-05-20 23:21:38 +00003079 switch (Attr) {
3080 case dwarf::DW_AT_sibling:
Devang Patel930143b2009-11-21 02:48:08 +00003081 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003082 break;
3083 case dwarf::DW_AT_abstract_origin: {
3084 DIEEntry *E = cast<DIEEntry>(Values[i]);
3085 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003086 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00003087 Asm->EmitInt32(Addr);
3088 break;
3089 }
Devang Patel12563b32010-04-16 23:33:45 +00003090 case dwarf::DW_AT_ranges: {
3091 // DW_AT_range Value encodes offset in debug_range section.
3092 DIEInteger *V = cast<DIEInteger>(Values[i]);
3093 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3094 V->getValue(),
3095 DwarfDebugRangeSectionSym,
3096 4);
3097 break;
3098 }
Devang Patel24bc1b52010-06-29 20:17:53 +00003099 case dwarf::DW_AT_stmt_list: {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003100 Asm->EmitLabelDifference(CurrentLineSectionSym,
Devang Patel24bc1b52010-06-29 20:17:53 +00003101 DwarfDebugLineSectionSym, 4);
3102 break;
3103 }
Devang Patel9fc11702010-05-25 23:40:22 +00003104 case dwarf::DW_AT_location: {
3105 if (UseDotDebugLocEntry.count(Die) != 0) {
3106 DIELabel *L = cast<DIELabel>(Values[i]);
3107 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
3108 } else
3109 Values[i]->EmitValue(Asm, Form);
3110 break;
3111 }
Bill Wendling480ff322009-05-20 23:21:38 +00003112 default:
3113 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003114 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00003115 break;
3116 }
Bill Wendling480ff322009-05-20 23:21:38 +00003117 }
3118
3119 // Emit the DIE children if any.
3120 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3121 const std::vector<DIE *> &Children = Die->getChildren();
3122
3123 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003124 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00003125
Chris Lattner7bde8c02010-04-04 18:52:31 +00003126 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00003127 Asm->OutStreamer.AddComment("End Of Children Mark");
3128 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003129 }
3130}
3131
Devang Patel9ccfb642009-12-09 18:24:21 +00003132/// emitDebugInfo - Emit the debug info section.
Bill Wendling480ff322009-05-20 23:21:38 +00003133///
Devang Patel9ccfb642009-12-09 18:24:21 +00003134void DwarfDebug::emitDebugInfo() {
3135 // Start debug info section.
3136 Asm->OutStreamer.SwitchSection(
3137 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel1a0df9a2010-05-10 22:49:55 +00003138 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3139 E = CUMap.end(); I != E; ++I) {
3140 CompileUnit *TheCU = I->second;
3141 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003142
Devang Patel1a0df9a2010-05-10 22:49:55 +00003143 // Emit the compile units header.
3144 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3145 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003146
Devang Patel1a0df9a2010-05-10 22:49:55 +00003147 // Emit size of content not including length itself
3148 unsigned ContentSize = Die->getSize() +
3149 sizeof(int16_t) + // DWARF version number
3150 sizeof(int32_t) + // Offset Into Abbrev. Section
3151 sizeof(int8_t) + // Pointer Size (in bytes)
3152 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003153
Devang Patel1a0df9a2010-05-10 22:49:55 +00003154 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3155 Asm->EmitInt32(ContentSize);
3156 Asm->OutStreamer.AddComment("DWARF version number");
3157 Asm->EmitInt16(dwarf::DWARF_VERSION);
3158 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3159 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3160 DwarfAbbrevSectionSym);
3161 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3162 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003163
Devang Patel1a0df9a2010-05-10 22:49:55 +00003164 emitDIE(Die);
3165 // FIXME - extra padding for gdb bug.
3166 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3167 Asm->EmitInt8(0);
3168 Asm->EmitInt8(0);
3169 Asm->EmitInt8(0);
3170 Asm->EmitInt8(0);
3171 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3172 }
Bill Wendling480ff322009-05-20 23:21:38 +00003173}
3174
Devang Patel930143b2009-11-21 02:48:08 +00003175/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling480ff322009-05-20 23:21:38 +00003176///
Devang Patel930143b2009-11-21 02:48:08 +00003177void DwarfDebug::emitAbbreviations() const {
Bill Wendling480ff322009-05-20 23:21:38 +00003178 // Check to see if it is worth the effort.
3179 if (!Abbreviations.empty()) {
3180 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003181 Asm->OutStreamer.SwitchSection(
3182 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003183
Chris Lattnera179b522010-04-04 19:25:43 +00003184 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003185
3186 // For each abbrevation.
3187 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3188 // Get abbreviation data
3189 const DIEAbbrev *Abbrev = Abbreviations[i];
3190
3191 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00003192 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00003193
3194 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003195 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00003196 }
3197
3198 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00003199 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00003200
Chris Lattnera179b522010-04-04 19:25:43 +00003201 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003202 }
3203}
3204
Devang Patel930143b2009-11-21 02:48:08 +00003205/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling480ff322009-05-20 23:21:38 +00003206/// the line matrix.
3207///
Devang Patel930143b2009-11-21 02:48:08 +00003208void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00003209 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00003210 Asm->OutStreamer.AddComment("Extended Op");
3211 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003212
Chris Lattner566cae92010-03-09 23:52:58 +00003213 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003214 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00003215 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3216 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3217
3218 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00003219
Chris Lattnera179b522010-04-04 19:25:43 +00003220 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003221 Asm->getTargetData().getPointerSize(),
3222 0/*AddrSpace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003223
3224 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00003225 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3226 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003227 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00003228 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003229}
3230
Devang Patel930143b2009-11-21 02:48:08 +00003231/// emitDebugLines - Emit source line information.
Bill Wendling480ff322009-05-20 23:21:38 +00003232///
Devang Patel930143b2009-11-21 02:48:08 +00003233void DwarfDebug::emitDebugLines() {
Bill Wendling480ff322009-05-20 23:21:38 +00003234 // If the target is using .loc/.file, the assembler will be emitting the
3235 // .debug_line table automatically.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003236 if (Asm->MAI->hasDotLocAndDotFile())
Bill Wendling480ff322009-05-20 23:21:38 +00003237 return;
3238
3239 // Minimum line delta, thus ranging from -10..(255-10).
3240 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
3241 // Maximum line delta, thus ranging from -10..(255-10).
3242 const int MaxLineDelta = 255 + MinLineDelta;
3243
3244 // Start the dwarf line section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003245 Asm->OutStreamer.SwitchSection(
3246 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003247
3248 // Construct the section header.
Devang Patel24bc1b52010-06-29 20:17:53 +00003249 CurrentLineSectionSym = Asm->GetTempSymbol("section_line_begin");
3250 Asm->OutStreamer.EmitLabel(CurrentLineSectionSym);
Chris Lattner566cae92010-03-09 23:52:58 +00003251 Asm->OutStreamer.AddComment("Length of Source Line Info");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003252 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_end"),
3253 Asm->GetTempSymbol("line_begin"), 4);
Chris Lattnera179b522010-04-04 19:25:43 +00003254 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003255
Chris Lattner566cae92010-03-09 23:52:58 +00003256 Asm->OutStreamer.AddComment("DWARF version number");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003257 Asm->EmitInt16(dwarf::DWARF_VERSION);
Bill Wendling480ff322009-05-20 23:21:38 +00003258
Chris Lattner566cae92010-03-09 23:52:58 +00003259 Asm->OutStreamer.AddComment("Prolog Length");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003260 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_prolog_end"),
3261 Asm->GetTempSymbol("line_prolog_begin"), 4);
Chris Lattnera179b522010-04-04 19:25:43 +00003262 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003263
Chris Lattner566cae92010-03-09 23:52:58 +00003264 Asm->OutStreamer.AddComment("Minimum Instruction Length");
3265 Asm->EmitInt8(1);
3266 Asm->OutStreamer.AddComment("Default is_stmt_start flag");
3267 Asm->EmitInt8(1);
3268 Asm->OutStreamer.AddComment("Line Base Value (Special Opcodes)");
3269 Asm->EmitInt8(MinLineDelta);
3270 Asm->OutStreamer.AddComment("Line Range Value (Special Opcodes)");
3271 Asm->EmitInt8(MaxLineDelta);
3272 Asm->OutStreamer.AddComment("Special Opcode Base");
3273 Asm->EmitInt8(-MinLineDelta);
Bill Wendling480ff322009-05-20 23:21:38 +00003274
3275 // Line number standard opcode encodings argument count
Chris Lattner566cae92010-03-09 23:52:58 +00003276 Asm->OutStreamer.AddComment("DW_LNS_copy arg count");
3277 Asm->EmitInt8(0);
3278 Asm->OutStreamer.AddComment("DW_LNS_advance_pc arg count");
3279 Asm->EmitInt8(1);
3280 Asm->OutStreamer.AddComment("DW_LNS_advance_line arg count");
3281 Asm->EmitInt8(1);
3282 Asm->OutStreamer.AddComment("DW_LNS_set_file arg count");
3283 Asm->EmitInt8(1);
3284 Asm->OutStreamer.AddComment("DW_LNS_set_column arg count");
3285 Asm->EmitInt8(1);
3286 Asm->OutStreamer.AddComment("DW_LNS_negate_stmt arg count");
3287 Asm->EmitInt8(0);
3288 Asm->OutStreamer.AddComment("DW_LNS_set_basic_block arg count");
3289 Asm->EmitInt8(0);
3290 Asm->OutStreamer.AddComment("DW_LNS_const_add_pc arg count");
3291 Asm->EmitInt8(0);
3292 Asm->OutStreamer.AddComment("DW_LNS_fixed_advance_pc arg count");
3293 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003294
3295 // Emit directories.
3296 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003297 const std::string &Dir = getSourceDirectoryName(DI);
Chris Lattner7bde8c02010-04-04 18:52:31 +00003298 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Directory");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003299 Asm->OutStreamer.EmitBytes(StringRef(Dir.c_str(), Dir.size()+1), 0);
Bill Wendling480ff322009-05-20 23:21:38 +00003300 }
3301
Chris Lattner566cae92010-03-09 23:52:58 +00003302 Asm->OutStreamer.AddComment("End of directories");
3303 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003304
3305 // Emit files.
3306 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
3307 // Remember source id starts at 1.
3308 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003309 const std::string &FN = getSourceFileName(Id.second);
Chris Lattner7bde8c02010-04-04 18:52:31 +00003310 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Source");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003311 Asm->OutStreamer.EmitBytes(StringRef(FN.c_str(), FN.size()+1), 0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003312
Chris Lattner9efd1182010-04-04 19:09:29 +00003313 Asm->EmitULEB128(Id.first, "Directory #");
3314 Asm->EmitULEB128(0, "Mod date");
3315 Asm->EmitULEB128(0, "File size");
Bill Wendling480ff322009-05-20 23:21:38 +00003316 }
3317
Chris Lattner566cae92010-03-09 23:52:58 +00003318 Asm->OutStreamer.AddComment("End of files");
3319 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003320
Chris Lattnera179b522010-04-04 19:25:43 +00003321 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003322
3323 // A sequence for each text section.
3324 unsigned SecSrcLinesSize = SectionSourceLines.size();
3325
3326 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
3327 // Isolate current sections line info.
3328 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
3329
Bill Wendling480ff322009-05-20 23:21:38 +00003330 // Dwarf assumes we start with first line of first source file.
3331 unsigned Source = 1;
3332 unsigned Line = 1;
3333
3334 // Construct rows of the address, source, line, column matrix.
3335 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
3336 const SrcLineInfo &LineInfo = LineInfos[i];
Chris Lattnerb4666f42010-03-14 08:15:55 +00003337 MCSymbol *Label = LineInfo.getLabel();
Chris Lattneree95d4c2010-03-14 02:20:58 +00003338 if (!Label->isDefined()) continue; // Not emitted, in dead code.
Bill Wendling480ff322009-05-20 23:21:38 +00003339
Chris Lattner3d72a672010-03-09 23:38:23 +00003340 if (Asm->isVerbose()) {
Chris Lattner7e998b72010-03-10 01:04:13 +00003341 std::pair<unsigned, unsigned> SrcID =
Bill Wendling480ff322009-05-20 23:21:38 +00003342 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner7e998b72010-03-10 01:04:13 +00003343 Asm->OutStreamer.AddComment(Twine(getSourceDirectoryName(SrcID.first)) +
Chris Lattnera26fbe42010-03-10 02:29:31 +00003344 "/" +
3345 Twine(getSourceFileName(SrcID.second)) +
Chris Lattner7e998b72010-03-10 01:04:13 +00003346 ":" + Twine(LineInfo.getLine()));
Bill Wendling480ff322009-05-20 23:21:38 +00003347 }
3348
3349 // Define the line address.
Chris Lattner566cae92010-03-09 23:52:58 +00003350 Asm->OutStreamer.AddComment("Extended Op");
3351 Asm->EmitInt8(0);
3352 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003353 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00003354
3355 Asm->OutStreamer.AddComment("DW_LNE_set_address");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003356 Asm->EmitInt8(dwarf::DW_LNE_set_address);
Chris Lattner566cae92010-03-09 23:52:58 +00003357
3358 Asm->OutStreamer.AddComment("Location label");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003359 Asm->OutStreamer.EmitSymbolValue(Label,
3360 Asm->getTargetData().getPointerSize(),
Chris Lattneree95d4c2010-03-14 02:20:58 +00003361 0/*AddrSpace*/);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003362
Bill Wendling480ff322009-05-20 23:21:38 +00003363 // If change of source, then switch to the new source.
3364 if (Source != LineInfo.getSourceID()) {
3365 Source = LineInfo.getSourceID();
Chris Lattner566cae92010-03-09 23:52:58 +00003366 Asm->OutStreamer.AddComment("DW_LNS_set_file");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003367 Asm->EmitInt8(dwarf::DW_LNS_set_file);
Chris Lattner9efd1182010-04-04 19:09:29 +00003368 Asm->EmitULEB128(Source, "New Source");
Bill Wendling480ff322009-05-20 23:21:38 +00003369 }
3370
3371 // If change of line.
3372 if (Line != LineInfo.getLine()) {
3373 // Determine offset.
3374 int Offset = LineInfo.getLine() - Line;
3375 int Delta = Offset - MinLineDelta;
3376
3377 // Update line.
3378 Line = LineInfo.getLine();
3379
3380 // If delta is small enough and in range...
3381 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
3382 // ... then use fast opcode.
Chris Lattner566cae92010-03-09 23:52:58 +00003383 Asm->OutStreamer.AddComment("Line Delta");
3384 Asm->EmitInt8(Delta - MinLineDelta);
Bill Wendling480ff322009-05-20 23:21:38 +00003385 } else {
3386 // ... otherwise use long hand.
Chris Lattner566cae92010-03-09 23:52:58 +00003387 Asm->OutStreamer.AddComment("DW_LNS_advance_line");
Bill Wendling480ff322009-05-20 23:21:38 +00003388 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
Chris Lattner9efd1182010-04-04 19:09:29 +00003389 Asm->EmitSLEB128(Offset, "Line Offset");
Chris Lattner566cae92010-03-09 23:52:58 +00003390 Asm->OutStreamer.AddComment("DW_LNS_copy");
3391 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling480ff322009-05-20 23:21:38 +00003392 }
3393 } else {
3394 // Copy the previous row (different address or source)
Chris Lattner566cae92010-03-09 23:52:58 +00003395 Asm->OutStreamer.AddComment("DW_LNS_copy");
3396 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling480ff322009-05-20 23:21:38 +00003397 }
3398 }
3399
Devang Patel930143b2009-11-21 02:48:08 +00003400 emitEndOfLineMatrix(j + 1);
Bill Wendling480ff322009-05-20 23:21:38 +00003401 }
3402
3403 if (SecSrcLinesSize == 0)
3404 // Because we're emitting a debug_line section, we still need a line
3405 // table. The linker and friends expect it to exist. If there's nothing to
3406 // put into it, emit an empty table.
Devang Patel930143b2009-11-21 02:48:08 +00003407 emitEndOfLineMatrix(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003408
Chris Lattnera179b522010-04-04 19:25:43 +00003409 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003410}
3411
Devang Patel930143b2009-11-21 02:48:08 +00003412/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling480ff322009-05-20 23:21:38 +00003413///
Devang Patel930143b2009-11-21 02:48:08 +00003414void DwarfDebug::emitCommonDebugFrame() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003415 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003416 return;
3417
Chris Lattner3a383cb2010-04-05 00:13:49 +00003418 int stackGrowth = Asm->getTargetData().getPointerSize();
3419 if (Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3420 TargetFrameInfo::StackGrowsDown)
3421 stackGrowth *= -1;
Bill Wendling480ff322009-05-20 23:21:38 +00003422
3423 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003424 Asm->OutStreamer.SwitchSection(
3425 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003426
Chris Lattnera179b522010-04-04 19:25:43 +00003427 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner566cae92010-03-09 23:52:58 +00003428 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003429 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3430 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003431
Chris Lattnera179b522010-04-04 19:25:43 +00003432 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner566cae92010-03-09 23:52:58 +00003433 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling480ff322009-05-20 23:21:38 +00003434 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner566cae92010-03-09 23:52:58 +00003435 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling480ff322009-05-20 23:21:38 +00003436 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner566cae92010-03-09 23:52:58 +00003437 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003438 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner9efd1182010-04-04 19:09:29 +00003439 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3440 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner566cae92010-03-09 23:52:58 +00003441 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003442 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling480ff322009-05-20 23:21:38 +00003443 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling480ff322009-05-20 23:21:38 +00003444
3445 std::vector<MachineMove> Moves;
3446 RI->getInitialFrameState(Moves);
3447
Chris Lattneraabc6042010-04-04 23:41:46 +00003448 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003449
Chris Lattner9e06e532010-04-28 01:05:45 +00003450 Asm->EmitAlignment(2);
Chris Lattnera179b522010-04-04 19:25:43 +00003451 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003452}
3453
Devang Patel930143b2009-11-21 02:48:08 +00003454/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling480ff322009-05-20 23:21:38 +00003455/// section.
Chris Lattner2c3f4782010-03-13 07:26:18 +00003456void DwarfDebug::
3457emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003458 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003459 return;
3460
3461 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003462 Asm->OutStreamer.SwitchSection(
3463 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003464
Chris Lattner566cae92010-03-09 23:52:58 +00003465 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner2c3f4782010-03-13 07:26:18 +00003466 MCSymbol *DebugFrameBegin =
Chris Lattnera179b522010-04-04 19:25:43 +00003467 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003468 MCSymbol *DebugFrameEnd =
Chris Lattnera179b522010-04-04 19:25:43 +00003469 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnerf1429f12010-04-04 19:58:12 +00003470 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003471
Chris Lattner2c3f4782010-03-13 07:26:18 +00003472 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling480ff322009-05-20 23:21:38 +00003473
Chris Lattner566cae92010-03-09 23:52:58 +00003474 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003475 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner70a4fce2010-04-04 23:25:33 +00003476 DwarfFrameSectionSym);
Bill Wendling480ff322009-05-20 23:21:38 +00003477
Chris Lattner566cae92010-03-09 23:52:58 +00003478 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnera179b522010-04-04 19:25:43 +00003479 MCSymbol *FuncBeginSym =
3480 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattner8811e122010-03-13 07:40:56 +00003481 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattner3a383cb2010-04-05 00:13:49 +00003482 Asm->getTargetData().getPointerSize(),
3483 0/*AddrSpace*/);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003484
3485
Chris Lattner566cae92010-03-09 23:52:58 +00003486 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003487 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003488 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003489
Chris Lattneraabc6042010-04-04 23:41:46 +00003490 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003491
Chris Lattner9e06e532010-04-28 01:05:45 +00003492 Asm->EmitAlignment(2);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003493 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling480ff322009-05-20 23:21:38 +00003494}
3495
Devang Patel9ccfb642009-12-09 18:24:21 +00003496/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3497///
3498void DwarfDebug::emitDebugPubNames() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003499 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3500 E = CUMap.end(); I != E; ++I) {
3501 CompileUnit *TheCU = I->second;
3502 // Start the dwarf pubnames section.
3503 Asm->OutStreamer.SwitchSection(
3504 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003505
Devang Patel1a0df9a2010-05-10 22:49:55 +00003506 Asm->OutStreamer.AddComment("Length of Public Names Info");
3507 Asm->EmitLabelDifference(
3508 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3509 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003510
Devang Patel1a0df9a2010-05-10 22:49:55 +00003511 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3512 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003513
Devang Patel1a0df9a2010-05-10 22:49:55 +00003514 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003515 Asm->EmitInt16(dwarf::DWARF_VERSION);
3516
Devang Patel1a0df9a2010-05-10 22:49:55 +00003517 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003518 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00003519 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003520
Devang Patel1a0df9a2010-05-10 22:49:55 +00003521 Asm->OutStreamer.AddComment("Compilation Unit Length");
3522 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3523 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3524 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003525
Devang Patel1a0df9a2010-05-10 22:49:55 +00003526 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3527 for (StringMap<DIE*>::const_iterator
3528 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3529 const char *Name = GI->getKeyData();
3530 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003531
Devang Patel1a0df9a2010-05-10 22:49:55 +00003532 Asm->OutStreamer.AddComment("DIE offset");
3533 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003534
Devang Patel1a0df9a2010-05-10 22:49:55 +00003535 if (Asm->isVerbose())
3536 Asm->OutStreamer.AddComment("External Name");
3537 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3538 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003539
Devang Patel1a0df9a2010-05-10 22:49:55 +00003540 Asm->OutStreamer.AddComment("End Mark");
3541 Asm->EmitInt32(0);
3542 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3543 TheCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00003544 }
Bill Wendling480ff322009-05-20 23:21:38 +00003545}
3546
Devang Patel04d2f2d2009-11-24 01:14:22 +00003547void DwarfDebug::emitDebugPubTypes() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003548 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3549 E = CUMap.end(); I != E; ++I) {
3550 CompileUnit *TheCU = I->second;
3551 // Start the dwarf pubnames section.
3552 Asm->OutStreamer.SwitchSection(
3553 Asm->getObjFileLowering().getDwarfPubTypesSection());
3554 Asm->OutStreamer.AddComment("Length of Public Types Info");
3555 Asm->EmitLabelDifference(
3556 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3557 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003558
Devang Patel1a0df9a2010-05-10 22:49:55 +00003559 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3560 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003561
Devang Patel1a0df9a2010-05-10 22:49:55 +00003562 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3563 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003564
Devang Patel1a0df9a2010-05-10 22:49:55 +00003565 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3566 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3567 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003568
Devang Patel1a0df9a2010-05-10 22:49:55 +00003569 Asm->OutStreamer.AddComment("Compilation Unit Length");
3570 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3571 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3572 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003573
Devang Patel1a0df9a2010-05-10 22:49:55 +00003574 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3575 for (StringMap<DIE*>::const_iterator
3576 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3577 const char *Name = GI->getKeyData();
3578 DIE * Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003579
Devang Patel1a0df9a2010-05-10 22:49:55 +00003580 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3581 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003582
Devang Patel1a0df9a2010-05-10 22:49:55 +00003583 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3584 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3585 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003586
Devang Patel1a0df9a2010-05-10 22:49:55 +00003587 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003588 Asm->EmitInt32(0);
Devang Patel1a0df9a2010-05-10 22:49:55 +00003589 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3590 TheCU->getID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00003591 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00003592}
3593
Devang Patel930143b2009-11-21 02:48:08 +00003594/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling480ff322009-05-20 23:21:38 +00003595///
Devang Patel930143b2009-11-21 02:48:08 +00003596void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00003597 // Check to see if it is worth the effort.
Chris Lattner3d72a672010-03-09 23:38:23 +00003598 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003599
Chris Lattner3d72a672010-03-09 23:38:23 +00003600 // Start the dwarf str section.
3601 Asm->OutStreamer.SwitchSection(
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003602 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003603
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003604 // Get all of the string pool entries and put them in an array by their ID so
3605 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003606 SmallVector<std::pair<unsigned,
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003607 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003608
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003609 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3610 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3611 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003612
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003613 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003614
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003615 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00003616 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003617 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003618
Chris Lattner3d72a672010-03-09 23:38:23 +00003619 // Emit the string itself.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003620 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003621 }
3622}
3623
Devang Patel930143b2009-11-21 02:48:08 +00003624/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling480ff322009-05-20 23:21:38 +00003625///
Devang Patel930143b2009-11-21 02:48:08 +00003626void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003627 if (DotDebugLocEntries.empty())
3628 return;
3629
Bill Wendling480ff322009-05-20 23:21:38 +00003630 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003631 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00003632 Asm->getObjFileLowering().getDwarfLocSection());
3633 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003634 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3635 unsigned index = 1;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003636 for (SmallVector<DotDebugLocEntry, 4>::iterator
3637 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00003638 I != E; ++I, ++index) {
Devang Patel9fc11702010-05-25 23:40:22 +00003639 DotDebugLocEntry Entry = *I;
Devang Patel9fc11702010-05-25 23:40:22 +00003640 if (Entry.isEmpty()) {
3641 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3642 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003643 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00003644 } else {
3645 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3646 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3647 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3648 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patel0e60e672010-08-04 18:40:52 +00003649 if (int Offset = Entry.Loc.getOffset()) {
3650 // If the value is at a certain offset from frame register then
3651 // use DW_OP_fbreg.
3652 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patel9fc11702010-05-25 23:40:22 +00003653 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patel0e60e672010-08-04 18:40:52 +00003654 Asm->EmitInt16(1 + OffsetSize);
3655 Asm->OutStreamer.AddComment(
3656 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3657 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3658 Asm->OutStreamer.AddComment("Offset");
3659 Asm->EmitSLEB128(Offset);
Devang Patel9fc11702010-05-25 23:40:22 +00003660 } else {
Devang Patel0e60e672010-08-04 18:40:52 +00003661 if (Reg < 32) {
3662 Asm->OutStreamer.AddComment("Loc expr size");
3663 Asm->EmitInt16(1);
3664 Asm->OutStreamer.AddComment(
Devang Patel6d21f612010-08-04 20:32:36 +00003665 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patel0e60e672010-08-04 18:40:52 +00003666 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3667 } else {
3668 Asm->OutStreamer.AddComment("Loc expr size");
3669 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3670 Asm->EmitInt8(dwarf::DW_OP_regx);
3671 Asm->EmitULEB128(Reg);
3672 }
Devang Patel9fc11702010-05-25 23:40:22 +00003673 }
3674 }
3675 }
Bill Wendling480ff322009-05-20 23:21:38 +00003676}
3677
3678/// EmitDebugARanges - Emit visible names into a debug aranges section.
3679///
3680void DwarfDebug::EmitDebugARanges() {
3681 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003682 Asm->OutStreamer.SwitchSection(
3683 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003684}
3685
Devang Patel930143b2009-11-21 02:48:08 +00003686/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling480ff322009-05-20 23:21:38 +00003687///
Devang Patel930143b2009-11-21 02:48:08 +00003688void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00003689 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003690 Asm->OutStreamer.SwitchSection(
Devang Patel12563b32010-04-16 23:33:45 +00003691 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Patel6c74a872010-04-27 19:46:33 +00003692 unsigned char Size = Asm->getTargetData().getPointerSize();
3693 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003694 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00003695 I != E; ++I) {
3696 if (*I)
3697 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patel12563b32010-04-16 23:33:45 +00003698 else
Devang Patel6c74a872010-04-27 19:46:33 +00003699 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel12563b32010-04-16 23:33:45 +00003700 }
Bill Wendling480ff322009-05-20 23:21:38 +00003701}
3702
Devang Patel930143b2009-11-21 02:48:08 +00003703/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling480ff322009-05-20 23:21:38 +00003704///
Devang Patel930143b2009-11-21 02:48:08 +00003705void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003706 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00003707 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00003708 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003709 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003710 }
3711}
3712
Devang Patel930143b2009-11-21 02:48:08 +00003713/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling480ff322009-05-20 23:21:38 +00003714/// Section Header:
3715/// 1. length of section
3716/// 2. Dwarf version number
3717/// 3. address size.
3718///
3719/// Entries (one "entry" for each function that was inlined):
3720///
3721/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3722/// otherwise offset into __debug_str for regular function name.
3723/// 2. offset into __debug_str section for regular function name.
3724/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3725/// instances for the function.
3726///
3727/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3728/// inlined instance; the die_offset points to the inlined_subroutine die in the
3729/// __debug_info section, and the low_pc is the starting address for the
3730/// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00003731void DwarfDebug::emitDebugInlineInfo() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003732 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003733 return;
3734
Devang Patel1a0df9a2010-05-10 22:49:55 +00003735 if (!FirstCU)
Bill Wendling480ff322009-05-20 23:21:38 +00003736 return;
3737
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003738 Asm->OutStreamer.SwitchSection(
3739 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003740
Chris Lattner566cae92010-03-09 23:52:58 +00003741 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003742 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3743 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003744
Chris Lattnera179b522010-04-04 19:25:43 +00003745 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003746
Chris Lattner566cae92010-03-09 23:52:58 +00003747 Asm->OutStreamer.AddComment("Dwarf Version");
3748 Asm->EmitInt16(dwarf::DWARF_VERSION);
3749 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003750 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003751
Devang Patel32cc43c2010-05-07 20:54:48 +00003752 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003753 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00003754
Devang Patel32cc43c2010-05-07 20:54:48 +00003755 const MDNode *Node = *I;
3756 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00003757 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003758 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00003759 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00003760 StringRef LName = SP.getLinkageName();
3761 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00003762
Chris Lattner566cae92010-03-09 23:52:58 +00003763 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003764 if (LName.empty()) {
3765 Asm->OutStreamer.EmitBytes(Name, 0);
3766 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003767 } else
Chris Lattner70a4fce2010-04-04 23:25:33 +00003768 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3769 DwarfStrSectionSym);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003770
Chris Lattner566cae92010-03-09 23:52:58 +00003771 Asm->OutStreamer.AddComment("Function name");
Chris Lattner70a4fce2010-04-04 23:25:33 +00003772 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner9efd1182010-04-04 19:09:29 +00003773 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00003774
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003775 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00003776 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner7bde8c02010-04-04 18:52:31 +00003777 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner085b6522010-03-09 00:31:02 +00003778 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003779
Chris Lattner7bde8c02010-04-04 18:52:31 +00003780 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003781 Asm->OutStreamer.EmitSymbolValue(LI->first,
3782 Asm->getTargetData().getPointerSize(),0);
Bill Wendling480ff322009-05-20 23:21:38 +00003783 }
3784 }
3785
Chris Lattnera179b522010-04-04 19:25:43 +00003786 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003787}