blob: 7fa4b6f24a4a1c8fb9f20d364fd3b0d8d62224b4 [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 Patela5d93242011-02-24 18:49:30 +000034#include "llvm/Analysis/DIBuilder.h"
Devang Patela86114b2010-10-25 20:45:32 +000035#include "llvm/ADT/Statistic.h"
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000036#include "llvm/ADT/STLExtras.h"
Chris Lattner06fa1762009-08-24 03:52:50 +000037#include "llvm/ADT/StringExtras.h"
Devang Patel6c74a872010-04-27 19:46:33 +000038#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000039#include "llvm/Support/Debug.h"
40#include "llvm/Support/ErrorHandling.h"
Devang Patel1973df22010-01-26 21:39:14 +000041#include "llvm/Support/ValueHandle.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000042#include "llvm/Support/FormattedStream.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000043#include "llvm/Support/Timer.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000044#include "llvm/Support/Path.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000045using namespace llvm;
46
Devang Patel6c74a872010-04-27 19:46:33 +000047static cl::opt<bool> PrintDbgScope("print-dbgscope", cl::Hidden,
48 cl::desc("Print DbgScope information for each machine instruction"));
49
Jim Grosbacha8683bb2010-07-21 21:21:52 +000050static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel30265c42010-07-07 20:12:52 +000051 cl::Hidden,
Devang Patel6c74a872010-04-27 19:46:33 +000052 cl::desc("Disable debug info printing"));
53
Dan Gohman7421ae42010-05-07 01:08:53 +000054static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
55 cl::desc("Make an absense of debug location information explicit."),
56 cl::init(false));
57
Nick Lewycky90b2ac22010-10-26 00:51:57 +000058#ifndef NDEBUG
Devang Patela86114b2010-10-25 20:45:32 +000059STATISTIC(BlocksWithoutLineNo, "Number of blocks without any line number");
Nick Lewycky90b2ac22010-10-26 00:51:57 +000060#endif
Devang Patela86114b2010-10-25 20:45:32 +000061
Bill Wendlingfcc14142010-04-07 09:28:04 +000062namespace {
63 const char *DWARFGroupName = "DWARF Emission";
64 const char *DbgTimerName = "DWARF Debug Writer";
65} // end anonymous namespace
66
Bill Wendling2f921f82009-05-15 09:23:25 +000067//===----------------------------------------------------------------------===//
68
69/// Configuration values for initial hash set sizes (log2).
70///
Bill Wendling2f921f82009-05-15 09:23:25 +000071static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +000072
73namespace llvm {
74
75//===----------------------------------------------------------------------===//
76/// CompileUnit - This dwarf writer support class manages information associate
77/// with a source file.
Nick Lewyckyb7993d62009-11-17 08:11:44 +000078class CompileUnit {
Bill Wendling2f921f82009-05-15 09:23:25 +000079 /// ID - File identifier for source.
80 ///
81 unsigned ID;
82
83 /// Die - Compile unit debug information entry.
84 ///
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000085 const OwningPtr<DIE> CUDie;
Bill Wendling2f921f82009-05-15 09:23:25 +000086
Jeffrey Yasskin0708de12010-03-11 18:29:55 +000087 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
Devang Patel92e8c652009-11-21 00:31:03 +000088 DIE *IndexTyDie;
89
Devang Patel9a0339f2010-07-07 20:49:57 +000090 /// MDNodeToDieMap - Tracks the mapping of unit level debug informaton
Bill Wendling2f921f82009-05-15 09:23:25 +000091 /// variables to debug information entries.
Devang Patel9a0339f2010-07-07 20:49:57 +000092 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
Bill Wendling2f921f82009-05-15 09:23:25 +000093
Devang Patel9a0339f2010-07-07 20:49:57 +000094 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug informaton
Bill Wendling2f921f82009-05-15 09:23:25 +000095 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patel9a0339f2010-07-07 20:49:57 +000096 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
Bill Wendling2f921f82009-05-15 09:23:25 +000097
98 /// Globals - A map of globally visible named entities for this unit.
99 ///
100 StringMap<DIE*> Globals;
101
Devang Patel04d2f2d2009-11-24 01:14:22 +0000102 /// GlobalTypes - A map of globally visible types for this unit.
103 ///
104 StringMap<DIE*> GlobalTypes;
105
Bill Wendling2f921f82009-05-15 09:23:25 +0000106public:
107 CompileUnit(unsigned I, DIE *D)
Devang Patel930143b2009-11-21 02:48:08 +0000108 : ID(I), CUDie(D), IndexTyDie(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000109
110 // Accessors.
Devang Patel04d2f2d2009-11-24 01:14:22 +0000111 unsigned getID() const { return ID; }
Jeffrey Yasskin0708de12010-03-11 18:29:55 +0000112 DIE* getCUDie() const { return CUDie.get(); }
Devang Patel04d2f2d2009-11-24 01:14:22 +0000113 const StringMap<DIE*> &getGlobals() const { return Globals; }
114 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000115
116 /// hasContent - Return true if this compile unit has something to write out.
117 ///
Devang Patel930143b2009-11-21 02:48:08 +0000118 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000119
Devang Patel930143b2009-11-21 02:48:08 +0000120 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +0000121 ///
Benjamin Kramer96956ed2010-03-31 20:15:45 +0000122 void addGlobal(StringRef Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000123
Devang Patel04d2f2d2009-11-24 01:14:22 +0000124 /// addGlobalType - Add a new global type to the compile unit.
125 ///
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000126 void addGlobalType(StringRef Name, DIE *Die) {
127 GlobalTypes[Name] = Die;
Devang Patel04d2f2d2009-11-24 01:14:22 +0000128 }
129
Devang Patele064ad42009-11-20 21:37:22 +0000130 /// getDIE - Returns the debug information entry map slot for the
Bill Wendling2f921f82009-05-15 09:23:25 +0000131 /// specified debug variable.
Devang Patel9a0339f2010-07-07 20:49:57 +0000132 DIE *getDIE(const MDNode *N) { return MDNodeToDieMap.lookup(N); }
Jim Grosbach042483e2009-11-21 23:12:12 +0000133
Devang Patele064ad42009-11-20 21:37:22 +0000134 /// insertDIE - Insert DIE into the map.
Devang Patel32cc43c2010-05-07 20:54:48 +0000135 void insertDIE(const MDNode *N, DIE *D) {
Devang Patel9a0339f2010-07-07 20:49:57 +0000136 MDNodeToDieMap.insert(std::make_pair(N, D));
Devang Patele064ad42009-11-20 21:37:22 +0000137 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000138
Devang Patele064ad42009-11-20 21:37:22 +0000139 /// getDIEEntry - Returns the debug information entry for the speciefied
140 /// debug variable.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000141 DIEEntry *getDIEEntry(const MDNode *N) {
142 DenseMap<const MDNode *, DIEEntry *>::iterator I =
143 MDNodeToDIEEntryMap.find(N);
Devang Patel9a0339f2010-07-07 20:49:57 +0000144 if (I == MDNodeToDIEEntryMap.end())
Devang Patel1f4690c2009-12-15 19:16:48 +0000145 return NULL;
146 return I->second;
147 }
Devang Patele064ad42009-11-20 21:37:22 +0000148
149 /// insertDIEEntry - Insert debug information entry into the map.
Devang Patel32cc43c2010-05-07 20:54:48 +0000150 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
Devang Patel9a0339f2010-07-07 20:49:57 +0000151 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
Bill Wendling2f921f82009-05-15 09:23:25 +0000152 }
153
Devang Patel930143b2009-11-21 02:48:08 +0000154 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +0000155 ///
Devang Patel930143b2009-11-21 02:48:08 +0000156 void addDie(DIE *Buffer) {
157 this->CUDie->addChild(Buffer);
Bill Wendling2f921f82009-05-15 09:23:25 +0000158 }
Devang Patel92e8c652009-11-21 00:31:03 +0000159
160 // getIndexTyDie - Get an anonymous type for index type.
161 DIE *getIndexTyDie() {
162 return IndexTyDie;
163 }
164
Jim Grosbach00e9c612009-11-22 19:20:36 +0000165 // setIndexTyDie - Set D as anonymous type for index which can be reused
166 // later.
Devang Patel92e8c652009-11-21 00:31:03 +0000167 void setIndexTyDie(DIE *D) {
168 IndexTyDie = D;
169 }
170
Bill Wendling2f921f82009-05-15 09:23:25 +0000171};
172
173//===----------------------------------------------------------------------===//
174/// DbgVariable - This class is used to track local variable information.
175///
Devang Patelf3d7c082009-11-16 21:53:40 +0000176class DbgVariable {
Bill Wendling2f921f82009-05-15 09:23:25 +0000177 DIVariable Var; // Variable Descriptor.
Devang Patel9fc11702010-05-25 23:40:22 +0000178 DIE *TheDIE; // Variable DIE.
179 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
Bill Wendling2f921f82009-05-15 09:23:25 +0000180public:
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000181 // AbsVar may be NULL.
Devang Patel9fc11702010-05-25 23:40:22 +0000182 DbgVariable(DIVariable V) : Var(V), TheDIE(0), DotDebugLocOffset(~0U) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000183
184 // Accessors.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000185 DIVariable getVariable() const { return Var; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000186 void setDIE(DIE *D) { TheDIE = D; }
187 DIE *getDIE() const { return TheDIE; }
Devang Patel9fc11702010-05-25 23:40:22 +0000188 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
189 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000190 StringRef getName() const { return Var.getName(); }
191 unsigned getTag() const { return Var.getTag(); }
192 bool variableHasComplexAddress() const {
193 assert(Var.Verify() && "Invalid complex DbgVariable!");
194 return Var.hasComplexAddress();
195 }
196 bool isBlockByrefVariable() const {
197 assert(Var.Verify() && "Invalid complex DbgVariable!");
198 return Var.isBlockByrefVariable();
199 }
200 unsigned getNumAddrElements() const {
201 assert(Var.Verify() && "Invalid complex DbgVariable!");
202 return Var.getNumAddrElements();
203 }
204 uint64_t getAddrElement(unsigned i) const {
205 return Var.getAddrElement(i);
206 }
207 DIType getType() const {
208 DIType Ty = Var.getType();
209 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
210 // addresses instead.
211 if (Var.isBlockByrefVariable()) {
212 /* Byref variables, in Blocks, are declared by the programmer as
213 "SomeType VarName;", but the compiler creates a
214 __Block_byref_x_VarName struct, and gives the variable VarName
215 either the struct, or a pointer to the struct, as its type. This
216 is necessary for various behind-the-scenes things the compiler
217 needs to do with by-reference variables in blocks.
218
219 However, as far as the original *programmer* is concerned, the
220 variable should still have type 'SomeType', as originally declared.
221
222 The following function dives into the __Block_byref_x_VarName
223 struct to find the original type of the variable. This will be
224 passed back to the code generating the type for the Debug
225 Information Entry for the variable 'VarName'. 'VarName' will then
226 have the original type 'SomeType' in its debug information.
227
228 The original type 'SomeType' will be the type of the field named
229 'VarName' inside the __Block_byref_x_VarName struct.
230
231 NOTE: In order for this to not completely fail on the debugger
232 side, the Debug Information Entry for the variable VarName needs to
233 have a DW_AT_location that tells the debugger how to unwind through
234 the pointers and __Block_byref_x_VarName struct to find the actual
235 value of the variable. The function addBlockByrefType does this. */
236 DIType subType = Ty;
237 unsigned tag = Ty.getTag();
238
239 if (tag == dwarf::DW_TAG_pointer_type) {
240 DIDerivedType DTy = DIDerivedType(Ty);
241 subType = DTy.getTypeDerivedFrom();
242 }
243
244 DICompositeType blockStruct = DICompositeType(subType);
245 DIArray Elements = blockStruct.getTypeArray();
246
247 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
248 DIDescriptor Element = Elements.getElement(i);
249 DIDerivedType DT = DIDerivedType(Element);
250 if (getName() == DT.getName())
251 return (DT.getTypeDerivedFrom());
252 }
253 return Ty;
254 }
255 return Ty;
256 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000257};
258
259//===----------------------------------------------------------------------===//
Devang Patel6c74a872010-04-27 19:46:33 +0000260/// DbgRange - This is used to track range of instructions with identical
261/// debug info scope.
262///
263typedef std::pair<const MachineInstr *, const MachineInstr *> DbgRange;
264
265//===----------------------------------------------------------------------===//
Bill Wendling2f921f82009-05-15 09:23:25 +0000266/// DbgScope - This class is used to track scope information.
267///
Devang Patelf3d7c082009-11-16 21:53:40 +0000268class DbgScope {
Bill Wendling2f921f82009-05-15 09:23:25 +0000269 DbgScope *Parent; // Parent to this scope.
Jim Grosbach042483e2009-11-21 23:12:12 +0000270 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel1973df22010-01-26 21:39:14 +0000271 // Location at which this scope is inlined.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000272 AssertingVH<const MDNode> InlinedAtLocation;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000273 bool AbstractScope; // Abstract Scope
Devang Patel787f94c2009-10-01 18:25:23 +0000274 const MachineInstr *LastInsn; // Last instruction of this scope.
275 const MachineInstr *FirstInsn; // First instruction of this scope.
Devang Patel6c74a872010-04-27 19:46:33 +0000276 unsigned DFSIn, DFSOut;
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000277 // Scopes defined in scope. Contents not owned.
278 SmallVector<DbgScope *, 4> Scopes;
279 // Variables declared in scope. Contents owned.
280 SmallVector<DbgVariable *, 8> Variables;
Devang Patel6c74a872010-04-27 19:46:33 +0000281 SmallVector<DbgRange, 4> Ranges;
Owen Anderson9becc182009-06-24 22:53:20 +0000282 // Private state for dump()
283 mutable unsigned IndentLevel;
Bill Wendling2f921f82009-05-15 09:23:25 +0000284public:
Devang Patel32cc43c2010-05-07 20:54:48 +0000285 DbgScope(DbgScope *P, DIDescriptor D, const MDNode *I = 0)
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000286 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Devang Patel6c74a872010-04-27 19:46:33 +0000287 LastInsn(0), FirstInsn(0),
288 DFSIn(0), DFSOut(0), IndentLevel(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000289 virtual ~DbgScope();
290
291 // Accessors.
292 DbgScope *getParent() const { return Parent; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000293 void setParent(DbgScope *P) { Parent = P; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000294 DIDescriptor getDesc() const { return Desc; }
Devang Patel32cc43c2010-05-07 20:54:48 +0000295 const MDNode *getInlinedAt() const { return InlinedAtLocation; }
296 const MDNode *getScopeNode() const { return Desc; }
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000297 const SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
Devang Patel406798a2010-08-09 18:51:29 +0000298 const SmallVector<DbgVariable *, 8> &getDbgVariables() { return Variables; }
Devang Patel6c74a872010-04-27 19:46:33 +0000299 const SmallVector<DbgRange, 4> &getRanges() { return Ranges; }
300
301 /// openInsnRange - This scope covers instruction range starting from MI.
302 void openInsnRange(const MachineInstr *MI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000303 if (!FirstInsn)
Devang Patel6c74a872010-04-27 19:46:33 +0000304 FirstInsn = MI;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000305
Devang Patel6c74a872010-04-27 19:46:33 +0000306 if (Parent)
307 Parent->openInsnRange(MI);
308 }
309
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000310 /// extendInsnRange - Extend the current instruction range covered by
Devang Patel6c74a872010-04-27 19:46:33 +0000311 /// this scope.
312 void extendInsnRange(const MachineInstr *MI) {
313 assert (FirstInsn && "MI Range is not open!");
314 LastInsn = MI;
315 if (Parent)
316 Parent->extendInsnRange(MI);
317 }
318
319 /// closeInsnRange - Create a range based on FirstInsn and LastInsn collected
320 /// until now. This is used when a new scope is encountered while walking
321 /// machine instructions.
322 void closeInsnRange(DbgScope *NewScope = NULL) {
323 assert (LastInsn && "Last insn missing!");
324 Ranges.push_back(DbgRange(FirstInsn, LastInsn));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000325 FirstInsn = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +0000326 LastInsn = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000327 // If Parent dominates NewScope then do not close Parent's instruction
Devang Patel6c74a872010-04-27 19:46:33 +0000328 // range.
329 if (Parent && (!NewScope || !Parent->dominates(NewScope)))
330 Parent->closeInsnRange(NewScope);
331 }
332
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000333 void setAbstractScope() { AbstractScope = true; }
334 bool isAbstractScope() const { return AbstractScope; }
Devang Patel6c74a872010-04-27 19:46:33 +0000335
336 // Depth First Search support to walk and mainpluate DbgScope hierarchy.
337 unsigned getDFSOut() const { return DFSOut; }
338 void setDFSOut(unsigned O) { DFSOut = O; }
339 unsigned getDFSIn() const { return DFSIn; }
340 void setDFSIn(unsigned I) { DFSIn = I; }
341 bool dominates(const DbgScope *S) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000342 if (S == this)
Devang Patel6c74a872010-04-27 19:46:33 +0000343 return true;
344 if (DFSIn < S->getDFSIn() && DFSOut > S->getDFSOut())
345 return true;
346 return false;
347 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000348
Devang Patel930143b2009-11-21 02:48:08 +0000349 /// addScope - Add a scope to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000350 ///
Devang Patel930143b2009-11-21 02:48:08 +0000351 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000352
Devang Patel930143b2009-11-21 02:48:08 +0000353 /// addVariable - Add a variable to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000354 ///
Devang Patel930143b2009-11-21 02:48:08 +0000355 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000356
Bill Wendling2f921f82009-05-15 09:23:25 +0000357#ifndef NDEBUG
358 void dump() const;
359#endif
360};
Devang Patel6c74a872010-04-27 19:46:33 +0000361
Chris Lattnerf5d06362010-04-05 04:09:20 +0000362} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000363
364#ifndef NDEBUG
365void DbgScope::dump() const {
David Greenec230cb92009-12-24 00:31:35 +0000366 raw_ostream &err = dbgs();
Chris Lattner81e8e022009-08-23 00:51:00 +0000367 err.indent(IndentLevel);
Devang Patel32cc43c2010-05-07 20:54:48 +0000368 const MDNode *N = Desc;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000369 N->dump();
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000370 if (AbstractScope)
371 err << "Abstract Scope\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000372
373 IndentLevel += 2;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000374 if (!Scopes.empty())
375 err << "Children ...\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000376 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
377 if (Scopes[i] != this)
378 Scopes[i]->dump();
379
380 IndentLevel -= 2;
381}
382#endif
383
Bill Wendling2f921f82009-05-15 09:23:25 +0000384DbgScope::~DbgScope() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000385 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
386 delete Variables[j];
Bill Wendling2f921f82009-05-15 09:23:25 +0000387}
388
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000389DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Devang Patel1a0df9a2010-05-10 22:49:55 +0000390 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000391 AbbreviationsSet(InitAbbreviationsSetSize),
Devang Patel12563b32010-04-16 23:33:45 +0000392 CurrentFnDbgScope(0), PrevLabel(NULL) {
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000393 NextStringPoolNumber = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000394
Chris Lattnere58b5472010-04-04 23:10:38 +0000395 DwarfFrameSectionSym = DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
396 DwarfStrSectionSym = TextSectionSym = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000397 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000398 FunctionBeginSym = FunctionEndSym = 0;
Devang Patel9c160e12010-07-08 20:10:35 +0000399 DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
Dan Gohman6e681a52010-06-18 15:56:31 +0000400 {
401 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
402 beginModule(M);
Torok Edwinf8dba242010-04-07 10:44:46 +0000403 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000404}
405DwarfDebug::~DwarfDebug() {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000406 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
407 DIEBlocks[j]->~DIEBlock();
Bill Wendling2f921f82009-05-15 09:23:25 +0000408}
409
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000410MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
411 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
412 if (Entry.first) return Entry.first;
413
414 Entry.second = NextStringPoolNumber++;
Chris Lattnera179b522010-04-04 19:25:43 +0000415 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000416}
417
418
Devang Patel930143b2009-11-21 02:48:08 +0000419/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling2f921f82009-05-15 09:23:25 +0000420///
Devang Patel930143b2009-11-21 02:48:08 +0000421void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000422 // Profile the node so that we can make it unique.
423 FoldingSetNodeID ID;
424 Abbrev.Profile(ID);
425
426 // Check the set for priors.
427 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
428
429 // If it's newly added.
430 if (InSet == &Abbrev) {
431 // Add to abbreviation list.
432 Abbreviations.push_back(&Abbrev);
433
434 // Assign the vector position + 1 as its number.
435 Abbrev.setNumber(Abbreviations.size());
436 } else {
437 // Assign existing abbreviation number.
438 Abbrev.setNumber(InSet->getNumber());
439 }
440}
441
Devang Patel930143b2009-11-21 02:48:08 +0000442/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendlingbcad77a2009-05-20 23:24:48 +0000443/// information entry.
Devang Patel930143b2009-11-21 02:48:08 +0000444DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000445 DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000446 return Value;
447}
448
Devang Patel930143b2009-11-21 02:48:08 +0000449/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000450///
Devang Patel930143b2009-11-21 02:48:08 +0000451void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000452 unsigned Form, uint64_t Integer) {
453 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000454 DIEValue *Value = Integer == 1 ?
Devang Patel9c160e12010-07-08 20:10:35 +0000455 DIEIntegerOne : new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000456 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000457}
458
Devang Patel930143b2009-11-21 02:48:08 +0000459/// addSInt - Add an signed integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000460///
Devang Patel930143b2009-11-21 02:48:08 +0000461void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000462 unsigned Form, int64_t Integer) {
463 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000464 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000465 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000466}
467
Devang Patel8c339592009-12-02 15:25:16 +0000468/// addString - Add a string attribute data and value. DIEString only
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000469/// keeps string reference.
Devang Patel930143b2009-11-21 02:48:08 +0000470void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerc3f23b82010-01-23 03:11:46 +0000471 StringRef String) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000472 DIEValue *Value = new (DIEValueAllocator) DIEString(String);
Devang Patel930143b2009-11-21 02:48:08 +0000473 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000474}
475
Devang Patel930143b2009-11-21 02:48:08 +0000476/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000477///
Devang Patel930143b2009-11-21 02:48:08 +0000478void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000479 const MCSymbol *Label) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000480 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
Devang Patel930143b2009-11-21 02:48:08 +0000481 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000482}
483
Devang Patel930143b2009-11-21 02:48:08 +0000484/// addDelta - Add a label delta attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000485///
Devang Patel930143b2009-11-21 02:48:08 +0000486void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000487 const MCSymbol *Hi, const MCSymbol *Lo) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000488 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
Devang Patel930143b2009-11-21 02:48:08 +0000489 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000490}
491
Chris Lattner3f3fb972010-04-05 05:24:55 +0000492/// addDIEEntry - Add a DIE attribute data and value.
493///
494void DwarfDebug::addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form,
495 DIE *Entry) {
496 Die->addValue(Attribute, Form, createDIEEntry(Entry));
497}
498
499
Devang Patel930143b2009-11-21 02:48:08 +0000500/// addBlock - Add block data.
Bill Wendling2f921f82009-05-15 09:23:25 +0000501///
Devang Patel930143b2009-11-21 02:48:08 +0000502void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling2f921f82009-05-15 09:23:25 +0000503 DIEBlock *Block) {
Chris Lattner5a00dea2010-04-05 00:18:22 +0000504 Block->ComputeSize(Asm);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000505 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
Devang Patel930143b2009-11-21 02:48:08 +0000506 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000507}
508
Devang Patel930143b2009-11-21 02:48:08 +0000509/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000510/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000511void DwarfDebug::addSourceLine(DIE *Die, DIVariable V) {
Devang Patel0625af22010-05-07 23:33:41 +0000512 // Verify variable.
Devang Patelb6511a32010-08-09 20:20:05 +0000513 if (!V.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000514 return;
515
Devang Patelb6511a32010-08-09 20:20:05 +0000516 unsigned Line = V.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000517 if (Line == 0)
518 return;
Devang Patele01b75c2011-03-24 20:30:50 +0000519 unsigned FileID = GetOrCreateSourceID(V.getContext().getFilename(),
520 V.getContext().getDirectory());
Bill Wendling2f921f82009-05-15 09:23:25 +0000521 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000522 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
523 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000524}
525
Devang Patel930143b2009-11-21 02:48:08 +0000526/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000527/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000528void DwarfDebug::addSourceLine(DIE *Die, DIGlobalVariable G) {
Devang Patel0625af22010-05-07 23:33:41 +0000529 // Verify global variable.
Devang Patelb6511a32010-08-09 20:20:05 +0000530 if (!G.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000531 return;
532
Devang Patelb6511a32010-08-09 20:20:05 +0000533 unsigned Line = G.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000534 if (Line == 0)
535 return;
Devang Patele01b75c2011-03-24 20:30:50 +0000536 unsigned FileID = GetOrCreateSourceID(G.getContext().getFilename(),
537 G.getContext().getDirectory());
Bill Wendling2f921f82009-05-15 09:23:25 +0000538 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000539 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
540 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000541}
Devang Patelb2de5fa2009-08-31 22:47:13 +0000542
Devang Patel930143b2009-11-21 02:48:08 +0000543/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000544/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000545void DwarfDebug::addSourceLine(DIE *Die, DISubprogram SP) {
Devang Patel0625af22010-05-07 23:33:41 +0000546 // Verify subprogram.
Devang Patelb6511a32010-08-09 20:20:05 +0000547 if (!SP.Verify())
Devang Patelb2de5fa2009-08-31 22:47:13 +0000548 return;
Caroline Tice183a5192009-09-11 18:25:54 +0000549 // If the line number is 0, don't add it.
Devang Patelb6511a32010-08-09 20:20:05 +0000550 if (SP.getLineNumber() == 0)
Caroline Tice183a5192009-09-11 18:25:54 +0000551 return;
552
Devang Patelb6511a32010-08-09 20:20:05 +0000553 unsigned Line = SP.getLineNumber();
554 if (!SP.getContext().Verify())
Devang Patel8119fe872010-03-08 22:02:50 +0000555 return;
Devang Patele01b75c2011-03-24 20:30:50 +0000556 unsigned FileID = GetOrCreateSourceID(SP.getFilename(), SP.getDirectory());
Devang Patelb2de5fa2009-08-31 22:47:13 +0000557 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000558 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
559 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patelb2de5fa2009-08-31 22:47:13 +0000560}
561
Devang Patel930143b2009-11-21 02:48:08 +0000562/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000563/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000564void DwarfDebug::addSourceLine(DIE *Die, DIType Ty) {
Devang Patel0625af22010-05-07 23:33:41 +0000565 // Verify type.
Devang Patelb6511a32010-08-09 20:20:05 +0000566 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000567 return;
568
Devang Patelb6511a32010-08-09 20:20:05 +0000569 unsigned Line = Ty.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000570 if (Line == 0 || !Ty.getContext().Verify())
Devang Patel8119fe872010-03-08 22:02:50 +0000571 return;
Devang Patele01b75c2011-03-24 20:30:50 +0000572 unsigned FileID = GetOrCreateSourceID(Ty.getFilename(), Ty.getDirectory());
Bill Wendling2f921f82009-05-15 09:23:25 +0000573 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000574 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
575 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000576}
577
Devang Patel1f4690c2009-12-15 19:16:48 +0000578/// addSourceLine - Add location information to specified debug information
579/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000580void DwarfDebug::addSourceLine(DIE *Die, DINameSpace NS) {
Devang Patel0625af22010-05-07 23:33:41 +0000581 // Verify namespace.
Devang Patelb6511a32010-08-09 20:20:05 +0000582 if (!NS.Verify())
Devang Patel1f4690c2009-12-15 19:16:48 +0000583 return;
584
Devang Patelb6511a32010-08-09 20:20:05 +0000585 unsigned Line = NS.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000586 if (Line == 0)
587 return;
Devang Patelb6511a32010-08-09 20:20:05 +0000588 StringRef FN = NS.getFilename();
Devang Patel1f4690c2009-12-15 19:16:48 +0000589
Devang Patele01b75c2011-03-24 20:30:50 +0000590 unsigned FileID = GetOrCreateSourceID(FN, NS.getDirectory());
Devang Patel1f4690c2009-12-15 19:16:48 +0000591 assert(FileID && "Invalid file id");
592 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
593 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
594}
595
Devang Patel2cfc3af2010-08-31 06:11:28 +0000596/// addVariableAddress - Add DW_AT_location attribute for a DbgVariable based
597/// on provided frame index.
598void DwarfDebug::addVariableAddress(DbgVariable *&DV, DIE *Die, int64_t FI) {
599 MachineLocation Location;
600 unsigned FrameReg;
Anton Korobeynikov2f931282011-01-10 12:39:04 +0000601 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
Anton Korobeynikov46877782010-11-20 15:59:32 +0000602 int Offset = TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
Devang Patel2cfc3af2010-08-31 06:11:28 +0000603 Location.set(FrameReg, Offset);
604
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000605 if (DV->variableHasComplexAddress())
606 addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
607 else if (DV->isBlockByrefVariable())
608 addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
609 else
610 addAddress(Die, dwarf::DW_AT_location, Location);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000611}
612
Devang Patel930143b2009-11-21 02:48:08 +0000613/// addComplexAddress - Start with the address based on the location provided,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000614/// and generate the DWARF information necessary to find the actual variable
615/// given the extra address information encoded in the DIVariable, starting from
616/// the starting location. Add the DWARF information to the die.
617///
Devang Patel930143b2009-11-21 02:48:08 +0000618void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000619 unsigned Attribute,
620 const MachineLocation &Location) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000621 DIType Ty = DV->getType();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000622
623 // Decode the original location, and use that as the start of the byref
624 // variable's location.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000625 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000626 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000627 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000628
629 if (Location.isReg()) {
630 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000631 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000632 } else {
Devang Patel8698f092011-01-19 23:04:47 +0000633 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
Devang Patel930143b2009-11-21 02:48:08 +0000634 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000635 }
636 } else {
637 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000638 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000639 else {
Devang Patel930143b2009-11-21 02:48:08 +0000640 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
641 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000642 }
643
Devang Patel930143b2009-11-21 02:48:08 +0000644 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump14cf8ec2009-09-30 00:08:22 +0000645 }
646
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000647 for (unsigned i = 0, N = DV->getNumAddrElements(); i < N; ++i) {
648 uint64_t Element = DV->getAddrElement(i);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000649
Devang Patela5d93242011-02-24 18:49:30 +0000650 if (Element == DIBuilder::OpPlus) {
Devang Patel930143b2009-11-21 02:48:08 +0000651 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000652 addUInt(Block, 0, dwarf::DW_FORM_udata, DV->getAddrElement(++i));
Devang Patela5d93242011-02-24 18:49:30 +0000653 } else if (Element == DIBuilder::OpDeref) {
Devang Patel930143b2009-11-21 02:48:08 +0000654 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Devang Patela5d93242011-02-24 18:49:30 +0000655 } else llvm_unreachable("unknown DIBuilder Opcode");
Mike Stump14cf8ec2009-09-30 00:08:22 +0000656 }
657
658 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000659 addBlock(Die, Attribute, 0, Block);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000660}
661
Caroline Ticec87c1e22009-08-31 21:19:37 +0000662/* Byref variables, in Blocks, are declared by the programmer as "SomeType
663 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
664 gives the variable VarName either the struct, or a pointer to the struct, as
665 its type. This is necessary for various behind-the-scenes things the
666 compiler needs to do with by-reference variables in Blocks.
667
668 However, as far as the original *programmer* is concerned, the variable
669 should still have type 'SomeType', as originally declared.
670
Devang Patel930143b2009-11-21 02:48:08 +0000671 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticec87c1e22009-08-31 21:19:37 +0000672 struct to find the original type of the variable, which is then assigned to
673 the variable's Debug Information Entry as its real type. So far, so good.
674 However now the debugger will expect the variable VarName to have the type
675 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000676 expression that explains to the debugger how to navigate through the
Caroline Ticec87c1e22009-08-31 21:19:37 +0000677 pointers and struct to find the actual variable of type SomeType.
678
679 The following function does just that. We start by getting
680 the "normal" location for the variable. This will be the location
681 of either the struct __Block_byref_x_VarName or the pointer to the
682 struct __Block_byref_x_VarName.
683
684 The struct will look something like:
685
686 struct __Block_byref_x_VarName {
687 ... <various fields>
688 struct __Block_byref_x_VarName *forwarding;
689 ... <various other fields>
690 SomeType VarName;
691 ... <maybe more fields>
692 };
693
694 If we are given the struct directly (as our starting point) we
695 need to tell the debugger to:
696
697 1). Add the offset of the forwarding field.
698
Dan Gohman4a618822010-02-10 16:03:48 +0000699 2). Follow that pointer to get the real __Block_byref_x_VarName
Caroline Ticec87c1e22009-08-31 21:19:37 +0000700 struct to use (the real one may have been copied onto the heap).
701
702 3). Add the offset for the field VarName, to find the actual variable.
703
704 If we started with a pointer to the struct, then we need to
705 dereference that pointer first, before the other steps.
706 Translating this into DWARF ops, we will need to append the following
707 to the current location description for the variable:
708
709 DW_OP_deref -- optional, if we start with a pointer
710 DW_OP_plus_uconst <forward_fld_offset>
711 DW_OP_deref
712 DW_OP_plus_uconst <varName_fld_offset>
713
714 That is what this function does. */
715
Devang Patel930143b2009-11-21 02:48:08 +0000716/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticec87c1e22009-08-31 21:19:37 +0000717/// provided, and generate the DWARF information necessary to find the
718/// actual Block variable (navigating the Block struct) based on the
719/// starting location. Add the DWARF information to the die. For
720/// more information, read large comment just above here.
721///
Devang Patel930143b2009-11-21 02:48:08 +0000722void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000723 unsigned Attribute,
724 const MachineLocation &Location) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000725 DIType Ty = DV->getType();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000726 DIType TmpTy = Ty;
727 unsigned Tag = Ty.getTag();
728 bool isPointer = false;
729
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000730 StringRef varName = DV->getName();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000731
732 if (Tag == dwarf::DW_TAG_pointer_type) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000733 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000734 TmpTy = DTy.getTypeDerivedFrom();
735 isPointer = true;
736 }
737
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000738 DICompositeType blockStruct = DICompositeType(TmpTy);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000739
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000740 // Find the __forwarding field and the variable field in the __Block_byref
741 // struct.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000742 DIArray Fields = blockStruct.getTypeArray();
743 DIDescriptor varField = DIDescriptor();
744 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000745
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000746 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
747 DIDescriptor Element = Fields.getElement(i);
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000748 DIDerivedType DT = DIDerivedType(Element);
Devang Patel2d9caf92009-11-25 17:36:49 +0000749 StringRef fieldName = DT.getName();
750 if (fieldName == "__forwarding")
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000751 forwardingField = Element;
Devang Patel2d9caf92009-11-25 17:36:49 +0000752 else if (fieldName == varName)
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000753 varField = Element;
754 }
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000755
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000756 // Get the offsets for the forwarding field and the variable field.
Chris Lattner71696ef2010-03-31 06:06:37 +0000757 unsigned forwardingFieldOffset =
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000758 DIDerivedType(forwardingField).getOffsetInBits() >> 3;
Chris Lattner71696ef2010-03-31 06:06:37 +0000759 unsigned varFieldOffset =
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000760 DIDerivedType(varField).getOffsetInBits() >> 3;
Caroline Ticec87c1e22009-08-31 21:19:37 +0000761
Mike Stump944fa252009-09-24 23:21:26 +0000762 // Decode the original location, and use that as the start of the byref
763 // variable's location.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000764 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000765 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000766 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000767
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000768 if (Location.isReg()) {
769 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000770 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000771 else {
Devang Patel8698f092011-01-19 23:04:47 +0000772 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
Devang Patel930143b2009-11-21 02:48:08 +0000773 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000774 }
775 } else {
776 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000777 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000778 else {
Devang Patel930143b2009-11-21 02:48:08 +0000779 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
780 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000781 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000782
Devang Patel930143b2009-11-21 02:48:08 +0000783 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000784 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000785
Mike Stump944fa252009-09-24 23:21:26 +0000786 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000787 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000788 if (isPointer)
Devang Patel930143b2009-11-21 02:48:08 +0000789 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000790
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000791 // Next add the offset for the '__forwarding' field:
792 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
793 // adding the offset if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000794 if (forwardingFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000795 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
796 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000797 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000798
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000799 // Now dereference the __forwarding field to get to the real __Block_byref
800 // struct: DW_OP_deref.
Devang Patel930143b2009-11-21 02:48:08 +0000801 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000802
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000803 // Now that we've got the real __Block_byref... struct, add the offset
804 // for the variable's field to get to the location of the actual variable:
805 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000806 if (varFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000807 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
808 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000809 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000810
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000811 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000812 addBlock(Die, Attribute, 0, Block);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000813}
814
Devang Patel930143b2009-11-21 02:48:08 +0000815/// addAddress - Add an address attribute to a die based on the location
Bill Wendling2f921f82009-05-15 09:23:25 +0000816/// provided.
Devang Patel930143b2009-11-21 02:48:08 +0000817void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000818 const MachineLocation &Location) {
Chris Lattner3a383cb2010-04-05 00:13:49 +0000819 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling2f921f82009-05-15 09:23:25 +0000820 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000821 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel804fcd42010-09-22 21:10:38 +0000822
Devang Patele7559662010-11-02 17:37:00 +0000823 if (RI->getFrameRegister(*Asm->MF) == Location.getReg()
Devang Patel804fcd42010-09-22 21:10:38 +0000824 && Location.getOffset()) {
825 // If variable offset is based in frame register then use fbreg.
826 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
827 addSInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
828 addBlock(Die, Attribute, 0, Block);
829 return;
830 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000831
832 if (Location.isReg()) {
833 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000834 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000835 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000836 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
837 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000838 }
839 } else {
840 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000841 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000842 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000843 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
844 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000845 }
846
Devang Patel930143b2009-11-21 02:48:08 +0000847 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling2f921f82009-05-15 09:23:25 +0000848 }
849
Devang Patel930143b2009-11-21 02:48:08 +0000850 addBlock(Die, Attribute, 0, Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000851}
852
Devang Patel173b2b92010-04-28 01:03:09 +0000853/// addRegisterAddress - Add register location entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000854bool DwarfDebug::addRegisterAddress(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000855 assert (MO.isReg() && "Invalid machine operand!");
856 if (!MO.getReg())
857 return false;
858 MachineLocation Location;
859 Location.set(MO.getReg());
860 addAddress(Die, dwarf::DW_AT_location, Location);
Devang Patel173b2b92010-04-28 01:03:09 +0000861 return true;
862}
863
864/// addConstantValue - Add constant value entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000865bool DwarfDebug::addConstantValue(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000866 assert (MO.isImm() && "Invalid machine operand!");
867 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
868 unsigned Imm = MO.getImm();
869 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
870 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patel173b2b92010-04-28 01:03:09 +0000871 return true;
872}
873
874/// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000875bool DwarfDebug::addConstantFPValue(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000876 assert (MO.isFPImm() && "Invalid machine operand!");
877 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
878 APFloat FPImm = MO.getFPImm()->getValueAPF();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000879
Devang Patel173b2b92010-04-28 01:03:09 +0000880 // Get the raw data form of the floating point.
881 const APInt FltVal = FPImm.bitcastToAPInt();
882 const char *FltPtr = (const char*)FltVal.getRawData();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000883
Devang Patel173b2b92010-04-28 01:03:09 +0000884 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
885 bool LittleEndian = Asm->getTargetData().isLittleEndian();
886 int Incr = (LittleEndian ? 1 : -1);
887 int Start = (LittleEndian ? 0 : NumBytes - 1);
888 int Stop = (LittleEndian ? NumBytes : -1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000889
Devang Patel173b2b92010-04-28 01:03:09 +0000890 // Output the constant to DWARF one byte at a time.
891 for (; Start != Stop; Start += Incr)
892 addUInt(Block, 0, dwarf::DW_FORM_data1,
893 (unsigned char)0xFF & FltPtr[Start]);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000894
Devang Patel173b2b92010-04-28 01:03:09 +0000895 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000896 return true;
Devang Patel173b2b92010-04-28 01:03:09 +0000897}
898
Devang Patel70eb9822011-01-06 21:39:25 +0000899/// addConstantValue - Add constant value entry in variable DIE.
900bool DwarfDebug::addConstantValue(DIE *Die, ConstantInt *CI,
901 bool Unsigned) {
902 if (CI->getBitWidth() <= 64) {
903 if (Unsigned)
904 addUInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
905 CI->getZExtValue());
906 else
907 addSInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
908 CI->getSExtValue());
909 return true;
910 }
911
912 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
913
914 // Get the raw data form of the large APInt.
915 const APInt Val = CI->getValue();
916 const char *Ptr = (const char*)Val.getRawData();
917
918 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
919 bool LittleEndian = Asm->getTargetData().isLittleEndian();
920 int Incr = (LittleEndian ? 1 : -1);
921 int Start = (LittleEndian ? 0 : NumBytes - 1);
922 int Stop = (LittleEndian ? NumBytes : -1);
923
924 // Output the constant to DWARF one byte at a time.
925 for (; Start != Stop; Start += Incr)
926 addUInt(Block, 0, dwarf::DW_FORM_data1,
927 (unsigned char)0xFF & Ptr[Start]);
928
929 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
930 return true;
931}
Devang Patel173b2b92010-04-28 01:03:09 +0000932
Devang Patel2b75ed22009-12-10 19:14:49 +0000933/// addToContextOwner - Add Die into the list of its context owner's children.
934void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000935 if (Context.isType()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000936 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
Devang Patel2b75ed22009-12-10 19:14:49 +0000937 ContextDIE->addChild(Die);
Devang Patel1f4690c2009-12-15 19:16:48 +0000938 } else if (Context.isNameSpace()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000939 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
Devang Patel1f4690c2009-12-15 19:16:48 +0000940 ContextDIE->addChild(Die);
Stuart Hastingsafe54f12010-06-11 20:08:44 +0000941 } else if (Context.isSubprogram()) {
Devang Patel185051c2010-09-27 23:15:27 +0000942 DIE *ContextDIE = createSubprogramDIE(DISubprogram(Context));
Stuart Hastingsafe54f12010-06-11 20:08:44 +0000943 ContextDIE->addChild(Die);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000944 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patel2b75ed22009-12-10 19:14:49 +0000945 ContextDIE->addChild(Die);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000946 else
Devang Patel1a0df9a2010-05-10 22:49:55 +0000947 getCompileUnit(Context)->addDie(Die);
Devang Patel2b75ed22009-12-10 19:14:49 +0000948}
949
Devang Patelb5b60ea2009-12-10 18:05:33 +0000950/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
951/// given DIType.
952DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000953 CompileUnit *TypeCU = getCompileUnit(Ty);
954 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000955 if (TyDIE)
956 return TyDIE;
957
958 // Create new type.
959 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000960 TypeCU->insertDIE(Ty, TyDIE);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000961 if (Ty.isBasicType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000962 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000963 else if (Ty.isCompositeType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000964 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000965 else {
966 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000967 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000968 }
969
Devang Patel2b75ed22009-12-10 19:14:49 +0000970 addToContextOwner(TyDIE, Ty.getContext());
Devang Patelb5b60ea2009-12-10 18:05:33 +0000971 return TyDIE;
972}
973
Devang Patel930143b2009-11-21 02:48:08 +0000974/// addType - Add a new type attribute to the specified entity.
Devang Patel9ccfb642009-12-09 18:24:21 +0000975void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel8d6a2b72010-05-07 21:45:47 +0000976 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000977 return;
978
979 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000980 CompileUnit *TypeCU = getCompileUnit(Ty);
981 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000982 // If it exists then use the existing value.
Devang Patel930143b2009-11-21 02:48:08 +0000983 if (Entry) {
984 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000985 return;
986 }
987
Bill Wendling2f921f82009-05-15 09:23:25 +0000988 // Construct type.
Devang Patelb5b60ea2009-12-10 18:05:33 +0000989 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000990
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000991 // Set up proxy.
992 Entry = createDIEEntry(Buffer);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000993 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000994
Devang Patel930143b2009-11-21 02:48:08 +0000995 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000996}
997
Devang Patel930143b2009-11-21 02:48:08 +0000998/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000999void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001000 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +00001001 StringRef Name = BTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001002 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +00001003 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling2f921f82009-05-15 09:23:25 +00001004 BTy.getEncoding());
1005
1006 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +00001007 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001008 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001009 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel930143b2009-11-21 02:48:08 +00001010 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001011}
1012
Devang Patel930143b2009-11-21 02:48:08 +00001013/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001014void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001015 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +00001016 StringRef Name = DTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001017 uint64_t Size = DTy.getSizeInBits() >> 3;
1018 unsigned Tag = DTy.getTag();
1019
1020 // FIXME - Workaround for templates.
1021 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
1022
1023 Buffer.setTag(Tag);
1024
1025 // Map to main type, void will not have a type.
1026 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel9ccfb642009-12-09 18:24:21 +00001027 addType(&Buffer, FromTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001028
1029 // Add name if not anonymous or intermediate type.
Devang Patelae466ef2009-11-30 23:56:56 +00001030 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001031 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001032
1033 // Add size if non-zero (derived types might be zero-sized.)
1034 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +00001035 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001036
1037 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patelb5b51592009-11-23 18:43:37 +00001038 if (!DTy.isForwardDecl())
Devang Patelb6511a32010-08-09 20:20:05 +00001039 addSourceLine(&Buffer, DTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001040}
1041
Devang Patel930143b2009-11-21 02:48:08 +00001042/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001043void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001044 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +00001045 StringRef Name = CTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001046
1047 uint64_t Size = CTy.getSizeInBits() >> 3;
1048 unsigned Tag = CTy.getTag();
1049 Buffer.setTag(Tag);
1050
1051 switch (Tag) {
1052 case dwarf::DW_TAG_vector_type:
1053 case dwarf::DW_TAG_array_type:
Devang Patel9ccfb642009-12-09 18:24:21 +00001054 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001055 break;
1056 case dwarf::DW_TAG_enumeration_type: {
1057 DIArray Elements = CTy.getTypeArray();
1058
1059 // Add enumerators to enumeration type.
1060 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1061 DIE *ElemDie = NULL;
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001062 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3b548aa2010-03-08 20:52:55 +00001063 if (Enum.isEnumerator()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001064 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel930143b2009-11-21 02:48:08 +00001065 Buffer.addChild(ElemDie);
Devang Patelfafa1fe2009-10-09 17:51:49 +00001066 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001067 }
1068 }
1069 break;
1070 case dwarf::DW_TAG_subroutine_type: {
1071 // Add return type.
1072 DIArray Elements = CTy.getTypeArray();
1073 DIDescriptor RTy = Elements.getElement(0);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001074 addType(&Buffer, DIType(RTy));
Bill Wendling2f921f82009-05-15 09:23:25 +00001075
Devang Patel9a33ec22010-10-06 20:50:40 +00001076 bool isPrototyped = true;
Bill Wendling2f921f82009-05-15 09:23:25 +00001077 // Add arguments.
1078 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001079 DIDescriptor Ty = Elements.getElement(i);
Devang Patel9a33ec22010-10-06 20:50:40 +00001080 if (Ty.isUnspecifiedParameter()) {
1081 DIE *Arg = new DIE(dwarf::DW_TAG_unspecified_parameters);
1082 Buffer.addChild(Arg);
1083 isPrototyped = false;
1084 } else {
1085 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1086 addType(Arg, DIType(Ty));
1087 Buffer.addChild(Arg);
1088 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001089 }
Devang Patel9a33ec22010-10-06 20:50:40 +00001090 // Add prototype flag.
1091 if (isPrototyped)
1092 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001093 }
1094 break;
1095 case dwarf::DW_TAG_structure_type:
1096 case dwarf::DW_TAG_union_type:
1097 case dwarf::DW_TAG_class_type: {
1098 // Add elements to structure type.
1099 DIArray Elements = CTy.getTypeArray();
1100
1101 // A forward struct declared type may not have elements available.
Devang Patel3b548aa2010-03-08 20:52:55 +00001102 unsigned N = Elements.getNumElements();
1103 if (N == 0)
Bill Wendling2f921f82009-05-15 09:23:25 +00001104 break;
1105
1106 // Add elements to structure type.
Devang Patel3b548aa2010-03-08 20:52:55 +00001107 for (unsigned i = 0; i < N; ++i) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001108 DIDescriptor Element = Elements.getElement(i);
1109 DIE *ElemDie = NULL;
Devang Patelcb03b142010-09-29 21:44:16 +00001110 if (Element.isSubprogram()) {
1111 DISubprogram SP(Element);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001112 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patelcb03b142010-09-29 21:44:16 +00001113 if (SP.isProtected())
1114 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1115 dwarf::DW_ACCESS_protected);
1116 else if (SP.isPrivate())
1117 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1118 dwarf::DW_ACCESS_private);
1119 else
1120 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1121 dwarf::DW_ACCESS_public);
Devang Patele1c71462010-10-01 23:31:40 +00001122 if (SP.isExplicit())
1123 addUInt(ElemDie, dwarf::DW_AT_explicit, dwarf::DW_FORM_flag, 1);
Devang Patelcb03b142010-09-29 21:44:16 +00001124 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001125 else if (Element.isVariable()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001126 DIVariable DV(Element);
Devang Patel160c92d2010-01-30 01:08:30 +00001127 ElemDie = new DIE(dwarf::DW_TAG_variable);
1128 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1129 DV.getName());
1130 addType(ElemDie, DV.getType());
1131 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1132 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patelb6511a32010-08-09 20:20:05 +00001133 addSourceLine(ElemDie, DV);
Devang Patel3b548aa2010-03-08 20:52:55 +00001134 } else if (Element.isDerivedType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001135 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3b548aa2010-03-08 20:52:55 +00001136 else
1137 continue;
Devang Patel930143b2009-11-21 02:48:08 +00001138 Buffer.addChild(ElemDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001139 }
1140
Devang Patel3082c012009-08-27 23:51:51 +00001141 if (CTy.isAppleBlockExtension())
Devang Patel930143b2009-11-21 02:48:08 +00001142 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001143
1144 unsigned RLang = CTy.getRunTimeLang();
1145 if (RLang)
Devang Patel930143b2009-11-21 02:48:08 +00001146 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling2f921f82009-05-15 09:23:25 +00001147 dwarf::DW_FORM_data1, RLang);
Devang Patel303a1be2010-01-26 21:16:06 +00001148
1149 DICompositeType ContainingType = CTy.getContainingType();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001150 if (DIDescriptor(ContainingType).isCompositeType())
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001151 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001152 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001153 else {
1154 DIDescriptor Context = CTy.getContext();
1155 addToContextOwner(&Buffer, Context);
1156 }
Devang Patel3a9e65e2011-02-02 21:38:25 +00001157
1158 if (Tag == dwarf::DW_TAG_class_type) {
1159 DIArray TParams = CTy.getTemplateParams();
1160 unsigned N = TParams.getNumElements();
1161 // Add template parameters.
1162 for (unsigned i = 0; i < N; ++i) {
1163 DIDescriptor Element = TParams.getElement(i);
1164 if (Element.isTemplateTypeParameter())
1165 Buffer.addChild(getOrCreateTemplateTypeParameterDIE(
1166 DITemplateTypeParameter(Element)));
Devang Patelbe933b42011-02-02 22:35:53 +00001167 else if (Element.isTemplateValueParameter())
1168 Buffer.addChild(getOrCreateTemplateValueParameterDIE(
1169 DITemplateValueParameter(Element)));
Devang Patel3a9e65e2011-02-02 21:38:25 +00001170 }
1171 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001172 break;
1173 }
1174 default:
1175 break;
1176 }
1177
1178 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +00001179 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001180 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001181
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001182 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
Devang Patel30265c42010-07-07 20:12:52 +00001183 || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1184 {
Bill Wendling2f921f82009-05-15 09:23:25 +00001185 // Add size if non-zero (derived types might be zero-sized.)
1186 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +00001187 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001188 else {
1189 // Add zero size if it is not a forward declaration.
1190 if (CTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +00001191 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001192 else
Devang Patel930143b2009-11-21 02:48:08 +00001193 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling2f921f82009-05-15 09:23:25 +00001194 }
1195
1196 // Add source line info if available.
1197 if (!CTy.isForwardDecl())
Devang Patelb6511a32010-08-09 20:20:05 +00001198 addSourceLine(&Buffer, CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001199 }
1200}
1201
Devang Patel3a9e65e2011-02-02 21:38:25 +00001202/// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
1203/// for the given DITemplateTypeParameter.
1204DIE *
1205DwarfDebug::getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP) {
1206 CompileUnit *TypeCU = getCompileUnit(TP);
1207 DIE *ParamDIE = TypeCU->getDIE(TP);
1208 if (ParamDIE)
1209 return ParamDIE;
1210
1211 ParamDIE = new DIE(dwarf::DW_TAG_template_type_parameter);
1212 addType(ParamDIE, TP.getType());
1213 addString(ParamDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string, TP.getName());
1214 return ParamDIE;
1215}
1216
Devang Patelbe933b42011-02-02 22:35:53 +00001217/// getOrCreateTemplateValueParameterDIE - Find existing DIE or create new DIE
1218/// for the given DITemplateValueParameter.
1219DIE *
1220DwarfDebug::getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TPV) {
1221 CompileUnit *TVCU = getCompileUnit(TPV);
1222 DIE *ParamDIE = TVCU->getDIE(TPV);
1223 if (ParamDIE)
1224 return ParamDIE;
1225
1226 ParamDIE = new DIE(dwarf::DW_TAG_template_value_parameter);
1227 addType(ParamDIE, TPV.getType());
Devang Patel651d06e2011-04-05 20:14:13 +00001228 if (!TPV.getName().empty())
1229 addString(ParamDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string, TPV.getName());
Devang Patelbe933b42011-02-02 22:35:53 +00001230 addUInt(ParamDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
1231 TPV.getValue());
1232 return ParamDIE;
1233}
1234
Devang Patel930143b2009-11-21 02:48:08 +00001235/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1236void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling2f921f82009-05-15 09:23:25 +00001237 int64_t L = SR.getLo();
1238 int64_t H = SR.getHi();
1239 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1240
Devang Patel930143b2009-11-21 02:48:08 +00001241 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patelf691df32009-08-14 20:59:16 +00001242 if (L)
Devang Patel930143b2009-11-21 02:48:08 +00001243 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Patel8f046022009-12-04 23:10:24 +00001244 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling2f921f82009-05-15 09:23:25 +00001245
Devang Patel930143b2009-11-21 02:48:08 +00001246 Buffer.addChild(DW_Subrange);
Bill Wendling2f921f82009-05-15 09:23:25 +00001247}
1248
Devang Patel930143b2009-11-21 02:48:08 +00001249/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001250void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling2f921f82009-05-15 09:23:25 +00001251 DICompositeType *CTy) {
1252 Buffer.setTag(dwarf::DW_TAG_array_type);
1253 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel930143b2009-11-21 02:48:08 +00001254 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001255
1256 // Emit derived type.
Devang Patel9ccfb642009-12-09 18:24:21 +00001257 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001258 DIArray Elements = CTy->getTypeArray();
1259
Devang Patel92e8c652009-11-21 00:31:03 +00001260 // Get an anonymous type for index type.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001261 CompileUnit *TheCU = getCompileUnit(*CTy);
1262 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel92e8c652009-11-21 00:31:03 +00001263 if (!IdxTy) {
1264 // Construct an anonymous type for index type.
1265 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +00001266 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1267 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel92e8c652009-11-21 00:31:03 +00001268 dwarf::DW_ATE_signed);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001269 TheCU->addDie(IdxTy);
1270 TheCU->setIndexTyDie(IdxTy);
Devang Patel92e8c652009-11-21 00:31:03 +00001271 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001272
1273 // Add subranges to array type.
1274 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1275 DIDescriptor Element = Elements.getElement(i);
1276 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001277 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001278 }
1279}
1280
Devang Patel930143b2009-11-21 02:48:08 +00001281/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3b548aa2010-03-08 20:52:55 +00001282DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001283 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3b548aa2010-03-08 20:52:55 +00001284 StringRef Name = ETy.getName();
Devang Patel930143b2009-11-21 02:48:08 +00001285 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3b548aa2010-03-08 20:52:55 +00001286 int64_t Value = ETy.getEnumValue();
Devang Patel930143b2009-11-21 02:48:08 +00001287 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +00001288 return Enumerator;
1289}
1290
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001291/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel43ef34d2010-01-05 01:46:14 +00001292/// printer to not emit usual symbol prefix before the symbol name is used then
1293/// return linkage name after skipping this special LLVM prefix.
1294static StringRef getRealLinkageName(StringRef LinkageName) {
1295 char One = '\1';
1296 if (LinkageName.startswith(StringRef(&One, 1)))
1297 return LinkageName.substr(1);
1298 return LinkageName;
1299}
1300
Devang Patel930143b2009-11-21 02:48:08 +00001301/// createMemberDIE - Create new member DIE.
Devang Patel18ba0b42010-08-10 04:12:17 +00001302DIE *DwarfDebug::createMemberDIE(DIDerivedType DT) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001303 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel2d9caf92009-11-25 17:36:49 +00001304 StringRef Name = DT.getName();
1305 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001306 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001307
Devang Patel9ccfb642009-12-09 18:24:21 +00001308 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001309
Devang Patelb6511a32010-08-09 20:20:05 +00001310 addSourceLine(MemberDie, DT);
Bill Wendling2f921f82009-05-15 09:23:25 +00001311
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001312 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel930143b2009-11-21 02:48:08 +00001313 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel67f56f02009-11-04 22:06:12 +00001314
Bill Wendling2f921f82009-05-15 09:23:25 +00001315 uint64_t Size = DT.getSizeInBits();
Devang Patelf05d5722009-11-04 23:48:00 +00001316 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling2f921f82009-05-15 09:23:25 +00001317
1318 if (Size != FieldSize) {
1319 // Handle bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001320 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1321 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling2f921f82009-05-15 09:23:25 +00001322
1323 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling2f921f82009-05-15 09:23:25 +00001324 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1325 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer2b459982010-01-07 17:50:57 +00001326 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling2f921f82009-05-15 09:23:25 +00001327 Offset -= FieldOffset;
1328
1329 // Maybe we need to work from the other end.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001330 if (Asm->getTargetData().isLittleEndian())
1331 Offset = FieldSize - (Offset + Size);
Devang Patel930143b2009-11-21 02:48:08 +00001332 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling2f921f82009-05-15 09:23:25 +00001333
Devang Patel67f56f02009-11-04 22:06:12 +00001334 // Here WD_AT_data_member_location points to the anonymous
1335 // field that includes this bit field.
Devang Patel930143b2009-11-21 02:48:08 +00001336 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001337
1338 } else
1339 // This is not a bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001340 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001341
Devang Pateld2316892010-02-03 20:08:48 +00001342 if (DT.getTag() == dwarf::DW_TAG_inheritance
1343 && DT.isVirtual()) {
1344
1345 // For C++, virtual base classes are not at fixed offset. Use following
1346 // expression to extract appropriate offset from vtable.
1347 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1348
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001349 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Pateld2316892010-02-03 20:08:48 +00001350 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1351 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1352 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1353 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1354 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1355 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1356 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1357
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001358 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
Devang Pateld2316892010-02-03 20:08:48 +00001359 VBaseLocationDie);
1360 } else
1361 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001362
1363 if (DT.isProtected())
Devang Pateleb57c592009-12-03 19:11:07 +00001364 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001365 dwarf::DW_ACCESS_protected);
1366 else if (DT.isPrivate())
Devang Pateleb57c592009-12-03 19:11:07 +00001367 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001368 dwarf::DW_ACCESS_private);
Devang Patela1bd5a12010-09-29 19:08:08 +00001369 // Otherwise C++ member and base classes are considered public.
1370 else if (DT.getCompileUnit().getLanguage() == dwarf::DW_LANG_C_plus_plus)
Devang Pateleb57c592009-12-03 19:11:07 +00001371 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1372 dwarf::DW_ACCESS_public);
1373 if (DT.isVirtual())
1374 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1375 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling2f921f82009-05-15 09:23:25 +00001376 return MemberDie;
1377}
1378
Devang Patel525dda02009-12-14 16:18:45 +00001379/// createSubprogramDIE - Create new DIE using SP.
Devang Patel185051c2010-09-27 23:15:27 +00001380DIE *DwarfDebug::createSubprogramDIE(DISubprogram SP) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001381 CompileUnit *SPCU = getCompileUnit(SP);
1382 DIE *SPDie = SPCU->getDIE(SP);
Devang Patel525dda02009-12-14 16:18:45 +00001383 if (SPDie)
1384 return SPDie;
1385
1386 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf200b392010-03-02 17:58:15 +00001387 // Constructors and operators for anonymous aggregates do not have names.
Devang Pateld0fa3042010-03-02 01:26:20 +00001388 if (!SP.getName().empty())
1389 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling2f921f82009-05-15 09:23:25 +00001390
Devang Patel2d9caf92009-11-25 17:36:49 +00001391 StringRef LinkageName = SP.getLinkageName();
Devang Patel43ef34d2010-01-05 01:46:14 +00001392 if (!LinkageName.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001393 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel43ef34d2010-01-05 01:46:14 +00001394 getRealLinkageName(LinkageName));
1395
Devang Patelb6511a32010-08-09 20:20:05 +00001396 addSourceLine(SPDie, SP);
Bill Wendling2f921f82009-05-15 09:23:25 +00001397
Devang Patel3a24f922010-10-07 22:03:01 +00001398 if (SP.isPrototyped())
Devang Patel930143b2009-11-21 02:48:08 +00001399 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001400
1401 // Add Return Type.
Devang Patel236526d2009-12-03 01:25:38 +00001402 DICompositeType SPTy = SP.getType();
1403 DIArray Args = SPTy.getTypeArray();
Bill Wendling2f921f82009-05-15 09:23:25 +00001404 unsigned SPTag = SPTy.getTag();
Devang Pateleb57c592009-12-03 19:11:07 +00001405
Devang Patel3b548aa2010-03-08 20:52:55 +00001406 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel9ccfb642009-12-09 18:24:21 +00001407 addType(SPDie, SPTy);
Devang Patel236526d2009-12-03 01:25:38 +00001408 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001409 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel236526d2009-12-03 01:25:38 +00001410
Devang Pateleb57c592009-12-03 19:11:07 +00001411 unsigned VK = SP.getVirtuality();
1412 if (VK) {
1413 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001414 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Pateleb57c592009-12-03 19:11:07 +00001415 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
Devang Patelc26da902010-12-09 00:10:40 +00001416 addUInt(Block, 0, dwarf::DW_FORM_udata, SP.getVirtualIndex());
Devang Pateleb57c592009-12-03 19:11:07 +00001417 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001418 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001419 SP.getContainingType()));
Devang Pateleb57c592009-12-03 19:11:07 +00001420 }
1421
Devang Patel185051c2010-09-27 23:15:27 +00001422 if (!SP.isDefinition()) {
Devang Patel930143b2009-11-21 02:48:08 +00001423 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001424
1425 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel236526d2009-12-03 01:25:38 +00001426 // be handled while processing variables.
1427 DICompositeType SPTy = SP.getType();
1428 DIArray Args = SPTy.getTypeArray();
1429 unsigned SPTag = SPTy.getTag();
1430
Bill Wendling2f921f82009-05-15 09:23:25 +00001431 if (SPTag == dwarf::DW_TAG_subroutine_type)
1432 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1433 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001434 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patel6efc8e52010-02-06 01:02:37 +00001435 addType(Arg, ATy);
1436 if (ATy.isArtificial())
1437 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel930143b2009-11-21 02:48:08 +00001438 SPDie->addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +00001439 }
1440 }
1441
Devang Patel999b4992010-02-03 19:57:19 +00001442 if (SP.isArtificial())
1443 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1444
Devang Patelb4e3b902010-04-30 19:38:23 +00001445 if (!SP.isLocalToUnit())
1446 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001447
Devang Patelb4e3b902010-04-30 19:38:23 +00001448 if (SP.isOptimized())
1449 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1450
Jim Grosbach965a73a2010-07-21 23:03:52 +00001451 if (unsigned isa = Asm->getISAEncoding()) {
1452 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1453 }
1454
Devang Patelb4e3b902010-04-30 19:38:23 +00001455 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001456 SPCU->insertDIE(SP, SPDie);
Devang Patelb4e3b902010-04-30 19:38:23 +00001457
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001458 // Add to context owner.
1459 addToContextOwner(SPDie, SP.getContext());
1460
Bill Wendling2f921f82009-05-15 09:23:25 +00001461 return SPDie;
1462}
1463
Devang Patel32cc43c2010-05-07 20:54:48 +00001464DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattner8d2fe282010-03-31 05:36:29 +00001465 assert(N && "Invalid Scope encoding!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001466
1467 DbgScope *AScope = AbstractScopes.lookup(N);
1468 if (AScope)
1469 return AScope;
Jim Grosbach042483e2009-11-21 23:12:12 +00001470
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001471 DbgScope *Parent = NULL;
1472
1473 DIDescriptor Scope(N);
1474 if (Scope.isLexicalBlock()) {
1475 DILexicalBlock DB(N);
1476 DIDescriptor ParentDesc = DB.getContext();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001477 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001478 }
1479
1480 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1481
1482 if (Parent)
Devang Patel930143b2009-11-21 02:48:08 +00001483 Parent->addScope(AScope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001484 AScope->setAbstractScope();
1485 AbstractScopes[N] = AScope;
1486 if (DIDescriptor(N).isSubprogram())
1487 AbstractScopesList.push_back(AScope);
1488 return AScope;
1489}
Devang Patel75cc16c2009-10-01 20:31:14 +00001490
Devang Patel019922d2010-04-06 23:53:48 +00001491/// isSubprogramContext - Return true if Context is either a subprogram
1492/// or another context nested inside a subprogram.
Devang Patel32cc43c2010-05-07 20:54:48 +00001493static bool isSubprogramContext(const MDNode *Context) {
Devang Patel019922d2010-04-06 23:53:48 +00001494 if (!Context)
1495 return false;
1496 DIDescriptor D(Context);
1497 if (D.isSubprogram())
1498 return true;
1499 if (D.isType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001500 return isSubprogramContext(DIType(Context).getContext());
Devang Patel019922d2010-04-06 23:53:48 +00001501 return false;
1502}
1503
Jim Grosbach042483e2009-11-21 23:12:12 +00001504/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel930143b2009-11-21 02:48:08 +00001505/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1506/// If there are global variables in this scope then create and insert
1507/// DIEs for these variables.
Devang Patel32cc43c2010-05-07 20:54:48 +00001508DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001509 CompileUnit *SPCU = getCompileUnit(SPNode);
1510 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +00001511
Chris Lattner3a383cb2010-04-05 00:13:49 +00001512 assert(SPDie && "Unable to find subprogram DIE!");
1513 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001514
Chris Lattner3a383cb2010-04-05 00:13:49 +00001515 // There is not any need to generate specification DIE for a function
1516 // defined at compile unit level. If a function is defined inside another
1517 // function then gdb prefers the definition at top level and but does not
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001518 // expect specification DIE in parent function. So avoid creating
Chris Lattner3a383cb2010-04-05 00:13:49 +00001519 // specification DIE for a function defined inside a function.
1520 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001521 !SP.getContext().isFile() &&
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001522 !isSubprogramContext(SP.getContext())) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00001523 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001524
1525 // Add arguments.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001526 DICompositeType SPTy = SP.getType();
1527 DIArray Args = SPTy.getTypeArray();
1528 unsigned SPTag = SPTy.getTag();
1529 if (SPTag == dwarf::DW_TAG_subroutine_type)
1530 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1531 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001532 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattner3a383cb2010-04-05 00:13:49 +00001533 addType(Arg, ATy);
1534 if (ATy.isArtificial())
1535 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1536 SPDie->addChild(Arg);
1537 }
1538 DIE *SPDeclDie = SPDie;
1539 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001540 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Chris Lattner3a383cb2010-04-05 00:13:49 +00001541 SPDeclDie);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001542 SPCU->addDie(SPDie);
Chris Lattner3a383cb2010-04-05 00:13:49 +00001543 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001544
Devang Patela37a95e2010-07-07 22:20:57 +00001545 // Pick up abstract subprogram DIE.
1546 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
1547 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1548 addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
1549 dwarf::DW_FORM_ref4, AbsSPDIE);
1550 SPCU->addDie(SPDie);
1551 }
1552
Chris Lattner3a383cb2010-04-05 00:13:49 +00001553 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1554 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1555 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1556 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1557 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1558 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1559 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +00001560
Chris Lattner3a383cb2010-04-05 00:13:49 +00001561 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001562}
1563
Jim Grosbach042483e2009-11-21 23:12:12 +00001564/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel930143b2009-11-21 02:48:08 +00001565/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1566DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001567
1568 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1569 if (Scope->isAbstractScope())
1570 return ScopeDIE;
1571
1572 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1573 if (Ranges.empty())
1574 return 0;
1575
1576 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1577 if (Ranges.size() > 1) {
1578 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001579 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +00001580 // DW_AT_ranges appropriately.
1581 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1582 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1583 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1584 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +00001585 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1586 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +00001587 }
1588 DebugRangeSymbols.push_back(NULL);
1589 DebugRangeSymbols.push_back(NULL);
1590 return ScopeDIE;
1591 }
1592
Devang Patel9fc11702010-05-25 23:40:22 +00001593 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1594 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001595
Devang Patel9fc11702010-05-25 23:40:22 +00001596 if (End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001597
Chris Lattnere13c3722010-03-09 01:58:53 +00001598 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1599 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001600
Devang Patel6c74a872010-04-27 19:46:33 +00001601 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1602 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001603
1604 return ScopeDIE;
1605}
1606
Devang Patel930143b2009-11-21 02:48:08 +00001607/// constructInlinedScopeDIE - This scope represents inlined body of
1608/// a function. Construct DIE to represent this concrete inlined copy
1609/// of the function.
1610DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001611
1612 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001613 assert (Ranges.empty() == false
Devang Patel6c74a872010-04-27 19:46:33 +00001614 && "DbgScope does not have instruction markers!");
1615
1616 // FIXME : .debug_inlined section specification does not clearly state how
1617 // to emit inlined scope that is split into multiple instruction ranges.
1618 // For now, use first instruction range and emit low_pc/high_pc pair and
1619 // corresponding .debug_inlined section entry for this pair.
1620 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel9fc11702010-05-25 23:40:22 +00001621 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1622 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001623
Devang Patel4c6bd662010-07-08 22:39:20 +00001624 if (StartLabel == 0 || EndLabel == 0) {
Devang Patel6c74a872010-04-27 19:46:33 +00001625 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1626 return 0;
1627 }
Chris Lattnere13c3722010-03-09 01:58:53 +00001628 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001629 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +00001630 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001631 "Invalid end label for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +00001632
Devang Patel3b548aa2010-03-08 20:52:55 +00001633 if (!Scope->getScopeNode())
Devang Patelbc97f6b2010-03-08 19:20:38 +00001634 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001635 DIScope DS(Scope->getScopeNode());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001636 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1637
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001638 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001639 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1640 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001641 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel930143b2009-11-21 02:48:08 +00001642 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001643 dwarf::DW_FORM_ref4, OriginDIE);
1644
Chris Lattner085b6522010-03-09 00:31:02 +00001645 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnere13c3722010-03-09 01:58:53 +00001646 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001647
1648 InlinedSubprogramDIEs.insert(OriginDIE);
1649
1650 // Track the start label for this inlined function.
Devang Patel32cc43c2010-05-07 20:54:48 +00001651 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001652 I = InlineInfo.find(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001653
1654 if (I == InlineInfo.end()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001655 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach00e9c612009-11-22 19:20:36 +00001656 ScopeDIE));
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001657 InlinedSPNodes.push_back(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001658 } else
Chris Lattner085b6522010-03-09 00:31:02 +00001659 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001660
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001661 DILocation DL(Scope->getInlinedAt());
Devang Patel1a0df9a2010-05-10 22:49:55 +00001662 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel930143b2009-11-21 02:48:08 +00001663 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001664
1665 return ScopeDIE;
1666}
1667
Devang Patel930143b2009-11-21 02:48:08 +00001668
1669/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel9ccfb642009-12-09 18:24:21 +00001670DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001671 StringRef Name = DV->getName();
Devang Patel2d9caf92009-11-25 17:36:49 +00001672 if (Name.empty())
Devang Patel97f99fa2009-11-13 02:25:26 +00001673 return NULL;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001674
1675 // Translate tag to proper Dwarf tag. The result variable is dropped for
1676 // now.
1677 unsigned Tag;
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001678 switch (DV->getTag()) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001679 case dwarf::DW_TAG_return_variable:
1680 return NULL;
1681 case dwarf::DW_TAG_arg_variable:
1682 Tag = dwarf::DW_TAG_formal_parameter;
1683 break;
1684 case dwarf::DW_TAG_auto_variable: // fall thru
1685 default:
1686 Tag = dwarf::DW_TAG_variable;
1687 break;
1688 }
1689
1690 // Define variable debug information entry.
1691 DIE *VariableDie = new DIE(Tag);
1692
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001693 DIE *AbsDIE = NULL;
Devang Patele1c53f22010-05-20 16:36:41 +00001694 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1695 V2AVI = VarToAbstractVarMap.find(DV);
1696 if (V2AVI != VarToAbstractVarMap.end())
1697 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach042483e2009-11-21 23:12:12 +00001698
Devang Patele1c53f22010-05-20 16:36:41 +00001699 if (AbsDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001700 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001701 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001702 else {
Devang Patel930143b2009-11-21 02:48:08 +00001703 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001704 addSourceLine(VariableDie, DV->getVariable());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001705
1706 // Add variable type.
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001707 addType(VariableDie, DV->getType());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001708 }
1709
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001710 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patel6efc8e52010-02-06 01:02:37 +00001711 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelbea08d12010-09-29 23:07:21 +00001712 else if (DIVariable(DV->getVariable()).isArtificial())
1713 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel9fc11702010-05-25 23:40:22 +00001714
1715 if (Scope->isAbstractScope()) {
1716 DV->setDIE(VariableDie);
1717 return VariableDie;
1718 }
1719
1720 // Add variable address.
1721
1722 unsigned Offset = DV->getDotDebugLocOffset();
1723 if (Offset != ~0U) {
1724 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1725 Asm->GetTempSymbol("debug_loc", Offset));
1726 DV->setDIE(VariableDie);
1727 UseDotDebugLocEntry.insert(VariableDie);
1728 return VariableDie;
1729 }
1730
1731 // Check if variable is described by a DBG_VALUE instruction.
1732 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1733 DbgVariableToDbgInstMap.find(DV);
1734 if (DVI != DbgVariableToDbgInstMap.end()) {
1735 const MachineInstr *DVInsn = DVI->second;
Devang Patel9fc11702010-05-25 23:40:22 +00001736 bool updated = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001737 // FIXME : Handle getNumOperands != 3
Devang Patel9fc11702010-05-25 23:40:22 +00001738 if (DVInsn->getNumOperands() == 3) {
Devang Patel86ec8b32010-08-31 22:22:42 +00001739 if (DVInsn->getOperand(0).isReg()) {
1740 const MachineOperand RegOp = DVInsn->getOperand(0);
1741 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1742 if (DVInsn->getOperand(1).isImm() &&
1743 TRI->getFrameRegister(*Asm->MF) == RegOp.getReg()) {
1744 addVariableAddress(DV, VariableDie, DVInsn->getOperand(1).getImm());
1745 updated = true;
1746 } else
Devang Patel53a40df62010-11-12 23:20:42 +00001747 updated = addRegisterAddress(VariableDie, RegOp);
Devang Patel86ec8b32010-08-31 22:22:42 +00001748 }
Devang Patel9fc11702010-05-25 23:40:22 +00001749 else if (DVInsn->getOperand(0).isImm())
Devang Patel53a40df62010-11-12 23:20:42 +00001750 updated = addConstantValue(VariableDie, DVInsn->getOperand(0));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001751 else if (DVInsn->getOperand(0).isFPImm())
1752 updated =
Devang Patel53a40df62010-11-12 23:20:42 +00001753 addConstantFPValue(VariableDie, DVInsn->getOperand(0));
Devang Patel9fc11702010-05-25 23:40:22 +00001754 } else {
1755 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1756 if (Location.getReg()) {
1757 addAddress(VariableDie, dwarf::DW_AT_location, Location);
Devang Patel9fc11702010-05-25 23:40:22 +00001758 updated = true;
1759 }
1760 }
1761 if (!updated) {
1762 // If variableDie is not updated then DBG_VALUE instruction does not
1763 // have valid variable info.
1764 delete VariableDie;
1765 return NULL;
1766 }
1767 DV->setDIE(VariableDie);
1768 return VariableDie;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001769 }
Devang Patel9fc11702010-05-25 23:40:22 +00001770
1771 // .. else use frame index, if available.
Devang Patel9fc11702010-05-25 23:40:22 +00001772 int FI = 0;
Devang Patel2cfc3af2010-08-31 06:11:28 +00001773 if (findVariableFrameIndex(DV, &FI))
1774 addVariableAddress(DV, VariableDie, FI);
1775
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001776 DV->setDIE(VariableDie);
1777 return VariableDie;
1778
1779}
Devang Patel930143b2009-11-21 02:48:08 +00001780
Devang Patel04d2f2d2009-11-24 01:14:22 +00001781void DwarfDebug::addPubTypes(DISubprogram SP) {
1782 DICompositeType SPTy = SP.getType();
1783 unsigned SPTag = SPTy.getTag();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001784 if (SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel04d2f2d2009-11-24 01:14:22 +00001785 return;
1786
1787 DIArray Args = SPTy.getTypeArray();
Devang Patel04d2f2d2009-11-24 01:14:22 +00001788 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001789 DIType ATy(Args.getElement(i));
Devang Patel8d6a2b72010-05-07 21:45:47 +00001790 if (!ATy.Verify())
Devang Patel04d2f2d2009-11-24 01:14:22 +00001791 continue;
1792 DICompositeType CATy = getDICompositeType(ATy);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001793 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel12d150e2010-04-13 20:35:04 +00001794 && !CATy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001795 CompileUnit *TheCU = getCompileUnit(CATy);
1796 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1797 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00001798 }
1799 }
1800}
1801
Devang Patel930143b2009-11-21 02:48:08 +00001802/// constructScopeDIE - Construct a DIE for this scope.
1803DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +00001804 if (!Scope || !Scope->getScopeNode())
1805 return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001806
Devang Patel5f1b4cd2011-02-19 01:31:27 +00001807 SmallVector <DIE *, 8> Children;
Devang Patel6c622ef2011-03-01 22:58:55 +00001808
1809 // Collect arguments for current function.
1810 if (Scope == CurrentFnDbgScope)
1811 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
1812 if (DbgVariable *ArgDV = CurrentFnArguments[i])
1813 if (DIE *Arg = constructVariableDIE(ArgDV, Scope))
1814 Children.push_back(Arg);
1815
Devang Patel5f1b4cd2011-02-19 01:31:27 +00001816 // Collect lexical scope childrens first.
1817 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
1818 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
1819 if (DIE *Variable = constructVariableDIE(Variables[i], Scope))
1820 Children.push_back(Variable);
1821 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
1822 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
1823 if (DIE *Nested = constructScopeDIE(Scopes[j]))
1824 Children.push_back(Nested);
Devang Patel3b548aa2010-03-08 20:52:55 +00001825 DIScope DS(Scope->getScopeNode());
1826 DIE *ScopeDIE = NULL;
1827 if (Scope->getInlinedAt())
1828 ScopeDIE = constructInlinedScopeDIE(Scope);
1829 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +00001830 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001831 if (Scope->isAbstractScope()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001832 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001833 // Note down abstract DIE.
1834 if (ScopeDIE)
1835 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
1836 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001837 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001838 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3b548aa2010-03-08 20:52:55 +00001839 }
Devang Patel5f1b4cd2011-02-19 01:31:27 +00001840 else {
1841 // There is no need to emit empty lexical block DIE.
1842 if (Children.empty())
1843 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001844 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +00001845 }
1846
Devang Patel23b2ae62010-03-29 22:59:58 +00001847 if (!ScopeDIE) return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001848
Devang Patel5f1b4cd2011-02-19 01:31:27 +00001849 // Add children
1850 for (SmallVector<DIE *, 8>::iterator I = Children.begin(),
1851 E = Children.end(); I != E; ++I)
1852 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +00001853
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001854 if (DS.isSubprogram())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001855 addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001856
Devang Patel04d2f2d2009-11-24 01:14:22 +00001857 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001858}
1859
Bill Wendling2b128d72009-05-20 23:19:06 +00001860/// GetOrCreateSourceID - Look up the source id with the given directory and
1861/// source file names. If none currently exists, create a new id and insert it
1862/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1863/// maps as well.
Devang Patel498877d2010-07-24 00:53:22 +00001864
Devang Patele01b75c2011-03-24 20:30:50 +00001865unsigned DwarfDebug::GetOrCreateSourceID(StringRef FileName,
1866 StringRef DirName) {
Devang Patel871d0b12010-09-16 20:57:49 +00001867 // If FE did not provide a file name, then assume stdin.
1868 if (FileName.empty())
Devang Patele01b75c2011-03-24 20:30:50 +00001869 return GetOrCreateSourceID("<stdin>", StringRef());
1870
1871 // MCStream expects full path name as filename.
1872 if (!DirName.empty() && !FileName.startswith("/")) {
1873 std::string FullPathName(DirName.data());
1874 if (!DirName.endswith("/"))
1875 FullPathName += "/";
1876 FullPathName += FileName.data();
1877 // Here FullPathName will be copied into StringMap by GetOrCreateSourceID.
1878 return GetOrCreateSourceID(StringRef(FullPathName), StringRef());
1879 }
Devang Patel871d0b12010-09-16 20:57:49 +00001880
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001881 StringMapEntry<unsigned> &Entry = SourceIdMap.GetOrCreateValue(FileName);
1882 if (Entry.getValue())
1883 return Entry.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +00001884
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001885 unsigned SrcId = SourceIdMap.size();
1886 Entry.setValue(SrcId);
Bill Wendling2b128d72009-05-20 23:19:06 +00001887
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001888 // Print out a .file directive to specify files for .loc directives.
Devang Patele01b75c2011-03-24 20:30:50 +00001889 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, Entry.getKey());
Bill Wendling2b128d72009-05-20 23:19:06 +00001890
1891 return SrcId;
1892}
1893
Devang Patel1f4690c2009-12-15 19:16:48 +00001894/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1895DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001896 CompileUnit *TheCU = getCompileUnit(NS);
1897 DIE *NDie = TheCU->getDIE(NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001898 if (NDie)
1899 return NDie;
1900 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001901 TheCU->insertDIE(NS, NDie);
Devang Patel1f4690c2009-12-15 19:16:48 +00001902 if (!NS.getName().empty())
1903 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
Devang Patelb6511a32010-08-09 20:20:05 +00001904 addSourceLine(NDie, NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001905 addToContextOwner(NDie, NS.getContext());
1906 return NDie;
1907}
1908
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001909/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel1a0df9a2010-05-10 22:49:55 +00001910/// metadata node with tag DW_TAG_compile_unit.
Devang Patel32cc43c2010-05-07 20:54:48 +00001911void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001912 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +00001913 StringRef FN = DIUnit.getFilename();
1914 StringRef Dir = DIUnit.getDirectory();
Devang Patele01b75c2011-03-24 20:30:50 +00001915 unsigned ID = GetOrCreateSourceID(FN, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +00001916
1917 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel930143b2009-11-21 02:48:08 +00001918 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patelb2969422009-09-29 18:40:58 +00001919 DIUnit.getProducer());
Devang Patel7b0f7962011-02-23 22:37:04 +00001920 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
Bill Wendling2b128d72009-05-20 23:19:06 +00001921 DIUnit.getLanguage());
Devang Patel930143b2009-11-21 02:48:08 +00001922 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patelbd798ce2010-04-26 22:54:28 +00001923 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1924 // simplifies debug range entries.
Devang Patel1de21ec2010-06-28 22:22:47 +00001925 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Pateld22ed622010-03-22 23:11:36 +00001926 // DW_AT_stmt_list is a offset of line number information for this
Devang Patel4a213872010-08-24 00:06:12 +00001927 // compile unit in debug_line section.
Devang Patelea636392010-08-31 23:50:19 +00001928 if (Asm->MAI->doesDwarfUsesAbsoluteLabelForStmtList())
Cameron Zwarichfcf51fd2011-02-25 16:30:32 +00001929 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_addr,
1930 Asm->GetTempSymbol("section_line"));
Devang Patelea636392010-08-31 23:50:19 +00001931 else
1932 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00001933
Devang Patel2d9caf92009-11-25 17:36:49 +00001934 if (!Dir.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001935 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +00001936 if (DIUnit.isOptimized())
Devang Patel930143b2009-11-21 02:48:08 +00001937 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendling2b128d72009-05-20 23:19:06 +00001938
Devang Patel2d9caf92009-11-25 17:36:49 +00001939 StringRef Flags = DIUnit.getFlags();
1940 if (!Flags.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001941 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendling2b128d72009-05-20 23:19:06 +00001942
1943 unsigned RVer = DIUnit.getRunTimeVersion();
1944 if (RVer)
Devang Patel930143b2009-11-21 02:48:08 +00001945 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +00001946 dwarf::DW_FORM_data1, RVer);
1947
Devang Patel1a0df9a2010-05-10 22:49:55 +00001948 CompileUnit *NewCU = new CompileUnit(ID, Die);
1949 if (!FirstCU)
1950 FirstCU = NewCU;
1951 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendling2b128d72009-05-20 23:19:06 +00001952}
1953
Devang Patel1a0df9a2010-05-10 22:49:55 +00001954/// getCompielUnit - Get CompileUnit DIE.
1955CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1956 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1957 DIDescriptor D(N);
1958 const MDNode *CUNode = NULL;
1959 if (D.isCompileUnit())
1960 CUNode = N;
1961 else if (D.isSubprogram())
1962 CUNode = DISubprogram(N).getCompileUnit();
1963 else if (D.isType())
1964 CUNode = DIType(N).getCompileUnit();
1965 else if (D.isGlobalVariable())
1966 CUNode = DIGlobalVariable(N).getCompileUnit();
1967 else if (D.isVariable())
1968 CUNode = DIVariable(N).getCompileUnit();
1969 else if (D.isNameSpace())
1970 CUNode = DINameSpace(N).getCompileUnit();
1971 else if (D.isFile())
1972 CUNode = DIFile(N).getCompileUnit();
1973 else
1974 return FirstCU;
1975
1976 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1977 = CUMap.find(CUNode);
1978 if (I == CUMap.end())
1979 return FirstCU;
1980 return I->second;
1981}
1982
Devang Patela8652672010-08-23 18:25:56 +00001983/// isUnsignedDIType - Return true if type encoding is unsigned.
1984static bool isUnsignedDIType(DIType Ty) {
1985 DIDerivedType DTy(Ty);
1986 if (DTy.Verify())
1987 return isUnsignedDIType(DTy.getTypeDerivedFrom());
1988
1989 DIBasicType BTy(Ty);
1990 if (BTy.Verify()) {
1991 unsigned Encoding = BTy.getEncoding();
1992 if (Encoding == dwarf::DW_ATE_unsigned ||
1993 Encoding == dwarf::DW_ATE_unsigned_char)
1994 return true;
1995 }
1996 return false;
1997}
Devang Patel1a0df9a2010-05-10 22:49:55 +00001998
Devang Patel2d9e5322011-01-20 00:02:16 +00001999// Return const exprssion if value is a GEP to access merged global
2000// constant. e.g.
2001// i8* getelementptr ({ i8, i8, i8, i8 }* @_MergedGlobals, i32 0, i32 0)
2002static const ConstantExpr *getMergedGlobalExpr(const Value *V) {
2003 const ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(V);
2004 if (!CE || CE->getNumOperands() != 3 ||
2005 CE->getOpcode() != Instruction::GetElementPtr)
2006 return NULL;
2007
2008 // First operand points to a global value.
2009 if (!isa<GlobalValue>(CE->getOperand(0)))
2010 return NULL;
2011
2012 // Second operand is zero.
2013 const ConstantInt *CI =
2014 dyn_cast_or_null<ConstantInt>(CE->getOperand(1));
2015 if (!CI || !CI->isZero())
2016 return NULL;
2017
2018 // Third operand is offset.
2019 if (!isa<ConstantInt>(CE->getOperand(2)))
2020 return NULL;
2021
2022 return CE;
2023}
2024
Devang Patel1a0df9a2010-05-10 22:49:55 +00002025/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00002026void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel469c12d22010-08-10 01:37:23 +00002027 DIGlobalVariable GV(N);
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002028
Devang Patelf5d53602009-09-04 23:59:07 +00002029 // If debug information is malformed then ignore it.
Devang Patel469c12d22010-08-10 01:37:23 +00002030 if (GV.Verify() == false)
Devang Patelf5d53602009-09-04 23:59:07 +00002031 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002032
2033 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002034 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel469c12d22010-08-10 01:37:23 +00002035 if (TheCU->getDIE(GV))
Devang Patel0751a282009-06-26 01:49:18 +00002036 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002037
Devang Patel469c12d22010-08-10 01:37:23 +00002038 DIType GTy = GV.getType();
Devang Patelb2197462010-08-10 07:11:13 +00002039 DIE *VariableDIE = new DIE(GV.getTag());
2040
2041 bool isGlobalVariable = GV.getGlobal() != NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00002042
Devang Patel469c12d22010-08-10 01:37:23 +00002043 // Add name.
2044 addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
2045 GV.getDisplayName());
2046 StringRef LinkageName = GV.getLinkageName();
Devang Patelb2197462010-08-10 07:11:13 +00002047 if (!LinkageName.empty() && isGlobalVariable)
Devang Patel469c12d22010-08-10 01:37:23 +00002048 addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
2049 getRealLinkageName(LinkageName));
2050 // Add type.
2051 addType(VariableDIE, GTy);
Devang Patel12d150e2010-04-13 20:35:04 +00002052 if (GTy.isCompositeType() && !GTy.getName().empty()
2053 && !GTy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002054 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattner8d2fe282010-03-31 05:36:29 +00002055 assert(Entry && "Missing global type!");
Devang Patel1a0df9a2010-05-10 22:49:55 +00002056 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00002057 }
Devang Patel469c12d22010-08-10 01:37:23 +00002058 // Add scoping info.
2059 if (!GV.isLocalToUnit()) {
2060 addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
2061 // Expose as global.
2062 TheCU->addGlobal(GV.getName(), VariableDIE);
2063 }
2064 // Add line number info.
2065 addSourceLine(VariableDIE, GV);
2066 // Add to map.
2067 TheCU->insertDIE(N, VariableDIE);
2068 // Add to context owner.
2069 DIDescriptor GVContext = GV.getContext();
2070 addToContextOwner(VariableDIE, GVContext);
2071 // Add location.
Devang Patelb2197462010-08-10 07:11:13 +00002072 if (isGlobalVariable) {
2073 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
2074 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
2075 addLabel(Block, 0, dwarf::DW_FORM_udata,
2076 Asm->Mang->getSymbol(GV.getGlobal()));
2077 // Do not create specification DIE if context is either compile unit
2078 // or a subprogram.
2079 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
2080 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
2081 // Create specification DIE.
2082 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
2083 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
2084 dwarf::DW_FORM_ref4, VariableDIE);
2085 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
2086 addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
2087 TheCU->addDie(VariableSpecDIE);
2088 } else {
2089 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
2090 }
Devang Patel70eb9822011-01-06 21:39:25 +00002091 } else if (ConstantInt *CI =
2092 dyn_cast_or_null<ConstantInt>(GV.getConstant()))
2093 addConstantValue(VariableDIE, CI, isUnsignedDIType(GTy));
Devang Patel2d9e5322011-01-20 00:02:16 +00002094 else if (const ConstantExpr *CE = getMergedGlobalExpr(N->getOperand(11))) {
2095 // GV is a merged global.
2096 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
2097 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
2098 addLabel(Block, 0, dwarf::DW_FORM_udata,
2099 Asm->Mang->getSymbol(cast<GlobalValue>(CE->getOperand(0))));
2100 ConstantInt *CII = cast<ConstantInt>(CE->getOperand(2));
2101 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
2102 addUInt(Block, 0, dwarf::DW_FORM_udata, CII->getZExtValue());
2103 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
2104 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
2105 }
Devang Patel70eb9822011-01-06 21:39:25 +00002106
Devang Patel0751a282009-06-26 01:49:18 +00002107 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002108}
2109
Devang Patel1a0df9a2010-05-10 22:49:55 +00002110/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00002111void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00002112 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +00002113
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002114 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002115 CompileUnit *TheCU = getCompileUnit(N);
2116 if (TheCU->getDIE(N))
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002117 return;
2118
Bill Wendling2b128d72009-05-20 23:19:06 +00002119 if (!SP.isDefinition())
2120 // This is a method declaration which will be handled while constructing
2121 // class type.
Devang Patel0751a282009-06-26 01:49:18 +00002122 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002123
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002124 DIE *SubprogramDie = createSubprogramDIE(SP);
2125
2126 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002127 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00002128
2129 // Add to context owner.
Devang Patel1f4690c2009-12-15 19:16:48 +00002130 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +00002131
Bill Wendling2b128d72009-05-20 23:19:06 +00002132 // Expose as global.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002133 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002134
Devang Patel0751a282009-06-26 01:49:18 +00002135 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002136}
2137
Devang Patel930143b2009-11-21 02:48:08 +00002138/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbarbe22ec42009-09-19 20:40:14 +00002139/// content. Create global DIEs and emit initial debug info sections.
2140/// This is inovked by the target AsmPrinter.
Chris Lattner11980022010-04-04 07:48:20 +00002141void DwarfDebug::beginModule(Module *M) {
Devang Patel6c74a872010-04-27 19:46:33 +00002142 if (DisableDebugInfoPrinting)
2143 return;
2144
Devang Patel63524442009-07-30 18:56:46 +00002145 DebugInfoFinder DbgFinder;
2146 DbgFinder.processModule(*M);
Devang Patel0751a282009-06-26 01:49:18 +00002147
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002148 bool HasDebugInfo = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002149
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002150 // Scan all the compile-units to see if there are any marked as the main unit.
2151 // if not, we do not generate debug info.
2152 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2153 E = DbgFinder.compile_unit_end(); I != E; ++I) {
2154 if (DICompileUnit(*I).isMain()) {
2155 HasDebugInfo = true;
2156 break;
2157 }
2158 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002159
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002160 if (!HasDebugInfo) return;
2161
2162 // Tell MMI that we have debug info.
2163 MMI->setDebugInfoAvailability(true);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002164
Chris Lattnerd442aa32010-04-04 23:17:54 +00002165 // Emit initial sections.
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002166 EmitSectionLabels();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002167
Bill Wendling2b128d72009-05-20 23:19:06 +00002168 // Create all the compile unit DIEs.
Devang Patel63524442009-07-30 18:56:46 +00002169 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2170 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002171 constructCompileUnit(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002172
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002173 // Create DIEs for each subprogram.
Devang Patel63524442009-07-30 18:56:46 +00002174 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
2175 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002176 constructSubprogramDIE(*I);
Devang Patel0751a282009-06-26 01:49:18 +00002177
Devang Patel2b75ed22009-12-10 19:14:49 +00002178 // Create DIEs for each global variable.
2179 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2180 E = DbgFinder.global_variable_end(); I != E; ++I)
2181 constructGlobalVariableDIE(*I);
2182
Devang Patel8e06a5e2010-08-10 20:01:20 +00002183 //getOrCreateTypeDIE
2184 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
2185 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2186 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2187
Devang Patel7a554812010-09-28 18:08:20 +00002188 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
2189 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2190 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2191
Bill Wendling2b128d72009-05-20 23:19:06 +00002192 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +00002193 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +00002194}
2195
Devang Patel930143b2009-11-21 02:48:08 +00002196/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendling2b128d72009-05-20 23:19:06 +00002197///
Devang Patel930143b2009-11-21 02:48:08 +00002198void DwarfDebug::endModule() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002199 if (!FirstCU) return;
Devang Patelf3b2db62010-06-28 18:25:03 +00002200 const Module *M = MMI->getModule();
Devang Pateld0701282010-08-02 17:32:15 +00002201 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patelf3b2db62010-06-28 18:25:03 +00002202 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2203 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2204 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2205 DISubprogram SP(AllSPs->getOperand(SI));
2206 if (!SP.Verify()) continue;
2207
2208 // Collect info for variables that were optimized out.
Devang Patel18efced2010-07-19 17:53:55 +00002209 if (!SP.isDefinition()) continue;
Devang Patelf3b2db62010-06-28 18:25:03 +00002210 StringRef FName = SP.getLinkageName();
2211 if (FName.empty())
2212 FName = SP.getName();
Devang Patel364bf042010-11-10 22:19:21 +00002213 NamedMDNode *NMD = getFnSpecificMDNode(*(MMI->getModule()), FName);
Devang Patelf3b2db62010-06-28 18:25:03 +00002214 if (!NMD) continue;
2215 unsigned E = NMD->getNumOperands();
2216 if (!E) continue;
2217 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Pateld0701282010-08-02 17:32:15 +00002218 DeadFnScopeMap[SP] = Scope;
Devang Patelf3b2db62010-06-28 18:25:03 +00002219 for (unsigned I = 0; I != E; ++I) {
2220 DIVariable DV(NMD->getOperand(I));
2221 if (!DV.Verify()) continue;
2222 Scope->addVariable(new DbgVariable(DV));
2223 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002224
Devang Patelf3b2db62010-06-28 18:25:03 +00002225 // Construct subprogram DIE and add variables DIEs.
2226 constructSubprogramDIE(SP);
2227 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patel406798a2010-08-09 18:51:29 +00002228 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf3b2db62010-06-28 18:25:03 +00002229 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2230 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2231 if (VariableDIE)
2232 ScopeDIE->addChild(VariableDIE);
2233 }
2234 }
2235 }
Bill Wendling2b128d72009-05-20 23:19:06 +00002236
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002237 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2238 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2239 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2240 DIE *ISP = *AI;
Devang Patel930143b2009-11-21 02:48:08 +00002241 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002242 }
2243
Devang Patel32cc43c2010-05-07 20:54:48 +00002244 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Pateleb57c592009-12-03 19:11:07 +00002245 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2246 DIE *SPDie = CI->first;
Devang Patel32cc43c2010-05-07 20:54:48 +00002247 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Pateleb57c592009-12-03 19:11:07 +00002248 if (!N) continue;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002249 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Pateleb57c592009-12-03 19:11:07 +00002250 if (!NDie) continue;
2251 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Pateleb57c592009-12-03 19:11:07 +00002252 }
2253
Bill Wendling2b128d72009-05-20 23:19:06 +00002254 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002255 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002256 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002257 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002258 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +00002259
2260 // End text sections.
2261 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002262 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnera179b522010-04-04 19:25:43 +00002263 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendling2b128d72009-05-20 23:19:06 +00002264 }
2265
2266 // Emit common frame information.
Devang Patel930143b2009-11-21 02:48:08 +00002267 emitCommonDebugFrame();
Bill Wendling2b128d72009-05-20 23:19:06 +00002268
2269 // Emit function debug frame information
2270 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2271 E = DebugFrames.end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002272 emitFunctionDebugFrame(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002273
2274 // Compute DIE offsets and sizes.
Devang Patel930143b2009-11-21 02:48:08 +00002275 computeSizeAndOffsets();
Bill Wendling2b128d72009-05-20 23:19:06 +00002276
2277 // Emit all the DIEs into a debug info section
Devang Patel930143b2009-11-21 02:48:08 +00002278 emitDebugInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002279
2280 // Corresponding abbreviations into a abbrev section.
Devang Patel930143b2009-11-21 02:48:08 +00002281 emitAbbreviations();
Bill Wendling2b128d72009-05-20 23:19:06 +00002282
Bill Wendling2b128d72009-05-20 23:19:06 +00002283 // Emit info into a debug pubnames section.
Devang Patel930143b2009-11-21 02:48:08 +00002284 emitDebugPubNames();
Bill Wendling2b128d72009-05-20 23:19:06 +00002285
Devang Patel04d2f2d2009-11-24 01:14:22 +00002286 // Emit info into a debug pubtypes section.
2287 emitDebugPubTypes();
2288
Bill Wendling2b128d72009-05-20 23:19:06 +00002289 // Emit info into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002290 emitDebugLoc();
Bill Wendling2b128d72009-05-20 23:19:06 +00002291
2292 // Emit info into a debug aranges section.
2293 EmitDebugARanges();
2294
2295 // Emit info into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002296 emitDebugRanges();
Bill Wendling2b128d72009-05-20 23:19:06 +00002297
2298 // Emit info into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002299 emitDebugMacInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002300
2301 // Emit inline info.
Devang Patel930143b2009-11-21 02:48:08 +00002302 emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002303
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002304 // Emit info into a debug str section.
2305 emitDebugStr();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002306
Devang Pateld0701282010-08-02 17:32:15 +00002307 // clean up.
2308 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002309 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2310 E = CUMap.end(); I != E; ++I)
2311 delete I->second;
2312 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendling2b128d72009-05-20 23:19:06 +00002313}
2314
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002315/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002316DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattner915c5f92010-04-02 19:42:39 +00002317 DebugLoc ScopeLoc) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002318
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002319 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002320 if (AbsDbgVariable)
2321 return AbsDbgVariable;
2322
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002323 LLVMContext &Ctx = Var->getContext();
Chris Lattner915c5f92010-04-02 19:42:39 +00002324 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002325 if (!Scope)
2326 return NULL;
2327
Devang Patele1c53f22010-05-20 16:36:41 +00002328 AbsDbgVariable = new DbgVariable(Var);
Devang Patel930143b2009-11-21 02:48:08 +00002329 Scope->addVariable(AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002330 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002331 return AbsDbgVariable;
2332}
2333
Devang Patel6c622ef2011-03-01 22:58:55 +00002334/// addCurrentFnArgument - If Var is an current function argument that add
2335/// it in CurrentFnArguments list.
2336bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
2337 DbgVariable *Var, DbgScope *Scope) {
2338 if (Scope != CurrentFnDbgScope)
2339 return false;
2340 DIVariable DV = Var->getVariable();
2341 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
2342 return false;
2343 unsigned ArgNo = DV.getArgNumber();
2344 if (ArgNo == 0)
2345 return false;
2346
Devang Patel4ab660b2011-03-03 20:02:02 +00002347 size_t Size = CurrentFnArguments.size();
2348 if (Size == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00002349 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00002350 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00002351 // arguments does the function have at source level.
2352 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00002353 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00002354 CurrentFnArguments[ArgNo - 1] = Var;
2355 return true;
2356}
2357
Devang Patel490c8ab2010-05-20 19:57:06 +00002358/// collectVariableInfoFromMMITable - Collect variable information from
2359/// side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002360void
Devang Patel490c8ab2010-05-20 19:57:06 +00002361DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2362 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00002363 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patel475d32a2009-10-06 01:26:37 +00002364 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2365 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2366 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00002367 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002368 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00002369 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00002370 DIVariable DV(Var);
2371 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002372
Chris Lattner915c5f92010-04-02 19:42:39 +00002373 DbgScope *Scope = 0;
Devang Patel32cc43c2010-05-07 20:54:48 +00002374 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattner915c5f92010-04-02 19:42:39 +00002375 Scope = ConcreteScopes.lookup(IA);
2376 if (Scope == 0)
2377 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002378
Devang Patelcdb7d442009-11-10 23:20:04 +00002379 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00002380 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00002381 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002382
Devang Patele1c53f22010-05-20 16:36:41 +00002383 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2384 DbgVariable *RegVar = new DbgVariable(DV);
2385 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel6c622ef2011-03-01 22:58:55 +00002386 if (!addCurrentFnArgument(MF, RegVar, Scope))
2387 Scope->addVariable(RegVar);
Devang Patele1c53f22010-05-20 16:36:41 +00002388 if (AbsDbgVariable) {
2389 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2390 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2391 }
Devang Patel475d32a2009-10-06 01:26:37 +00002392 }
Devang Patel490c8ab2010-05-20 19:57:06 +00002393}
Devang Patela3e9c9c2010-03-15 18:33:46 +00002394
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002395/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +00002396/// DBG_VALUE instruction, is in a defined reg.
2397static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2398 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002399 return MI->getNumOperands() == 3 &&
2400 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
2401 MI->getOperand(1).isImm() && MI->getOperand(1).getImm() == 0;
Devang Patel9fc11702010-05-25 23:40:22 +00002402}
2403
Devang Patel490c8ab2010-05-20 19:57:06 +00002404/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002405void
Devang Patel5c0f85c2010-06-25 22:07:34 +00002406DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2407 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002408
Devang Patel490c8ab2010-05-20 19:57:06 +00002409 /// collection info from MMI table.
2410 collectVariableInfoFromMMITable(MF, Processed);
2411
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002412 for (SmallVectorImpl<const MDNode*>::const_iterator
2413 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
2414 ++UVI) {
2415 const MDNode *Var = *UVI;
2416 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00002417 continue;
2418
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002419 // History contains relevant DBG_VALUE instructions for Var and instructions
2420 // clobbering it.
2421 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
2422 if (History.empty())
2423 continue;
2424 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00002425
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002426 DIVariable DV(Var);
Devang Patel447cb382011-01-11 21:42:10 +00002427 DbgScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00002428 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2429 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelfbd6c452010-05-21 00:10:20 +00002430 Scope = CurrentFnDbgScope;
Devang Patel447cb382011-01-11 21:42:10 +00002431 else
2432 Scope = findDbgScope(MInsn);
Devang Patel490c8ab2010-05-20 19:57:06 +00002433 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00002434 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00002435 continue;
2436
2437 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002438 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel490c8ab2010-05-20 19:57:06 +00002439 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patel6c622ef2011-03-01 22:58:55 +00002440 if (!addCurrentFnArgument(MF, RegVar, Scope))
2441 Scope->addVariable(RegVar);
Devang Patelfbd6c452010-05-21 00:10:20 +00002442 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2443 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2444 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002445 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002446
2447 // Simple ranges that are fully coalesced.
2448 if (History.size() <= 1 || (History.size() == 2 &&
2449 MInsn->isIdenticalTo(History.back()))) {
Devang Patel9fc11702010-05-25 23:40:22 +00002450 DbgVariableToDbgInstMap[RegVar] = MInsn;
2451 continue;
2452 }
2453
2454 // handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002455 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002456
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002457 for (SmallVectorImpl<const MachineInstr*>::const_iterator
2458 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
2459 const MachineInstr *Begin = *HI;
2460 assert(Begin->isDebugValue() && "Invalid History entry");
Devang Patel9fc11702010-05-25 23:40:22 +00002461 MachineLocation MLoc;
Devang Patel0e60e672010-08-04 18:40:52 +00002462 if (Begin->getNumOperands() == 3) {
2463 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2464 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2465 } else
2466 MLoc = Asm->getDebugValueLocation(Begin);
2467
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002468 // FIXME: emitDebugLoc only understands registers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002469 if (!MLoc.getReg())
2470 continue;
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00002471
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002472 // Compute the range for a register location.
2473 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2474 const MCSymbol *SLabel = 0;
2475
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002476 if (HI + 1 == HE)
2477 // If Begin is the last instruction in History then its value is valid
Devang Patel9fc11702010-05-25 23:40:22 +00002478 // until the end of the funtion.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002479 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002480 else {
2481 const MachineInstr *End = HI[1];
2482 if (End->isDebugValue())
2483 SLabel = getLabelBeforeInsn(End);
2484 else {
2485 // End is a normal instruction clobbering the range.
2486 SLabel = getLabelAfterInsn(End);
2487 assert(SLabel && "Forgot label after clobber instruction");
2488 ++HI;
2489 }
2490 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002491
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002492 // The value is valid until the next DBG_VALUE or clobber.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002493 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
Devang Patel9fc11702010-05-25 23:40:22 +00002494 }
2495 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00002496 }
Devang Patele0a94bf2010-05-14 21:01:35 +00002497
2498 // Collect info for variables that were optimized out.
Devang Patelad517352010-06-22 01:01:58 +00002499 const Function *F = MF->getFunction();
Devang Patel364bf042010-11-10 22:19:21 +00002500 if (NamedMDNode *NMD = getFnSpecificMDNode(*(F->getParent()), F->getName())) {
Devang Patele0a94bf2010-05-14 21:01:35 +00002501 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002502 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel490c8ab2010-05-20 19:57:06 +00002503 if (!DV || !Processed.insert(DV))
Devang Patele0a94bf2010-05-14 21:01:35 +00002504 continue;
2505 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2506 if (Scope)
Devang Patele1c53f22010-05-20 16:36:41 +00002507 Scope->addVariable(new DbgVariable(DV));
Devang Patele0a94bf2010-05-14 21:01:35 +00002508 }
2509 }
Devang Patel9fc11702010-05-25 23:40:22 +00002510}
Devang Patele0a94bf2010-05-14 21:01:35 +00002511
Devang Patel9fc11702010-05-25 23:40:22 +00002512/// getLabelBeforeInsn - Return Label preceding the instruction.
2513const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002514 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
2515 assert(Label && "Didn't insert label before instruction");
2516 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00002517}
2518
2519/// getLabelAfterInsn - Return Label immediately following the instruction.
2520const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002521 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00002522}
2523
Devang Patelb5694e72010-10-26 17:49:02 +00002524/// beginInstruction - Process beginning of an instruction.
2525void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00002526 // Check if source location changes, but ignore DBG_VALUE locations.
2527 if (!MI->isDebugValue()) {
2528 DebugLoc DL = MI->getDebugLoc();
2529 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
2530 PrevInstLoc = DL;
2531 if (!DL.isUnknown()) {
2532 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2533 recordSourceLine(DL.getLine(), DL.getCol(), Scope);
2534 } else
2535 recordSourceLine(0, 0, 0);
2536 }
Devang Patel9fc11702010-05-25 23:40:22 +00002537 }
Devang Patel23b2ae62010-03-29 22:59:58 +00002538
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00002539 // Insert labels where requested.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002540 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
2541 LabelsBeforeInsn.find(MI);
2542
2543 // No label needed.
2544 if (I == LabelsBeforeInsn.end())
2545 return;
2546
2547 // Label already assigned.
2548 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00002549 return;
Devang Patelbd477be2010-03-29 17:20:31 +00002550
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00002551 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00002552 PrevLabel = MMI->getContext().CreateTempSymbol();
2553 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00002554 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002555 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00002556}
2557
Devang Patelb5694e72010-10-26 17:49:02 +00002558/// endInstruction - Process end of an instruction.
2559void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00002560 // Don't create a new label after DBG_VALUE instructions.
2561 // They don't generate code.
2562 if (!MI->isDebugValue())
2563 PrevLabel = 0;
2564
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002565 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
2566 LabelsAfterInsn.find(MI);
2567
2568 // No label needed.
2569 if (I == LabelsAfterInsn.end())
2570 return;
2571
2572 // Label already assigned.
2573 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00002574 return;
2575
2576 // We need a label after this instruction.
2577 if (!PrevLabel) {
2578 PrevLabel = MMI->getContext().CreateTempSymbol();
2579 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00002580 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002581 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002582}
2583
Devang Patel6c74a872010-04-27 19:46:33 +00002584/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002585DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel30265c42010-07-07 20:12:52 +00002586 const MDNode *InlinedAt) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002587 if (!InlinedAt) {
2588 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2589 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002590 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002591 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2592 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Patel6c74a872010-04-27 19:46:33 +00002593 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002594 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002595 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Patel6c74a872010-04-27 19:46:33 +00002596 WScope->setParent(Parent);
2597 Parent->addScope(WScope);
2598 }
2599
2600 if (!WScope->getParent()) {
2601 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastings9b5005c2010-06-15 23:06:30 +00002602 // We used to check only for a linkage name, but that fails
2603 // since we began omitting the linkage name for private
2604 // functions. The new way is to check for the name in metadata,
2605 // but that's not supported in old .ll test cases. Ergo, we
2606 // check both.
Stuart Hastingsafe54f12010-06-11 20:08:44 +00002607 if (SPName == Asm->MF->getFunction()->getName() ||
2608 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Patel6c74a872010-04-27 19:46:33 +00002609 CurrentFnDbgScope = WScope;
2610 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002611
Devang Patel6c74a872010-04-27 19:46:33 +00002612 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002613 }
2614
Devang Patel5c0f85c2010-06-25 22:07:34 +00002615 getOrCreateAbstractScope(Scope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002616 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2617 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002618 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002619
2620 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2621 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2622 DILocation DL(InlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002623 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002624 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Patel6c74a872010-04-27 19:46:33 +00002625 WScope->setParent(Parent);
2626 Parent->addScope(WScope);
2627
2628 ConcreteScopes[InlinedAt] = WScope;
Devang Patel6c74a872010-04-27 19:46:33 +00002629
2630 return WScope;
Devang Patel8db360d2009-10-06 01:50:42 +00002631}
2632
Devang Patel6c74a872010-04-27 19:46:33 +00002633/// hasValidLocation - Return true if debug location entry attached with
2634/// machine instruction encodes valid location info.
2635static bool hasValidLocation(LLVMContext &Ctx,
2636 const MachineInstr *MInsn,
Devang Patel32cc43c2010-05-07 20:54:48 +00002637 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Patel6c74a872010-04-27 19:46:33 +00002638 DebugLoc DL = MInsn->getDebugLoc();
2639 if (DL.isUnknown()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002640
Devang Patel32cc43c2010-05-07 20:54:48 +00002641 const MDNode *S = DL.getScope(Ctx);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002642
Devang Patel6c74a872010-04-27 19:46:33 +00002643 // There is no need to create another DIE for compile unit. For all
2644 // other scopes, create one DbgScope now. This will be translated
2645 // into a scope DIE at the end.
2646 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002647
Devang Patel6c74a872010-04-27 19:46:33 +00002648 Scope = S;
2649 InlinedAt = DL.getInlinedAt(Ctx);
2650 return true;
2651}
2652
2653/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2654/// hierarchy.
2655static void calculateDominanceGraph(DbgScope *Scope) {
2656 assert (Scope && "Unable to calculate scop edominance graph!");
2657 SmallVector<DbgScope *, 4> WorkStack;
2658 WorkStack.push_back(Scope);
2659 unsigned Counter = 0;
2660 while (!WorkStack.empty()) {
2661 DbgScope *WS = WorkStack.back();
2662 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2663 bool visitedChildren = false;
2664 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2665 SE = Children.end(); SI != SE; ++SI) {
2666 DbgScope *ChildScope = *SI;
2667 if (!ChildScope->getDFSOut()) {
2668 WorkStack.push_back(ChildScope);
2669 visitedChildren = true;
2670 ChildScope->setDFSIn(++Counter);
2671 break;
2672 }
2673 }
2674 if (!visitedChildren) {
2675 WorkStack.pop_back();
2676 WS->setDFSOut(++Counter);
2677 }
2678 }
2679}
2680
2681/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002682static
Devang Patel6c74a872010-04-27 19:46:33 +00002683void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2684 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2685{
2686#ifndef NDEBUG
2687 unsigned PrevDFSIn = 0;
2688 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2689 I != E; ++I) {
2690 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2691 II != IE; ++II) {
2692 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002693 const MDNode *Scope = NULL;
2694 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002695
2696 // Check if instruction has valid location information.
2697 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2698 dbgs() << " [ ";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002699 if (InlinedAt)
Devang Patel6c74a872010-04-27 19:46:33 +00002700 dbgs() << "*";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002701 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Patel6c74a872010-04-27 19:46:33 +00002702 MI2ScopeMap.find(MInsn);
2703 if (DI != MI2ScopeMap.end()) {
2704 DbgScope *S = DI->second;
2705 dbgs() << S->getDFSIn();
2706 PrevDFSIn = S->getDFSIn();
2707 } else
2708 dbgs() << PrevDFSIn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002709 } else
Devang Patel6c74a872010-04-27 19:46:33 +00002710 dbgs() << " [ x" << PrevDFSIn;
2711 dbgs() << " ]";
2712 MInsn->dump();
2713 }
2714 dbgs() << "\n";
2715 }
2716#endif
2717}
Devang Patel930143b2009-11-21 02:48:08 +00002718/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner848c7d22010-03-31 05:39:57 +00002719/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattner76555b52010-01-26 23:18:02 +00002720bool DwarfDebug::extractScopeInformation() {
Devang Patel75cc16c2009-10-01 20:31:14 +00002721 // If scope information was extracted using .dbg intrinsics then there is not
2722 // any need to extract these information by scanning each instruction.
2723 if (!DbgScopeMap.empty())
2724 return false;
2725
Dan Gohmane9135cb2010-04-23 01:18:53 +00002726 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patel6c74a872010-04-27 19:46:33 +00002727 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2728 SmallVector<DbgRange, 4> MIRanges;
2729 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patel32cc43c2010-05-07 20:54:48 +00002730 const MDNode *PrevScope = NULL;
2731 const MDNode *PrevInlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002732 const MachineInstr *RangeBeginMI = NULL;
2733 const MachineInstr *PrevMI = NULL;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002734 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel75cc16c2009-10-01 20:31:14 +00002735 I != E; ++I) {
2736 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2737 II != IE; ++II) {
2738 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002739 const MDNode *Scope = NULL;
2740 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002741
2742 // Check if instruction has valid location information.
2743 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2744 PrevMI = MInsn;
2745 continue;
2746 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002747
Devang Patel6c74a872010-04-27 19:46:33 +00002748 // If scope has not changed then skip this instruction.
2749 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2750 PrevMI = MInsn;
2751 continue;
2752 }
2753
Devang Pateld12c0a22011-02-15 17:56:09 +00002754 // Ignore DBG_VALUE. It does not contribute any instruction in output.
2755 if (MInsn->isDebugValue())
2756 continue;
2757
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002758 if (RangeBeginMI) {
2759 // If we have alread seen a beginning of a instruction range and
Devang Patel6c74a872010-04-27 19:46:33 +00002760 // current instruction scope does not match scope of first instruction
2761 // in this range then create a new instruction range.
2762 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002763 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel30265c42010-07-07 20:12:52 +00002764 PrevInlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002765 MIRanges.push_back(R);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002766 }
Devang Patel6c74a872010-04-27 19:46:33 +00002767
2768 // This is a beginning of a new instruction range.
2769 RangeBeginMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002770
Devang Patel6c74a872010-04-27 19:46:33 +00002771 // Reset previous markers.
2772 PrevMI = MInsn;
2773 PrevScope = Scope;
2774 PrevInlinedAt = InlinedAt;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002775 }
2776 }
2777
Devang Patel6c74a872010-04-27 19:46:33 +00002778 // Create last instruction range.
2779 if (RangeBeginMI && PrevMI && PrevScope) {
2780 DbgRange R(RangeBeginMI, PrevMI);
2781 MIRanges.push_back(R);
2782 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patel75cc16c2009-10-01 20:31:14 +00002783 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002784
Devang Patel530a0752010-01-04 20:44:00 +00002785 if (!CurrentFnDbgScope)
2786 return false;
2787
Devang Patel6c74a872010-04-27 19:46:33 +00002788 calculateDominanceGraph(CurrentFnDbgScope);
2789 if (PrintDbgScope)
2790 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2791
2792 // Find ranges of instructions covered by each DbgScope;
2793 DbgScope *PrevDbgScope = NULL;
2794 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2795 RE = MIRanges.end(); RI != RE; ++RI) {
2796 const DbgRange &R = *RI;
2797 DbgScope *S = MI2ScopeMap.lookup(R.first);
2798 assert (S && "Lost DbgScope for a machine instruction!");
2799 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2800 PrevDbgScope->closeInsnRange(S);
2801 S->openInsnRange(R.first);
2802 S->extendInsnRange(R.second);
2803 PrevDbgScope = S;
2804 }
2805
2806 if (PrevDbgScope)
2807 PrevDbgScope->closeInsnRange();
Devang Patel75cc16c2009-10-01 20:31:14 +00002808
Devang Patel359b0132010-04-08 18:43:56 +00002809 identifyScopeMarkers();
Devang Patelf1d5a1e2010-04-08 15:37:09 +00002810
2811 return !DbgScopeMap.empty();
2812}
2813
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002814/// identifyScopeMarkers() -
Devang Patel6c74a872010-04-27 19:46:33 +00002815/// Each DbgScope has first instruction and last instruction to mark beginning
2816/// and end of a scope respectively. Create an inverse map that list scopes
2817/// starts (and ends) with an instruction. One instruction may start (or end)
2818/// multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00002819void DwarfDebug::identifyScopeMarkers() {
Devang Patel7771b7c2010-01-20 02:05:23 +00002820 SmallVector<DbgScope *, 4> WorkList;
2821 WorkList.push_back(CurrentFnDbgScope);
2822 while (!WorkList.empty()) {
Chris Lattner848c7d22010-03-31 05:39:57 +00002823 DbgScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002824
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002825 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002826 if (!Children.empty())
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002827 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00002828 SE = Children.end(); SI != SE; ++SI)
2829 WorkList.push_back(*SI);
2830
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002831 if (S->isAbstractScope())
2832 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002833
Devang Patel6c74a872010-04-27 19:46:33 +00002834 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2835 if (Ranges.empty())
2836 continue;
2837 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2838 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002839 assert(RI->first && "DbgRange does not have first instruction!");
2840 assert(RI->second && "DbgRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002841 requestLabelBeforeInsn(RI->first);
2842 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00002843 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002844 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002845}
2846
Dan Gohman3df671a2010-04-20 00:37:27 +00002847/// FindFirstDebugLoc - Find the first debug location in the function. This
2848/// is intended to be an approximation for the source position of the
2849/// beginning of the function.
2850static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2851 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2852 I != E; ++I)
2853 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2854 MBBI != MBBE; ++MBBI) {
2855 DebugLoc DL = MBBI->getDebugLoc();
2856 if (!DL.isUnknown())
2857 return DL;
2858 }
2859 return DebugLoc();
2860}
2861
Devang Patela86114b2010-10-25 20:45:32 +00002862#ifndef NDEBUG
2863/// CheckLineNumbers - Count basicblocks whose instructions do not have any
2864/// line number information.
2865static void CheckLineNumbers(const MachineFunction *MF) {
2866 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2867 I != E; ++I) {
2868 bool FoundLineNo = false;
2869 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2870 II != IE; ++II) {
2871 const MachineInstr *MI = II;
2872 if (!MI->getDebugLoc().isUnknown()) {
2873 FoundLineNo = true;
2874 break;
2875 }
2876 }
Devang Patel6e0d5892010-10-28 22:11:59 +00002877 if (!FoundLineNo && I->size())
Devang Patela86114b2010-10-25 20:45:32 +00002878 ++BlocksWithoutLineNo;
2879 }
2880}
2881#endif
2882
Devang Patel930143b2009-11-21 02:48:08 +00002883/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendling2b128d72009-05-20 23:19:06 +00002884/// emitted immediately after the function entry point.
Chris Lattner76555b52010-01-26 23:18:02 +00002885void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00002886 if (!MMI->hasDebugInfo()) return;
Bill Wendlingfcc14142010-04-07 09:28:04 +00002887 if (!extractScopeInformation()) return;
Devang Patel4598eb62009-10-06 18:37:31 +00002888
Devang Patela86114b2010-10-25 20:45:32 +00002889#ifndef NDEBUG
2890 CheckLineNumbers(MF);
2891#endif
2892
Devang Patel6c74a872010-04-27 19:46:33 +00002893 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2894 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00002895 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00002896 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00002897
2898 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2899 // function.
Dan Gohman3df671a2010-04-20 00:37:27 +00002900 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattner915c5f92010-04-02 19:42:39 +00002901 if (FDL.isUnknown()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002902
Devang Patel32cc43c2010-05-07 20:54:48 +00002903 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings61475c52010-07-19 23:56:30 +00002904 const MDNode *TheScope = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002905
Chris Lattner915c5f92010-04-02 19:42:39 +00002906 DISubprogram SP = getDISubprogram(Scope);
2907 unsigned Line, Col;
2908 if (SP.Verify()) {
2909 Line = SP.getLineNumber();
2910 Col = 0;
Stuart Hastings61475c52010-07-19 23:56:30 +00002911 TheScope = SP;
Chris Lattner915c5f92010-04-02 19:42:39 +00002912 } else {
2913 Line = FDL.getLine();
2914 Col = FDL.getCol();
Stuart Hastings61475c52010-07-19 23:56:30 +00002915 TheScope = Scope;
Bill Wendling2b128d72009-05-20 23:19:06 +00002916 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002917
Stuart Hastings61475c52010-07-19 23:56:30 +00002918 recordSourceLine(Line, Col, TheScope);
Devang Patel002d54d2010-05-26 19:37:24 +00002919
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002920 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
2921
Devang Patel21ccf052010-06-02 16:42:51 +00002922 /// ProcessedArgs - Collection of arguments already processed.
2923 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2924
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002925 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
2926
2927 /// LiveUserVar - Map physreg numbers to the MDNode they contain.
2928 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
2929
Devang Patel002d54d2010-05-26 19:37:24 +00002930 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002931 I != E; ++I) {
2932 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00002933 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2934 II != IE; ++II) {
2935 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002936
Devang Patel002d54d2010-05-26 19:37:24 +00002937 if (MI->isDebugValue()) {
Devang Patel002d54d2010-05-26 19:37:24 +00002938 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002939
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002940 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002941 const MDNode *Var =
2942 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002943
2944 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002945 if (isDbgValueInDefinedReg(MI))
2946 LiveUserVar[MI->getOperand(0).getReg()] = Var;
2947
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002948 // Check the history of this variable.
2949 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
2950 if (History.empty()) {
2951 UserVariables.push_back(Var);
2952 // The first mention of a function argument gets the FunctionBeginSym
2953 // label, so arguments are visible when breaking at function entry.
2954 DIVariable DV(Var);
2955 if (DV.Verify() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
2956 DISubprogram(getDISubprogram(DV.getContext()))
2957 .describes(MF->getFunction()))
2958 LabelsBeforeInsn[MI] = FunctionBeginSym;
2959 } else {
2960 // We have seen this variable before. Try to coalesce DBG_VALUEs.
2961 const MachineInstr *Prev = History.back();
2962 if (Prev->isDebugValue()) {
2963 // Coalesce identical entries at the end of History.
2964 if (History.size() >= 2 &&
2965 Prev->isIdenticalTo(History[History.size() - 2]))
2966 History.pop_back();
2967
2968 // Terminate old register assignments that don't reach MI;
2969 MachineFunction::const_iterator PrevMBB = Prev->getParent();
2970 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
2971 isDbgValueInDefinedReg(Prev)) {
2972 // Previous register assignment needs to terminate at the end of
2973 // its basic block.
2974 MachineBasicBlock::const_iterator LastMI =
2975 PrevMBB->getLastNonDebugInstr();
2976 if (LastMI == PrevMBB->end())
2977 // Drop DBG_VALUE for empty range.
2978 History.pop_back();
2979 else {
2980 // Terminate after LastMI.
2981 History.push_back(LastMI);
2982 }
2983 }
2984 }
2985 }
2986 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00002987 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002988 // Not a DBG_VALUE instruction.
2989 if (!MI->isLabel())
2990 AtBlockEntry = false;
2991
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002992 // Check if the instruction clobbers any registers with debug vars.
2993 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
2994 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
2995 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
2996 continue;
2997 for (const unsigned *AI = TRI->getOverlaps(MOI->getReg());
2998 unsigned Reg = *AI; ++AI) {
2999 const MDNode *Var = LiveUserVar[Reg];
3000 if (!Var)
3001 continue;
3002 // Reg is now clobbered.
3003 LiveUserVar[Reg] = 0;
3004
3005 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00003006 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
3007 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00003008 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00003009 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
3010 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00003011 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00003012 const MachineInstr *Prev = History.back();
3013 // Sanity-check: Register assignments are terminated at the end of
3014 // their block.
3015 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
3016 continue;
3017 // Is the variable still in Reg?
3018 if (!isDbgValueInDefinedReg(Prev) ||
3019 Prev->getOperand(0).getReg() != Reg)
3020 continue;
3021 // Var is clobbered. Make sure the next instruction gets a label.
3022 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00003023 }
3024 }
Devang Patel002d54d2010-05-26 19:37:24 +00003025 }
Devang Patel002d54d2010-05-26 19:37:24 +00003026 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00003027 }
3028
3029 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
3030 I != E; ++I) {
3031 SmallVectorImpl<const MachineInstr*> &History = I->second;
3032 if (History.empty())
3033 continue;
3034
3035 // Make sure the final register assignments are terminated.
3036 const MachineInstr *Prev = History.back();
3037 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
3038 const MachineBasicBlock *PrevMBB = Prev->getParent();
3039 MachineBasicBlock::const_iterator LastMI = PrevMBB->getLastNonDebugInstr();
3040 if (LastMI == PrevMBB->end())
3041 // Drop DBG_VALUE for empty range.
3042 History.pop_back();
3043 else {
3044 // Terminate after LastMI.
3045 History.push_back(LastMI);
3046 }
3047 }
3048 // Request labels for the full history.
3049 for (unsigned i = 0, e = History.size(); i != e; ++i) {
3050 const MachineInstr *MI = History[i];
3051 if (MI->isDebugValue())
3052 requestLabelBeforeInsn(MI);
3053 else
3054 requestLabelAfterInsn(MI);
3055 }
3056 }
Devang Patel002d54d2010-05-26 19:37:24 +00003057
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00003058 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00003059 PrevLabel = FunctionBeginSym;
Bill Wendling2b128d72009-05-20 23:19:06 +00003060}
3061
Devang Patel930143b2009-11-21 02:48:08 +00003062/// endFunction - Gather and emit post-function debug information.
Bill Wendling2b128d72009-05-20 23:19:06 +00003063///
Chris Lattner76555b52010-01-26 23:18:02 +00003064void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendlingfcc14142010-04-07 09:28:04 +00003065 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00003066
Devang Patel530a0752010-01-04 20:44:00 +00003067 if (CurrentFnDbgScope) {
Devang Patel4a8e6e82010-05-22 00:04:14 +00003068
Devang Patel9fc11702010-05-25 23:40:22 +00003069 // Define end label for subprogram.
3070 FunctionEndSym = Asm->GetTempSymbol("func_end",
3071 Asm->getFunctionNumber());
3072 // Assumes in correct section after the entry point.
3073 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003074
Devang Patel5c0f85c2010-06-25 22:07:34 +00003075 SmallPtrSet<const MDNode *, 16> ProcessedVars;
3076 collectVariableInfo(MF, ProcessedVars);
Devang Patel4a8e6e82010-05-22 00:04:14 +00003077
Devang Patel530a0752010-01-04 20:44:00 +00003078 // Construct abstract scopes.
3079 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel5c0f85c2010-06-25 22:07:34 +00003080 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00003081 DISubprogram SP((*AI)->getScopeNode());
3082 if (SP.Verify()) {
3083 // Collect info for variables that were optimized out.
3084 StringRef FName = SP.getLinkageName();
3085 if (FName.empty())
3086 FName = SP.getName();
Devang Patel364bf042010-11-10 22:19:21 +00003087 if (NamedMDNode *NMD =
3088 getFnSpecificMDNode(*(MF->getFunction()->getParent()), FName)) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00003089 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00003090 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel5c0f85c2010-06-25 22:07:34 +00003091 if (!DV || !ProcessedVars.insert(DV))
3092 continue;
Devang Patel648df7b2010-06-30 00:11:08 +00003093 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel5c0f85c2010-06-25 22:07:34 +00003094 if (Scope)
3095 Scope->addVariable(new DbgVariable(DV));
3096 }
3097 }
3098 }
Devang Patelc5b31092010-06-30 01:40:11 +00003099 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
3100 constructScopeDIE(*AI);
Devang Patel5c0f85c2010-06-25 22:07:34 +00003101 }
Devang Patel30265c42010-07-07 20:12:52 +00003102
Devang Patel075e9b52010-05-04 06:15:30 +00003103 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003104
Devang Patel075e9b52010-05-04 06:15:30 +00003105 if (!DisableFramePointerElim(*MF))
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003106 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel075e9b52010-05-04 06:15:30 +00003107 dwarf::DW_FORM_flag, 1);
3108
3109
Chris Lattner3a383cb2010-04-05 00:13:49 +00003110 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel530a0752010-01-04 20:44:00 +00003111 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00003112 }
3113
Bill Wendling2b128d72009-05-20 23:19:06 +00003114 // Clear debug info
Devang Patelfe189e62010-01-19 01:26:02 +00003115 CurrentFnDbgScope = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +00003116 CurrentFnArguments.clear();
Devang Patele1c53f22010-05-20 16:36:41 +00003117 DbgVariableToFrameIndexMap.clear();
3118 VarToAbstractVarMap.clear();
3119 DbgVariableToDbgInstMap.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00003120 DeleteContainerSeconds(DbgScopeMap);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00003121 UserVariables.clear();
3122 DbgValues.clear();
Devang Patelfe189e62010-01-19 01:26:02 +00003123 ConcreteScopes.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00003124 DeleteContainerSeconds(AbstractScopes);
Devang Patelfe189e62010-01-19 01:26:02 +00003125 AbstractScopesList.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00003126 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00003127 LabelsBeforeInsn.clear();
3128 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00003129 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00003130}
3131
Devang Patele1c53f22010-05-20 16:36:41 +00003132/// recordVariableFrameIndex - Record a variable's index.
3133void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
3134 assert (V && "Invalid DbgVariable!");
3135 DbgVariableToFrameIndexMap[V] = Index;
3136}
3137
3138/// findVariableFrameIndex - Return true if frame index for the variable
3139/// is found. Update FI to hold value of the index.
3140bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
3141 assert (V && "Invalid DbgVariable!");
3142 DenseMap<const DbgVariable *, int>::iterator I =
3143 DbgVariableToFrameIndexMap.find(V);
3144 if (I == DbgVariableToFrameIndexMap.end())
3145 return false;
3146 *FI = I->second;
3147 return true;
3148}
3149
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003150/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patel490c8ab2010-05-20 19:57:06 +00003151/// instruction.
3152DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
3153 DbgScope *Scope = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003154 LLVMContext &Ctx =
Devang Patel490c8ab2010-05-20 19:57:06 +00003155 MInsn->getParent()->getParent()->getFunction()->getContext();
3156 DebugLoc DL = MInsn->getDebugLoc();
3157
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003158 if (DL.isUnknown())
Devang Patel490c8ab2010-05-20 19:57:06 +00003159 return Scope;
3160
3161 if (const MDNode *IA = DL.getInlinedAt(Ctx))
3162 Scope = ConcreteScopes.lookup(IA);
3163 if (Scope == 0)
3164 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003165
Devang Patel490c8ab2010-05-20 19:57:06 +00003166 return Scope;
3167}
3168
3169
Chris Lattnerba35a672010-03-09 04:54:43 +00003170/// recordSourceLine - Register a source line with debug info. Returns the
3171/// unique label that was emitted and which provides correspondence to
3172/// the source line list.
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00003173void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S){
Devang Patel2d9caf92009-11-25 17:36:49 +00003174 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00003175 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00003176 unsigned Src = 1;
3177 if (S) {
3178 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00003179
Dan Gohman50849c62010-05-05 23:41:32 +00003180 if (Scope.isCompileUnit()) {
3181 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00003182 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00003183 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00003184 } else if (Scope.isFile()) {
3185 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00003186 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00003187 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00003188 } else if (Scope.isSubprogram()) {
3189 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00003190 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00003191 Dir = SP.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00003192 } else if (Scope.isLexicalBlock()) {
3193 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00003194 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00003195 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00003196 } else
3197 assert(0 && "Unexpected scope info");
3198
Devang Patele01b75c2011-03-24 20:30:50 +00003199 Src = GetOrCreateSourceID(Fn, Dir);
Dan Gohman50849c62010-05-05 23:41:32 +00003200 }
3201
Rafael Espindola67c6ab82010-11-18 02:04:25 +00003202 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, DWARF2_FLAG_IS_STMT,
3203 0, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00003204}
3205
Bill Wendling806535f2009-05-20 23:22:40 +00003206//===----------------------------------------------------------------------===//
3207// Emit Methods
3208//===----------------------------------------------------------------------===//
3209
Devang Patel930143b2009-11-21 02:48:08 +00003210/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling480ff322009-05-20 23:21:38 +00003211///
Jim Grosbach00e9c612009-11-22 19:20:36 +00003212unsigned
3213DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling480ff322009-05-20 23:21:38 +00003214 // Get the children.
3215 const std::vector<DIE *> &Children = Die->getChildren();
3216
3217 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00003218 if (!Last && !Children.empty())
Benjamin Kramer74729ae2010-03-31 19:34:01 +00003219 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling480ff322009-05-20 23:21:38 +00003220
3221 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00003222 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00003223
3224 // Get the abbreviation for this DIE.
3225 unsigned AbbrevNumber = Die->getAbbrevNumber();
3226 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3227
3228 // Set DIE offset
3229 Die->setOffset(Offset);
3230
3231 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00003232 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003233
3234 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
3235 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3236
3237 // Size the DIE attribute values.
3238 for (unsigned i = 0, N = Values.size(); i < N; ++i)
3239 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00003240 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00003241
3242 // Size the DIE children if any.
3243 if (!Children.empty()) {
3244 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
3245 "Children flag not set");
3246
3247 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003248 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling480ff322009-05-20 23:21:38 +00003249
3250 // End of children marker.
3251 Offset += sizeof(int8_t);
3252 }
3253
3254 Die->setSize(Offset - Die->getOffset());
3255 return Offset;
3256}
3257
Devang Patel930143b2009-11-21 02:48:08 +00003258/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling480ff322009-05-20 23:21:38 +00003259///
Devang Patel930143b2009-11-21 02:48:08 +00003260void DwarfDebug::computeSizeAndOffsets() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003261 unsigned PrevOffset = 0;
3262 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3263 E = CUMap.end(); I != E; ++I) {
3264 // Compute size of compile unit header.
3265 static unsigned Offset = PrevOffset +
3266 sizeof(int32_t) + // Length of Compilation Unit Info
3267 sizeof(int16_t) + // DWARF version number
3268 sizeof(int32_t) + // Offset Into Abbrev. Section
3269 sizeof(int8_t); // Pointer Size (in bytes)
3270 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
3271 PrevOffset = Offset;
3272 }
Bill Wendling480ff322009-05-20 23:21:38 +00003273}
3274
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003275/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3276/// temporary label to it if SymbolStem is specified.
Chris Lattner6629ca92010-04-04 22:59:04 +00003277static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003278 const char *SymbolStem = 0) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003279 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003280 if (!SymbolStem) return 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003281
Chris Lattner6629ca92010-04-04 22:59:04 +00003282 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3283 Asm->OutStreamer.EmitLabel(TmpSym);
3284 return TmpSym;
3285}
3286
3287/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3288/// the start of each one.
Chris Lattner46355d82010-04-04 22:33:59 +00003289void DwarfDebug::EmitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003290 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003291
Bill Wendling480ff322009-05-20 23:21:38 +00003292 // Dwarf sections base addresses.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003293 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003294 DwarfFrameSectionSym =
3295 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3296 }
Bill Wendling480ff322009-05-20 23:21:38 +00003297
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003298 DwarfInfoSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003299 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003300 DwarfAbbrevSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003301 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003302 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003303
Chris Lattner6629ca92010-04-04 22:59:04 +00003304 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003305 EmitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003306
Devang Patel4a213872010-08-24 00:06:12 +00003307 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003308 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3309 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3310 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003311 DwarfStrSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003312 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patel12563b32010-04-16 23:33:45 +00003313 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3314 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00003315
Devang Patel9fc11702010-05-25 23:40:22 +00003316 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3317 "section_debug_loc");
3318
Chris Lattner6629ca92010-04-04 22:59:04 +00003319 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattnere58b5472010-04-04 23:10:38 +00003320 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003321}
3322
Devang Patel930143b2009-11-21 02:48:08 +00003323/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling480ff322009-05-20 23:21:38 +00003324///
Devang Patel930143b2009-11-21 02:48:08 +00003325void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00003326 // Get the abbreviation for this DIE.
3327 unsigned AbbrevNumber = Die->getAbbrevNumber();
3328 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3329
Bill Wendling480ff322009-05-20 23:21:38 +00003330 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00003331 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00003332 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3333 Twine::utohexstr(Die->getOffset()) + ":0x" +
3334 Twine::utohexstr(Die->getSize()) + " " +
3335 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00003336 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003337
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00003338 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00003339 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3340
3341 // Emit the DIE attribute values.
3342 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3343 unsigned Attr = AbbrevData[i].getAttribute();
3344 unsigned Form = AbbrevData[i].getForm();
3345 assert(Form && "Too many attributes for DIE (check abbreviation)");
3346
Chris Lattner7bde8c02010-04-04 18:52:31 +00003347 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00003348 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003349
Bill Wendling480ff322009-05-20 23:21:38 +00003350 switch (Attr) {
3351 case dwarf::DW_AT_sibling:
Devang Patel930143b2009-11-21 02:48:08 +00003352 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003353 break;
3354 case dwarf::DW_AT_abstract_origin: {
3355 DIEEntry *E = cast<DIEEntry>(Values[i]);
3356 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003357 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00003358 Asm->EmitInt32(Addr);
3359 break;
3360 }
Devang Patel12563b32010-04-16 23:33:45 +00003361 case dwarf::DW_AT_ranges: {
3362 // DW_AT_range Value encodes offset in debug_range section.
3363 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00003364
3365 if (Asm->MAI->doesDwarfUsesLabelOffsetForRanges()) {
3366 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
3367 V->getValue(),
3368 4);
3369 } else {
3370 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3371 V->getValue(),
3372 DwarfDebugRangeSectionSym,
3373 4);
3374 }
Devang Patel12563b32010-04-16 23:33:45 +00003375 break;
3376 }
Devang Patel9fc11702010-05-25 23:40:22 +00003377 case dwarf::DW_AT_location: {
3378 if (UseDotDebugLocEntry.count(Die) != 0) {
3379 DIELabel *L = cast<DIELabel>(Values[i]);
Daniel Dunbarfd95b012011-03-16 22:16:39 +00003380 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Devang Patel9fc11702010-05-25 23:40:22 +00003381 } else
3382 Values[i]->EmitValue(Asm, Form);
3383 break;
3384 }
Devang Patela1bd5a12010-09-29 19:08:08 +00003385 case dwarf::DW_AT_accessibility: {
3386 if (Asm->isVerbose()) {
3387 DIEInteger *V = cast<DIEInteger>(Values[i]);
3388 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
3389 }
3390 Values[i]->EmitValue(Asm, Form);
3391 break;
3392 }
Bill Wendling480ff322009-05-20 23:21:38 +00003393 default:
3394 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003395 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00003396 break;
3397 }
Bill Wendling480ff322009-05-20 23:21:38 +00003398 }
3399
3400 // Emit the DIE children if any.
3401 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3402 const std::vector<DIE *> &Children = Die->getChildren();
3403
3404 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003405 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00003406
Chris Lattner7bde8c02010-04-04 18:52:31 +00003407 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00003408 Asm->OutStreamer.AddComment("End Of Children Mark");
3409 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003410 }
3411}
3412
Devang Patel9ccfb642009-12-09 18:24:21 +00003413/// emitDebugInfo - Emit the debug info section.
Bill Wendling480ff322009-05-20 23:21:38 +00003414///
Devang Patel9ccfb642009-12-09 18:24:21 +00003415void DwarfDebug::emitDebugInfo() {
3416 // Start debug info section.
3417 Asm->OutStreamer.SwitchSection(
3418 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel1a0df9a2010-05-10 22:49:55 +00003419 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3420 E = CUMap.end(); I != E; ++I) {
3421 CompileUnit *TheCU = I->second;
3422 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003423
Devang Patel1a0df9a2010-05-10 22:49:55 +00003424 // Emit the compile units header.
3425 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3426 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003427
Devang Patel1a0df9a2010-05-10 22:49:55 +00003428 // Emit size of content not including length itself
3429 unsigned ContentSize = Die->getSize() +
3430 sizeof(int16_t) + // DWARF version number
3431 sizeof(int32_t) + // Offset Into Abbrev. Section
3432 sizeof(int8_t) + // Pointer Size (in bytes)
3433 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003434
Devang Patel1a0df9a2010-05-10 22:49:55 +00003435 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3436 Asm->EmitInt32(ContentSize);
3437 Asm->OutStreamer.AddComment("DWARF version number");
3438 Asm->EmitInt16(dwarf::DWARF_VERSION);
3439 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3440 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3441 DwarfAbbrevSectionSym);
3442 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3443 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003444
Devang Patel1a0df9a2010-05-10 22:49:55 +00003445 emitDIE(Die);
3446 // FIXME - extra padding for gdb bug.
3447 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3448 Asm->EmitInt8(0);
3449 Asm->EmitInt8(0);
3450 Asm->EmitInt8(0);
3451 Asm->EmitInt8(0);
3452 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3453 }
Bill Wendling480ff322009-05-20 23:21:38 +00003454}
3455
Devang Patel930143b2009-11-21 02:48:08 +00003456/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling480ff322009-05-20 23:21:38 +00003457///
Devang Patel930143b2009-11-21 02:48:08 +00003458void DwarfDebug::emitAbbreviations() const {
Bill Wendling480ff322009-05-20 23:21:38 +00003459 // Check to see if it is worth the effort.
3460 if (!Abbreviations.empty()) {
3461 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003462 Asm->OutStreamer.SwitchSection(
3463 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003464
Chris Lattnera179b522010-04-04 19:25:43 +00003465 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003466
3467 // For each abbrevation.
3468 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3469 // Get abbreviation data
3470 const DIEAbbrev *Abbrev = Abbreviations[i];
3471
3472 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00003473 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00003474
3475 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003476 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00003477 }
3478
3479 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00003480 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00003481
Chris Lattnera179b522010-04-04 19:25:43 +00003482 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003483 }
3484}
3485
Devang Patel930143b2009-11-21 02:48:08 +00003486/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling480ff322009-05-20 23:21:38 +00003487/// the line matrix.
3488///
Devang Patel930143b2009-11-21 02:48:08 +00003489void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00003490 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00003491 Asm->OutStreamer.AddComment("Extended Op");
3492 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003493
Chris Lattner566cae92010-03-09 23:52:58 +00003494 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003495 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00003496 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3497 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3498
3499 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00003500
Chris Lattnera179b522010-04-04 19:25:43 +00003501 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003502 Asm->getTargetData().getPointerSize(),
3503 0/*AddrSpace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003504
3505 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00003506 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3507 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003508 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00003509 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003510}
3511
Devang Patel930143b2009-11-21 02:48:08 +00003512/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling480ff322009-05-20 23:21:38 +00003513///
Devang Patel930143b2009-11-21 02:48:08 +00003514void DwarfDebug::emitCommonDebugFrame() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003515 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003516 return;
3517
Chris Lattner3a383cb2010-04-05 00:13:49 +00003518 int stackGrowth = Asm->getTargetData().getPointerSize();
Anton Korobeynikov2f931282011-01-10 12:39:04 +00003519 if (Asm->TM.getFrameLowering()->getStackGrowthDirection() ==
3520 TargetFrameLowering::StackGrowsDown)
Chris Lattner3a383cb2010-04-05 00:13:49 +00003521 stackGrowth *= -1;
Bill Wendling480ff322009-05-20 23:21:38 +00003522
3523 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003524 Asm->OutStreamer.SwitchSection(
3525 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003526
Chris Lattnera179b522010-04-04 19:25:43 +00003527 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner566cae92010-03-09 23:52:58 +00003528 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003529 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3530 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003531
Chris Lattnera179b522010-04-04 19:25:43 +00003532 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner566cae92010-03-09 23:52:58 +00003533 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling480ff322009-05-20 23:21:38 +00003534 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner566cae92010-03-09 23:52:58 +00003535 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling480ff322009-05-20 23:21:38 +00003536 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner566cae92010-03-09 23:52:58 +00003537 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003538 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner9efd1182010-04-04 19:09:29 +00003539 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3540 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner566cae92010-03-09 23:52:58 +00003541 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003542 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Anton Korobeynikov2f931282011-01-10 12:39:04 +00003543 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
Bill Wendling480ff322009-05-20 23:21:38 +00003544 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling480ff322009-05-20 23:21:38 +00003545
3546 std::vector<MachineMove> Moves;
Anton Korobeynikov14ee3442010-11-18 23:25:52 +00003547 TFI->getInitialFrameState(Moves);
Bill Wendling480ff322009-05-20 23:21:38 +00003548
Chris Lattneraabc6042010-04-04 23:41:46 +00003549 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003550
Chris Lattner9e06e532010-04-28 01:05:45 +00003551 Asm->EmitAlignment(2);
Chris Lattnera179b522010-04-04 19:25:43 +00003552 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003553}
3554
Devang Patel930143b2009-11-21 02:48:08 +00003555/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling480ff322009-05-20 23:21:38 +00003556/// section.
Chris Lattner2c3f4782010-03-13 07:26:18 +00003557void DwarfDebug::
3558emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003559 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003560 return;
3561
3562 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003563 Asm->OutStreamer.SwitchSection(
3564 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003565
Chris Lattner566cae92010-03-09 23:52:58 +00003566 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner2c3f4782010-03-13 07:26:18 +00003567 MCSymbol *DebugFrameBegin =
Chris Lattnera179b522010-04-04 19:25:43 +00003568 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003569 MCSymbol *DebugFrameEnd =
Chris Lattnera179b522010-04-04 19:25:43 +00003570 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnerf1429f12010-04-04 19:58:12 +00003571 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003572
Chris Lattner2c3f4782010-03-13 07:26:18 +00003573 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling480ff322009-05-20 23:21:38 +00003574
Chris Lattner566cae92010-03-09 23:52:58 +00003575 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003576 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner70a4fce2010-04-04 23:25:33 +00003577 DwarfFrameSectionSym);
Bill Wendling480ff322009-05-20 23:21:38 +00003578
Chris Lattner566cae92010-03-09 23:52:58 +00003579 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnera179b522010-04-04 19:25:43 +00003580 MCSymbol *FuncBeginSym =
3581 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattner8811e122010-03-13 07:40:56 +00003582 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattner3a383cb2010-04-05 00:13:49 +00003583 Asm->getTargetData().getPointerSize(),
3584 0/*AddrSpace*/);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003585
3586
Chris Lattner566cae92010-03-09 23:52:58 +00003587 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003588 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003589 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003590
Chris Lattneraabc6042010-04-04 23:41:46 +00003591 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003592
Chris Lattner9e06e532010-04-28 01:05:45 +00003593 Asm->EmitAlignment(2);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003594 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling480ff322009-05-20 23:21:38 +00003595}
3596
Devang Patel9ccfb642009-12-09 18:24:21 +00003597/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3598///
3599void DwarfDebug::emitDebugPubNames() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003600 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3601 E = CUMap.end(); I != E; ++I) {
3602 CompileUnit *TheCU = I->second;
3603 // Start the dwarf pubnames section.
3604 Asm->OutStreamer.SwitchSection(
3605 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003606
Devang Patel1a0df9a2010-05-10 22:49:55 +00003607 Asm->OutStreamer.AddComment("Length of Public Names Info");
3608 Asm->EmitLabelDifference(
3609 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3610 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003611
Devang Patel1a0df9a2010-05-10 22:49:55 +00003612 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3613 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003614
Devang Patel1a0df9a2010-05-10 22:49:55 +00003615 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003616 Asm->EmitInt16(dwarf::DWARF_VERSION);
3617
Devang Patel1a0df9a2010-05-10 22:49:55 +00003618 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003619 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00003620 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003621
Devang Patel1a0df9a2010-05-10 22:49:55 +00003622 Asm->OutStreamer.AddComment("Compilation Unit Length");
3623 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3624 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3625 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003626
Devang Patel1a0df9a2010-05-10 22:49:55 +00003627 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3628 for (StringMap<DIE*>::const_iterator
3629 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3630 const char *Name = GI->getKeyData();
3631 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003632
Devang Patel1a0df9a2010-05-10 22:49:55 +00003633 Asm->OutStreamer.AddComment("DIE offset");
3634 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003635
Devang Patel1a0df9a2010-05-10 22:49:55 +00003636 if (Asm->isVerbose())
3637 Asm->OutStreamer.AddComment("External Name");
3638 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3639 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003640
Devang Patel1a0df9a2010-05-10 22:49:55 +00003641 Asm->OutStreamer.AddComment("End Mark");
3642 Asm->EmitInt32(0);
3643 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3644 TheCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00003645 }
Bill Wendling480ff322009-05-20 23:21:38 +00003646}
3647
Devang Patel04d2f2d2009-11-24 01:14:22 +00003648void DwarfDebug::emitDebugPubTypes() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003649 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3650 E = CUMap.end(); I != E; ++I) {
3651 CompileUnit *TheCU = I->second;
3652 // Start the dwarf pubnames section.
3653 Asm->OutStreamer.SwitchSection(
3654 Asm->getObjFileLowering().getDwarfPubTypesSection());
3655 Asm->OutStreamer.AddComment("Length of Public Types Info");
3656 Asm->EmitLabelDifference(
3657 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3658 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003659
Devang Patel1a0df9a2010-05-10 22:49:55 +00003660 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3661 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003662
Devang Patel1a0df9a2010-05-10 22:49:55 +00003663 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3664 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003665
Devang Patel1a0df9a2010-05-10 22:49:55 +00003666 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3667 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3668 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003669
Devang Patel1a0df9a2010-05-10 22:49:55 +00003670 Asm->OutStreamer.AddComment("Compilation Unit Length");
3671 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3672 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3673 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003674
Devang Patel1a0df9a2010-05-10 22:49:55 +00003675 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3676 for (StringMap<DIE*>::const_iterator
3677 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3678 const char *Name = GI->getKeyData();
3679 DIE * Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003680
Devang Patel1a0df9a2010-05-10 22:49:55 +00003681 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3682 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003683
Devang Patel1a0df9a2010-05-10 22:49:55 +00003684 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3685 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3686 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003687
Devang Patel1a0df9a2010-05-10 22:49:55 +00003688 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003689 Asm->EmitInt32(0);
Devang Patel1a0df9a2010-05-10 22:49:55 +00003690 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3691 TheCU->getID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00003692 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00003693}
3694
Devang Patel930143b2009-11-21 02:48:08 +00003695/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling480ff322009-05-20 23:21:38 +00003696///
Devang Patel930143b2009-11-21 02:48:08 +00003697void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00003698 // Check to see if it is worth the effort.
Chris Lattner3d72a672010-03-09 23:38:23 +00003699 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003700
Chris Lattner3d72a672010-03-09 23:38:23 +00003701 // Start the dwarf str section.
3702 Asm->OutStreamer.SwitchSection(
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003703 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003704
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003705 // Get all of the string pool entries and put them in an array by their ID so
3706 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003707 SmallVector<std::pair<unsigned,
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003708 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003709
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003710 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3711 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3712 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003713
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003714 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003715
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003716 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00003717 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003718 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003719
Chris Lattner3d72a672010-03-09 23:38:23 +00003720 // Emit the string itself.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003721 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003722 }
3723}
3724
Devang Patel930143b2009-11-21 02:48:08 +00003725/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling480ff322009-05-20 23:21:38 +00003726///
Devang Patel930143b2009-11-21 02:48:08 +00003727void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003728 if (DotDebugLocEntries.empty())
3729 return;
3730
Devang Patel116a9d72011-02-04 22:57:18 +00003731 for (SmallVector<DotDebugLocEntry, 4>::iterator
3732 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
3733 I != E; ++I) {
3734 DotDebugLocEntry &Entry = *I;
3735 if (I + 1 != DotDebugLocEntries.end())
3736 Entry.Merge(I+1);
3737 }
3738
Daniel Dunbarfd95b012011-03-16 22:16:39 +00003739 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003740 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00003741 Asm->getObjFileLowering().getDwarfLocSection());
3742 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003743 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3744 unsigned index = 1;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003745 for (SmallVector<DotDebugLocEntry, 4>::iterator
3746 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00003747 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00003748 DotDebugLocEntry &Entry = *I;
3749 if (Entry.isMerged()) continue;
Devang Patel9fc11702010-05-25 23:40:22 +00003750 if (Entry.isEmpty()) {
3751 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3752 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003753 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00003754 } else {
3755 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3756 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3757 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3758 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patel0e60e672010-08-04 18:40:52 +00003759 if (int Offset = Entry.Loc.getOffset()) {
3760 // If the value is at a certain offset from frame register then
3761 // use DW_OP_fbreg.
3762 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patel9fc11702010-05-25 23:40:22 +00003763 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patel0e60e672010-08-04 18:40:52 +00003764 Asm->EmitInt16(1 + OffsetSize);
3765 Asm->OutStreamer.AddComment(
3766 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3767 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3768 Asm->OutStreamer.AddComment("Offset");
3769 Asm->EmitSLEB128(Offset);
Devang Patel9fc11702010-05-25 23:40:22 +00003770 } else {
Devang Patel0e60e672010-08-04 18:40:52 +00003771 if (Reg < 32) {
3772 Asm->OutStreamer.AddComment("Loc expr size");
3773 Asm->EmitInt16(1);
3774 Asm->OutStreamer.AddComment(
Devang Patel6d21f612010-08-04 20:32:36 +00003775 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patel0e60e672010-08-04 18:40:52 +00003776 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3777 } else {
3778 Asm->OutStreamer.AddComment("Loc expr size");
3779 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3780 Asm->EmitInt8(dwarf::DW_OP_regx);
3781 Asm->EmitULEB128(Reg);
3782 }
Devang Patel9fc11702010-05-25 23:40:22 +00003783 }
3784 }
3785 }
Bill Wendling480ff322009-05-20 23:21:38 +00003786}
3787
3788/// EmitDebugARanges - Emit visible names into a debug aranges section.
3789///
3790void DwarfDebug::EmitDebugARanges() {
3791 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003792 Asm->OutStreamer.SwitchSection(
3793 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003794}
3795
Devang Patel930143b2009-11-21 02:48:08 +00003796/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling480ff322009-05-20 23:21:38 +00003797///
Devang Patel930143b2009-11-21 02:48:08 +00003798void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00003799 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003800 Asm->OutStreamer.SwitchSection(
Devang Patel12563b32010-04-16 23:33:45 +00003801 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Patel6c74a872010-04-27 19:46:33 +00003802 unsigned char Size = Asm->getTargetData().getPointerSize();
3803 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003804 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00003805 I != E; ++I) {
3806 if (*I)
3807 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patel12563b32010-04-16 23:33:45 +00003808 else
Devang Patel6c74a872010-04-27 19:46:33 +00003809 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel12563b32010-04-16 23:33:45 +00003810 }
Bill Wendling480ff322009-05-20 23:21:38 +00003811}
3812
Devang Patel930143b2009-11-21 02:48:08 +00003813/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling480ff322009-05-20 23:21:38 +00003814///
Devang Patel930143b2009-11-21 02:48:08 +00003815void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003816 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00003817 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00003818 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003819 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003820 }
3821}
3822
Devang Patel930143b2009-11-21 02:48:08 +00003823/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling480ff322009-05-20 23:21:38 +00003824/// Section Header:
3825/// 1. length of section
3826/// 2. Dwarf version number
3827/// 3. address size.
3828///
3829/// Entries (one "entry" for each function that was inlined):
3830///
3831/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3832/// otherwise offset into __debug_str for regular function name.
3833/// 2. offset into __debug_str section for regular function name.
3834/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3835/// instances for the function.
3836///
3837/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3838/// inlined instance; the die_offset points to the inlined_subroutine die in the
3839/// __debug_info section, and the low_pc is the starting address for the
3840/// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00003841void DwarfDebug::emitDebugInlineInfo() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003842 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003843 return;
3844
Devang Patel1a0df9a2010-05-10 22:49:55 +00003845 if (!FirstCU)
Bill Wendling480ff322009-05-20 23:21:38 +00003846 return;
3847
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003848 Asm->OutStreamer.SwitchSection(
3849 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003850
Chris Lattner566cae92010-03-09 23:52:58 +00003851 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003852 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3853 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003854
Chris Lattnera179b522010-04-04 19:25:43 +00003855 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003856
Chris Lattner566cae92010-03-09 23:52:58 +00003857 Asm->OutStreamer.AddComment("Dwarf Version");
3858 Asm->EmitInt16(dwarf::DWARF_VERSION);
3859 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003860 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003861
Devang Patel32cc43c2010-05-07 20:54:48 +00003862 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003863 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00003864
Devang Patel32cc43c2010-05-07 20:54:48 +00003865 const MDNode *Node = *I;
3866 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00003867 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003868 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00003869 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00003870 StringRef LName = SP.getLinkageName();
3871 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00003872
Chris Lattner566cae92010-03-09 23:52:58 +00003873 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003874 if (LName.empty()) {
3875 Asm->OutStreamer.EmitBytes(Name, 0);
3876 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003877 } else
Chris Lattner70a4fce2010-04-04 23:25:33 +00003878 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3879 DwarfStrSectionSym);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003880
Chris Lattner566cae92010-03-09 23:52:58 +00003881 Asm->OutStreamer.AddComment("Function name");
Chris Lattner70a4fce2010-04-04 23:25:33 +00003882 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner9efd1182010-04-04 19:09:29 +00003883 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00003884
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003885 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00003886 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner7bde8c02010-04-04 18:52:31 +00003887 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner085b6522010-03-09 00:31:02 +00003888 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003889
Chris Lattner7bde8c02010-04-04 18:52:31 +00003890 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003891 Asm->OutStreamer.EmitSymbolValue(LI->first,
3892 Asm->getTargetData().getPointerSize(),0);
Bill Wendling480ff322009-05-20 23:21:38 +00003893 }
3894 }
3895
Chris Lattnera179b522010-04-04 19:25:43 +00003896 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003897}