blob: d055790609178ab24c98fc6de312fd00eed6803f [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"
David Greene829b3e82009-08-19 21:52:55 +000019#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000020#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000021#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000022#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000023#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000024#include "llvm/MC/MCSymbol.h"
Chris Lattnerf62e3ee2010-01-16 21:57:06 +000025#include "llvm/Target/Mangler.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000026#include "llvm/Target/TargetData.h"
Anton Korobeynikov2f931282011-01-10 12:39:04 +000027#include "llvm/Target/TargetFrameLowering.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000028#include "llvm/Target/TargetLoweringObjectFile.h"
Chris Lattner21dc46e2010-04-04 18:06:11 +000029#include "llvm/Target/TargetMachine.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000030#include "llvm/Target/TargetRegisterInfo.h"
Devang Patel61880932010-04-19 19:14:02 +000031#include "llvm/Target/TargetOptions.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000032#include "llvm/Analysis/DebugInfo.h"
Devang Patela86114b2010-10-25 20:45:32 +000033#include "llvm/ADT/Statistic.h"
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000034#include "llvm/ADT/STLExtras.h"
Chris Lattner06fa1762009-08-24 03:52:50 +000035#include "llvm/ADT/StringExtras.h"
Devang Patel6c74a872010-04-27 19:46:33 +000036#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000037#include "llvm/Support/Debug.h"
38#include "llvm/Support/ErrorHandling.h"
Devang Patel1973df22010-01-26 21:39:14 +000039#include "llvm/Support/ValueHandle.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000040#include "llvm/Support/FormattedStream.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000041#include "llvm/Support/Timer.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000042#include "llvm/Support/Path.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000043using namespace llvm;
44
Devang Patel6c74a872010-04-27 19:46:33 +000045static cl::opt<bool> PrintDbgScope("print-dbgscope", cl::Hidden,
46 cl::desc("Print DbgScope information for each machine instruction"));
47
Jim Grosbacha8683bb2010-07-21 21:21:52 +000048static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel30265c42010-07-07 20:12:52 +000049 cl::Hidden,
Devang Patel6c74a872010-04-27 19:46:33 +000050 cl::desc("Disable debug info printing"));
51
Dan Gohman7421ae42010-05-07 01:08:53 +000052static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
53 cl::desc("Make an absense of debug location information explicit."),
54 cl::init(false));
55
Nick Lewycky90b2ac22010-10-26 00:51:57 +000056#ifndef NDEBUG
Devang Patela86114b2010-10-25 20:45:32 +000057STATISTIC(BlocksWithoutLineNo, "Number of blocks without any line number");
Nick Lewycky90b2ac22010-10-26 00:51:57 +000058#endif
Devang Patela86114b2010-10-25 20:45:32 +000059
Bill Wendlingfcc14142010-04-07 09:28:04 +000060namespace {
61 const char *DWARFGroupName = "DWARF Emission";
62 const char *DbgTimerName = "DWARF Debug Writer";
63} // end anonymous namespace
64
Bill Wendling2f921f82009-05-15 09:23:25 +000065//===----------------------------------------------------------------------===//
66
67/// Configuration values for initial hash set sizes (log2).
68///
Bill Wendling2f921f82009-05-15 09:23:25 +000069static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +000070
71namespace llvm {
72
73//===----------------------------------------------------------------------===//
74/// CompileUnit - This dwarf writer support class manages information associate
75/// with a source file.
Nick Lewyckyb7993d62009-11-17 08:11:44 +000076class CompileUnit {
Bill Wendling2f921f82009-05-15 09:23:25 +000077 /// ID - File identifier for source.
78 ///
79 unsigned ID;
80
81 /// Die - Compile unit debug information entry.
82 ///
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000083 const OwningPtr<DIE> CUDie;
Bill Wendling2f921f82009-05-15 09:23:25 +000084
Jeffrey Yasskin0708de12010-03-11 18:29:55 +000085 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
Devang Patel92e8c652009-11-21 00:31:03 +000086 DIE *IndexTyDie;
87
Devang Patel9a0339f2010-07-07 20:49:57 +000088 /// MDNodeToDieMap - Tracks the mapping of unit level debug informaton
Bill Wendling2f921f82009-05-15 09:23:25 +000089 /// variables to debug information entries.
Devang Patel9a0339f2010-07-07 20:49:57 +000090 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
Bill Wendling2f921f82009-05-15 09:23:25 +000091
Devang Patel9a0339f2010-07-07 20:49:57 +000092 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug informaton
Bill Wendling2f921f82009-05-15 09:23:25 +000093 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patel9a0339f2010-07-07 20:49:57 +000094 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
Bill Wendling2f921f82009-05-15 09:23:25 +000095
96 /// Globals - A map of globally visible named entities for this unit.
97 ///
98 StringMap<DIE*> Globals;
99
Devang Patel04d2f2d2009-11-24 01:14:22 +0000100 /// GlobalTypes - A map of globally visible types for this unit.
101 ///
102 StringMap<DIE*> GlobalTypes;
103
Bill Wendling2f921f82009-05-15 09:23:25 +0000104public:
105 CompileUnit(unsigned I, DIE *D)
Devang Patel930143b2009-11-21 02:48:08 +0000106 : ID(I), CUDie(D), IndexTyDie(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000107
108 // Accessors.
Devang Patel04d2f2d2009-11-24 01:14:22 +0000109 unsigned getID() const { return ID; }
Jeffrey Yasskin0708de12010-03-11 18:29:55 +0000110 DIE* getCUDie() const { return CUDie.get(); }
Devang Patel04d2f2d2009-11-24 01:14:22 +0000111 const StringMap<DIE*> &getGlobals() const { return Globals; }
112 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000113
114 /// hasContent - Return true if this compile unit has something to write out.
115 ///
Devang Patel930143b2009-11-21 02:48:08 +0000116 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000117
Devang Patel930143b2009-11-21 02:48:08 +0000118 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +0000119 ///
Benjamin Kramer96956ed2010-03-31 20:15:45 +0000120 void addGlobal(StringRef Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000121
Devang Patel04d2f2d2009-11-24 01:14:22 +0000122 /// addGlobalType - Add a new global type to the compile unit.
123 ///
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000124 void addGlobalType(StringRef Name, DIE *Die) {
125 GlobalTypes[Name] = Die;
Devang Patel04d2f2d2009-11-24 01:14:22 +0000126 }
127
Devang Patele064ad42009-11-20 21:37:22 +0000128 /// getDIE - Returns the debug information entry map slot for the
Bill Wendling2f921f82009-05-15 09:23:25 +0000129 /// specified debug variable.
Devang Patel9a0339f2010-07-07 20:49:57 +0000130 DIE *getDIE(const MDNode *N) { return MDNodeToDieMap.lookup(N); }
Jim Grosbach042483e2009-11-21 23:12:12 +0000131
Devang Patele064ad42009-11-20 21:37:22 +0000132 /// insertDIE - Insert DIE into the map.
Devang Patel32cc43c2010-05-07 20:54:48 +0000133 void insertDIE(const MDNode *N, DIE *D) {
Devang Patel9a0339f2010-07-07 20:49:57 +0000134 MDNodeToDieMap.insert(std::make_pair(N, D));
Devang Patele064ad42009-11-20 21:37:22 +0000135 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000136
Devang Patele064ad42009-11-20 21:37:22 +0000137 /// getDIEEntry - Returns the debug information entry for the speciefied
138 /// debug variable.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000139 DIEEntry *getDIEEntry(const MDNode *N) {
140 DenseMap<const MDNode *, DIEEntry *>::iterator I =
141 MDNodeToDIEEntryMap.find(N);
Devang Patel9a0339f2010-07-07 20:49:57 +0000142 if (I == MDNodeToDIEEntryMap.end())
Devang Patel1f4690c2009-12-15 19:16:48 +0000143 return NULL;
144 return I->second;
145 }
Devang Patele064ad42009-11-20 21:37:22 +0000146
147 /// insertDIEEntry - Insert debug information entry into the map.
Devang Patel32cc43c2010-05-07 20:54:48 +0000148 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
Devang Patel9a0339f2010-07-07 20:49:57 +0000149 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
Bill Wendling2f921f82009-05-15 09:23:25 +0000150 }
151
Devang Patel930143b2009-11-21 02:48:08 +0000152 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +0000153 ///
Devang Patel930143b2009-11-21 02:48:08 +0000154 void addDie(DIE *Buffer) {
155 this->CUDie->addChild(Buffer);
Bill Wendling2f921f82009-05-15 09:23:25 +0000156 }
Devang Patel92e8c652009-11-21 00:31:03 +0000157
158 // getIndexTyDie - Get an anonymous type for index type.
159 DIE *getIndexTyDie() {
160 return IndexTyDie;
161 }
162
Jim Grosbach00e9c612009-11-22 19:20:36 +0000163 // setIndexTyDie - Set D as anonymous type for index which can be reused
164 // later.
Devang Patel92e8c652009-11-21 00:31:03 +0000165 void setIndexTyDie(DIE *D) {
166 IndexTyDie = D;
167 }
168
Bill Wendling2f921f82009-05-15 09:23:25 +0000169};
170
171//===----------------------------------------------------------------------===//
172/// DbgVariable - This class is used to track local variable information.
173///
Devang Patelf3d7c082009-11-16 21:53:40 +0000174class DbgVariable {
Bill Wendling2f921f82009-05-15 09:23:25 +0000175 DIVariable Var; // Variable Descriptor.
Devang Patel9fc11702010-05-25 23:40:22 +0000176 DIE *TheDIE; // Variable DIE.
177 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
Bill Wendling2f921f82009-05-15 09:23:25 +0000178public:
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000179 // AbsVar may be NULL.
Devang Patel9fc11702010-05-25 23:40:22 +0000180 DbgVariable(DIVariable V) : Var(V), TheDIE(0), DotDebugLocOffset(~0U) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000181
182 // Accessors.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000183 DIVariable getVariable() const { return Var; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000184 void setDIE(DIE *D) { TheDIE = D; }
185 DIE *getDIE() const { return TheDIE; }
Devang Patel9fc11702010-05-25 23:40:22 +0000186 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
187 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000188 StringRef getName() const { return Var.getName(); }
189 unsigned getTag() const { return Var.getTag(); }
190 bool variableHasComplexAddress() const {
191 assert(Var.Verify() && "Invalid complex DbgVariable!");
192 return Var.hasComplexAddress();
193 }
194 bool isBlockByrefVariable() const {
195 assert(Var.Verify() && "Invalid complex DbgVariable!");
196 return Var.isBlockByrefVariable();
197 }
198 unsigned getNumAddrElements() const {
199 assert(Var.Verify() && "Invalid complex DbgVariable!");
200 return Var.getNumAddrElements();
201 }
202 uint64_t getAddrElement(unsigned i) const {
203 return Var.getAddrElement(i);
204 }
205 DIType getType() const {
206 DIType Ty = Var.getType();
207 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
208 // addresses instead.
209 if (Var.isBlockByrefVariable()) {
210 /* Byref variables, in Blocks, are declared by the programmer as
211 "SomeType VarName;", but the compiler creates a
212 __Block_byref_x_VarName struct, and gives the variable VarName
213 either the struct, or a pointer to the struct, as its type. This
214 is necessary for various behind-the-scenes things the compiler
215 needs to do with by-reference variables in blocks.
216
217 However, as far as the original *programmer* is concerned, the
218 variable should still have type 'SomeType', as originally declared.
219
220 The following function dives into the __Block_byref_x_VarName
221 struct to find the original type of the variable. This will be
222 passed back to the code generating the type for the Debug
223 Information Entry for the variable 'VarName'. 'VarName' will then
224 have the original type 'SomeType' in its debug information.
225
226 The original type 'SomeType' will be the type of the field named
227 'VarName' inside the __Block_byref_x_VarName struct.
228
229 NOTE: In order for this to not completely fail on the debugger
230 side, the Debug Information Entry for the variable VarName needs to
231 have a DW_AT_location that tells the debugger how to unwind through
232 the pointers and __Block_byref_x_VarName struct to find the actual
233 value of the variable. The function addBlockByrefType does this. */
234 DIType subType = Ty;
235 unsigned tag = Ty.getTag();
236
237 if (tag == dwarf::DW_TAG_pointer_type) {
238 DIDerivedType DTy = DIDerivedType(Ty);
239 subType = DTy.getTypeDerivedFrom();
240 }
241
242 DICompositeType blockStruct = DICompositeType(subType);
243 DIArray Elements = blockStruct.getTypeArray();
244
245 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
246 DIDescriptor Element = Elements.getElement(i);
247 DIDerivedType DT = DIDerivedType(Element);
248 if (getName() == DT.getName())
249 return (DT.getTypeDerivedFrom());
250 }
251 return Ty;
252 }
253 return Ty;
254 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000255};
256
257//===----------------------------------------------------------------------===//
Devang Patel6c74a872010-04-27 19:46:33 +0000258/// DbgRange - This is used to track range of instructions with identical
259/// debug info scope.
260///
261typedef std::pair<const MachineInstr *, const MachineInstr *> DbgRange;
262
263//===----------------------------------------------------------------------===//
Bill Wendling2f921f82009-05-15 09:23:25 +0000264/// DbgScope - This class is used to track scope information.
265///
Devang Patelf3d7c082009-11-16 21:53:40 +0000266class DbgScope {
Bill Wendling2f921f82009-05-15 09:23:25 +0000267 DbgScope *Parent; // Parent to this scope.
Jim Grosbach042483e2009-11-21 23:12:12 +0000268 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel1973df22010-01-26 21:39:14 +0000269 // Location at which this scope is inlined.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000270 AssertingVH<const MDNode> InlinedAtLocation;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000271 bool AbstractScope; // Abstract Scope
Devang Patel787f94c2009-10-01 18:25:23 +0000272 const MachineInstr *LastInsn; // Last instruction of this scope.
273 const MachineInstr *FirstInsn; // First instruction of this scope.
Devang Patel6c74a872010-04-27 19:46:33 +0000274 unsigned DFSIn, DFSOut;
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000275 // Scopes defined in scope. Contents not owned.
276 SmallVector<DbgScope *, 4> Scopes;
277 // Variables declared in scope. Contents owned.
278 SmallVector<DbgVariable *, 8> Variables;
Devang Patel6c74a872010-04-27 19:46:33 +0000279 SmallVector<DbgRange, 4> Ranges;
Owen Anderson9becc182009-06-24 22:53:20 +0000280 // Private state for dump()
281 mutable unsigned IndentLevel;
Bill Wendling2f921f82009-05-15 09:23:25 +0000282public:
Devang Patel32cc43c2010-05-07 20:54:48 +0000283 DbgScope(DbgScope *P, DIDescriptor D, const MDNode *I = 0)
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000284 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Devang Patel6c74a872010-04-27 19:46:33 +0000285 LastInsn(0), FirstInsn(0),
286 DFSIn(0), DFSOut(0), IndentLevel(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000287 virtual ~DbgScope();
288
289 // Accessors.
290 DbgScope *getParent() const { return Parent; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000291 void setParent(DbgScope *P) { Parent = P; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000292 DIDescriptor getDesc() const { return Desc; }
Devang Patel32cc43c2010-05-07 20:54:48 +0000293 const MDNode *getInlinedAt() const { return InlinedAtLocation; }
294 const MDNode *getScopeNode() const { return Desc; }
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000295 const SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
Devang Patel406798a2010-08-09 18:51:29 +0000296 const SmallVector<DbgVariable *, 8> &getDbgVariables() { return Variables; }
Devang Patel6c74a872010-04-27 19:46:33 +0000297 const SmallVector<DbgRange, 4> &getRanges() { return Ranges; }
298
299 /// openInsnRange - This scope covers instruction range starting from MI.
300 void openInsnRange(const MachineInstr *MI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000301 if (!FirstInsn)
Devang Patel6c74a872010-04-27 19:46:33 +0000302 FirstInsn = MI;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000303
Devang Patel6c74a872010-04-27 19:46:33 +0000304 if (Parent)
305 Parent->openInsnRange(MI);
306 }
307
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000308 /// extendInsnRange - Extend the current instruction range covered by
Devang Patel6c74a872010-04-27 19:46:33 +0000309 /// this scope.
310 void extendInsnRange(const MachineInstr *MI) {
311 assert (FirstInsn && "MI Range is not open!");
312 LastInsn = MI;
313 if (Parent)
314 Parent->extendInsnRange(MI);
315 }
316
317 /// closeInsnRange - Create a range based on FirstInsn and LastInsn collected
318 /// until now. This is used when a new scope is encountered while walking
319 /// machine instructions.
320 void closeInsnRange(DbgScope *NewScope = NULL) {
321 assert (LastInsn && "Last insn missing!");
322 Ranges.push_back(DbgRange(FirstInsn, LastInsn));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000323 FirstInsn = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +0000324 LastInsn = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000325 // If Parent dominates NewScope then do not close Parent's instruction
Devang Patel6c74a872010-04-27 19:46:33 +0000326 // range.
327 if (Parent && (!NewScope || !Parent->dominates(NewScope)))
328 Parent->closeInsnRange(NewScope);
329 }
330
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000331 void setAbstractScope() { AbstractScope = true; }
332 bool isAbstractScope() const { return AbstractScope; }
Devang Patel6c74a872010-04-27 19:46:33 +0000333
334 // Depth First Search support to walk and mainpluate DbgScope hierarchy.
335 unsigned getDFSOut() const { return DFSOut; }
336 void setDFSOut(unsigned O) { DFSOut = O; }
337 unsigned getDFSIn() const { return DFSIn; }
338 void setDFSIn(unsigned I) { DFSIn = I; }
339 bool dominates(const DbgScope *S) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000340 if (S == this)
Devang Patel6c74a872010-04-27 19:46:33 +0000341 return true;
342 if (DFSIn < S->getDFSIn() && DFSOut > S->getDFSOut())
343 return true;
344 return false;
345 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000346
Devang Patel930143b2009-11-21 02:48:08 +0000347 /// addScope - Add a scope to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000348 ///
Devang Patel930143b2009-11-21 02:48:08 +0000349 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000350
Devang Patel930143b2009-11-21 02:48:08 +0000351 /// addVariable - Add a variable to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000352 ///
Devang Patel930143b2009-11-21 02:48:08 +0000353 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000354
Bill Wendling2f921f82009-05-15 09:23:25 +0000355#ifndef NDEBUG
356 void dump() const;
357#endif
358};
Devang Patel6c74a872010-04-27 19:46:33 +0000359
Chris Lattnerf5d06362010-04-05 04:09:20 +0000360} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000361
362#ifndef NDEBUG
363void DbgScope::dump() const {
David Greenec230cb92009-12-24 00:31:35 +0000364 raw_ostream &err = dbgs();
Chris Lattner81e8e022009-08-23 00:51:00 +0000365 err.indent(IndentLevel);
Devang Patel32cc43c2010-05-07 20:54:48 +0000366 const MDNode *N = Desc;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000367 N->dump();
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000368 if (AbstractScope)
369 err << "Abstract Scope\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000370
371 IndentLevel += 2;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000372 if (!Scopes.empty())
373 err << "Children ...\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000374 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
375 if (Scopes[i] != this)
376 Scopes[i]->dump();
377
378 IndentLevel -= 2;
379}
380#endif
381
Bill Wendling2f921f82009-05-15 09:23:25 +0000382DbgScope::~DbgScope() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000383 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
384 delete Variables[j];
Bill Wendling2f921f82009-05-15 09:23:25 +0000385}
386
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000387DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Devang Patel1a0df9a2010-05-10 22:49:55 +0000388 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000389 AbbreviationsSet(InitAbbreviationsSetSize),
Devang Patel12563b32010-04-16 23:33:45 +0000390 CurrentFnDbgScope(0), PrevLabel(NULL) {
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000391 NextStringPoolNumber = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000392
Chris Lattnere58b5472010-04-04 23:10:38 +0000393 DwarfFrameSectionSym = DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
394 DwarfStrSectionSym = TextSectionSym = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000395 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000396 FunctionBeginSym = FunctionEndSym = 0;
Devang Patel9c160e12010-07-08 20:10:35 +0000397 DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
Dan Gohman6e681a52010-06-18 15:56:31 +0000398 {
399 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
400 beginModule(M);
Torok Edwinf8dba242010-04-07 10:44:46 +0000401 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000402}
403DwarfDebug::~DwarfDebug() {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000404 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
405 DIEBlocks[j]->~DIEBlock();
Bill Wendling2f921f82009-05-15 09:23:25 +0000406}
407
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000408MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
409 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
410 if (Entry.first) return Entry.first;
411
412 Entry.second = NextStringPoolNumber++;
Chris Lattnera179b522010-04-04 19:25:43 +0000413 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000414}
415
416
Devang Patel930143b2009-11-21 02:48:08 +0000417/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling2f921f82009-05-15 09:23:25 +0000418///
Devang Patel930143b2009-11-21 02:48:08 +0000419void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000420 // Profile the node so that we can make it unique.
421 FoldingSetNodeID ID;
422 Abbrev.Profile(ID);
423
424 // Check the set for priors.
425 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
426
427 // If it's newly added.
428 if (InSet == &Abbrev) {
429 // Add to abbreviation list.
430 Abbreviations.push_back(&Abbrev);
431
432 // Assign the vector position + 1 as its number.
433 Abbrev.setNumber(Abbreviations.size());
434 } else {
435 // Assign existing abbreviation number.
436 Abbrev.setNumber(InSet->getNumber());
437 }
438}
439
Devang Patel930143b2009-11-21 02:48:08 +0000440/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendlingbcad77a2009-05-20 23:24:48 +0000441/// information entry.
Devang Patel930143b2009-11-21 02:48:08 +0000442DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000443 DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000444 return Value;
445}
446
Devang Patel930143b2009-11-21 02:48:08 +0000447/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000448///
Devang Patel930143b2009-11-21 02:48:08 +0000449void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000450 unsigned Form, uint64_t Integer) {
451 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000452 DIEValue *Value = Integer == 1 ?
Devang Patel9c160e12010-07-08 20:10:35 +0000453 DIEIntegerOne : new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000454 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000455}
456
Devang Patel930143b2009-11-21 02:48:08 +0000457/// addSInt - Add an signed integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000458///
Devang Patel930143b2009-11-21 02:48:08 +0000459void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000460 unsigned Form, int64_t Integer) {
461 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000462 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000463 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000464}
465
Devang Patel8c339592009-12-02 15:25:16 +0000466/// addString - Add a string attribute data and value. DIEString only
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000467/// keeps string reference.
Devang Patel930143b2009-11-21 02:48:08 +0000468void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerc3f23b82010-01-23 03:11:46 +0000469 StringRef String) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000470 DIEValue *Value = new (DIEValueAllocator) DIEString(String);
Devang Patel930143b2009-11-21 02:48:08 +0000471 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000472}
473
Devang Patel930143b2009-11-21 02:48:08 +0000474/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000475///
Devang Patel930143b2009-11-21 02:48:08 +0000476void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000477 const MCSymbol *Label) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000478 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
Devang Patel930143b2009-11-21 02:48:08 +0000479 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000480}
481
Devang Patel930143b2009-11-21 02:48:08 +0000482/// addDelta - Add a label delta attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000483///
Devang Patel930143b2009-11-21 02:48:08 +0000484void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000485 const MCSymbol *Hi, const MCSymbol *Lo) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000486 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
Devang Patel930143b2009-11-21 02:48:08 +0000487 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000488}
489
Chris Lattner3f3fb972010-04-05 05:24:55 +0000490/// addDIEEntry - Add a DIE attribute data and value.
491///
492void DwarfDebug::addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form,
493 DIE *Entry) {
494 Die->addValue(Attribute, Form, createDIEEntry(Entry));
495}
496
497
Devang Patel930143b2009-11-21 02:48:08 +0000498/// addBlock - Add block data.
Bill Wendling2f921f82009-05-15 09:23:25 +0000499///
Devang Patel930143b2009-11-21 02:48:08 +0000500void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling2f921f82009-05-15 09:23:25 +0000501 DIEBlock *Block) {
Chris Lattner5a00dea2010-04-05 00:18:22 +0000502 Block->ComputeSize(Asm);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000503 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
Devang Patel930143b2009-11-21 02:48:08 +0000504 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000505}
506
Devang Patel930143b2009-11-21 02:48:08 +0000507/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000508/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000509void DwarfDebug::addSourceLine(DIE *Die, DIVariable V) {
Devang Patel0625af22010-05-07 23:33:41 +0000510 // Verify variable.
Devang Patelb6511a32010-08-09 20:20:05 +0000511 if (!V.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000512 return;
513
Devang Patelb6511a32010-08-09 20:20:05 +0000514 unsigned Line = V.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000515 if (Line == 0)
516 return;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000517 unsigned FileID = GetOrCreateSourceID(V.getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000518 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000519 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
520 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000521}
522
Devang Patel930143b2009-11-21 02:48:08 +0000523/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000524/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000525void DwarfDebug::addSourceLine(DIE *Die, DIGlobalVariable G) {
Devang Patel0625af22010-05-07 23:33:41 +0000526 // Verify global variable.
Devang Patelb6511a32010-08-09 20:20:05 +0000527 if (!G.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000528 return;
529
Devang Patelb6511a32010-08-09 20:20:05 +0000530 unsigned Line = G.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000531 if (Line == 0)
532 return;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000533 unsigned FileID = GetOrCreateSourceID(G.getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000534 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000535 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
536 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000537}
Devang Patelb2de5fa2009-08-31 22:47:13 +0000538
Devang Patel930143b2009-11-21 02:48:08 +0000539/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000540/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000541void DwarfDebug::addSourceLine(DIE *Die, DISubprogram SP) {
Devang Patel0625af22010-05-07 23:33:41 +0000542 // Verify subprogram.
Devang Patelb6511a32010-08-09 20:20:05 +0000543 if (!SP.Verify())
Devang Patelb2de5fa2009-08-31 22:47:13 +0000544 return;
Caroline Tice183a5192009-09-11 18:25:54 +0000545 // If the line number is 0, don't add it.
Devang Patelb6511a32010-08-09 20:20:05 +0000546 if (SP.getLineNumber() == 0)
Caroline Tice183a5192009-09-11 18:25:54 +0000547 return;
548
Devang Patelb6511a32010-08-09 20:20:05 +0000549 unsigned Line = SP.getLineNumber();
550 if (!SP.getContext().Verify())
Devang Patel8119fe872010-03-08 22:02:50 +0000551 return;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000552 unsigned FileID = GetOrCreateSourceID(SP.getFilename());
Devang Patelb2de5fa2009-08-31 22:47:13 +0000553 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000554 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
555 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patelb2de5fa2009-08-31 22:47:13 +0000556}
557
Devang Patel930143b2009-11-21 02:48:08 +0000558/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000559/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000560void DwarfDebug::addSourceLine(DIE *Die, DIType Ty) {
Devang Patel0625af22010-05-07 23:33:41 +0000561 // Verify type.
Devang Patelb6511a32010-08-09 20:20:05 +0000562 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000563 return;
564
Devang Patelb6511a32010-08-09 20:20:05 +0000565 unsigned Line = Ty.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000566 if (Line == 0 || !Ty.getContext().Verify())
Devang Patel8119fe872010-03-08 22:02:50 +0000567 return;
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000568 unsigned FileID = GetOrCreateSourceID(Ty.getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000569 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000570 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
571 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000572}
573
Devang Patel1f4690c2009-12-15 19:16:48 +0000574/// addSourceLine - Add location information to specified debug information
575/// entry.
Devang Patelb1e07b32010-08-10 04:09:06 +0000576void DwarfDebug::addSourceLine(DIE *Die, DINameSpace NS) {
Devang Patel0625af22010-05-07 23:33:41 +0000577 // Verify namespace.
Devang Patelb6511a32010-08-09 20:20:05 +0000578 if (!NS.Verify())
Devang Patel1f4690c2009-12-15 19:16:48 +0000579 return;
580
Devang Patelb6511a32010-08-09 20:20:05 +0000581 unsigned Line = NS.getLineNumber();
Devang Pateldd1c2892010-10-08 17:18:54 +0000582 if (Line == 0)
583 return;
Devang Patelb6511a32010-08-09 20:20:05 +0000584 StringRef FN = NS.getFilename();
Devang Patel1f4690c2009-12-15 19:16:48 +0000585
Rafael Espindola67c6ab82010-11-18 02:04:25 +0000586 unsigned FileID = GetOrCreateSourceID(FN);
Devang Patel1f4690c2009-12-15 19:16:48 +0000587 assert(FileID && "Invalid file id");
588 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
589 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
590}
591
Devang Patel2cfc3af2010-08-31 06:11:28 +0000592/// addVariableAddress - Add DW_AT_location attribute for a DbgVariable based
593/// on provided frame index.
594void DwarfDebug::addVariableAddress(DbgVariable *&DV, DIE *Die, int64_t FI) {
595 MachineLocation Location;
596 unsigned FrameReg;
Anton Korobeynikov2f931282011-01-10 12:39:04 +0000597 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
Anton Korobeynikov46877782010-11-20 15:59:32 +0000598 int Offset = TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
Devang Patel2cfc3af2010-08-31 06:11:28 +0000599 Location.set(FrameReg, Offset);
600
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000601 if (DV->variableHasComplexAddress())
602 addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
603 else if (DV->isBlockByrefVariable())
604 addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
605 else
606 addAddress(Die, dwarf::DW_AT_location, Location);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000607}
608
Devang Patel930143b2009-11-21 02:48:08 +0000609/// addComplexAddress - Start with the address based on the location provided,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000610/// and generate the DWARF information necessary to find the actual variable
611/// given the extra address information encoded in the DIVariable, starting from
612/// the starting location. Add the DWARF information to the die.
613///
Devang Patel930143b2009-11-21 02:48:08 +0000614void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000615 unsigned Attribute,
616 const MachineLocation &Location) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +0000617 DIType Ty = DV->getType();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000618
619 // Decode the original location, and use that as the start of the byref
620 // variable's location.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000621 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000622 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000623 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000624
625 if (Location.isReg()) {
626 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000627 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000628 } else {
629 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel930143b2009-11-21 02:48:08 +0000630 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
631 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 {
769 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel930143b2009-11-21 02:48:08 +0000770 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
771 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000772 }
773 } else {
774 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000775 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000776 else {
Devang Patel930143b2009-11-21 02:48:08 +0000777 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
778 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000779 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000780
Devang Patel930143b2009-11-21 02:48:08 +0000781 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000782 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000783
Mike Stump944fa252009-09-24 23:21:26 +0000784 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000785 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000786 if (isPointer)
Devang Patel930143b2009-11-21 02:48:08 +0000787 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000788
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000789 // Next add the offset for the '__forwarding' field:
790 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
791 // adding the offset if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000792 if (forwardingFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000793 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
794 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000795 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000796
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000797 // Now dereference the __forwarding field to get to the real __Block_byref
798 // struct: DW_OP_deref.
Devang Patel930143b2009-11-21 02:48:08 +0000799 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000800
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000801 // Now that we've got the real __Block_byref... struct, add the offset
802 // for the variable's field to get to the location of the actual variable:
803 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000804 if (varFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000805 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
806 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000807 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000808
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000809 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000810 addBlock(Die, Attribute, 0, Block);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000811}
812
Devang Patel930143b2009-11-21 02:48:08 +0000813/// addAddress - Add an address attribute to a die based on the location
Bill Wendling2f921f82009-05-15 09:23:25 +0000814/// provided.
Devang Patel930143b2009-11-21 02:48:08 +0000815void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000816 const MachineLocation &Location) {
Chris Lattner3a383cb2010-04-05 00:13:49 +0000817 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling2f921f82009-05-15 09:23:25 +0000818 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000819 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel804fcd42010-09-22 21:10:38 +0000820
Devang Patele7559662010-11-02 17:37:00 +0000821 if (RI->getFrameRegister(*Asm->MF) == Location.getReg()
Devang Patel804fcd42010-09-22 21:10:38 +0000822 && Location.getOffset()) {
823 // If variable offset is based in frame register then use fbreg.
824 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
825 addSInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
826 addBlock(Die, Attribute, 0, Block);
827 return;
828 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000829
830 if (Location.isReg()) {
831 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000832 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000833 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000834 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
835 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000836 }
837 } else {
838 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000839 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000840 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000841 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
842 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000843 }
844
Devang Patel930143b2009-11-21 02:48:08 +0000845 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling2f921f82009-05-15 09:23:25 +0000846 }
847
Devang Patel930143b2009-11-21 02:48:08 +0000848 addBlock(Die, Attribute, 0, Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000849}
850
Devang Patel173b2b92010-04-28 01:03:09 +0000851/// addRegisterAddress - Add register location entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000852bool DwarfDebug::addRegisterAddress(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000853 assert (MO.isReg() && "Invalid machine operand!");
854 if (!MO.getReg())
855 return false;
856 MachineLocation Location;
857 Location.set(MO.getReg());
858 addAddress(Die, dwarf::DW_AT_location, Location);
Devang Patel173b2b92010-04-28 01:03:09 +0000859 return true;
860}
861
862/// addConstantValue - Add constant value entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000863bool DwarfDebug::addConstantValue(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000864 assert (MO.isImm() && "Invalid machine operand!");
865 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
866 unsigned Imm = MO.getImm();
867 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
868 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patel173b2b92010-04-28 01:03:09 +0000869 return true;
870}
871
872/// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patel53a40df62010-11-12 23:20:42 +0000873bool DwarfDebug::addConstantFPValue(DIE *Die, const MachineOperand &MO) {
Devang Patel173b2b92010-04-28 01:03:09 +0000874 assert (MO.isFPImm() && "Invalid machine operand!");
875 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
876 APFloat FPImm = MO.getFPImm()->getValueAPF();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000877
Devang Patel173b2b92010-04-28 01:03:09 +0000878 // Get the raw data form of the floating point.
879 const APInt FltVal = FPImm.bitcastToAPInt();
880 const char *FltPtr = (const char*)FltVal.getRawData();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000881
Devang Patel173b2b92010-04-28 01:03:09 +0000882 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
883 bool LittleEndian = Asm->getTargetData().isLittleEndian();
884 int Incr = (LittleEndian ? 1 : -1);
885 int Start = (LittleEndian ? 0 : NumBytes - 1);
886 int Stop = (LittleEndian ? NumBytes : -1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000887
Devang Patel173b2b92010-04-28 01:03:09 +0000888 // Output the constant to DWARF one byte at a time.
889 for (; Start != Stop; Start += Incr)
890 addUInt(Block, 0, dwarf::DW_FORM_data1,
891 (unsigned char)0xFF & FltPtr[Start]);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000892
Devang Patel173b2b92010-04-28 01:03:09 +0000893 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000894 return true;
Devang Patel173b2b92010-04-28 01:03:09 +0000895}
896
Devang Patel70eb9822011-01-06 21:39:25 +0000897/// addConstantValue - Add constant value entry in variable DIE.
898bool DwarfDebug::addConstantValue(DIE *Die, ConstantInt *CI,
899 bool Unsigned) {
900 if (CI->getBitWidth() <= 64) {
901 if (Unsigned)
902 addUInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
903 CI->getZExtValue());
904 else
905 addSInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
906 CI->getSExtValue());
907 return true;
908 }
909
910 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
911
912 // Get the raw data form of the large APInt.
913 const APInt Val = CI->getValue();
914 const char *Ptr = (const char*)Val.getRawData();
915
916 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
917 bool LittleEndian = Asm->getTargetData().isLittleEndian();
918 int Incr = (LittleEndian ? 1 : -1);
919 int Start = (LittleEndian ? 0 : NumBytes - 1);
920 int Stop = (LittleEndian ? NumBytes : -1);
921
922 // Output the constant to DWARF one byte at a time.
923 for (; Start != Stop; Start += Incr)
924 addUInt(Block, 0, dwarf::DW_FORM_data1,
925 (unsigned char)0xFF & Ptr[Start]);
926
927 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
928 return true;
929}
Devang Patel173b2b92010-04-28 01:03:09 +0000930
Devang Patel2b75ed22009-12-10 19:14:49 +0000931/// addToContextOwner - Add Die into the list of its context owner's children.
932void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000933 if (Context.isType()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000934 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
Devang Patel2b75ed22009-12-10 19:14:49 +0000935 ContextDIE->addChild(Die);
Devang Patel1f4690c2009-12-15 19:16:48 +0000936 } else if (Context.isNameSpace()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000937 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
Devang Patel1f4690c2009-12-15 19:16:48 +0000938 ContextDIE->addChild(Die);
Stuart Hastingsafe54f12010-06-11 20:08:44 +0000939 } else if (Context.isSubprogram()) {
Devang Patel185051c2010-09-27 23:15:27 +0000940 DIE *ContextDIE = createSubprogramDIE(DISubprogram(Context));
Stuart Hastingsafe54f12010-06-11 20:08:44 +0000941 ContextDIE->addChild(Die);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000942 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patel2b75ed22009-12-10 19:14:49 +0000943 ContextDIE->addChild(Die);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000944 else
Devang Patel1a0df9a2010-05-10 22:49:55 +0000945 getCompileUnit(Context)->addDie(Die);
Devang Patel2b75ed22009-12-10 19:14:49 +0000946}
947
Devang Patelb5b60ea2009-12-10 18:05:33 +0000948/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
949/// given DIType.
950DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000951 CompileUnit *TypeCU = getCompileUnit(Ty);
952 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000953 if (TyDIE)
954 return TyDIE;
955
956 // Create new type.
957 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000958 TypeCU->insertDIE(Ty, TyDIE);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000959 if (Ty.isBasicType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000960 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000961 else if (Ty.isCompositeType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000962 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000963 else {
964 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000965 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000966 }
967
Devang Patel2b75ed22009-12-10 19:14:49 +0000968 addToContextOwner(TyDIE, Ty.getContext());
Devang Patelb5b60ea2009-12-10 18:05:33 +0000969 return TyDIE;
970}
971
Devang Patel930143b2009-11-21 02:48:08 +0000972/// addType - Add a new type attribute to the specified entity.
Devang Patel9ccfb642009-12-09 18:24:21 +0000973void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel8d6a2b72010-05-07 21:45:47 +0000974 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000975 return;
976
977 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000978 CompileUnit *TypeCU = getCompileUnit(Ty);
979 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000980 // If it exists then use the existing value.
Devang Patel930143b2009-11-21 02:48:08 +0000981 if (Entry) {
982 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000983 return;
984 }
985
Bill Wendling2f921f82009-05-15 09:23:25 +0000986 // Construct type.
Devang Patelb5b60ea2009-12-10 18:05:33 +0000987 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000988
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000989 // Set up proxy.
990 Entry = createDIEEntry(Buffer);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000991 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000992
Devang Patel930143b2009-11-21 02:48:08 +0000993 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000994}
995
Devang Patel930143b2009-11-21 02:48:08 +0000996/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000997void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000998 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000999 StringRef Name = BTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001000 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +00001001 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling2f921f82009-05-15 09:23:25 +00001002 BTy.getEncoding());
1003
1004 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +00001005 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001006 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001007 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel930143b2009-11-21 02:48:08 +00001008 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001009}
1010
Devang Patel930143b2009-11-21 02:48:08 +00001011/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001012void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001013 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +00001014 StringRef Name = DTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001015 uint64_t Size = DTy.getSizeInBits() >> 3;
1016 unsigned Tag = DTy.getTag();
1017
1018 // FIXME - Workaround for templates.
1019 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
1020
1021 Buffer.setTag(Tag);
1022
1023 // Map to main type, void will not have a type.
1024 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel9ccfb642009-12-09 18:24:21 +00001025 addType(&Buffer, FromTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001026
1027 // Add name if not anonymous or intermediate type.
Devang Patelae466ef2009-11-30 23:56:56 +00001028 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001029 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001030
1031 // Add size if non-zero (derived types might be zero-sized.)
1032 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +00001033 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001034
1035 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patelb5b51592009-11-23 18:43:37 +00001036 if (!DTy.isForwardDecl())
Devang Patelb6511a32010-08-09 20:20:05 +00001037 addSourceLine(&Buffer, DTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001038}
1039
Devang Patel930143b2009-11-21 02:48:08 +00001040/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001041void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001042 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +00001043 StringRef Name = CTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +00001044
1045 uint64_t Size = CTy.getSizeInBits() >> 3;
1046 unsigned Tag = CTy.getTag();
1047 Buffer.setTag(Tag);
1048
1049 switch (Tag) {
1050 case dwarf::DW_TAG_vector_type:
1051 case dwarf::DW_TAG_array_type:
Devang Patel9ccfb642009-12-09 18:24:21 +00001052 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001053 break;
1054 case dwarf::DW_TAG_enumeration_type: {
1055 DIArray Elements = CTy.getTypeArray();
1056
1057 // Add enumerators to enumeration type.
1058 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1059 DIE *ElemDie = NULL;
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001060 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3b548aa2010-03-08 20:52:55 +00001061 if (Enum.isEnumerator()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001062 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel930143b2009-11-21 02:48:08 +00001063 Buffer.addChild(ElemDie);
Devang Patelfafa1fe2009-10-09 17:51:49 +00001064 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001065 }
1066 }
1067 break;
1068 case dwarf::DW_TAG_subroutine_type: {
1069 // Add return type.
1070 DIArray Elements = CTy.getTypeArray();
1071 DIDescriptor RTy = Elements.getElement(0);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001072 addType(&Buffer, DIType(RTy));
Bill Wendling2f921f82009-05-15 09:23:25 +00001073
Devang Patel9a33ec22010-10-06 20:50:40 +00001074 bool isPrototyped = true;
Bill Wendling2f921f82009-05-15 09:23:25 +00001075 // Add arguments.
1076 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001077 DIDescriptor Ty = Elements.getElement(i);
Devang Patel9a33ec22010-10-06 20:50:40 +00001078 if (Ty.isUnspecifiedParameter()) {
1079 DIE *Arg = new DIE(dwarf::DW_TAG_unspecified_parameters);
1080 Buffer.addChild(Arg);
1081 isPrototyped = false;
1082 } else {
1083 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1084 addType(Arg, DIType(Ty));
1085 Buffer.addChild(Arg);
1086 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001087 }
Devang Patel9a33ec22010-10-06 20:50:40 +00001088 // Add prototype flag.
1089 if (isPrototyped)
1090 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001091 }
1092 break;
1093 case dwarf::DW_TAG_structure_type:
1094 case dwarf::DW_TAG_union_type:
1095 case dwarf::DW_TAG_class_type: {
1096 // Add elements to structure type.
1097 DIArray Elements = CTy.getTypeArray();
1098
1099 // A forward struct declared type may not have elements available.
Devang Patel3b548aa2010-03-08 20:52:55 +00001100 unsigned N = Elements.getNumElements();
1101 if (N == 0)
Bill Wendling2f921f82009-05-15 09:23:25 +00001102 break;
1103
1104 // Add elements to structure type.
Devang Patel3b548aa2010-03-08 20:52:55 +00001105 for (unsigned i = 0; i < N; ++i) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001106 DIDescriptor Element = Elements.getElement(i);
1107 DIE *ElemDie = NULL;
Devang Patelcb03b142010-09-29 21:44:16 +00001108 if (Element.isSubprogram()) {
1109 DISubprogram SP(Element);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001110 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patelcb03b142010-09-29 21:44:16 +00001111 if (SP.isProtected())
1112 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1113 dwarf::DW_ACCESS_protected);
1114 else if (SP.isPrivate())
1115 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1116 dwarf::DW_ACCESS_private);
1117 else
1118 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1119 dwarf::DW_ACCESS_public);
Devang Patele1c71462010-10-01 23:31:40 +00001120 if (SP.isExplicit())
1121 addUInt(ElemDie, dwarf::DW_AT_explicit, dwarf::DW_FORM_flag, 1);
Devang Patelcb03b142010-09-29 21:44:16 +00001122 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001123 else if (Element.isVariable()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001124 DIVariable DV(Element);
Devang Patel160c92d2010-01-30 01:08:30 +00001125 ElemDie = new DIE(dwarf::DW_TAG_variable);
1126 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1127 DV.getName());
1128 addType(ElemDie, DV.getType());
1129 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1130 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patelb6511a32010-08-09 20:20:05 +00001131 addSourceLine(ElemDie, DV);
Devang Patel3b548aa2010-03-08 20:52:55 +00001132 } else if (Element.isDerivedType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001133 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3b548aa2010-03-08 20:52:55 +00001134 else
1135 continue;
Devang Patel930143b2009-11-21 02:48:08 +00001136 Buffer.addChild(ElemDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001137 }
1138
Devang Patel3082c012009-08-27 23:51:51 +00001139 if (CTy.isAppleBlockExtension())
Devang Patel930143b2009-11-21 02:48:08 +00001140 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001141
1142 unsigned RLang = CTy.getRunTimeLang();
1143 if (RLang)
Devang Patel930143b2009-11-21 02:48:08 +00001144 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling2f921f82009-05-15 09:23:25 +00001145 dwarf::DW_FORM_data1, RLang);
Devang Patel303a1be2010-01-26 21:16:06 +00001146
1147 DICompositeType ContainingType = CTy.getContainingType();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001148 if (DIDescriptor(ContainingType).isCompositeType())
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001149 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001150 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001151 else {
1152 DIDescriptor Context = CTy.getContext();
1153 addToContextOwner(&Buffer, Context);
1154 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001155 break;
1156 }
1157 default:
1158 break;
1159 }
1160
1161 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +00001162 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001163 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001164
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001165 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
Devang Patel30265c42010-07-07 20:12:52 +00001166 || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1167 {
Bill Wendling2f921f82009-05-15 09:23:25 +00001168 // Add size if non-zero (derived types might be zero-sized.)
1169 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +00001170 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001171 else {
1172 // Add zero size if it is not a forward declaration.
1173 if (CTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +00001174 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001175 else
Devang Patel930143b2009-11-21 02:48:08 +00001176 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling2f921f82009-05-15 09:23:25 +00001177 }
1178
1179 // Add source line info if available.
1180 if (!CTy.isForwardDecl())
Devang Patelb6511a32010-08-09 20:20:05 +00001181 addSourceLine(&Buffer, CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001182 }
1183}
1184
Devang Patel930143b2009-11-21 02:48:08 +00001185/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1186void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling2f921f82009-05-15 09:23:25 +00001187 int64_t L = SR.getLo();
1188 int64_t H = SR.getHi();
1189 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1190
Devang Patel930143b2009-11-21 02:48:08 +00001191 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patelf691df32009-08-14 20:59:16 +00001192 if (L)
Devang Patel930143b2009-11-21 02:48:08 +00001193 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Patel8f046022009-12-04 23:10:24 +00001194 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling2f921f82009-05-15 09:23:25 +00001195
Devang Patel930143b2009-11-21 02:48:08 +00001196 Buffer.addChild(DW_Subrange);
Bill Wendling2f921f82009-05-15 09:23:25 +00001197}
1198
Devang Patel930143b2009-11-21 02:48:08 +00001199/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001200void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling2f921f82009-05-15 09:23:25 +00001201 DICompositeType *CTy) {
1202 Buffer.setTag(dwarf::DW_TAG_array_type);
1203 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel930143b2009-11-21 02:48:08 +00001204 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001205
1206 // Emit derived type.
Devang Patel9ccfb642009-12-09 18:24:21 +00001207 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001208 DIArray Elements = CTy->getTypeArray();
1209
Devang Patel92e8c652009-11-21 00:31:03 +00001210 // Get an anonymous type for index type.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001211 CompileUnit *TheCU = getCompileUnit(*CTy);
1212 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel92e8c652009-11-21 00:31:03 +00001213 if (!IdxTy) {
1214 // Construct an anonymous type for index type.
1215 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +00001216 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1217 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel92e8c652009-11-21 00:31:03 +00001218 dwarf::DW_ATE_signed);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001219 TheCU->addDie(IdxTy);
1220 TheCU->setIndexTyDie(IdxTy);
Devang Patel92e8c652009-11-21 00:31:03 +00001221 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001222
1223 // Add subranges to array type.
1224 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1225 DIDescriptor Element = Elements.getElement(i);
1226 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001227 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001228 }
1229}
1230
Devang Patel930143b2009-11-21 02:48:08 +00001231/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3b548aa2010-03-08 20:52:55 +00001232DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001233 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3b548aa2010-03-08 20:52:55 +00001234 StringRef Name = ETy.getName();
Devang Patel930143b2009-11-21 02:48:08 +00001235 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3b548aa2010-03-08 20:52:55 +00001236 int64_t Value = ETy.getEnumValue();
Devang Patel930143b2009-11-21 02:48:08 +00001237 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +00001238 return Enumerator;
1239}
1240
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001241/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel43ef34d2010-01-05 01:46:14 +00001242/// printer to not emit usual symbol prefix before the symbol name is used then
1243/// return linkage name after skipping this special LLVM prefix.
1244static StringRef getRealLinkageName(StringRef LinkageName) {
1245 char One = '\1';
1246 if (LinkageName.startswith(StringRef(&One, 1)))
1247 return LinkageName.substr(1);
1248 return LinkageName;
1249}
1250
Devang Patel930143b2009-11-21 02:48:08 +00001251/// createMemberDIE - Create new member DIE.
Devang Patel18ba0b42010-08-10 04:12:17 +00001252DIE *DwarfDebug::createMemberDIE(DIDerivedType DT) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001253 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel2d9caf92009-11-25 17:36:49 +00001254 StringRef Name = DT.getName();
1255 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001256 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001257
Devang Patel9ccfb642009-12-09 18:24:21 +00001258 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001259
Devang Patelb6511a32010-08-09 20:20:05 +00001260 addSourceLine(MemberDie, DT);
Bill Wendling2f921f82009-05-15 09:23:25 +00001261
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001262 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel930143b2009-11-21 02:48:08 +00001263 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel67f56f02009-11-04 22:06:12 +00001264
Bill Wendling2f921f82009-05-15 09:23:25 +00001265 uint64_t Size = DT.getSizeInBits();
Devang Patelf05d5722009-11-04 23:48:00 +00001266 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling2f921f82009-05-15 09:23:25 +00001267
1268 if (Size != FieldSize) {
1269 // Handle bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001270 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1271 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling2f921f82009-05-15 09:23:25 +00001272
1273 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling2f921f82009-05-15 09:23:25 +00001274 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1275 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer2b459982010-01-07 17:50:57 +00001276 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling2f921f82009-05-15 09:23:25 +00001277 Offset -= FieldOffset;
1278
1279 // Maybe we need to work from the other end.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001280 if (Asm->getTargetData().isLittleEndian())
1281 Offset = FieldSize - (Offset + Size);
Devang Patel930143b2009-11-21 02:48:08 +00001282 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling2f921f82009-05-15 09:23:25 +00001283
Devang Patel67f56f02009-11-04 22:06:12 +00001284 // Here WD_AT_data_member_location points to the anonymous
1285 // field that includes this bit field.
Devang Patel930143b2009-11-21 02:48:08 +00001286 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001287
1288 } else
1289 // This is not a bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001290 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001291
Devang Pateld2316892010-02-03 20:08:48 +00001292 if (DT.getTag() == dwarf::DW_TAG_inheritance
1293 && DT.isVirtual()) {
1294
1295 // For C++, virtual base classes are not at fixed offset. Use following
1296 // expression to extract appropriate offset from vtable.
1297 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1298
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001299 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Pateld2316892010-02-03 20:08:48 +00001300 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1301 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1302 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1303 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1304 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1305 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1306 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1307
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001308 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
Devang Pateld2316892010-02-03 20:08:48 +00001309 VBaseLocationDie);
1310 } else
1311 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001312
1313 if (DT.isProtected())
Devang Pateleb57c592009-12-03 19:11:07 +00001314 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001315 dwarf::DW_ACCESS_protected);
1316 else if (DT.isPrivate())
Devang Pateleb57c592009-12-03 19:11:07 +00001317 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001318 dwarf::DW_ACCESS_private);
Devang Patela1bd5a12010-09-29 19:08:08 +00001319 // Otherwise C++ member and base classes are considered public.
1320 else if (DT.getCompileUnit().getLanguage() == dwarf::DW_LANG_C_plus_plus)
Devang Pateleb57c592009-12-03 19:11:07 +00001321 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1322 dwarf::DW_ACCESS_public);
1323 if (DT.isVirtual())
1324 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1325 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling2f921f82009-05-15 09:23:25 +00001326 return MemberDie;
1327}
1328
Devang Patel525dda02009-12-14 16:18:45 +00001329/// createSubprogramDIE - Create new DIE using SP.
Devang Patel185051c2010-09-27 23:15:27 +00001330DIE *DwarfDebug::createSubprogramDIE(DISubprogram SP) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001331 CompileUnit *SPCU = getCompileUnit(SP);
1332 DIE *SPDie = SPCU->getDIE(SP);
Devang Patel525dda02009-12-14 16:18:45 +00001333 if (SPDie)
1334 return SPDie;
1335
1336 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf200b392010-03-02 17:58:15 +00001337 // Constructors and operators for anonymous aggregates do not have names.
Devang Pateld0fa3042010-03-02 01:26:20 +00001338 if (!SP.getName().empty())
1339 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling2f921f82009-05-15 09:23:25 +00001340
Devang Patel2d9caf92009-11-25 17:36:49 +00001341 StringRef LinkageName = SP.getLinkageName();
Devang Patel43ef34d2010-01-05 01:46:14 +00001342 if (!LinkageName.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001343 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel43ef34d2010-01-05 01:46:14 +00001344 getRealLinkageName(LinkageName));
1345
Devang Patelb6511a32010-08-09 20:20:05 +00001346 addSourceLine(SPDie, SP);
Bill Wendling2f921f82009-05-15 09:23:25 +00001347
Devang Patel3a24f922010-10-07 22:03:01 +00001348 if (SP.isPrototyped())
Devang Patel930143b2009-11-21 02:48:08 +00001349 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001350
1351 // Add Return Type.
Devang Patel236526d2009-12-03 01:25:38 +00001352 DICompositeType SPTy = SP.getType();
1353 DIArray Args = SPTy.getTypeArray();
Bill Wendling2f921f82009-05-15 09:23:25 +00001354 unsigned SPTag = SPTy.getTag();
Devang Pateleb57c592009-12-03 19:11:07 +00001355
Devang Patel3b548aa2010-03-08 20:52:55 +00001356 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel9ccfb642009-12-09 18:24:21 +00001357 addType(SPDie, SPTy);
Devang Patel236526d2009-12-03 01:25:38 +00001358 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001359 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel236526d2009-12-03 01:25:38 +00001360
Devang Pateleb57c592009-12-03 19:11:07 +00001361 unsigned VK = SP.getVirtuality();
1362 if (VK) {
1363 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001364 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Pateleb57c592009-12-03 19:11:07 +00001365 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
Devang Patelc26da902010-12-09 00:10:40 +00001366 addUInt(Block, 0, dwarf::DW_FORM_udata, SP.getVirtualIndex());
Devang Pateleb57c592009-12-03 19:11:07 +00001367 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001368 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001369 SP.getContainingType()));
Devang Pateleb57c592009-12-03 19:11:07 +00001370 }
1371
Devang Patel185051c2010-09-27 23:15:27 +00001372 if (!SP.isDefinition()) {
Devang Patel930143b2009-11-21 02:48:08 +00001373 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001374
1375 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel236526d2009-12-03 01:25:38 +00001376 // be handled while processing variables.
1377 DICompositeType SPTy = SP.getType();
1378 DIArray Args = SPTy.getTypeArray();
1379 unsigned SPTag = SPTy.getTag();
1380
Bill Wendling2f921f82009-05-15 09:23:25 +00001381 if (SPTag == dwarf::DW_TAG_subroutine_type)
1382 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1383 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001384 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patel6efc8e52010-02-06 01:02:37 +00001385 addType(Arg, ATy);
1386 if (ATy.isArtificial())
1387 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel930143b2009-11-21 02:48:08 +00001388 SPDie->addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +00001389 }
1390 }
1391
Devang Patel999b4992010-02-03 19:57:19 +00001392 if (SP.isArtificial())
1393 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1394
Devang Patelb4e3b902010-04-30 19:38:23 +00001395 if (!SP.isLocalToUnit())
1396 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001397
Devang Patelb4e3b902010-04-30 19:38:23 +00001398 if (SP.isOptimized())
1399 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1400
Jim Grosbach965a73a2010-07-21 23:03:52 +00001401 if (unsigned isa = Asm->getISAEncoding()) {
1402 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1403 }
1404
Devang Patelb4e3b902010-04-30 19:38:23 +00001405 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001406 SPCU->insertDIE(SP, SPDie);
Devang Patelb4e3b902010-04-30 19:38:23 +00001407
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001408 // Add to context owner.
1409 addToContextOwner(SPDie, SP.getContext());
1410
Bill Wendling2f921f82009-05-15 09:23:25 +00001411 return SPDie;
1412}
1413
Devang Patel32cc43c2010-05-07 20:54:48 +00001414DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattner8d2fe282010-03-31 05:36:29 +00001415 assert(N && "Invalid Scope encoding!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001416
1417 DbgScope *AScope = AbstractScopes.lookup(N);
1418 if (AScope)
1419 return AScope;
Jim Grosbach042483e2009-11-21 23:12:12 +00001420
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001421 DbgScope *Parent = NULL;
1422
1423 DIDescriptor Scope(N);
1424 if (Scope.isLexicalBlock()) {
1425 DILexicalBlock DB(N);
1426 DIDescriptor ParentDesc = DB.getContext();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001427 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001428 }
1429
1430 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1431
1432 if (Parent)
Devang Patel930143b2009-11-21 02:48:08 +00001433 Parent->addScope(AScope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001434 AScope->setAbstractScope();
1435 AbstractScopes[N] = AScope;
1436 if (DIDescriptor(N).isSubprogram())
1437 AbstractScopesList.push_back(AScope);
1438 return AScope;
1439}
Devang Patel75cc16c2009-10-01 20:31:14 +00001440
Devang Patel019922d2010-04-06 23:53:48 +00001441/// isSubprogramContext - Return true if Context is either a subprogram
1442/// or another context nested inside a subprogram.
Devang Patel32cc43c2010-05-07 20:54:48 +00001443static bool isSubprogramContext(const MDNode *Context) {
Devang Patel019922d2010-04-06 23:53:48 +00001444 if (!Context)
1445 return false;
1446 DIDescriptor D(Context);
1447 if (D.isSubprogram())
1448 return true;
1449 if (D.isType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001450 return isSubprogramContext(DIType(Context).getContext());
Devang Patel019922d2010-04-06 23:53:48 +00001451 return false;
1452}
1453
Jim Grosbach042483e2009-11-21 23:12:12 +00001454/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel930143b2009-11-21 02:48:08 +00001455/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1456/// If there are global variables in this scope then create and insert
1457/// DIEs for these variables.
Devang Patel32cc43c2010-05-07 20:54:48 +00001458DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001459 CompileUnit *SPCU = getCompileUnit(SPNode);
1460 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +00001461
Chris Lattner3a383cb2010-04-05 00:13:49 +00001462 assert(SPDie && "Unable to find subprogram DIE!");
1463 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001464
Chris Lattner3a383cb2010-04-05 00:13:49 +00001465 // There is not any need to generate specification DIE for a function
1466 // defined at compile unit level. If a function is defined inside another
1467 // function then gdb prefers the definition at top level and but does not
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001468 // expect specification DIE in parent function. So avoid creating
Chris Lattner3a383cb2010-04-05 00:13:49 +00001469 // specification DIE for a function defined inside a function.
1470 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001471 !SP.getContext().isFile() &&
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001472 !isSubprogramContext(SP.getContext())) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00001473 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001474
1475 // Add arguments.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001476 DICompositeType SPTy = SP.getType();
1477 DIArray Args = SPTy.getTypeArray();
1478 unsigned SPTag = SPTy.getTag();
1479 if (SPTag == dwarf::DW_TAG_subroutine_type)
1480 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1481 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001482 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattner3a383cb2010-04-05 00:13:49 +00001483 addType(Arg, ATy);
1484 if (ATy.isArtificial())
1485 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1486 SPDie->addChild(Arg);
1487 }
1488 DIE *SPDeclDie = SPDie;
1489 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001490 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Chris Lattner3a383cb2010-04-05 00:13:49 +00001491 SPDeclDie);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001492 SPCU->addDie(SPDie);
Chris Lattner3a383cb2010-04-05 00:13:49 +00001493 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001494
Devang Patela37a95e2010-07-07 22:20:57 +00001495 // Pick up abstract subprogram DIE.
1496 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
1497 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1498 addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
1499 dwarf::DW_FORM_ref4, AbsSPDIE);
1500 SPCU->addDie(SPDie);
1501 }
1502
Chris Lattner3a383cb2010-04-05 00:13:49 +00001503 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1504 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1505 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1506 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1507 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1508 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1509 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +00001510
Chris Lattner3a383cb2010-04-05 00:13:49 +00001511 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001512}
1513
Jim Grosbach042483e2009-11-21 23:12:12 +00001514/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel930143b2009-11-21 02:48:08 +00001515/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1516DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001517
1518 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1519 if (Scope->isAbstractScope())
1520 return ScopeDIE;
1521
1522 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1523 if (Ranges.empty())
1524 return 0;
1525
1526 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1527 if (Ranges.size() > 1) {
1528 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001529 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +00001530 // DW_AT_ranges appropriately.
1531 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1532 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1533 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1534 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +00001535 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1536 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +00001537 }
1538 DebugRangeSymbols.push_back(NULL);
1539 DebugRangeSymbols.push_back(NULL);
1540 return ScopeDIE;
1541 }
1542
Devang Patel9fc11702010-05-25 23:40:22 +00001543 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1544 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001545
Devang Patel9fc11702010-05-25 23:40:22 +00001546 if (End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001547
Chris Lattnere13c3722010-03-09 01:58:53 +00001548 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1549 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001550
Devang Patel6c74a872010-04-27 19:46:33 +00001551 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1552 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001553
1554 return ScopeDIE;
1555}
1556
Devang Patel930143b2009-11-21 02:48:08 +00001557/// constructInlinedScopeDIE - This scope represents inlined body of
1558/// a function. Construct DIE to represent this concrete inlined copy
1559/// of the function.
1560DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001561
1562 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001563 assert (Ranges.empty() == false
Devang Patel6c74a872010-04-27 19:46:33 +00001564 && "DbgScope does not have instruction markers!");
1565
1566 // FIXME : .debug_inlined section specification does not clearly state how
1567 // to emit inlined scope that is split into multiple instruction ranges.
1568 // For now, use first instruction range and emit low_pc/high_pc pair and
1569 // corresponding .debug_inlined section entry for this pair.
1570 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel9fc11702010-05-25 23:40:22 +00001571 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1572 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001573
Devang Patel4c6bd662010-07-08 22:39:20 +00001574 if (StartLabel == 0 || EndLabel == 0) {
Devang Patel6c74a872010-04-27 19:46:33 +00001575 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1576 return 0;
1577 }
Chris Lattnere13c3722010-03-09 01:58:53 +00001578 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001579 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +00001580 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001581 "Invalid end label for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +00001582
Devang Patel3b548aa2010-03-08 20:52:55 +00001583 if (!Scope->getScopeNode())
Devang Patelbc97f6b2010-03-08 19:20:38 +00001584 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001585 DIScope DS(Scope->getScopeNode());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001586 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1587
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001588 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001589 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1590 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001591 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel930143b2009-11-21 02:48:08 +00001592 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001593 dwarf::DW_FORM_ref4, OriginDIE);
1594
Chris Lattner085b6522010-03-09 00:31:02 +00001595 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnere13c3722010-03-09 01:58:53 +00001596 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001597
1598 InlinedSubprogramDIEs.insert(OriginDIE);
1599
1600 // Track the start label for this inlined function.
Devang Patel32cc43c2010-05-07 20:54:48 +00001601 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001602 I = InlineInfo.find(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001603
1604 if (I == InlineInfo.end()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001605 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach00e9c612009-11-22 19:20:36 +00001606 ScopeDIE));
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001607 InlinedSPNodes.push_back(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001608 } else
Chris Lattner085b6522010-03-09 00:31:02 +00001609 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001610
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001611 DILocation DL(Scope->getInlinedAt());
Devang Patel1a0df9a2010-05-10 22:49:55 +00001612 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel930143b2009-11-21 02:48:08 +00001613 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001614
1615 return ScopeDIE;
1616}
1617
Devang Patel930143b2009-11-21 02:48:08 +00001618
1619/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel9ccfb642009-12-09 18:24:21 +00001620DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001621 StringRef Name = DV->getName();
Devang Patel2d9caf92009-11-25 17:36:49 +00001622 if (Name.empty())
Devang Patel97f99fa2009-11-13 02:25:26 +00001623 return NULL;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001624
1625 // Translate tag to proper Dwarf tag. The result variable is dropped for
1626 // now.
1627 unsigned Tag;
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001628 switch (DV->getTag()) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001629 case dwarf::DW_TAG_return_variable:
1630 return NULL;
1631 case dwarf::DW_TAG_arg_variable:
1632 Tag = dwarf::DW_TAG_formal_parameter;
1633 break;
1634 case dwarf::DW_TAG_auto_variable: // fall thru
1635 default:
1636 Tag = dwarf::DW_TAG_variable;
1637 break;
1638 }
1639
1640 // Define variable debug information entry.
1641 DIE *VariableDie = new DIE(Tag);
1642
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001643 DIE *AbsDIE = NULL;
Devang Patele1c53f22010-05-20 16:36:41 +00001644 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1645 V2AVI = VarToAbstractVarMap.find(DV);
1646 if (V2AVI != VarToAbstractVarMap.end())
1647 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach042483e2009-11-21 23:12:12 +00001648
Devang Patele1c53f22010-05-20 16:36:41 +00001649 if (AbsDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001650 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001651 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001652 else {
Devang Patel930143b2009-11-21 02:48:08 +00001653 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001654 addSourceLine(VariableDie, DV->getVariable());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001655
1656 // Add variable type.
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001657 addType(VariableDie, DV->getType());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001658 }
1659
Devang Patel6d9f9fe2010-08-09 21:01:39 +00001660 if (Tag == dwarf::DW_TAG_formal_parameter && DV->getType().isArtificial())
Devang Patel6efc8e52010-02-06 01:02:37 +00001661 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelbea08d12010-09-29 23:07:21 +00001662 else if (DIVariable(DV->getVariable()).isArtificial())
1663 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel9fc11702010-05-25 23:40:22 +00001664
1665 if (Scope->isAbstractScope()) {
1666 DV->setDIE(VariableDie);
1667 return VariableDie;
1668 }
1669
1670 // Add variable address.
1671
1672 unsigned Offset = DV->getDotDebugLocOffset();
1673 if (Offset != ~0U) {
1674 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1675 Asm->GetTempSymbol("debug_loc", Offset));
1676 DV->setDIE(VariableDie);
1677 UseDotDebugLocEntry.insert(VariableDie);
1678 return VariableDie;
1679 }
1680
1681 // Check if variable is described by a DBG_VALUE instruction.
1682 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1683 DbgVariableToDbgInstMap.find(DV);
1684 if (DVI != DbgVariableToDbgInstMap.end()) {
1685 const MachineInstr *DVInsn = DVI->second;
Devang Patel9fc11702010-05-25 23:40:22 +00001686 bool updated = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001687 // FIXME : Handle getNumOperands != 3
Devang Patel9fc11702010-05-25 23:40:22 +00001688 if (DVInsn->getNumOperands() == 3) {
Devang Patel86ec8b32010-08-31 22:22:42 +00001689 if (DVInsn->getOperand(0).isReg()) {
1690 const MachineOperand RegOp = DVInsn->getOperand(0);
1691 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1692 if (DVInsn->getOperand(1).isImm() &&
1693 TRI->getFrameRegister(*Asm->MF) == RegOp.getReg()) {
1694 addVariableAddress(DV, VariableDie, DVInsn->getOperand(1).getImm());
1695 updated = true;
1696 } else
Devang Patel53a40df62010-11-12 23:20:42 +00001697 updated = addRegisterAddress(VariableDie, RegOp);
Devang Patel86ec8b32010-08-31 22:22:42 +00001698 }
Devang Patel9fc11702010-05-25 23:40:22 +00001699 else if (DVInsn->getOperand(0).isImm())
Devang Patel53a40df62010-11-12 23:20:42 +00001700 updated = addConstantValue(VariableDie, DVInsn->getOperand(0));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001701 else if (DVInsn->getOperand(0).isFPImm())
1702 updated =
Devang Patel53a40df62010-11-12 23:20:42 +00001703 addConstantFPValue(VariableDie, DVInsn->getOperand(0));
Devang Patel9fc11702010-05-25 23:40:22 +00001704 } else {
1705 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1706 if (Location.getReg()) {
1707 addAddress(VariableDie, dwarf::DW_AT_location, Location);
Devang Patel9fc11702010-05-25 23:40:22 +00001708 updated = true;
1709 }
1710 }
1711 if (!updated) {
1712 // If variableDie is not updated then DBG_VALUE instruction does not
1713 // have valid variable info.
1714 delete VariableDie;
1715 return NULL;
1716 }
1717 DV->setDIE(VariableDie);
1718 return VariableDie;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001719 }
Devang Patel9fc11702010-05-25 23:40:22 +00001720
1721 // .. else use frame index, if available.
Devang Patel9fc11702010-05-25 23:40:22 +00001722 int FI = 0;
Devang Patel2cfc3af2010-08-31 06:11:28 +00001723 if (findVariableFrameIndex(DV, &FI))
1724 addVariableAddress(DV, VariableDie, FI);
1725
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001726 DV->setDIE(VariableDie);
1727 return VariableDie;
1728
1729}
Devang Patel930143b2009-11-21 02:48:08 +00001730
Devang Patel04d2f2d2009-11-24 01:14:22 +00001731void DwarfDebug::addPubTypes(DISubprogram SP) {
1732 DICompositeType SPTy = SP.getType();
1733 unsigned SPTag = SPTy.getTag();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001734 if (SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel04d2f2d2009-11-24 01:14:22 +00001735 return;
1736
1737 DIArray Args = SPTy.getTypeArray();
Devang Patel04d2f2d2009-11-24 01:14:22 +00001738 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001739 DIType ATy(Args.getElement(i));
Devang Patel8d6a2b72010-05-07 21:45:47 +00001740 if (!ATy.Verify())
Devang Patel04d2f2d2009-11-24 01:14:22 +00001741 continue;
1742 DICompositeType CATy = getDICompositeType(ATy);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001743 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel12d150e2010-04-13 20:35:04 +00001744 && !CATy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001745 CompileUnit *TheCU = getCompileUnit(CATy);
1746 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1747 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00001748 }
1749 }
1750}
1751
Devang Patel930143b2009-11-21 02:48:08 +00001752/// constructScopeDIE - Construct a DIE for this scope.
1753DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +00001754 if (!Scope || !Scope->getScopeNode())
1755 return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001756
Devang Patel3b548aa2010-03-08 20:52:55 +00001757 DIScope DS(Scope->getScopeNode());
1758 DIE *ScopeDIE = NULL;
1759 if (Scope->getInlinedAt())
1760 ScopeDIE = constructInlinedScopeDIE(Scope);
1761 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +00001762 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001763 if (Scope->isAbstractScope()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001764 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001765 // Note down abstract DIE.
1766 if (ScopeDIE)
1767 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
1768 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001769 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001770 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3b548aa2010-03-08 20:52:55 +00001771 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001772 else
Devang Patel3b548aa2010-03-08 20:52:55 +00001773 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel23b2ae62010-03-29 22:59:58 +00001774 if (!ScopeDIE) return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001775
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001776 // Add variables to scope.
Devang Patel406798a2010-08-09 18:51:29 +00001777 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001778 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel9ccfb642009-12-09 18:24:21 +00001779 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach042483e2009-11-21 23:12:12 +00001780 if (VariableDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001781 ScopeDIE->addChild(VariableDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001782 }
1783
1784 // Add nested scopes.
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001785 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001786 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1787 // Define the Scope debug information entry.
Devang Patel930143b2009-11-21 02:48:08 +00001788 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach042483e2009-11-21 23:12:12 +00001789 if (NestedDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001790 ScopeDIE->addChild(NestedDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001791 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001792
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001793 if (DS.isSubprogram())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001794 addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001795
Devang Patel04d2f2d2009-11-24 01:14:22 +00001796 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001797}
1798
Bill Wendling2b128d72009-05-20 23:19:06 +00001799/// GetOrCreateSourceID - Look up the source id with the given directory and
1800/// source file names. If none currently exists, create a new id and insert it
1801/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1802/// maps as well.
Devang Patel498877d2010-07-24 00:53:22 +00001803
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001804unsigned DwarfDebug::GetOrCreateSourceID(StringRef FileName){
Devang Patel871d0b12010-09-16 20:57:49 +00001805 // If FE did not provide a file name, then assume stdin.
1806 if (FileName.empty())
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001807 return GetOrCreateSourceID("<stdin>");
Devang Patel871d0b12010-09-16 20:57:49 +00001808
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001809 StringMapEntry<unsigned> &Entry = SourceIdMap.GetOrCreateValue(FileName);
1810 if (Entry.getValue())
1811 return Entry.getValue();
Bill Wendling2b128d72009-05-20 23:19:06 +00001812
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001813 unsigned SrcId = SourceIdMap.size();
1814 Entry.setValue(SrcId);
Bill Wendling2b128d72009-05-20 23:19:06 +00001815
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001816 // Print out a .file directive to specify files for .loc directives.
1817 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, FileName);
Bill Wendling2b128d72009-05-20 23:19:06 +00001818
1819 return SrcId;
1820}
1821
Devang Patel1f4690c2009-12-15 19:16:48 +00001822/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1823DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001824 CompileUnit *TheCU = getCompileUnit(NS);
1825 DIE *NDie = TheCU->getDIE(NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001826 if (NDie)
1827 return NDie;
1828 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001829 TheCU->insertDIE(NS, NDie);
Devang Patel1f4690c2009-12-15 19:16:48 +00001830 if (!NS.getName().empty())
1831 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
Devang Patelb6511a32010-08-09 20:20:05 +00001832 addSourceLine(NDie, NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001833 addToContextOwner(NDie, NS.getContext());
1834 return NDie;
1835}
1836
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001837/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel1a0df9a2010-05-10 22:49:55 +00001838/// metadata node with tag DW_TAG_compile_unit.
Devang Patel32cc43c2010-05-07 20:54:48 +00001839void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001840 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +00001841 StringRef FN = DIUnit.getFilename();
1842 StringRef Dir = DIUnit.getDirectory();
Rafael Espindola67c6ab82010-11-18 02:04:25 +00001843 unsigned ID = GetOrCreateSourceID(FN);
Bill Wendling2b128d72009-05-20 23:19:06 +00001844
1845 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel930143b2009-11-21 02:48:08 +00001846 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patelb2969422009-09-29 18:40:58 +00001847 DIUnit.getProducer());
Devang Patel930143b2009-11-21 02:48:08 +00001848 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendling2b128d72009-05-20 23:19:06 +00001849 DIUnit.getLanguage());
Devang Patel930143b2009-11-21 02:48:08 +00001850 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patelbd798ce2010-04-26 22:54:28 +00001851 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1852 // simplifies debug range entries.
Devang Patel1de21ec2010-06-28 22:22:47 +00001853 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Pateld22ed622010-03-22 23:11:36 +00001854 // DW_AT_stmt_list is a offset of line number information for this
Devang Patel4a213872010-08-24 00:06:12 +00001855 // compile unit in debug_line section.
Devang Patelea636392010-08-31 23:50:19 +00001856 if (Asm->MAI->doesDwarfUsesAbsoluteLabelForStmtList())
1857 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_addr,
1858 Asm->GetTempSymbol("section_line"));
1859 else
1860 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00001861
Devang Patel2d9caf92009-11-25 17:36:49 +00001862 if (!Dir.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001863 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +00001864 if (DIUnit.isOptimized())
Devang Patel930143b2009-11-21 02:48:08 +00001865 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendling2b128d72009-05-20 23:19:06 +00001866
Devang Patel2d9caf92009-11-25 17:36:49 +00001867 StringRef Flags = DIUnit.getFlags();
1868 if (!Flags.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001869 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendling2b128d72009-05-20 23:19:06 +00001870
1871 unsigned RVer = DIUnit.getRunTimeVersion();
1872 if (RVer)
Devang Patel930143b2009-11-21 02:48:08 +00001873 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +00001874 dwarf::DW_FORM_data1, RVer);
1875
Devang Patel1a0df9a2010-05-10 22:49:55 +00001876 CompileUnit *NewCU = new CompileUnit(ID, Die);
1877 if (!FirstCU)
1878 FirstCU = NewCU;
1879 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendling2b128d72009-05-20 23:19:06 +00001880}
1881
Devang Patel1a0df9a2010-05-10 22:49:55 +00001882/// getCompielUnit - Get CompileUnit DIE.
1883CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1884 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1885 DIDescriptor D(N);
1886 const MDNode *CUNode = NULL;
1887 if (D.isCompileUnit())
1888 CUNode = N;
1889 else if (D.isSubprogram())
1890 CUNode = DISubprogram(N).getCompileUnit();
1891 else if (D.isType())
1892 CUNode = DIType(N).getCompileUnit();
1893 else if (D.isGlobalVariable())
1894 CUNode = DIGlobalVariable(N).getCompileUnit();
1895 else if (D.isVariable())
1896 CUNode = DIVariable(N).getCompileUnit();
1897 else if (D.isNameSpace())
1898 CUNode = DINameSpace(N).getCompileUnit();
1899 else if (D.isFile())
1900 CUNode = DIFile(N).getCompileUnit();
1901 else
1902 return FirstCU;
1903
1904 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1905 = CUMap.find(CUNode);
1906 if (I == CUMap.end())
1907 return FirstCU;
1908 return I->second;
1909}
1910
Devang Patela8652672010-08-23 18:25:56 +00001911/// isUnsignedDIType - Return true if type encoding is unsigned.
1912static bool isUnsignedDIType(DIType Ty) {
1913 DIDerivedType DTy(Ty);
1914 if (DTy.Verify())
1915 return isUnsignedDIType(DTy.getTypeDerivedFrom());
1916
1917 DIBasicType BTy(Ty);
1918 if (BTy.Verify()) {
1919 unsigned Encoding = BTy.getEncoding();
1920 if (Encoding == dwarf::DW_ATE_unsigned ||
1921 Encoding == dwarf::DW_ATE_unsigned_char)
1922 return true;
1923 }
1924 return false;
1925}
Devang Patel1a0df9a2010-05-10 22:49:55 +00001926
1927/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00001928void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel469c12d22010-08-10 01:37:23 +00001929 DIGlobalVariable GV(N);
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001930
Devang Patelf5d53602009-09-04 23:59:07 +00001931 // If debug information is malformed then ignore it.
Devang Patel469c12d22010-08-10 01:37:23 +00001932 if (GV.Verify() == false)
Devang Patelf5d53602009-09-04 23:59:07 +00001933 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001934
1935 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001936 CompileUnit *TheCU = getCompileUnit(N);
Devang Patel469c12d22010-08-10 01:37:23 +00001937 if (TheCU->getDIE(GV))
Devang Patel0751a282009-06-26 01:49:18 +00001938 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001939
Devang Patel469c12d22010-08-10 01:37:23 +00001940 DIType GTy = GV.getType();
Devang Patelb2197462010-08-10 07:11:13 +00001941 DIE *VariableDIE = new DIE(GV.getTag());
1942
1943 bool isGlobalVariable = GV.getGlobal() != NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00001944
Devang Patel469c12d22010-08-10 01:37:23 +00001945 // Add name.
1946 addString(VariableDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1947 GV.getDisplayName());
1948 StringRef LinkageName = GV.getLinkageName();
Devang Patelb2197462010-08-10 07:11:13 +00001949 if (!LinkageName.empty() && isGlobalVariable)
Devang Patel469c12d22010-08-10 01:37:23 +00001950 addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
1951 getRealLinkageName(LinkageName));
1952 // Add type.
1953 addType(VariableDIE, GTy);
Devang Patel12d150e2010-04-13 20:35:04 +00001954 if (GTy.isCompositeType() && !GTy.getName().empty()
1955 && !GTy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001956 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001957 assert(Entry && "Missing global type!");
Devang Patel1a0df9a2010-05-10 22:49:55 +00001958 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00001959 }
Devang Patel469c12d22010-08-10 01:37:23 +00001960 // Add scoping info.
1961 if (!GV.isLocalToUnit()) {
1962 addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1963 // Expose as global.
1964 TheCU->addGlobal(GV.getName(), VariableDIE);
1965 }
1966 // Add line number info.
1967 addSourceLine(VariableDIE, GV);
1968 // Add to map.
1969 TheCU->insertDIE(N, VariableDIE);
1970 // Add to context owner.
1971 DIDescriptor GVContext = GV.getContext();
1972 addToContextOwner(VariableDIE, GVContext);
1973 // Add location.
Devang Patelb2197462010-08-10 07:11:13 +00001974 if (isGlobalVariable) {
1975 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1976 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1977 addLabel(Block, 0, dwarf::DW_FORM_udata,
1978 Asm->Mang->getSymbol(GV.getGlobal()));
1979 // Do not create specification DIE if context is either compile unit
1980 // or a subprogram.
1981 if (GV.isDefinition() && !GVContext.isCompileUnit() &&
1982 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
1983 // Create specification DIE.
1984 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1985 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1986 dwarf::DW_FORM_ref4, VariableDIE);
1987 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1988 addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1989 TheCU->addDie(VariableSpecDIE);
1990 } else {
1991 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
1992 }
Devang Patel70eb9822011-01-06 21:39:25 +00001993 } else if (ConstantInt *CI =
1994 dyn_cast_or_null<ConstantInt>(GV.getConstant()))
1995 addConstantValue(VariableDIE, CI, isUnsignedDIType(GTy));
1996
Devang Patel0751a282009-06-26 01:49:18 +00001997 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001998}
1999
Devang Patel1a0df9a2010-05-10 22:49:55 +00002000/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00002001void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00002002 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +00002003
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002004 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002005 CompileUnit *TheCU = getCompileUnit(N);
2006 if (TheCU->getDIE(N))
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002007 return;
2008
Bill Wendling2b128d72009-05-20 23:19:06 +00002009 if (!SP.isDefinition())
2010 // This is a method declaration which will be handled while constructing
2011 // class type.
Devang Patel0751a282009-06-26 01:49:18 +00002012 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002013
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00002014 DIE *SubprogramDie = createSubprogramDIE(SP);
2015
2016 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002017 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00002018
2019 // Add to context owner.
Devang Patel1f4690c2009-12-15 19:16:48 +00002020 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +00002021
Bill Wendling2b128d72009-05-20 23:19:06 +00002022 // Expose as global.
Devang Patel1a0df9a2010-05-10 22:49:55 +00002023 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002024
Devang Patel0751a282009-06-26 01:49:18 +00002025 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00002026}
2027
Devang Patel930143b2009-11-21 02:48:08 +00002028/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbarbe22ec42009-09-19 20:40:14 +00002029/// content. Create global DIEs and emit initial debug info sections.
2030/// This is inovked by the target AsmPrinter.
Chris Lattner11980022010-04-04 07:48:20 +00002031void DwarfDebug::beginModule(Module *M) {
Devang Patel6c74a872010-04-27 19:46:33 +00002032 if (DisableDebugInfoPrinting)
2033 return;
2034
Devang Patel63524442009-07-30 18:56:46 +00002035 DebugInfoFinder DbgFinder;
2036 DbgFinder.processModule(*M);
Devang Patel0751a282009-06-26 01:49:18 +00002037
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002038 bool HasDebugInfo = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002039
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002040 // Scan all the compile-units to see if there are any marked as the main unit.
2041 // if not, we do not generate debug info.
2042 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2043 E = DbgFinder.compile_unit_end(); I != E; ++I) {
2044 if (DICompileUnit(*I).isMain()) {
2045 HasDebugInfo = true;
2046 break;
2047 }
2048 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002049
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002050 if (!HasDebugInfo) return;
2051
2052 // Tell MMI that we have debug info.
2053 MMI->setDebugInfoAvailability(true);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002054
Chris Lattnerd442aa32010-04-04 23:17:54 +00002055 // Emit initial sections.
Chris Lattner7cfa70e2010-04-05 02:19:28 +00002056 EmitSectionLabels();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002057
Bill Wendling2b128d72009-05-20 23:19:06 +00002058 // Create all the compile unit DIEs.
Devang Patel63524442009-07-30 18:56:46 +00002059 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
2060 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002061 constructCompileUnit(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002062
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002063 // Create DIEs for each subprogram.
Devang Patel63524442009-07-30 18:56:46 +00002064 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
2065 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002066 constructSubprogramDIE(*I);
Devang Patel0751a282009-06-26 01:49:18 +00002067
Devang Patel2b75ed22009-12-10 19:14:49 +00002068 // Create DIEs for each global variable.
2069 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2070 E = DbgFinder.global_variable_end(); I != E; ++I)
2071 constructGlobalVariableDIE(*I);
2072
Devang Patel8e06a5e2010-08-10 20:01:20 +00002073 //getOrCreateTypeDIE
2074 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
2075 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2076 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2077
Devang Patel7a554812010-09-28 18:08:20 +00002078 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
2079 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
2080 getOrCreateTypeDIE(DIType(NMD->getOperand(i)));
2081
Bill Wendling2b128d72009-05-20 23:19:06 +00002082 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +00002083 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +00002084}
2085
Devang Patel930143b2009-11-21 02:48:08 +00002086/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendling2b128d72009-05-20 23:19:06 +00002087///
Devang Patel930143b2009-11-21 02:48:08 +00002088void DwarfDebug::endModule() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002089 if (!FirstCU) return;
Devang Patelf3b2db62010-06-28 18:25:03 +00002090 const Module *M = MMI->getModule();
Devang Pateld0701282010-08-02 17:32:15 +00002091 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patelf3b2db62010-06-28 18:25:03 +00002092 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2093 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2094 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2095 DISubprogram SP(AllSPs->getOperand(SI));
2096 if (!SP.Verify()) continue;
2097
2098 // Collect info for variables that were optimized out.
Devang Patel18efced2010-07-19 17:53:55 +00002099 if (!SP.isDefinition()) continue;
Devang Patelf3b2db62010-06-28 18:25:03 +00002100 StringRef FName = SP.getLinkageName();
2101 if (FName.empty())
2102 FName = SP.getName();
Devang Patel364bf042010-11-10 22:19:21 +00002103 NamedMDNode *NMD = getFnSpecificMDNode(*(MMI->getModule()), FName);
Devang Patelf3b2db62010-06-28 18:25:03 +00002104 if (!NMD) continue;
2105 unsigned E = NMD->getNumOperands();
2106 if (!E) continue;
2107 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Pateld0701282010-08-02 17:32:15 +00002108 DeadFnScopeMap[SP] = Scope;
Devang Patelf3b2db62010-06-28 18:25:03 +00002109 for (unsigned I = 0; I != E; ++I) {
2110 DIVariable DV(NMD->getOperand(I));
2111 if (!DV.Verify()) continue;
2112 Scope->addVariable(new DbgVariable(DV));
2113 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002114
Devang Patelf3b2db62010-06-28 18:25:03 +00002115 // Construct subprogram DIE and add variables DIEs.
2116 constructSubprogramDIE(SP);
2117 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patel406798a2010-08-09 18:51:29 +00002118 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf3b2db62010-06-28 18:25:03 +00002119 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2120 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2121 if (VariableDIE)
2122 ScopeDIE->addChild(VariableDIE);
2123 }
2124 }
2125 }
Bill Wendling2b128d72009-05-20 23:19:06 +00002126
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002127 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2128 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2129 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2130 DIE *ISP = *AI;
Devang Patel930143b2009-11-21 02:48:08 +00002131 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002132 }
2133
Devang Patel32cc43c2010-05-07 20:54:48 +00002134 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Pateleb57c592009-12-03 19:11:07 +00002135 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2136 DIE *SPDie = CI->first;
Devang Patel32cc43c2010-05-07 20:54:48 +00002137 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Pateleb57c592009-12-03 19:11:07 +00002138 if (!N) continue;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002139 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Pateleb57c592009-12-03 19:11:07 +00002140 if (!NDie) continue;
2141 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Pateleb57c592009-12-03 19:11:07 +00002142 }
2143
Bill Wendling2b128d72009-05-20 23:19:06 +00002144 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002145 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002146 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002147 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002148 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +00002149
2150 // End text sections.
2151 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002152 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnera179b522010-04-04 19:25:43 +00002153 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendling2b128d72009-05-20 23:19:06 +00002154 }
2155
2156 // Emit common frame information.
Devang Patel930143b2009-11-21 02:48:08 +00002157 emitCommonDebugFrame();
Bill Wendling2b128d72009-05-20 23:19:06 +00002158
2159 // Emit function debug frame information
2160 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2161 E = DebugFrames.end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002162 emitFunctionDebugFrame(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002163
2164 // Compute DIE offsets and sizes.
Devang Patel930143b2009-11-21 02:48:08 +00002165 computeSizeAndOffsets();
Bill Wendling2b128d72009-05-20 23:19:06 +00002166
2167 // Emit all the DIEs into a debug info section
Devang Patel930143b2009-11-21 02:48:08 +00002168 emitDebugInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002169
2170 // Corresponding abbreviations into a abbrev section.
Devang Patel930143b2009-11-21 02:48:08 +00002171 emitAbbreviations();
Bill Wendling2b128d72009-05-20 23:19:06 +00002172
Bill Wendling2b128d72009-05-20 23:19:06 +00002173 // Emit info into a debug pubnames section.
Devang Patel930143b2009-11-21 02:48:08 +00002174 emitDebugPubNames();
Bill Wendling2b128d72009-05-20 23:19:06 +00002175
Devang Patel04d2f2d2009-11-24 01:14:22 +00002176 // Emit info into a debug pubtypes section.
2177 emitDebugPubTypes();
2178
Bill Wendling2b128d72009-05-20 23:19:06 +00002179 // Emit info into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002180 emitDebugLoc();
Bill Wendling2b128d72009-05-20 23:19:06 +00002181
2182 // Emit info into a debug aranges section.
2183 EmitDebugARanges();
2184
2185 // Emit info into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002186 emitDebugRanges();
Bill Wendling2b128d72009-05-20 23:19:06 +00002187
2188 // Emit info into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002189 emitDebugMacInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002190
2191 // Emit inline info.
Devang Patel930143b2009-11-21 02:48:08 +00002192 emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002193
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002194 // Emit info into a debug str section.
2195 emitDebugStr();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002196
Devang Pateld0701282010-08-02 17:32:15 +00002197 // clean up.
2198 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002199 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2200 E = CUMap.end(); I != E; ++I)
2201 delete I->second;
2202 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendling2b128d72009-05-20 23:19:06 +00002203}
2204
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002205/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002206DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattner915c5f92010-04-02 19:42:39 +00002207 DebugLoc ScopeLoc) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002208
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002209 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002210 if (AbsDbgVariable)
2211 return AbsDbgVariable;
2212
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002213 LLVMContext &Ctx = Var->getContext();
Chris Lattner915c5f92010-04-02 19:42:39 +00002214 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002215 if (!Scope)
2216 return NULL;
2217
Devang Patele1c53f22010-05-20 16:36:41 +00002218 AbsDbgVariable = new DbgVariable(Var);
Devang Patel930143b2009-11-21 02:48:08 +00002219 Scope->addVariable(AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002220 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002221 return AbsDbgVariable;
2222}
2223
Devang Patel490c8ab2010-05-20 19:57:06 +00002224/// collectVariableInfoFromMMITable - Collect variable information from
2225/// side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002226void
Devang Patel490c8ab2010-05-20 19:57:06 +00002227DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2228 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00002229 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patel475d32a2009-10-06 01:26:37 +00002230 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2231 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2232 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00002233 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002234 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00002235 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00002236 DIVariable DV(Var);
2237 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002238
Chris Lattner915c5f92010-04-02 19:42:39 +00002239 DbgScope *Scope = 0;
Devang Patel32cc43c2010-05-07 20:54:48 +00002240 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattner915c5f92010-04-02 19:42:39 +00002241 Scope = ConcreteScopes.lookup(IA);
2242 if (Scope == 0)
2243 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002244
Devang Patelcdb7d442009-11-10 23:20:04 +00002245 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00002246 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00002247 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002248
Devang Patele1c53f22010-05-20 16:36:41 +00002249 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2250 DbgVariable *RegVar = new DbgVariable(DV);
2251 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel930143b2009-11-21 02:48:08 +00002252 Scope->addVariable(RegVar);
Devang Patele1c53f22010-05-20 16:36:41 +00002253 if (AbsDbgVariable) {
2254 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2255 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2256 }
Devang Patel475d32a2009-10-06 01:26:37 +00002257 }
Devang Patel490c8ab2010-05-20 19:57:06 +00002258}
Devang Patela3e9c9c2010-03-15 18:33:46 +00002259
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002260/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +00002261/// DBG_VALUE instruction, is in a defined reg.
2262static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2263 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2264 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2265 return true;
2266 return false;
2267}
2268
Devang Patel490c8ab2010-05-20 19:57:06 +00002269/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002270void
Devang Patel5c0f85c2010-06-25 22:07:34 +00002271DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2272 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002273
Devang Patel490c8ab2010-05-20 19:57:06 +00002274 /// collection info from MMI table.
2275 collectVariableInfoFromMMITable(MF, Processed);
2276
2277 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002278 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002279 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel490c8ab2010-05-20 19:57:06 +00002280 I != E; ++I)
Devang Patela3e9c9c2010-03-15 18:33:46 +00002281 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2282 II != IE; ++II) {
2283 const MachineInstr *MInsn = II;
Devang Patel447cb382011-01-11 21:42:10 +00002284 if (!MInsn->isDebugValue())
Devang Patela3e9c9c2010-03-15 18:33:46 +00002285 continue;
Devang Patel490c8ab2010-05-20 19:57:06 +00002286 DbgValues.push_back(MInsn);
2287 }
Devang Patela3e9c9c2010-03-15 18:33:46 +00002288
Devang Patel9fc11702010-05-25 23:40:22 +00002289 // This is a collection of DBV_VALUE instructions describing same variable.
2290 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patel490c8ab2010-05-20 19:57:06 +00002291 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2292 E = DbgValues.end(); I != E; ++I) {
2293 const MachineInstr *MInsn = *I;
Devang Patel9fc11702010-05-25 23:40:22 +00002294 MultipleValues.clear();
2295 if (isDbgValueInDefinedReg(MInsn))
2296 MultipleValues.push_back(MInsn);
Devang Patel490c8ab2010-05-20 19:57:06 +00002297 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2298 if (Processed.count(DV) != 0)
2299 continue;
2300
Devang Patelc2254f62010-06-02 19:05:13 +00002301 const MachineInstr *PrevMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002302 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
Devang Patel9fc11702010-05-25 23:40:22 +00002303 ME = DbgValues.end(); MI != ME; ++MI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002304 const MDNode *Var =
Devang Patel9fc11702010-05-25 23:40:22 +00002305 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
Devang Patel447cb382011-01-11 21:42:10 +00002306 if (Var == DV &&
Devang Patelc2254f62010-06-02 19:05:13 +00002307 !PrevMI->isIdenticalTo(*MI))
Devang Patel9fc11702010-05-25 23:40:22 +00002308 MultipleValues.push_back(*MI);
Devang Patelc2254f62010-06-02 19:05:13 +00002309 PrevMI = *MI;
Devang Patel9fc11702010-05-25 23:40:22 +00002310 }
2311
Devang Patel447cb382011-01-11 21:42:10 +00002312 DbgScope *Scope = NULL;
Devang Patel7a9dedf2010-05-27 20:25:04 +00002313 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2314 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelfbd6c452010-05-21 00:10:20 +00002315 Scope = CurrentFnDbgScope;
Devang Patel447cb382011-01-11 21:42:10 +00002316 else
2317 Scope = findDbgScope(MInsn);
Devang Patel490c8ab2010-05-20 19:57:06 +00002318 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00002319 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00002320 continue;
2321
2322 Processed.insert(DV);
Devang Patel490c8ab2010-05-20 19:57:06 +00002323 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patel490c8ab2010-05-20 19:57:06 +00002324 Scope->addVariable(RegVar);
Devang Patelfbd6c452010-05-21 00:10:20 +00002325 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2326 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2327 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002328 }
Devang Patel9fc11702010-05-25 23:40:22 +00002329 if (MultipleValues.size() <= 1) {
2330 DbgVariableToDbgInstMap[RegVar] = MInsn;
2331 continue;
2332 }
2333
2334 // handle multiple DBG_VALUE instructions describing one variable.
Devang Patel9fc11702010-05-25 23:40:22 +00002335 if (DotDebugLocEntries.empty())
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002336 RegVar->setDotDebugLocOffset(0);
2337 else
2338 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002339 const MachineInstr *Begin = NULL;
2340 const MachineInstr *End = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002341 for (SmallVector<const MachineInstr *, 4>::iterator
2342 MVI = MultipleValues.begin(), MVE = MultipleValues.end();
Devang Patel30265c42010-07-07 20:12:52 +00002343 MVI != MVE; ++MVI) {
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002344 if (!Begin) {
2345 Begin = *MVI;
2346 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002347 }
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002348 End = *MVI;
Devang Patel9fc11702010-05-25 23:40:22 +00002349 MachineLocation MLoc;
Devang Patel0e60e672010-08-04 18:40:52 +00002350 if (Begin->getNumOperands() == 3) {
2351 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2352 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2353 } else
2354 MLoc = Asm->getDebugValueLocation(Begin);
2355
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002356 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2357 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patel6c378ac2010-08-04 22:07:27 +00002358 if (MLoc.getReg())
2359 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
2360
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002361 Begin = End;
2362 if (MVI + 1 == MVE) {
2363 // If End is the last instruction then its value is valid
Devang Patel9fc11702010-05-25 23:40:22 +00002364 // until the end of the funtion.
Devang Patel0e60e672010-08-04 18:40:52 +00002365 MachineLocation EMLoc;
2366 if (End->getNumOperands() == 3) {
2367 if (End->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2368 EMLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2369 } else
2370 EMLoc = Asm->getDebugValueLocation(End);
Devang Patel6c378ac2010-08-04 22:07:27 +00002371 if (EMLoc.getReg())
2372 DotDebugLocEntries.
2373 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, EMLoc));
Devang Patel9fc11702010-05-25 23:40:22 +00002374 }
2375 }
2376 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00002377 }
Devang Patele0a94bf2010-05-14 21:01:35 +00002378
2379 // Collect info for variables that were optimized out.
Devang Patelad517352010-06-22 01:01:58 +00002380 const Function *F = MF->getFunction();
Devang Patel364bf042010-11-10 22:19:21 +00002381 if (NamedMDNode *NMD = getFnSpecificMDNode(*(F->getParent()), F->getName())) {
Devang Patele0a94bf2010-05-14 21:01:35 +00002382 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002383 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel490c8ab2010-05-20 19:57:06 +00002384 if (!DV || !Processed.insert(DV))
Devang Patele0a94bf2010-05-14 21:01:35 +00002385 continue;
2386 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2387 if (Scope)
Devang Patele1c53f22010-05-20 16:36:41 +00002388 Scope->addVariable(new DbgVariable(DV));
Devang Patele0a94bf2010-05-14 21:01:35 +00002389 }
2390 }
Devang Patel9fc11702010-05-25 23:40:22 +00002391}
Devang Patele0a94bf2010-05-14 21:01:35 +00002392
Devang Patel9fc11702010-05-25 23:40:22 +00002393/// getLabelBeforeInsn - Return Label preceding the instruction.
2394const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2395 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2396 LabelsBeforeInsn.find(MI);
2397 if (I == LabelsBeforeInsn.end())
2398 // FunctionBeginSym always preceeds all the instruction in current function.
2399 return FunctionBeginSym;
2400 return I->second;
2401}
2402
2403/// getLabelAfterInsn - Return Label immediately following the instruction.
2404const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2405 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2406 LabelsAfterInsn.find(MI);
2407 if (I == LabelsAfterInsn.end())
2408 return NULL;
2409 return I->second;
Devang Patel475d32a2009-10-06 01:26:37 +00002410}
2411
Devang Patelb5694e72010-10-26 17:49:02 +00002412/// beginInstruction - Process beginning of an instruction.
2413void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Devang Patel002d54d2010-05-26 19:37:24 +00002414 if (InsnNeedsLabel.count(MI) == 0) {
2415 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patelbd477be2010-03-29 17:20:31 +00002416 return;
Devang Patel9fc11702010-05-25 23:40:22 +00002417 }
Devang Patel23b2ae62010-03-29 22:59:58 +00002418
Devang Patel002d54d2010-05-26 19:37:24 +00002419 // Check location.
2420 DebugLoc DL = MI->getDebugLoc();
2421 if (!DL.isUnknown()) {
2422 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2423 PrevLabel = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
Devang Patel6c74a872010-04-27 19:46:33 +00002424 PrevInstLoc = DL;
Devang Patel002d54d2010-05-26 19:37:24 +00002425 LabelsBeforeInsn[MI] = PrevLabel;
2426 return;
Devang Patel6c74a872010-04-27 19:46:33 +00002427 }
Devang Patelbd477be2010-03-29 17:20:31 +00002428
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002429 // If location is unknown then use temp label for this DBG_VALUE
Devang Patel002d54d2010-05-26 19:37:24 +00002430 // instruction.
2431 if (MI->isDebugValue()) {
Devang Patelacc32a52010-05-26 21:23:46 +00002432 PrevLabel = MMI->getContext().CreateTempSymbol();
2433 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00002434 LabelsBeforeInsn[MI] = PrevLabel;
2435 return;
2436 }
2437
2438 if (UnknownLocations) {
2439 PrevLabel = recordSourceLine(0, 0, 0);
2440 LabelsBeforeInsn[MI] = PrevLabel;
2441 return;
2442 }
2443
2444 assert (0 && "Instruction is not processed!");
Devang Patel8db360d2009-10-06 01:50:42 +00002445}
2446
Devang Patelb5694e72010-10-26 17:49:02 +00002447/// endInstruction - Process end of an instruction.
2448void DwarfDebug::endInstruction(const MachineInstr *MI) {
Devang Patel3ebd8932010-04-08 16:50:29 +00002449 if (InsnsEndScopeSet.count(MI) != 0) {
2450 // Emit a label if this instruction ends a scope.
2451 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2452 Asm->OutStreamer.EmitLabel(Label);
Devang Patel6c74a872010-04-27 19:46:33 +00002453 LabelsAfterInsn[MI] = Label;
Devang Patel3ebd8932010-04-08 16:50:29 +00002454 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002455}
2456
Devang Patel6c74a872010-04-27 19:46:33 +00002457/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002458DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel30265c42010-07-07 20:12:52 +00002459 const MDNode *InlinedAt) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002460 if (!InlinedAt) {
2461 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2462 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002463 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002464 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2465 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Patel6c74a872010-04-27 19:46:33 +00002466 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002467 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002468 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Patel6c74a872010-04-27 19:46:33 +00002469 WScope->setParent(Parent);
2470 Parent->addScope(WScope);
2471 }
2472
2473 if (!WScope->getParent()) {
2474 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastings9b5005c2010-06-15 23:06:30 +00002475 // We used to check only for a linkage name, but that fails
2476 // since we began omitting the linkage name for private
2477 // functions. The new way is to check for the name in metadata,
2478 // but that's not supported in old .ll test cases. Ergo, we
2479 // check both.
Stuart Hastingsafe54f12010-06-11 20:08:44 +00002480 if (SPName == Asm->MF->getFunction()->getName() ||
2481 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Patel6c74a872010-04-27 19:46:33 +00002482 CurrentFnDbgScope = WScope;
2483 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002484
Devang Patel6c74a872010-04-27 19:46:33 +00002485 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002486 }
2487
Devang Patel5c0f85c2010-06-25 22:07:34 +00002488 getOrCreateAbstractScope(Scope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002489 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2490 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002491 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002492
2493 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2494 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2495 DILocation DL(InlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002496 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002497 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Patel6c74a872010-04-27 19:46:33 +00002498 WScope->setParent(Parent);
2499 Parent->addScope(WScope);
2500
2501 ConcreteScopes[InlinedAt] = WScope;
Devang Patel6c74a872010-04-27 19:46:33 +00002502
2503 return WScope;
Devang Patel8db360d2009-10-06 01:50:42 +00002504}
2505
Devang Patel6c74a872010-04-27 19:46:33 +00002506/// hasValidLocation - Return true if debug location entry attached with
2507/// machine instruction encodes valid location info.
2508static bool hasValidLocation(LLVMContext &Ctx,
2509 const MachineInstr *MInsn,
Devang Patel32cc43c2010-05-07 20:54:48 +00002510 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Patel6c74a872010-04-27 19:46:33 +00002511 DebugLoc DL = MInsn->getDebugLoc();
2512 if (DL.isUnknown()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002513
Devang Patel32cc43c2010-05-07 20:54:48 +00002514 const MDNode *S = DL.getScope(Ctx);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002515
Devang Patel6c74a872010-04-27 19:46:33 +00002516 // There is no need to create another DIE for compile unit. For all
2517 // other scopes, create one DbgScope now. This will be translated
2518 // into a scope DIE at the end.
2519 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002520
Devang Patel6c74a872010-04-27 19:46:33 +00002521 Scope = S;
2522 InlinedAt = DL.getInlinedAt(Ctx);
2523 return true;
2524}
2525
2526/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2527/// hierarchy.
2528static void calculateDominanceGraph(DbgScope *Scope) {
2529 assert (Scope && "Unable to calculate scop edominance graph!");
2530 SmallVector<DbgScope *, 4> WorkStack;
2531 WorkStack.push_back(Scope);
2532 unsigned Counter = 0;
2533 while (!WorkStack.empty()) {
2534 DbgScope *WS = WorkStack.back();
2535 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2536 bool visitedChildren = false;
2537 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2538 SE = Children.end(); SI != SE; ++SI) {
2539 DbgScope *ChildScope = *SI;
2540 if (!ChildScope->getDFSOut()) {
2541 WorkStack.push_back(ChildScope);
2542 visitedChildren = true;
2543 ChildScope->setDFSIn(++Counter);
2544 break;
2545 }
2546 }
2547 if (!visitedChildren) {
2548 WorkStack.pop_back();
2549 WS->setDFSOut(++Counter);
2550 }
2551 }
2552}
2553
2554/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002555static
Devang Patel6c74a872010-04-27 19:46:33 +00002556void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2557 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2558{
2559#ifndef NDEBUG
2560 unsigned PrevDFSIn = 0;
2561 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2562 I != E; ++I) {
2563 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2564 II != IE; ++II) {
2565 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002566 const MDNode *Scope = NULL;
2567 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002568
2569 // Check if instruction has valid location information.
2570 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2571 dbgs() << " [ ";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002572 if (InlinedAt)
Devang Patel6c74a872010-04-27 19:46:33 +00002573 dbgs() << "*";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002574 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Patel6c74a872010-04-27 19:46:33 +00002575 MI2ScopeMap.find(MInsn);
2576 if (DI != MI2ScopeMap.end()) {
2577 DbgScope *S = DI->second;
2578 dbgs() << S->getDFSIn();
2579 PrevDFSIn = S->getDFSIn();
2580 } else
2581 dbgs() << PrevDFSIn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002582 } else
Devang Patel6c74a872010-04-27 19:46:33 +00002583 dbgs() << " [ x" << PrevDFSIn;
2584 dbgs() << " ]";
2585 MInsn->dump();
2586 }
2587 dbgs() << "\n";
2588 }
2589#endif
2590}
Devang Patel930143b2009-11-21 02:48:08 +00002591/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner848c7d22010-03-31 05:39:57 +00002592/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattner76555b52010-01-26 23:18:02 +00002593bool DwarfDebug::extractScopeInformation() {
Devang Patel75cc16c2009-10-01 20:31:14 +00002594 // If scope information was extracted using .dbg intrinsics then there is not
2595 // any need to extract these information by scanning each instruction.
2596 if (!DbgScopeMap.empty())
2597 return false;
2598
Dan Gohmane9135cb2010-04-23 01:18:53 +00002599 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patel6c74a872010-04-27 19:46:33 +00002600 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2601 SmallVector<DbgRange, 4> MIRanges;
2602 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patel32cc43c2010-05-07 20:54:48 +00002603 const MDNode *PrevScope = NULL;
2604 const MDNode *PrevInlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002605 const MachineInstr *RangeBeginMI = NULL;
2606 const MachineInstr *PrevMI = NULL;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002607 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel75cc16c2009-10-01 20:31:14 +00002608 I != E; ++I) {
2609 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2610 II != IE; ++II) {
2611 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002612 const MDNode *Scope = NULL;
2613 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002614
2615 // Check if instruction has valid location information.
2616 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2617 PrevMI = MInsn;
2618 continue;
2619 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002620
Devang Patel6c74a872010-04-27 19:46:33 +00002621 // If scope has not changed then skip this instruction.
2622 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2623 PrevMI = MInsn;
2624 continue;
2625 }
2626
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002627 if (RangeBeginMI) {
2628 // If we have alread seen a beginning of a instruction range and
Devang Patel6c74a872010-04-27 19:46:33 +00002629 // current instruction scope does not match scope of first instruction
2630 // in this range then create a new instruction range.
2631 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002632 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel30265c42010-07-07 20:12:52 +00002633 PrevInlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002634 MIRanges.push_back(R);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002635 }
Devang Patel6c74a872010-04-27 19:46:33 +00002636
2637 // This is a beginning of a new instruction range.
2638 RangeBeginMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002639
Devang Patel6c74a872010-04-27 19:46:33 +00002640 // Reset previous markers.
2641 PrevMI = MInsn;
2642 PrevScope = Scope;
2643 PrevInlinedAt = InlinedAt;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002644 }
2645 }
2646
Devang Patel6c74a872010-04-27 19:46:33 +00002647 // Create last instruction range.
2648 if (RangeBeginMI && PrevMI && PrevScope) {
2649 DbgRange R(RangeBeginMI, PrevMI);
2650 MIRanges.push_back(R);
2651 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patel75cc16c2009-10-01 20:31:14 +00002652 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002653
Devang Patel530a0752010-01-04 20:44:00 +00002654 if (!CurrentFnDbgScope)
2655 return false;
2656
Devang Patel6c74a872010-04-27 19:46:33 +00002657 calculateDominanceGraph(CurrentFnDbgScope);
2658 if (PrintDbgScope)
2659 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2660
2661 // Find ranges of instructions covered by each DbgScope;
2662 DbgScope *PrevDbgScope = NULL;
2663 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2664 RE = MIRanges.end(); RI != RE; ++RI) {
2665 const DbgRange &R = *RI;
2666 DbgScope *S = MI2ScopeMap.lookup(R.first);
2667 assert (S && "Lost DbgScope for a machine instruction!");
2668 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2669 PrevDbgScope->closeInsnRange(S);
2670 S->openInsnRange(R.first);
2671 S->extendInsnRange(R.second);
2672 PrevDbgScope = S;
2673 }
2674
2675 if (PrevDbgScope)
2676 PrevDbgScope->closeInsnRange();
Devang Patel75cc16c2009-10-01 20:31:14 +00002677
Devang Patel359b0132010-04-08 18:43:56 +00002678 identifyScopeMarkers();
Devang Patelf1d5a1e2010-04-08 15:37:09 +00002679
2680 return !DbgScopeMap.empty();
2681}
2682
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002683/// identifyScopeMarkers() -
Devang Patel6c74a872010-04-27 19:46:33 +00002684/// Each DbgScope has first instruction and last instruction to mark beginning
2685/// and end of a scope respectively. Create an inverse map that list scopes
2686/// starts (and ends) with an instruction. One instruction may start (or end)
2687/// multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00002688void DwarfDebug::identifyScopeMarkers() {
Devang Patel7771b7c2010-01-20 02:05:23 +00002689 SmallVector<DbgScope *, 4> WorkList;
2690 WorkList.push_back(CurrentFnDbgScope);
2691 while (!WorkList.empty()) {
Chris Lattner848c7d22010-03-31 05:39:57 +00002692 DbgScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002693
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002694 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002695 if (!Children.empty())
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002696 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00002697 SE = Children.end(); SI != SE; ++SI)
2698 WorkList.push_back(*SI);
2699
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002700 if (S->isAbstractScope())
2701 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002702
Devang Patel6c74a872010-04-27 19:46:33 +00002703 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2704 if (Ranges.empty())
2705 continue;
2706 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2707 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002708 assert(RI->first && "DbgRange does not have first instruction!");
2709 assert(RI->second && "DbgRange does not have second instruction!");
Devang Patel6c74a872010-04-27 19:46:33 +00002710 InsnsEndScopeSet.insert(RI->second);
2711 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002712 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002713}
2714
Dan Gohman3df671a2010-04-20 00:37:27 +00002715/// FindFirstDebugLoc - Find the first debug location in the function. This
2716/// is intended to be an approximation for the source position of the
2717/// beginning of the function.
2718static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2719 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2720 I != E; ++I)
2721 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2722 MBBI != MBBE; ++MBBI) {
2723 DebugLoc DL = MBBI->getDebugLoc();
2724 if (!DL.isUnknown())
2725 return DL;
2726 }
2727 return DebugLoc();
2728}
2729
Devang Patela86114b2010-10-25 20:45:32 +00002730#ifndef NDEBUG
2731/// CheckLineNumbers - Count basicblocks whose instructions do not have any
2732/// line number information.
2733static void CheckLineNumbers(const MachineFunction *MF) {
2734 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2735 I != E; ++I) {
2736 bool FoundLineNo = false;
2737 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2738 II != IE; ++II) {
2739 const MachineInstr *MI = II;
2740 if (!MI->getDebugLoc().isUnknown()) {
2741 FoundLineNo = true;
2742 break;
2743 }
2744 }
Devang Patel6e0d5892010-10-28 22:11:59 +00002745 if (!FoundLineNo && I->size())
Devang Patela86114b2010-10-25 20:45:32 +00002746 ++BlocksWithoutLineNo;
2747 }
2748}
2749#endif
2750
Devang Patel930143b2009-11-21 02:48:08 +00002751/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendling2b128d72009-05-20 23:19:06 +00002752/// emitted immediately after the function entry point.
Chris Lattner76555b52010-01-26 23:18:02 +00002753void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00002754 if (!MMI->hasDebugInfo()) return;
Bill Wendlingfcc14142010-04-07 09:28:04 +00002755 if (!extractScopeInformation()) return;
Devang Patel4598eb62009-10-06 18:37:31 +00002756
Devang Patela86114b2010-10-25 20:45:32 +00002757#ifndef NDEBUG
2758 CheckLineNumbers(MF);
2759#endif
2760
Devang Patel6c74a872010-04-27 19:46:33 +00002761 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2762 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00002763 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00002764 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00002765
2766 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2767 // function.
Dan Gohman3df671a2010-04-20 00:37:27 +00002768 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattner915c5f92010-04-02 19:42:39 +00002769 if (FDL.isUnknown()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002770
Devang Patel32cc43c2010-05-07 20:54:48 +00002771 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings61475c52010-07-19 23:56:30 +00002772 const MDNode *TheScope = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002773
Chris Lattner915c5f92010-04-02 19:42:39 +00002774 DISubprogram SP = getDISubprogram(Scope);
2775 unsigned Line, Col;
2776 if (SP.Verify()) {
2777 Line = SP.getLineNumber();
2778 Col = 0;
Stuart Hastings61475c52010-07-19 23:56:30 +00002779 TheScope = SP;
Chris Lattner915c5f92010-04-02 19:42:39 +00002780 } else {
2781 Line = FDL.getLine();
2782 Col = FDL.getCol();
Stuart Hastings61475c52010-07-19 23:56:30 +00002783 TheScope = Scope;
Bill Wendling2b128d72009-05-20 23:19:06 +00002784 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002785
Stuart Hastings61475c52010-07-19 23:56:30 +00002786 recordSourceLine(Line, Col, TheScope);
Devang Patel002d54d2010-05-26 19:37:24 +00002787
Devang Patel21ccf052010-06-02 16:42:51 +00002788 /// ProcessedArgs - Collection of arguments already processed.
2789 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2790
Devang Patel002d54d2010-05-26 19:37:24 +00002791 DebugLoc PrevLoc;
2792 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2793 I != E; ++I)
2794 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2795 II != IE; ++II) {
2796 const MachineInstr *MI = II;
2797 DebugLoc DL = MI->getDebugLoc();
2798 if (MI->isDebugValue()) {
Devang Patel002d54d2010-05-26 19:37:24 +00002799 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2800 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2801 if (!DV.Verify()) continue;
Devang Patel5e6b71c2010-05-27 16:47:30 +00002802 // If DBG_VALUE is for a local variable then it needs a label.
Devang Patelbca5b252010-12-06 22:48:22 +00002803 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
Devang Patel002d54d2010-05-26 19:37:24 +00002804 InsnNeedsLabel.insert(MI);
Devang Patel5e6b71c2010-05-27 16:47:30 +00002805 // DBG_VALUE for inlined functions argument needs a label.
Devang Patel42939752010-07-01 21:38:08 +00002806 else if (!DISubprogram(getDISubprogram(DV.getContext())).
2807 describes(MF->getFunction()))
Devang Patel5e6b71c2010-05-27 16:47:30 +00002808 InsnNeedsLabel.insert(MI);
2809 // DBG_VALUE indicating argument location change needs a label.
Devang Patelbca5b252010-12-06 22:48:22 +00002810 else if (!ProcessedArgs.insert(DV))
Devang Patel002d54d2010-05-26 19:37:24 +00002811 InsnNeedsLabel.insert(MI);
2812 } else {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002813 // If location is unknown then instruction needs a location only if
Devang Patel002d54d2010-05-26 19:37:24 +00002814 // UnknownLocations flag is set.
2815 if (DL.isUnknown()) {
2816 if (UnknownLocations && !PrevLoc.isUnknown())
2817 InsnNeedsLabel.insert(MI);
2818 } else if (DL != PrevLoc)
2819 // Otherwise, instruction needs a location only if it is new location.
2820 InsnNeedsLabel.insert(MI);
2821 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002822
Devang Patel002d54d2010-05-26 19:37:24 +00002823 if (!DL.isUnknown() || UnknownLocations)
2824 PrevLoc = DL;
2825 }
2826
2827 PrevLabel = FunctionBeginSym;
Bill Wendling2b128d72009-05-20 23:19:06 +00002828}
2829
Devang Patel930143b2009-11-21 02:48:08 +00002830/// endFunction - Gather and emit post-function debug information.
Bill Wendling2b128d72009-05-20 23:19:06 +00002831///
Chris Lattner76555b52010-01-26 23:18:02 +00002832void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendlingfcc14142010-04-07 09:28:04 +00002833 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00002834
Devang Patel530a0752010-01-04 20:44:00 +00002835 if (CurrentFnDbgScope) {
Devang Patel4a8e6e82010-05-22 00:04:14 +00002836
Devang Patel9fc11702010-05-25 23:40:22 +00002837 // Define end label for subprogram.
2838 FunctionEndSym = Asm->GetTempSymbol("func_end",
2839 Asm->getFunctionNumber());
2840 // Assumes in correct section after the entry point.
2841 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002842
Devang Patel5c0f85c2010-06-25 22:07:34 +00002843 SmallPtrSet<const MDNode *, 16> ProcessedVars;
2844 collectVariableInfo(MF, ProcessedVars);
Devang Patel4a8e6e82010-05-22 00:04:14 +00002845
Devang Patel530a0752010-01-04 20:44:00 +00002846 // Construct abstract scopes.
2847 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel5c0f85c2010-06-25 22:07:34 +00002848 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00002849 DISubprogram SP((*AI)->getScopeNode());
2850 if (SP.Verify()) {
2851 // Collect info for variables that were optimized out.
2852 StringRef FName = SP.getLinkageName();
2853 if (FName.empty())
2854 FName = SP.getName();
Devang Patel364bf042010-11-10 22:19:21 +00002855 if (NamedMDNode *NMD =
2856 getFnSpecificMDNode(*(MF->getFunction()->getParent()), FName)) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00002857 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002858 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel5c0f85c2010-06-25 22:07:34 +00002859 if (!DV || !ProcessedVars.insert(DV))
2860 continue;
Devang Patel648df7b2010-06-30 00:11:08 +00002861 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel5c0f85c2010-06-25 22:07:34 +00002862 if (Scope)
2863 Scope->addVariable(new DbgVariable(DV));
2864 }
2865 }
2866 }
Devang Patelc5b31092010-06-30 01:40:11 +00002867 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
2868 constructScopeDIE(*AI);
Devang Patel5c0f85c2010-06-25 22:07:34 +00002869 }
Devang Patel30265c42010-07-07 20:12:52 +00002870
Devang Patel075e9b52010-05-04 06:15:30 +00002871 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002872
Devang Patel075e9b52010-05-04 06:15:30 +00002873 if (!DisableFramePointerElim(*MF))
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002874 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel075e9b52010-05-04 06:15:30 +00002875 dwarf::DW_FORM_flag, 1);
2876
2877
Chris Lattner3a383cb2010-04-05 00:13:49 +00002878 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel530a0752010-01-04 20:44:00 +00002879 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00002880 }
2881
Bill Wendling2b128d72009-05-20 23:19:06 +00002882 // Clear debug info
Devang Patelfe189e62010-01-19 01:26:02 +00002883 CurrentFnDbgScope = NULL;
Devang Patel002d54d2010-05-26 19:37:24 +00002884 InsnNeedsLabel.clear();
Devang Patele1c53f22010-05-20 16:36:41 +00002885 DbgVariableToFrameIndexMap.clear();
2886 VarToAbstractVarMap.clear();
2887 DbgVariableToDbgInstMap.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002888 DeleteContainerSeconds(DbgScopeMap);
Devang Patel541019d2010-04-09 16:04:20 +00002889 InsnsEndScopeSet.clear();
Devang Patelfe189e62010-01-19 01:26:02 +00002890 ConcreteScopes.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002891 DeleteContainerSeconds(AbstractScopes);
Devang Patelfe189e62010-01-19 01:26:02 +00002892 AbstractScopesList.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002893 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00002894 LabelsBeforeInsn.clear();
2895 LabelsAfterInsn.clear();
Devang Patel12563b32010-04-16 23:33:45 +00002896 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00002897}
2898
Devang Patele1c53f22010-05-20 16:36:41 +00002899/// recordVariableFrameIndex - Record a variable's index.
2900void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2901 assert (V && "Invalid DbgVariable!");
2902 DbgVariableToFrameIndexMap[V] = Index;
2903}
2904
2905/// findVariableFrameIndex - Return true if frame index for the variable
2906/// is found. Update FI to hold value of the index.
2907bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
2908 assert (V && "Invalid DbgVariable!");
2909 DenseMap<const DbgVariable *, int>::iterator I =
2910 DbgVariableToFrameIndexMap.find(V);
2911 if (I == DbgVariableToFrameIndexMap.end())
2912 return false;
2913 *FI = I->second;
2914 return true;
2915}
2916
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002917/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patel490c8ab2010-05-20 19:57:06 +00002918/// instruction.
2919DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
2920 DbgScope *Scope = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002921 LLVMContext &Ctx =
Devang Patel490c8ab2010-05-20 19:57:06 +00002922 MInsn->getParent()->getParent()->getFunction()->getContext();
2923 DebugLoc DL = MInsn->getDebugLoc();
2924
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002925 if (DL.isUnknown())
Devang Patel490c8ab2010-05-20 19:57:06 +00002926 return Scope;
2927
2928 if (const MDNode *IA = DL.getInlinedAt(Ctx))
2929 Scope = ConcreteScopes.lookup(IA);
2930 if (Scope == 0)
2931 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002932
Devang Patel490c8ab2010-05-20 19:57:06 +00002933 return Scope;
2934}
2935
2936
Chris Lattnerba35a672010-03-09 04:54:43 +00002937/// recordSourceLine - Register a source line with debug info. Returns the
2938/// unique label that was emitted and which provides correspondence to
2939/// the source line list.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002940MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel30265c42010-07-07 20:12:52 +00002941 const MDNode *S) {
Devang Patel2d9caf92009-11-25 17:36:49 +00002942 StringRef Fn;
Devang Patel2089d162009-10-05 18:03:19 +00002943
Dan Gohman50849c62010-05-05 23:41:32 +00002944 unsigned Src = 1;
2945 if (S) {
2946 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00002947
Dan Gohman50849c62010-05-05 23:41:32 +00002948 if (Scope.isCompileUnit()) {
2949 DICompileUnit CU(S);
Dan Gohman50849c62010-05-05 23:41:32 +00002950 Fn = CU.getFilename();
Devang Patelc4b69052010-10-28 17:30:52 +00002951 } else if (Scope.isFile()) {
2952 DIFile F(S);
Devang Patelc4b69052010-10-28 17:30:52 +00002953 Fn = F.getFilename();
Dan Gohman50849c62010-05-05 23:41:32 +00002954 } else if (Scope.isSubprogram()) {
2955 DISubprogram SP(S);
Dan Gohman50849c62010-05-05 23:41:32 +00002956 Fn = SP.getFilename();
2957 } else if (Scope.isLexicalBlock()) {
2958 DILexicalBlock DB(S);
Dan Gohman50849c62010-05-05 23:41:32 +00002959 Fn = DB.getFilename();
2960 } else
2961 assert(0 && "Unexpected scope info");
2962
Rafael Espindola67c6ab82010-11-18 02:04:25 +00002963 Src = GetOrCreateSourceID(Fn);
Dan Gohman50849c62010-05-05 23:41:32 +00002964 }
2965
Rafael Espindola67c6ab82010-11-18 02:04:25 +00002966 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, DWARF2_FLAG_IS_STMT,
2967 0, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00002968
Rafael Espindola67c6ab82010-11-18 02:04:25 +00002969 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattnerba35a672010-03-09 04:54:43 +00002970 Asm->OutStreamer.EmitLabel(Label);
2971 return Label;
Bill Wendling2b128d72009-05-20 23:19:06 +00002972}
2973
Bill Wendling806535f2009-05-20 23:22:40 +00002974//===----------------------------------------------------------------------===//
2975// Emit Methods
2976//===----------------------------------------------------------------------===//
2977
Devang Patel930143b2009-11-21 02:48:08 +00002978/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling480ff322009-05-20 23:21:38 +00002979///
Jim Grosbach00e9c612009-11-22 19:20:36 +00002980unsigned
2981DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling480ff322009-05-20 23:21:38 +00002982 // Get the children.
2983 const std::vector<DIE *> &Children = Die->getChildren();
2984
2985 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00002986 if (!Last && !Children.empty())
Benjamin Kramer74729ae2010-03-31 19:34:01 +00002987 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling480ff322009-05-20 23:21:38 +00002988
2989 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00002990 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00002991
2992 // Get the abbreviation for this DIE.
2993 unsigned AbbrevNumber = Die->getAbbrevNumber();
2994 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2995
2996 // Set DIE offset
2997 Die->setOffset(Offset);
2998
2999 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00003000 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003001
3002 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
3003 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3004
3005 // Size the DIE attribute values.
3006 for (unsigned i = 0, N = Values.size(); i < N; ++i)
3007 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00003008 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00003009
3010 // Size the DIE children if any.
3011 if (!Children.empty()) {
3012 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
3013 "Children flag not set");
3014
3015 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003016 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling480ff322009-05-20 23:21:38 +00003017
3018 // End of children marker.
3019 Offset += sizeof(int8_t);
3020 }
3021
3022 Die->setSize(Offset - Die->getOffset());
3023 return Offset;
3024}
3025
Devang Patel930143b2009-11-21 02:48:08 +00003026/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling480ff322009-05-20 23:21:38 +00003027///
Devang Patel930143b2009-11-21 02:48:08 +00003028void DwarfDebug::computeSizeAndOffsets() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003029 unsigned PrevOffset = 0;
3030 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3031 E = CUMap.end(); I != E; ++I) {
3032 // Compute size of compile unit header.
3033 static unsigned Offset = PrevOffset +
3034 sizeof(int32_t) + // Length of Compilation Unit Info
3035 sizeof(int16_t) + // DWARF version number
3036 sizeof(int32_t) + // Offset Into Abbrev. Section
3037 sizeof(int8_t); // Pointer Size (in bytes)
3038 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
3039 PrevOffset = Offset;
3040 }
Bill Wendling480ff322009-05-20 23:21:38 +00003041}
3042
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003043/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3044/// temporary label to it if SymbolStem is specified.
Chris Lattner6629ca92010-04-04 22:59:04 +00003045static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003046 const char *SymbolStem = 0) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003047 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003048 if (!SymbolStem) return 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003049
Chris Lattner6629ca92010-04-04 22:59:04 +00003050 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3051 Asm->OutStreamer.EmitLabel(TmpSym);
3052 return TmpSym;
3053}
3054
3055/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3056/// the start of each one.
Chris Lattner46355d82010-04-04 22:33:59 +00003057void DwarfDebug::EmitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003058 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003059
Bill Wendling480ff322009-05-20 23:21:38 +00003060 // Dwarf sections base addresses.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003061 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003062 DwarfFrameSectionSym =
3063 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3064 }
Bill Wendling480ff322009-05-20 23:21:38 +00003065
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003066 DwarfInfoSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003067 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003068 DwarfAbbrevSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003069 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003070 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003071
Chris Lattner6629ca92010-04-04 22:59:04 +00003072 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003073 EmitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003074
Devang Patel4a213872010-08-24 00:06:12 +00003075 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003076 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3077 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3078 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003079 DwarfStrSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003080 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patel12563b32010-04-16 23:33:45 +00003081 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3082 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00003083
Devang Patel9fc11702010-05-25 23:40:22 +00003084 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3085 "section_debug_loc");
3086
Chris Lattner6629ca92010-04-04 22:59:04 +00003087 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattnere58b5472010-04-04 23:10:38 +00003088 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003089}
3090
Devang Patel930143b2009-11-21 02:48:08 +00003091/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling480ff322009-05-20 23:21:38 +00003092///
Devang Patel930143b2009-11-21 02:48:08 +00003093void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00003094 // Get the abbreviation for this DIE.
3095 unsigned AbbrevNumber = Die->getAbbrevNumber();
3096 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3097
Bill Wendling480ff322009-05-20 23:21:38 +00003098 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00003099 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00003100 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3101 Twine::utohexstr(Die->getOffset()) + ":0x" +
3102 Twine::utohexstr(Die->getSize()) + " " +
3103 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00003104 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003105
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00003106 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00003107 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3108
3109 // Emit the DIE attribute values.
3110 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3111 unsigned Attr = AbbrevData[i].getAttribute();
3112 unsigned Form = AbbrevData[i].getForm();
3113 assert(Form && "Too many attributes for DIE (check abbreviation)");
3114
Chris Lattner7bde8c02010-04-04 18:52:31 +00003115 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00003116 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003117
Bill Wendling480ff322009-05-20 23:21:38 +00003118 switch (Attr) {
3119 case dwarf::DW_AT_sibling:
Devang Patel930143b2009-11-21 02:48:08 +00003120 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003121 break;
3122 case dwarf::DW_AT_abstract_origin: {
3123 DIEEntry *E = cast<DIEEntry>(Values[i]);
3124 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003125 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00003126 Asm->EmitInt32(Addr);
3127 break;
3128 }
Devang Patel12563b32010-04-16 23:33:45 +00003129 case dwarf::DW_AT_ranges: {
3130 // DW_AT_range Value encodes offset in debug_range section.
3131 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelda3ef852010-09-02 16:43:44 +00003132
3133 if (Asm->MAI->doesDwarfUsesLabelOffsetForRanges()) {
3134 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
3135 V->getValue(),
3136 4);
3137 } else {
3138 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3139 V->getValue(),
3140 DwarfDebugRangeSectionSym,
3141 4);
3142 }
Devang Patel12563b32010-04-16 23:33:45 +00003143 break;
3144 }
Devang Patel9fc11702010-05-25 23:40:22 +00003145 case dwarf::DW_AT_location: {
3146 if (UseDotDebugLocEntry.count(Die) != 0) {
3147 DIELabel *L = cast<DIELabel>(Values[i]);
3148 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
3149 } else
3150 Values[i]->EmitValue(Asm, Form);
3151 break;
3152 }
Devang Patela1bd5a12010-09-29 19:08:08 +00003153 case dwarf::DW_AT_accessibility: {
3154 if (Asm->isVerbose()) {
3155 DIEInteger *V = cast<DIEInteger>(Values[i]);
3156 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
3157 }
3158 Values[i]->EmitValue(Asm, Form);
3159 break;
3160 }
Bill Wendling480ff322009-05-20 23:21:38 +00003161 default:
3162 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003163 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00003164 break;
3165 }
Bill Wendling480ff322009-05-20 23:21:38 +00003166 }
3167
3168 // Emit the DIE children if any.
3169 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3170 const std::vector<DIE *> &Children = Die->getChildren();
3171
3172 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003173 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00003174
Chris Lattner7bde8c02010-04-04 18:52:31 +00003175 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00003176 Asm->OutStreamer.AddComment("End Of Children Mark");
3177 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003178 }
3179}
3180
Devang Patel9ccfb642009-12-09 18:24:21 +00003181/// emitDebugInfo - Emit the debug info section.
Bill Wendling480ff322009-05-20 23:21:38 +00003182///
Devang Patel9ccfb642009-12-09 18:24:21 +00003183void DwarfDebug::emitDebugInfo() {
3184 // Start debug info section.
3185 Asm->OutStreamer.SwitchSection(
3186 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel1a0df9a2010-05-10 22:49:55 +00003187 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3188 E = CUMap.end(); I != E; ++I) {
3189 CompileUnit *TheCU = I->second;
3190 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003191
Devang Patel1a0df9a2010-05-10 22:49:55 +00003192 // Emit the compile units header.
3193 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3194 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003195
Devang Patel1a0df9a2010-05-10 22:49:55 +00003196 // Emit size of content not including length itself
3197 unsigned ContentSize = Die->getSize() +
3198 sizeof(int16_t) + // DWARF version number
3199 sizeof(int32_t) + // Offset Into Abbrev. Section
3200 sizeof(int8_t) + // Pointer Size (in bytes)
3201 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003202
Devang Patel1a0df9a2010-05-10 22:49:55 +00003203 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3204 Asm->EmitInt32(ContentSize);
3205 Asm->OutStreamer.AddComment("DWARF version number");
3206 Asm->EmitInt16(dwarf::DWARF_VERSION);
3207 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3208 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3209 DwarfAbbrevSectionSym);
3210 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3211 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003212
Devang Patel1a0df9a2010-05-10 22:49:55 +00003213 emitDIE(Die);
3214 // FIXME - extra padding for gdb bug.
3215 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3216 Asm->EmitInt8(0);
3217 Asm->EmitInt8(0);
3218 Asm->EmitInt8(0);
3219 Asm->EmitInt8(0);
3220 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3221 }
Bill Wendling480ff322009-05-20 23:21:38 +00003222}
3223
Devang Patel930143b2009-11-21 02:48:08 +00003224/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling480ff322009-05-20 23:21:38 +00003225///
Devang Patel930143b2009-11-21 02:48:08 +00003226void DwarfDebug::emitAbbreviations() const {
Bill Wendling480ff322009-05-20 23:21:38 +00003227 // Check to see if it is worth the effort.
3228 if (!Abbreviations.empty()) {
3229 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003230 Asm->OutStreamer.SwitchSection(
3231 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003232
Chris Lattnera179b522010-04-04 19:25:43 +00003233 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003234
3235 // For each abbrevation.
3236 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3237 // Get abbreviation data
3238 const DIEAbbrev *Abbrev = Abbreviations[i];
3239
3240 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00003241 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00003242
3243 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003244 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00003245 }
3246
3247 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00003248 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00003249
Chris Lattnera179b522010-04-04 19:25:43 +00003250 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003251 }
3252}
3253
Devang Patel930143b2009-11-21 02:48:08 +00003254/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling480ff322009-05-20 23:21:38 +00003255/// the line matrix.
3256///
Devang Patel930143b2009-11-21 02:48:08 +00003257void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00003258 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00003259 Asm->OutStreamer.AddComment("Extended Op");
3260 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003261
Chris Lattner566cae92010-03-09 23:52:58 +00003262 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003263 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00003264 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3265 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3266
3267 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00003268
Chris Lattnera179b522010-04-04 19:25:43 +00003269 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003270 Asm->getTargetData().getPointerSize(),
3271 0/*AddrSpace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003272
3273 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00003274 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3275 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003276 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00003277 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003278}
3279
Devang Patel930143b2009-11-21 02:48:08 +00003280/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling480ff322009-05-20 23:21:38 +00003281///
Devang Patel930143b2009-11-21 02:48:08 +00003282void DwarfDebug::emitCommonDebugFrame() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003283 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003284 return;
3285
Chris Lattner3a383cb2010-04-05 00:13:49 +00003286 int stackGrowth = Asm->getTargetData().getPointerSize();
Anton Korobeynikov2f931282011-01-10 12:39:04 +00003287 if (Asm->TM.getFrameLowering()->getStackGrowthDirection() ==
3288 TargetFrameLowering::StackGrowsDown)
Chris Lattner3a383cb2010-04-05 00:13:49 +00003289 stackGrowth *= -1;
Bill Wendling480ff322009-05-20 23:21:38 +00003290
3291 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003292 Asm->OutStreamer.SwitchSection(
3293 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003294
Chris Lattnera179b522010-04-04 19:25:43 +00003295 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner566cae92010-03-09 23:52:58 +00003296 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003297 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3298 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003299
Chris Lattnera179b522010-04-04 19:25:43 +00003300 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner566cae92010-03-09 23:52:58 +00003301 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling480ff322009-05-20 23:21:38 +00003302 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner566cae92010-03-09 23:52:58 +00003303 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling480ff322009-05-20 23:21:38 +00003304 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner566cae92010-03-09 23:52:58 +00003305 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003306 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner9efd1182010-04-04 19:09:29 +00003307 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3308 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner566cae92010-03-09 23:52:58 +00003309 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003310 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Anton Korobeynikov2f931282011-01-10 12:39:04 +00003311 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
Bill Wendling480ff322009-05-20 23:21:38 +00003312 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling480ff322009-05-20 23:21:38 +00003313
3314 std::vector<MachineMove> Moves;
Anton Korobeynikov14ee3442010-11-18 23:25:52 +00003315 TFI->getInitialFrameState(Moves);
Bill Wendling480ff322009-05-20 23:21:38 +00003316
Chris Lattneraabc6042010-04-04 23:41:46 +00003317 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003318
Chris Lattner9e06e532010-04-28 01:05:45 +00003319 Asm->EmitAlignment(2);
Chris Lattnera179b522010-04-04 19:25:43 +00003320 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003321}
3322
Devang Patel930143b2009-11-21 02:48:08 +00003323/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling480ff322009-05-20 23:21:38 +00003324/// section.
Chris Lattner2c3f4782010-03-13 07:26:18 +00003325void DwarfDebug::
3326emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003327 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003328 return;
3329
3330 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003331 Asm->OutStreamer.SwitchSection(
3332 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003333
Chris Lattner566cae92010-03-09 23:52:58 +00003334 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner2c3f4782010-03-13 07:26:18 +00003335 MCSymbol *DebugFrameBegin =
Chris Lattnera179b522010-04-04 19:25:43 +00003336 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003337 MCSymbol *DebugFrameEnd =
Chris Lattnera179b522010-04-04 19:25:43 +00003338 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnerf1429f12010-04-04 19:58:12 +00003339 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003340
Chris Lattner2c3f4782010-03-13 07:26:18 +00003341 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling480ff322009-05-20 23:21:38 +00003342
Chris Lattner566cae92010-03-09 23:52:58 +00003343 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003344 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner70a4fce2010-04-04 23:25:33 +00003345 DwarfFrameSectionSym);
Bill Wendling480ff322009-05-20 23:21:38 +00003346
Chris Lattner566cae92010-03-09 23:52:58 +00003347 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnera179b522010-04-04 19:25:43 +00003348 MCSymbol *FuncBeginSym =
3349 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattner8811e122010-03-13 07:40:56 +00003350 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattner3a383cb2010-04-05 00:13:49 +00003351 Asm->getTargetData().getPointerSize(),
3352 0/*AddrSpace*/);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003353
3354
Chris Lattner566cae92010-03-09 23:52:58 +00003355 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003356 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003357 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003358
Chris Lattneraabc6042010-04-04 23:41:46 +00003359 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003360
Chris Lattner9e06e532010-04-28 01:05:45 +00003361 Asm->EmitAlignment(2);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003362 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling480ff322009-05-20 23:21:38 +00003363}
3364
Devang Patel9ccfb642009-12-09 18:24:21 +00003365/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3366///
3367void DwarfDebug::emitDebugPubNames() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003368 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3369 E = CUMap.end(); I != E; ++I) {
3370 CompileUnit *TheCU = I->second;
3371 // Start the dwarf pubnames section.
3372 Asm->OutStreamer.SwitchSection(
3373 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003374
Devang Patel1a0df9a2010-05-10 22:49:55 +00003375 Asm->OutStreamer.AddComment("Length of Public Names Info");
3376 Asm->EmitLabelDifference(
3377 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3378 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003379
Devang Patel1a0df9a2010-05-10 22:49:55 +00003380 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3381 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003382
Devang Patel1a0df9a2010-05-10 22:49:55 +00003383 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003384 Asm->EmitInt16(dwarf::DWARF_VERSION);
3385
Devang Patel1a0df9a2010-05-10 22:49:55 +00003386 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003387 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00003388 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003389
Devang Patel1a0df9a2010-05-10 22:49:55 +00003390 Asm->OutStreamer.AddComment("Compilation Unit Length");
3391 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3392 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3393 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003394
Devang Patel1a0df9a2010-05-10 22:49:55 +00003395 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3396 for (StringMap<DIE*>::const_iterator
3397 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3398 const char *Name = GI->getKeyData();
3399 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003400
Devang Patel1a0df9a2010-05-10 22:49:55 +00003401 Asm->OutStreamer.AddComment("DIE offset");
3402 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003403
Devang Patel1a0df9a2010-05-10 22:49:55 +00003404 if (Asm->isVerbose())
3405 Asm->OutStreamer.AddComment("External Name");
3406 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3407 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003408
Devang Patel1a0df9a2010-05-10 22:49:55 +00003409 Asm->OutStreamer.AddComment("End Mark");
3410 Asm->EmitInt32(0);
3411 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3412 TheCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00003413 }
Bill Wendling480ff322009-05-20 23:21:38 +00003414}
3415
Devang Patel04d2f2d2009-11-24 01:14:22 +00003416void DwarfDebug::emitDebugPubTypes() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003417 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3418 E = CUMap.end(); I != E; ++I) {
3419 CompileUnit *TheCU = I->second;
3420 // Start the dwarf pubnames section.
3421 Asm->OutStreamer.SwitchSection(
3422 Asm->getObjFileLowering().getDwarfPubTypesSection());
3423 Asm->OutStreamer.AddComment("Length of Public Types Info");
3424 Asm->EmitLabelDifference(
3425 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3426 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003427
Devang Patel1a0df9a2010-05-10 22:49:55 +00003428 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3429 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003430
Devang Patel1a0df9a2010-05-10 22:49:55 +00003431 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3432 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003433
Devang Patel1a0df9a2010-05-10 22:49:55 +00003434 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3435 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3436 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003437
Devang Patel1a0df9a2010-05-10 22:49:55 +00003438 Asm->OutStreamer.AddComment("Compilation Unit Length");
3439 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3440 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3441 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003442
Devang Patel1a0df9a2010-05-10 22:49:55 +00003443 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3444 for (StringMap<DIE*>::const_iterator
3445 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3446 const char *Name = GI->getKeyData();
3447 DIE * Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003448
Devang Patel1a0df9a2010-05-10 22:49:55 +00003449 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3450 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003451
Devang Patel1a0df9a2010-05-10 22:49:55 +00003452 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3453 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3454 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003455
Devang Patel1a0df9a2010-05-10 22:49:55 +00003456 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003457 Asm->EmitInt32(0);
Devang Patel1a0df9a2010-05-10 22:49:55 +00003458 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3459 TheCU->getID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00003460 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00003461}
3462
Devang Patel930143b2009-11-21 02:48:08 +00003463/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling480ff322009-05-20 23:21:38 +00003464///
Devang Patel930143b2009-11-21 02:48:08 +00003465void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00003466 // Check to see if it is worth the effort.
Chris Lattner3d72a672010-03-09 23:38:23 +00003467 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003468
Chris Lattner3d72a672010-03-09 23:38:23 +00003469 // Start the dwarf str section.
3470 Asm->OutStreamer.SwitchSection(
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003471 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003472
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003473 // Get all of the string pool entries and put them in an array by their ID so
3474 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003475 SmallVector<std::pair<unsigned,
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003476 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003477
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003478 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3479 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3480 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003481
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003482 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003483
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003484 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00003485 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003486 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003487
Chris Lattner3d72a672010-03-09 23:38:23 +00003488 // Emit the string itself.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003489 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003490 }
3491}
3492
Devang Patel930143b2009-11-21 02:48:08 +00003493/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling480ff322009-05-20 23:21:38 +00003494///
Devang Patel930143b2009-11-21 02:48:08 +00003495void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003496 if (DotDebugLocEntries.empty())
3497 return;
3498
Bill Wendling480ff322009-05-20 23:21:38 +00003499 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003500 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00003501 Asm->getObjFileLowering().getDwarfLocSection());
3502 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003503 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3504 unsigned index = 1;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003505 for (SmallVector<DotDebugLocEntry, 4>::iterator
3506 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00003507 I != E; ++I, ++index) {
Devang Patel9fc11702010-05-25 23:40:22 +00003508 DotDebugLocEntry Entry = *I;
Devang Patel9fc11702010-05-25 23:40:22 +00003509 if (Entry.isEmpty()) {
3510 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3511 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003512 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00003513 } else {
3514 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3515 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3516 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3517 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patel0e60e672010-08-04 18:40:52 +00003518 if (int Offset = Entry.Loc.getOffset()) {
3519 // If the value is at a certain offset from frame register then
3520 // use DW_OP_fbreg.
3521 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patel9fc11702010-05-25 23:40:22 +00003522 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patel0e60e672010-08-04 18:40:52 +00003523 Asm->EmitInt16(1 + OffsetSize);
3524 Asm->OutStreamer.AddComment(
3525 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3526 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3527 Asm->OutStreamer.AddComment("Offset");
3528 Asm->EmitSLEB128(Offset);
Devang Patel9fc11702010-05-25 23:40:22 +00003529 } else {
Devang Patel0e60e672010-08-04 18:40:52 +00003530 if (Reg < 32) {
3531 Asm->OutStreamer.AddComment("Loc expr size");
3532 Asm->EmitInt16(1);
3533 Asm->OutStreamer.AddComment(
Devang Patel6d21f612010-08-04 20:32:36 +00003534 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patel0e60e672010-08-04 18:40:52 +00003535 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3536 } else {
3537 Asm->OutStreamer.AddComment("Loc expr size");
3538 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3539 Asm->EmitInt8(dwarf::DW_OP_regx);
3540 Asm->EmitULEB128(Reg);
3541 }
Devang Patel9fc11702010-05-25 23:40:22 +00003542 }
3543 }
3544 }
Bill Wendling480ff322009-05-20 23:21:38 +00003545}
3546
3547/// EmitDebugARanges - Emit visible names into a debug aranges section.
3548///
3549void DwarfDebug::EmitDebugARanges() {
3550 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003551 Asm->OutStreamer.SwitchSection(
3552 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003553}
3554
Devang Patel930143b2009-11-21 02:48:08 +00003555/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling480ff322009-05-20 23:21:38 +00003556///
Devang Patel930143b2009-11-21 02:48:08 +00003557void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00003558 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003559 Asm->OutStreamer.SwitchSection(
Devang Patel12563b32010-04-16 23:33:45 +00003560 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Patel6c74a872010-04-27 19:46:33 +00003561 unsigned char Size = Asm->getTargetData().getPointerSize();
3562 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003563 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00003564 I != E; ++I) {
3565 if (*I)
3566 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patel12563b32010-04-16 23:33:45 +00003567 else
Devang Patel6c74a872010-04-27 19:46:33 +00003568 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel12563b32010-04-16 23:33:45 +00003569 }
Bill Wendling480ff322009-05-20 23:21:38 +00003570}
3571
Devang Patel930143b2009-11-21 02:48:08 +00003572/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling480ff322009-05-20 23:21:38 +00003573///
Devang Patel930143b2009-11-21 02:48:08 +00003574void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003575 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00003576 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00003577 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003578 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003579 }
3580}
3581
Devang Patel930143b2009-11-21 02:48:08 +00003582/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling480ff322009-05-20 23:21:38 +00003583/// Section Header:
3584/// 1. length of section
3585/// 2. Dwarf version number
3586/// 3. address size.
3587///
3588/// Entries (one "entry" for each function that was inlined):
3589///
3590/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3591/// otherwise offset into __debug_str for regular function name.
3592/// 2. offset into __debug_str section for regular function name.
3593/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3594/// instances for the function.
3595///
3596/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3597/// inlined instance; the die_offset points to the inlined_subroutine die in the
3598/// __debug_info section, and the low_pc is the starting address for the
3599/// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00003600void DwarfDebug::emitDebugInlineInfo() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003601 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003602 return;
3603
Devang Patel1a0df9a2010-05-10 22:49:55 +00003604 if (!FirstCU)
Bill Wendling480ff322009-05-20 23:21:38 +00003605 return;
3606
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003607 Asm->OutStreamer.SwitchSection(
3608 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003609
Chris Lattner566cae92010-03-09 23:52:58 +00003610 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003611 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3612 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003613
Chris Lattnera179b522010-04-04 19:25:43 +00003614 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003615
Chris Lattner566cae92010-03-09 23:52:58 +00003616 Asm->OutStreamer.AddComment("Dwarf Version");
3617 Asm->EmitInt16(dwarf::DWARF_VERSION);
3618 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003619 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003620
Devang Patel32cc43c2010-05-07 20:54:48 +00003621 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003622 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00003623
Devang Patel32cc43c2010-05-07 20:54:48 +00003624 const MDNode *Node = *I;
3625 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00003626 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003627 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00003628 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00003629 StringRef LName = SP.getLinkageName();
3630 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00003631
Chris Lattner566cae92010-03-09 23:52:58 +00003632 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003633 if (LName.empty()) {
3634 Asm->OutStreamer.EmitBytes(Name, 0);
3635 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003636 } else
Chris Lattner70a4fce2010-04-04 23:25:33 +00003637 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3638 DwarfStrSectionSym);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003639
Chris Lattner566cae92010-03-09 23:52:58 +00003640 Asm->OutStreamer.AddComment("Function name");
Chris Lattner70a4fce2010-04-04 23:25:33 +00003641 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner9efd1182010-04-04 19:09:29 +00003642 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00003643
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003644 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00003645 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner7bde8c02010-04-04 18:52:31 +00003646 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner085b6522010-03-09 00:31:02 +00003647 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003648
Chris Lattner7bde8c02010-04-04 18:52:31 +00003649 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003650 Asm->OutStreamer.EmitSymbolValue(LI->first,
3651 Asm->getTargetData().getPointerSize(),0);
Bill Wendling480ff322009-05-20 23:21:38 +00003652 }
3653 }
3654
Chris Lattnera179b522010-04-04 19:25:43 +00003655 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003656}