blob: d8c15fb5fb6f11bd2f7cb711fc1e3861df22503d [file] [log] [blame]
Bill Wendling2f921f82009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Chris Lattnerb14490d2010-03-09 00:39:24 +000013
Devang Patel80ae3492009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling2f921f82009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000016#include "DIE.h"
Bill Wendling30346342010-04-05 22:59:21 +000017#include "llvm/Constants.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000018#include "llvm/Module.h"
Devang Patel2d9e5322011-01-20 00:02:16 +000019#include "llvm/Instructions.h"
David Greene829b3e82009-08-19 21:52:55 +000020#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000021#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000022#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000023#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000024#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000025#include "llvm/MC/MCSymbol.h"
Chris Lattnerf62e3ee2010-01-16 21:57:06 +000026#include "llvm/Target/Mangler.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000027#include "llvm/Target/TargetData.h"
Anton Korobeynikov2f931282011-01-10 12:39:04 +000028#include "llvm/Target/TargetFrameLowering.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000029#include "llvm/Target/TargetLoweringObjectFile.h"
Chris Lattner21dc46e2010-04-04 18:06:11 +000030#include "llvm/Target/TargetMachine.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000031#include "llvm/Target/TargetRegisterInfo.h"
Devang Patel61880932010-04-19 19:14:02 +000032#include "llvm/Target/TargetOptions.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000033#include "llvm/Analysis/DebugInfo.h"
Devang Patela86114b2010-10-25 20:45:32 +000034#include "llvm/ADT/Statistic.h"
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000035#include "llvm/ADT/STLExtras.h"
Chris Lattner06fa1762009-08-24 03:52:50 +000036#include "llvm/ADT/StringExtras.h"
Devang Patel6c74a872010-04-27 19:46:33 +000037#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000038#include "llvm/Support/Debug.h"
39#include "llvm/Support/ErrorHandling.h"
Devang Patel1973df22010-01-26 21:39:14 +000040#include "llvm/Support/ValueHandle.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000041#include "llvm/Support/FormattedStream.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000042#include "llvm/Support/Timer.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000043#include "llvm/Support/Path.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000044using namespace llvm;
45
Devang Patel6c74a872010-04-27 19:46:33 +000046static cl::opt<bool> PrintDbgScope("print-dbgscope", cl::Hidden,
47 cl::desc("Print DbgScope information for each machine instruction"));
48
Jim Grosbacha8683bb2010-07-21 21:21:52 +000049static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel30265c42010-07-07 20:12:52 +000050 cl::Hidden,
Devang Patel6c74a872010-04-27 19:46:33 +000051 cl::desc("Disable debug info printing"));
52
Dan Gohman7421ae42010-05-07 01:08:53 +000053static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
54 cl::desc("Make an absense of debug location information explicit."),
55 cl::init(false));
56
Nick Lewycky90b2ac22010-10-26 00:51:57 +000057#ifndef NDEBUG
Devang Patela86114b2010-10-25 20:45:32 +000058STATISTIC(BlocksWithoutLineNo, "Number of blocks without any line number");
Nick Lewycky90b2ac22010-10-26 00:51:57 +000059#endif
Devang Patela86114b2010-10-25 20:45:32 +000060
Bill Wendlingfcc14142010-04-07 09:28:04 +000061namespace {
62 const char *DWARFGroupName = "DWARF Emission";
63 const char *DbgTimerName = "DWARF Debug Writer";
64} // end anonymous namespace
65
Bill Wendling2f921f82009-05-15 09:23:25 +000066//===----------------------------------------------------------------------===//
67
68/// Configuration values for initial hash set sizes (log2).
69///
Bill Wendling2f921f82009-05-15 09:23:25 +000070static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +000071
72namespace llvm {
73
74//===----------------------------------------------------------------------===//
75/// CompileUnit - This dwarf writer support class manages information associate
76/// with a source file.
Nick Lewyckyb7993d62009-11-17 08:11:44 +000077class CompileUnit {
Bill Wendling2f921f82009-05-15 09:23:25 +000078 /// ID - File identifier for source.
79 ///
80 unsigned ID;
81
82 /// Die - Compile unit debug information entry.
83 ///
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000084 const OwningPtr<DIE> CUDie;
Bill Wendling2f921f82009-05-15 09:23:25 +000085
Jeffrey Yasskin0708de12010-03-11 18:29:55 +000086 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
Devang Patel92e8c652009-11-21 00:31:03 +000087 DIE *IndexTyDie;
88
Devang Patel9a0339f2010-07-07 20:49:57 +000089 /// MDNodeToDieMap - Tracks the mapping of unit level debug informaton
Bill Wendling2f921f82009-05-15 09:23:25 +000090 /// variables to debug information entries.
Devang Patel9a0339f2010-07-07 20:49:57 +000091 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
Bill Wendling2f921f82009-05-15 09:23:25 +000092
Devang Patel9a0339f2010-07-07 20:49:57 +000093 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug informaton
Bill Wendling2f921f82009-05-15 09:23:25 +000094 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patel9a0339f2010-07-07 20:49:57 +000095 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
Bill Wendling2f921f82009-05-15 09:23:25 +000096
97 /// Globals - A map of globally visible named entities for this unit.
98 ///
99 StringMap<DIE*> Globals;
100
Devang Patel04d2f2d2009-11-24 01:14:22 +0000101 /// GlobalTypes - A map of globally visible types for this unit.
102 ///
103 StringMap<DIE*> GlobalTypes;
104
Bill Wendling2f921f82009-05-15 09:23:25 +0000105public:
106 CompileUnit(unsigned I, DIE *D)
Devang Patel930143b2009-11-21 02:48:08 +0000107 : ID(I), CUDie(D), IndexTyDie(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000108
109 // Accessors.
Devang Patel04d2f2d2009-11-24 01:14:22 +0000110 unsigned getID() const { return ID; }
Jeffrey Yasskin0708de12010-03-11 18:29:55 +0000111 DIE* getCUDie() const { return CUDie.get(); }
Devang Patel04d2f2d2009-11-24 01:14:22 +0000112 const StringMap<DIE*> &getGlobals() const { return Globals; }
113 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000114
115 /// hasContent - Return true if this compile unit has something to write out.
116 ///
Devang Patel930143b2009-11-21 02:48:08 +0000117 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000118
Devang Patel930143b2009-11-21 02:48:08 +0000119 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +0000120 ///
Benjamin Kramer96956ed2010-03-31 20:15:45 +0000121 void addGlobal(StringRef Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000122
Devang Patel04d2f2d2009-11-24 01:14:22 +0000123 /// addGlobalType - Add a new global type to the compile unit.
124 ///
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000125 void addGlobalType(StringRef Name, DIE *Die) {
126 GlobalTypes[Name] = Die;
Devang Patel04d2f2d2009-11-24 01:14:22 +0000127 }
128
Devang Patele064ad42009-11-20 21:37:22 +0000129 /// getDIE - Returns the debug information entry map slot for the
Bill Wendling2f921f82009-05-15 09:23:25 +0000130 /// specified debug variable.
Devang Patel9a0339f2010-07-07 20:49:57 +0000131 DIE *getDIE(const MDNode *N) { return MDNodeToDieMap.lookup(N); }
Jim Grosbach042483e2009-11-21 23:12:12 +0000132
Devang Patele064ad42009-11-20 21:37:22 +0000133 /// insertDIE - Insert DIE into the map.
Devang Patel32cc43c2010-05-07 20:54:48 +0000134 void insertDIE(const MDNode *N, DIE *D) {
Devang Patel9a0339f2010-07-07 20:49:57 +0000135 MDNodeToDieMap.insert(std::make_pair(N, D));
Devang Patele064ad42009-11-20 21:37:22 +0000136 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000137
Devang Patele064ad42009-11-20 21:37:22 +0000138 /// getDIEEntry - Returns the debug information entry for the speciefied
139 /// debug variable.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000140 DIEEntry *getDIEEntry(const MDNode *N) {
141 DenseMap<const MDNode *, DIEEntry *>::iterator I =
142 MDNodeToDIEEntryMap.find(N);
Devang Patel9a0339f2010-07-07 20:49:57 +0000143 if (I == MDNodeToDIEEntryMap.end())
Devang Patel1f4690c2009-12-15 19:16:48 +0000144 return NULL;
145 return I->second;
146 }
Devang Patele064ad42009-11-20 21:37:22 +0000147
148 /// insertDIEEntry - Insert debug information entry into the map.
Devang Patel32cc43c2010-05-07 20:54:48 +0000149 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
Devang Patel9a0339f2010-07-07 20:49:57 +0000150 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
Bill Wendling2f921f82009-05-15 09:23:25 +0000151 }
152
Devang Patel930143b2009-11-21 02:48:08 +0000153 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +0000154 ///
Devang Patel930143b2009-11-21 02:48:08 +0000155 void addDie(DIE *Buffer) {
156 this->CUDie->addChild(Buffer);
Bill Wendling2f921f82009-05-15 09:23:25 +0000157 }
Devang Patel92e8c652009-11-21 00:31:03 +0000158
159 // getIndexTyDie - Get an anonymous type for index type.
160 DIE *getIndexTyDie() {
161 return IndexTyDie;
162 }
163
Jim Grosbach00e9c612009-11-22 19:20:36 +0000164 // setIndexTyDie - Set D as anonymous type for index which can be reused
165 // later.
Devang Patel92e8c652009-11-21 00:31:03 +0000166 void setIndexTyDie(DIE *D) {
167 IndexTyDie = D;
168 }
169
Bill Wendling2f921f82009-05-15 09:23:25 +0000170};
171
172//===----------------------------------------------------------------------===//
173/// DbgVariable - This class is used to track local variable information.
174///
Devang Patelf3d7c082009-11-16 21:53:40 +0000175class DbgVariable {
Bill Wendling2f921f82009-05-15 09:23:25 +0000176 DIVariable Var; // Variable Descriptor.
Devang Patel9fc11702010-05-25 23:40:22 +0000177 DIE *TheDIE; // Variable DIE.
178 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
Bill Wendling2f921f82009-05-15 09:23:25 +0000179public:
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000180 // AbsVar may be NULL.
Devang Patel9fc11702010-05-25 23:40:22 +0000181 DbgVariable(DIVariable V) : Var(V), TheDIE(0), DotDebugLocOffset(~0U) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000182
183 // Accessors.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000184 DIVariable getVariable() const { return Var; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000185 void setDIE(DIE *D) { TheDIE = D; }
186 DIE *getDIE() const { return TheDIE; }
Devang Patel9fc11702010-05-25 23:40:22 +0000187 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
188 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000189 StringRef getName() const { return Var.getName(); }
190 unsigned getTag() const { return Var.getTag(); }
191 bool variableHasComplexAddress() const {
192 assert(Var.Verify() && "Invalid complex DbgVariable!");
193 return Var.hasComplexAddress();
194 }
195 bool isBlockByrefVariable() const {
196 assert(Var.Verify() && "Invalid complex DbgVariable!");
197 return Var.isBlockByrefVariable();
198 }
199 unsigned getNumAddrElements() const {
200 assert(Var.Verify() && "Invalid complex DbgVariable!");
201 return Var.getNumAddrElements();
202 }
203 uint64_t getAddrElement(unsigned i) const {
204 return Var.getAddrElement(i);
205 }
206 DIType getType() const {
207 DIType Ty = Var.getType();
208 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
209 // addresses instead.
210 if (Var.isBlockByrefVariable()) {
211 /* Byref variables, in Blocks, are declared by the programmer as
212 "SomeType VarName;", but the compiler creates a
213 __Block_byref_x_VarName struct, and gives the variable VarName
214 either the struct, or a pointer to the struct, as its type. This
215 is necessary for various behind-the-scenes things the compiler
216 needs to do with by-reference variables in blocks.
217
218 However, as far as the original *programmer* is concerned, the
219 variable should still have type 'SomeType', as originally declared.
220
221 The following function dives into the __Block_byref_x_VarName
222 struct to find the original type of the variable. This will be
223 passed back to the code generating the type for the Debug
224 Information Entry for the variable 'VarName'. 'VarName' will then
225 have the original type 'SomeType' in its debug information.
226
227 The original type 'SomeType' will be the type of the field named
228 'VarName' inside the __Block_byref_x_VarName struct.
229
230 NOTE: In order for this to not completely fail on the debugger
231 side, the Debug Information Entry for the variable VarName needs to
232 have a DW_AT_location that tells the debugger how to unwind through
233 the pointers and __Block_byref_x_VarName struct to find the actual
234 value of the variable. The function addBlockByrefType does this. */
235 DIType subType = Ty;
236 unsigned tag = Ty.getTag();
237
238 if (tag == dwarf::DW_TAG_pointer_type) {
239 DIDerivedType DTy = DIDerivedType(Ty);
240 subType = DTy.getTypeDerivedFrom();
241 }
242
243 DICompositeType blockStruct = DICompositeType(subType);
244 DIArray Elements = blockStruct.getTypeArray();
245
246 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
247 DIDescriptor Element = Elements.getElement(i);
248 DIDerivedType DT = DIDerivedType(Element);
249 if (getName() == DT.getName())
250 return (DT.getTypeDerivedFrom());
251 }
252 return Ty;
253 }
254 return Ty;
255 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000256};
257
258//===----------------------------------------------------------------------===//
Devang Patel6c74a872010-04-27 19:46:33 +0000259/// DbgRange - This is used to track range of instructions with identical
260/// debug info scope.
261///
262typedef std::pair<const MachineInstr *, const MachineInstr *> DbgRange;
263
264//===----------------------------------------------------------------------===//
Bill Wendling2f921f82009-05-15 09:23:25 +0000265/// DbgScope - This class is used to track scope information.
266///
Devang Patelf3d7c082009-11-16 21:53:40 +0000267class DbgScope {
Bill Wendling2f921f82009-05-15 09:23:25 +0000268 DbgScope *Parent; // Parent to this scope.
Jim Grosbach042483e2009-11-21 23:12:12 +0000269 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel1973df22010-01-26 21:39:14 +0000270 // Location at which this scope is inlined.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000271 AssertingVH<const MDNode> InlinedAtLocation;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000272 bool AbstractScope; // Abstract Scope
Devang Patel787f94c2009-10-01 18:25:23 +0000273 const MachineInstr *LastInsn; // Last instruction of this scope.
274 const MachineInstr *FirstInsn; // First instruction of this scope.
Devang Patel6c74a872010-04-27 19:46:33 +0000275 unsigned DFSIn, DFSOut;
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000276 // Scopes defined in scope. Contents not owned.
277 SmallVector<DbgScope *, 4> Scopes;
278 // Variables declared in scope. Contents owned.
279 SmallVector<DbgVariable *, 8> Variables;
Devang Patel6c74a872010-04-27 19:46:33 +0000280 SmallVector<DbgRange, 4> Ranges;
Owen Anderson9becc182009-06-24 22:53:20 +0000281 // Private state for dump()
282 mutable unsigned IndentLevel;
Bill Wendling2f921f82009-05-15 09:23:25 +0000283public:
Devang Patel32cc43c2010-05-07 20:54:48 +0000284 DbgScope(DbgScope *P, DIDescriptor D, const MDNode *I = 0)
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000285 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Devang Patel6c74a872010-04-27 19:46:33 +0000286 LastInsn(0), FirstInsn(0),
287 DFSIn(0), DFSOut(0), IndentLevel(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000288 virtual ~DbgScope();
289
290 // Accessors.
291 DbgScope *getParent() const { return Parent; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000292 void setParent(DbgScope *P) { Parent = P; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000293 DIDescriptor getDesc() const { return Desc; }
Devang Patel32cc43c2010-05-07 20:54:48 +0000294 const MDNode *getInlinedAt() const { return InlinedAtLocation; }
295 const MDNode *getScopeNode() const { return Desc; }
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000296 const SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
Devang Patel406798a2010-08-09 18:51:29 +0000297 const SmallVector<DbgVariable *, 8> &getDbgVariables() { return Variables; }
Devang Patel6c74a872010-04-27 19:46:33 +0000298 const SmallVector<DbgRange, 4> &getRanges() { return Ranges; }
299
300 /// openInsnRange - This scope covers instruction range starting from MI.
301 void openInsnRange(const MachineInstr *MI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000302 if (!FirstInsn)
Devang Patel6c74a872010-04-27 19:46:33 +0000303 FirstInsn = MI;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000304
Devang Patel6c74a872010-04-27 19:46:33 +0000305 if (Parent)
306 Parent->openInsnRange(MI);
307 }
308
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000309 /// extendInsnRange - Extend the current instruction range covered by
Devang Patel6c74a872010-04-27 19:46:33 +0000310 /// this scope.
311 void extendInsnRange(const MachineInstr *MI) {
312 assert (FirstInsn && "MI Range is not open!");
313 LastInsn = MI;
314 if (Parent)
315 Parent->extendInsnRange(MI);
316 }
317
318 /// closeInsnRange - Create a range based on FirstInsn and LastInsn collected
319 /// until now. This is used when a new scope is encountered while walking
320 /// machine instructions.
321 void closeInsnRange(DbgScope *NewScope = NULL) {
322 assert (LastInsn && "Last insn missing!");
323 Ranges.push_back(DbgRange(FirstInsn, LastInsn));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000324 FirstInsn = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +0000325 LastInsn = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000326 // If Parent dominates NewScope then do not close Parent's instruction
Devang Patel6c74a872010-04-27 19:46:33 +0000327 // range.
328 if (Parent && (!NewScope || !Parent->dominates(NewScope)))
329 Parent->closeInsnRange(NewScope);
330 }
331
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000332 void setAbstractScope() { AbstractScope = true; }
333 bool isAbstractScope() const { return AbstractScope; }
Devang Patel6c74a872010-04-27 19:46:33 +0000334
335 // Depth First Search support to walk and mainpluate DbgScope hierarchy.
336 unsigned getDFSOut() const { return DFSOut; }
337 void setDFSOut(unsigned O) { DFSOut = O; }
338 unsigned getDFSIn() const { return DFSIn; }
339 void setDFSIn(unsigned I) { DFSIn = I; }
340 bool dominates(const DbgScope *S) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000341 if (S == this)
Devang Patel6c74a872010-04-27 19:46:33 +0000342 return true;
343 if (DFSIn < S->getDFSIn() && DFSOut > S->getDFSOut())
344 return true;
345 return false;
346 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000347
Devang Patel930143b2009-11-21 02:48:08 +0000348 /// addScope - Add a scope to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000349 ///
Devang Patel930143b2009-11-21 02:48:08 +0000350 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000351
Devang Patel930143b2009-11-21 02:48:08 +0000352 /// addVariable - Add a variable to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000353 ///
Devang Patel930143b2009-11-21 02:48:08 +0000354 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000355
Bill Wendling2f921f82009-05-15 09:23:25 +0000356#ifndef NDEBUG
357 void dump() const;
358#endif
359};
Devang Patel6c74a872010-04-27 19:46:33 +0000360
Chris Lattnerf5d06362010-04-05 04:09:20 +0000361} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000362
363#ifndef NDEBUG
364void DbgScope::dump() const {
David Greenec230cb92009-12-24 00:31:35 +0000365 raw_ostream &err = dbgs();
Chris Lattner81e8e022009-08-23 00:51:00 +0000366 err.indent(IndentLevel);
Devang Patel32cc43c2010-05-07 20:54:48 +0000367 const MDNode *N = Desc;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000368 N->dump();
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000369 if (AbstractScope)
370 err << "Abstract Scope\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000371
372 IndentLevel += 2;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000373 if (!Scopes.empty())
374 err << "Children ...\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000375 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
376 if (Scopes[i] != this)
377 Scopes[i]->dump();
378
379 IndentLevel -= 2;
380}
381#endif
382
Bill Wendling2f921f82009-05-15 09:23:25 +0000383DbgScope::~DbgScope() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000384 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
385 delete Variables[j];
Bill Wendling2f921f82009-05-15 09:23:25 +0000386}
387
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000388DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Devang Patel1a0df9a2010-05-10 22:49:55 +0000389 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000390 AbbreviationsSet(InitAbbreviationsSetSize),
Devang Patel12563b32010-04-16 23:33:45 +0000391 CurrentFnDbgScope(0), PrevLabel(NULL) {
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000392 NextStringPoolNumber = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000393
Chris Lattnere58b5472010-04-04 23:10:38 +0000394 DwarfFrameSectionSym = DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
395 DwarfStrSectionSym = TextSectionSym = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000396 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000397 FunctionBeginSym = FunctionEndSym = 0;
Devang Patel9c160e12010-07-08 20:10:35 +0000398 DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
Dan Gohman6e681a52010-06-18 15:56:31 +0000399 {
400 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
401 beginModule(M);
Torok Edwinf8dba242010-04-07 10:44:46 +0000402 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000403}
404DwarfDebug::~DwarfDebug() {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000405 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
406 DIEBlocks[j]->~DIEBlock();
Bill Wendling2f921f82009-05-15 09:23:25 +0000407}
408
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000409MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
410 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
411 if (Entry.first) return Entry.first;
412
413 Entry.second = NextStringPoolNumber++;
Chris Lattnera179b522010-04-04 19:25:43 +0000414 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000415}
416
417
Devang Patel930143b2009-11-21 02:48:08 +0000418/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling2f921f82009-05-15 09:23:25 +0000419///
Devang Patel930143b2009-11-21 02:48:08 +0000420void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000421 // Profile the node so that we can make it unique.
422 FoldingSetNodeID ID;
423 Abbrev.Profile(ID);
424
425 // Check the set for priors.
426 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
427
428 // If it's newly added.
429 if (InSet == &Abbrev) {
430 // Add to abbreviation list.
431 Abbreviations.push_back(&Abbrev);
432
433 // Assign the vector position + 1 as its number.
434 Abbrev.setNumber(Abbreviations.size());
435 } else {
436 // Assign existing abbreviation number.
437 Abbrev.setNumber(InSet->getNumber());
438 }
439}
440
Devang Patel930143b2009-11-21 02:48:08 +0000441/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendlingbcad77a2009-05-20 23:24:48 +0000442/// information entry.
Devang Patel930143b2009-11-21 02:48:08 +0000443DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000444 DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000445 return Value;
446}
447
Devang Patel930143b2009-11-21 02:48:08 +0000448/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000449///
Devang Patel930143b2009-11-21 02:48:08 +0000450void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000451 unsigned Form, uint64_t Integer) {
452 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000453 DIEValue *Value = Integer == 1 ?
Devang Patel9c160e12010-07-08 20:10:35 +0000454 DIEIntegerOne : new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000455 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000456}
457
Devang Patel930143b2009-11-21 02:48:08 +0000458/// addSInt - Add an signed integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000459///
Devang Patel930143b2009-11-21 02:48:08 +0000460void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000461 unsigned Form, int64_t Integer) {
462 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000463 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000464 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000465}
466
Devang Patel8c339592009-12-02 15:25:16 +0000467/// addString - Add a string attribute data and value. DIEString only
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000468/// keeps string reference.
Devang Patel930143b2009-11-21 02:48:08 +0000469void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerc3f23b82010-01-23 03:11:46 +0000470 StringRef String) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000471 DIEValue *Value = new (DIEValueAllocator) DIEString(String);
Devang Patel930143b2009-11-21 02:48:08 +0000472 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000473}
474
Devang Patel930143b2009-11-21 02:48:08 +0000475/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000476///
Devang Patel930143b2009-11-21 02:48:08 +0000477void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000478 const MCSymbol *Label) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000479 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
Devang Patel930143b2009-11-21 02:48:08 +0000480 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000481}
482
Devang Patel930143b2009-11-21 02:48:08 +0000483/// addDelta - Add a label delta attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000484///
Devang Patel930143b2009-11-21 02:48:08 +0000485void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000486 const MCSymbol *Hi, const MCSymbol *Lo) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000487 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
Devang Patel930143b2009-11-21 02:48:08 +0000488 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000489}
490
Chris Lattner3f3fb972010-04-05 05:24:55 +0000491/// addDIEEntry - Add a DIE attribute data and value.
492///
493void DwarfDebug::addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form,
494 DIE *Entry) {
495 Die->addValue(Attribute, Form, createDIEEntry(Entry));
496}
497
498
Devang Patel930143b2009-11-21 02:48:08 +0000499/// addBlock - Add block data.
Bill Wendling2f921f82009-05-15 09:23:25 +0000500///
Devang Patel930143b2009-11-21 02:48:08 +0000501void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling2f921f82009-05-15 09:23:25 +0000502 DIEBlock *Block) {
Chris Lattner5a00dea2010-04-05 00:18:22 +0000503 Block->ComputeSize(Asm);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000504 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
Devang Patel930143b2009-11-21 02:48:08 +0000505 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000506}
507
Devang Patel930143b2009-11-21 02:48:08 +0000508/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000509/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000510void DwarfDebug::addSourceLine(DIE *Die, DIVariable V) {
Devang Patel0625af22010-05-07 23:33:41 +0000511 // Verify variable.
Devang Patelb6511a32010-08-09 20:20:05 +0000512 if (!V.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000513 return;
514
Devang Patelb6511a32010-08-09 20:20:05 +0000515 unsigned Line = V.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000516 if (Line == 0)
517 return;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000518 unsigned FileID = GetOrCreateSourceID(V.getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000519 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000520 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
521 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000522}
523
Devang Patel930143b2009-11-21 02:48:08 +0000524/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000525/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000526void DwarfDebug::addSourceLine(DIE *Die, DIGlobalVariable G) {
Devang Patel0625af22010-05-07 23:33:41 +0000527 // Verify global variable.
Devang Patelb6511a32010-08-09 20:20:05 +0000528 if (!G.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000529 return;
530
Devang Patelb6511a32010-08-09 20:20:05 +0000531 unsigned Line = G.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000532 if (Line == 0)
533 return;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000534 unsigned FileID = GetOrCreateSourceID(G.getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000535 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000536 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
537 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000538}
Devang Patelb2de5fa2009-08-31 22:47:13 +0000539
Devang Patel930143b2009-11-21 02:48:08 +0000540/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000541/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000542void DwarfDebug::addSourceLine(DIE *Die, DISubprogram SP) {
Devang Patel0625af22010-05-07 23:33:41 +0000543 // Verify subprogram.
Devang Patelb6511a32010-08-09 20:20:05 +0000544 if (!SP.Verify())
Devang Patelb2de5fa2009-08-31 22:47:13 +0000545 return;
Caroline Tice183a5192009-09-11 18:25:54 +0000546 // If the line number is 0, don't add it.
Devang Patelb6511a32010-08-09 20:20:05 +0000547 if (SP.getLineNumber() == 0)
Caroline Tice183a5192009-09-11 18:25:54 +0000548 return;
549
Devang Patelb6511a32010-08-09 20:20:05 +0000550 unsigned Line = SP.getLineNumber();
551 if (!SP.getContext().Verify())
Devang Patel8119fe872010-03-08 22:02:50 +0000552 return;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000553 unsigned FileID = GetOrCreateSourceID(SP.getFilename());
Devang Patelb2de5fa2009-08-31 22:47:13 +0000554 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000555 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
556 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patelb2de5fa2009-08-31 22:47:13 +0000557}
558
Devang Patel930143b2009-11-21 02:48:08 +0000559/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000560/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000561void DwarfDebug::addSourceLine(DIE *Die, DIType Ty) {
Devang Patel0625af22010-05-07 23:33:41 +0000562 // Verify type.
Devang Patelb6511a32010-08-09 20:20:05 +0000563 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000564 return;
565
Devang Patelb6511a32010-08-09 20:20:05 +0000566 unsigned Line = Ty.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000567 if (Line == 0 || !Ty.getContext().Verify())
Devang Patel8119fe872010-03-08 22:02:50 +0000568 return;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000569 unsigned FileID = GetOrCreateSourceID(Ty.getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000570 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000571 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
572 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000573}
574
Devang Patel1f4690c2009-12-15 19:16:48 +0000575/// addSourceLine - Add location information to specified debug information
576/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000577void DwarfDebug::addSourceLine(DIE *Die, DINameSpace NS) {
Devang Patel0625af22010-05-07 23:33:41 +0000578 // Verify namespace.
Devang Patelb6511a32010-08-09 20:20:05 +0000579 if (!NS.Verify())
Devang Patel1f4690c2009-12-15 19:16:48 +0000580 return;
581
Devang Patelb6511a32010-08-09 20:20:05 +0000582 unsigned Line = NS.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000583 if (Line == 0)
584 return;
Devang Patelb6511a32010-08-09 20:20:05 +0000585 StringRef FN = NS.getFilename();
Devang Patel1f4690c2009-12-15 19:16:48 +0000586
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000587 unsigned FileID = GetOrCreateSourceID(FN);
Devang Patel1f4690c2009-12-15 19:16:48 +0000588 assert(FileID && "Invalid file id");
589 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
590 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
591}
592
Devang Patel2cfc3af2010-08-31 06:11:28 +0000593/// addVariableAddress - Add DW_AT_location attribute for a DbgVariable based
594/// on provided frame index.
595void DwarfDebug::addVariableAddress(DbgVariable *&DV, DIE *Die, int64_t FI) {
596 MachineLocation Location;
597 unsigned FrameReg;
Anton Korobeynikov2f931282011-01-10 12:39:04 +0000598 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
Anton Korobeynikov46877782010-11-20 15:59:32 +0000599 int Offset = TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
Devang Patel2cfc3af2010-08-31 06:11:28 +0000600 Location.set(FrameReg, Offset);
601
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000602 if (DV->variableHasComplexAddress())
603 addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
604 else if (DV->isBlockByrefVariable())
605 addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
606 else
607 addAddress(Die, dwarf::DW_AT_location, Location);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000608}
609
Devang Patel930143b2009-11-21 02:48:08 +0000610/// addComplexAddress - Start with the address based on the location provided,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000611/// and generate the DWARF information necessary to find the actual variable
612/// given the extra address information encoded in the DIVariable, starting from
613/// the starting location. Add the DWARF information to the die.
614///
Devang Patel930143b2009-11-21 02:48:08 +0000615void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000616 unsigned Attribute,
617 const MachineLocation &Location) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000618 DIType Ty = DV->getType();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000619
620 // Decode the original location, and use that as the start of the byref
621 // variable's location.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000622 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000623 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000624 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000625
626 if (Location.isReg()) {
627 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000628 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000629 } else {
Devang Patel8698f092011-01-19 23:04:47 +0000630 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
Devang Patel930143b2009-11-21 02:48:08 +0000631 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000632 }
633 } else {
634 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000635 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000636 else {
Devang Patel930143b2009-11-21 02:48:08 +0000637 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
638 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000639 }
640
Devang Patel930143b2009-11-21 02:48:08 +0000641 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump14cf8ec2009-09-30 00:08:22 +0000642 }
643
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000644 for (unsigned i = 0, N = DV->getNumAddrElements(); i < N; ++i) {
645 uint64_t Element = DV->getAddrElement(i);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000646
647 if (Element == DIFactory::OpPlus) {
Devang Patel930143b2009-11-21 02:48:08 +0000648 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000649 addUInt(Block, 0, dwarf::DW_FORM_udata, DV->getAddrElement(++i));
Mike Stump14cf8ec2009-09-30 00:08:22 +0000650 } else if (Element == DIFactory::OpDeref) {
Devang Patel930143b2009-11-21 02:48:08 +0000651 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000652 } else llvm_unreachable("unknown DIFactory Opcode");
653 }
654
655 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000656 addBlock(Die, Attribute, 0, Block);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000657}
658
Caroline Ticec87c1e22009-08-31 21:19:37 +0000659/* Byref variables, in Blocks, are declared by the programmer as "SomeType
660 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
661 gives the variable VarName either the struct, or a pointer to the struct, as
662 its type. This is necessary for various behind-the-scenes things the
663 compiler needs to do with by-reference variables in Blocks.
664
665 However, as far as the original *programmer* is concerned, the variable
666 should still have type 'SomeType', as originally declared.
667
Devang Patel930143b2009-11-21 02:48:08 +0000668 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticec87c1e22009-08-31 21:19:37 +0000669 struct to find the original type of the variable, which is then assigned to
670 the variable's Debug Information Entry as its real type. So far, so good.
671 However now the debugger will expect the variable VarName to have the type
672 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000673 expression that explains to the debugger how to navigate through the
Caroline Ticec87c1e22009-08-31 21:19:37 +0000674 pointers and struct to find the actual variable of type SomeType.
675
676 The following function does just that. We start by getting
677 the "normal" location for the variable. This will be the location
678 of either the struct __Block_byref_x_VarName or the pointer to the
679 struct __Block_byref_x_VarName.
680
681 The struct will look something like:
682
683 struct __Block_byref_x_VarName {
684 ... <various fields>
685 struct __Block_byref_x_VarName *forwarding;
686 ... <various other fields>
687 SomeType VarName;
688 ... <maybe more fields>
689 };
690
691 If we are given the struct directly (as our starting point) we
692 need to tell the debugger to:
693
694 1). Add the offset of the forwarding field.
695
Dan Gohman4a618822010-02-10 16:03:48 +0000696 2). Follow that pointer to get the real __Block_byref_x_VarName
Caroline Ticec87c1e22009-08-31 21:19:37 +0000697 struct to use (the real one may have been copied onto the heap).
698
699 3). Add the offset for the field VarName, to find the actual variable.
700
701 If we started with a pointer to the struct, then we need to
702 dereference that pointer first, before the other steps.
703 Translating this into DWARF ops, we will need to append the following
704 to the current location description for the variable:
705
706 DW_OP_deref -- optional, if we start with a pointer
707 DW_OP_plus_uconst <forward_fld_offset>
708 DW_OP_deref
709 DW_OP_plus_uconst <varName_fld_offset>
710
711 That is what this function does. */
712
Devang Patel930143b2009-11-21 02:48:08 +0000713/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticec87c1e22009-08-31 21:19:37 +0000714/// provided, and generate the DWARF information necessary to find the
715/// actual Block variable (navigating the Block struct) based on the
716/// starting location. Add the DWARF information to the die. For
717/// more information, read large comment just above here.
718///
Devang Patel930143b2009-11-21 02:48:08 +0000719void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000720 unsigned Attribute,
721 const MachineLocation &Location) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000722 DIType Ty = DV->getType();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000723 DIType TmpTy = Ty;
724 unsigned Tag = Ty.getTag();
725 bool isPointer = false;
726
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000727 StringRef varName = DV->getName();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000728
729 if (Tag == dwarf::DW_TAG_pointer_type) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000730 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000731 TmpTy = DTy.getTypeDerivedFrom();
732 isPointer = true;
733 }
734
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000735 DICompositeType blockStruct = DICompositeType(TmpTy);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000736
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000737 // Find the __forwarding field and the variable field in the __Block_byref
738 // struct.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000739 DIArray Fields = blockStruct.getTypeArray();
740 DIDescriptor varField = DIDescriptor();
741 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000742
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000743 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
744 DIDescriptor Element = Fields.getElement(i);
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000745 DIDerivedType DT = DIDerivedType(Element);
Devang Patel2d9caf92009-11-25 17:36:49 +0000746 StringRef fieldName = DT.getName();
747 if (fieldName == "__forwarding")
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000748 forwardingField = Element;
Devang Patel2d9caf92009-11-25 17:36:49 +0000749 else if (fieldName == varName)
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000750 varField = Element;
751 }
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000752
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000753 // Get the offsets for the forwarding field and the variable field.
Chris Lattner71696ef2010-03-31 06:06:37 +0000754 unsigned forwardingFieldOffset =
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000755 DIDerivedType(forwardingField).getOffsetInBits() >> 3;
Chris Lattner71696ef2010-03-31 06:06:37 +0000756 unsigned varFieldOffset =
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000757 DIDerivedType(varField).getOffsetInBits() >> 3;
Caroline Ticec87c1e22009-08-31 21:19:37 +0000758
Mike Stump944fa252009-09-24 23:21:26 +0000759 // Decode the original location, and use that as the start of the byref
760 // variable's location.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000761 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000762 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000763 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000764
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000765 if (Location.isReg()) {
766 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000767 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000768 else {
Devang Patel8698f092011-01-19 23:04:47 +0000769 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
Devang Patel930143b2009-11-21 02:48:08 +0000770 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000771 }
772 } else {
773 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000774 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000775 else {
Devang Patel930143b2009-11-21 02:48:08 +0000776 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
777 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000778 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000779
Devang Patel930143b2009-11-21 02:48:08 +0000780 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000781 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000782
Mike Stump944fa252009-09-24 23:21:26 +0000783 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000784 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000785 if (isPointer)
Devang Patel930143b2009-11-21 02:48:08 +0000786 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000787
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000788 // Next add the offset for the '__forwarding' field:
789 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
790 // adding the offset if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000791 if (forwardingFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000792 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
793 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000794 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000795
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000796 // Now dereference the __forwarding field to get to the real __Block_byref
797 // struct: DW_OP_deref.
Devang Patel930143b2009-11-21 02:48:08 +0000798 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000799
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000800 // Now that we've got the real __Block_byref... struct, add the offset
801 // for the variable's field to get to the location of the actual variable:
802 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000803 if (varFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000804 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
805 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000806 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000807
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000808 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000809 addBlock(Die, Attribute, 0, Block);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000810}
811
Devang Patel930143b2009-11-21 02:48:08 +0000812/// addAddress - Add an address attribute to a die based on the location
Bill Wendling2f921f82009-05-15 09:23:25 +0000813/// provided.
Devang Patel930143b2009-11-21 02:48:08 +0000814void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000815 const MachineLocation &Location) {
Chris Lattner3a383cb2010-04-05 00:13:49 +0000816 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling2f921f82009-05-15 09:23:25 +0000817 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000818 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel804fcd42010-09-22 21:10:38 +0000819
Devang Patele7559662010-11-02 17:37:00 +0000820 if (RI->getFrameRegister(*Asm->MF) == Location.getReg()
Devang Patel804fcd42010-09-22 21:10:38 +0000821 && Location.getOffset()) {
822 // If variable offset is based in frame register then use fbreg.
823 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
824 addSInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
825 addBlock(Die, Attribute, 0, Block);
826 return;
827 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000828
829 if (Location.isReg()) {
830 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000831 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000832 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000833 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
834 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000835 }
836 } else {
837 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000838 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000839 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000840 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
841 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000842 }
843
Devang Patel930143b2009-11-21 02:48:08 +0000844 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling2f921f82009-05-15 09:23:25 +0000845 }
846
Devang Patel930143b2009-11-21 02:48:08 +0000847 addBlock(Die, Attribute, 0, Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000848}
849
Devang Patel173b2b92010-04-28 01:03:09 +0000850/// addRegisterAddress - Add register location entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000851bool DwarfDebug::addRegisterAddress(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000852 assert (MO.isReg() && "Invalid machine operand!");
853 if (!MO.getReg())
854 return false;
855 MachineLocation Location;
856 Location.set(MO.getReg());
857 addAddress(Die, dwarf::DW_AT_location, Location);
Devang Patel173b2b92010-04-28 01:03:09 +0000858 return true;
859}
860
861/// addConstantValue - Add constant value entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000862bool DwarfDebug::addConstantValue(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000863 assert (MO.isImm() && "Invalid machine operand!");
864 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
865 unsigned Imm = MO.getImm();
866 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
867 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patel173b2b92010-04-28 01:03:09 +0000868 return true;
869}
870
871/// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000872bool DwarfDebug::addConstantFPValue(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000873 assert (MO.isFPImm() && "Invalid machine operand!");
874 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
875 APFloat FPImm = MO.getFPImm()->getValueAPF();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000876
Devang Patel173b2b92010-04-28 01:03:09 +0000877 // Get the raw data form of the floating point.
878 const APInt FltVal = FPImm.bitcastToAPInt();
879 const char *FltPtr = (const char*)FltVal.getRawData();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000880
Devang Patel173b2b92010-04-28 01:03:09 +0000881 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
882 bool LittleEndian = Asm->getTargetData().isLittleEndian();
883 int Incr = (LittleEndian ? 1 : -1);
884 int Start = (LittleEndian ? 0 : NumBytes - 1);
885 int Stop = (LittleEndian ? NumBytes : -1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000886
Devang Patel173b2b92010-04-28 01:03:09 +0000887 // Output the constant to DWARF one byte at a time.
888 for (; Start != Stop; Start += Incr)
889 addUInt(Block, 0, dwarf::DW_FORM_data1,
890 (unsigned char)0xFF & FltPtr[Start]);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000891
Devang Patel173b2b92010-04-28 01:03:09 +0000892 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000893 return true;
Devang Patel173b2b92010-04-28 01:03:09 +0000894}
895
Devang Patel70eb9822011-01-06 21:39:25 +0000896/// addConstantValue - Add constant value entry in variable DIE.
897bool DwarfDebug::addConstantValue(DIE *Die, ConstantInt *CI,
898 bool Unsigned) {
899 if (CI->getBitWidth() <= 64) {
900 if (Unsigned)
901 addUInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
902 CI->getZExtValue());
903 else
904 addSInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
905 CI->getSExtValue());
906 return true;
907 }
908
909 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
910
911 // Get the raw data form of the large APInt.
912 const APInt Val = CI->getValue();
913 const char *Ptr = (const char*)Val.getRawData();
914
915 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
916 bool LittleEndian = Asm->getTargetData().isLittleEndian();
917 int Incr = (LittleEndian ? 1 : -1);
918 int Start = (LittleEndian ? 0 : NumBytes - 1);
919 int Stop = (LittleEndian ? NumBytes : -1);
920
921 // Output the constant to DWARF one byte at a time.
922 for (; Start != Stop; Start += Incr)
923 addUInt(Block, 0, dwarf::DW_FORM_data1,
924 (unsigned char)0xFF & Ptr[Start]);
925
926 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
927 return true;
928}
Devang Patel173b2b92010-04-28 01:03:09 +0000929
Devang Patel2b75ed22009-12-10 19:14:49 +0000930/// addToContextOwner - Add Die into the list of its context owner's children.
931void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000932 if (Context.isType()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000933 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
Devang Patel2b75ed22009-12-10 19:14:49 +0000934 ContextDIE->addChild(Die);
Devang Patel1f4690c2009-12-15 19:16:48 +0000935 } else if (Context.isNameSpace()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000936 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
Devang Patel1f4690c2009-12-15 19:16:48 +0000937 ContextDIE->addChild(Die);
Stuart Hastingsafe54f12010-06-11 20:08:44 +0000938 } else if (Context.isSubprogram()) {
Devang Patel185051c2010-09-27 23:15:27 +0000939 DIE *ContextDIE = createSubprogramDIE(DISubprogram(Context));
Stuart Hastingsafe54f12010-06-11 20:08:44 +0000940 ContextDIE->addChild(Die);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000941 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patel2b75ed22009-12-10 19:14:49 +0000942 ContextDIE->addChild(Die);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000943 else
Devang Patel1a0df9a2010-05-10 22:49:55 +0000944 getCompileUnit(Context)->addDie(Die);
Devang Patel2b75ed22009-12-10 19:14:49 +0000945}
946
Devang Patelb5b60ea2009-12-10 18:05:33 +0000947/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
948/// given DIType.
949DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000950 CompileUnit *TypeCU = getCompileUnit(Ty);
951 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000952 if (TyDIE)
953 return TyDIE;
954
955 // Create new type.
956 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000957 TypeCU->insertDIE(Ty, TyDIE);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000958 if (Ty.isBasicType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000959 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000960 else if (Ty.isCompositeType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000961 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000962 else {
963 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000964 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000965 }
966
Devang Patel2b75ed22009-12-10 19:14:49 +0000967 addToContextOwner(TyDIE, Ty.getContext());
Devang Patelb5b60ea2009-12-10 18:05:33 +0000968 return TyDIE;
969}
970
Devang Patel930143b2009-11-21 02:48:08 +0000971/// addType - Add a new type attribute to the specified entity.
Devang Patel9ccfb642009-12-09 18:24:21 +0000972void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel8d6a2b72010-05-07 21:45:47 +0000973 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000974 return;
975
976 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000977 CompileUnit *TypeCU = getCompileUnit(Ty);
978 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000979 // If it exists then use the existing value.
Devang Patel930143b2009-11-21 02:48:08 +0000980 if (Entry) {
981 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000982 return;
983 }
984
Bill Wendling2f921f82009-05-15 09:23:25 +0000985 // Construct type.
Devang Patelb5b60ea2009-12-10 18:05:33 +0000986 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000987
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000988 // Set up proxy.
989 Entry = createDIEEntry(Buffer);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000990 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000991
Devang Patel930143b2009-11-21 02:48:08 +0000992 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000993}
994
Devang Patel930143b2009-11-21 02:48:08 +0000995/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000996void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000997 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000998 StringRef Name = BTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +0000999 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +00001000 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling2f921f82009-05-15 09:23:25 +00001001 BTy.getEncoding());
1002
1003 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +00001004 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001005 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001006 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel930143b2009-11-21 02:48:08 +00001007 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001008}
1009
Devang Patel930143b2009-11-21 02:48:08 +00001010/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001011void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001012 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +00001013 StringRef Name = DTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001014 uint64_t Size = DTy.getSizeInBits() >> 3;
1015 unsigned Tag = DTy.getTag();
1016
1017 // FIXME - Workaround for templates.
1018 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
1019
1020 Buffer.setTag(Tag);
1021
1022 // Map to main type, void will not have a type.
1023 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel9ccfb642009-12-09 18:24:21 +00001024 addType(&Buffer, FromTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001025
1026 // Add name if not anonymous or intermediate type.
Devang Patelae466ef2009-11-30 23:56:56 +00001027 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001028 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001029
1030 // Add size if non-zero (derived types might be zero-sized.)
1031 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +00001032 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001033
1034 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patelb5b51592009-11-23 18:43:37 +00001035 if (!DTy.isForwardDecl())
Devang Patelb6511a32010-08-09 20:20:05 +00001036 addSourceLine(&Buffer, DTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001037}
1038
Devang Patel930143b2009-11-21 02:48:08 +00001039/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001040void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001041 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +00001042 StringRef Name = CTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001043
1044 uint64_t Size = CTy.getSizeInBits() >> 3;
1045 unsigned Tag = CTy.getTag();
1046 Buffer.setTag(Tag);
1047
1048 switch (Tag) {
1049 case dwarf::DW_TAG_vector_type:
1050 case dwarf::DW_TAG_array_type:
Devang Patel9ccfb642009-12-09 18:24:21 +00001051 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001052 break;
1053 case dwarf::DW_TAG_enumeration_type: {
1054 DIArray Elements = CTy.getTypeArray();
1055
1056 // Add enumerators to enumeration type.
1057 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1058 DIE *ElemDie = NULL;
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001059 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3b548aa2010-03-08 20:52:55 +00001060 if (Enum.isEnumerator()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001061 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel930143b2009-11-21 02:48:08 +00001062 Buffer.addChild(ElemDie);
Devang Patelfafa1fe2009-10-09 17:51:49 +00001063 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001064 }
1065 }
1066 break;
1067 case dwarf::DW_TAG_subroutine_type: {
1068 // Add return type.
1069 DIArray Elements = CTy.getTypeArray();
1070 DIDescriptor RTy = Elements.getElement(0);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001071 addType(&Buffer, DIType(RTy));
Bill Wendling2f921f82009-05-15 09:23:25 +00001072
Devang Patel9a33ec22010-10-06 20:50:40 +00001073 bool isPrototyped = true;
Bill Wendling2f921f82009-05-15 09:23:25 +00001074 // Add arguments.
1075 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001076 DIDescriptor Ty = Elements.getElement(i);
Devang Patel9a33ec22010-10-06 20:50:40 +00001077 if (Ty.isUnspecifiedParameter()) {
1078 DIE *Arg = new DIE(dwarf::DW_TAG_unspecified_parameters);
1079 Buffer.addChild(Arg);
1080 isPrototyped = false;
1081 } else {
1082 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1083 addType(Arg, DIType(Ty));
1084 Buffer.addChild(Arg);
1085 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001086 }
Devang Patel9a33ec22010-10-06 20:50:40 +00001087 // Add prototype flag.
1088 if (isPrototyped)
1089 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001090 }
1091 break;
1092 case dwarf::DW_TAG_structure_type:
1093 case dwarf::DW_TAG_union_type:
1094 case dwarf::DW_TAG_class_type: {
1095 // Add elements to structure type.
1096 DIArray Elements = CTy.getTypeArray();
1097
1098 // A forward struct declared type may not have elements available.
Devang Patel3b548aa2010-03-08 20:52:55 +00001099 unsigned N = Elements.getNumElements();
1100 if (N == 0)
Bill Wendling2f921f82009-05-15 09:23:25 +00001101 break;
1102
1103 // Add elements to structure type.
Devang Patel3b548aa2010-03-08 20:52:55 +00001104 for (unsigned i = 0; i < N; ++i) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001105 DIDescriptor Element = Elements.getElement(i);
1106 DIE *ElemDie = NULL;
Devang Patelcb03b142010-09-29 21:44:16 +00001107 if (Element.isSubprogram()) {
1108 DISubprogram SP(Element);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001109 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patelcb03b142010-09-29 21:44:16 +00001110 if (SP.isProtected())
1111 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1112 dwarf::DW_ACCESS_protected);
1113 else if (SP.isPrivate())
1114 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1115 dwarf::DW_ACCESS_private);
1116 else
1117 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1118 dwarf::DW_ACCESS_public);
Devang Patele1c71462010-10-01 23:31:40 +00001119 if (SP.isExplicit())
1120 addUInt(ElemDie, dwarf::DW_AT_explicit, dwarf::DW_FORM_flag, 1);
Devang Patelcb03b142010-09-29 21:44:16 +00001121 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001122 else if (Element.isVariable()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001123 DIVariable DV(Element);
Devang Patel160c92d2010-01-30 01:08:30 +00001124 ElemDie = new DIE(dwarf::DW_TAG_variable);
1125 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1126 DV.getName());
1127 addType(ElemDie, DV.getType());
1128 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1129 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patelb6511a32010-08-09 20:20:05 +00001130 addSourceLine(ElemDie, DV);
Devang Patel3b548aa2010-03-08 20:52:55 +00001131 } else if (Element.isDerivedType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001132 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3b548aa2010-03-08 20:52:55 +00001133 else
1134 continue;
Devang Patel930143b2009-11-21 02:48:08 +00001135 Buffer.addChild(ElemDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001136 }
1137
Devang Patel3082c012009-08-27 23:51:51 +00001138 if (CTy.isAppleBlockExtension())
Devang Patel930143b2009-11-21 02:48:08 +00001139 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001140
1141 unsigned RLang = CTy.getRunTimeLang();
1142 if (RLang)
Devang Patel930143b2009-11-21 02:48:08 +00001143 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling2f921f82009-05-15 09:23:25 +00001144 dwarf::DW_FORM_data1, RLang);
Devang Patel303a1be2010-01-26 21:16:06 +00001145
1146 DICompositeType ContainingType = CTy.getContainingType();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001147 if (DIDescriptor(ContainingType).isCompositeType())
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001148 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001149 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001150 else {
1151 DIDescriptor Context = CTy.getContext();
1152 addToContextOwner(&Buffer, Context);
1153 }
Devang Patel3a9e65e2011-02-02 21:38:25 +00001154
1155 if (Tag == dwarf::DW_TAG_class_type) {
1156 DIArray TParams = CTy.getTemplateParams();
1157 unsigned N = TParams.getNumElements();
1158 // Add template parameters.
1159 for (unsigned i = 0; i < N; ++i) {
1160 DIDescriptor Element = TParams.getElement(i);
1161 if (Element.isTemplateTypeParameter())
1162 Buffer.addChild(getOrCreateTemplateTypeParameterDIE(
1163 DITemplateTypeParameter(Element)));
Devang Patelbe933b42011-02-02 22:35:53 +00001164 else if (Element.isTemplateValueParameter())
1165 Buffer.addChild(getOrCreateTemplateValueParameterDIE(
1166 DITemplateValueParameter(Element)));
Devang Patel3a9e65e2011-02-02 21:38:25 +00001167 }
1168 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001169 break;
1170 }
1171 default:
1172 break;
1173 }
1174
1175 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +00001176 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001177 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001178
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001179 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
Devang Patel30265c42010-07-07 20:12:52 +00001180 || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1181 {
Bill Wendling2f921f82009-05-15 09:23:25 +00001182 // Add size if non-zero (derived types might be zero-sized.)
1183 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +00001184 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001185 else {
1186 // Add zero size if it is not a forward declaration.
1187 if (CTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +00001188 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001189 else
Devang Patel930143b2009-11-21 02:48:08 +00001190 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling2f921f82009-05-15 09:23:25 +00001191 }
1192
1193 // Add source line info if available.
1194 if (!CTy.isForwardDecl())
Devang Patelb6511a32010-08-09 20:20:05 +00001195 addSourceLine(&Buffer, CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001196 }
1197}
1198
Devang Patel3a9e65e2011-02-02 21:38:25 +00001199/// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
1200/// for the given DITemplateTypeParameter.
1201DIE *
1202DwarfDebug::getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP) {
1203 CompileUnit *TypeCU = getCompileUnit(TP);
1204 DIE *ParamDIE = TypeCU->getDIE(TP);
1205 if (ParamDIE)
1206 return ParamDIE;
1207
1208 ParamDIE = new DIE(dwarf::DW_TAG_template_type_parameter);
1209 addType(ParamDIE, TP.getType());
1210 addString(ParamDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string, TP.getName());
1211 return ParamDIE;
1212}
1213
Devang Patelbe933b42011-02-02 22:35:53 +00001214/// getOrCreateTemplateValueParameterDIE - Find existing DIE or create new DIE
1215/// for the given DITemplateValueParameter.
1216DIE *
1217DwarfDebug::getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TPV) {
1218 CompileUnit *TVCU = getCompileUnit(TPV);
1219 DIE *ParamDIE = TVCU->getDIE(TPV);
1220 if (ParamDIE)
1221 return ParamDIE;
1222
1223 ParamDIE = new DIE(dwarf::DW_TAG_template_value_parameter);
1224 addType(ParamDIE, TPV.getType());
1225 addString(ParamDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string, TPV.getName());
1226 addUInt(ParamDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
1227 TPV.getValue());
1228 return ParamDIE;
1229}
1230
Devang Patel930143b2009-11-21 02:48:08 +00001231/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1232void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling2f921f82009-05-15 09:23:25 +00001233 int64_t L = SR.getLo();
1234 int64_t H = SR.getHi();
1235 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1236
Devang Patel930143b2009-11-21 02:48:08 +00001237 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patelf691df32009-08-14 20:59:16 +00001238 if (L)
Devang Patel930143b2009-11-21 02:48:08 +00001239 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Patel8f046022009-12-04 23:10:24 +00001240 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling2f921f82009-05-15 09:23:25 +00001241
Devang Patel930143b2009-11-21 02:48:08 +00001242 Buffer.addChild(DW_Subrange);
Bill Wendling2f921f82009-05-15 09:23:25 +00001243}
1244
Devang Patel930143b2009-11-21 02:48:08 +00001245/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001246void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling2f921f82009-05-15 09:23:25 +00001247 DICompositeType *CTy) {
1248 Buffer.setTag(dwarf::DW_TAG_array_type);
1249 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel930143b2009-11-21 02:48:08 +00001250 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001251
1252 // Emit derived type.
Devang Patel9ccfb642009-12-09 18:24:21 +00001253 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001254 DIArray Elements = CTy->getTypeArray();
1255
Devang Patel92e8c652009-11-21 00:31:03 +00001256 // Get an anonymous type for index type.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001257 CompileUnit *TheCU = getCompileUnit(*CTy);
1258 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel92e8c652009-11-21 00:31:03 +00001259 if (!IdxTy) {
1260 // Construct an anonymous type for index type.
1261 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +00001262 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1263 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel92e8c652009-11-21 00:31:03 +00001264 dwarf::DW_ATE_signed);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001265 TheCU->addDie(IdxTy);
1266 TheCU->setIndexTyDie(IdxTy);
Devang Patel92e8c652009-11-21 00:31:03 +00001267 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001268
1269 // Add subranges to array type.
1270 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1271 DIDescriptor Element = Elements.getElement(i);
1272 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001273 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001274 }
1275}
1276
Devang Patel930143b2009-11-21 02:48:08 +00001277/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3b548aa2010-03-08 20:52:55 +00001278DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001279 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3b548aa2010-03-08 20:52:55 +00001280 StringRef Name = ETy.getName();
Devang Patel930143b2009-11-21 02:48:08 +00001281 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3b548aa2010-03-08 20:52:55 +00001282 int64_t Value = ETy.getEnumValue();
Devang Patel930143b2009-11-21 02:48:08 +00001283 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +00001284 return Enumerator;
1285}
1286
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001287/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel43ef34d2010-01-05 01:46:14 +00001288/// printer to not emit usual symbol prefix before the symbol name is used then
1289/// return linkage name after skipping this special LLVM prefix.
1290static StringRef getRealLinkageName(StringRef LinkageName) {
1291 char One = '\1';
1292 if (LinkageName.startswith(StringRef(&One, 1)))
1293 return LinkageName.substr(1);
1294 return LinkageName;
1295}
1296
Devang Patel930143b2009-11-21 02:48:08 +00001297/// createMemberDIE - Create new member DIE.
Devang Patel18ba0b42010-08-10 04:12:17 +00001298DIE *DwarfDebug::createMemberDIE(DIDerivedType DT) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001299 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel2d9caf92009-11-25 17:36:49 +00001300 StringRef Name = DT.getName();
1301 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001302 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001303
Devang Patel9ccfb642009-12-09 18:24:21 +00001304 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001305
Devang Patelb6511a32010-08-09 20:20:05 +00001306 addSourceLine(MemberDie, DT);
Bill Wendling2f921f82009-05-15 09:23:25 +00001307
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001308 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel930143b2009-11-21 02:48:08 +00001309 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel67f56f02009-11-04 22:06:12 +00001310
Bill Wendling2f921f82009-05-15 09:23:25 +00001311 uint64_t Size = DT.getSizeInBits();
Devang Patelf05d5722009-11-04 23:48:00 +00001312 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling2f921f82009-05-15 09:23:25 +00001313
1314 if (Size != FieldSize) {
1315 // Handle bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001316 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1317 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling2f921f82009-05-15 09:23:25 +00001318
1319 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling2f921f82009-05-15 09:23:25 +00001320 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1321 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer2b459982010-01-07 17:50:57 +00001322 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling2f921f82009-05-15 09:23:25 +00001323 Offset -= FieldOffset;
1324
1325 // Maybe we need to work from the other end.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001326 if (Asm->getTargetData().isLittleEndian())
1327 Offset = FieldSize - (Offset + Size);
Devang Patel930143b2009-11-21 02:48:08 +00001328 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling2f921f82009-05-15 09:23:25 +00001329
Devang Patel67f56f02009-11-04 22:06:12 +00001330 // Here WD_AT_data_member_location points to the anonymous
1331 // field that includes this bit field.
Devang Patel930143b2009-11-21 02:48:08 +00001332 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001333
1334 } else
1335 // This is not a bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001336 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001337
Devang Pateld2316892010-02-03 20:08:48 +00001338 if (DT.getTag() == dwarf::DW_TAG_inheritance
1339 && DT.isVirtual()) {
1340
1341 // For C++, virtual base classes are not at fixed offset. Use following
1342 // expression to extract appropriate offset from vtable.
1343 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1344
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001345 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Pateld2316892010-02-03 20:08:48 +00001346 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1347 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1348 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1349 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1350 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1351 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1352 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1353
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001354 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
Devang Pateld2316892010-02-03 20:08:48 +00001355 VBaseLocationDie);
1356 } else
1357 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001358
1359 if (DT.isProtected())
Devang Pateleb57c592009-12-03 19:11:07 +00001360 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001361 dwarf::DW_ACCESS_protected);
1362 else if (DT.isPrivate())
Devang Pateleb57c592009-12-03 19:11:07 +00001363 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001364 dwarf::DW_ACCESS_private);
Devang Patela1bd5a12010-09-29 19:08:08 +00001365 // Otherwise C++ member and base classes are considered public.
1366 else if (DT.getCompileUnit().getLanguage() == dwarf::DW_LANG_C_plus_plus)
Devang Pateleb57c592009-12-03 19:11:07 +00001367 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1368 dwarf::DW_ACCESS_public);
1369 if (DT.isVirtual())
1370 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1371 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling2f921f82009-05-15 09:23:25 +00001372 return MemberDie;
1373}
1374
Devang Patel525dda02009-12-14 16:18:45 +00001375/// createSubprogramDIE - Create new DIE using SP.
Devang Patel185051c2010-09-27 23:15:27 +00001376DIE *DwarfDebug::createSubprogramDIE(DISubprogram SP) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001377 CompileUnit *SPCU = getCompileUnit(SP);
1378 DIE *SPDie = SPCU->getDIE(SP);
Devang Patel525dda02009-12-14 16:18:45 +00001379 if (SPDie)
1380 return SPDie;
1381
1382 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf200b392010-03-02 17:58:15 +00001383 // Constructors and operators for anonymous aggregates do not have names.
Devang Pateld0fa3042010-03-02 01:26:20 +00001384 if (!SP.getName().empty())
1385 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling2f921f82009-05-15 09:23:25 +00001386
Devang Patel2d9caf92009-11-25 17:36:49 +00001387 StringRef LinkageName = SP.getLinkageName();
Devang Patel43ef34d2010-01-05 01:46:14 +00001388 if (!LinkageName.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001389 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel43ef34d2010-01-05 01:46:14 +00001390 getRealLinkageName(LinkageName));
1391
Devang Patelb6511a32010-08-09 20:20:05 +00001392 addSourceLine(SPDie, SP);
Bill Wendling2f921f82009-05-15 09:23:25 +00001393
Devang Patel3a24f922010-10-07 22:03:01 +00001394 if (SP.isPrototyped())
Devang Patel930143b2009-11-21 02:48:08 +00001395 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001396
1397 // Add Return Type.
Devang Patel236526d2009-12-03 01:25:38 +00001398 DICompositeType SPTy = SP.getType();
1399 DIArray Args = SPTy.getTypeArray();
Bill Wendling2f921f82009-05-15 09:23:25 +00001400 unsigned SPTag = SPTy.getTag();
Devang Pateleb57c592009-12-03 19:11:07 +00001401
Devang Patel3b548aa2010-03-08 20:52:55 +00001402 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel9ccfb642009-12-09 18:24:21 +00001403 addType(SPDie, SPTy);
Devang Patel236526d2009-12-03 01:25:38 +00001404 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001405 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel236526d2009-12-03 01:25:38 +00001406
Devang Pateleb57c592009-12-03 19:11:07 +00001407 unsigned VK = SP.getVirtuality();
1408 if (VK) {
1409 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001410 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Pateleb57c592009-12-03 19:11:07 +00001411 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
Devang Patelc26da902010-12-09 00:10:40 +00001412 addUInt(Block, 0, dwarf::DW_FORM_udata, SP.getVirtualIndex());
Devang Pateleb57c592009-12-03 19:11:07 +00001413 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001414 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001415 SP.getContainingType()));
Devang Pateleb57c592009-12-03 19:11:07 +00001416 }
1417
Devang Patel185051c2010-09-27 23:15:27 +00001418 if (!SP.isDefinition()) {
Devang Patel930143b2009-11-21 02:48:08 +00001419 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001420
1421 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel236526d2009-12-03 01:25:38 +00001422 // be handled while processing variables.
1423 DICompositeType SPTy = SP.getType();
1424 DIArray Args = SPTy.getTypeArray();
1425 unsigned SPTag = SPTy.getTag();
1426
Bill Wendling2f921f82009-05-15 09:23:25 +00001427 if (SPTag == dwarf::DW_TAG_subroutine_type)
1428 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1429 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001430 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patel6efc8e52010-02-06 01:02:37 +00001431 addType(Arg, ATy);
1432 if (ATy.isArtificial())
1433 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel930143b2009-11-21 02:48:08 +00001434 SPDie->addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +00001435 }
1436 }
1437
Devang Patel999b4992010-02-03 19:57:19 +00001438 if (SP.isArtificial())
1439 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1440
Devang Patelb4e3b902010-04-30 19:38:23 +00001441 if (!SP.isLocalToUnit())
1442 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001443
Devang Patelb4e3b902010-04-30 19:38:23 +00001444 if (SP.isOptimized())
1445 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1446
Jim Grosbach965a73a2010-07-21 23:03:52 +00001447 if (unsigned isa = Asm->getISAEncoding()) {
1448 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1449 }
1450
Devang Patelb4e3b902010-04-30 19:38:23 +00001451 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001452 SPCU->insertDIE(SP, SPDie);
Devang Patelb4e3b902010-04-30 19:38:23 +00001453
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001454 // Add to context owner.
1455 addToContextOwner(SPDie, SP.getContext());
1456
Bill Wendling2f921f82009-05-15 09:23:25 +00001457 return SPDie;
1458}
1459
Devang Patel32cc43c2010-05-07 20:54:48 +00001460DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattner8d2fe282010-03-31 05:36:29 +00001461 assert(N && "Invalid Scope encoding!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001462
1463 DbgScope *AScope = AbstractScopes.lookup(N);
1464 if (AScope)
1465 return AScope;
Jim Grosbach042483e2009-11-21 23:12:12 +00001466
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001467 DbgScope *Parent = NULL;
1468
1469 DIDescriptor Scope(N);
1470 if (Scope.isLexicalBlock()) {
1471 DILexicalBlock DB(N);
1472 DIDescriptor ParentDesc = DB.getContext();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001473 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001474 }
1475
1476 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1477
1478 if (Parent)
Devang Patel930143b2009-11-21 02:48:08 +00001479 Parent->addScope(AScope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001480 AScope->setAbstractScope();
1481 AbstractScopes[N] = AScope;
1482 if (DIDescriptor(N).isSubprogram())
1483 AbstractScopesList.push_back(AScope);
1484 return AScope;
1485}
Devang Patel75cc16c2009-10-01 20:31:14 +00001486
Devang Patel019922d2010-04-06 23:53:48 +00001487/// isSubprogramContext - Return true if Context is either a subprogram
1488/// or another context nested inside a subprogram.
Devang Patel32cc43c2010-05-07 20:54:48 +00001489static bool isSubprogramContext(const MDNode *Context) {
Devang Patel019922d2010-04-06 23:53:48 +00001490 if (!Context)
1491 return false;
1492 DIDescriptor D(Context);
1493 if (D.isSubprogram())
1494 return true;
1495 if (D.isType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001496 return isSubprogramContext(DIType(Context).getContext());
Devang Patel019922d2010-04-06 23:53:48 +00001497 return false;
1498}
1499
Jim Grosbach042483e2009-11-21 23:12:12 +00001500/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel930143b2009-11-21 02:48:08 +00001501/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1502/// If there are global variables in this scope then create and insert
1503/// DIEs for these variables.
Devang Patel32cc43c2010-05-07 20:54:48 +00001504DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001505 CompileUnit *SPCU = getCompileUnit(SPNode);
1506 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +00001507
Chris Lattner3a383cb2010-04-05 00:13:49 +00001508 assert(SPDie && "Unable to find subprogram DIE!");
1509 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001510
Chris Lattner3a383cb2010-04-05 00:13:49 +00001511 // There is not any need to generate specification DIE for a function
1512 // defined at compile unit level. If a function is defined inside another
1513 // function then gdb prefers the definition at top level and but does not
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001514 // expect specification DIE in parent function. So avoid creating
Chris Lattner3a383cb2010-04-05 00:13:49 +00001515 // specification DIE for a function defined inside a function.
1516 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001517 !SP.getContext().isFile() &&
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001518 !isSubprogramContext(SP.getContext())) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00001519 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001520
1521 // Add arguments.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001522 DICompositeType SPTy = SP.getType();
1523 DIArray Args = SPTy.getTypeArray();
1524 unsigned SPTag = SPTy.getTag();
1525 if (SPTag == dwarf::DW_TAG_subroutine_type)
1526 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1527 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001528 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattner3a383cb2010-04-05 00:13:49 +00001529 addType(Arg, ATy);
1530 if (ATy.isArtificial())
1531 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1532 SPDie->addChild(Arg);
1533 }
1534 DIE *SPDeclDie = SPDie;
1535 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001536 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Chris Lattner3a383cb2010-04-05 00:13:49 +00001537 SPDeclDie);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001538 SPCU->addDie(SPDie);
Chris Lattner3a383cb2010-04-05 00:13:49 +00001539 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001540
Devang Patela37a95e2010-07-07 22:20:57 +00001541 // Pick up abstract subprogram DIE.
1542 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
1543 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1544 addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
1545 dwarf::DW_FORM_ref4, AbsSPDIE);
1546 SPCU->addDie(SPDie);
1547 }
1548
Chris Lattner3a383cb2010-04-05 00:13:49 +00001549 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1550 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1551 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1552 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1553 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1554 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1555 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +00001556
Chris Lattner3a383cb2010-04-05 00:13:49 +00001557 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001558}
1559
Jim Grosbach042483e2009-11-21 23:12:12 +00001560/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel930143b2009-11-21 02:48:08 +00001561/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1562DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001563
1564 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1565 if (Scope->isAbstractScope())
1566 return ScopeDIE;
1567
1568 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1569 if (Ranges.empty())
1570 return 0;
1571
1572 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1573 if (Ranges.size() > 1) {
1574 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001575 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +00001576 // DW_AT_ranges appropriately.
1577 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1578 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1579 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1580 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +00001581 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1582 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +00001583 }
1584 DebugRangeSymbols.push_back(NULL);
1585 DebugRangeSymbols.push_back(NULL);
1586 return ScopeDIE;
1587 }
1588
Devang Patel9fc11702010-05-25 23:40:22 +00001589 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1590 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001591
Devang Patel9fc11702010-05-25 23:40:22 +00001592 if (End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001593
Chris Lattnere13c3722010-03-09 01:58:53 +00001594 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1595 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001596
Devang Patel6c74a872010-04-27 19:46:33 +00001597 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1598 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001599
1600 return ScopeDIE;
1601}
1602
Devang Patel930143b2009-11-21 02:48:08 +00001603/// constructInlinedScopeDIE - This scope represents inlined body of
1604/// a function. Construct DIE to represent this concrete inlined copy
1605/// of the function.
1606DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001607
1608 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001609 assert (Ranges.empty() == false
Devang Patel6c74a872010-04-27 19:46:33 +00001610 && "DbgScope does not have instruction markers!");
1611
1612 // FIXME : .debug_inlined section specification does not clearly state how
1613 // to emit inlined scope that is split into multiple instruction ranges.
1614 // For now, use first instruction range and emit low_pc/high_pc pair and
1615 // corresponding .debug_inlined section entry for this pair.
1616 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel9fc11702010-05-25 23:40:22 +00001617 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1618 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001619
Devang Patel4c6bd662010-07-08 22:39:20 +00001620 if (StartLabel == 0 || EndLabel == 0) {
Devang Patel6c74a872010-04-27 19:46:33 +00001621 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1622 return 0;
1623 }
Chris Lattnere13c3722010-03-09 01:58:53 +00001624 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001625 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +00001626 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001627 "Invalid end label for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +00001628
Devang Patel3b548aa2010-03-08 20:52:55 +00001629 if (!Scope->getScopeNode())
Devang Patelbc97f6b2010-03-08 19:20:38 +00001630 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001631 DIScope DS(Scope->getScopeNode());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001632 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1633
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001634 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001635 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1636 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001637 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel930143b2009-11-21 02:48:08 +00001638 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001639 dwarf::DW_FORM_ref4, OriginDIE);
1640
Chris Lattner085b6522010-03-09 00:31:02 +00001641 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnere13c3722010-03-09 01:58:53 +00001642 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001643
1644 InlinedSubprogramDIEs.insert(OriginDIE);
1645
1646 // Track the start label for this inlined function.
Devang Patel32cc43c2010-05-07 20:54:48 +00001647 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001648 I = InlineInfo.find(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001649
1650 if (I == InlineInfo.end()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001651 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach00e9c612009-11-22 19:20:36 +00001652 ScopeDIE));
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001653 InlinedSPNodes.push_back(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001654 } else
Chris Lattner085b6522010-03-09 00:31:02 +00001655 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001656
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001657 DILocation DL(Scope->getInlinedAt());
Devang Patel1a0df9a2010-05-10 22:49:55 +00001658 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel930143b2009-11-21 02:48:08 +00001659 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001660
1661 return ScopeDIE;
1662}
1663
Devang Patel930143b2009-11-21 02:48:08 +00001664
1665/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel9ccfb642009-12-09 18:24:21 +00001666DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001667 StringRef Name = DV->getName();
Devang Patel2d9caf92009-11-25 17:36:49 +00001668 if (Name.empty())
Devang Patel97f99fa2009-11-13 02:25:26 +00001669 return NULL;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001670
1671 // Translate tag to proper Dwarf tag. The result variable is dropped for
1672 // now.
1673 unsigned Tag;
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001674 switch (DV->getTag()) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001675 case dwarf::DW_TAG_return_variable:
1676 return NULL;
1677 case dwarf::DW_TAG_arg_variable:
1678 Tag = dwarf::DW_TAG_formal_parameter;
1679 break;
1680 case dwarf::DW_TAG_auto_variable: // fall thru
1681 default:
1682 Tag = dwarf::DW_TAG_variable;
1683 break;
1684 }
1685
1686 // Define variable debug information entry.
1687 DIE *VariableDie = new DIE(Tag);
1688
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001689 DIE *AbsDIE = NULL;
Devang Patele1c53f22010-05-20 16:36:41 +00001690 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1691 V2AVI = VarToAbstractVarMap.find(DV);
1692 if (V2AVI != VarToAbstractVarMap.end())
1693 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach042483e2009-11-21 23:12:12 +00001694
Devang Patele1c53f22010-05-20 16:36:41 +00001695 if (AbsDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001696 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001697 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001698 else {
Devang Patel930143b2009-11-21 02:48:08 +00001699 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001700 addSourceLine(VariableDie, DV->getVariable());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001701
1702 // Add variable type.
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001703 addType(VariableDie, DV->getType());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001704 }
1705
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001706 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patel6efc8e52010-02-06 01:02:37 +00001707 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelbea08d12010-09-29 23:07:21 +00001708 else if (DIVariable(DV->getVariable()).isArtificial())
1709 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel9fc11702010-05-25 23:40:22 +00001710
1711 if (Scope->isAbstractScope()) {
1712 DV->setDIE(VariableDie);
1713 return VariableDie;
1714 }
1715
1716 // Add variable address.
1717
1718 unsigned Offset = DV->getDotDebugLocOffset();
1719 if (Offset != ~0U) {
1720 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1721 Asm->GetTempSymbol("debug_loc", Offset));
1722 DV->setDIE(VariableDie);
1723 UseDotDebugLocEntry.insert(VariableDie);
1724 return VariableDie;
1725 }
1726
1727 // Check if variable is described by a DBG_VALUE instruction.
1728 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1729 DbgVariableToDbgInstMap.find(DV);
1730 if (DVI != DbgVariableToDbgInstMap.end()) {
1731 const MachineInstr *DVInsn = DVI->second;
Devang Patel9fc11702010-05-25 23:40:22 +00001732 bool updated = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001733 // FIXME : Handle getNumOperands != 3
Devang Patel9fc11702010-05-25 23:40:22 +00001734 if (DVInsn->getNumOperands() == 3) {
Devang Patel86ec8b32010-08-31 22:22:42 +00001735 if (DVInsn->getOperand(0).isReg()) {
1736 const MachineOperand RegOp = DVInsn->getOperand(0);
1737 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1738 if (DVInsn->getOperand(1).isImm() &&
1739 TRI->getFrameRegister(*Asm->MF) == RegOp.getReg()) {
1740 addVariableAddress(DV, VariableDie, DVInsn->getOperand(1).getImm());
1741 updated = true;
1742 } else
Devang Patel53a40df62010-11-12 23:20:42 +00001743 updated = addRegisterAddress(VariableDie, RegOp);
Devang Patel86ec8b32010-08-31 22:22:42 +00001744 }
Devang Patel9fc11702010-05-25 23:40:22 +00001745 else if (DVInsn->getOperand(0).isImm())
Devang Patel53a40df62010-11-12 23:20:42 +00001746 updated = addConstantValue(VariableDie, DVInsn->getOperand(0));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001747 else if (DVInsn->getOperand(0).isFPImm())
1748 updated =
Devang Patel53a40df62010-11-12 23:20:42 +00001749 addConstantFPValue(VariableDie, DVInsn->getOperand(0));
Devang Patel9fc11702010-05-25 23:40:22 +00001750 } else {
1751 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1752 if (Location.getReg()) {
1753 addAddress(VariableDie, dwarf::DW_AT_location, Location);
Devang Patel9fc11702010-05-25 23:40:22 +00001754 updated = true;
1755 }
1756 }
1757 if (!updated) {
1758 // If variableDie is not updated then DBG_VALUE instruction does not
1759 // have valid variable info.
1760 delete VariableDie;
1761 return NULL;
1762 }
1763 DV->setDIE(VariableDie);
1764 return VariableDie;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001765 }
Devang Patel9fc11702010-05-25 23:40:22 +00001766
1767 // .. else use frame index, if available.
Devang Patel9fc11702010-05-25 23:40:22 +00001768 int FI = 0;
Devang Patel2cfc3af2010-08-31 06:11:28 +00001769 if (findVariableFrameIndex(DV, &FI))
1770 addVariableAddress(DV, VariableDie, FI);
1771
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001772 DV->setDIE(VariableDie);
1773 return VariableDie;
1774
1775}
Devang Patel930143b2009-11-21 02:48:08 +00001776
Devang Patel04d2f2d2009-11-24 01:14:22 +00001777void DwarfDebug::addPubTypes(DISubprogram SP) {
1778 DICompositeType SPTy = SP.getType();
1779 unsigned SPTag = SPTy.getTag();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001780 if (SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel04d2f2d2009-11-24 01:14:22 +00001781 return;
1782
1783 DIArray Args = SPTy.getTypeArray();
Devang Patel04d2f2d2009-11-24 01:14:22 +00001784 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001785 DIType ATy(Args.getElement(i));
Devang Patel8d6a2b72010-05-07 21:45:47 +00001786 if (!ATy.Verify())
Devang Patel04d2f2d2009-11-24 01:14:22 +00001787 continue;
1788 DICompositeType CATy = getDICompositeType(ATy);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001789 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel12d150e2010-04-13 20:35:04 +00001790 && !CATy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001791 CompileUnit *TheCU = getCompileUnit(CATy);
1792 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1793 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00001794 }
1795 }
1796}
1797
Devang Patel930143b2009-11-21 02:48:08 +00001798/// constructScopeDIE - Construct a DIE for this scope.
1799DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +00001800 if (!Scope || !Scope->getScopeNode())
1801 return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001802
Devang Patel3b548aa2010-03-08 20:52:55 +00001803 DIScope DS(Scope->getScopeNode());
1804 DIE *ScopeDIE = NULL;
1805 if (Scope->getInlinedAt())
1806 ScopeDIE = constructInlinedScopeDIE(Scope);
1807 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +00001808 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001809 if (Scope->isAbstractScope()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001810 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001811 // Note down abstract DIE.
1812 if (ScopeDIE)
1813 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
1814 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001815 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001816 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3b548aa2010-03-08 20:52:55 +00001817 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001818 else
Devang Patel3b548aa2010-03-08 20:52:55 +00001819 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel23b2ae62010-03-29 22:59:58 +00001820 if (!ScopeDIE) return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001821
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001822 // Add variables to scope.
Devang Patel406798a2010-08-09 18:51:29 +00001823 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001824 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel9ccfb642009-12-09 18:24:21 +00001825 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach042483e2009-11-21 23:12:12 +00001826 if (VariableDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001827 ScopeDIE->addChild(VariableDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001828 }
1829
1830 // Add nested scopes.
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001831 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001832 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1833 // Define the Scope debug information entry.
Devang Patel930143b2009-11-21 02:48:08 +00001834 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach042483e2009-11-21 23:12:12 +00001835 if (NestedDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001836 ScopeDIE->addChild(NestedDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001837 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001838
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001839 if (DS.isSubprogram())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001840 addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001841
Devang Patel04d2f2d2009-11-24 01:14:22 +00001842 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001843}
1844
Bill Wendling2b128d72009-05-20 23:19:06 +00001845/// GetOrCreateSourceID - Look up the source id with the given directory and
1846/// source file names. If none currently exists, create a new id and insert it
1847/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1848/// maps as well.
Devang Patel498877d2010-07-24 00:53:22 +00001849
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001850unsigned DwarfDebug::GetOrCreateSourceID(StringRef FileName){
Devang Patel871d0b12010-09-16 20:57:49 +00001851 // If FE did not provide a file name, then assume stdin.
1852 if (FileName.empty())
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001853 return GetOrCreateSourceID("<stdin>");
Devang Patel871d0b12010-09-16 20:57:49 +00001854
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001855 StringMapEntry<unsigned> &Entry = SourceIdMap.GetOrCreateValue(FileName);
1856 if (Entry.getValue())
1857 return Entry.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +00001858
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001859 unsigned SrcId = SourceIdMap.size();
1860 Entry.setValue(SrcId);
Bill Wendling2b128d72009-05-20 23:19:06 +00001861
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001862 // Print out a .file directive to specify files for .loc directives.
1863 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, FileName);
Bill Wendling2b128d72009-05-20 23:19:06 +00001864
1865 return SrcId;
1866}
1867
Devang Patel1f4690c2009-12-15 19:16:48 +00001868/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1869DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001870 CompileUnit *TheCU = getCompileUnit(NS);
1871 DIE *NDie = TheCU->getDIE(NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001872 if (NDie)
1873 return NDie;
1874 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001875 TheCU->insertDIE(NS, NDie);
Devang Patel1f4690c2009-12-15 19:16:48 +00001876 if (!NS.getName().empty())
1877 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
Devang Patelb6511a32010-08-09 20:20:05 +00001878 addSourceLine(NDie, NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001879 addToContextOwner(NDie, NS.getContext());
1880 return NDie;
1881}
1882
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001883/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel1a0df9a2010-05-10 22:49:55 +00001884/// metadata node with tag DW_TAG_compile_unit.
Devang Patel32cc43c2010-05-07 20:54:48 +00001885void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001886 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +00001887 StringRef FN = DIUnit.getFilename();
1888 StringRef Dir = DIUnit.getDirectory();
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001889 unsigned ID = GetOrCreateSourceID(FN);
Bill Wendling2b128d72009-05-20 23:19:06 +00001890
1891 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel930143b2009-11-21 02:48:08 +00001892 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patelb2969422009-09-29 18:40:58 +00001893 DIUnit.getProducer());
Devang Patel930143b2009-11-21 02:48:08 +00001894 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendling2b128d72009-05-20 23:19:06 +00001895 DIUnit.getLanguage());
Devang Patel930143b2009-11-21 02:48:08 +00001896 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patelbd798ce2010-04-26 22:54:28 +00001897 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1898 // simplifies debug range entries.
Devang Patel1de21ec2010-06-28 22:22:47 +00001899 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Pateld22ed622010-03-22 23:11:36 +00001900 // DW_AT_stmt_list is a offset of line number information for this
Devang Patel4a213872010-08-24 00:06:12 +00001901 // compile unit in debug_line section.
Devang Patelea636392010-08-31 23:50:19 +00001902 if (Asm->MAI->doesDwarfUsesAbsoluteLabelForStmtList())
1903 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_addr,
1904 Asm->GetTempSymbol("section_line"));
1905 else
1906 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00001907
Devang Patel2d9caf92009-11-25 17:36:49 +00001908 if (!Dir.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001909 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +00001910 if (DIUnit.isOptimized())
Devang Patel930143b2009-11-21 02:48:08 +00001911 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendling2b128d72009-05-20 23:19:06 +00001912
Devang Patel2d9caf92009-11-25 17:36:49 +00001913 StringRef Flags = DIUnit.getFlags();
1914 if (!Flags.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001915 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendling2b128d72009-05-20 23:19:06 +00001916
1917 unsigned RVer = DIUnit.getRunTimeVersion();
1918 if (RVer)
Devang Patel930143b2009-11-21 02:48:08 +00001919 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +00001920 dwarf::DW_FORM_data1, RVer);
1921
Devang Patel1a0df9a2010-05-10 22:49:55 +00001922 CompileUnit *NewCU = new CompileUnit(ID, Die);
1923 if (!FirstCU)
1924 FirstCU = NewCU;
1925 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendling2b128d72009-05-20 23:19:06 +00001926}
1927
Devang Patel1a0df9a2010-05-10 22:49:55 +00001928/// getCompielUnit - Get CompileUnit DIE.
1929CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1930 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1931 DIDescriptor D(N);
1932 const MDNode *CUNode = NULL;
1933 if (D.isCompileUnit())
1934 CUNode = N;
1935 else if (D.isSubprogram())
1936 CUNode = DISubprogram(N).getCompileUnit();
1937 else if (D.isType())
1938 CUNode = DIType(N).getCompileUnit();
1939 else if (D.isGlobalVariable())
1940 CUNode = DIGlobalVariable(N).getCompileUnit();
1941 else if (D.isVariable())
1942 CUNode = DIVariable(N).getCompileUnit();
1943 else if (D.isNameSpace())
1944 CUNode = DINameSpace(N).getCompileUnit();
1945 else if (D.isFile())
1946 CUNode = DIFile(N).getCompileUnit();
1947 else
1948 return FirstCU;
1949
1950 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1951 = CUMap.find(CUNode);
1952 if (I == CUMap.end())
1953 return FirstCU;
1954 return I->second;
1955}
1956
Devang Patela8652672010-08-23 18:25:56 +00001957/// isUnsignedDIType - Return true if type encoding is unsigned.
1958static bool isUnsignedDIType(DIType Ty) {
1959 DIDerivedType DTy(Ty);
1960 if (DTy.Verify())
1961 return isUnsignedDIType(DTy.getTypeDerivedFrom());
1962
1963 DIBasicType BTy(Ty);
1964 if (BTy.Verify()) {
1965 unsigned Encoding = BTy.getEncoding();
1966 if (Encoding == dwarf::DW_ATE_unsigned ||
1967 Encoding == dwarf::DW_ATE_unsigned_char)
1968 return true;
1969 }
1970 return false;
1971}
Devang Patel1a0df9a2010-05-10 22:49:55 +00001972
Devang Patel2d9e5322011-01-20 00:02:16 +00001973// Return const exprssion if value is a GEP to access merged global
1974// constant. e.g.
1975// i8* getelementptr ({ i8, i8, i8, i8 }* @_MergedGlobals, i32 0, i32 0)
1976static const ConstantExpr *getMergedGlobalExpr(const Value *V) {
1977 const ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(V);
1978 if (!CE || CE->getNumOperands() != 3 ||
1979 CE->getOpcode() != Instruction::GetElementPtr)
1980 return NULL;
1981
1982 // First operand points to a global value.
1983 if (!isa<GlobalValue>(CE->getOperand(0)))
1984 return NULL;
1985
1986 // Second operand is zero.
1987 const ConstantInt *CI =
1988 dyn_cast_or_null<ConstantInt>(CE->getOperand(1));
1989 if (!CI || !CI->isZero())
1990 return NULL;
1991
1992 // Third operand is offset.
1993 if (!isa<ConstantInt>(CE->getOperand(2)))
1994 return NULL;
1995
1996 return CE;
1997}
1998
Devang Patel1a0df9a2010-05-10 22:49:55 +00001999/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00002000void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel469c12d22010-08-10 01:37:23 +00002001 DIGlobalVariable GV(N);
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002002
Devang Patelf5d53602009-09-04 23:59:07 +00002003 // If debug information is malformed then ignore it.
Devang Patel469c12d22010-08-10 01:37:23 +00002004 if (GV.Verify() == false)
Devang Patelf5d53602009-09-04 23:59:07 +00002005 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002006
2007 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002008 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel469c12d22010-08-10 01:37:23 +00002009 if (TheCU->getDIE(GV))
Devang Patel0751a282009-06-26 01:49:18 +00002010 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002011
Devang Patel469c12d22010-08-10 01:37:23 +00002012 DIType GTy = GV.getType();
Devang Patelb2197462010-08-10 07:11:13 +00002013 DIE *VariableDIE = new DIE(GV.getTag());
2014
2015 bool isGlobalVariable = GV.getGlobal() != NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00002016
Devang Patel469c12d22010-08-10 01:37:23 +00002017 // Add name.
2018 addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
2019 GV.getDisplayName());
2020 StringRef LinkageName = GV.getLinkageName();
Devang Patelb2197462010-08-10 07:11:13 +00002021 if (!LinkageName.empty() && isGlobalVariable)
Devang Patel469c12d22010-08-10 01:37:23 +00002022 addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
2023 getRealLinkageName(LinkageName));
2024 // Add type.
2025 addType(VariableDIE, GTy);
Devang Patel12d150e2010-04-13 20:35:04 +00002026 if (GTy.isCompositeType() && !GTy.getName().empty()
2027 && !GTy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002028 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattner8d2fe282010-03-31 05:36:29 +00002029 assert(Entry && "Missing global type!");
Devang Patel1a0df9a2010-05-10 22:49:55 +00002030 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00002031 }
Devang Patel469c12d22010-08-10 01:37:23 +00002032 // Add scoping info.
2033 if (!GV.isLocalToUnit()) {
2034 addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
2035 // Expose as global.
2036 TheCU->addGlobal(GV.getName(), VariableDIE);
2037 }
2038 // Add line number info.
2039 addSourceLine(VariableDIE, GV);
2040 // Add to map.
2041 TheCU->insertDIE(N, VariableDIE);
2042 // Add to context owner.
2043 DIDescriptor GVContext = GV.getContext();
2044 addToContextOwner(VariableDIE, GVContext);
2045 // Add location.
Devang Patelb2197462010-08-10 07:11:13 +00002046 if (isGlobalVariable) {
2047 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
2048 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
2049 addLabel(Block, 0, dwarf::DW_FORM_udata,
2050 Asm->Mang->getSymbol(GV.getGlobal()));
2051 // Do not create specification DIE if context is either compile unit
2052 // or a subprogram.
2053 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
2054 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
2055 // Create specification DIE.
2056 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
2057 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
2058 dwarf::DW_FORM_ref4, VariableDIE);
2059 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
2060 addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
2061 TheCU->addDie(VariableSpecDIE);
2062 } else {
2063 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
2064 }
Devang Patel70eb9822011-01-06 21:39:25 +00002065 } else if (ConstantInt *CI =
2066 dyn_cast_or_null<ConstantInt>(GV.getConstant()))
2067 addConstantValue(VariableDIE, CI, isUnsignedDIType(GTy));
Devang Patel2d9e5322011-01-20 00:02:16 +00002068 else if (const ConstantExpr *CE = getMergedGlobalExpr(N->getOperand(11))) {
2069 // GV is a merged global.
2070 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
2071 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
2072 addLabel(Block, 0, dwarf::DW_FORM_udata,
2073 Asm->Mang->getSymbol(cast<GlobalValue>(CE->getOperand(0))));
2074 ConstantInt *CII = cast<ConstantInt>(CE->getOperand(2));
2075 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
2076 addUInt(Block, 0, dwarf::DW_FORM_udata, CII->getZExtValue());
2077 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
2078 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
2079 }
Devang Patel70eb9822011-01-06 21:39:25 +00002080
Devang Patel0751a282009-06-26 01:49:18 +00002081 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002082}
2083
Devang Patel1a0df9a2010-05-10 22:49:55 +00002084/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00002085void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00002086 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +00002087
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002088 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002089 CompileUnit *TheCU = getCompileUnit(N);
2090 if (TheCU->getDIE(N))
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002091 return;
2092
Bill Wendling2b128d72009-05-20 23:19:06 +00002093 if (!SP.isDefinition())
2094 // This is a method declaration which will be handled while constructing
2095 // class type.
Devang Patel0751a282009-06-26 01:49:18 +00002096 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002097
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002098 DIE *SubprogramDie = createSubprogramDIE(SP);
2099
2100 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002101 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00002102
2103 // Add to context owner.
Devang Patel1f4690c2009-12-15 19:16:48 +00002104 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +00002105
Bill Wendling2b128d72009-05-20 23:19:06 +00002106 // Expose as global.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002107 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002108
Devang Patel0751a282009-06-26 01:49:18 +00002109 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002110}
2111
Devang Patel930143b2009-11-21 02:48:08 +00002112/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbarbe22ec42009-09-19 20:40:14 +00002113/// content. Create global DIEs and emit initial debug info sections.
2114/// This is inovked by the target AsmPrinter.
Chris Lattner11980022010-04-04 07:48:20 +00002115void DwarfDebug::beginModule(Module *M) {
Devang Patel6c74a872010-04-27 19:46:33 +00002116 if (DisableDebugInfoPrinting)
2117 return;
2118
Devang Patel63524442009-07-30 18:56:46 +00002119 DebugInfoFinder DbgFinder;
2120 DbgFinder.processModule(*M);
Devang Patel0751a282009-06-26 01:49:18 +00002121
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002122 bool HasDebugInfo = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002123
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002124 // Scan all the compile-units to see if there are any marked as the main unit.
2125 // if not, we do not generate debug info.
2126 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2127 E = DbgFinder.compile_unit_end(); I != E; ++I) {
2128 if (DICompileUnit(*I).isMain()) {
2129 HasDebugInfo = true;
2130 break;
2131 }
2132 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002133
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002134 if (!HasDebugInfo) return;
2135
2136 // Tell MMI that we have debug info.
2137 MMI->setDebugInfoAvailability(true);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002138
Chris Lattnerd442aa32010-04-04 23:17:54 +00002139 // Emit initial sections.
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002140 EmitSectionLabels();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002141
Bill Wendling2b128d72009-05-20 23:19:06 +00002142 // Create all the compile unit DIEs.
Devang Patel63524442009-07-30 18:56:46 +00002143 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2144 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002145 constructCompileUnit(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002146
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002147 // Create DIEs for each subprogram.
Devang Patel63524442009-07-30 18:56:46 +00002148 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
2149 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002150 constructSubprogramDIE(*I);
Devang Patel0751a282009-06-26 01:49:18 +00002151
Devang Patel2b75ed22009-12-10 19:14:49 +00002152 // Create DIEs for each global variable.
2153 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2154 E = DbgFinder.global_variable_end(); I != E; ++I)
2155 constructGlobalVariableDIE(*I);
2156
Devang Patel8e06a5e2010-08-10 20:01:20 +00002157 //getOrCreateTypeDIE
2158 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
2159 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2160 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2161
Devang Patel7a554812010-09-28 18:08:20 +00002162 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
2163 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2164 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2165
Bill Wendling2b128d72009-05-20 23:19:06 +00002166 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +00002167 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +00002168}
2169
Devang Patel930143b2009-11-21 02:48:08 +00002170/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendling2b128d72009-05-20 23:19:06 +00002171///
Devang Patel930143b2009-11-21 02:48:08 +00002172void DwarfDebug::endModule() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002173 if (!FirstCU) return;
Devang Patelf3b2db62010-06-28 18:25:03 +00002174 const Module *M = MMI->getModule();
Devang Pateld0701282010-08-02 17:32:15 +00002175 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patelf3b2db62010-06-28 18:25:03 +00002176 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2177 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2178 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2179 DISubprogram SP(AllSPs->getOperand(SI));
2180 if (!SP.Verify()) continue;
2181
2182 // Collect info for variables that were optimized out.
Devang Patel18efced2010-07-19 17:53:55 +00002183 if (!SP.isDefinition()) continue;
Devang Patelf3b2db62010-06-28 18:25:03 +00002184 StringRef FName = SP.getLinkageName();
2185 if (FName.empty())
2186 FName = SP.getName();
Devang Patel364bf042010-11-10 22:19:21 +00002187 NamedMDNode *NMD = getFnSpecificMDNode(*(MMI->getModule()), FName);
Devang Patelf3b2db62010-06-28 18:25:03 +00002188 if (!NMD) continue;
2189 unsigned E = NMD->getNumOperands();
2190 if (!E) continue;
2191 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Pateld0701282010-08-02 17:32:15 +00002192 DeadFnScopeMap[SP] = Scope;
Devang Patelf3b2db62010-06-28 18:25:03 +00002193 for (unsigned I = 0; I != E; ++I) {
2194 DIVariable DV(NMD->getOperand(I));
2195 if (!DV.Verify()) continue;
2196 Scope->addVariable(new DbgVariable(DV));
2197 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002198
Devang Patelf3b2db62010-06-28 18:25:03 +00002199 // Construct subprogram DIE and add variables DIEs.
2200 constructSubprogramDIE(SP);
2201 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patel406798a2010-08-09 18:51:29 +00002202 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf3b2db62010-06-28 18:25:03 +00002203 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2204 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2205 if (VariableDIE)
2206 ScopeDIE->addChild(VariableDIE);
2207 }
2208 }
2209 }
Bill Wendling2b128d72009-05-20 23:19:06 +00002210
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002211 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2212 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2213 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2214 DIE *ISP = *AI;
Devang Patel930143b2009-11-21 02:48:08 +00002215 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002216 }
2217
Devang Patel32cc43c2010-05-07 20:54:48 +00002218 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Pateleb57c592009-12-03 19:11:07 +00002219 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2220 DIE *SPDie = CI->first;
Devang Patel32cc43c2010-05-07 20:54:48 +00002221 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Pateleb57c592009-12-03 19:11:07 +00002222 if (!N) continue;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002223 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Pateleb57c592009-12-03 19:11:07 +00002224 if (!NDie) continue;
2225 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Pateleb57c592009-12-03 19:11:07 +00002226 }
2227
Bill Wendling2b128d72009-05-20 23:19:06 +00002228 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002229 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002230 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002231 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002232 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +00002233
2234 // End text sections.
2235 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002236 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnera179b522010-04-04 19:25:43 +00002237 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendling2b128d72009-05-20 23:19:06 +00002238 }
2239
2240 // Emit common frame information.
Devang Patel930143b2009-11-21 02:48:08 +00002241 emitCommonDebugFrame();
Bill Wendling2b128d72009-05-20 23:19:06 +00002242
2243 // Emit function debug frame information
2244 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2245 E = DebugFrames.end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002246 emitFunctionDebugFrame(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002247
2248 // Compute DIE offsets and sizes.
Devang Patel930143b2009-11-21 02:48:08 +00002249 computeSizeAndOffsets();
Bill Wendling2b128d72009-05-20 23:19:06 +00002250
2251 // Emit all the DIEs into a debug info section
Devang Patel930143b2009-11-21 02:48:08 +00002252 emitDebugInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002253
2254 // Corresponding abbreviations into a abbrev section.
Devang Patel930143b2009-11-21 02:48:08 +00002255 emitAbbreviations();
Bill Wendling2b128d72009-05-20 23:19:06 +00002256
Bill Wendling2b128d72009-05-20 23:19:06 +00002257 // Emit info into a debug pubnames section.
Devang Patel930143b2009-11-21 02:48:08 +00002258 emitDebugPubNames();
Bill Wendling2b128d72009-05-20 23:19:06 +00002259
Devang Patel04d2f2d2009-11-24 01:14:22 +00002260 // Emit info into a debug pubtypes section.
2261 emitDebugPubTypes();
2262
Bill Wendling2b128d72009-05-20 23:19:06 +00002263 // Emit info into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002264 emitDebugLoc();
Bill Wendling2b128d72009-05-20 23:19:06 +00002265
2266 // Emit info into a debug aranges section.
2267 EmitDebugARanges();
2268
2269 // Emit info into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002270 emitDebugRanges();
Bill Wendling2b128d72009-05-20 23:19:06 +00002271
2272 // Emit info into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002273 emitDebugMacInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002274
2275 // Emit inline info.
Devang Patel930143b2009-11-21 02:48:08 +00002276 emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002277
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002278 // Emit info into a debug str section.
2279 emitDebugStr();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002280
Devang Pateld0701282010-08-02 17:32:15 +00002281 // clean up.
2282 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002283 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2284 E = CUMap.end(); I != E; ++I)
2285 delete I->second;
2286 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendling2b128d72009-05-20 23:19:06 +00002287}
2288
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002289/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002290DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattner915c5f92010-04-02 19:42:39 +00002291 DebugLoc ScopeLoc) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002292
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002293 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002294 if (AbsDbgVariable)
2295 return AbsDbgVariable;
2296
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002297 LLVMContext &Ctx = Var->getContext();
Chris Lattner915c5f92010-04-02 19:42:39 +00002298 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002299 if (!Scope)
2300 return NULL;
2301
Devang Patele1c53f22010-05-20 16:36:41 +00002302 AbsDbgVariable = new DbgVariable(Var);
Devang Patel930143b2009-11-21 02:48:08 +00002303 Scope->addVariable(AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002304 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002305 return AbsDbgVariable;
2306}
2307
Devang Patel490c8ab2010-05-20 19:57:06 +00002308/// collectVariableInfoFromMMITable - Collect variable information from
2309/// side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002310void
Devang Patel490c8ab2010-05-20 19:57:06 +00002311DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2312 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00002313 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patel475d32a2009-10-06 01:26:37 +00002314 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2315 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2316 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00002317 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002318 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00002319 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00002320 DIVariable DV(Var);
2321 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002322
Chris Lattner915c5f92010-04-02 19:42:39 +00002323 DbgScope *Scope = 0;
Devang Patel32cc43c2010-05-07 20:54:48 +00002324 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattner915c5f92010-04-02 19:42:39 +00002325 Scope = ConcreteScopes.lookup(IA);
2326 if (Scope == 0)
2327 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002328
Devang Patelcdb7d442009-11-10 23:20:04 +00002329 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00002330 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00002331 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002332
Devang Patele1c53f22010-05-20 16:36:41 +00002333 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2334 DbgVariable *RegVar = new DbgVariable(DV);
2335 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel930143b2009-11-21 02:48:08 +00002336 Scope->addVariable(RegVar);
Devang Patele1c53f22010-05-20 16:36:41 +00002337 if (AbsDbgVariable) {
2338 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2339 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2340 }
Devang Patel475d32a2009-10-06 01:26:37 +00002341 }
Devang Patel490c8ab2010-05-20 19:57:06 +00002342}
Devang Patela3e9c9c2010-03-15 18:33:46 +00002343
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002344/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +00002345/// DBG_VALUE instruction, is in a defined reg.
2346static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2347 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2348 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2349 return true;
2350 return false;
2351}
2352
Devang Patel490c8ab2010-05-20 19:57:06 +00002353/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002354void
Devang Patel5c0f85c2010-06-25 22:07:34 +00002355DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2356 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002357
Devang Patel490c8ab2010-05-20 19:57:06 +00002358 /// collection info from MMI table.
2359 collectVariableInfoFromMMITable(MF, Processed);
2360
2361 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002362 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002363 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel490c8ab2010-05-20 19:57:06 +00002364 I != E; ++I)
Devang Patela3e9c9c2010-03-15 18:33:46 +00002365 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2366 II != IE; ++II) {
2367 const MachineInstr *MInsn = II;
Devang Patel447cb382011-01-11 21:42:10 +00002368 if (!MInsn->isDebugValue())
Devang Patela3e9c9c2010-03-15 18:33:46 +00002369 continue;
Devang Patel490c8ab2010-05-20 19:57:06 +00002370 DbgValues.push_back(MInsn);
2371 }
Devang Patela3e9c9c2010-03-15 18:33:46 +00002372
Devang Patel9fc11702010-05-25 23:40:22 +00002373 // This is a collection of DBV_VALUE instructions describing same variable.
2374 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patel490c8ab2010-05-20 19:57:06 +00002375 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2376 E = DbgValues.end(); I != E; ++I) {
2377 const MachineInstr *MInsn = *I;
Devang Patel9fc11702010-05-25 23:40:22 +00002378 MultipleValues.clear();
2379 if (isDbgValueInDefinedReg(MInsn))
2380 MultipleValues.push_back(MInsn);
Devang Patel490c8ab2010-05-20 19:57:06 +00002381 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2382 if (Processed.count(DV) != 0)
2383 continue;
2384
Devang Patelc2254f62010-06-02 19:05:13 +00002385 const MachineInstr *PrevMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002386 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
Devang Patel9fc11702010-05-25 23:40:22 +00002387 ME = DbgValues.end(); MI != ME; ++MI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002388 const MDNode *Var =
Devang Patel9fc11702010-05-25 23:40:22 +00002389 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
Devang Patel447cb382011-01-11 21:42:10 +00002390 if (Var == DV &&
Devang Patelc2254f62010-06-02 19:05:13 +00002391 !PrevMI->isIdenticalTo(*MI))
Devang Patel9fc11702010-05-25 23:40:22 +00002392 MultipleValues.push_back(*MI);
Devang Patelc2254f62010-06-02 19:05:13 +00002393 PrevMI = *MI;
Devang Patel9fc11702010-05-25 23:40:22 +00002394 }
2395
Devang Patel447cb382011-01-11 21:42:10 +00002396 DbgScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00002397 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2398 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelfbd6c452010-05-21 00:10:20 +00002399 Scope = CurrentFnDbgScope;
Devang Patel447cb382011-01-11 21:42:10 +00002400 else
2401 Scope = findDbgScope(MInsn);
Devang Patel490c8ab2010-05-20 19:57:06 +00002402 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00002403 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00002404 continue;
2405
2406 Processed.insert(DV);
Devang Patel490c8ab2010-05-20 19:57:06 +00002407 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patel490c8ab2010-05-20 19:57:06 +00002408 Scope->addVariable(RegVar);
Devang Patelfbd6c452010-05-21 00:10:20 +00002409 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2410 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2411 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002412 }
Devang Patel9fc11702010-05-25 23:40:22 +00002413 if (MultipleValues.size() <= 1) {
2414 DbgVariableToDbgInstMap[RegVar] = MInsn;
2415 continue;
2416 }
2417
2418 // handle multiple DBG_VALUE instructions describing one variable.
Devang Patel9fc11702010-05-25 23:40:22 +00002419 if (DotDebugLocEntries.empty())
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002420 RegVar->setDotDebugLocOffset(0);
2421 else
2422 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002423 const MachineInstr *Begin = NULL;
2424 const MachineInstr *End = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002425 for (SmallVector<const MachineInstr *, 4>::iterator
2426 MVI = MultipleValues.begin(), MVE = MultipleValues.end();
Devang Patel30265c42010-07-07 20:12:52 +00002427 MVI != MVE; ++MVI) {
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002428 if (!Begin) {
2429 Begin = *MVI;
2430 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002431 }
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002432 End = *MVI;
Devang Patel9fc11702010-05-25 23:40:22 +00002433 MachineLocation MLoc;
Devang Patel0e60e672010-08-04 18:40:52 +00002434 if (Begin->getNumOperands() == 3) {
2435 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2436 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2437 } else
2438 MLoc = Asm->getDebugValueLocation(Begin);
2439
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002440 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2441 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patel6c378ac2010-08-04 22:07:27 +00002442 if (MLoc.getReg())
2443 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
2444
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002445 Begin = End;
2446 if (MVI + 1 == MVE) {
2447 // If End is the last instruction then its value is valid
Devang Patel9fc11702010-05-25 23:40:22 +00002448 // until the end of the funtion.
Devang Patel0e60e672010-08-04 18:40:52 +00002449 MachineLocation EMLoc;
2450 if (End->getNumOperands() == 3) {
2451 if (End->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2452 EMLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2453 } else
2454 EMLoc = Asm->getDebugValueLocation(End);
Devang Patel6c378ac2010-08-04 22:07:27 +00002455 if (EMLoc.getReg())
2456 DotDebugLocEntries.
2457 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, EMLoc));
Devang Patel9fc11702010-05-25 23:40:22 +00002458 }
2459 }
2460 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00002461 }
Devang Patele0a94bf2010-05-14 21:01:35 +00002462
2463 // Collect info for variables that were optimized out.
Devang Patelad517352010-06-22 01:01:58 +00002464 const Function *F = MF->getFunction();
Devang Patel364bf042010-11-10 22:19:21 +00002465 if (NamedMDNode *NMD = getFnSpecificMDNode(*(F->getParent()), F->getName())) {
Devang Patele0a94bf2010-05-14 21:01:35 +00002466 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002467 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel490c8ab2010-05-20 19:57:06 +00002468 if (!DV || !Processed.insert(DV))
Devang Patele0a94bf2010-05-14 21:01:35 +00002469 continue;
2470 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2471 if (Scope)
Devang Patele1c53f22010-05-20 16:36:41 +00002472 Scope->addVariable(new DbgVariable(DV));
Devang Patele0a94bf2010-05-14 21:01:35 +00002473 }
2474 }
Devang Patel9fc11702010-05-25 23:40:22 +00002475}
Devang Patele0a94bf2010-05-14 21:01:35 +00002476
Devang Patel9fc11702010-05-25 23:40:22 +00002477/// getLabelBeforeInsn - Return Label preceding the instruction.
2478const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2479 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2480 LabelsBeforeInsn.find(MI);
2481 if (I == LabelsBeforeInsn.end())
2482 // FunctionBeginSym always preceeds all the instruction in current function.
2483 return FunctionBeginSym;
2484 return I->second;
2485}
2486
2487/// getLabelAfterInsn - Return Label immediately following the instruction.
2488const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2489 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2490 LabelsAfterInsn.find(MI);
2491 if (I == LabelsAfterInsn.end())
2492 return NULL;
2493 return I->second;
Devang Patel475d32a2009-10-06 01:26:37 +00002494}
2495
Devang Patelb5694e72010-10-26 17:49:02 +00002496/// beginInstruction - Process beginning of an instruction.
2497void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Devang Patel002d54d2010-05-26 19:37:24 +00002498 if (InsnNeedsLabel.count(MI) == 0) {
2499 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patelbd477be2010-03-29 17:20:31 +00002500 return;
Devang Patel9fc11702010-05-25 23:40:22 +00002501 }
Devang Patel23b2ae62010-03-29 22:59:58 +00002502
Devang Patel002d54d2010-05-26 19:37:24 +00002503 // Check location.
2504 DebugLoc DL = MI->getDebugLoc();
2505 if (!DL.isUnknown()) {
2506 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2507 PrevLabel = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
Devang Patel6c74a872010-04-27 19:46:33 +00002508 PrevInstLoc = DL;
Devang Patel002d54d2010-05-26 19:37:24 +00002509 LabelsBeforeInsn[MI] = PrevLabel;
2510 return;
Devang Patel6c74a872010-04-27 19:46:33 +00002511 }
Devang Patelbd477be2010-03-29 17:20:31 +00002512
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002513 // If location is unknown then use temp label for this DBG_VALUE
Devang Patel002d54d2010-05-26 19:37:24 +00002514 // instruction.
2515 if (MI->isDebugValue()) {
Devang Patelacc32a52010-05-26 21:23:46 +00002516 PrevLabel = MMI->getContext().CreateTempSymbol();
2517 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00002518 LabelsBeforeInsn[MI] = PrevLabel;
2519 return;
2520 }
2521
2522 if (UnknownLocations) {
2523 PrevLabel = recordSourceLine(0, 0, 0);
2524 LabelsBeforeInsn[MI] = PrevLabel;
2525 return;
2526 }
2527
2528 assert (0 && "Instruction is not processed!");
Devang Patel8db360d2009-10-06 01:50:42 +00002529}
2530
Devang Patelb5694e72010-10-26 17:49:02 +00002531/// endInstruction - Process end of an instruction.
2532void DwarfDebug::endInstruction(const MachineInstr *MI) {
Devang Patel3ebd8932010-04-08 16:50:29 +00002533 if (InsnsEndScopeSet.count(MI) != 0) {
2534 // Emit a label if this instruction ends a scope.
2535 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2536 Asm->OutStreamer.EmitLabel(Label);
Devang Patel6c74a872010-04-27 19:46:33 +00002537 LabelsAfterInsn[MI] = Label;
Devang Patel3ebd8932010-04-08 16:50:29 +00002538 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002539}
2540
Devang Patel6c74a872010-04-27 19:46:33 +00002541/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002542DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel30265c42010-07-07 20:12:52 +00002543 const MDNode *InlinedAt) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002544 if (!InlinedAt) {
2545 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2546 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002547 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002548 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2549 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Patel6c74a872010-04-27 19:46:33 +00002550 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002551 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002552 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Patel6c74a872010-04-27 19:46:33 +00002553 WScope->setParent(Parent);
2554 Parent->addScope(WScope);
2555 }
2556
2557 if (!WScope->getParent()) {
2558 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastings9b5005c2010-06-15 23:06:30 +00002559 // We used to check only for a linkage name, but that fails
2560 // since we began omitting the linkage name for private
2561 // functions. The new way is to check for the name in metadata,
2562 // but that's not supported in old .ll test cases. Ergo, we
2563 // check both.
Stuart Hastingsafe54f12010-06-11 20:08:44 +00002564 if (SPName == Asm->MF->getFunction()->getName() ||
2565 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Patel6c74a872010-04-27 19:46:33 +00002566 CurrentFnDbgScope = WScope;
2567 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002568
Devang Patel6c74a872010-04-27 19:46:33 +00002569 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002570 }
2571
Devang Patel5c0f85c2010-06-25 22:07:34 +00002572 getOrCreateAbstractScope(Scope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002573 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2574 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002575 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002576
2577 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2578 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2579 DILocation DL(InlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002580 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002581 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Patel6c74a872010-04-27 19:46:33 +00002582 WScope->setParent(Parent);
2583 Parent->addScope(WScope);
2584
2585 ConcreteScopes[InlinedAt] = WScope;
Devang Patel6c74a872010-04-27 19:46:33 +00002586
2587 return WScope;
Devang Patel8db360d2009-10-06 01:50:42 +00002588}
2589
Devang Patel6c74a872010-04-27 19:46:33 +00002590/// hasValidLocation - Return true if debug location entry attached with
2591/// machine instruction encodes valid location info.
2592static bool hasValidLocation(LLVMContext &Ctx,
2593 const MachineInstr *MInsn,
Devang Patel32cc43c2010-05-07 20:54:48 +00002594 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Patel6c74a872010-04-27 19:46:33 +00002595 DebugLoc DL = MInsn->getDebugLoc();
2596 if (DL.isUnknown()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002597
Devang Patel32cc43c2010-05-07 20:54:48 +00002598 const MDNode *S = DL.getScope(Ctx);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002599
Devang Patel6c74a872010-04-27 19:46:33 +00002600 // There is no need to create another DIE for compile unit. For all
2601 // other scopes, create one DbgScope now. This will be translated
2602 // into a scope DIE at the end.
2603 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002604
Devang Patel6c74a872010-04-27 19:46:33 +00002605 Scope = S;
2606 InlinedAt = DL.getInlinedAt(Ctx);
2607 return true;
2608}
2609
2610/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2611/// hierarchy.
2612static void calculateDominanceGraph(DbgScope *Scope) {
2613 assert (Scope && "Unable to calculate scop edominance graph!");
2614 SmallVector<DbgScope *, 4> WorkStack;
2615 WorkStack.push_back(Scope);
2616 unsigned Counter = 0;
2617 while (!WorkStack.empty()) {
2618 DbgScope *WS = WorkStack.back();
2619 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2620 bool visitedChildren = false;
2621 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2622 SE = Children.end(); SI != SE; ++SI) {
2623 DbgScope *ChildScope = *SI;
2624 if (!ChildScope->getDFSOut()) {
2625 WorkStack.push_back(ChildScope);
2626 visitedChildren = true;
2627 ChildScope->setDFSIn(++Counter);
2628 break;
2629 }
2630 }
2631 if (!visitedChildren) {
2632 WorkStack.pop_back();
2633 WS->setDFSOut(++Counter);
2634 }
2635 }
2636}
2637
2638/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002639static
Devang Patel6c74a872010-04-27 19:46:33 +00002640void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2641 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2642{
2643#ifndef NDEBUG
2644 unsigned PrevDFSIn = 0;
2645 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2646 I != E; ++I) {
2647 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2648 II != IE; ++II) {
2649 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002650 const MDNode *Scope = NULL;
2651 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002652
2653 // Check if instruction has valid location information.
2654 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2655 dbgs() << " [ ";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002656 if (InlinedAt)
Devang Patel6c74a872010-04-27 19:46:33 +00002657 dbgs() << "*";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002658 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Patel6c74a872010-04-27 19:46:33 +00002659 MI2ScopeMap.find(MInsn);
2660 if (DI != MI2ScopeMap.end()) {
2661 DbgScope *S = DI->second;
2662 dbgs() << S->getDFSIn();
2663 PrevDFSIn = S->getDFSIn();
2664 } else
2665 dbgs() << PrevDFSIn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002666 } else
Devang Patel6c74a872010-04-27 19:46:33 +00002667 dbgs() << " [ x" << PrevDFSIn;
2668 dbgs() << " ]";
2669 MInsn->dump();
2670 }
2671 dbgs() << "\n";
2672 }
2673#endif
2674}
Devang Patel930143b2009-11-21 02:48:08 +00002675/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner848c7d22010-03-31 05:39:57 +00002676/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattner76555b52010-01-26 23:18:02 +00002677bool DwarfDebug::extractScopeInformation() {
Devang Patel75cc16c2009-10-01 20:31:14 +00002678 // If scope information was extracted using .dbg intrinsics then there is not
2679 // any need to extract these information by scanning each instruction.
2680 if (!DbgScopeMap.empty())
2681 return false;
2682
Dan Gohmane9135cb2010-04-23 01:18:53 +00002683 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patel6c74a872010-04-27 19:46:33 +00002684 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2685 SmallVector<DbgRange, 4> MIRanges;
2686 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patel32cc43c2010-05-07 20:54:48 +00002687 const MDNode *PrevScope = NULL;
2688 const MDNode *PrevInlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002689 const MachineInstr *RangeBeginMI = NULL;
2690 const MachineInstr *PrevMI = NULL;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002691 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel75cc16c2009-10-01 20:31:14 +00002692 I != E; ++I) {
2693 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2694 II != IE; ++II) {
2695 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002696 const MDNode *Scope = NULL;
2697 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002698
2699 // Check if instruction has valid location information.
2700 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2701 PrevMI = MInsn;
2702 continue;
2703 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002704
Devang Patel6c74a872010-04-27 19:46:33 +00002705 // If scope has not changed then skip this instruction.
2706 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2707 PrevMI = MInsn;
2708 continue;
2709 }
2710
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002711 if (RangeBeginMI) {
2712 // If we have alread seen a beginning of a instruction range and
Devang Patel6c74a872010-04-27 19:46:33 +00002713 // current instruction scope does not match scope of first instruction
2714 // in this range then create a new instruction range.
2715 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002716 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel30265c42010-07-07 20:12:52 +00002717 PrevInlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002718 MIRanges.push_back(R);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002719 }
Devang Patel6c74a872010-04-27 19:46:33 +00002720
2721 // This is a beginning of a new instruction range.
2722 RangeBeginMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002723
Devang Patel6c74a872010-04-27 19:46:33 +00002724 // Reset previous markers.
2725 PrevMI = MInsn;
2726 PrevScope = Scope;
2727 PrevInlinedAt = InlinedAt;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002728 }
2729 }
2730
Devang Patel6c74a872010-04-27 19:46:33 +00002731 // Create last instruction range.
2732 if (RangeBeginMI && PrevMI && PrevScope) {
2733 DbgRange R(RangeBeginMI, PrevMI);
2734 MIRanges.push_back(R);
2735 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patel75cc16c2009-10-01 20:31:14 +00002736 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002737
Devang Patel530a0752010-01-04 20:44:00 +00002738 if (!CurrentFnDbgScope)
2739 return false;
2740
Devang Patel6c74a872010-04-27 19:46:33 +00002741 calculateDominanceGraph(CurrentFnDbgScope);
2742 if (PrintDbgScope)
2743 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2744
2745 // Find ranges of instructions covered by each DbgScope;
2746 DbgScope *PrevDbgScope = NULL;
2747 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2748 RE = MIRanges.end(); RI != RE; ++RI) {
2749 const DbgRange &R = *RI;
2750 DbgScope *S = MI2ScopeMap.lookup(R.first);
2751 assert (S && "Lost DbgScope for a machine instruction!");
2752 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2753 PrevDbgScope->closeInsnRange(S);
2754 S->openInsnRange(R.first);
2755 S->extendInsnRange(R.second);
2756 PrevDbgScope = S;
2757 }
2758
2759 if (PrevDbgScope)
2760 PrevDbgScope->closeInsnRange();
Devang Patel75cc16c2009-10-01 20:31:14 +00002761
Devang Patel359b0132010-04-08 18:43:56 +00002762 identifyScopeMarkers();
Devang Patelf1d5a1e2010-04-08 15:37:09 +00002763
2764 return !DbgScopeMap.empty();
2765}
2766
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002767/// identifyScopeMarkers() -
Devang Patel6c74a872010-04-27 19:46:33 +00002768/// Each DbgScope has first instruction and last instruction to mark beginning
2769/// and end of a scope respectively. Create an inverse map that list scopes
2770/// starts (and ends) with an instruction. One instruction may start (or end)
2771/// multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00002772void DwarfDebug::identifyScopeMarkers() {
Devang Patel7771b7c2010-01-20 02:05:23 +00002773 SmallVector<DbgScope *, 4> WorkList;
2774 WorkList.push_back(CurrentFnDbgScope);
2775 while (!WorkList.empty()) {
Chris Lattner848c7d22010-03-31 05:39:57 +00002776 DbgScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002777
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002778 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002779 if (!Children.empty())
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002780 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00002781 SE = Children.end(); SI != SE; ++SI)
2782 WorkList.push_back(*SI);
2783
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002784 if (S->isAbstractScope())
2785 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002786
Devang Patel6c74a872010-04-27 19:46:33 +00002787 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2788 if (Ranges.empty())
2789 continue;
2790 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2791 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002792 assert(RI->first && "DbgRange does not have first instruction!");
2793 assert(RI->second && "DbgRange does not have second instruction!");
Devang Patel6c74a872010-04-27 19:46:33 +00002794 InsnsEndScopeSet.insert(RI->second);
2795 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002796 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002797}
2798
Dan Gohman3df671a2010-04-20 00:37:27 +00002799/// FindFirstDebugLoc - Find the first debug location in the function. This
2800/// is intended to be an approximation for the source position of the
2801/// beginning of the function.
2802static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2803 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2804 I != E; ++I)
2805 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2806 MBBI != MBBE; ++MBBI) {
2807 DebugLoc DL = MBBI->getDebugLoc();
2808 if (!DL.isUnknown())
2809 return DL;
2810 }
2811 return DebugLoc();
2812}
2813
Devang Patela86114b2010-10-25 20:45:32 +00002814#ifndef NDEBUG
2815/// CheckLineNumbers - Count basicblocks whose instructions do not have any
2816/// line number information.
2817static void CheckLineNumbers(const MachineFunction *MF) {
2818 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2819 I != E; ++I) {
2820 bool FoundLineNo = false;
2821 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2822 II != IE; ++II) {
2823 const MachineInstr *MI = II;
2824 if (!MI->getDebugLoc().isUnknown()) {
2825 FoundLineNo = true;
2826 break;
2827 }
2828 }
Devang Patel6e0d5892010-10-28 22:11:59 +00002829 if (!FoundLineNo && I->size())
Devang Patela86114b2010-10-25 20:45:32 +00002830 ++BlocksWithoutLineNo;
2831 }
2832}
2833#endif
2834
Devang Patel930143b2009-11-21 02:48:08 +00002835/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendling2b128d72009-05-20 23:19:06 +00002836/// emitted immediately after the function entry point.
Chris Lattner76555b52010-01-26 23:18:02 +00002837void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00002838 if (!MMI->hasDebugInfo()) return;
Bill Wendlingfcc14142010-04-07 09:28:04 +00002839 if (!extractScopeInformation()) return;
Devang Patel4598eb62009-10-06 18:37:31 +00002840
Devang Patela86114b2010-10-25 20:45:32 +00002841#ifndef NDEBUG
2842 CheckLineNumbers(MF);
2843#endif
2844
Devang Patel6c74a872010-04-27 19:46:33 +00002845 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2846 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00002847 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00002848 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00002849
2850 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2851 // function.
Dan Gohman3df671a2010-04-20 00:37:27 +00002852 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattner915c5f92010-04-02 19:42:39 +00002853 if (FDL.isUnknown()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002854
Devang Patel32cc43c2010-05-07 20:54:48 +00002855 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings61475c52010-07-19 23:56:30 +00002856 const MDNode *TheScope = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002857
Chris Lattner915c5f92010-04-02 19:42:39 +00002858 DISubprogram SP = getDISubprogram(Scope);
2859 unsigned Line, Col;
2860 if (SP.Verify()) {
2861 Line = SP.getLineNumber();
2862 Col = 0;
Stuart Hastings61475c52010-07-19 23:56:30 +00002863 TheScope = SP;
Chris Lattner915c5f92010-04-02 19:42:39 +00002864 } else {
2865 Line = FDL.getLine();
2866 Col = FDL.getCol();
Stuart Hastings61475c52010-07-19 23:56:30 +00002867 TheScope = Scope;
Bill Wendling2b128d72009-05-20 23:19:06 +00002868 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002869
Stuart Hastings61475c52010-07-19 23:56:30 +00002870 recordSourceLine(Line, Col, TheScope);
Devang Patel002d54d2010-05-26 19:37:24 +00002871
Devang Patel21ccf052010-06-02 16:42:51 +00002872 /// ProcessedArgs - Collection of arguments already processed.
2873 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2874
Devang Patel002d54d2010-05-26 19:37:24 +00002875 DebugLoc PrevLoc;
2876 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2877 I != E; ++I)
2878 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2879 II != IE; ++II) {
2880 const MachineInstr *MI = II;
2881 DebugLoc DL = MI->getDebugLoc();
2882 if (MI->isDebugValue()) {
Devang Patel002d54d2010-05-26 19:37:24 +00002883 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2884 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2885 if (!DV.Verify()) continue;
Devang Patel5e6b71c2010-05-27 16:47:30 +00002886 // If DBG_VALUE is for a local variable then it needs a label.
Devang Patelbca5b252010-12-06 22:48:22 +00002887 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
Devang Patel002d54d2010-05-26 19:37:24 +00002888 InsnNeedsLabel.insert(MI);
Devang Patel5e6b71c2010-05-27 16:47:30 +00002889 // DBG_VALUE for inlined functions argument needs a label.
Devang Patel42939752010-07-01 21:38:08 +00002890 else if (!DISubprogram(getDISubprogram(DV.getContext())).
2891 describes(MF->getFunction()))
Devang Patel5e6b71c2010-05-27 16:47:30 +00002892 InsnNeedsLabel.insert(MI);
2893 // DBG_VALUE indicating argument location change needs a label.
Devang Patelbca5b252010-12-06 22:48:22 +00002894 else if (!ProcessedArgs.insert(DV))
Devang Patel002d54d2010-05-26 19:37:24 +00002895 InsnNeedsLabel.insert(MI);
2896 } else {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002897 // If location is unknown then instruction needs a location only if
Devang Patel002d54d2010-05-26 19:37:24 +00002898 // UnknownLocations flag is set.
2899 if (DL.isUnknown()) {
2900 if (UnknownLocations && !PrevLoc.isUnknown())
2901 InsnNeedsLabel.insert(MI);
2902 } else if (DL != PrevLoc)
2903 // Otherwise, instruction needs a location only if it is new location.
2904 InsnNeedsLabel.insert(MI);
2905 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002906
Devang Patel002d54d2010-05-26 19:37:24 +00002907 if (!DL.isUnknown() || UnknownLocations)
2908 PrevLoc = DL;
2909 }
2910
2911 PrevLabel = FunctionBeginSym;
Bill Wendling2b128d72009-05-20 23:19:06 +00002912}
2913
Devang Patel930143b2009-11-21 02:48:08 +00002914/// endFunction - Gather and emit post-function debug information.
Bill Wendling2b128d72009-05-20 23:19:06 +00002915///
Chris Lattner76555b52010-01-26 23:18:02 +00002916void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendlingfcc14142010-04-07 09:28:04 +00002917 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00002918
Devang Patel530a0752010-01-04 20:44:00 +00002919 if (CurrentFnDbgScope) {
Devang Patel4a8e6e82010-05-22 00:04:14 +00002920
Devang Patel9fc11702010-05-25 23:40:22 +00002921 // Define end label for subprogram.
2922 FunctionEndSym = Asm->GetTempSymbol("func_end",
2923 Asm->getFunctionNumber());
2924 // Assumes in correct section after the entry point.
2925 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002926
Devang Patel5c0f85c2010-06-25 22:07:34 +00002927 SmallPtrSet<const MDNode *, 16> ProcessedVars;
2928 collectVariableInfo(MF, ProcessedVars);
Devang Patel4a8e6e82010-05-22 00:04:14 +00002929
Devang Patel530a0752010-01-04 20:44:00 +00002930 // Construct abstract scopes.
2931 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel5c0f85c2010-06-25 22:07:34 +00002932 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00002933 DISubprogram SP((*AI)->getScopeNode());
2934 if (SP.Verify()) {
2935 // Collect info for variables that were optimized out.
2936 StringRef FName = SP.getLinkageName();
2937 if (FName.empty())
2938 FName = SP.getName();
Devang Patel364bf042010-11-10 22:19:21 +00002939 if (NamedMDNode *NMD =
2940 getFnSpecificMDNode(*(MF->getFunction()->getParent()), FName)) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00002941 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002942 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel5c0f85c2010-06-25 22:07:34 +00002943 if (!DV || !ProcessedVars.insert(DV))
2944 continue;
Devang Patel648df7b2010-06-30 00:11:08 +00002945 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel5c0f85c2010-06-25 22:07:34 +00002946 if (Scope)
2947 Scope->addVariable(new DbgVariable(DV));
2948 }
2949 }
2950 }
Devang Patelc5b31092010-06-30 01:40:11 +00002951 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
2952 constructScopeDIE(*AI);
Devang Patel5c0f85c2010-06-25 22:07:34 +00002953 }
Devang Patel30265c42010-07-07 20:12:52 +00002954
Devang Patel075e9b52010-05-04 06:15:30 +00002955 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002956
Devang Patel075e9b52010-05-04 06:15:30 +00002957 if (!DisableFramePointerElim(*MF))
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002958 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel075e9b52010-05-04 06:15:30 +00002959 dwarf::DW_FORM_flag, 1);
2960
2961
Chris Lattner3a383cb2010-04-05 00:13:49 +00002962 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel530a0752010-01-04 20:44:00 +00002963 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00002964 }
2965
Bill Wendling2b128d72009-05-20 23:19:06 +00002966 // Clear debug info
Devang Patelfe189e62010-01-19 01:26:02 +00002967 CurrentFnDbgScope = NULL;
Devang Patel002d54d2010-05-26 19:37:24 +00002968 InsnNeedsLabel.clear();
Devang Patele1c53f22010-05-20 16:36:41 +00002969 DbgVariableToFrameIndexMap.clear();
2970 VarToAbstractVarMap.clear();
2971 DbgVariableToDbgInstMap.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002972 DeleteContainerSeconds(DbgScopeMap);
Devang Patel541019d2010-04-09 16:04:20 +00002973 InsnsEndScopeSet.clear();
Devang Patelfe189e62010-01-19 01:26:02 +00002974 ConcreteScopes.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002975 DeleteContainerSeconds(AbstractScopes);
Devang Patelfe189e62010-01-19 01:26:02 +00002976 AbstractScopesList.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002977 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00002978 LabelsBeforeInsn.clear();
2979 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00002980 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00002981}
2982
Devang Patele1c53f22010-05-20 16:36:41 +00002983/// recordVariableFrameIndex - Record a variable's index.
2984void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2985 assert (V && "Invalid DbgVariable!");
2986 DbgVariableToFrameIndexMap[V] = Index;
2987}
2988
2989/// findVariableFrameIndex - Return true if frame index for the variable
2990/// is found. Update FI to hold value of the index.
2991bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
2992 assert (V && "Invalid DbgVariable!");
2993 DenseMap<const DbgVariable *, int>::iterator I =
2994 DbgVariableToFrameIndexMap.find(V);
2995 if (I == DbgVariableToFrameIndexMap.end())
2996 return false;
2997 *FI = I->second;
2998 return true;
2999}
3000
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003001/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patel490c8ab2010-05-20 19:57:06 +00003002/// instruction.
3003DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
3004 DbgScope *Scope = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003005 LLVMContext &Ctx =
Devang Patel490c8ab2010-05-20 19:57:06 +00003006 MInsn->getParent()->getParent()->getFunction()->getContext();
3007 DebugLoc DL = MInsn->getDebugLoc();
3008
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003009 if (DL.isUnknown())
Devang Patel490c8ab2010-05-20 19:57:06 +00003010 return Scope;
3011
3012 if (const MDNode *IA = DL.getInlinedAt(Ctx))
3013 Scope = ConcreteScopes.lookup(IA);
3014 if (Scope == 0)
3015 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003016
Devang Patel490c8ab2010-05-20 19:57:06 +00003017 return Scope;
3018}
3019
3020
Chris Lattnerba35a672010-03-09 04:54:43 +00003021/// recordSourceLine - Register a source line with debug info. Returns the
3022/// unique label that was emitted and which provides correspondence to
3023/// the source line list.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003024MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel30265c42010-07-07 20:12:52 +00003025 const MDNode *S) {
Devang Patel2d9caf92009-11-25 17:36:49 +00003026 StringRef Fn;
Devang Patel2089d162009-10-05 18:03:19 +00003027
Dan Gohman50849c62010-05-05 23:41:32 +00003028 unsigned Src = 1;
3029 if (S) {
3030 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00003031
Dan Gohman50849c62010-05-05 23:41:32 +00003032 if (Scope.isCompileUnit()) {
3033 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00003034 Fn = CU.getFilename();
Devang Patelc4b69052010-10-28 17:30:52 +00003035 } else if (Scope.isFile()) {
3036 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00003037 Fn = F.getFilename();
Dan Gohman50849c62010-05-05 23:41:32 +00003038 } else if (Scope.isSubprogram()) {
3039 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00003040 Fn = SP.getFilename();
3041 } else if (Scope.isLexicalBlock()) {
3042 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00003043 Fn = DB.getFilename();
3044 } else
3045 assert(0 && "Unexpected scope info");
3046
Rafael Espindola67c6ab82010-11-18 02:04:25 +00003047 Src = GetOrCreateSourceID(Fn);
Dan Gohman50849c62010-05-05 23:41:32 +00003048 }
3049
Rafael Espindola67c6ab82010-11-18 02:04:25 +00003050 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, DWARF2_FLAG_IS_STMT,
3051 0, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00003052
Rafael Espindola67c6ab82010-11-18 02:04:25 +00003053 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattnerba35a672010-03-09 04:54:43 +00003054 Asm->OutStreamer.EmitLabel(Label);
3055 return Label;
Bill Wendling2b128d72009-05-20 23:19:06 +00003056}
3057
Bill Wendling806535f2009-05-20 23:22:40 +00003058//===----------------------------------------------------------------------===//
3059// Emit Methods
3060//===----------------------------------------------------------------------===//
3061
Devang Patel930143b2009-11-21 02:48:08 +00003062/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling480ff322009-05-20 23:21:38 +00003063///
Jim Grosbach00e9c612009-11-22 19:20:36 +00003064unsigned
3065DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling480ff322009-05-20 23:21:38 +00003066 // Get the children.
3067 const std::vector<DIE *> &Children = Die->getChildren();
3068
3069 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00003070 if (!Last && !Children.empty())
Benjamin Kramer74729ae2010-03-31 19:34:01 +00003071 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling480ff322009-05-20 23:21:38 +00003072
3073 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00003074 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00003075
3076 // Get the abbreviation for this DIE.
3077 unsigned AbbrevNumber = Die->getAbbrevNumber();
3078 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3079
3080 // Set DIE offset
3081 Die->setOffset(Offset);
3082
3083 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00003084 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003085
3086 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
3087 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3088
3089 // Size the DIE attribute values.
3090 for (unsigned i = 0, N = Values.size(); i < N; ++i)
3091 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00003092 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00003093
3094 // Size the DIE children if any.
3095 if (!Children.empty()) {
3096 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
3097 "Children flag not set");
3098
3099 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003100 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling480ff322009-05-20 23:21:38 +00003101
3102 // End of children marker.
3103 Offset += sizeof(int8_t);
3104 }
3105
3106 Die->setSize(Offset - Die->getOffset());
3107 return Offset;
3108}
3109
Devang Patel930143b2009-11-21 02:48:08 +00003110/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling480ff322009-05-20 23:21:38 +00003111///
Devang Patel930143b2009-11-21 02:48:08 +00003112void DwarfDebug::computeSizeAndOffsets() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003113 unsigned PrevOffset = 0;
3114 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3115 E = CUMap.end(); I != E; ++I) {
3116 // Compute size of compile unit header.
3117 static unsigned Offset = PrevOffset +
3118 sizeof(int32_t) + // Length of Compilation Unit Info
3119 sizeof(int16_t) + // DWARF version number
3120 sizeof(int32_t) + // Offset Into Abbrev. Section
3121 sizeof(int8_t); // Pointer Size (in bytes)
3122 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
3123 PrevOffset = Offset;
3124 }
Bill Wendling480ff322009-05-20 23:21:38 +00003125}
3126
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003127/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3128/// temporary label to it if SymbolStem is specified.
Chris Lattner6629ca92010-04-04 22:59:04 +00003129static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003130 const char *SymbolStem = 0) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003131 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003132 if (!SymbolStem) return 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003133
Chris Lattner6629ca92010-04-04 22:59:04 +00003134 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3135 Asm->OutStreamer.EmitLabel(TmpSym);
3136 return TmpSym;
3137}
3138
3139/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3140/// the start of each one.
Chris Lattner46355d82010-04-04 22:33:59 +00003141void DwarfDebug::EmitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003142 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003143
Bill Wendling480ff322009-05-20 23:21:38 +00003144 // Dwarf sections base addresses.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003145 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003146 DwarfFrameSectionSym =
3147 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3148 }
Bill Wendling480ff322009-05-20 23:21:38 +00003149
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003150 DwarfInfoSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003151 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003152 DwarfAbbrevSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003153 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003154 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003155
Chris Lattner6629ca92010-04-04 22:59:04 +00003156 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003157 EmitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003158
Devang Patel4a213872010-08-24 00:06:12 +00003159 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003160 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3161 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3162 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003163 DwarfStrSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003164 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patel12563b32010-04-16 23:33:45 +00003165 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3166 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00003167
Devang Patel9fc11702010-05-25 23:40:22 +00003168 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3169 "section_debug_loc");
3170
Chris Lattner6629ca92010-04-04 22:59:04 +00003171 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattnere58b5472010-04-04 23:10:38 +00003172 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003173}
3174
Devang Patel930143b2009-11-21 02:48:08 +00003175/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling480ff322009-05-20 23:21:38 +00003176///
Devang Patel930143b2009-11-21 02:48:08 +00003177void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00003178 // Get the abbreviation for this DIE.
3179 unsigned AbbrevNumber = Die->getAbbrevNumber();
3180 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3181
Bill Wendling480ff322009-05-20 23:21:38 +00003182 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00003183 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00003184 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3185 Twine::utohexstr(Die->getOffset()) + ":0x" +
3186 Twine::utohexstr(Die->getSize()) + " " +
3187 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00003188 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003189
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00003190 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00003191 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3192
3193 // Emit the DIE attribute values.
3194 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3195 unsigned Attr = AbbrevData[i].getAttribute();
3196 unsigned Form = AbbrevData[i].getForm();
3197 assert(Form && "Too many attributes for DIE (check abbreviation)");
3198
Chris Lattner7bde8c02010-04-04 18:52:31 +00003199 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00003200 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003201
Bill Wendling480ff322009-05-20 23:21:38 +00003202 switch (Attr) {
3203 case dwarf::DW_AT_sibling:
Devang Patel930143b2009-11-21 02:48:08 +00003204 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003205 break;
3206 case dwarf::DW_AT_abstract_origin: {
3207 DIEEntry *E = cast<DIEEntry>(Values[i]);
3208 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003209 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00003210 Asm->EmitInt32(Addr);
3211 break;
3212 }
Devang Patel12563b32010-04-16 23:33:45 +00003213 case dwarf::DW_AT_ranges: {
3214 // DW_AT_range Value encodes offset in debug_range section.
3215 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00003216
3217 if (Asm->MAI->doesDwarfUsesLabelOffsetForRanges()) {
3218 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
3219 V->getValue(),
3220 4);
3221 } else {
3222 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3223 V->getValue(),
3224 DwarfDebugRangeSectionSym,
3225 4);
3226 }
Devang Patel12563b32010-04-16 23:33:45 +00003227 break;
3228 }
Devang Patel9fc11702010-05-25 23:40:22 +00003229 case dwarf::DW_AT_location: {
3230 if (UseDotDebugLocEntry.count(Die) != 0) {
3231 DIELabel *L = cast<DIELabel>(Values[i]);
3232 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
3233 } else
3234 Values[i]->EmitValue(Asm, Form);
3235 break;
3236 }
Devang Patela1bd5a12010-09-29 19:08:08 +00003237 case dwarf::DW_AT_accessibility: {
3238 if (Asm->isVerbose()) {
3239 DIEInteger *V = cast<DIEInteger>(Values[i]);
3240 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
3241 }
3242 Values[i]->EmitValue(Asm, Form);
3243 break;
3244 }
Bill Wendling480ff322009-05-20 23:21:38 +00003245 default:
3246 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003247 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00003248 break;
3249 }
Bill Wendling480ff322009-05-20 23:21:38 +00003250 }
3251
3252 // Emit the DIE children if any.
3253 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3254 const std::vector<DIE *> &Children = Die->getChildren();
3255
3256 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003257 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00003258
Chris Lattner7bde8c02010-04-04 18:52:31 +00003259 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00003260 Asm->OutStreamer.AddComment("End Of Children Mark");
3261 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003262 }
3263}
3264
Devang Patel9ccfb642009-12-09 18:24:21 +00003265/// emitDebugInfo - Emit the debug info section.
Bill Wendling480ff322009-05-20 23:21:38 +00003266///
Devang Patel9ccfb642009-12-09 18:24:21 +00003267void DwarfDebug::emitDebugInfo() {
3268 // Start debug info section.
3269 Asm->OutStreamer.SwitchSection(
3270 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel1a0df9a2010-05-10 22:49:55 +00003271 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3272 E = CUMap.end(); I != E; ++I) {
3273 CompileUnit *TheCU = I->second;
3274 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003275
Devang Patel1a0df9a2010-05-10 22:49:55 +00003276 // Emit the compile units header.
3277 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3278 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003279
Devang Patel1a0df9a2010-05-10 22:49:55 +00003280 // Emit size of content not including length itself
3281 unsigned ContentSize = Die->getSize() +
3282 sizeof(int16_t) + // DWARF version number
3283 sizeof(int32_t) + // Offset Into Abbrev. Section
3284 sizeof(int8_t) + // Pointer Size (in bytes)
3285 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003286
Devang Patel1a0df9a2010-05-10 22:49:55 +00003287 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3288 Asm->EmitInt32(ContentSize);
3289 Asm->OutStreamer.AddComment("DWARF version number");
3290 Asm->EmitInt16(dwarf::DWARF_VERSION);
3291 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3292 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3293 DwarfAbbrevSectionSym);
3294 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3295 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003296
Devang Patel1a0df9a2010-05-10 22:49:55 +00003297 emitDIE(Die);
3298 // FIXME - extra padding for gdb bug.
3299 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3300 Asm->EmitInt8(0);
3301 Asm->EmitInt8(0);
3302 Asm->EmitInt8(0);
3303 Asm->EmitInt8(0);
3304 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3305 }
Bill Wendling480ff322009-05-20 23:21:38 +00003306}
3307
Devang Patel930143b2009-11-21 02:48:08 +00003308/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling480ff322009-05-20 23:21:38 +00003309///
Devang Patel930143b2009-11-21 02:48:08 +00003310void DwarfDebug::emitAbbreviations() const {
Bill Wendling480ff322009-05-20 23:21:38 +00003311 // Check to see if it is worth the effort.
3312 if (!Abbreviations.empty()) {
3313 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003314 Asm->OutStreamer.SwitchSection(
3315 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003316
Chris Lattnera179b522010-04-04 19:25:43 +00003317 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003318
3319 // For each abbrevation.
3320 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3321 // Get abbreviation data
3322 const DIEAbbrev *Abbrev = Abbreviations[i];
3323
3324 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00003325 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00003326
3327 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003328 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00003329 }
3330
3331 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00003332 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00003333
Chris Lattnera179b522010-04-04 19:25:43 +00003334 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003335 }
3336}
3337
Devang Patel930143b2009-11-21 02:48:08 +00003338/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling480ff322009-05-20 23:21:38 +00003339/// the line matrix.
3340///
Devang Patel930143b2009-11-21 02:48:08 +00003341void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00003342 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00003343 Asm->OutStreamer.AddComment("Extended Op");
3344 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003345
Chris Lattner566cae92010-03-09 23:52:58 +00003346 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003347 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00003348 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3349 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3350
3351 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00003352
Chris Lattnera179b522010-04-04 19:25:43 +00003353 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003354 Asm->getTargetData().getPointerSize(),
3355 0/*AddrSpace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003356
3357 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00003358 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3359 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003360 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00003361 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003362}
3363
Devang Patel930143b2009-11-21 02:48:08 +00003364/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling480ff322009-05-20 23:21:38 +00003365///
Devang Patel930143b2009-11-21 02:48:08 +00003366void DwarfDebug::emitCommonDebugFrame() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003367 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003368 return;
3369
Chris Lattner3a383cb2010-04-05 00:13:49 +00003370 int stackGrowth = Asm->getTargetData().getPointerSize();
Anton Korobeynikov2f931282011-01-10 12:39:04 +00003371 if (Asm->TM.getFrameLowering()->getStackGrowthDirection() ==
3372 TargetFrameLowering::StackGrowsDown)
Chris Lattner3a383cb2010-04-05 00:13:49 +00003373 stackGrowth *= -1;
Bill Wendling480ff322009-05-20 23:21:38 +00003374
3375 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003376 Asm->OutStreamer.SwitchSection(
3377 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003378
Chris Lattnera179b522010-04-04 19:25:43 +00003379 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner566cae92010-03-09 23:52:58 +00003380 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003381 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3382 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003383
Chris Lattnera179b522010-04-04 19:25:43 +00003384 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner566cae92010-03-09 23:52:58 +00003385 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling480ff322009-05-20 23:21:38 +00003386 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner566cae92010-03-09 23:52:58 +00003387 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling480ff322009-05-20 23:21:38 +00003388 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner566cae92010-03-09 23:52:58 +00003389 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003390 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner9efd1182010-04-04 19:09:29 +00003391 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3392 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner566cae92010-03-09 23:52:58 +00003393 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003394 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Anton Korobeynikov2f931282011-01-10 12:39:04 +00003395 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
Bill Wendling480ff322009-05-20 23:21:38 +00003396 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling480ff322009-05-20 23:21:38 +00003397
3398 std::vector<MachineMove> Moves;
Anton Korobeynikov14ee3442010-11-18 23:25:52 +00003399 TFI->getInitialFrameState(Moves);
Bill Wendling480ff322009-05-20 23:21:38 +00003400
Chris Lattneraabc6042010-04-04 23:41:46 +00003401 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003402
Chris Lattner9e06e532010-04-28 01:05:45 +00003403 Asm->EmitAlignment(2);
Chris Lattnera179b522010-04-04 19:25:43 +00003404 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003405}
3406
Devang Patel930143b2009-11-21 02:48:08 +00003407/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling480ff322009-05-20 23:21:38 +00003408/// section.
Chris Lattner2c3f4782010-03-13 07:26:18 +00003409void DwarfDebug::
3410emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003411 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003412 return;
3413
3414 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003415 Asm->OutStreamer.SwitchSection(
3416 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003417
Chris Lattner566cae92010-03-09 23:52:58 +00003418 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner2c3f4782010-03-13 07:26:18 +00003419 MCSymbol *DebugFrameBegin =
Chris Lattnera179b522010-04-04 19:25:43 +00003420 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003421 MCSymbol *DebugFrameEnd =
Chris Lattnera179b522010-04-04 19:25:43 +00003422 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnerf1429f12010-04-04 19:58:12 +00003423 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003424
Chris Lattner2c3f4782010-03-13 07:26:18 +00003425 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling480ff322009-05-20 23:21:38 +00003426
Chris Lattner566cae92010-03-09 23:52:58 +00003427 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003428 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner70a4fce2010-04-04 23:25:33 +00003429 DwarfFrameSectionSym);
Bill Wendling480ff322009-05-20 23:21:38 +00003430
Chris Lattner566cae92010-03-09 23:52:58 +00003431 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnera179b522010-04-04 19:25:43 +00003432 MCSymbol *FuncBeginSym =
3433 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattner8811e122010-03-13 07:40:56 +00003434 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattner3a383cb2010-04-05 00:13:49 +00003435 Asm->getTargetData().getPointerSize(),
3436 0/*AddrSpace*/);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003437
3438
Chris Lattner566cae92010-03-09 23:52:58 +00003439 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003440 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003441 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003442
Chris Lattneraabc6042010-04-04 23:41:46 +00003443 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003444
Chris Lattner9e06e532010-04-28 01:05:45 +00003445 Asm->EmitAlignment(2);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003446 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling480ff322009-05-20 23:21:38 +00003447}
3448
Devang Patel9ccfb642009-12-09 18:24:21 +00003449/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3450///
3451void DwarfDebug::emitDebugPubNames() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003452 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3453 E = CUMap.end(); I != E; ++I) {
3454 CompileUnit *TheCU = I->second;
3455 // Start the dwarf pubnames section.
3456 Asm->OutStreamer.SwitchSection(
3457 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003458
Devang Patel1a0df9a2010-05-10 22:49:55 +00003459 Asm->OutStreamer.AddComment("Length of Public Names Info");
3460 Asm->EmitLabelDifference(
3461 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3462 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003463
Devang Patel1a0df9a2010-05-10 22:49:55 +00003464 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3465 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003466
Devang Patel1a0df9a2010-05-10 22:49:55 +00003467 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003468 Asm->EmitInt16(dwarf::DWARF_VERSION);
3469
Devang Patel1a0df9a2010-05-10 22:49:55 +00003470 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003471 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00003472 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003473
Devang Patel1a0df9a2010-05-10 22:49:55 +00003474 Asm->OutStreamer.AddComment("Compilation Unit Length");
3475 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3476 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3477 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003478
Devang Patel1a0df9a2010-05-10 22:49:55 +00003479 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3480 for (StringMap<DIE*>::const_iterator
3481 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3482 const char *Name = GI->getKeyData();
3483 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003484
Devang Patel1a0df9a2010-05-10 22:49:55 +00003485 Asm->OutStreamer.AddComment("DIE offset");
3486 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003487
Devang Patel1a0df9a2010-05-10 22:49:55 +00003488 if (Asm->isVerbose())
3489 Asm->OutStreamer.AddComment("External Name");
3490 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3491 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003492
Devang Patel1a0df9a2010-05-10 22:49:55 +00003493 Asm->OutStreamer.AddComment("End Mark");
3494 Asm->EmitInt32(0);
3495 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3496 TheCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00003497 }
Bill Wendling480ff322009-05-20 23:21:38 +00003498}
3499
Devang Patel04d2f2d2009-11-24 01:14:22 +00003500void DwarfDebug::emitDebugPubTypes() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003501 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3502 E = CUMap.end(); I != E; ++I) {
3503 CompileUnit *TheCU = I->second;
3504 // Start the dwarf pubnames section.
3505 Asm->OutStreamer.SwitchSection(
3506 Asm->getObjFileLowering().getDwarfPubTypesSection());
3507 Asm->OutStreamer.AddComment("Length of Public Types Info");
3508 Asm->EmitLabelDifference(
3509 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3510 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003511
Devang Patel1a0df9a2010-05-10 22:49:55 +00003512 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3513 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003514
Devang Patel1a0df9a2010-05-10 22:49:55 +00003515 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3516 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003517
Devang Patel1a0df9a2010-05-10 22:49:55 +00003518 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3519 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3520 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003521
Devang Patel1a0df9a2010-05-10 22:49:55 +00003522 Asm->OutStreamer.AddComment("Compilation Unit Length");
3523 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3524 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3525 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003526
Devang Patel1a0df9a2010-05-10 22:49:55 +00003527 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3528 for (StringMap<DIE*>::const_iterator
3529 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3530 const char *Name = GI->getKeyData();
3531 DIE * Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003532
Devang Patel1a0df9a2010-05-10 22:49:55 +00003533 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3534 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003535
Devang Patel1a0df9a2010-05-10 22:49:55 +00003536 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3537 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3538 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003539
Devang Patel1a0df9a2010-05-10 22:49:55 +00003540 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003541 Asm->EmitInt32(0);
Devang Patel1a0df9a2010-05-10 22:49:55 +00003542 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3543 TheCU->getID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00003544 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00003545}
3546
Devang Patel930143b2009-11-21 02:48:08 +00003547/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling480ff322009-05-20 23:21:38 +00003548///
Devang Patel930143b2009-11-21 02:48:08 +00003549void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00003550 // Check to see if it is worth the effort.
Chris Lattner3d72a672010-03-09 23:38:23 +00003551 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003552
Chris Lattner3d72a672010-03-09 23:38:23 +00003553 // Start the dwarf str section.
3554 Asm->OutStreamer.SwitchSection(
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003555 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003556
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003557 // Get all of the string pool entries and put them in an array by their ID so
3558 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003559 SmallVector<std::pair<unsigned,
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003560 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003561
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003562 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3563 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3564 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003565
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003566 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003567
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003568 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00003569 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003570 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003571
Chris Lattner3d72a672010-03-09 23:38:23 +00003572 // Emit the string itself.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003573 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003574 }
3575}
3576
Devang Patel930143b2009-11-21 02:48:08 +00003577/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling480ff322009-05-20 23:21:38 +00003578///
Devang Patel930143b2009-11-21 02:48:08 +00003579void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003580 if (DotDebugLocEntries.empty())
3581 return;
3582
Bill Wendling480ff322009-05-20 23:21:38 +00003583 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003584 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00003585 Asm->getObjFileLowering().getDwarfLocSection());
3586 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003587 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3588 unsigned index = 1;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003589 for (SmallVector<DotDebugLocEntry, 4>::iterator
3590 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00003591 I != E; ++I, ++index) {
Devang Patel9fc11702010-05-25 23:40:22 +00003592 DotDebugLocEntry Entry = *I;
Devang Patel9fc11702010-05-25 23:40:22 +00003593 if (Entry.isEmpty()) {
3594 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3595 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003596 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00003597 } else {
3598 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3599 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3600 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3601 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patel0e60e672010-08-04 18:40:52 +00003602 if (int Offset = Entry.Loc.getOffset()) {
3603 // If the value is at a certain offset from frame register then
3604 // use DW_OP_fbreg.
3605 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patel9fc11702010-05-25 23:40:22 +00003606 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patel0e60e672010-08-04 18:40:52 +00003607 Asm->EmitInt16(1 + OffsetSize);
3608 Asm->OutStreamer.AddComment(
3609 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3610 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3611 Asm->OutStreamer.AddComment("Offset");
3612 Asm->EmitSLEB128(Offset);
Devang Patel9fc11702010-05-25 23:40:22 +00003613 } else {
Devang Patel0e60e672010-08-04 18:40:52 +00003614 if (Reg < 32) {
3615 Asm->OutStreamer.AddComment("Loc expr size");
3616 Asm->EmitInt16(1);
3617 Asm->OutStreamer.AddComment(
Devang Patel6d21f612010-08-04 20:32:36 +00003618 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patel0e60e672010-08-04 18:40:52 +00003619 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3620 } else {
3621 Asm->OutStreamer.AddComment("Loc expr size");
3622 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3623 Asm->EmitInt8(dwarf::DW_OP_regx);
3624 Asm->EmitULEB128(Reg);
3625 }
Devang Patel9fc11702010-05-25 23:40:22 +00003626 }
3627 }
3628 }
Bill Wendling480ff322009-05-20 23:21:38 +00003629}
3630
3631/// EmitDebugARanges - Emit visible names into a debug aranges section.
3632///
3633void DwarfDebug::EmitDebugARanges() {
3634 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003635 Asm->OutStreamer.SwitchSection(
3636 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003637}
3638
Devang Patel930143b2009-11-21 02:48:08 +00003639/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling480ff322009-05-20 23:21:38 +00003640///
Devang Patel930143b2009-11-21 02:48:08 +00003641void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00003642 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003643 Asm->OutStreamer.SwitchSection(
Devang Patel12563b32010-04-16 23:33:45 +00003644 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Patel6c74a872010-04-27 19:46:33 +00003645 unsigned char Size = Asm->getTargetData().getPointerSize();
3646 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003647 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00003648 I != E; ++I) {
3649 if (*I)
3650 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patel12563b32010-04-16 23:33:45 +00003651 else
Devang Patel6c74a872010-04-27 19:46:33 +00003652 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel12563b32010-04-16 23:33:45 +00003653 }
Bill Wendling480ff322009-05-20 23:21:38 +00003654}
3655
Devang Patel930143b2009-11-21 02:48:08 +00003656/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling480ff322009-05-20 23:21:38 +00003657///
Devang Patel930143b2009-11-21 02:48:08 +00003658void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003659 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00003660 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00003661 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003662 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003663 }
3664}
3665
Devang Patel930143b2009-11-21 02:48:08 +00003666/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling480ff322009-05-20 23:21:38 +00003667/// Section Header:
3668/// 1. length of section
3669/// 2. Dwarf version number
3670/// 3. address size.
3671///
3672/// Entries (one "entry" for each function that was inlined):
3673///
3674/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3675/// otherwise offset into __debug_str for regular function name.
3676/// 2. offset into __debug_str section for regular function name.
3677/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3678/// instances for the function.
3679///
3680/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3681/// inlined instance; the die_offset points to the inlined_subroutine die in the
3682/// __debug_info section, and the low_pc is the starting address for the
3683/// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00003684void DwarfDebug::emitDebugInlineInfo() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003685 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003686 return;
3687
Devang Patel1a0df9a2010-05-10 22:49:55 +00003688 if (!FirstCU)
Bill Wendling480ff322009-05-20 23:21:38 +00003689 return;
3690
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003691 Asm->OutStreamer.SwitchSection(
3692 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003693
Chris Lattner566cae92010-03-09 23:52:58 +00003694 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003695 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3696 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003697
Chris Lattnera179b522010-04-04 19:25:43 +00003698 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003699
Chris Lattner566cae92010-03-09 23:52:58 +00003700 Asm->OutStreamer.AddComment("Dwarf Version");
3701 Asm->EmitInt16(dwarf::DWARF_VERSION);
3702 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003703 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003704
Devang Patel32cc43c2010-05-07 20:54:48 +00003705 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003706 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00003707
Devang Patel32cc43c2010-05-07 20:54:48 +00003708 const MDNode *Node = *I;
3709 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00003710 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003711 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00003712 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00003713 StringRef LName = SP.getLinkageName();
3714 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00003715
Chris Lattner566cae92010-03-09 23:52:58 +00003716 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003717 if (LName.empty()) {
3718 Asm->OutStreamer.EmitBytes(Name, 0);
3719 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003720 } else
Chris Lattner70a4fce2010-04-04 23:25:33 +00003721 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3722 DwarfStrSectionSym);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003723
Chris Lattner566cae92010-03-09 23:52:58 +00003724 Asm->OutStreamer.AddComment("Function name");
Chris Lattner70a4fce2010-04-04 23:25:33 +00003725 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner9efd1182010-04-04 19:09:29 +00003726 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00003727
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003728 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00003729 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner7bde8c02010-04-04 18:52:31 +00003730 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner085b6522010-03-09 00:31:02 +00003731 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003732
Chris Lattner7bde8c02010-04-04 18:52:31 +00003733 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003734 Asm->OutStreamer.EmitSymbolValue(LI->first,
3735 Asm->getTargetData().getPointerSize(),0);
Bill Wendling480ff322009-05-20 23:21:38 +00003736 }
3737 }
3738
Chris Lattnera179b522010-04-04 19:25:43 +00003739 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003740}