blob: 6d6071a3b5ef69d08f3f865a16971e0bd238e001 [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"
16#include "llvm/Module.h"
David Greene829b3e82009-08-19 21:52:55 +000017#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000018#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000019#include "llvm/MC/MCAsmInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000020#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000021#include "llvm/MC/MCStreamer.h"
Chris Lattnere13c3722010-03-09 01:58:53 +000022#include "llvm/MC/MCSymbol.h"
Chris Lattnerf62e3ee2010-01-16 21:57:06 +000023#include "llvm/Target/Mangler.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000024#include "llvm/Target/TargetData.h"
25#include "llvm/Target/TargetFrameInfo.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000026#include "llvm/Target/TargetLoweringObjectFile.h"
Chris Lattner21dc46e2010-04-04 18:06:11 +000027#include "llvm/Target/TargetMachine.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000028#include "llvm/Target/TargetRegisterInfo.h"
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000029#include "llvm/ADT/STLExtras.h"
Chris Lattner06fa1762009-08-24 03:52:50 +000030#include "llvm/ADT/StringExtras.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000031#include "llvm/Support/Debug.h"
32#include "llvm/Support/ErrorHandling.h"
Devang Patel1973df22010-01-26 21:39:14 +000033#include "llvm/Support/ValueHandle.h"
Chris Lattnerf5c834f2010-01-22 22:09:00 +000034#include "llvm/Support/FormattedStream.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000035#include "llvm/Support/Timer.h"
36#include "llvm/System/Path.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000037using namespace llvm;
38
Bill Wendling2f921f82009-05-15 09:23:25 +000039//===----------------------------------------------------------------------===//
40
41/// Configuration values for initial hash set sizes (log2).
42///
Bill Wendling2f921f82009-05-15 09:23:25 +000043static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-05-15 09:23:25 +000044
45namespace llvm {
46
47//===----------------------------------------------------------------------===//
48/// CompileUnit - This dwarf writer support class manages information associate
49/// with a source file.
Nick Lewyckyb7993d62009-11-17 08:11:44 +000050class CompileUnit {
Bill Wendling2f921f82009-05-15 09:23:25 +000051 /// ID - File identifier for source.
52 ///
53 unsigned ID;
54
55 /// Die - Compile unit debug information entry.
56 ///
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +000057 const OwningPtr<DIE> CUDie;
Bill Wendling2f921f82009-05-15 09:23:25 +000058
Jeffrey Yasskin0708de12010-03-11 18:29:55 +000059 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
Devang Patel92e8c652009-11-21 00:31:03 +000060 DIE *IndexTyDie;
61
Bill Wendling2f921f82009-05-15 09:23:25 +000062 /// GVToDieMap - Tracks the mapping of unit level debug informaton
63 /// variables to debug information entries.
Devang Patel80ae3492009-08-28 23:24:31 +000064 /// FIXME : Rename GVToDieMap -> NodeToDieMap
Devang Patel018b29b2010-01-19 06:19:05 +000065 DenseMap<MDNode *, DIE *> GVToDieMap;
Bill Wendling2f921f82009-05-15 09:23:25 +000066
67 /// GVToDIEEntryMap - Tracks the mapping of unit level debug informaton
68 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patel80ae3492009-08-28 23:24:31 +000069 /// FIXME : Rename
Devang Patel018b29b2010-01-19 06:19:05 +000070 DenseMap<MDNode *, DIEEntry *> GVToDIEEntryMap;
Bill Wendling2f921f82009-05-15 09:23:25 +000071
72 /// Globals - A map of globally visible named entities for this unit.
73 ///
74 StringMap<DIE*> Globals;
75
Devang Patel04d2f2d2009-11-24 01:14:22 +000076 /// GlobalTypes - A map of globally visible types for this unit.
77 ///
78 StringMap<DIE*> GlobalTypes;
79
Bill Wendling2f921f82009-05-15 09:23:25 +000080public:
81 CompileUnit(unsigned I, DIE *D)
Devang Patel930143b2009-11-21 02:48:08 +000082 : ID(I), CUDie(D), IndexTyDie(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +000083
84 // Accessors.
Devang Patel04d2f2d2009-11-24 01:14:22 +000085 unsigned getID() const { return ID; }
Jeffrey Yasskin0708de12010-03-11 18:29:55 +000086 DIE* getCUDie() const { return CUDie.get(); }
Devang Patel04d2f2d2009-11-24 01:14:22 +000087 const StringMap<DIE*> &getGlobals() const { return Globals; }
88 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
Bill Wendling2f921f82009-05-15 09:23:25 +000089
90 /// hasContent - Return true if this compile unit has something to write out.
91 ///
Devang Patel930143b2009-11-21 02:48:08 +000092 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendling2f921f82009-05-15 09:23:25 +000093
Devang Patel930143b2009-11-21 02:48:08 +000094 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +000095 ///
Benjamin Kramer96956ed2010-03-31 20:15:45 +000096 void addGlobal(StringRef Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling2f921f82009-05-15 09:23:25 +000097
Devang Patel04d2f2d2009-11-24 01:14:22 +000098 /// addGlobalType - Add a new global type to the compile unit.
99 ///
Benjamin Kramer96956ed2010-03-31 20:15:45 +0000100 void addGlobalType(StringRef Name, DIE *Die) {
Devang Patel04d2f2d2009-11-24 01:14:22 +0000101 GlobalTypes[Name] = Die;
102 }
103
Devang Patele064ad42009-11-20 21:37:22 +0000104 /// getDIE - Returns the debug information entry map slot for the
Bill Wendling2f921f82009-05-15 09:23:25 +0000105 /// specified debug variable.
Devang Patele064ad42009-11-20 21:37:22 +0000106 DIE *getDIE(MDNode *N) { return GVToDieMap.lookup(N); }
Jim Grosbach042483e2009-11-21 23:12:12 +0000107
Devang Patele064ad42009-11-20 21:37:22 +0000108 /// insertDIE - Insert DIE into the map.
109 void insertDIE(MDNode *N, DIE *D) {
110 GVToDieMap.insert(std::make_pair(N, D));
111 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000112
Devang Patele064ad42009-11-20 21:37:22 +0000113 /// getDIEEntry - Returns the debug information entry for the speciefied
114 /// debug variable.
Devang Patel1f4690c2009-12-15 19:16:48 +0000115 DIEEntry *getDIEEntry(MDNode *N) {
Devang Patel018b29b2010-01-19 06:19:05 +0000116 DenseMap<MDNode *, DIEEntry *>::iterator I = GVToDIEEntryMap.find(N);
Devang Patel1f4690c2009-12-15 19:16:48 +0000117 if (I == GVToDIEEntryMap.end())
118 return NULL;
119 return I->second;
120 }
Devang Patele064ad42009-11-20 21:37:22 +0000121
122 /// insertDIEEntry - Insert debug information entry into the map.
123 void insertDIEEntry(MDNode *N, DIEEntry *E) {
124 GVToDIEEntryMap.insert(std::make_pair(N, E));
Bill Wendling2f921f82009-05-15 09:23:25 +0000125 }
126
Devang Patel930143b2009-11-21 02:48:08 +0000127 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +0000128 ///
Devang Patel930143b2009-11-21 02:48:08 +0000129 void addDie(DIE *Buffer) {
130 this->CUDie->addChild(Buffer);
Bill Wendling2f921f82009-05-15 09:23:25 +0000131 }
Devang Patel92e8c652009-11-21 00:31:03 +0000132
133 // getIndexTyDie - Get an anonymous type for index type.
134 DIE *getIndexTyDie() {
135 return IndexTyDie;
136 }
137
Jim Grosbach00e9c612009-11-22 19:20:36 +0000138 // setIndexTyDie - Set D as anonymous type for index which can be reused
139 // later.
Devang Patel92e8c652009-11-21 00:31:03 +0000140 void setIndexTyDie(DIE *D) {
141 IndexTyDie = D;
142 }
143
Bill Wendling2f921f82009-05-15 09:23:25 +0000144};
145
146//===----------------------------------------------------------------------===//
147/// DbgVariable - This class is used to track local variable information.
148///
Devang Patelf3d7c082009-11-16 21:53:40 +0000149class DbgVariable {
Bill Wendling2f921f82009-05-15 09:23:25 +0000150 DIVariable Var; // Variable Descriptor.
151 unsigned FrameIndex; // Variable frame index.
Devang Patela3e9c9c2010-03-15 18:33:46 +0000152 const MachineInstr *DbgValueMInsn; // DBG_VALUE
Devang Patel23b2ae62010-03-29 22:59:58 +0000153 // DbgValueLabel - DBG_VALUE is effective from this label.
154 MCSymbol *DbgValueLabel;
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000155 DbgVariable *const AbstractVar; // Abstract variable for this variable.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000156 DIE *TheDIE;
Bill Wendling2f921f82009-05-15 09:23:25 +0000157public:
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000158 // AbsVar may be NULL.
159 DbgVariable(DIVariable V, unsigned I, DbgVariable *AbsVar)
Devang Patel23b2ae62010-03-29 22:59:58 +0000160 : Var(V), FrameIndex(I), DbgValueMInsn(0),
161 DbgValueLabel(0), AbstractVar(AbsVar), TheDIE(0) {}
Devang Patela3e9c9c2010-03-15 18:33:46 +0000162 DbgVariable(DIVariable V, const MachineInstr *MI, DbgVariable *AbsVar)
Devang Patel23b2ae62010-03-29 22:59:58 +0000163 : Var(V), FrameIndex(0), DbgValueMInsn(MI), DbgValueLabel(0),
164 AbstractVar(AbsVar), TheDIE(0)
Devang Patela3e9c9c2010-03-15 18:33:46 +0000165 {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000166
167 // Accessors.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000168 DIVariable getVariable() const { return Var; }
169 unsigned getFrameIndex() const { return FrameIndex; }
Devang Patela3e9c9c2010-03-15 18:33:46 +0000170 const MachineInstr *getDbgValue() const { return DbgValueMInsn; }
Devang Patel23b2ae62010-03-29 22:59:58 +0000171 MCSymbol *getDbgValueLabel() const { return DbgValueLabel; }
172 void setDbgValueLabel(MCSymbol *L) { DbgValueLabel = L; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000173 DbgVariable *getAbstractVariable() const { return AbstractVar; }
174 void setDIE(DIE *D) { TheDIE = D; }
175 DIE *getDIE() const { return TheDIE; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000176};
177
178//===----------------------------------------------------------------------===//
179/// DbgScope - This class is used to track scope information.
180///
Devang Patelf3d7c082009-11-16 21:53:40 +0000181class DbgScope {
Bill Wendling2f921f82009-05-15 09:23:25 +0000182 DbgScope *Parent; // Parent to this scope.
Jim Grosbach042483e2009-11-21 23:12:12 +0000183 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel1973df22010-01-26 21:39:14 +0000184 // Location at which this scope is inlined.
185 AssertingVH<MDNode> InlinedAtLocation;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000186 bool AbstractScope; // Abstract Scope
Chris Lattnere13c3722010-03-09 01:58:53 +0000187 MCSymbol *StartLabel; // Label ID of the beginning of scope.
188 MCSymbol *EndLabel; // Label ID of the end of scope.
Devang Patel787f94c2009-10-01 18:25:23 +0000189 const MachineInstr *LastInsn; // Last instruction of this scope.
190 const MachineInstr *FirstInsn; // First instruction of this scope.
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000191 // Scopes defined in scope. Contents not owned.
192 SmallVector<DbgScope *, 4> Scopes;
193 // Variables declared in scope. Contents owned.
194 SmallVector<DbgVariable *, 8> Variables;
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000195
Owen Anderson9becc182009-06-24 22:53:20 +0000196 // Private state for dump()
197 mutable unsigned IndentLevel;
Bill Wendling2f921f82009-05-15 09:23:25 +0000198public:
Devang Patel6875c5eb2009-10-14 21:08:09 +0000199 DbgScope(DbgScope *P, DIDescriptor D, MDNode *I = 0)
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000200 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Chris Lattnere13c3722010-03-09 01:58:53 +0000201 StartLabel(0), EndLabel(0),
Devang Patel6875c5eb2009-10-14 21:08:09 +0000202 LastInsn(0), FirstInsn(0), IndentLevel(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000203 virtual ~DbgScope();
204
205 // Accessors.
206 DbgScope *getParent() const { return Parent; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000207 void setParent(DbgScope *P) { Parent = P; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000208 DIDescriptor getDesc() const { return Desc; }
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000209 MDNode *getInlinedAt() const { return InlinedAtLocation; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000210 MDNode *getScopeNode() const { return Desc.getNode(); }
Chris Lattnere13c3722010-03-09 01:58:53 +0000211 MCSymbol *getStartLabel() const { return StartLabel; }
212 MCSymbol *getEndLabel() const { return EndLabel; }
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000213 const SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
214 const SmallVector<DbgVariable *, 8> &getVariables() { return Variables; }
Chris Lattnere13c3722010-03-09 01:58:53 +0000215 void setStartLabel(MCSymbol *S) { StartLabel = S; }
216 void setEndLabel(MCSymbol *E) { EndLabel = E; }
Devang Patel787f94c2009-10-01 18:25:23 +0000217 void setLastInsn(const MachineInstr *MI) { LastInsn = MI; }
218 const MachineInstr *getLastInsn() { return LastInsn; }
219 void setFirstInsn(const MachineInstr *MI) { FirstInsn = MI; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000220 void setAbstractScope() { AbstractScope = true; }
221 bool isAbstractScope() const { return AbstractScope; }
Devang Patel787f94c2009-10-01 18:25:23 +0000222 const MachineInstr *getFirstInsn() { return FirstInsn; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000223
Devang Patel930143b2009-11-21 02:48:08 +0000224 /// addScope - Add a scope to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000225 ///
Devang Patel930143b2009-11-21 02:48:08 +0000226 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000227
Devang Patel930143b2009-11-21 02:48:08 +0000228 /// addVariable - Add a variable to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000229 ///
Devang Patel930143b2009-11-21 02:48:08 +0000230 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000231
Devang Patel530a0752010-01-04 20:44:00 +0000232 void fixInstructionMarkers(DenseMap<const MachineInstr *,
233 unsigned> &MIIndexMap) {
Chris Lattner8d2fe282010-03-31 05:36:29 +0000234 assert(getFirstInsn() && "First instruction is missing!");
Devang Patel530a0752010-01-04 20:44:00 +0000235
236 // Use the end of last child scope as end of this scope.
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000237 const SmallVector<DbgScope *, 4> &Scopes = getScopes();
Devang Pateld146e2e2010-01-05 16:59:17 +0000238 const MachineInstr *LastInsn = getFirstInsn();
Devang Patel530a0752010-01-04 20:44:00 +0000239 unsigned LIndex = 0;
240 if (Scopes.empty()) {
Chris Lattner8d2fe282010-03-31 05:36:29 +0000241 assert(getLastInsn() && "Inner most scope does not have last insn!");
Devang Patel530a0752010-01-04 20:44:00 +0000242 return;
243 }
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000244 for (SmallVector<DbgScope *, 4>::const_iterator SI = Scopes.begin(),
Devang Patel530a0752010-01-04 20:44:00 +0000245 SE = Scopes.end(); SI != SE; ++SI) {
246 DbgScope *DS = *SI;
247 DS->fixInstructionMarkers(MIIndexMap);
248 const MachineInstr *DSLastInsn = DS->getLastInsn();
249 unsigned DSI = MIIndexMap[DSLastInsn];
250 if (DSI > LIndex) {
251 LastInsn = DSLastInsn;
252 LIndex = DSI;
253 }
254 }
Devang Patelca55a042010-02-17 02:20:34 +0000255
256 unsigned CurrentLastInsnIndex = 0;
257 if (const MachineInstr *CL = getLastInsn())
258 CurrentLastInsnIndex = MIIndexMap[CL];
259 unsigned FIndex = MIIndexMap[getFirstInsn()];
260
261 // Set LastInsn as the last instruction for this scope only if
262 // it follows
263 // 1) this scope's first instruction and
264 // 2) current last instruction for this scope, if any.
265 if (LIndex >= CurrentLastInsnIndex && LIndex >= FIndex)
266 setLastInsn(LastInsn);
Devang Patel75cc16c2009-10-01 20:31:14 +0000267 }
268
Bill Wendling2f921f82009-05-15 09:23:25 +0000269#ifndef NDEBUG
270 void dump() const;
271#endif
272};
273
274#ifndef NDEBUG
275void DbgScope::dump() const {
David Greenec230cb92009-12-24 00:31:35 +0000276 raw_ostream &err = dbgs();
Chris Lattner81e8e022009-08-23 00:51:00 +0000277 err.indent(IndentLevel);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000278 MDNode *N = Desc.getNode();
279 N->dump();
Chris Lattnere13c3722010-03-09 01:58:53 +0000280 err << " [" << StartLabel << ", " << EndLabel << "]\n";
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000281 if (AbstractScope)
282 err << "Abstract Scope\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000283
284 IndentLevel += 2;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000285 if (!Scopes.empty())
286 err << "Children ...\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000287 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
288 if (Scopes[i] != this)
289 Scopes[i]->dump();
290
291 IndentLevel -= 2;
292}
293#endif
294
Bill Wendling2f921f82009-05-15 09:23:25 +0000295DbgScope::~DbgScope() {
Bill Wendling2f921f82009-05-15 09:23:25 +0000296 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
297 delete Variables[j];
Bill Wendling2f921f82009-05-15 09:23:25 +0000298}
299
300} // end llvm namespace
301
Chris Lattner11980022010-04-04 07:48:20 +0000302DwarfDebug::DwarfDebug(AsmPrinter *A)
303 : DwarfPrinter(A), ModuleCU(0),
Bill Wendling2f921f82009-05-15 09:23:25 +0000304 AbbreviationsSet(InitAbbreviationsSetSize), Abbreviations(),
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000305 DIEBlocks(), SectionSourceLines(), didInitial(false), shouldEmit(false),
Chris Lattner915c5f92010-04-02 19:42:39 +0000306 CurrentFnDbgScope(0), DebugTimer(0) {
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000307 NextStringPoolNumber = 0;
Bill Wendling2f921f82009-05-15 09:23:25 +0000308 if (TimePassesIsEnabled)
Chris Lattnerf81add32009-12-28 07:41:18 +0000309 DebugTimer = new Timer("Dwarf Debug Writer");
Bill Wendling2f921f82009-05-15 09:23:25 +0000310}
311DwarfDebug::~DwarfDebug() {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000312 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
313 DIEBlocks[j]->~DIEBlock();
Bill Wendling2f921f82009-05-15 09:23:25 +0000314
Bill Wendling2f921f82009-05-15 09:23:25 +0000315 delete DebugTimer;
316}
317
Chris Lattnerb7aa9522010-03-13 02:17:42 +0000318MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
319 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
320 if (Entry.first) return Entry.first;
321
322 Entry.second = NextStringPoolNumber++;
323 return Entry.first = getDWLabel("string", Entry.second);
324}
325
326
Devang Patel930143b2009-11-21 02:48:08 +0000327/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling2f921f82009-05-15 09:23:25 +0000328///
Devang Patel930143b2009-11-21 02:48:08 +0000329void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000330 // Profile the node so that we can make it unique.
331 FoldingSetNodeID ID;
332 Abbrev.Profile(ID);
333
334 // Check the set for priors.
335 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
336
337 // If it's newly added.
338 if (InSet == &Abbrev) {
339 // Add to abbreviation list.
340 Abbreviations.push_back(&Abbrev);
341
342 // Assign the vector position + 1 as its number.
343 Abbrev.setNumber(Abbreviations.size());
344 } else {
345 // Assign existing abbreviation number.
346 Abbrev.setNumber(InSet->getNumber());
347 }
348}
349
Devang Patel930143b2009-11-21 02:48:08 +0000350/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendlingbcad77a2009-05-20 23:24:48 +0000351/// information entry.
Devang Patel930143b2009-11-21 02:48:08 +0000352DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000353 DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000354 return Value;
355}
356
Devang Patel930143b2009-11-21 02:48:08 +0000357/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000358///
Devang Patel930143b2009-11-21 02:48:08 +0000359void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000360 unsigned Form, uint64_t Integer) {
361 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000362 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000363 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000364}
365
Devang Patel930143b2009-11-21 02:48:08 +0000366/// addSInt - Add an signed integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000367///
Devang Patel930143b2009-11-21 02:48:08 +0000368void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000369 unsigned Form, int64_t Integer) {
370 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000371 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000372 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000373}
374
Devang Patel8c339592009-12-02 15:25:16 +0000375/// addString - Add a string attribute data and value. DIEString only
376/// keeps string reference.
Devang Patel930143b2009-11-21 02:48:08 +0000377void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerc3f23b82010-01-23 03:11:46 +0000378 StringRef String) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000379 DIEValue *Value = new (DIEValueAllocator) DIEString(String);
Devang Patel930143b2009-11-21 02:48:08 +0000380 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000381}
382
Devang Patel930143b2009-11-21 02:48:08 +0000383/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000384///
Devang Patel930143b2009-11-21 02:48:08 +0000385void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000386 const MCSymbol *Label) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000387 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
Devang Patel930143b2009-11-21 02:48:08 +0000388 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000389}
390
Devang Patel930143b2009-11-21 02:48:08 +0000391/// addDelta - Add a label delta attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000392///
Devang Patel930143b2009-11-21 02:48:08 +0000393void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerbc9210c2010-03-08 22:23:36 +0000394 const MCSymbol *Hi, const MCSymbol *Lo) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000395 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
Devang Patel930143b2009-11-21 02:48:08 +0000396 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000397}
398
Devang Patel930143b2009-11-21 02:48:08 +0000399/// addBlock - Add block data.
Bill Wendling2f921f82009-05-15 09:23:25 +0000400///
Devang Patel930143b2009-11-21 02:48:08 +0000401void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling2f921f82009-05-15 09:23:25 +0000402 DIEBlock *Block) {
403 Block->ComputeSize(TD);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000404 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
Devang Patel930143b2009-11-21 02:48:08 +0000405 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000406}
407
Devang Patel930143b2009-11-21 02:48:08 +0000408/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000409/// entry.
Devang Patel930143b2009-11-21 02:48:08 +0000410void DwarfDebug::addSourceLine(DIE *Die, const DIVariable *V) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000411 // If there is no compile unit specified, don't add a line #.
Devang Patel3b548aa2010-03-08 20:52:55 +0000412 if (!V->getCompileUnit().Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000413 return;
414
415 unsigned Line = V->getLineNumber();
Devang Patel8119fe872010-03-08 22:02:50 +0000416 unsigned FileID = GetOrCreateSourceID(V->getContext().getDirectory(),
417 V->getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000418 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000419 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
420 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000421}
422
Devang Patel930143b2009-11-21 02:48:08 +0000423/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000424/// entry.
Devang Patel930143b2009-11-21 02:48:08 +0000425void DwarfDebug::addSourceLine(DIE *Die, const DIGlobal *G) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000426 // If there is no compile unit specified, don't add a line #.
Devang Patel3b548aa2010-03-08 20:52:55 +0000427 if (!G->getCompileUnit().Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000428 return;
429
430 unsigned Line = G->getLineNumber();
Devang Patel8119fe872010-03-08 22:02:50 +0000431 unsigned FileID = GetOrCreateSourceID(G->getContext().getDirectory(),
432 G->getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000433 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000434 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
435 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000436}
Devang Patelb2de5fa2009-08-31 22:47:13 +0000437
Devang Patel930143b2009-11-21 02:48:08 +0000438/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000439/// entry.
Devang Patel930143b2009-11-21 02:48:08 +0000440void DwarfDebug::addSourceLine(DIE *Die, const DISubprogram *SP) {
Devang Patelb2de5fa2009-08-31 22:47:13 +0000441 // If there is no compile unit specified, don't add a line #.
Devang Patel3b548aa2010-03-08 20:52:55 +0000442 if (!SP->getCompileUnit().Verify())
Devang Patelb2de5fa2009-08-31 22:47:13 +0000443 return;
Caroline Tice183a5192009-09-11 18:25:54 +0000444 // If the line number is 0, don't add it.
445 if (SP->getLineNumber() == 0)
446 return;
447
Devang Patelb2de5fa2009-08-31 22:47:13 +0000448 unsigned Line = SP->getLineNumber();
Devang Patel8119fe872010-03-08 22:02:50 +0000449 if (!SP->getContext().Verify())
450 return;
Devang Patel834392f2010-03-24 21:30:35 +0000451 unsigned FileID = GetOrCreateSourceID(SP->getDirectory(),
452 SP->getFilename());
Devang Patelb2de5fa2009-08-31 22:47:13 +0000453 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000454 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
455 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patelb2de5fa2009-08-31 22:47:13 +0000456}
457
Devang Patel930143b2009-11-21 02:48:08 +0000458/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000459/// entry.
Devang Patel930143b2009-11-21 02:48:08 +0000460void DwarfDebug::addSourceLine(DIE *Die, const DIType *Ty) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000461 // If there is no compile unit specified, don't add a line #.
462 DICompileUnit CU = Ty->getCompileUnit();
Devang Patel3b548aa2010-03-08 20:52:55 +0000463 if (!CU.Verify())
Bill Wendling2f921f82009-05-15 09:23:25 +0000464 return;
465
466 unsigned Line = Ty->getLineNumber();
Devang Patel8119fe872010-03-08 22:02:50 +0000467 if (!Ty->getContext().Verify())
468 return;
469 unsigned FileID = GetOrCreateSourceID(Ty->getContext().getDirectory(),
470 Ty->getContext().getFilename());
Bill Wendling2f921f82009-05-15 09:23:25 +0000471 assert(FileID && "Invalid file id");
Devang Patel930143b2009-11-21 02:48:08 +0000472 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
473 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling2f921f82009-05-15 09:23:25 +0000474}
475
Devang Patel1f4690c2009-12-15 19:16:48 +0000476/// addSourceLine - Add location information to specified debug information
477/// entry.
478void DwarfDebug::addSourceLine(DIE *Die, const DINameSpace *NS) {
479 // If there is no compile unit specified, don't add a line #.
Devang Patel3b548aa2010-03-08 20:52:55 +0000480 if (!NS->getCompileUnit().Verify())
Devang Patel1f4690c2009-12-15 19:16:48 +0000481 return;
482
483 unsigned Line = NS->getLineNumber();
484 StringRef FN = NS->getFilename();
485 StringRef Dir = NS->getDirectory();
486
487 unsigned FileID = GetOrCreateSourceID(Dir, FN);
488 assert(FileID && "Invalid file id");
489 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
490 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
491}
492
Caroline Ticec87c1e22009-08-31 21:19:37 +0000493/* Byref variables, in Blocks, are declared by the programmer as
494 "SomeType VarName;", but the compiler creates a
495 __Block_byref_x_VarName struct, and gives the variable VarName
496 either the struct, or a pointer to the struct, as its type. This
497 is necessary for various behind-the-scenes things the compiler
498 needs to do with by-reference variables in blocks.
499
500 However, as far as the original *programmer* is concerned, the
501 variable should still have type 'SomeType', as originally declared.
502
503 The following function dives into the __Block_byref_x_VarName
504 struct to find the original type of the variable. This will be
505 passed back to the code generating the type for the Debug
506 Information Entry for the variable 'VarName'. 'VarName' will then
507 have the original type 'SomeType' in its debug information.
508
509 The original type 'SomeType' will be the type of the field named
510 'VarName' inside the __Block_byref_x_VarName struct.
511
512 NOTE: In order for this to not completely fail on the debugger
513 side, the Debug Information Entry for the variable VarName needs to
514 have a DW_AT_location that tells the debugger how to unwind through
515 the pointers and __Block_byref_x_VarName struct to find the actual
Devang Patel930143b2009-11-21 02:48:08 +0000516 value of the variable. The function addBlockByrefType does this. */
Caroline Ticec87c1e22009-08-31 21:19:37 +0000517
518/// Find the type the programmer originally declared the variable to be
519/// and return that type.
520///
Devang Patel930143b2009-11-21 02:48:08 +0000521DIType DwarfDebug::getBlockByrefType(DIType Ty, std::string Name) {
Caroline Ticec87c1e22009-08-31 21:19:37 +0000522
523 DIType subType = Ty;
524 unsigned tag = Ty.getTag();
525
526 if (tag == dwarf::DW_TAG_pointer_type) {
Mike Stump14cf8ec2009-09-30 00:08:22 +0000527 DIDerivedType DTy = DIDerivedType(Ty.getNode());
Caroline Ticec87c1e22009-08-31 21:19:37 +0000528 subType = DTy.getTypeDerivedFrom();
529 }
530
531 DICompositeType blockStruct = DICompositeType(subType.getNode());
Caroline Ticec87c1e22009-08-31 21:19:37 +0000532 DIArray Elements = blockStruct.getTypeArray();
533
Caroline Ticec87c1e22009-08-31 21:19:37 +0000534 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
535 DIDescriptor Element = Elements.getElement(i);
536 DIDerivedType DT = DIDerivedType(Element.getNode());
Devang Patel2d9caf92009-11-25 17:36:49 +0000537 if (Name == DT.getName())
Caroline Ticec87c1e22009-08-31 21:19:37 +0000538 return (DT.getTypeDerivedFrom());
539 }
540
541 return Ty;
542}
543
Devang Patel930143b2009-11-21 02:48:08 +0000544/// addComplexAddress - Start with the address based on the location provided,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000545/// and generate the DWARF information necessary to find the actual variable
546/// given the extra address information encoded in the DIVariable, starting from
547/// the starting location. Add the DWARF information to the die.
548///
Devang Patel930143b2009-11-21 02:48:08 +0000549void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump14cf8ec2009-09-30 00:08:22 +0000550 unsigned Attribute,
551 const MachineLocation &Location) {
552 const DIVariable &VD = DV->getVariable();
553 DIType Ty = VD.getType();
554
555 // Decode the original location, and use that as the start of the byref
556 // variable's location.
557 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000558 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Mike Stump14cf8ec2009-09-30 00:08:22 +0000559
560 if (Location.isReg()) {
561 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000562 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000563 } else {
564 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel930143b2009-11-21 02:48:08 +0000565 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
566 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000567 }
568 } else {
569 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000570 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000571 else {
Devang Patel930143b2009-11-21 02:48:08 +0000572 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
573 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000574 }
575
Devang Patel930143b2009-11-21 02:48:08 +0000576 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump14cf8ec2009-09-30 00:08:22 +0000577 }
578
579 for (unsigned i = 0, N = VD.getNumAddrElements(); i < N; ++i) {
580 uint64_t Element = VD.getAddrElement(i);
581
582 if (Element == DIFactory::OpPlus) {
Devang Patel930143b2009-11-21 02:48:08 +0000583 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
584 addUInt(Block, 0, dwarf::DW_FORM_udata, VD.getAddrElement(++i));
Mike Stump14cf8ec2009-09-30 00:08:22 +0000585 } else if (Element == DIFactory::OpDeref) {
Devang Patel930143b2009-11-21 02:48:08 +0000586 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000587 } else llvm_unreachable("unknown DIFactory Opcode");
588 }
589
590 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000591 addBlock(Die, Attribute, 0, Block);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000592}
593
Caroline Ticec87c1e22009-08-31 21:19:37 +0000594/* Byref variables, in Blocks, are declared by the programmer as "SomeType
595 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
596 gives the variable VarName either the struct, or a pointer to the struct, as
597 its type. This is necessary for various behind-the-scenes things the
598 compiler needs to do with by-reference variables in Blocks.
599
600 However, as far as the original *programmer* is concerned, the variable
601 should still have type 'SomeType', as originally declared.
602
Devang Patel930143b2009-11-21 02:48:08 +0000603 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticec87c1e22009-08-31 21:19:37 +0000604 struct to find the original type of the variable, which is then assigned to
605 the variable's Debug Information Entry as its real type. So far, so good.
606 However now the debugger will expect the variable VarName to have the type
607 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000608 expression that explains to the debugger how to navigate through the
Caroline Ticec87c1e22009-08-31 21:19:37 +0000609 pointers and struct to find the actual variable of type SomeType.
610
611 The following function does just that. We start by getting
612 the "normal" location for the variable. This will be the location
613 of either the struct __Block_byref_x_VarName or the pointer to the
614 struct __Block_byref_x_VarName.
615
616 The struct will look something like:
617
618 struct __Block_byref_x_VarName {
619 ... <various fields>
620 struct __Block_byref_x_VarName *forwarding;
621 ... <various other fields>
622 SomeType VarName;
623 ... <maybe more fields>
624 };
625
626 If we are given the struct directly (as our starting point) we
627 need to tell the debugger to:
628
629 1). Add the offset of the forwarding field.
630
Dan Gohman4a618822010-02-10 16:03:48 +0000631 2). Follow that pointer to get the real __Block_byref_x_VarName
Caroline Ticec87c1e22009-08-31 21:19:37 +0000632 struct to use (the real one may have been copied onto the heap).
633
634 3). Add the offset for the field VarName, to find the actual variable.
635
636 If we started with a pointer to the struct, then we need to
637 dereference that pointer first, before the other steps.
638 Translating this into DWARF ops, we will need to append the following
639 to the current location description for the variable:
640
641 DW_OP_deref -- optional, if we start with a pointer
642 DW_OP_plus_uconst <forward_fld_offset>
643 DW_OP_deref
644 DW_OP_plus_uconst <varName_fld_offset>
645
646 That is what this function does. */
647
Devang Patel930143b2009-11-21 02:48:08 +0000648/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticec87c1e22009-08-31 21:19:37 +0000649/// provided, and generate the DWARF information necessary to find the
650/// actual Block variable (navigating the Block struct) based on the
651/// starting location. Add the DWARF information to the die. For
652/// more information, read large comment just above here.
653///
Devang Patel930143b2009-11-21 02:48:08 +0000654void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000655 unsigned Attribute,
656 const MachineLocation &Location) {
Caroline Ticec87c1e22009-08-31 21:19:37 +0000657 const DIVariable &VD = DV->getVariable();
658 DIType Ty = VD.getType();
659 DIType TmpTy = Ty;
660 unsigned Tag = Ty.getTag();
661 bool isPointer = false;
662
Devang Patel2d9caf92009-11-25 17:36:49 +0000663 StringRef varName = VD.getName();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000664
665 if (Tag == dwarf::DW_TAG_pointer_type) {
Mike Stump14cf8ec2009-09-30 00:08:22 +0000666 DIDerivedType DTy = DIDerivedType(Ty.getNode());
Caroline Ticec87c1e22009-08-31 21:19:37 +0000667 TmpTy = DTy.getTypeDerivedFrom();
668 isPointer = true;
669 }
670
671 DICompositeType blockStruct = DICompositeType(TmpTy.getNode());
672
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000673 // Find the __forwarding field and the variable field in the __Block_byref
674 // struct.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000675 DIArray Fields = blockStruct.getTypeArray();
676 DIDescriptor varField = DIDescriptor();
677 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000678
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000679 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
680 DIDescriptor Element = Fields.getElement(i);
681 DIDerivedType DT = DIDerivedType(Element.getNode());
Devang Patel2d9caf92009-11-25 17:36:49 +0000682 StringRef fieldName = DT.getName();
683 if (fieldName == "__forwarding")
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000684 forwardingField = Element;
Devang Patel2d9caf92009-11-25 17:36:49 +0000685 else if (fieldName == varName)
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000686 varField = Element;
687 }
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000688
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000689 // Get the offsets for the forwarding field and the variable field.
Chris Lattner71696ef2010-03-31 06:06:37 +0000690 unsigned forwardingFieldOffset =
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000691 DIDerivedType(forwardingField.getNode()).getOffsetInBits() >> 3;
Chris Lattner71696ef2010-03-31 06:06:37 +0000692 unsigned varFieldOffset =
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000693 DIDerivedType(varField.getNode()).getOffsetInBits() >> 3;
Caroline Ticec87c1e22009-08-31 21:19:37 +0000694
Mike Stump944fa252009-09-24 23:21:26 +0000695 // Decode the original location, and use that as the start of the byref
696 // variable's location.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000697 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000698 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000699
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000700 if (Location.isReg()) {
701 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000702 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000703 else {
704 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel930143b2009-11-21 02:48:08 +0000705 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
706 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000707 }
708 } else {
709 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000710 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000711 else {
Devang Patel930143b2009-11-21 02:48:08 +0000712 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
713 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000714 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000715
Devang Patel930143b2009-11-21 02:48:08 +0000716 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000717 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000718
Mike Stump944fa252009-09-24 23:21:26 +0000719 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000720 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000721 if (isPointer)
Devang Patel930143b2009-11-21 02:48:08 +0000722 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000723
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000724 // Next add the offset for the '__forwarding' field:
725 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
726 // adding the offset if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000727 if (forwardingFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000728 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
729 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000730 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000731
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000732 // Now dereference the __forwarding field to get to the real __Block_byref
733 // struct: DW_OP_deref.
Devang Patel930143b2009-11-21 02:48:08 +0000734 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000735
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000736 // Now that we've got the real __Block_byref... struct, add the offset
737 // for the variable's field to get to the location of the actual variable:
738 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000739 if (varFieldOffset > 0) {
Devang Patel930143b2009-11-21 02:48:08 +0000740 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
741 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000742 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000743
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000744 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000745 addBlock(Die, Attribute, 0, Block);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000746}
747
Devang Patel930143b2009-11-21 02:48:08 +0000748/// addAddress - Add an address attribute to a die based on the location
Bill Wendling2f921f82009-05-15 09:23:25 +0000749/// provided.
Devang Patel930143b2009-11-21 02:48:08 +0000750void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000751 const MachineLocation &Location) {
752 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Benjamin Kramer74729ae2010-03-31 19:34:01 +0000753 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Bill Wendling2f921f82009-05-15 09:23:25 +0000754
755 if (Location.isReg()) {
756 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000757 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000758 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000759 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
760 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000761 }
762 } else {
763 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000764 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000765 } else {
Devang Patel930143b2009-11-21 02:48:08 +0000766 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
767 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000768 }
769
Devang Patel930143b2009-11-21 02:48:08 +0000770 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling2f921f82009-05-15 09:23:25 +0000771 }
772
Devang Patel930143b2009-11-21 02:48:08 +0000773 addBlock(Die, Attribute, 0, Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000774}
775
Devang Patel2b75ed22009-12-10 19:14:49 +0000776/// addToContextOwner - Add Die into the list of its context owner's children.
777void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000778 if (Context.isType()) {
Devang Patel2b75ed22009-12-10 19:14:49 +0000779 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context.getNode()));
780 ContextDIE->addChild(Die);
Devang Patel1f4690c2009-12-15 19:16:48 +0000781 } else if (Context.isNameSpace()) {
782 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context.getNode()));
783 ContextDIE->addChild(Die);
Devang Patel2b75ed22009-12-10 19:14:49 +0000784 } else if (DIE *ContextDIE = ModuleCU->getDIE(Context.getNode()))
785 ContextDIE->addChild(Die);
786 else
787 ModuleCU->addDie(Die);
788}
789
Devang Patelb5b60ea2009-12-10 18:05:33 +0000790/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
791/// given DIType.
792DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
793 DIE *TyDIE = ModuleCU->getDIE(Ty.getNode());
794 if (TyDIE)
795 return TyDIE;
796
797 // Create new type.
798 TyDIE = new DIE(dwarf::DW_TAG_base_type);
799 ModuleCU->insertDIE(Ty.getNode(), TyDIE);
800 if (Ty.isBasicType())
801 constructTypeDIE(*TyDIE, DIBasicType(Ty.getNode()));
802 else if (Ty.isCompositeType())
803 constructTypeDIE(*TyDIE, DICompositeType(Ty.getNode()));
804 else {
805 assert(Ty.isDerivedType() && "Unknown kind of DIType");
806 constructTypeDIE(*TyDIE, DIDerivedType(Ty.getNode()));
807 }
808
Devang Patel2b75ed22009-12-10 19:14:49 +0000809 addToContextOwner(TyDIE, Ty.getContext());
Devang Patelb5b60ea2009-12-10 18:05:33 +0000810 return TyDIE;
811}
812
Devang Patel930143b2009-11-21 02:48:08 +0000813/// addType - Add a new type attribute to the specified entity.
Devang Patel9ccfb642009-12-09 18:24:21 +0000814void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Devang Patel3b548aa2010-03-08 20:52:55 +0000815 if (!Ty.isValid())
Bill Wendling2f921f82009-05-15 09:23:25 +0000816 return;
817
818 // Check for pre-existence.
Devang Patel9ccfb642009-12-09 18:24:21 +0000819 DIEEntry *Entry = ModuleCU->getDIEEntry(Ty.getNode());
Bill Wendling2f921f82009-05-15 09:23:25 +0000820 // If it exists then use the existing value.
Devang Patel930143b2009-11-21 02:48:08 +0000821 if (Entry) {
822 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000823 return;
824 }
825
Bill Wendling2f921f82009-05-15 09:23:25 +0000826 // Construct type.
Devang Patelb5b60ea2009-12-10 18:05:33 +0000827 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000828
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +0000829 // Set up proxy.
830 Entry = createDIEEntry(Buffer);
831 ModuleCU->insertDIEEntry(Ty.getNode(), Entry);
832
Devang Patel930143b2009-11-21 02:48:08 +0000833 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000834}
835
Devang Patel930143b2009-11-21 02:48:08 +0000836/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000837void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000838 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000839 StringRef Name = BTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +0000840 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +0000841 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling2f921f82009-05-15 09:23:25 +0000842 BTy.getEncoding());
843
844 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +0000845 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +0000846 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +0000847 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel930143b2009-11-21 02:48:08 +0000848 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +0000849}
850
Devang Patel930143b2009-11-21 02:48:08 +0000851/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000852void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000853 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000854 StringRef Name = DTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +0000855 uint64_t Size = DTy.getSizeInBits() >> 3;
856 unsigned Tag = DTy.getTag();
857
858 // FIXME - Workaround for templates.
859 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
860
861 Buffer.setTag(Tag);
862
863 // Map to main type, void will not have a type.
864 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel9ccfb642009-12-09 18:24:21 +0000865 addType(&Buffer, FromTy);
Bill Wendling2f921f82009-05-15 09:23:25 +0000866
867 // Add name if not anonymous or intermediate type.
Devang Patelae466ef2009-11-30 23:56:56 +0000868 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +0000869 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +0000870
871 // Add size if non-zero (derived types might be zero-sized.)
872 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +0000873 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +0000874
875 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patelb5b51592009-11-23 18:43:37 +0000876 if (!DTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +0000877 addSourceLine(&Buffer, &DTy);
Bill Wendling2f921f82009-05-15 09:23:25 +0000878}
879
Devang Patel930143b2009-11-21 02:48:08 +0000880/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000881void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000882 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000883 StringRef Name = CTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +0000884
885 uint64_t Size = CTy.getSizeInBits() >> 3;
886 unsigned Tag = CTy.getTag();
887 Buffer.setTag(Tag);
888
889 switch (Tag) {
890 case dwarf::DW_TAG_vector_type:
891 case dwarf::DW_TAG_array_type:
Devang Patel9ccfb642009-12-09 18:24:21 +0000892 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +0000893 break;
894 case dwarf::DW_TAG_enumeration_type: {
895 DIArray Elements = CTy.getTypeArray();
896
897 // Add enumerators to enumeration type.
898 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
899 DIE *ElemDie = NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +0000900 DIDescriptor Enum(Elements.getElement(i).getNode());
901 if (Enum.isEnumerator()) {
902 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum.getNode()));
Devang Patel930143b2009-11-21 02:48:08 +0000903 Buffer.addChild(ElemDie);
Devang Patelfafa1fe2009-10-09 17:51:49 +0000904 }
Bill Wendling2f921f82009-05-15 09:23:25 +0000905 }
906 }
907 break;
908 case dwarf::DW_TAG_subroutine_type: {
909 // Add return type.
910 DIArray Elements = CTy.getTypeArray();
911 DIDescriptor RTy = Elements.getElement(0);
Devang Patel9ccfb642009-12-09 18:24:21 +0000912 addType(&Buffer, DIType(RTy.getNode()));
Bill Wendling2f921f82009-05-15 09:23:25 +0000913
914 // Add prototype flag.
Devang Patel930143b2009-11-21 02:48:08 +0000915 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +0000916
917 // Add arguments.
918 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
919 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
920 DIDescriptor Ty = Elements.getElement(i);
Devang Patel9ccfb642009-12-09 18:24:21 +0000921 addType(Arg, DIType(Ty.getNode()));
Devang Patel930143b2009-11-21 02:48:08 +0000922 Buffer.addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000923 }
924 }
925 break;
926 case dwarf::DW_TAG_structure_type:
927 case dwarf::DW_TAG_union_type:
928 case dwarf::DW_TAG_class_type: {
929 // Add elements to structure type.
930 DIArray Elements = CTy.getTypeArray();
931
932 // A forward struct declared type may not have elements available.
Devang Patel3b548aa2010-03-08 20:52:55 +0000933 unsigned N = Elements.getNumElements();
934 if (N == 0)
Bill Wendling2f921f82009-05-15 09:23:25 +0000935 break;
936
937 // Add elements to structure type.
Devang Patel3b548aa2010-03-08 20:52:55 +0000938 for (unsigned i = 0; i < N; ++i) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000939 DIDescriptor Element = Elements.getElement(i);
940 DIE *ElemDie = NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +0000941 if (Element.isSubprogram())
Devang Patel525dda02009-12-14 16:18:45 +0000942 ElemDie = createSubprogramDIE(DISubprogram(Element.getNode()));
Devang Patel3b548aa2010-03-08 20:52:55 +0000943 else if (Element.isVariable()) {
Devang Patel160c92d2010-01-30 01:08:30 +0000944 DIVariable DV(Element.getNode());
945 ElemDie = new DIE(dwarf::DW_TAG_variable);
946 addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
947 DV.getName());
948 addType(ElemDie, DV.getType());
949 addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
950 addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
951 addSourceLine(ElemDie, &DV);
Devang Patel3b548aa2010-03-08 20:52:55 +0000952 } else if (Element.isDerivedType())
Devang Patel9ccfb642009-12-09 18:24:21 +0000953 ElemDie = createMemberDIE(DIDerivedType(Element.getNode()));
Devang Patel3b548aa2010-03-08 20:52:55 +0000954 else
955 continue;
Devang Patel930143b2009-11-21 02:48:08 +0000956 Buffer.addChild(ElemDie);
Bill Wendling2f921f82009-05-15 09:23:25 +0000957 }
958
Devang Patel3082c012009-08-27 23:51:51 +0000959 if (CTy.isAppleBlockExtension())
Devang Patel930143b2009-11-21 02:48:08 +0000960 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +0000961
962 unsigned RLang = CTy.getRunTimeLang();
963 if (RLang)
Devang Patel930143b2009-11-21 02:48:08 +0000964 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling2f921f82009-05-15 09:23:25 +0000965 dwarf::DW_FORM_data1, RLang);
Devang Patel303a1be2010-01-26 21:16:06 +0000966
967 DICompositeType ContainingType = CTy.getContainingType();
Devang Patel3b548aa2010-03-08 20:52:55 +0000968 if (DIDescriptor(ContainingType.getNode()).isCompositeType())
Devang Patel303a1be2010-01-26 21:16:06 +0000969 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
970 getOrCreateTypeDIE(DIType(ContainingType.getNode())));
Bill Wendling2f921f82009-05-15 09:23:25 +0000971 break;
972 }
973 default:
974 break;
975 }
976
977 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +0000978 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +0000979 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +0000980
Devang Patelaedd6f52010-01-29 18:34:58 +0000981 if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type ||
Bill Wendling2f921f82009-05-15 09:23:25 +0000982 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type) {
983 // Add size if non-zero (derived types might be zero-sized.)
984 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +0000985 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +0000986 else {
987 // Add zero size if it is not a forward declaration.
988 if (CTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +0000989 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +0000990 else
Devang Patel930143b2009-11-21 02:48:08 +0000991 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling2f921f82009-05-15 09:23:25 +0000992 }
993
994 // Add source line info if available.
995 if (!CTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +0000996 addSourceLine(&Buffer, &CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +0000997 }
998}
999
Devang Patel930143b2009-11-21 02:48:08 +00001000/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1001void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling2f921f82009-05-15 09:23:25 +00001002 int64_t L = SR.getLo();
1003 int64_t H = SR.getHi();
1004 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1005
Devang Patel930143b2009-11-21 02:48:08 +00001006 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patelf691df32009-08-14 20:59:16 +00001007 if (L)
Devang Patel930143b2009-11-21 02:48:08 +00001008 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Patel8f046022009-12-04 23:10:24 +00001009 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling2f921f82009-05-15 09:23:25 +00001010
Devang Patel930143b2009-11-21 02:48:08 +00001011 Buffer.addChild(DW_Subrange);
Bill Wendling2f921f82009-05-15 09:23:25 +00001012}
1013
Devang Patel930143b2009-11-21 02:48:08 +00001014/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +00001015void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling2f921f82009-05-15 09:23:25 +00001016 DICompositeType *CTy) {
1017 Buffer.setTag(dwarf::DW_TAG_array_type);
1018 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel930143b2009-11-21 02:48:08 +00001019 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001020
1021 // Emit derived type.
Devang Patel9ccfb642009-12-09 18:24:21 +00001022 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001023 DIArray Elements = CTy->getTypeArray();
1024
Devang Patel92e8c652009-11-21 00:31:03 +00001025 // Get an anonymous type for index type.
Devang Patel9ccfb642009-12-09 18:24:21 +00001026 DIE *IdxTy = ModuleCU->getIndexTyDie();
Devang Patel92e8c652009-11-21 00:31:03 +00001027 if (!IdxTy) {
1028 // Construct an anonymous type for index type.
1029 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +00001030 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1031 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel92e8c652009-11-21 00:31:03 +00001032 dwarf::DW_ATE_signed);
Devang Patel9ccfb642009-12-09 18:24:21 +00001033 ModuleCU->addDie(IdxTy);
1034 ModuleCU->setIndexTyDie(IdxTy);
Devang Patel92e8c652009-11-21 00:31:03 +00001035 }
Bill Wendling2f921f82009-05-15 09:23:25 +00001036
1037 // Add subranges to array type.
1038 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1039 DIDescriptor Element = Elements.getElement(i);
1040 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patel930143b2009-11-21 02:48:08 +00001041 constructSubrangeDIE(Buffer, DISubrange(Element.getNode()), IdxTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001042 }
1043}
1044
Devang Patel930143b2009-11-21 02:48:08 +00001045/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3b548aa2010-03-08 20:52:55 +00001046DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator ETy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001047 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel3b548aa2010-03-08 20:52:55 +00001048 StringRef Name = ETy.getName();
Devang Patel930143b2009-11-21 02:48:08 +00001049 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel3b548aa2010-03-08 20:52:55 +00001050 int64_t Value = ETy.getEnumValue();
Devang Patel930143b2009-11-21 02:48:08 +00001051 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +00001052 return Enumerator;
1053}
1054
Devang Patel43ef34d2010-01-05 01:46:14 +00001055/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
1056/// printer to not emit usual symbol prefix before the symbol name is used then
1057/// return linkage name after skipping this special LLVM prefix.
1058static StringRef getRealLinkageName(StringRef LinkageName) {
1059 char One = '\1';
1060 if (LinkageName.startswith(StringRef(&One, 1)))
1061 return LinkageName.substr(1);
1062 return LinkageName;
1063}
1064
Devang Patel930143b2009-11-21 02:48:08 +00001065/// createGlobalVariableDIE - Create new DIE using GV.
Devang Patel9ccfb642009-12-09 18:24:21 +00001066DIE *DwarfDebug::createGlobalVariableDIE(const DIGlobalVariable &GV) {
Jim Grosbach00e9c612009-11-22 19:20:36 +00001067 // If the global variable was optmized out then no need to create debug info
1068 // entry.
Devang Patelcc11371b2009-11-06 17:58:12 +00001069 if (!GV.getGlobal()) return NULL;
Devang Patel2d9caf92009-11-25 17:36:49 +00001070 if (GV.getDisplayName().empty()) return NULL;
Devang Patel06ce6502009-11-06 01:30:04 +00001071
Bill Wendling2f921f82009-05-15 09:23:25 +00001072 DIE *GVDie = new DIE(dwarf::DW_TAG_variable);
Jim Grosbach042483e2009-11-21 23:12:12 +00001073 addString(GVDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
Devang Patelb2969422009-09-29 18:40:58 +00001074 GV.getDisplayName());
1075
Devang Patel2d9caf92009-11-25 17:36:49 +00001076 StringRef LinkageName = GV.getLinkageName();
Devang Patel43ef34d2010-01-05 01:46:14 +00001077 if (!LinkageName.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001078 addString(GVDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel43ef34d2010-01-05 01:46:14 +00001079 getRealLinkageName(LinkageName));
1080
Devang Patel9ccfb642009-12-09 18:24:21 +00001081 addType(GVDie, GV.getType());
Bill Wendling2f921f82009-05-15 09:23:25 +00001082 if (!GV.isLocalToUnit())
Devang Patel930143b2009-11-21 02:48:08 +00001083 addUInt(GVDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1084 addSourceLine(GVDie, &GV);
Devang Patel4144a822009-10-05 23:22:08 +00001085
Bill Wendling2f921f82009-05-15 09:23:25 +00001086 return GVDie;
1087}
1088
Devang Patel930143b2009-11-21 02:48:08 +00001089/// createMemberDIE - Create new member DIE.
Devang Patel9ccfb642009-12-09 18:24:21 +00001090DIE *DwarfDebug::createMemberDIE(const DIDerivedType &DT) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001091 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel2d9caf92009-11-25 17:36:49 +00001092 StringRef Name = DT.getName();
1093 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001094 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel2d9caf92009-11-25 17:36:49 +00001095
Devang Patel9ccfb642009-12-09 18:24:21 +00001096 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001097
Devang Patel930143b2009-11-21 02:48:08 +00001098 addSourceLine(MemberDie, &DT);
Bill Wendling2f921f82009-05-15 09:23:25 +00001099
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001100 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Patel930143b2009-11-21 02:48:08 +00001101 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel67f56f02009-11-04 22:06:12 +00001102
Bill Wendling2f921f82009-05-15 09:23:25 +00001103 uint64_t Size = DT.getSizeInBits();
Devang Patelf05d5722009-11-04 23:48:00 +00001104 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling2f921f82009-05-15 09:23:25 +00001105
1106 if (Size != FieldSize) {
1107 // Handle bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001108 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1109 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling2f921f82009-05-15 09:23:25 +00001110
1111 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling2f921f82009-05-15 09:23:25 +00001112 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1113 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer2b459982010-01-07 17:50:57 +00001114 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling2f921f82009-05-15 09:23:25 +00001115 Offset -= FieldOffset;
1116
1117 // Maybe we need to work from the other end.
1118 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
Devang Patel930143b2009-11-21 02:48:08 +00001119 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling2f921f82009-05-15 09:23:25 +00001120
Devang Patel67f56f02009-11-04 22:06:12 +00001121 // Here WD_AT_data_member_location points to the anonymous
1122 // field that includes this bit field.
Devang Patel930143b2009-11-21 02:48:08 +00001123 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001124
1125 } else
1126 // This is not a bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001127 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001128
Devang Pateld2316892010-02-03 20:08:48 +00001129 if (DT.getTag() == dwarf::DW_TAG_inheritance
1130 && DT.isVirtual()) {
1131
1132 // For C++, virtual base classes are not at fixed offset. Use following
1133 // expression to extract appropriate offset from vtable.
1134 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1135
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001136 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
Devang Pateld2316892010-02-03 20:08:48 +00001137 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1138 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1139 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1140 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1141 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1142 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1143 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1144
1145 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
1146 VBaseLocationDie);
1147 } else
1148 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001149
1150 if (DT.isProtected())
Devang Pateleb57c592009-12-03 19:11:07 +00001151 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001152 dwarf::DW_ACCESS_protected);
1153 else if (DT.isPrivate())
Devang Pateleb57c592009-12-03 19:11:07 +00001154 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001155 dwarf::DW_ACCESS_private);
Devang Pateleb57c592009-12-03 19:11:07 +00001156 else if (DT.getTag() == dwarf::DW_TAG_inheritance)
1157 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1158 dwarf::DW_ACCESS_public);
1159 if (DT.isVirtual())
1160 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1161 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling2f921f82009-05-15 09:23:25 +00001162 return MemberDie;
1163}
1164
Devang Patel525dda02009-12-14 16:18:45 +00001165/// createSubprogramDIE - Create new DIE using SP.
1166DIE *DwarfDebug::createSubprogramDIE(const DISubprogram &SP, bool MakeDecl) {
1167 DIE *SPDie = ModuleCU->getDIE(SP.getNode());
1168 if (SPDie)
1169 return SPDie;
1170
1171 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patelf200b392010-03-02 17:58:15 +00001172 // Constructors and operators for anonymous aggregates do not have names.
Devang Pateld0fa3042010-03-02 01:26:20 +00001173 if (!SP.getName().empty())
1174 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling2f921f82009-05-15 09:23:25 +00001175
Devang Patel2d9caf92009-11-25 17:36:49 +00001176 StringRef LinkageName = SP.getLinkageName();
Devang Patel43ef34d2010-01-05 01:46:14 +00001177 if (!LinkageName.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001178 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel43ef34d2010-01-05 01:46:14 +00001179 getRealLinkageName(LinkageName));
1180
Devang Patel930143b2009-11-21 02:48:08 +00001181 addSourceLine(SPDie, &SP);
Bill Wendling2f921f82009-05-15 09:23:25 +00001182
Bill Wendling2f921f82009-05-15 09:23:25 +00001183 // Add prototyped tag, if C or ObjC.
1184 unsigned Lang = SP.getCompileUnit().getLanguage();
1185 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1186 Lang == dwarf::DW_LANG_ObjC)
Devang Patel930143b2009-11-21 02:48:08 +00001187 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001188
1189 // Add Return Type.
Devang Patel236526d2009-12-03 01:25:38 +00001190 DICompositeType SPTy = SP.getType();
1191 DIArray Args = SPTy.getTypeArray();
Bill Wendling2f921f82009-05-15 09:23:25 +00001192 unsigned SPTag = SPTy.getTag();
Devang Pateleb57c592009-12-03 19:11:07 +00001193
Devang Patel3b548aa2010-03-08 20:52:55 +00001194 if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel9ccfb642009-12-09 18:24:21 +00001195 addType(SPDie, SPTy);
Devang Patel236526d2009-12-03 01:25:38 +00001196 else
Devang Patel9ccfb642009-12-09 18:24:21 +00001197 addType(SPDie, DIType(Args.getElement(0).getNode()));
Devang Patel236526d2009-12-03 01:25:38 +00001198
Devang Pateleb57c592009-12-03 19:11:07 +00001199 unsigned VK = SP.getVirtuality();
1200 if (VK) {
1201 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001202 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Pateleb57c592009-12-03 19:11:07 +00001203 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1204 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1205 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Devang Patel018b29b2010-01-19 06:19:05 +00001206 ContainingTypeMap.insert(std::make_pair(SPDie,
1207 SP.getContainingType().getNode()));
Devang Pateleb57c592009-12-03 19:11:07 +00001208 }
1209
Devang Patel525dda02009-12-14 16:18:45 +00001210 if (MakeDecl || !SP.isDefinition()) {
Devang Patel930143b2009-11-21 02:48:08 +00001211 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001212
1213 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel236526d2009-12-03 01:25:38 +00001214 // be handled while processing variables.
1215 DICompositeType SPTy = SP.getType();
1216 DIArray Args = SPTy.getTypeArray();
1217 unsigned SPTag = SPTy.getTag();
1218
Bill Wendling2f921f82009-05-15 09:23:25 +00001219 if (SPTag == dwarf::DW_TAG_subroutine_type)
1220 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1221 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel6efc8e52010-02-06 01:02:37 +00001222 DIType ATy = DIType(DIType(Args.getElement(i).getNode()));
1223 addType(Arg, ATy);
1224 if (ATy.isArtificial())
1225 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel930143b2009-11-21 02:48:08 +00001226 SPDie->addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +00001227 }
1228 }
1229
Devang Patel999b4992010-02-03 19:57:19 +00001230 if (SP.isArtificial())
1231 addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1232
Bill Wendling2f921f82009-05-15 09:23:25 +00001233 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel9ccfb642009-12-09 18:24:21 +00001234 ModuleCU->insertDIE(SP.getNode(), SPDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001235 return SPDie;
1236}
1237
Devang Patel4c603b12010-04-01 17:16:48 +00001238/// getUpdatedDbgScope - Find DbgScope assicated with the instruction.
1239/// Update scope hierarchy. Create abstract scope if required.
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001240DbgScope *DwarfDebug::getUpdatedDbgScope(MDNode *N, const MachineInstr *MI,
Chris Lattner8d2fe282010-03-31 05:36:29 +00001241 MDNode *InlinedAt) {
1242 assert(N && "Invalid Scope encoding!");
1243 assert(MI && "Missing machine instruction!");
Devang Patel4c603b12010-04-01 17:16:48 +00001244 bool isAConcreteScope = InlinedAt != 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001245
1246 DbgScope *NScope = NULL;
1247
1248 if (InlinedAt)
1249 NScope = DbgScopeMap.lookup(InlinedAt);
1250 else
1251 NScope = DbgScopeMap.lookup(N);
Chris Lattner8d2fe282010-03-31 05:36:29 +00001252 assert(NScope && "Unable to find working scope!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001253
1254 if (NScope->getFirstInsn())
1255 return NScope;
Devang Patel75cc16c2009-10-01 20:31:14 +00001256
1257 DbgScope *Parent = NULL;
Devang Patel4c603b12010-04-01 17:16:48 +00001258 if (isAConcreteScope) {
Devang Patel6875c5eb2009-10-14 21:08:09 +00001259 DILocation IL(InlinedAt);
Jim Grosbach042483e2009-11-21 23:12:12 +00001260 Parent = getUpdatedDbgScope(IL.getScope().getNode(), MI,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001261 IL.getOrigLocation().getNode());
Chris Lattner8d2fe282010-03-31 05:36:29 +00001262 assert(Parent && "Unable to find Parent scope!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001263 NScope->setParent(Parent);
Devang Patel930143b2009-11-21 02:48:08 +00001264 Parent->addScope(NScope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001265 } else if (DIDescriptor(N).isLexicalBlock()) {
1266 DILexicalBlock DB(N);
Devang Patel3b548aa2010-03-08 20:52:55 +00001267 Parent = getUpdatedDbgScope(DB.getContext().getNode(), MI, InlinedAt);
1268 NScope->setParent(Parent);
1269 Parent->addScope(NScope);
Devang Patel6875c5eb2009-10-14 21:08:09 +00001270 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001271
Devang Patelcfeaa482009-10-27 20:47:17 +00001272 NScope->setFirstInsn(MI);
Devang Patel75cc16c2009-10-01 20:31:14 +00001273
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001274 if (!Parent && !InlinedAt) {
Devang Patel78319c62009-11-11 00:31:36 +00001275 StringRef SPName = DISubprogram(N).getLinkageName();
1276 if (SPName == MF->getFunction()->getName())
1277 CurrentFnDbgScope = NScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001278 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001279
Devang Patel4c603b12010-04-01 17:16:48 +00001280 if (isAConcreteScope) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001281 ConcreteScopes[InlinedAt] = NScope;
1282 getOrCreateAbstractScope(N);
1283 }
1284
Devang Patelcfeaa482009-10-27 20:47:17 +00001285 return NScope;
Devang Patel75cc16c2009-10-01 20:31:14 +00001286}
1287
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001288DbgScope *DwarfDebug::getOrCreateAbstractScope(MDNode *N) {
Chris Lattner8d2fe282010-03-31 05:36:29 +00001289 assert(N && "Invalid Scope encoding!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001290
1291 DbgScope *AScope = AbstractScopes.lookup(N);
1292 if (AScope)
1293 return AScope;
Jim Grosbach042483e2009-11-21 23:12:12 +00001294
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001295 DbgScope *Parent = NULL;
1296
1297 DIDescriptor Scope(N);
1298 if (Scope.isLexicalBlock()) {
1299 DILexicalBlock DB(N);
1300 DIDescriptor ParentDesc = DB.getContext();
Devang Patel3b548aa2010-03-08 20:52:55 +00001301 Parent = getOrCreateAbstractScope(ParentDesc.getNode());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001302 }
1303
1304 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1305
1306 if (Parent)
Devang Patel930143b2009-11-21 02:48:08 +00001307 Parent->addScope(AScope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001308 AScope->setAbstractScope();
1309 AbstractScopes[N] = AScope;
1310 if (DIDescriptor(N).isSubprogram())
1311 AbstractScopesList.push_back(AScope);
1312 return AScope;
1313}
Devang Patel75cc16c2009-10-01 20:31:14 +00001314
Jim Grosbach042483e2009-11-21 23:12:12 +00001315/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel930143b2009-11-21 02:48:08 +00001316/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1317/// If there are global variables in this scope then create and insert
1318/// DIEs for these variables.
1319DIE *DwarfDebug::updateSubprogramScopeDIE(MDNode *SPNode) {
Devang Patele064ad42009-11-20 21:37:22 +00001320 DIE *SPDie = ModuleCU->getDIE(SPNode);
Chris Lattner2c3f4782010-03-13 07:26:18 +00001321 assert(SPDie && "Unable to find subprogram DIE!");
Devang Patel525dda02009-12-14 16:18:45 +00001322 DISubprogram SP(SPNode);
Chris Lattner2c3f4782010-03-13 07:26:18 +00001323
Devang Pateld4be4ce2010-02-05 23:09:20 +00001324 // There is not any need to generate specification DIE for a function
1325 // defined at compile unit level. If a function is defined inside another
1326 // function then gdb prefers the definition at top level and but does not
1327 // expect specification DIE in parent function. So avoid creating
1328 // specification DIE for a function defined inside a function.
Stuart Hastings7f89a0a2010-03-31 23:08:46 +00001329 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
1330 !SP.getContext().isFile() && !SP.getContext().isSubprogram()) {
Devang Patel525dda02009-12-14 16:18:45 +00001331 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Chris Lattner2c3f4782010-03-13 07:26:18 +00001332
1333 // Add arguments.
Devang Patel525dda02009-12-14 16:18:45 +00001334 DICompositeType SPTy = SP.getType();
1335 DIArray Args = SPTy.getTypeArray();
1336 unsigned SPTag = SPTy.getTag();
1337 if (SPTag == dwarf::DW_TAG_subroutine_type)
Chris Lattner2c3f4782010-03-13 07:26:18 +00001338 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
Devang Patel525dda02009-12-14 16:18:45 +00001339 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel6efc8e52010-02-06 01:02:37 +00001340 DIType ATy = DIType(DIType(Args.getElement(i).getNode()));
1341 addType(Arg, ATy);
1342 if (ATy.isArtificial())
1343 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patel525dda02009-12-14 16:18:45 +00001344 SPDie->addChild(Arg);
1345 }
1346 DIE *SPDeclDie = SPDie;
1347 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1348 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
1349 SPDeclDie);
Devang Patel525dda02009-12-14 16:18:45 +00001350 ModuleCU->addDie(SPDie);
1351 }
Devang Patel6efc8e52010-02-06 01:02:37 +00001352
Devang Patel930143b2009-11-21 02:48:08 +00001353 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Chris Lattnerbc9210c2010-03-08 22:23:36 +00001354 getDWLabel("func_begin", SubprogramCount));
Devang Patel930143b2009-11-21 02:48:08 +00001355 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Chris Lattnerbc9210c2010-03-08 22:23:36 +00001356 getDWLabel("func_end", SubprogramCount));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001357 MachineLocation Location(RI->getFrameRegister(*MF));
Devang Patel930143b2009-11-21 02:48:08 +00001358 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Jim Grosbach042483e2009-11-21 23:12:12 +00001359
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001360 if (!DISubprogram(SPNode).isLocalToUnit())
Devang Patel930143b2009-11-21 02:48:08 +00001361 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001362
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001363 return SPDie;
1364}
1365
Jim Grosbach042483e2009-11-21 23:12:12 +00001366/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel930143b2009-11-21 02:48:08 +00001367/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1368DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Chris Lattnere13c3722010-03-09 01:58:53 +00001369 MCSymbol *Start = Scope->getStartLabel();
1370 MCSymbol *End = Scope->getEndLabel();
Devang Patel23b2ae62010-03-29 22:59:58 +00001371 if (Start == 0 || End == 0) return 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001372
Chris Lattnere13c3722010-03-09 01:58:53 +00001373 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
1374 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001375
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001376 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1377 if (Scope->isAbstractScope())
1378 return ScopeDIE;
1379
Devang Patel930143b2009-11-21 02:48:08 +00001380 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Chris Lattnere13c3722010-03-09 01:58:53 +00001381 Start ? Start : getDWLabel("func_begin", SubprogramCount));
Devang Patel930143b2009-11-21 02:48:08 +00001382 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Chris Lattnere13c3722010-03-09 01:58:53 +00001383 End ? End : getDWLabel("func_end", SubprogramCount));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001384
1385 return ScopeDIE;
1386}
1387
Devang Patel930143b2009-11-21 02:48:08 +00001388/// constructInlinedScopeDIE - This scope represents inlined body of
1389/// a function. Construct DIE to represent this concrete inlined copy
1390/// of the function.
1391DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Chris Lattnere13c3722010-03-09 01:58:53 +00001392 MCSymbol *StartLabel = Scope->getStartLabel();
1393 MCSymbol *EndLabel = Scope->getEndLabel();
Devang Patel23b2ae62010-03-29 22:59:58 +00001394 if (StartLabel == 0 || EndLabel == 0) return 0;
Chris Lattner54a68762010-03-09 04:48:35 +00001395
Chris Lattnere13c3722010-03-09 01:58:53 +00001396 assert(StartLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001397 "Invalid starting label for an inlined scope!");
Chris Lattnere13c3722010-03-09 01:58:53 +00001398 assert(EndLabel->isDefined() &&
Chris Lattnerc3b70f62010-03-09 01:51:43 +00001399 "Invalid end label for an inlined scope!");
Devang Patel3b548aa2010-03-08 20:52:55 +00001400 if (!Scope->getScopeNode())
Devang Patelbc97f6b2010-03-08 19:20:38 +00001401 return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001402 DIScope DS(Scope->getScopeNode());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001403 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1404
1405 DISubprogram InlinedSP = getDISubprogram(DS.getNode());
Devang Patele064ad42009-11-20 21:37:22 +00001406 DIE *OriginDIE = ModuleCU->getDIE(InlinedSP.getNode());
Chris Lattner8d2fe282010-03-31 05:36:29 +00001407 assert(OriginDIE && "Unable to find Origin DIE!");
Devang Patel930143b2009-11-21 02:48:08 +00001408 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001409 dwarf::DW_FORM_ref4, OriginDIE);
1410
Chris Lattner085b6522010-03-09 00:31:02 +00001411 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, StartLabel);
Chris Lattnere13c3722010-03-09 01:58:53 +00001412 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, EndLabel);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001413
1414 InlinedSubprogramDIEs.insert(OriginDIE);
1415
1416 // Track the start label for this inlined function.
Devang Patel018b29b2010-01-19 06:19:05 +00001417 DenseMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001418 I = InlineInfo.find(InlinedSP.getNode());
1419
1420 if (I == InlineInfo.end()) {
Chris Lattner085b6522010-03-09 00:31:02 +00001421 InlineInfo[InlinedSP.getNode()].push_back(std::make_pair(StartLabel,
Jim Grosbach00e9c612009-11-22 19:20:36 +00001422 ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001423 InlinedSPNodes.push_back(InlinedSP.getNode());
1424 } else
Chris Lattner085b6522010-03-09 00:31:02 +00001425 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001426
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001427 DILocation DL(Scope->getInlinedAt());
Devang Patel930143b2009-11-21 02:48:08 +00001428 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, ModuleCU->getID());
1429 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001430
1431 return ScopeDIE;
1432}
1433
Devang Patel930143b2009-11-21 02:48:08 +00001434
1435/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel9ccfb642009-12-09 18:24:21 +00001436DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001437 // Get the descriptor.
1438 const DIVariable &VD = DV->getVariable();
Devang Patel2d9caf92009-11-25 17:36:49 +00001439 StringRef Name = VD.getName();
1440 if (Name.empty())
Devang Patel97f99fa2009-11-13 02:25:26 +00001441 return NULL;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001442
1443 // Translate tag to proper Dwarf tag. The result variable is dropped for
1444 // now.
1445 unsigned Tag;
1446 switch (VD.getTag()) {
1447 case dwarf::DW_TAG_return_variable:
1448 return NULL;
1449 case dwarf::DW_TAG_arg_variable:
1450 Tag = dwarf::DW_TAG_formal_parameter;
1451 break;
1452 case dwarf::DW_TAG_auto_variable: // fall thru
1453 default:
1454 Tag = dwarf::DW_TAG_variable;
1455 break;
1456 }
1457
1458 // Define variable debug information entry.
1459 DIE *VariableDie = new DIE(Tag);
1460
1461
1462 DIE *AbsDIE = NULL;
1463 if (DbgVariable *AV = DV->getAbstractVariable())
1464 AbsDIE = AV->getDIE();
Jim Grosbach042483e2009-11-21 23:12:12 +00001465
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001466 if (AbsDIE) {
1467 DIScope DS(Scope->getScopeNode());
1468 DISubprogram InlinedSP = getDISubprogram(DS.getNode());
Devang Patele064ad42009-11-20 21:37:22 +00001469 DIE *OriginSPDIE = ModuleCU->getDIE(InlinedSP.getNode());
Daniel Dunbar75b4d352009-11-11 03:09:50 +00001470 (void) OriginSPDIE;
Chris Lattner8d2fe282010-03-31 05:36:29 +00001471 assert(OriginSPDIE && "Unable to find Origin DIE for the SP!");
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001472 DIE *AbsDIE = DV->getAbstractVariable()->getDIE();
Chris Lattner8d2fe282010-03-31 05:36:29 +00001473 assert(AbsDIE && "Unable to find Origin DIE for the Variable!");
Devang Patel930143b2009-11-21 02:48:08 +00001474 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001475 dwarf::DW_FORM_ref4, AbsDIE);
1476 }
1477 else {
Devang Patel930143b2009-11-21 02:48:08 +00001478 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
1479 addSourceLine(VariableDie, &VD);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001480
1481 // Add variable type.
Jim Grosbach042483e2009-11-21 23:12:12 +00001482 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001483 // addresses instead.
1484 if (VD.isBlockByrefVariable())
Devang Patel9ccfb642009-12-09 18:24:21 +00001485 addType(VariableDie, getBlockByrefType(VD.getType(), Name));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001486 else
Devang Patel9ccfb642009-12-09 18:24:21 +00001487 addType(VariableDie, VD.getType());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001488 }
1489
1490 // Add variable address.
1491 if (!Scope->isAbstractScope()) {
Devang Patela3e9c9c2010-03-15 18:33:46 +00001492 // Check if variable is described by DBG_VALUE instruction.
1493 if (const MachineInstr *DbgValueInsn = DV->getDbgValue()) {
1494 if (DbgValueInsn->getNumOperands() == 3) {
1495 // FIXME : Handle getNumOperands != 3
1496 if (DbgValueInsn->getOperand(0).getType()
1497 == MachineOperand::MO_Register
1498 && DbgValueInsn->getOperand(0).getReg()) {
1499 MachineLocation Location;
1500 Location.set(DbgValueInsn->getOperand(0).getReg());
1501 addAddress(VariableDie, dwarf::DW_AT_location, Location);
Devang Patel23b2ae62010-03-29 22:59:58 +00001502 if (MCSymbol *VS = DV->getDbgValueLabel())
1503 addLabel(VariableDie, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr,
1504 VS);
Devang Patela3e9c9c2010-03-15 18:33:46 +00001505 } else if (DbgValueInsn->getOperand(0).getType() ==
1506 MachineOperand::MO_Immediate) {
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001507 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patela3e9c9c2010-03-15 18:33:46 +00001508 unsigned Imm = DbgValueInsn->getOperand(0).getImm();
1509 addUInt(Block, 0, dwarf::DW_FORM_udata, Imm);
1510 addBlock(VariableDie, dwarf::DW_AT_const_value, 0, Block);
Devang Patel23b2ae62010-03-29 22:59:58 +00001511 if (MCSymbol *VS = DV->getDbgValueLabel())
1512 addLabel(VariableDie, dwarf::DW_AT_start_scope, dwarf::DW_FORM_addr,
1513 VS);
Devang Patela3e9c9c2010-03-15 18:33:46 +00001514 } else {
1515 //FIXME : Handle other operand types.
1516 delete VariableDie;
1517 return NULL;
1518 }
1519 }
1520 } else {
1521 MachineLocation Location;
1522 unsigned FrameReg;
Chris Lattner71696ef2010-03-31 06:06:37 +00001523 int Offset = RI->getFrameIndexReference(*MF, DV->getFrameIndex(),
1524 FrameReg);
Devang Patela3e9c9c2010-03-15 18:33:46 +00001525 Location.set(FrameReg, Offset);
1526
1527 if (VD.hasComplexAddress())
1528 addComplexAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
1529 else if (VD.isBlockByrefVariable())
1530 addBlockByrefAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
1531 else
1532 addAddress(VariableDie, dwarf::DW_AT_location, Location);
1533 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001534 }
Devang Patel6efc8e52010-02-06 01:02:37 +00001535
1536 if (Tag == dwarf::DW_TAG_formal_parameter && VD.getType().isArtificial())
1537 addUInt(VariableDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001538 DV->setDIE(VariableDie);
1539 return VariableDie;
1540
1541}
Devang Patel930143b2009-11-21 02:48:08 +00001542
Devang Patel04d2f2d2009-11-24 01:14:22 +00001543void DwarfDebug::addPubTypes(DISubprogram SP) {
1544 DICompositeType SPTy = SP.getType();
1545 unsigned SPTag = SPTy.getTag();
1546 if (SPTag != dwarf::DW_TAG_subroutine_type)
1547 return;
1548
1549 DIArray Args = SPTy.getTypeArray();
Devang Patel04d2f2d2009-11-24 01:14:22 +00001550 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
1551 DIType ATy(Args.getElement(i).getNode());
Devang Patel3b548aa2010-03-08 20:52:55 +00001552 if (!ATy.isValid())
Devang Patel04d2f2d2009-11-24 01:14:22 +00001553 continue;
1554 DICompositeType CATy = getDICompositeType(ATy);
Devang Patel3b548aa2010-03-08 20:52:55 +00001555 if (DIDescriptor(CATy.getNode()).Verify() && !CATy.getName().empty()) {
Devang Patel04d2f2d2009-11-24 01:14:22 +00001556 if (DIEEntry *Entry = ModuleCU->getDIEEntry(CATy.getNode()))
1557 ModuleCU->addGlobalType(CATy.getName(), Entry->getEntry());
1558 }
1559 }
1560}
1561
Devang Patel930143b2009-11-21 02:48:08 +00001562/// constructScopeDIE - Construct a DIE for this scope.
1563DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel3b548aa2010-03-08 20:52:55 +00001564 if (!Scope || !Scope->getScopeNode())
1565 return NULL;
1566
1567 DIScope DS(Scope->getScopeNode());
1568 DIE *ScopeDIE = NULL;
1569 if (Scope->getInlinedAt())
1570 ScopeDIE = constructInlinedScopeDIE(Scope);
1571 else if (DS.isSubprogram()) {
1572 if (Scope->isAbstractScope())
1573 ScopeDIE = ModuleCU->getDIE(DS.getNode());
1574 else
1575 ScopeDIE = updateSubprogramScopeDIE(DS.getNode());
1576 }
Devang Patel23b2ae62010-03-29 22:59:58 +00001577 else
Devang Patel3b548aa2010-03-08 20:52:55 +00001578 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel23b2ae62010-03-29 22:59:58 +00001579 if (!ScopeDIE) return NULL;
Devang Patel3b548aa2010-03-08 20:52:55 +00001580
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001581 // Add variables to scope.
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001582 const SmallVector<DbgVariable *, 8> &Variables = Scope->getVariables();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001583 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel9ccfb642009-12-09 18:24:21 +00001584 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach042483e2009-11-21 23:12:12 +00001585 if (VariableDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001586 ScopeDIE->addChild(VariableDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001587 }
1588
1589 // Add nested scopes.
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001590 const SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001591 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1592 // Define the Scope debug information entry.
Devang Patel930143b2009-11-21 02:48:08 +00001593 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach042483e2009-11-21 23:12:12 +00001594 if (NestedDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001595 ScopeDIE->addChild(NestedDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001596 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001597
1598 if (DS.isSubprogram())
1599 addPubTypes(DISubprogram(DS.getNode()));
1600
1601 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001602}
1603
Bill Wendling2b128d72009-05-20 23:19:06 +00001604/// GetOrCreateSourceID - Look up the source id with the given directory and
1605/// source file names. If none currently exists, create a new id and insert it
1606/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1607/// maps as well.
Chris Lattner71696ef2010-03-31 06:06:37 +00001608unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName){
Bill Wendling2b128d72009-05-20 23:19:06 +00001609 unsigned DId;
1610 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1611 if (DI != DirectoryIdMap.end()) {
1612 DId = DI->getValue();
1613 } else {
1614 DId = DirectoryNames.size() + 1;
1615 DirectoryIdMap[DirName] = DId;
1616 DirectoryNames.push_back(DirName);
1617 }
1618
1619 unsigned FId;
1620 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1621 if (FI != SourceFileIdMap.end()) {
1622 FId = FI->getValue();
1623 } else {
1624 FId = SourceFileNames.size() + 1;
1625 SourceFileIdMap[FileName] = FId;
1626 SourceFileNames.push_back(FileName);
1627 }
1628
1629 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1630 SourceIdMap.find(std::make_pair(DId, FId));
1631 if (SI != SourceIdMap.end())
1632 return SI->second;
1633
1634 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1635 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1636 SourceIds.push_back(std::make_pair(DId, FId));
1637
1638 return SrcId;
1639}
1640
Devang Patel1f4690c2009-12-15 19:16:48 +00001641/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1642DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
1643 DIE *NDie = ModuleCU->getDIE(NS.getNode());
1644 if (NDie)
1645 return NDie;
1646 NDie = new DIE(dwarf::DW_TAG_namespace);
1647 ModuleCU->insertDIE(NS.getNode(), NDie);
1648 if (!NS.getName().empty())
1649 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
1650 addSourceLine(NDie, &NS);
1651 addToContextOwner(NDie, NS.getContext());
1652 return NDie;
1653}
1654
Jeffrey Yasskin0708de12010-03-11 18:29:55 +00001655void DwarfDebug::constructCompileUnit(MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001656 DICompileUnit DIUnit(N);
Jeffrey Yasskin0708de12010-03-11 18:29:55 +00001657 // Use first compile unit marked as isMain as the compile unit for this
1658 // module.
1659 if (ModuleCU || !DIUnit.isMain())
1660 return;
Devang Patel2d9caf92009-11-25 17:36:49 +00001661 StringRef FN = DIUnit.getFilename();
1662 StringRef Dir = DIUnit.getDirectory();
Devang Patelb2969422009-09-29 18:40:58 +00001663 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendling2b128d72009-05-20 23:19:06 +00001664
1665 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel930143b2009-11-21 02:48:08 +00001666 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patelb2969422009-09-29 18:40:58 +00001667 DIUnit.getProducer());
Devang Patel930143b2009-11-21 02:48:08 +00001668 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendling2b128d72009-05-20 23:19:06 +00001669 DIUnit.getLanguage());
Devang Patel930143b2009-11-21 02:48:08 +00001670 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Devang Pateld22ed622010-03-22 23:11:36 +00001671 addLabel(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1672 getTempLabel("text_begin"));
1673 addLabel(Die, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1674 getTempLabel("text_end"));
1675 // DW_AT_stmt_list is a offset of line number information for this
1676 // compile unit in debug_line section. It is always zero when only one
1677 // compile unit is emitted in one object file.
1678 addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Bill Wendling2b128d72009-05-20 23:19:06 +00001679
Devang Patel2d9caf92009-11-25 17:36:49 +00001680 if (!Dir.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001681 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +00001682 if (DIUnit.isOptimized())
Devang Patel930143b2009-11-21 02:48:08 +00001683 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendling2b128d72009-05-20 23:19:06 +00001684
Devang Patel2d9caf92009-11-25 17:36:49 +00001685 StringRef Flags = DIUnit.getFlags();
1686 if (!Flags.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001687 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendling2b128d72009-05-20 23:19:06 +00001688
1689 unsigned RVer = DIUnit.getRunTimeVersion();
1690 if (RVer)
Devang Patel930143b2009-11-21 02:48:08 +00001691 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +00001692 dwarf::DW_FORM_data1, RVer);
1693
Jeffrey Yasskin0708de12010-03-11 18:29:55 +00001694 assert(!ModuleCU &&
1695 "ModuleCU assigned since the top of constructCompileUnit");
1696 ModuleCU = new CompileUnit(ID, Die);
Bill Wendling2b128d72009-05-20 23:19:06 +00001697}
1698
Devang Patel930143b2009-11-21 02:48:08 +00001699void DwarfDebug::constructGlobalVariableDIE(MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001700 DIGlobalVariable DI_GV(N);
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001701
Devang Patelf5d53602009-09-04 23:59:07 +00001702 // If debug information is malformed then ignore it.
1703 if (DI_GV.Verify() == false)
1704 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001705
1706 // Check for pre-existence.
Devang Patele064ad42009-11-20 21:37:22 +00001707 if (ModuleCU->getDIE(DI_GV.getNode()))
Devang Patel0751a282009-06-26 01:49:18 +00001708 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001709
Devang Patel9ccfb642009-12-09 18:24:21 +00001710 DIE *VariableDie = createGlobalVariableDIE(DI_GV);
Devang Patel2eec32d2009-12-10 23:25:41 +00001711 if (!VariableDie)
1712 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001713
Bill Wendling2b128d72009-05-20 23:19:06 +00001714 // Add to map.
Devang Patele064ad42009-11-20 21:37:22 +00001715 ModuleCU->insertDIE(N, VariableDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00001716
1717 // Add to context owner.
Devang Patel89880c82010-01-15 01:12:22 +00001718 DIDescriptor GVContext = DI_GV.getContext();
1719 // Do not create specification DIE if context is either compile unit
1720 // or a subprogram.
Chris Lattner71696ef2010-03-31 06:06:37 +00001721 if (DI_GV.isDefinition() && !GVContext.isCompileUnit() &&
1722 !GVContext.isFile() && !GVContext.isSubprogram()) {
Devang Patel1f4690c2009-12-15 19:16:48 +00001723 // Create specification DIE.
1724 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1725 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1726 dwarf::DW_FORM_ref4, VariableDie);
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001727 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel1f4690c2009-12-15 19:16:48 +00001728 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
Chris Lattner8dcf41e2010-03-08 22:31:46 +00001729 addLabel(Block, 0, dwarf::DW_FORM_udata,
Chris Lattner9e4cafe2010-03-12 21:09:07 +00001730 Asm->Mang->getSymbol(DI_GV.getGlobal()));
Devang Patel1f4690c2009-12-15 19:16:48 +00001731 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
Devang Patelce25dd72010-02-09 01:58:33 +00001732 addUInt(VariableDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Devang Patel1f4690c2009-12-15 19:16:48 +00001733 ModuleCU->addDie(VariableSpecDIE);
1734 } else {
Benjamin Kramer74729ae2010-03-31 19:34:01 +00001735 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
Devang Patel1f4690c2009-12-15 19:16:48 +00001736 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
Chris Lattner8dcf41e2010-03-08 22:31:46 +00001737 addLabel(Block, 0, dwarf::DW_FORM_udata,
Chris Lattner9e4cafe2010-03-12 21:09:07 +00001738 Asm->Mang->getSymbol(DI_GV.getGlobal()));
Devang Patel1f4690c2009-12-15 19:16:48 +00001739 addBlock(VariableDie, dwarf::DW_AT_location, 0, Block);
1740 }
Devang Patel89880c82010-01-15 01:12:22 +00001741 addToContextOwner(VariableDie, GVContext);
Devang Patel2b75ed22009-12-10 19:14:49 +00001742
Bill Wendling2b128d72009-05-20 23:19:06 +00001743 // Expose as global. FIXME - need to check external flag.
Devang Patel930143b2009-11-21 02:48:08 +00001744 ModuleCU->addGlobal(DI_GV.getName(), VariableDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00001745
1746 DIType GTy = DI_GV.getType();
Devang Patel2d9caf92009-11-25 17:36:49 +00001747 if (GTy.isCompositeType() && !GTy.getName().empty()) {
Devang Patel04d2f2d2009-11-24 01:14:22 +00001748 DIEEntry *Entry = ModuleCU->getDIEEntry(GTy.getNode());
Chris Lattner8d2fe282010-03-31 05:36:29 +00001749 assert(Entry && "Missing global type!");
Devang Patel04d2f2d2009-11-24 01:14:22 +00001750 ModuleCU->addGlobalType(GTy.getName(), Entry->getEntry());
1751 }
Devang Patel0751a282009-06-26 01:49:18 +00001752 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001753}
1754
Devang Patel930143b2009-11-21 02:48:08 +00001755void DwarfDebug::constructSubprogramDIE(MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001756 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +00001757
Stuart Hastings7f89a0a2010-03-31 23:08:46 +00001758 // Check for pre-existence.
1759 if (ModuleCU->getDIE(N))
1760 return;
1761
Bill Wendling2b128d72009-05-20 23:19:06 +00001762 if (!SP.isDefinition())
1763 // This is a method declaration which will be handled while constructing
1764 // class type.
Devang Patel0751a282009-06-26 01:49:18 +00001765 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001766
Stuart Hastings7f89a0a2010-03-31 23:08:46 +00001767 DIE *SubprogramDie = createSubprogramDIE(SP);
1768
1769 // Add to map.
1770 ModuleCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00001771
1772 // Add to context owner.
Devang Patel1f4690c2009-12-15 19:16:48 +00001773 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +00001774
Bill Wendling2b128d72009-05-20 23:19:06 +00001775 // Expose as global.
Devang Patel930143b2009-11-21 02:48:08 +00001776 ModuleCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00001777
Devang Patel0751a282009-06-26 01:49:18 +00001778 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001779}
1780
Devang Patel930143b2009-11-21 02:48:08 +00001781/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbarbe22ec42009-09-19 20:40:14 +00001782/// content. Create global DIEs and emit initial debug info sections.
1783/// This is inovked by the target AsmPrinter.
Chris Lattner11980022010-04-04 07:48:20 +00001784void DwarfDebug::beginModule(Module *M) {
Devang Patel0c044ec2009-06-25 22:36:02 +00001785 this->M = M;
1786
Devang Pateld41f1192009-11-11 19:55:08 +00001787 if (!MAI->doesSupportDebugInformation())
1788 return;
1789
Chris Lattner47879752010-03-29 20:38:20 +00001790 TimeRegion Timer(DebugTimer);
1791
Devang Patel63524442009-07-30 18:56:46 +00001792 DebugInfoFinder DbgFinder;
1793 DbgFinder.processModule(*M);
Devang Patel0751a282009-06-26 01:49:18 +00001794
Bill Wendling2b128d72009-05-20 23:19:06 +00001795 // Create all the compile unit DIEs.
Devang Patel63524442009-07-30 18:56:46 +00001796 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1797 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00001798 constructCompileUnit(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00001799
Devang Patel40d78412009-06-29 20:45:18 +00001800 if (!ModuleCU)
Devang Patel8119fe872010-03-08 22:02:50 +00001801 return;
Devang Patel86353452009-06-29 20:38:13 +00001802
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001803 // Create DIEs for each subprogram.
Devang Patel63524442009-07-30 18:56:46 +00001804 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
1805 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00001806 constructSubprogramDIE(*I);
Devang Patel0751a282009-06-26 01:49:18 +00001807
Devang Patel2b75ed22009-12-10 19:14:49 +00001808 // Create DIEs for each global variable.
1809 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
1810 E = DbgFinder.global_variable_end(); I != E; ++I)
1811 constructGlobalVariableDIE(*I);
1812
Chris Lattner11980022010-04-04 07:48:20 +00001813 MMI = Asm->MMI;
Bill Wendling2b128d72009-05-20 23:19:06 +00001814 shouldEmit = true;
1815 MMI->setDebugInfoAvailability(true);
1816
1817 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +00001818 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +00001819
1820 // Print out .file directives to specify files for .loc directives. These are
1821 // printed out early so that they precede any .loc directives.
Chris Lattnere9a75a62009-08-22 21:43:10 +00001822 if (MAI->hasDotLocAndDotFile()) {
Bill Wendling2b128d72009-05-20 23:19:06 +00001823 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
1824 // Remember source id starts at 1.
1825 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00001826 // FIXME: don't use sys::path for this! This should not depend on the
1827 // host.
Bill Wendling2b128d72009-05-20 23:19:06 +00001828 sys::Path FullPath(getSourceDirectoryName(Id.first));
1829 bool AppendOk =
1830 FullPath.appendComponent(getSourceFileName(Id.second));
1831 assert(AppendOk && "Could not append filename to directory!");
1832 AppendOk = false;
Chris Lattner601ef332010-01-25 18:58:59 +00001833 Asm->OutStreamer.EmitDwarfFileDirective(i, FullPath.str());
Bill Wendling2b128d72009-05-20 23:19:06 +00001834 }
1835 }
1836
1837 // Emit initial sections
Devang Patel930143b2009-11-21 02:48:08 +00001838 emitInitial();
Bill Wendling2b128d72009-05-20 23:19:06 +00001839}
1840
Devang Patel930143b2009-11-21 02:48:08 +00001841/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendling2b128d72009-05-20 23:19:06 +00001842///
Devang Patel930143b2009-11-21 02:48:08 +00001843void DwarfDebug::endModule() {
Devang Pateld859d862009-10-06 00:03:14 +00001844 if (!ModuleCU)
Bill Wendling2b128d72009-05-20 23:19:06 +00001845 return;
1846
Chris Lattner47879752010-03-29 20:38:20 +00001847 TimeRegion Timer(DebugTimer);
Bill Wendling2b128d72009-05-20 23:19:06 +00001848
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001849 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1850 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
1851 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
1852 DIE *ISP = *AI;
Devang Patel930143b2009-11-21 02:48:08 +00001853 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001854 }
1855
Devang Patel236526d2009-12-03 01:25:38 +00001856 // Insert top level DIEs.
1857 for (SmallVector<DIE *, 4>::iterator TI = TopLevelDIEsVector.begin(),
1858 TE = TopLevelDIEsVector.end(); TI != TE; ++TI)
1859 ModuleCU->getCUDie()->addChild(*TI);
1860
Devang Patel018b29b2010-01-19 06:19:05 +00001861 for (DenseMap<DIE *, MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Pateleb57c592009-12-03 19:11:07 +00001862 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
1863 DIE *SPDie = CI->first;
1864 MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
1865 if (!N) continue;
1866 DIE *NDie = ModuleCU->getDIE(N);
1867 if (!NDie) continue;
1868 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patel2108ee02010-01-15 00:26:31 +00001869 // FIXME - This is not the correct approach.
Chris Lattner71696ef2010-03-31 06:06:37 +00001870 //addDIEEntry(NDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie
Devang Pateleb57c592009-12-03 19:11:07 +00001871 }
1872
Bill Wendling2b128d72009-05-20 23:19:06 +00001873 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001874 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattner722714d2010-03-08 22:44:40 +00001875 Asm->OutStreamer.EmitLabel(getTempLabel("text_end"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001876 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattner722714d2010-03-08 22:44:40 +00001877 Asm->OutStreamer.EmitLabel(getTempLabel("data_end"));
Bill Wendling2b128d72009-05-20 23:19:06 +00001878
1879 // End text sections.
1880 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001881 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Chris Lattner722714d2010-03-08 22:44:40 +00001882 Asm->OutStreamer.EmitLabel(getDWLabel("section_end", i));
Bill Wendling2b128d72009-05-20 23:19:06 +00001883 }
1884
1885 // Emit common frame information.
Devang Patel930143b2009-11-21 02:48:08 +00001886 emitCommonDebugFrame();
Bill Wendling2b128d72009-05-20 23:19:06 +00001887
1888 // Emit function debug frame information
1889 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
1890 E = DebugFrames.end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00001891 emitFunctionDebugFrame(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00001892
1893 // Compute DIE offsets and sizes.
Devang Patel930143b2009-11-21 02:48:08 +00001894 computeSizeAndOffsets();
Bill Wendling2b128d72009-05-20 23:19:06 +00001895
1896 // Emit all the DIEs into a debug info section
Devang Patel930143b2009-11-21 02:48:08 +00001897 emitDebugInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001898
1899 // Corresponding abbreviations into a abbrev section.
Devang Patel930143b2009-11-21 02:48:08 +00001900 emitAbbreviations();
Bill Wendling2b128d72009-05-20 23:19:06 +00001901
1902 // Emit source line correspondence into a debug line section.
Devang Patel930143b2009-11-21 02:48:08 +00001903 emitDebugLines();
Bill Wendling2b128d72009-05-20 23:19:06 +00001904
1905 // Emit info into a debug pubnames section.
Devang Patel930143b2009-11-21 02:48:08 +00001906 emitDebugPubNames();
Bill Wendling2b128d72009-05-20 23:19:06 +00001907
Devang Patel04d2f2d2009-11-24 01:14:22 +00001908 // Emit info into a debug pubtypes section.
1909 emitDebugPubTypes();
1910
Bill Wendling2b128d72009-05-20 23:19:06 +00001911 // Emit info into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00001912 emitDebugLoc();
Bill Wendling2b128d72009-05-20 23:19:06 +00001913
1914 // Emit info into a debug aranges section.
1915 EmitDebugARanges();
1916
1917 // Emit info into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00001918 emitDebugRanges();
Bill Wendling2b128d72009-05-20 23:19:06 +00001919
1920 // Emit info into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00001921 emitDebugMacInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001922
1923 // Emit inline info.
Devang Patel930143b2009-11-21 02:48:08 +00001924 emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001925
Chris Lattnerb7aa9522010-03-13 02:17:42 +00001926 // Emit info into a debug str section.
1927 emitDebugStr();
1928
Jeffrey Yasskin0708de12010-03-11 18:29:55 +00001929 delete ModuleCU;
1930 ModuleCU = NULL; // Reset for the next Module, if any.
Bill Wendling2b128d72009-05-20 23:19:06 +00001931}
1932
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001933/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbach00e9c612009-11-22 19:20:36 +00001934DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
1935 unsigned FrameIdx,
Chris Lattner915c5f92010-04-02 19:42:39 +00001936 DebugLoc ScopeLoc) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001937
1938 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var.getNode());
1939 if (AbsDbgVariable)
1940 return AbsDbgVariable;
1941
Chris Lattner915c5f92010-04-02 19:42:39 +00001942 LLVMContext &Ctx = Var.getNode()->getContext();
1943 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001944 if (!Scope)
1945 return NULL;
1946
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00001947 AbsDbgVariable = new DbgVariable(Var, FrameIdx,
1948 NULL /* No more-abstract variable*/);
Devang Patel930143b2009-11-21 02:48:08 +00001949 Scope->addVariable(AbsDbgVariable);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001950 AbstractVariables[Var.getNode()] = AbsDbgVariable;
1951 return AbsDbgVariable;
1952}
1953
Devang Patela3e9c9c2010-03-15 18:33:46 +00001954/// findAbstractVariable - Find abstract variable, if any, associated with Var.
1955/// FIXME : Refactor findAbstractVariable.
1956DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
1957 const MachineInstr *MI,
Chris Lattner915c5f92010-04-02 19:42:39 +00001958 DebugLoc ScopeLoc) {
Devang Patela3e9c9c2010-03-15 18:33:46 +00001959
1960 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var.getNode());
1961 if (AbsDbgVariable)
1962 return AbsDbgVariable;
1963
Chris Lattner915c5f92010-04-02 19:42:39 +00001964 LLVMContext &Ctx = Var.getNode()->getContext();
1965 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope(Ctx));
Devang Patela3e9c9c2010-03-15 18:33:46 +00001966 if (!Scope)
1967 return NULL;
1968
Devang Patel23b2ae62010-03-29 22:59:58 +00001969 AbsDbgVariable = new DbgVariable(Var, MI,
Devang Patela3e9c9c2010-03-15 18:33:46 +00001970 NULL /* No more-abstract variable*/);
1971 Scope->addVariable(AbsDbgVariable);
1972 AbstractVariables[Var.getNode()] = AbsDbgVariable;
Devang Patel23b2ae62010-03-29 22:59:58 +00001973 DbgValueStartMap[MI] = AbsDbgVariable;
Devang Patela3e9c9c2010-03-15 18:33:46 +00001974 return AbsDbgVariable;
1975}
1976
Devang Patel930143b2009-11-21 02:48:08 +00001977/// collectVariableInfo - Populate DbgScope entries with variables' info.
1978void DwarfDebug::collectVariableInfo() {
Devang Pateldf45c7f2009-10-09 22:42:28 +00001979 if (!MMI) return;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001980
Chris Lattner915c5f92010-04-02 19:42:39 +00001981 const LLVMContext &Ctx = MF->getFunction()->getContext();
1982
Devang Patel475d32a2009-10-06 01:26:37 +00001983 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1984 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1985 VE = VMap.end(); VI != VE; ++VI) {
Devang Patelac277eb2010-01-22 22:52:10 +00001986 MDNode *Var = VI->first;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001987 if (!Var) continue;
Chris Lattner915c5f92010-04-02 19:42:39 +00001988 DIVariable DV(Var);
1989 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001990
Chris Lattner915c5f92010-04-02 19:42:39 +00001991 DbgScope *Scope = 0;
1992 if (MDNode *IA = VP.second.getInlinedAt(Ctx))
1993 Scope = ConcreteScopes.lookup(IA);
1994 if (Scope == 0)
1995 Scope = DbgScopeMap.lookup(VP.second.getScope(Ctx));
1996
Devang Patelcdb7d442009-11-10 23:20:04 +00001997 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00001998 if (Scope == 0)
Devang Patelcdb7d442009-11-10 23:20:04 +00001999 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002000
Chris Lattner915c5f92010-04-02 19:42:39 +00002001 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.first, VP.second);
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002002 DbgVariable *RegVar = new DbgVariable(DV, VP.first, AbsDbgVariable);
Devang Patel930143b2009-11-21 02:48:08 +00002003 Scope->addVariable(RegVar);
Devang Patel475d32a2009-10-06 01:26:37 +00002004 }
Devang Patela3e9c9c2010-03-15 18:33:46 +00002005
2006 // Collect variable information from DBG_VALUE machine instructions;
2007 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2008 I != E; ++I) {
2009 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2010 II != IE; ++II) {
2011 const MachineInstr *MInsn = II;
Chris Lattner848c7d22010-03-31 05:39:57 +00002012 if (!MInsn->isDebugValue())
Devang Patela3e9c9c2010-03-15 18:33:46 +00002013 continue;
Devang Patel23b2ae62010-03-29 22:59:58 +00002014
Devang Patela3e9c9c2010-03-15 18:33:46 +00002015 // FIXME : Lift this restriction.
2016 if (MInsn->getNumOperands() != 3)
2017 continue;
Chris Lattner009de332010-03-31 03:34:40 +00002018 DIVariable DV((MDNode*)(MInsn->getOperand(MInsn->getNumOperands()
2019 - 1).getMetadata()));
Devang Patela3e9c9c2010-03-15 18:33:46 +00002020 if (DV.getTag() == dwarf::DW_TAG_arg_variable) {
2021 // FIXME Handle inlined subroutine arguments.
2022 DbgVariable *ArgVar = new DbgVariable(DV, MInsn, NULL);
2023 CurrentFnDbgScope->addVariable(ArgVar);
Devang Patel23b2ae62010-03-29 22:59:58 +00002024 DbgValueStartMap[MInsn] = ArgVar;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002025 continue;
2026 }
2027
2028 DebugLoc DL = MInsn->getDebugLoc();
2029 if (DL.isUnknown()) continue;
Chris Lattner915c5f92010-04-02 19:42:39 +00002030 DbgScope *Scope = 0;
2031 if (MDNode *IA = DL.getInlinedAt(Ctx))
2032 Scope = ConcreteScopes.lookup(IA);
2033 if (Scope == 0)
2034 Scope = DbgScopeMap.lookup(DL.getScope(Ctx));
2035
Devang Patela3e9c9c2010-03-15 18:33:46 +00002036 // If variable scope is not found then skip this variable.
Chris Lattner915c5f92010-04-02 19:42:39 +00002037 if (Scope == 0)
Devang Patela3e9c9c2010-03-15 18:33:46 +00002038 continue;
2039
Chris Lattner915c5f92010-04-02 19:42:39 +00002040 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, MInsn, DL);
Devang Patela3e9c9c2010-03-15 18:33:46 +00002041 DbgVariable *RegVar = new DbgVariable(DV, MInsn, AbsDbgVariable);
Devang Patel23b2ae62010-03-29 22:59:58 +00002042 DbgValueStartMap[MInsn] = RegVar;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002043 Scope->addVariable(RegVar);
2044 }
2045 }
Devang Patel475d32a2009-10-06 01:26:37 +00002046}
2047
Devang Patelbd477be2010-03-29 17:20:31 +00002048/// beginScope - Process beginning of a scope.
2049void DwarfDebug::beginScope(const MachineInstr *MI) {
Devang Patelbd477be2010-03-29 17:20:31 +00002050 // Check location.
2051 DebugLoc DL = MI->getDebugLoc();
2052 if (DL.isUnknown())
2053 return;
Devang Patelbd477be2010-03-29 17:20:31 +00002054
2055 // Check and update last known location info.
Chris Lattner915c5f92010-04-02 19:42:39 +00002056 if (DL == PrevInstLoc)
2057 return;
2058
2059 MDNode *Scope = DL.getScope(MF->getFunction()->getContext());
2060
2061 // FIXME: Should only verify each scope once!
2062 if (!DIScope(Scope).Verify())
Devang Patelbd477be2010-03-29 17:20:31 +00002063 return;
Devang Patelbd477be2010-03-29 17:20:31 +00002064
Devang Patel23b2ae62010-03-29 22:59:58 +00002065 // DBG_VALUE instruction establishes new value.
Chris Lattner848c7d22010-03-31 05:39:57 +00002066 if (MI->isDebugValue()) {
Devang Patel23b2ae62010-03-29 22:59:58 +00002067 DenseMap<const MachineInstr *, DbgVariable *>::iterator DI
2068 = DbgValueStartMap.find(MI);
2069 if (DI != DbgValueStartMap.end()) {
Chris Lattner915c5f92010-04-02 19:42:39 +00002070 MCSymbol *Label = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
2071 PrevInstLoc = DL;
Devang Patel23b2ae62010-03-29 22:59:58 +00002072 DI->second->setDbgValueLabel(Label);
2073 }
Devang Patel67d94ab2010-03-30 18:07:00 +00002074 return;
Devang Patel23b2ae62010-03-29 22:59:58 +00002075 }
2076
Devang Patelbd477be2010-03-29 17:20:31 +00002077 // Emit a label to indicate location change. This is used for line
2078 // table even if this instruction does start a new scope.
Chris Lattner915c5f92010-04-02 19:42:39 +00002079 MCSymbol *Label = recordSourceLine(DL.getLine(), DL.getCol(), Scope);
2080 PrevInstLoc = DL;
Devang Patelbd477be2010-03-29 17:20:31 +00002081
2082 // update DbgScope if this instruction starts a new scope.
Devang Patel8db360d2009-10-06 01:50:42 +00002083 InsnToDbgScopeMapTy::iterator I = DbgScopeBeginMap.find(MI);
2084 if (I == DbgScopeBeginMap.end())
2085 return;
Devang Patelbd477be2010-03-29 17:20:31 +00002086
Dan Gohman3650f4e2009-11-23 21:30:55 +00002087 ScopeVector &SD = I->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002088 for (ScopeVector::iterator SDI = SD.begin(), SDE = SD.end();
Jim Grosbach042483e2009-11-21 23:12:12 +00002089 SDI != SDE; ++SDI)
Chris Lattnerba35a672010-03-09 04:54:43 +00002090 (*SDI)->setStartLabel(Label);
Devang Patel8db360d2009-10-06 01:50:42 +00002091}
2092
Devang Patel930143b2009-11-21 02:48:08 +00002093/// endScope - Process end of a scope.
2094void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patelbd477be2010-03-29 17:20:31 +00002095 // Ignore DBG_VALUE instruction.
Chris Lattner848c7d22010-03-31 05:39:57 +00002096 if (MI->isDebugValue())
Devang Patelbd477be2010-03-29 17:20:31 +00002097 return;
2098
2099 // Check location.
2100 DebugLoc DL = MI->getDebugLoc();
2101 if (DL.isUnknown())
2102 return;
Chris Lattner915c5f92010-04-02 19:42:39 +00002103
Devang Patelbd477be2010-03-29 17:20:31 +00002104 // Emit a label and update DbgScope if this instruction ends a scope.
Devang Patel8db360d2009-10-06 01:50:42 +00002105 InsnToDbgScopeMapTy::iterator I = DbgScopeEndMap.find(MI);
Devang Patel7d838bb2009-10-06 03:15:38 +00002106 if (I == DbgScopeEndMap.end())
Devang Patel8db360d2009-10-06 01:50:42 +00002107 return;
Chris Lattner915c5f92010-04-02 19:42:39 +00002108
Chris Lattner6e52e9d2010-03-14 08:36:50 +00002109 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattnere13c3722010-03-09 01:58:53 +00002110 Asm->OutStreamer.EmitLabel(Label);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002111
Chris Lattnere13c3722010-03-09 01:58:53 +00002112 SmallVector<DbgScope*, 2> &SD = I->second;
Devang Patel8db360d2009-10-06 01:50:42 +00002113 for (SmallVector<DbgScope *, 2>::iterator SDI = SD.begin(), SDE = SD.end();
Jim Grosbach042483e2009-11-21 23:12:12 +00002114 SDI != SDE; ++SDI)
Chris Lattnere13c3722010-03-09 01:58:53 +00002115 (*SDI)->setEndLabel(Label);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002116 return;
2117}
2118
2119/// createDbgScope - Create DbgScope for the scope.
2120void DwarfDebug::createDbgScope(MDNode *Scope, MDNode *InlinedAt) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002121 if (!InlinedAt) {
2122 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2123 if (WScope)
2124 return;
2125 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2126 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Jim Grosbach042483e2009-11-21 23:12:12 +00002127 if (DIDescriptor(Scope).isLexicalBlock())
Devang Patel4450f262009-11-11 00:18:40 +00002128 createDbgScope(DILexicalBlock(Scope).getContext().getNode(), NULL);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002129 return;
2130 }
2131
2132 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2133 if (WScope)
2134 return;
2135
2136 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2137 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2138 DILocation DL(InlinedAt);
2139 createDbgScope(DL.getScope().getNode(), DL.getOrigLocation().getNode());
Devang Patel8db360d2009-10-06 01:50:42 +00002140}
2141
Devang Patel930143b2009-11-21 02:48:08 +00002142/// extractScopeInformation - Scan machine instructions in this function
Chris Lattner848c7d22010-03-31 05:39:57 +00002143/// and collect DbgScopes. Return true, if at least one scope was found.
Chris Lattner76555b52010-01-26 23:18:02 +00002144bool DwarfDebug::extractScopeInformation() {
Devang Patel75cc16c2009-10-01 20:31:14 +00002145 // If scope information was extracted using .dbg intrinsics then there is not
2146 // any need to extract these information by scanning each instruction.
2147 if (!DbgScopeMap.empty())
2148 return false;
2149
Devang Patel530a0752010-01-04 20:44:00 +00002150 DenseMap<const MachineInstr *, unsigned> MIIndexMap;
2151 unsigned MIIndex = 0;
Chris Lattner915c5f92010-04-02 19:42:39 +00002152 LLVMContext &Ctx = MF->getFunction()->getContext();
2153
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002154 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patel75cc16c2009-10-01 20:31:14 +00002155 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2156 I != E; ++I) {
2157 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2158 II != IE; ++II) {
2159 const MachineInstr *MInsn = II;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002160 // FIXME : Remove DBG_VALUE check.
Chris Lattner848c7d22010-03-31 05:39:57 +00002161 if (MInsn->isDebugValue()) continue;
Devang Patel530a0752010-01-04 20:44:00 +00002162 MIIndexMap[MInsn] = MIIndex++;
Chris Lattner915c5f92010-04-02 19:42:39 +00002163
Devang Patel75cc16c2009-10-01 20:31:14 +00002164 DebugLoc DL = MInsn->getDebugLoc();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002165 if (DL.isUnknown()) continue;
Chris Lattner915c5f92010-04-02 19:42:39 +00002166
2167 MDNode *Scope = DL.getScope(Ctx);
2168
Devang Patel75cc16c2009-10-01 20:31:14 +00002169 // There is no need to create another DIE for compile unit. For all
Jim Grosbach042483e2009-11-21 23:12:12 +00002170 // other scopes, create one DbgScope now. This will be translated
Devang Patel75cc16c2009-10-01 20:31:14 +00002171 // into a scope DIE at the end.
Chris Lattner915c5f92010-04-02 19:42:39 +00002172 if (DIScope(Scope).isCompileUnit()) continue;
2173 createDbgScope(Scope, DL.getInlinedAt(Ctx));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002174 }
2175 }
2176
Devang Patel18737b22010-04-01 22:47:29 +00002177
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002178 // Build scope hierarchy using working set of scopes.
2179 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2180 I != E; ++I) {
2181 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2182 II != IE; ++II) {
2183 const MachineInstr *MInsn = II;
Devang Patela3e9c9c2010-03-15 18:33:46 +00002184 // FIXME : Remove DBG_VALUE check.
Chris Lattner848c7d22010-03-31 05:39:57 +00002185 if (MInsn->isDebugValue()) continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002186 DebugLoc DL = MInsn->getDebugLoc();
Chris Lattner915c5f92010-04-02 19:42:39 +00002187 if (DL.isUnknown()) continue;
2188
2189 MDNode *Scope = DL.getScope(Ctx);
2190 if (Scope == 0) continue;
2191
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002192 // There is no need to create another DIE for compile unit. For all
Jim Grosbach042483e2009-11-21 23:12:12 +00002193 // other scopes, create one DbgScope now. This will be translated
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002194 // into a scope DIE at the end.
Chris Lattner915c5f92010-04-02 19:42:39 +00002195 if (DIScope(Scope).isCompileUnit()) continue;
2196 DbgScope *DScope = getUpdatedDbgScope(Scope, MInsn, DL.getInlinedAt(Ctx));
2197 DScope->setLastInsn(MInsn);
Devang Patel75cc16c2009-10-01 20:31:14 +00002198 }
2199 }
2200
Devang Patel530a0752010-01-04 20:44:00 +00002201 if (!CurrentFnDbgScope)
2202 return false;
2203
2204 CurrentFnDbgScope->fixInstructionMarkers(MIIndexMap);
Devang Patel75cc16c2009-10-01 20:31:14 +00002205
2206 // Each scope has first instruction and last instruction to mark beginning
2207 // and end of a scope respectively. Create an inverse map that list scopes
2208 // starts (and ends) with an instruction. One instruction may start (or end)
Devang Patel7771b7c2010-01-20 02:05:23 +00002209 // multiple scopes. Ignore scopes that are not reachable.
2210 SmallVector<DbgScope *, 4> WorkList;
2211 WorkList.push_back(CurrentFnDbgScope);
2212 while (!WorkList.empty()) {
Chris Lattner848c7d22010-03-31 05:39:57 +00002213 DbgScope *S = WorkList.pop_back_val();
Devang Patel7771b7c2010-01-20 02:05:23 +00002214
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002215 const SmallVector<DbgScope *, 4> &Children = S->getScopes();
Devang Patel7771b7c2010-01-20 02:05:23 +00002216 if (!Children.empty())
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002217 for (SmallVector<DbgScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel7771b7c2010-01-20 02:05:23 +00002218 SE = Children.end(); SI != SE; ++SI)
2219 WorkList.push_back(*SI);
2220
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002221 if (S->isAbstractScope())
2222 continue;
Devang Patel75cc16c2009-10-01 20:31:14 +00002223 const MachineInstr *MI = S->getFirstInsn();
Chris Lattner8d2fe282010-03-31 05:36:29 +00002224 assert(MI && "DbgScope does not have first instruction!");
Devang Patel75cc16c2009-10-01 20:31:14 +00002225
2226 InsnToDbgScopeMapTy::iterator IDI = DbgScopeBeginMap.find(MI);
2227 if (IDI != DbgScopeBeginMap.end())
2228 IDI->second.push_back(S);
2229 else
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002230 DbgScopeBeginMap[MI].push_back(S);
Devang Patel75cc16c2009-10-01 20:31:14 +00002231
2232 MI = S->getLastInsn();
Chris Lattner8d2fe282010-03-31 05:36:29 +00002233 assert(MI && "DbgScope does not have last instruction!");
Devang Patel75cc16c2009-10-01 20:31:14 +00002234 IDI = DbgScopeEndMap.find(MI);
2235 if (IDI != DbgScopeEndMap.end())
2236 IDI->second.push_back(S);
2237 else
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002238 DbgScopeEndMap[MI].push_back(S);
Devang Patel75cc16c2009-10-01 20:31:14 +00002239 }
2240
2241 return !DbgScopeMap.empty();
2242}
2243
Devang Patel930143b2009-11-21 02:48:08 +00002244/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendling2b128d72009-05-20 23:19:06 +00002245/// emitted immediately after the function entry point.
Chris Lattner76555b52010-01-26 23:18:02 +00002246void DwarfDebug::beginFunction(const MachineFunction *MF) {
Bill Wendling2b128d72009-05-20 23:19:06 +00002247 this->MF = MF;
2248
2249 if (!ShouldEmitDwarfDebug()) return;
Chris Lattner76555b52010-01-26 23:18:02 +00002250 if (!extractScopeInformation())
Devang Patel4598eb62009-10-06 18:37:31 +00002251 return;
Chris Lattner47879752010-03-29 20:38:20 +00002252
2253 TimeRegion Timer(DebugTimer);
Devang Patel930143b2009-11-21 02:48:08 +00002254
2255 collectVariableInfo();
Devang Patel4598eb62009-10-06 18:37:31 +00002256
Bill Wendling2b128d72009-05-20 23:19:06 +00002257 // Assumes in correct section after the entry point.
Chris Lattner722714d2010-03-08 22:44:40 +00002258 Asm->OutStreamer.EmitLabel(getDWLabel("func_begin", ++SubprogramCount));
Bill Wendling2b128d72009-05-20 23:19:06 +00002259
2260 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2261 // function.
Devang Pateldf45c7f2009-10-09 22:42:28 +00002262 DebugLoc FDL = MF->getDefaultDebugLoc();
Chris Lattner915c5f92010-04-02 19:42:39 +00002263 if (FDL.isUnknown()) return;
2264
2265 MDNode *Scope = FDL.getScope(MF->getFunction()->getContext());
2266
2267 DISubprogram SP = getDISubprogram(Scope);
2268 unsigned Line, Col;
2269 if (SP.Verify()) {
2270 Line = SP.getLineNumber();
2271 Col = 0;
2272 } else {
2273 Line = FDL.getLine();
2274 Col = FDL.getCol();
Bill Wendling2b128d72009-05-20 23:19:06 +00002275 }
Chris Lattner915c5f92010-04-02 19:42:39 +00002276
2277 recordSourceLine(Line, Col, Scope);
Bill Wendling2b128d72009-05-20 23:19:06 +00002278}
2279
Devang Patel930143b2009-11-21 02:48:08 +00002280/// endFunction - Gather and emit post-function debug information.
Bill Wendling2b128d72009-05-20 23:19:06 +00002281///
Chris Lattner76555b52010-01-26 23:18:02 +00002282void DwarfDebug::endFunction(const MachineFunction *MF) {
Bill Wendling2b128d72009-05-20 23:19:06 +00002283 if (!ShouldEmitDwarfDebug()) return;
Chris Lattner47879752010-03-29 20:38:20 +00002284 if (DbgScopeMap.empty()) return;
2285
2286 TimeRegion Timer(DebugTimer);
Devang Patel2904aa92009-11-12 19:02:56 +00002287
Devang Patel530a0752010-01-04 20:44:00 +00002288 if (CurrentFnDbgScope) {
2289 // Define end label for subprogram.
Chris Lattner722714d2010-03-08 22:44:40 +00002290 Asm->OutStreamer.EmitLabel(getDWLabel("func_end", SubprogramCount));
Devang Patel530a0752010-01-04 20:44:00 +00002291
2292 // Get function line info.
2293 if (!Lines.empty()) {
2294 // Get section line info.
2295 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2296 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2297 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2298 // Append the function info to section info.
2299 SectionLineInfos.insert(SectionLineInfos.end(),
2300 Lines.begin(), Lines.end());
2301 }
2302
2303 // Construct abstract scopes.
2304 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
2305 AE = AbstractScopesList.end(); AI != AE; ++AI)
2306 constructScopeDIE(*AI);
2307
2308 constructScopeDIE(CurrentFnDbgScope);
2309
2310 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
2311 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00002312 }
2313
Bill Wendling2b128d72009-05-20 23:19:06 +00002314 // Clear debug info
Devang Patelfe189e62010-01-19 01:26:02 +00002315 CurrentFnDbgScope = NULL;
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002316 DeleteContainerSeconds(DbgScopeMap);
Devang Patelfe189e62010-01-19 01:26:02 +00002317 DbgScopeBeginMap.clear();
2318 DbgScopeEndMap.clear();
Devang Patel23b2ae62010-03-29 22:59:58 +00002319 DbgValueStartMap.clear();
Devang Patelfe189e62010-01-19 01:26:02 +00002320 ConcreteScopes.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002321 DeleteContainerSeconds(AbstractScopes);
Devang Patelfe189e62010-01-19 01:26:02 +00002322 AbstractScopesList.clear();
Jeffrey Yasskin35b4e4f2010-03-12 17:45:06 +00002323 AbstractVariables.clear();
Bill Wendling2b128d72009-05-20 23:19:06 +00002324 Lines.clear();
Bill Wendling2b128d72009-05-20 23:19:06 +00002325}
2326
Chris Lattnerba35a672010-03-09 04:54:43 +00002327/// recordSourceLine - Register a source line with debug info. Returns the
2328/// unique label that was emitted and which provides correspondence to
2329/// the source line list.
2330MCSymbol *DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, MDNode *S) {
Devang Patel80ae3492009-08-28 23:24:31 +00002331 if (!MMI)
2332 return 0;
2333
Chris Lattner47879752010-03-29 20:38:20 +00002334 TimeRegion Timer(DebugTimer);
Bill Wendling2b128d72009-05-20 23:19:06 +00002335
Devang Patel2d9caf92009-11-25 17:36:49 +00002336 StringRef Dir;
2337 StringRef Fn;
Devang Patel2089d162009-10-05 18:03:19 +00002338
2339 DIDescriptor Scope(S);
2340 if (Scope.isCompileUnit()) {
2341 DICompileUnit CU(S);
2342 Dir = CU.getDirectory();
2343 Fn = CU.getFilename();
2344 } else if (Scope.isSubprogram()) {
2345 DISubprogram SP(S);
2346 Dir = SP.getDirectory();
2347 Fn = SP.getFilename();
2348 } else if (Scope.isLexicalBlock()) {
2349 DILexicalBlock DB(S);
2350 Dir = DB.getDirectory();
2351 Fn = DB.getFilename();
2352 } else
Chris Lattner2c3f4782010-03-13 07:26:18 +00002353 assert(0 && "Unexpected scope info");
Devang Patel2089d162009-10-05 18:03:19 +00002354
2355 unsigned Src = GetOrCreateSourceID(Dir, Fn);
Chris Lattner6e52e9d2010-03-14 08:36:50 +00002356 MCSymbol *Label = MMI->getContext().CreateTempSymbol();
Chris Lattnerb4666f42010-03-14 08:15:55 +00002357 Lines.push_back(SrcLineInfo(Line, Col, Src, Label));
Bill Wendling2b128d72009-05-20 23:19:06 +00002358
Chris Lattnerba35a672010-03-09 04:54:43 +00002359 Asm->OutStreamer.EmitLabel(Label);
2360 return Label;
Bill Wendling2b128d72009-05-20 23:19:06 +00002361}
2362
2363/// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
2364/// timed. Look up the source id with the given directory and source file
2365/// names. If none currently exists, create a new id and insert it in the
2366/// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
2367/// well.
2368unsigned DwarfDebug::getOrCreateSourceID(const std::string &DirName,
2369 const std::string &FileName) {
Chris Lattner47879752010-03-29 20:38:20 +00002370 TimeRegion Timer(DebugTimer);
2371 return GetOrCreateSourceID(DirName.c_str(), FileName.c_str());
Bill Wendling2b128d72009-05-20 23:19:06 +00002372}
2373
Bill Wendling806535f2009-05-20 23:22:40 +00002374//===----------------------------------------------------------------------===//
2375// Emit Methods
2376//===----------------------------------------------------------------------===//
2377
Devang Patel930143b2009-11-21 02:48:08 +00002378/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling480ff322009-05-20 23:21:38 +00002379///
Jim Grosbach00e9c612009-11-22 19:20:36 +00002380unsigned
2381DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling480ff322009-05-20 23:21:38 +00002382 // Get the children.
2383 const std::vector<DIE *> &Children = Die->getChildren();
2384
2385 // If not last sibling and has children then add sibling offset attribute.
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00002386 if (!Last && !Children.empty())
Benjamin Kramer74729ae2010-03-31 19:34:01 +00002387 Die->addSiblingOffset(DIEValueAllocator);
Bill Wendling480ff322009-05-20 23:21:38 +00002388
2389 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00002390 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00002391
2392 // Get the abbreviation for this DIE.
2393 unsigned AbbrevNumber = Die->getAbbrevNumber();
2394 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2395
2396 // Set DIE offset
2397 Die->setOffset(Offset);
2398
2399 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00002400 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00002401
2402 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2403 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2404
2405 // Size the DIE attribute values.
2406 for (unsigned i = 0, N = Values.size(); i < N; ++i)
2407 // Size attribute value.
2408 Offset += Values[i]->SizeOf(TD, AbbrevData[i].getForm());
2409
2410 // Size the DIE children if any.
2411 if (!Children.empty()) {
2412 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
2413 "Children flag not set");
2414
2415 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00002416 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling480ff322009-05-20 23:21:38 +00002417
2418 // End of children marker.
2419 Offset += sizeof(int8_t);
2420 }
2421
2422 Die->setSize(Offset - Die->getOffset());
2423 return Offset;
2424}
2425
Devang Patel930143b2009-11-21 02:48:08 +00002426/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling480ff322009-05-20 23:21:38 +00002427///
Devang Patel930143b2009-11-21 02:48:08 +00002428void DwarfDebug::computeSizeAndOffsets() {
Bill Wendling480ff322009-05-20 23:21:38 +00002429 // Compute size of compile unit header.
2430 static unsigned Offset =
2431 sizeof(int32_t) + // Length of Compilation Unit Info
2432 sizeof(int16_t) + // DWARF version number
2433 sizeof(int32_t) + // Offset Into Abbrev. Section
2434 sizeof(int8_t); // Pointer Size (in bytes)
2435
Devang Patel930143b2009-11-21 02:48:08 +00002436 computeSizeAndOffset(ModuleCU->getCUDie(), Offset, true);
Devang Patel40d78412009-06-29 20:45:18 +00002437 CompileUnitOffsets[ModuleCU] = 0;
Bill Wendling480ff322009-05-20 23:21:38 +00002438}
2439
Devang Patel930143b2009-11-21 02:48:08 +00002440/// emitInitial - Emit initial Dwarf declarations. This is necessary for cc
Bill Wendling480ff322009-05-20 23:21:38 +00002441/// tools to recognize the object file contains Dwarf information.
Devang Patel930143b2009-11-21 02:48:08 +00002442void DwarfDebug::emitInitial() {
Bill Wendling480ff322009-05-20 23:21:38 +00002443 // Check to see if we already emitted intial headers.
2444 if (didInitial) return;
2445 didInitial = true;
2446
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002447 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002448
Bill Wendling480ff322009-05-20 23:21:38 +00002449 // Dwarf sections base addresses.
Chris Lattnere9a75a62009-08-22 21:43:10 +00002450 if (MAI->doesDwarfRequireFrameSection()) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002451 Asm->OutStreamer.SwitchSection(TLOF.getDwarfFrameSection());
Chris Lattner722714d2010-03-08 22:44:40 +00002452 Asm->OutStreamer.EmitLabel(getTempLabel("section_debug_frame"));
Bill Wendling480ff322009-05-20 23:21:38 +00002453 }
2454
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002455 Asm->OutStreamer.SwitchSection(TLOF.getDwarfInfoSection());
Chris Lattner722714d2010-03-08 22:44:40 +00002456 Asm->OutStreamer.EmitLabel(getTempLabel("section_info"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002457 Asm->OutStreamer.SwitchSection(TLOF.getDwarfAbbrevSection());
Chris Lattner722714d2010-03-08 22:44:40 +00002458 Asm->OutStreamer.EmitLabel(getTempLabel("section_abbrev"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002459 Asm->OutStreamer.SwitchSection(TLOF.getDwarfARangesSection());
Chris Lattner722714d2010-03-08 22:44:40 +00002460 Asm->OutStreamer.EmitLabel(getTempLabel("section_aranges"));
Bill Wendling480ff322009-05-20 23:21:38 +00002461
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002462 if (const MCSection *LineInfoDirective = TLOF.getDwarfMacroInfoSection()) {
2463 Asm->OutStreamer.SwitchSection(LineInfoDirective);
Chris Lattner722714d2010-03-08 22:44:40 +00002464 Asm->OutStreamer.EmitLabel(getTempLabel("section_macinfo"));
Bill Wendling480ff322009-05-20 23:21:38 +00002465 }
2466
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002467 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLineSection());
Chris Lattner722714d2010-03-08 22:44:40 +00002468 Asm->OutStreamer.EmitLabel(getTempLabel("section_line"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002469 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLocSection());
Chris Lattner722714d2010-03-08 22:44:40 +00002470 Asm->OutStreamer.EmitLabel(getTempLabel("section_loc"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002471 Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubNamesSection());
Chris Lattner722714d2010-03-08 22:44:40 +00002472 Asm->OutStreamer.EmitLabel(getTempLabel("section_pubnames"));
Devang Patel04d2f2d2009-11-24 01:14:22 +00002473 Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubTypesSection());
Chris Lattner722714d2010-03-08 22:44:40 +00002474 Asm->OutStreamer.EmitLabel(getTempLabel("section_pubtypes"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002475 Asm->OutStreamer.SwitchSection(TLOF.getDwarfStrSection());
Chris Lattner722714d2010-03-08 22:44:40 +00002476 Asm->OutStreamer.EmitLabel(getTempLabel("section_str"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002477 Asm->OutStreamer.SwitchSection(TLOF.getDwarfRangesSection());
Chris Lattner722714d2010-03-08 22:44:40 +00002478 Asm->OutStreamer.EmitLabel(getTempLabel("section_ranges"));
Bill Wendling480ff322009-05-20 23:21:38 +00002479
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002480 Asm->OutStreamer.SwitchSection(TLOF.getTextSection());
Chris Lattner722714d2010-03-08 22:44:40 +00002481 Asm->OutStreamer.EmitLabel(getTempLabel("text_begin"));
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002482 Asm->OutStreamer.SwitchSection(TLOF.getDataSection());
Chris Lattner722714d2010-03-08 22:44:40 +00002483 Asm->OutStreamer.EmitLabel(getTempLabel("data_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00002484}
2485
Devang Patel930143b2009-11-21 02:48:08 +00002486/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling480ff322009-05-20 23:21:38 +00002487///
Devang Patel930143b2009-11-21 02:48:08 +00002488void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00002489 // Get the abbreviation for this DIE.
2490 unsigned AbbrevNumber = Die->getAbbrevNumber();
2491 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2492
Bill Wendling480ff322009-05-20 23:21:38 +00002493 // Emit the code (index) for the abbreviation.
Chris Lattnerfa823552010-01-22 23:18:42 +00002494 if (Asm->VerboseAsm)
2495 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2496 Twine::utohexstr(Die->getOffset()) + ":0x" +
2497 Twine::utohexstr(Die->getSize()) + " " +
2498 dwarf::TagString(Abbrev->getTag()));
2499 EmitULEB128(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00002500
Jeffrey Yasskin54ebc982010-03-22 18:47:14 +00002501 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling480ff322009-05-20 23:21:38 +00002502 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2503
2504 // Emit the DIE attribute values.
2505 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2506 unsigned Attr = AbbrevData[i].getAttribute();
2507 unsigned Form = AbbrevData[i].getForm();
2508 assert(Form && "Too many attributes for DIE (check abbreviation)");
2509
Chris Lattner5adf9872010-01-24 18:54:17 +00002510 if (Asm->VerboseAsm)
2511 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
2512
Bill Wendling480ff322009-05-20 23:21:38 +00002513 switch (Attr) {
2514 case dwarf::DW_AT_sibling:
Devang Patel930143b2009-11-21 02:48:08 +00002515 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00002516 break;
2517 case dwarf::DW_AT_abstract_origin: {
2518 DIEEntry *E = cast<DIEEntry>(Values[i]);
2519 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002520 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00002521 Asm->EmitInt32(Addr);
2522 break;
2523 }
2524 default:
2525 // Emit an attribute using the defined form.
2526 Values[i]->EmitValue(this, Form);
2527 break;
2528 }
Bill Wendling480ff322009-05-20 23:21:38 +00002529 }
2530
2531 // Emit the DIE children if any.
2532 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2533 const std::vector<DIE *> &Children = Die->getChildren();
2534
2535 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00002536 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00002537
Chris Lattner566cae92010-03-09 23:52:58 +00002538 if (Asm->VerboseAsm)
2539 Asm->OutStreamer.AddComment("End Of Children Mark");
2540 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00002541 }
2542}
2543
Devang Patel9ccfb642009-12-09 18:24:21 +00002544/// emitDebugInfo - Emit the debug info section.
Bill Wendling480ff322009-05-20 23:21:38 +00002545///
Devang Patel9ccfb642009-12-09 18:24:21 +00002546void DwarfDebug::emitDebugInfo() {
2547 // Start debug info section.
2548 Asm->OutStreamer.SwitchSection(
2549 Asm->getObjFileLowering().getDwarfInfoSection());
2550 DIE *Die = ModuleCU->getCUDie();
Bill Wendling480ff322009-05-20 23:21:38 +00002551
2552 // Emit the compile units header.
Chris Lattner722714d2010-03-08 22:44:40 +00002553 Asm->OutStreamer.EmitLabel(getDWLabel("info_begin", ModuleCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00002554
2555 // Emit size of content not including length itself
2556 unsigned ContentSize = Die->getSize() +
2557 sizeof(int16_t) + // DWARF version number
2558 sizeof(int32_t) + // Offset Into Abbrev. Section
2559 sizeof(int8_t) + // Pointer Size (in bytes)
2560 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2561
Chris Lattner566cae92010-03-09 23:52:58 +00002562 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
2563 Asm->EmitInt32(ContentSize);
2564 Asm->OutStreamer.AddComment("DWARF version number");
2565 Asm->EmitInt16(dwarf::DWARF_VERSION);
2566 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
Devang Patel852a04e2010-03-17 17:29:55 +00002567 EmitSectionOffset(getTempLabel("abbrev_begin"),getTempLabel("section_abbrev"),
2568 true);
Chris Lattner566cae92010-03-09 23:52:58 +00002569 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2570 Asm->EmitInt8(TD->getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00002571
Devang Patel930143b2009-11-21 02:48:08 +00002572 emitDIE(Die);
Bill Wendling480ff322009-05-20 23:21:38 +00002573 // FIXME - extra padding for gdb bug.
Chris Lattner566cae92010-03-09 23:52:58 +00002574 Asm->OutStreamer.AddComment("4 extra padding bytes for GDB");
2575 Asm->EmitInt8(0);
2576 Asm->EmitInt8(0);
2577 Asm->EmitInt8(0);
2578 Asm->EmitInt8(0);
Chris Lattner722714d2010-03-08 22:44:40 +00002579 Asm->OutStreamer.EmitLabel(getDWLabel("info_end", ModuleCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00002580}
2581
Devang Patel930143b2009-11-21 02:48:08 +00002582/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling480ff322009-05-20 23:21:38 +00002583///
Devang Patel930143b2009-11-21 02:48:08 +00002584void DwarfDebug::emitAbbreviations() const {
Bill Wendling480ff322009-05-20 23:21:38 +00002585 // Check to see if it is worth the effort.
2586 if (!Abbreviations.empty()) {
2587 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002588 Asm->OutStreamer.SwitchSection(
2589 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002590
Chris Lattner722714d2010-03-08 22:44:40 +00002591 Asm->OutStreamer.EmitLabel(getTempLabel("abbrev_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00002592
2593 // For each abbrevation.
2594 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2595 // Get abbreviation data
2596 const DIEAbbrev *Abbrev = Abbreviations[i];
2597
2598 // Emit the abbrevations code (base 1 index.)
Chris Lattnerfa823552010-01-22 23:18:42 +00002599 EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling480ff322009-05-20 23:21:38 +00002600
2601 // Emit the abbreviations data.
Chris Lattnerfa823552010-01-22 23:18:42 +00002602 Abbrev->Emit(this);
Bill Wendling480ff322009-05-20 23:21:38 +00002603 }
2604
2605 // Mark end of abbreviations.
Chris Lattnerfa823552010-01-22 23:18:42 +00002606 EmitULEB128(0, "EOM(3)");
Bill Wendling480ff322009-05-20 23:21:38 +00002607
Chris Lattner722714d2010-03-08 22:44:40 +00002608 Asm->OutStreamer.EmitLabel(getTempLabel("abbrev_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00002609 }
2610}
2611
Devang Patel930143b2009-11-21 02:48:08 +00002612/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling480ff322009-05-20 23:21:38 +00002613/// the line matrix.
2614///
Devang Patel930143b2009-11-21 02:48:08 +00002615void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00002616 // Define last address of section.
Chris Lattner566cae92010-03-09 23:52:58 +00002617 Asm->OutStreamer.AddComment("Extended Op");
2618 Asm->EmitInt8(0);
2619
2620 Asm->OutStreamer.AddComment("Op size");
2621 Asm->EmitInt8(TD->getPointerSize() + 1);
2622 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2623 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2624
2625 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002626
2627 Asm->OutStreamer.EmitSymbolValue(getDWLabel("section_end", SectionEnd),
2628 TD->getPointerSize(), 0/*AddrSpace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00002629
2630 // Mark end of matrix.
Chris Lattner566cae92010-03-09 23:52:58 +00002631 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2632 Asm->EmitInt8(0);
Chris Lattnerf5c834f2010-01-22 22:09:00 +00002633 Asm->EmitInt8(1);
Chris Lattnerfa823552010-01-22 23:18:42 +00002634 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002635}
2636
Devang Patel930143b2009-11-21 02:48:08 +00002637/// emitDebugLines - Emit source line information.
Bill Wendling480ff322009-05-20 23:21:38 +00002638///
Devang Patel930143b2009-11-21 02:48:08 +00002639void DwarfDebug::emitDebugLines() {
Bill Wendling480ff322009-05-20 23:21:38 +00002640 // If the target is using .loc/.file, the assembler will be emitting the
2641 // .debug_line table automatically.
Chris Lattnere9a75a62009-08-22 21:43:10 +00002642 if (MAI->hasDotLocAndDotFile())
Bill Wendling480ff322009-05-20 23:21:38 +00002643 return;
2644
2645 // Minimum line delta, thus ranging from -10..(255-10).
2646 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
2647 // Maximum line delta, thus ranging from -10..(255-10).
2648 const int MaxLineDelta = 255 + MinLineDelta;
2649
2650 // Start the dwarf line section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002651 Asm->OutStreamer.SwitchSection(
2652 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002653
2654 // Construct the section header.
Chris Lattner566cae92010-03-09 23:52:58 +00002655 Asm->OutStreamer.AddComment("Length of Source Line Info");
Chris Lattner722714d2010-03-08 22:44:40 +00002656 EmitDifference(getTempLabel("line_end"), getTempLabel("line_begin"), true);
Chris Lattner722714d2010-03-08 22:44:40 +00002657 Asm->OutStreamer.EmitLabel(getTempLabel("line_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00002658
Chris Lattner566cae92010-03-09 23:52:58 +00002659 Asm->OutStreamer.AddComment("DWARF version number");
2660 Asm->EmitInt16(dwarf::DWARF_VERSION);
Bill Wendling480ff322009-05-20 23:21:38 +00002661
Chris Lattner566cae92010-03-09 23:52:58 +00002662 Asm->OutStreamer.AddComment("Prolog Length");
Chris Lattner722714d2010-03-08 22:44:40 +00002663 EmitDifference(getTempLabel("line_prolog_end"),
2664 getTempLabel("line_prolog_begin"), true);
Chris Lattner722714d2010-03-08 22:44:40 +00002665 Asm->OutStreamer.EmitLabel(getTempLabel("line_prolog_begin"));
Bill Wendling480ff322009-05-20 23:21:38 +00002666
Chris Lattner566cae92010-03-09 23:52:58 +00002667 Asm->OutStreamer.AddComment("Minimum Instruction Length");
2668 Asm->EmitInt8(1);
2669 Asm->OutStreamer.AddComment("Default is_stmt_start flag");
2670 Asm->EmitInt8(1);
2671 Asm->OutStreamer.AddComment("Line Base Value (Special Opcodes)");
2672 Asm->EmitInt8(MinLineDelta);
2673 Asm->OutStreamer.AddComment("Line Range Value (Special Opcodes)");
2674 Asm->EmitInt8(MaxLineDelta);
2675 Asm->OutStreamer.AddComment("Special Opcode Base");
2676 Asm->EmitInt8(-MinLineDelta);
Bill Wendling480ff322009-05-20 23:21:38 +00002677
2678 // Line number standard opcode encodings argument count
Chris Lattner566cae92010-03-09 23:52:58 +00002679 Asm->OutStreamer.AddComment("DW_LNS_copy arg count");
2680 Asm->EmitInt8(0);
2681 Asm->OutStreamer.AddComment("DW_LNS_advance_pc arg count");
2682 Asm->EmitInt8(1);
2683 Asm->OutStreamer.AddComment("DW_LNS_advance_line arg count");
2684 Asm->EmitInt8(1);
2685 Asm->OutStreamer.AddComment("DW_LNS_set_file arg count");
2686 Asm->EmitInt8(1);
2687 Asm->OutStreamer.AddComment("DW_LNS_set_column arg count");
2688 Asm->EmitInt8(1);
2689 Asm->OutStreamer.AddComment("DW_LNS_negate_stmt arg count");
2690 Asm->EmitInt8(0);
2691 Asm->OutStreamer.AddComment("DW_LNS_set_basic_block arg count");
2692 Asm->EmitInt8(0);
2693 Asm->OutStreamer.AddComment("DW_LNS_const_add_pc arg count");
2694 Asm->EmitInt8(0);
2695 Asm->OutStreamer.AddComment("DW_LNS_fixed_advance_pc arg count");
2696 Asm->EmitInt8(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002697
2698 // Emit directories.
2699 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
Chris Lattnerc3f23b82010-01-23 03:11:46 +00002700 const std::string &Dir = getSourceDirectoryName(DI);
2701 if (Asm->VerboseAsm) Asm->OutStreamer.AddComment("Directory");
2702 Asm->OutStreamer.EmitBytes(StringRef(Dir.c_str(), Dir.size()+1), 0);
Bill Wendling480ff322009-05-20 23:21:38 +00002703 }
2704
Chris Lattner566cae92010-03-09 23:52:58 +00002705 Asm->OutStreamer.AddComment("End of directories");
2706 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00002707
2708 // Emit files.
2709 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
2710 // Remember source id starts at 1.
2711 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
Chris Lattnerc3f23b82010-01-23 03:11:46 +00002712 const std::string &FN = getSourceFileName(Id.second);
2713 if (Asm->VerboseAsm) Asm->OutStreamer.AddComment("Source");
2714 Asm->OutStreamer.EmitBytes(StringRef(FN.c_str(), FN.size()+1), 0);
2715
Chris Lattnerfa823552010-01-22 23:18:42 +00002716 EmitULEB128(Id.first, "Directory #");
2717 EmitULEB128(0, "Mod date");
2718 EmitULEB128(0, "File size");
Bill Wendling480ff322009-05-20 23:21:38 +00002719 }
2720
Chris Lattner566cae92010-03-09 23:52:58 +00002721 Asm->OutStreamer.AddComment("End of files");
2722 Asm->EmitInt8(0);
Bill Wendling480ff322009-05-20 23:21:38 +00002723
Chris Lattner722714d2010-03-08 22:44:40 +00002724 Asm->OutStreamer.EmitLabel(getTempLabel("line_prolog_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00002725
2726 // A sequence for each text section.
2727 unsigned SecSrcLinesSize = SectionSourceLines.size();
2728
2729 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2730 // Isolate current sections line info.
2731 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2732
Bill Wendling480ff322009-05-20 23:21:38 +00002733 // Dwarf assumes we start with first line of first source file.
2734 unsigned Source = 1;
2735 unsigned Line = 1;
2736
2737 // Construct rows of the address, source, line, column matrix.
2738 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2739 const SrcLineInfo &LineInfo = LineInfos[i];
Chris Lattnerb4666f42010-03-14 08:15:55 +00002740 MCSymbol *Label = LineInfo.getLabel();
Chris Lattneree95d4c2010-03-14 02:20:58 +00002741 if (!Label->isDefined()) continue; // Not emitted, in dead code.
Bill Wendling480ff322009-05-20 23:21:38 +00002742
Caroline Tice183a5192009-09-11 18:25:54 +00002743 if (LineInfo.getLine() == 0) continue;
2744
Chris Lattner3d72a672010-03-09 23:38:23 +00002745 if (Asm->isVerbose()) {
Chris Lattner7e998b72010-03-10 01:04:13 +00002746 std::pair<unsigned, unsigned> SrcID =
Bill Wendling480ff322009-05-20 23:21:38 +00002747 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner7e998b72010-03-10 01:04:13 +00002748 Asm->OutStreamer.AddComment(Twine(getSourceDirectoryName(SrcID.first)) +
Chris Lattnera26fbe42010-03-10 02:29:31 +00002749 "/" +
2750 Twine(getSourceFileName(SrcID.second)) +
Chris Lattner7e998b72010-03-10 01:04:13 +00002751 ":" + Twine(LineInfo.getLine()));
Bill Wendling480ff322009-05-20 23:21:38 +00002752 }
2753
2754 // Define the line address.
Chris Lattner566cae92010-03-09 23:52:58 +00002755 Asm->OutStreamer.AddComment("Extended Op");
2756 Asm->EmitInt8(0);
2757 Asm->OutStreamer.AddComment("Op size");
2758 Asm->EmitInt8(TD->getPointerSize() + 1);
2759
2760 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2761 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2762
2763 Asm->OutStreamer.AddComment("Location label");
Chris Lattneree95d4c2010-03-14 02:20:58 +00002764 Asm->OutStreamer.EmitSymbolValue(Label, TD->getPointerSize(),
2765 0/*AddrSpace*/);
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002766
Bill Wendling480ff322009-05-20 23:21:38 +00002767 // If change of source, then switch to the new source.
2768 if (Source != LineInfo.getSourceID()) {
2769 Source = LineInfo.getSourceID();
Chris Lattner566cae92010-03-09 23:52:58 +00002770 Asm->OutStreamer.AddComment("DW_LNS_set_file");
2771 Asm->EmitInt8(dwarf::DW_LNS_set_file);
Chris Lattnerfa823552010-01-22 23:18:42 +00002772 EmitULEB128(Source, "New Source");
Bill Wendling480ff322009-05-20 23:21:38 +00002773 }
2774
2775 // If change of line.
2776 if (Line != LineInfo.getLine()) {
2777 // Determine offset.
2778 int Offset = LineInfo.getLine() - Line;
2779 int Delta = Offset - MinLineDelta;
2780
2781 // Update line.
2782 Line = LineInfo.getLine();
2783
2784 // If delta is small enough and in range...
2785 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2786 // ... then use fast opcode.
Chris Lattner566cae92010-03-09 23:52:58 +00002787 Asm->OutStreamer.AddComment("Line Delta");
2788 Asm->EmitInt8(Delta - MinLineDelta);
Bill Wendling480ff322009-05-20 23:21:38 +00002789 } else {
2790 // ... otherwise use long hand.
Chris Lattner566cae92010-03-09 23:52:58 +00002791 Asm->OutStreamer.AddComment("DW_LNS_advance_line");
Bill Wendling480ff322009-05-20 23:21:38 +00002792 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
Chris Lattner23031452010-01-22 22:56:55 +00002793 EmitSLEB128(Offset, "Line Offset");
Chris Lattner566cae92010-03-09 23:52:58 +00002794 Asm->OutStreamer.AddComment("DW_LNS_copy");
2795 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling480ff322009-05-20 23:21:38 +00002796 }
2797 } else {
2798 // Copy the previous row (different address or source)
Chris Lattner566cae92010-03-09 23:52:58 +00002799 Asm->OutStreamer.AddComment("DW_LNS_copy");
2800 Asm->EmitInt8(dwarf::DW_LNS_copy);
Bill Wendling480ff322009-05-20 23:21:38 +00002801 }
2802 }
2803
Devang Patel930143b2009-11-21 02:48:08 +00002804 emitEndOfLineMatrix(j + 1);
Bill Wendling480ff322009-05-20 23:21:38 +00002805 }
2806
2807 if (SecSrcLinesSize == 0)
2808 // Because we're emitting a debug_line section, we still need a line
2809 // table. The linker and friends expect it to exist. If there's nothing to
2810 // put into it, emit an empty table.
Devang Patel930143b2009-11-21 02:48:08 +00002811 emitEndOfLineMatrix(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002812
Chris Lattner722714d2010-03-08 22:44:40 +00002813 Asm->OutStreamer.EmitLabel(getTempLabel("line_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00002814}
2815
Devang Patel930143b2009-11-21 02:48:08 +00002816/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling480ff322009-05-20 23:21:38 +00002817///
Devang Patel930143b2009-11-21 02:48:08 +00002818void DwarfDebug::emitCommonDebugFrame() {
Chris Lattnere9a75a62009-08-22 21:43:10 +00002819 if (!MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00002820 return;
2821
2822 int stackGrowth =
2823 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2824 TargetFrameInfo::StackGrowsUp ?
2825 TD->getPointerSize() : -TD->getPointerSize();
2826
2827 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002828 Asm->OutStreamer.SwitchSection(
2829 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002830
Chris Lattner722714d2010-03-08 22:44:40 +00002831 Asm->OutStreamer.EmitLabel(getTempLabel("debug_frame_common"));
Chris Lattner566cae92010-03-09 23:52:58 +00002832 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattner449a9ff2010-03-08 23:02:59 +00002833 EmitDifference(getTempLabel("debug_frame_common_end"),
2834 getTempLabel("debug_frame_common_begin"), true);
Bill Wendling480ff322009-05-20 23:21:38 +00002835
Chris Lattner722714d2010-03-08 22:44:40 +00002836 Asm->OutStreamer.EmitLabel(getTempLabel("debug_frame_common_begin"));
Chris Lattner566cae92010-03-09 23:52:58 +00002837 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Bill Wendling480ff322009-05-20 23:21:38 +00002838 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
Chris Lattner566cae92010-03-09 23:52:58 +00002839 Asm->OutStreamer.AddComment("CIE Version");
Bill Wendling480ff322009-05-20 23:21:38 +00002840 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
Chris Lattner566cae92010-03-09 23:52:58 +00002841 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00002842 Asm->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0); // nul terminator.
Chris Lattnerfa823552010-01-22 23:18:42 +00002843 EmitULEB128(1, "CIE Code Alignment Factor");
Chris Lattner23031452010-01-22 22:56:55 +00002844 EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner566cae92010-03-09 23:52:58 +00002845 Asm->OutStreamer.AddComment("CIE RA Column");
Bill Wendling480ff322009-05-20 23:21:38 +00002846 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Bill Wendling480ff322009-05-20 23:21:38 +00002847
2848 std::vector<MachineMove> Moves;
2849 RI->getInitialFrameState(Moves);
2850
Chris Lattner41e275d2010-03-13 08:05:25 +00002851 EmitFrameMoves(0, Moves, false);
Bill Wendling480ff322009-05-20 23:21:38 +00002852
2853 Asm->EmitAlignment(2, 0, 0, false);
Chris Lattner722714d2010-03-08 22:44:40 +00002854 Asm->OutStreamer.EmitLabel(getTempLabel("debug_frame_common_end"));
Bill Wendling480ff322009-05-20 23:21:38 +00002855}
2856
Devang Patel930143b2009-11-21 02:48:08 +00002857/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling480ff322009-05-20 23:21:38 +00002858/// section.
Chris Lattner2c3f4782010-03-13 07:26:18 +00002859void DwarfDebug::
2860emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Chris Lattnere9a75a62009-08-22 21:43:10 +00002861 if (!MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00002862 return;
2863
2864 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002865 Asm->OutStreamer.SwitchSection(
2866 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002867
Chris Lattner566cae92010-03-09 23:52:58 +00002868 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattner2c3f4782010-03-13 07:26:18 +00002869 MCSymbol *DebugFrameBegin =
2870 getDWLabel("debug_frame_begin", DebugFrameInfo.Number);
2871 MCSymbol *DebugFrameEnd =
2872 getDWLabel("debug_frame_end", DebugFrameInfo.Number);
2873 EmitDifference(DebugFrameEnd, DebugFrameBegin, true);
Bill Wendling480ff322009-05-20 23:21:38 +00002874
Chris Lattner2c3f4782010-03-13 07:26:18 +00002875 Asm->OutStreamer.EmitLabel(DebugFrameBegin);
Bill Wendling480ff322009-05-20 23:21:38 +00002876
Chris Lattner566cae92010-03-09 23:52:58 +00002877 Asm->OutStreamer.AddComment("FDE CIE offset");
Devang Patel852a04e2010-03-17 17:29:55 +00002878 EmitSectionOffset(getTempLabel("debug_frame_common"),
2879 getTempLabel("section_debug_frame"), true);
Bill Wendling480ff322009-05-20 23:21:38 +00002880
Chris Lattner566cae92010-03-09 23:52:58 +00002881 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattner8811e122010-03-13 07:40:56 +00002882 MCSymbol *FuncBeginSym = getDWLabel("func_begin", DebugFrameInfo.Number);
2883 Asm->OutStreamer.EmitSymbolValue(FuncBeginSym,
Chris Lattnerb245dfb2010-03-10 01:17:49 +00002884 TD->getPointerSize(), 0/*AddrSpace*/);
2885
2886
Chris Lattner566cae92010-03-09 23:52:58 +00002887 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattner8811e122010-03-13 07:40:56 +00002888 EmitDifference(getDWLabel("func_end", DebugFrameInfo.Number), FuncBeginSym);
Bill Wendling480ff322009-05-20 23:21:38 +00002889
Chris Lattner41e275d2010-03-13 08:05:25 +00002890 EmitFrameMoves(FuncBeginSym, DebugFrameInfo.Moves, false);
Bill Wendling480ff322009-05-20 23:21:38 +00002891
2892 Asm->EmitAlignment(2, 0, 0, false);
Chris Lattner2c3f4782010-03-13 07:26:18 +00002893 Asm->OutStreamer.EmitLabel(DebugFrameEnd);
Bill Wendling480ff322009-05-20 23:21:38 +00002894}
2895
Devang Patel9ccfb642009-12-09 18:24:21 +00002896/// emitDebugPubNames - Emit visible names into a debug pubnames section.
2897///
2898void DwarfDebug::emitDebugPubNames() {
2899 // Start the dwarf pubnames section.
2900 Asm->OutStreamer.SwitchSection(
2901 Asm->getObjFileLowering().getDwarfPubNamesSection());
2902
Chris Lattner566cae92010-03-09 23:52:58 +00002903 Asm->OutStreamer.AddComment("Length of Public Names Info");
Chris Lattner449a9ff2010-03-08 23:02:59 +00002904 EmitDifference(getDWLabel("pubnames_end", ModuleCU->getID()),
2905 getDWLabel("pubnames_begin", ModuleCU->getID()), true);
Bill Wendling480ff322009-05-20 23:21:38 +00002906
Chris Lattner722714d2010-03-08 22:44:40 +00002907 Asm->OutStreamer.EmitLabel(getDWLabel("pubnames_begin", ModuleCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00002908
Chris Lattner566cae92010-03-09 23:52:58 +00002909 Asm->OutStreamer.AddComment("DWARF Version");
2910 Asm->EmitInt16(dwarf::DWARF_VERSION);
Bill Wendling480ff322009-05-20 23:21:38 +00002911
Chris Lattner566cae92010-03-09 23:52:58 +00002912 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Chris Lattnerbc9210c2010-03-08 22:23:36 +00002913 EmitSectionOffset(getDWLabel("info_begin", ModuleCU->getID()),
Devang Patel852a04e2010-03-17 17:29:55 +00002914 getTempLabel("section_info"), true);
Bill Wendling480ff322009-05-20 23:21:38 +00002915
Chris Lattner566cae92010-03-09 23:52:58 +00002916 Asm->OutStreamer.AddComment("Compilation Unit Length");
Chris Lattner449a9ff2010-03-08 23:02:59 +00002917 EmitDifference(getDWLabel("info_end", ModuleCU->getID()),
2918 getDWLabel("info_begin", ModuleCU->getID()),
Bill Wendling480ff322009-05-20 23:21:38 +00002919 true);
Bill Wendling480ff322009-05-20 23:21:38 +00002920
Devang Patel9ccfb642009-12-09 18:24:21 +00002921 const StringMap<DIE*> &Globals = ModuleCU->getGlobals();
Bill Wendling480ff322009-05-20 23:21:38 +00002922 for (StringMap<DIE*>::const_iterator
2923 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2924 const char *Name = GI->getKeyData();
Chris Lattner566cae92010-03-09 23:52:58 +00002925 DIE *Entity = GI->second;
Bill Wendling480ff322009-05-20 23:21:38 +00002926
Chris Lattner566cae92010-03-09 23:52:58 +00002927 Asm->OutStreamer.AddComment("DIE offset");
2928 Asm->EmitInt32(Entity->getOffset());
Chris Lattnerc3f23b82010-01-23 03:11:46 +00002929
2930 if (Asm->VerboseAsm)
2931 Asm->OutStreamer.AddComment("External Name");
2932 Asm->OutStreamer.EmitBytes(StringRef(Name, strlen(Name)+1), 0);
Bill Wendling480ff322009-05-20 23:21:38 +00002933 }
2934
Chris Lattner566cae92010-03-09 23:52:58 +00002935 Asm->OutStreamer.AddComment("End Mark");
2936 Asm->EmitInt32(0);
Chris Lattner722714d2010-03-08 22:44:40 +00002937 Asm->OutStreamer.EmitLabel(getDWLabel("pubnames_end", ModuleCU->getID()));
Bill Wendling480ff322009-05-20 23:21:38 +00002938}
2939
Devang Patel04d2f2d2009-11-24 01:14:22 +00002940void DwarfDebug::emitDebugPubTypes() {
Devang Patelc8654eb2009-11-24 19:18:41 +00002941 // Start the dwarf pubnames section.
2942 Asm->OutStreamer.SwitchSection(
2943 Asm->getObjFileLowering().getDwarfPubTypesSection());
Chris Lattner566cae92010-03-09 23:52:58 +00002944 Asm->OutStreamer.AddComment("Length of Public Types Info");
Chris Lattner449a9ff2010-03-08 23:02:59 +00002945 EmitDifference(getDWLabel("pubtypes_end", ModuleCU->getID()),
2946 getDWLabel("pubtypes_begin", ModuleCU->getID()), true);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002947
Chris Lattner722714d2010-03-08 22:44:40 +00002948 Asm->OutStreamer.EmitLabel(getDWLabel("pubtypes_begin", ModuleCU->getID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00002949
Devang Patel057c6422010-02-02 03:47:27 +00002950 if (Asm->VerboseAsm) Asm->OutStreamer.AddComment("DWARF Version");
2951 Asm->EmitInt16(dwarf::DWARF_VERSION);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002952
Chris Lattner566cae92010-03-09 23:52:58 +00002953 Asm->OutStreamer.AddComment("Offset of Compilation ModuleCU Info");
Chris Lattnerbc9210c2010-03-08 22:23:36 +00002954 EmitSectionOffset(getDWLabel("info_begin", ModuleCU->getID()),
Devang Patel852a04e2010-03-17 17:29:55 +00002955 getTempLabel("section_info"), true);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002956
Chris Lattner566cae92010-03-09 23:52:58 +00002957 Asm->OutStreamer.AddComment("Compilation ModuleCU Length");
Chris Lattner449a9ff2010-03-08 23:02:59 +00002958 EmitDifference(getDWLabel("info_end", ModuleCU->getID()),
2959 getDWLabel("info_begin", ModuleCU->getID()),
Devang Patel04d2f2d2009-11-24 01:14:22 +00002960 true);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002961
2962 const StringMap<DIE*> &Globals = ModuleCU->getGlobalTypes();
2963 for (StringMap<DIE*>::const_iterator
2964 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2965 const char *Name = GI->getKeyData();
2966 DIE * Entity = GI->second;
2967
Devang Patel057c6422010-02-02 03:47:27 +00002968 if (Asm->VerboseAsm) Asm->OutStreamer.AddComment("DIE offset");
2969 Asm->EmitInt32(Entity->getOffset());
Chris Lattnerc3f23b82010-01-23 03:11:46 +00002970
2971 if (Asm->VerboseAsm) Asm->OutStreamer.AddComment("External Name");
Devang Patel6d404ad2010-02-02 03:37:03 +00002972 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002973 }
2974
Chris Lattner566cae92010-03-09 23:52:58 +00002975 Asm->OutStreamer.AddComment("End Mark");
2976 Asm->EmitInt32(0);
Chris Lattner722714d2010-03-08 22:44:40 +00002977 Asm->OutStreamer.EmitLabel(getDWLabel("pubtypes_end", ModuleCU->getID()));
Devang Patel04d2f2d2009-11-24 01:14:22 +00002978}
2979
Devang Patel930143b2009-11-21 02:48:08 +00002980/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling480ff322009-05-20 23:21:38 +00002981///
Devang Patel930143b2009-11-21 02:48:08 +00002982void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00002983 // Check to see if it is worth the effort.
Chris Lattner3d72a672010-03-09 23:38:23 +00002984 if (StringPool.empty()) return;
2985
2986 // Start the dwarf str section.
2987 Asm->OutStreamer.SwitchSection(
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002988 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002989
Chris Lattnerb7aa9522010-03-13 02:17:42 +00002990 // Get all of the string pool entries and put them in an array by their ID so
2991 // we can sort them.
2992 SmallVector<std::pair<unsigned,
2993 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
2994
2995 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
2996 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
2997 Entries.push_back(std::make_pair(I->second.second, &*I));
2998
2999 array_pod_sort(Entries.begin(), Entries.end());
3000
3001 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner3d72a672010-03-09 23:38:23 +00003002 // Emit a label for reference from debug information entries.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003003 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Chris Lattner3d72a672010-03-09 23:38:23 +00003004
3005 // Emit the string itself.
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003006 Asm->OutStreamer.EmitBytes(Entries[i].second->getKey(), 0/*addrspace*/);
Bill Wendling480ff322009-05-20 23:21:38 +00003007 }
3008}
3009
Devang Patel930143b2009-11-21 02:48:08 +00003010/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling480ff322009-05-20 23:21:38 +00003011///
Devang Patel930143b2009-11-21 02:48:08 +00003012void DwarfDebug::emitDebugLoc() {
Bill Wendling480ff322009-05-20 23:21:38 +00003013 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003014 Asm->OutStreamer.SwitchSection(
3015 Asm->getObjFileLowering().getDwarfLocSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003016}
3017
3018/// EmitDebugARanges - Emit visible names into a debug aranges section.
3019///
3020void DwarfDebug::EmitDebugARanges() {
3021 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003022 Asm->OutStreamer.SwitchSection(
3023 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003024}
3025
Devang Patel930143b2009-11-21 02:48:08 +00003026/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling480ff322009-05-20 23:21:38 +00003027///
Devang Patel930143b2009-11-21 02:48:08 +00003028void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00003029 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003030 Asm->OutStreamer.SwitchSection(
3031 Asm->getObjFileLowering().getDwarfRangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00003032}
3033
Devang Patel930143b2009-11-21 02:48:08 +00003034/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling480ff322009-05-20 23:21:38 +00003035///
Devang Patel930143b2009-11-21 02:48:08 +00003036void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00003037 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00003038 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00003039 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003040 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00003041 }
3042}
3043
Devang Patel930143b2009-11-21 02:48:08 +00003044/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling480ff322009-05-20 23:21:38 +00003045/// Section Header:
3046/// 1. length of section
3047/// 2. Dwarf version number
3048/// 3. address size.
3049///
3050/// Entries (one "entry" for each function that was inlined):
3051///
3052/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3053/// otherwise offset into __debug_str for regular function name.
3054/// 2. offset into __debug_str section for regular function name.
3055/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3056/// instances for the function.
3057///
3058/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3059/// inlined instance; the die_offset points to the inlined_subroutine die in the
3060/// __debug_info section, and the low_pc is the starting address for the
3061/// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00003062void DwarfDebug::emitDebugInlineInfo() {
Chris Lattnere9a75a62009-08-22 21:43:10 +00003063 if (!MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00003064 return;
3065
Devang Patel40d78412009-06-29 20:45:18 +00003066 if (!ModuleCU)
Bill Wendling480ff322009-05-20 23:21:38 +00003067 return;
3068
Chris Lattner4b7dadb2009-08-19 05:49:37 +00003069 Asm->OutStreamer.SwitchSection(
3070 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerf5c834f2010-01-22 22:09:00 +00003071
Chris Lattner566cae92010-03-09 23:52:58 +00003072 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattner449a9ff2010-03-08 23:02:59 +00003073 EmitDifference(getDWLabel("debug_inlined_end", 1),
3074 getDWLabel("debug_inlined_begin", 1), true);
Bill Wendling480ff322009-05-20 23:21:38 +00003075
Chris Lattner722714d2010-03-08 22:44:40 +00003076 Asm->OutStreamer.EmitLabel(getDWLabel("debug_inlined_begin", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003077
Chris Lattner566cae92010-03-09 23:52:58 +00003078 Asm->OutStreamer.AddComment("Dwarf Version");
3079 Asm->EmitInt16(dwarf::DWARF_VERSION);
3080 Asm->OutStreamer.AddComment("Address Size (in bytes)");
3081 Asm->EmitInt8(TD->getPointerSize());
Bill Wendling480ff322009-05-20 23:21:38 +00003082
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003083 for (SmallVector<MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
3084 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00003085
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003086 MDNode *Node = *I;
Devang Patel018b29b2010-01-19 06:19:05 +00003087 DenseMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach00e9c612009-11-22 19:20:36 +00003088 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003089 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00003090 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00003091 StringRef LName = SP.getLinkageName();
3092 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00003093
Chris Lattner566cae92010-03-09 23:52:58 +00003094 Asm->OutStreamer.AddComment("MIPS linkage name");
Chris Lattnerc3f23b82010-01-23 03:11:46 +00003095 if (LName.empty()) {
3096 Asm->OutStreamer.EmitBytes(Name, 0);
3097 Asm->OutStreamer.EmitIntValue(0, 1, 0); // nul terminator.
3098 } else
Chris Lattnerb7aa9522010-03-13 02:17:42 +00003099 EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
Chris Lattnerbc9210c2010-03-08 22:23:36 +00003100 getTempLabel("section_str"), true);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003101
Chris Lattner566cae92010-03-09 23:52:58 +00003102 Asm->OutStreamer.AddComment("Function name");
Devang Patel852a04e2010-03-17 17:29:55 +00003103 EmitSectionOffset(getStringPoolEntry(Name), getTempLabel("section_str"),
3104 true);
Chris Lattnerfa823552010-01-22 23:18:42 +00003105 EmitULEB128(Labels.size(), "Inline count");
Bill Wendling480ff322009-05-20 23:21:38 +00003106
Devang Patelf6eeaeb2009-11-10 23:06:00 +00003107 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00003108 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner085b6522010-03-09 00:31:02 +00003109 if (Asm->VerboseAsm) Asm->OutStreamer.AddComment("DIE offset");
3110 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00003111
Chris Lattner53d6d1e2010-03-09 00:26:09 +00003112 if (Asm->VerboseAsm) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerb14490d2010-03-09 00:39:24 +00003113 Asm->OutStreamer.EmitSymbolValue(LI->first, TD->getPointerSize(), 0);
Bill Wendling480ff322009-05-20 23:21:38 +00003114 }
3115 }
3116
Chris Lattner722714d2010-03-08 22:44:40 +00003117 Asm->OutStreamer.EmitLabel(getDWLabel("debug_inlined_end", 1));
Bill Wendling480ff322009-05-20 23:21:38 +00003118}