blob: 45d48b5165457166056daada70dcc0bbdfea86e5 [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"
27#include "llvm/Target/TargetFrameInfo.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"
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000033#include "llvm/ADT/STLExtras.h"
Chris Lattner06fa1762009-08-24 03:52:50 +000034#include "llvm/ADT/StringExtras.h"
Devang Patel6c74a872010-04-27 19:46:33 +000035#include "llvm/Support/CommandLine.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000036#include "llvm/Support/Debug.h"
37#include "llvm/Support/ErrorHandling.h"
Devang Patel1973df22010-01-26 21:39:14 +000038#include "llvm/Support/ValueHandle.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000039#include "llvm/Support/FormattedStream.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000040#include "llvm/Support/Timer.h"
41#include "llvm/System/Path.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000042using namespace llvm;
43
Devang Patel6c74a872010-04-27 19:46:33 +000044static cl::opt<bool> PrintDbgScope("print-dbgscope", cl::Hidden,
45 cl::desc("Print DbgScope information for each machine instruction"));
46
Jim Grosbacha8683bb2010-07-21 21:21:52 +000047static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel30265c42010-07-07 20:12:52 +000048 cl::Hidden,
Devang Patel6c74a872010-04-27 19:46:33 +000049 cl::desc("Disable debug info printing"));
50
Dan Gohman7421ae42010-05-07 01:08:53 +000051static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
52 cl::desc("Make an absense of debug location information explicit."),
53 cl::init(false));
54
Bill Wendlingfcc14142010-04-07 09:28:04 +000055namespace {
56 const char *DWARFGroupName = "DWARF Emission";
57 const char *DbgTimerName = "DWARF Debug Writer";
58} // end anonymous namespace
59
Bill Wendling2f921f82009-05-15 09:23:25 +000060//===----------------------------------------------------------------------===//
61
62/// Configuration values for initial hash set sizes (log2).
63///
Bill Wendling2f921f82009-05-15 09:23:25 +000064static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +000065
66namespace llvm {
67
68//===----------------------------------------------------------------------===//
69/// CompileUnit - This dwarf writer support class manages information associate
70/// with a source file.
Nick Lewyckyb7993d62009-11-17 08:11:44 +000071class CompileUnit {
Bill Wendling2f921f82009-05-15 09:23:25 +000072 /// ID - File identifier for source.
73 ///
74 unsigned ID;
75
76 /// Die - Compile unit debug information entry.
77 ///
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000078 const OwningPtr<DIE> CUDie;
Bill Wendling2f921f82009-05-15 09:23:25 +000079
Jeffrey Yasskin0708de12010-03-11 18:29:55 +000080 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
Devang Patel92e8c652009-11-21 00:31:03 +000081 DIE *IndexTyDie;
82
Devang Patel9a0339f2010-07-07 20:49:57 +000083 /// MDNodeToDieMap - Tracks the mapping of unit level debug informaton
Bill Wendling2f921f82009-05-15 09:23:25 +000084 /// variables to debug information entries.
Devang Patel9a0339f2010-07-07 20:49:57 +000085 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
Bill Wendling2f921f82009-05-15 09:23:25 +000086
Devang Patel9a0339f2010-07-07 20:49:57 +000087 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug informaton
Bill Wendling2f921f82009-05-15 09:23:25 +000088 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patel9a0339f2010-07-07 20:49:57 +000089 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
Bill Wendling2f921f82009-05-15 09:23:25 +000090
91 /// Globals - A map of globally visible named entities for this unit.
92 ///
93 StringMap<DIE*> Globals;
94
Devang Patel04d2f2d2009-11-24 01:14:22 +000095 /// GlobalTypes - A map of globally visible types for this unit.
96 ///
97 StringMap<DIE*> GlobalTypes;
98
Bill Wendling2f921f82009-05-15 09:23:25 +000099public:
100 CompileUnit(unsigned I, DIE *D)
Devang Patel930143b2009-11-21 02:48:08 +0000101 : ID(I), CUDie(D), IndexTyDie(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000102
103 // Accessors.
Devang Patel04d2f2d2009-11-24 01:14:22 +0000104 unsigned getID() const { return ID; }
Jeffrey Yasskin0708de12010-03-11 18:29:55 +0000105 DIE* getCUDie() const { return CUDie.get(); }
Devang Patel04d2f2d2009-11-24 01:14:22 +0000106 const StringMap<DIE*> &getGlobals() const { return Globals; }
107 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000108
109 /// hasContent - Return true if this compile unit has something to write out.
110 ///
Devang Patel930143b2009-11-21 02:48:08 +0000111 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000112
Devang Patel930143b2009-11-21 02:48:08 +0000113 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +0000114 ///
Benjamin Kramer96956ed2010-03-31 20:15:45 +0000115 void addGlobal(StringRef Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000116
Devang Patel04d2f2d2009-11-24 01:14:22 +0000117 /// addGlobalType - Add a new global type to the compile unit.
118 ///
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000119 void addGlobalType(StringRef Name, DIE *Die) {
120 GlobalTypes[Name] = Die;
Devang Patel04d2f2d2009-11-24 01:14:22 +0000121 }
122
Devang Patele064ad42009-11-20 21:37:22 +0000123 /// getDIE - Returns the debug information entry map slot for the
Bill Wendling2f921f82009-05-15 09:23:25 +0000124 /// specified debug variable.
Devang Patel9a0339f2010-07-07 20:49:57 +0000125 DIE *getDIE(const MDNode *N) { return MDNodeToDieMap.lookup(N); }
Jim Grosbach042483e2009-11-21 23:12:12 +0000126
Devang Patele064ad42009-11-20 21:37:22 +0000127 /// insertDIE - Insert DIE into the map.
Devang Patel32cc43c2010-05-07 20:54:48 +0000128 void insertDIE(const MDNode *N, DIE *D) {
Devang Patel9a0339f2010-07-07 20:49:57 +0000129 MDNodeToDieMap.insert(std::make_pair(N, D));
Devang Patele064ad42009-11-20 21:37:22 +0000130 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000131
Devang Patele064ad42009-11-20 21:37:22 +0000132 /// getDIEEntry - Returns the debug information entry for the speciefied
133 /// debug variable.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000134 DIEEntry *getDIEEntry(const MDNode *N) {
135 DenseMap<const MDNode *, DIEEntry *>::iterator I =
136 MDNodeToDIEEntryMap.find(N);
Devang Patel9a0339f2010-07-07 20:49:57 +0000137 if (I == MDNodeToDIEEntryMap.end())
Devang Patel1f4690c2009-12-15 19:16:48 +0000138 return NULL;
139 return I->second;
140 }
Devang Patele064ad42009-11-20 21:37:22 +0000141
142 /// insertDIEEntry - Insert debug information entry into the map.
Devang Patel32cc43c2010-05-07 20:54:48 +0000143 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
Devang Patel9a0339f2010-07-07 20:49:57 +0000144 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
Bill Wendling2f921f82009-05-15 09:23:25 +0000145 }
146
Devang Patel930143b2009-11-21 02:48:08 +0000147 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +0000148 ///
Devang Patel930143b2009-11-21 02:48:08 +0000149 void addDie(DIE *Buffer) {
150 this->CUDie->addChild(Buffer);
Bill Wendling2f921f82009-05-15 09:23:25 +0000151 }
Devang Patel92e8c652009-11-21 00:31:03 +0000152
153 // getIndexTyDie - Get an anonymous type for index type.
154 DIE *getIndexTyDie() {
155 return IndexTyDie;
156 }
157
Jim Grosbach00e9c612009-11-22 19:20:36 +0000158 // setIndexTyDie - Set D as anonymous type for index which can be reused
159 // later.
Devang Patel92e8c652009-11-21 00:31:03 +0000160 void setIndexTyDie(DIE *D) {
161 IndexTyDie = D;
162 }
163
Bill Wendling2f921f82009-05-15 09:23:25 +0000164};
165
166//===----------------------------------------------------------------------===//
167/// DbgVariable - This class is used to track local variable information.
168///
Devang Patelf3d7c082009-11-16 21:53:40 +0000169class DbgVariable {
Bill Wendling2f921f82009-05-15 09:23:25 +0000170 DIVariable Var; // Variable Descriptor.
Devang Patel9fc11702010-05-25 23:40:22 +0000171 DIE *TheDIE; // Variable DIE.
172 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
Bill Wendling2f921f82009-05-15 09:23:25 +0000173public:
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000174 // AbsVar may be NULL.
Devang Patel9fc11702010-05-25 23:40:22 +0000175 DbgVariable(DIVariable V) : Var(V), TheDIE(0), DotDebugLocOffset(~0U) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000176
177 // Accessors.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000178 DIVariable getVariable() const { return Var; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000179 void setDIE(DIE *D) { TheDIE = D; }
180 DIE *getDIE() const { return TheDIE; }
Devang Patel9fc11702010-05-25 23:40:22 +0000181 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
182 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000183};
184
185//===----------------------------------------------------------------------===//
Devang Patel6c74a872010-04-27 19:46:33 +0000186/// DbgRange - This is used to track range of instructions with identical
187/// debug info scope.
188///
189typedef std::pair<const MachineInstr *, const MachineInstr *> DbgRange;
190
191//===----------------------------------------------------------------------===//
Bill Wendling2f921f82009-05-15 09:23:25 +0000192/// DbgScope - This class is used to track scope information.
193///
Devang Patelf3d7c082009-11-16 21:53:40 +0000194class DbgScope {
Bill Wendling2f921f82009-05-15 09:23:25 +0000195 DbgScope *Parent; // Parent to this scope.
Jim Grosbach042483e2009-11-21 23:12:12 +0000196 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel1973df22010-01-26 21:39:14 +0000197 // Location at which this scope is inlined.
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000198 AssertingVH<const MDNode> InlinedAtLocation;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000199 bool AbstractScope; // Abstract Scope
Devang Patel787f94c2009-10-01 18:25:23 +0000200 const MachineInstr *LastInsn; // Last instruction of this scope.
201 const MachineInstr *FirstInsn; // First instruction of this scope.
Devang Patel6c74a872010-04-27 19:46:33 +0000202 unsigned DFSIn, DFSOut;
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000203 // Scopes defined in scope. Contents not owned.
204 SmallVector<DbgScope *, 4> Scopes;
205 // Variables declared in scope. Contents owned.
206 SmallVector<DbgVariable *, 8> Variables;
Devang Patel6c74a872010-04-27 19:46:33 +0000207 SmallVector<DbgRange, 4> Ranges;
Owen Anderson9becc182009-06-24 22:53:20 +0000208 // Private state for dump()
209 mutable unsigned IndentLevel;
Bill Wendling2f921f82009-05-15 09:23:25 +0000210public:
Devang Patel32cc43c2010-05-07 20:54:48 +0000211 DbgScope(DbgScope *P, DIDescriptor D, const MDNode *I = 0)
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000212 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Devang Patel6c74a872010-04-27 19:46:33 +0000213 LastInsn(0), FirstInsn(0),
214 DFSIn(0), DFSOut(0), IndentLevel(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000215 virtual ~DbgScope();
216
217 // Accessors.
218 DbgScope *getParent() const { return Parent; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000219 void setParent(DbgScope *P) { Parent = P; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000220 DIDescriptor getDesc() const { return Desc; }
Devang Patel32cc43c2010-05-07 20:54:48 +0000221 const MDNode *getInlinedAt() const { return InlinedAtLocation; }
222 const MDNode *getScopeNode() const { return Desc; }
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000223 const SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
Devang Patel406798a2010-08-09 18:51:29 +0000224 const SmallVector<DbgVariable *, 8> &getDbgVariables() { return Variables; }
Devang Patel6c74a872010-04-27 19:46:33 +0000225 const SmallVector<DbgRange, 4> &getRanges() { return Ranges; }
226
227 /// openInsnRange - This scope covers instruction range starting from MI.
228 void openInsnRange(const MachineInstr *MI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000229 if (!FirstInsn)
Devang Patel6c74a872010-04-27 19:46:33 +0000230 FirstInsn = MI;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000231
Devang Patel6c74a872010-04-27 19:46:33 +0000232 if (Parent)
233 Parent->openInsnRange(MI);
234 }
235
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000236 /// extendInsnRange - Extend the current instruction range covered by
Devang Patel6c74a872010-04-27 19:46:33 +0000237 /// this scope.
238 void extendInsnRange(const MachineInstr *MI) {
239 assert (FirstInsn && "MI Range is not open!");
240 LastInsn = MI;
241 if (Parent)
242 Parent->extendInsnRange(MI);
243 }
244
245 /// closeInsnRange - Create a range based on FirstInsn and LastInsn collected
246 /// until now. This is used when a new scope is encountered while walking
247 /// machine instructions.
248 void closeInsnRange(DbgScope *NewScope = NULL) {
249 assert (LastInsn && "Last insn missing!");
250 Ranges.push_back(DbgRange(FirstInsn, LastInsn));
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000251 FirstInsn = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +0000252 LastInsn = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000253 // If Parent dominates NewScope then do not close Parent's instruction
Devang Patel6c74a872010-04-27 19:46:33 +0000254 // range.
255 if (Parent && (!NewScope || !Parent->dominates(NewScope)))
256 Parent->closeInsnRange(NewScope);
257 }
258
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000259 void setAbstractScope() { AbstractScope = true; }
260 bool isAbstractScope() const { return AbstractScope; }
Devang Patel6c74a872010-04-27 19:46:33 +0000261
262 // Depth First Search support to walk and mainpluate DbgScope hierarchy.
263 unsigned getDFSOut() const { return DFSOut; }
264 void setDFSOut(unsigned O) { DFSOut = O; }
265 unsigned getDFSIn() const { return DFSIn; }
266 void setDFSIn(unsigned I) { DFSIn = I; }
267 bool dominates(const DbgScope *S) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000268 if (S == this)
Devang Patel6c74a872010-04-27 19:46:33 +0000269 return true;
270 if (DFSIn < S->getDFSIn() && DFSOut > S->getDFSOut())
271 return true;
272 return false;
273 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000274
Devang Patel930143b2009-11-21 02:48:08 +0000275 /// addScope - Add a scope to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000276 ///
Devang Patel930143b2009-11-21 02:48:08 +0000277 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000278
Devang Patel930143b2009-11-21 02:48:08 +0000279 /// addVariable - Add a variable to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000280 ///
Devang Patel930143b2009-11-21 02:48:08 +0000281 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000282
Bill Wendling2f921f82009-05-15 09:23:25 +0000283#ifndef NDEBUG
284 void dump() const;
285#endif
286};
Devang Patel6c74a872010-04-27 19:46:33 +0000287
Chris Lattnerf5d06362010-04-05 04:09:20 +0000288} // end llvm namespace
Bill Wendling2f921f82009-05-15 09:23:25 +0000289
290#ifndef NDEBUG
291void DbgScope::dump() const {
David Greenec230cb92009-12-24 00:31:35 +0000292 raw_ostream &err = dbgs();
Chris Lattner81e8e022009-08-23 00:51:00 +0000293 err.indent(IndentLevel);
Devang Patel32cc43c2010-05-07 20:54:48 +0000294 const MDNode *N = Desc;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000295 N->dump();
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000296 if (AbstractScope)
297 err << "Abstract Scope\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000298
299 IndentLevel += 2;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000300 if (!Scopes.empty())
301 err << "Children ...\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000302 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
303 if (Scopes[i] != this)
304 Scopes[i]->dump();
305
306 IndentLevel -= 2;
307}
308#endif
309
Bill Wendling2f921f82009-05-15 09:23:25 +0000310DbgScope::~DbgScope() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000311 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
312 delete Variables[j];
Bill Wendling2f921f82009-05-15 09:23:25 +0000313}
314
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000315DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Devang Patel1a0df9a2010-05-10 22:49:55 +0000316 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000317 AbbreviationsSet(InitAbbreviationsSetSize),
Devang Patel12563b32010-04-16 23:33:45 +0000318 CurrentFnDbgScope(0), PrevLabel(NULL) {
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000319 NextStringPoolNumber = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000320
Chris Lattnere58b5472010-04-04 23:10:38 +0000321 DwarfFrameSectionSym = DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
322 DwarfStrSectionSym = TextSectionSym = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000323 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
Devang Patel24bc1b52010-06-29 20:17:53 +0000324 DwarfDebugLineSectionSym = CurrentLineSectionSym = 0;
Devang Patel9fc11702010-05-25 23:40:22 +0000325 FunctionBeginSym = FunctionEndSym = 0;
Devang Patel9c160e12010-07-08 20:10:35 +0000326 DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
Dan Gohman6e681a52010-06-18 15:56:31 +0000327 {
328 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
329 beginModule(M);
Torok Edwinf8dba242010-04-07 10:44:46 +0000330 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000331}
332DwarfDebug::~DwarfDebug() {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000333 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
334 DIEBlocks[j]->~DIEBlock();
Bill Wendling2f921f82009-05-15 09:23:25 +0000335}
336
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000337MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
338 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
339 if (Entry.first) return Entry.first;
340
341 Entry.second = NextStringPoolNumber++;
Chris Lattnera179b522010-04-04 19:25:43 +0000342 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000343}
344
345
Devang Patel930143b2009-11-21 02:48:08 +0000346/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling2f921f82009-05-15 09:23:25 +0000347///
Devang Patel930143b2009-11-21 02:48:08 +0000348void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000349 // Profile the node so that we can make it unique.
350 FoldingSetNodeID ID;
351 Abbrev.Profile(ID);
352
353 // Check the set for priors.
354 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
355
356 // If it's newly added.
357 if (InSet == &Abbrev) {
358 // Add to abbreviation list.
359 Abbreviations.push_back(&Abbrev);
360
361 // Assign the vector position + 1 as its number.
362 Abbrev.setNumber(Abbreviations.size());
363 } else {
364 // Assign existing abbreviation number.
365 Abbrev.setNumber(InSet->getNumber());
366 }
367}
368
Devang Patel930143b2009-11-21 02:48:08 +0000369/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendlingbcad77a2009-05-20 23:24:48 +0000370/// information entry.
Devang Patel930143b2009-11-21 02:48:08 +0000371DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000372 DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000373 return Value;
374}
375
Devang Patel930143b2009-11-21 02:48:08 +0000376/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000377///
Devang Patel930143b2009-11-21 02:48:08 +0000378void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000379 unsigned Form, uint64_t Integer) {
380 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000381 DIEValue *Value = Integer == 1 ?
Devang Patel9c160e12010-07-08 20:10:35 +0000382 DIEIntegerOne : new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000383 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000384}
385
Devang Patel930143b2009-11-21 02:48:08 +0000386/// addSInt - Add an signed integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000387///
Devang Patel930143b2009-11-21 02:48:08 +0000388void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000389 unsigned Form, int64_t Integer) {
390 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000391 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000392 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000393}
394
Devang Patel8c339592009-12-02 15:25:16 +0000395/// addString - Add a string attribute data and value. DIEString only
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000396/// keeps string reference.
Devang Patel930143b2009-11-21 02:48:08 +0000397void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerc3f23b82010-01-23 03:11:46 +0000398 StringRef String) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000399 DIEValue *Value = new (DIEValueAllocator) DIEString(String);
Devang Patel930143b2009-11-21 02:48:08 +0000400 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000401}
402
Devang Patel930143b2009-11-21 02:48:08 +0000403/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000404///
Devang Patel930143b2009-11-21 02:48:08 +0000405void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000406 const MCSymbol *Label) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000407 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
Devang Patel930143b2009-11-21 02:48:08 +0000408 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000409}
410
Devang Patel930143b2009-11-21 02:48:08 +0000411/// addDelta - Add a label delta attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000412///
Devang Patel930143b2009-11-21 02:48:08 +0000413void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000414 const MCSymbol *Hi, const MCSymbol *Lo) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000415 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
Devang Patel930143b2009-11-21 02:48:08 +0000416 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000417}
418
Chris Lattner3f3fb972010-04-05 05:24:55 +0000419/// addDIEEntry - Add a DIE attribute data and value.
420///
421void DwarfDebug::addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form,
422 DIE *Entry) {
423 Die->addValue(Attribute, Form, createDIEEntry(Entry));
424}
425
426
Devang Patel930143b2009-11-21 02:48:08 +0000427/// addBlock - Add block data.
Bill Wendling2f921f82009-05-15 09:23:25 +0000428///
Devang Patel930143b2009-11-21 02:48:08 +0000429void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling2f921f82009-05-15 09:23:25 +0000430 DIEBlock *Block) {
Chris Lattner5a00dea2010-04-05 00:18:22 +0000431 Block->ComputeSize(Asm);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000432 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
Devang Patel930143b2009-11-21 02:48:08 +0000433 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000434}
435
Devang Patel930143b2009-11-21 02:48:08 +0000436/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000437/// entry.
Devang Patel930143b2009-11-21 02:48:08 +0000438void DwarfDebug::addSourceLine(DIE *Die, const DIVariable *V) {
Devang Patel0625af22010-05-07 23:33:41 +0000439 // Verify variable.
440 if (!V->Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000441 return;
442
443 unsigned Line = V->getLineNumber();
Devang Patel8119fe872010-03-08 22:02:50 +0000444 unsigned FileID = GetOrCreateSourceID(V->getContext().getDirectory(),
445 V->getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000446 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000447 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
448 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000449}
450
Devang Patel930143b2009-11-21 02:48:08 +0000451/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000452/// entry.
Devang Patelcbe7a852010-05-07 23:19:07 +0000453void DwarfDebug::addSourceLine(DIE *Die, const DIGlobalVariable *G) {
Devang Patel0625af22010-05-07 23:33:41 +0000454 // Verify global variable.
455 if (!G->Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000456 return;
457
458 unsigned Line = G->getLineNumber();
Devang Patel8119fe872010-03-08 22:02:50 +0000459 unsigned FileID = GetOrCreateSourceID(G->getContext().getDirectory(),
460 G->getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000461 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000462 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
463 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000464}
Devang Patelb2de5fa2009-08-31 22:47:13 +0000465
Devang Patel930143b2009-11-21 02:48:08 +0000466/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000467/// entry.
Devang Patel930143b2009-11-21 02:48:08 +0000468void DwarfDebug::addSourceLine(DIE *Die, const DISubprogram *SP) {
Devang Patel0625af22010-05-07 23:33:41 +0000469 // Verify subprogram.
470 if (!SP->Verify())
Devang Patelb2de5fa2009-08-31 22:47:13 +0000471 return;
Caroline Tice183a5192009-09-11 18:25:54 +0000472 // If the line number is 0, don't add it.
473 if (SP->getLineNumber() == 0)
474 return;
475
Devang Patelb2de5fa2009-08-31 22:47:13 +0000476 unsigned Line = SP->getLineNumber();
Devang Patel8119fe872010-03-08 22:02:50 +0000477 if (!SP->getContext().Verify())
478 return;
Devang Patel834392f2010-03-24 21:30:35 +0000479 unsigned FileID = GetOrCreateSourceID(SP->getDirectory(),
480 SP->getFilename());
Devang Patelb2de5fa2009-08-31 22:47:13 +0000481 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000482 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
483 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patelb2de5fa2009-08-31 22:47:13 +0000484}
485
Devang Patel930143b2009-11-21 02:48:08 +0000486/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000487/// entry.
Devang Patel930143b2009-11-21 02:48:08 +0000488void DwarfDebug::addSourceLine(DIE *Die, const DIType *Ty) {
Devang Patel0625af22010-05-07 23:33:41 +0000489 // Verify type.
490 if (!Ty->Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000491 return;
492
493 unsigned Line = Ty->getLineNumber();
Devang Patel8119fe872010-03-08 22:02:50 +0000494 if (!Ty->getContext().Verify())
495 return;
496 unsigned FileID = GetOrCreateSourceID(Ty->getContext().getDirectory(),
497 Ty->getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000498 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000499 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
500 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000501}
502
Devang Patel1f4690c2009-12-15 19:16:48 +0000503/// addSourceLine - Add location information to specified debug information
504/// entry.
505void DwarfDebug::addSourceLine(DIE *Die, const DINameSpace *NS) {
Devang Patel0625af22010-05-07 23:33:41 +0000506 // Verify namespace.
507 if (!NS->Verify())
Devang Patel1f4690c2009-12-15 19:16:48 +0000508 return;
509
510 unsigned Line = NS->getLineNumber();
511 StringRef FN = NS->getFilename();
512 StringRef Dir = NS->getDirectory();
513
514 unsigned FileID = GetOrCreateSourceID(Dir, FN);
515 assert(FileID && "Invalid file id");
516 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
517 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
518}
519
Caroline Ticec87c1e22009-08-31 21:19:37 +0000520/* Byref variables, in Blocks, are declared by the programmer as
521 "SomeType VarName;", but the compiler creates a
522 __Block_byref_x_VarName struct, and gives the variable VarName
523 either the struct, or a pointer to the struct, as its type. This
524 is necessary for various behind-the-scenes things the compiler
525 needs to do with by-reference variables in blocks.
526
527 However, as far as the original *programmer* is concerned, the
528 variable should still have type 'SomeType', as originally declared.
529
530 The following function dives into the __Block_byref_x_VarName
531 struct to find the original type of the variable. This will be
532 passed back to the code generating the type for the Debug
533 Information Entry for the variable 'VarName'. 'VarName' will then
534 have the original type 'SomeType' in its debug information.
535
536 The original type 'SomeType' will be the type of the field named
537 'VarName' inside the __Block_byref_x_VarName struct.
538
539 NOTE: In order for this to not completely fail on the debugger
540 side, the Debug Information Entry for the variable VarName needs to
541 have a DW_AT_location that tells the debugger how to unwind through
542 the pointers and __Block_byref_x_VarName struct to find the actual
Devang Patel930143b2009-11-21 02:48:08 +0000543 value of the variable. The function addBlockByrefType does this. */
Caroline Ticec87c1e22009-08-31 21:19:37 +0000544
545/// Find the type the programmer originally declared the variable to be
546/// and return that type.
547///
Devang Patel930143b2009-11-21 02:48:08 +0000548DIType DwarfDebug::getBlockByrefType(DIType Ty, std::string Name) {
Caroline Ticec87c1e22009-08-31 21:19:37 +0000549
550 DIType subType = Ty;
551 unsigned tag = Ty.getTag();
552
553 if (tag == dwarf::DW_TAG_pointer_type) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000554 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000555 subType = DTy.getTypeDerivedFrom();
556 }
557
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000558 DICompositeType blockStruct = DICompositeType(subType);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000559 DIArray Elements = blockStruct.getTypeArray();
560
Caroline Ticec87c1e22009-08-31 21:19:37 +0000561 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
562 DIDescriptor Element = Elements.getElement(i);
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000563 DIDerivedType DT = DIDerivedType(Element);
Devang Patel2d9caf92009-11-25 17:36:49 +0000564 if (Name == DT.getName())
Caroline Ticec87c1e22009-08-31 21:19:37 +0000565 return (DT.getTypeDerivedFrom());
566 }
567
568 return Ty;
569}
570
Devang Patel930143b2009-11-21 02:48:08 +0000571/// addComplexAddress - Start with the address based on the location provided,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000572/// and generate the DWARF information necessary to find the actual variable
573/// given the extra address information encoded in the DIVariable, starting from
574/// the starting location. Add the DWARF information to the die.
575///
Devang Patel930143b2009-11-21 02:48:08 +0000576void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000577 unsigned Attribute,
578 const MachineLocation &Location) {
579 const DIVariable &VD = DV->getVariable();
580 DIType Ty = VD.getType();
581
582 // Decode the original location, and use that as the start of the byref
583 // variable's location.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000584 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000585 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000586 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000587
588 if (Location.isReg()) {
589 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000590 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000591 } else {
592 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel930143b2009-11-21 02:48:08 +0000593 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
594 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000595 }
596 } else {
597 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000598 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000599 else {
Devang Patel930143b2009-11-21 02:48:08 +0000600 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
601 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000602 }
603
Devang Patel930143b2009-11-21 02:48:08 +0000604 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump14cf8ec2009-09-30 00:08:22 +0000605 }
606
607 for (unsigned i = 0, N = VD.getNumAddrElements(); i < N; ++i) {
608 uint64_t Element = VD.getAddrElement(i);
609
610 if (Element == DIFactory::OpPlus) {
Devang Patel930143b2009-11-21 02:48:08 +0000611 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
612 addUInt(Block, 0, dwarf::DW_FORM_udata, VD.getAddrElement(++i));
Mike Stump14cf8ec2009-09-30 00:08:22 +0000613 } else if (Element == DIFactory::OpDeref) {
Devang Patel930143b2009-11-21 02:48:08 +0000614 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000615 } else llvm_unreachable("unknown DIFactory Opcode");
616 }
617
618 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000619 addBlock(Die, Attribute, 0, Block);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000620}
621
Caroline Ticec87c1e22009-08-31 21:19:37 +0000622/* Byref variables, in Blocks, are declared by the programmer as "SomeType
623 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
624 gives the variable VarName either the struct, or a pointer to the struct, as
625 its type. This is necessary for various behind-the-scenes things the
626 compiler needs to do with by-reference variables in Blocks.
627
628 However, as far as the original *programmer* is concerned, the variable
629 should still have type 'SomeType', as originally declared.
630
Devang Patel930143b2009-11-21 02:48:08 +0000631 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticec87c1e22009-08-31 21:19:37 +0000632 struct to find the original type of the variable, which is then assigned to
633 the variable's Debug Information Entry as its real type. So far, so good.
634 However now the debugger will expect the variable VarName to have the type
635 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000636 expression that explains to the debugger how to navigate through the
Caroline Ticec87c1e22009-08-31 21:19:37 +0000637 pointers and struct to find the actual variable of type SomeType.
638
639 The following function does just that. We start by getting
640 the "normal" location for the variable. This will be the location
641 of either the struct __Block_byref_x_VarName or the pointer to the
642 struct __Block_byref_x_VarName.
643
644 The struct will look something like:
645
646 struct __Block_byref_x_VarName {
647 ... <various fields>
648 struct __Block_byref_x_VarName *forwarding;
649 ... <various other fields>
650 SomeType VarName;
651 ... <maybe more fields>
652 };
653
654 If we are given the struct directly (as our starting point) we
655 need to tell the debugger to:
656
657 1). Add the offset of the forwarding field.
658
Dan Gohman4a618822010-02-10 16:03:48 +0000659 2). Follow that pointer to get the real __Block_byref_x_VarName
Caroline Ticec87c1e22009-08-31 21:19:37 +0000660 struct to use (the real one may have been copied onto the heap).
661
662 3). Add the offset for the field VarName, to find the actual variable.
663
664 If we started with a pointer to the struct, then we need to
665 dereference that pointer first, before the other steps.
666 Translating this into DWARF ops, we will need to append the following
667 to the current location description for the variable:
668
669 DW_OP_deref -- optional, if we start with a pointer
670 DW_OP_plus_uconst <forward_fld_offset>
671 DW_OP_deref
672 DW_OP_plus_uconst <varName_fld_offset>
673
674 That is what this function does. */
675
Devang Patel930143b2009-11-21 02:48:08 +0000676/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticec87c1e22009-08-31 21:19:37 +0000677/// provided, and generate the DWARF information necessary to find the
678/// actual Block variable (navigating the Block struct) based on the
679/// starting location. Add the DWARF information to the die. For
680/// more information, read large comment just above here.
681///
Devang Patel930143b2009-11-21 02:48:08 +0000682void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000683 unsigned Attribute,
684 const MachineLocation &Location) {
Caroline Ticec87c1e22009-08-31 21:19:37 +0000685 const DIVariable &VD = DV->getVariable();
686 DIType Ty = VD.getType();
687 DIType TmpTy = Ty;
688 unsigned Tag = Ty.getTag();
689 bool isPointer = false;
690
Devang Patel2d9caf92009-11-25 17:36:49 +0000691 StringRef varName = VD.getName();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000692
693 if (Tag == dwarf::DW_TAG_pointer_type) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000694 DIDerivedType DTy = DIDerivedType(Ty);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000695 TmpTy = DTy.getTypeDerivedFrom();
696 isPointer = true;
697 }
698
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000699 DICompositeType blockStruct = DICompositeType(TmpTy);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000700
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000701 // Find the __forwarding field and the variable field in the __Block_byref
702 // struct.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000703 DIArray Fields = blockStruct.getTypeArray();
704 DIDescriptor varField = DIDescriptor();
705 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000706
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000707 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
708 DIDescriptor Element = Fields.getElement(i);
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000709 DIDerivedType DT = DIDerivedType(Element);
Devang Patel2d9caf92009-11-25 17:36:49 +0000710 StringRef fieldName = DT.getName();
711 if (fieldName == "__forwarding")
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000712 forwardingField = Element;
Devang Patel2d9caf92009-11-25 17:36:49 +0000713 else if (fieldName == varName)
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000714 varField = Element;
715 }
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000716
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000717 // Get the offsets for the forwarding field and the variable field.
Chris Lattner71696ef2010-03-31 06:06:37 +0000718 unsigned forwardingFieldOffset =
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000719 DIDerivedType(forwardingField).getOffsetInBits() >> 3;
Chris Lattner71696ef2010-03-31 06:06:37 +0000720 unsigned varFieldOffset =
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000721 DIDerivedType(varField).getOffsetInBits() >> 3;
Caroline Ticec87c1e22009-08-31 21:19:37 +0000722
Mike Stump944fa252009-09-24 23:21:26 +0000723 // Decode the original location, and use that as the start of the byref
724 // variable's location.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000725 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000726 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000727 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000728
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000729 if (Location.isReg()) {
730 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000731 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000732 else {
733 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel930143b2009-11-21 02:48:08 +0000734 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
735 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000736 }
737 } else {
738 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000739 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000740 else {
Devang Patel930143b2009-11-21 02:48:08 +0000741 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
742 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000743 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000744
Devang Patel930143b2009-11-21 02:48:08 +0000745 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000746 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000747
Mike Stump944fa252009-09-24 23:21:26 +0000748 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000749 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000750 if (isPointer)
Devang Patel930143b2009-11-21 02:48:08 +0000751 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000752
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000753 // Next add the offset for the '__forwarding' field:
754 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
755 // adding the offset if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000756 if (forwardingFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000757 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
758 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000759 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000760
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000761 // Now dereference the __forwarding field to get to the real __Block_byref
762 // struct: DW_OP_deref.
Devang Patel930143b2009-11-21 02:48:08 +0000763 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000764
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000765 // Now that we've got the real __Block_byref... struct, add the offset
766 // for the variable's field to get to the location of the actual variable:
767 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000768 if (varFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000769 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
770 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000771 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000772
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000773 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000774 addBlock(Die, Attribute, 0, Block);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000775}
776
Devang Patel930143b2009-11-21 02:48:08 +0000777/// addAddress - Add an address attribute to a die based on the location
Bill Wendling2f921f82009-05-15 09:23:25 +0000778/// provided.
Devang Patel930143b2009-11-21 02:48:08 +0000779void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000780 const MachineLocation &Location) {
Chris Lattner3a383cb2010-04-05 00:13:49 +0000781 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling2f921f82009-05-15 09:23:25 +0000782 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000783 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Bill Wendling2f921f82009-05-15 09:23:25 +0000784
785 if (Location.isReg()) {
786 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000787 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000788 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000789 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
790 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000791 }
792 } else {
793 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000794 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000795 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000796 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
797 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000798 }
799
Devang Patel930143b2009-11-21 02:48:08 +0000800 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling2f921f82009-05-15 09:23:25 +0000801 }
802
Devang Patel930143b2009-11-21 02:48:08 +0000803 addBlock(Die, Attribute, 0, Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000804}
805
Devang Patel173b2b92010-04-28 01:03:09 +0000806/// addRegisterAddress - Add register location entry in variable DIE.
Devang Patele1c53f22010-05-20 16:36:41 +0000807bool DwarfDebug::addRegisterAddress(DIE *Die, const MCSymbol *VS,
Devang Patel173b2b92010-04-28 01:03:09 +0000808 const MachineOperand &MO) {
809 assert (MO.isReg() && "Invalid machine operand!");
810 if (!MO.getReg())
811 return false;
812 MachineLocation Location;
813 Location.set(MO.getReg());
814 addAddress(Die, dwarf::DW_AT_location, Location);
Devang Patele1c53f22010-05-20 16:36:41 +0000815 if (VS)
Devang Patel173b2b92010-04-28 01:03:09 +0000816 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
817 return true;
818}
819
820/// addConstantValue - Add constant value entry in variable DIE.
Devang Patele1c53f22010-05-20 16:36:41 +0000821bool DwarfDebug::addConstantValue(DIE *Die, const MCSymbol *VS,
Devang Patel173b2b92010-04-28 01:03:09 +0000822 const MachineOperand &MO) {
823 assert (MO.isImm() && "Invalid machine operand!");
824 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
825 unsigned Imm = MO.getImm();
826 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
827 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patele1c53f22010-05-20 16:36:41 +0000828 if (VS)
Devang Patel173b2b92010-04-28 01:03:09 +0000829 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
830 return true;
831}
832
833/// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patele1c53f22010-05-20 16:36:41 +0000834bool DwarfDebug::addConstantFPValue(DIE *Die, const MCSymbol *VS,
Devang Patel173b2b92010-04-28 01:03:09 +0000835 const MachineOperand &MO) {
836 assert (MO.isFPImm() && "Invalid machine operand!");
837 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
838 APFloat FPImm = MO.getFPImm()->getValueAPF();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000839
Devang Patel173b2b92010-04-28 01:03:09 +0000840 // Get the raw data form of the floating point.
841 const APInt FltVal = FPImm.bitcastToAPInt();
842 const char *FltPtr = (const char*)FltVal.getRawData();
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000843
Devang Patel173b2b92010-04-28 01:03:09 +0000844 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
845 bool LittleEndian = Asm->getTargetData().isLittleEndian();
846 int Incr = (LittleEndian ? 1 : -1);
847 int Start = (LittleEndian ? 0 : NumBytes - 1);
848 int Stop = (LittleEndian ? NumBytes : -1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000849
Devang Patel173b2b92010-04-28 01:03:09 +0000850 // Output the constant to DWARF one byte at a time.
851 for (; Start != Stop; Start += Incr)
852 addUInt(Block, 0, dwarf::DW_FORM_data1,
853 (unsigned char)0xFF & FltPtr[Start]);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000854
Devang Patel173b2b92010-04-28 01:03:09 +0000855 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
Devang Patele1c53f22010-05-20 16:36:41 +0000856 if (VS)
857 addLabel(Die, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr, VS);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000858 return true;
Devang Patel173b2b92010-04-28 01:03:09 +0000859}
860
861
Devang Patel2b75ed22009-12-10 19:14:49 +0000862/// addToContextOwner - Add Die into the list of its context owner's children.
863void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000864 if (Context.isType()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000865 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
Devang Patel2b75ed22009-12-10 19:14:49 +0000866 ContextDIE->addChild(Die);
Devang Patel1f4690c2009-12-15 19:16:48 +0000867 } else if (Context.isNameSpace()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000868 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
Devang Patel1f4690c2009-12-15 19:16:48 +0000869 ContextDIE->addChild(Die);
Stuart Hastingsafe54f12010-06-11 20:08:44 +0000870 } else if (Context.isSubprogram()) {
871 DIE *ContextDIE = createSubprogramDIE(DISubprogram(Context),
872 /*MakeDecl=*/false);
873 ContextDIE->addChild(Die);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000874 } else if (DIE *ContextDIE = getCompileUnit(Context)->getDIE(Context))
Devang Patel2b75ed22009-12-10 19:14:49 +0000875 ContextDIE->addChild(Die);
Jim Grosbacha8683bb2010-07-21 21:21:52 +0000876 else
Devang Patel1a0df9a2010-05-10 22:49:55 +0000877 getCompileUnit(Context)->addDie(Die);
Devang Patel2b75ed22009-12-10 19:14:49 +0000878}
879
Devang Patelb5b60ea2009-12-10 18:05:33 +0000880/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
881/// given DIType.
882DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
Devang Patel1a0df9a2010-05-10 22:49:55 +0000883 CompileUnit *TypeCU = getCompileUnit(Ty);
884 DIE *TyDIE = TypeCU->getDIE(Ty);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000885 if (TyDIE)
886 return TyDIE;
887
888 // Create new type.
889 TyDIE = new DIE(dwarf::DW_TAG_base_type);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000890 TypeCU->insertDIE(Ty, TyDIE);
Devang Patelb5b60ea2009-12-10 18:05:33 +0000891 if (Ty.isBasicType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000892 constructTypeDIE(*TyDIE, DIBasicType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000893 else if (Ty.isCompositeType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000894 constructTypeDIE(*TyDIE, DICompositeType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000895 else {
896 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000897 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
Devang Patelb5b60ea2009-12-10 18:05:33 +0000898 }
899
Devang Patel2b75ed22009-12-10 19:14:49 +0000900 addToContextOwner(TyDIE, Ty.getContext());
Devang Patelb5b60ea2009-12-10 18:05:33 +0000901 return TyDIE;
902}
903
Devang Patel930143b2009-11-21 02:48:08 +0000904/// addType - Add a new type attribute to the specified entity.
Devang Patel9ccfb642009-12-09 18:24:21 +0000905void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel8d6a2b72010-05-07 21:45:47 +0000906 if (!Ty.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000907 return;
908
909 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +0000910 CompileUnit *TypeCU = getCompileUnit(Ty);
911 DIEEntry *Entry = TypeCU->getDIEEntry(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000912 // If it exists then use the existing value.
Devang Patel930143b2009-11-21 02:48:08 +0000913 if (Entry) {
914 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000915 return;
916 }
917
Bill Wendling2f921f82009-05-15 09:23:25 +0000918 // Construct type.
Devang Patelb5b60ea2009-12-10 18:05:33 +0000919 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000920
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000921 // Set up proxy.
922 Entry = createDIEEntry(Buffer);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000923 TypeCU->insertDIEEntry(Ty, Entry);
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000924
Devang Patel930143b2009-11-21 02:48:08 +0000925 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000926}
927
Devang Patel930143b2009-11-21 02:48:08 +0000928/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000929void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000930 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000931 StringRef Name = BTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +0000932 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +0000933 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling2f921f82009-05-15 09:23:25 +0000934 BTy.getEncoding());
935
936 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +0000937 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +0000938 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +0000939 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel930143b2009-11-21 02:48:08 +0000940 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +0000941}
942
Devang Patel930143b2009-11-21 02:48:08 +0000943/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000944void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000945 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000946 StringRef Name = DTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +0000947 uint64_t Size = DTy.getSizeInBits() >> 3;
948 unsigned Tag = DTy.getTag();
949
950 // FIXME - Workaround for templates.
951 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
952
953 Buffer.setTag(Tag);
954
955 // Map to main type, void will not have a type.
956 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel9ccfb642009-12-09 18:24:21 +0000957 addType(&Buffer, FromTy);
Bill Wendling2f921f82009-05-15 09:23:25 +0000958
959 // Add name if not anonymous or intermediate type.
Devang Patelae466ef2009-11-30 23:56:56 +0000960 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +0000961 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +0000962
963 // Add size if non-zero (derived types might be zero-sized.)
964 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +0000965 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +0000966
967 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patelb5b51592009-11-23 18:43:37 +0000968 if (!DTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +0000969 addSourceLine(&Buffer, &DTy);
Bill Wendling2f921f82009-05-15 09:23:25 +0000970}
971
Devang Patel930143b2009-11-21 02:48:08 +0000972/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000973void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000974 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000975 StringRef Name = CTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +0000976
977 uint64_t Size = CTy.getSizeInBits() >> 3;
978 unsigned Tag = CTy.getTag();
979 Buffer.setTag(Tag);
980
981 switch (Tag) {
982 case dwarf::DW_TAG_vector_type:
983 case dwarf::DW_TAG_array_type:
Devang Patel9ccfb642009-12-09 18:24:21 +0000984 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +0000985 break;
986 case dwarf::DW_TAG_enumeration_type: {
987 DIArray Elements = CTy.getTypeArray();
988
989 // Add enumerators to enumeration type.
990 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
991 DIE *ElemDie = NULL;
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000992 DIDescriptor Enum(Elements.getElement(i));
Devang Patel3b548aa2010-03-08 20:52:55 +0000993 if (Enum.isEnumerator()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +0000994 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
Devang Patel930143b2009-11-21 02:48:08 +0000995 Buffer.addChild(ElemDie);
Devang Patelfafa1fe2009-10-09 17:51:49 +0000996 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000997 }
998 }
999 break;
1000 case dwarf::DW_TAG_subroutine_type: {
1001 // Add return type.
1002 DIArray Elements = CTy.getTypeArray();
1003 DIDescriptor RTy = Elements.getElement(0);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001004 addType(&Buffer, DIType(RTy));
Bill Wendling2f921f82009-05-15 09:23:25 +00001005
1006 // Add prototype flag.
Devang Patel930143b2009-11-21 02:48:08 +00001007 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001008
1009 // Add arguments.
1010 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1011 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1012 DIDescriptor Ty = Elements.getElement(i);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001013 addType(Arg, DIType(Ty));
Devang Patel930143b2009-11-21 02:48:08 +00001014 Buffer.addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +00001015 }
1016 }
1017 break;
1018 case dwarf::DW_TAG_structure_type:
1019 case dwarf::DW_TAG_union_type:
1020 case dwarf::DW_TAG_class_type: {
1021 // Add elements to structure type.
1022 DIArray Elements = CTy.getTypeArray();
1023
1024 // A forward struct declared type may not have elements available.
Devang Patel3b548aa2010-03-08 20:52:55 +00001025 unsigned N = Elements.getNumElements();
1026 if (N == 0)
Bill Wendling2f921f82009-05-15 09:23:25 +00001027 break;
1028
1029 // Add elements to structure type.
Devang Patel3b548aa2010-03-08 20:52:55 +00001030 for (unsigned i = 0; i < N; ++i) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001031 DIDescriptor Element = Elements.getElement(i);
1032 DIE *ElemDie = NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001033 if (Element.isSubprogram())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001034 ElemDie = createSubprogramDIE(DISubprogram(Element));
Devang Patel3b548aa2010-03-08 20:52:55 +00001035 else if (Element.isVariable()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001036 DIVariable DV(Element);
Devang Patel160c92d2010-01-30 01:08:30 +00001037 ElemDie = new DIE(dwarf::DW_TAG_variable);
1038 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1039 DV.getName());
1040 addType(ElemDie, DV.getType());
1041 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1042 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1043 addSourceLine(ElemDie, &DV);
Devang Patel3b548aa2010-03-08 20:52:55 +00001044 } else if (Element.isDerivedType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001045 ElemDie = createMemberDIE(DIDerivedType(Element));
Devang Patel3b548aa2010-03-08 20:52:55 +00001046 else
1047 continue;
Devang Patel930143b2009-11-21 02:48:08 +00001048 Buffer.addChild(ElemDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001049 }
1050
Devang Patel3082c012009-08-27 23:51:51 +00001051 if (CTy.isAppleBlockExtension())
Devang Patel930143b2009-11-21 02:48:08 +00001052 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001053
1054 unsigned RLang = CTy.getRunTimeLang();
1055 if (RLang)
Devang Patel930143b2009-11-21 02:48:08 +00001056 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling2f921f82009-05-15 09:23:25 +00001057 dwarf::DW_FORM_data1, RLang);
Devang Patel303a1be2010-01-26 21:16:06 +00001058
1059 DICompositeType ContainingType = CTy.getContainingType();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001060 if (DIDescriptor(ContainingType).isCompositeType())
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001061 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001062 getOrCreateTypeDIE(DIType(ContainingType)));
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001063 else {
1064 DIDescriptor Context = CTy.getContext();
1065 addToContextOwner(&Buffer, Context);
1066 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001067 break;
1068 }
1069 default:
1070 break;
1071 }
1072
1073 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +00001074 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001075 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001076
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001077 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
Devang Patel30265c42010-07-07 20:12:52 +00001078 || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1079 {
Bill Wendling2f921f82009-05-15 09:23:25 +00001080 // Add size if non-zero (derived types might be zero-sized.)
1081 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +00001082 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +00001083 else {
1084 // Add zero size if it is not a forward declaration.
1085 if (CTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +00001086 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001087 else
Devang Patel930143b2009-11-21 02:48:08 +00001088 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling2f921f82009-05-15 09:23:25 +00001089 }
1090
1091 // Add source line info if available.
1092 if (!CTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +00001093 addSourceLine(&Buffer, &CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001094 }
1095}
1096
Devang Patel930143b2009-11-21 02:48:08 +00001097/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1098void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling2f921f82009-05-15 09:23:25 +00001099 int64_t L = SR.getLo();
1100 int64_t H = SR.getHi();
1101 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1102
Devang Patel930143b2009-11-21 02:48:08 +00001103 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patelf691df32009-08-14 20:59:16 +00001104 if (L)
Devang Patel930143b2009-11-21 02:48:08 +00001105 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Patel8f046022009-12-04 23:10:24 +00001106 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling2f921f82009-05-15 09:23:25 +00001107
Devang Patel930143b2009-11-21 02:48:08 +00001108 Buffer.addChild(DW_Subrange);
Bill Wendling2f921f82009-05-15 09:23:25 +00001109}
1110
Devang Patel930143b2009-11-21 02:48:08 +00001111/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001112void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling2f921f82009-05-15 09:23:25 +00001113 DICompositeType *CTy) {
1114 Buffer.setTag(dwarf::DW_TAG_array_type);
1115 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel930143b2009-11-21 02:48:08 +00001116 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001117
1118 // Emit derived type.
Devang Patel9ccfb642009-12-09 18:24:21 +00001119 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001120 DIArray Elements = CTy->getTypeArray();
1121
Devang Patel92e8c652009-11-21 00:31:03 +00001122 // Get an anonymous type for index type.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001123 CompileUnit *TheCU = getCompileUnit(*CTy);
1124 DIE *IdxTy = TheCU->getIndexTyDie();
Devang Patel92e8c652009-11-21 00:31:03 +00001125 if (!IdxTy) {
1126 // Construct an anonymous type for index type.
1127 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +00001128 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1129 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel92e8c652009-11-21 00:31:03 +00001130 dwarf::DW_ATE_signed);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001131 TheCU->addDie(IdxTy);
1132 TheCU->setIndexTyDie(IdxTy);
Devang Patel92e8c652009-11-21 00:31:03 +00001133 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001134
1135 // Add subranges to array type.
1136 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1137 DIDescriptor Element = Elements.getElement(i);
1138 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001139 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001140 }
1141}
1142
Devang Patel930143b2009-11-21 02:48:08 +00001143/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3b548aa2010-03-08 20:52:55 +00001144DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001145 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3b548aa2010-03-08 20:52:55 +00001146 StringRef Name = ETy.getName();
Devang Patel930143b2009-11-21 02:48:08 +00001147 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3b548aa2010-03-08 20:52:55 +00001148 int64_t Value = ETy.getEnumValue();
Devang Patel930143b2009-11-21 02:48:08 +00001149 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +00001150 return Enumerator;
1151}
1152
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001153/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
Devang Patel43ef34d2010-01-05 01:46:14 +00001154/// printer to not emit usual symbol prefix before the symbol name is used then
1155/// return linkage name after skipping this special LLVM prefix.
1156static StringRef getRealLinkageName(StringRef LinkageName) {
1157 char One = '\1';
1158 if (LinkageName.startswith(StringRef(&One, 1)))
1159 return LinkageName.substr(1);
1160 return LinkageName;
1161}
1162
Devang Patel930143b2009-11-21 02:48:08 +00001163/// createGlobalVariableDIE - Create new DIE using GV.
Devang Patel9ccfb642009-12-09 18:24:21 +00001164DIE *DwarfDebug::createGlobalVariableDIE(const DIGlobalVariable &GV) {
Jim Grosbach00e9c612009-11-22 19:20:36 +00001165 // If the global variable was optmized out then no need to create debug info
1166 // entry.
Devang Patelcc11371b2009-11-06 17:58:12 +00001167 if (!GV.getGlobal()) return NULL;
Devang Patel2d9caf92009-11-25 17:36:49 +00001168 if (GV.getDisplayName().empty()) return NULL;
Devang Patel06ce6502009-11-06 01:30:04 +00001169
Bill Wendling2f921f82009-05-15 09:23:25 +00001170 DIE *GVDie = new DIE(dwarf::DW_TAG_variable);
Jim Grosbach042483e2009-11-21 23:12:12 +00001171 addString(GVDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
Devang Patelb2969422009-09-29 18:40:58 +00001172 GV.getDisplayName());
1173
Devang Patel2d9caf92009-11-25 17:36:49 +00001174 StringRef LinkageName = GV.getLinkageName();
Devang Patel43ef34d2010-01-05 01:46:14 +00001175 if (!LinkageName.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001176 addString(GVDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel43ef34d2010-01-05 01:46:14 +00001177 getRealLinkageName(LinkageName));
1178
Devang Patel9ccfb642009-12-09 18:24:21 +00001179 addType(GVDie, GV.getType());
Bill Wendling2f921f82009-05-15 09:23:25 +00001180 if (!GV.isLocalToUnit())
Devang Patel930143b2009-11-21 02:48:08 +00001181 addUInt(GVDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1182 addSourceLine(GVDie, &GV);
Devang Patel4144a822009-10-05 23:22:08 +00001183
Bill Wendling2f921f82009-05-15 09:23:25 +00001184 return GVDie;
1185}
1186
Devang Patel930143b2009-11-21 02:48:08 +00001187/// createMemberDIE - Create new member DIE.
Devang Patel9ccfb642009-12-09 18:24:21 +00001188DIE *DwarfDebug::createMemberDIE(const DIDerivedType &DT) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001189 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel2d9caf92009-11-25 17:36:49 +00001190 StringRef Name = DT.getName();
1191 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001192 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001193
Devang Patel9ccfb642009-12-09 18:24:21 +00001194 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001195
Devang Patel930143b2009-11-21 02:48:08 +00001196 addSourceLine(MemberDie, &DT);
Bill Wendling2f921f82009-05-15 09:23:25 +00001197
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001198 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel930143b2009-11-21 02:48:08 +00001199 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel67f56f02009-11-04 22:06:12 +00001200
Bill Wendling2f921f82009-05-15 09:23:25 +00001201 uint64_t Size = DT.getSizeInBits();
Devang Patelf05d5722009-11-04 23:48:00 +00001202 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling2f921f82009-05-15 09:23:25 +00001203
1204 if (Size != FieldSize) {
1205 // Handle bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001206 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1207 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling2f921f82009-05-15 09:23:25 +00001208
1209 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling2f921f82009-05-15 09:23:25 +00001210 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1211 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer2b459982010-01-07 17:50:57 +00001212 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling2f921f82009-05-15 09:23:25 +00001213 Offset -= FieldOffset;
1214
1215 // Maybe we need to work from the other end.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001216 if (Asm->getTargetData().isLittleEndian())
1217 Offset = FieldSize - (Offset + Size);
Devang Patel930143b2009-11-21 02:48:08 +00001218 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling2f921f82009-05-15 09:23:25 +00001219
Devang Patel67f56f02009-11-04 22:06:12 +00001220 // Here WD_AT_data_member_location points to the anonymous
1221 // field that includes this bit field.
Devang Patel930143b2009-11-21 02:48:08 +00001222 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001223
1224 } else
1225 // This is not a bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001226 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001227
Devang Pateld2316892010-02-03 20:08:48 +00001228 if (DT.getTag() == dwarf::DW_TAG_inheritance
1229 && DT.isVirtual()) {
1230
1231 // For C++, virtual base classes are not at fixed offset. Use following
1232 // expression to extract appropriate offset from vtable.
1233 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1234
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001235 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Pateld2316892010-02-03 20:08:48 +00001236 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1237 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1238 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1239 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1240 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1241 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1242 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1243
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001244 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
Devang Pateld2316892010-02-03 20:08:48 +00001245 VBaseLocationDie);
1246 } else
1247 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001248
1249 if (DT.isProtected())
Devang Pateleb57c592009-12-03 19:11:07 +00001250 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001251 dwarf::DW_ACCESS_protected);
1252 else if (DT.isPrivate())
Devang Pateleb57c592009-12-03 19:11:07 +00001253 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001254 dwarf::DW_ACCESS_private);
Devang Pateleb57c592009-12-03 19:11:07 +00001255 else if (DT.getTag() == dwarf::DW_TAG_inheritance)
1256 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1257 dwarf::DW_ACCESS_public);
1258 if (DT.isVirtual())
1259 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1260 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling2f921f82009-05-15 09:23:25 +00001261 return MemberDie;
1262}
1263
Devang Patel525dda02009-12-14 16:18:45 +00001264/// createSubprogramDIE - Create new DIE using SP.
1265DIE *DwarfDebug::createSubprogramDIE(const DISubprogram &SP, bool MakeDecl) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001266 CompileUnit *SPCU = getCompileUnit(SP);
1267 DIE *SPDie = SPCU->getDIE(SP);
Devang Patel525dda02009-12-14 16:18:45 +00001268 if (SPDie)
1269 return SPDie;
1270
1271 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf200b392010-03-02 17:58:15 +00001272 // Constructors and operators for anonymous aggregates do not have names.
Devang Pateld0fa3042010-03-02 01:26:20 +00001273 if (!SP.getName().empty())
1274 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling2f921f82009-05-15 09:23:25 +00001275
Devang Patel2d9caf92009-11-25 17:36:49 +00001276 StringRef LinkageName = SP.getLinkageName();
Devang Patel43ef34d2010-01-05 01:46:14 +00001277 if (!LinkageName.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001278 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel43ef34d2010-01-05 01:46:14 +00001279 getRealLinkageName(LinkageName));
1280
Devang Patel930143b2009-11-21 02:48:08 +00001281 addSourceLine(SPDie, &SP);
Bill Wendling2f921f82009-05-15 09:23:25 +00001282
Bill Wendling2f921f82009-05-15 09:23:25 +00001283 // Add prototyped tag, if C or ObjC.
1284 unsigned Lang = SP.getCompileUnit().getLanguage();
1285 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1286 Lang == dwarf::DW_LANG_ObjC)
Devang Patel930143b2009-11-21 02:48:08 +00001287 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001288
1289 // Add Return Type.
Devang Patel236526d2009-12-03 01:25:38 +00001290 DICompositeType SPTy = SP.getType();
1291 DIArray Args = SPTy.getTypeArray();
Bill Wendling2f921f82009-05-15 09:23:25 +00001292 unsigned SPTag = SPTy.getTag();
Devang Pateleb57c592009-12-03 19:11:07 +00001293
Devang Patel3b548aa2010-03-08 20:52:55 +00001294 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel9ccfb642009-12-09 18:24:21 +00001295 addType(SPDie, SPTy);
Devang Patel236526d2009-12-03 01:25:38 +00001296 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001297 addType(SPDie, DIType(Args.getElement(0)));
Devang Patel236526d2009-12-03 01:25:38 +00001298
Devang Pateleb57c592009-12-03 19:11:07 +00001299 unsigned VK = SP.getVirtuality();
1300 if (VK) {
1301 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001302 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Pateleb57c592009-12-03 19:11:07 +00001303 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1304 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1305 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001306 ContainingTypeMap.insert(std::make_pair(SPDie,
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001307 SP.getContainingType()));
Devang Pateleb57c592009-12-03 19:11:07 +00001308 }
1309
Devang Patel525dda02009-12-14 16:18:45 +00001310 if (MakeDecl || !SP.isDefinition()) {
Devang Patel930143b2009-11-21 02:48:08 +00001311 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001312
1313 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel236526d2009-12-03 01:25:38 +00001314 // be handled while processing variables.
1315 DICompositeType SPTy = SP.getType();
1316 DIArray Args = SPTy.getTypeArray();
1317 unsigned SPTag = SPTy.getTag();
1318
Bill Wendling2f921f82009-05-15 09:23:25 +00001319 if (SPTag == dwarf::DW_TAG_subroutine_type)
1320 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1321 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001322 DIType ATy = DIType(DIType(Args.getElement(i)));
Devang Patel6efc8e52010-02-06 01:02:37 +00001323 addType(Arg, ATy);
1324 if (ATy.isArtificial())
1325 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel930143b2009-11-21 02:48:08 +00001326 SPDie->addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +00001327 }
1328 }
1329
Devang Patel999b4992010-02-03 19:57:19 +00001330 if (SP.isArtificial())
1331 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1332
Devang Patelb4e3b902010-04-30 19:38:23 +00001333 if (!SP.isLocalToUnit())
1334 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001335
Devang Patelb4e3b902010-04-30 19:38:23 +00001336 if (SP.isOptimized())
1337 addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1338
Jim Grosbach965a73a2010-07-21 23:03:52 +00001339 if (unsigned isa = Asm->getISAEncoding()) {
1340 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1341 }
1342
Devang Patelb4e3b902010-04-30 19:38:23 +00001343 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001344 SPCU->insertDIE(SP, SPDie);
Devang Patelb4e3b902010-04-30 19:38:23 +00001345
Stuart Hastingsafe54f12010-06-11 20:08:44 +00001346 // Add to context owner.
1347 addToContextOwner(SPDie, SP.getContext());
1348
Bill Wendling2f921f82009-05-15 09:23:25 +00001349 return SPDie;
1350}
1351
Devang Patel32cc43c2010-05-07 20:54:48 +00001352DbgScope *DwarfDebug::getOrCreateAbstractScope(const MDNode *N) {
Chris Lattner8d2fe282010-03-31 05:36:29 +00001353 assert(N && "Invalid Scope encoding!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001354
1355 DbgScope *AScope = AbstractScopes.lookup(N);
1356 if (AScope)
1357 return AScope;
Jim Grosbach042483e2009-11-21 23:12:12 +00001358
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001359 DbgScope *Parent = NULL;
1360
1361 DIDescriptor Scope(N);
1362 if (Scope.isLexicalBlock()) {
1363 DILexicalBlock DB(N);
1364 DIDescriptor ParentDesc = DB.getContext();
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001365 Parent = getOrCreateAbstractScope(ParentDesc);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001366 }
1367
1368 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1369
1370 if (Parent)
Devang Patel930143b2009-11-21 02:48:08 +00001371 Parent->addScope(AScope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001372 AScope->setAbstractScope();
1373 AbstractScopes[N] = AScope;
1374 if (DIDescriptor(N).isSubprogram())
1375 AbstractScopesList.push_back(AScope);
1376 return AScope;
1377}
Devang Patel75cc16c2009-10-01 20:31:14 +00001378
Devang Patel019922d2010-04-06 23:53:48 +00001379/// isSubprogramContext - Return true if Context is either a subprogram
1380/// or another context nested inside a subprogram.
Devang Patel32cc43c2010-05-07 20:54:48 +00001381static bool isSubprogramContext(const MDNode *Context) {
Devang Patel019922d2010-04-06 23:53:48 +00001382 if (!Context)
1383 return false;
1384 DIDescriptor D(Context);
1385 if (D.isSubprogram())
1386 return true;
1387 if (D.isType())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001388 return isSubprogramContext(DIType(Context).getContext());
Devang Patel019922d2010-04-06 23:53:48 +00001389 return false;
1390}
1391
Jim Grosbach042483e2009-11-21 23:12:12 +00001392/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel930143b2009-11-21 02:48:08 +00001393/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1394/// If there are global variables in this scope then create and insert
1395/// DIEs for these variables.
Devang Patel32cc43c2010-05-07 20:54:48 +00001396DIE *DwarfDebug::updateSubprogramScopeDIE(const MDNode *SPNode) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001397 CompileUnit *SPCU = getCompileUnit(SPNode);
1398 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patela37a95e2010-07-07 22:20:57 +00001399
Chris Lattner3a383cb2010-04-05 00:13:49 +00001400 assert(SPDie && "Unable to find subprogram DIE!");
1401 DISubprogram SP(SPNode);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001402
Chris Lattner3a383cb2010-04-05 00:13:49 +00001403 // There is not any need to generate specification DIE for a function
1404 // defined at compile unit level. If a function is defined inside another
1405 // function then gdb prefers the definition at top level and but does not
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001406 // expect specification DIE in parent function. So avoid creating
Chris Lattner3a383cb2010-04-05 00:13:49 +00001407 // specification DIE for a function defined inside a function.
1408 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001409 !SP.getContext().isFile() &&
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001410 !isSubprogramContext(SP.getContext())) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00001411 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001412
1413 // Add arguments.
Chris Lattner3a383cb2010-04-05 00:13:49 +00001414 DICompositeType SPTy = SP.getType();
1415 DIArray Args = SPTy.getTypeArray();
1416 unsigned SPTag = SPTy.getTag();
1417 if (SPTag == dwarf::DW_TAG_subroutine_type)
1418 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1419 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001420 DIType ATy = DIType(DIType(Args.getElement(i)));
Chris Lattner3a383cb2010-04-05 00:13:49 +00001421 addType(Arg, ATy);
1422 if (ATy.isArtificial())
1423 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1424 SPDie->addChild(Arg);
1425 }
1426 DIE *SPDeclDie = SPDie;
1427 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001428 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
Chris Lattner3a383cb2010-04-05 00:13:49 +00001429 SPDeclDie);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001430 SPCU->addDie(SPDie);
Chris Lattner3a383cb2010-04-05 00:13:49 +00001431 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001432
Devang Patela37a95e2010-07-07 22:20:57 +00001433 // Pick up abstract subprogram DIE.
1434 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
1435 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1436 addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
1437 dwarf::DW_FORM_ref4, AbsSPDIE);
1438 SPCU->addDie(SPDie);
1439 }
1440
Chris Lattner3a383cb2010-04-05 00:13:49 +00001441 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1442 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
1443 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1444 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
1445 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1446 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
1447 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patel6efc8e52010-02-06 01:02:37 +00001448
Chris Lattner3a383cb2010-04-05 00:13:49 +00001449 return SPDie;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001450}
1451
Jim Grosbach042483e2009-11-21 23:12:12 +00001452/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel930143b2009-11-21 02:48:08 +00001453/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1454DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001455
1456 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1457 if (Scope->isAbstractScope())
1458 return ScopeDIE;
1459
1460 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
1461 if (Ranges.empty())
1462 return 0;
1463
1464 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
1465 if (Ranges.size() > 1) {
1466 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001467 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Patel6c74a872010-04-27 19:46:33 +00001468 // DW_AT_ranges appropriately.
1469 addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
1470 DebugRangeSymbols.size() * Asm->getTargetData().getPointerSize());
1471 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
1472 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patel9fc11702010-05-25 23:40:22 +00001473 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
1474 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Patel6c74a872010-04-27 19:46:33 +00001475 }
1476 DebugRangeSymbols.push_back(NULL);
1477 DebugRangeSymbols.push_back(NULL);
1478 return ScopeDIE;
1479 }
1480
Devang Patel9fc11702010-05-25 23:40:22 +00001481 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
1482 const MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001483
Devang Patel9fc11702010-05-25 23:40:22 +00001484 if (End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001485
Chris Lattnere13c3722010-03-09 01:58:53 +00001486 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1487 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001488
Devang Patel6c74a872010-04-27 19:46:33 +00001489 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
1490 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001491
1492 return ScopeDIE;
1493}
1494
Devang Patel930143b2009-11-21 02:48:08 +00001495/// constructInlinedScopeDIE - This scope represents inlined body of
1496/// a function. Construct DIE to represent this concrete inlined copy
1497/// of the function.
1498DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patel6c74a872010-04-27 19:46:33 +00001499
1500 const SmallVector<DbgRange, 4> &Ranges = Scope->getRanges();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001501 assert (Ranges.empty() == false
Devang Patel6c74a872010-04-27 19:46:33 +00001502 && "DbgScope does not have instruction markers!");
1503
1504 // FIXME : .debug_inlined section specification does not clearly state how
1505 // to emit inlined scope that is split into multiple instruction ranges.
1506 // For now, use first instruction range and emit low_pc/high_pc pair and
1507 // corresponding .debug_inlined section entry for this pair.
1508 SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin();
Devang Patel9fc11702010-05-25 23:40:22 +00001509 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
1510 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Patel6c74a872010-04-27 19:46:33 +00001511
Devang Patel4c6bd662010-07-08 22:39:20 +00001512 if (StartLabel == 0 || EndLabel == 0) {
Devang Patel6c74a872010-04-27 19:46:33 +00001513 assert (0 && "Unexpected Start and End labels for a inlined scope!");
1514 return 0;
1515 }
Chris Lattnere13c3722010-03-09 01:58:53 +00001516 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001517 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +00001518 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001519 "Invalid end label for an inlined scope!");
Devang Patel6c74a872010-04-27 19:46:33 +00001520
Devang Patel3b548aa2010-03-08 20:52:55 +00001521 if (!Scope->getScopeNode())
Devang Patelbc97f6b2010-03-08 19:20:38 +00001522 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001523 DIScope DS(Scope->getScopeNode());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001524 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1525
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001526 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001527 CompileUnit *TheCU = getCompileUnit(InlinedSP);
1528 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001529 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel930143b2009-11-21 02:48:08 +00001530 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001531 dwarf::DW_FORM_ref4, OriginDIE);
1532
Chris Lattner085b6522010-03-09 00:31:02 +00001533 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnere13c3722010-03-09 01:58:53 +00001534 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001535
1536 InlinedSubprogramDIEs.insert(OriginDIE);
1537
1538 // Track the start label for this inlined function.
Devang Patel32cc43c2010-05-07 20:54:48 +00001539 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001540 I = InlineInfo.find(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001541
1542 if (I == InlineInfo.end()) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001543 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel,
Jim Grosbach00e9c612009-11-22 19:20:36 +00001544 ScopeDIE));
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001545 InlinedSPNodes.push_back(InlinedSP);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001546 } else
Chris Lattner085b6522010-03-09 00:31:02 +00001547 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001548
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001549 DILocation DL(Scope->getInlinedAt());
Devang Patel1a0df9a2010-05-10 22:49:55 +00001550 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, TheCU->getID());
Devang Patel930143b2009-11-21 02:48:08 +00001551 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001552
1553 return ScopeDIE;
1554}
1555
Devang Patel930143b2009-11-21 02:48:08 +00001556
1557/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel9ccfb642009-12-09 18:24:21 +00001558DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001559 // Get the descriptor.
1560 const DIVariable &VD = DV->getVariable();
Devang Patel2d9caf92009-11-25 17:36:49 +00001561 StringRef Name = VD.getName();
1562 if (Name.empty())
Devang Patel97f99fa2009-11-13 02:25:26 +00001563 return NULL;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001564
1565 // Translate tag to proper Dwarf tag. The result variable is dropped for
1566 // now.
1567 unsigned Tag;
1568 switch (VD.getTag()) {
1569 case dwarf::DW_TAG_return_variable:
1570 return NULL;
1571 case dwarf::DW_TAG_arg_variable:
1572 Tag = dwarf::DW_TAG_formal_parameter;
1573 break;
1574 case dwarf::DW_TAG_auto_variable: // fall thru
1575 default:
1576 Tag = dwarf::DW_TAG_variable;
1577 break;
1578 }
1579
1580 // Define variable debug information entry.
1581 DIE *VariableDie = new DIE(Tag);
1582
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001583 DIE *AbsDIE = NULL;
Devang Patele1c53f22010-05-20 16:36:41 +00001584 DenseMap<const DbgVariable *, const DbgVariable *>::iterator
1585 V2AVI = VarToAbstractVarMap.find(DV);
1586 if (V2AVI != VarToAbstractVarMap.end())
1587 AbsDIE = V2AVI->second->getDIE();
Jim Grosbach042483e2009-11-21 23:12:12 +00001588
Devang Patele1c53f22010-05-20 16:36:41 +00001589 if (AbsDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001590 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001591 dwarf::DW_FORM_ref4, AbsDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001592 else {
Devang Patel930143b2009-11-21 02:48:08 +00001593 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
1594 addSourceLine(VariableDie, &VD);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001595
1596 // Add variable type.
Jim Grosbach042483e2009-11-21 23:12:12 +00001597 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001598 // addresses instead.
1599 if (VD.isBlockByrefVariable())
Devang Patel9ccfb642009-12-09 18:24:21 +00001600 addType(VariableDie, getBlockByrefType(VD.getType(), Name));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001601 else
Devang Patel9ccfb642009-12-09 18:24:21 +00001602 addType(VariableDie, VD.getType());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001603 }
1604
Devang Patel6efc8e52010-02-06 01:02:37 +00001605 if (Tag == dwarf::DW_TAG_formal_parameter && VD.getType().isArtificial())
1606 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel9fc11702010-05-25 23:40:22 +00001607
1608 if (Scope->isAbstractScope()) {
1609 DV->setDIE(VariableDie);
1610 return VariableDie;
1611 }
1612
1613 // Add variable address.
1614
1615 unsigned Offset = DV->getDotDebugLocOffset();
1616 if (Offset != ~0U) {
1617 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1618 Asm->GetTempSymbol("debug_loc", Offset));
1619 DV->setDIE(VariableDie);
1620 UseDotDebugLocEntry.insert(VariableDie);
1621 return VariableDie;
1622 }
1623
1624 // Check if variable is described by a DBG_VALUE instruction.
1625 DenseMap<const DbgVariable *, const MachineInstr *>::iterator DVI =
1626 DbgVariableToDbgInstMap.find(DV);
1627 if (DVI != DbgVariableToDbgInstMap.end()) {
1628 const MachineInstr *DVInsn = DVI->second;
1629 const MCSymbol *DVLabel = findVariableLabel(DV);
1630 bool updated = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001631 // FIXME : Handle getNumOperands != 3
Devang Patel9fc11702010-05-25 23:40:22 +00001632 if (DVInsn->getNumOperands() == 3) {
1633 if (DVInsn->getOperand(0).isReg())
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001634 updated =
Devang Patel30265c42010-07-07 20:12:52 +00001635 addRegisterAddress(VariableDie, DVLabel, DVInsn->getOperand(0));
Devang Patel9fc11702010-05-25 23:40:22 +00001636 else if (DVInsn->getOperand(0).isImm())
1637 updated = addConstantValue(VariableDie, DVLabel, DVInsn->getOperand(0));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001638 else if (DVInsn->getOperand(0).isFPImm())
1639 updated =
Devang Patel30265c42010-07-07 20:12:52 +00001640 addConstantFPValue(VariableDie, DVLabel, DVInsn->getOperand(0));
Devang Patel9fc11702010-05-25 23:40:22 +00001641 } else {
1642 MachineLocation Location = Asm->getDebugValueLocation(DVInsn);
1643 if (Location.getReg()) {
1644 addAddress(VariableDie, dwarf::DW_AT_location, Location);
1645 if (DVLabel)
1646 addLabel(VariableDie, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr,
1647 DVLabel);
1648 updated = true;
1649 }
1650 }
1651 if (!updated) {
1652 // If variableDie is not updated then DBG_VALUE instruction does not
1653 // have valid variable info.
1654 delete VariableDie;
1655 return NULL;
1656 }
1657 DV->setDIE(VariableDie);
1658 return VariableDie;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001659 }
Devang Patel9fc11702010-05-25 23:40:22 +00001660
1661 // .. else use frame index, if available.
1662 MachineLocation Location;
1663 unsigned FrameReg;
1664 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
1665 int FI = 0;
1666 if (findVariableFrameIndex(DV, &FI)) {
1667 int Offset = RI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
1668 Location.set(FrameReg, Offset);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001669
Devang Patel9fc11702010-05-25 23:40:22 +00001670 if (VD.hasComplexAddress())
1671 addComplexAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
1672 else if (VD.isBlockByrefVariable())
1673 addBlockByrefAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
1674 else
1675 addAddress(VariableDie, dwarf::DW_AT_location, Location);
1676 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001677 DV->setDIE(VariableDie);
1678 return VariableDie;
1679
1680}
Devang Patel930143b2009-11-21 02:48:08 +00001681
Devang Patel04d2f2d2009-11-24 01:14:22 +00001682void DwarfDebug::addPubTypes(DISubprogram SP) {
1683 DICompositeType SPTy = SP.getType();
1684 unsigned SPTag = SPTy.getTag();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001685 if (SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel04d2f2d2009-11-24 01:14:22 +00001686 return;
1687
1688 DIArray Args = SPTy.getTypeArray();
Devang Patel04d2f2d2009-11-24 01:14:22 +00001689 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001690 DIType ATy(Args.getElement(i));
Devang Patel8d6a2b72010-05-07 21:45:47 +00001691 if (!ATy.Verify())
Devang Patel04d2f2d2009-11-24 01:14:22 +00001692 continue;
1693 DICompositeType CATy = getDICompositeType(ATy);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001694 if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
Devang Patel12d150e2010-04-13 20:35:04 +00001695 && !CATy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001696 CompileUnit *TheCU = getCompileUnit(CATy);
1697 if (DIEEntry *Entry = TheCU->getDIEEntry(CATy))
1698 TheCU->addGlobalType(CATy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00001699 }
1700 }
1701}
1702
Devang Patel930143b2009-11-21 02:48:08 +00001703/// constructScopeDIE - Construct a DIE for this scope.
1704DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +00001705 if (!Scope || !Scope->getScopeNode())
1706 return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001707
Devang Patel3b548aa2010-03-08 20:52:55 +00001708 DIScope DS(Scope->getScopeNode());
1709 DIE *ScopeDIE = NULL;
1710 if (Scope->getInlinedAt())
1711 ScopeDIE = constructInlinedScopeDIE(Scope);
1712 else if (DS.isSubprogram()) {
Devang Pateld10b2af2010-06-28 20:53:04 +00001713 ProcessedSPNodes.insert(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001714 if (Scope->isAbstractScope()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001715 ScopeDIE = getCompileUnit(DS)->getDIE(DS);
Devang Patela37a95e2010-07-07 22:20:57 +00001716 // Note down abstract DIE.
1717 if (ScopeDIE)
1718 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
1719 }
Devang Patel3b548aa2010-03-08 20:52:55 +00001720 else
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001721 ScopeDIE = updateSubprogramScopeDIE(DS);
Devang Patel3b548aa2010-03-08 20:52:55 +00001722 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001723 else
Devang Patel3b548aa2010-03-08 20:52:55 +00001724 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel23b2ae62010-03-29 22:59:58 +00001725 if (!ScopeDIE) return NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001726
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001727 // Add variables to scope.
Devang Patel406798a2010-08-09 18:51:29 +00001728 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001729 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel9ccfb642009-12-09 18:24:21 +00001730 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach042483e2009-11-21 23:12:12 +00001731 if (VariableDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001732 ScopeDIE->addChild(VariableDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001733 }
1734
1735 // Add nested scopes.
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001736 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001737 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1738 // Define the Scope debug information entry.
Devang Patel930143b2009-11-21 02:48:08 +00001739 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach042483e2009-11-21 23:12:12 +00001740 if (NestedDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001741 ScopeDIE->addChild(NestedDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001742 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001743
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001744 if (DS.isSubprogram())
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001745 addPubTypes(DISubprogram(DS));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001746
Devang Patel04d2f2d2009-11-24 01:14:22 +00001747 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001748}
1749
Bill Wendling2b128d72009-05-20 23:19:06 +00001750/// GetOrCreateSourceID - Look up the source id with the given directory and
1751/// source file names. If none currently exists, create a new id and insert it
1752/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1753/// maps as well.
Chris Lattner71696ef2010-03-31 06:06:37 +00001754unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName){
Bill Wendling2b128d72009-05-20 23:19:06 +00001755 unsigned DId;
Devang Patel84a74772010-07-27 20:51:15 +00001756 assert (DirName.empty() == false && "Invalid directory name!");
Devang Patel498877d2010-07-24 00:53:22 +00001757
Bill Wendling2b128d72009-05-20 23:19:06 +00001758 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1759 if (DI != DirectoryIdMap.end()) {
1760 DId = DI->getValue();
1761 } else {
1762 DId = DirectoryNames.size() + 1;
1763 DirectoryIdMap[DirName] = DId;
1764 DirectoryNames.push_back(DirName);
1765 }
1766
1767 unsigned FId;
1768 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1769 if (FI != SourceFileIdMap.end()) {
1770 FId = FI->getValue();
1771 } else {
1772 FId = SourceFileNames.size() + 1;
1773 SourceFileIdMap[FileName] = FId;
1774 SourceFileNames.push_back(FileName);
1775 }
1776
1777 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1778 SourceIdMap.find(std::make_pair(DId, FId));
1779 if (SI != SourceIdMap.end())
1780 return SI->second;
1781
1782 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1783 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1784 SourceIds.push_back(std::make_pair(DId, FId));
1785
1786 return SrcId;
1787}
1788
Devang Patel1f4690c2009-12-15 19:16:48 +00001789/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1790DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001791 CompileUnit *TheCU = getCompileUnit(NS);
1792 DIE *NDie = TheCU->getDIE(NS);
Devang Patel1f4690c2009-12-15 19:16:48 +00001793 if (NDie)
1794 return NDie;
1795 NDie = new DIE(dwarf::DW_TAG_namespace);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001796 TheCU->insertDIE(NS, NDie);
Devang Patel1f4690c2009-12-15 19:16:48 +00001797 if (!NS.getName().empty())
1798 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
1799 addSourceLine(NDie, &NS);
1800 addToContextOwner(NDie, NS.getContext());
1801 return NDie;
1802}
1803
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001804/// constructCompileUnit - Create new CompileUnit for the given
Devang Patel1a0df9a2010-05-10 22:49:55 +00001805/// metadata node with tag DW_TAG_compile_unit.
Devang Patel32cc43c2010-05-07 20:54:48 +00001806void DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001807 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +00001808 StringRef FN = DIUnit.getFilename();
1809 StringRef Dir = DIUnit.getDirectory();
Devang Patelb2969422009-09-29 18:40:58 +00001810 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendling2b128d72009-05-20 23:19:06 +00001811
1812 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel930143b2009-11-21 02:48:08 +00001813 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patelb2969422009-09-29 18:40:58 +00001814 DIUnit.getProducer());
Devang Patel930143b2009-11-21 02:48:08 +00001815 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendling2b128d72009-05-20 23:19:06 +00001816 DIUnit.getLanguage());
Devang Patel930143b2009-11-21 02:48:08 +00001817 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Patelbd798ce2010-04-26 22:54:28 +00001818 // Use DW_AT_entry_pc instead of DW_AT_low_pc/DW_AT_high_pc pair. This
1819 // simplifies debug range entries.
Devang Patel1de21ec2010-06-28 22:22:47 +00001820 addUInt(Die, dwarf::DW_AT_entry_pc, dwarf::DW_FORM_addr, 0);
Devang Pateld22ed622010-03-22 23:11:36 +00001821 // DW_AT_stmt_list is a offset of line number information for this
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001822 // compile unit in debug_line section. This offset is calculated
Devang Patel24bc1b52010-06-29 20:17:53 +00001823 // during endMoudle().
1824 addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00001825
Devang Patel2d9caf92009-11-25 17:36:49 +00001826 if (!Dir.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001827 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +00001828 if (DIUnit.isOptimized())
Devang Patel930143b2009-11-21 02:48:08 +00001829 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendling2b128d72009-05-20 23:19:06 +00001830
Devang Patel2d9caf92009-11-25 17:36:49 +00001831 StringRef Flags = DIUnit.getFlags();
1832 if (!Flags.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001833 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendling2b128d72009-05-20 23:19:06 +00001834
1835 unsigned RVer = DIUnit.getRunTimeVersion();
1836 if (RVer)
Devang Patel930143b2009-11-21 02:48:08 +00001837 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +00001838 dwarf::DW_FORM_data1, RVer);
1839
Devang Patel1a0df9a2010-05-10 22:49:55 +00001840 CompileUnit *NewCU = new CompileUnit(ID, Die);
1841 if (!FirstCU)
1842 FirstCU = NewCU;
1843 CUMap.insert(std::make_pair(N, NewCU));
Bill Wendling2b128d72009-05-20 23:19:06 +00001844}
1845
Devang Patel1a0df9a2010-05-10 22:49:55 +00001846/// getCompielUnit - Get CompileUnit DIE.
1847CompileUnit *DwarfDebug::getCompileUnit(const MDNode *N) const {
1848 assert (N && "Invalid DwarfDebug::getCompileUnit argument!");
1849 DIDescriptor D(N);
1850 const MDNode *CUNode = NULL;
1851 if (D.isCompileUnit())
1852 CUNode = N;
1853 else if (D.isSubprogram())
1854 CUNode = DISubprogram(N).getCompileUnit();
1855 else if (D.isType())
1856 CUNode = DIType(N).getCompileUnit();
1857 else if (D.isGlobalVariable())
1858 CUNode = DIGlobalVariable(N).getCompileUnit();
1859 else if (D.isVariable())
1860 CUNode = DIVariable(N).getCompileUnit();
1861 else if (D.isNameSpace())
1862 CUNode = DINameSpace(N).getCompileUnit();
1863 else if (D.isFile())
1864 CUNode = DIFile(N).getCompileUnit();
1865 else
1866 return FirstCU;
1867
1868 DenseMap<const MDNode *, CompileUnit *>::const_iterator I
1869 = CUMap.find(CUNode);
1870 if (I == CUMap.end())
1871 return FirstCU;
1872 return I->second;
1873}
1874
1875
1876/// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00001877void DwarfDebug::constructGlobalVariableDIE(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001878 DIGlobalVariable DI_GV(N);
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001879
Devang Patelf5d53602009-09-04 23:59:07 +00001880 // If debug information is malformed then ignore it.
1881 if (DI_GV.Verify() == false)
1882 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001883
1884 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001885 CompileUnit *TheCU = getCompileUnit(N);
1886 if (TheCU->getDIE(DI_GV))
Devang Patel0751a282009-06-26 01:49:18 +00001887 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001888
Devang Patel9ccfb642009-12-09 18:24:21 +00001889 DIE *VariableDie = createGlobalVariableDIE(DI_GV);
Devang Patel2eec32d2009-12-10 23:25:41 +00001890 if (!VariableDie)
1891 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001892
Bill Wendling2b128d72009-05-20 23:19:06 +00001893 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001894 TheCU->insertDIE(N, VariableDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00001895
1896 // Add to context owner.
Devang Patel89880c82010-01-15 01:12:22 +00001897 DIDescriptor GVContext = DI_GV.getContext();
1898 // Do not create specification DIE if context is either compile unit
1899 // or a subprogram.
Chris Lattner71696ef2010-03-31 06:06:37 +00001900 if (DI_GV.isDefinition() && !GVContext.isCompileUnit() &&
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001901 !GVContext.isFile() &&
Devang Patelcfa8e9d2010-05-07 18:11:54 +00001902 !isSubprogramContext(GVContext)) {
Devang Patel1f4690c2009-12-15 19:16:48 +00001903 // Create specification DIE.
1904 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1905 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1906 dwarf::DW_FORM_ref4, VariableDie);
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001907 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel1f4690c2009-12-15 19:16:48 +00001908 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
Chris Lattner8dcf41e2010-03-08 22:31:46 +00001909 addLabel(Block, 0, dwarf::DW_FORM_udata,
Chris Lattner9e4cafe2010-03-12 21:09:07 +00001910 Asm->Mang->getSymbol(DI_GV.getGlobal()));
Devang Patel1f4690c2009-12-15 19:16:48 +00001911 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
Devang Patelce25dd72010-02-09 01:58:33 +00001912 addUInt(VariableDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Devang Patel1a0df9a2010-05-10 22:49:55 +00001913 TheCU->addDie(VariableSpecDIE);
Devang Patel1f4690c2009-12-15 19:16:48 +00001914 } else {
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001915 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel1f4690c2009-12-15 19:16:48 +00001916 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
Chris Lattner8dcf41e2010-03-08 22:31:46 +00001917 addLabel(Block, 0, dwarf::DW_FORM_udata,
Chris Lattner9e4cafe2010-03-12 21:09:07 +00001918 Asm->Mang->getSymbol(DI_GV.getGlobal()));
Devang Patel1f4690c2009-12-15 19:16:48 +00001919 addBlock(VariableDie, dwarf::DW_AT_location, 0, Block);
1920 }
Devang Patel89880c82010-01-15 01:12:22 +00001921 addToContextOwner(VariableDie, GVContext);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001922
Bill Wendling2b128d72009-05-20 23:19:06 +00001923 // Expose as global. FIXME - need to check external flag.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001924 TheCU->addGlobal(DI_GV.getName(), VariableDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00001925
1926 DIType GTy = DI_GV.getType();
Devang Patel12d150e2010-04-13 20:35:04 +00001927 if (GTy.isCompositeType() && !GTy.getName().empty()
1928 && !GTy.isForwardDecl()) {
Devang Patel1a0df9a2010-05-10 22:49:55 +00001929 DIEEntry *Entry = TheCU->getDIEEntry(GTy);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001930 assert(Entry && "Missing global type!");
Devang Patel1a0df9a2010-05-10 22:49:55 +00001931 TheCU->addGlobalType(GTy.getName(), Entry->getEntry());
Devang Patel04d2f2d2009-11-24 01:14:22 +00001932 }
Devang Patel0751a282009-06-26 01:49:18 +00001933 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001934}
1935
Devang Patel1a0df9a2010-05-10 22:49:55 +00001936/// construct SubprogramDIE - Construct subprogram DIE.
Devang Patel32cc43c2010-05-07 20:54:48 +00001937void DwarfDebug::constructSubprogramDIE(const MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001938 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +00001939
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00001940 // Check for pre-existence.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001941 CompileUnit *TheCU = getCompileUnit(N);
1942 if (TheCU->getDIE(N))
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00001943 return;
1944
Bill Wendling2b128d72009-05-20 23:19:06 +00001945 if (!SP.isDefinition())
1946 // This is a method declaration which will be handled while constructing
1947 // class type.
Devang Patel0751a282009-06-26 01:49:18 +00001948 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001949
Stuart Hastings4bd3dd92010-04-06 21:38:29 +00001950 DIE *SubprogramDie = createSubprogramDIE(SP);
1951
1952 // Add to map.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001953 TheCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00001954
1955 // Add to context owner.
Devang Patel1f4690c2009-12-15 19:16:48 +00001956 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +00001957
Bill Wendling2b128d72009-05-20 23:19:06 +00001958 // Expose as global.
Devang Patel1a0df9a2010-05-10 22:49:55 +00001959 TheCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00001960
Devang Patel0751a282009-06-26 01:49:18 +00001961 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001962}
1963
Devang Patel930143b2009-11-21 02:48:08 +00001964/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbarbe22ec42009-09-19 20:40:14 +00001965/// content. Create global DIEs and emit initial debug info sections.
1966/// This is inovked by the target AsmPrinter.
Chris Lattner11980022010-04-04 07:48:20 +00001967void DwarfDebug::beginModule(Module *M) {
Devang Patel6c74a872010-04-27 19:46:33 +00001968 if (DisableDebugInfoPrinting)
1969 return;
1970
Devang Patel63524442009-07-30 18:56:46 +00001971 DebugInfoFinder DbgFinder;
1972 DbgFinder.processModule(*M);
Devang Patel0751a282009-06-26 01:49:18 +00001973
Chris Lattner7cfa70e2010-04-05 02:19:28 +00001974 bool HasDebugInfo = false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001975
Chris Lattner7cfa70e2010-04-05 02:19:28 +00001976 // Scan all the compile-units to see if there are any marked as the main unit.
1977 // if not, we do not generate debug info.
1978 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1979 E = DbgFinder.compile_unit_end(); I != E; ++I) {
1980 if (DICompileUnit(*I).isMain()) {
1981 HasDebugInfo = true;
1982 break;
1983 }
1984 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001985
Chris Lattner7cfa70e2010-04-05 02:19:28 +00001986 if (!HasDebugInfo) return;
1987
1988 // Tell MMI that we have debug info.
1989 MMI->setDebugInfoAvailability(true);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001990
Chris Lattnerd442aa32010-04-04 23:17:54 +00001991 // Emit initial sections.
Chris Lattner7cfa70e2010-04-05 02:19:28 +00001992 EmitSectionLabels();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00001993
Bill Wendling2b128d72009-05-20 23:19:06 +00001994 // Create all the compile unit DIEs.
Devang Patel63524442009-07-30 18:56:46 +00001995 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1996 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00001997 constructCompileUnit(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00001998
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001999 // Create DIEs for each subprogram.
Devang Patel63524442009-07-30 18:56:46 +00002000 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
2001 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002002 constructSubprogramDIE(*I);
Devang Patel0751a282009-06-26 01:49:18 +00002003
Devang Patel2b75ed22009-12-10 19:14:49 +00002004 // Create DIEs for each global variable.
2005 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
2006 E = DbgFinder.global_variable_end(); I != E; ++I)
2007 constructGlobalVariableDIE(*I);
2008
Bill Wendling2b128d72009-05-20 23:19:06 +00002009 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +00002010 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +00002011
2012 // Print out .file directives to specify files for .loc directives. These are
2013 // printed out early so that they precede any .loc directives.
Chris Lattner3a383cb2010-04-05 00:13:49 +00002014 if (Asm->MAI->hasDotLocAndDotFile()) {
Bill Wendling2b128d72009-05-20 23:19:06 +00002015 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
2016 // Remember source id starts at 1.
2017 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002018 // FIXME: don't use sys::path for this! This should not depend on the
2019 // host.
Bill Wendling2b128d72009-05-20 23:19:06 +00002020 sys::Path FullPath(getSourceDirectoryName(Id.first));
2021 bool AppendOk =
2022 FullPath.appendComponent(getSourceFileName(Id.second));
2023 assert(AppendOk && "Could not append filename to directory!");
2024 AppendOk = false;
Chris Lattner601ef332010-01-25 18:58:59 +00002025 Asm->OutStreamer.EmitDwarfFileDirective(i, FullPath.str());
Bill Wendling2b128d72009-05-20 23:19:06 +00002026 }
2027 }
Bill Wendling2b128d72009-05-20 23:19:06 +00002028}
2029
Devang Patel930143b2009-11-21 02:48:08 +00002030/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendling2b128d72009-05-20 23:19:06 +00002031///
Devang Patel930143b2009-11-21 02:48:08 +00002032void DwarfDebug::endModule() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002033 if (!FirstCU) return;
Devang Patelf3b2db62010-06-28 18:25:03 +00002034 const Module *M = MMI->getModule();
Devang Pateld0701282010-08-02 17:32:15 +00002035 DenseMap<const MDNode *, DbgScope *> DeadFnScopeMap;
Devang Patelf3b2db62010-06-28 18:25:03 +00002036 if (NamedMDNode *AllSPs = M->getNamedMetadata("llvm.dbg.sp")) {
2037 for (unsigned SI = 0, SE = AllSPs->getNumOperands(); SI != SE; ++SI) {
2038 if (ProcessedSPNodes.count(AllSPs->getOperand(SI)) != 0) continue;
2039 DISubprogram SP(AllSPs->getOperand(SI));
2040 if (!SP.Verify()) continue;
2041
2042 // Collect info for variables that were optimized out.
Devang Patel18efced2010-07-19 17:53:55 +00002043 if (!SP.isDefinition()) continue;
Devang Patelf3b2db62010-06-28 18:25:03 +00002044 StringRef FName = SP.getLinkageName();
2045 if (FName.empty())
2046 FName = SP.getName();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002047 NamedMDNode *NMD =
Devang Patelf3b2db62010-06-28 18:25:03 +00002048 M->getNamedMetadata(Twine("llvm.dbg.lv.", getRealLinkageName(FName)));
2049 if (!NMD) continue;
2050 unsigned E = NMD->getNumOperands();
2051 if (!E) continue;
2052 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(SP), NULL);
Devang Pateld0701282010-08-02 17:32:15 +00002053 DeadFnScopeMap[SP] = Scope;
Devang Patelf3b2db62010-06-28 18:25:03 +00002054 for (unsigned I = 0; I != E; ++I) {
2055 DIVariable DV(NMD->getOperand(I));
2056 if (!DV.Verify()) continue;
2057 Scope->addVariable(new DbgVariable(DV));
2058 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002059
Devang Patelf3b2db62010-06-28 18:25:03 +00002060 // Construct subprogram DIE and add variables DIEs.
2061 constructSubprogramDIE(SP);
2062 DIE *ScopeDIE = getCompileUnit(SP)->getDIE(SP);
Devang Patel406798a2010-08-09 18:51:29 +00002063 const SmallVector<DbgVariable *, 8> &Variables = Scope->getDbgVariables();
Devang Patelf3b2db62010-06-28 18:25:03 +00002064 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2065 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
2066 if (VariableDIE)
2067 ScopeDIE->addChild(VariableDIE);
2068 }
2069 }
2070 }
Bill Wendling2b128d72009-05-20 23:19:06 +00002071
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002072 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
2073 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
2074 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
2075 DIE *ISP = *AI;
Devang Patel930143b2009-11-21 02:48:08 +00002076 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002077 }
2078
Devang Patel32cc43c2010-05-07 20:54:48 +00002079 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Pateleb57c592009-12-03 19:11:07 +00002080 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
2081 DIE *SPDie = CI->first;
Devang Patel32cc43c2010-05-07 20:54:48 +00002082 const MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
Devang Pateleb57c592009-12-03 19:11:07 +00002083 if (!N) continue;
Devang Patel1a0df9a2010-05-10 22:49:55 +00002084 DIE *NDie = getCompileUnit(N)->getDIE(N);
Devang Pateleb57c592009-12-03 19:11:07 +00002085 if (!NDie) continue;
2086 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Pateleb57c592009-12-03 19:11:07 +00002087 }
2088
Bill Wendling2b128d72009-05-20 23:19:06 +00002089 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002090 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002091 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002092 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnera179b522010-04-04 19:25:43 +00002093 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +00002094
2095 // End text sections.
2096 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002097 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattnera179b522010-04-04 19:25:43 +00002098 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
Bill Wendling2b128d72009-05-20 23:19:06 +00002099 }
2100
2101 // Emit common frame information.
Devang Patel930143b2009-11-21 02:48:08 +00002102 emitCommonDebugFrame();
Bill Wendling2b128d72009-05-20 23:19:06 +00002103
2104 // Emit function debug frame information
2105 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2106 E = DebugFrames.end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00002107 emitFunctionDebugFrame(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00002108
2109 // Compute DIE offsets and sizes.
Devang Patel930143b2009-11-21 02:48:08 +00002110 computeSizeAndOffsets();
Bill Wendling2b128d72009-05-20 23:19:06 +00002111
Devang Patel24bc1b52010-06-29 20:17:53 +00002112 // Emit source line correspondence into a debug line section.
2113 emitDebugLines();
2114
Bill Wendling2b128d72009-05-20 23:19:06 +00002115 // Emit all the DIEs into a debug info section
Devang Patel930143b2009-11-21 02:48:08 +00002116 emitDebugInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002117
2118 // Corresponding abbreviations into a abbrev section.
Devang Patel930143b2009-11-21 02:48:08 +00002119 emitAbbreviations();
Bill Wendling2b128d72009-05-20 23:19:06 +00002120
Bill Wendling2b128d72009-05-20 23:19:06 +00002121 // Emit info into a debug pubnames section.
Devang Patel930143b2009-11-21 02:48:08 +00002122 emitDebugPubNames();
Bill Wendling2b128d72009-05-20 23:19:06 +00002123
Devang Patel04d2f2d2009-11-24 01:14:22 +00002124 // Emit info into a debug pubtypes section.
2125 emitDebugPubTypes();
2126
Bill Wendling2b128d72009-05-20 23:19:06 +00002127 // Emit info into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00002128 emitDebugLoc();
Bill Wendling2b128d72009-05-20 23:19:06 +00002129
2130 // Emit info into a debug aranges section.
2131 EmitDebugARanges();
2132
2133 // Emit info into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00002134 emitDebugRanges();
Bill Wendling2b128d72009-05-20 23:19:06 +00002135
2136 // Emit info into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00002137 emitDebugMacInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002138
2139 // Emit inline info.
Devang Patel930143b2009-11-21 02:48:08 +00002140 emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00002141
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002142 // Emit info into a debug str section.
2143 emitDebugStr();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002144
Devang Pateld0701282010-08-02 17:32:15 +00002145 // clean up.
2146 DeleteContainerSeconds(DeadFnScopeMap);
Devang Patel1a0df9a2010-05-10 22:49:55 +00002147 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2148 E = CUMap.end(); I != E; ++I)
2149 delete I->second;
2150 FirstCU = NULL; // Reset for the next Module, if any.
Bill Wendling2b128d72009-05-20 23:19:06 +00002151}
2152
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002153/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002154DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
Chris Lattner915c5f92010-04-02 19:42:39 +00002155 DebugLoc ScopeLoc) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002156
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002157 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002158 if (AbsDbgVariable)
2159 return AbsDbgVariable;
2160
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002161 LLVMContext &Ctx = Var->getContext();
Chris Lattner915c5f92010-04-02 19:42:39 +00002162 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002163 if (!Scope)
2164 return NULL;
2165
Devang Patele1c53f22010-05-20 16:36:41 +00002166 AbsDbgVariable = new DbgVariable(Var);
Devang Patel930143b2009-11-21 02:48:08 +00002167 Scope->addVariable(AbsDbgVariable);
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002168 AbstractVariables[Var] = AbsDbgVariable;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002169 return AbsDbgVariable;
2170}
2171
Devang Patel490c8ab2010-05-20 19:57:06 +00002172/// collectVariableInfoFromMMITable - Collect variable information from
2173/// side table maintained by MMI.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002174void
Devang Patel490c8ab2010-05-20 19:57:06 +00002175DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction * MF,
2176 SmallPtrSet<const MDNode *, 16> &Processed) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00002177 const LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
Devang Patel475d32a2009-10-06 01:26:37 +00002178 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2179 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2180 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel32cc43c2010-05-07 20:54:48 +00002181 const MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002182 if (!Var) continue;
Devang Patele0a94bf2010-05-14 21:01:35 +00002183 Processed.insert(Var);
Chris Lattner915c5f92010-04-02 19:42:39 +00002184 DIVariable DV(Var);
2185 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002186
Chris Lattner915c5f92010-04-02 19:42:39 +00002187 DbgScope *Scope = 0;
Devang Patel32cc43c2010-05-07 20:54:48 +00002188 if (const MDNode *IA = VP.second.getInlinedAt(Ctx))
Chris Lattner915c5f92010-04-02 19:42:39 +00002189 Scope = ConcreteScopes.lookup(IA);
2190 if (Scope == 0)
2191 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002192
Devang Patelcdb7d442009-11-10 23:20:04 +00002193 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00002194 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00002195 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002196
Devang Patele1c53f22010-05-20 16:36:41 +00002197 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
2198 DbgVariable *RegVar = new DbgVariable(DV);
2199 recordVariableFrameIndex(RegVar, VP.first);
Devang Patel930143b2009-11-21 02:48:08 +00002200 Scope->addVariable(RegVar);
Devang Patele1c53f22010-05-20 16:36:41 +00002201 if (AbsDbgVariable) {
2202 recordVariableFrameIndex(AbsDbgVariable, VP.first);
2203 VarToAbstractVarMap[RegVar] = AbsDbgVariable;
2204 }
Devang Patel475d32a2009-10-06 01:26:37 +00002205 }
Devang Patel490c8ab2010-05-20 19:57:06 +00002206}
Devang Patela3e9c9c2010-03-15 18:33:46 +00002207
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002208/// isDbgValueInUndefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +00002209/// DBG_VALUE instruction, is in undefined reg.
2210static bool isDbgValueInUndefinedReg(const MachineInstr *MI) {
2211 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2212 if (MI->getOperand(0).isReg() && !MI->getOperand(0).getReg())
2213 return true;
2214 return false;
2215}
2216
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002217/// isDbgValueInDefinedReg - Return true if debug value, encoded by
Devang Patel9fc11702010-05-25 23:40:22 +00002218/// DBG_VALUE instruction, is in a defined reg.
2219static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
2220 assert (MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
2221 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg())
2222 return true;
2223 return false;
2224}
2225
Devang Patel490c8ab2010-05-20 19:57:06 +00002226/// collectVariableInfo - Populate DbgScope entries with variables' info.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002227void
Devang Patel5c0f85c2010-06-25 22:07:34 +00002228DwarfDebug::collectVariableInfo(const MachineFunction *MF,
2229 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002230
Devang Patel490c8ab2010-05-20 19:57:06 +00002231 /// collection info from MMI table.
2232 collectVariableInfoFromMMITable(MF, Processed);
2233
2234 SmallVector<const MachineInstr *, 8> DbgValues;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002235 // Collect variable information from DBG_VALUE machine instructions;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002236 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel490c8ab2010-05-20 19:57:06 +00002237 I != E; ++I)
Devang Patela3e9c9c2010-03-15 18:33:46 +00002238 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2239 II != IE; ++II) {
2240 const MachineInstr *MInsn = II;
Devang Patel9fc11702010-05-25 23:40:22 +00002241 if (!MInsn->isDebugValue() || isDbgValueInUndefinedReg(MInsn))
Devang Patela3e9c9c2010-03-15 18:33:46 +00002242 continue;
Devang Patel490c8ab2010-05-20 19:57:06 +00002243 DbgValues.push_back(MInsn);
2244 }
Devang Patela3e9c9c2010-03-15 18:33:46 +00002245
Devang Patel9fc11702010-05-25 23:40:22 +00002246 // This is a collection of DBV_VALUE instructions describing same variable.
2247 SmallVector<const MachineInstr *, 4> MultipleValues;
Devang Patel490c8ab2010-05-20 19:57:06 +00002248 for(SmallVector<const MachineInstr *, 8>::iterator I = DbgValues.begin(),
2249 E = DbgValues.end(); I != E; ++I) {
2250 const MachineInstr *MInsn = *I;
Devang Patel9fc11702010-05-25 23:40:22 +00002251 MultipleValues.clear();
2252 if (isDbgValueInDefinedReg(MInsn))
2253 MultipleValues.push_back(MInsn);
Devang Patel490c8ab2010-05-20 19:57:06 +00002254 DIVariable DV(MInsn->getOperand(MInsn->getNumOperands() - 1).getMetadata());
2255 if (Processed.count(DV) != 0)
2256 continue;
2257
Devang Patelc2254f62010-06-02 19:05:13 +00002258 const MachineInstr *PrevMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002259 for (SmallVector<const MachineInstr *, 8>::iterator MI = I+1,
Devang Patel9fc11702010-05-25 23:40:22 +00002260 ME = DbgValues.end(); MI != ME; ++MI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002261 const MDNode *Var =
Devang Patel9fc11702010-05-25 23:40:22 +00002262 (*MI)->getOperand((*MI)->getNumOperands()-1).getMetadata();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002263 if (Var == DV && isDbgValueInDefinedReg(*MI) &&
Devang Patelc2254f62010-06-02 19:05:13 +00002264 !PrevMI->isIdenticalTo(*MI))
Devang Patel9fc11702010-05-25 23:40:22 +00002265 MultipleValues.push_back(*MI);
Devang Patelc2254f62010-06-02 19:05:13 +00002266 PrevMI = *MI;
Devang Patel9fc11702010-05-25 23:40:22 +00002267 }
2268
Devang Patel490c8ab2010-05-20 19:57:06 +00002269 DbgScope *Scope = findDbgScope(MInsn);
Devang Patel7a9dedf2010-05-27 20:25:04 +00002270 bool CurFnArg = false;
2271 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
2272 DISubprogram(DV.getContext()).describes(MF->getFunction()))
2273 CurFnArg = true;
2274 if (!Scope && CurFnArg)
Devang Patelfbd6c452010-05-21 00:10:20 +00002275 Scope = CurrentFnDbgScope;
Devang Patel490c8ab2010-05-20 19:57:06 +00002276 // If variable scope is not found then skip this variable.
Devang Patelfbd6c452010-05-21 00:10:20 +00002277 if (!Scope)
Devang Patel490c8ab2010-05-20 19:57:06 +00002278 continue;
2279
2280 Processed.insert(DV);
Devang Patel490c8ab2010-05-20 19:57:06 +00002281 DbgVariable *RegVar = new DbgVariable(DV);
Devang Patel490c8ab2010-05-20 19:57:06 +00002282 Scope->addVariable(RegVar);
Devang Patel7a9dedf2010-05-27 20:25:04 +00002283 if (!CurFnArg)
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002284 DbgVariableLabelsMap[RegVar] = getLabelBeforeInsn(MInsn);
Devang Patelfbd6c452010-05-21 00:10:20 +00002285 if (DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc())) {
2286 DbgVariableToDbgInstMap[AbsVar] = MInsn;
2287 VarToAbstractVarMap[RegVar] = AbsVar;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002288 }
Devang Patel9fc11702010-05-25 23:40:22 +00002289 if (MultipleValues.size() <= 1) {
2290 DbgVariableToDbgInstMap[RegVar] = MInsn;
2291 continue;
2292 }
2293
2294 // handle multiple DBG_VALUE instructions describing one variable.
Devang Patel9fc11702010-05-25 23:40:22 +00002295 if (DotDebugLocEntries.empty())
Devang Patel6b9a9fe2010-05-26 23:55:23 +00002296 RegVar->setDotDebugLocOffset(0);
2297 else
2298 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002299 const MachineInstr *Begin = NULL;
2300 const MachineInstr *End = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002301 for (SmallVector<const MachineInstr *, 4>::iterator
2302 MVI = MultipleValues.begin(), MVE = MultipleValues.end();
Devang Patel30265c42010-07-07 20:12:52 +00002303 MVI != MVE; ++MVI) {
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002304 if (!Begin) {
2305 Begin = *MVI;
2306 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002307 }
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002308 End = *MVI;
Devang Patel9fc11702010-05-25 23:40:22 +00002309 MachineLocation MLoc;
Devang Patel0e60e672010-08-04 18:40:52 +00002310 if (Begin->getNumOperands() == 3) {
2311 if (Begin->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2312 MLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2313 } else
2314 MLoc = Asm->getDebugValueLocation(Begin);
2315
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002316 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
2317 const MCSymbol *SLabel = getLabelBeforeInsn(End);
Devang Patel6c378ac2010-08-04 22:07:27 +00002318 if (MLoc.getReg())
2319 DotDebugLocEntries.push_back(DotDebugLocEntry(FLabel, SLabel, MLoc));
2320
Devang Patel5a5e0bc2010-05-26 17:29:32 +00002321 Begin = End;
2322 if (MVI + 1 == MVE) {
2323 // If End is the last instruction then its value is valid
Devang Patel9fc11702010-05-25 23:40:22 +00002324 // until the end of the funtion.
Devang Patel0e60e672010-08-04 18:40:52 +00002325 MachineLocation EMLoc;
2326 if (End->getNumOperands() == 3) {
2327 if (End->getOperand(0).isReg() && Begin->getOperand(1).isImm())
2328 EMLoc.set(Begin->getOperand(0).getReg(), Begin->getOperand(1).getImm());
2329 } else
2330 EMLoc = Asm->getDebugValueLocation(End);
Devang Patel6c378ac2010-08-04 22:07:27 +00002331 if (EMLoc.getReg())
2332 DotDebugLocEntries.
2333 push_back(DotDebugLocEntry(SLabel, FunctionEndSym, EMLoc));
Devang Patel9fc11702010-05-25 23:40:22 +00002334 }
2335 }
2336 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patela3e9c9c2010-03-15 18:33:46 +00002337 }
Devang Patele0a94bf2010-05-14 21:01:35 +00002338
2339 // Collect info for variables that were optimized out.
Devang Patelad517352010-06-22 01:01:58 +00002340 const Function *F = MF->getFunction();
2341 const Module *M = F->getParent();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002342 if (NamedMDNode *NMD =
2343 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patelb6e058d2010-06-22 01:19:38 +00002344 getRealLinkageName(F->getName())))) {
Devang Patele0a94bf2010-05-14 21:01:35 +00002345 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002346 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel490c8ab2010-05-20 19:57:06 +00002347 if (!DV || !Processed.insert(DV))
Devang Patele0a94bf2010-05-14 21:01:35 +00002348 continue;
2349 DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
2350 if (Scope)
Devang Patele1c53f22010-05-20 16:36:41 +00002351 Scope->addVariable(new DbgVariable(DV));
Devang Patele0a94bf2010-05-14 21:01:35 +00002352 }
2353 }
Devang Patel9fc11702010-05-25 23:40:22 +00002354}
Devang Patele0a94bf2010-05-14 21:01:35 +00002355
Devang Patel9fc11702010-05-25 23:40:22 +00002356/// getLabelBeforeInsn - Return Label preceding the instruction.
2357const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
2358 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2359 LabelsBeforeInsn.find(MI);
2360 if (I == LabelsBeforeInsn.end())
2361 // FunctionBeginSym always preceeds all the instruction in current function.
2362 return FunctionBeginSym;
2363 return I->second;
2364}
2365
2366/// getLabelAfterInsn - Return Label immediately following the instruction.
2367const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
2368 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
2369 LabelsAfterInsn.find(MI);
2370 if (I == LabelsAfterInsn.end())
2371 return NULL;
2372 return I->second;
Devang Patel475d32a2009-10-06 01:26:37 +00002373}
2374
Devang Patelbd477be2010-03-29 17:20:31 +00002375/// beginScope - Process beginning of a scope.
2376void DwarfDebug::beginScope(const MachineInstr *MI) {
Devang Patel002d54d2010-05-26 19:37:24 +00002377 if (InsnNeedsLabel.count(MI) == 0) {
2378 LabelsBeforeInsn[MI] = PrevLabel;
Devang Patelbd477be2010-03-29 17:20:31 +00002379 return;
Devang Patel9fc11702010-05-25 23:40:22 +00002380 }
Devang Patel23b2ae62010-03-29 22:59:58 +00002381
Devang Patel002d54d2010-05-26 19:37:24 +00002382 // Check location.
2383 DebugLoc DL = MI->getDebugLoc();
2384 if (!DL.isUnknown()) {
2385 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
2386 PrevLabel = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
Devang Patel6c74a872010-04-27 19:46:33 +00002387 PrevInstLoc = DL;
Devang Patel002d54d2010-05-26 19:37:24 +00002388 LabelsBeforeInsn[MI] = PrevLabel;
2389 return;
Devang Patel6c74a872010-04-27 19:46:33 +00002390 }
Devang Patelbd477be2010-03-29 17:20:31 +00002391
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002392 // If location is unknown then use temp label for this DBG_VALUE
Devang Patel002d54d2010-05-26 19:37:24 +00002393 // instruction.
2394 if (MI->isDebugValue()) {
Devang Patelacc32a52010-05-26 21:23:46 +00002395 PrevLabel = MMI->getContext().CreateTempSymbol();
2396 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel002d54d2010-05-26 19:37:24 +00002397 LabelsBeforeInsn[MI] = PrevLabel;
2398 return;
2399 }
2400
2401 if (UnknownLocations) {
2402 PrevLabel = recordSourceLine(0, 0, 0);
2403 LabelsBeforeInsn[MI] = PrevLabel;
2404 return;
2405 }
2406
2407 assert (0 && "Instruction is not processed!");
Devang Patel8db360d2009-10-06 01:50:42 +00002408}
2409
Devang Patel930143b2009-11-21 02:48:08 +00002410/// endScope - Process end of a scope.
2411void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel3ebd8932010-04-08 16:50:29 +00002412 if (InsnsEndScopeSet.count(MI) != 0) {
2413 // Emit a label if this instruction ends a scope.
2414 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
2415 Asm->OutStreamer.EmitLabel(Label);
Devang Patel6c74a872010-04-27 19:46:33 +00002416 LabelsAfterInsn[MI] = Label;
Devang Patel3ebd8932010-04-08 16:50:29 +00002417 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002418}
2419
Devang Patel6c74a872010-04-27 19:46:33 +00002420/// getOrCreateDbgScope - Create DbgScope for the scope.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002421DbgScope *DwarfDebug::getOrCreateDbgScope(const MDNode *Scope,
Devang Patel30265c42010-07-07 20:12:52 +00002422 const MDNode *InlinedAt) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002423 if (!InlinedAt) {
2424 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2425 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002426 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002427 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2428 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Patel6c74a872010-04-27 19:46:33 +00002429 if (DIDescriptor(Scope).isLexicalBlock()) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002430 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002431 getOrCreateDbgScope(DILexicalBlock(Scope).getContext(), NULL);
Devang Patel6c74a872010-04-27 19:46:33 +00002432 WScope->setParent(Parent);
2433 Parent->addScope(WScope);
2434 }
2435
2436 if (!WScope->getParent()) {
2437 StringRef SPName = DISubprogram(Scope).getLinkageName();
Stuart Hastings9b5005c2010-06-15 23:06:30 +00002438 // We used to check only for a linkage name, but that fails
2439 // since we began omitting the linkage name for private
2440 // functions. The new way is to check for the name in metadata,
2441 // but that's not supported in old .ll test cases. Ergo, we
2442 // check both.
Stuart Hastingsafe54f12010-06-11 20:08:44 +00002443 if (SPName == Asm->MF->getFunction()->getName() ||
2444 DISubprogram(Scope).getFunction() == Asm->MF->getFunction())
Devang Patel6c74a872010-04-27 19:46:33 +00002445 CurrentFnDbgScope = WScope;
2446 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002447
Devang Patel6c74a872010-04-27 19:46:33 +00002448 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002449 }
2450
Devang Patel5c0f85c2010-06-25 22:07:34 +00002451 getOrCreateAbstractScope(Scope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002452 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2453 if (WScope)
Devang Patel6c74a872010-04-27 19:46:33 +00002454 return WScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002455
2456 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2457 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2458 DILocation DL(InlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002459 DbgScope *Parent =
Devang Patelcfa8e9d2010-05-07 18:11:54 +00002460 getOrCreateDbgScope(DL.getScope(), DL.getOrigLocation());
Devang Patel6c74a872010-04-27 19:46:33 +00002461 WScope->setParent(Parent);
2462 Parent->addScope(WScope);
2463
2464 ConcreteScopes[InlinedAt] = WScope;
Devang Patel6c74a872010-04-27 19:46:33 +00002465
2466 return WScope;
Devang Patel8db360d2009-10-06 01:50:42 +00002467}
2468
Devang Patel6c74a872010-04-27 19:46:33 +00002469/// hasValidLocation - Return true if debug location entry attached with
2470/// machine instruction encodes valid location info.
2471static bool hasValidLocation(LLVMContext &Ctx,
2472 const MachineInstr *MInsn,
Devang Patel32cc43c2010-05-07 20:54:48 +00002473 const MDNode *&Scope, const MDNode *&InlinedAt) {
Devang Patel6c74a872010-04-27 19:46:33 +00002474 DebugLoc DL = MInsn->getDebugLoc();
2475 if (DL.isUnknown()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002476
Devang Patel32cc43c2010-05-07 20:54:48 +00002477 const MDNode *S = DL.getScope(Ctx);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002478
Devang Patel6c74a872010-04-27 19:46:33 +00002479 // There is no need to create another DIE for compile unit. For all
2480 // other scopes, create one DbgScope now. This will be translated
2481 // into a scope DIE at the end.
2482 if (DIScope(S).isCompileUnit()) return false;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002483
Devang Patel6c74a872010-04-27 19:46:33 +00002484 Scope = S;
2485 InlinedAt = DL.getInlinedAt(Ctx);
2486 return true;
2487}
2488
2489/// calculateDominanceGraph - Calculate dominance graph for DbgScope
2490/// hierarchy.
2491static void calculateDominanceGraph(DbgScope *Scope) {
2492 assert (Scope && "Unable to calculate scop edominance graph!");
2493 SmallVector<DbgScope *, 4> WorkStack;
2494 WorkStack.push_back(Scope);
2495 unsigned Counter = 0;
2496 while (!WorkStack.empty()) {
2497 DbgScope *WS = WorkStack.back();
2498 const SmallVector<DbgScope *, 4> &Children = WS->getScopes();
2499 bool visitedChildren = false;
2500 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
2501 SE = Children.end(); SI != SE; ++SI) {
2502 DbgScope *ChildScope = *SI;
2503 if (!ChildScope->getDFSOut()) {
2504 WorkStack.push_back(ChildScope);
2505 visitedChildren = true;
2506 ChildScope->setDFSIn(++Counter);
2507 break;
2508 }
2509 }
2510 if (!visitedChildren) {
2511 WorkStack.pop_back();
2512 WS->setDFSOut(++Counter);
2513 }
2514 }
2515}
2516
2517/// printDbgScopeInfo - Print DbgScope info for each machine instruction.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002518static
Devang Patel6c74a872010-04-27 19:46:33 +00002519void printDbgScopeInfo(LLVMContext &Ctx, const MachineFunction *MF,
2520 DenseMap<const MachineInstr *, DbgScope *> &MI2ScopeMap)
2521{
2522#ifndef NDEBUG
2523 unsigned PrevDFSIn = 0;
2524 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2525 I != E; ++I) {
2526 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2527 II != IE; ++II) {
2528 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002529 const MDNode *Scope = NULL;
2530 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002531
2532 // Check if instruction has valid location information.
2533 if (hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2534 dbgs() << " [ ";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002535 if (InlinedAt)
Devang Patel6c74a872010-04-27 19:46:33 +00002536 dbgs() << "*";
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002537 DenseMap<const MachineInstr *, DbgScope *>::iterator DI =
Devang Patel6c74a872010-04-27 19:46:33 +00002538 MI2ScopeMap.find(MInsn);
2539 if (DI != MI2ScopeMap.end()) {
2540 DbgScope *S = DI->second;
2541 dbgs() << S->getDFSIn();
2542 PrevDFSIn = S->getDFSIn();
2543 } else
2544 dbgs() << PrevDFSIn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002545 } else
Devang Patel6c74a872010-04-27 19:46:33 +00002546 dbgs() << " [ x" << PrevDFSIn;
2547 dbgs() << " ]";
2548 MInsn->dump();
2549 }
2550 dbgs() << "\n";
2551 }
2552#endif
2553}
Devang Patel930143b2009-11-21 02:48:08 +00002554/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner848c7d22010-03-31 05:39:57 +00002555/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattner76555b52010-01-26 23:18:02 +00002556bool DwarfDebug::extractScopeInformation() {
Devang Patel75cc16c2009-10-01 20:31:14 +00002557 // If scope information was extracted using .dbg intrinsics then there is not
2558 // any need to extract these information by scanning each instruction.
2559 if (!DbgScopeMap.empty())
2560 return false;
2561
Dan Gohmane9135cb2010-04-23 01:18:53 +00002562 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patel6c74a872010-04-27 19:46:33 +00002563 LLVMContext &Ctx = Asm->MF->getFunction()->getContext();
2564 SmallVector<DbgRange, 4> MIRanges;
2565 DenseMap<const MachineInstr *, DbgScope *> MI2ScopeMap;
Devang Patel32cc43c2010-05-07 20:54:48 +00002566 const MDNode *PrevScope = NULL;
2567 const MDNode *PrevInlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002568 const MachineInstr *RangeBeginMI = NULL;
2569 const MachineInstr *PrevMI = NULL;
Chris Lattner3a383cb2010-04-05 00:13:49 +00002570 for (MachineFunction::const_iterator I = Asm->MF->begin(), E = Asm->MF->end();
Devang Patel75cc16c2009-10-01 20:31:14 +00002571 I != E; ++I) {
2572 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2573 II != IE; ++II) {
2574 const MachineInstr *MInsn = II;
Devang Patel32cc43c2010-05-07 20:54:48 +00002575 const MDNode *Scope = NULL;
2576 const MDNode *InlinedAt = NULL;
Devang Patel6c74a872010-04-27 19:46:33 +00002577
2578 // Check if instruction has valid location information.
2579 if (!hasValidLocation(Ctx, MInsn, Scope, InlinedAt)) {
2580 PrevMI = MInsn;
2581 continue;
2582 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002583
Devang Patel6c74a872010-04-27 19:46:33 +00002584 // If scope has not changed then skip this instruction.
2585 if (Scope == PrevScope && PrevInlinedAt == InlinedAt) {
2586 PrevMI = MInsn;
2587 continue;
2588 }
2589
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002590 if (RangeBeginMI) {
2591 // If we have alread seen a beginning of a instruction range and
Devang Patel6c74a872010-04-27 19:46:33 +00002592 // current instruction scope does not match scope of first instruction
2593 // in this range then create a new instruction range.
2594 DbgRange R(RangeBeginMI, PrevMI);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002595 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope,
Devang Patel30265c42010-07-07 20:12:52 +00002596 PrevInlinedAt);
Devang Patel6c74a872010-04-27 19:46:33 +00002597 MIRanges.push_back(R);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002598 }
Devang Patel6c74a872010-04-27 19:46:33 +00002599
2600 // This is a beginning of a new instruction range.
2601 RangeBeginMI = MInsn;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002602
Devang Patel6c74a872010-04-27 19:46:33 +00002603 // Reset previous markers.
2604 PrevMI = MInsn;
2605 PrevScope = Scope;
2606 PrevInlinedAt = InlinedAt;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002607 }
2608 }
2609
Devang Patel6c74a872010-04-27 19:46:33 +00002610 // Create last instruction range.
2611 if (RangeBeginMI && PrevMI && PrevScope) {
2612 DbgRange R(RangeBeginMI, PrevMI);
2613 MIRanges.push_back(R);
2614 MI2ScopeMap[RangeBeginMI] = getOrCreateDbgScope(PrevScope, PrevInlinedAt);
Devang Patel75cc16c2009-10-01 20:31:14 +00002615 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002616
Devang Patel530a0752010-01-04 20:44:00 +00002617 if (!CurrentFnDbgScope)
2618 return false;
2619
Devang Patel6c74a872010-04-27 19:46:33 +00002620 calculateDominanceGraph(CurrentFnDbgScope);
2621 if (PrintDbgScope)
2622 printDbgScopeInfo(Ctx, Asm->MF, MI2ScopeMap);
2623
2624 // Find ranges of instructions covered by each DbgScope;
2625 DbgScope *PrevDbgScope = NULL;
2626 for (SmallVector<DbgRange, 4>::const_iterator RI = MIRanges.begin(),
2627 RE = MIRanges.end(); RI != RE; ++RI) {
2628 const DbgRange &R = *RI;
2629 DbgScope *S = MI2ScopeMap.lookup(R.first);
2630 assert (S && "Lost DbgScope for a machine instruction!");
2631 if (PrevDbgScope && !PrevDbgScope->dominates(S))
2632 PrevDbgScope->closeInsnRange(S);
2633 S->openInsnRange(R.first);
2634 S->extendInsnRange(R.second);
2635 PrevDbgScope = S;
2636 }
2637
2638 if (PrevDbgScope)
2639 PrevDbgScope->closeInsnRange();
Devang Patel75cc16c2009-10-01 20:31:14 +00002640
Devang Patel359b0132010-04-08 18:43:56 +00002641 identifyScopeMarkers();
Devang Patelf1d5a1e2010-04-08 15:37:09 +00002642
2643 return !DbgScopeMap.empty();
2644}
2645
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002646/// identifyScopeMarkers() -
Devang Patel6c74a872010-04-27 19:46:33 +00002647/// Each DbgScope has first instruction and last instruction to mark beginning
2648/// and end of a scope respectively. Create an inverse map that list scopes
2649/// starts (and ends) with an instruction. One instruction may start (or end)
2650/// multiple scopes. Ignore scopes that are not reachable.
Devang Patel359b0132010-04-08 18:43:56 +00002651void DwarfDebug::identifyScopeMarkers() {
Devang Patel7771b7c2010-01-20 02:05:23 +00002652 SmallVector<DbgScope *, 4> WorkList;
2653 WorkList.push_back(CurrentFnDbgScope);
2654 while (!WorkList.empty()) {
Chris Lattner848c7d22010-03-31 05:39:57 +00002655 DbgScope *S = WorkList.pop_back_val();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002656
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002657 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002658 if (!Children.empty())
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002659 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00002660 SE = Children.end(); SI != SE; ++SI)
2661 WorkList.push_back(*SI);
2662
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002663 if (S->isAbstractScope())
2664 continue;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002665
Devang Patel6c74a872010-04-27 19:46:33 +00002666 const SmallVector<DbgRange, 4> &Ranges = S->getRanges();
2667 if (Ranges.empty())
2668 continue;
2669 for (SmallVector<DbgRange, 4>::const_iterator RI = Ranges.begin(),
2670 RE = Ranges.end(); RI != RE; ++RI) {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002671 assert(RI->first && "DbgRange does not have first instruction!");
2672 assert(RI->second && "DbgRange does not have second instruction!");
Devang Patel6c74a872010-04-27 19:46:33 +00002673 InsnsEndScopeSet.insert(RI->second);
2674 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002675 }
Devang Patel75cc16c2009-10-01 20:31:14 +00002676}
2677
Dan Gohman3df671a2010-04-20 00:37:27 +00002678/// FindFirstDebugLoc - Find the first debug location in the function. This
2679/// is intended to be an approximation for the source position of the
2680/// beginning of the function.
2681static DebugLoc FindFirstDebugLoc(const MachineFunction *MF) {
2682 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2683 I != E; ++I)
2684 for (MachineBasicBlock::const_iterator MBBI = I->begin(), MBBE = I->end();
2685 MBBI != MBBE; ++MBBI) {
2686 DebugLoc DL = MBBI->getDebugLoc();
2687 if (!DL.isUnknown())
2688 return DL;
2689 }
2690 return DebugLoc();
2691}
2692
Devang Patel930143b2009-11-21 02:48:08 +00002693/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendling2b128d72009-05-20 23:19:06 +00002694/// emitted immediately after the function entry point.
Chris Lattner76555b52010-01-26 23:18:02 +00002695void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner196dbdc2010-04-05 03:52:55 +00002696 if (!MMI->hasDebugInfo()) return;
Bill Wendlingfcc14142010-04-07 09:28:04 +00002697 if (!extractScopeInformation()) return;
Devang Patel4598eb62009-10-06 18:37:31 +00002698
Devang Patel6c74a872010-04-27 19:46:33 +00002699 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
2700 Asm->getFunctionNumber());
Bill Wendling2b128d72009-05-20 23:19:06 +00002701 // Assumes in correct section after the entry point.
Devang Patel6c74a872010-04-27 19:46:33 +00002702 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendling2b128d72009-05-20 23:19:06 +00002703
2704 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2705 // function.
Dan Gohman3df671a2010-04-20 00:37:27 +00002706 DebugLoc FDL = FindFirstDebugLoc(MF);
Chris Lattner915c5f92010-04-02 19:42:39 +00002707 if (FDL.isUnknown()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002708
Devang Patel32cc43c2010-05-07 20:54:48 +00002709 const MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
Stuart Hastings61475c52010-07-19 23:56:30 +00002710 const MDNode *TheScope = 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002711
Chris Lattner915c5f92010-04-02 19:42:39 +00002712 DISubprogram SP = getDISubprogram(Scope);
2713 unsigned Line, Col;
2714 if (SP.Verify()) {
2715 Line = SP.getLineNumber();
2716 Col = 0;
Stuart Hastings61475c52010-07-19 23:56:30 +00002717 TheScope = SP;
Chris Lattner915c5f92010-04-02 19:42:39 +00002718 } else {
2719 Line = FDL.getLine();
2720 Col = FDL.getCol();
Stuart Hastings61475c52010-07-19 23:56:30 +00002721 TheScope = Scope;
Bill Wendling2b128d72009-05-20 23:19:06 +00002722 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002723
Stuart Hastings61475c52010-07-19 23:56:30 +00002724 recordSourceLine(Line, Col, TheScope);
Devang Patel002d54d2010-05-26 19:37:24 +00002725
Devang Patel21ccf052010-06-02 16:42:51 +00002726 /// ProcessedArgs - Collection of arguments already processed.
2727 SmallPtrSet<const MDNode *, 8> ProcessedArgs;
2728
Devang Patel002d54d2010-05-26 19:37:24 +00002729 DebugLoc PrevLoc;
2730 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2731 I != E; ++I)
2732 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2733 II != IE; ++II) {
2734 const MachineInstr *MI = II;
2735 DebugLoc DL = MI->getDebugLoc();
2736 if (MI->isDebugValue()) {
Devang Patel002d54d2010-05-26 19:37:24 +00002737 assert (MI->getNumOperands() > 1 && "Invalid machine instruction!");
2738 DIVariable DV(MI->getOperand(MI->getNumOperands() - 1).getMetadata());
2739 if (!DV.Verify()) continue;
Devang Patel5e6b71c2010-05-27 16:47:30 +00002740 // If DBG_VALUE is for a local variable then it needs a label.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002741 if (DV.getTag() != dwarf::DW_TAG_arg_variable
Devang Patel42939752010-07-01 21:38:08 +00002742 && isDbgValueInUndefinedReg(MI) == false)
Devang Patel002d54d2010-05-26 19:37:24 +00002743 InsnNeedsLabel.insert(MI);
Devang Patel5e6b71c2010-05-27 16:47:30 +00002744 // DBG_VALUE for inlined functions argument needs a label.
Devang Patel42939752010-07-01 21:38:08 +00002745 else if (!DISubprogram(getDISubprogram(DV.getContext())).
2746 describes(MF->getFunction()))
Devang Patel5e6b71c2010-05-27 16:47:30 +00002747 InsnNeedsLabel.insert(MI);
2748 // DBG_VALUE indicating argument location change needs a label.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002749 else if (isDbgValueInUndefinedReg(MI) == false
2750 && !ProcessedArgs.insert(DV))
Devang Patel002d54d2010-05-26 19:37:24 +00002751 InsnNeedsLabel.insert(MI);
2752 } else {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002753 // If location is unknown then instruction needs a location only if
Devang Patel002d54d2010-05-26 19:37:24 +00002754 // UnknownLocations flag is set.
2755 if (DL.isUnknown()) {
2756 if (UnknownLocations && !PrevLoc.isUnknown())
2757 InsnNeedsLabel.insert(MI);
2758 } else if (DL != PrevLoc)
2759 // Otherwise, instruction needs a location only if it is new location.
2760 InsnNeedsLabel.insert(MI);
2761 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002762
Devang Patel002d54d2010-05-26 19:37:24 +00002763 if (!DL.isUnknown() || UnknownLocations)
2764 PrevLoc = DL;
2765 }
2766
2767 PrevLabel = FunctionBeginSym;
Bill Wendling2b128d72009-05-20 23:19:06 +00002768}
2769
Devang Patel930143b2009-11-21 02:48:08 +00002770/// endFunction - Gather and emit post-function debug information.
Bill Wendling2b128d72009-05-20 23:19:06 +00002771///
Chris Lattner76555b52010-01-26 23:18:02 +00002772void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendlingfcc14142010-04-07 09:28:04 +00002773 if (!MMI->hasDebugInfo() || DbgScopeMap.empty()) return;
Devang Patel2904aa92009-11-12 19:02:56 +00002774
Devang Patel530a0752010-01-04 20:44:00 +00002775 if (CurrentFnDbgScope) {
Devang Patel4a8e6e82010-05-22 00:04:14 +00002776
Devang Patel9fc11702010-05-25 23:40:22 +00002777 // Define end label for subprogram.
2778 FunctionEndSym = Asm->GetTempSymbol("func_end",
2779 Asm->getFunctionNumber());
2780 // Assumes in correct section after the entry point.
2781 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002782
Devang Patel5c0f85c2010-06-25 22:07:34 +00002783 SmallPtrSet<const MDNode *, 16> ProcessedVars;
2784 collectVariableInfo(MF, ProcessedVars);
Devang Patel4a8e6e82010-05-22 00:04:14 +00002785
Devang Patel530a0752010-01-04 20:44:00 +00002786 // Get function line info.
2787 if (!Lines.empty()) {
2788 // Get section line info.
2789 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2790 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2791 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2792 // Append the function info to section info.
2793 SectionLineInfos.insert(SectionLineInfos.end(),
2794 Lines.begin(), Lines.end());
2795 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002796
Devang Patel530a0752010-01-04 20:44:00 +00002797 // Construct abstract scopes.
2798 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Devang Patel5c0f85c2010-06-25 22:07:34 +00002799 AE = AbstractScopesList.end(); AI != AE; ++AI) {
Devang Patel5c0f85c2010-06-25 22:07:34 +00002800 DISubprogram SP((*AI)->getScopeNode());
2801 if (SP.Verify()) {
2802 // Collect info for variables that were optimized out.
2803 StringRef FName = SP.getLinkageName();
2804 if (FName.empty())
2805 FName = SP.getName();
2806 const Module *M = MF->getFunction()->getParent();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002807 if (NamedMDNode *NMD =
2808 M->getNamedMetadata(Twine("llvm.dbg.lv.",
Devang Patel5c0f85c2010-06-25 22:07:34 +00002809 getRealLinkageName(FName)))) {
2810 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Dan Gohman093cb792010-07-21 18:54:18 +00002811 DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
Devang Patel5c0f85c2010-06-25 22:07:34 +00002812 if (!DV || !ProcessedVars.insert(DV))
2813 continue;
Devang Patel648df7b2010-06-30 00:11:08 +00002814 DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Devang Patel5c0f85c2010-06-25 22:07:34 +00002815 if (Scope)
2816 Scope->addVariable(new DbgVariable(DV));
2817 }
2818 }
2819 }
Devang Patelc5b31092010-06-30 01:40:11 +00002820 if (ProcessedSPNodes.count((*AI)->getScopeNode()) == 0)
2821 constructScopeDIE(*AI);
Devang Patel5c0f85c2010-06-25 22:07:34 +00002822 }
Devang Patel30265c42010-07-07 20:12:52 +00002823
Devang Patel075e9b52010-05-04 06:15:30 +00002824 DIE *CurFnDIE = constructScopeDIE(CurrentFnDbgScope);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002825
Devang Patel075e9b52010-05-04 06:15:30 +00002826 if (!DisableFramePointerElim(*MF))
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002827 addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
Devang Patel075e9b52010-05-04 06:15:30 +00002828 dwarf::DW_FORM_flag, 1);
2829
2830
Chris Lattner3a383cb2010-04-05 00:13:49 +00002831 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
Devang Patel530a0752010-01-04 20:44:00 +00002832 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00002833 }
2834
Bill Wendling2b128d72009-05-20 23:19:06 +00002835 // Clear debug info
Devang Patelfe189e62010-01-19 01:26:02 +00002836 CurrentFnDbgScope = NULL;
Devang Patel002d54d2010-05-26 19:37:24 +00002837 InsnNeedsLabel.clear();
Devang Patele1c53f22010-05-20 16:36:41 +00002838 DbgVariableToFrameIndexMap.clear();
2839 VarToAbstractVarMap.clear();
2840 DbgVariableToDbgInstMap.clear();
2841 DbgVariableLabelsMap.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002842 DeleteContainerSeconds(DbgScopeMap);
Devang Patel541019d2010-04-09 16:04:20 +00002843 InsnsEndScopeSet.clear();
Devang Patelfe189e62010-01-19 01:26:02 +00002844 ConcreteScopes.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002845 DeleteContainerSeconds(AbstractScopes);
Devang Patelfe189e62010-01-19 01:26:02 +00002846 AbstractScopesList.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002847 AbstractVariables.clear();
Devang Patel6c74a872010-04-27 19:46:33 +00002848 LabelsBeforeInsn.clear();
2849 LabelsAfterInsn.clear();
Bill Wendling2b128d72009-05-20 23:19:06 +00002850 Lines.clear();
Devang Patel12563b32010-04-16 23:33:45 +00002851 PrevLabel = NULL;
Bill Wendling2b128d72009-05-20 23:19:06 +00002852}
2853
Devang Patele1c53f22010-05-20 16:36:41 +00002854/// recordVariableFrameIndex - Record a variable's index.
2855void DwarfDebug::recordVariableFrameIndex(const DbgVariable *V, int Index) {
2856 assert (V && "Invalid DbgVariable!");
2857 DbgVariableToFrameIndexMap[V] = Index;
2858}
2859
2860/// findVariableFrameIndex - Return true if frame index for the variable
2861/// is found. Update FI to hold value of the index.
2862bool DwarfDebug::findVariableFrameIndex(const DbgVariable *V, int *FI) {
2863 assert (V && "Invalid DbgVariable!");
2864 DenseMap<const DbgVariable *, int>::iterator I =
2865 DbgVariableToFrameIndexMap.find(V);
2866 if (I == DbgVariableToFrameIndexMap.end())
2867 return false;
2868 *FI = I->second;
2869 return true;
2870}
2871
2872/// findVariableLabel - Find MCSymbol for the variable.
2873const MCSymbol *DwarfDebug::findVariableLabel(const DbgVariable *V) {
2874 DenseMap<const DbgVariable *, const MCSymbol *>::iterator I
2875 = DbgVariableLabelsMap.find(V);
2876 if (I == DbgVariableLabelsMap.end())
2877 return NULL;
2878 else return I->second;
2879}
2880
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002881/// findDbgScope - Find DbgScope for the debug loc attached with an
Devang Patel490c8ab2010-05-20 19:57:06 +00002882/// instruction.
2883DbgScope *DwarfDebug::findDbgScope(const MachineInstr *MInsn) {
2884 DbgScope *Scope = NULL;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002885 LLVMContext &Ctx =
Devang Patel490c8ab2010-05-20 19:57:06 +00002886 MInsn->getParent()->getParent()->getFunction()->getContext();
2887 DebugLoc DL = MInsn->getDebugLoc();
2888
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002889 if (DL.isUnknown())
Devang Patel490c8ab2010-05-20 19:57:06 +00002890 return Scope;
2891
2892 if (const MDNode *IA = DL.getInlinedAt(Ctx))
2893 Scope = ConcreteScopes.lookup(IA);
2894 if (Scope == 0)
2895 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002896
Devang Patel490c8ab2010-05-20 19:57:06 +00002897 return Scope;
2898}
2899
2900
Chris Lattnerba35a672010-03-09 04:54:43 +00002901/// recordSourceLine - Register a source line with debug info. Returns the
2902/// unique label that was emitted and which provides correspondence to
2903/// the source line list.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00002904MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel30265c42010-07-07 20:12:52 +00002905 const MDNode *S) {
Devang Patel2d9caf92009-11-25 17:36:49 +00002906 StringRef Dir;
2907 StringRef Fn;
Devang Patel2089d162009-10-05 18:03:19 +00002908
Dan Gohman50849c62010-05-05 23:41:32 +00002909 unsigned Src = 1;
2910 if (S) {
2911 DIDescriptor Scope(S);
Devang Patel2089d162009-10-05 18:03:19 +00002912
Dan Gohman50849c62010-05-05 23:41:32 +00002913 if (Scope.isCompileUnit()) {
2914 DICompileUnit CU(S);
2915 Dir = CU.getDirectory();
2916 Fn = CU.getFilename();
2917 } else if (Scope.isSubprogram()) {
2918 DISubprogram SP(S);
2919 Dir = SP.getDirectory();
2920 Fn = SP.getFilename();
2921 } else if (Scope.isLexicalBlock()) {
2922 DILexicalBlock DB(S);
2923 Dir = DB.getDirectory();
2924 Fn = DB.getFilename();
2925 } else
2926 assert(0 && "Unexpected scope info");
2927
2928 Src = GetOrCreateSourceID(Dir, Fn);
2929 }
2930
Chris Lattner6e52e9d2010-03-14 08:36:50 +00002931 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattnerb4666f42010-03-14 08:15:55 +00002932 Lines.push_back(SrcLineInfo(Line, Col, Src, Label));
Bill Wendling2b128d72009-05-20 23:19:06 +00002933
Chris Lattnerba35a672010-03-09 04:54:43 +00002934 Asm->OutStreamer.EmitLabel(Label);
2935 return Label;
Bill Wendling2b128d72009-05-20 23:19:06 +00002936}
2937
Bill Wendling806535f2009-05-20 23:22:40 +00002938//===----------------------------------------------------------------------===//
2939// Emit Methods
2940//===----------------------------------------------------------------------===//
2941
Devang Patel930143b2009-11-21 02:48:08 +00002942/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling480ff322009-05-20 23:21:38 +00002943///
Jim Grosbach00e9c612009-11-22 19:20:36 +00002944unsigned
2945DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling480ff322009-05-20 23:21:38 +00002946 // Get the children.
2947 const std::vector<DIE *> &Children = Die->getChildren();
2948
2949 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00002950 if (!Last && !Children.empty())
Benjamin Kramer74729ae2010-03-31 19:34:01 +00002951 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling480ff322009-05-20 23:21:38 +00002952
2953 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00002954 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00002955
2956 // Get the abbreviation for this DIE.
2957 unsigned AbbrevNumber = Die->getAbbrevNumber();
2958 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2959
2960 // Set DIE offset
2961 Die->setOffset(Offset);
2962
2963 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00002964 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00002965
2966 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2967 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2968
2969 // Size the DIE attribute values.
2970 for (unsigned i = 0, N = Values.size(); i < N; ++i)
2971 // Size attribute value.
Chris Lattner5a00dea2010-04-05 00:18:22 +00002972 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling480ff322009-05-20 23:21:38 +00002973
2974 // Size the DIE children if any.
2975 if (!Children.empty()) {
2976 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
2977 "Children flag not set");
2978
2979 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00002980 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling480ff322009-05-20 23:21:38 +00002981
2982 // End of children marker.
2983 Offset += sizeof(int8_t);
2984 }
2985
2986 Die->setSize(Offset - Die->getOffset());
2987 return Offset;
2988}
2989
Devang Patel930143b2009-11-21 02:48:08 +00002990/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling480ff322009-05-20 23:21:38 +00002991///
Devang Patel930143b2009-11-21 02:48:08 +00002992void DwarfDebug::computeSizeAndOffsets() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00002993 unsigned PrevOffset = 0;
2994 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2995 E = CUMap.end(); I != E; ++I) {
2996 // Compute size of compile unit header.
2997 static unsigned Offset = PrevOffset +
2998 sizeof(int32_t) + // Length of Compilation Unit Info
2999 sizeof(int16_t) + // DWARF version number
3000 sizeof(int32_t) + // Offset Into Abbrev. Section
3001 sizeof(int8_t); // Pointer Size (in bytes)
3002 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
3003 PrevOffset = Offset;
3004 }
Bill Wendling480ff322009-05-20 23:21:38 +00003005}
3006
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003007/// EmitSectionSym - Switch to the specified MCSection and emit an assembler
3008/// temporary label to it if SymbolStem is specified.
Chris Lattner6629ca92010-04-04 22:59:04 +00003009static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003010 const char *SymbolStem = 0) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003011 Asm->OutStreamer.SwitchSection(Section);
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003012 if (!SymbolStem) return 0;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003013
Chris Lattner6629ca92010-04-04 22:59:04 +00003014 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
3015 Asm->OutStreamer.EmitLabel(TmpSym);
3016 return TmpSym;
3017}
3018
3019/// EmitSectionLabels - Emit initial Dwarf sections with a label at
3020/// the start of each one.
Chris Lattner46355d82010-04-04 22:33:59 +00003021void DwarfDebug::EmitSectionLabels() {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003022 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003023
Bill Wendling480ff322009-05-20 23:21:38 +00003024 // Dwarf sections base addresses.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003025 if (Asm->MAI->doesDwarfRequireFrameSection()) {
Chris Lattner6629ca92010-04-04 22:59:04 +00003026 DwarfFrameSectionSym =
3027 EmitSectionSym(Asm, TLOF.getDwarfFrameSection(), "section_debug_frame");
3028 }
Bill Wendling480ff322009-05-20 23:21:38 +00003029
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003030 DwarfInfoSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003031 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003032 DwarfAbbrevSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003033 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003034 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003035
Chris Lattner6629ca92010-04-04 22:59:04 +00003036 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003037 EmitSectionSym(Asm, MacroInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003038
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003039 DwarfDebugLineSectionSym =
Devang Patel24bc1b52010-06-29 20:17:53 +00003040 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Chris Lattner1fbf53b2010-04-04 23:02:02 +00003041 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
3042 EmitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
3043 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003044 DwarfStrSectionSym =
Chris Lattner6629ca92010-04-04 22:59:04 +00003045 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
Devang Patel12563b32010-04-16 23:33:45 +00003046 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
3047 "debug_range");
Bill Wendling480ff322009-05-20 23:21:38 +00003048
Devang Patel9fc11702010-05-25 23:40:22 +00003049 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
3050 "section_debug_loc");
3051
Chris Lattner6629ca92010-04-04 22:59:04 +00003052 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
Chris Lattnere58b5472010-04-04 23:10:38 +00003053 EmitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003054}
3055
Devang Patel930143b2009-11-21 02:48:08 +00003056/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling480ff322009-05-20 23:21:38 +00003057///
Devang Patel930143b2009-11-21 02:48:08 +00003058void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00003059 // Get the abbreviation for this DIE.
3060 unsigned AbbrevNumber = Die->getAbbrevNumber();
3061 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
3062
Bill Wendling480ff322009-05-20 23:21:38 +00003063 // Emit the code (index) for the abbreviation.
Chris Lattner7bde8c02010-04-04 18:52:31 +00003064 if (Asm->isVerbose())
Chris Lattnerfa823552010-01-22 23:18:42 +00003065 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
3066 Twine::utohexstr(Die->getOffset()) + ":0x" +
3067 Twine::utohexstr(Die->getSize()) + " " +
3068 dwarf::TagString(Abbrev->getTag()));
Chris Lattner9efd1182010-04-04 19:09:29 +00003069 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00003070
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00003071 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00003072 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
3073
3074 // Emit the DIE attribute values.
3075 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3076 unsigned Attr = AbbrevData[i].getAttribute();
3077 unsigned Form = AbbrevData[i].getForm();
3078 assert(Form && "Too many attributes for DIE (check abbreviation)");
3079
Chris Lattner7bde8c02010-04-04 18:52:31 +00003080 if (Asm->isVerbose())
Chris Lattner5adf9872010-01-24 18:54:17 +00003081 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003082
Bill Wendling480ff322009-05-20 23:21:38 +00003083 switch (Attr) {
3084 case dwarf::DW_AT_sibling:
Devang Patel930143b2009-11-21 02:48:08 +00003085 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003086 break;
3087 case dwarf::DW_AT_abstract_origin: {
3088 DIEEntry *E = cast<DIEEntry>(Values[i]);
3089 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003090 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00003091 Asm->EmitInt32(Addr);
3092 break;
3093 }
Devang Patel12563b32010-04-16 23:33:45 +00003094 case dwarf::DW_AT_ranges: {
3095 // DW_AT_range Value encodes offset in debug_range section.
3096 DIEInteger *V = cast<DIEInteger>(Values[i]);
3097 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
3098 V->getValue(),
3099 DwarfDebugRangeSectionSym,
3100 4);
3101 break;
3102 }
Devang Patel24bc1b52010-06-29 20:17:53 +00003103 case dwarf::DW_AT_stmt_list: {
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003104 Asm->EmitLabelDifference(CurrentLineSectionSym,
Devang Patel24bc1b52010-06-29 20:17:53 +00003105 DwarfDebugLineSectionSym, 4);
3106 break;
3107 }
Devang Patel9fc11702010-05-25 23:40:22 +00003108 case dwarf::DW_AT_location: {
3109 if (UseDotDebugLocEntry.count(Die) != 0) {
3110 DIELabel *L = cast<DIELabel>(Values[i]);
3111 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
3112 } else
3113 Values[i]->EmitValue(Asm, Form);
3114 break;
3115 }
Bill Wendling480ff322009-05-20 23:21:38 +00003116 default:
3117 // Emit an attribute using the defined form.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003118 Values[i]->EmitValue(Asm, Form);
Bill Wendling480ff322009-05-20 23:21:38 +00003119 break;
3120 }
Bill Wendling480ff322009-05-20 23:21:38 +00003121 }
3122
3123 // Emit the DIE children if any.
3124 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
3125 const std::vector<DIE *> &Children = Die->getChildren();
3126
3127 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00003128 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00003129
Chris Lattner7bde8c02010-04-04 18:52:31 +00003130 if (Asm->isVerbose())
Chris Lattner566cae92010-03-09 23:52:58 +00003131 Asm->OutStreamer.AddComment("End Of Children Mark");
3132 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003133 }
3134}
3135
Devang Patel9ccfb642009-12-09 18:24:21 +00003136/// emitDebugInfo - Emit the debug info section.
Bill Wendling480ff322009-05-20 23:21:38 +00003137///
Devang Patel9ccfb642009-12-09 18:24:21 +00003138void DwarfDebug::emitDebugInfo() {
3139 // Start debug info section.
3140 Asm->OutStreamer.SwitchSection(
3141 Asm->getObjFileLowering().getDwarfInfoSection());
Devang Patel1a0df9a2010-05-10 22:49:55 +00003142 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3143 E = CUMap.end(); I != E; ++I) {
3144 CompileUnit *TheCU = I->second;
3145 DIE *Die = TheCU->getCUDie();
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003146
Devang Patel1a0df9a2010-05-10 22:49:55 +00003147 // Emit the compile units header.
3148 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
3149 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003150
Devang Patel1a0df9a2010-05-10 22:49:55 +00003151 // Emit size of content not including length itself
3152 unsigned ContentSize = Die->getSize() +
3153 sizeof(int16_t) + // DWARF version number
3154 sizeof(int32_t) + // Offset Into Abbrev. Section
3155 sizeof(int8_t) + // Pointer Size (in bytes)
3156 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003157
Devang Patel1a0df9a2010-05-10 22:49:55 +00003158 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
3159 Asm->EmitInt32(ContentSize);
3160 Asm->OutStreamer.AddComment("DWARF version number");
3161 Asm->EmitInt16(dwarf::DWARF_VERSION);
3162 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
3163 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
3164 DwarfAbbrevSectionSym);
3165 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3166 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003167
Devang Patel1a0df9a2010-05-10 22:49:55 +00003168 emitDIE(Die);
3169 // FIXME - extra padding for gdb bug.
3170 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
3171 Asm->EmitInt8(0);
3172 Asm->EmitInt8(0);
3173 Asm->EmitInt8(0);
3174 Asm->EmitInt8(0);
3175 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
3176 }
Bill Wendling480ff322009-05-20 23:21:38 +00003177}
3178
Devang Patel930143b2009-11-21 02:48:08 +00003179/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling480ff322009-05-20 23:21:38 +00003180///
Devang Patel930143b2009-11-21 02:48:08 +00003181void DwarfDebug::emitAbbreviations() const {
Bill Wendling480ff322009-05-20 23:21:38 +00003182 // Check to see if it is worth the effort.
3183 if (!Abbreviations.empty()) {
3184 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003185 Asm->OutStreamer.SwitchSection(
3186 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003187
Chris Lattnera179b522010-04-04 19:25:43 +00003188 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003189
3190 // For each abbrevation.
3191 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3192 // Get abbreviation data
3193 const DIEAbbrev *Abbrev = Abbreviations[i];
3194
3195 // Emit the abbrevations code (base 1 index.)
Chris Lattner9efd1182010-04-04 19:09:29 +00003196 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00003197
3198 // Emit the abbreviations data.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003199 Abbrev->Emit(Asm);
Bill Wendling480ff322009-05-20 23:21:38 +00003200 }
3201
3202 // Mark end of abbreviations.
Chris Lattner9efd1182010-04-04 19:09:29 +00003203 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00003204
Chris Lattnera179b522010-04-04 19:25:43 +00003205 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003206 }
3207}
3208
Devang Patel930143b2009-11-21 02:48:08 +00003209/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling480ff322009-05-20 23:21:38 +00003210/// the line matrix.
3211///
Devang Patel930143b2009-11-21 02:48:08 +00003212void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00003213 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00003214 Asm->OutStreamer.AddComment("Extended Op");
3215 Asm->EmitInt8(0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003216
Chris Lattner566cae92010-03-09 23:52:58 +00003217 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003218 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00003219 Asm->OutStreamer.AddComment("DW_LNE_set_address");
3220 Asm->EmitInt8(dwarf::DW_LNE_set_address);
3221
3222 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00003223
Chris Lattnera179b522010-04-04 19:25:43 +00003224 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003225 Asm->getTargetData().getPointerSize(),
3226 0/*AddrSpace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003227
3228 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00003229 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
3230 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003231 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00003232 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003233}
3234
Devang Patel930143b2009-11-21 02:48:08 +00003235/// emitDebugLines - Emit source line information.
Bill Wendling480ff322009-05-20 23:21:38 +00003236///
Devang Patel930143b2009-11-21 02:48:08 +00003237void DwarfDebug::emitDebugLines() {
Bill Wendling480ff322009-05-20 23:21:38 +00003238 // If the target is using .loc/.file, the assembler will be emitting the
3239 // .debug_line table automatically.
Chris Lattner3a383cb2010-04-05 00:13:49 +00003240 if (Asm->MAI->hasDotLocAndDotFile())
Bill Wendling480ff322009-05-20 23:21:38 +00003241 return;
3242
3243 // Minimum line delta, thus ranging from -10..(255-10).
3244 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
3245 // Maximum line delta, thus ranging from -10..(255-10).
3246 const int MaxLineDelta = 255 + MinLineDelta;
3247
3248 // Start the dwarf line section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003249 Asm->OutStreamer.SwitchSection(
3250 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003251
3252 // Construct the section header.
Devang Patel24bc1b52010-06-29 20:17:53 +00003253 CurrentLineSectionSym = Asm->GetTempSymbol("section_line_begin");
3254 Asm->OutStreamer.EmitLabel(CurrentLineSectionSym);
Chris Lattner566cae92010-03-09 23:52:58 +00003255 Asm->OutStreamer.AddComment("Length of Source Line Info");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003256 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_end"),
3257 Asm->GetTempSymbol("line_begin"), 4);
Chris Lattnera179b522010-04-04 19:25:43 +00003258 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003259
Chris Lattner566cae92010-03-09 23:52:58 +00003260 Asm->OutStreamer.AddComment("DWARF version number");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003261 Asm->EmitInt16(dwarf::DWARF_VERSION);
Bill Wendling480ff322009-05-20 23:21:38 +00003262
Chris Lattner566cae92010-03-09 23:52:58 +00003263 Asm->OutStreamer.AddComment("Prolog Length");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003264 Asm->EmitLabelDifference(Asm->GetTempSymbol("line_prolog_end"),
3265 Asm->GetTempSymbol("line_prolog_begin"), 4);
Chris Lattnera179b522010-04-04 19:25:43 +00003266 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00003267
Chris Lattner566cae92010-03-09 23:52:58 +00003268 Asm->OutStreamer.AddComment("Minimum Instruction Length");
3269 Asm->EmitInt8(1);
3270 Asm->OutStreamer.AddComment("Default is_stmt_start flag");
3271 Asm->EmitInt8(1);
3272 Asm->OutStreamer.AddComment("Line Base Value (Special Opcodes)");
3273 Asm->EmitInt8(MinLineDelta);
3274 Asm->OutStreamer.AddComment("Line Range Value (Special Opcodes)");
3275 Asm->EmitInt8(MaxLineDelta);
3276 Asm->OutStreamer.AddComment("Special Opcode Base");
3277 Asm->EmitInt8(-MinLineDelta);
Bill Wendling480ff322009-05-20 23:21:38 +00003278
3279 // Line number standard opcode encodings argument count
Chris Lattner566cae92010-03-09 23:52:58 +00003280 Asm->OutStreamer.AddComment("DW_LNS_copy arg count");
3281 Asm->EmitInt8(0);
3282 Asm->OutStreamer.AddComment("DW_LNS_advance_pc arg count");
3283 Asm->EmitInt8(1);
3284 Asm->OutStreamer.AddComment("DW_LNS_advance_line arg count");
3285 Asm->EmitInt8(1);
3286 Asm->OutStreamer.AddComment("DW_LNS_set_file arg count");
3287 Asm->EmitInt8(1);
3288 Asm->OutStreamer.AddComment("DW_LNS_set_column arg count");
3289 Asm->EmitInt8(1);
3290 Asm->OutStreamer.AddComment("DW_LNS_negate_stmt arg count");
3291 Asm->EmitInt8(0);
3292 Asm->OutStreamer.AddComment("DW_LNS_set_basic_block arg count");
3293 Asm->EmitInt8(0);
3294 Asm->OutStreamer.AddComment("DW_LNS_const_add_pc arg count");
3295 Asm->EmitInt8(0);
3296 Asm->OutStreamer.AddComment("DW_LNS_fixed_advance_pc arg count");
3297 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003298
3299 // Emit directories.
3300 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003301 const std::string &Dir = getSourceDirectoryName(DI);
Chris Lattner7bde8c02010-04-04 18:52:31 +00003302 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Directory");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003303 Asm->OutStreamer.EmitBytes(StringRef(Dir.c_str(), Dir.size()+1), 0);
Bill Wendling480ff322009-05-20 23:21:38 +00003304 }
3305
Chris Lattner566cae92010-03-09 23:52:58 +00003306 Asm->OutStreamer.AddComment("End of directories");
3307 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003308
3309 // Emit files.
3310 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
3311 // Remember source id starts at 1.
3312 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003313 const std::string &FN = getSourceFileName(Id.second);
Chris Lattner7bde8c02010-04-04 18:52:31 +00003314 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("Source");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003315 Asm->OutStreamer.EmitBytes(StringRef(FN.c_str(), FN.size()+1), 0);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003316
Chris Lattner9efd1182010-04-04 19:09:29 +00003317 Asm->EmitULEB128(Id.first, "Directory #");
3318 Asm->EmitULEB128(0, "Mod date");
3319 Asm->EmitULEB128(0, "File size");
Bill Wendling480ff322009-05-20 23:21:38 +00003320 }
3321
Chris Lattner566cae92010-03-09 23:52:58 +00003322 Asm->OutStreamer.AddComment("End of files");
3323 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00003324
Chris Lattnera179b522010-04-04 19:25:43 +00003325 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_prolog_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003326
3327 // A sequence for each text section.
3328 unsigned SecSrcLinesSize = SectionSourceLines.size();
3329
3330 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
3331 // Isolate current sections line info.
3332 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
3333
Bill Wendling480ff322009-05-20 23:21:38 +00003334 // Dwarf assumes we start with first line of first source file.
3335 unsigned Source = 1;
3336 unsigned Line = 1;
3337
3338 // Construct rows of the address, source, line, column matrix.
3339 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
3340 const SrcLineInfo &LineInfo = LineInfos[i];
Chris Lattnerb4666f42010-03-14 08:15:55 +00003341 MCSymbol *Label = LineInfo.getLabel();
Chris Lattneree95d4c2010-03-14 02:20:58 +00003342 if (!Label->isDefined()) continue; // Not emitted, in dead code.
Bill Wendling480ff322009-05-20 23:21:38 +00003343
Chris Lattner3d72a672010-03-09 23:38:23 +00003344 if (Asm->isVerbose()) {
Chris Lattner7e998b72010-03-10 01:04:13 +00003345 std::pair<unsigned, unsigned> SrcID =
Bill Wendling480ff322009-05-20 23:21:38 +00003346 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner7e998b72010-03-10 01:04:13 +00003347 Asm->OutStreamer.AddComment(Twine(getSourceDirectoryName(SrcID.first)) +
Chris Lattnera26fbe42010-03-10 02:29:31 +00003348 "/" +
3349 Twine(getSourceFileName(SrcID.second)) +
Chris Lattner7e998b72010-03-10 01:04:13 +00003350 ":" + Twine(LineInfo.getLine()));
Bill Wendling480ff322009-05-20 23:21:38 +00003351 }
3352
3353 // Define the line address.
Chris Lattner566cae92010-03-09 23:52:58 +00003354 Asm->OutStreamer.AddComment("Extended Op");
3355 Asm->EmitInt8(0);
3356 Asm->OutStreamer.AddComment("Op size");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003357 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
Chris Lattner566cae92010-03-09 23:52:58 +00003358
3359 Asm->OutStreamer.AddComment("DW_LNE_set_address");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003360 Asm->EmitInt8(dwarf::DW_LNE_set_address);
Chris Lattner566cae92010-03-09 23:52:58 +00003361
3362 Asm->OutStreamer.AddComment("Location label");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003363 Asm->OutStreamer.EmitSymbolValue(Label,
3364 Asm->getTargetData().getPointerSize(),
Chris Lattneree95d4c2010-03-14 02:20:58 +00003365 0/*AddrSpace*/);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003366
Bill Wendling480ff322009-05-20 23:21:38 +00003367 // If change of source, then switch to the new source.
3368 if (Source != LineInfo.getSourceID()) {
3369 Source = LineInfo.getSourceID();
Chris Lattner566cae92010-03-09 23:52:58 +00003370 Asm->OutStreamer.AddComment("DW_LNS_set_file");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003371 Asm->EmitInt8(dwarf::DW_LNS_set_file);
Chris Lattner9efd1182010-04-04 19:09:29 +00003372 Asm->EmitULEB128(Source, "New Source");
Bill Wendling480ff322009-05-20 23:21:38 +00003373 }
3374
3375 // If change of line.
3376 if (Line != LineInfo.getLine()) {
3377 // Determine offset.
3378 int Offset = LineInfo.getLine() - Line;
3379 int Delta = Offset - MinLineDelta;
3380
3381 // Update line.
3382 Line = LineInfo.getLine();
3383
3384 // If delta is small enough and in range...
3385 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
3386 // ... then use fast opcode.
Chris Lattner566cae92010-03-09 23:52:58 +00003387 Asm->OutStreamer.AddComment("Line Delta");
3388 Asm->EmitInt8(Delta - MinLineDelta);
Bill Wendling480ff322009-05-20 23:21:38 +00003389 } else {
3390 // ... otherwise use long hand.
Chris Lattner566cae92010-03-09 23:52:58 +00003391 Asm->OutStreamer.AddComment("DW_LNS_advance_line");
Bill Wendling480ff322009-05-20 23:21:38 +00003392 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
Chris Lattner9efd1182010-04-04 19:09:29 +00003393 Asm->EmitSLEB128(Offset, "Line Offset");
Chris Lattner566cae92010-03-09 23:52:58 +00003394 Asm->OutStreamer.AddComment("DW_LNS_copy");
3395 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling480ff322009-05-20 23:21:38 +00003396 }
3397 } else {
3398 // Copy the previous row (different address or source)
Chris Lattner566cae92010-03-09 23:52:58 +00003399 Asm->OutStreamer.AddComment("DW_LNS_copy");
3400 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling480ff322009-05-20 23:21:38 +00003401 }
3402 }
3403
Devang Patel930143b2009-11-21 02:48:08 +00003404 emitEndOfLineMatrix(j + 1);
Bill Wendling480ff322009-05-20 23:21:38 +00003405 }
3406
3407 if (SecSrcLinesSize == 0)
3408 // Because we're emitting a debug_line section, we still need a line
3409 // table. The linker and friends expect it to exist. If there's nothing to
3410 // put into it, emit an empty table.
Devang Patel930143b2009-11-21 02:48:08 +00003411 emitEndOfLineMatrix(1);
Bill Wendling480ff322009-05-20 23:21:38 +00003412
Chris Lattnera179b522010-04-04 19:25:43 +00003413 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("line_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003414}
3415
Devang Patel930143b2009-11-21 02:48:08 +00003416/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling480ff322009-05-20 23:21:38 +00003417///
Devang Patel930143b2009-11-21 02:48:08 +00003418void DwarfDebug::emitCommonDebugFrame() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003419 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003420 return;
3421
Chris Lattner3a383cb2010-04-05 00:13:49 +00003422 int stackGrowth = Asm->getTargetData().getPointerSize();
3423 if (Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3424 TargetFrameInfo::StackGrowsDown)
3425 stackGrowth *= -1;
Bill Wendling480ff322009-05-20 23:21:38 +00003426
3427 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003428 Asm->OutStreamer.SwitchSection(
3429 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003430
Chris Lattnera179b522010-04-04 19:25:43 +00003431 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common"));
Chris Lattner566cae92010-03-09 23:52:58 +00003432 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003433 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_frame_common_end"),
3434 Asm->GetTempSymbol("debug_frame_common_begin"), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003435
Chris Lattnera179b522010-04-04 19:25:43 +00003436 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_begin"));
Chris Lattner566cae92010-03-09 23:52:58 +00003437 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling480ff322009-05-20 23:21:38 +00003438 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner566cae92010-03-09 23:52:58 +00003439 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling480ff322009-05-20 23:21:38 +00003440 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner566cae92010-03-09 23:52:58 +00003441 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003442 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattner9efd1182010-04-04 19:09:29 +00003443 Asm->EmitULEB128(1, "CIE Code Alignment Factor");
3444 Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner566cae92010-03-09 23:52:58 +00003445 Asm->OutStreamer.AddComment("CIE RA Column");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003446 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
Bill Wendling480ff322009-05-20 23:21:38 +00003447 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling480ff322009-05-20 23:21:38 +00003448
3449 std::vector<MachineMove> Moves;
3450 RI->getInitialFrameState(Moves);
3451
Chris Lattneraabc6042010-04-04 23:41:46 +00003452 Asm->EmitFrameMoves(Moves, 0, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003453
Chris Lattner9e06e532010-04-28 01:05:45 +00003454 Asm->EmitAlignment(2);
Chris Lattnera179b522010-04-04 19:25:43 +00003455 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_frame_common_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00003456}
3457
Devang Patel930143b2009-11-21 02:48:08 +00003458/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling480ff322009-05-20 23:21:38 +00003459/// section.
Chris Lattner2c3f4782010-03-13 07:26:18 +00003460void DwarfDebug::
3461emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003462 if (!Asm->MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003463 return;
3464
3465 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003466 Asm->OutStreamer.SwitchSection(
3467 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003468
Chris Lattner566cae92010-03-09 23:52:58 +00003469 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner2c3f4782010-03-13 07:26:18 +00003470 MCSymbol *DebugFrameBegin =
Chris Lattnera179b522010-04-04 19:25:43 +00003471 Asm->GetTempSymbol("debug_frame_begin", DebugFrameInfo.Number);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003472 MCSymbol *DebugFrameEnd =
Chris Lattnera179b522010-04-04 19:25:43 +00003473 Asm->GetTempSymbol("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnerf1429f12010-04-04 19:58:12 +00003474 Asm->EmitLabelDifference(DebugFrameEnd, DebugFrameBegin, 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003475
Chris Lattner2c3f4782010-03-13 07:26:18 +00003476 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling480ff322009-05-20 23:21:38 +00003477
Chris Lattner566cae92010-03-09 23:52:58 +00003478 Asm->OutStreamer.AddComment("FDE CIE offset");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003479 Asm->EmitSectionOffset(Asm->GetTempSymbol("debug_frame_common"),
Chris Lattner70a4fce2010-04-04 23:25:33 +00003480 DwarfFrameSectionSym);
Bill Wendling480ff322009-05-20 23:21:38 +00003481
Chris Lattner566cae92010-03-09 23:52:58 +00003482 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnera179b522010-04-04 19:25:43 +00003483 MCSymbol *FuncBeginSym =
3484 Asm->GetTempSymbol("func_begin", DebugFrameInfo.Number);
Chris Lattner8811e122010-03-13 07:40:56 +00003485 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattner3a383cb2010-04-05 00:13:49 +00003486 Asm->getTargetData().getPointerSize(),
3487 0/*AddrSpace*/);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003488
3489
Chris Lattner566cae92010-03-09 23:52:58 +00003490 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003491 Asm->EmitLabelDifference(Asm->GetTempSymbol("func_end",DebugFrameInfo.Number),
Chris Lattner3a383cb2010-04-05 00:13:49 +00003492 FuncBeginSym, Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003493
Chris Lattneraabc6042010-04-04 23:41:46 +00003494 Asm->EmitFrameMoves(DebugFrameInfo.Moves, FuncBeginSym, false);
Bill Wendling480ff322009-05-20 23:21:38 +00003495
Chris Lattner9e06e532010-04-28 01:05:45 +00003496 Asm->EmitAlignment(2);
Chris Lattner2c3f4782010-03-13 07:26:18 +00003497 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling480ff322009-05-20 23:21:38 +00003498}
3499
Devang Patel9ccfb642009-12-09 18:24:21 +00003500/// emitDebugPubNames - Emit visible names into a debug pubnames section.
3501///
3502void DwarfDebug::emitDebugPubNames() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003503 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3504 E = CUMap.end(); I != E; ++I) {
3505 CompileUnit *TheCU = I->second;
3506 // Start the dwarf pubnames section.
3507 Asm->OutStreamer.SwitchSection(
3508 Asm->getObjFileLowering().getDwarfPubNamesSection());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003509
Devang Patel1a0df9a2010-05-10 22:49:55 +00003510 Asm->OutStreamer.AddComment("Length of Public Names Info");
3511 Asm->EmitLabelDifference(
3512 Asm->GetTempSymbol("pubnames_end", TheCU->getID()),
3513 Asm->GetTempSymbol("pubnames_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003514
Devang Patel1a0df9a2010-05-10 22:49:55 +00003515 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin",
3516 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003517
Devang Patel1a0df9a2010-05-10 22:49:55 +00003518 Asm->OutStreamer.AddComment("DWARF Version");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003519 Asm->EmitInt16(dwarf::DWARF_VERSION);
3520
Devang Patel1a0df9a2010-05-10 22:49:55 +00003521 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003522 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
Devang Patel1a0df9a2010-05-10 22:49:55 +00003523 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003524
Devang Patel1a0df9a2010-05-10 22:49:55 +00003525 Asm->OutStreamer.AddComment("Compilation Unit Length");
3526 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3527 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3528 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003529
Devang Patel1a0df9a2010-05-10 22:49:55 +00003530 const StringMap<DIE*> &Globals = TheCU->getGlobals();
3531 for (StringMap<DIE*>::const_iterator
3532 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3533 const char *Name = GI->getKeyData();
3534 DIE *Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003535
Devang Patel1a0df9a2010-05-10 22:49:55 +00003536 Asm->OutStreamer.AddComment("DIE offset");
3537 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003538
Devang Patel1a0df9a2010-05-10 22:49:55 +00003539 if (Asm->isVerbose())
3540 Asm->OutStreamer.AddComment("External Name");
3541 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
3542 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003543
Devang Patel1a0df9a2010-05-10 22:49:55 +00003544 Asm->OutStreamer.AddComment("End Mark");
3545 Asm->EmitInt32(0);
3546 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end",
3547 TheCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00003548 }
Bill Wendling480ff322009-05-20 23:21:38 +00003549}
3550
Devang Patel04d2f2d2009-11-24 01:14:22 +00003551void DwarfDebug::emitDebugPubTypes() {
Devang Patel1a0df9a2010-05-10 22:49:55 +00003552 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
3553 E = CUMap.end(); I != E; ++I) {
3554 CompileUnit *TheCU = I->second;
3555 // Start the dwarf pubnames section.
3556 Asm->OutStreamer.SwitchSection(
3557 Asm->getObjFileLowering().getDwarfPubTypesSection());
3558 Asm->OutStreamer.AddComment("Length of Public Types Info");
3559 Asm->EmitLabelDifference(
3560 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
3561 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003562
Devang Patel1a0df9a2010-05-10 22:49:55 +00003563 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
3564 TheCU->getID()));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003565
Devang Patel1a0df9a2010-05-10 22:49:55 +00003566 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
3567 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003568
Devang Patel1a0df9a2010-05-10 22:49:55 +00003569 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
3570 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
3571 DwarfInfoSectionSym);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003572
Devang Patel1a0df9a2010-05-10 22:49:55 +00003573 Asm->OutStreamer.AddComment("Compilation Unit Length");
3574 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
3575 Asm->GetTempSymbol("info_begin", TheCU->getID()),
3576 4);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003577
Devang Patel1a0df9a2010-05-10 22:49:55 +00003578 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
3579 for (StringMap<DIE*>::const_iterator
3580 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
3581 const char *Name = GI->getKeyData();
3582 DIE * Entity = GI->second;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003583
Devang Patel1a0df9a2010-05-10 22:49:55 +00003584 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
3585 Asm->EmitInt32(Entity->getOffset());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003586
Devang Patel1a0df9a2010-05-10 22:49:55 +00003587 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
3588 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
3589 }
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003590
Devang Patel1a0df9a2010-05-10 22:49:55 +00003591 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003592 Asm->EmitInt32(0);
Devang Patel1a0df9a2010-05-10 22:49:55 +00003593 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
3594 TheCU->getID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00003595 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00003596}
3597
Devang Patel930143b2009-11-21 02:48:08 +00003598/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling480ff322009-05-20 23:21:38 +00003599///
Devang Patel930143b2009-11-21 02:48:08 +00003600void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00003601 // Check to see if it is worth the effort.
Chris Lattner3d72a672010-03-09 23:38:23 +00003602 if (StringPool.empty()) return;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003603
Chris Lattner3d72a672010-03-09 23:38:23 +00003604 // Start the dwarf str section.
3605 Asm->OutStreamer.SwitchSection(
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003606 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003607
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003608 // Get all of the string pool entries and put them in an array by their ID so
3609 // we can sort them.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003610 SmallVector<std::pair<unsigned,
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003611 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003612
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003613 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
3614 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
3615 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003616
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003617 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003618
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003619 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00003620 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003621 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003622
Chris Lattner3d72a672010-03-09 23:38:23 +00003623 // Emit the string itself.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003624 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003625 }
3626}
3627
Devang Patel930143b2009-11-21 02:48:08 +00003628/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling480ff322009-05-20 23:21:38 +00003629///
Devang Patel930143b2009-11-21 02:48:08 +00003630void DwarfDebug::emitDebugLoc() {
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003631 if (DotDebugLocEntries.empty())
3632 return;
3633
Bill Wendling480ff322009-05-20 23:21:38 +00003634 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003635 Asm->OutStreamer.SwitchSection(
Devang Patel9fc11702010-05-25 23:40:22 +00003636 Asm->getObjFileLowering().getDwarfLocSection());
3637 unsigned char Size = Asm->getTargetData().getPointerSize();
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003638 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
3639 unsigned index = 1;
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003640 for (SmallVector<DotDebugLocEntry, 4>::iterator
3641 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel30265c42010-07-07 20:12:52 +00003642 I != E; ++I, ++index) {
Devang Patel9fc11702010-05-25 23:40:22 +00003643 DotDebugLocEntry Entry = *I;
Devang Patel9fc11702010-05-25 23:40:22 +00003644 if (Entry.isEmpty()) {
3645 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
3646 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel6b9a9fe2010-05-26 23:55:23 +00003647 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patel9fc11702010-05-25 23:40:22 +00003648 } else {
3649 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
3650 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
3651 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
3652 unsigned Reg = RI->getDwarfRegNum(Entry.Loc.getReg(), false);
Devang Patel0e60e672010-08-04 18:40:52 +00003653 if (int Offset = Entry.Loc.getOffset()) {
3654 // If the value is at a certain offset from frame register then
3655 // use DW_OP_fbreg.
3656 unsigned OffsetSize = Offset ? MCAsmInfo::getSLEB128Size(Offset) : 1;
Devang Patel9fc11702010-05-25 23:40:22 +00003657 Asm->OutStreamer.AddComment("Loc expr size");
Devang Patel0e60e672010-08-04 18:40:52 +00003658 Asm->EmitInt16(1 + OffsetSize);
3659 Asm->OutStreamer.AddComment(
3660 dwarf::OperationEncodingString(dwarf::DW_OP_fbreg));
3661 Asm->EmitInt8(dwarf::DW_OP_fbreg);
3662 Asm->OutStreamer.AddComment("Offset");
3663 Asm->EmitSLEB128(Offset);
Devang Patel9fc11702010-05-25 23:40:22 +00003664 } else {
Devang Patel0e60e672010-08-04 18:40:52 +00003665 if (Reg < 32) {
3666 Asm->OutStreamer.AddComment("Loc expr size");
3667 Asm->EmitInt16(1);
3668 Asm->OutStreamer.AddComment(
Devang Patel6d21f612010-08-04 20:32:36 +00003669 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
Devang Patel0e60e672010-08-04 18:40:52 +00003670 Asm->EmitInt8(dwarf::DW_OP_reg0 + Reg);
3671 } else {
3672 Asm->OutStreamer.AddComment("Loc expr size");
3673 Asm->EmitInt16(1 + MCAsmInfo::getULEB128Size(Reg));
3674 Asm->EmitInt8(dwarf::DW_OP_regx);
3675 Asm->EmitULEB128(Reg);
3676 }
Devang Patel9fc11702010-05-25 23:40:22 +00003677 }
3678 }
3679 }
Bill Wendling480ff322009-05-20 23:21:38 +00003680}
3681
3682/// EmitDebugARanges - Emit visible names into a debug aranges section.
3683///
3684void DwarfDebug::EmitDebugARanges() {
3685 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003686 Asm->OutStreamer.SwitchSection(
3687 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003688}
3689
Devang Patel930143b2009-11-21 02:48:08 +00003690/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling480ff322009-05-20 23:21:38 +00003691///
Devang Patel930143b2009-11-21 02:48:08 +00003692void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00003693 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003694 Asm->OutStreamer.SwitchSection(
Devang Patel12563b32010-04-16 23:33:45 +00003695 Asm->getObjFileLowering().getDwarfRangesSection());
Devang Patel6c74a872010-04-27 19:46:33 +00003696 unsigned char Size = Asm->getTargetData().getPointerSize();
3697 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003698 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Patel6c74a872010-04-27 19:46:33 +00003699 I != E; ++I) {
3700 if (*I)
3701 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
Devang Patel12563b32010-04-16 23:33:45 +00003702 else
Devang Patel6c74a872010-04-27 19:46:33 +00003703 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
Devang Patel12563b32010-04-16 23:33:45 +00003704 }
Bill Wendling480ff322009-05-20 23:21:38 +00003705}
3706
Devang Patel930143b2009-11-21 02:48:08 +00003707/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling480ff322009-05-20 23:21:38 +00003708///
Devang Patel930143b2009-11-21 02:48:08 +00003709void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003710 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00003711 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00003712 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003713 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003714 }
3715}
3716
Devang Patel930143b2009-11-21 02:48:08 +00003717/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling480ff322009-05-20 23:21:38 +00003718/// Section Header:
3719/// 1. length of section
3720/// 2. Dwarf version number
3721/// 3. address size.
3722///
3723/// Entries (one "entry" for each function that was inlined):
3724///
3725/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3726/// otherwise offset into __debug_str for regular function name.
3727/// 2. offset into __debug_str section for regular function name.
3728/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3729/// instances for the function.
3730///
3731/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3732/// inlined instance; the die_offset points to the inlined_subroutine die in the
3733/// __debug_info section, and the low_pc is the starting address for the
3734/// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00003735void DwarfDebug::emitDebugInlineInfo() {
Chris Lattner3a383cb2010-04-05 00:13:49 +00003736 if (!Asm->MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003737 return;
3738
Devang Patel1a0df9a2010-05-10 22:49:55 +00003739 if (!FirstCU)
Bill Wendling480ff322009-05-20 23:21:38 +00003740 return;
3741
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003742 Asm->OutStreamer.SwitchSection(
3743 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003744
Chris Lattner566cae92010-03-09 23:52:58 +00003745 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnerf1429f12010-04-04 19:58:12 +00003746 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
3747 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling480ff322009-05-20 23:21:38 +00003748
Chris Lattnera179b522010-04-04 19:25:43 +00003749 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003750
Chris Lattner566cae92010-03-09 23:52:58 +00003751 Asm->OutStreamer.AddComment("Dwarf Version");
3752 Asm->EmitInt16(dwarf::DWARF_VERSION);
3753 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003754 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003755
Devang Patel32cc43c2010-05-07 20:54:48 +00003756 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003757 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00003758
Devang Patel32cc43c2010-05-07 20:54:48 +00003759 const MDNode *Node = *I;
3760 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00003761 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003762 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00003763 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00003764 StringRef LName = SP.getLinkageName();
3765 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00003766
Chris Lattner566cae92010-03-09 23:52:58 +00003767 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003768 if (LName.empty()) {
3769 Asm->OutStreamer.EmitBytes(Name, 0);
3770 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
Jim Grosbacha8683bb2010-07-21 21:21:52 +00003771 } else
Chris Lattner70a4fce2010-04-04 23:25:33 +00003772 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
3773 DwarfStrSectionSym);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003774
Chris Lattner566cae92010-03-09 23:52:58 +00003775 Asm->OutStreamer.AddComment("Function name");
Chris Lattner70a4fce2010-04-04 23:25:33 +00003776 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
Chris Lattner9efd1182010-04-04 19:09:29 +00003777 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00003778
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003779 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00003780 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner7bde8c02010-04-04 18:52:31 +00003781 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner085b6522010-03-09 00:31:02 +00003782 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003783
Chris Lattner7bde8c02010-04-04 18:52:31 +00003784 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattner3a383cb2010-04-05 00:13:49 +00003785 Asm->OutStreamer.EmitSymbolValue(LI->first,
3786 Asm->getTargetData().getPointerSize(),0);
Bill Wendling480ff322009-05-20 23:21:38 +00003787 }
3788 }
3789
Chris Lattnera179b522010-04-04 19:25:43 +00003790 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003791}