blob: 440099f607dad951c901349c0d57510bf8c8fd79 [file] [log] [blame]
Bill Wendling2f921f82009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Chris Lattnerb14490d2010-03-09 00:39:24 +000013
Devang Patel80ae3492009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling2f921f82009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000016#include "DIE.h"
Bill Wendling30346342010-04-05 22:59:21 +000017#include "llvm/Constants.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000018#include "llvm/Module.h"
Devang Patel2d9e5322011-01-20 00:02:16 +000019#include "llvm/Instructions.h"
David Greene829b3e82009-08-19 21:52:55 +000020#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000021#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000022#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000023#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000024#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000025#include "llvm/MC/MCSymbol.h"
Chris Lattnerf62e3ee2010-01-16 21:57:06 +000026#include "llvm/Target/Mangler.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000027#include "llvm/Target/TargetData.h"
Anton Korobeynikov2f931282011-01-10 12:39:04 +000028#include "llvm/Target/TargetFrameLowering.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000029#include "llvm/Target/TargetLoweringObjectFile.h"
Chris Lattner21dc46e2010-04-04 18:06:11 +000030#include "llvm/Target/TargetMachine.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000031#include "llvm/Target/TargetRegisterInfo.h"
Devang Patel61880932010-04-19 19:14:02 +000032#include "llvm/Target/TargetOptions.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000033#include "llvm/Analysis/DebugInfo.h"
Devang Patela5d93242011-02-24 18:49:30 +000034#include "llvm/Analysis/DIBuilder.h"
Devang Patela86114b2010-10-25 20:45:32 +000035#include "llvm/ADT/Statistic.h"
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000036#include "llvm/ADT/STLExtras.h"
Chris Lattner06fa1762009-08-24 03:52:50 +000037#include "llvm/ADT/StringExtras.h"
Devang Patel6c74a872010-04-27 19:46:33 +000038#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000039#include "llvm/Support/Debug.h"
40#include "llvm/Support/ErrorHandling.h"
Devang Patel1973df22010-01-26 21:39:14 +000041#include "llvm/Support/ValueHandle.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000042#include "llvm/Support/FormattedStream.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000043#include "llvm/Support/Timer.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000044#include "llvm/Support/Path.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000045using namespace llvm;
46
Devang Patel6c74a872010-04-27 19:46:33 +000047static cl::opt<bool> PrintDbgScope("print-dbgscope", cl::Hidden,
48 cl::desc("Print DbgScope information for each machine instruction"));
49
Jim Grosbacha8683bb2010-07-21 21:21:52 +000050static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel30265c42010-07-07 20:12:52 +000051 cl::Hidden,
Devang Patel6c74a872010-04-27 19:46:33 +000052 cl::desc("Disable debug info printing"));
53
Dan Gohman7421ae42010-05-07 01:08:53 +000054static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
55 cl::desc("Make an absense of debug location information explicit."),
56 cl::init(false));
57
Nick Lewycky90b2ac22010-10-26 00:51:57 +000058#ifndef NDEBUG
Devang Patela86114b2010-10-25 20:45:32 +000059STATISTIC(BlocksWithoutLineNo, "Number of blocks without any line number");
Nick Lewycky90b2ac22010-10-26 00:51:57 +000060#endif
Devang Patela86114b2010-10-25 20:45:32 +000061
Bill Wendlingfcc14142010-04-07 09:28:04 +000062namespace {
63 const char *DWARFGroupName = "DWARF Emission";
64 const char *DbgTimerName = "DWARF Debug Writer";
65} // end anonymous namespace
66
Bill Wendling2f921f82009-05-15 09:23:25 +000067//===----------------------------------------------------------------------===//
68
69/// Configuration values for initial hash set sizes (log2).
70///
Bill Wendling2f921f82009-05-15 09:23:25 +000071static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +000072
73namespace llvm {
74
75//===----------------------------------------------------------------------===//
76/// CompileUnit - This dwarf writer support class manages information associate
77/// with a source file.
Nick Lewyckyb7993d62009-11-17 08:11:44 +000078class CompileUnit {
Bill Wendling2f921f82009-05-15 09:23:25 +000079 /// ID - File identifier for source.
80 ///
81 unsigned ID;
82
83 /// Die - Compile unit debug information entry.
84 ///
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000085 const OwningPtr<DIE> CUDie;
Bill Wendling2f921f82009-05-15 09:23:25 +000086
Jeffrey Yasskin0708de12010-03-11 18:29:55 +000087 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
Devang Patel92e8c652009-11-21 00:31:03 +000088 DIE *IndexTyDie;
89
Devang Patel9a0339f2010-07-07 20:49:57 +000090 /// MDNodeToDieMap - Tracks the mapping of unit level debug informaton
Bill Wendling2f921f82009-05-15 09:23:25 +000091 /// variables to debug information entries.
Devang Patel9a0339f2010-07-07 20:49:57 +000092 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
Bill Wendling2f921f82009-05-15 09:23:25 +000093
Devang Patel9a0339f2010-07-07 20:49:57 +000094 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug informaton
Bill Wendling2f921f82009-05-15 09:23:25 +000095 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patel9a0339f2010-07-07 20:49:57 +000096 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
Bill Wendling2f921f82009-05-15 09:23:25 +000097
98 /// Globals - A map of globally visible named entities for this unit.
99 ///
100 StringMap<DIE*> Globals;
101
Devang Patel04d2f2d2009-11-24 01:14:22 +0000102 /// GlobalTypes - A map of globally visible types for this unit.
103 ///
104 StringMap<DIE*> GlobalTypes;
105
Bill Wendling2f921f82009-05-15 09:23:25 +0000106public:
107 CompileUnit(unsigned I, DIE *D)
Devang Patel930143b2009-11-21 02:48:08 +0000108 : ID(I), CUDie(D), IndexTyDie(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000109
110 // Accessors.
Devang Patel04d2f2d2009-11-24 01:14:22 +0000111 unsigned getID() const { return ID; }
Jeffrey Yasskin0708de12010-03-11 18:29:55 +0000112 DIE* getCUDie() const { return CUDie.get(); }
Devang Patel04d2f2d2009-11-24 01:14:22 +0000113 const StringMap<DIE*> &getGlobals() const { return Globals; }
114 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000115
116 /// hasContent - Return true if this compile unit has something to write out.
117 ///
Devang Patel930143b2009-11-21 02:48:08 +0000118 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000119
Devang Patel930143b2009-11-21 02:48:08 +0000120 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +0000121 ///
Benjamin Kramer96956ed2010-03-31 20:15:45 +0000122 void addGlobal(StringRef Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000123
Devang Patel04d2f2d2009-11-24 01:14:22 +0000124 /// addGlobalType - Add a new global type to the compile unit.
125 ///
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000126 void addGlobalType(StringRef Name, DIE *Die) {
127 GlobalTypes[Name] = Die;
Devang Patel04d2f2d2009-11-24 01:14:22 +0000128 }
129
Devang Patele064ad42009-11-20 21:37:22 +0000130 /// getDIE - Returns the debug information entry map slot for the
Bill Wendling2f921f82009-05-15 09:23:25 +0000131 /// specified debug variable.
Devang Patel9a0339f2010-07-07 20:49:57 +0000132 DIE *getDIE(const MDNode *N) { return MDNodeToDieMap.lookup(N); }
Jim Grosbach042483e2009-11-21 23:12:12 +0000133
Devang Patele064ad42009-11-20 21:37:22 +0000134 /// insertDIE - Insert DIE into the map.
Devang Patel32cc43c2010-05-07 20:54:48 +0000135 void insertDIE(const MDNode *N, DIE *D) {
Devang Patel9a0339f2010-07-07 20:49:57 +0000136 MDNodeToDieMap.insert(std::make_pair(N, D));
Devang Patele064ad42009-11-20 21:37:22 +0000137 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000138
Devang Patele064ad42009-11-20 21:37:22 +0000139 /// getDIEEntry - Returns the debug information entry for the speciefied
140 /// debug variable.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000141 DIEEntry *getDIEEntry(const MDNode *N) {
142 DenseMap<const MDNode *, DIEEntry *>::iterator I =
143 MDNodeToDIEEntryMap.find(N);
Devang Patel9a0339f2010-07-07 20:49:57 +0000144 if (I == MDNodeToDIEEntryMap.end())
Devang Patel1f4690c2009-12-15 19:16:48 +0000145 return NULL;
146 return I->second;
147 }
Devang Patele064ad42009-11-20 21:37:22 +0000148
149 /// insertDIEEntry - Insert debug information entry into the map.
Devang Patel32cc43c2010-05-07 20:54:48 +0000150 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
Devang Patel9a0339f2010-07-07 20:49:57 +0000151 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
Bill Wendling2f921f82009-05-15 09:23:25 +0000152 }
153
Devang Patel930143b2009-11-21 02:48:08 +0000154 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +0000155 ///
Devang Patel930143b2009-11-21 02:48:08 +0000156 void addDie(DIE *Buffer) {
157 this->CUDie->addChild(Buffer);
Bill Wendling2f921f82009-05-15 09:23:25 +0000158 }
Devang Patel92e8c652009-11-21 00:31:03 +0000159
160 // getIndexTyDie - Get an anonymous type for index type.
161 DIE *getIndexTyDie() {
162 return IndexTyDie;
163 }
164
Jim Grosbach00e9c612009-11-22 19:20:36 +0000165 // setIndexTyDie - Set D as anonymous type for index which can be reused
166 // later.
Devang Patel92e8c652009-11-21 00:31:03 +0000167 void setIndexTyDie(DIE *D) {
168 IndexTyDie = D;
169 }
170
Bill Wendling2f921f82009-05-15 09:23:25 +0000171};
172
173//===----------------------------------------------------------------------===//
174/// DbgVariable - This class is used to track local variable information.
175///
Devang Patelf3d7c082009-11-16 21:53:40 +0000176class DbgVariable {
Bill Wendling2f921f82009-05-15 09:23:25 +0000177 DIVariable Var; // Variable Descriptor.
Devang Patel9fc11702010-05-25 23:40:22 +0000178 DIE *TheDIE; // Variable DIE.
179 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
Bill Wendling2f921f82009-05-15 09:23:25 +0000180public:
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000181 // AbsVar may be NULL.
Devang Patel9fc11702010-05-25 23:40:22 +0000182 DbgVariable(DIVariable V) : Var(V), TheDIE(0), DotDebugLocOffset(~0U) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000183
184 // Accessors.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000185 DIVariable getVariable() const { return Var; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000186 void setDIE(DIE *D) { TheDIE = D; }
187 DIE *getDIE() const { return TheDIE; }
Devang Patel9fc11702010-05-25 23:40:22 +0000188 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
189 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000190 StringRef getName() const { return Var.getName(); }
191 unsigned getTag() const { return Var.getTag(); }
192 bool variableHasComplexAddress() const {
193 assert(Var.Verify() && "Invalid complex DbgVariable!");
194 return Var.hasComplexAddress();
195 }
196 bool isBlockByrefVariable() const {
197 assert(Var.Verify() && "Invalid complex DbgVariable!");
198 return Var.isBlockByrefVariable();
199 }
200 unsigned getNumAddrElements() const {
201 assert(Var.Verify() && "Invalid complex DbgVariable!");
202 return Var.getNumAddrElements();
203 }
204 uint64_t getAddrElement(unsigned i) const {
205 return Var.getAddrElement(i);
206 }
207 DIType getType() const {
208 DIType Ty = Var.getType();
209 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
210 // addresses instead.
211 if (Var.isBlockByrefVariable()) {
212 /* Byref variables, in Blocks, are declared by the programmer as
213 "SomeType VarName;", but the compiler creates a
214 __Block_byref_x_VarName struct, and gives the variable VarName
215 either the struct, or a pointer to the struct, as its type. This
216 is necessary for various behind-the-scenes things the compiler
217 needs to do with by-reference variables in blocks.
218
219 However, as far as the original *programmer* is concerned, the
220 variable should still have type 'SomeType', as originally declared.
221
222 The following function dives into the __Block_byref_x_VarName
223 struct to find the original type of the variable. This will be
224 passed back to the code generating the type for the Debug
225 Information Entry for the variable 'VarName'. 'VarName' will then
226 have the original type 'SomeType' in its debug information.
227
228 The original type 'SomeType' will be the type of the field named
229 'VarName' inside the __Block_byref_x_VarName struct.
230
231 NOTE: In order for this to not completely fail on the debugger
232 side, the Debug Information Entry for the variable VarName needs to
233 have a DW_AT_location that tells the debugger how to unwind through
234 the pointers and __Block_byref_x_VarName struct to find the actual
235 value of the variable. The function addBlockByrefType does this. */
236 DIType subType = Ty;
237 unsigned tag = Ty.getTag();
238
239 if (tag == dwarf::DW_TAG_pointer_type) {
240 DIDerivedType DTy = DIDerivedType(Ty);
241 subType = DTy.getTypeDerivedFrom();
242 }
243
244 DICompositeType blockStruct = DICompositeType(subType);
245 DIArray Elements = blockStruct.getTypeArray();
246
247 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
248 DIDescriptor Element = Elements.getElement(i);
249 DIDerivedType DT = DIDerivedType(Element);
250 if (getName() == DT.getName())
251 return (DT.getTypeDerivedFrom());
252 }
253 return Ty;
254 }
255 return Ty;
256 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000257};
258
259//===----------------------------------------------------------------------===//
Devang Patel6c74a872010-04-27 19:46:33 +0000260/// DbgRange - This is used to track range of instructions with identical
261/// debug info scope.
262///
263typedef std::pair<const MachineInstr *, const MachineInstr *> DbgRange;
264
265//===----------------------------------------------------------------------===//
Bill Wendling2f921f82009-05-15 09:23:25 +0000266/// DbgScope - This class is used to track scope information.
267///
Devang Patelf3d7c082009-11-16 21:53:40 +0000268class DbgScope {
Bill Wendling2f921f82009-05-15 09:23:25 +0000269 DbgScope *Parent; // Parent to this scope.
Jim Grosbach042483e2009-11-21 23:12:12 +0000270 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel1973df22010-01-26 21:39:14 +0000271 // Location at which this scope is inlined.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000272 AssertingVH<const MDNode> InlinedAtLocation;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000273 bool AbstractScope; // Abstract Scope
Devang Patel787f94c2009-10-01 18:25:23 +0000274 const MachineInstr *LastInsn; // Last instruction of this scope.
275 const MachineInstr *FirstInsn; // First instruction of this scope.
Devang Patel6c74a872010-04-27 19:46:33 +0000276 unsigned DFSIn, DFSOut;
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000277 // Scopes defined in scope. Contents not owned.
278 SmallVector<DbgScope *, 4> Scopes;
279 // Variables declared in scope. Contents owned.
280 SmallVector<DbgVariable *, 8> Variables;
Devang Patel6c74a872010-04-27 19:46:33 +0000281 SmallVector<DbgRange, 4> Ranges;
Owen Anderson9becc182009-06-24 22:53:20 +0000282 // Private state for dump()
283 mutable unsigned IndentLevel;
Bill Wendling2f921f82009-05-15 09:23:25 +0000284public:
Devang Patel32cc43c2010-05-07 20:54:48 +0000285 DbgScope(DbgScope *P, DIDescriptor D, const MDNode *I = 0)
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000286 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Devang Patel6c74a872010-04-27 19:46:33 +0000287 LastInsn(0), FirstInsn(0),
288 DFSIn(0), DFSOut(0), IndentLevel(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000289 virtual ~DbgScope();
290
291 // Accessors.
292 DbgScope *getParent() const { return Parent; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000293 void setParent(DbgScope *P) { Parent = P; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000294 DIDescriptor getDesc() const { return Desc; }
Devang Patel32cc43c2010-05-07 20:54:48 +0000295 const MDNode *getInlinedAt() const { return InlinedAtLocation; }
296 const MDNode *getScopeNode() const { return Desc; }
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000297 const SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
Devang Patel406798a2010-08-09 18:51:29 +0000298 const SmallVector<DbgVariable *, 8> &getDbgVariables() { return Variables; }
Devang Patel6c74a872010-04-27 19:46:33 +0000299 const SmallVector<DbgRange, 4> &getRanges() { return Ranges; }
300
301 /// openInsnRange - This scope covers instruction range starting from MI.
302 void openInsnRange(const MachineInstr *MI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000303 if (!FirstInsn)
Devang Patel6c74a872010-04-27 19:46:33 +0000304 FirstInsn = MI;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000305
Devang Patel6c74a872010-04-27 19:46:33 +0000306 if (Parent)
307 Parent->openInsnRange(MI);
308 }
309
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000310 /// extendInsnRange - Extend the current instruction range covered by
Devang Patel6c74a872010-04-27 19:46:33 +0000311 /// this scope.
312 void extendInsnRange(const MachineInstr *MI) {
313 assert (FirstInsn && "MI Range is not open!");
314 LastInsn = MI;
315 if (Parent)
316 Parent->extendInsnRange(MI);
317 }
318
319 /// closeInsnRange - Create a range based on FirstInsn and LastInsn collected
320 /// until now. This is used when a new scope is encountered while walking
321 /// machine instructions.
322 void closeInsnRange(DbgScope *NewScope = NULL) {
323 assert (LastInsn && "Last insn missing!");
324 Ranges.push_back(DbgRange(FirstInsn, LastInsn));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000325 FirstInsn = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +0000326 LastInsn = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000327 // If Parent dominates NewScope then do not close Parent's instruction
Devang Patel6c74a872010-04-27 19:46:33 +0000328 // range.
329 if (Parent && (!NewScope || !Parent->dominates(NewScope)))
330 Parent->closeInsnRange(NewScope);
331 }
332
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000333 void setAbstractScope() { AbstractScope = true; }
334 bool isAbstractScope() const { return AbstractScope; }
Devang Patel6c74a872010-04-27 19:46:33 +0000335
336 // Depth First Search support to walk and mainpluate DbgScope hierarchy.
337 unsigned getDFSOut() const { return DFSOut; }
338 void setDFSOut(unsigned O) { DFSOut = O; }
339 unsigned getDFSIn() const { return DFSIn; }
340 void setDFSIn(unsigned I) { DFSIn = I; }
341 bool dominates(const DbgScope *S) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000342 if (S == this)
Devang Patel6c74a872010-04-27 19:46:33 +0000343 return true;
344 if (DFSIn < S->getDFSIn() && DFSOut > S->getDFSOut())
345 return true;
346 return false;
347 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000348
Devang Patel930143b2009-11-21 02:48:08 +0000349 /// addScope - Add a scope to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000350 ///
Devang Patel930143b2009-11-21 02:48:08 +0000351 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000352
Devang Patel930143b2009-11-21 02:48:08 +0000353 /// addVariable - Add a variable to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000354 ///
Devang Patel930143b2009-11-21 02:48:08 +0000355 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000356
Bill Wendling2f921f82009-05-15 09:23:25 +0000357#ifndef NDEBUG
358 void dump() const;
359#endif
360};
Devang Patel6c74a872010-04-27 19:46:33 +0000361
Chris Lattnerf5d06362010-04-05 04:09:20 +0000362} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000363
364#ifndef NDEBUG
365void DbgScope::dump() const {
David Greenec230cb92009-12-24 00:31:35 +0000366 raw_ostream &err = dbgs();
Chris Lattner81e8e022009-08-23 00:51:00 +0000367 err.indent(IndentLevel);
Devang Patel32cc43c2010-05-07 20:54:48 +0000368 const MDNode *N = Desc;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000369 N->dump();
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000370 if (AbstractScope)
371 err << "Abstract Scope\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000372
373 IndentLevel += 2;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000374 if (!Scopes.empty())
375 err << "Children ...\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000376 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
377 if (Scopes[i] != this)
378 Scopes[i]->dump();
379
380 IndentLevel -= 2;
381}
382#endif
383
Bill Wendling2f921f82009-05-15 09:23:25 +0000384DbgScope::~DbgScope() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000385 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
386 delete Variables[j];
Bill Wendling2f921f82009-05-15 09:23:25 +0000387}
388
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000389DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Devang Patel1a0df9a2010-05-10 22:49:55 +0000390 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000391 AbbreviationsSet(InitAbbreviationsSetSize),
Devang Patel12563b32010-04-16 23:33:45 +0000392 CurrentFnDbgScope(0), PrevLabel(NULL) {
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000393 NextStringPoolNumber = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000394
Chris Lattnere58b5472010-04-04 23:10:38 +0000395 DwarfFrameSectionSym = DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
396 DwarfStrSectionSym = TextSectionSym = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000397 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000398 FunctionBeginSym = FunctionEndSym = 0;
Devang Patel9c160e12010-07-08 20:10:35 +0000399 DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
Dan Gohman6e681a52010-06-18 15:56:31 +0000400 {
401 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
402 beginModule(M);
Torok Edwinf8dba242010-04-07 10:44:46 +0000403 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000404}
405DwarfDebug::~DwarfDebug() {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000406 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
407 DIEBlocks[j]->~DIEBlock();
Bill Wendling2f921f82009-05-15 09:23:25 +0000408}
409
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000410MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
411 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
412 if (Entry.first) return Entry.first;
413
414 Entry.second = NextStringPoolNumber++;
Chris Lattnera179b522010-04-04 19:25:43 +0000415 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000416}
417
418
Devang Patel930143b2009-11-21 02:48:08 +0000419/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling2f921f82009-05-15 09:23:25 +0000420///
Devang Patel930143b2009-11-21 02:48:08 +0000421void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000422 // Profile the node so that we can make it unique.
423 FoldingSetNodeID ID;
424 Abbrev.Profile(ID);
425
426 // Check the set for priors.
427 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
428
429 // If it's newly added.
430 if (InSet == &Abbrev) {
431 // Add to abbreviation list.
432 Abbreviations.push_back(&Abbrev);
433
434 // Assign the vector position + 1 as its number.
435 Abbrev.setNumber(Abbreviations.size());
436 } else {
437 // Assign existing abbreviation number.
438 Abbrev.setNumber(InSet->getNumber());
439 }
440}
441
Devang Patel930143b2009-11-21 02:48:08 +0000442/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendlingbcad77a2009-05-20 23:24:48 +0000443/// information entry.
Devang Patel930143b2009-11-21 02:48:08 +0000444DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000445 DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000446 return Value;
447}
448
Devang Patel930143b2009-11-21 02:48:08 +0000449/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000450///
Devang Patel930143b2009-11-21 02:48:08 +0000451void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000452 unsigned Form, uint64_t Integer) {
453 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000454 DIEValue *Value = Integer == 1 ?
Devang Patel9c160e12010-07-08 20:10:35 +0000455 DIEIntegerOne : new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000456 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000457}
458
Devang Patel930143b2009-11-21 02:48:08 +0000459/// addSInt - Add an signed integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000460///
Devang Patel930143b2009-11-21 02:48:08 +0000461void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000462 unsigned Form, int64_t Integer) {
463 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000464 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000465 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000466}
467
Devang Patel8c339592009-12-02 15:25:16 +0000468/// addString - Add a string attribute data and value. DIEString only
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000469/// keeps string reference.
Devang Patel930143b2009-11-21 02:48:08 +0000470void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerc3f23b82010-01-23 03:11:46 +0000471 StringRef String) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000472 DIEValue *Value = new (DIEValueAllocator) DIEString(String);
Devang Patel930143b2009-11-21 02:48:08 +0000473 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000474}
475
Devang Patel930143b2009-11-21 02:48:08 +0000476/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000477///
Devang Patel930143b2009-11-21 02:48:08 +0000478void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000479 const MCSymbol *Label) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000480 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
Devang Patel930143b2009-11-21 02:48:08 +0000481 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000482}
483
Devang Patel930143b2009-11-21 02:48:08 +0000484/// addDelta - Add a label delta attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000485///
Devang Patel930143b2009-11-21 02:48:08 +0000486void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000487 const MCSymbol *Hi, const MCSymbol *Lo) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000488 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
Devang Patel930143b2009-11-21 02:48:08 +0000489 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000490}
491
Chris Lattner3f3fb972010-04-05 05:24:55 +0000492/// addDIEEntry - Add a DIE attribute data and value.
493///
494void DwarfDebug::addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form,
495 DIE *Entry) {
496 Die->addValue(Attribute, Form, createDIEEntry(Entry));
497}
498
499
Devang Patel930143b2009-11-21 02:48:08 +0000500/// addBlock - Add block data.
Bill Wendling2f921f82009-05-15 09:23:25 +0000501///
Devang Patel930143b2009-11-21 02:48:08 +0000502void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling2f921f82009-05-15 09:23:25 +0000503 DIEBlock *Block) {
Chris Lattner5a00dea2010-04-05 00:18:22 +0000504 Block->ComputeSize(Asm);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000505 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
Devang Patel930143b2009-11-21 02:48:08 +0000506 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000507}
508
Devang Patel930143b2009-11-21 02:48:08 +0000509/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000510/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000511void DwarfDebug::addSourceLine(DIE *Die, DIVariable V) {
Devang Patel0625af22010-05-07 23:33:41 +0000512 // Verify variable.
Devang Patelb6511a32010-08-09 20:20:05 +0000513 if (!V.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000514 return;
515
Devang Patelb6511a32010-08-09 20:20:05 +0000516 unsigned Line = V.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000517 if (Line == 0)
518 return;
Devang Patele01b75c2011-03-24 20:30:50 +0000519 unsigned FileID = GetOrCreateSourceID(V.getContext().getFilename(),
520 V.getContext().getDirectory());
Bill Wendling2f921f82009-05-15 09:23:25 +0000521 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000522 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
523 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000524}
525
Devang Patel930143b2009-11-21 02:48:08 +0000526/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000527/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000528void DwarfDebug::addSourceLine(DIE *Die, DIGlobalVariable G) {
Devang Patel0625af22010-05-07 23:33:41 +0000529 // Verify global variable.
Devang Patelb6511a32010-08-09 20:20:05 +0000530 if (!G.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000531 return;
532
Devang Patelb6511a32010-08-09 20:20:05 +0000533 unsigned Line = G.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000534 if (Line == 0)
535 return;
Devang Patele01b75c2011-03-24 20:30:50 +0000536 unsigned FileID = GetOrCreateSourceID(G.getContext().getFilename(),
537 G.getContext().getDirectory());
Bill Wendling2f921f82009-05-15 09:23:25 +0000538 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000539 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
540 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000541}
Devang Patelb2de5fa2009-08-31 22:47:13 +0000542
Devang Patel930143b2009-11-21 02:48:08 +0000543/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000544/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000545void DwarfDebug::addSourceLine(DIE *Die, DISubprogram SP) {
Devang Patel0625af22010-05-07 23:33:41 +0000546 // Verify subprogram.
Devang Patelb6511a32010-08-09 20:20:05 +0000547 if (!SP.Verify())
Devang Patelb2de5fa2009-08-31 22:47:13 +0000548 return;
Caroline Tice183a5192009-09-11 18:25:54 +0000549 // If the line number is 0, don't add it.
Devang Patelb6511a32010-08-09 20:20:05 +0000550 if (SP.getLineNumber() == 0)
Caroline Tice183a5192009-09-11 18:25:54 +0000551 return;
552
Devang Patelb6511a32010-08-09 20:20:05 +0000553 unsigned Line = SP.getLineNumber();
554 if (!SP.getContext().Verify())
Devang Patel8119fe872010-03-08 22:02:50 +0000555 return;
Devang Patele01b75c2011-03-24 20:30:50 +0000556 unsigned FileID = GetOrCreateSourceID(SP.getFilename(), SP.getDirectory());
Devang Patelb2de5fa2009-08-31 22:47:13 +0000557 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000558 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
559 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patelb2de5fa2009-08-31 22:47:13 +0000560}
561
Devang Patel930143b2009-11-21 02:48:08 +0000562/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000563/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000564void DwarfDebug::addSourceLine(DIE *Die, DIType Ty) {
Devang Patel0625af22010-05-07 23:33:41 +0000565 // Verify type.
Devang Patelb6511a32010-08-09 20:20:05 +0000566 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000567 return;
568
Devang Patelb6511a32010-08-09 20:20:05 +0000569 unsigned Line = Ty.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000570 if (Line == 0 || !Ty.getContext().Verify())
Devang Patel8119fe872010-03-08 22:02:50 +0000571 return;
Devang Patele01b75c2011-03-24 20:30:50 +0000572 unsigned FileID = GetOrCreateSourceID(Ty.getFilename(), Ty.getDirectory());
Bill Wendling2f921f82009-05-15 09:23:25 +0000573 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000574 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
575 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000576}
577
Devang Patel1f4690c2009-12-15 19:16:48 +0000578/// addSourceLine - Add location information to specified debug information
579/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000580void DwarfDebug::addSourceLine(DIE *Die, DINameSpace NS) {
Devang Patel0625af22010-05-07 23:33:41 +0000581 // Verify namespace.
Devang Patelb6511a32010-08-09 20:20:05 +0000582 if (!NS.Verify())
Devang Patel1f4690c2009-12-15 19:16:48 +0000583 return;
584
Devang Patelb6511a32010-08-09 20:20:05 +0000585 unsigned Line = NS.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000586 if (Line == 0)
587 return;
Devang Patelb6511a32010-08-09 20:20:05 +0000588 StringRef FN = NS.getFilename();
Devang Patel1f4690c2009-12-15 19:16:48 +0000589
Devang Patele01b75c2011-03-24 20:30:50 +0000590 unsigned FileID = GetOrCreateSourceID(FN, NS.getDirectory());
Devang Patel1f4690c2009-12-15 19:16:48 +0000591 assert(FileID && "Invalid file id");
592 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
593 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
594}
595
Devang Patel2cfc3af2010-08-31 06:11:28 +0000596/// addVariableAddress - Add DW_AT_location attribute for a DbgVariable based
597/// on provided frame index.
598void DwarfDebug::addVariableAddress(DbgVariable *&DV, DIE *Die, int64_t FI) {
599 MachineLocation Location;
600 unsigned FrameReg;
Anton Korobeynikov2f931282011-01-10 12:39:04 +0000601 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
Anton Korobeynikov46877782010-11-20 15:59:32 +0000602 int Offset = TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
Devang Patel2cfc3af2010-08-31 06:11:28 +0000603 Location.set(FrameReg, Offset);
604
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000605 if (DV->variableHasComplexAddress())
606 addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
607 else if (DV->isBlockByrefVariable())
608 addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
609 else
610 addAddress(Die, dwarf::DW_AT_location, Location);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000611}
612
Devang Patel930143b2009-11-21 02:48:08 +0000613/// addComplexAddress - Start with the address based on the location provided,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000614/// and generate the DWARF information necessary to find the actual variable
615/// given the extra address information encoded in the DIVariable, starting from
616/// the starting location. Add the DWARF information to the die.
617///
Devang Patel930143b2009-11-21 02:48:08 +0000618void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000619 unsigned Attribute,
620 const MachineLocation &Location) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000621 DIType Ty = DV->getType();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000622
623 // Decode the original location, and use that as the start of the byref
624 // variable's location.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000625 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000626 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000627 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000628
629 if (Location.isReg()) {
630 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000631 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000632 } else {
Devang Patel8698f092011-01-19 23:04:47 +0000633 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
Devang Patel930143b2009-11-21 02:48:08 +0000634 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000635 }
636 } else {
637 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000638 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000639 else {
Devang Patel930143b2009-11-21 02:48:08 +0000640 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
641 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000642 }
643
Devang Patel930143b2009-11-21 02:48:08 +0000644 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump14cf8ec2009-09-30 00:08:22 +0000645 }
646
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000647 for (unsigned i = 0, N = DV->getNumAddrElements(); i < N; ++i) {
648 uint64_t Element = DV->getAddrElement(i);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000649
Devang Patela5d93242011-02-24 18:49:30 +0000650 if (Element == DIBuilder::OpPlus) {
Devang Patel930143b2009-11-21 02:48:08 +0000651 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000652 addUInt(Block, 0, dwarf::DW_FORM_udata, DV->getAddrElement(++i));
Devang Patela5d93242011-02-24 18:49:30 +0000653 } else if (Element == DIBuilder::OpDeref) {
Devang Patel930143b2009-11-21 02:48:08 +0000654 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Devang Patela5d93242011-02-24 18:49:30 +0000655 } else llvm_unreachable("unknown DIBuilder Opcode");
Mike Stump14cf8ec2009-09-30 00:08:22 +0000656 }
657
658 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000659 addBlock(Die, Attribute, 0, Block);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000660}
661
Caroline Ticec87c1e22009-08-31 21:19:37 +0000662/* Byref variables, in Blocks, are declared by the programmer as "SomeType
663 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
664 gives the variable VarName either the struct, or a pointer to the struct, as
665 its type. This is necessary for various behind-the-scenes things the
666 compiler needs to do with by-reference variables in Blocks.
667
668 However, as far as the original *programmer* is concerned, the variable
669 should still have type 'SomeType', as originally declared.
670
Devang Patel930143b2009-11-21 02:48:08 +0000671 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticec87c1e22009-08-31 21:19:37 +0000672 struct to find the original type of the variable, which is then assigned to
673 the variable's Debug Information Entry as its real type. So far, so good.
674 However now the debugger will expect the variable VarName to have the type
675 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000676 expression that explains to the debugger how to navigate through the
Caroline Ticec87c1e22009-08-31 21:19:37 +0000677 pointers and struct to find the actual variable of type SomeType.
678
679 The following function does just that. We start by getting
680 the "normal" location for the variable. This will be the location
681 of either the struct __Block_byref_x_VarName or the pointer to the
682 struct __Block_byref_x_VarName.
683
684 The struct will look something like:
685
686 struct __Block_byref_x_VarName {
687 ... <various fields>
688 struct __Block_byref_x_VarName *forwarding;
689 ... <various other fields>
690 SomeType VarName;
691 ... <maybe more fields>
692 };
693
694 If we are given the struct directly (as our starting point) we
695 need to tell the debugger to:
696
697 1). Add the offset of the forwarding field.
698
Dan Gohman4a618822010-02-10 16:03:48 +0000699 2). Follow that pointer to get the real __Block_byref_x_VarName
Caroline Ticec87c1e22009-08-31 21:19:37 +0000700 struct to use (the real one may have been copied onto the heap).
701
702 3). Add the offset for the field VarName, to find the actual variable.
703
704 If we started with a pointer to the struct, then we need to
705 dereference that pointer first, before the other steps.
706 Translating this into DWARF ops, we will need to append the following
707 to the current location description for the variable:
708
709 DW_OP_deref -- optional, if we start with a pointer
710 DW_OP_plus_uconst <forward_fld_offset>
711 DW_OP_deref
712 DW_OP_plus_uconst <varName_fld_offset>
713
714 That is what this function does. */
715
Devang Patel930143b2009-11-21 02:48:08 +0000716/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticec87c1e22009-08-31 21:19:37 +0000717/// provided, and generate the DWARF information necessary to find the
718/// actual Block variable (navigating the Block struct) based on the
719/// starting location. Add the DWARF information to the die. For
720/// more information, read large comment just above here.
721///
Devang Patel930143b2009-11-21 02:48:08 +0000722void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000723 unsigned Attribute,
724 const MachineLocation &Location) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000725 DIType Ty = DV->getType();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000726 DIType TmpTy = Ty;
727 unsigned Tag = Ty.getTag();
728 bool isPointer = false;
729
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000730 StringRef varName = DV->getName();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000731
732 if (Tag == dwarf::DW_TAG_pointer_type) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000733 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000734 TmpTy = DTy.getTypeDerivedFrom();
735 isPointer = true;
736 }
737
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000738 DICompositeType blockStruct = DICompositeType(TmpTy);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000739
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000740 // Find the __forwarding field and the variable field in the __Block_byref
741 // struct.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000742 DIArray Fields = blockStruct.getTypeArray();
743 DIDescriptor varField = DIDescriptor();
744 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000745
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000746 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
747 DIDescriptor Element = Fields.getElement(i);
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000748 DIDerivedType DT = DIDerivedType(Element);
Devang Patel2d9caf92009-11-25 17:36:49 +0000749 StringRef fieldName = DT.getName();
750 if (fieldName == "__forwarding")
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000751 forwardingField = Element;
Devang Patel2d9caf92009-11-25 17:36:49 +0000752 else if (fieldName == varName)
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000753 varField = Element;
754 }
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000755
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000756 // Get the offsets for the forwarding field and the variable field.
Chris Lattner71696ef2010-03-31 06:06:37 +0000757 unsigned forwardingFieldOffset =
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000758 DIDerivedType(forwardingField).getOffsetInBits() >> 3;
Chris Lattner71696ef2010-03-31 06:06:37 +0000759 unsigned varFieldOffset =
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000760 DIDerivedType(varField).getOffsetInBits() >> 3;
Caroline Ticec87c1e22009-08-31 21:19:37 +0000761
Mike Stump944fa252009-09-24 23:21:26 +0000762 // Decode the original location, and use that as the start of the byref
763 // variable's location.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000764 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000765 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000766 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000767
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000768 if (Location.isReg()) {
769 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000770 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000771 else {
Devang Patel8698f092011-01-19 23:04:47 +0000772 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
Devang Patel930143b2009-11-21 02:48:08 +0000773 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000774 }
775 } else {
776 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000777 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000778 else {
Devang Patel930143b2009-11-21 02:48:08 +0000779 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
780 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000781 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000782
Devang Patel930143b2009-11-21 02:48:08 +0000783 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000784 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000785
Mike Stump944fa252009-09-24 23:21:26 +0000786 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000787 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000788 if (isPointer)
Devang Patel930143b2009-11-21 02:48:08 +0000789 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000790
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000791 // Next add the offset for the '__forwarding' field:
792 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
793 // adding the offset if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000794 if (forwardingFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000795 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
796 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000797 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000798
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000799 // Now dereference the __forwarding field to get to the real __Block_byref
800 // struct: DW_OP_deref.
Devang Patel930143b2009-11-21 02:48:08 +0000801 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000802
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000803 // Now that we've got the real __Block_byref... struct, add the offset
804 // for the variable's field to get to the location of the actual variable:
805 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000806 if (varFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000807 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
808 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000809 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000810
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000811 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000812 addBlock(Die, Attribute, 0, Block);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000813}
814
Devang Patel930143b2009-11-21 02:48:08 +0000815/// addAddress - Add an address attribute to a die based on the location
Bill Wendling2f921f82009-05-15 09:23:25 +0000816/// provided.
Devang Patel930143b2009-11-21 02:48:08 +0000817void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000818 const MachineLocation &Location) {
Chris Lattner3a383cb2010-04-05 00:13:49 +0000819 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling2f921f82009-05-15 09:23:25 +0000820 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000821 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel804fcd42010-09-22 21:10:38 +0000822
Devang Patele7559662010-11-02 17:37:00 +0000823 if (RI->getFrameRegister(*Asm->MF) == Location.getReg()
Devang Patel804fcd42010-09-22 21:10:38 +0000824 && Location.getOffset()) {
825 // If variable offset is based in frame register then use fbreg.
826 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
827 addSInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
828 addBlock(Die, Attribute, 0, Block);
829 return;
830 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000831
832 if (Location.isReg()) {
833 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000834 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000835 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000836 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
837 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000838 }
839 } else {
840 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000841 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000842 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000843 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
844 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000845 }
846
Devang Patel930143b2009-11-21 02:48:08 +0000847 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling2f921f82009-05-15 09:23:25 +0000848 }
849
Devang Patel930143b2009-11-21 02:48:08 +0000850 addBlock(Die, Attribute, 0, Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000851}
852
Devang Patel173b2b92010-04-28 01:03:09 +0000853/// addRegisterAddress - Add register location entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000854bool DwarfDebug::addRegisterAddress(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000855 assert (MO.isReg() && "Invalid machine operand!");
856 if (!MO.getReg())
857 return false;
858 MachineLocation Location;
859 Location.set(MO.getReg());
860 addAddress(Die, dwarf::DW_AT_location, Location);
Devang Patel173b2b92010-04-28 01:03:09 +0000861 return true;
862}
863
864/// addConstantValue - Add constant value entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000865bool DwarfDebug::addConstantValue(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000866 assert (MO.isImm() && "Invalid machine operand!");
867 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
868 unsigned Imm = MO.getImm();
869 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
870 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patel173b2b92010-04-28 01:03:09 +0000871 return true;
872}
873
874/// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000875bool DwarfDebug::addConstantFPValue(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000876 assert (MO.isFPImm() && "Invalid machine operand!");
877 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
878 APFloat FPImm = MO.getFPImm()->getValueAPF();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000879
Devang Patel173b2b92010-04-28 01:03:09 +0000880 // Get the raw data form of the floating point.
881 const APInt FltVal = FPImm.bitcastToAPInt();
882 const char *FltPtr = (const char*)FltVal.getRawData();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000883
Devang Patel173b2b92010-04-28 01:03:09 +0000884 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
885 bool LittleEndian = Asm->getTargetData().isLittleEndian();
886 int Incr = (LittleEndian ? 1 : -1);
887 int Start = (LittleEndian ? 0 : NumBytes - 1);
888 int Stop = (LittleEndian ? NumBytes : -1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000889
Devang Patel173b2b92010-04-28 01:03:09 +0000890 // Output the constant to DWARF one byte at a time.
891 for (; Start != Stop; Start += Incr)
892 addUInt(Block, 0, dwarf::DW_FORM_data1,
893 (unsigned char)0xFF & FltPtr[Start]);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000894
Devang Patel173b2b92010-04-28 01:03:09 +0000895 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000896 return true;
Devang Patel173b2b92010-04-28 01:03:09 +0000897}
898
Devang Patel70eb9822011-01-06 21:39:25 +0000899/// addConstantValue - Add constant value entry in variable DIE.
900bool DwarfDebug::addConstantValue(DIE *Die, ConstantInt *CI,
901 bool Unsigned) {
902 if (CI->getBitWidth() <= 64) {
903 if (Unsigned)
904 addUInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
905 CI->getZExtValue());
906 else
907 addSInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
908 CI->getSExtValue());
909 return true;
910 }
911
912 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
913
914 // Get the raw data form of the large APInt.
915 const APInt Val = CI->getValue();
916 const char *Ptr = (const char*)Val.getRawData();
917
918 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
919 bool LittleEndian = Asm->getTargetData().isLittleEndian();
920 int Incr = (LittleEndian ? 1 : -1);
921 int Start = (LittleEndian ? 0 : NumBytes - 1);
922 int Stop = (LittleEndian ? NumBytes : -1);
923
924 // Output the constant to DWARF one byte at a time.
925 for (; Start != Stop; Start += Incr)
926 addUInt(Block, 0, dwarf::DW_FORM_data1,
927 (unsigned char)0xFF & Ptr[Start]);
928
929 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
930 return true;
931}
Devang Patel173b2b92010-04-28 01:03:09 +0000932
Devang Pateld4e20ea2011-04-05 21:08:24 +0000933/// addTemplateParams - Add template parameters in buffer.
934void DwarfDebug::addTemplateParams(DIE &Buffer, DIArray TParams) {
935 // Add template parameters.
936 for (unsigned i = 0, e = TParams.getNumElements(); i != e; ++i) {
937 DIDescriptor Element = TParams.getElement(i);
938 if (Element.isTemplateTypeParameter())
939 Buffer.addChild(getOrCreateTemplateTypeParameterDIE(
940 DITemplateTypeParameter(Element)));
941 else if (Element.isTemplateValueParameter())
942 Buffer.addChild(getOrCreateTemplateValueParameterDIE(
943 DITemplateValueParameter(Element)));
944 }
945
946}
Devang Patel2b75ed22009-12-10 19:14:49 +0000947/// addToContextOwner - Add Die into the list of its context owner's children.
948void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000949 if (Context.isType()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000950 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
Devang Patel2b75ed22009-12-10 19:14:49 +0000951 ContextDIE->addChild(Die);
Devang Patel1f4690c2009-12-15 19:16:48 +0000952 } else if (Context.isNameSpace()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000953 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
Devang Patel1f4690c2009-12-15 19:16:48 +0000954 ContextDIE->addChild(Die);
Stuart Hastingsafe54f12010-06-11 20:08:44 +0000955 } else if (Context.isSubprogram()) {
Devang Patel185051c2010-09-27 23:15:27 +0000956 DIE *ContextDIE = createSubprogramDIE(DISubprogram(Context));
Stuart Hastingsafe54f12010-06-11 20:08:44 +0000957 ContextDIE->addChild(Die);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000958 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patel2b75ed22009-12-10 19:14:49 +0000959 ContextDIE->addChild(Die);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000960 else
Devang Patel1a0df9a2010-05-10 22:49:55 +0000961 getCompileUnit(Context)->addDie(Die);
Devang Patel2b75ed22009-12-10 19:14:49 +0000962}
963
Devang Patelb5b60ea2009-12-10 18:05:33 +0000964/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
965/// given DIType.
966DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000967 CompileUnit *TypeCU = getCompileUnit(Ty);
968 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000969 if (TyDIE)
970 return TyDIE;
971
972 // Create new type.
973 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000974 TypeCU->insertDIE(Ty, TyDIE);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000975 if (Ty.isBasicType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000976 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000977 else if (Ty.isCompositeType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000978 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000979 else {
980 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000981 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000982 }
983
Devang Patel2b75ed22009-12-10 19:14:49 +0000984 addToContextOwner(TyDIE, Ty.getContext());
Devang Patelb5b60ea2009-12-10 18:05:33 +0000985 return TyDIE;
986}
987
Devang Patel930143b2009-11-21 02:48:08 +0000988/// addType - Add a new type attribute to the specified entity.
Devang Patel9ccfb642009-12-09 18:24:21 +0000989void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel8d6a2b72010-05-07 21:45:47 +0000990 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000991 return;
992
993 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000994 CompileUnit *TypeCU = getCompileUnit(Ty);
995 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000996 // If it exists then use the existing value.
Devang Patel930143b2009-11-21 02:48:08 +0000997 if (Entry) {
998 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000999 return;
1000 }
1001
Bill Wendling2f921f82009-05-15 09:23:25 +00001002 // Construct type.
Devang Patelb5b60ea2009-12-10 18:05:33 +00001003 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +00001004
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001005 // Set up proxy.
1006 Entry = createDIEEntry(Buffer);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001007 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001008
Devang Patel930143b2009-11-21 02:48:08 +00001009 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +00001010}
1011
Devang Patel930143b2009-11-21 02:48:08 +00001012/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001013void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001014 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +00001015 StringRef Name = BTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001016 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +00001017 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling2f921f82009-05-15 09:23:25 +00001018 BTy.getEncoding());
1019
1020 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +00001021 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001022 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001023 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel930143b2009-11-21 02:48:08 +00001024 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001025}
1026
Devang Patel930143b2009-11-21 02:48:08 +00001027/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001028void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001029 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +00001030 StringRef Name = DTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001031 uint64_t Size = DTy.getSizeInBits() >> 3;
1032 unsigned Tag = DTy.getTag();
1033
1034 // FIXME - Workaround for templates.
1035 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
1036
1037 Buffer.setTag(Tag);
1038
1039 // Map to main type, void will not have a type.
1040 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel9ccfb642009-12-09 18:24:21 +00001041 addType(&Buffer, FromTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001042
1043 // Add name if not anonymous or intermediate type.
Devang Patelae466ef2009-11-30 23:56:56 +00001044 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001045 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001046
1047 // Add size if non-zero (derived types might be zero-sized.)
1048 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +00001049 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001050
1051 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patelb5b51592009-11-23 18:43:37 +00001052 if (!DTy.isForwardDecl())
Devang Patelb6511a32010-08-09 20:20:05 +00001053 addSourceLine(&Buffer, DTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001054}
1055
Devang Patel930143b2009-11-21 02:48:08 +00001056/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001057void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001058 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +00001059 StringRef Name = CTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001060
1061 uint64_t Size = CTy.getSizeInBits() >> 3;
1062 unsigned Tag = CTy.getTag();
1063 Buffer.setTag(Tag);
1064
1065 switch (Tag) {
1066 case dwarf::DW_TAG_vector_type:
1067 case dwarf::DW_TAG_array_type:
Devang Patel9ccfb642009-12-09 18:24:21 +00001068 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001069 break;
1070 case dwarf::DW_TAG_enumeration_type: {
1071 DIArray Elements = CTy.getTypeArray();
1072
1073 // Add enumerators to enumeration type.
1074 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1075 DIE *ElemDie = NULL;
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001076 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3b548aa2010-03-08 20:52:55 +00001077 if (Enum.isEnumerator()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001078 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel930143b2009-11-21 02:48:08 +00001079 Buffer.addChild(ElemDie);
Devang Patelfafa1fe2009-10-09 17:51:49 +00001080 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001081 }
1082 }
1083 break;
1084 case dwarf::DW_TAG_subroutine_type: {
1085 // Add return type.
1086 DIArray Elements = CTy.getTypeArray();
1087 DIDescriptor RTy = Elements.getElement(0);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001088 addType(&Buffer, DIType(RTy));
Bill Wendling2f921f82009-05-15 09:23:25 +00001089
Devang Patel9a33ec22010-10-06 20:50:40 +00001090 bool isPrototyped = true;
Bill Wendling2f921f82009-05-15 09:23:25 +00001091 // Add arguments.
1092 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001093 DIDescriptor Ty = Elements.getElement(i);
Devang Patel9a33ec22010-10-06 20:50:40 +00001094 if (Ty.isUnspecifiedParameter()) {
1095 DIE *Arg = new DIE(dwarf::DW_TAG_unspecified_parameters);
1096 Buffer.addChild(Arg);
1097 isPrototyped = false;
1098 } else {
1099 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1100 addType(Arg, DIType(Ty));
1101 Buffer.addChild(Arg);
1102 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001103 }
Devang Patel9a33ec22010-10-06 20:50:40 +00001104 // Add prototype flag.
1105 if (isPrototyped)
1106 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001107 }
1108 break;
1109 case dwarf::DW_TAG_structure_type:
1110 case dwarf::DW_TAG_union_type:
1111 case dwarf::DW_TAG_class_type: {
1112 // Add elements to structure type.
1113 DIArray Elements = CTy.getTypeArray();
1114
1115 // A forward struct declared type may not have elements available.
Devang Patel3b548aa2010-03-08 20:52:55 +00001116 unsigned N = Elements.getNumElements();
1117 if (N == 0)
Bill Wendling2f921f82009-05-15 09:23:25 +00001118 break;
1119
1120 // Add elements to structure type.
Devang Patel3b548aa2010-03-08 20:52:55 +00001121 for (unsigned i = 0; i < N; ++i) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001122 DIDescriptor Element = Elements.getElement(i);
1123 DIE *ElemDie = NULL;
Devang Patelcb03b142010-09-29 21:44:16 +00001124 if (Element.isSubprogram()) {
1125 DISubprogram SP(Element);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001126 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patelcb03b142010-09-29 21:44:16 +00001127 if (SP.isProtected())
1128 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1129 dwarf::DW_ACCESS_protected);
1130 else if (SP.isPrivate())
1131 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1132 dwarf::DW_ACCESS_private);
1133 else
1134 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1135 dwarf::DW_ACCESS_public);
Devang Patele1c71462010-10-01 23:31:40 +00001136 if (SP.isExplicit())
1137 addUInt(ElemDie, dwarf::DW_AT_explicit, dwarf::DW_FORM_flag, 1);
Devang Patelcb03b142010-09-29 21:44:16 +00001138 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001139 else if (Element.isVariable()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001140 DIVariable DV(Element);
Devang Patel160c92d2010-01-30 01:08:30 +00001141 ElemDie = new DIE(dwarf::DW_TAG_variable);
1142 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1143 DV.getName());
1144 addType(ElemDie, DV.getType());
1145 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1146 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patelb6511a32010-08-09 20:20:05 +00001147 addSourceLine(ElemDie, DV);
Devang Patel3b548aa2010-03-08 20:52:55 +00001148 } else if (Element.isDerivedType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001149 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3b548aa2010-03-08 20:52:55 +00001150 else
1151 continue;
Devang Patel930143b2009-11-21 02:48:08 +00001152 Buffer.addChild(ElemDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001153 }
1154
Devang Patel3082c012009-08-27 23:51:51 +00001155 if (CTy.isAppleBlockExtension())
Devang Patel930143b2009-11-21 02:48:08 +00001156 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001157
1158 unsigned RLang = CTy.getRunTimeLang();
1159 if (RLang)
Devang Patel930143b2009-11-21 02:48:08 +00001160 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling2f921f82009-05-15 09:23:25 +00001161 dwarf::DW_FORM_data1, RLang);
Devang Patel303a1be2010-01-26 21:16:06 +00001162
1163 DICompositeType ContainingType = CTy.getContainingType();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001164 if (DIDescriptor(ContainingType).isCompositeType())
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001165 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001166 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001167 else {
1168 DIDescriptor Context = CTy.getContext();
1169 addToContextOwner(&Buffer, Context);
1170 }
Devang Patel3a9e65e2011-02-02 21:38:25 +00001171
Devang Pateld4e20ea2011-04-05 21:08:24 +00001172 if (Tag == dwarf::DW_TAG_class_type)
1173 addTemplateParams(Buffer, CTy.getTemplateParams());
1174
Bill Wendling2f921f82009-05-15 09:23:25 +00001175 break;
1176 }
1177 default:
1178 break;
1179 }
1180
1181 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +00001182 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001183 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001184
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001185 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
Devang Patel30265c42010-07-07 20:12:52 +00001186 || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1187 {
Bill Wendling2f921f82009-05-15 09:23:25 +00001188 // Add size if non-zero (derived types might be zero-sized.)
1189 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +00001190 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001191 else {
1192 // Add zero size if it is not a forward declaration.
1193 if (CTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +00001194 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001195 else
Devang Patel930143b2009-11-21 02:48:08 +00001196 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling2f921f82009-05-15 09:23:25 +00001197 }
1198
1199 // Add source line info if available.
1200 if (!CTy.isForwardDecl())
Devang Patelb6511a32010-08-09 20:20:05 +00001201 addSourceLine(&Buffer, CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001202 }
1203}
1204
Devang Patel3a9e65e2011-02-02 21:38:25 +00001205/// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
1206/// for the given DITemplateTypeParameter.
1207DIE *
1208DwarfDebug::getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP) {
1209 CompileUnit *TypeCU = getCompileUnit(TP);
1210 DIE *ParamDIE = TypeCU->getDIE(TP);
1211 if (ParamDIE)
1212 return ParamDIE;
1213
1214 ParamDIE = new DIE(dwarf::DW_TAG_template_type_parameter);
1215 addType(ParamDIE, TP.getType());
1216 addString(ParamDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string, TP.getName());
1217 return ParamDIE;
1218}
1219
Devang Patelbe933b42011-02-02 22:35:53 +00001220/// getOrCreateTemplateValueParameterDIE - Find existing DIE or create new DIE
1221/// for the given DITemplateValueParameter.
1222DIE *
1223DwarfDebug::getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TPV) {
1224 CompileUnit *TVCU = getCompileUnit(TPV);
1225 DIE *ParamDIE = TVCU->getDIE(TPV);
1226 if (ParamDIE)
1227 return ParamDIE;
1228
1229 ParamDIE = new DIE(dwarf::DW_TAG_template_value_parameter);
1230 addType(ParamDIE, TPV.getType());
Devang Patel651d06e2011-04-05 20:14:13 +00001231 if (!TPV.getName().empty())
1232 addString(ParamDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string, TPV.getName());
Devang Patelbe933b42011-02-02 22:35:53 +00001233 addUInt(ParamDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
1234 TPV.getValue());
1235 return ParamDIE;
1236}
1237
Devang Patel930143b2009-11-21 02:48:08 +00001238/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1239void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Devang Patele3964792011-04-08 21:55:10 +00001240 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1241 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001242 int64_t L = SR.getLo();
1243 int64_t H = SR.getHi();
Bill Wendling2f921f82009-05-15 09:23:25 +00001244
Devang Patel778947c2011-04-08 23:39:38 +00001245 // The L value defines the lower bounds which is typically zero for C/C++. The
1246 // H value is the upper bounds. Values are 64 bit. H - L + 1 is the size
1247 // of the array. If L > H then do not emit DW_AT_lower_bound and
1248 // DW_AT_upper_bound attributes. If L is zero and H is also zero then the
1249 // array has one element and in such case do not emit lower bound.
Devang Patele3964792011-04-08 21:55:10 +00001250
Devang Patel778947c2011-04-08 23:39:38 +00001251 if (L > H) {
Devang Patele3964792011-04-08 21:55:10 +00001252 Buffer.addChild(DW_Subrange);
1253 return;
1254 }
Devang Patelf691df32009-08-14 20:59:16 +00001255 if (L)
Devang Patel930143b2009-11-21 02:48:08 +00001256 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Patel8f046022009-12-04 23:10:24 +00001257 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Devang Patel930143b2009-11-21 02:48:08 +00001258 Buffer.addChild(DW_Subrange);
Bill Wendling2f921f82009-05-15 09:23:25 +00001259}
1260
Devang Patel930143b2009-11-21 02:48:08 +00001261/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001262void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling2f921f82009-05-15 09:23:25 +00001263 DICompositeType *CTy) {
1264 Buffer.setTag(dwarf::DW_TAG_array_type);
1265 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel930143b2009-11-21 02:48:08 +00001266 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001267
1268 // Emit derived type.
Devang Patel9ccfb642009-12-09 18:24:21 +00001269 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001270 DIArray Elements = CTy->getTypeArray();
1271
Devang Patel92e8c652009-11-21 00:31:03 +00001272 // Get an anonymous type for index type.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001273 CompileUnit *TheCU = getCompileUnit(*CTy);
1274 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel92e8c652009-11-21 00:31:03 +00001275 if (!IdxTy) {
1276 // Construct an anonymous type for index type.
1277 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +00001278 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1279 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel92e8c652009-11-21 00:31:03 +00001280 dwarf::DW_ATE_signed);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001281 TheCU->addDie(IdxTy);
1282 TheCU->setIndexTyDie(IdxTy);
Devang Patel92e8c652009-11-21 00:31:03 +00001283 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001284
1285 // Add subranges to array type.
1286 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1287 DIDescriptor Element = Elements.getElement(i);
1288 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001289 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001290 }
1291}
1292
Devang Patel930143b2009-11-21 02:48:08 +00001293/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3b548aa2010-03-08 20:52:55 +00001294DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001295 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3b548aa2010-03-08 20:52:55 +00001296 StringRef Name = ETy.getName();
Devang Patel930143b2009-11-21 02:48:08 +00001297 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3b548aa2010-03-08 20:52:55 +00001298 int64_t Value = ETy.getEnumValue();
Devang Patel930143b2009-11-21 02:48:08 +00001299 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +00001300 return Enumerator;
1301}
1302
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001303/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel43ef34d2010-01-05 01:46:14 +00001304/// printer to not emit usual symbol prefix before the symbol name is used then
1305/// return linkage name after skipping this special LLVM prefix.
1306static StringRef getRealLinkageName(StringRef LinkageName) {
1307 char One = '\1';
1308 if (LinkageName.startswith(StringRef(&One, 1)))
1309 return LinkageName.substr(1);
1310 return LinkageName;
1311}
1312
Devang Patel930143b2009-11-21 02:48:08 +00001313/// createMemberDIE - Create new member DIE.
Devang Patel18ba0b42010-08-10 04:12:17 +00001314DIE *DwarfDebug::createMemberDIE(DIDerivedType DT) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001315 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel2d9caf92009-11-25 17:36:49 +00001316 StringRef Name = DT.getName();
1317 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001318 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001319
Devang Patel9ccfb642009-12-09 18:24:21 +00001320 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001321
Devang Patelb6511a32010-08-09 20:20:05 +00001322 addSourceLine(MemberDie, DT);
Bill Wendling2f921f82009-05-15 09:23:25 +00001323
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001324 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel930143b2009-11-21 02:48:08 +00001325 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel67f56f02009-11-04 22:06:12 +00001326
Bill Wendling2f921f82009-05-15 09:23:25 +00001327 uint64_t Size = DT.getSizeInBits();
Devang Patelf05d5722009-11-04 23:48:00 +00001328 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling2f921f82009-05-15 09:23:25 +00001329
1330 if (Size != FieldSize) {
1331 // Handle bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001332 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1333 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling2f921f82009-05-15 09:23:25 +00001334
1335 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling2f921f82009-05-15 09:23:25 +00001336 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1337 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer2b459982010-01-07 17:50:57 +00001338 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling2f921f82009-05-15 09:23:25 +00001339 Offset -= FieldOffset;
1340
1341 // Maybe we need to work from the other end.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001342 if (Asm->getTargetData().isLittleEndian())
1343 Offset = FieldSize - (Offset + Size);
Devang Patel930143b2009-11-21 02:48:08 +00001344 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling2f921f82009-05-15 09:23:25 +00001345
Devang Patel67f56f02009-11-04 22:06:12 +00001346 // Here WD_AT_data_member_location points to the anonymous
1347 // field that includes this bit field.
Devang Patel930143b2009-11-21 02:48:08 +00001348 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001349
1350 } else
1351 // This is not a bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001352 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001353
Devang Pateld2316892010-02-03 20:08:48 +00001354 if (DT.getTag() == dwarf::DW_TAG_inheritance
1355 && DT.isVirtual()) {
1356
1357 // For C++, virtual base classes are not at fixed offset. Use following
1358 // expression to extract appropriate offset from vtable.
1359 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1360
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001361 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Pateld2316892010-02-03 20:08:48 +00001362 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1363 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1364 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1365 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1366 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1367 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1368 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1369
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001370 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
Devang Pateld2316892010-02-03 20:08:48 +00001371 VBaseLocationDie);
1372 } else
1373 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001374
1375 if (DT.isProtected())
Devang Pateleb57c592009-12-03 19:11:07 +00001376 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001377 dwarf::DW_ACCESS_protected);
1378 else if (DT.isPrivate())
Devang Pateleb57c592009-12-03 19:11:07 +00001379 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001380 dwarf::DW_ACCESS_private);
Devang Patela1bd5a12010-09-29 19:08:08 +00001381 // Otherwise C++ member and base classes are considered public.
1382 else if (DT.getCompileUnit().getLanguage() == dwarf::DW_LANG_C_plus_plus)
Devang Pateleb57c592009-12-03 19:11:07 +00001383 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1384 dwarf::DW_ACCESS_public);
1385 if (DT.isVirtual())
1386 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1387 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling2f921f82009-05-15 09:23:25 +00001388 return MemberDie;
1389}
1390
Devang Patel525dda02009-12-14 16:18:45 +00001391/// createSubprogramDIE - Create new DIE using SP.
Devang Patel185051c2010-09-27 23:15:27 +00001392DIE *DwarfDebug::createSubprogramDIE(DISubprogram SP) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001393 CompileUnit *SPCU = getCompileUnit(SP);
1394 DIE *SPDie = SPCU->getDIE(SP);
Devang Patel525dda02009-12-14 16:18:45 +00001395 if (SPDie)
1396 return SPDie;
1397
1398 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf200b392010-03-02 17:58:15 +00001399 // Constructors and operators for anonymous aggregates do not have names.
Devang Pateld0fa3042010-03-02 01:26:20 +00001400 if (!SP.getName().empty())
1401 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling2f921f82009-05-15 09:23:25 +00001402
Devang Patel2d9caf92009-11-25 17:36:49 +00001403 StringRef LinkageName = SP.getLinkageName();
Devang Patel43ef34d2010-01-05 01:46:14 +00001404 if (!LinkageName.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001405 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel43ef34d2010-01-05 01:46:14 +00001406 getRealLinkageName(LinkageName));
1407
Devang Patelb6511a32010-08-09 20:20:05 +00001408 addSourceLine(SPDie, SP);
Bill Wendling2f921f82009-05-15 09:23:25 +00001409
Devang Patel3a24f922010-10-07 22:03:01 +00001410 if (SP.isPrototyped())
Devang Patel930143b2009-11-21 02:48:08 +00001411 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001412
1413 // Add Return Type.
Devang Patel236526d2009-12-03 01:25:38 +00001414 DICompositeType SPTy = SP.getType();
1415 DIArray Args = SPTy.getTypeArray();
Bill Wendling2f921f82009-05-15 09:23:25 +00001416 unsigned SPTag = SPTy.getTag();
Devang Pateleb57c592009-12-03 19:11:07 +00001417
Devang Patel3b548aa2010-03-08 20:52:55 +00001418 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel9ccfb642009-12-09 18:24:21 +00001419 addType(SPDie, SPTy);
Devang Patel236526d2009-12-03 01:25:38 +00001420 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001421 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel236526d2009-12-03 01:25:38 +00001422
Devang Pateleb57c592009-12-03 19:11:07 +00001423 unsigned VK = SP.getVirtuality();
1424 if (VK) {
1425 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001426 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Pateleb57c592009-12-03 19:11:07 +00001427 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
Devang Patelc26da902010-12-09 00:10:40 +00001428 addUInt(Block, 0, dwarf::DW_FORM_udata, SP.getVirtualIndex());
Devang Pateleb57c592009-12-03 19:11:07 +00001429 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001430 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001431 SP.getContainingType()));
Devang Pateleb57c592009-12-03 19:11:07 +00001432 }
1433
Devang Patel185051c2010-09-27 23:15:27 +00001434 if (!SP.isDefinition()) {
Devang Patel930143b2009-11-21 02:48:08 +00001435 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001436
1437 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel236526d2009-12-03 01:25:38 +00001438 // be handled while processing variables.
1439 DICompositeType SPTy = SP.getType();
1440 DIArray Args = SPTy.getTypeArray();
1441 unsigned SPTag = SPTy.getTag();
1442
Bill Wendling2f921f82009-05-15 09:23:25 +00001443 if (SPTag == dwarf::DW_TAG_subroutine_type)
1444 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1445 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001446 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patel6efc8e52010-02-06 01:02:37 +00001447 addType(Arg, ATy);
1448 if (ATy.isArtificial())
1449 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel930143b2009-11-21 02:48:08 +00001450 SPDie->addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +00001451 }
1452 }
1453
Devang Patel999b4992010-02-03 19:57:19 +00001454 if (SP.isArtificial())
1455 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1456
Devang Patelb4e3b902010-04-30 19:38:23 +00001457 if (!SP.isLocalToUnit())
1458 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001459
Devang Patelb4e3b902010-04-30 19:38:23 +00001460 if (SP.isOptimized())
1461 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1462
Jim Grosbach965a73a2010-07-21 23:03:52 +00001463 if (unsigned isa = Asm->getISAEncoding()) {
1464 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1465 }
1466
Devang Patel9f738842011-04-05 22:52:06 +00001467 // Add function template parameters.
1468 addTemplateParams(*SPDie, SP.getTemplateParams());
1469
Devang Patelb4e3b902010-04-30 19:38:23 +00001470 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001471 SPCU->insertDIE(SP, SPDie);
Devang Patelb4e3b902010-04-30 19:38:23 +00001472
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001473 // Add to context owner.
1474 addToContextOwner(SPDie, SP.getContext());
1475
Bill Wendling2f921f82009-05-15 09:23:25 +00001476 return SPDie;
1477}
1478
Devang Patel32cc43c2010-05-07 20:54:48 +00001479DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattner8d2fe282010-03-31 05:36:29 +00001480 assert(N && "Invalid Scope encoding!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001481
1482 DbgScope *AScope = AbstractScopes.lookup(N);
1483 if (AScope)
1484 return AScope;
Jim Grosbach042483e2009-11-21 23:12:12 +00001485
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001486 DbgScope *Parent = NULL;
1487
1488 DIDescriptor Scope(N);
1489 if (Scope.isLexicalBlock()) {
1490 DILexicalBlock DB(N);
1491 DIDescriptor ParentDesc = DB.getContext();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001492 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001493 }
1494
1495 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1496
1497 if (Parent)
Devang Patel930143b2009-11-21 02:48:08 +00001498 Parent->addScope(AScope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001499 AScope->setAbstractScope();
1500 AbstractScopes[N] = AScope;
1501 if (DIDescriptor(N).isSubprogram())
1502 AbstractScopesList.push_back(AScope);
1503 return AScope;
1504}
Devang Patel75cc16c2009-10-01 20:31:14 +00001505
Devang Patel019922d2010-04-06 23:53:48 +00001506/// isSubprogramContext - Return true if Context is either a subprogram
1507/// or another context nested inside a subprogram.
Devang Patel32cc43c2010-05-07 20:54:48 +00001508static bool isSubprogramContext(const MDNode *Context) {
Devang Patel019922d2010-04-06 23:53:48 +00001509 if (!Context)
1510 return false;
1511 DIDescriptor D(Context);
1512 if (D.isSubprogram())
1513 return true;
1514 if (D.isType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001515 return isSubprogramContext(DIType(Context).getContext());
Devang Patel019922d2010-04-06 23:53:48 +00001516 return false;
1517}
1518
Jim Grosbach042483e2009-11-21 23:12:12 +00001519/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel930143b2009-11-21 02:48:08 +00001520/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1521/// If there are global variables in this scope then create and insert
1522/// DIEs for these variables.
Devang Patel32cc43c2010-05-07 20:54:48 +00001523DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001524 CompileUnit *SPCU = getCompileUnit(SPNode);
1525 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +00001526
Chris Lattner3a383cb2010-04-05 00:13:49 +00001527 assert(SPDie && "Unable to find subprogram DIE!");
1528 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001529
Chris Lattner3a383cb2010-04-05 00:13:49 +00001530 // There is not any need to generate specification DIE for a function
1531 // defined at compile unit level. If a function is defined inside another
1532 // function then gdb prefers the definition at top level and but does not
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001533 // expect specification DIE in parent function. So avoid creating
Chris Lattner3a383cb2010-04-05 00:13:49 +00001534 // specification DIE for a function defined inside a function.
1535 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001536 !SP.getContext().isFile() &&
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001537 !isSubprogramContext(SP.getContext())) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00001538 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001539
1540 // Add arguments.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001541 DICompositeType SPTy = SP.getType();
1542 DIArray Args = SPTy.getTypeArray();
1543 unsigned SPTag = SPTy.getTag();
1544 if (SPTag == dwarf::DW_TAG_subroutine_type)
1545 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1546 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001547 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattner3a383cb2010-04-05 00:13:49 +00001548 addType(Arg, ATy);
1549 if (ATy.isArtificial())
1550 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1551 SPDie->addChild(Arg);
1552 }
1553 DIE *SPDeclDie = SPDie;
1554 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001555 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Chris Lattner3a383cb2010-04-05 00:13:49 +00001556 SPDeclDie);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001557 SPCU->addDie(SPDie);
Chris Lattner3a383cb2010-04-05 00:13:49 +00001558 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001559
Devang Patela37a95e2010-07-07 22:20:57 +00001560 // Pick up abstract subprogram DIE.
1561 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
1562 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1563 addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
1564 dwarf::DW_FORM_ref4, AbsSPDIE);
1565 SPCU->addDie(SPDie);
1566 }
1567
Chris Lattner3a383cb2010-04-05 00:13:49 +00001568 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1569 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1570 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1571 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1572 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1573 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1574 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +00001575
Chris Lattner3a383cb2010-04-05 00:13:49 +00001576 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001577}
1578
Jim Grosbach042483e2009-11-21 23:12:12 +00001579/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel930143b2009-11-21 02:48:08 +00001580/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1581DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001582
1583 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1584 if (Scope->isAbstractScope())
1585 return ScopeDIE;
1586
1587 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1588 if (Ranges.empty())
1589 return 0;
1590
1591 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1592 if (Ranges.size() > 1) {
1593 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001594 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +00001595 // DW_AT_ranges appropriately.
1596 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1597 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1598 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1599 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +00001600 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1601 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +00001602 }
1603 DebugRangeSymbols.push_back(NULL);
1604 DebugRangeSymbols.push_back(NULL);
1605 return ScopeDIE;
1606 }
1607
Devang Patel9fc11702010-05-25 23:40:22 +00001608 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1609 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001610
Devang Patel9fc11702010-05-25 23:40:22 +00001611 if (End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001612
Chris Lattnere13c3722010-03-09 01:58:53 +00001613 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1614 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001615
Devang Patel6c74a872010-04-27 19:46:33 +00001616 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1617 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001618
1619 return ScopeDIE;
1620}
1621
Devang Patel930143b2009-11-21 02:48:08 +00001622/// constructInlinedScopeDIE - This scope represents inlined body of
1623/// a function. Construct DIE to represent this concrete inlined copy
1624/// of the function.
1625DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001626
1627 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001628 assert (Ranges.empty() == false
Devang Patel6c74a872010-04-27 19:46:33 +00001629 && "DbgScope does not have instruction markers!");
1630
1631 // FIXME : .debug_inlined section specification does not clearly state how
1632 // to emit inlined scope that is split into multiple instruction ranges.
1633 // For now, use first instruction range and emit low_pc/high_pc pair and
1634 // corresponding .debug_inlined section entry for this pair.
1635 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel9fc11702010-05-25 23:40:22 +00001636 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1637 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001638
Devang Patel4c6bd662010-07-08 22:39:20 +00001639 if (StartLabel == 0 || EndLabel == 0) {
Devang Patel6c74a872010-04-27 19:46:33 +00001640 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1641 return 0;
1642 }
Chris Lattnere13c3722010-03-09 01:58:53 +00001643 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001644 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +00001645 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001646 "Invalid end label for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +00001647
Devang Patel3b548aa2010-03-08 20:52:55 +00001648 if (!Scope->getScopeNode())
Devang Patelbc97f6b2010-03-08 19:20:38 +00001649 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001650 DIScope DS(Scope->getScopeNode());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001651 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1652
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001653 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001654 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1655 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001656 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel930143b2009-11-21 02:48:08 +00001657 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001658 dwarf::DW_FORM_ref4, OriginDIE);
1659
Chris Lattner085b6522010-03-09 00:31:02 +00001660 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnere13c3722010-03-09 01:58:53 +00001661 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001662
1663 InlinedSubprogramDIEs.insert(OriginDIE);
1664
1665 // Track the start label for this inlined function.
Devang Patel32cc43c2010-05-07 20:54:48 +00001666 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001667 I = InlineInfo.find(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001668
1669 if (I == InlineInfo.end()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001670 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach00e9c612009-11-22 19:20:36 +00001671 ScopeDIE));
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001672 InlinedSPNodes.push_back(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001673 } else
Chris Lattner085b6522010-03-09 00:31:02 +00001674 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001675
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001676 DILocation DL(Scope->getInlinedAt());
Devang Patel1a0df9a2010-05-10 22:49:55 +00001677 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel930143b2009-11-21 02:48:08 +00001678 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001679
1680 return ScopeDIE;
1681}
1682
Devang Patel930143b2009-11-21 02:48:08 +00001683
1684/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel9ccfb642009-12-09 18:24:21 +00001685DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001686 StringRef Name = DV->getName();
Devang Patel2d9caf92009-11-25 17:36:49 +00001687 if (Name.empty())
Devang Patel97f99fa2009-11-13 02:25:26 +00001688 return NULL;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001689
1690 // Translate tag to proper Dwarf tag. The result variable is dropped for
1691 // now.
1692 unsigned Tag;
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001693 switch (DV->getTag()) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001694 case dwarf::DW_TAG_return_variable:
1695 return NULL;
1696 case dwarf::DW_TAG_arg_variable:
1697 Tag = dwarf::DW_TAG_formal_parameter;
1698 break;
1699 case dwarf::DW_TAG_auto_variable: // fall thru
1700 default:
1701 Tag = dwarf::DW_TAG_variable;
1702 break;
1703 }
1704
1705 // Define variable debug information entry.
1706 DIE *VariableDie = new DIE(Tag);
1707
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001708 DIE *AbsDIE = NULL;
Devang Patele1c53f22010-05-20 16:36:41 +00001709 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1710 V2AVI = VarToAbstractVarMap.find(DV);
1711 if (V2AVI != VarToAbstractVarMap.end())
1712 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach042483e2009-11-21 23:12:12 +00001713
Devang Patele1c53f22010-05-20 16:36:41 +00001714 if (AbsDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001715 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001716 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001717 else {
Devang Patel930143b2009-11-21 02:48:08 +00001718 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001719 addSourceLine(VariableDie, DV->getVariable());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001720
1721 // Add variable type.
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001722 addType(VariableDie, DV->getType());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001723 }
1724
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001725 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patel6efc8e52010-02-06 01:02:37 +00001726 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelbea08d12010-09-29 23:07:21 +00001727 else if (DIVariable(DV->getVariable()).isArtificial())
1728 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel9fc11702010-05-25 23:40:22 +00001729
1730 if (Scope->isAbstractScope()) {
1731 DV->setDIE(VariableDie);
1732 return VariableDie;
1733 }
1734
1735 // Add variable address.
1736
1737 unsigned Offset = DV->getDotDebugLocOffset();
1738 if (Offset != ~0U) {
1739 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1740 Asm->GetTempSymbol("debug_loc", Offset));
1741 DV->setDIE(VariableDie);
1742 UseDotDebugLocEntry.insert(VariableDie);
1743 return VariableDie;
1744 }
1745
1746 // Check if variable is described by a DBG_VALUE instruction.
1747 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1748 DbgVariableToDbgInstMap.find(DV);
1749 if (DVI != DbgVariableToDbgInstMap.end()) {
1750 const MachineInstr *DVInsn = DVI->second;
Devang Patel9fc11702010-05-25 23:40:22 +00001751 bool updated = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001752 // FIXME : Handle getNumOperands != 3
Devang Patel9fc11702010-05-25 23:40:22 +00001753 if (DVInsn->getNumOperands() == 3) {
Devang Patel86ec8b32010-08-31 22:22:42 +00001754 if (DVInsn->getOperand(0).isReg()) {
1755 const MachineOperand RegOp = DVInsn->getOperand(0);
1756 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1757 if (DVInsn->getOperand(1).isImm() &&
1758 TRI->getFrameRegister(*Asm->MF) == RegOp.getReg()) {
1759 addVariableAddress(DV, VariableDie, DVInsn->getOperand(1).getImm());
1760 updated = true;
1761 } else
Devang Patel53a40df62010-11-12 23:20:42 +00001762 updated = addRegisterAddress(VariableDie, RegOp);
Devang Patel86ec8b32010-08-31 22:22:42 +00001763 }
Devang Patel9fc11702010-05-25 23:40:22 +00001764 else if (DVInsn->getOperand(0).isImm())
Devang Patel53a40df62010-11-12 23:20:42 +00001765 updated = addConstantValue(VariableDie, DVInsn->getOperand(0));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001766 else if (DVInsn->getOperand(0).isFPImm())
1767 updated =
Devang Patel53a40df62010-11-12 23:20:42 +00001768 addConstantFPValue(VariableDie, DVInsn->getOperand(0));
Devang Patel9fc11702010-05-25 23:40:22 +00001769 } else {
1770 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1771 if (Location.getReg()) {
1772 addAddress(VariableDie, dwarf::DW_AT_location, Location);
Devang Patel9fc11702010-05-25 23:40:22 +00001773 updated = true;
1774 }
1775 }
1776 if (!updated) {
1777 // If variableDie is not updated then DBG_VALUE instruction does not
1778 // have valid variable info.
1779 delete VariableDie;
1780 return NULL;
1781 }
1782 DV->setDIE(VariableDie);
1783 return VariableDie;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001784 }
Devang Patel9fc11702010-05-25 23:40:22 +00001785
1786 // .. else use frame index, if available.
Devang Patel9fc11702010-05-25 23:40:22 +00001787 int FI = 0;
Devang Patel2cfc3af2010-08-31 06:11:28 +00001788 if (findVariableFrameIndex(DV, &FI))
1789 addVariableAddress(DV, VariableDie, FI);
1790
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001791 DV->setDIE(VariableDie);
1792 return VariableDie;
1793
1794}
Devang Patel930143b2009-11-21 02:48:08 +00001795
Devang Patel04d2f2d2009-11-24 01:14:22 +00001796void DwarfDebug::addPubTypes(DISubprogram SP) {
1797 DICompositeType SPTy = SP.getType();
1798 unsigned SPTag = SPTy.getTag();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001799 if (SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel04d2f2d2009-11-24 01:14:22 +00001800 return;
1801
1802 DIArray Args = SPTy.getTypeArray();
Devang Patel04d2f2d2009-11-24 01:14:22 +00001803 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001804 DIType ATy(Args.getElement(i));
Devang Patel8d6a2b72010-05-07 21:45:47 +00001805 if (!ATy.Verify())
Devang Patel04d2f2d2009-11-24 01:14:22 +00001806 continue;
1807 DICompositeType CATy = getDICompositeType(ATy);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001808 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel12d150e2010-04-13 20:35:04 +00001809 && !CATy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001810 CompileUnit *TheCU = getCompileUnit(CATy);
1811 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1812 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00001813 }
1814 }
1815}
1816
Devang Patel930143b2009-11-21 02:48:08 +00001817/// constructScopeDIE - Construct a DIE for this scope.
1818DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +00001819 if (!Scope || !Scope->getScopeNode())
1820 return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001821
Devang Patel5f1b4cd2011-02-19 01:31:27 +00001822 SmallVector <DIE *, 8> Children;
Devang Patel6c622ef2011-03-01 22:58:55 +00001823
1824 // Collect arguments for current function.
1825 if (Scope == CurrentFnDbgScope)
1826 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
1827 if (DbgVariable *ArgDV = CurrentFnArguments[i])
1828 if (DIE *Arg = constructVariableDIE(ArgDV, Scope))
1829 Children.push_back(Arg);
1830
Devang Patel5f1b4cd2011-02-19 01:31:27 +00001831 // Collect lexical scope childrens first.
1832 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
1833 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
1834 if (DIE *Variable = constructVariableDIE(Variables[i], Scope))
1835 Children.push_back(Variable);
1836 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
1837 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
1838 if (DIE *Nested = constructScopeDIE(Scopes[j]))
1839 Children.push_back(Nested);
Devang Patel3b548aa2010-03-08 20:52:55 +00001840 DIScope DS(Scope->getScopeNode());
1841 DIE *ScopeDIE = NULL;
1842 if (Scope->getInlinedAt())
1843 ScopeDIE = constructInlinedScopeDIE(Scope);
1844 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +00001845 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001846 if (Scope->isAbstractScope()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001847 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001848 // Note down abstract DIE.
1849 if (ScopeDIE)
1850 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
1851 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001852 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001853 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3b548aa2010-03-08 20:52:55 +00001854 }
Devang Patel5f1b4cd2011-02-19 01:31:27 +00001855 else {
1856 // There is no need to emit empty lexical block DIE.
1857 if (Children.empty())
1858 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001859 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel5f1b4cd2011-02-19 01:31:27 +00001860 }
1861
Devang Patel23b2ae62010-03-29 22:59:58 +00001862 if (!ScopeDIE) return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001863
Devang Patel5f1b4cd2011-02-19 01:31:27 +00001864 // Add children
1865 for (SmallVector<DIE *, 8>::iterator I = Children.begin(),
1866 E = Children.end(); I != E; ++I)
1867 ScopeDIE->addChild(*I);
Devang Patel04d2f2d2009-11-24 01:14:22 +00001868
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001869 if (DS.isSubprogram())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001870 addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001871
Devang Patel04d2f2d2009-11-24 01:14:22 +00001872 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001873}
1874
Bill Wendling2b128d72009-05-20 23:19:06 +00001875/// GetOrCreateSourceID - Look up the source id with the given directory and
1876/// source file names. If none currently exists, create a new id and insert it
1877/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1878/// maps as well.
Devang Patel498877d2010-07-24 00:53:22 +00001879
Devang Patele01b75c2011-03-24 20:30:50 +00001880unsigned DwarfDebug::GetOrCreateSourceID(StringRef FileName,
1881 StringRef DirName) {
Devang Patel871d0b12010-09-16 20:57:49 +00001882 // If FE did not provide a file name, then assume stdin.
1883 if (FileName.empty())
Devang Patele01b75c2011-03-24 20:30:50 +00001884 return GetOrCreateSourceID("<stdin>", StringRef());
1885
1886 // MCStream expects full path name as filename.
1887 if (!DirName.empty() && !FileName.startswith("/")) {
1888 std::string FullPathName(DirName.data());
1889 if (!DirName.endswith("/"))
1890 FullPathName += "/";
1891 FullPathName += FileName.data();
1892 // Here FullPathName will be copied into StringMap by GetOrCreateSourceID.
1893 return GetOrCreateSourceID(StringRef(FullPathName), StringRef());
1894 }
Devang Patel871d0b12010-09-16 20:57:49 +00001895
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001896 StringMapEntry<unsigned> &Entry = SourceIdMap.GetOrCreateValue(FileName);
1897 if (Entry.getValue())
1898 return Entry.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +00001899
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001900 unsigned SrcId = SourceIdMap.size();
1901 Entry.setValue(SrcId);
Bill Wendling2b128d72009-05-20 23:19:06 +00001902
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001903 // Print out a .file directive to specify files for .loc directives.
Devang Patele01b75c2011-03-24 20:30:50 +00001904 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, Entry.getKey());
Bill Wendling2b128d72009-05-20 23:19:06 +00001905
1906 return SrcId;
1907}
1908
Devang Patel1f4690c2009-12-15 19:16:48 +00001909/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1910DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001911 CompileUnit *TheCU = getCompileUnit(NS);
1912 DIE *NDie = TheCU->getDIE(NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001913 if (NDie)
1914 return NDie;
1915 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001916 TheCU->insertDIE(NS, NDie);
Devang Patel1f4690c2009-12-15 19:16:48 +00001917 if (!NS.getName().empty())
1918 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
Devang Patelb6511a32010-08-09 20:20:05 +00001919 addSourceLine(NDie, NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001920 addToContextOwner(NDie, NS.getContext());
1921 return NDie;
1922}
1923
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001924/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel1a0df9a2010-05-10 22:49:55 +00001925/// metadata node with tag DW_TAG_compile_unit.
Devang Patel32cc43c2010-05-07 20:54:48 +00001926void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001927 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +00001928 StringRef FN = DIUnit.getFilename();
1929 StringRef Dir = DIUnit.getDirectory();
Devang Patele01b75c2011-03-24 20:30:50 +00001930 unsigned ID = GetOrCreateSourceID(FN, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +00001931
1932 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel930143b2009-11-21 02:48:08 +00001933 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patelb2969422009-09-29 18:40:58 +00001934 DIUnit.getProducer());
Devang Patel7b0f7962011-02-23 22:37:04 +00001935 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
Bill Wendling2b128d72009-05-20 23:19:06 +00001936 DIUnit.getLanguage());
Devang Patel930143b2009-11-21 02:48:08 +00001937 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patelbd798ce2010-04-26 22:54:28 +00001938 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1939 // simplifies debug range entries.
Devang Patel1de21ec2010-06-28 22:22:47 +00001940 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Pateld22ed622010-03-22 23:11:36 +00001941 // DW_AT_stmt_list is a offset of line number information for this
Devang Patel4a213872010-08-24 00:06:12 +00001942 // compile unit in debug_line section.
Devang Patelea636392010-08-31 23:50:19 +00001943 if (Asm->MAI->doesDwarfUsesAbsoluteLabelForStmtList())
Cameron Zwarichfcf51fd2011-02-25 16:30:32 +00001944 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_addr,
1945 Asm->GetTempSymbol("section_line"));
Devang Patelea636392010-08-31 23:50:19 +00001946 else
1947 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00001948
Devang Patel2d9caf92009-11-25 17:36:49 +00001949 if (!Dir.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001950 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +00001951 if (DIUnit.isOptimized())
Devang Patel930143b2009-11-21 02:48:08 +00001952 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendling2b128d72009-05-20 23:19:06 +00001953
Devang Patel2d9caf92009-11-25 17:36:49 +00001954 StringRef Flags = DIUnit.getFlags();
1955 if (!Flags.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001956 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendling2b128d72009-05-20 23:19:06 +00001957
1958 unsigned RVer = DIUnit.getRunTimeVersion();
1959 if (RVer)
Devang Patel930143b2009-11-21 02:48:08 +00001960 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +00001961 dwarf::DW_FORM_data1, RVer);
1962
Devang Patel1a0df9a2010-05-10 22:49:55 +00001963 CompileUnit *NewCU = new CompileUnit(ID, Die);
1964 if (!FirstCU)
1965 FirstCU = NewCU;
1966 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendling2b128d72009-05-20 23:19:06 +00001967}
1968
Devang Patel1a0df9a2010-05-10 22:49:55 +00001969/// getCompielUnit - Get CompileUnit DIE.
1970CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1971 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1972 DIDescriptor D(N);
1973 const MDNode *CUNode = NULL;
1974 if (D.isCompileUnit())
1975 CUNode = N;
1976 else if (D.isSubprogram())
1977 CUNode = DISubprogram(N).getCompileUnit();
1978 else if (D.isType())
1979 CUNode = DIType(N).getCompileUnit();
1980 else if (D.isGlobalVariable())
1981 CUNode = DIGlobalVariable(N).getCompileUnit();
1982 else if (D.isVariable())
1983 CUNode = DIVariable(N).getCompileUnit();
1984 else if (D.isNameSpace())
1985 CUNode = DINameSpace(N).getCompileUnit();
1986 else if (D.isFile())
1987 CUNode = DIFile(N).getCompileUnit();
1988 else
1989 return FirstCU;
1990
1991 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1992 = CUMap.find(CUNode);
1993 if (I == CUMap.end())
1994 return FirstCU;
1995 return I->second;
1996}
1997
Devang Patela8652672010-08-23 18:25:56 +00001998/// isUnsignedDIType - Return true if type encoding is unsigned.
1999static bool isUnsignedDIType(DIType Ty) {
2000 DIDerivedType DTy(Ty);
2001 if (DTy.Verify())
2002 return isUnsignedDIType(DTy.getTypeDerivedFrom());
2003
2004 DIBasicType BTy(Ty);
2005 if (BTy.Verify()) {
2006 unsigned Encoding = BTy.getEncoding();
2007 if (Encoding == dwarf::DW_ATE_unsigned ||
2008 Encoding == dwarf::DW_ATE_unsigned_char)
2009 return true;
2010 }
2011 return false;
2012}
Devang Patel1a0df9a2010-05-10 22:49:55 +00002013
Devang Patel2d9e5322011-01-20 00:02:16 +00002014// Return const exprssion if value is a GEP to access merged global
2015// constant. e.g.
2016// i8* getelementptr ({ i8, i8, i8, i8 }* @_MergedGlobals, i32 0, i32 0)
2017static const ConstantExpr *getMergedGlobalExpr(const Value *V) {
2018 const ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(V);
2019 if (!CE || CE->getNumOperands() != 3 ||
2020 CE->getOpcode() != Instruction::GetElementPtr)
2021 return NULL;
2022
2023 // First operand points to a global value.
2024 if (!isa<GlobalValue>(CE->getOperand(0)))
2025 return NULL;
2026
2027 // Second operand is zero.
2028 const ConstantInt *CI =
2029 dyn_cast_or_null<ConstantInt>(CE->getOperand(1));
2030 if (!CI || !CI->isZero())
2031 return NULL;
2032
2033 // Third operand is offset.
2034 if (!isa<ConstantInt>(CE->getOperand(2)))
2035 return NULL;
2036
2037 return CE;
2038}
2039
Devang Patel1a0df9a2010-05-10 22:49:55 +00002040/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00002041void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel469c12d22010-08-10 01:37:23 +00002042 DIGlobalVariable GV(N);
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002043
Devang Patelf5d53602009-09-04 23:59:07 +00002044 // If debug information is malformed then ignore it.
Devang Patel469c12d22010-08-10 01:37:23 +00002045 if (GV.Verify() == false)
Devang Patelf5d53602009-09-04 23:59:07 +00002046 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002047
2048 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002049 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel469c12d22010-08-10 01:37:23 +00002050 if (TheCU->getDIE(GV))
Devang Patel0751a282009-06-26 01:49:18 +00002051 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002052
Devang Patel469c12d22010-08-10 01:37:23 +00002053 DIType GTy = GV.getType();
Devang Patelb2197462010-08-10 07:11:13 +00002054 DIE *VariableDIE = new DIE(GV.getTag());
2055
2056 bool isGlobalVariable = GV.getGlobal() != NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00002057
Devang Patel469c12d22010-08-10 01:37:23 +00002058 // Add name.
2059 addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
2060 GV.getDisplayName());
2061 StringRef LinkageName = GV.getLinkageName();
Devang Patelb2197462010-08-10 07:11:13 +00002062 if (!LinkageName.empty() && isGlobalVariable)
Devang Patel469c12d22010-08-10 01:37:23 +00002063 addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
2064 getRealLinkageName(LinkageName));
2065 // Add type.
2066 addType(VariableDIE, GTy);
Devang Patel12d150e2010-04-13 20:35:04 +00002067 if (GTy.isCompositeType() && !GTy.getName().empty()
2068 && !GTy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002069 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattner8d2fe282010-03-31 05:36:29 +00002070 assert(Entry && "Missing global type!");
Devang Patel1a0df9a2010-05-10 22:49:55 +00002071 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00002072 }
Devang Patel469c12d22010-08-10 01:37:23 +00002073 // Add scoping info.
2074 if (!GV.isLocalToUnit()) {
2075 addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
2076 // Expose as global.
2077 TheCU->addGlobal(GV.getName(), VariableDIE);
2078 }
2079 // Add line number info.
2080 addSourceLine(VariableDIE, GV);
2081 // Add to map.
2082 TheCU->insertDIE(N, VariableDIE);
2083 // Add to context owner.
2084 DIDescriptor GVContext = GV.getContext();
2085 addToContextOwner(VariableDIE, GVContext);
2086 // Add location.
Devang Patelb2197462010-08-10 07:11:13 +00002087 if (isGlobalVariable) {
2088 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
2089 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
2090 addLabel(Block, 0, dwarf::DW_FORM_udata,
2091 Asm->Mang->getSymbol(GV.getGlobal()));
2092 // Do not create specification DIE if context is either compile unit
2093 // or a subprogram.
2094 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
2095 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
2096 // Create specification DIE.
2097 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
2098 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
2099 dwarf::DW_FORM_ref4, VariableDIE);
2100 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
2101 addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
2102 TheCU->addDie(VariableSpecDIE);
2103 } else {
2104 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
2105 }
Devang Patel70eb9822011-01-06 21:39:25 +00002106 } else if (ConstantInt *CI =
2107 dyn_cast_or_null<ConstantInt>(GV.getConstant()))
2108 addConstantValue(VariableDIE, CI, isUnsignedDIType(GTy));
Devang Patel2d9e5322011-01-20 00:02:16 +00002109 else if (const ConstantExpr *CE = getMergedGlobalExpr(N->getOperand(11))) {
2110 // GV is a merged global.
2111 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
2112 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
2113 addLabel(Block, 0, dwarf::DW_FORM_udata,
2114 Asm->Mang->getSymbol(cast<GlobalValue>(CE->getOperand(0))));
2115 ConstantInt *CII = cast<ConstantInt>(CE->getOperand(2));
2116 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
2117 addUInt(Block, 0, dwarf::DW_FORM_udata, CII->getZExtValue());
2118 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
2119 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
2120 }
Devang Patel70eb9822011-01-06 21:39:25 +00002121
Devang Patel0751a282009-06-26 01:49:18 +00002122 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002123}
2124
Devang Patel1a0df9a2010-05-10 22:49:55 +00002125/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00002126void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00002127 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +00002128
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002129 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002130 CompileUnit *TheCU = getCompileUnit(N);
2131 if (TheCU->getDIE(N))
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002132 return;
2133
Bill Wendling2b128d72009-05-20 23:19:06 +00002134 if (!SP.isDefinition())
2135 // This is a method declaration which will be handled while constructing
2136 // class type.
Devang Patel0751a282009-06-26 01:49:18 +00002137 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002138
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002139 DIE *SubprogramDie = createSubprogramDIE(SP);
2140
2141 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002142 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00002143
2144 // Add to context owner.
Devang Patel1f4690c2009-12-15 19:16:48 +00002145 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +00002146
Bill Wendling2b128d72009-05-20 23:19:06 +00002147 // Expose as global.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002148 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002149
Devang Patel0751a282009-06-26 01:49:18 +00002150 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002151}
2152
Devang Patel930143b2009-11-21 02:48:08 +00002153/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbarbe22ec42009-09-19 20:40:14 +00002154/// content. Create global DIEs and emit initial debug info sections.
2155/// This is inovked by the target AsmPrinter.
Chris Lattner11980022010-04-04 07:48:20 +00002156void DwarfDebug::beginModule(Module *M) {
Devang Patel6c74a872010-04-27 19:46:33 +00002157 if (DisableDebugInfoPrinting)
2158 return;
2159
Devang Patel63524442009-07-30 18:56:46 +00002160 DebugInfoFinder DbgFinder;
2161 DbgFinder.processModule(*M);
Devang Patel0751a282009-06-26 01:49:18 +00002162
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002163 bool HasDebugInfo = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002164
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002165 // Scan all the compile-units to see if there are any marked as the main unit.
2166 // if not, we do not generate debug info.
2167 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2168 E = DbgFinder.compile_unit_end(); I != E; ++I) {
2169 if (DICompileUnit(*I).isMain()) {
2170 HasDebugInfo = true;
2171 break;
2172 }
2173 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002174
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002175 if (!HasDebugInfo) return;
2176
2177 // Tell MMI that we have debug info.
2178 MMI->setDebugInfoAvailability(true);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002179
Chris Lattnerd442aa32010-04-04 23:17:54 +00002180 // Emit initial sections.
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002181 EmitSectionLabels();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002182
Bill Wendling2b128d72009-05-20 23:19:06 +00002183 // Create all the compile unit DIEs.
Devang Patel63524442009-07-30 18:56:46 +00002184 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2185 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002186 constructCompileUnit(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002187
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002188 // Create DIEs for each subprogram.
Devang Patel63524442009-07-30 18:56:46 +00002189 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
2190 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002191 constructSubprogramDIE(*I);
Devang Patel0751a282009-06-26 01:49:18 +00002192
Devang Patel2b75ed22009-12-10 19:14:49 +00002193 // Create DIEs for each global variable.
2194 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2195 E = DbgFinder.global_variable_end(); I != E; ++I)
2196 constructGlobalVariableDIE(*I);
2197
Devang Patel8e06a5e2010-08-10 20:01:20 +00002198 //getOrCreateTypeDIE
2199 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
2200 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2201 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2202
Devang Patel7a554812010-09-28 18:08:20 +00002203 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
2204 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2205 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2206
Bill Wendling2b128d72009-05-20 23:19:06 +00002207 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +00002208 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +00002209}
2210
Devang Patel930143b2009-11-21 02:48:08 +00002211/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendling2b128d72009-05-20 23:19:06 +00002212///
Devang Patel930143b2009-11-21 02:48:08 +00002213void DwarfDebug::endModule() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002214 if (!FirstCU) return;
Devang Patelf3b2db62010-06-28 18:25:03 +00002215 const Module *M = MMI->getModule();
Devang Pateld0701282010-08-02 17:32:15 +00002216 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patelf3b2db62010-06-28 18:25:03 +00002217 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2218 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2219 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2220 DISubprogram SP(AllSPs->getOperand(SI));
2221 if (!SP.Verify()) continue;
2222
2223 // Collect info for variables that were optimized out.
Devang Patel18efced2010-07-19 17:53:55 +00002224 if (!SP.isDefinition()) continue;
Devang Patelf3b2db62010-06-28 18:25:03 +00002225 StringRef FName = SP.getLinkageName();
2226 if (FName.empty())
2227 FName = SP.getName();
Devang Patel364bf042010-11-10 22:19:21 +00002228 NamedMDNode *NMD = getFnSpecificMDNode(*(MMI->getModule()), FName);
Devang Patelf3b2db62010-06-28 18:25:03 +00002229 if (!NMD) continue;
2230 unsigned E = NMD->getNumOperands();
2231 if (!E) continue;
2232 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Pateld0701282010-08-02 17:32:15 +00002233 DeadFnScopeMap[SP] = Scope;
Devang Patelf3b2db62010-06-28 18:25:03 +00002234 for (unsigned I = 0; I != E; ++I) {
2235 DIVariable DV(NMD->getOperand(I));
2236 if (!DV.Verify()) continue;
2237 Scope->addVariable(new DbgVariable(DV));
2238 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002239
Devang Patelf3b2db62010-06-28 18:25:03 +00002240 // Construct subprogram DIE and add variables DIEs.
2241 constructSubprogramDIE(SP);
2242 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patel406798a2010-08-09 18:51:29 +00002243 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf3b2db62010-06-28 18:25:03 +00002244 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2245 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2246 if (VariableDIE)
2247 ScopeDIE->addChild(VariableDIE);
2248 }
2249 }
2250 }
Bill Wendling2b128d72009-05-20 23:19:06 +00002251
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002252 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2253 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2254 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2255 DIE *ISP = *AI;
Devang Patel930143b2009-11-21 02:48:08 +00002256 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002257 }
2258
Devang Patel32cc43c2010-05-07 20:54:48 +00002259 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Pateleb57c592009-12-03 19:11:07 +00002260 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2261 DIE *SPDie = CI->first;
Devang Patel32cc43c2010-05-07 20:54:48 +00002262 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Pateleb57c592009-12-03 19:11:07 +00002263 if (!N) continue;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002264 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Pateleb57c592009-12-03 19:11:07 +00002265 if (!NDie) continue;
2266 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Pateleb57c592009-12-03 19:11:07 +00002267 }
2268
Bill Wendling2b128d72009-05-20 23:19:06 +00002269 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002270 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002271 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002272 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002273 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +00002274
2275 // End text sections.
2276 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002277 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnera179b522010-04-04 19:25:43 +00002278 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendling2b128d72009-05-20 23:19:06 +00002279 }
2280
2281 // Emit common frame information.
Devang Patel930143b2009-11-21 02:48:08 +00002282 emitCommonDebugFrame();
Bill Wendling2b128d72009-05-20 23:19:06 +00002283
2284 // Emit function debug frame information
2285 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2286 E = DebugFrames.end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002287 emitFunctionDebugFrame(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002288
2289 // Compute DIE offsets and sizes.
Devang Patel930143b2009-11-21 02:48:08 +00002290 computeSizeAndOffsets();
Bill Wendling2b128d72009-05-20 23:19:06 +00002291
2292 // Emit all the DIEs into a debug info section
Devang Patel930143b2009-11-21 02:48:08 +00002293 emitDebugInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002294
2295 // Corresponding abbreviations into a abbrev section.
Devang Patel930143b2009-11-21 02:48:08 +00002296 emitAbbreviations();
Bill Wendling2b128d72009-05-20 23:19:06 +00002297
Bill Wendling2b128d72009-05-20 23:19:06 +00002298 // Emit info into a debug pubnames section.
Devang Patel930143b2009-11-21 02:48:08 +00002299 emitDebugPubNames();
Bill Wendling2b128d72009-05-20 23:19:06 +00002300
Devang Patel04d2f2d2009-11-24 01:14:22 +00002301 // Emit info into a debug pubtypes section.
2302 emitDebugPubTypes();
2303
Bill Wendling2b128d72009-05-20 23:19:06 +00002304 // Emit info into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002305 emitDebugLoc();
Bill Wendling2b128d72009-05-20 23:19:06 +00002306
2307 // Emit info into a debug aranges section.
2308 EmitDebugARanges();
2309
2310 // Emit info into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002311 emitDebugRanges();
Bill Wendling2b128d72009-05-20 23:19:06 +00002312
2313 // Emit info into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002314 emitDebugMacInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002315
2316 // Emit inline info.
Devang Patel930143b2009-11-21 02:48:08 +00002317 emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002318
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002319 // Emit info into a debug str section.
2320 emitDebugStr();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002321
Devang Pateld0701282010-08-02 17:32:15 +00002322 // clean up.
2323 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002324 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2325 E = CUMap.end(); I != E; ++I)
2326 delete I->second;
2327 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendling2b128d72009-05-20 23:19:06 +00002328}
2329
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002330/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002331DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattner915c5f92010-04-02 19:42:39 +00002332 DebugLoc ScopeLoc) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002333
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002334 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002335 if (AbsDbgVariable)
2336 return AbsDbgVariable;
2337
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002338 LLVMContext &Ctx = Var->getContext();
Chris Lattner915c5f92010-04-02 19:42:39 +00002339 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002340 if (!Scope)
2341 return NULL;
2342
Devang Patele1c53f22010-05-20 16:36:41 +00002343 AbsDbgVariable = new DbgVariable(Var);
Devang Patel930143b2009-11-21 02:48:08 +00002344 Scope->addVariable(AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002345 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002346 return AbsDbgVariable;
2347}
2348
Devang Patel6c622ef2011-03-01 22:58:55 +00002349/// addCurrentFnArgument - If Var is an current function argument that add
2350/// it in CurrentFnArguments list.
2351bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
2352 DbgVariable *Var, DbgScope *Scope) {
2353 if (Scope != CurrentFnDbgScope)
2354 return false;
2355 DIVariable DV = Var->getVariable();
2356 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
2357 return false;
2358 unsigned ArgNo = DV.getArgNumber();
2359 if (ArgNo == 0)
2360 return false;
2361
Devang Patel4ab660b2011-03-03 20:02:02 +00002362 size_t Size = CurrentFnArguments.size();
2363 if (Size == 0)
Devang Patel6c622ef2011-03-01 22:58:55 +00002364 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patel63b3e762011-03-03 21:49:41 +00002365 // llvm::Function argument size is not good indicator of how many
Devang Patel34a7ab42011-03-03 20:08:10 +00002366 // arguments does the function have at source level.
2367 if (ArgNo > Size)
Devang Patel4ab660b2011-03-03 20:02:02 +00002368 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel6c622ef2011-03-01 22:58:55 +00002369 CurrentFnArguments[ArgNo - 1] = Var;
2370 return true;
2371}
2372
Devang Patel490c8ab2010-05-20 19:57:06 +00002373/// collectVariableInfoFromMMITable - Collect variable information from
2374/// side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002375void
Devang Patel490c8ab2010-05-20 19:57:06 +00002376DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2377 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00002378 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patel475d32a2009-10-06 01:26:37 +00002379 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2380 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2381 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00002382 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002383 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00002384 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00002385 DIVariable DV(Var);
2386 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002387
Chris Lattner915c5f92010-04-02 19:42:39 +00002388 DbgScope *Scope = 0;
Devang Patel32cc43c2010-05-07 20:54:48 +00002389 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattner915c5f92010-04-02 19:42:39 +00002390 Scope = ConcreteScopes.lookup(IA);
2391 if (Scope == 0)
2392 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002393
Devang Patelcdb7d442009-11-10 23:20:04 +00002394 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00002395 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00002396 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002397
Devang Patele1c53f22010-05-20 16:36:41 +00002398 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2399 DbgVariable *RegVar = new DbgVariable(DV);
2400 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel6c622ef2011-03-01 22:58:55 +00002401 if (!addCurrentFnArgument(MF, RegVar, Scope))
2402 Scope->addVariable(RegVar);
Devang Patele1c53f22010-05-20 16:36:41 +00002403 if (AbsDbgVariable) {
2404 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2405 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2406 }
Devang Patel475d32a2009-10-06 01:26:37 +00002407 }
Devang Patel490c8ab2010-05-20 19:57:06 +00002408}
Devang Patela3e9c9c2010-03-15 18:33:46 +00002409
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002410/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +00002411/// DBG_VALUE instruction, is in a defined reg.
2412static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2413 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002414 return MI->getNumOperands() == 3 &&
2415 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
2416 MI->getOperand(1).isImm() && MI->getOperand(1).getImm() == 0;
Devang Patel9fc11702010-05-25 23:40:22 +00002417}
2418
Devang Patel490c8ab2010-05-20 19:57:06 +00002419/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002420void
Devang Patel5c0f85c2010-06-25 22:07:34 +00002421DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2422 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002423
Devang Patel490c8ab2010-05-20 19:57:06 +00002424 /// collection info from MMI table.
2425 collectVariableInfoFromMMITable(MF, Processed);
2426
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002427 for (SmallVectorImpl<const MDNode*>::const_iterator
2428 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
2429 ++UVI) {
2430 const MDNode *Var = *UVI;
2431 if (Processed.count(Var))
Devang Patel490c8ab2010-05-20 19:57:06 +00002432 continue;
2433
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002434 // History contains relevant DBG_VALUE instructions for Var and instructions
2435 // clobbering it.
2436 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
2437 if (History.empty())
2438 continue;
2439 const MachineInstr *MInsn = History.front();
Devang Patel9fc11702010-05-25 23:40:22 +00002440
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002441 DIVariable DV(Var);
Devang Patel447cb382011-01-11 21:42:10 +00002442 DbgScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00002443 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2444 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelfbd6c452010-05-21 00:10:20 +00002445 Scope = CurrentFnDbgScope;
Devang Patel447cb382011-01-11 21:42:10 +00002446 else
2447 Scope = findDbgScope(MInsn);
Devang Patel490c8ab2010-05-20 19:57:06 +00002448 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00002449 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00002450 continue;
2451
2452 Processed.insert(DV);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002453 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel490c8ab2010-05-20 19:57:06 +00002454 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patel6c622ef2011-03-01 22:58:55 +00002455 if (!addCurrentFnArgument(MF, RegVar, Scope))
2456 Scope->addVariable(RegVar);
Devang Patelfbd6c452010-05-21 00:10:20 +00002457 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2458 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2459 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002460 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002461
2462 // Simple ranges that are fully coalesced.
2463 if (History.size() <= 1 || (History.size() == 2 &&
2464 MInsn->isIdenticalTo(History.back()))) {
Devang Patel9fc11702010-05-25 23:40:22 +00002465 DbgVariableToDbgInstMap[RegVar] = MInsn;
2466 continue;
2467 }
2468
2469 // handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002470 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002471
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002472 for (SmallVectorImpl<const MachineInstr*>::const_iterator
2473 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
2474 const MachineInstr *Begin = *HI;
2475 assert(Begin->isDebugValue() && "Invalid History entry");
Devang Patel9fc11702010-05-25 23:40:22 +00002476 MachineLocation MLoc;
Devang Patel0e60e672010-08-04 18:40:52 +00002477 if (Begin->getNumOperands() == 3) {
2478 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2479 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2480 } else
2481 MLoc = Asm->getDebugValueLocation(Begin);
2482
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002483 // FIXME: emitDebugLoc only understands registers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002484 if (!MLoc.getReg())
2485 continue;
Jakob Stoklund Olesen9c057ee2011-03-22 00:21:41 +00002486
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002487 // Compute the range for a register location.
2488 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2489 const MCSymbol *SLabel = 0;
2490
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002491 if (HI + 1 == HE)
2492 // If Begin is the last instruction in History then its value is valid
Devang Patel9fc11702010-05-25 23:40:22 +00002493 // until the end of the funtion.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002494 SLabel = FunctionEndSym;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002495 else {
2496 const MachineInstr *End = HI[1];
2497 if (End->isDebugValue())
2498 SLabel = getLabelBeforeInsn(End);
2499 else {
2500 // End is a normal instruction clobbering the range.
2501 SLabel = getLabelAfterInsn(End);
2502 assert(SLabel && "Forgot label after clobber instruction");
2503 ++HI;
2504 }
2505 }
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002506
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002507 // The value is valid until the next DBG_VALUE or clobber.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002508 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
Devang Patel9fc11702010-05-25 23:40:22 +00002509 }
2510 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00002511 }
Devang Patele0a94bf2010-05-14 21:01:35 +00002512
2513 // Collect info for variables that were optimized out.
Devang Patelad517352010-06-22 01:01:58 +00002514 const Function *F = MF->getFunction();
Devang Patel364bf042010-11-10 22:19:21 +00002515 if (NamedMDNode *NMD = getFnSpecificMDNode(*(F->getParent()), F->getName())) {
Devang Patele0a94bf2010-05-14 21:01:35 +00002516 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002517 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel490c8ab2010-05-20 19:57:06 +00002518 if (!DV || !Processed.insert(DV))
Devang Patele0a94bf2010-05-14 21:01:35 +00002519 continue;
2520 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2521 if (Scope)
Devang Patele1c53f22010-05-20 16:36:41 +00002522 Scope->addVariable(new DbgVariable(DV));
Devang Patele0a94bf2010-05-14 21:01:35 +00002523 }
2524 }
Devang Patel9fc11702010-05-25 23:40:22 +00002525}
Devang Patele0a94bf2010-05-14 21:01:35 +00002526
Devang Patel9fc11702010-05-25 23:40:22 +00002527/// getLabelBeforeInsn - Return Label preceding the instruction.
2528const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002529 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
2530 assert(Label && "Didn't insert label before instruction");
2531 return Label;
Devang Patel9fc11702010-05-25 23:40:22 +00002532}
2533
2534/// getLabelAfterInsn - Return Label immediately following the instruction.
2535const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002536 return LabelsAfterInsn.lookup(MI);
Devang Patel475d32a2009-10-06 01:26:37 +00002537}
2538
Devang Patelb5694e72010-10-26 17:49:02 +00002539/// beginInstruction - Process beginning of an instruction.
2540void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00002541 // Check if source location changes, but ignore DBG_VALUE locations.
2542 if (!MI->isDebugValue()) {
2543 DebugLoc DL = MI->getDebugLoc();
2544 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
2545 PrevInstLoc = DL;
2546 if (!DL.isUnknown()) {
2547 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2548 recordSourceLine(DL.getLine(), DL.getCol(), Scope);
2549 } else
2550 recordSourceLine(0, 0, 0);
2551 }
Devang Patel9fc11702010-05-25 23:40:22 +00002552 }
Devang Patel23b2ae62010-03-29 22:59:58 +00002553
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00002554 // Insert labels where requested.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002555 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
2556 LabelsBeforeInsn.find(MI);
2557
2558 // No label needed.
2559 if (I == LabelsBeforeInsn.end())
2560 return;
2561
2562 // Label already assigned.
2563 if (I->second)
Devang Patel002d54d2010-05-26 19:37:24 +00002564 return;
Devang Patelbd477be2010-03-29 17:20:31 +00002565
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00002566 if (!PrevLabel) {
Devang Patelacc32a52010-05-26 21:23:46 +00002567 PrevLabel = MMI->getContext().CreateTempSymbol();
2568 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00002569 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002570 I->second = PrevLabel;
Devang Patel8db360d2009-10-06 01:50:42 +00002571}
2572
Devang Patelb5694e72010-10-26 17:49:02 +00002573/// endInstruction - Process end of an instruction.
2574void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00002575 // Don't create a new label after DBG_VALUE instructions.
2576 // They don't generate code.
2577 if (!MI->isDebugValue())
2578 PrevLabel = 0;
2579
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002580 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
2581 LabelsAfterInsn.find(MI);
2582
2583 // No label needed.
2584 if (I == LabelsAfterInsn.end())
2585 return;
2586
2587 // Label already assigned.
2588 if (I->second)
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00002589 return;
2590
2591 // We need a label after this instruction.
2592 if (!PrevLabel) {
2593 PrevLabel = MMI->getContext().CreateTempSymbol();
2594 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel3ebd8932010-04-08 16:50:29 +00002595 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002596 I->second = PrevLabel;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002597}
2598
Devang Patel6c74a872010-04-27 19:46:33 +00002599/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002600DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel30265c42010-07-07 20:12:52 +00002601 const MDNode *InlinedAt) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002602 if (!InlinedAt) {
2603 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2604 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002605 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002606 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2607 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Patel6c74a872010-04-27 19:46:33 +00002608 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002609 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002610 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Patel6c74a872010-04-27 19:46:33 +00002611 WScope->setParent(Parent);
2612 Parent->addScope(WScope);
2613 }
2614
2615 if (!WScope->getParent()) {
2616 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastings9b5005c2010-06-15 23:06:30 +00002617 // We used to check only for a linkage name, but that fails
2618 // since we began omitting the linkage name for private
2619 // functions. The new way is to check for the name in metadata,
2620 // but that's not supported in old .ll test cases. Ergo, we
2621 // check both.
Stuart Hastingsafe54f12010-06-11 20:08:44 +00002622 if (SPName == Asm->MF->getFunction()->getName() ||
2623 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Patel6c74a872010-04-27 19:46:33 +00002624 CurrentFnDbgScope = WScope;
2625 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002626
Devang Patel6c74a872010-04-27 19:46:33 +00002627 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002628 }
2629
Devang Patel5c0f85c2010-06-25 22:07:34 +00002630 getOrCreateAbstractScope(Scope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002631 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2632 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002633 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002634
2635 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2636 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2637 DILocation DL(InlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002638 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002639 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Patel6c74a872010-04-27 19:46:33 +00002640 WScope->setParent(Parent);
2641 Parent->addScope(WScope);
2642
2643 ConcreteScopes[InlinedAt] = WScope;
Devang Patel6c74a872010-04-27 19:46:33 +00002644
2645 return WScope;
Devang Patel8db360d2009-10-06 01:50:42 +00002646}
2647
Devang Patel6c74a872010-04-27 19:46:33 +00002648/// hasValidLocation - Return true if debug location entry attached with
2649/// machine instruction encodes valid location info.
2650static bool hasValidLocation(LLVMContext &Ctx,
2651 const MachineInstr *MInsn,
Devang Patel32cc43c2010-05-07 20:54:48 +00002652 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Patel6c74a872010-04-27 19:46:33 +00002653 DebugLoc DL = MInsn->getDebugLoc();
2654 if (DL.isUnknown()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002655
Devang Patel32cc43c2010-05-07 20:54:48 +00002656 const MDNode *S = DL.getScope(Ctx);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002657
Devang Patel6c74a872010-04-27 19:46:33 +00002658 // There is no need to create another DIE for compile unit. For all
2659 // other scopes, create one DbgScope now. This will be translated
2660 // into a scope DIE at the end.
2661 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002662
Devang Patel6c74a872010-04-27 19:46:33 +00002663 Scope = S;
2664 InlinedAt = DL.getInlinedAt(Ctx);
2665 return true;
2666}
2667
2668/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2669/// hierarchy.
2670static void calculateDominanceGraph(DbgScope *Scope) {
2671 assert (Scope && "Unable to calculate scop edominance graph!");
2672 SmallVector<DbgScope *, 4> WorkStack;
2673 WorkStack.push_back(Scope);
2674 unsigned Counter = 0;
2675 while (!WorkStack.empty()) {
2676 DbgScope *WS = WorkStack.back();
2677 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2678 bool visitedChildren = false;
2679 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2680 SE = Children.end(); SI != SE; ++SI) {
2681 DbgScope *ChildScope = *SI;
2682 if (!ChildScope->getDFSOut()) {
2683 WorkStack.push_back(ChildScope);
2684 visitedChildren = true;
2685 ChildScope->setDFSIn(++Counter);
2686 break;
2687 }
2688 }
2689 if (!visitedChildren) {
2690 WorkStack.pop_back();
2691 WS->setDFSOut(++Counter);
2692 }
2693 }
2694}
2695
2696/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002697static
Devang Patel6c74a872010-04-27 19:46:33 +00002698void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2699 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2700{
2701#ifndef NDEBUG
2702 unsigned PrevDFSIn = 0;
2703 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2704 I != E; ++I) {
2705 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2706 II != IE; ++II) {
2707 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002708 const MDNode *Scope = NULL;
2709 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002710
2711 // Check if instruction has valid location information.
2712 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2713 dbgs() << " [ ";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002714 if (InlinedAt)
Devang Patel6c74a872010-04-27 19:46:33 +00002715 dbgs() << "*";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002716 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Patel6c74a872010-04-27 19:46:33 +00002717 MI2ScopeMap.find(MInsn);
2718 if (DI != MI2ScopeMap.end()) {
2719 DbgScope *S = DI->second;
2720 dbgs() << S->getDFSIn();
2721 PrevDFSIn = S->getDFSIn();
2722 } else
2723 dbgs() << PrevDFSIn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002724 } else
Devang Patel6c74a872010-04-27 19:46:33 +00002725 dbgs() << " [ x" << PrevDFSIn;
2726 dbgs() << " ]";
2727 MInsn->dump();
2728 }
2729 dbgs() << "\n";
2730 }
2731#endif
2732}
Devang Patel930143b2009-11-21 02:48:08 +00002733/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner848c7d22010-03-31 05:39:57 +00002734/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattner76555b52010-01-26 23:18:02 +00002735bool DwarfDebug::extractScopeInformation() {
Devang Patel75cc16c2009-10-01 20:31:14 +00002736 // If scope information was extracted using .dbg intrinsics then there is not
2737 // any need to extract these information by scanning each instruction.
2738 if (!DbgScopeMap.empty())
2739 return false;
2740
Dan Gohmane9135cb2010-04-23 01:18:53 +00002741 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patel6c74a872010-04-27 19:46:33 +00002742 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2743 SmallVector<DbgRange, 4> MIRanges;
2744 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patel32cc43c2010-05-07 20:54:48 +00002745 const MDNode *PrevScope = NULL;
2746 const MDNode *PrevInlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002747 const MachineInstr *RangeBeginMI = NULL;
2748 const MachineInstr *PrevMI = NULL;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002749 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel75cc16c2009-10-01 20:31:14 +00002750 I != E; ++I) {
2751 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2752 II != IE; ++II) {
2753 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002754 const MDNode *Scope = NULL;
2755 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002756
2757 // Check if instruction has valid location information.
2758 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2759 PrevMI = MInsn;
2760 continue;
2761 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002762
Devang Patel6c74a872010-04-27 19:46:33 +00002763 // If scope has not changed then skip this instruction.
2764 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2765 PrevMI = MInsn;
2766 continue;
2767 }
2768
Devang Pateld12c0a22011-02-15 17:56:09 +00002769 // Ignore DBG_VALUE. It does not contribute any instruction in output.
2770 if (MInsn->isDebugValue())
2771 continue;
2772
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002773 if (RangeBeginMI) {
2774 // If we have alread seen a beginning of a instruction range and
Devang Patel6c74a872010-04-27 19:46:33 +00002775 // current instruction scope does not match scope of first instruction
2776 // in this range then create a new instruction range.
2777 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002778 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel30265c42010-07-07 20:12:52 +00002779 PrevInlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002780 MIRanges.push_back(R);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002781 }
Devang Patel6c74a872010-04-27 19:46:33 +00002782
2783 // This is a beginning of a new instruction range.
2784 RangeBeginMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002785
Devang Patel6c74a872010-04-27 19:46:33 +00002786 // Reset previous markers.
2787 PrevMI = MInsn;
2788 PrevScope = Scope;
2789 PrevInlinedAt = InlinedAt;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002790 }
2791 }
2792
Devang Patel6c74a872010-04-27 19:46:33 +00002793 // Create last instruction range.
2794 if (RangeBeginMI && PrevMI && PrevScope) {
2795 DbgRange R(RangeBeginMI, PrevMI);
2796 MIRanges.push_back(R);
2797 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patel75cc16c2009-10-01 20:31:14 +00002798 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002799
Devang Patel530a0752010-01-04 20:44:00 +00002800 if (!CurrentFnDbgScope)
2801 return false;
2802
Devang Patel6c74a872010-04-27 19:46:33 +00002803 calculateDominanceGraph(CurrentFnDbgScope);
2804 if (PrintDbgScope)
2805 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2806
2807 // Find ranges of instructions covered by each DbgScope;
2808 DbgScope *PrevDbgScope = NULL;
2809 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2810 RE = MIRanges.end(); RI != RE; ++RI) {
2811 const DbgRange &R = *RI;
2812 DbgScope *S = MI2ScopeMap.lookup(R.first);
2813 assert (S && "Lost DbgScope for a machine instruction!");
2814 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2815 PrevDbgScope->closeInsnRange(S);
2816 S->openInsnRange(R.first);
2817 S->extendInsnRange(R.second);
2818 PrevDbgScope = S;
2819 }
2820
2821 if (PrevDbgScope)
2822 PrevDbgScope->closeInsnRange();
Devang Patel75cc16c2009-10-01 20:31:14 +00002823
Devang Patel359b0132010-04-08 18:43:56 +00002824 identifyScopeMarkers();
Devang Patelf1d5a1e2010-04-08 15:37:09 +00002825
2826 return !DbgScopeMap.empty();
2827}
2828
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002829/// identifyScopeMarkers() -
Devang Patel6c74a872010-04-27 19:46:33 +00002830/// Each DbgScope has first instruction and last instruction to mark beginning
2831/// and end of a scope respectively. Create an inverse map that list scopes
2832/// starts (and ends) with an instruction. One instruction may start (or end)
2833/// multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00002834void DwarfDebug::identifyScopeMarkers() {
Devang Patel7771b7c2010-01-20 02:05:23 +00002835 SmallVector<DbgScope *, 4> WorkList;
2836 WorkList.push_back(CurrentFnDbgScope);
2837 while (!WorkList.empty()) {
Chris Lattner848c7d22010-03-31 05:39:57 +00002838 DbgScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002839
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002840 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002841 if (!Children.empty())
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002842 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00002843 SE = Children.end(); SI != SE; ++SI)
2844 WorkList.push_back(*SI);
2845
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002846 if (S->isAbstractScope())
2847 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002848
Devang Patel6c74a872010-04-27 19:46:33 +00002849 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2850 if (Ranges.empty())
2851 continue;
2852 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2853 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002854 assert(RI->first && "DbgRange does not have first instruction!");
2855 assert(RI->second && "DbgRange does not have second instruction!");
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002856 requestLabelBeforeInsn(RI->first);
2857 requestLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00002858 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002859 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002860}
2861
Dan Gohman3df671a2010-04-20 00:37:27 +00002862/// FindFirstDebugLoc - Find the first debug location in the function. This
2863/// is intended to be an approximation for the source position of the
2864/// beginning of the function.
2865static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2866 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2867 I != E; ++I)
2868 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2869 MBBI != MBBE; ++MBBI) {
2870 DebugLoc DL = MBBI->getDebugLoc();
2871 if (!DL.isUnknown())
2872 return DL;
2873 }
2874 return DebugLoc();
2875}
2876
Devang Patela86114b2010-10-25 20:45:32 +00002877#ifndef NDEBUG
2878/// CheckLineNumbers - Count basicblocks whose instructions do not have any
2879/// line number information.
2880static void CheckLineNumbers(const MachineFunction *MF) {
2881 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2882 I != E; ++I) {
2883 bool FoundLineNo = false;
2884 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2885 II != IE; ++II) {
2886 const MachineInstr *MI = II;
2887 if (!MI->getDebugLoc().isUnknown()) {
2888 FoundLineNo = true;
2889 break;
2890 }
2891 }
Devang Patel6e0d5892010-10-28 22:11:59 +00002892 if (!FoundLineNo && I->size())
Devang Patela86114b2010-10-25 20:45:32 +00002893 ++BlocksWithoutLineNo;
2894 }
2895}
2896#endif
2897
Devang Patel930143b2009-11-21 02:48:08 +00002898/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendling2b128d72009-05-20 23:19:06 +00002899/// emitted immediately after the function entry point.
Chris Lattner76555b52010-01-26 23:18:02 +00002900void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00002901 if (!MMI->hasDebugInfo()) return;
Bill Wendlingfcc14142010-04-07 09:28:04 +00002902 if (!extractScopeInformation()) return;
Devang Patel4598eb62009-10-06 18:37:31 +00002903
Devang Patela86114b2010-10-25 20:45:32 +00002904#ifndef NDEBUG
2905 CheckLineNumbers(MF);
2906#endif
2907
Devang Patel6c74a872010-04-27 19:46:33 +00002908 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2909 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00002910 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00002911 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00002912
2913 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2914 // function.
Dan Gohman3df671a2010-04-20 00:37:27 +00002915 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattner915c5f92010-04-02 19:42:39 +00002916 if (FDL.isUnknown()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002917
Devang Patel32cc43c2010-05-07 20:54:48 +00002918 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings61475c52010-07-19 23:56:30 +00002919 const MDNode *TheScope = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002920
Chris Lattner915c5f92010-04-02 19:42:39 +00002921 DISubprogram SP = getDISubprogram(Scope);
2922 unsigned Line, Col;
2923 if (SP.Verify()) {
2924 Line = SP.getLineNumber();
2925 Col = 0;
Stuart Hastings61475c52010-07-19 23:56:30 +00002926 TheScope = SP;
Chris Lattner915c5f92010-04-02 19:42:39 +00002927 } else {
2928 Line = FDL.getLine();
2929 Col = FDL.getCol();
Stuart Hastings61475c52010-07-19 23:56:30 +00002930 TheScope = Scope;
Bill Wendling2b128d72009-05-20 23:19:06 +00002931 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002932
Stuart Hastings61475c52010-07-19 23:56:30 +00002933 recordSourceLine(Line, Col, TheScope);
Devang Patel002d54d2010-05-26 19:37:24 +00002934
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002935 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
2936
Devang Patel21ccf052010-06-02 16:42:51 +00002937 /// ProcessedArgs - Collection of arguments already processed.
2938 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2939
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002940 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
2941
2942 /// LiveUserVar - Map physreg numbers to the MDNode they contain.
2943 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
2944
Devang Patel002d54d2010-05-26 19:37:24 +00002945 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002946 I != E; ++I) {
2947 bool AtBlockEntry = true;
Devang Patel002d54d2010-05-26 19:37:24 +00002948 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2949 II != IE; ++II) {
2950 const MachineInstr *MI = II;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002951
Devang Patel002d54d2010-05-26 19:37:24 +00002952 if (MI->isDebugValue()) {
Devang Patel002d54d2010-05-26 19:37:24 +00002953 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002954
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002955 // Keep track of user variables.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002956 const MDNode *Var =
2957 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002958
2959 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00002960 if (isDbgValueInDefinedReg(MI))
2961 LiveUserVar[MI->getOperand(0).getReg()] = Var;
2962
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00002963 // Check the history of this variable.
2964 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
2965 if (History.empty()) {
2966 UserVariables.push_back(Var);
2967 // The first mention of a function argument gets the FunctionBeginSym
2968 // label, so arguments are visible when breaking at function entry.
2969 DIVariable DV(Var);
2970 if (DV.Verify() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
2971 DISubprogram(getDISubprogram(DV.getContext()))
2972 .describes(MF->getFunction()))
2973 LabelsBeforeInsn[MI] = FunctionBeginSym;
2974 } else {
2975 // We have seen this variable before. Try to coalesce DBG_VALUEs.
2976 const MachineInstr *Prev = History.back();
2977 if (Prev->isDebugValue()) {
2978 // Coalesce identical entries at the end of History.
2979 if (History.size() >= 2 &&
2980 Prev->isIdenticalTo(History[History.size() - 2]))
2981 History.pop_back();
2982
2983 // Terminate old register assignments that don't reach MI;
2984 MachineFunction::const_iterator PrevMBB = Prev->getParent();
2985 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
2986 isDbgValueInDefinedReg(Prev)) {
2987 // Previous register assignment needs to terminate at the end of
2988 // its basic block.
2989 MachineBasicBlock::const_iterator LastMI =
2990 PrevMBB->getLastNonDebugInstr();
2991 if (LastMI == PrevMBB->end())
2992 // Drop DBG_VALUE for empty range.
2993 History.pop_back();
2994 else {
2995 // Terminate after LastMI.
2996 History.push_back(LastMI);
2997 }
2998 }
2999 }
3000 }
3001 History.push_back(MI);
Devang Patel002d54d2010-05-26 19:37:24 +00003002 } else {
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00003003 // Not a DBG_VALUE instruction.
3004 if (!MI->isLabel())
3005 AtBlockEntry = false;
3006
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00003007 // Check if the instruction clobbers any registers with debug vars.
3008 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
3009 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
3010 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
3011 continue;
3012 for (const unsigned *AI = TRI->getOverlaps(MOI->getReg());
3013 unsigned Reg = *AI; ++AI) {
3014 const MDNode *Var = LiveUserVar[Reg];
3015 if (!Var)
3016 continue;
3017 // Reg is now clobbered.
3018 LiveUserVar[Reg] = 0;
3019
3020 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00003021 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
3022 if (HistI == DbgValues.end())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00003023 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00003024 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
3025 if (History.empty())
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00003026 continue;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00003027 const MachineInstr *Prev = History.back();
3028 // Sanity-check: Register assignments are terminated at the end of
3029 // their block.
3030 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
3031 continue;
3032 // Is the variable still in Reg?
3033 if (!isDbgValueInDefinedReg(Prev) ||
3034 Prev->getOperand(0).getReg() != Reg)
3035 continue;
3036 // Var is clobbered. Make sure the next instruction gets a label.
3037 History.push_back(MI);
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +00003038 }
3039 }
Devang Patel002d54d2010-05-26 19:37:24 +00003040 }
Devang Patel002d54d2010-05-26 19:37:24 +00003041 }
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00003042 }
3043
3044 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
3045 I != E; ++I) {
3046 SmallVectorImpl<const MachineInstr*> &History = I->second;
3047 if (History.empty())
3048 continue;
3049
3050 // Make sure the final register assignments are terminated.
3051 const MachineInstr *Prev = History.back();
3052 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
3053 const MachineBasicBlock *PrevMBB = Prev->getParent();
3054 MachineBasicBlock::const_iterator LastMI = PrevMBB->getLastNonDebugInstr();
3055 if (LastMI == PrevMBB->end())
3056 // Drop DBG_VALUE for empty range.
3057 History.pop_back();
3058 else {
3059 // Terminate after LastMI.
3060 History.push_back(LastMI);
3061 }
3062 }
3063 // Request labels for the full history.
3064 for (unsigned i = 0, e = History.size(); i != e; ++i) {
3065 const MachineInstr *MI = History[i];
3066 if (MI->isDebugValue())
3067 requestLabelBeforeInsn(MI);
3068 else
3069 requestLabelAfterInsn(MI);
3070 }
3071 }
Devang Patel002d54d2010-05-26 19:37:24 +00003072
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00003073 PrevInstLoc = DebugLoc();
Devang Patel002d54d2010-05-26 19:37:24 +00003074 PrevLabel = FunctionBeginSym;
Bill Wendling2b128d72009-05-20 23:19:06 +00003075}
3076
Devang Patel930143b2009-11-21 02:48:08 +00003077/// endFunction - Gather and emit post-function debug information.
Bill Wendling2b128d72009-05-20 23:19:06 +00003078///
Chris Lattner76555b52010-01-26 23:18:02 +00003079void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendlingfcc14142010-04-07 09:28:04 +00003080 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00003081
Devang Patel530a0752010-01-04 20:44:00 +00003082 if (CurrentFnDbgScope) {
Devang Patel4a8e6e82010-05-22 00:04:14 +00003083
Devang Patel9fc11702010-05-25 23:40:22 +00003084 // Define end label for subprogram.
3085 FunctionEndSym = Asm->GetTempSymbol("func_end",
3086 Asm->getFunctionNumber());
3087 // Assumes in correct section after the entry point.
3088 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003089
Devang Patel5c0f85c2010-06-25 22:07:34 +00003090 SmallPtrSet<const MDNode *, 16> ProcessedVars;
3091 collectVariableInfo(MF, ProcessedVars);
Devang Patel4a8e6e82010-05-22 00:04:14 +00003092
Devang Patel530a0752010-01-04 20:44:00 +00003093 // Construct abstract scopes.
3094 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel5c0f85c2010-06-25 22:07:34 +00003095 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00003096 DISubprogram SP((*AI)->getScopeNode());
3097 if (SP.Verify()) {
3098 // Collect info for variables that were optimized out.
3099 StringRef FName = SP.getLinkageName();
3100 if (FName.empty())
3101 FName = SP.getName();
Devang Patel364bf042010-11-10 22:19:21 +00003102 if (NamedMDNode *NMD =
3103 getFnSpecificMDNode(*(MF->getFunction()->getParent()), FName)) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00003104 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00003105 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel5c0f85c2010-06-25 22:07:34 +00003106 if (!DV || !ProcessedVars.insert(DV))
3107 continue;
Devang Patel648df7b2010-06-30 00:11:08 +00003108 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel5c0f85c2010-06-25 22:07:34 +00003109 if (Scope)
3110 Scope->addVariable(new DbgVariable(DV));
3111 }
3112 }
3113 }
Devang Patelc5b31092010-06-30 01:40:11 +00003114 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
3115 constructScopeDIE(*AI);
Devang Patel5c0f85c2010-06-25 22:07:34 +00003116 }
Devang Patel30265c42010-07-07 20:12:52 +00003117
Devang Patel075e9b52010-05-04 06:15:30 +00003118 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003119
Devang Patel075e9b52010-05-04 06:15:30 +00003120 if (!DisableFramePointerElim(*MF))
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003121 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel075e9b52010-05-04 06:15:30 +00003122 dwarf::DW_FORM_flag, 1);
3123
3124
Chris Lattner3a383cb2010-04-05 00:13:49 +00003125 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel530a0752010-01-04 20:44:00 +00003126 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00003127 }
3128
Bill Wendling2b128d72009-05-20 23:19:06 +00003129 // Clear debug info
Devang Patelfe189e62010-01-19 01:26:02 +00003130 CurrentFnDbgScope = NULL;
Devang Patel6c622ef2011-03-01 22:58:55 +00003131 CurrentFnArguments.clear();
Devang Patele1c53f22010-05-20 16:36:41 +00003132 DbgVariableToFrameIndexMap.clear();
3133 VarToAbstractVarMap.clear();
3134 DbgVariableToDbgInstMap.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00003135 DeleteContainerSeconds(DbgScopeMap);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +00003136 UserVariables.clear();
3137 DbgValues.clear();
Devang Patelfe189e62010-01-19 01:26:02 +00003138 ConcreteScopes.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00003139 DeleteContainerSeconds(AbstractScopes);
Devang Patelfe189e62010-01-19 01:26:02 +00003140 AbstractScopesList.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00003141 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00003142 LabelsBeforeInsn.clear();
3143 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00003144 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00003145}
3146
Devang Patele1c53f22010-05-20 16:36:41 +00003147/// recordVariableFrameIndex - Record a variable's index.
3148void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
3149 assert (V && "Invalid DbgVariable!");
3150 DbgVariableToFrameIndexMap[V] = Index;
3151}
3152
3153/// findVariableFrameIndex - Return true if frame index for the variable
3154/// is found. Update FI to hold value of the index.
3155bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
3156 assert (V && "Invalid DbgVariable!");
3157 DenseMap<const DbgVariable *, int>::iterator I =
3158 DbgVariableToFrameIndexMap.find(V);
3159 if (I == DbgVariableToFrameIndexMap.end())
3160 return false;
3161 *FI = I->second;
3162 return true;
3163}
3164
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003165/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patel490c8ab2010-05-20 19:57:06 +00003166/// instruction.
3167DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
3168 DbgScope *Scope = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003169 LLVMContext &Ctx =
Devang Patel490c8ab2010-05-20 19:57:06 +00003170 MInsn->getParent()->getParent()->getFunction()->getContext();
3171 DebugLoc DL = MInsn->getDebugLoc();
3172
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003173 if (DL.isUnknown())
Devang Patel490c8ab2010-05-20 19:57:06 +00003174 return Scope;
3175
3176 if (const MDNode *IA = DL.getInlinedAt(Ctx))
3177 Scope = ConcreteScopes.lookup(IA);
3178 if (Scope == 0)
3179 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003180
Devang Patel490c8ab2010-05-20 19:57:06 +00003181 return Scope;
3182}
3183
3184
Chris Lattnerba35a672010-03-09 04:54:43 +00003185/// recordSourceLine - Register a source line with debug info. Returns the
3186/// unique label that was emitted and which provides correspondence to
3187/// the source line list.
Jakob Stoklund Olesen1886a4c2011-03-25 17:20:59 +00003188void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S){
Devang Patel2d9caf92009-11-25 17:36:49 +00003189 StringRef Fn;
Devang Patele01b75c2011-03-24 20:30:50 +00003190 StringRef Dir;
Dan Gohman50849c62010-05-05 23:41:32 +00003191 unsigned Src = 1;
3192 if (S) {
3193 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00003194
Dan Gohman50849c62010-05-05 23:41:32 +00003195 if (Scope.isCompileUnit()) {
3196 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00003197 Fn = CU.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00003198 Dir = CU.getDirectory();
Devang Patelc4b69052010-10-28 17:30:52 +00003199 } else if (Scope.isFile()) {
3200 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00003201 Fn = F.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00003202 Dir = F.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00003203 } else if (Scope.isSubprogram()) {
3204 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00003205 Fn = SP.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00003206 Dir = SP.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00003207 } else if (Scope.isLexicalBlock()) {
3208 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00003209 Fn = DB.getFilename();
Devang Patele01b75c2011-03-24 20:30:50 +00003210 Dir = DB.getDirectory();
Dan Gohman50849c62010-05-05 23:41:32 +00003211 } else
3212 assert(0 && "Unexpected scope info");
3213
Devang Patele01b75c2011-03-24 20:30:50 +00003214 Src = GetOrCreateSourceID(Fn, Dir);
Dan Gohman50849c62010-05-05 23:41:32 +00003215 }
3216
Rafael Espindola67c6ab82010-11-18 02:04:25 +00003217 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, DWARF2_FLAG_IS_STMT,
3218 0, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00003219}
3220
Bill Wendling806535f2009-05-20 23:22:40 +00003221//===----------------------------------------------------------------------===//
3222// Emit Methods
3223//===----------------------------------------------------------------------===//
3224
Devang Patel930143b2009-11-21 02:48:08 +00003225/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling480ff322009-05-20 23:21:38 +00003226///
Jim Grosbach00e9c612009-11-22 19:20:36 +00003227unsigned
3228DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling480ff322009-05-20 23:21:38 +00003229 // Get the children.
3230 const std::vector<DIE *> &Children = Die->getChildren();
3231
3232 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00003233 if (!Last && !Children.empty())
Benjamin Kramer74729ae2010-03-31 19:34:01 +00003234 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling480ff322009-05-20 23:21:38 +00003235
3236 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00003237 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00003238
3239 // Get the abbreviation for this DIE.
3240 unsigned AbbrevNumber = Die->getAbbrevNumber();
3241 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3242
3243 // Set DIE offset
3244 Die->setOffset(Offset);
3245
3246 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00003247 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003248
3249 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
3250 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3251
3252 // Size the DIE attribute values.
3253 for (unsigned i = 0, N = Values.size(); i < N; ++i)
3254 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00003255 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00003256
3257 // Size the DIE children if any.
3258 if (!Children.empty()) {
3259 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
3260 "Children flag not set");
3261
3262 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003263 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling480ff322009-05-20 23:21:38 +00003264
3265 // End of children marker.
3266 Offset += sizeof(int8_t);
3267 }
3268
3269 Die->setSize(Offset - Die->getOffset());
3270 return Offset;
3271}
3272
Devang Patel930143b2009-11-21 02:48:08 +00003273/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling480ff322009-05-20 23:21:38 +00003274///
Devang Patel930143b2009-11-21 02:48:08 +00003275void DwarfDebug::computeSizeAndOffsets() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003276 unsigned PrevOffset = 0;
3277 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3278 E = CUMap.end(); I != E; ++I) {
3279 // Compute size of compile unit header.
3280 static unsigned Offset = PrevOffset +
3281 sizeof(int32_t) + // Length of Compilation Unit Info
3282 sizeof(int16_t) + // DWARF version number
3283 sizeof(int32_t) + // Offset Into Abbrev. Section
3284 sizeof(int8_t); // Pointer Size (in bytes)
3285 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
3286 PrevOffset = Offset;
3287 }
Bill Wendling480ff322009-05-20 23:21:38 +00003288}
3289
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003290/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3291/// temporary label to it if SymbolStem is specified.
Chris Lattner6629ca92010-04-04 22:59:04 +00003292static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003293 const char *SymbolStem = 0) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003294 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003295 if (!SymbolStem) return 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003296
Chris Lattner6629ca92010-04-04 22:59:04 +00003297 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3298 Asm->OutStreamer.EmitLabel(TmpSym);
3299 return TmpSym;
3300}
3301
3302/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3303/// the start of each one.
Chris Lattner46355d82010-04-04 22:33:59 +00003304void DwarfDebug::EmitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003305 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003306
Bill Wendling480ff322009-05-20 23:21:38 +00003307 // Dwarf sections base addresses.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003308 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003309 DwarfFrameSectionSym =
3310 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3311 }
Bill Wendling480ff322009-05-20 23:21:38 +00003312
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003313 DwarfInfoSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003314 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003315 DwarfAbbrevSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003316 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003317 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003318
Chris Lattner6629ca92010-04-04 22:59:04 +00003319 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003320 EmitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003321
Devang Patel4a213872010-08-24 00:06:12 +00003322 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003323 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3324 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3325 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003326 DwarfStrSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003327 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patel12563b32010-04-16 23:33:45 +00003328 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3329 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00003330
Devang Patel9fc11702010-05-25 23:40:22 +00003331 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3332 "section_debug_loc");
3333
Chris Lattner6629ca92010-04-04 22:59:04 +00003334 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattnere58b5472010-04-04 23:10:38 +00003335 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003336}
3337
Devang Patel930143b2009-11-21 02:48:08 +00003338/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling480ff322009-05-20 23:21:38 +00003339///
Devang Patel930143b2009-11-21 02:48:08 +00003340void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00003341 // Get the abbreviation for this DIE.
3342 unsigned AbbrevNumber = Die->getAbbrevNumber();
3343 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3344
Bill Wendling480ff322009-05-20 23:21:38 +00003345 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00003346 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00003347 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3348 Twine::utohexstr(Die->getOffset()) + ":0x" +
3349 Twine::utohexstr(Die->getSize()) + " " +
3350 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00003351 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003352
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00003353 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00003354 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3355
3356 // Emit the DIE attribute values.
3357 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3358 unsigned Attr = AbbrevData[i].getAttribute();
3359 unsigned Form = AbbrevData[i].getForm();
3360 assert(Form && "Too many attributes for DIE (check abbreviation)");
3361
Chris Lattner7bde8c02010-04-04 18:52:31 +00003362 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00003363 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003364
Bill Wendling480ff322009-05-20 23:21:38 +00003365 switch (Attr) {
3366 case dwarf::DW_AT_sibling:
Devang Patel930143b2009-11-21 02:48:08 +00003367 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003368 break;
3369 case dwarf::DW_AT_abstract_origin: {
3370 DIEEntry *E = cast<DIEEntry>(Values[i]);
3371 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003372 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00003373 Asm->EmitInt32(Addr);
3374 break;
3375 }
Devang Patel12563b32010-04-16 23:33:45 +00003376 case dwarf::DW_AT_ranges: {
3377 // DW_AT_range Value encodes offset in debug_range section.
3378 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00003379
3380 if (Asm->MAI->doesDwarfUsesLabelOffsetForRanges()) {
3381 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
3382 V->getValue(),
3383 4);
3384 } else {
3385 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3386 V->getValue(),
3387 DwarfDebugRangeSectionSym,
3388 4);
3389 }
Devang Patel12563b32010-04-16 23:33:45 +00003390 break;
3391 }
Devang Patel9fc11702010-05-25 23:40:22 +00003392 case dwarf::DW_AT_location: {
3393 if (UseDotDebugLocEntry.count(Die) != 0) {
3394 DIELabel *L = cast<DIELabel>(Values[i]);
Daniel Dunbarfd95b012011-03-16 22:16:39 +00003395 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
Devang Patel9fc11702010-05-25 23:40:22 +00003396 } else
3397 Values[i]->EmitValue(Asm, Form);
3398 break;
3399 }
Devang Patela1bd5a12010-09-29 19:08:08 +00003400 case dwarf::DW_AT_accessibility: {
3401 if (Asm->isVerbose()) {
3402 DIEInteger *V = cast<DIEInteger>(Values[i]);
3403 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
3404 }
3405 Values[i]->EmitValue(Asm, Form);
3406 break;
3407 }
Bill Wendling480ff322009-05-20 23:21:38 +00003408 default:
3409 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003410 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00003411 break;
3412 }
Bill Wendling480ff322009-05-20 23:21:38 +00003413 }
3414
3415 // Emit the DIE children if any.
3416 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3417 const std::vector<DIE *> &Children = Die->getChildren();
3418
3419 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003420 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00003421
Chris Lattner7bde8c02010-04-04 18:52:31 +00003422 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00003423 Asm->OutStreamer.AddComment("End Of Children Mark");
3424 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003425 }
3426}
3427
Devang Patel9ccfb642009-12-09 18:24:21 +00003428/// emitDebugInfo - Emit the debug info section.
Bill Wendling480ff322009-05-20 23:21:38 +00003429///
Devang Patel9ccfb642009-12-09 18:24:21 +00003430void DwarfDebug::emitDebugInfo() {
3431 // Start debug info section.
3432 Asm->OutStreamer.SwitchSection(
3433 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel1a0df9a2010-05-10 22:49:55 +00003434 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3435 E = CUMap.end(); I != E; ++I) {
3436 CompileUnit *TheCU = I->second;
3437 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003438
Devang Patel1a0df9a2010-05-10 22:49:55 +00003439 // Emit the compile units header.
3440 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3441 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003442
Devang Patel1a0df9a2010-05-10 22:49:55 +00003443 // Emit size of content not including length itself
3444 unsigned ContentSize = Die->getSize() +
3445 sizeof(int16_t) + // DWARF version number
3446 sizeof(int32_t) + // Offset Into Abbrev. Section
3447 sizeof(int8_t) + // Pointer Size (in bytes)
3448 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003449
Devang Patel1a0df9a2010-05-10 22:49:55 +00003450 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3451 Asm->EmitInt32(ContentSize);
3452 Asm->OutStreamer.AddComment("DWARF version number");
3453 Asm->EmitInt16(dwarf::DWARF_VERSION);
3454 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3455 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3456 DwarfAbbrevSectionSym);
3457 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3458 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003459
Devang Patel1a0df9a2010-05-10 22:49:55 +00003460 emitDIE(Die);
3461 // FIXME - extra padding for gdb bug.
3462 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3463 Asm->EmitInt8(0);
3464 Asm->EmitInt8(0);
3465 Asm->EmitInt8(0);
3466 Asm->EmitInt8(0);
3467 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3468 }
Bill Wendling480ff322009-05-20 23:21:38 +00003469}
3470
Devang Patel930143b2009-11-21 02:48:08 +00003471/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling480ff322009-05-20 23:21:38 +00003472///
Devang Patel930143b2009-11-21 02:48:08 +00003473void DwarfDebug::emitAbbreviations() const {
Bill Wendling480ff322009-05-20 23:21:38 +00003474 // Check to see if it is worth the effort.
3475 if (!Abbreviations.empty()) {
3476 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003477 Asm->OutStreamer.SwitchSection(
3478 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003479
Chris Lattnera179b522010-04-04 19:25:43 +00003480 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003481
3482 // For each abbrevation.
3483 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3484 // Get abbreviation data
3485 const DIEAbbrev *Abbrev = Abbreviations[i];
3486
3487 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00003488 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00003489
3490 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003491 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00003492 }
3493
3494 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00003495 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00003496
Chris Lattnera179b522010-04-04 19:25:43 +00003497 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003498 }
3499}
3500
Devang Patel930143b2009-11-21 02:48:08 +00003501/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling480ff322009-05-20 23:21:38 +00003502/// the line matrix.
3503///
Devang Patel930143b2009-11-21 02:48:08 +00003504void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00003505 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00003506 Asm->OutStreamer.AddComment("Extended Op");
3507 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003508
Chris Lattner566cae92010-03-09 23:52:58 +00003509 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003510 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00003511 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3512 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3513
3514 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00003515
Chris Lattnera179b522010-04-04 19:25:43 +00003516 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003517 Asm->getTargetData().getPointerSize(),
3518 0/*AddrSpace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003519
3520 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00003521 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3522 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003523 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00003524 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003525}
3526
Devang Patel930143b2009-11-21 02:48:08 +00003527/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling480ff322009-05-20 23:21:38 +00003528///
Devang Patel930143b2009-11-21 02:48:08 +00003529void DwarfDebug::emitCommonDebugFrame() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003530 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003531 return;
3532
Chris Lattner3a383cb2010-04-05 00:13:49 +00003533 int stackGrowth = Asm->getTargetData().getPointerSize();
Anton Korobeynikov2f931282011-01-10 12:39:04 +00003534 if (Asm->TM.getFrameLowering()->getStackGrowthDirection() ==
3535 TargetFrameLowering::StackGrowsDown)
Chris Lattner3a383cb2010-04-05 00:13:49 +00003536 stackGrowth *= -1;
Bill Wendling480ff322009-05-20 23:21:38 +00003537
3538 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003539 Asm->OutStreamer.SwitchSection(
3540 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003541
Chris Lattnera179b522010-04-04 19:25:43 +00003542 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner566cae92010-03-09 23:52:58 +00003543 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003544 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3545 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003546
Chris Lattnera179b522010-04-04 19:25:43 +00003547 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner566cae92010-03-09 23:52:58 +00003548 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling480ff322009-05-20 23:21:38 +00003549 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner566cae92010-03-09 23:52:58 +00003550 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling480ff322009-05-20 23:21:38 +00003551 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner566cae92010-03-09 23:52:58 +00003552 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003553 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner9efd1182010-04-04 19:09:29 +00003554 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3555 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner566cae92010-03-09 23:52:58 +00003556 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003557 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Anton Korobeynikov2f931282011-01-10 12:39:04 +00003558 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
Bill Wendling480ff322009-05-20 23:21:38 +00003559 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling480ff322009-05-20 23:21:38 +00003560
3561 std::vector<MachineMove> Moves;
Anton Korobeynikov14ee3442010-11-18 23:25:52 +00003562 TFI->getInitialFrameState(Moves);
Bill Wendling480ff322009-05-20 23:21:38 +00003563
Chris Lattneraabc6042010-04-04 23:41:46 +00003564 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003565
Chris Lattner9e06e532010-04-28 01:05:45 +00003566 Asm->EmitAlignment(2);
Chris Lattnera179b522010-04-04 19:25:43 +00003567 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003568}
3569
Devang Patel930143b2009-11-21 02:48:08 +00003570/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling480ff322009-05-20 23:21:38 +00003571/// section.
Chris Lattner2c3f4782010-03-13 07:26:18 +00003572void DwarfDebug::
3573emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003574 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003575 return;
3576
3577 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003578 Asm->OutStreamer.SwitchSection(
3579 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003580
Chris Lattner566cae92010-03-09 23:52:58 +00003581 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner2c3f4782010-03-13 07:26:18 +00003582 MCSymbol *DebugFrameBegin =
Chris Lattnera179b522010-04-04 19:25:43 +00003583 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003584 MCSymbol *DebugFrameEnd =
Chris Lattnera179b522010-04-04 19:25:43 +00003585 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnerf1429f12010-04-04 19:58:12 +00003586 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003587
Chris Lattner2c3f4782010-03-13 07:26:18 +00003588 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling480ff322009-05-20 23:21:38 +00003589
Chris Lattner566cae92010-03-09 23:52:58 +00003590 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003591 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner70a4fce2010-04-04 23:25:33 +00003592 DwarfFrameSectionSym);
Bill Wendling480ff322009-05-20 23:21:38 +00003593
Chris Lattner566cae92010-03-09 23:52:58 +00003594 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnera179b522010-04-04 19:25:43 +00003595 MCSymbol *FuncBeginSym =
3596 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattner8811e122010-03-13 07:40:56 +00003597 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattner3a383cb2010-04-05 00:13:49 +00003598 Asm->getTargetData().getPointerSize(),
3599 0/*AddrSpace*/);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003600
3601
Chris Lattner566cae92010-03-09 23:52:58 +00003602 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003603 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003604 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003605
Chris Lattneraabc6042010-04-04 23:41:46 +00003606 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003607
Chris Lattner9e06e532010-04-28 01:05:45 +00003608 Asm->EmitAlignment(2);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003609 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling480ff322009-05-20 23:21:38 +00003610}
3611
Devang Patel9ccfb642009-12-09 18:24:21 +00003612/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3613///
3614void DwarfDebug::emitDebugPubNames() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003615 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3616 E = CUMap.end(); I != E; ++I) {
3617 CompileUnit *TheCU = I->second;
3618 // Start the dwarf pubnames section.
3619 Asm->OutStreamer.SwitchSection(
3620 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003621
Devang Patel1a0df9a2010-05-10 22:49:55 +00003622 Asm->OutStreamer.AddComment("Length of Public Names Info");
3623 Asm->EmitLabelDifference(
3624 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3625 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003626
Devang Patel1a0df9a2010-05-10 22:49:55 +00003627 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3628 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003629
Devang Patel1a0df9a2010-05-10 22:49:55 +00003630 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003631 Asm->EmitInt16(dwarf::DWARF_VERSION);
3632
Devang Patel1a0df9a2010-05-10 22:49:55 +00003633 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003634 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00003635 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003636
Devang Patel1a0df9a2010-05-10 22:49:55 +00003637 Asm->OutStreamer.AddComment("Compilation Unit Length");
3638 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3639 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3640 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003641
Devang Patel1a0df9a2010-05-10 22:49:55 +00003642 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3643 for (StringMap<DIE*>::const_iterator
3644 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3645 const char *Name = GI->getKeyData();
3646 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003647
Devang Patel1a0df9a2010-05-10 22:49:55 +00003648 Asm->OutStreamer.AddComment("DIE offset");
3649 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003650
Devang Patel1a0df9a2010-05-10 22:49:55 +00003651 if (Asm->isVerbose())
3652 Asm->OutStreamer.AddComment("External Name");
3653 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3654 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003655
Devang Patel1a0df9a2010-05-10 22:49:55 +00003656 Asm->OutStreamer.AddComment("End Mark");
3657 Asm->EmitInt32(0);
3658 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3659 TheCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00003660 }
Bill Wendling480ff322009-05-20 23:21:38 +00003661}
3662
Devang Patel04d2f2d2009-11-24 01:14:22 +00003663void DwarfDebug::emitDebugPubTypes() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003664 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3665 E = CUMap.end(); I != E; ++I) {
3666 CompileUnit *TheCU = I->second;
3667 // Start the dwarf pubnames section.
3668 Asm->OutStreamer.SwitchSection(
3669 Asm->getObjFileLowering().getDwarfPubTypesSection());
3670 Asm->OutStreamer.AddComment("Length of Public Types Info");
3671 Asm->EmitLabelDifference(
3672 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3673 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003674
Devang Patel1a0df9a2010-05-10 22:49:55 +00003675 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3676 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003677
Devang Patel1a0df9a2010-05-10 22:49:55 +00003678 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3679 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003680
Devang Patel1a0df9a2010-05-10 22:49:55 +00003681 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3682 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3683 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003684
Devang Patel1a0df9a2010-05-10 22:49:55 +00003685 Asm->OutStreamer.AddComment("Compilation Unit Length");
3686 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3687 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3688 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003689
Devang Patel1a0df9a2010-05-10 22:49:55 +00003690 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3691 for (StringMap<DIE*>::const_iterator
3692 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3693 const char *Name = GI->getKeyData();
3694 DIE * Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003695
Devang Patel1a0df9a2010-05-10 22:49:55 +00003696 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3697 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003698
Devang Patel1a0df9a2010-05-10 22:49:55 +00003699 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3700 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3701 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003702
Devang Patel1a0df9a2010-05-10 22:49:55 +00003703 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003704 Asm->EmitInt32(0);
Devang Patel1a0df9a2010-05-10 22:49:55 +00003705 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3706 TheCU->getID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00003707 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00003708}
3709
Devang Patel930143b2009-11-21 02:48:08 +00003710/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling480ff322009-05-20 23:21:38 +00003711///
Devang Patel930143b2009-11-21 02:48:08 +00003712void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00003713 // Check to see if it is worth the effort.
Chris Lattner3d72a672010-03-09 23:38:23 +00003714 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003715
Chris Lattner3d72a672010-03-09 23:38:23 +00003716 // Start the dwarf str section.
3717 Asm->OutStreamer.SwitchSection(
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003718 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003719
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003720 // Get all of the string pool entries and put them in an array by their ID so
3721 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003722 SmallVector<std::pair<unsigned,
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003723 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003724
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003725 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3726 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3727 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003728
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003729 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003730
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003731 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00003732 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003733 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003734
Chris Lattner3d72a672010-03-09 23:38:23 +00003735 // Emit the string itself.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003736 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003737 }
3738}
3739
Devang Patel930143b2009-11-21 02:48:08 +00003740/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling480ff322009-05-20 23:21:38 +00003741///
Devang Patel930143b2009-11-21 02:48:08 +00003742void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003743 if (DotDebugLocEntries.empty())
3744 return;
3745
Devang Patel116a9d72011-02-04 22:57:18 +00003746 for (SmallVector<DotDebugLocEntry, 4>::iterator
3747 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
3748 I != E; ++I) {
3749 DotDebugLocEntry &Entry = *I;
3750 if (I + 1 != DotDebugLocEntries.end())
3751 Entry.Merge(I+1);
3752 }
3753
Daniel Dunbarfd95b012011-03-16 22:16:39 +00003754 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003755 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00003756 Asm->getObjFileLowering().getDwarfLocSection());
3757 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003758 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3759 unsigned index = 1;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003760 for (SmallVector<DotDebugLocEntry, 4>::iterator
3761 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00003762 I != E; ++I, ++index) {
Devang Patel116a9d72011-02-04 22:57:18 +00003763 DotDebugLocEntry &Entry = *I;
3764 if (Entry.isMerged()) continue;
Devang Patel9fc11702010-05-25 23:40:22 +00003765 if (Entry.isEmpty()) {
3766 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3767 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003768 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00003769 } else {
3770 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3771 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3772 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3773 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patel0e60e672010-08-04 18:40:52 +00003774 if (int Offset = Entry.Loc.getOffset()) {
3775 // If the value is at a certain offset from frame register then
3776 // use DW_OP_fbreg.
3777 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patel9fc11702010-05-25 23:40:22 +00003778 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patel0e60e672010-08-04 18:40:52 +00003779 Asm->EmitInt16(1 + OffsetSize);
3780 Asm->OutStreamer.AddComment(
3781 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3782 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3783 Asm->OutStreamer.AddComment("Offset");
3784 Asm->EmitSLEB128(Offset);
Devang Patel9fc11702010-05-25 23:40:22 +00003785 } else {
Devang Patel0e60e672010-08-04 18:40:52 +00003786 if (Reg < 32) {
3787 Asm->OutStreamer.AddComment("Loc expr size");
3788 Asm->EmitInt16(1);
3789 Asm->OutStreamer.AddComment(
Devang Patel6d21f612010-08-04 20:32:36 +00003790 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patel0e60e672010-08-04 18:40:52 +00003791 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3792 } else {
3793 Asm->OutStreamer.AddComment("Loc expr size");
3794 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3795 Asm->EmitInt8(dwarf::DW_OP_regx);
3796 Asm->EmitULEB128(Reg);
3797 }
Devang Patel9fc11702010-05-25 23:40:22 +00003798 }
3799 }
3800 }
Bill Wendling480ff322009-05-20 23:21:38 +00003801}
3802
3803/// EmitDebugARanges - Emit visible names into a debug aranges section.
3804///
3805void DwarfDebug::EmitDebugARanges() {
3806 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003807 Asm->OutStreamer.SwitchSection(
3808 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003809}
3810
Devang Patel930143b2009-11-21 02:48:08 +00003811/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling480ff322009-05-20 23:21:38 +00003812///
Devang Patel930143b2009-11-21 02:48:08 +00003813void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00003814 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003815 Asm->OutStreamer.SwitchSection(
Devang Patel12563b32010-04-16 23:33:45 +00003816 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Patel6c74a872010-04-27 19:46:33 +00003817 unsigned char Size = Asm->getTargetData().getPointerSize();
3818 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003819 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00003820 I != E; ++I) {
3821 if (*I)
3822 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patel12563b32010-04-16 23:33:45 +00003823 else
Devang Patel6c74a872010-04-27 19:46:33 +00003824 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel12563b32010-04-16 23:33:45 +00003825 }
Bill Wendling480ff322009-05-20 23:21:38 +00003826}
3827
Devang Patel930143b2009-11-21 02:48:08 +00003828/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling480ff322009-05-20 23:21:38 +00003829///
Devang Patel930143b2009-11-21 02:48:08 +00003830void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003831 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00003832 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00003833 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003834 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003835 }
3836}
3837
Devang Patel930143b2009-11-21 02:48:08 +00003838/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling480ff322009-05-20 23:21:38 +00003839/// Section Header:
3840/// 1. length of section
3841/// 2. Dwarf version number
3842/// 3. address size.
3843///
3844/// Entries (one "entry" for each function that was inlined):
3845///
3846/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3847/// otherwise offset into __debug_str for regular function name.
3848/// 2. offset into __debug_str section for regular function name.
3849/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3850/// instances for the function.
3851///
3852/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3853/// inlined instance; the die_offset points to the inlined_subroutine die in the
3854/// __debug_info section, and the low_pc is the starting address for the
3855/// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00003856void DwarfDebug::emitDebugInlineInfo() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003857 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003858 return;
3859
Devang Patel1a0df9a2010-05-10 22:49:55 +00003860 if (!FirstCU)
Bill Wendling480ff322009-05-20 23:21:38 +00003861 return;
3862
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003863 Asm->OutStreamer.SwitchSection(
3864 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003865
Chris Lattner566cae92010-03-09 23:52:58 +00003866 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003867 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3868 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003869
Chris Lattnera179b522010-04-04 19:25:43 +00003870 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003871
Chris Lattner566cae92010-03-09 23:52:58 +00003872 Asm->OutStreamer.AddComment("Dwarf Version");
3873 Asm->EmitInt16(dwarf::DWARF_VERSION);
3874 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003875 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003876
Devang Patel32cc43c2010-05-07 20:54:48 +00003877 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003878 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00003879
Devang Patel32cc43c2010-05-07 20:54:48 +00003880 const MDNode *Node = *I;
3881 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00003882 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003883 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00003884 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00003885 StringRef LName = SP.getLinkageName();
3886 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00003887
Chris Lattner566cae92010-03-09 23:52:58 +00003888 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003889 if (LName.empty()) {
3890 Asm->OutStreamer.EmitBytes(Name, 0);
3891 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003892 } else
Chris Lattner70a4fce2010-04-04 23:25:33 +00003893 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3894 DwarfStrSectionSym);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003895
Chris Lattner566cae92010-03-09 23:52:58 +00003896 Asm->OutStreamer.AddComment("Function name");
Chris Lattner70a4fce2010-04-04 23:25:33 +00003897 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner9efd1182010-04-04 19:09:29 +00003898 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00003899
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003900 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00003901 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner7bde8c02010-04-04 18:52:31 +00003902 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner085b6522010-03-09 00:31:02 +00003903 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003904
Chris Lattner7bde8c02010-04-04 18:52:31 +00003905 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003906 Asm->OutStreamer.EmitSymbolValue(LI->first,
3907 Asm->getTargetData().getPointerSize(),0);
Bill Wendling480ff322009-05-20 23:21:38 +00003908 }
3909 }
3910
Chris Lattnera179b522010-04-04 19:25:43 +00003911 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003912}