blob: 5c63ab5563cda14b75efd49c4c74eff10b42c194 [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"
Devang Patel2d9e5322011-01-20 00:02:16 +000019#include "llvm/Instructions.h"
David Greene829b3e82009-08-19 21:52:55 +000020#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000021#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000022#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000023#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000024#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000025#include "llvm/MC/MCSymbol.h"
Chris Lattnerf62e3ee2010-01-16 21:57:06 +000026#include "llvm/Target/Mangler.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000027#include "llvm/Target/TargetData.h"
Anton Korobeynikov2f931282011-01-10 12:39:04 +000028#include "llvm/Target/TargetFrameLowering.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000029#include "llvm/Target/TargetLoweringObjectFile.h"
Chris Lattner21dc46e2010-04-04 18:06:11 +000030#include "llvm/Target/TargetMachine.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000031#include "llvm/Target/TargetRegisterInfo.h"
Devang Patel61880932010-04-19 19:14:02 +000032#include "llvm/Target/TargetOptions.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000033#include "llvm/Analysis/DebugInfo.h"
Devang Patela86114b2010-10-25 20:45:32 +000034#include "llvm/ADT/Statistic.h"
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000035#include "llvm/ADT/STLExtras.h"
Chris Lattner06fa1762009-08-24 03:52:50 +000036#include "llvm/ADT/StringExtras.h"
Devang Patel6c74a872010-04-27 19:46:33 +000037#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000038#include "llvm/Support/Debug.h"
39#include "llvm/Support/ErrorHandling.h"
Devang Patel1973df22010-01-26 21:39:14 +000040#include "llvm/Support/ValueHandle.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000041#include "llvm/Support/FormattedStream.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000042#include "llvm/Support/Timer.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000043#include "llvm/Support/Path.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000044using namespace llvm;
45
Devang Patel6c74a872010-04-27 19:46:33 +000046static cl::opt<bool> PrintDbgScope("print-dbgscope", cl::Hidden,
47 cl::desc("Print DbgScope information for each machine instruction"));
48
Jim Grosbacha8683bb2010-07-21 21:21:52 +000049static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel30265c42010-07-07 20:12:52 +000050 cl::Hidden,
Devang Patel6c74a872010-04-27 19:46:33 +000051 cl::desc("Disable debug info printing"));
52
Dan Gohman7421ae42010-05-07 01:08:53 +000053static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
54 cl::desc("Make an absense of debug location information explicit."),
55 cl::init(false));
56
Nick Lewycky90b2ac22010-10-26 00:51:57 +000057#ifndef NDEBUG
Devang Patela86114b2010-10-25 20:45:32 +000058STATISTIC(BlocksWithoutLineNo, "Number of blocks without any line number");
Nick Lewycky90b2ac22010-10-26 00:51:57 +000059#endif
Devang Patela86114b2010-10-25 20:45:32 +000060
Bill Wendlingfcc14142010-04-07 09:28:04 +000061namespace {
62 const char *DWARFGroupName = "DWARF Emission";
63 const char *DbgTimerName = "DWARF Debug Writer";
64} // end anonymous namespace
65
Bill Wendling2f921f82009-05-15 09:23:25 +000066//===----------------------------------------------------------------------===//
67
68/// Configuration values for initial hash set sizes (log2).
69///
Bill Wendling2f921f82009-05-15 09:23:25 +000070static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +000071
72namespace llvm {
73
74//===----------------------------------------------------------------------===//
75/// CompileUnit - This dwarf writer support class manages information associate
76/// with a source file.
Nick Lewyckyb7993d62009-11-17 08:11:44 +000077class CompileUnit {
Bill Wendling2f921f82009-05-15 09:23:25 +000078 /// ID - File identifier for source.
79 ///
80 unsigned ID;
81
82 /// Die - Compile unit debug information entry.
83 ///
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000084 const OwningPtr<DIE> CUDie;
Bill Wendling2f921f82009-05-15 09:23:25 +000085
Jeffrey Yasskin0708de12010-03-11 18:29:55 +000086 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
Devang Patel92e8c652009-11-21 00:31:03 +000087 DIE *IndexTyDie;
88
Devang Patel9a0339f2010-07-07 20:49:57 +000089 /// MDNodeToDieMap - Tracks the mapping of unit level debug informaton
Bill Wendling2f921f82009-05-15 09:23:25 +000090 /// variables to debug information entries.
Devang Patel9a0339f2010-07-07 20:49:57 +000091 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
Bill Wendling2f921f82009-05-15 09:23:25 +000092
Devang Patel9a0339f2010-07-07 20:49:57 +000093 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug informaton
Bill Wendling2f921f82009-05-15 09:23:25 +000094 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patel9a0339f2010-07-07 20:49:57 +000095 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
Bill Wendling2f921f82009-05-15 09:23:25 +000096
97 /// Globals - A map of globally visible named entities for this unit.
98 ///
99 StringMap<DIE*> Globals;
100
Devang Patel04d2f2d2009-11-24 01:14:22 +0000101 /// GlobalTypes - A map of globally visible types for this unit.
102 ///
103 StringMap<DIE*> GlobalTypes;
104
Bill Wendling2f921f82009-05-15 09:23:25 +0000105public:
106 CompileUnit(unsigned I, DIE *D)
Devang Patel930143b2009-11-21 02:48:08 +0000107 : ID(I), CUDie(D), IndexTyDie(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000108
109 // Accessors.
Devang Patel04d2f2d2009-11-24 01:14:22 +0000110 unsigned getID() const { return ID; }
Jeffrey Yasskin0708de12010-03-11 18:29:55 +0000111 DIE* getCUDie() const { return CUDie.get(); }
Devang Patel04d2f2d2009-11-24 01:14:22 +0000112 const StringMap<DIE*> &getGlobals() const { return Globals; }
113 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000114
115 /// hasContent - Return true if this compile unit has something to write out.
116 ///
Devang Patel930143b2009-11-21 02:48:08 +0000117 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000118
Devang Patel930143b2009-11-21 02:48:08 +0000119 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +0000120 ///
Benjamin Kramer96956ed2010-03-31 20:15:45 +0000121 void addGlobal(StringRef Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000122
Devang Patel04d2f2d2009-11-24 01:14:22 +0000123 /// addGlobalType - Add a new global type to the compile unit.
124 ///
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000125 void addGlobalType(StringRef Name, DIE *Die) {
126 GlobalTypes[Name] = Die;
Devang Patel04d2f2d2009-11-24 01:14:22 +0000127 }
128
Devang Patele064ad42009-11-20 21:37:22 +0000129 /// getDIE - Returns the debug information entry map slot for the
Bill Wendling2f921f82009-05-15 09:23:25 +0000130 /// specified debug variable.
Devang Patel9a0339f2010-07-07 20:49:57 +0000131 DIE *getDIE(const MDNode *N) { return MDNodeToDieMap.lookup(N); }
Jim Grosbach042483e2009-11-21 23:12:12 +0000132
Devang Patele064ad42009-11-20 21:37:22 +0000133 /// insertDIE - Insert DIE into the map.
Devang Patel32cc43c2010-05-07 20:54:48 +0000134 void insertDIE(const MDNode *N, DIE *D) {
Devang Patel9a0339f2010-07-07 20:49:57 +0000135 MDNodeToDieMap.insert(std::make_pair(N, D));
Devang Patele064ad42009-11-20 21:37:22 +0000136 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000137
Devang Patele064ad42009-11-20 21:37:22 +0000138 /// getDIEEntry - Returns the debug information entry for the speciefied
139 /// debug variable.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000140 DIEEntry *getDIEEntry(const MDNode *N) {
141 DenseMap<const MDNode *, DIEEntry *>::iterator I =
142 MDNodeToDIEEntryMap.find(N);
Devang Patel9a0339f2010-07-07 20:49:57 +0000143 if (I == MDNodeToDIEEntryMap.end())
Devang Patel1f4690c2009-12-15 19:16:48 +0000144 return NULL;
145 return I->second;
146 }
Devang Patele064ad42009-11-20 21:37:22 +0000147
148 /// insertDIEEntry - Insert debug information entry into the map.
Devang Patel32cc43c2010-05-07 20:54:48 +0000149 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
Devang Patel9a0339f2010-07-07 20:49:57 +0000150 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
Bill Wendling2f921f82009-05-15 09:23:25 +0000151 }
152
Devang Patel930143b2009-11-21 02:48:08 +0000153 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +0000154 ///
Devang Patel930143b2009-11-21 02:48:08 +0000155 void addDie(DIE *Buffer) {
156 this->CUDie->addChild(Buffer);
Bill Wendling2f921f82009-05-15 09:23:25 +0000157 }
Devang Patel92e8c652009-11-21 00:31:03 +0000158
159 // getIndexTyDie - Get an anonymous type for index type.
160 DIE *getIndexTyDie() {
161 return IndexTyDie;
162 }
163
Jim Grosbach00e9c612009-11-22 19:20:36 +0000164 // setIndexTyDie - Set D as anonymous type for index which can be reused
165 // later.
Devang Patel92e8c652009-11-21 00:31:03 +0000166 void setIndexTyDie(DIE *D) {
167 IndexTyDie = D;
168 }
169
Bill Wendling2f921f82009-05-15 09:23:25 +0000170};
171
172//===----------------------------------------------------------------------===//
173/// DbgVariable - This class is used to track local variable information.
174///
Devang Patelf3d7c082009-11-16 21:53:40 +0000175class DbgVariable {
Bill Wendling2f921f82009-05-15 09:23:25 +0000176 DIVariable Var; // Variable Descriptor.
Devang Patel9fc11702010-05-25 23:40:22 +0000177 DIE *TheDIE; // Variable DIE.
178 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
Bill Wendling2f921f82009-05-15 09:23:25 +0000179public:
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000180 // AbsVar may be NULL.
Devang Patel9fc11702010-05-25 23:40:22 +0000181 DbgVariable(DIVariable V) : Var(V), TheDIE(0), DotDebugLocOffset(~0U) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000182
183 // Accessors.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000184 DIVariable getVariable() const { return Var; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000185 void setDIE(DIE *D) { TheDIE = D; }
186 DIE *getDIE() const { return TheDIE; }
Devang Patel9fc11702010-05-25 23:40:22 +0000187 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
188 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000189 StringRef getName() const { return Var.getName(); }
190 unsigned getTag() const { return Var.getTag(); }
191 bool variableHasComplexAddress() const {
192 assert(Var.Verify() && "Invalid complex DbgVariable!");
193 return Var.hasComplexAddress();
194 }
195 bool isBlockByrefVariable() const {
196 assert(Var.Verify() && "Invalid complex DbgVariable!");
197 return Var.isBlockByrefVariable();
198 }
199 unsigned getNumAddrElements() const {
200 assert(Var.Verify() && "Invalid complex DbgVariable!");
201 return Var.getNumAddrElements();
202 }
203 uint64_t getAddrElement(unsigned i) const {
204 return Var.getAddrElement(i);
205 }
206 DIType getType() const {
207 DIType Ty = Var.getType();
208 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
209 // addresses instead.
210 if (Var.isBlockByrefVariable()) {
211 /* Byref variables, in Blocks, are declared by the programmer as
212 "SomeType VarName;", but the compiler creates a
213 __Block_byref_x_VarName struct, and gives the variable VarName
214 either the struct, or a pointer to the struct, as its type. This
215 is necessary for various behind-the-scenes things the compiler
216 needs to do with by-reference variables in blocks.
217
218 However, as far as the original *programmer* is concerned, the
219 variable should still have type 'SomeType', as originally declared.
220
221 The following function dives into the __Block_byref_x_VarName
222 struct to find the original type of the variable. This will be
223 passed back to the code generating the type for the Debug
224 Information Entry for the variable 'VarName'. 'VarName' will then
225 have the original type 'SomeType' in its debug information.
226
227 The original type 'SomeType' will be the type of the field named
228 'VarName' inside the __Block_byref_x_VarName struct.
229
230 NOTE: In order for this to not completely fail on the debugger
231 side, the Debug Information Entry for the variable VarName needs to
232 have a DW_AT_location that tells the debugger how to unwind through
233 the pointers and __Block_byref_x_VarName struct to find the actual
234 value of the variable. The function addBlockByrefType does this. */
235 DIType subType = Ty;
236 unsigned tag = Ty.getTag();
237
238 if (tag == dwarf::DW_TAG_pointer_type) {
239 DIDerivedType DTy = DIDerivedType(Ty);
240 subType = DTy.getTypeDerivedFrom();
241 }
242
243 DICompositeType blockStruct = DICompositeType(subType);
244 DIArray Elements = blockStruct.getTypeArray();
245
246 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
247 DIDescriptor Element = Elements.getElement(i);
248 DIDerivedType DT = DIDerivedType(Element);
249 if (getName() == DT.getName())
250 return (DT.getTypeDerivedFrom());
251 }
252 return Ty;
253 }
254 return Ty;
255 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000256};
257
258//===----------------------------------------------------------------------===//
Devang Patel6c74a872010-04-27 19:46:33 +0000259/// DbgRange - This is used to track range of instructions with identical
260/// debug info scope.
261///
262typedef std::pair<const MachineInstr *, const MachineInstr *> DbgRange;
263
264//===----------------------------------------------------------------------===//
Bill Wendling2f921f82009-05-15 09:23:25 +0000265/// DbgScope - This class is used to track scope information.
266///
Devang Patelf3d7c082009-11-16 21:53:40 +0000267class DbgScope {
Bill Wendling2f921f82009-05-15 09:23:25 +0000268 DbgScope *Parent; // Parent to this scope.
Jim Grosbach042483e2009-11-21 23:12:12 +0000269 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel1973df22010-01-26 21:39:14 +0000270 // Location at which this scope is inlined.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000271 AssertingVH<const MDNode> InlinedAtLocation;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000272 bool AbstractScope; // Abstract Scope
Devang Patel787f94c2009-10-01 18:25:23 +0000273 const MachineInstr *LastInsn; // Last instruction of this scope.
274 const MachineInstr *FirstInsn; // First instruction of this scope.
Devang Patel6c74a872010-04-27 19:46:33 +0000275 unsigned DFSIn, DFSOut;
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000276 // Scopes defined in scope. Contents not owned.
277 SmallVector<DbgScope *, 4> Scopes;
278 // Variables declared in scope. Contents owned.
279 SmallVector<DbgVariable *, 8> Variables;
Devang Patel6c74a872010-04-27 19:46:33 +0000280 SmallVector<DbgRange, 4> Ranges;
Owen Anderson9becc182009-06-24 22:53:20 +0000281 // Private state for dump()
282 mutable unsigned IndentLevel;
Bill Wendling2f921f82009-05-15 09:23:25 +0000283public:
Devang Patel32cc43c2010-05-07 20:54:48 +0000284 DbgScope(DbgScope *P, DIDescriptor D, const MDNode *I = 0)
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000285 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Devang Patel6c74a872010-04-27 19:46:33 +0000286 LastInsn(0), FirstInsn(0),
287 DFSIn(0), DFSOut(0), IndentLevel(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000288 virtual ~DbgScope();
289
290 // Accessors.
291 DbgScope *getParent() const { return Parent; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000292 void setParent(DbgScope *P) { Parent = P; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000293 DIDescriptor getDesc() const { return Desc; }
Devang Patel32cc43c2010-05-07 20:54:48 +0000294 const MDNode *getInlinedAt() const { return InlinedAtLocation; }
295 const MDNode *getScopeNode() const { return Desc; }
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000296 const SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
Devang Patel406798a2010-08-09 18:51:29 +0000297 const SmallVector<DbgVariable *, 8> &getDbgVariables() { return Variables; }
Devang Patel6c74a872010-04-27 19:46:33 +0000298 const SmallVector<DbgRange, 4> &getRanges() { return Ranges; }
299
300 /// openInsnRange - This scope covers instruction range starting from MI.
301 void openInsnRange(const MachineInstr *MI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000302 if (!FirstInsn)
Devang Patel6c74a872010-04-27 19:46:33 +0000303 FirstInsn = MI;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000304
Devang Patel6c74a872010-04-27 19:46:33 +0000305 if (Parent)
306 Parent->openInsnRange(MI);
307 }
308
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000309 /// extendInsnRange - Extend the current instruction range covered by
Devang Patel6c74a872010-04-27 19:46:33 +0000310 /// this scope.
311 void extendInsnRange(const MachineInstr *MI) {
312 assert (FirstInsn && "MI Range is not open!");
313 LastInsn = MI;
314 if (Parent)
315 Parent->extendInsnRange(MI);
316 }
317
318 /// closeInsnRange - Create a range based on FirstInsn and LastInsn collected
319 /// until now. This is used when a new scope is encountered while walking
320 /// machine instructions.
321 void closeInsnRange(DbgScope *NewScope = NULL) {
322 assert (LastInsn && "Last insn missing!");
323 Ranges.push_back(DbgRange(FirstInsn, LastInsn));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000324 FirstInsn = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +0000325 LastInsn = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000326 // If Parent dominates NewScope then do not close Parent's instruction
Devang Patel6c74a872010-04-27 19:46:33 +0000327 // range.
328 if (Parent && (!NewScope || !Parent->dominates(NewScope)))
329 Parent->closeInsnRange(NewScope);
330 }
331
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000332 void setAbstractScope() { AbstractScope = true; }
333 bool isAbstractScope() const { return AbstractScope; }
Devang Patel6c74a872010-04-27 19:46:33 +0000334
335 // Depth First Search support to walk and mainpluate DbgScope hierarchy.
336 unsigned getDFSOut() const { return DFSOut; }
337 void setDFSOut(unsigned O) { DFSOut = O; }
338 unsigned getDFSIn() const { return DFSIn; }
339 void setDFSIn(unsigned I) { DFSIn = I; }
340 bool dominates(const DbgScope *S) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000341 if (S == this)
Devang Patel6c74a872010-04-27 19:46:33 +0000342 return true;
343 if (DFSIn < S->getDFSIn() && DFSOut > S->getDFSOut())
344 return true;
345 return false;
346 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000347
Devang Patel930143b2009-11-21 02:48:08 +0000348 /// addScope - Add a scope to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000349 ///
Devang Patel930143b2009-11-21 02:48:08 +0000350 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000351
Devang Patel930143b2009-11-21 02:48:08 +0000352 /// addVariable - Add a variable to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000353 ///
Devang Patel930143b2009-11-21 02:48:08 +0000354 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000355
Bill Wendling2f921f82009-05-15 09:23:25 +0000356#ifndef NDEBUG
357 void dump() const;
358#endif
359};
Devang Patel6c74a872010-04-27 19:46:33 +0000360
Chris Lattnerf5d06362010-04-05 04:09:20 +0000361} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000362
363#ifndef NDEBUG
364void DbgScope::dump() const {
David Greenec230cb92009-12-24 00:31:35 +0000365 raw_ostream &err = dbgs();
Chris Lattner81e8e022009-08-23 00:51:00 +0000366 err.indent(IndentLevel);
Devang Patel32cc43c2010-05-07 20:54:48 +0000367 const MDNode *N = Desc;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000368 N->dump();
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000369 if (AbstractScope)
370 err << "Abstract Scope\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000371
372 IndentLevel += 2;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000373 if (!Scopes.empty())
374 err << "Children ...\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000375 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
376 if (Scopes[i] != this)
377 Scopes[i]->dump();
378
379 IndentLevel -= 2;
380}
381#endif
382
Bill Wendling2f921f82009-05-15 09:23:25 +0000383DbgScope::~DbgScope() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000384 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
385 delete Variables[j];
Bill Wendling2f921f82009-05-15 09:23:25 +0000386}
387
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000388DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Devang Patel1a0df9a2010-05-10 22:49:55 +0000389 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000390 AbbreviationsSet(InitAbbreviationsSetSize),
Devang Patel12563b32010-04-16 23:33:45 +0000391 CurrentFnDbgScope(0), PrevLabel(NULL) {
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000392 NextStringPoolNumber = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000393
Chris Lattnere58b5472010-04-04 23:10:38 +0000394 DwarfFrameSectionSym = DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
395 DwarfStrSectionSym = TextSectionSym = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000396 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000397 FunctionBeginSym = FunctionEndSym = 0;
Devang Patel9c160e12010-07-08 20:10:35 +0000398 DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
Dan Gohman6e681a52010-06-18 15:56:31 +0000399 {
400 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
401 beginModule(M);
Torok Edwinf8dba242010-04-07 10:44:46 +0000402 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000403}
404DwarfDebug::~DwarfDebug() {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000405 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
406 DIEBlocks[j]->~DIEBlock();
Bill Wendling2f921f82009-05-15 09:23:25 +0000407}
408
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000409MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
410 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
411 if (Entry.first) return Entry.first;
412
413 Entry.second = NextStringPoolNumber++;
Chris Lattnera179b522010-04-04 19:25:43 +0000414 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000415}
416
417
Devang Patel930143b2009-11-21 02:48:08 +0000418/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling2f921f82009-05-15 09:23:25 +0000419///
Devang Patel930143b2009-11-21 02:48:08 +0000420void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000421 // Profile the node so that we can make it unique.
422 FoldingSetNodeID ID;
423 Abbrev.Profile(ID);
424
425 // Check the set for priors.
426 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
427
428 // If it's newly added.
429 if (InSet == &Abbrev) {
430 // Add to abbreviation list.
431 Abbreviations.push_back(&Abbrev);
432
433 // Assign the vector position + 1 as its number.
434 Abbrev.setNumber(Abbreviations.size());
435 } else {
436 // Assign existing abbreviation number.
437 Abbrev.setNumber(InSet->getNumber());
438 }
439}
440
Devang Patel930143b2009-11-21 02:48:08 +0000441/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendlingbcad77a2009-05-20 23:24:48 +0000442/// information entry.
Devang Patel930143b2009-11-21 02:48:08 +0000443DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000444 DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000445 return Value;
446}
447
Devang Patel930143b2009-11-21 02:48:08 +0000448/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000449///
Devang Patel930143b2009-11-21 02:48:08 +0000450void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000451 unsigned Form, uint64_t Integer) {
452 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000453 DIEValue *Value = Integer == 1 ?
Devang Patel9c160e12010-07-08 20:10:35 +0000454 DIEIntegerOne : new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000455 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000456}
457
Devang Patel930143b2009-11-21 02:48:08 +0000458/// addSInt - Add an signed integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000459///
Devang Patel930143b2009-11-21 02:48:08 +0000460void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000461 unsigned Form, int64_t Integer) {
462 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000463 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000464 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000465}
466
Devang Patel8c339592009-12-02 15:25:16 +0000467/// addString - Add a string attribute data and value. DIEString only
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000468/// keeps string reference.
Devang Patel930143b2009-11-21 02:48:08 +0000469void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerc3f23b82010-01-23 03:11:46 +0000470 StringRef String) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000471 DIEValue *Value = new (DIEValueAllocator) DIEString(String);
Devang Patel930143b2009-11-21 02:48:08 +0000472 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000473}
474
Devang Patel930143b2009-11-21 02:48:08 +0000475/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000476///
Devang Patel930143b2009-11-21 02:48:08 +0000477void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000478 const MCSymbol *Label) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000479 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
Devang Patel930143b2009-11-21 02:48:08 +0000480 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000481}
482
Devang Patel930143b2009-11-21 02:48:08 +0000483/// addDelta - Add a label delta attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000484///
Devang Patel930143b2009-11-21 02:48:08 +0000485void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000486 const MCSymbol *Hi, const MCSymbol *Lo) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000487 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
Devang Patel930143b2009-11-21 02:48:08 +0000488 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000489}
490
Chris Lattner3f3fb972010-04-05 05:24:55 +0000491/// addDIEEntry - Add a DIE attribute data and value.
492///
493void DwarfDebug::addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form,
494 DIE *Entry) {
495 Die->addValue(Attribute, Form, createDIEEntry(Entry));
496}
497
498
Devang Patel930143b2009-11-21 02:48:08 +0000499/// addBlock - Add block data.
Bill Wendling2f921f82009-05-15 09:23:25 +0000500///
Devang Patel930143b2009-11-21 02:48:08 +0000501void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling2f921f82009-05-15 09:23:25 +0000502 DIEBlock *Block) {
Chris Lattner5a00dea2010-04-05 00:18:22 +0000503 Block->ComputeSize(Asm);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000504 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
Devang Patel930143b2009-11-21 02:48:08 +0000505 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000506}
507
Devang Patel930143b2009-11-21 02:48:08 +0000508/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000509/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000510void DwarfDebug::addSourceLine(DIE *Die, DIVariable V) {
Devang Patel0625af22010-05-07 23:33:41 +0000511 // Verify variable.
Devang Patelb6511a32010-08-09 20:20:05 +0000512 if (!V.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000513 return;
514
Devang Patelb6511a32010-08-09 20:20:05 +0000515 unsigned Line = V.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000516 if (Line == 0)
517 return;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000518 unsigned FileID = GetOrCreateSourceID(V.getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000519 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000520 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
521 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000522}
523
Devang Patel930143b2009-11-21 02:48:08 +0000524/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000525/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000526void DwarfDebug::addSourceLine(DIE *Die, DIGlobalVariable G) {
Devang Patel0625af22010-05-07 23:33:41 +0000527 // Verify global variable.
Devang Patelb6511a32010-08-09 20:20:05 +0000528 if (!G.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000529 return;
530
Devang Patelb6511a32010-08-09 20:20:05 +0000531 unsigned Line = G.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000532 if (Line == 0)
533 return;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000534 unsigned FileID = GetOrCreateSourceID(G.getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000535 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000536 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
537 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000538}
Devang Patelb2de5fa2009-08-31 22:47:13 +0000539
Devang Patel930143b2009-11-21 02:48:08 +0000540/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000541/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000542void DwarfDebug::addSourceLine(DIE *Die, DISubprogram SP) {
Devang Patel0625af22010-05-07 23:33:41 +0000543 // Verify subprogram.
Devang Patelb6511a32010-08-09 20:20:05 +0000544 if (!SP.Verify())
Devang Patelb2de5fa2009-08-31 22:47:13 +0000545 return;
Caroline Tice183a5192009-09-11 18:25:54 +0000546 // If the line number is 0, don't add it.
Devang Patelb6511a32010-08-09 20:20:05 +0000547 if (SP.getLineNumber() == 0)
Caroline Tice183a5192009-09-11 18:25:54 +0000548 return;
549
Devang Patelb6511a32010-08-09 20:20:05 +0000550 unsigned Line = SP.getLineNumber();
551 if (!SP.getContext().Verify())
Devang Patel8119fe872010-03-08 22:02:50 +0000552 return;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000553 unsigned FileID = GetOrCreateSourceID(SP.getFilename());
Devang Patelb2de5fa2009-08-31 22:47:13 +0000554 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000555 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
556 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patelb2de5fa2009-08-31 22:47:13 +0000557}
558
Devang Patel930143b2009-11-21 02:48:08 +0000559/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000560/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000561void DwarfDebug::addSourceLine(DIE *Die, DIType Ty) {
Devang Patel0625af22010-05-07 23:33:41 +0000562 // Verify type.
Devang Patelb6511a32010-08-09 20:20:05 +0000563 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000564 return;
565
Devang Patelb6511a32010-08-09 20:20:05 +0000566 unsigned Line = Ty.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000567 if (Line == 0 || !Ty.getContext().Verify())
Devang Patel8119fe872010-03-08 22:02:50 +0000568 return;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000569 unsigned FileID = GetOrCreateSourceID(Ty.getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000570 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000571 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
572 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000573}
574
Devang Patel1f4690c2009-12-15 19:16:48 +0000575/// addSourceLine - Add location information to specified debug information
576/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000577void DwarfDebug::addSourceLine(DIE *Die, DINameSpace NS) {
Devang Patel0625af22010-05-07 23:33:41 +0000578 // Verify namespace.
Devang Patelb6511a32010-08-09 20:20:05 +0000579 if (!NS.Verify())
Devang Patel1f4690c2009-12-15 19:16:48 +0000580 return;
581
Devang Patelb6511a32010-08-09 20:20:05 +0000582 unsigned Line = NS.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000583 if (Line == 0)
584 return;
Devang Patelb6511a32010-08-09 20:20:05 +0000585 StringRef FN = NS.getFilename();
Devang Patel1f4690c2009-12-15 19:16:48 +0000586
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000587 unsigned FileID = GetOrCreateSourceID(FN);
Devang Patel1f4690c2009-12-15 19:16:48 +0000588 assert(FileID && "Invalid file id");
589 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
590 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
591}
592
Devang Patel2cfc3af2010-08-31 06:11:28 +0000593/// addVariableAddress - Add DW_AT_location attribute for a DbgVariable based
594/// on provided frame index.
595void DwarfDebug::addVariableAddress(DbgVariable *&DV, DIE *Die, int64_t FI) {
596 MachineLocation Location;
597 unsigned FrameReg;
Anton Korobeynikov2f931282011-01-10 12:39:04 +0000598 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
Anton Korobeynikov46877782010-11-20 15:59:32 +0000599 int Offset = TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
Devang Patel2cfc3af2010-08-31 06:11:28 +0000600 Location.set(FrameReg, Offset);
601
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000602 if (DV->variableHasComplexAddress())
603 addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
604 else if (DV->isBlockByrefVariable())
605 addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
606 else
607 addAddress(Die, dwarf::DW_AT_location, Location);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000608}
609
Devang Patel930143b2009-11-21 02:48:08 +0000610/// addComplexAddress - Start with the address based on the location provided,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000611/// and generate the DWARF information necessary to find the actual variable
612/// given the extra address information encoded in the DIVariable, starting from
613/// the starting location. Add the DWARF information to the die.
614///
Devang Patel930143b2009-11-21 02:48:08 +0000615void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000616 unsigned Attribute,
617 const MachineLocation &Location) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000618 DIType Ty = DV->getType();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000619
620 // Decode the original location, and use that as the start of the byref
621 // variable's location.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000622 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000623 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000624 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000625
626 if (Location.isReg()) {
627 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000628 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000629 } else {
Devang Patel8698f092011-01-19 23:04:47 +0000630 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
Devang Patel930143b2009-11-21 02:48:08 +0000631 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000632 }
633 } else {
634 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000635 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000636 else {
Devang Patel930143b2009-11-21 02:48:08 +0000637 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
638 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000639 }
640
Devang Patel930143b2009-11-21 02:48:08 +0000641 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump14cf8ec2009-09-30 00:08:22 +0000642 }
643
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000644 for (unsigned i = 0, N = DV->getNumAddrElements(); i < N; ++i) {
645 uint64_t Element = DV->getAddrElement(i);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000646
647 if (Element == DIFactory::OpPlus) {
Devang Patel930143b2009-11-21 02:48:08 +0000648 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000649 addUInt(Block, 0, dwarf::DW_FORM_udata, DV->getAddrElement(++i));
Mike Stump14cf8ec2009-09-30 00:08:22 +0000650 } else if (Element == DIFactory::OpDeref) {
Devang Patel930143b2009-11-21 02:48:08 +0000651 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000652 } else llvm_unreachable("unknown DIFactory Opcode");
653 }
654
655 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000656 addBlock(Die, Attribute, 0, Block);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000657}
658
Caroline Ticec87c1e22009-08-31 21:19:37 +0000659/* Byref variables, in Blocks, are declared by the programmer as "SomeType
660 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
661 gives the variable VarName either the struct, or a pointer to the struct, as
662 its type. This is necessary for various behind-the-scenes things the
663 compiler needs to do with by-reference variables in Blocks.
664
665 However, as far as the original *programmer* is concerned, the variable
666 should still have type 'SomeType', as originally declared.
667
Devang Patel930143b2009-11-21 02:48:08 +0000668 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticec87c1e22009-08-31 21:19:37 +0000669 struct to find the original type of the variable, which is then assigned to
670 the variable's Debug Information Entry as its real type. So far, so good.
671 However now the debugger will expect the variable VarName to have the type
672 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000673 expression that explains to the debugger how to navigate through the
Caroline Ticec87c1e22009-08-31 21:19:37 +0000674 pointers and struct to find the actual variable of type SomeType.
675
676 The following function does just that. We start by getting
677 the "normal" location for the variable. This will be the location
678 of either the struct __Block_byref_x_VarName or the pointer to the
679 struct __Block_byref_x_VarName.
680
681 The struct will look something like:
682
683 struct __Block_byref_x_VarName {
684 ... <various fields>
685 struct __Block_byref_x_VarName *forwarding;
686 ... <various other fields>
687 SomeType VarName;
688 ... <maybe more fields>
689 };
690
691 If we are given the struct directly (as our starting point) we
692 need to tell the debugger to:
693
694 1). Add the offset of the forwarding field.
695
Dan Gohman4a618822010-02-10 16:03:48 +0000696 2). Follow that pointer to get the real __Block_byref_x_VarName
Caroline Ticec87c1e22009-08-31 21:19:37 +0000697 struct to use (the real one may have been copied onto the heap).
698
699 3). Add the offset for the field VarName, to find the actual variable.
700
701 If we started with a pointer to the struct, then we need to
702 dereference that pointer first, before the other steps.
703 Translating this into DWARF ops, we will need to append the following
704 to the current location description for the variable:
705
706 DW_OP_deref -- optional, if we start with a pointer
707 DW_OP_plus_uconst <forward_fld_offset>
708 DW_OP_deref
709 DW_OP_plus_uconst <varName_fld_offset>
710
711 That is what this function does. */
712
Devang Patel930143b2009-11-21 02:48:08 +0000713/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticec87c1e22009-08-31 21:19:37 +0000714/// provided, and generate the DWARF information necessary to find the
715/// actual Block variable (navigating the Block struct) based on the
716/// starting location. Add the DWARF information to the die. For
717/// more information, read large comment just above here.
718///
Devang Patel930143b2009-11-21 02:48:08 +0000719void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000720 unsigned Attribute,
721 const MachineLocation &Location) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000722 DIType Ty = DV->getType();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000723 DIType TmpTy = Ty;
724 unsigned Tag = Ty.getTag();
725 bool isPointer = false;
726
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000727 StringRef varName = DV->getName();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000728
729 if (Tag == dwarf::DW_TAG_pointer_type) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000730 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000731 TmpTy = DTy.getTypeDerivedFrom();
732 isPointer = true;
733 }
734
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000735 DICompositeType blockStruct = DICompositeType(TmpTy);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000736
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000737 // Find the __forwarding field and the variable field in the __Block_byref
738 // struct.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000739 DIArray Fields = blockStruct.getTypeArray();
740 DIDescriptor varField = DIDescriptor();
741 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000742
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000743 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
744 DIDescriptor Element = Fields.getElement(i);
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000745 DIDerivedType DT = DIDerivedType(Element);
Devang Patel2d9caf92009-11-25 17:36:49 +0000746 StringRef fieldName = DT.getName();
747 if (fieldName == "__forwarding")
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000748 forwardingField = Element;
Devang Patel2d9caf92009-11-25 17:36:49 +0000749 else if (fieldName == varName)
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000750 varField = Element;
751 }
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000752
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000753 // Get the offsets for the forwarding field and the variable field.
Chris Lattner71696ef2010-03-31 06:06:37 +0000754 unsigned forwardingFieldOffset =
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000755 DIDerivedType(forwardingField).getOffsetInBits() >> 3;
Chris Lattner71696ef2010-03-31 06:06:37 +0000756 unsigned varFieldOffset =
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000757 DIDerivedType(varField).getOffsetInBits() >> 3;
Caroline Ticec87c1e22009-08-31 21:19:37 +0000758
Mike Stump944fa252009-09-24 23:21:26 +0000759 // Decode the original location, and use that as the start of the byref
760 // variable's location.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000761 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000762 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000763 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000764
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000765 if (Location.isReg()) {
766 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000767 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000768 else {
Devang Patel8698f092011-01-19 23:04:47 +0000769 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
Devang Patel930143b2009-11-21 02:48:08 +0000770 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000771 }
772 } else {
773 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000774 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000775 else {
Devang Patel930143b2009-11-21 02:48:08 +0000776 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
777 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000778 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000779
Devang Patel930143b2009-11-21 02:48:08 +0000780 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000781 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000782
Mike Stump944fa252009-09-24 23:21:26 +0000783 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000784 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000785 if (isPointer)
Devang Patel930143b2009-11-21 02:48:08 +0000786 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000787
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000788 // Next add the offset for the '__forwarding' field:
789 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
790 // adding the offset if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000791 if (forwardingFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000792 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
793 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000794 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000795
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000796 // Now dereference the __forwarding field to get to the real __Block_byref
797 // struct: DW_OP_deref.
Devang Patel930143b2009-11-21 02:48:08 +0000798 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000799
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000800 // Now that we've got the real __Block_byref... struct, add the offset
801 // for the variable's field to get to the location of the actual variable:
802 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000803 if (varFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000804 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
805 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000806 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000807
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000808 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000809 addBlock(Die, Attribute, 0, Block);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000810}
811
Devang Patel930143b2009-11-21 02:48:08 +0000812/// addAddress - Add an address attribute to a die based on the location
Bill Wendling2f921f82009-05-15 09:23:25 +0000813/// provided.
Devang Patel930143b2009-11-21 02:48:08 +0000814void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000815 const MachineLocation &Location) {
Chris Lattner3a383cb2010-04-05 00:13:49 +0000816 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling2f921f82009-05-15 09:23:25 +0000817 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000818 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel804fcd42010-09-22 21:10:38 +0000819
Devang Patele7559662010-11-02 17:37:00 +0000820 if (RI->getFrameRegister(*Asm->MF) == Location.getReg()
Devang Patel804fcd42010-09-22 21:10:38 +0000821 && Location.getOffset()) {
822 // If variable offset is based in frame register then use fbreg.
823 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
824 addSInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
825 addBlock(Die, Attribute, 0, Block);
826 return;
827 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000828
829 if (Location.isReg()) {
830 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000831 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000832 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000833 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
834 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000835 }
836 } else {
837 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000838 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000839 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000840 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
841 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000842 }
843
Devang Patel930143b2009-11-21 02:48:08 +0000844 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling2f921f82009-05-15 09:23:25 +0000845 }
846
Devang Patel930143b2009-11-21 02:48:08 +0000847 addBlock(Die, Attribute, 0, Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000848}
849
Devang Patel173b2b92010-04-28 01:03:09 +0000850/// addRegisterAddress - Add register location entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000851bool DwarfDebug::addRegisterAddress(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000852 assert (MO.isReg() && "Invalid machine operand!");
853 if (!MO.getReg())
854 return false;
855 MachineLocation Location;
856 Location.set(MO.getReg());
857 addAddress(Die, dwarf::DW_AT_location, Location);
Devang Patel173b2b92010-04-28 01:03:09 +0000858 return true;
859}
860
861/// addConstantValue - Add constant value entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000862bool DwarfDebug::addConstantValue(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000863 assert (MO.isImm() && "Invalid machine operand!");
864 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
865 unsigned Imm = MO.getImm();
866 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
867 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patel173b2b92010-04-28 01:03:09 +0000868 return true;
869}
870
871/// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000872bool DwarfDebug::addConstantFPValue(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000873 assert (MO.isFPImm() && "Invalid machine operand!");
874 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
875 APFloat FPImm = MO.getFPImm()->getValueAPF();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000876
Devang Patel173b2b92010-04-28 01:03:09 +0000877 // Get the raw data form of the floating point.
878 const APInt FltVal = FPImm.bitcastToAPInt();
879 const char *FltPtr = (const char*)FltVal.getRawData();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000880
Devang Patel173b2b92010-04-28 01:03:09 +0000881 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
882 bool LittleEndian = Asm->getTargetData().isLittleEndian();
883 int Incr = (LittleEndian ? 1 : -1);
884 int Start = (LittleEndian ? 0 : NumBytes - 1);
885 int Stop = (LittleEndian ? NumBytes : -1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000886
Devang Patel173b2b92010-04-28 01:03:09 +0000887 // Output the constant to DWARF one byte at a time.
888 for (; Start != Stop; Start += Incr)
889 addUInt(Block, 0, dwarf::DW_FORM_data1,
890 (unsigned char)0xFF & FltPtr[Start]);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000891
Devang Patel173b2b92010-04-28 01:03:09 +0000892 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000893 return true;
Devang Patel173b2b92010-04-28 01:03:09 +0000894}
895
Devang Patel70eb9822011-01-06 21:39:25 +0000896/// addConstantValue - Add constant value entry in variable DIE.
897bool DwarfDebug::addConstantValue(DIE *Die, ConstantInt *CI,
898 bool Unsigned) {
899 if (CI->getBitWidth() <= 64) {
900 if (Unsigned)
901 addUInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
902 CI->getZExtValue());
903 else
904 addSInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
905 CI->getSExtValue());
906 return true;
907 }
908
909 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
910
911 // Get the raw data form of the large APInt.
912 const APInt Val = CI->getValue();
913 const char *Ptr = (const char*)Val.getRawData();
914
915 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
916 bool LittleEndian = Asm->getTargetData().isLittleEndian();
917 int Incr = (LittleEndian ? 1 : -1);
918 int Start = (LittleEndian ? 0 : NumBytes - 1);
919 int Stop = (LittleEndian ? NumBytes : -1);
920
921 // Output the constant to DWARF one byte at a time.
922 for (; Start != Stop; Start += Incr)
923 addUInt(Block, 0, dwarf::DW_FORM_data1,
924 (unsigned char)0xFF & Ptr[Start]);
925
926 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
927 return true;
928}
Devang Patel173b2b92010-04-28 01:03:09 +0000929
Devang Patel2b75ed22009-12-10 19:14:49 +0000930/// addToContextOwner - Add Die into the list of its context owner's children.
931void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000932 if (Context.isType()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000933 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
Devang Patel2b75ed22009-12-10 19:14:49 +0000934 ContextDIE->addChild(Die);
Devang Patel1f4690c2009-12-15 19:16:48 +0000935 } else if (Context.isNameSpace()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000936 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
Devang Patel1f4690c2009-12-15 19:16:48 +0000937 ContextDIE->addChild(Die);
Stuart Hastingsafe54f12010-06-11 20:08:44 +0000938 } else if (Context.isSubprogram()) {
Devang Patel185051c2010-09-27 23:15:27 +0000939 DIE *ContextDIE = createSubprogramDIE(DISubprogram(Context));
Stuart Hastingsafe54f12010-06-11 20:08:44 +0000940 ContextDIE->addChild(Die);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000941 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patel2b75ed22009-12-10 19:14:49 +0000942 ContextDIE->addChild(Die);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000943 else
Devang Patel1a0df9a2010-05-10 22:49:55 +0000944 getCompileUnit(Context)->addDie(Die);
Devang Patel2b75ed22009-12-10 19:14:49 +0000945}
946
Devang Patelb5b60ea2009-12-10 18:05:33 +0000947/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
948/// given DIType.
949DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000950 CompileUnit *TypeCU = getCompileUnit(Ty);
951 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000952 if (TyDIE)
953 return TyDIE;
954
955 // Create new type.
956 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000957 TypeCU->insertDIE(Ty, TyDIE);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000958 if (Ty.isBasicType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000959 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000960 else if (Ty.isCompositeType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000961 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000962 else {
963 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000964 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000965 }
966
Devang Patel2b75ed22009-12-10 19:14:49 +0000967 addToContextOwner(TyDIE, Ty.getContext());
Devang Patelb5b60ea2009-12-10 18:05:33 +0000968 return TyDIE;
969}
970
Devang Patel930143b2009-11-21 02:48:08 +0000971/// addType - Add a new type attribute to the specified entity.
Devang Patel9ccfb642009-12-09 18:24:21 +0000972void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel8d6a2b72010-05-07 21:45:47 +0000973 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000974 return;
975
976 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000977 CompileUnit *TypeCU = getCompileUnit(Ty);
978 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000979 // If it exists then use the existing value.
Devang Patel930143b2009-11-21 02:48:08 +0000980 if (Entry) {
981 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000982 return;
983 }
984
Bill Wendling2f921f82009-05-15 09:23:25 +0000985 // Construct type.
Devang Patelb5b60ea2009-12-10 18:05:33 +0000986 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000987
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000988 // Set up proxy.
989 Entry = createDIEEntry(Buffer);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000990 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000991
Devang Patel930143b2009-11-21 02:48:08 +0000992 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000993}
994
Devang Patel930143b2009-11-21 02:48:08 +0000995/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000996void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000997 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000998 StringRef Name = BTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +0000999 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +00001000 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling2f921f82009-05-15 09:23:25 +00001001 BTy.getEncoding());
1002
1003 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +00001004 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001005 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001006 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel930143b2009-11-21 02:48:08 +00001007 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001008}
1009
Devang Patel930143b2009-11-21 02:48:08 +00001010/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001011void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001012 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +00001013 StringRef Name = DTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001014 uint64_t Size = DTy.getSizeInBits() >> 3;
1015 unsigned Tag = DTy.getTag();
1016
1017 // FIXME - Workaround for templates.
1018 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
1019
1020 Buffer.setTag(Tag);
1021
1022 // Map to main type, void will not have a type.
1023 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel9ccfb642009-12-09 18:24:21 +00001024 addType(&Buffer, FromTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001025
1026 // Add name if not anonymous or intermediate type.
Devang Patelae466ef2009-11-30 23:56:56 +00001027 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001028 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001029
1030 // Add size if non-zero (derived types might be zero-sized.)
1031 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +00001032 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001033
1034 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patelb5b51592009-11-23 18:43:37 +00001035 if (!DTy.isForwardDecl())
Devang Patelb6511a32010-08-09 20:20:05 +00001036 addSourceLine(&Buffer, DTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001037}
1038
Devang Patel930143b2009-11-21 02:48:08 +00001039/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001040void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001041 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +00001042 StringRef Name = CTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001043
1044 uint64_t Size = CTy.getSizeInBits() >> 3;
1045 unsigned Tag = CTy.getTag();
1046 Buffer.setTag(Tag);
1047
1048 switch (Tag) {
1049 case dwarf::DW_TAG_vector_type:
1050 case dwarf::DW_TAG_array_type:
Devang Patel9ccfb642009-12-09 18:24:21 +00001051 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001052 break;
1053 case dwarf::DW_TAG_enumeration_type: {
1054 DIArray Elements = CTy.getTypeArray();
1055
1056 // Add enumerators to enumeration type.
1057 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1058 DIE *ElemDie = NULL;
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001059 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3b548aa2010-03-08 20:52:55 +00001060 if (Enum.isEnumerator()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001061 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel930143b2009-11-21 02:48:08 +00001062 Buffer.addChild(ElemDie);
Devang Patelfafa1fe2009-10-09 17:51:49 +00001063 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001064 }
1065 }
1066 break;
1067 case dwarf::DW_TAG_subroutine_type: {
1068 // Add return type.
1069 DIArray Elements = CTy.getTypeArray();
1070 DIDescriptor RTy = Elements.getElement(0);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001071 addType(&Buffer, DIType(RTy));
Bill Wendling2f921f82009-05-15 09:23:25 +00001072
Devang Patel9a33ec22010-10-06 20:50:40 +00001073 bool isPrototyped = true;
Bill Wendling2f921f82009-05-15 09:23:25 +00001074 // Add arguments.
1075 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001076 DIDescriptor Ty = Elements.getElement(i);
Devang Patel9a33ec22010-10-06 20:50:40 +00001077 if (Ty.isUnspecifiedParameter()) {
1078 DIE *Arg = new DIE(dwarf::DW_TAG_unspecified_parameters);
1079 Buffer.addChild(Arg);
1080 isPrototyped = false;
1081 } else {
1082 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1083 addType(Arg, DIType(Ty));
1084 Buffer.addChild(Arg);
1085 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001086 }
Devang Patel9a33ec22010-10-06 20:50:40 +00001087 // Add prototype flag.
1088 if (isPrototyped)
1089 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001090 }
1091 break;
1092 case dwarf::DW_TAG_structure_type:
1093 case dwarf::DW_TAG_union_type:
1094 case dwarf::DW_TAG_class_type: {
1095 // Add elements to structure type.
1096 DIArray Elements = CTy.getTypeArray();
1097
1098 // A forward struct declared type may not have elements available.
Devang Patel3b548aa2010-03-08 20:52:55 +00001099 unsigned N = Elements.getNumElements();
1100 if (N == 0)
Bill Wendling2f921f82009-05-15 09:23:25 +00001101 break;
1102
1103 // Add elements to structure type.
Devang Patel3b548aa2010-03-08 20:52:55 +00001104 for (unsigned i = 0; i < N; ++i) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001105 DIDescriptor Element = Elements.getElement(i);
1106 DIE *ElemDie = NULL;
Devang Patelcb03b142010-09-29 21:44:16 +00001107 if (Element.isSubprogram()) {
1108 DISubprogram SP(Element);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001109 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patelcb03b142010-09-29 21:44:16 +00001110 if (SP.isProtected())
1111 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1112 dwarf::DW_ACCESS_protected);
1113 else if (SP.isPrivate())
1114 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1115 dwarf::DW_ACCESS_private);
1116 else
1117 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1118 dwarf::DW_ACCESS_public);
Devang Patele1c71462010-10-01 23:31:40 +00001119 if (SP.isExplicit())
1120 addUInt(ElemDie, dwarf::DW_AT_explicit, dwarf::DW_FORM_flag, 1);
Devang Patelcb03b142010-09-29 21:44:16 +00001121 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001122 else if (Element.isVariable()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001123 DIVariable DV(Element);
Devang Patel160c92d2010-01-30 01:08:30 +00001124 ElemDie = new DIE(dwarf::DW_TAG_variable);
1125 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1126 DV.getName());
1127 addType(ElemDie, DV.getType());
1128 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1129 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patelb6511a32010-08-09 20:20:05 +00001130 addSourceLine(ElemDie, DV);
Devang Patel3b548aa2010-03-08 20:52:55 +00001131 } else if (Element.isDerivedType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001132 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3b548aa2010-03-08 20:52:55 +00001133 else
1134 continue;
Devang Patel930143b2009-11-21 02:48:08 +00001135 Buffer.addChild(ElemDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001136 }
1137
Devang Patel3082c012009-08-27 23:51:51 +00001138 if (CTy.isAppleBlockExtension())
Devang Patel930143b2009-11-21 02:48:08 +00001139 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001140
1141 unsigned RLang = CTy.getRunTimeLang();
1142 if (RLang)
Devang Patel930143b2009-11-21 02:48:08 +00001143 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling2f921f82009-05-15 09:23:25 +00001144 dwarf::DW_FORM_data1, RLang);
Devang Patel303a1be2010-01-26 21:16:06 +00001145
1146 DICompositeType ContainingType = CTy.getContainingType();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001147 if (DIDescriptor(ContainingType).isCompositeType())
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001148 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001149 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001150 else {
1151 DIDescriptor Context = CTy.getContext();
1152 addToContextOwner(&Buffer, Context);
1153 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001154 break;
1155 }
1156 default:
1157 break;
1158 }
1159
1160 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +00001161 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001162 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001163
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001164 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
Devang Patel30265c42010-07-07 20:12:52 +00001165 || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1166 {
Bill Wendling2f921f82009-05-15 09:23:25 +00001167 // Add size if non-zero (derived types might be zero-sized.)
1168 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +00001169 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001170 else {
1171 // Add zero size if it is not a forward declaration.
1172 if (CTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +00001173 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001174 else
Devang Patel930143b2009-11-21 02:48:08 +00001175 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling2f921f82009-05-15 09:23:25 +00001176 }
1177
1178 // Add source line info if available.
1179 if (!CTy.isForwardDecl())
Devang Patelb6511a32010-08-09 20:20:05 +00001180 addSourceLine(&Buffer, CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001181 }
1182}
1183
Devang Patel930143b2009-11-21 02:48:08 +00001184/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1185void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling2f921f82009-05-15 09:23:25 +00001186 int64_t L = SR.getLo();
1187 int64_t H = SR.getHi();
1188 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1189
Devang Patel930143b2009-11-21 02:48:08 +00001190 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patelf691df32009-08-14 20:59:16 +00001191 if (L)
Devang Patel930143b2009-11-21 02:48:08 +00001192 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Patel8f046022009-12-04 23:10:24 +00001193 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling2f921f82009-05-15 09:23:25 +00001194
Devang Patel930143b2009-11-21 02:48:08 +00001195 Buffer.addChild(DW_Subrange);
Bill Wendling2f921f82009-05-15 09:23:25 +00001196}
1197
Devang Patel930143b2009-11-21 02:48:08 +00001198/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001199void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling2f921f82009-05-15 09:23:25 +00001200 DICompositeType *CTy) {
1201 Buffer.setTag(dwarf::DW_TAG_array_type);
1202 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel930143b2009-11-21 02:48:08 +00001203 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001204
1205 // Emit derived type.
Devang Patel9ccfb642009-12-09 18:24:21 +00001206 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001207 DIArray Elements = CTy->getTypeArray();
1208
Devang Patel92e8c652009-11-21 00:31:03 +00001209 // Get an anonymous type for index type.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001210 CompileUnit *TheCU = getCompileUnit(*CTy);
1211 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel92e8c652009-11-21 00:31:03 +00001212 if (!IdxTy) {
1213 // Construct an anonymous type for index type.
1214 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +00001215 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1216 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel92e8c652009-11-21 00:31:03 +00001217 dwarf::DW_ATE_signed);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001218 TheCU->addDie(IdxTy);
1219 TheCU->setIndexTyDie(IdxTy);
Devang Patel92e8c652009-11-21 00:31:03 +00001220 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001221
1222 // Add subranges to array type.
1223 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1224 DIDescriptor Element = Elements.getElement(i);
1225 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001226 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001227 }
1228}
1229
Devang Patel930143b2009-11-21 02:48:08 +00001230/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3b548aa2010-03-08 20:52:55 +00001231DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001232 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3b548aa2010-03-08 20:52:55 +00001233 StringRef Name = ETy.getName();
Devang Patel930143b2009-11-21 02:48:08 +00001234 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3b548aa2010-03-08 20:52:55 +00001235 int64_t Value = ETy.getEnumValue();
Devang Patel930143b2009-11-21 02:48:08 +00001236 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +00001237 return Enumerator;
1238}
1239
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001240/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel43ef34d2010-01-05 01:46:14 +00001241/// printer to not emit usual symbol prefix before the symbol name is used then
1242/// return linkage name after skipping this special LLVM prefix.
1243static StringRef getRealLinkageName(StringRef LinkageName) {
1244 char One = '\1';
1245 if (LinkageName.startswith(StringRef(&One, 1)))
1246 return LinkageName.substr(1);
1247 return LinkageName;
1248}
1249
Devang Patel930143b2009-11-21 02:48:08 +00001250/// createMemberDIE - Create new member DIE.
Devang Patel18ba0b42010-08-10 04:12:17 +00001251DIE *DwarfDebug::createMemberDIE(DIDerivedType DT) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001252 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel2d9caf92009-11-25 17:36:49 +00001253 StringRef Name = DT.getName();
1254 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001255 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001256
Devang Patel9ccfb642009-12-09 18:24:21 +00001257 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001258
Devang Patelb6511a32010-08-09 20:20:05 +00001259 addSourceLine(MemberDie, DT);
Bill Wendling2f921f82009-05-15 09:23:25 +00001260
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001261 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel930143b2009-11-21 02:48:08 +00001262 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel67f56f02009-11-04 22:06:12 +00001263
Bill Wendling2f921f82009-05-15 09:23:25 +00001264 uint64_t Size = DT.getSizeInBits();
Devang Patelf05d5722009-11-04 23:48:00 +00001265 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling2f921f82009-05-15 09:23:25 +00001266
1267 if (Size != FieldSize) {
1268 // Handle bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001269 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1270 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling2f921f82009-05-15 09:23:25 +00001271
1272 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling2f921f82009-05-15 09:23:25 +00001273 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1274 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer2b459982010-01-07 17:50:57 +00001275 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling2f921f82009-05-15 09:23:25 +00001276 Offset -= FieldOffset;
1277
1278 // Maybe we need to work from the other end.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001279 if (Asm->getTargetData().isLittleEndian())
1280 Offset = FieldSize - (Offset + Size);
Devang Patel930143b2009-11-21 02:48:08 +00001281 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling2f921f82009-05-15 09:23:25 +00001282
Devang Patel67f56f02009-11-04 22:06:12 +00001283 // Here WD_AT_data_member_location points to the anonymous
1284 // field that includes this bit field.
Devang Patel930143b2009-11-21 02:48:08 +00001285 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001286
1287 } else
1288 // This is not a bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001289 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001290
Devang Pateld2316892010-02-03 20:08:48 +00001291 if (DT.getTag() == dwarf::DW_TAG_inheritance
1292 && DT.isVirtual()) {
1293
1294 // For C++, virtual base classes are not at fixed offset. Use following
1295 // expression to extract appropriate offset from vtable.
1296 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1297
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001298 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Pateld2316892010-02-03 20:08:48 +00001299 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1300 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1301 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1302 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1303 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1304 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1305 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1306
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001307 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
Devang Pateld2316892010-02-03 20:08:48 +00001308 VBaseLocationDie);
1309 } else
1310 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001311
1312 if (DT.isProtected())
Devang Pateleb57c592009-12-03 19:11:07 +00001313 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001314 dwarf::DW_ACCESS_protected);
1315 else if (DT.isPrivate())
Devang Pateleb57c592009-12-03 19:11:07 +00001316 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001317 dwarf::DW_ACCESS_private);
Devang Patela1bd5a12010-09-29 19:08:08 +00001318 // Otherwise C++ member and base classes are considered public.
1319 else if (DT.getCompileUnit().getLanguage() == dwarf::DW_LANG_C_plus_plus)
Devang Pateleb57c592009-12-03 19:11:07 +00001320 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1321 dwarf::DW_ACCESS_public);
1322 if (DT.isVirtual())
1323 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1324 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling2f921f82009-05-15 09:23:25 +00001325 return MemberDie;
1326}
1327
Devang Patel525dda02009-12-14 16:18:45 +00001328/// createSubprogramDIE - Create new DIE using SP.
Devang Patel185051c2010-09-27 23:15:27 +00001329DIE *DwarfDebug::createSubprogramDIE(DISubprogram SP) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001330 CompileUnit *SPCU = getCompileUnit(SP);
1331 DIE *SPDie = SPCU->getDIE(SP);
Devang Patel525dda02009-12-14 16:18:45 +00001332 if (SPDie)
1333 return SPDie;
1334
1335 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf200b392010-03-02 17:58:15 +00001336 // Constructors and operators for anonymous aggregates do not have names.
Devang Pateld0fa3042010-03-02 01:26:20 +00001337 if (!SP.getName().empty())
1338 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling2f921f82009-05-15 09:23:25 +00001339
Devang Patel2d9caf92009-11-25 17:36:49 +00001340 StringRef LinkageName = SP.getLinkageName();
Devang Patel43ef34d2010-01-05 01:46:14 +00001341 if (!LinkageName.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001342 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel43ef34d2010-01-05 01:46:14 +00001343 getRealLinkageName(LinkageName));
1344
Devang Patelb6511a32010-08-09 20:20:05 +00001345 addSourceLine(SPDie, SP);
Bill Wendling2f921f82009-05-15 09:23:25 +00001346
Devang Patel3a24f922010-10-07 22:03:01 +00001347 if (SP.isPrototyped())
Devang Patel930143b2009-11-21 02:48:08 +00001348 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001349
1350 // Add Return Type.
Devang Patel236526d2009-12-03 01:25:38 +00001351 DICompositeType SPTy = SP.getType();
1352 DIArray Args = SPTy.getTypeArray();
Bill Wendling2f921f82009-05-15 09:23:25 +00001353 unsigned SPTag = SPTy.getTag();
Devang Pateleb57c592009-12-03 19:11:07 +00001354
Devang Patel3b548aa2010-03-08 20:52:55 +00001355 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel9ccfb642009-12-09 18:24:21 +00001356 addType(SPDie, SPTy);
Devang Patel236526d2009-12-03 01:25:38 +00001357 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001358 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel236526d2009-12-03 01:25:38 +00001359
Devang Pateleb57c592009-12-03 19:11:07 +00001360 unsigned VK = SP.getVirtuality();
1361 if (VK) {
1362 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001363 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Pateleb57c592009-12-03 19:11:07 +00001364 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
Devang Patelc26da902010-12-09 00:10:40 +00001365 addUInt(Block, 0, dwarf::DW_FORM_udata, SP.getVirtualIndex());
Devang Pateleb57c592009-12-03 19:11:07 +00001366 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001367 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001368 SP.getContainingType()));
Devang Pateleb57c592009-12-03 19:11:07 +00001369 }
1370
Devang Patel185051c2010-09-27 23:15:27 +00001371 if (!SP.isDefinition()) {
Devang Patel930143b2009-11-21 02:48:08 +00001372 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001373
1374 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel236526d2009-12-03 01:25:38 +00001375 // be handled while processing variables.
1376 DICompositeType SPTy = SP.getType();
1377 DIArray Args = SPTy.getTypeArray();
1378 unsigned SPTag = SPTy.getTag();
1379
Bill Wendling2f921f82009-05-15 09:23:25 +00001380 if (SPTag == dwarf::DW_TAG_subroutine_type)
1381 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1382 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001383 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patel6efc8e52010-02-06 01:02:37 +00001384 addType(Arg, ATy);
1385 if (ATy.isArtificial())
1386 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel930143b2009-11-21 02:48:08 +00001387 SPDie->addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +00001388 }
1389 }
1390
Devang Patel999b4992010-02-03 19:57:19 +00001391 if (SP.isArtificial())
1392 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1393
Devang Patelb4e3b902010-04-30 19:38:23 +00001394 if (!SP.isLocalToUnit())
1395 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001396
Devang Patelb4e3b902010-04-30 19:38:23 +00001397 if (SP.isOptimized())
1398 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1399
Jim Grosbach965a73a2010-07-21 23:03:52 +00001400 if (unsigned isa = Asm->getISAEncoding()) {
1401 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1402 }
1403
Devang Patelb4e3b902010-04-30 19:38:23 +00001404 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001405 SPCU->insertDIE(SP, SPDie);
Devang Patelb4e3b902010-04-30 19:38:23 +00001406
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001407 // Add to context owner.
1408 addToContextOwner(SPDie, SP.getContext());
1409
Bill Wendling2f921f82009-05-15 09:23:25 +00001410 return SPDie;
1411}
1412
Devang Patel32cc43c2010-05-07 20:54:48 +00001413DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattner8d2fe282010-03-31 05:36:29 +00001414 assert(N && "Invalid Scope encoding!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001415
1416 DbgScope *AScope = AbstractScopes.lookup(N);
1417 if (AScope)
1418 return AScope;
Jim Grosbach042483e2009-11-21 23:12:12 +00001419
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001420 DbgScope *Parent = NULL;
1421
1422 DIDescriptor Scope(N);
1423 if (Scope.isLexicalBlock()) {
1424 DILexicalBlock DB(N);
1425 DIDescriptor ParentDesc = DB.getContext();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001426 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001427 }
1428
1429 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1430
1431 if (Parent)
Devang Patel930143b2009-11-21 02:48:08 +00001432 Parent->addScope(AScope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001433 AScope->setAbstractScope();
1434 AbstractScopes[N] = AScope;
1435 if (DIDescriptor(N).isSubprogram())
1436 AbstractScopesList.push_back(AScope);
1437 return AScope;
1438}
Devang Patel75cc16c2009-10-01 20:31:14 +00001439
Devang Patel019922d2010-04-06 23:53:48 +00001440/// isSubprogramContext - Return true if Context is either a subprogram
1441/// or another context nested inside a subprogram.
Devang Patel32cc43c2010-05-07 20:54:48 +00001442static bool isSubprogramContext(const MDNode *Context) {
Devang Patel019922d2010-04-06 23:53:48 +00001443 if (!Context)
1444 return false;
1445 DIDescriptor D(Context);
1446 if (D.isSubprogram())
1447 return true;
1448 if (D.isType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001449 return isSubprogramContext(DIType(Context).getContext());
Devang Patel019922d2010-04-06 23:53:48 +00001450 return false;
1451}
1452
Jim Grosbach042483e2009-11-21 23:12:12 +00001453/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel930143b2009-11-21 02:48:08 +00001454/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1455/// If there are global variables in this scope then create and insert
1456/// DIEs for these variables.
Devang Patel32cc43c2010-05-07 20:54:48 +00001457DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001458 CompileUnit *SPCU = getCompileUnit(SPNode);
1459 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +00001460
Chris Lattner3a383cb2010-04-05 00:13:49 +00001461 assert(SPDie && "Unable to find subprogram DIE!");
1462 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001463
Chris Lattner3a383cb2010-04-05 00:13:49 +00001464 // There is not any need to generate specification DIE for a function
1465 // defined at compile unit level. If a function is defined inside another
1466 // function then gdb prefers the definition at top level and but does not
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001467 // expect specification DIE in parent function. So avoid creating
Chris Lattner3a383cb2010-04-05 00:13:49 +00001468 // specification DIE for a function defined inside a function.
1469 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001470 !SP.getContext().isFile() &&
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001471 !isSubprogramContext(SP.getContext())) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00001472 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001473
1474 // Add arguments.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001475 DICompositeType SPTy = SP.getType();
1476 DIArray Args = SPTy.getTypeArray();
1477 unsigned SPTag = SPTy.getTag();
1478 if (SPTag == dwarf::DW_TAG_subroutine_type)
1479 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1480 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001481 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattner3a383cb2010-04-05 00:13:49 +00001482 addType(Arg, ATy);
1483 if (ATy.isArtificial())
1484 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1485 SPDie->addChild(Arg);
1486 }
1487 DIE *SPDeclDie = SPDie;
1488 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001489 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Chris Lattner3a383cb2010-04-05 00:13:49 +00001490 SPDeclDie);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001491 SPCU->addDie(SPDie);
Chris Lattner3a383cb2010-04-05 00:13:49 +00001492 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001493
Devang Patela37a95e2010-07-07 22:20:57 +00001494 // Pick up abstract subprogram DIE.
1495 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
1496 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1497 addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
1498 dwarf::DW_FORM_ref4, AbsSPDIE);
1499 SPCU->addDie(SPDie);
1500 }
1501
Chris Lattner3a383cb2010-04-05 00:13:49 +00001502 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1503 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1504 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1505 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1506 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1507 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1508 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +00001509
Chris Lattner3a383cb2010-04-05 00:13:49 +00001510 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001511}
1512
Jim Grosbach042483e2009-11-21 23:12:12 +00001513/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel930143b2009-11-21 02:48:08 +00001514/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1515DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001516
1517 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1518 if (Scope->isAbstractScope())
1519 return ScopeDIE;
1520
1521 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1522 if (Ranges.empty())
1523 return 0;
1524
1525 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1526 if (Ranges.size() > 1) {
1527 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001528 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +00001529 // DW_AT_ranges appropriately.
1530 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1531 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1532 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1533 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +00001534 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1535 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +00001536 }
1537 DebugRangeSymbols.push_back(NULL);
1538 DebugRangeSymbols.push_back(NULL);
1539 return ScopeDIE;
1540 }
1541
Devang Patel9fc11702010-05-25 23:40:22 +00001542 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1543 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001544
Devang Patel9fc11702010-05-25 23:40:22 +00001545 if (End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001546
Chris Lattnere13c3722010-03-09 01:58:53 +00001547 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1548 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001549
Devang Patel6c74a872010-04-27 19:46:33 +00001550 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1551 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001552
1553 return ScopeDIE;
1554}
1555
Devang Patel930143b2009-11-21 02:48:08 +00001556/// constructInlinedScopeDIE - This scope represents inlined body of
1557/// a function. Construct DIE to represent this concrete inlined copy
1558/// of the function.
1559DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001560
1561 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001562 assert (Ranges.empty() == false
Devang Patel6c74a872010-04-27 19:46:33 +00001563 && "DbgScope does not have instruction markers!");
1564
1565 // FIXME : .debug_inlined section specification does not clearly state how
1566 // to emit inlined scope that is split into multiple instruction ranges.
1567 // For now, use first instruction range and emit low_pc/high_pc pair and
1568 // corresponding .debug_inlined section entry for this pair.
1569 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel9fc11702010-05-25 23:40:22 +00001570 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1571 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001572
Devang Patel4c6bd662010-07-08 22:39:20 +00001573 if (StartLabel == 0 || EndLabel == 0) {
Devang Patel6c74a872010-04-27 19:46:33 +00001574 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1575 return 0;
1576 }
Chris Lattnere13c3722010-03-09 01:58:53 +00001577 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001578 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +00001579 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001580 "Invalid end label for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +00001581
Devang Patel3b548aa2010-03-08 20:52:55 +00001582 if (!Scope->getScopeNode())
Devang Patelbc97f6b2010-03-08 19:20:38 +00001583 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001584 DIScope DS(Scope->getScopeNode());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001585 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1586
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001587 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001588 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1589 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001590 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel930143b2009-11-21 02:48:08 +00001591 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001592 dwarf::DW_FORM_ref4, OriginDIE);
1593
Chris Lattner085b6522010-03-09 00:31:02 +00001594 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnere13c3722010-03-09 01:58:53 +00001595 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001596
1597 InlinedSubprogramDIEs.insert(OriginDIE);
1598
1599 // Track the start label for this inlined function.
Devang Patel32cc43c2010-05-07 20:54:48 +00001600 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001601 I = InlineInfo.find(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001602
1603 if (I == InlineInfo.end()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001604 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach00e9c612009-11-22 19:20:36 +00001605 ScopeDIE));
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001606 InlinedSPNodes.push_back(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001607 } else
Chris Lattner085b6522010-03-09 00:31:02 +00001608 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001609
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001610 DILocation DL(Scope->getInlinedAt());
Devang Patel1a0df9a2010-05-10 22:49:55 +00001611 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel930143b2009-11-21 02:48:08 +00001612 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001613
1614 return ScopeDIE;
1615}
1616
Devang Patel930143b2009-11-21 02:48:08 +00001617
1618/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel9ccfb642009-12-09 18:24:21 +00001619DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001620 StringRef Name = DV->getName();
Devang Patel2d9caf92009-11-25 17:36:49 +00001621 if (Name.empty())
Devang Patel97f99fa2009-11-13 02:25:26 +00001622 return NULL;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001623
1624 // Translate tag to proper Dwarf tag. The result variable is dropped for
1625 // now.
1626 unsigned Tag;
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001627 switch (DV->getTag()) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001628 case dwarf::DW_TAG_return_variable:
1629 return NULL;
1630 case dwarf::DW_TAG_arg_variable:
1631 Tag = dwarf::DW_TAG_formal_parameter;
1632 break;
1633 case dwarf::DW_TAG_auto_variable: // fall thru
1634 default:
1635 Tag = dwarf::DW_TAG_variable;
1636 break;
1637 }
1638
1639 // Define variable debug information entry.
1640 DIE *VariableDie = new DIE(Tag);
1641
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001642 DIE *AbsDIE = NULL;
Devang Patele1c53f22010-05-20 16:36:41 +00001643 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1644 V2AVI = VarToAbstractVarMap.find(DV);
1645 if (V2AVI != VarToAbstractVarMap.end())
1646 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach042483e2009-11-21 23:12:12 +00001647
Devang Patele1c53f22010-05-20 16:36:41 +00001648 if (AbsDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001649 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001650 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001651 else {
Devang Patel930143b2009-11-21 02:48:08 +00001652 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001653 addSourceLine(VariableDie, DV->getVariable());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001654
1655 // Add variable type.
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001656 addType(VariableDie, DV->getType());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001657 }
1658
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001659 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patel6efc8e52010-02-06 01:02:37 +00001660 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelbea08d12010-09-29 23:07:21 +00001661 else if (DIVariable(DV->getVariable()).isArtificial())
1662 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel9fc11702010-05-25 23:40:22 +00001663
1664 if (Scope->isAbstractScope()) {
1665 DV->setDIE(VariableDie);
1666 return VariableDie;
1667 }
1668
1669 // Add variable address.
1670
1671 unsigned Offset = DV->getDotDebugLocOffset();
1672 if (Offset != ~0U) {
1673 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1674 Asm->GetTempSymbol("debug_loc", Offset));
1675 DV->setDIE(VariableDie);
1676 UseDotDebugLocEntry.insert(VariableDie);
1677 return VariableDie;
1678 }
1679
1680 // Check if variable is described by a DBG_VALUE instruction.
1681 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1682 DbgVariableToDbgInstMap.find(DV);
1683 if (DVI != DbgVariableToDbgInstMap.end()) {
1684 const MachineInstr *DVInsn = DVI->second;
Devang Patel9fc11702010-05-25 23:40:22 +00001685 bool updated = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001686 // FIXME : Handle getNumOperands != 3
Devang Patel9fc11702010-05-25 23:40:22 +00001687 if (DVInsn->getNumOperands() == 3) {
Devang Patel86ec8b32010-08-31 22:22:42 +00001688 if (DVInsn->getOperand(0).isReg()) {
1689 const MachineOperand RegOp = DVInsn->getOperand(0);
1690 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1691 if (DVInsn->getOperand(1).isImm() &&
1692 TRI->getFrameRegister(*Asm->MF) == RegOp.getReg()) {
1693 addVariableAddress(DV, VariableDie, DVInsn->getOperand(1).getImm());
1694 updated = true;
1695 } else
Devang Patel53a40df62010-11-12 23:20:42 +00001696 updated = addRegisterAddress(VariableDie, RegOp);
Devang Patel86ec8b32010-08-31 22:22:42 +00001697 }
Devang Patel9fc11702010-05-25 23:40:22 +00001698 else if (DVInsn->getOperand(0).isImm())
Devang Patel53a40df62010-11-12 23:20:42 +00001699 updated = addConstantValue(VariableDie, DVInsn->getOperand(0));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001700 else if (DVInsn->getOperand(0).isFPImm())
1701 updated =
Devang Patel53a40df62010-11-12 23:20:42 +00001702 addConstantFPValue(VariableDie, DVInsn->getOperand(0));
Devang Patel9fc11702010-05-25 23:40:22 +00001703 } else {
1704 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1705 if (Location.getReg()) {
1706 addAddress(VariableDie, dwarf::DW_AT_location, Location);
Devang Patel9fc11702010-05-25 23:40:22 +00001707 updated = true;
1708 }
1709 }
1710 if (!updated) {
1711 // If variableDie is not updated then DBG_VALUE instruction does not
1712 // have valid variable info.
1713 delete VariableDie;
1714 return NULL;
1715 }
1716 DV->setDIE(VariableDie);
1717 return VariableDie;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001718 }
Devang Patel9fc11702010-05-25 23:40:22 +00001719
1720 // .. else use frame index, if available.
Devang Patel9fc11702010-05-25 23:40:22 +00001721 int FI = 0;
Devang Patel2cfc3af2010-08-31 06:11:28 +00001722 if (findVariableFrameIndex(DV, &FI))
1723 addVariableAddress(DV, VariableDie, FI);
1724
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001725 DV->setDIE(VariableDie);
1726 return VariableDie;
1727
1728}
Devang Patel930143b2009-11-21 02:48:08 +00001729
Devang Patel04d2f2d2009-11-24 01:14:22 +00001730void DwarfDebug::addPubTypes(DISubprogram SP) {
1731 DICompositeType SPTy = SP.getType();
1732 unsigned SPTag = SPTy.getTag();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001733 if (SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel04d2f2d2009-11-24 01:14:22 +00001734 return;
1735
1736 DIArray Args = SPTy.getTypeArray();
Devang Patel04d2f2d2009-11-24 01:14:22 +00001737 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001738 DIType ATy(Args.getElement(i));
Devang Patel8d6a2b72010-05-07 21:45:47 +00001739 if (!ATy.Verify())
Devang Patel04d2f2d2009-11-24 01:14:22 +00001740 continue;
1741 DICompositeType CATy = getDICompositeType(ATy);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001742 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel12d150e2010-04-13 20:35:04 +00001743 && !CATy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001744 CompileUnit *TheCU = getCompileUnit(CATy);
1745 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1746 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00001747 }
1748 }
1749}
1750
Devang Patel930143b2009-11-21 02:48:08 +00001751/// constructScopeDIE - Construct a DIE for this scope.
1752DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +00001753 if (!Scope || !Scope->getScopeNode())
1754 return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001755
Devang Patel3b548aa2010-03-08 20:52:55 +00001756 DIScope DS(Scope->getScopeNode());
1757 DIE *ScopeDIE = NULL;
1758 if (Scope->getInlinedAt())
1759 ScopeDIE = constructInlinedScopeDIE(Scope);
1760 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +00001761 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001762 if (Scope->isAbstractScope()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001763 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001764 // Note down abstract DIE.
1765 if (ScopeDIE)
1766 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
1767 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001768 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001769 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3b548aa2010-03-08 20:52:55 +00001770 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001771 else
Devang Patel3b548aa2010-03-08 20:52:55 +00001772 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel23b2ae62010-03-29 22:59:58 +00001773 if (!ScopeDIE) return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001774
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001775 // Add variables to scope.
Devang Patel406798a2010-08-09 18:51:29 +00001776 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001777 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel9ccfb642009-12-09 18:24:21 +00001778 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach042483e2009-11-21 23:12:12 +00001779 if (VariableDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001780 ScopeDIE->addChild(VariableDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001781 }
1782
1783 // Add nested scopes.
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001784 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001785 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1786 // Define the Scope debug information entry.
Devang Patel930143b2009-11-21 02:48:08 +00001787 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach042483e2009-11-21 23:12:12 +00001788 if (NestedDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001789 ScopeDIE->addChild(NestedDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001790 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001791
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001792 if (DS.isSubprogram())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001793 addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001794
Devang Patel04d2f2d2009-11-24 01:14:22 +00001795 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001796}
1797
Bill Wendling2b128d72009-05-20 23:19:06 +00001798/// GetOrCreateSourceID - Look up the source id with the given directory and
1799/// source file names. If none currently exists, create a new id and insert it
1800/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1801/// maps as well.
Devang Patel498877d2010-07-24 00:53:22 +00001802
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001803unsigned DwarfDebug::GetOrCreateSourceID(StringRef FileName){
Devang Patel871d0b12010-09-16 20:57:49 +00001804 // If FE did not provide a file name, then assume stdin.
1805 if (FileName.empty())
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001806 return GetOrCreateSourceID("<stdin>");
Devang Patel871d0b12010-09-16 20:57:49 +00001807
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001808 StringMapEntry<unsigned> &Entry = SourceIdMap.GetOrCreateValue(FileName);
1809 if (Entry.getValue())
1810 return Entry.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +00001811
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001812 unsigned SrcId = SourceIdMap.size();
1813 Entry.setValue(SrcId);
Bill Wendling2b128d72009-05-20 23:19:06 +00001814
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001815 // Print out a .file directive to specify files for .loc directives.
1816 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, FileName);
Bill Wendling2b128d72009-05-20 23:19:06 +00001817
1818 return SrcId;
1819}
1820
Devang Patel1f4690c2009-12-15 19:16:48 +00001821/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1822DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001823 CompileUnit *TheCU = getCompileUnit(NS);
1824 DIE *NDie = TheCU->getDIE(NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001825 if (NDie)
1826 return NDie;
1827 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001828 TheCU->insertDIE(NS, NDie);
Devang Patel1f4690c2009-12-15 19:16:48 +00001829 if (!NS.getName().empty())
1830 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
Devang Patelb6511a32010-08-09 20:20:05 +00001831 addSourceLine(NDie, NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001832 addToContextOwner(NDie, NS.getContext());
1833 return NDie;
1834}
1835
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001836/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel1a0df9a2010-05-10 22:49:55 +00001837/// metadata node with tag DW_TAG_compile_unit.
Devang Patel32cc43c2010-05-07 20:54:48 +00001838void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001839 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +00001840 StringRef FN = DIUnit.getFilename();
1841 StringRef Dir = DIUnit.getDirectory();
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001842 unsigned ID = GetOrCreateSourceID(FN);
Bill Wendling2b128d72009-05-20 23:19:06 +00001843
1844 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel930143b2009-11-21 02:48:08 +00001845 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patelb2969422009-09-29 18:40:58 +00001846 DIUnit.getProducer());
Devang Patel930143b2009-11-21 02:48:08 +00001847 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendling2b128d72009-05-20 23:19:06 +00001848 DIUnit.getLanguage());
Devang Patel930143b2009-11-21 02:48:08 +00001849 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patelbd798ce2010-04-26 22:54:28 +00001850 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1851 // simplifies debug range entries.
Devang Patel1de21ec2010-06-28 22:22:47 +00001852 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Pateld22ed622010-03-22 23:11:36 +00001853 // DW_AT_stmt_list is a offset of line number information for this
Devang Patel4a213872010-08-24 00:06:12 +00001854 // compile unit in debug_line section.
Devang Patelea636392010-08-31 23:50:19 +00001855 if (Asm->MAI->doesDwarfUsesAbsoluteLabelForStmtList())
1856 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_addr,
1857 Asm->GetTempSymbol("section_line"));
1858 else
1859 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00001860
Devang Patel2d9caf92009-11-25 17:36:49 +00001861 if (!Dir.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001862 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +00001863 if (DIUnit.isOptimized())
Devang Patel930143b2009-11-21 02:48:08 +00001864 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendling2b128d72009-05-20 23:19:06 +00001865
Devang Patel2d9caf92009-11-25 17:36:49 +00001866 StringRef Flags = DIUnit.getFlags();
1867 if (!Flags.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001868 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendling2b128d72009-05-20 23:19:06 +00001869
1870 unsigned RVer = DIUnit.getRunTimeVersion();
1871 if (RVer)
Devang Patel930143b2009-11-21 02:48:08 +00001872 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +00001873 dwarf::DW_FORM_data1, RVer);
1874
Devang Patel1a0df9a2010-05-10 22:49:55 +00001875 CompileUnit *NewCU = new CompileUnit(ID, Die);
1876 if (!FirstCU)
1877 FirstCU = NewCU;
1878 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendling2b128d72009-05-20 23:19:06 +00001879}
1880
Devang Patel1a0df9a2010-05-10 22:49:55 +00001881/// getCompielUnit - Get CompileUnit DIE.
1882CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1883 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1884 DIDescriptor D(N);
1885 const MDNode *CUNode = NULL;
1886 if (D.isCompileUnit())
1887 CUNode = N;
1888 else if (D.isSubprogram())
1889 CUNode = DISubprogram(N).getCompileUnit();
1890 else if (D.isType())
1891 CUNode = DIType(N).getCompileUnit();
1892 else if (D.isGlobalVariable())
1893 CUNode = DIGlobalVariable(N).getCompileUnit();
1894 else if (D.isVariable())
1895 CUNode = DIVariable(N).getCompileUnit();
1896 else if (D.isNameSpace())
1897 CUNode = DINameSpace(N).getCompileUnit();
1898 else if (D.isFile())
1899 CUNode = DIFile(N).getCompileUnit();
1900 else
1901 return FirstCU;
1902
1903 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1904 = CUMap.find(CUNode);
1905 if (I == CUMap.end())
1906 return FirstCU;
1907 return I->second;
1908}
1909
Devang Patela8652672010-08-23 18:25:56 +00001910/// isUnsignedDIType - Return true if type encoding is unsigned.
1911static bool isUnsignedDIType(DIType Ty) {
1912 DIDerivedType DTy(Ty);
1913 if (DTy.Verify())
1914 return isUnsignedDIType(DTy.getTypeDerivedFrom());
1915
1916 DIBasicType BTy(Ty);
1917 if (BTy.Verify()) {
1918 unsigned Encoding = BTy.getEncoding();
1919 if (Encoding == dwarf::DW_ATE_unsigned ||
1920 Encoding == dwarf::DW_ATE_unsigned_char)
1921 return true;
1922 }
1923 return false;
1924}
Devang Patel1a0df9a2010-05-10 22:49:55 +00001925
Devang Patel2d9e5322011-01-20 00:02:16 +00001926// Return const exprssion if value is a GEP to access merged global
1927// constant. e.g.
1928// i8* getelementptr ({ i8, i8, i8, i8 }* @_MergedGlobals, i32 0, i32 0)
1929static const ConstantExpr *getMergedGlobalExpr(const Value *V) {
1930 const ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(V);
1931 if (!CE || CE->getNumOperands() != 3 ||
1932 CE->getOpcode() != Instruction::GetElementPtr)
1933 return NULL;
1934
1935 // First operand points to a global value.
1936 if (!isa<GlobalValue>(CE->getOperand(0)))
1937 return NULL;
1938
1939 // Second operand is zero.
1940 const ConstantInt *CI =
1941 dyn_cast_or_null<ConstantInt>(CE->getOperand(1));
1942 if (!CI || !CI->isZero())
1943 return NULL;
1944
1945 // Third operand is offset.
1946 if (!isa<ConstantInt>(CE->getOperand(2)))
1947 return NULL;
1948
1949 return CE;
1950}
1951
Devang Patel1a0df9a2010-05-10 22:49:55 +00001952/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00001953void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel469c12d22010-08-10 01:37:23 +00001954 DIGlobalVariable GV(N);
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001955
Devang Patelf5d53602009-09-04 23:59:07 +00001956 // If debug information is malformed then ignore it.
Devang Patel469c12d22010-08-10 01:37:23 +00001957 if (GV.Verify() == false)
Devang Patelf5d53602009-09-04 23:59:07 +00001958 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001959
1960 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001961 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel469c12d22010-08-10 01:37:23 +00001962 if (TheCU->getDIE(GV))
Devang Patel0751a282009-06-26 01:49:18 +00001963 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001964
Devang Patel469c12d22010-08-10 01:37:23 +00001965 DIType GTy = GV.getType();
Devang Patelb2197462010-08-10 07:11:13 +00001966 DIE *VariableDIE = new DIE(GV.getTag());
1967
1968 bool isGlobalVariable = GV.getGlobal() != NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001969
Devang Patel469c12d22010-08-10 01:37:23 +00001970 // Add name.
1971 addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1972 GV.getDisplayName());
1973 StringRef LinkageName = GV.getLinkageName();
Devang Patelb2197462010-08-10 07:11:13 +00001974 if (!LinkageName.empty() && isGlobalVariable)
Devang Patel469c12d22010-08-10 01:37:23 +00001975 addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
1976 getRealLinkageName(LinkageName));
1977 // Add type.
1978 addType(VariableDIE, GTy);
Devang Patel12d150e2010-04-13 20:35:04 +00001979 if (GTy.isCompositeType() && !GTy.getName().empty()
1980 && !GTy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001981 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001982 assert(Entry && "Missing global type!");
Devang Patel1a0df9a2010-05-10 22:49:55 +00001983 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00001984 }
Devang Patel469c12d22010-08-10 01:37:23 +00001985 // Add scoping info.
1986 if (!GV.isLocalToUnit()) {
1987 addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1988 // Expose as global.
1989 TheCU->addGlobal(GV.getName(), VariableDIE);
1990 }
1991 // Add line number info.
1992 addSourceLine(VariableDIE, GV);
1993 // Add to map.
1994 TheCU->insertDIE(N, VariableDIE);
1995 // Add to context owner.
1996 DIDescriptor GVContext = GV.getContext();
1997 addToContextOwner(VariableDIE, GVContext);
1998 // Add location.
Devang Patelb2197462010-08-10 07:11:13 +00001999 if (isGlobalVariable) {
2000 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
2001 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
2002 addLabel(Block, 0, dwarf::DW_FORM_udata,
2003 Asm->Mang->getSymbol(GV.getGlobal()));
2004 // Do not create specification DIE if context is either compile unit
2005 // or a subprogram.
2006 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
2007 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
2008 // Create specification DIE.
2009 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
2010 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
2011 dwarf::DW_FORM_ref4, VariableDIE);
2012 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
2013 addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
2014 TheCU->addDie(VariableSpecDIE);
2015 } else {
2016 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
2017 }
Devang Patel70eb9822011-01-06 21:39:25 +00002018 } else if (ConstantInt *CI =
2019 dyn_cast_or_null<ConstantInt>(GV.getConstant()))
2020 addConstantValue(VariableDIE, CI, isUnsignedDIType(GTy));
Devang Patel2d9e5322011-01-20 00:02:16 +00002021 else if (const ConstantExpr *CE = getMergedGlobalExpr(N->getOperand(11))) {
2022 // GV is a merged global.
2023 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
2024 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
2025 addLabel(Block, 0, dwarf::DW_FORM_udata,
2026 Asm->Mang->getSymbol(cast<GlobalValue>(CE->getOperand(0))));
2027 ConstantInt *CII = cast<ConstantInt>(CE->getOperand(2));
2028 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
2029 addUInt(Block, 0, dwarf::DW_FORM_udata, CII->getZExtValue());
2030 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
2031 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
2032 }
Devang Patel70eb9822011-01-06 21:39:25 +00002033
Devang Patel0751a282009-06-26 01:49:18 +00002034 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002035}
2036
Devang Patel1a0df9a2010-05-10 22:49:55 +00002037/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00002038void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00002039 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +00002040
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002041 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002042 CompileUnit *TheCU = getCompileUnit(N);
2043 if (TheCU->getDIE(N))
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002044 return;
2045
Bill Wendling2b128d72009-05-20 23:19:06 +00002046 if (!SP.isDefinition())
2047 // This is a method declaration which will be handled while constructing
2048 // class type.
Devang Patel0751a282009-06-26 01:49:18 +00002049 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002050
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002051 DIE *SubprogramDie = createSubprogramDIE(SP);
2052
2053 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002054 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00002055
2056 // Add to context owner.
Devang Patel1f4690c2009-12-15 19:16:48 +00002057 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +00002058
Bill Wendling2b128d72009-05-20 23:19:06 +00002059 // Expose as global.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002060 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002061
Devang Patel0751a282009-06-26 01:49:18 +00002062 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002063}
2064
Devang Patel930143b2009-11-21 02:48:08 +00002065/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbarbe22ec42009-09-19 20:40:14 +00002066/// content. Create global DIEs and emit initial debug info sections.
2067/// This is inovked by the target AsmPrinter.
Chris Lattner11980022010-04-04 07:48:20 +00002068void DwarfDebug::beginModule(Module *M) {
Devang Patel6c74a872010-04-27 19:46:33 +00002069 if (DisableDebugInfoPrinting)
2070 return;
2071
Devang Patel63524442009-07-30 18:56:46 +00002072 DebugInfoFinder DbgFinder;
2073 DbgFinder.processModule(*M);
Devang Patel0751a282009-06-26 01:49:18 +00002074
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002075 bool HasDebugInfo = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002076
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002077 // Scan all the compile-units to see if there are any marked as the main unit.
2078 // if not, we do not generate debug info.
2079 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2080 E = DbgFinder.compile_unit_end(); I != E; ++I) {
2081 if (DICompileUnit(*I).isMain()) {
2082 HasDebugInfo = true;
2083 break;
2084 }
2085 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002086
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002087 if (!HasDebugInfo) return;
2088
2089 // Tell MMI that we have debug info.
2090 MMI->setDebugInfoAvailability(true);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002091
Chris Lattnerd442aa32010-04-04 23:17:54 +00002092 // Emit initial sections.
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002093 EmitSectionLabels();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002094
Bill Wendling2b128d72009-05-20 23:19:06 +00002095 // Create all the compile unit DIEs.
Devang Patel63524442009-07-30 18:56:46 +00002096 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2097 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002098 constructCompileUnit(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002099
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002100 // Create DIEs for each subprogram.
Devang Patel63524442009-07-30 18:56:46 +00002101 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
2102 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002103 constructSubprogramDIE(*I);
Devang Patel0751a282009-06-26 01:49:18 +00002104
Devang Patel2b75ed22009-12-10 19:14:49 +00002105 // Create DIEs for each global variable.
2106 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2107 E = DbgFinder.global_variable_end(); I != E; ++I)
2108 constructGlobalVariableDIE(*I);
2109
Devang Patel8e06a5e2010-08-10 20:01:20 +00002110 //getOrCreateTypeDIE
2111 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
2112 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2113 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2114
Devang Patel7a554812010-09-28 18:08:20 +00002115 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
2116 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2117 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2118
Bill Wendling2b128d72009-05-20 23:19:06 +00002119 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +00002120 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +00002121}
2122
Devang Patel930143b2009-11-21 02:48:08 +00002123/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendling2b128d72009-05-20 23:19:06 +00002124///
Devang Patel930143b2009-11-21 02:48:08 +00002125void DwarfDebug::endModule() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002126 if (!FirstCU) return;
Devang Patelf3b2db62010-06-28 18:25:03 +00002127 const Module *M = MMI->getModule();
Devang Pateld0701282010-08-02 17:32:15 +00002128 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patelf3b2db62010-06-28 18:25:03 +00002129 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2130 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2131 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2132 DISubprogram SP(AllSPs->getOperand(SI));
2133 if (!SP.Verify()) continue;
2134
2135 // Collect info for variables that were optimized out.
Devang Patel18efced2010-07-19 17:53:55 +00002136 if (!SP.isDefinition()) continue;
Devang Patelf3b2db62010-06-28 18:25:03 +00002137 StringRef FName = SP.getLinkageName();
2138 if (FName.empty())
2139 FName = SP.getName();
Devang Patel364bf042010-11-10 22:19:21 +00002140 NamedMDNode *NMD = getFnSpecificMDNode(*(MMI->getModule()), FName);
Devang Patelf3b2db62010-06-28 18:25:03 +00002141 if (!NMD) continue;
2142 unsigned E = NMD->getNumOperands();
2143 if (!E) continue;
2144 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Pateld0701282010-08-02 17:32:15 +00002145 DeadFnScopeMap[SP] = Scope;
Devang Patelf3b2db62010-06-28 18:25:03 +00002146 for (unsigned I = 0; I != E; ++I) {
2147 DIVariable DV(NMD->getOperand(I));
2148 if (!DV.Verify()) continue;
2149 Scope->addVariable(new DbgVariable(DV));
2150 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002151
Devang Patelf3b2db62010-06-28 18:25:03 +00002152 // Construct subprogram DIE and add variables DIEs.
2153 constructSubprogramDIE(SP);
2154 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patel406798a2010-08-09 18:51:29 +00002155 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf3b2db62010-06-28 18:25:03 +00002156 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2157 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2158 if (VariableDIE)
2159 ScopeDIE->addChild(VariableDIE);
2160 }
2161 }
2162 }
Bill Wendling2b128d72009-05-20 23:19:06 +00002163
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002164 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2165 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2166 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2167 DIE *ISP = *AI;
Devang Patel930143b2009-11-21 02:48:08 +00002168 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002169 }
2170
Devang Patel32cc43c2010-05-07 20:54:48 +00002171 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Pateleb57c592009-12-03 19:11:07 +00002172 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2173 DIE *SPDie = CI->first;
Devang Patel32cc43c2010-05-07 20:54:48 +00002174 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Pateleb57c592009-12-03 19:11:07 +00002175 if (!N) continue;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002176 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Pateleb57c592009-12-03 19:11:07 +00002177 if (!NDie) continue;
2178 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Pateleb57c592009-12-03 19:11:07 +00002179 }
2180
Bill Wendling2b128d72009-05-20 23:19:06 +00002181 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002182 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002183 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002184 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002185 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +00002186
2187 // End text sections.
2188 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002189 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnera179b522010-04-04 19:25:43 +00002190 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendling2b128d72009-05-20 23:19:06 +00002191 }
2192
2193 // Emit common frame information.
Devang Patel930143b2009-11-21 02:48:08 +00002194 emitCommonDebugFrame();
Bill Wendling2b128d72009-05-20 23:19:06 +00002195
2196 // Emit function debug frame information
2197 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2198 E = DebugFrames.end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002199 emitFunctionDebugFrame(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002200
2201 // Compute DIE offsets and sizes.
Devang Patel930143b2009-11-21 02:48:08 +00002202 computeSizeAndOffsets();
Bill Wendling2b128d72009-05-20 23:19:06 +00002203
2204 // Emit all the DIEs into a debug info section
Devang Patel930143b2009-11-21 02:48:08 +00002205 emitDebugInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002206
2207 // Corresponding abbreviations into a abbrev section.
Devang Patel930143b2009-11-21 02:48:08 +00002208 emitAbbreviations();
Bill Wendling2b128d72009-05-20 23:19:06 +00002209
Bill Wendling2b128d72009-05-20 23:19:06 +00002210 // Emit info into a debug pubnames section.
Devang Patel930143b2009-11-21 02:48:08 +00002211 emitDebugPubNames();
Bill Wendling2b128d72009-05-20 23:19:06 +00002212
Devang Patel04d2f2d2009-11-24 01:14:22 +00002213 // Emit info into a debug pubtypes section.
2214 emitDebugPubTypes();
2215
Bill Wendling2b128d72009-05-20 23:19:06 +00002216 // Emit info into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002217 emitDebugLoc();
Bill Wendling2b128d72009-05-20 23:19:06 +00002218
2219 // Emit info into a debug aranges section.
2220 EmitDebugARanges();
2221
2222 // Emit info into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002223 emitDebugRanges();
Bill Wendling2b128d72009-05-20 23:19:06 +00002224
2225 // Emit info into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002226 emitDebugMacInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002227
2228 // Emit inline info.
Devang Patel930143b2009-11-21 02:48:08 +00002229 emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002230
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002231 // Emit info into a debug str section.
2232 emitDebugStr();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002233
Devang Pateld0701282010-08-02 17:32:15 +00002234 // clean up.
2235 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002236 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2237 E = CUMap.end(); I != E; ++I)
2238 delete I->second;
2239 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendling2b128d72009-05-20 23:19:06 +00002240}
2241
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002242/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002243DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattner915c5f92010-04-02 19:42:39 +00002244 DebugLoc ScopeLoc) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002245
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002246 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002247 if (AbsDbgVariable)
2248 return AbsDbgVariable;
2249
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002250 LLVMContext &Ctx = Var->getContext();
Chris Lattner915c5f92010-04-02 19:42:39 +00002251 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002252 if (!Scope)
2253 return NULL;
2254
Devang Patele1c53f22010-05-20 16:36:41 +00002255 AbsDbgVariable = new DbgVariable(Var);
Devang Patel930143b2009-11-21 02:48:08 +00002256 Scope->addVariable(AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002257 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002258 return AbsDbgVariable;
2259}
2260
Devang Patel490c8ab2010-05-20 19:57:06 +00002261/// collectVariableInfoFromMMITable - Collect variable information from
2262/// side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002263void
Devang Patel490c8ab2010-05-20 19:57:06 +00002264DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2265 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00002266 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patel475d32a2009-10-06 01:26:37 +00002267 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2268 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2269 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00002270 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002271 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00002272 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00002273 DIVariable DV(Var);
2274 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002275
Chris Lattner915c5f92010-04-02 19:42:39 +00002276 DbgScope *Scope = 0;
Devang Patel32cc43c2010-05-07 20:54:48 +00002277 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattner915c5f92010-04-02 19:42:39 +00002278 Scope = ConcreteScopes.lookup(IA);
2279 if (Scope == 0)
2280 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002281
Devang Patelcdb7d442009-11-10 23:20:04 +00002282 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00002283 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00002284 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002285
Devang Patele1c53f22010-05-20 16:36:41 +00002286 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2287 DbgVariable *RegVar = new DbgVariable(DV);
2288 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel930143b2009-11-21 02:48:08 +00002289 Scope->addVariable(RegVar);
Devang Patele1c53f22010-05-20 16:36:41 +00002290 if (AbsDbgVariable) {
2291 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2292 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2293 }
Devang Patel475d32a2009-10-06 01:26:37 +00002294 }
Devang Patel490c8ab2010-05-20 19:57:06 +00002295}
Devang Patela3e9c9c2010-03-15 18:33:46 +00002296
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002297/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +00002298/// DBG_VALUE instruction, is in a defined reg.
2299static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2300 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2301 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2302 return true;
2303 return false;
2304}
2305
Devang Patel490c8ab2010-05-20 19:57:06 +00002306/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002307void
Devang Patel5c0f85c2010-06-25 22:07:34 +00002308DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2309 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002310
Devang Patel490c8ab2010-05-20 19:57:06 +00002311 /// collection info from MMI table.
2312 collectVariableInfoFromMMITable(MF, Processed);
2313
2314 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002315 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002316 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel490c8ab2010-05-20 19:57:06 +00002317 I != E; ++I)
Devang Patela3e9c9c2010-03-15 18:33:46 +00002318 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2319 II != IE; ++II) {
2320 const MachineInstr *MInsn = II;
Devang Patel447cb382011-01-11 21:42:10 +00002321 if (!MInsn->isDebugValue())
Devang Patela3e9c9c2010-03-15 18:33:46 +00002322 continue;
Devang Patel490c8ab2010-05-20 19:57:06 +00002323 DbgValues.push_back(MInsn);
2324 }
Devang Patela3e9c9c2010-03-15 18:33:46 +00002325
Devang Patel9fc11702010-05-25 23:40:22 +00002326 // This is a collection of DBV_VALUE instructions describing same variable.
2327 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patel490c8ab2010-05-20 19:57:06 +00002328 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2329 E = DbgValues.end(); I != E; ++I) {
2330 const MachineInstr *MInsn = *I;
Devang Patel9fc11702010-05-25 23:40:22 +00002331 MultipleValues.clear();
2332 if (isDbgValueInDefinedReg(MInsn))
2333 MultipleValues.push_back(MInsn);
Devang Patel490c8ab2010-05-20 19:57:06 +00002334 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2335 if (Processed.count(DV) != 0)
2336 continue;
2337
Devang Patelc2254f62010-06-02 19:05:13 +00002338 const MachineInstr *PrevMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002339 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
Devang Patel9fc11702010-05-25 23:40:22 +00002340 ME = DbgValues.end(); MI != ME; ++MI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002341 const MDNode *Var =
Devang Patel9fc11702010-05-25 23:40:22 +00002342 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
Devang Patel447cb382011-01-11 21:42:10 +00002343 if (Var == DV &&
Devang Patelc2254f62010-06-02 19:05:13 +00002344 !PrevMI->isIdenticalTo(*MI))
Devang Patel9fc11702010-05-25 23:40:22 +00002345 MultipleValues.push_back(*MI);
Devang Patelc2254f62010-06-02 19:05:13 +00002346 PrevMI = *MI;
Devang Patel9fc11702010-05-25 23:40:22 +00002347 }
2348
Devang Patel447cb382011-01-11 21:42:10 +00002349 DbgScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00002350 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2351 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelfbd6c452010-05-21 00:10:20 +00002352 Scope = CurrentFnDbgScope;
Devang Patel447cb382011-01-11 21:42:10 +00002353 else
2354 Scope = findDbgScope(MInsn);
Devang Patel490c8ab2010-05-20 19:57:06 +00002355 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00002356 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00002357 continue;
2358
2359 Processed.insert(DV);
Devang Patel490c8ab2010-05-20 19:57:06 +00002360 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patel490c8ab2010-05-20 19:57:06 +00002361 Scope->addVariable(RegVar);
Devang Patelfbd6c452010-05-21 00:10:20 +00002362 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2363 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2364 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002365 }
Devang Patel9fc11702010-05-25 23:40:22 +00002366 if (MultipleValues.size() <= 1) {
2367 DbgVariableToDbgInstMap[RegVar] = MInsn;
2368 continue;
2369 }
2370
2371 // handle multiple DBG_VALUE instructions describing one variable.
Devang Patel9fc11702010-05-25 23:40:22 +00002372 if (DotDebugLocEntries.empty())
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002373 RegVar->setDotDebugLocOffset(0);
2374 else
2375 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002376 const MachineInstr *Begin = NULL;
2377 const MachineInstr *End = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002378 for (SmallVector<const MachineInstr *, 4>::iterator
2379 MVI = MultipleValues.begin(), MVE = MultipleValues.end();
Devang Patel30265c42010-07-07 20:12:52 +00002380 MVI != MVE; ++MVI) {
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002381 if (!Begin) {
2382 Begin = *MVI;
2383 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002384 }
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002385 End = *MVI;
Devang Patel9fc11702010-05-25 23:40:22 +00002386 MachineLocation MLoc;
Devang Patel0e60e672010-08-04 18:40:52 +00002387 if (Begin->getNumOperands() == 3) {
2388 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2389 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2390 } else
2391 MLoc = Asm->getDebugValueLocation(Begin);
2392
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002393 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2394 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patel6c378ac2010-08-04 22:07:27 +00002395 if (MLoc.getReg())
2396 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
2397
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002398 Begin = End;
2399 if (MVI + 1 == MVE) {
2400 // If End is the last instruction then its value is valid
Devang Patel9fc11702010-05-25 23:40:22 +00002401 // until the end of the funtion.
Devang Patel0e60e672010-08-04 18:40:52 +00002402 MachineLocation EMLoc;
2403 if (End->getNumOperands() == 3) {
2404 if (End->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2405 EMLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2406 } else
2407 EMLoc = Asm->getDebugValueLocation(End);
Devang Patel6c378ac2010-08-04 22:07:27 +00002408 if (EMLoc.getReg())
2409 DotDebugLocEntries.
2410 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, EMLoc));
Devang Patel9fc11702010-05-25 23:40:22 +00002411 }
2412 }
2413 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00002414 }
Devang Patele0a94bf2010-05-14 21:01:35 +00002415
2416 // Collect info for variables that were optimized out.
Devang Patelad517352010-06-22 01:01:58 +00002417 const Function *F = MF->getFunction();
Devang Patel364bf042010-11-10 22:19:21 +00002418 if (NamedMDNode *NMD = getFnSpecificMDNode(*(F->getParent()), F->getName())) {
Devang Patele0a94bf2010-05-14 21:01:35 +00002419 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002420 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel490c8ab2010-05-20 19:57:06 +00002421 if (!DV || !Processed.insert(DV))
Devang Patele0a94bf2010-05-14 21:01:35 +00002422 continue;
2423 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2424 if (Scope)
Devang Patele1c53f22010-05-20 16:36:41 +00002425 Scope->addVariable(new DbgVariable(DV));
Devang Patele0a94bf2010-05-14 21:01:35 +00002426 }
2427 }
Devang Patel9fc11702010-05-25 23:40:22 +00002428}
Devang Patele0a94bf2010-05-14 21:01:35 +00002429
Devang Patel9fc11702010-05-25 23:40:22 +00002430/// getLabelBeforeInsn - Return Label preceding the instruction.
2431const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2432 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2433 LabelsBeforeInsn.find(MI);
2434 if (I == LabelsBeforeInsn.end())
2435 // FunctionBeginSym always preceeds all the instruction in current function.
2436 return FunctionBeginSym;
2437 return I->second;
2438}
2439
2440/// getLabelAfterInsn - Return Label immediately following the instruction.
2441const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2442 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2443 LabelsAfterInsn.find(MI);
2444 if (I == LabelsAfterInsn.end())
2445 return NULL;
2446 return I->second;
Devang Patel475d32a2009-10-06 01:26:37 +00002447}
2448
Devang Patelb5694e72010-10-26 17:49:02 +00002449/// beginInstruction - Process beginning of an instruction.
2450void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Devang Patel002d54d2010-05-26 19:37:24 +00002451 if (InsnNeedsLabel.count(MI) == 0) {
2452 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patelbd477be2010-03-29 17:20:31 +00002453 return;
Devang Patel9fc11702010-05-25 23:40:22 +00002454 }
Devang Patel23b2ae62010-03-29 22:59:58 +00002455
Devang Patel002d54d2010-05-26 19:37:24 +00002456 // Check location.
2457 DebugLoc DL = MI->getDebugLoc();
2458 if (!DL.isUnknown()) {
2459 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2460 PrevLabel = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
Devang Patel6c74a872010-04-27 19:46:33 +00002461 PrevInstLoc = DL;
Devang Patel002d54d2010-05-26 19:37:24 +00002462 LabelsBeforeInsn[MI] = PrevLabel;
2463 return;
Devang Patel6c74a872010-04-27 19:46:33 +00002464 }
Devang Patelbd477be2010-03-29 17:20:31 +00002465
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002466 // If location is unknown then use temp label for this DBG_VALUE
Devang Patel002d54d2010-05-26 19:37:24 +00002467 // instruction.
2468 if (MI->isDebugValue()) {
Devang Patelacc32a52010-05-26 21:23:46 +00002469 PrevLabel = MMI->getContext().CreateTempSymbol();
2470 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00002471 LabelsBeforeInsn[MI] = PrevLabel;
2472 return;
2473 }
2474
2475 if (UnknownLocations) {
2476 PrevLabel = recordSourceLine(0, 0, 0);
2477 LabelsBeforeInsn[MI] = PrevLabel;
2478 return;
2479 }
2480
2481 assert (0 && "Instruction is not processed!");
Devang Patel8db360d2009-10-06 01:50:42 +00002482}
2483
Devang Patelb5694e72010-10-26 17:49:02 +00002484/// endInstruction - Process end of an instruction.
2485void DwarfDebug::endInstruction(const MachineInstr *MI) {
Devang Patel3ebd8932010-04-08 16:50:29 +00002486 if (InsnsEndScopeSet.count(MI) != 0) {
2487 // Emit a label if this instruction ends a scope.
2488 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2489 Asm->OutStreamer.EmitLabel(Label);
Devang Patel6c74a872010-04-27 19:46:33 +00002490 LabelsAfterInsn[MI] = Label;
Devang Patel3ebd8932010-04-08 16:50:29 +00002491 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002492}
2493
Devang Patel6c74a872010-04-27 19:46:33 +00002494/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002495DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel30265c42010-07-07 20:12:52 +00002496 const MDNode *InlinedAt) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002497 if (!InlinedAt) {
2498 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2499 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002500 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002501 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2502 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Patel6c74a872010-04-27 19:46:33 +00002503 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002504 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002505 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Patel6c74a872010-04-27 19:46:33 +00002506 WScope->setParent(Parent);
2507 Parent->addScope(WScope);
2508 }
2509
2510 if (!WScope->getParent()) {
2511 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastings9b5005c2010-06-15 23:06:30 +00002512 // We used to check only for a linkage name, but that fails
2513 // since we began omitting the linkage name for private
2514 // functions. The new way is to check for the name in metadata,
2515 // but that's not supported in old .ll test cases. Ergo, we
2516 // check both.
Stuart Hastingsafe54f12010-06-11 20:08:44 +00002517 if (SPName == Asm->MF->getFunction()->getName() ||
2518 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Patel6c74a872010-04-27 19:46:33 +00002519 CurrentFnDbgScope = WScope;
2520 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002521
Devang Patel6c74a872010-04-27 19:46:33 +00002522 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002523 }
2524
Devang Patel5c0f85c2010-06-25 22:07:34 +00002525 getOrCreateAbstractScope(Scope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002526 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2527 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002528 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002529
2530 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2531 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2532 DILocation DL(InlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002533 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002534 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Patel6c74a872010-04-27 19:46:33 +00002535 WScope->setParent(Parent);
2536 Parent->addScope(WScope);
2537
2538 ConcreteScopes[InlinedAt] = WScope;
Devang Patel6c74a872010-04-27 19:46:33 +00002539
2540 return WScope;
Devang Patel8db360d2009-10-06 01:50:42 +00002541}
2542
Devang Patel6c74a872010-04-27 19:46:33 +00002543/// hasValidLocation - Return true if debug location entry attached with
2544/// machine instruction encodes valid location info.
2545static bool hasValidLocation(LLVMContext &Ctx,
2546 const MachineInstr *MInsn,
Devang Patel32cc43c2010-05-07 20:54:48 +00002547 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Patel6c74a872010-04-27 19:46:33 +00002548 DebugLoc DL = MInsn->getDebugLoc();
2549 if (DL.isUnknown()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002550
Devang Patel32cc43c2010-05-07 20:54:48 +00002551 const MDNode *S = DL.getScope(Ctx);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002552
Devang Patel6c74a872010-04-27 19:46:33 +00002553 // There is no need to create another DIE for compile unit. For all
2554 // other scopes, create one DbgScope now. This will be translated
2555 // into a scope DIE at the end.
2556 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002557
Devang Patel6c74a872010-04-27 19:46:33 +00002558 Scope = S;
2559 InlinedAt = DL.getInlinedAt(Ctx);
2560 return true;
2561}
2562
2563/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2564/// hierarchy.
2565static void calculateDominanceGraph(DbgScope *Scope) {
2566 assert (Scope && "Unable to calculate scop edominance graph!");
2567 SmallVector<DbgScope *, 4> WorkStack;
2568 WorkStack.push_back(Scope);
2569 unsigned Counter = 0;
2570 while (!WorkStack.empty()) {
2571 DbgScope *WS = WorkStack.back();
2572 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2573 bool visitedChildren = false;
2574 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2575 SE = Children.end(); SI != SE; ++SI) {
2576 DbgScope *ChildScope = *SI;
2577 if (!ChildScope->getDFSOut()) {
2578 WorkStack.push_back(ChildScope);
2579 visitedChildren = true;
2580 ChildScope->setDFSIn(++Counter);
2581 break;
2582 }
2583 }
2584 if (!visitedChildren) {
2585 WorkStack.pop_back();
2586 WS->setDFSOut(++Counter);
2587 }
2588 }
2589}
2590
2591/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002592static
Devang Patel6c74a872010-04-27 19:46:33 +00002593void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2594 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2595{
2596#ifndef NDEBUG
2597 unsigned PrevDFSIn = 0;
2598 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2599 I != E; ++I) {
2600 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2601 II != IE; ++II) {
2602 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002603 const MDNode *Scope = NULL;
2604 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002605
2606 // Check if instruction has valid location information.
2607 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2608 dbgs() << " [ ";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002609 if (InlinedAt)
Devang Patel6c74a872010-04-27 19:46:33 +00002610 dbgs() << "*";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002611 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Patel6c74a872010-04-27 19:46:33 +00002612 MI2ScopeMap.find(MInsn);
2613 if (DI != MI2ScopeMap.end()) {
2614 DbgScope *S = DI->second;
2615 dbgs() << S->getDFSIn();
2616 PrevDFSIn = S->getDFSIn();
2617 } else
2618 dbgs() << PrevDFSIn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002619 } else
Devang Patel6c74a872010-04-27 19:46:33 +00002620 dbgs() << " [ x" << PrevDFSIn;
2621 dbgs() << " ]";
2622 MInsn->dump();
2623 }
2624 dbgs() << "\n";
2625 }
2626#endif
2627}
Devang Patel930143b2009-11-21 02:48:08 +00002628/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner848c7d22010-03-31 05:39:57 +00002629/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattner76555b52010-01-26 23:18:02 +00002630bool DwarfDebug::extractScopeInformation() {
Devang Patel75cc16c2009-10-01 20:31:14 +00002631 // If scope information was extracted using .dbg intrinsics then there is not
2632 // any need to extract these information by scanning each instruction.
2633 if (!DbgScopeMap.empty())
2634 return false;
2635
Dan Gohmane9135cb2010-04-23 01:18:53 +00002636 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patel6c74a872010-04-27 19:46:33 +00002637 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2638 SmallVector<DbgRange, 4> MIRanges;
2639 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patel32cc43c2010-05-07 20:54:48 +00002640 const MDNode *PrevScope = NULL;
2641 const MDNode *PrevInlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002642 const MachineInstr *RangeBeginMI = NULL;
2643 const MachineInstr *PrevMI = NULL;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002644 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel75cc16c2009-10-01 20:31:14 +00002645 I != E; ++I) {
2646 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2647 II != IE; ++II) {
2648 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002649 const MDNode *Scope = NULL;
2650 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002651
2652 // Check if instruction has valid location information.
2653 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2654 PrevMI = MInsn;
2655 continue;
2656 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002657
Devang Patel6c74a872010-04-27 19:46:33 +00002658 // If scope has not changed then skip this instruction.
2659 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2660 PrevMI = MInsn;
2661 continue;
2662 }
2663
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002664 if (RangeBeginMI) {
2665 // If we have alread seen a beginning of a instruction range and
Devang Patel6c74a872010-04-27 19:46:33 +00002666 // current instruction scope does not match scope of first instruction
2667 // in this range then create a new instruction range.
2668 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002669 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel30265c42010-07-07 20:12:52 +00002670 PrevInlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002671 MIRanges.push_back(R);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002672 }
Devang Patel6c74a872010-04-27 19:46:33 +00002673
2674 // This is a beginning of a new instruction range.
2675 RangeBeginMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002676
Devang Patel6c74a872010-04-27 19:46:33 +00002677 // Reset previous markers.
2678 PrevMI = MInsn;
2679 PrevScope = Scope;
2680 PrevInlinedAt = InlinedAt;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002681 }
2682 }
2683
Devang Patel6c74a872010-04-27 19:46:33 +00002684 // Create last instruction range.
2685 if (RangeBeginMI && PrevMI && PrevScope) {
2686 DbgRange R(RangeBeginMI, PrevMI);
2687 MIRanges.push_back(R);
2688 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patel75cc16c2009-10-01 20:31:14 +00002689 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002690
Devang Patel530a0752010-01-04 20:44:00 +00002691 if (!CurrentFnDbgScope)
2692 return false;
2693
Devang Patel6c74a872010-04-27 19:46:33 +00002694 calculateDominanceGraph(CurrentFnDbgScope);
2695 if (PrintDbgScope)
2696 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2697
2698 // Find ranges of instructions covered by each DbgScope;
2699 DbgScope *PrevDbgScope = NULL;
2700 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2701 RE = MIRanges.end(); RI != RE; ++RI) {
2702 const DbgRange &R = *RI;
2703 DbgScope *S = MI2ScopeMap.lookup(R.first);
2704 assert (S && "Lost DbgScope for a machine instruction!");
2705 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2706 PrevDbgScope->closeInsnRange(S);
2707 S->openInsnRange(R.first);
2708 S->extendInsnRange(R.second);
2709 PrevDbgScope = S;
2710 }
2711
2712 if (PrevDbgScope)
2713 PrevDbgScope->closeInsnRange();
Devang Patel75cc16c2009-10-01 20:31:14 +00002714
Devang Patel359b0132010-04-08 18:43:56 +00002715 identifyScopeMarkers();
Devang Patelf1d5a1e2010-04-08 15:37:09 +00002716
2717 return !DbgScopeMap.empty();
2718}
2719
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002720/// identifyScopeMarkers() -
Devang Patel6c74a872010-04-27 19:46:33 +00002721/// Each DbgScope has first instruction and last instruction to mark beginning
2722/// and end of a scope respectively. Create an inverse map that list scopes
2723/// starts (and ends) with an instruction. One instruction may start (or end)
2724/// multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00002725void DwarfDebug::identifyScopeMarkers() {
Devang Patel7771b7c2010-01-20 02:05:23 +00002726 SmallVector<DbgScope *, 4> WorkList;
2727 WorkList.push_back(CurrentFnDbgScope);
2728 while (!WorkList.empty()) {
Chris Lattner848c7d22010-03-31 05:39:57 +00002729 DbgScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002730
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002731 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002732 if (!Children.empty())
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002733 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00002734 SE = Children.end(); SI != SE; ++SI)
2735 WorkList.push_back(*SI);
2736
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002737 if (S->isAbstractScope())
2738 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002739
Devang Patel6c74a872010-04-27 19:46:33 +00002740 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2741 if (Ranges.empty())
2742 continue;
2743 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2744 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002745 assert(RI->first && "DbgRange does not have first instruction!");
2746 assert(RI->second && "DbgRange does not have second instruction!");
Devang Patel6c74a872010-04-27 19:46:33 +00002747 InsnsEndScopeSet.insert(RI->second);
2748 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002749 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002750}
2751
Dan Gohman3df671a2010-04-20 00:37:27 +00002752/// FindFirstDebugLoc - Find the first debug location in the function. This
2753/// is intended to be an approximation for the source position of the
2754/// beginning of the function.
2755static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2756 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2757 I != E; ++I)
2758 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2759 MBBI != MBBE; ++MBBI) {
2760 DebugLoc DL = MBBI->getDebugLoc();
2761 if (!DL.isUnknown())
2762 return DL;
2763 }
2764 return DebugLoc();
2765}
2766
Devang Patela86114b2010-10-25 20:45:32 +00002767#ifndef NDEBUG
2768/// CheckLineNumbers - Count basicblocks whose instructions do not have any
2769/// line number information.
2770static void CheckLineNumbers(const MachineFunction *MF) {
2771 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2772 I != E; ++I) {
2773 bool FoundLineNo = false;
2774 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2775 II != IE; ++II) {
2776 const MachineInstr *MI = II;
2777 if (!MI->getDebugLoc().isUnknown()) {
2778 FoundLineNo = true;
2779 break;
2780 }
2781 }
Devang Patel6e0d5892010-10-28 22:11:59 +00002782 if (!FoundLineNo && I->size())
Devang Patela86114b2010-10-25 20:45:32 +00002783 ++BlocksWithoutLineNo;
2784 }
2785}
2786#endif
2787
Devang Patel930143b2009-11-21 02:48:08 +00002788/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendling2b128d72009-05-20 23:19:06 +00002789/// emitted immediately after the function entry point.
Chris Lattner76555b52010-01-26 23:18:02 +00002790void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00002791 if (!MMI->hasDebugInfo()) return;
Bill Wendlingfcc14142010-04-07 09:28:04 +00002792 if (!extractScopeInformation()) return;
Devang Patel4598eb62009-10-06 18:37:31 +00002793
Devang Patela86114b2010-10-25 20:45:32 +00002794#ifndef NDEBUG
2795 CheckLineNumbers(MF);
2796#endif
2797
Devang Patel6c74a872010-04-27 19:46:33 +00002798 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2799 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00002800 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00002801 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00002802
2803 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2804 // function.
Dan Gohman3df671a2010-04-20 00:37:27 +00002805 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattner915c5f92010-04-02 19:42:39 +00002806 if (FDL.isUnknown()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002807
Devang Patel32cc43c2010-05-07 20:54:48 +00002808 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings61475c52010-07-19 23:56:30 +00002809 const MDNode *TheScope = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002810
Chris Lattner915c5f92010-04-02 19:42:39 +00002811 DISubprogram SP = getDISubprogram(Scope);
2812 unsigned Line, Col;
2813 if (SP.Verify()) {
2814 Line = SP.getLineNumber();
2815 Col = 0;
Stuart Hastings61475c52010-07-19 23:56:30 +00002816 TheScope = SP;
Chris Lattner915c5f92010-04-02 19:42:39 +00002817 } else {
2818 Line = FDL.getLine();
2819 Col = FDL.getCol();
Stuart Hastings61475c52010-07-19 23:56:30 +00002820 TheScope = Scope;
Bill Wendling2b128d72009-05-20 23:19:06 +00002821 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002822
Stuart Hastings61475c52010-07-19 23:56:30 +00002823 recordSourceLine(Line, Col, TheScope);
Devang Patel002d54d2010-05-26 19:37:24 +00002824
Devang Patel21ccf052010-06-02 16:42:51 +00002825 /// ProcessedArgs - Collection of arguments already processed.
2826 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2827
Devang Patel002d54d2010-05-26 19:37:24 +00002828 DebugLoc PrevLoc;
2829 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2830 I != E; ++I)
2831 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2832 II != IE; ++II) {
2833 const MachineInstr *MI = II;
2834 DebugLoc DL = MI->getDebugLoc();
2835 if (MI->isDebugValue()) {
Devang Patel002d54d2010-05-26 19:37:24 +00002836 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2837 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2838 if (!DV.Verify()) continue;
Devang Patel5e6b71c2010-05-27 16:47:30 +00002839 // If DBG_VALUE is for a local variable then it needs a label.
Devang Patelbca5b252010-12-06 22:48:22 +00002840 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
Devang Patel002d54d2010-05-26 19:37:24 +00002841 InsnNeedsLabel.insert(MI);
Devang Patel5e6b71c2010-05-27 16:47:30 +00002842 // DBG_VALUE for inlined functions argument needs a label.
Devang Patel42939752010-07-01 21:38:08 +00002843 else if (!DISubprogram(getDISubprogram(DV.getContext())).
2844 describes(MF->getFunction()))
Devang Patel5e6b71c2010-05-27 16:47:30 +00002845 InsnNeedsLabel.insert(MI);
2846 // DBG_VALUE indicating argument location change needs a label.
Devang Patelbca5b252010-12-06 22:48:22 +00002847 else if (!ProcessedArgs.insert(DV))
Devang Patel002d54d2010-05-26 19:37:24 +00002848 InsnNeedsLabel.insert(MI);
2849 } else {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002850 // If location is unknown then instruction needs a location only if
Devang Patel002d54d2010-05-26 19:37:24 +00002851 // UnknownLocations flag is set.
2852 if (DL.isUnknown()) {
2853 if (UnknownLocations && !PrevLoc.isUnknown())
2854 InsnNeedsLabel.insert(MI);
2855 } else if (DL != PrevLoc)
2856 // Otherwise, instruction needs a location only if it is new location.
2857 InsnNeedsLabel.insert(MI);
2858 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002859
Devang Patel002d54d2010-05-26 19:37:24 +00002860 if (!DL.isUnknown() || UnknownLocations)
2861 PrevLoc = DL;
2862 }
2863
2864 PrevLabel = FunctionBeginSym;
Bill Wendling2b128d72009-05-20 23:19:06 +00002865}
2866
Devang Patel930143b2009-11-21 02:48:08 +00002867/// endFunction - Gather and emit post-function debug information.
Bill Wendling2b128d72009-05-20 23:19:06 +00002868///
Chris Lattner76555b52010-01-26 23:18:02 +00002869void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendlingfcc14142010-04-07 09:28:04 +00002870 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00002871
Devang Patel530a0752010-01-04 20:44:00 +00002872 if (CurrentFnDbgScope) {
Devang Patel4a8e6e82010-05-22 00:04:14 +00002873
Devang Patel9fc11702010-05-25 23:40:22 +00002874 // Define end label for subprogram.
2875 FunctionEndSym = Asm->GetTempSymbol("func_end",
2876 Asm->getFunctionNumber());
2877 // Assumes in correct section after the entry point.
2878 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002879
Devang Patel5c0f85c2010-06-25 22:07:34 +00002880 SmallPtrSet<const MDNode *, 16> ProcessedVars;
2881 collectVariableInfo(MF, ProcessedVars);
Devang Patel4a8e6e82010-05-22 00:04:14 +00002882
Devang Patel530a0752010-01-04 20:44:00 +00002883 // Construct abstract scopes.
2884 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel5c0f85c2010-06-25 22:07:34 +00002885 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00002886 DISubprogram SP((*AI)->getScopeNode());
2887 if (SP.Verify()) {
2888 // Collect info for variables that were optimized out.
2889 StringRef FName = SP.getLinkageName();
2890 if (FName.empty())
2891 FName = SP.getName();
Devang Patel364bf042010-11-10 22:19:21 +00002892 if (NamedMDNode *NMD =
2893 getFnSpecificMDNode(*(MF->getFunction()->getParent()), FName)) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00002894 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002895 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel5c0f85c2010-06-25 22:07:34 +00002896 if (!DV || !ProcessedVars.insert(DV))
2897 continue;
Devang Patel648df7b2010-06-30 00:11:08 +00002898 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel5c0f85c2010-06-25 22:07:34 +00002899 if (Scope)
2900 Scope->addVariable(new DbgVariable(DV));
2901 }
2902 }
2903 }
Devang Patelc5b31092010-06-30 01:40:11 +00002904 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
2905 constructScopeDIE(*AI);
Devang Patel5c0f85c2010-06-25 22:07:34 +00002906 }
Devang Patel30265c42010-07-07 20:12:52 +00002907
Devang Patel075e9b52010-05-04 06:15:30 +00002908 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002909
Devang Patel075e9b52010-05-04 06:15:30 +00002910 if (!DisableFramePointerElim(*MF))
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002911 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel075e9b52010-05-04 06:15:30 +00002912 dwarf::DW_FORM_flag, 1);
2913
2914
Chris Lattner3a383cb2010-04-05 00:13:49 +00002915 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel530a0752010-01-04 20:44:00 +00002916 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00002917 }
2918
Bill Wendling2b128d72009-05-20 23:19:06 +00002919 // Clear debug info
Devang Patelfe189e62010-01-19 01:26:02 +00002920 CurrentFnDbgScope = NULL;
Devang Patel002d54d2010-05-26 19:37:24 +00002921 InsnNeedsLabel.clear();
Devang Patele1c53f22010-05-20 16:36:41 +00002922 DbgVariableToFrameIndexMap.clear();
2923 VarToAbstractVarMap.clear();
2924 DbgVariableToDbgInstMap.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002925 DeleteContainerSeconds(DbgScopeMap);
Devang Patel541019d2010-04-09 16:04:20 +00002926 InsnsEndScopeSet.clear();
Devang Patelfe189e62010-01-19 01:26:02 +00002927 ConcreteScopes.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002928 DeleteContainerSeconds(AbstractScopes);
Devang Patelfe189e62010-01-19 01:26:02 +00002929 AbstractScopesList.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002930 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00002931 LabelsBeforeInsn.clear();
2932 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00002933 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00002934}
2935
Devang Patele1c53f22010-05-20 16:36:41 +00002936/// recordVariableFrameIndex - Record a variable's index.
2937void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2938 assert (V && "Invalid DbgVariable!");
2939 DbgVariableToFrameIndexMap[V] = Index;
2940}
2941
2942/// findVariableFrameIndex - Return true if frame index for the variable
2943/// is found. Update FI to hold value of the index.
2944bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
2945 assert (V && "Invalid DbgVariable!");
2946 DenseMap<const DbgVariable *, int>::iterator I =
2947 DbgVariableToFrameIndexMap.find(V);
2948 if (I == DbgVariableToFrameIndexMap.end())
2949 return false;
2950 *FI = I->second;
2951 return true;
2952}
2953
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002954/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patel490c8ab2010-05-20 19:57:06 +00002955/// instruction.
2956DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
2957 DbgScope *Scope = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002958 LLVMContext &Ctx =
Devang Patel490c8ab2010-05-20 19:57:06 +00002959 MInsn->getParent()->getParent()->getFunction()->getContext();
2960 DebugLoc DL = MInsn->getDebugLoc();
2961
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002962 if (DL.isUnknown())
Devang Patel490c8ab2010-05-20 19:57:06 +00002963 return Scope;
2964
2965 if (const MDNode *IA = DL.getInlinedAt(Ctx))
2966 Scope = ConcreteScopes.lookup(IA);
2967 if (Scope == 0)
2968 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002969
Devang Patel490c8ab2010-05-20 19:57:06 +00002970 return Scope;
2971}
2972
2973
Chris Lattnerba35a672010-03-09 04:54:43 +00002974/// recordSourceLine - Register a source line with debug info. Returns the
2975/// unique label that was emitted and which provides correspondence to
2976/// the source line list.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002977MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel30265c42010-07-07 20:12:52 +00002978 const MDNode *S) {
Devang Patel2d9caf92009-11-25 17:36:49 +00002979 StringRef Fn;
Devang Patel2089d162009-10-05 18:03:19 +00002980
Dan Gohman50849c62010-05-05 23:41:32 +00002981 unsigned Src = 1;
2982 if (S) {
2983 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00002984
Dan Gohman50849c62010-05-05 23:41:32 +00002985 if (Scope.isCompileUnit()) {
2986 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00002987 Fn = CU.getFilename();
Devang Patelc4b69052010-10-28 17:30:52 +00002988 } else if (Scope.isFile()) {
2989 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00002990 Fn = F.getFilename();
Dan Gohman50849c62010-05-05 23:41:32 +00002991 } else if (Scope.isSubprogram()) {
2992 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00002993 Fn = SP.getFilename();
2994 } else if (Scope.isLexicalBlock()) {
2995 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00002996 Fn = DB.getFilename();
2997 } else
2998 assert(0 && "Unexpected scope info");
2999
Rafael Espindola67c6ab82010-11-18 02:04:25 +00003000 Src = GetOrCreateSourceID(Fn);
Dan Gohman50849c62010-05-05 23:41:32 +00003001 }
3002
Rafael Espindola67c6ab82010-11-18 02:04:25 +00003003 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, DWARF2_FLAG_IS_STMT,
3004 0, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00003005
Rafael Espindola67c6ab82010-11-18 02:04:25 +00003006 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattnerba35a672010-03-09 04:54:43 +00003007 Asm->OutStreamer.EmitLabel(Label);
3008 return Label;
Bill Wendling2b128d72009-05-20 23:19:06 +00003009}
3010
Bill Wendling806535f2009-05-20 23:22:40 +00003011//===----------------------------------------------------------------------===//
3012// Emit Methods
3013//===----------------------------------------------------------------------===//
3014
Devang Patel930143b2009-11-21 02:48:08 +00003015/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling480ff322009-05-20 23:21:38 +00003016///
Jim Grosbach00e9c612009-11-22 19:20:36 +00003017unsigned
3018DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling480ff322009-05-20 23:21:38 +00003019 // Get the children.
3020 const std::vector<DIE *> &Children = Die->getChildren();
3021
3022 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00003023 if (!Last && !Children.empty())
Benjamin Kramer74729ae2010-03-31 19:34:01 +00003024 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling480ff322009-05-20 23:21:38 +00003025
3026 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00003027 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00003028
3029 // Get the abbreviation for this DIE.
3030 unsigned AbbrevNumber = Die->getAbbrevNumber();
3031 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3032
3033 // Set DIE offset
3034 Die->setOffset(Offset);
3035
3036 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00003037 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003038
3039 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
3040 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3041
3042 // Size the DIE attribute values.
3043 for (unsigned i = 0, N = Values.size(); i < N; ++i)
3044 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00003045 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00003046
3047 // Size the DIE children if any.
3048 if (!Children.empty()) {
3049 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
3050 "Children flag not set");
3051
3052 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003053 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling480ff322009-05-20 23:21:38 +00003054
3055 // End of children marker.
3056 Offset += sizeof(int8_t);
3057 }
3058
3059 Die->setSize(Offset - Die->getOffset());
3060 return Offset;
3061}
3062
Devang Patel930143b2009-11-21 02:48:08 +00003063/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling480ff322009-05-20 23:21:38 +00003064///
Devang Patel930143b2009-11-21 02:48:08 +00003065void DwarfDebug::computeSizeAndOffsets() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003066 unsigned PrevOffset = 0;
3067 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3068 E = CUMap.end(); I != E; ++I) {
3069 // Compute size of compile unit header.
3070 static unsigned Offset = PrevOffset +
3071 sizeof(int32_t) + // Length of Compilation Unit Info
3072 sizeof(int16_t) + // DWARF version number
3073 sizeof(int32_t) + // Offset Into Abbrev. Section
3074 sizeof(int8_t); // Pointer Size (in bytes)
3075 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
3076 PrevOffset = Offset;
3077 }
Bill Wendling480ff322009-05-20 23:21:38 +00003078}
3079
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003080/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3081/// temporary label to it if SymbolStem is specified.
Chris Lattner6629ca92010-04-04 22:59:04 +00003082static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003083 const char *SymbolStem = 0) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003084 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003085 if (!SymbolStem) return 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003086
Chris Lattner6629ca92010-04-04 22:59:04 +00003087 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3088 Asm->OutStreamer.EmitLabel(TmpSym);
3089 return TmpSym;
3090}
3091
3092/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3093/// the start of each one.
Chris Lattner46355d82010-04-04 22:33:59 +00003094void DwarfDebug::EmitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003095 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003096
Bill Wendling480ff322009-05-20 23:21:38 +00003097 // Dwarf sections base addresses.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003098 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003099 DwarfFrameSectionSym =
3100 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3101 }
Bill Wendling480ff322009-05-20 23:21:38 +00003102
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003103 DwarfInfoSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003104 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003105 DwarfAbbrevSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003106 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003107 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003108
Chris Lattner6629ca92010-04-04 22:59:04 +00003109 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003110 EmitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003111
Devang Patel4a213872010-08-24 00:06:12 +00003112 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003113 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3114 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3115 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003116 DwarfStrSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003117 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patel12563b32010-04-16 23:33:45 +00003118 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3119 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00003120
Devang Patel9fc11702010-05-25 23:40:22 +00003121 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3122 "section_debug_loc");
3123
Chris Lattner6629ca92010-04-04 22:59:04 +00003124 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattnere58b5472010-04-04 23:10:38 +00003125 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003126}
3127
Devang Patel930143b2009-11-21 02:48:08 +00003128/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling480ff322009-05-20 23:21:38 +00003129///
Devang Patel930143b2009-11-21 02:48:08 +00003130void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00003131 // Get the abbreviation for this DIE.
3132 unsigned AbbrevNumber = Die->getAbbrevNumber();
3133 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3134
Bill Wendling480ff322009-05-20 23:21:38 +00003135 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00003136 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00003137 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3138 Twine::utohexstr(Die->getOffset()) + ":0x" +
3139 Twine::utohexstr(Die->getSize()) + " " +
3140 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00003141 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003142
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00003143 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00003144 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3145
3146 // Emit the DIE attribute values.
3147 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3148 unsigned Attr = AbbrevData[i].getAttribute();
3149 unsigned Form = AbbrevData[i].getForm();
3150 assert(Form && "Too many attributes for DIE (check abbreviation)");
3151
Chris Lattner7bde8c02010-04-04 18:52:31 +00003152 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00003153 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003154
Bill Wendling480ff322009-05-20 23:21:38 +00003155 switch (Attr) {
3156 case dwarf::DW_AT_sibling:
Devang Patel930143b2009-11-21 02:48:08 +00003157 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003158 break;
3159 case dwarf::DW_AT_abstract_origin: {
3160 DIEEntry *E = cast<DIEEntry>(Values[i]);
3161 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003162 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00003163 Asm->EmitInt32(Addr);
3164 break;
3165 }
Devang Patel12563b32010-04-16 23:33:45 +00003166 case dwarf::DW_AT_ranges: {
3167 // DW_AT_range Value encodes offset in debug_range section.
3168 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00003169
3170 if (Asm->MAI->doesDwarfUsesLabelOffsetForRanges()) {
3171 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
3172 V->getValue(),
3173 4);
3174 } else {
3175 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3176 V->getValue(),
3177 DwarfDebugRangeSectionSym,
3178 4);
3179 }
Devang Patel12563b32010-04-16 23:33:45 +00003180 break;
3181 }
Devang Patel9fc11702010-05-25 23:40:22 +00003182 case dwarf::DW_AT_location: {
3183 if (UseDotDebugLocEntry.count(Die) != 0) {
3184 DIELabel *L = cast<DIELabel>(Values[i]);
3185 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
3186 } else
3187 Values[i]->EmitValue(Asm, Form);
3188 break;
3189 }
Devang Patela1bd5a12010-09-29 19:08:08 +00003190 case dwarf::DW_AT_accessibility: {
3191 if (Asm->isVerbose()) {
3192 DIEInteger *V = cast<DIEInteger>(Values[i]);
3193 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
3194 }
3195 Values[i]->EmitValue(Asm, Form);
3196 break;
3197 }
Bill Wendling480ff322009-05-20 23:21:38 +00003198 default:
3199 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003200 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00003201 break;
3202 }
Bill Wendling480ff322009-05-20 23:21:38 +00003203 }
3204
3205 // Emit the DIE children if any.
3206 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3207 const std::vector<DIE *> &Children = Die->getChildren();
3208
3209 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003210 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00003211
Chris Lattner7bde8c02010-04-04 18:52:31 +00003212 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00003213 Asm->OutStreamer.AddComment("End Of Children Mark");
3214 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003215 }
3216}
3217
Devang Patel9ccfb642009-12-09 18:24:21 +00003218/// emitDebugInfo - Emit the debug info section.
Bill Wendling480ff322009-05-20 23:21:38 +00003219///
Devang Patel9ccfb642009-12-09 18:24:21 +00003220void DwarfDebug::emitDebugInfo() {
3221 // Start debug info section.
3222 Asm->OutStreamer.SwitchSection(
3223 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel1a0df9a2010-05-10 22:49:55 +00003224 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3225 E = CUMap.end(); I != E; ++I) {
3226 CompileUnit *TheCU = I->second;
3227 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003228
Devang Patel1a0df9a2010-05-10 22:49:55 +00003229 // Emit the compile units header.
3230 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3231 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003232
Devang Patel1a0df9a2010-05-10 22:49:55 +00003233 // Emit size of content not including length itself
3234 unsigned ContentSize = Die->getSize() +
3235 sizeof(int16_t) + // DWARF version number
3236 sizeof(int32_t) + // Offset Into Abbrev. Section
3237 sizeof(int8_t) + // Pointer Size (in bytes)
3238 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003239
Devang Patel1a0df9a2010-05-10 22:49:55 +00003240 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3241 Asm->EmitInt32(ContentSize);
3242 Asm->OutStreamer.AddComment("DWARF version number");
3243 Asm->EmitInt16(dwarf::DWARF_VERSION);
3244 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3245 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3246 DwarfAbbrevSectionSym);
3247 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3248 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003249
Devang Patel1a0df9a2010-05-10 22:49:55 +00003250 emitDIE(Die);
3251 // FIXME - extra padding for gdb bug.
3252 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3253 Asm->EmitInt8(0);
3254 Asm->EmitInt8(0);
3255 Asm->EmitInt8(0);
3256 Asm->EmitInt8(0);
3257 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3258 }
Bill Wendling480ff322009-05-20 23:21:38 +00003259}
3260
Devang Patel930143b2009-11-21 02:48:08 +00003261/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling480ff322009-05-20 23:21:38 +00003262///
Devang Patel930143b2009-11-21 02:48:08 +00003263void DwarfDebug::emitAbbreviations() const {
Bill Wendling480ff322009-05-20 23:21:38 +00003264 // Check to see if it is worth the effort.
3265 if (!Abbreviations.empty()) {
3266 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003267 Asm->OutStreamer.SwitchSection(
3268 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003269
Chris Lattnera179b522010-04-04 19:25:43 +00003270 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003271
3272 // For each abbrevation.
3273 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3274 // Get abbreviation data
3275 const DIEAbbrev *Abbrev = Abbreviations[i];
3276
3277 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00003278 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00003279
3280 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003281 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00003282 }
3283
3284 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00003285 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00003286
Chris Lattnera179b522010-04-04 19:25:43 +00003287 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003288 }
3289}
3290
Devang Patel930143b2009-11-21 02:48:08 +00003291/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling480ff322009-05-20 23:21:38 +00003292/// the line matrix.
3293///
Devang Patel930143b2009-11-21 02:48:08 +00003294void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00003295 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00003296 Asm->OutStreamer.AddComment("Extended Op");
3297 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003298
Chris Lattner566cae92010-03-09 23:52:58 +00003299 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003300 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00003301 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3302 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3303
3304 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00003305
Chris Lattnera179b522010-04-04 19:25:43 +00003306 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003307 Asm->getTargetData().getPointerSize(),
3308 0/*AddrSpace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003309
3310 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00003311 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3312 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003313 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00003314 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003315}
3316
Devang Patel930143b2009-11-21 02:48:08 +00003317/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling480ff322009-05-20 23:21:38 +00003318///
Devang Patel930143b2009-11-21 02:48:08 +00003319void DwarfDebug::emitCommonDebugFrame() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003320 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003321 return;
3322
Chris Lattner3a383cb2010-04-05 00:13:49 +00003323 int stackGrowth = Asm->getTargetData().getPointerSize();
Anton Korobeynikov2f931282011-01-10 12:39:04 +00003324 if (Asm->TM.getFrameLowering()->getStackGrowthDirection() ==
3325 TargetFrameLowering::StackGrowsDown)
Chris Lattner3a383cb2010-04-05 00:13:49 +00003326 stackGrowth *= -1;
Bill Wendling480ff322009-05-20 23:21:38 +00003327
3328 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003329 Asm->OutStreamer.SwitchSection(
3330 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003331
Chris Lattnera179b522010-04-04 19:25:43 +00003332 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner566cae92010-03-09 23:52:58 +00003333 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003334 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3335 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003336
Chris Lattnera179b522010-04-04 19:25:43 +00003337 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner566cae92010-03-09 23:52:58 +00003338 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling480ff322009-05-20 23:21:38 +00003339 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner566cae92010-03-09 23:52:58 +00003340 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling480ff322009-05-20 23:21:38 +00003341 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner566cae92010-03-09 23:52:58 +00003342 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003343 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner9efd1182010-04-04 19:09:29 +00003344 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3345 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner566cae92010-03-09 23:52:58 +00003346 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003347 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Anton Korobeynikov2f931282011-01-10 12:39:04 +00003348 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
Bill Wendling480ff322009-05-20 23:21:38 +00003349 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling480ff322009-05-20 23:21:38 +00003350
3351 std::vector<MachineMove> Moves;
Anton Korobeynikov14ee3442010-11-18 23:25:52 +00003352 TFI->getInitialFrameState(Moves);
Bill Wendling480ff322009-05-20 23:21:38 +00003353
Chris Lattneraabc6042010-04-04 23:41:46 +00003354 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003355
Chris Lattner9e06e532010-04-28 01:05:45 +00003356 Asm->EmitAlignment(2);
Chris Lattnera179b522010-04-04 19:25:43 +00003357 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003358}
3359
Devang Patel930143b2009-11-21 02:48:08 +00003360/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling480ff322009-05-20 23:21:38 +00003361/// section.
Chris Lattner2c3f4782010-03-13 07:26:18 +00003362void DwarfDebug::
3363emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003364 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003365 return;
3366
3367 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003368 Asm->OutStreamer.SwitchSection(
3369 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003370
Chris Lattner566cae92010-03-09 23:52:58 +00003371 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner2c3f4782010-03-13 07:26:18 +00003372 MCSymbol *DebugFrameBegin =
Chris Lattnera179b522010-04-04 19:25:43 +00003373 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003374 MCSymbol *DebugFrameEnd =
Chris Lattnera179b522010-04-04 19:25:43 +00003375 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnerf1429f12010-04-04 19:58:12 +00003376 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003377
Chris Lattner2c3f4782010-03-13 07:26:18 +00003378 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling480ff322009-05-20 23:21:38 +00003379
Chris Lattner566cae92010-03-09 23:52:58 +00003380 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003381 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner70a4fce2010-04-04 23:25:33 +00003382 DwarfFrameSectionSym);
Bill Wendling480ff322009-05-20 23:21:38 +00003383
Chris Lattner566cae92010-03-09 23:52:58 +00003384 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnera179b522010-04-04 19:25:43 +00003385 MCSymbol *FuncBeginSym =
3386 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattner8811e122010-03-13 07:40:56 +00003387 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattner3a383cb2010-04-05 00:13:49 +00003388 Asm->getTargetData().getPointerSize(),
3389 0/*AddrSpace*/);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003390
3391
Chris Lattner566cae92010-03-09 23:52:58 +00003392 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003393 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003394 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003395
Chris Lattneraabc6042010-04-04 23:41:46 +00003396 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003397
Chris Lattner9e06e532010-04-28 01:05:45 +00003398 Asm->EmitAlignment(2);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003399 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling480ff322009-05-20 23:21:38 +00003400}
3401
Devang Patel9ccfb642009-12-09 18:24:21 +00003402/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3403///
3404void DwarfDebug::emitDebugPubNames() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003405 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3406 E = CUMap.end(); I != E; ++I) {
3407 CompileUnit *TheCU = I->second;
3408 // Start the dwarf pubnames section.
3409 Asm->OutStreamer.SwitchSection(
3410 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003411
Devang Patel1a0df9a2010-05-10 22:49:55 +00003412 Asm->OutStreamer.AddComment("Length of Public Names Info");
3413 Asm->EmitLabelDifference(
3414 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3415 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003416
Devang Patel1a0df9a2010-05-10 22:49:55 +00003417 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3418 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003419
Devang Patel1a0df9a2010-05-10 22:49:55 +00003420 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003421 Asm->EmitInt16(dwarf::DWARF_VERSION);
3422
Devang Patel1a0df9a2010-05-10 22:49:55 +00003423 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003424 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00003425 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003426
Devang Patel1a0df9a2010-05-10 22:49:55 +00003427 Asm->OutStreamer.AddComment("Compilation Unit Length");
3428 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3429 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3430 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003431
Devang Patel1a0df9a2010-05-10 22:49:55 +00003432 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3433 for (StringMap<DIE*>::const_iterator
3434 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3435 const char *Name = GI->getKeyData();
3436 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003437
Devang Patel1a0df9a2010-05-10 22:49:55 +00003438 Asm->OutStreamer.AddComment("DIE offset");
3439 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003440
Devang Patel1a0df9a2010-05-10 22:49:55 +00003441 if (Asm->isVerbose())
3442 Asm->OutStreamer.AddComment("External Name");
3443 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3444 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003445
Devang Patel1a0df9a2010-05-10 22:49:55 +00003446 Asm->OutStreamer.AddComment("End Mark");
3447 Asm->EmitInt32(0);
3448 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3449 TheCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00003450 }
Bill Wendling480ff322009-05-20 23:21:38 +00003451}
3452
Devang Patel04d2f2d2009-11-24 01:14:22 +00003453void DwarfDebug::emitDebugPubTypes() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003454 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3455 E = CUMap.end(); I != E; ++I) {
3456 CompileUnit *TheCU = I->second;
3457 // Start the dwarf pubnames section.
3458 Asm->OutStreamer.SwitchSection(
3459 Asm->getObjFileLowering().getDwarfPubTypesSection());
3460 Asm->OutStreamer.AddComment("Length of Public Types Info");
3461 Asm->EmitLabelDifference(
3462 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3463 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003464
Devang Patel1a0df9a2010-05-10 22:49:55 +00003465 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3466 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003467
Devang Patel1a0df9a2010-05-10 22:49:55 +00003468 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3469 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003470
Devang Patel1a0df9a2010-05-10 22:49:55 +00003471 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3472 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3473 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003474
Devang Patel1a0df9a2010-05-10 22:49:55 +00003475 Asm->OutStreamer.AddComment("Compilation Unit Length");
3476 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3477 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3478 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003479
Devang Patel1a0df9a2010-05-10 22:49:55 +00003480 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3481 for (StringMap<DIE*>::const_iterator
3482 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3483 const char *Name = GI->getKeyData();
3484 DIE * Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003485
Devang Patel1a0df9a2010-05-10 22:49:55 +00003486 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3487 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003488
Devang Patel1a0df9a2010-05-10 22:49:55 +00003489 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3490 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3491 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003492
Devang Patel1a0df9a2010-05-10 22:49:55 +00003493 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003494 Asm->EmitInt32(0);
Devang Patel1a0df9a2010-05-10 22:49:55 +00003495 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3496 TheCU->getID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00003497 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00003498}
3499
Devang Patel930143b2009-11-21 02:48:08 +00003500/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling480ff322009-05-20 23:21:38 +00003501///
Devang Patel930143b2009-11-21 02:48:08 +00003502void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00003503 // Check to see if it is worth the effort.
Chris Lattner3d72a672010-03-09 23:38:23 +00003504 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003505
Chris Lattner3d72a672010-03-09 23:38:23 +00003506 // Start the dwarf str section.
3507 Asm->OutStreamer.SwitchSection(
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003508 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003509
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003510 // Get all of the string pool entries and put them in an array by their ID so
3511 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003512 SmallVector<std::pair<unsigned,
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003513 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003514
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003515 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3516 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3517 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003518
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003519 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003520
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003521 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00003522 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003523 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003524
Chris Lattner3d72a672010-03-09 23:38:23 +00003525 // Emit the string itself.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003526 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003527 }
3528}
3529
Devang Patel930143b2009-11-21 02:48:08 +00003530/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling480ff322009-05-20 23:21:38 +00003531///
Devang Patel930143b2009-11-21 02:48:08 +00003532void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003533 if (DotDebugLocEntries.empty())
3534 return;
3535
Bill Wendling480ff322009-05-20 23:21:38 +00003536 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003537 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00003538 Asm->getObjFileLowering().getDwarfLocSection());
3539 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003540 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3541 unsigned index = 1;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003542 for (SmallVector<DotDebugLocEntry, 4>::iterator
3543 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00003544 I != E; ++I, ++index) {
Devang Patel9fc11702010-05-25 23:40:22 +00003545 DotDebugLocEntry Entry = *I;
Devang Patel9fc11702010-05-25 23:40:22 +00003546 if (Entry.isEmpty()) {
3547 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3548 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003549 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00003550 } else {
3551 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3552 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3553 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3554 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patel0e60e672010-08-04 18:40:52 +00003555 if (int Offset = Entry.Loc.getOffset()) {
3556 // If the value is at a certain offset from frame register then
3557 // use DW_OP_fbreg.
3558 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patel9fc11702010-05-25 23:40:22 +00003559 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patel0e60e672010-08-04 18:40:52 +00003560 Asm->EmitInt16(1 + OffsetSize);
3561 Asm->OutStreamer.AddComment(
3562 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3563 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3564 Asm->OutStreamer.AddComment("Offset");
3565 Asm->EmitSLEB128(Offset);
Devang Patel9fc11702010-05-25 23:40:22 +00003566 } else {
Devang Patel0e60e672010-08-04 18:40:52 +00003567 if (Reg < 32) {
3568 Asm->OutStreamer.AddComment("Loc expr size");
3569 Asm->EmitInt16(1);
3570 Asm->OutStreamer.AddComment(
Devang Patel6d21f612010-08-04 20:32:36 +00003571 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patel0e60e672010-08-04 18:40:52 +00003572 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3573 } else {
3574 Asm->OutStreamer.AddComment("Loc expr size");
3575 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3576 Asm->EmitInt8(dwarf::DW_OP_regx);
3577 Asm->EmitULEB128(Reg);
3578 }
Devang Patel9fc11702010-05-25 23:40:22 +00003579 }
3580 }
3581 }
Bill Wendling480ff322009-05-20 23:21:38 +00003582}
3583
3584/// EmitDebugARanges - Emit visible names into a debug aranges section.
3585///
3586void DwarfDebug::EmitDebugARanges() {
3587 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003588 Asm->OutStreamer.SwitchSection(
3589 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003590}
3591
Devang Patel930143b2009-11-21 02:48:08 +00003592/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling480ff322009-05-20 23:21:38 +00003593///
Devang Patel930143b2009-11-21 02:48:08 +00003594void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00003595 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003596 Asm->OutStreamer.SwitchSection(
Devang Patel12563b32010-04-16 23:33:45 +00003597 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Patel6c74a872010-04-27 19:46:33 +00003598 unsigned char Size = Asm->getTargetData().getPointerSize();
3599 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003600 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00003601 I != E; ++I) {
3602 if (*I)
3603 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patel12563b32010-04-16 23:33:45 +00003604 else
Devang Patel6c74a872010-04-27 19:46:33 +00003605 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel12563b32010-04-16 23:33:45 +00003606 }
Bill Wendling480ff322009-05-20 23:21:38 +00003607}
3608
Devang Patel930143b2009-11-21 02:48:08 +00003609/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling480ff322009-05-20 23:21:38 +00003610///
Devang Patel930143b2009-11-21 02:48:08 +00003611void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003612 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00003613 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00003614 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003615 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003616 }
3617}
3618
Devang Patel930143b2009-11-21 02:48:08 +00003619/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling480ff322009-05-20 23:21:38 +00003620/// Section Header:
3621/// 1. length of section
3622/// 2. Dwarf version number
3623/// 3. address size.
3624///
3625/// Entries (one "entry" for each function that was inlined):
3626///
3627/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3628/// otherwise offset into __debug_str for regular function name.
3629/// 2. offset into __debug_str section for regular function name.
3630/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3631/// instances for the function.
3632///
3633/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3634/// inlined instance; the die_offset points to the inlined_subroutine die in the
3635/// __debug_info section, and the low_pc is the starting address for the
3636/// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00003637void DwarfDebug::emitDebugInlineInfo() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003638 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003639 return;
3640
Devang Patel1a0df9a2010-05-10 22:49:55 +00003641 if (!FirstCU)
Bill Wendling480ff322009-05-20 23:21:38 +00003642 return;
3643
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003644 Asm->OutStreamer.SwitchSection(
3645 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003646
Chris Lattner566cae92010-03-09 23:52:58 +00003647 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003648 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3649 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003650
Chris Lattnera179b522010-04-04 19:25:43 +00003651 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003652
Chris Lattner566cae92010-03-09 23:52:58 +00003653 Asm->OutStreamer.AddComment("Dwarf Version");
3654 Asm->EmitInt16(dwarf::DWARF_VERSION);
3655 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003656 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003657
Devang Patel32cc43c2010-05-07 20:54:48 +00003658 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003659 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00003660
Devang Patel32cc43c2010-05-07 20:54:48 +00003661 const MDNode *Node = *I;
3662 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00003663 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003664 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00003665 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00003666 StringRef LName = SP.getLinkageName();
3667 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00003668
Chris Lattner566cae92010-03-09 23:52:58 +00003669 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003670 if (LName.empty()) {
3671 Asm->OutStreamer.EmitBytes(Name, 0);
3672 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003673 } else
Chris Lattner70a4fce2010-04-04 23:25:33 +00003674 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3675 DwarfStrSectionSym);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003676
Chris Lattner566cae92010-03-09 23:52:58 +00003677 Asm->OutStreamer.AddComment("Function name");
Chris Lattner70a4fce2010-04-04 23:25:33 +00003678 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner9efd1182010-04-04 19:09:29 +00003679 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00003680
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003681 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00003682 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner7bde8c02010-04-04 18:52:31 +00003683 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner085b6522010-03-09 00:31:02 +00003684 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003685
Chris Lattner7bde8c02010-04-04 18:52:31 +00003686 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003687 Asm->OutStreamer.EmitSymbolValue(LI->first,
3688 Asm->getTargetData().getPointerSize(),0);
Bill Wendling480ff322009-05-20 23:21:38 +00003689 }
3690 }
3691
Chris Lattnera179b522010-04-04 19:25:43 +00003692 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003693}