blob: 6af81bb67ff36c9cf2e537b4e58ea16268bc6158 [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;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000519 unsigned FileID = GetOrCreateSourceID(V.getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000520 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000521 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
522 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000523}
524
Devang Patel930143b2009-11-21 02:48:08 +0000525/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000526/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000527void DwarfDebug::addSourceLine(DIE *Die, DIGlobalVariable G) {
Devang Patel0625af22010-05-07 23:33:41 +0000528 // Verify global variable.
Devang Patelb6511a32010-08-09 20:20:05 +0000529 if (!G.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000530 return;
531
Devang Patelb6511a32010-08-09 20:20:05 +0000532 unsigned Line = G.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000533 if (Line == 0)
534 return;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000535 unsigned FileID = GetOrCreateSourceID(G.getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000536 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000537 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
538 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000539}
Devang Patelb2de5fa2009-08-31 22:47:13 +0000540
Devang Patel930143b2009-11-21 02:48:08 +0000541/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000542/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000543void DwarfDebug::addSourceLine(DIE *Die, DISubprogram SP) {
Devang Patel0625af22010-05-07 23:33:41 +0000544 // Verify subprogram.
Devang Patelb6511a32010-08-09 20:20:05 +0000545 if (!SP.Verify())
Devang Patelb2de5fa2009-08-31 22:47:13 +0000546 return;
Caroline Tice183a5192009-09-11 18:25:54 +0000547 // If the line number is 0, don't add it.
Devang Patelb6511a32010-08-09 20:20:05 +0000548 if (SP.getLineNumber() == 0)
Caroline Tice183a5192009-09-11 18:25:54 +0000549 return;
550
Devang Patelb6511a32010-08-09 20:20:05 +0000551 unsigned Line = SP.getLineNumber();
552 if (!SP.getContext().Verify())
Devang Patel8119fe872010-03-08 22:02:50 +0000553 return;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000554 unsigned FileID = GetOrCreateSourceID(SP.getFilename());
Devang Patelb2de5fa2009-08-31 22:47:13 +0000555 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000556 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
557 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patelb2de5fa2009-08-31 22:47:13 +0000558}
559
Devang Patel930143b2009-11-21 02:48:08 +0000560/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000561/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000562void DwarfDebug::addSourceLine(DIE *Die, DIType Ty) {
Devang Patel0625af22010-05-07 23:33:41 +0000563 // Verify type.
Devang Patelb6511a32010-08-09 20:20:05 +0000564 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000565 return;
566
Devang Patelb6511a32010-08-09 20:20:05 +0000567 unsigned Line = Ty.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000568 if (Line == 0 || !Ty.getContext().Verify())
Devang Patel8119fe872010-03-08 22:02:50 +0000569 return;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000570 unsigned FileID = GetOrCreateSourceID(Ty.getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000571 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000572 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
573 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000574}
575
Devang Patel1f4690c2009-12-15 19:16:48 +0000576/// addSourceLine - Add location information to specified debug information
577/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000578void DwarfDebug::addSourceLine(DIE *Die, DINameSpace NS) {
Devang Patel0625af22010-05-07 23:33:41 +0000579 // Verify namespace.
Devang Patelb6511a32010-08-09 20:20:05 +0000580 if (!NS.Verify())
Devang Patel1f4690c2009-12-15 19:16:48 +0000581 return;
582
Devang Patelb6511a32010-08-09 20:20:05 +0000583 unsigned Line = NS.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000584 if (Line == 0)
585 return;
Devang Patelb6511a32010-08-09 20:20:05 +0000586 StringRef FN = NS.getFilename();
Devang Patel1f4690c2009-12-15 19:16:48 +0000587
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000588 unsigned FileID = GetOrCreateSourceID(FN);
Devang Patel1f4690c2009-12-15 19:16:48 +0000589 assert(FileID && "Invalid file id");
590 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
591 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
592}
593
Devang Patel2cfc3af2010-08-31 06:11:28 +0000594/// addVariableAddress - Add DW_AT_location attribute for a DbgVariable based
595/// on provided frame index.
596void DwarfDebug::addVariableAddress(DbgVariable *&DV, DIE *Die, int64_t FI) {
597 MachineLocation Location;
598 unsigned FrameReg;
Anton Korobeynikov2f931282011-01-10 12:39:04 +0000599 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
Anton Korobeynikov46877782010-11-20 15:59:32 +0000600 int Offset = TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
Devang Patel2cfc3af2010-08-31 06:11:28 +0000601 Location.set(FrameReg, Offset);
602
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000603 if (DV->variableHasComplexAddress())
604 addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
605 else if (DV->isBlockByrefVariable())
606 addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
607 else
608 addAddress(Die, dwarf::DW_AT_location, Location);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000609}
610
Devang Patel930143b2009-11-21 02:48:08 +0000611/// addComplexAddress - Start with the address based on the location provided,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000612/// and generate the DWARF information necessary to find the actual variable
613/// given the extra address information encoded in the DIVariable, starting from
614/// the starting location. Add the DWARF information to the die.
615///
Devang Patel930143b2009-11-21 02:48:08 +0000616void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000617 unsigned Attribute,
618 const MachineLocation &Location) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000619 DIType Ty = DV->getType();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000620
621 // Decode the original location, and use that as the start of the byref
622 // variable's location.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000623 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000624 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000625 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000626
627 if (Location.isReg()) {
628 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000629 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000630 } else {
Devang Patel8698f092011-01-19 23:04:47 +0000631 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
Devang Patel930143b2009-11-21 02:48:08 +0000632 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000633 }
634 } else {
635 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000636 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000637 else {
Devang Patel930143b2009-11-21 02:48:08 +0000638 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
639 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000640 }
641
Devang Patel930143b2009-11-21 02:48:08 +0000642 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump14cf8ec2009-09-30 00:08:22 +0000643 }
644
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000645 for (unsigned i = 0, N = DV->getNumAddrElements(); i < N; ++i) {
646 uint64_t Element = DV->getAddrElement(i);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000647
Devang Patela5d93242011-02-24 18:49:30 +0000648 if (Element == DIBuilder::OpPlus) {
Devang Patel930143b2009-11-21 02:48:08 +0000649 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000650 addUInt(Block, 0, dwarf::DW_FORM_udata, DV->getAddrElement(++i));
Devang Patela5d93242011-02-24 18:49:30 +0000651 } else if (Element == DIBuilder::OpDeref) {
Devang Patel930143b2009-11-21 02:48:08 +0000652 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Devang Patela5d93242011-02-24 18:49:30 +0000653 } else llvm_unreachable("unknown DIBuilder Opcode");
Mike Stump14cf8ec2009-09-30 00:08:22 +0000654 }
655
656 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000657 addBlock(Die, Attribute, 0, Block);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000658}
659
Caroline Ticec87c1e22009-08-31 21:19:37 +0000660/* Byref variables, in Blocks, are declared by the programmer as "SomeType
661 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
662 gives the variable VarName either the struct, or a pointer to the struct, as
663 its type. This is necessary for various behind-the-scenes things the
664 compiler needs to do with by-reference variables in Blocks.
665
666 However, as far as the original *programmer* is concerned, the variable
667 should still have type 'SomeType', as originally declared.
668
Devang Patel930143b2009-11-21 02:48:08 +0000669 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticec87c1e22009-08-31 21:19:37 +0000670 struct to find the original type of the variable, which is then assigned to
671 the variable's Debug Information Entry as its real type. So far, so good.
672 However now the debugger will expect the variable VarName to have the type
673 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000674 expression that explains to the debugger how to navigate through the
Caroline Ticec87c1e22009-08-31 21:19:37 +0000675 pointers and struct to find the actual variable of type SomeType.
676
677 The following function does just that. We start by getting
678 the "normal" location for the variable. This will be the location
679 of either the struct __Block_byref_x_VarName or the pointer to the
680 struct __Block_byref_x_VarName.
681
682 The struct will look something like:
683
684 struct __Block_byref_x_VarName {
685 ... <various fields>
686 struct __Block_byref_x_VarName *forwarding;
687 ... <various other fields>
688 SomeType VarName;
689 ... <maybe more fields>
690 };
691
692 If we are given the struct directly (as our starting point) we
693 need to tell the debugger to:
694
695 1). Add the offset of the forwarding field.
696
Dan Gohman4a618822010-02-10 16:03:48 +0000697 2). Follow that pointer to get the real __Block_byref_x_VarName
Caroline Ticec87c1e22009-08-31 21:19:37 +0000698 struct to use (the real one may have been copied onto the heap).
699
700 3). Add the offset for the field VarName, to find the actual variable.
701
702 If we started with a pointer to the struct, then we need to
703 dereference that pointer first, before the other steps.
704 Translating this into DWARF ops, we will need to append the following
705 to the current location description for the variable:
706
707 DW_OP_deref -- optional, if we start with a pointer
708 DW_OP_plus_uconst <forward_fld_offset>
709 DW_OP_deref
710 DW_OP_plus_uconst <varName_fld_offset>
711
712 That is what this function does. */
713
Devang Patel930143b2009-11-21 02:48:08 +0000714/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticec87c1e22009-08-31 21:19:37 +0000715/// provided, and generate the DWARF information necessary to find the
716/// actual Block variable (navigating the Block struct) based on the
717/// starting location. Add the DWARF information to the die. For
718/// more information, read large comment just above here.
719///
Devang Patel930143b2009-11-21 02:48:08 +0000720void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000721 unsigned Attribute,
722 const MachineLocation &Location) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000723 DIType Ty = DV->getType();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000724 DIType TmpTy = Ty;
725 unsigned Tag = Ty.getTag();
726 bool isPointer = false;
727
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000728 StringRef varName = DV->getName();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000729
730 if (Tag == dwarf::DW_TAG_pointer_type) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000731 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000732 TmpTy = DTy.getTypeDerivedFrom();
733 isPointer = true;
734 }
735
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000736 DICompositeType blockStruct = DICompositeType(TmpTy);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000737
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000738 // Find the __forwarding field and the variable field in the __Block_byref
739 // struct.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000740 DIArray Fields = blockStruct.getTypeArray();
741 DIDescriptor varField = DIDescriptor();
742 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000743
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000744 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
745 DIDescriptor Element = Fields.getElement(i);
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000746 DIDerivedType DT = DIDerivedType(Element);
Devang Patel2d9caf92009-11-25 17:36:49 +0000747 StringRef fieldName = DT.getName();
748 if (fieldName == "__forwarding")
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000749 forwardingField = Element;
Devang Patel2d9caf92009-11-25 17:36:49 +0000750 else if (fieldName == varName)
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000751 varField = Element;
752 }
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000753
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000754 // Get the offsets for the forwarding field and the variable field.
Chris Lattner71696ef2010-03-31 06:06:37 +0000755 unsigned forwardingFieldOffset =
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000756 DIDerivedType(forwardingField).getOffsetInBits() >> 3;
Chris Lattner71696ef2010-03-31 06:06:37 +0000757 unsigned varFieldOffset =
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000758 DIDerivedType(varField).getOffsetInBits() >> 3;
Caroline Ticec87c1e22009-08-31 21:19:37 +0000759
Mike Stump944fa252009-09-24 23:21:26 +0000760 // Decode the original location, and use that as the start of the byref
761 // variable's location.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000762 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000763 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000764 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000765
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000766 if (Location.isReg()) {
767 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000768 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000769 else {
Devang Patel8698f092011-01-19 23:04:47 +0000770 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
Devang Patel930143b2009-11-21 02:48:08 +0000771 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000772 }
773 } else {
774 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000775 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000776 else {
Devang Patel930143b2009-11-21 02:48:08 +0000777 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
778 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000779 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000780
Devang Patel930143b2009-11-21 02:48:08 +0000781 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000782 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000783
Mike Stump944fa252009-09-24 23:21:26 +0000784 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000785 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000786 if (isPointer)
Devang Patel930143b2009-11-21 02:48:08 +0000787 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000788
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000789 // Next add the offset for the '__forwarding' field:
790 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
791 // adding the offset if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000792 if (forwardingFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000793 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
794 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000795 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000796
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000797 // Now dereference the __forwarding field to get to the real __Block_byref
798 // struct: DW_OP_deref.
Devang Patel930143b2009-11-21 02:48:08 +0000799 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000800
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000801 // Now that we've got the real __Block_byref... struct, add the offset
802 // for the variable's field to get to the location of the actual variable:
803 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000804 if (varFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000805 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
806 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000807 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000808
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000809 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000810 addBlock(Die, Attribute, 0, Block);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000811}
812
Devang Patel930143b2009-11-21 02:48:08 +0000813/// addAddress - Add an address attribute to a die based on the location
Bill Wendling2f921f82009-05-15 09:23:25 +0000814/// provided.
Devang Patel930143b2009-11-21 02:48:08 +0000815void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000816 const MachineLocation &Location) {
Chris Lattner3a383cb2010-04-05 00:13:49 +0000817 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling2f921f82009-05-15 09:23:25 +0000818 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000819 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel804fcd42010-09-22 21:10:38 +0000820
Devang Patele7559662010-11-02 17:37:00 +0000821 if (RI->getFrameRegister(*Asm->MF) == Location.getReg()
Devang Patel804fcd42010-09-22 21:10:38 +0000822 && Location.getOffset()) {
823 // If variable offset is based in frame register then use fbreg.
824 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
825 addSInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
826 addBlock(Die, Attribute, 0, Block);
827 return;
828 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000829
830 if (Location.isReg()) {
831 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000832 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000833 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000834 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
835 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000836 }
837 } else {
838 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000839 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000840 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000841 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
842 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000843 }
844
Devang Patel930143b2009-11-21 02:48:08 +0000845 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling2f921f82009-05-15 09:23:25 +0000846 }
847
Devang Patel930143b2009-11-21 02:48:08 +0000848 addBlock(Die, Attribute, 0, Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000849}
850
Devang Patel173b2b92010-04-28 01:03:09 +0000851/// addRegisterAddress - Add register location entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000852bool DwarfDebug::addRegisterAddress(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000853 assert (MO.isReg() && "Invalid machine operand!");
854 if (!MO.getReg())
855 return false;
856 MachineLocation Location;
857 Location.set(MO.getReg());
858 addAddress(Die, dwarf::DW_AT_location, Location);
Devang Patel173b2b92010-04-28 01:03:09 +0000859 return true;
860}
861
862/// addConstantValue - Add constant value entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000863bool DwarfDebug::addConstantValue(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000864 assert (MO.isImm() && "Invalid machine operand!");
865 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
866 unsigned Imm = MO.getImm();
867 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
868 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patel173b2b92010-04-28 01:03:09 +0000869 return true;
870}
871
872/// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000873bool DwarfDebug::addConstantFPValue(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000874 assert (MO.isFPImm() && "Invalid machine operand!");
875 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
876 APFloat FPImm = MO.getFPImm()->getValueAPF();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000877
Devang Patel173b2b92010-04-28 01:03:09 +0000878 // Get the raw data form of the floating point.
879 const APInt FltVal = FPImm.bitcastToAPInt();
880 const char *FltPtr = (const char*)FltVal.getRawData();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000881
Devang Patel173b2b92010-04-28 01:03:09 +0000882 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
883 bool LittleEndian = Asm->getTargetData().isLittleEndian();
884 int Incr = (LittleEndian ? 1 : -1);
885 int Start = (LittleEndian ? 0 : NumBytes - 1);
886 int Stop = (LittleEndian ? NumBytes : -1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000887
Devang Patel173b2b92010-04-28 01:03:09 +0000888 // Output the constant to DWARF one byte at a time.
889 for (; Start != Stop; Start += Incr)
890 addUInt(Block, 0, dwarf::DW_FORM_data1,
891 (unsigned char)0xFF & FltPtr[Start]);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000892
Devang Patel173b2b92010-04-28 01:03:09 +0000893 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000894 return true;
Devang Patel173b2b92010-04-28 01:03:09 +0000895}
896
Devang Patel70eb9822011-01-06 21:39:25 +0000897/// addConstantValue - Add constant value entry in variable DIE.
898bool DwarfDebug::addConstantValue(DIE *Die, ConstantInt *CI,
899 bool Unsigned) {
900 if (CI->getBitWidth() <= 64) {
901 if (Unsigned)
902 addUInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
903 CI->getZExtValue());
904 else
905 addSInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
906 CI->getSExtValue());
907 return true;
908 }
909
910 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
911
912 // Get the raw data form of the large APInt.
913 const APInt Val = CI->getValue();
914 const char *Ptr = (const char*)Val.getRawData();
915
916 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
917 bool LittleEndian = Asm->getTargetData().isLittleEndian();
918 int Incr = (LittleEndian ? 1 : -1);
919 int Start = (LittleEndian ? 0 : NumBytes - 1);
920 int Stop = (LittleEndian ? NumBytes : -1);
921
922 // Output the constant to DWARF one byte at a time.
923 for (; Start != Stop; Start += Incr)
924 addUInt(Block, 0, dwarf::DW_FORM_data1,
925 (unsigned char)0xFF & Ptr[Start]);
926
927 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
928 return true;
929}
Devang Patel173b2b92010-04-28 01:03:09 +0000930
Devang Patel2b75ed22009-12-10 19:14:49 +0000931/// addToContextOwner - Add Die into the list of its context owner's children.
932void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000933 if (Context.isType()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000934 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
Devang Patel2b75ed22009-12-10 19:14:49 +0000935 ContextDIE->addChild(Die);
Devang Patel1f4690c2009-12-15 19:16:48 +0000936 } else if (Context.isNameSpace()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000937 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
Devang Patel1f4690c2009-12-15 19:16:48 +0000938 ContextDIE->addChild(Die);
Stuart Hastingsafe54f12010-06-11 20:08:44 +0000939 } else if (Context.isSubprogram()) {
Devang Patel185051c2010-09-27 23:15:27 +0000940 DIE *ContextDIE = createSubprogramDIE(DISubprogram(Context));
Stuart Hastingsafe54f12010-06-11 20:08:44 +0000941 ContextDIE->addChild(Die);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000942 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patel2b75ed22009-12-10 19:14:49 +0000943 ContextDIE->addChild(Die);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000944 else
Devang Patel1a0df9a2010-05-10 22:49:55 +0000945 getCompileUnit(Context)->addDie(Die);
Devang Patel2b75ed22009-12-10 19:14:49 +0000946}
947
Devang Patelb5b60ea2009-12-10 18:05:33 +0000948/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
949/// given DIType.
950DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000951 CompileUnit *TypeCU = getCompileUnit(Ty);
952 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000953 if (TyDIE)
954 return TyDIE;
955
956 // Create new type.
957 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000958 TypeCU->insertDIE(Ty, TyDIE);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000959 if (Ty.isBasicType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000960 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000961 else if (Ty.isCompositeType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000962 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000963 else {
964 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000965 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000966 }
967
Devang Patel2b75ed22009-12-10 19:14:49 +0000968 addToContextOwner(TyDIE, Ty.getContext());
Devang Patelb5b60ea2009-12-10 18:05:33 +0000969 return TyDIE;
970}
971
Devang Patel930143b2009-11-21 02:48:08 +0000972/// addType - Add a new type attribute to the specified entity.
Devang Patel9ccfb642009-12-09 18:24:21 +0000973void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel8d6a2b72010-05-07 21:45:47 +0000974 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000975 return;
976
977 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000978 CompileUnit *TypeCU = getCompileUnit(Ty);
979 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000980 // If it exists then use the existing value.
Devang Patel930143b2009-11-21 02:48:08 +0000981 if (Entry) {
982 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000983 return;
984 }
985
Bill Wendling2f921f82009-05-15 09:23:25 +0000986 // Construct type.
Devang Patelb5b60ea2009-12-10 18:05:33 +0000987 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000988
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000989 // Set up proxy.
990 Entry = createDIEEntry(Buffer);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000991 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000992
Devang Patel930143b2009-11-21 02:48:08 +0000993 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000994}
995
Devang Patel930143b2009-11-21 02:48:08 +0000996/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000997void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000998 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000999 StringRef Name = BTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001000 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +00001001 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling2f921f82009-05-15 09:23:25 +00001002 BTy.getEncoding());
1003
1004 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +00001005 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001006 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001007 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel930143b2009-11-21 02:48:08 +00001008 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001009}
1010
Devang Patel930143b2009-11-21 02:48:08 +00001011/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001012void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001013 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +00001014 StringRef Name = DTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001015 uint64_t Size = DTy.getSizeInBits() >> 3;
1016 unsigned Tag = DTy.getTag();
1017
1018 // FIXME - Workaround for templates.
1019 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
1020
1021 Buffer.setTag(Tag);
1022
1023 // Map to main type, void will not have a type.
1024 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel9ccfb642009-12-09 18:24:21 +00001025 addType(&Buffer, FromTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001026
1027 // Add name if not anonymous or intermediate type.
Devang Patelae466ef2009-11-30 23:56:56 +00001028 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001029 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001030
1031 // Add size if non-zero (derived types might be zero-sized.)
1032 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +00001033 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001034
1035 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patelb5b51592009-11-23 18:43:37 +00001036 if (!DTy.isForwardDecl())
Devang Patelb6511a32010-08-09 20:20:05 +00001037 addSourceLine(&Buffer, DTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001038}
1039
Devang Patel930143b2009-11-21 02:48:08 +00001040/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001041void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001042 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +00001043 StringRef Name = CTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001044
1045 uint64_t Size = CTy.getSizeInBits() >> 3;
1046 unsigned Tag = CTy.getTag();
1047 Buffer.setTag(Tag);
1048
1049 switch (Tag) {
1050 case dwarf::DW_TAG_vector_type:
1051 case dwarf::DW_TAG_array_type:
Devang Patel9ccfb642009-12-09 18:24:21 +00001052 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001053 break;
1054 case dwarf::DW_TAG_enumeration_type: {
1055 DIArray Elements = CTy.getTypeArray();
1056
1057 // Add enumerators to enumeration type.
1058 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1059 DIE *ElemDie = NULL;
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001060 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3b548aa2010-03-08 20:52:55 +00001061 if (Enum.isEnumerator()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001062 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel930143b2009-11-21 02:48:08 +00001063 Buffer.addChild(ElemDie);
Devang Patelfafa1fe2009-10-09 17:51:49 +00001064 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001065 }
1066 }
1067 break;
1068 case dwarf::DW_TAG_subroutine_type: {
1069 // Add return type.
1070 DIArray Elements = CTy.getTypeArray();
1071 DIDescriptor RTy = Elements.getElement(0);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001072 addType(&Buffer, DIType(RTy));
Bill Wendling2f921f82009-05-15 09:23:25 +00001073
Devang Patel9a33ec22010-10-06 20:50:40 +00001074 bool isPrototyped = true;
Bill Wendling2f921f82009-05-15 09:23:25 +00001075 // Add arguments.
1076 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001077 DIDescriptor Ty = Elements.getElement(i);
Devang Patel9a33ec22010-10-06 20:50:40 +00001078 if (Ty.isUnspecifiedParameter()) {
1079 DIE *Arg = new DIE(dwarf::DW_TAG_unspecified_parameters);
1080 Buffer.addChild(Arg);
1081 isPrototyped = false;
1082 } else {
1083 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1084 addType(Arg, DIType(Ty));
1085 Buffer.addChild(Arg);
1086 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001087 }
Devang Patel9a33ec22010-10-06 20:50:40 +00001088 // Add prototype flag.
1089 if (isPrototyped)
1090 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001091 }
1092 break;
1093 case dwarf::DW_TAG_structure_type:
1094 case dwarf::DW_TAG_union_type:
1095 case dwarf::DW_TAG_class_type: {
1096 // Add elements to structure type.
1097 DIArray Elements = CTy.getTypeArray();
1098
1099 // A forward struct declared type may not have elements available.
Devang Patel3b548aa2010-03-08 20:52:55 +00001100 unsigned N = Elements.getNumElements();
1101 if (N == 0)
Bill Wendling2f921f82009-05-15 09:23:25 +00001102 break;
1103
1104 // Add elements to structure type.
Devang Patel3b548aa2010-03-08 20:52:55 +00001105 for (unsigned i = 0; i < N; ++i) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001106 DIDescriptor Element = Elements.getElement(i);
1107 DIE *ElemDie = NULL;
Devang Patelcb03b142010-09-29 21:44:16 +00001108 if (Element.isSubprogram()) {
1109 DISubprogram SP(Element);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001110 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patelcb03b142010-09-29 21:44:16 +00001111 if (SP.isProtected())
1112 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1113 dwarf::DW_ACCESS_protected);
1114 else if (SP.isPrivate())
1115 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1116 dwarf::DW_ACCESS_private);
1117 else
1118 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1119 dwarf::DW_ACCESS_public);
Devang Patele1c71462010-10-01 23:31:40 +00001120 if (SP.isExplicit())
1121 addUInt(ElemDie, dwarf::DW_AT_explicit, dwarf::DW_FORM_flag, 1);
Devang Patelcb03b142010-09-29 21:44:16 +00001122 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001123 else if (Element.isVariable()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001124 DIVariable DV(Element);
Devang Patel160c92d2010-01-30 01:08:30 +00001125 ElemDie = new DIE(dwarf::DW_TAG_variable);
1126 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1127 DV.getName());
1128 addType(ElemDie, DV.getType());
1129 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1130 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patelb6511a32010-08-09 20:20:05 +00001131 addSourceLine(ElemDie, DV);
Devang Patel3b548aa2010-03-08 20:52:55 +00001132 } else if (Element.isDerivedType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001133 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3b548aa2010-03-08 20:52:55 +00001134 else
1135 continue;
Devang Patel930143b2009-11-21 02:48:08 +00001136 Buffer.addChild(ElemDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001137 }
1138
Devang Patel3082c012009-08-27 23:51:51 +00001139 if (CTy.isAppleBlockExtension())
Devang Patel930143b2009-11-21 02:48:08 +00001140 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001141
1142 unsigned RLang = CTy.getRunTimeLang();
1143 if (RLang)
Devang Patel930143b2009-11-21 02:48:08 +00001144 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling2f921f82009-05-15 09:23:25 +00001145 dwarf::DW_FORM_data1, RLang);
Devang Patel303a1be2010-01-26 21:16:06 +00001146
1147 DICompositeType ContainingType = CTy.getContainingType();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001148 if (DIDescriptor(ContainingType).isCompositeType())
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001149 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001150 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001151 else {
1152 DIDescriptor Context = CTy.getContext();
1153 addToContextOwner(&Buffer, Context);
1154 }
Devang Patel3a9e65e2011-02-02 21:38:25 +00001155
1156 if (Tag == dwarf::DW_TAG_class_type) {
1157 DIArray TParams = CTy.getTemplateParams();
1158 unsigned N = TParams.getNumElements();
1159 // Add template parameters.
1160 for (unsigned i = 0; i < N; ++i) {
1161 DIDescriptor Element = TParams.getElement(i);
1162 if (Element.isTemplateTypeParameter())
1163 Buffer.addChild(getOrCreateTemplateTypeParameterDIE(
1164 DITemplateTypeParameter(Element)));
Devang Patelbe933b42011-02-02 22:35:53 +00001165 else if (Element.isTemplateValueParameter())
1166 Buffer.addChild(getOrCreateTemplateValueParameterDIE(
1167 DITemplateValueParameter(Element)));
Devang Patel3a9e65e2011-02-02 21:38:25 +00001168 }
1169 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001170 break;
1171 }
1172 default:
1173 break;
1174 }
1175
1176 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +00001177 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001178 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001179
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001180 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
Devang Patel30265c42010-07-07 20:12:52 +00001181 || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1182 {
Bill Wendling2f921f82009-05-15 09:23:25 +00001183 // Add size if non-zero (derived types might be zero-sized.)
1184 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +00001185 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001186 else {
1187 // Add zero size if it is not a forward declaration.
1188 if (CTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +00001189 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001190 else
Devang Patel930143b2009-11-21 02:48:08 +00001191 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling2f921f82009-05-15 09:23:25 +00001192 }
1193
1194 // Add source line info if available.
1195 if (!CTy.isForwardDecl())
Devang Patelb6511a32010-08-09 20:20:05 +00001196 addSourceLine(&Buffer, CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001197 }
1198}
1199
Devang Patel3a9e65e2011-02-02 21:38:25 +00001200/// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
1201/// for the given DITemplateTypeParameter.
1202DIE *
1203DwarfDebug::getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP) {
1204 CompileUnit *TypeCU = getCompileUnit(TP);
1205 DIE *ParamDIE = TypeCU->getDIE(TP);
1206 if (ParamDIE)
1207 return ParamDIE;
1208
1209 ParamDIE = new DIE(dwarf::DW_TAG_template_type_parameter);
1210 addType(ParamDIE, TP.getType());
1211 addString(ParamDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string, TP.getName());
1212 return ParamDIE;
1213}
1214
Devang Patelbe933b42011-02-02 22:35:53 +00001215/// getOrCreateTemplateValueParameterDIE - Find existing DIE or create new DIE
1216/// for the given DITemplateValueParameter.
1217DIE *
1218DwarfDebug::getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TPV) {
1219 CompileUnit *TVCU = getCompileUnit(TPV);
1220 DIE *ParamDIE = TVCU->getDIE(TPV);
1221 if (ParamDIE)
1222 return ParamDIE;
1223
1224 ParamDIE = new DIE(dwarf::DW_TAG_template_value_parameter);
1225 addType(ParamDIE, TPV.getType());
1226 addString(ParamDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string, TPV.getName());
1227 addUInt(ParamDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
1228 TPV.getValue());
1229 return ParamDIE;
1230}
1231
Devang Patel930143b2009-11-21 02:48:08 +00001232/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1233void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling2f921f82009-05-15 09:23:25 +00001234 int64_t L = SR.getLo();
1235 int64_t H = SR.getHi();
1236 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1237
Devang Patel930143b2009-11-21 02:48:08 +00001238 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patelf691df32009-08-14 20:59:16 +00001239 if (L)
Devang Patel930143b2009-11-21 02:48:08 +00001240 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Patel8f046022009-12-04 23:10:24 +00001241 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling2f921f82009-05-15 09:23:25 +00001242
Devang Patel930143b2009-11-21 02:48:08 +00001243 Buffer.addChild(DW_Subrange);
Bill Wendling2f921f82009-05-15 09:23:25 +00001244}
1245
Devang Patel930143b2009-11-21 02:48:08 +00001246/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001247void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling2f921f82009-05-15 09:23:25 +00001248 DICompositeType *CTy) {
1249 Buffer.setTag(dwarf::DW_TAG_array_type);
1250 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel930143b2009-11-21 02:48:08 +00001251 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001252
1253 // Emit derived type.
Devang Patel9ccfb642009-12-09 18:24:21 +00001254 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001255 DIArray Elements = CTy->getTypeArray();
1256
Devang Patel92e8c652009-11-21 00:31:03 +00001257 // Get an anonymous type for index type.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001258 CompileUnit *TheCU = getCompileUnit(*CTy);
1259 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel92e8c652009-11-21 00:31:03 +00001260 if (!IdxTy) {
1261 // Construct an anonymous type for index type.
1262 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +00001263 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1264 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel92e8c652009-11-21 00:31:03 +00001265 dwarf::DW_ATE_signed);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001266 TheCU->addDie(IdxTy);
1267 TheCU->setIndexTyDie(IdxTy);
Devang Patel92e8c652009-11-21 00:31:03 +00001268 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001269
1270 // Add subranges to array type.
1271 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1272 DIDescriptor Element = Elements.getElement(i);
1273 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001274 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001275 }
1276}
1277
Devang Patel930143b2009-11-21 02:48:08 +00001278/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3b548aa2010-03-08 20:52:55 +00001279DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001280 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3b548aa2010-03-08 20:52:55 +00001281 StringRef Name = ETy.getName();
Devang Patel930143b2009-11-21 02:48:08 +00001282 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3b548aa2010-03-08 20:52:55 +00001283 int64_t Value = ETy.getEnumValue();
Devang Patel930143b2009-11-21 02:48:08 +00001284 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +00001285 return Enumerator;
1286}
1287
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001288/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel43ef34d2010-01-05 01:46:14 +00001289/// printer to not emit usual symbol prefix before the symbol name is used then
1290/// return linkage name after skipping this special LLVM prefix.
1291static StringRef getRealLinkageName(StringRef LinkageName) {
1292 char One = '\1';
1293 if (LinkageName.startswith(StringRef(&One, 1)))
1294 return LinkageName.substr(1);
1295 return LinkageName;
1296}
1297
Devang Patel930143b2009-11-21 02:48:08 +00001298/// createMemberDIE - Create new member DIE.
Devang Patel18ba0b42010-08-10 04:12:17 +00001299DIE *DwarfDebug::createMemberDIE(DIDerivedType DT) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001300 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel2d9caf92009-11-25 17:36:49 +00001301 StringRef Name = DT.getName();
1302 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001303 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001304
Devang Patel9ccfb642009-12-09 18:24:21 +00001305 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001306
Devang Patelb6511a32010-08-09 20:20:05 +00001307 addSourceLine(MemberDie, DT);
Bill Wendling2f921f82009-05-15 09:23:25 +00001308
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001309 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel930143b2009-11-21 02:48:08 +00001310 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel67f56f02009-11-04 22:06:12 +00001311
Bill Wendling2f921f82009-05-15 09:23:25 +00001312 uint64_t Size = DT.getSizeInBits();
Devang Patelf05d5722009-11-04 23:48:00 +00001313 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling2f921f82009-05-15 09:23:25 +00001314
1315 if (Size != FieldSize) {
1316 // Handle bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001317 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1318 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling2f921f82009-05-15 09:23:25 +00001319
1320 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling2f921f82009-05-15 09:23:25 +00001321 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1322 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer2b459982010-01-07 17:50:57 +00001323 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling2f921f82009-05-15 09:23:25 +00001324 Offset -= FieldOffset;
1325
1326 // Maybe we need to work from the other end.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001327 if (Asm->getTargetData().isLittleEndian())
1328 Offset = FieldSize - (Offset + Size);
Devang Patel930143b2009-11-21 02:48:08 +00001329 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling2f921f82009-05-15 09:23:25 +00001330
Devang Patel67f56f02009-11-04 22:06:12 +00001331 // Here WD_AT_data_member_location points to the anonymous
1332 // field that includes this bit field.
Devang Patel930143b2009-11-21 02:48:08 +00001333 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001334
1335 } else
1336 // This is not a bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001337 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001338
Devang Pateld2316892010-02-03 20:08:48 +00001339 if (DT.getTag() == dwarf::DW_TAG_inheritance
1340 && DT.isVirtual()) {
1341
1342 // For C++, virtual base classes are not at fixed offset. Use following
1343 // expression to extract appropriate offset from vtable.
1344 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1345
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001346 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Pateld2316892010-02-03 20:08:48 +00001347 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1348 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1349 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1350 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1351 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1352 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1353 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1354
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001355 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
Devang Pateld2316892010-02-03 20:08:48 +00001356 VBaseLocationDie);
1357 } else
1358 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001359
1360 if (DT.isProtected())
Devang Pateleb57c592009-12-03 19:11:07 +00001361 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001362 dwarf::DW_ACCESS_protected);
1363 else if (DT.isPrivate())
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_private);
Devang Patela1bd5a12010-09-29 19:08:08 +00001366 // Otherwise C++ member and base classes are considered public.
1367 else if (DT.getCompileUnit().getLanguage() == dwarf::DW_LANG_C_plus_plus)
Devang Pateleb57c592009-12-03 19:11:07 +00001368 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1369 dwarf::DW_ACCESS_public);
1370 if (DT.isVirtual())
1371 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1372 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling2f921f82009-05-15 09:23:25 +00001373 return MemberDie;
1374}
1375
Devang Patel525dda02009-12-14 16:18:45 +00001376/// createSubprogramDIE - Create new DIE using SP.
Devang Patel185051c2010-09-27 23:15:27 +00001377DIE *DwarfDebug::createSubprogramDIE(DISubprogram SP) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001378 CompileUnit *SPCU = getCompileUnit(SP);
1379 DIE *SPDie = SPCU->getDIE(SP);
Devang Patel525dda02009-12-14 16:18:45 +00001380 if (SPDie)
1381 return SPDie;
1382
1383 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf200b392010-03-02 17:58:15 +00001384 // Constructors and operators for anonymous aggregates do not have names.
Devang Pateld0fa3042010-03-02 01:26:20 +00001385 if (!SP.getName().empty())
1386 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling2f921f82009-05-15 09:23:25 +00001387
Devang Patel2d9caf92009-11-25 17:36:49 +00001388 StringRef LinkageName = SP.getLinkageName();
Devang Patel43ef34d2010-01-05 01:46:14 +00001389 if (!LinkageName.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001390 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel43ef34d2010-01-05 01:46:14 +00001391 getRealLinkageName(LinkageName));
1392
Devang Patelb6511a32010-08-09 20:20:05 +00001393 addSourceLine(SPDie, SP);
Bill Wendling2f921f82009-05-15 09:23:25 +00001394
Devang Patel3a24f922010-10-07 22:03:01 +00001395 if (SP.isPrototyped())
Devang Patel930143b2009-11-21 02:48:08 +00001396 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001397
1398 // Add Return Type.
Devang Patel236526d2009-12-03 01:25:38 +00001399 DICompositeType SPTy = SP.getType();
1400 DIArray Args = SPTy.getTypeArray();
Bill Wendling2f921f82009-05-15 09:23:25 +00001401 unsigned SPTag = SPTy.getTag();
Devang Pateleb57c592009-12-03 19:11:07 +00001402
Devang Patel3b548aa2010-03-08 20:52:55 +00001403 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel9ccfb642009-12-09 18:24:21 +00001404 addType(SPDie, SPTy);
Devang Patel236526d2009-12-03 01:25:38 +00001405 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001406 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel236526d2009-12-03 01:25:38 +00001407
Devang Pateleb57c592009-12-03 19:11:07 +00001408 unsigned VK = SP.getVirtuality();
1409 if (VK) {
1410 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001411 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Pateleb57c592009-12-03 19:11:07 +00001412 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
Devang Patelc26da902010-12-09 00:10:40 +00001413 addUInt(Block, 0, dwarf::DW_FORM_udata, SP.getVirtualIndex());
Devang Pateleb57c592009-12-03 19:11:07 +00001414 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001415 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001416 SP.getContainingType()));
Devang Pateleb57c592009-12-03 19:11:07 +00001417 }
1418
Devang Patel185051c2010-09-27 23:15:27 +00001419 if (!SP.isDefinition()) {
Devang Patel930143b2009-11-21 02:48:08 +00001420 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001421
1422 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel236526d2009-12-03 01:25:38 +00001423 // be handled while processing variables.
1424 DICompositeType SPTy = SP.getType();
1425 DIArray Args = SPTy.getTypeArray();
1426 unsigned SPTag = SPTy.getTag();
1427
Bill Wendling2f921f82009-05-15 09:23:25 +00001428 if (SPTag == dwarf::DW_TAG_subroutine_type)
1429 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1430 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001431 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patel6efc8e52010-02-06 01:02:37 +00001432 addType(Arg, ATy);
1433 if (ATy.isArtificial())
1434 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel930143b2009-11-21 02:48:08 +00001435 SPDie->addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +00001436 }
1437 }
1438
Devang Patel999b4992010-02-03 19:57:19 +00001439 if (SP.isArtificial())
1440 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1441
Devang Patelb4e3b902010-04-30 19:38:23 +00001442 if (!SP.isLocalToUnit())
1443 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001444
Devang Patelb4e3b902010-04-30 19:38:23 +00001445 if (SP.isOptimized())
1446 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1447
Jim Grosbach965a73a2010-07-21 23:03:52 +00001448 if (unsigned isa = Asm->getISAEncoding()) {
1449 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1450 }
1451
Devang Patelb4e3b902010-04-30 19:38:23 +00001452 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001453 SPCU->insertDIE(SP, SPDie);
Devang Patelb4e3b902010-04-30 19:38:23 +00001454
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001455 // Add to context owner.
1456 addToContextOwner(SPDie, SP.getContext());
1457
Bill Wendling2f921f82009-05-15 09:23:25 +00001458 return SPDie;
1459}
1460
Devang Patel32cc43c2010-05-07 20:54:48 +00001461DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattner8d2fe282010-03-31 05:36:29 +00001462 assert(N && "Invalid Scope encoding!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001463
1464 DbgScope *AScope = AbstractScopes.lookup(N);
1465 if (AScope)
1466 return AScope;
Jim Grosbach042483e2009-11-21 23:12:12 +00001467
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001468 DbgScope *Parent = NULL;
1469
1470 DIDescriptor Scope(N);
1471 if (Scope.isLexicalBlock()) {
1472 DILexicalBlock DB(N);
1473 DIDescriptor ParentDesc = DB.getContext();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001474 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001475 }
1476
1477 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1478
1479 if (Parent)
Devang Patel930143b2009-11-21 02:48:08 +00001480 Parent->addScope(AScope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001481 AScope->setAbstractScope();
1482 AbstractScopes[N] = AScope;
1483 if (DIDescriptor(N).isSubprogram())
1484 AbstractScopesList.push_back(AScope);
1485 return AScope;
1486}
Devang Patel75cc16c2009-10-01 20:31:14 +00001487
Devang Patel019922d2010-04-06 23:53:48 +00001488/// isSubprogramContext - Return true if Context is either a subprogram
1489/// or another context nested inside a subprogram.
Devang Patel32cc43c2010-05-07 20:54:48 +00001490static bool isSubprogramContext(const MDNode *Context) {
Devang Patel019922d2010-04-06 23:53:48 +00001491 if (!Context)
1492 return false;
1493 DIDescriptor D(Context);
1494 if (D.isSubprogram())
1495 return true;
1496 if (D.isType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001497 return isSubprogramContext(DIType(Context).getContext());
Devang Patel019922d2010-04-06 23:53:48 +00001498 return false;
1499}
1500
Jim Grosbach042483e2009-11-21 23:12:12 +00001501/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel930143b2009-11-21 02:48:08 +00001502/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1503/// If there are global variables in this scope then create and insert
1504/// DIEs for these variables.
Devang Patel32cc43c2010-05-07 20:54:48 +00001505DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001506 CompileUnit *SPCU = getCompileUnit(SPNode);
1507 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +00001508
Chris Lattner3a383cb2010-04-05 00:13:49 +00001509 assert(SPDie && "Unable to find subprogram DIE!");
1510 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001511
Chris Lattner3a383cb2010-04-05 00:13:49 +00001512 // There is not any need to generate specification DIE for a function
1513 // defined at compile unit level. If a function is defined inside another
1514 // function then gdb prefers the definition at top level and but does not
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001515 // expect specification DIE in parent function. So avoid creating
Chris Lattner3a383cb2010-04-05 00:13:49 +00001516 // specification DIE for a function defined inside a function.
1517 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001518 !SP.getContext().isFile() &&
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001519 !isSubprogramContext(SP.getContext())) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00001520 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001521
1522 // Add arguments.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001523 DICompositeType SPTy = SP.getType();
1524 DIArray Args = SPTy.getTypeArray();
1525 unsigned SPTag = SPTy.getTag();
1526 if (SPTag == dwarf::DW_TAG_subroutine_type)
1527 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1528 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001529 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattner3a383cb2010-04-05 00:13:49 +00001530 addType(Arg, ATy);
1531 if (ATy.isArtificial())
1532 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1533 SPDie->addChild(Arg);
1534 }
1535 DIE *SPDeclDie = SPDie;
1536 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001537 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Chris Lattner3a383cb2010-04-05 00:13:49 +00001538 SPDeclDie);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001539 SPCU->addDie(SPDie);
Chris Lattner3a383cb2010-04-05 00:13:49 +00001540 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001541
Devang Patela37a95e2010-07-07 22:20:57 +00001542 // Pick up abstract subprogram DIE.
1543 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
1544 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1545 addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
1546 dwarf::DW_FORM_ref4, AbsSPDIE);
1547 SPCU->addDie(SPDie);
1548 }
1549
Chris Lattner3a383cb2010-04-05 00:13:49 +00001550 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1551 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1552 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1553 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1554 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1555 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1556 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +00001557
Chris Lattner3a383cb2010-04-05 00:13:49 +00001558 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001559}
1560
Jim Grosbach042483e2009-11-21 23:12:12 +00001561/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel930143b2009-11-21 02:48:08 +00001562/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1563DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001564
1565 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1566 if (Scope->isAbstractScope())
1567 return ScopeDIE;
1568
1569 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1570 if (Ranges.empty())
1571 return 0;
1572
1573 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1574 if (Ranges.size() > 1) {
1575 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001576 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +00001577 // DW_AT_ranges appropriately.
1578 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1579 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1580 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1581 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +00001582 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1583 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +00001584 }
1585 DebugRangeSymbols.push_back(NULL);
1586 DebugRangeSymbols.push_back(NULL);
1587 return ScopeDIE;
1588 }
1589
Devang Patel9fc11702010-05-25 23:40:22 +00001590 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1591 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001592
Devang Patel9fc11702010-05-25 23:40:22 +00001593 if (End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001594
Chris Lattnere13c3722010-03-09 01:58:53 +00001595 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1596 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001597
Devang Patel6c74a872010-04-27 19:46:33 +00001598 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1599 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001600
1601 return ScopeDIE;
1602}
1603
Devang Patel930143b2009-11-21 02:48:08 +00001604/// constructInlinedScopeDIE - This scope represents inlined body of
1605/// a function. Construct DIE to represent this concrete inlined copy
1606/// of the function.
1607DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001608
1609 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001610 assert (Ranges.empty() == false
Devang Patel6c74a872010-04-27 19:46:33 +00001611 && "DbgScope does not have instruction markers!");
1612
1613 // FIXME : .debug_inlined section specification does not clearly state how
1614 // to emit inlined scope that is split into multiple instruction ranges.
1615 // For now, use first instruction range and emit low_pc/high_pc pair and
1616 // corresponding .debug_inlined section entry for this pair.
1617 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel9fc11702010-05-25 23:40:22 +00001618 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1619 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001620
Devang Patel4c6bd662010-07-08 22:39:20 +00001621 if (StartLabel == 0 || EndLabel == 0) {
Devang Patel6c74a872010-04-27 19:46:33 +00001622 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1623 return 0;
1624 }
Chris Lattnere13c3722010-03-09 01:58:53 +00001625 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001626 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +00001627 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001628 "Invalid end label for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +00001629
Devang Patel3b548aa2010-03-08 20:52:55 +00001630 if (!Scope->getScopeNode())
Devang Patelbc97f6b2010-03-08 19:20:38 +00001631 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001632 DIScope DS(Scope->getScopeNode());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001633 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1634
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001635 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001636 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1637 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001638 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel930143b2009-11-21 02:48:08 +00001639 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001640 dwarf::DW_FORM_ref4, OriginDIE);
1641
Chris Lattner085b6522010-03-09 00:31:02 +00001642 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnere13c3722010-03-09 01:58:53 +00001643 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001644
1645 InlinedSubprogramDIEs.insert(OriginDIE);
1646
1647 // Track the start label for this inlined function.
Devang Patel32cc43c2010-05-07 20:54:48 +00001648 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001649 I = InlineInfo.find(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001650
1651 if (I == InlineInfo.end()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001652 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach00e9c612009-11-22 19:20:36 +00001653 ScopeDIE));
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001654 InlinedSPNodes.push_back(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001655 } else
Chris Lattner085b6522010-03-09 00:31:02 +00001656 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001657
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001658 DILocation DL(Scope->getInlinedAt());
Devang Patel1a0df9a2010-05-10 22:49:55 +00001659 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel930143b2009-11-21 02:48:08 +00001660 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001661
1662 return ScopeDIE;
1663}
1664
Devang Patel930143b2009-11-21 02:48:08 +00001665
1666/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel9ccfb642009-12-09 18:24:21 +00001667DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001668 StringRef Name = DV->getName();
Devang Patel2d9caf92009-11-25 17:36:49 +00001669 if (Name.empty())
Devang Patel97f99fa2009-11-13 02:25:26 +00001670 return NULL;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001671
1672 // Translate tag to proper Dwarf tag. The result variable is dropped for
1673 // now.
1674 unsigned Tag;
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001675 switch (DV->getTag()) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001676 case dwarf::DW_TAG_return_variable:
1677 return NULL;
1678 case dwarf::DW_TAG_arg_variable:
1679 Tag = dwarf::DW_TAG_formal_parameter;
1680 break;
1681 case dwarf::DW_TAG_auto_variable: // fall thru
1682 default:
1683 Tag = dwarf::DW_TAG_variable;
1684 break;
1685 }
1686
1687 // Define variable debug information entry.
1688 DIE *VariableDie = new DIE(Tag);
1689
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001690 DIE *AbsDIE = NULL;
Devang Patele1c53f22010-05-20 16:36:41 +00001691 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1692 V2AVI = VarToAbstractVarMap.find(DV);
1693 if (V2AVI != VarToAbstractVarMap.end())
1694 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach042483e2009-11-21 23:12:12 +00001695
Devang Patele1c53f22010-05-20 16:36:41 +00001696 if (AbsDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001697 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001698 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001699 else {
Devang Patel930143b2009-11-21 02:48:08 +00001700 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001701 addSourceLine(VariableDie, DV->getVariable());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001702
1703 // Add variable type.
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001704 addType(VariableDie, DV->getType());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001705 }
1706
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001707 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patel6efc8e52010-02-06 01:02:37 +00001708 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelbea08d12010-09-29 23:07:21 +00001709 else if (DIVariable(DV->getVariable()).isArtificial())
1710 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel9fc11702010-05-25 23:40:22 +00001711
1712 if (Scope->isAbstractScope()) {
1713 DV->setDIE(VariableDie);
1714 return VariableDie;
1715 }
1716
1717 // Add variable address.
1718
1719 unsigned Offset = DV->getDotDebugLocOffset();
1720 if (Offset != ~0U) {
1721 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1722 Asm->GetTempSymbol("debug_loc", Offset));
1723 DV->setDIE(VariableDie);
1724 UseDotDebugLocEntry.insert(VariableDie);
1725 return VariableDie;
1726 }
1727
1728 // Check if variable is described by a DBG_VALUE instruction.
1729 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1730 DbgVariableToDbgInstMap.find(DV);
1731 if (DVI != DbgVariableToDbgInstMap.end()) {
1732 const MachineInstr *DVInsn = DVI->second;
Devang Patel9fc11702010-05-25 23:40:22 +00001733 bool updated = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001734 // FIXME : Handle getNumOperands != 3
Devang Patel9fc11702010-05-25 23:40:22 +00001735 if (DVInsn->getNumOperands() == 3) {
Devang Patel86ec8b32010-08-31 22:22:42 +00001736 if (DVInsn->getOperand(0).isReg()) {
1737 const MachineOperand RegOp = DVInsn->getOperand(0);
1738 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1739 if (DVInsn->getOperand(1).isImm() &&
1740 TRI->getFrameRegister(*Asm->MF) == RegOp.getReg()) {
1741 addVariableAddress(DV, VariableDie, DVInsn->getOperand(1).getImm());
1742 updated = true;
1743 } else
Devang Patel53a40df62010-11-12 23:20:42 +00001744 updated = addRegisterAddress(VariableDie, RegOp);
Devang Patel86ec8b32010-08-31 22:22:42 +00001745 }
Devang Patel9fc11702010-05-25 23:40:22 +00001746 else if (DVInsn->getOperand(0).isImm())
Devang Patel53a40df62010-11-12 23:20:42 +00001747 updated = addConstantValue(VariableDie, DVInsn->getOperand(0));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001748 else if (DVInsn->getOperand(0).isFPImm())
1749 updated =
Devang Patel53a40df62010-11-12 23:20:42 +00001750 addConstantFPValue(VariableDie, DVInsn->getOperand(0));
Devang Patel9fc11702010-05-25 23:40:22 +00001751 } else {
1752 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1753 if (Location.getReg()) {
1754 addAddress(VariableDie, dwarf::DW_AT_location, Location);
Devang Patel9fc11702010-05-25 23:40:22 +00001755 updated = true;
1756 }
1757 }
1758 if (!updated) {
1759 // If variableDie is not updated then DBG_VALUE instruction does not
1760 // have valid variable info.
1761 delete VariableDie;
1762 return NULL;
1763 }
1764 DV->setDIE(VariableDie);
1765 return VariableDie;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001766 }
Devang Patel9fc11702010-05-25 23:40:22 +00001767
1768 // .. else use frame index, if available.
Devang Patel9fc11702010-05-25 23:40:22 +00001769 int FI = 0;
Devang Patel2cfc3af2010-08-31 06:11:28 +00001770 if (findVariableFrameIndex(DV, &FI))
1771 addVariableAddress(DV, VariableDie, FI);
1772
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001773 DV->setDIE(VariableDie);
1774 return VariableDie;
1775
1776}
Devang Patel930143b2009-11-21 02:48:08 +00001777
Devang Patel04d2f2d2009-11-24 01:14:22 +00001778void DwarfDebug::addPubTypes(DISubprogram SP) {
1779 DICompositeType SPTy = SP.getType();
1780 unsigned SPTag = SPTy.getTag();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001781 if (SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel04d2f2d2009-11-24 01:14:22 +00001782 return;
1783
1784 DIArray Args = SPTy.getTypeArray();
Devang Patel04d2f2d2009-11-24 01:14:22 +00001785 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001786 DIType ATy(Args.getElement(i));
Devang Patel8d6a2b72010-05-07 21:45:47 +00001787 if (!ATy.Verify())
Devang Patel04d2f2d2009-11-24 01:14:22 +00001788 continue;
1789 DICompositeType CATy = getDICompositeType(ATy);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001790 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel12d150e2010-04-13 20:35:04 +00001791 && !CATy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001792 CompileUnit *TheCU = getCompileUnit(CATy);
1793 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1794 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00001795 }
1796 }
1797}
1798
Devang Patel930143b2009-11-21 02:48:08 +00001799/// constructScopeDIE - Construct a DIE for this scope.
1800DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +00001801 if (!Scope || !Scope->getScopeNode())
1802 return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001803
Devang Patel5f1b4cd2011-02-19 01:31:27 +00001804 SmallVector <DIE *, 8> Children;
Devang Patel6c622ef2011-03-01 22:58:55 +00001805
1806 // Collect arguments for current function.
1807 if (Scope == CurrentFnDbgScope)
1808 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
1809 if (DbgVariable *ArgDV = CurrentFnArguments[i])
1810 if (DIE *Arg = constructVariableDIE(ArgDV, Scope))
1811 Children.push_back(Arg);
1812
Devang Patel5f1b4cd2011-02-19 01:31:27 +00001813 // Collect lexical scope childrens first.
1814 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
1815 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
1816 if (DIE *Variable = constructVariableDIE(Variables[i], Scope))
1817 Children.push_back(Variable);
1818 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
1819 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
1820 if (DIE *Nested = constructScopeDIE(Scopes[j]))
1821 Children.push_back(Nested);
Devang Patel3b548aa2010-03-08 20:52:55 +00001822 DIScope DS(Scope->getScopeNode());
1823 DIE *ScopeDIE = NULL;
1824 if (Scope->getInlinedAt())
1825 ScopeDIE = constructInlinedScopeDIE(Scope);
1826 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +00001827 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001828 if (Scope->isAbstractScope()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001829 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001830 // Note down abstract DIE.
1831 if (ScopeDIE)
1832 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
1833 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001834 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001835 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3b548aa2010-03-08 20:52:55 +00001836 }
Devang Patel5f1b4cd2011-02-19 01:31:27 +00001837 else {
1838 // There is no need to emit empty lexical block DIE.
1839 if (Children.empty())
1840 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001841 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +00001842 }
1843
Devang Patel23b2ae62010-03-29 22:59:58 +00001844 if (!ScopeDIE) return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001845
Devang Patel5f1b4cd2011-02-19 01:31:27 +00001846 // Add children
1847 for (SmallVector<DIE *, 8>::iterator I = Children.begin(),
1848 E = Children.end(); I != E; ++I)
1849 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +00001850
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001851 if (DS.isSubprogram())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001852 addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001853
Devang Patel04d2f2d2009-11-24 01:14:22 +00001854 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001855}
1856
Bill Wendling2b128d72009-05-20 23:19:06 +00001857/// GetOrCreateSourceID - Look up the source id with the given directory and
1858/// source file names. If none currently exists, create a new id and insert it
1859/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1860/// maps as well.
Devang Patel498877d2010-07-24 00:53:22 +00001861
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001862unsigned DwarfDebug::GetOrCreateSourceID(StringRef FileName){
Devang Patel871d0b12010-09-16 20:57:49 +00001863 // If FE did not provide a file name, then assume stdin.
1864 if (FileName.empty())
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001865 return GetOrCreateSourceID("<stdin>");
Devang Patel871d0b12010-09-16 20:57:49 +00001866
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001867 StringMapEntry<unsigned> &Entry = SourceIdMap.GetOrCreateValue(FileName);
1868 if (Entry.getValue())
1869 return Entry.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +00001870
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001871 unsigned SrcId = SourceIdMap.size();
1872 Entry.setValue(SrcId);
Bill Wendling2b128d72009-05-20 23:19:06 +00001873
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001874 // Print out a .file directive to specify files for .loc directives.
1875 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, FileName);
Bill Wendling2b128d72009-05-20 23:19:06 +00001876
1877 return SrcId;
1878}
1879
Devang Patel1f4690c2009-12-15 19:16:48 +00001880/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1881DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001882 CompileUnit *TheCU = getCompileUnit(NS);
1883 DIE *NDie = TheCU->getDIE(NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001884 if (NDie)
1885 return NDie;
1886 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001887 TheCU->insertDIE(NS, NDie);
Devang Patel1f4690c2009-12-15 19:16:48 +00001888 if (!NS.getName().empty())
1889 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
Devang Patelb6511a32010-08-09 20:20:05 +00001890 addSourceLine(NDie, NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001891 addToContextOwner(NDie, NS.getContext());
1892 return NDie;
1893}
1894
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001895/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel1a0df9a2010-05-10 22:49:55 +00001896/// metadata node with tag DW_TAG_compile_unit.
Devang Patel32cc43c2010-05-07 20:54:48 +00001897void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001898 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +00001899 StringRef FN = DIUnit.getFilename();
1900 StringRef Dir = DIUnit.getDirectory();
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001901 unsigned ID = GetOrCreateSourceID(FN);
Bill Wendling2b128d72009-05-20 23:19:06 +00001902
1903 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel930143b2009-11-21 02:48:08 +00001904 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patelb2969422009-09-29 18:40:58 +00001905 DIUnit.getProducer());
Devang Patel7b0f7962011-02-23 22:37:04 +00001906 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
Bill Wendling2b128d72009-05-20 23:19:06 +00001907 DIUnit.getLanguage());
Devang Patel930143b2009-11-21 02:48:08 +00001908 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patelbd798ce2010-04-26 22:54:28 +00001909 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1910 // simplifies debug range entries.
Devang Patel1de21ec2010-06-28 22:22:47 +00001911 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Pateld22ed622010-03-22 23:11:36 +00001912 // DW_AT_stmt_list is a offset of line number information for this
Devang Patel4a213872010-08-24 00:06:12 +00001913 // compile unit in debug_line section.
Devang Patelea636392010-08-31 23:50:19 +00001914 if (Asm->MAI->doesDwarfUsesAbsoluteLabelForStmtList())
Cameron Zwarichfcf51fd2011-02-25 16:30:32 +00001915 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_addr,
1916 Asm->GetTempSymbol("section_line"));
Devang Patelea636392010-08-31 23:50:19 +00001917 else
1918 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00001919
Devang Patel2d9caf92009-11-25 17:36:49 +00001920 if (!Dir.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001921 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +00001922 if (DIUnit.isOptimized())
Devang Patel930143b2009-11-21 02:48:08 +00001923 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendling2b128d72009-05-20 23:19:06 +00001924
Devang Patel2d9caf92009-11-25 17:36:49 +00001925 StringRef Flags = DIUnit.getFlags();
1926 if (!Flags.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001927 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendling2b128d72009-05-20 23:19:06 +00001928
1929 unsigned RVer = DIUnit.getRunTimeVersion();
1930 if (RVer)
Devang Patel930143b2009-11-21 02:48:08 +00001931 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +00001932 dwarf::DW_FORM_data1, RVer);
1933
Devang Patel1a0df9a2010-05-10 22:49:55 +00001934 CompileUnit *NewCU = new CompileUnit(ID, Die);
1935 if (!FirstCU)
1936 FirstCU = NewCU;
1937 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendling2b128d72009-05-20 23:19:06 +00001938}
1939
Devang Patel1a0df9a2010-05-10 22:49:55 +00001940/// getCompielUnit - Get CompileUnit DIE.
1941CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1942 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1943 DIDescriptor D(N);
1944 const MDNode *CUNode = NULL;
1945 if (D.isCompileUnit())
1946 CUNode = N;
1947 else if (D.isSubprogram())
1948 CUNode = DISubprogram(N).getCompileUnit();
1949 else if (D.isType())
1950 CUNode = DIType(N).getCompileUnit();
1951 else if (D.isGlobalVariable())
1952 CUNode = DIGlobalVariable(N).getCompileUnit();
1953 else if (D.isVariable())
1954 CUNode = DIVariable(N).getCompileUnit();
1955 else if (D.isNameSpace())
1956 CUNode = DINameSpace(N).getCompileUnit();
1957 else if (D.isFile())
1958 CUNode = DIFile(N).getCompileUnit();
1959 else
1960 return FirstCU;
1961
1962 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1963 = CUMap.find(CUNode);
1964 if (I == CUMap.end())
1965 return FirstCU;
1966 return I->second;
1967}
1968
Devang Patela8652672010-08-23 18:25:56 +00001969/// isUnsignedDIType - Return true if type encoding is unsigned.
1970static bool isUnsignedDIType(DIType Ty) {
1971 DIDerivedType DTy(Ty);
1972 if (DTy.Verify())
1973 return isUnsignedDIType(DTy.getTypeDerivedFrom());
1974
1975 DIBasicType BTy(Ty);
1976 if (BTy.Verify()) {
1977 unsigned Encoding = BTy.getEncoding();
1978 if (Encoding == dwarf::DW_ATE_unsigned ||
1979 Encoding == dwarf::DW_ATE_unsigned_char)
1980 return true;
1981 }
1982 return false;
1983}
Devang Patel1a0df9a2010-05-10 22:49:55 +00001984
Devang Patel2d9e5322011-01-20 00:02:16 +00001985// Return const exprssion if value is a GEP to access merged global
1986// constant. e.g.
1987// i8* getelementptr ({ i8, i8, i8, i8 }* @_MergedGlobals, i32 0, i32 0)
1988static const ConstantExpr *getMergedGlobalExpr(const Value *V) {
1989 const ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(V);
1990 if (!CE || CE->getNumOperands() != 3 ||
1991 CE->getOpcode() != Instruction::GetElementPtr)
1992 return NULL;
1993
1994 // First operand points to a global value.
1995 if (!isa<GlobalValue>(CE->getOperand(0)))
1996 return NULL;
1997
1998 // Second operand is zero.
1999 const ConstantInt *CI =
2000 dyn_cast_or_null<ConstantInt>(CE->getOperand(1));
2001 if (!CI || !CI->isZero())
2002 return NULL;
2003
2004 // Third operand is offset.
2005 if (!isa<ConstantInt>(CE->getOperand(2)))
2006 return NULL;
2007
2008 return CE;
2009}
2010
Devang Patel1a0df9a2010-05-10 22:49:55 +00002011/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00002012void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel469c12d22010-08-10 01:37:23 +00002013 DIGlobalVariable GV(N);
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002014
Devang Patelf5d53602009-09-04 23:59:07 +00002015 // If debug information is malformed then ignore it.
Devang Patel469c12d22010-08-10 01:37:23 +00002016 if (GV.Verify() == false)
Devang Patelf5d53602009-09-04 23:59:07 +00002017 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002018
2019 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002020 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel469c12d22010-08-10 01:37:23 +00002021 if (TheCU->getDIE(GV))
Devang Patel0751a282009-06-26 01:49:18 +00002022 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002023
Devang Patel469c12d22010-08-10 01:37:23 +00002024 DIType GTy = GV.getType();
Devang Patelb2197462010-08-10 07:11:13 +00002025 DIE *VariableDIE = new DIE(GV.getTag());
2026
2027 bool isGlobalVariable = GV.getGlobal() != NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00002028
Devang Patel469c12d22010-08-10 01:37:23 +00002029 // Add name.
2030 addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
2031 GV.getDisplayName());
2032 StringRef LinkageName = GV.getLinkageName();
Devang Patelb2197462010-08-10 07:11:13 +00002033 if (!LinkageName.empty() && isGlobalVariable)
Devang Patel469c12d22010-08-10 01:37:23 +00002034 addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
2035 getRealLinkageName(LinkageName));
2036 // Add type.
2037 addType(VariableDIE, GTy);
Devang Patel12d150e2010-04-13 20:35:04 +00002038 if (GTy.isCompositeType() && !GTy.getName().empty()
2039 && !GTy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002040 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattner8d2fe282010-03-31 05:36:29 +00002041 assert(Entry && "Missing global type!");
Devang Patel1a0df9a2010-05-10 22:49:55 +00002042 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00002043 }
Devang Patel469c12d22010-08-10 01:37:23 +00002044 // Add scoping info.
2045 if (!GV.isLocalToUnit()) {
2046 addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
2047 // Expose as global.
2048 TheCU->addGlobal(GV.getName(), VariableDIE);
2049 }
2050 // Add line number info.
2051 addSourceLine(VariableDIE, GV);
2052 // Add to map.
2053 TheCU->insertDIE(N, VariableDIE);
2054 // Add to context owner.
2055 DIDescriptor GVContext = GV.getContext();
2056 addToContextOwner(VariableDIE, GVContext);
2057 // Add location.
Devang Patelb2197462010-08-10 07:11:13 +00002058 if (isGlobalVariable) {
2059 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
2060 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
2061 addLabel(Block, 0, dwarf::DW_FORM_udata,
2062 Asm->Mang->getSymbol(GV.getGlobal()));
2063 // Do not create specification DIE if context is either compile unit
2064 // or a subprogram.
2065 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
2066 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
2067 // Create specification DIE.
2068 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
2069 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
2070 dwarf::DW_FORM_ref4, VariableDIE);
2071 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
2072 addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
2073 TheCU->addDie(VariableSpecDIE);
2074 } else {
2075 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
2076 }
Devang Patel70eb9822011-01-06 21:39:25 +00002077 } else if (ConstantInt *CI =
2078 dyn_cast_or_null<ConstantInt>(GV.getConstant()))
2079 addConstantValue(VariableDIE, CI, isUnsignedDIType(GTy));
Devang Patel2d9e5322011-01-20 00:02:16 +00002080 else if (const ConstantExpr *CE = getMergedGlobalExpr(N->getOperand(11))) {
2081 // GV is a merged global.
2082 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
2083 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
2084 addLabel(Block, 0, dwarf::DW_FORM_udata,
2085 Asm->Mang->getSymbol(cast<GlobalValue>(CE->getOperand(0))));
2086 ConstantInt *CII = cast<ConstantInt>(CE->getOperand(2));
2087 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
2088 addUInt(Block, 0, dwarf::DW_FORM_udata, CII->getZExtValue());
2089 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
2090 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
2091 }
Devang Patel70eb9822011-01-06 21:39:25 +00002092
Devang Patel0751a282009-06-26 01:49:18 +00002093 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002094}
2095
Devang Patel1a0df9a2010-05-10 22:49:55 +00002096/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00002097void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00002098 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +00002099
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002100 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002101 CompileUnit *TheCU = getCompileUnit(N);
2102 if (TheCU->getDIE(N))
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002103 return;
2104
Bill Wendling2b128d72009-05-20 23:19:06 +00002105 if (!SP.isDefinition())
2106 // This is a method declaration which will be handled while constructing
2107 // class type.
Devang Patel0751a282009-06-26 01:49:18 +00002108 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002109
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002110 DIE *SubprogramDie = createSubprogramDIE(SP);
2111
2112 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002113 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00002114
2115 // Add to context owner.
Devang Patel1f4690c2009-12-15 19:16:48 +00002116 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +00002117
Bill Wendling2b128d72009-05-20 23:19:06 +00002118 // Expose as global.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002119 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002120
Devang Patel0751a282009-06-26 01:49:18 +00002121 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002122}
2123
Devang Patel930143b2009-11-21 02:48:08 +00002124/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbarbe22ec42009-09-19 20:40:14 +00002125/// content. Create global DIEs and emit initial debug info sections.
2126/// This is inovked by the target AsmPrinter.
Chris Lattner11980022010-04-04 07:48:20 +00002127void DwarfDebug::beginModule(Module *M) {
Devang Patel6c74a872010-04-27 19:46:33 +00002128 if (DisableDebugInfoPrinting)
2129 return;
2130
Devang Patel63524442009-07-30 18:56:46 +00002131 DebugInfoFinder DbgFinder;
2132 DbgFinder.processModule(*M);
Devang Patel0751a282009-06-26 01:49:18 +00002133
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002134 bool HasDebugInfo = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002135
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002136 // Scan all the compile-units to see if there are any marked as the main unit.
2137 // if not, we do not generate debug info.
2138 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2139 E = DbgFinder.compile_unit_end(); I != E; ++I) {
2140 if (DICompileUnit(*I).isMain()) {
2141 HasDebugInfo = true;
2142 break;
2143 }
2144 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002145
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002146 if (!HasDebugInfo) return;
2147
2148 // Tell MMI that we have debug info.
2149 MMI->setDebugInfoAvailability(true);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002150
Chris Lattnerd442aa32010-04-04 23:17:54 +00002151 // Emit initial sections.
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002152 EmitSectionLabels();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002153
Bill Wendling2b128d72009-05-20 23:19:06 +00002154 // Create all the compile unit DIEs.
Devang Patel63524442009-07-30 18:56:46 +00002155 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2156 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002157 constructCompileUnit(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002158
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002159 // Create DIEs for each subprogram.
Devang Patel63524442009-07-30 18:56:46 +00002160 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
2161 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002162 constructSubprogramDIE(*I);
Devang Patel0751a282009-06-26 01:49:18 +00002163
Devang Patel2b75ed22009-12-10 19:14:49 +00002164 // Create DIEs for each global variable.
2165 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2166 E = DbgFinder.global_variable_end(); I != E; ++I)
2167 constructGlobalVariableDIE(*I);
2168
Devang Patel8e06a5e2010-08-10 20:01:20 +00002169 //getOrCreateTypeDIE
2170 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
2171 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2172 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2173
Devang Patel7a554812010-09-28 18:08:20 +00002174 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
2175 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2176 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2177
Bill Wendling2b128d72009-05-20 23:19:06 +00002178 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +00002179 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +00002180}
2181
Devang Patel930143b2009-11-21 02:48:08 +00002182/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendling2b128d72009-05-20 23:19:06 +00002183///
Devang Patel930143b2009-11-21 02:48:08 +00002184void DwarfDebug::endModule() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002185 if (!FirstCU) return;
Devang Patelf3b2db62010-06-28 18:25:03 +00002186 const Module *M = MMI->getModule();
Devang Pateld0701282010-08-02 17:32:15 +00002187 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patelf3b2db62010-06-28 18:25:03 +00002188 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2189 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2190 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2191 DISubprogram SP(AllSPs->getOperand(SI));
2192 if (!SP.Verify()) continue;
2193
2194 // Collect info for variables that were optimized out.
Devang Patel18efced2010-07-19 17:53:55 +00002195 if (!SP.isDefinition()) continue;
Devang Patelf3b2db62010-06-28 18:25:03 +00002196 StringRef FName = SP.getLinkageName();
2197 if (FName.empty())
2198 FName = SP.getName();
Devang Patel364bf042010-11-10 22:19:21 +00002199 NamedMDNode *NMD = getFnSpecificMDNode(*(MMI->getModule()), FName);
Devang Patelf3b2db62010-06-28 18:25:03 +00002200 if (!NMD) continue;
2201 unsigned E = NMD->getNumOperands();
2202 if (!E) continue;
2203 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Pateld0701282010-08-02 17:32:15 +00002204 DeadFnScopeMap[SP] = Scope;
Devang Patelf3b2db62010-06-28 18:25:03 +00002205 for (unsigned I = 0; I != E; ++I) {
2206 DIVariable DV(NMD->getOperand(I));
2207 if (!DV.Verify()) continue;
2208 Scope->addVariable(new DbgVariable(DV));
2209 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002210
Devang Patelf3b2db62010-06-28 18:25:03 +00002211 // Construct subprogram DIE and add variables DIEs.
2212 constructSubprogramDIE(SP);
2213 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patel406798a2010-08-09 18:51:29 +00002214 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf3b2db62010-06-28 18:25:03 +00002215 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2216 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2217 if (VariableDIE)
2218 ScopeDIE->addChild(VariableDIE);
2219 }
2220 }
2221 }
Bill Wendling2b128d72009-05-20 23:19:06 +00002222
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002223 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2224 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2225 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2226 DIE *ISP = *AI;
Devang Patel930143b2009-11-21 02:48:08 +00002227 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002228 }
2229
Devang Patel32cc43c2010-05-07 20:54:48 +00002230 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Pateleb57c592009-12-03 19:11:07 +00002231 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2232 DIE *SPDie = CI->first;
Devang Patel32cc43c2010-05-07 20:54:48 +00002233 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Pateleb57c592009-12-03 19:11:07 +00002234 if (!N) continue;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002235 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Pateleb57c592009-12-03 19:11:07 +00002236 if (!NDie) continue;
2237 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Pateleb57c592009-12-03 19:11:07 +00002238 }
2239
Bill Wendling2b128d72009-05-20 23:19:06 +00002240 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002241 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002242 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002243 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002244 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +00002245
2246 // End text sections.
2247 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002248 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnera179b522010-04-04 19:25:43 +00002249 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendling2b128d72009-05-20 23:19:06 +00002250 }
2251
2252 // Emit common frame information.
Devang Patel930143b2009-11-21 02:48:08 +00002253 emitCommonDebugFrame();
Bill Wendling2b128d72009-05-20 23:19:06 +00002254
2255 // Emit function debug frame information
2256 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2257 E = DebugFrames.end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002258 emitFunctionDebugFrame(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002259
2260 // Compute DIE offsets and sizes.
Devang Patel930143b2009-11-21 02:48:08 +00002261 computeSizeAndOffsets();
Bill Wendling2b128d72009-05-20 23:19:06 +00002262
2263 // Emit all the DIEs into a debug info section
Devang Patel930143b2009-11-21 02:48:08 +00002264 emitDebugInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002265
2266 // Corresponding abbreviations into a abbrev section.
Devang Patel930143b2009-11-21 02:48:08 +00002267 emitAbbreviations();
Bill Wendling2b128d72009-05-20 23:19:06 +00002268
Bill Wendling2b128d72009-05-20 23:19:06 +00002269 // Emit info into a debug pubnames section.
Devang Patel930143b2009-11-21 02:48:08 +00002270 emitDebugPubNames();
Bill Wendling2b128d72009-05-20 23:19:06 +00002271
Devang Patel04d2f2d2009-11-24 01:14:22 +00002272 // Emit info into a debug pubtypes section.
2273 emitDebugPubTypes();
2274
Bill Wendling2b128d72009-05-20 23:19:06 +00002275 // Emit info into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002276 emitDebugLoc();
Bill Wendling2b128d72009-05-20 23:19:06 +00002277
2278 // Emit info into a debug aranges section.
2279 EmitDebugARanges();
2280
2281 // Emit info into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002282 emitDebugRanges();
Bill Wendling2b128d72009-05-20 23:19:06 +00002283
2284 // Emit info into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002285 emitDebugMacInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002286
2287 // Emit inline info.
Devang Patel930143b2009-11-21 02:48:08 +00002288 emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002289
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002290 // Emit info into a debug str section.
2291 emitDebugStr();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002292
Devang Pateld0701282010-08-02 17:32:15 +00002293 // clean up.
2294 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002295 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2296 E = CUMap.end(); I != E; ++I)
2297 delete I->second;
2298 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendling2b128d72009-05-20 23:19:06 +00002299}
2300
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002301/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002302DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattner915c5f92010-04-02 19:42:39 +00002303 DebugLoc ScopeLoc) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002304
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002305 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002306 if (AbsDbgVariable)
2307 return AbsDbgVariable;
2308
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002309 LLVMContext &Ctx = Var->getContext();
Chris Lattner915c5f92010-04-02 19:42:39 +00002310 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002311 if (!Scope)
2312 return NULL;
2313
Devang Patele1c53f22010-05-20 16:36:41 +00002314 AbsDbgVariable = new DbgVariable(Var);
Devang Patel930143b2009-11-21 02:48:08 +00002315 Scope->addVariable(AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002316 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002317 return AbsDbgVariable;
2318}
2319
Devang Patel6c622ef2011-03-01 22:58:55 +00002320/// addCurrentFnArgument - If Var is an current function argument that add
2321/// it in CurrentFnArguments list.
2322bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
2323 DbgVariable *Var, DbgScope *Scope) {
2324 if (Scope != CurrentFnDbgScope)
2325 return false;
2326 DIVariable DV = Var->getVariable();
2327 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
2328 return false;
2329 unsigned ArgNo = DV.getArgNumber();
2330 if (ArgNo == 0)
2331 return false;
2332
Devang Patel4ab660b2011-03-03 20:02:02 +00002333 size_t Size = CurrentFnArguments.size();
2334 if (Size == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00002335 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patel34a7ab42011-03-03 20:08:10 +00002336 // llvm::Function arugment size is not good indicator of how many
2337 // arguments does the function have at source level.
2338 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00002339 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00002340 CurrentFnArguments[ArgNo - 1] = Var;
2341 return true;
2342}
2343
Devang Patel490c8ab2010-05-20 19:57:06 +00002344/// collectVariableInfoFromMMITable - Collect variable information from
2345/// side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002346void
Devang Patel490c8ab2010-05-20 19:57:06 +00002347DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2348 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00002349 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patel475d32a2009-10-06 01:26:37 +00002350 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2351 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2352 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00002353 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002354 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00002355 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00002356 DIVariable DV(Var);
2357 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002358
Chris Lattner915c5f92010-04-02 19:42:39 +00002359 DbgScope *Scope = 0;
Devang Patel32cc43c2010-05-07 20:54:48 +00002360 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattner915c5f92010-04-02 19:42:39 +00002361 Scope = ConcreteScopes.lookup(IA);
2362 if (Scope == 0)
2363 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002364
Devang Patelcdb7d442009-11-10 23:20:04 +00002365 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00002366 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00002367 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002368
Devang Patele1c53f22010-05-20 16:36:41 +00002369 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2370 DbgVariable *RegVar = new DbgVariable(DV);
2371 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel6c622ef2011-03-01 22:58:55 +00002372 if (!addCurrentFnArgument(MF, RegVar, Scope))
2373 Scope->addVariable(RegVar);
Devang Patele1c53f22010-05-20 16:36:41 +00002374 if (AbsDbgVariable) {
2375 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2376 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2377 }
Devang Patel475d32a2009-10-06 01:26:37 +00002378 }
Devang Patel490c8ab2010-05-20 19:57:06 +00002379}
Devang Patela3e9c9c2010-03-15 18:33:46 +00002380
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002381/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +00002382/// DBG_VALUE instruction, is in a defined reg.
2383static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2384 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2385 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2386 return true;
2387 return false;
2388}
2389
Devang Patel490c8ab2010-05-20 19:57:06 +00002390/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002391void
Devang Patel5c0f85c2010-06-25 22:07:34 +00002392DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2393 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002394
Devang Patel490c8ab2010-05-20 19:57:06 +00002395 /// collection info from MMI table.
2396 collectVariableInfoFromMMITable(MF, Processed);
2397
2398 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002399 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002400 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel490c8ab2010-05-20 19:57:06 +00002401 I != E; ++I)
Devang Patela3e9c9c2010-03-15 18:33:46 +00002402 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2403 II != IE; ++II) {
2404 const MachineInstr *MInsn = II;
Devang Patel447cb382011-01-11 21:42:10 +00002405 if (!MInsn->isDebugValue())
Devang Patela3e9c9c2010-03-15 18:33:46 +00002406 continue;
Devang Patel490c8ab2010-05-20 19:57:06 +00002407 DbgValues.push_back(MInsn);
2408 }
Devang Patela3e9c9c2010-03-15 18:33:46 +00002409
Devang Patel9fc11702010-05-25 23:40:22 +00002410 // This is a collection of DBV_VALUE instructions describing same variable.
2411 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patel490c8ab2010-05-20 19:57:06 +00002412 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2413 E = DbgValues.end(); I != E; ++I) {
2414 const MachineInstr *MInsn = *I;
Devang Patel9fc11702010-05-25 23:40:22 +00002415 MultipleValues.clear();
2416 if (isDbgValueInDefinedReg(MInsn))
2417 MultipleValues.push_back(MInsn);
Devang Patel490c8ab2010-05-20 19:57:06 +00002418 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2419 if (Processed.count(DV) != 0)
2420 continue;
2421
Devang Patelc2254f62010-06-02 19:05:13 +00002422 const MachineInstr *PrevMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002423 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
Devang Patel9fc11702010-05-25 23:40:22 +00002424 ME = DbgValues.end(); MI != ME; ++MI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002425 const MDNode *Var =
Devang Patel9fc11702010-05-25 23:40:22 +00002426 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
Devang Patel447cb382011-01-11 21:42:10 +00002427 if (Var == DV &&
Devang Patelc2254f62010-06-02 19:05:13 +00002428 !PrevMI->isIdenticalTo(*MI))
Devang Patel9fc11702010-05-25 23:40:22 +00002429 MultipleValues.push_back(*MI);
Devang Patelc2254f62010-06-02 19:05:13 +00002430 PrevMI = *MI;
Devang Patel9fc11702010-05-25 23:40:22 +00002431 }
2432
Devang Patel447cb382011-01-11 21:42:10 +00002433 DbgScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00002434 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2435 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelfbd6c452010-05-21 00:10:20 +00002436 Scope = CurrentFnDbgScope;
Devang Patel447cb382011-01-11 21:42:10 +00002437 else
2438 Scope = findDbgScope(MInsn);
Devang Patel490c8ab2010-05-20 19:57:06 +00002439 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00002440 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00002441 continue;
2442
2443 Processed.insert(DV);
Devang Patel490c8ab2010-05-20 19:57:06 +00002444 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patel6c622ef2011-03-01 22:58:55 +00002445 if (!addCurrentFnArgument(MF, RegVar, Scope))
2446 Scope->addVariable(RegVar);
Devang Patelfbd6c452010-05-21 00:10:20 +00002447 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2448 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2449 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002450 }
Devang Patel9fc11702010-05-25 23:40:22 +00002451 if (MultipleValues.size() <= 1) {
2452 DbgVariableToDbgInstMap[RegVar] = MInsn;
2453 continue;
2454 }
2455
2456 // handle multiple DBG_VALUE instructions describing one variable.
Devang Patel9fc11702010-05-25 23:40:22 +00002457 if (DotDebugLocEntries.empty())
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002458 RegVar->setDotDebugLocOffset(0);
2459 else
2460 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002461 const MachineInstr *Begin = NULL;
2462 const MachineInstr *End = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002463 for (SmallVector<const MachineInstr *, 4>::iterator
2464 MVI = MultipleValues.begin(), MVE = MultipleValues.end();
Devang Patel30265c42010-07-07 20:12:52 +00002465 MVI != MVE; ++MVI) {
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002466 if (!Begin) {
2467 Begin = *MVI;
2468 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002469 }
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002470 End = *MVI;
Devang Patel9fc11702010-05-25 23:40:22 +00002471 MachineLocation MLoc;
Devang Patel0e60e672010-08-04 18:40:52 +00002472 if (Begin->getNumOperands() == 3) {
2473 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2474 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2475 } else
2476 MLoc = Asm->getDebugValueLocation(Begin);
2477
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002478 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2479 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patel6c378ac2010-08-04 22:07:27 +00002480 if (MLoc.getReg())
2481 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
2482
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002483 Begin = End;
2484 if (MVI + 1 == MVE) {
2485 // If End is the last instruction then its value is valid
Devang Patel9fc11702010-05-25 23:40:22 +00002486 // until the end of the funtion.
Devang Patel0e60e672010-08-04 18:40:52 +00002487 MachineLocation EMLoc;
2488 if (End->getNumOperands() == 3) {
2489 if (End->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2490 EMLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2491 } else
2492 EMLoc = Asm->getDebugValueLocation(End);
Devang Patel6c378ac2010-08-04 22:07:27 +00002493 if (EMLoc.getReg())
2494 DotDebugLocEntries.
2495 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, EMLoc));
Devang Patel9fc11702010-05-25 23:40:22 +00002496 }
2497 }
2498 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00002499 }
Devang Patele0a94bf2010-05-14 21:01:35 +00002500
2501 // Collect info for variables that were optimized out.
Devang Patelad517352010-06-22 01:01:58 +00002502 const Function *F = MF->getFunction();
Devang Patel364bf042010-11-10 22:19:21 +00002503 if (NamedMDNode *NMD = getFnSpecificMDNode(*(F->getParent()), F->getName())) {
Devang Patele0a94bf2010-05-14 21:01:35 +00002504 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002505 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel490c8ab2010-05-20 19:57:06 +00002506 if (!DV || !Processed.insert(DV))
Devang Patele0a94bf2010-05-14 21:01:35 +00002507 continue;
2508 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2509 if (Scope)
Devang Patele1c53f22010-05-20 16:36:41 +00002510 Scope->addVariable(new DbgVariable(DV));
Devang Patele0a94bf2010-05-14 21:01:35 +00002511 }
2512 }
Devang Patel9fc11702010-05-25 23:40:22 +00002513}
Devang Patele0a94bf2010-05-14 21:01:35 +00002514
Devang Patel9fc11702010-05-25 23:40:22 +00002515/// getLabelBeforeInsn - Return Label preceding the instruction.
2516const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2517 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2518 LabelsBeforeInsn.find(MI);
2519 if (I == LabelsBeforeInsn.end())
2520 // FunctionBeginSym always preceeds all the instruction in current function.
2521 return FunctionBeginSym;
2522 return I->second;
2523}
2524
2525/// getLabelAfterInsn - Return Label immediately following the instruction.
2526const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2527 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2528 LabelsAfterInsn.find(MI);
2529 if (I == LabelsAfterInsn.end())
2530 return NULL;
2531 return I->second;
Devang Patel475d32a2009-10-06 01:26:37 +00002532}
2533
Devang Patelb5694e72010-10-26 17:49:02 +00002534/// beginInstruction - Process beginning of an instruction.
2535void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Devang Patel002d54d2010-05-26 19:37:24 +00002536 if (InsnNeedsLabel.count(MI) == 0) {
2537 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patelbd477be2010-03-29 17:20:31 +00002538 return;
Devang Patel9fc11702010-05-25 23:40:22 +00002539 }
Devang Patel23b2ae62010-03-29 22:59:58 +00002540
Devang Patel002d54d2010-05-26 19:37:24 +00002541 // Check location.
2542 DebugLoc DL = MI->getDebugLoc();
2543 if (!DL.isUnknown()) {
2544 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2545 PrevLabel = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
Devang Patel6c74a872010-04-27 19:46:33 +00002546 PrevInstLoc = DL;
Devang Patel002d54d2010-05-26 19:37:24 +00002547 LabelsBeforeInsn[MI] = PrevLabel;
2548 return;
Devang Patel6c74a872010-04-27 19:46:33 +00002549 }
Devang Patelbd477be2010-03-29 17:20:31 +00002550
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002551 // If location is unknown then use temp label for this DBG_VALUE
Devang Patel002d54d2010-05-26 19:37:24 +00002552 // instruction.
2553 if (MI->isDebugValue()) {
Devang Patelacc32a52010-05-26 21:23:46 +00002554 PrevLabel = MMI->getContext().CreateTempSymbol();
2555 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00002556 LabelsBeforeInsn[MI] = PrevLabel;
2557 return;
2558 }
2559
2560 if (UnknownLocations) {
2561 PrevLabel = recordSourceLine(0, 0, 0);
2562 LabelsBeforeInsn[MI] = PrevLabel;
2563 return;
2564 }
2565
2566 assert (0 && "Instruction is not processed!");
Devang Patel8db360d2009-10-06 01:50:42 +00002567}
2568
Devang Patelb5694e72010-10-26 17:49:02 +00002569/// endInstruction - Process end of an instruction.
2570void DwarfDebug::endInstruction(const MachineInstr *MI) {
Devang Patel3ebd8932010-04-08 16:50:29 +00002571 if (InsnsEndScopeSet.count(MI) != 0) {
2572 // Emit a label if this instruction ends a scope.
2573 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2574 Asm->OutStreamer.EmitLabel(Label);
Devang Patel6c74a872010-04-27 19:46:33 +00002575 LabelsAfterInsn[MI] = Label;
Devang Patel3ebd8932010-04-08 16:50:29 +00002576 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002577}
2578
Devang Patel6c74a872010-04-27 19:46:33 +00002579/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002580DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel30265c42010-07-07 20:12:52 +00002581 const MDNode *InlinedAt) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002582 if (!InlinedAt) {
2583 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2584 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002585 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002586 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2587 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Patel6c74a872010-04-27 19:46:33 +00002588 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002589 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002590 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Patel6c74a872010-04-27 19:46:33 +00002591 WScope->setParent(Parent);
2592 Parent->addScope(WScope);
2593 }
2594
2595 if (!WScope->getParent()) {
2596 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastings9b5005c2010-06-15 23:06:30 +00002597 // We used to check only for a linkage name, but that fails
2598 // since we began omitting the linkage name for private
2599 // functions. The new way is to check for the name in metadata,
2600 // but that's not supported in old .ll test cases. Ergo, we
2601 // check both.
Stuart Hastingsafe54f12010-06-11 20:08:44 +00002602 if (SPName == Asm->MF->getFunction()->getName() ||
2603 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Patel6c74a872010-04-27 19:46:33 +00002604 CurrentFnDbgScope = WScope;
2605 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002606
Devang Patel6c74a872010-04-27 19:46:33 +00002607 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002608 }
2609
Devang Patel5c0f85c2010-06-25 22:07:34 +00002610 getOrCreateAbstractScope(Scope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002611 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2612 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002613 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002614
2615 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2616 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2617 DILocation DL(InlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002618 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002619 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Patel6c74a872010-04-27 19:46:33 +00002620 WScope->setParent(Parent);
2621 Parent->addScope(WScope);
2622
2623 ConcreteScopes[InlinedAt] = WScope;
Devang Patel6c74a872010-04-27 19:46:33 +00002624
2625 return WScope;
Devang Patel8db360d2009-10-06 01:50:42 +00002626}
2627
Devang Patel6c74a872010-04-27 19:46:33 +00002628/// hasValidLocation - Return true if debug location entry attached with
2629/// machine instruction encodes valid location info.
2630static bool hasValidLocation(LLVMContext &Ctx,
2631 const MachineInstr *MInsn,
Devang Patel32cc43c2010-05-07 20:54:48 +00002632 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Patel6c74a872010-04-27 19:46:33 +00002633 DebugLoc DL = MInsn->getDebugLoc();
2634 if (DL.isUnknown()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002635
Devang Patel32cc43c2010-05-07 20:54:48 +00002636 const MDNode *S = DL.getScope(Ctx);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002637
Devang Patel6c74a872010-04-27 19:46:33 +00002638 // There is no need to create another DIE for compile unit. For all
2639 // other scopes, create one DbgScope now. This will be translated
2640 // into a scope DIE at the end.
2641 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002642
Devang Patel6c74a872010-04-27 19:46:33 +00002643 Scope = S;
2644 InlinedAt = DL.getInlinedAt(Ctx);
2645 return true;
2646}
2647
2648/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2649/// hierarchy.
2650static void calculateDominanceGraph(DbgScope *Scope) {
2651 assert (Scope && "Unable to calculate scop edominance graph!");
2652 SmallVector<DbgScope *, 4> WorkStack;
2653 WorkStack.push_back(Scope);
2654 unsigned Counter = 0;
2655 while (!WorkStack.empty()) {
2656 DbgScope *WS = WorkStack.back();
2657 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2658 bool visitedChildren = false;
2659 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2660 SE = Children.end(); SI != SE; ++SI) {
2661 DbgScope *ChildScope = *SI;
2662 if (!ChildScope->getDFSOut()) {
2663 WorkStack.push_back(ChildScope);
2664 visitedChildren = true;
2665 ChildScope->setDFSIn(++Counter);
2666 break;
2667 }
2668 }
2669 if (!visitedChildren) {
2670 WorkStack.pop_back();
2671 WS->setDFSOut(++Counter);
2672 }
2673 }
2674}
2675
2676/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002677static
Devang Patel6c74a872010-04-27 19:46:33 +00002678void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2679 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2680{
2681#ifndef NDEBUG
2682 unsigned PrevDFSIn = 0;
2683 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2684 I != E; ++I) {
2685 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2686 II != IE; ++II) {
2687 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002688 const MDNode *Scope = NULL;
2689 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002690
2691 // Check if instruction has valid location information.
2692 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2693 dbgs() << " [ ";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002694 if (InlinedAt)
Devang Patel6c74a872010-04-27 19:46:33 +00002695 dbgs() << "*";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002696 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Patel6c74a872010-04-27 19:46:33 +00002697 MI2ScopeMap.find(MInsn);
2698 if (DI != MI2ScopeMap.end()) {
2699 DbgScope *S = DI->second;
2700 dbgs() << S->getDFSIn();
2701 PrevDFSIn = S->getDFSIn();
2702 } else
2703 dbgs() << PrevDFSIn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002704 } else
Devang Patel6c74a872010-04-27 19:46:33 +00002705 dbgs() << " [ x" << PrevDFSIn;
2706 dbgs() << " ]";
2707 MInsn->dump();
2708 }
2709 dbgs() << "\n";
2710 }
2711#endif
2712}
Devang Patel930143b2009-11-21 02:48:08 +00002713/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner848c7d22010-03-31 05:39:57 +00002714/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattner76555b52010-01-26 23:18:02 +00002715bool DwarfDebug::extractScopeInformation() {
Devang Patel75cc16c2009-10-01 20:31:14 +00002716 // If scope information was extracted using .dbg intrinsics then there is not
2717 // any need to extract these information by scanning each instruction.
2718 if (!DbgScopeMap.empty())
2719 return false;
2720
Dan Gohmane9135cb2010-04-23 01:18:53 +00002721 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patel6c74a872010-04-27 19:46:33 +00002722 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2723 SmallVector<DbgRange, 4> MIRanges;
2724 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patel32cc43c2010-05-07 20:54:48 +00002725 const MDNode *PrevScope = NULL;
2726 const MDNode *PrevInlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002727 const MachineInstr *RangeBeginMI = NULL;
2728 const MachineInstr *PrevMI = NULL;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002729 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel75cc16c2009-10-01 20:31:14 +00002730 I != E; ++I) {
2731 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2732 II != IE; ++II) {
2733 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002734 const MDNode *Scope = NULL;
2735 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002736
2737 // Check if instruction has valid location information.
2738 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2739 PrevMI = MInsn;
2740 continue;
2741 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002742
Devang Patel6c74a872010-04-27 19:46:33 +00002743 // If scope has not changed then skip this instruction.
2744 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2745 PrevMI = MInsn;
2746 continue;
2747 }
2748
Devang Pateld12c0a22011-02-15 17:56:09 +00002749 // Ignore DBG_VALUE. It does not contribute any instruction in output.
2750 if (MInsn->isDebugValue())
2751 continue;
2752
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002753 if (RangeBeginMI) {
2754 // If we have alread seen a beginning of a instruction range and
Devang Patel6c74a872010-04-27 19:46:33 +00002755 // current instruction scope does not match scope of first instruction
2756 // in this range then create a new instruction range.
2757 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002758 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel30265c42010-07-07 20:12:52 +00002759 PrevInlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002760 MIRanges.push_back(R);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002761 }
Devang Patel6c74a872010-04-27 19:46:33 +00002762
2763 // This is a beginning of a new instruction range.
2764 RangeBeginMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002765
Devang Patel6c74a872010-04-27 19:46:33 +00002766 // Reset previous markers.
2767 PrevMI = MInsn;
2768 PrevScope = Scope;
2769 PrevInlinedAt = InlinedAt;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002770 }
2771 }
2772
Devang Patel6c74a872010-04-27 19:46:33 +00002773 // Create last instruction range.
2774 if (RangeBeginMI && PrevMI && PrevScope) {
2775 DbgRange R(RangeBeginMI, PrevMI);
2776 MIRanges.push_back(R);
2777 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patel75cc16c2009-10-01 20:31:14 +00002778 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002779
Devang Patel530a0752010-01-04 20:44:00 +00002780 if (!CurrentFnDbgScope)
2781 return false;
2782
Devang Patel6c74a872010-04-27 19:46:33 +00002783 calculateDominanceGraph(CurrentFnDbgScope);
2784 if (PrintDbgScope)
2785 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2786
2787 // Find ranges of instructions covered by each DbgScope;
2788 DbgScope *PrevDbgScope = NULL;
2789 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2790 RE = MIRanges.end(); RI != RE; ++RI) {
2791 const DbgRange &R = *RI;
2792 DbgScope *S = MI2ScopeMap.lookup(R.first);
2793 assert (S && "Lost DbgScope for a machine instruction!");
2794 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2795 PrevDbgScope->closeInsnRange(S);
2796 S->openInsnRange(R.first);
2797 S->extendInsnRange(R.second);
2798 PrevDbgScope = S;
2799 }
2800
2801 if (PrevDbgScope)
2802 PrevDbgScope->closeInsnRange();
Devang Patel75cc16c2009-10-01 20:31:14 +00002803
Devang Patel359b0132010-04-08 18:43:56 +00002804 identifyScopeMarkers();
Devang Patelf1d5a1e2010-04-08 15:37:09 +00002805
2806 return !DbgScopeMap.empty();
2807}
2808
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002809/// identifyScopeMarkers() -
Devang Patel6c74a872010-04-27 19:46:33 +00002810/// Each DbgScope has first instruction and last instruction to mark beginning
2811/// and end of a scope respectively. Create an inverse map that list scopes
2812/// starts (and ends) with an instruction. One instruction may start (or end)
2813/// multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00002814void DwarfDebug::identifyScopeMarkers() {
Devang Patel7771b7c2010-01-20 02:05:23 +00002815 SmallVector<DbgScope *, 4> WorkList;
2816 WorkList.push_back(CurrentFnDbgScope);
2817 while (!WorkList.empty()) {
Chris Lattner848c7d22010-03-31 05:39:57 +00002818 DbgScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002819
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002820 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002821 if (!Children.empty())
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002822 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00002823 SE = Children.end(); SI != SE; ++SI)
2824 WorkList.push_back(*SI);
2825
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002826 if (S->isAbstractScope())
2827 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002828
Devang Patel6c74a872010-04-27 19:46:33 +00002829 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2830 if (Ranges.empty())
2831 continue;
2832 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2833 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002834 assert(RI->first && "DbgRange does not have first instruction!");
2835 assert(RI->second && "DbgRange does not have second instruction!");
Devang Patel6c74a872010-04-27 19:46:33 +00002836 InsnsEndScopeSet.insert(RI->second);
2837 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002838 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002839}
2840
Dan Gohman3df671a2010-04-20 00:37:27 +00002841/// FindFirstDebugLoc - Find the first debug location in the function. This
2842/// is intended to be an approximation for the source position of the
2843/// beginning of the function.
2844static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2845 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2846 I != E; ++I)
2847 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2848 MBBI != MBBE; ++MBBI) {
2849 DebugLoc DL = MBBI->getDebugLoc();
2850 if (!DL.isUnknown())
2851 return DL;
2852 }
2853 return DebugLoc();
2854}
2855
Devang Patela86114b2010-10-25 20:45:32 +00002856#ifndef NDEBUG
2857/// CheckLineNumbers - Count basicblocks whose instructions do not have any
2858/// line number information.
2859static void CheckLineNumbers(const MachineFunction *MF) {
2860 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2861 I != E; ++I) {
2862 bool FoundLineNo = false;
2863 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2864 II != IE; ++II) {
2865 const MachineInstr *MI = II;
2866 if (!MI->getDebugLoc().isUnknown()) {
2867 FoundLineNo = true;
2868 break;
2869 }
2870 }
Devang Patel6e0d5892010-10-28 22:11:59 +00002871 if (!FoundLineNo && I->size())
Devang Patela86114b2010-10-25 20:45:32 +00002872 ++BlocksWithoutLineNo;
2873 }
2874}
2875#endif
2876
Devang Patel930143b2009-11-21 02:48:08 +00002877/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendling2b128d72009-05-20 23:19:06 +00002878/// emitted immediately after the function entry point.
Chris Lattner76555b52010-01-26 23:18:02 +00002879void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00002880 if (!MMI->hasDebugInfo()) return;
Bill Wendlingfcc14142010-04-07 09:28:04 +00002881 if (!extractScopeInformation()) return;
Devang Patel4598eb62009-10-06 18:37:31 +00002882
Devang Patela86114b2010-10-25 20:45:32 +00002883#ifndef NDEBUG
2884 CheckLineNumbers(MF);
2885#endif
2886
Devang Patel6c74a872010-04-27 19:46:33 +00002887 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2888 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00002889 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00002890 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00002891
2892 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2893 // function.
Dan Gohman3df671a2010-04-20 00:37:27 +00002894 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattner915c5f92010-04-02 19:42:39 +00002895 if (FDL.isUnknown()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002896
Devang Patel32cc43c2010-05-07 20:54:48 +00002897 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings61475c52010-07-19 23:56:30 +00002898 const MDNode *TheScope = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002899
Chris Lattner915c5f92010-04-02 19:42:39 +00002900 DISubprogram SP = getDISubprogram(Scope);
2901 unsigned Line, Col;
2902 if (SP.Verify()) {
2903 Line = SP.getLineNumber();
2904 Col = 0;
Stuart Hastings61475c52010-07-19 23:56:30 +00002905 TheScope = SP;
Chris Lattner915c5f92010-04-02 19:42:39 +00002906 } else {
2907 Line = FDL.getLine();
2908 Col = FDL.getCol();
Stuart Hastings61475c52010-07-19 23:56:30 +00002909 TheScope = Scope;
Bill Wendling2b128d72009-05-20 23:19:06 +00002910 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002911
Stuart Hastings61475c52010-07-19 23:56:30 +00002912 recordSourceLine(Line, Col, TheScope);
Devang Patel002d54d2010-05-26 19:37:24 +00002913
Devang Patel21ccf052010-06-02 16:42:51 +00002914 /// ProcessedArgs - Collection of arguments already processed.
2915 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2916
Devang Patel002d54d2010-05-26 19:37:24 +00002917 DebugLoc PrevLoc;
2918 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2919 I != E; ++I)
2920 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2921 II != IE; ++II) {
2922 const MachineInstr *MI = II;
2923 DebugLoc DL = MI->getDebugLoc();
2924 if (MI->isDebugValue()) {
Devang Patel002d54d2010-05-26 19:37:24 +00002925 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2926 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2927 if (!DV.Verify()) continue;
Devang Patel5e6b71c2010-05-27 16:47:30 +00002928 // If DBG_VALUE is for a local variable then it needs a label.
Devang Patelbca5b252010-12-06 22:48:22 +00002929 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
Devang Patel002d54d2010-05-26 19:37:24 +00002930 InsnNeedsLabel.insert(MI);
Devang Patel5e6b71c2010-05-27 16:47:30 +00002931 // DBG_VALUE for inlined functions argument needs a label.
Devang Patel42939752010-07-01 21:38:08 +00002932 else if (!DISubprogram(getDISubprogram(DV.getContext())).
2933 describes(MF->getFunction()))
Devang Patel5e6b71c2010-05-27 16:47:30 +00002934 InsnNeedsLabel.insert(MI);
2935 // DBG_VALUE indicating argument location change needs a label.
Devang Patelbca5b252010-12-06 22:48:22 +00002936 else if (!ProcessedArgs.insert(DV))
Devang Patel002d54d2010-05-26 19:37:24 +00002937 InsnNeedsLabel.insert(MI);
2938 } else {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002939 // If location is unknown then instruction needs a location only if
Devang Patel002d54d2010-05-26 19:37:24 +00002940 // UnknownLocations flag is set.
2941 if (DL.isUnknown()) {
2942 if (UnknownLocations && !PrevLoc.isUnknown())
2943 InsnNeedsLabel.insert(MI);
2944 } else if (DL != PrevLoc)
2945 // Otherwise, instruction needs a location only if it is new location.
2946 InsnNeedsLabel.insert(MI);
2947 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002948
Devang Patel002d54d2010-05-26 19:37:24 +00002949 if (!DL.isUnknown() || UnknownLocations)
2950 PrevLoc = DL;
2951 }
2952
2953 PrevLabel = FunctionBeginSym;
Bill Wendling2b128d72009-05-20 23:19:06 +00002954}
2955
Devang Patel930143b2009-11-21 02:48:08 +00002956/// endFunction - Gather and emit post-function debug information.
Bill Wendling2b128d72009-05-20 23:19:06 +00002957///
Chris Lattner76555b52010-01-26 23:18:02 +00002958void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendlingfcc14142010-04-07 09:28:04 +00002959 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00002960
Devang Patel530a0752010-01-04 20:44:00 +00002961 if (CurrentFnDbgScope) {
Devang Patel4a8e6e82010-05-22 00:04:14 +00002962
Devang Patel9fc11702010-05-25 23:40:22 +00002963 // Define end label for subprogram.
2964 FunctionEndSym = Asm->GetTempSymbol("func_end",
2965 Asm->getFunctionNumber());
2966 // Assumes in correct section after the entry point.
2967 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002968
Devang Patel5c0f85c2010-06-25 22:07:34 +00002969 SmallPtrSet<const MDNode *, 16> ProcessedVars;
2970 collectVariableInfo(MF, ProcessedVars);
Devang Patel4a8e6e82010-05-22 00:04:14 +00002971
Devang Patel530a0752010-01-04 20:44:00 +00002972 // Construct abstract scopes.
2973 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel5c0f85c2010-06-25 22:07:34 +00002974 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00002975 DISubprogram SP((*AI)->getScopeNode());
2976 if (SP.Verify()) {
2977 // Collect info for variables that were optimized out.
2978 StringRef FName = SP.getLinkageName();
2979 if (FName.empty())
2980 FName = SP.getName();
Devang Patel364bf042010-11-10 22:19:21 +00002981 if (NamedMDNode *NMD =
2982 getFnSpecificMDNode(*(MF->getFunction()->getParent()), FName)) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00002983 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002984 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel5c0f85c2010-06-25 22:07:34 +00002985 if (!DV || !ProcessedVars.insert(DV))
2986 continue;
Devang Patel648df7b2010-06-30 00:11:08 +00002987 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel5c0f85c2010-06-25 22:07:34 +00002988 if (Scope)
2989 Scope->addVariable(new DbgVariable(DV));
2990 }
2991 }
2992 }
Devang Patelc5b31092010-06-30 01:40:11 +00002993 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
2994 constructScopeDIE(*AI);
Devang Patel5c0f85c2010-06-25 22:07:34 +00002995 }
Devang Patel30265c42010-07-07 20:12:52 +00002996
Devang Patel075e9b52010-05-04 06:15:30 +00002997 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002998
Devang Patel075e9b52010-05-04 06:15:30 +00002999 if (!DisableFramePointerElim(*MF))
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003000 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel075e9b52010-05-04 06:15:30 +00003001 dwarf::DW_FORM_flag, 1);
3002
3003
Chris Lattner3a383cb2010-04-05 00:13:49 +00003004 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel530a0752010-01-04 20:44:00 +00003005 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00003006 }
3007
Bill Wendling2b128d72009-05-20 23:19:06 +00003008 // Clear debug info
Devang Patelfe189e62010-01-19 01:26:02 +00003009 CurrentFnDbgScope = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +00003010 CurrentFnArguments.clear();
Devang Patel002d54d2010-05-26 19:37:24 +00003011 InsnNeedsLabel.clear();
Devang Patele1c53f22010-05-20 16:36:41 +00003012 DbgVariableToFrameIndexMap.clear();
3013 VarToAbstractVarMap.clear();
3014 DbgVariableToDbgInstMap.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00003015 DeleteContainerSeconds(DbgScopeMap);
Devang Patel541019d2010-04-09 16:04:20 +00003016 InsnsEndScopeSet.clear();
Devang Patelfe189e62010-01-19 01:26:02 +00003017 ConcreteScopes.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00003018 DeleteContainerSeconds(AbstractScopes);
Devang Patelfe189e62010-01-19 01:26:02 +00003019 AbstractScopesList.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00003020 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00003021 LabelsBeforeInsn.clear();
3022 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00003023 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00003024}
3025
Devang Patele1c53f22010-05-20 16:36:41 +00003026/// recordVariableFrameIndex - Record a variable's index.
3027void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
3028 assert (V && "Invalid DbgVariable!");
3029 DbgVariableToFrameIndexMap[V] = Index;
3030}
3031
3032/// findVariableFrameIndex - Return true if frame index for the variable
3033/// is found. Update FI to hold value of the index.
3034bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
3035 assert (V && "Invalid DbgVariable!");
3036 DenseMap<const DbgVariable *, int>::iterator I =
3037 DbgVariableToFrameIndexMap.find(V);
3038 if (I == DbgVariableToFrameIndexMap.end())
3039 return false;
3040 *FI = I->second;
3041 return true;
3042}
3043
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003044/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patel490c8ab2010-05-20 19:57:06 +00003045/// instruction.
3046DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
3047 DbgScope *Scope = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003048 LLVMContext &Ctx =
Devang Patel490c8ab2010-05-20 19:57:06 +00003049 MInsn->getParent()->getParent()->getFunction()->getContext();
3050 DebugLoc DL = MInsn->getDebugLoc();
3051
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003052 if (DL.isUnknown())
Devang Patel490c8ab2010-05-20 19:57:06 +00003053 return Scope;
3054
3055 if (const MDNode *IA = DL.getInlinedAt(Ctx))
3056 Scope = ConcreteScopes.lookup(IA);
3057 if (Scope == 0)
3058 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003059
Devang Patel490c8ab2010-05-20 19:57:06 +00003060 return Scope;
3061}
3062
3063
Chris Lattnerba35a672010-03-09 04:54:43 +00003064/// recordSourceLine - Register a source line with debug info. Returns the
3065/// unique label that was emitted and which provides correspondence to
3066/// the source line list.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003067MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel30265c42010-07-07 20:12:52 +00003068 const MDNode *S) {
Devang Patel2d9caf92009-11-25 17:36:49 +00003069 StringRef Fn;
Devang Patel2089d162009-10-05 18:03:19 +00003070
Dan Gohman50849c62010-05-05 23:41:32 +00003071 unsigned Src = 1;
3072 if (S) {
3073 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00003074
Dan Gohman50849c62010-05-05 23:41:32 +00003075 if (Scope.isCompileUnit()) {
3076 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00003077 Fn = CU.getFilename();
Devang Patelc4b69052010-10-28 17:30:52 +00003078 } else if (Scope.isFile()) {
3079 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00003080 Fn = F.getFilename();
Dan Gohman50849c62010-05-05 23:41:32 +00003081 } else if (Scope.isSubprogram()) {
3082 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00003083 Fn = SP.getFilename();
3084 } else if (Scope.isLexicalBlock()) {
3085 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00003086 Fn = DB.getFilename();
3087 } else
3088 assert(0 && "Unexpected scope info");
3089
Rafael Espindola67c6ab82010-11-18 02:04:25 +00003090 Src = GetOrCreateSourceID(Fn);
Dan Gohman50849c62010-05-05 23:41:32 +00003091 }
3092
Rafael Espindola67c6ab82010-11-18 02:04:25 +00003093 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, DWARF2_FLAG_IS_STMT,
3094 0, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00003095
Rafael Espindola67c6ab82010-11-18 02:04:25 +00003096 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattnerba35a672010-03-09 04:54:43 +00003097 Asm->OutStreamer.EmitLabel(Label);
3098 return Label;
Bill Wendling2b128d72009-05-20 23:19:06 +00003099}
3100
Bill Wendling806535f2009-05-20 23:22:40 +00003101//===----------------------------------------------------------------------===//
3102// Emit Methods
3103//===----------------------------------------------------------------------===//
3104
Devang Patel930143b2009-11-21 02:48:08 +00003105/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling480ff322009-05-20 23:21:38 +00003106///
Jim Grosbach00e9c612009-11-22 19:20:36 +00003107unsigned
3108DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling480ff322009-05-20 23:21:38 +00003109 // Get the children.
3110 const std::vector<DIE *> &Children = Die->getChildren();
3111
3112 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00003113 if (!Last && !Children.empty())
Benjamin Kramer74729ae2010-03-31 19:34:01 +00003114 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling480ff322009-05-20 23:21:38 +00003115
3116 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00003117 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00003118
3119 // Get the abbreviation for this DIE.
3120 unsigned AbbrevNumber = Die->getAbbrevNumber();
3121 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3122
3123 // Set DIE offset
3124 Die->setOffset(Offset);
3125
3126 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00003127 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003128
3129 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
3130 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3131
3132 // Size the DIE attribute values.
3133 for (unsigned i = 0, N = Values.size(); i < N; ++i)
3134 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00003135 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00003136
3137 // Size the DIE children if any.
3138 if (!Children.empty()) {
3139 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
3140 "Children flag not set");
3141
3142 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003143 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling480ff322009-05-20 23:21:38 +00003144
3145 // End of children marker.
3146 Offset += sizeof(int8_t);
3147 }
3148
3149 Die->setSize(Offset - Die->getOffset());
3150 return Offset;
3151}
3152
Devang Patel930143b2009-11-21 02:48:08 +00003153/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling480ff322009-05-20 23:21:38 +00003154///
Devang Patel930143b2009-11-21 02:48:08 +00003155void DwarfDebug::computeSizeAndOffsets() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003156 unsigned PrevOffset = 0;
3157 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3158 E = CUMap.end(); I != E; ++I) {
3159 // Compute size of compile unit header.
3160 static unsigned Offset = PrevOffset +
3161 sizeof(int32_t) + // Length of Compilation Unit Info
3162 sizeof(int16_t) + // DWARF version number
3163 sizeof(int32_t) + // Offset Into Abbrev. Section
3164 sizeof(int8_t); // Pointer Size (in bytes)
3165 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
3166 PrevOffset = Offset;
3167 }
Bill Wendling480ff322009-05-20 23:21:38 +00003168}
3169
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003170/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3171/// temporary label to it if SymbolStem is specified.
Chris Lattner6629ca92010-04-04 22:59:04 +00003172static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003173 const char *SymbolStem = 0) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003174 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003175 if (!SymbolStem) return 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003176
Chris Lattner6629ca92010-04-04 22:59:04 +00003177 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3178 Asm->OutStreamer.EmitLabel(TmpSym);
3179 return TmpSym;
3180}
3181
3182/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3183/// the start of each one.
Chris Lattner46355d82010-04-04 22:33:59 +00003184void DwarfDebug::EmitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003185 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003186
Bill Wendling480ff322009-05-20 23:21:38 +00003187 // Dwarf sections base addresses.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003188 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003189 DwarfFrameSectionSym =
3190 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3191 }
Bill Wendling480ff322009-05-20 23:21:38 +00003192
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003193 DwarfInfoSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003194 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003195 DwarfAbbrevSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003196 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003197 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003198
Chris Lattner6629ca92010-04-04 22:59:04 +00003199 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003200 EmitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003201
Devang Patel4a213872010-08-24 00:06:12 +00003202 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003203 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3204 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3205 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003206 DwarfStrSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003207 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patel12563b32010-04-16 23:33:45 +00003208 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3209 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00003210
Devang Patel9fc11702010-05-25 23:40:22 +00003211 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3212 "section_debug_loc");
3213
Chris Lattner6629ca92010-04-04 22:59:04 +00003214 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattnere58b5472010-04-04 23:10:38 +00003215 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003216}
3217
Devang Patel930143b2009-11-21 02:48:08 +00003218/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling480ff322009-05-20 23:21:38 +00003219///
Devang Patel930143b2009-11-21 02:48:08 +00003220void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00003221 // Get the abbreviation for this DIE.
3222 unsigned AbbrevNumber = Die->getAbbrevNumber();
3223 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3224
Bill Wendling480ff322009-05-20 23:21:38 +00003225 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00003226 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00003227 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3228 Twine::utohexstr(Die->getOffset()) + ":0x" +
3229 Twine::utohexstr(Die->getSize()) + " " +
3230 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00003231 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003232
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00003233 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00003234 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3235
3236 // Emit the DIE attribute values.
3237 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3238 unsigned Attr = AbbrevData[i].getAttribute();
3239 unsigned Form = AbbrevData[i].getForm();
3240 assert(Form && "Too many attributes for DIE (check abbreviation)");
3241
Chris Lattner7bde8c02010-04-04 18:52:31 +00003242 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00003243 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003244
Bill Wendling480ff322009-05-20 23:21:38 +00003245 switch (Attr) {
3246 case dwarf::DW_AT_sibling:
Devang Patel930143b2009-11-21 02:48:08 +00003247 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003248 break;
3249 case dwarf::DW_AT_abstract_origin: {
3250 DIEEntry *E = cast<DIEEntry>(Values[i]);
3251 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003252 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00003253 Asm->EmitInt32(Addr);
3254 break;
3255 }
Devang Patel12563b32010-04-16 23:33:45 +00003256 case dwarf::DW_AT_ranges: {
3257 // DW_AT_range Value encodes offset in debug_range section.
3258 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00003259
3260 if (Asm->MAI->doesDwarfUsesLabelOffsetForRanges()) {
3261 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
3262 V->getValue(),
3263 4);
3264 } else {
3265 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3266 V->getValue(),
3267 DwarfDebugRangeSectionSym,
3268 4);
3269 }
Devang Patel12563b32010-04-16 23:33:45 +00003270 break;
3271 }
Devang Patel9fc11702010-05-25 23:40:22 +00003272 case dwarf::DW_AT_location: {
3273 if (UseDotDebugLocEntry.count(Die) != 0) {
3274 DIELabel *L = cast<DIELabel>(Values[i]);
3275 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
3276 } else
3277 Values[i]->EmitValue(Asm, Form);
3278 break;
3279 }
Devang Patela1bd5a12010-09-29 19:08:08 +00003280 case dwarf::DW_AT_accessibility: {
3281 if (Asm->isVerbose()) {
3282 DIEInteger *V = cast<DIEInteger>(Values[i]);
3283 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
3284 }
3285 Values[i]->EmitValue(Asm, Form);
3286 break;
3287 }
Bill Wendling480ff322009-05-20 23:21:38 +00003288 default:
3289 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003290 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00003291 break;
3292 }
Bill Wendling480ff322009-05-20 23:21:38 +00003293 }
3294
3295 // Emit the DIE children if any.
3296 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3297 const std::vector<DIE *> &Children = Die->getChildren();
3298
3299 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003300 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00003301
Chris Lattner7bde8c02010-04-04 18:52:31 +00003302 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00003303 Asm->OutStreamer.AddComment("End Of Children Mark");
3304 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003305 }
3306}
3307
Devang Patel9ccfb642009-12-09 18:24:21 +00003308/// emitDebugInfo - Emit the debug info section.
Bill Wendling480ff322009-05-20 23:21:38 +00003309///
Devang Patel9ccfb642009-12-09 18:24:21 +00003310void DwarfDebug::emitDebugInfo() {
3311 // Start debug info section.
3312 Asm->OutStreamer.SwitchSection(
3313 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel1a0df9a2010-05-10 22:49:55 +00003314 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3315 E = CUMap.end(); I != E; ++I) {
3316 CompileUnit *TheCU = I->second;
3317 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003318
Devang Patel1a0df9a2010-05-10 22:49:55 +00003319 // Emit the compile units header.
3320 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3321 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003322
Devang Patel1a0df9a2010-05-10 22:49:55 +00003323 // Emit size of content not including length itself
3324 unsigned ContentSize = Die->getSize() +
3325 sizeof(int16_t) + // DWARF version number
3326 sizeof(int32_t) + // Offset Into Abbrev. Section
3327 sizeof(int8_t) + // Pointer Size (in bytes)
3328 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003329
Devang Patel1a0df9a2010-05-10 22:49:55 +00003330 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3331 Asm->EmitInt32(ContentSize);
3332 Asm->OutStreamer.AddComment("DWARF version number");
3333 Asm->EmitInt16(dwarf::DWARF_VERSION);
3334 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3335 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3336 DwarfAbbrevSectionSym);
3337 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3338 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003339
Devang Patel1a0df9a2010-05-10 22:49:55 +00003340 emitDIE(Die);
3341 // FIXME - extra padding for gdb bug.
3342 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3343 Asm->EmitInt8(0);
3344 Asm->EmitInt8(0);
3345 Asm->EmitInt8(0);
3346 Asm->EmitInt8(0);
3347 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3348 }
Bill Wendling480ff322009-05-20 23:21:38 +00003349}
3350
Devang Patel930143b2009-11-21 02:48:08 +00003351/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling480ff322009-05-20 23:21:38 +00003352///
Devang Patel930143b2009-11-21 02:48:08 +00003353void DwarfDebug::emitAbbreviations() const {
Bill Wendling480ff322009-05-20 23:21:38 +00003354 // Check to see if it is worth the effort.
3355 if (!Abbreviations.empty()) {
3356 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003357 Asm->OutStreamer.SwitchSection(
3358 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003359
Chris Lattnera179b522010-04-04 19:25:43 +00003360 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003361
3362 // For each abbrevation.
3363 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3364 // Get abbreviation data
3365 const DIEAbbrev *Abbrev = Abbreviations[i];
3366
3367 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00003368 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00003369
3370 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003371 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00003372 }
3373
3374 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00003375 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00003376
Chris Lattnera179b522010-04-04 19:25:43 +00003377 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003378 }
3379}
3380
Devang Patel930143b2009-11-21 02:48:08 +00003381/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling480ff322009-05-20 23:21:38 +00003382/// the line matrix.
3383///
Devang Patel930143b2009-11-21 02:48:08 +00003384void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00003385 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00003386 Asm->OutStreamer.AddComment("Extended Op");
3387 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003388
Chris Lattner566cae92010-03-09 23:52:58 +00003389 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003390 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00003391 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3392 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3393
3394 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00003395
Chris Lattnera179b522010-04-04 19:25:43 +00003396 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003397 Asm->getTargetData().getPointerSize(),
3398 0/*AddrSpace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003399
3400 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00003401 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3402 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003403 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00003404 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003405}
3406
Devang Patel930143b2009-11-21 02:48:08 +00003407/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling480ff322009-05-20 23:21:38 +00003408///
Devang Patel930143b2009-11-21 02:48:08 +00003409void DwarfDebug::emitCommonDebugFrame() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003410 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003411 return;
3412
Chris Lattner3a383cb2010-04-05 00:13:49 +00003413 int stackGrowth = Asm->getTargetData().getPointerSize();
Anton Korobeynikov2f931282011-01-10 12:39:04 +00003414 if (Asm->TM.getFrameLowering()->getStackGrowthDirection() ==
3415 TargetFrameLowering::StackGrowsDown)
Chris Lattner3a383cb2010-04-05 00:13:49 +00003416 stackGrowth *= -1;
Bill Wendling480ff322009-05-20 23:21:38 +00003417
3418 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003419 Asm->OutStreamer.SwitchSection(
3420 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003421
Chris Lattnera179b522010-04-04 19:25:43 +00003422 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner566cae92010-03-09 23:52:58 +00003423 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003424 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3425 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003426
Chris Lattnera179b522010-04-04 19:25:43 +00003427 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner566cae92010-03-09 23:52:58 +00003428 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling480ff322009-05-20 23:21:38 +00003429 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner566cae92010-03-09 23:52:58 +00003430 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling480ff322009-05-20 23:21:38 +00003431 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner566cae92010-03-09 23:52:58 +00003432 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003433 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner9efd1182010-04-04 19:09:29 +00003434 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3435 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner566cae92010-03-09 23:52:58 +00003436 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003437 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Anton Korobeynikov2f931282011-01-10 12:39:04 +00003438 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
Bill Wendling480ff322009-05-20 23:21:38 +00003439 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling480ff322009-05-20 23:21:38 +00003440
3441 std::vector<MachineMove> Moves;
Anton Korobeynikov14ee3442010-11-18 23:25:52 +00003442 TFI->getInitialFrameState(Moves);
Bill Wendling480ff322009-05-20 23:21:38 +00003443
Chris Lattneraabc6042010-04-04 23:41:46 +00003444 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003445
Chris Lattner9e06e532010-04-28 01:05:45 +00003446 Asm->EmitAlignment(2);
Chris Lattnera179b522010-04-04 19:25:43 +00003447 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003448}
3449
Devang Patel930143b2009-11-21 02:48:08 +00003450/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling480ff322009-05-20 23:21:38 +00003451/// section.
Chris Lattner2c3f4782010-03-13 07:26:18 +00003452void DwarfDebug::
3453emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003454 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003455 return;
3456
3457 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003458 Asm->OutStreamer.SwitchSection(
3459 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003460
Chris Lattner566cae92010-03-09 23:52:58 +00003461 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner2c3f4782010-03-13 07:26:18 +00003462 MCSymbol *DebugFrameBegin =
Chris Lattnera179b522010-04-04 19:25:43 +00003463 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003464 MCSymbol *DebugFrameEnd =
Chris Lattnera179b522010-04-04 19:25:43 +00003465 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnerf1429f12010-04-04 19:58:12 +00003466 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003467
Chris Lattner2c3f4782010-03-13 07:26:18 +00003468 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling480ff322009-05-20 23:21:38 +00003469
Chris Lattner566cae92010-03-09 23:52:58 +00003470 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003471 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner70a4fce2010-04-04 23:25:33 +00003472 DwarfFrameSectionSym);
Bill Wendling480ff322009-05-20 23:21:38 +00003473
Chris Lattner566cae92010-03-09 23:52:58 +00003474 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnera179b522010-04-04 19:25:43 +00003475 MCSymbol *FuncBeginSym =
3476 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattner8811e122010-03-13 07:40:56 +00003477 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattner3a383cb2010-04-05 00:13:49 +00003478 Asm->getTargetData().getPointerSize(),
3479 0/*AddrSpace*/);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003480
3481
Chris Lattner566cae92010-03-09 23:52:58 +00003482 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003483 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003484 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003485
Chris Lattneraabc6042010-04-04 23:41:46 +00003486 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003487
Chris Lattner9e06e532010-04-28 01:05:45 +00003488 Asm->EmitAlignment(2);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003489 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling480ff322009-05-20 23:21:38 +00003490}
3491
Devang Patel9ccfb642009-12-09 18:24:21 +00003492/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3493///
3494void DwarfDebug::emitDebugPubNames() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003495 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3496 E = CUMap.end(); I != E; ++I) {
3497 CompileUnit *TheCU = I->second;
3498 // Start the dwarf pubnames section.
3499 Asm->OutStreamer.SwitchSection(
3500 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003501
Devang Patel1a0df9a2010-05-10 22:49:55 +00003502 Asm->OutStreamer.AddComment("Length of Public Names Info");
3503 Asm->EmitLabelDifference(
3504 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3505 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003506
Devang Patel1a0df9a2010-05-10 22:49:55 +00003507 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3508 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003509
Devang Patel1a0df9a2010-05-10 22:49:55 +00003510 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003511 Asm->EmitInt16(dwarf::DWARF_VERSION);
3512
Devang Patel1a0df9a2010-05-10 22:49:55 +00003513 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003514 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00003515 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003516
Devang Patel1a0df9a2010-05-10 22:49:55 +00003517 Asm->OutStreamer.AddComment("Compilation Unit Length");
3518 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3519 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3520 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003521
Devang Patel1a0df9a2010-05-10 22:49:55 +00003522 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3523 for (StringMap<DIE*>::const_iterator
3524 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3525 const char *Name = GI->getKeyData();
3526 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003527
Devang Patel1a0df9a2010-05-10 22:49:55 +00003528 Asm->OutStreamer.AddComment("DIE offset");
3529 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003530
Devang Patel1a0df9a2010-05-10 22:49:55 +00003531 if (Asm->isVerbose())
3532 Asm->OutStreamer.AddComment("External Name");
3533 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3534 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003535
Devang Patel1a0df9a2010-05-10 22:49:55 +00003536 Asm->OutStreamer.AddComment("End Mark");
3537 Asm->EmitInt32(0);
3538 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3539 TheCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00003540 }
Bill Wendling480ff322009-05-20 23:21:38 +00003541}
3542
Devang Patel04d2f2d2009-11-24 01:14:22 +00003543void DwarfDebug::emitDebugPubTypes() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003544 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3545 E = CUMap.end(); I != E; ++I) {
3546 CompileUnit *TheCU = I->second;
3547 // Start the dwarf pubnames section.
3548 Asm->OutStreamer.SwitchSection(
3549 Asm->getObjFileLowering().getDwarfPubTypesSection());
3550 Asm->OutStreamer.AddComment("Length of Public Types Info");
3551 Asm->EmitLabelDifference(
3552 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3553 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003554
Devang Patel1a0df9a2010-05-10 22:49:55 +00003555 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3556 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003557
Devang Patel1a0df9a2010-05-10 22:49:55 +00003558 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3559 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003560
Devang Patel1a0df9a2010-05-10 22:49:55 +00003561 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3562 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3563 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003564
Devang Patel1a0df9a2010-05-10 22:49:55 +00003565 Asm->OutStreamer.AddComment("Compilation Unit Length");
3566 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3567 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3568 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003569
Devang Patel1a0df9a2010-05-10 22:49:55 +00003570 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3571 for (StringMap<DIE*>::const_iterator
3572 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3573 const char *Name = GI->getKeyData();
3574 DIE * Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003575
Devang Patel1a0df9a2010-05-10 22:49:55 +00003576 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3577 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003578
Devang Patel1a0df9a2010-05-10 22:49:55 +00003579 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3580 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3581 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003582
Devang Patel1a0df9a2010-05-10 22:49:55 +00003583 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003584 Asm->EmitInt32(0);
Devang Patel1a0df9a2010-05-10 22:49:55 +00003585 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3586 TheCU->getID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00003587 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00003588}
3589
Devang Patel930143b2009-11-21 02:48:08 +00003590/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling480ff322009-05-20 23:21:38 +00003591///
Devang Patel930143b2009-11-21 02:48:08 +00003592void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00003593 // Check to see if it is worth the effort.
Chris Lattner3d72a672010-03-09 23:38:23 +00003594 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003595
Chris Lattner3d72a672010-03-09 23:38:23 +00003596 // Start the dwarf str section.
3597 Asm->OutStreamer.SwitchSection(
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003598 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003599
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003600 // Get all of the string pool entries and put them in an array by their ID so
3601 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003602 SmallVector<std::pair<unsigned,
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003603 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003604
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003605 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3606 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3607 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003608
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003609 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003610
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003611 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00003612 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003613 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003614
Chris Lattner3d72a672010-03-09 23:38:23 +00003615 // Emit the string itself.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003616 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003617 }
3618}
3619
Devang Patel930143b2009-11-21 02:48:08 +00003620/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling480ff322009-05-20 23:21:38 +00003621///
Devang Patel930143b2009-11-21 02:48:08 +00003622void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003623 if (DotDebugLocEntries.empty())
3624 return;
3625
Devang Patel116a9d72011-02-04 22:57:18 +00003626 for (SmallVector<DotDebugLocEntry, 4>::iterator
3627 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
3628 I != E; ++I) {
3629 DotDebugLocEntry &Entry = *I;
3630 if (I + 1 != DotDebugLocEntries.end())
3631 Entry.Merge(I+1);
3632 }
3633
Bill Wendling480ff322009-05-20 23:21:38 +00003634 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003635 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00003636 Asm->getObjFileLowering().getDwarfLocSection());
3637 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003638 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3639 unsigned index = 1;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003640 for (SmallVector<DotDebugLocEntry, 4>::iterator
3641 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00003642 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00003643 DotDebugLocEntry &Entry = *I;
3644 if (Entry.isMerged()) continue;
Devang Patel9fc11702010-05-25 23:40:22 +00003645 if (Entry.isEmpty()) {
3646 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3647 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003648 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00003649 } else {
3650 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3651 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3652 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3653 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patel0e60e672010-08-04 18:40:52 +00003654 if (int Offset = Entry.Loc.getOffset()) {
3655 // If the value is at a certain offset from frame register then
3656 // use DW_OP_fbreg.
3657 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patel9fc11702010-05-25 23:40:22 +00003658 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patel0e60e672010-08-04 18:40:52 +00003659 Asm->EmitInt16(1 + OffsetSize);
3660 Asm->OutStreamer.AddComment(
3661 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3662 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3663 Asm->OutStreamer.AddComment("Offset");
3664 Asm->EmitSLEB128(Offset);
Devang Patel9fc11702010-05-25 23:40:22 +00003665 } else {
Devang Patel0e60e672010-08-04 18:40:52 +00003666 if (Reg < 32) {
3667 Asm->OutStreamer.AddComment("Loc expr size");
3668 Asm->EmitInt16(1);
3669 Asm->OutStreamer.AddComment(
Devang Patel6d21f612010-08-04 20:32:36 +00003670 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patel0e60e672010-08-04 18:40:52 +00003671 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3672 } else {
3673 Asm->OutStreamer.AddComment("Loc expr size");
3674 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3675 Asm->EmitInt8(dwarf::DW_OP_regx);
3676 Asm->EmitULEB128(Reg);
3677 }
Devang Patel9fc11702010-05-25 23:40:22 +00003678 }
3679 }
3680 }
Bill Wendling480ff322009-05-20 23:21:38 +00003681}
3682
3683/// EmitDebugARanges - Emit visible names into a debug aranges section.
3684///
3685void DwarfDebug::EmitDebugARanges() {
3686 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003687 Asm->OutStreamer.SwitchSection(
3688 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003689}
3690
Devang Patel930143b2009-11-21 02:48:08 +00003691/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling480ff322009-05-20 23:21:38 +00003692///
Devang Patel930143b2009-11-21 02:48:08 +00003693void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00003694 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003695 Asm->OutStreamer.SwitchSection(
Devang Patel12563b32010-04-16 23:33:45 +00003696 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Patel6c74a872010-04-27 19:46:33 +00003697 unsigned char Size = Asm->getTargetData().getPointerSize();
3698 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003699 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00003700 I != E; ++I) {
3701 if (*I)
3702 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patel12563b32010-04-16 23:33:45 +00003703 else
Devang Patel6c74a872010-04-27 19:46:33 +00003704 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel12563b32010-04-16 23:33:45 +00003705 }
Bill Wendling480ff322009-05-20 23:21:38 +00003706}
3707
Devang Patel930143b2009-11-21 02:48:08 +00003708/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling480ff322009-05-20 23:21:38 +00003709///
Devang Patel930143b2009-11-21 02:48:08 +00003710void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003711 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00003712 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00003713 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003714 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003715 }
3716}
3717
Devang Patel930143b2009-11-21 02:48:08 +00003718/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling480ff322009-05-20 23:21:38 +00003719/// Section Header:
3720/// 1. length of section
3721/// 2. Dwarf version number
3722/// 3. address size.
3723///
3724/// Entries (one "entry" for each function that was inlined):
3725///
3726/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3727/// otherwise offset into __debug_str for regular function name.
3728/// 2. offset into __debug_str section for regular function name.
3729/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3730/// instances for the function.
3731///
3732/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3733/// inlined instance; the die_offset points to the inlined_subroutine die in the
3734/// __debug_info section, and the low_pc is the starting address for the
3735/// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00003736void DwarfDebug::emitDebugInlineInfo() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003737 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003738 return;
3739
Devang Patel1a0df9a2010-05-10 22:49:55 +00003740 if (!FirstCU)
Bill Wendling480ff322009-05-20 23:21:38 +00003741 return;
3742
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003743 Asm->OutStreamer.SwitchSection(
3744 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003745
Chris Lattner566cae92010-03-09 23:52:58 +00003746 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003747 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3748 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003749
Chris Lattnera179b522010-04-04 19:25:43 +00003750 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003751
Chris Lattner566cae92010-03-09 23:52:58 +00003752 Asm->OutStreamer.AddComment("Dwarf Version");
3753 Asm->EmitInt16(dwarf::DWARF_VERSION);
3754 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003755 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003756
Devang Patel32cc43c2010-05-07 20:54:48 +00003757 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003758 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00003759
Devang Patel32cc43c2010-05-07 20:54:48 +00003760 const MDNode *Node = *I;
3761 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00003762 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003763 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00003764 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00003765 StringRef LName = SP.getLinkageName();
3766 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00003767
Chris Lattner566cae92010-03-09 23:52:58 +00003768 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003769 if (LName.empty()) {
3770 Asm->OutStreamer.EmitBytes(Name, 0);
3771 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003772 } else
Chris Lattner70a4fce2010-04-04 23:25:33 +00003773 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3774 DwarfStrSectionSym);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003775
Chris Lattner566cae92010-03-09 23:52:58 +00003776 Asm->OutStreamer.AddComment("Function name");
Chris Lattner70a4fce2010-04-04 23:25:33 +00003777 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner9efd1182010-04-04 19:09:29 +00003778 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00003779
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003780 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00003781 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner7bde8c02010-04-04 18:52:31 +00003782 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner085b6522010-03-09 00:31:02 +00003783 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003784
Chris Lattner7bde8c02010-04-04 18:52:31 +00003785 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003786 Asm->OutStreamer.EmitSymbolValue(LI->first,
3787 Asm->getTargetData().getPointerSize(),0);
Bill Wendling480ff322009-05-20 23:21:38 +00003788 }
3789 }
3790
Chris Lattnera179b522010-04-04 19:25:43 +00003791 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003792}