blob: 33a62733ee05c779a1798b9007a2fea3537a7ae9 [file] [log] [blame]
Bill Wendling0310d762009-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//===----------------------------------------------------------------------===//
Devang Patele4b27562009-08-28 23:24:31 +000013#define DEBUG_TYPE "dwarfdebug"
Bill Wendling0310d762009-05-15 09:23:25 +000014#include "DwarfDebug.h"
15#include "llvm/Module.h"
David Greeneb2c66fc2009-08-19 21:52:55 +000016#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling0310d762009-05-15 09:23:25 +000017#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000018#include "llvm/MC/MCSection.h"
Chris Lattner6c2f9e12009-08-19 05:49:37 +000019#include "llvm/MC/MCStreamer.h"
Chris Lattneraf76e592009-08-22 20:48:53 +000020#include "llvm/MC/MCAsmInfo.h"
Chris Lattner45111d12010-01-16 21:57:06 +000021#include "llvm/Target/Mangler.h"
Bill Wendling0310d762009-05-15 09:23:25 +000022#include "llvm/Target/TargetData.h"
23#include "llvm/Target/TargetFrameInfo.h"
Chris Lattnerf0144122009-07-28 03:13:23 +000024#include "llvm/Target/TargetLoweringObjectFile.h"
25#include "llvm/Target/TargetRegisterInfo.h"
Chris Lattner23132b12009-08-24 03:52:50 +000026#include "llvm/ADT/StringExtras.h"
Daniel Dunbar6e4bdfc2009-10-13 06:47:08 +000027#include "llvm/Support/Debug.h"
28#include "llvm/Support/ErrorHandling.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000029#include "llvm/Support/Timer.h"
30#include "llvm/System/Path.h"
Bill Wendling0310d762009-05-15 09:23:25 +000031using namespace llvm;
32
Bill Wendling0310d762009-05-15 09:23:25 +000033//===----------------------------------------------------------------------===//
34
35/// Configuration values for initial hash set sizes (log2).
36///
Bill Wendling0310d762009-05-15 09:23:25 +000037static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling0310d762009-05-15 09:23:25 +000038
39namespace llvm {
40
41//===----------------------------------------------------------------------===//
42/// CompileUnit - This dwarf writer support class manages information associate
43/// with a source file.
Nick Lewycky5f9843f2009-11-17 08:11:44 +000044class CompileUnit {
Bill Wendling0310d762009-05-15 09:23:25 +000045 /// ID - File identifier for source.
46 ///
47 unsigned ID;
48
49 /// Die - Compile unit debug information entry.
50 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +000051 DIE *CUDie;
Bill Wendling0310d762009-05-15 09:23:25 +000052
Devang Patel6f01d9c2009-11-21 00:31:03 +000053 /// IndexTyDie - An anonymous type for index type.
54 DIE *IndexTyDie;
55
Bill Wendling0310d762009-05-15 09:23:25 +000056 /// GVToDieMap - Tracks the mapping of unit level debug informaton
57 /// variables to debug information entries.
Devang Patele4b27562009-08-28 23:24:31 +000058 /// FIXME : Rename GVToDieMap -> NodeToDieMap
Devang Patel017d1212009-11-20 21:37:22 +000059 ValueMap<MDNode *, DIE *> GVToDieMap;
Bill Wendling0310d762009-05-15 09:23:25 +000060
61 /// GVToDIEEntryMap - Tracks the mapping of unit level debug informaton
62 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patele4b27562009-08-28 23:24:31 +000063 /// FIXME : Rename
Devang Patel017d1212009-11-20 21:37:22 +000064 ValueMap<MDNode *, DIEEntry *> GVToDIEEntryMap;
Bill Wendling0310d762009-05-15 09:23:25 +000065
66 /// Globals - A map of globally visible named entities for this unit.
67 ///
68 StringMap<DIE*> Globals;
69
Devang Patel193f7202009-11-24 01:14:22 +000070 /// GlobalTypes - A map of globally visible types for this unit.
71 ///
72 StringMap<DIE*> GlobalTypes;
73
Bill Wendling0310d762009-05-15 09:23:25 +000074public:
75 CompileUnit(unsigned I, DIE *D)
Devang Patel2c4ceb12009-11-21 02:48:08 +000076 : ID(I), CUDie(D), IndexTyDie(0) {}
77 ~CompileUnit() { delete CUDie; delete IndexTyDie; }
Bill Wendling0310d762009-05-15 09:23:25 +000078
79 // Accessors.
Devang Patel193f7202009-11-24 01:14:22 +000080 unsigned getID() const { return ID; }
81 DIE* getCUDie() const { return CUDie; }
82 const StringMap<DIE*> &getGlobals() const { return Globals; }
83 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
Bill Wendling0310d762009-05-15 09:23:25 +000084
85 /// hasContent - Return true if this compile unit has something to write out.
86 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +000087 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendling0310d762009-05-15 09:23:25 +000088
Devang Patel2c4ceb12009-11-21 02:48:08 +000089 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendling0310d762009-05-15 09:23:25 +000090 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +000091 void addGlobal(const std::string &Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling0310d762009-05-15 09:23:25 +000092
Devang Patel193f7202009-11-24 01:14:22 +000093 /// addGlobalType - Add a new global type to the compile unit.
94 ///
95 void addGlobalType(const std::string &Name, DIE *Die) {
96 GlobalTypes[Name] = Die;
97 }
98
Devang Patel017d1212009-11-20 21:37:22 +000099 /// getDIE - Returns the debug information entry map slot for the
Bill Wendling0310d762009-05-15 09:23:25 +0000100 /// specified debug variable.
Devang Patel017d1212009-11-20 21:37:22 +0000101 DIE *getDIE(MDNode *N) { return GVToDieMap.lookup(N); }
Jim Grosbach31ef40e2009-11-21 23:12:12 +0000102
Devang Patel017d1212009-11-20 21:37:22 +0000103 /// insertDIE - Insert DIE into the map.
104 void insertDIE(MDNode *N, DIE *D) {
105 GVToDieMap.insert(std::make_pair(N, D));
106 }
Bill Wendling0310d762009-05-15 09:23:25 +0000107
Devang Patel017d1212009-11-20 21:37:22 +0000108 /// getDIEEntry - Returns the debug information entry for the speciefied
109 /// debug variable.
Devang Patel6404e4e2009-12-15 19:16:48 +0000110 DIEEntry *getDIEEntry(MDNode *N) {
111 ValueMap<MDNode *, DIEEntry *>::iterator I = GVToDIEEntryMap.find(N);
112 if (I == GVToDIEEntryMap.end())
113 return NULL;
114 return I->second;
115 }
Devang Patel017d1212009-11-20 21:37:22 +0000116
117 /// insertDIEEntry - Insert debug information entry into the map.
118 void insertDIEEntry(MDNode *N, DIEEntry *E) {
119 GVToDIEEntryMap.insert(std::make_pair(N, E));
Bill Wendling0310d762009-05-15 09:23:25 +0000120 }
121
Devang Patel2c4ceb12009-11-21 02:48:08 +0000122 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendling0310d762009-05-15 09:23:25 +0000123 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000124 void addDie(DIE *Buffer) {
125 this->CUDie->addChild(Buffer);
Bill Wendling0310d762009-05-15 09:23:25 +0000126 }
Devang Patel6f01d9c2009-11-21 00:31:03 +0000127
128 // getIndexTyDie - Get an anonymous type for index type.
129 DIE *getIndexTyDie() {
130 return IndexTyDie;
131 }
132
Jim Grosbach7ab38df2009-11-22 19:20:36 +0000133 // setIndexTyDie - Set D as anonymous type for index which can be reused
134 // later.
Devang Patel6f01d9c2009-11-21 00:31:03 +0000135 void setIndexTyDie(DIE *D) {
136 IndexTyDie = D;
137 }
138
Bill Wendling0310d762009-05-15 09:23:25 +0000139};
140
141//===----------------------------------------------------------------------===//
142/// DbgVariable - This class is used to track local variable information.
143///
Devang Patelf76a3d62009-11-16 21:53:40 +0000144class DbgVariable {
Bill Wendling0310d762009-05-15 09:23:25 +0000145 DIVariable Var; // Variable Descriptor.
146 unsigned FrameIndex; // Variable frame index.
Devang Patel53bb5c92009-11-10 23:06:00 +0000147 DbgVariable *AbstractVar; // Abstract variable for this variable.
148 DIE *TheDIE;
Bill Wendling0310d762009-05-15 09:23:25 +0000149public:
Devang Patel53bb5c92009-11-10 23:06:00 +0000150 DbgVariable(DIVariable V, unsigned I)
151 : Var(V), FrameIndex(I), AbstractVar(0), TheDIE(0) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000152
153 // Accessors.
Devang Patel53bb5c92009-11-10 23:06:00 +0000154 DIVariable getVariable() const { return Var; }
155 unsigned getFrameIndex() const { return FrameIndex; }
156 void setAbstractVariable(DbgVariable *V) { AbstractVar = V; }
157 DbgVariable *getAbstractVariable() const { return AbstractVar; }
158 void setDIE(DIE *D) { TheDIE = D; }
159 DIE *getDIE() const { return TheDIE; }
Bill Wendling0310d762009-05-15 09:23:25 +0000160};
161
162//===----------------------------------------------------------------------===//
163/// DbgScope - This class is used to track scope information.
164///
Devang Patelf76a3d62009-11-16 21:53:40 +0000165class DbgScope {
Bill Wendling0310d762009-05-15 09:23:25 +0000166 DbgScope *Parent; // Parent to this scope.
Jim Grosbach31ef40e2009-11-21 23:12:12 +0000167 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patela27f6e42010-01-16 06:17:40 +0000168 MDNode * InlinedAtLocation; // Location at which scope is inlined.
Devang Patel53bb5c92009-11-10 23:06:00 +0000169 bool AbstractScope; // Abstract Scope
Bill Wendling0310d762009-05-15 09:23:25 +0000170 unsigned StartLabelID; // Label ID of the beginning of scope.
171 unsigned EndLabelID; // Label ID of the end of scope.
Devang Pateld38dd112009-10-01 18:25:23 +0000172 const MachineInstr *LastInsn; // Last instruction of this scope.
173 const MachineInstr *FirstInsn; // First instruction of this scope.
Bill Wendling0310d762009-05-15 09:23:25 +0000174 SmallVector<DbgScope *, 4> Scopes; // Scopes defined in scope.
175 SmallVector<DbgVariable *, 8> Variables;// Variables declared in scope.
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000176
Owen Anderson04c05f72009-06-24 22:53:20 +0000177 // Private state for dump()
178 mutable unsigned IndentLevel;
Bill Wendling0310d762009-05-15 09:23:25 +0000179public:
Devang Patelc90aefe2009-10-14 21:08:09 +0000180 DbgScope(DbgScope *P, DIDescriptor D, MDNode *I = 0)
Devang Patel53bb5c92009-11-10 23:06:00 +0000181 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Jim Grosbach31ef40e2009-11-21 23:12:12 +0000182 StartLabelID(0), EndLabelID(0),
Devang Patelc90aefe2009-10-14 21:08:09 +0000183 LastInsn(0), FirstInsn(0), IndentLevel(0) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000184 virtual ~DbgScope();
185
186 // Accessors.
187 DbgScope *getParent() const { return Parent; }
Devang Patel53bb5c92009-11-10 23:06:00 +0000188 void setParent(DbgScope *P) { Parent = P; }
Bill Wendling0310d762009-05-15 09:23:25 +0000189 DIDescriptor getDesc() const { return Desc; }
Jim Grosbach31ef40e2009-11-21 23:12:12 +0000190 MDNode *getInlinedAt() const {
Devang Patel53bb5c92009-11-10 23:06:00 +0000191 return dyn_cast_or_null<MDNode>(InlinedAtLocation);
Devang Patelc90aefe2009-10-14 21:08:09 +0000192 }
Devang Patel53bb5c92009-11-10 23:06:00 +0000193 MDNode *getScopeNode() const { return Desc.getNode(); }
Bill Wendling0310d762009-05-15 09:23:25 +0000194 unsigned getStartLabelID() const { return StartLabelID; }
195 unsigned getEndLabelID() const { return EndLabelID; }
196 SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
197 SmallVector<DbgVariable *, 8> &getVariables() { return Variables; }
Bill Wendling0310d762009-05-15 09:23:25 +0000198 void setStartLabelID(unsigned S) { StartLabelID = S; }
199 void setEndLabelID(unsigned E) { EndLabelID = E; }
Devang Pateld38dd112009-10-01 18:25:23 +0000200 void setLastInsn(const MachineInstr *MI) { LastInsn = MI; }
201 const MachineInstr *getLastInsn() { return LastInsn; }
202 void setFirstInsn(const MachineInstr *MI) { FirstInsn = MI; }
Devang Patel53bb5c92009-11-10 23:06:00 +0000203 void setAbstractScope() { AbstractScope = true; }
204 bool isAbstractScope() const { return AbstractScope; }
Devang Pateld38dd112009-10-01 18:25:23 +0000205 const MachineInstr *getFirstInsn() { return FirstInsn; }
Devang Patel53bb5c92009-11-10 23:06:00 +0000206
Devang Patel2c4ceb12009-11-21 02:48:08 +0000207 /// addScope - Add a scope to the scope.
Bill Wendling0310d762009-05-15 09:23:25 +0000208 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000209 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendling0310d762009-05-15 09:23:25 +0000210
Devang Patel2c4ceb12009-11-21 02:48:08 +0000211 /// addVariable - Add a variable to the scope.
Bill Wendling0310d762009-05-15 09:23:25 +0000212 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000213 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendling0310d762009-05-15 09:23:25 +0000214
Devang Patel344130e2010-01-04 20:44:00 +0000215 void fixInstructionMarkers(DenseMap<const MachineInstr *,
216 unsigned> &MIIndexMap) {
Devang Patelaf9e8472009-10-01 20:31:14 +0000217 assert (getFirstInsn() && "First instruction is missing!");
Devang Patel344130e2010-01-04 20:44:00 +0000218
219 // Use the end of last child scope as end of this scope.
Devang Patelaf9e8472009-10-01 20:31:14 +0000220 SmallVector<DbgScope *, 4> &Scopes = getScopes();
Devang Patelee890ed2010-01-05 16:59:17 +0000221 const MachineInstr *LastInsn = getFirstInsn();
Devang Patel344130e2010-01-04 20:44:00 +0000222 unsigned LIndex = 0;
223 if (Scopes.empty()) {
224 assert (getLastInsn() && "Inner most scope does not have last insn!");
225 return;
226 }
227 for (SmallVector<DbgScope *, 4>::iterator SI = Scopes.begin(),
228 SE = Scopes.end(); SI != SE; ++SI) {
229 DbgScope *DS = *SI;
230 DS->fixInstructionMarkers(MIIndexMap);
231 const MachineInstr *DSLastInsn = DS->getLastInsn();
232 unsigned DSI = MIIndexMap[DSLastInsn];
233 if (DSI > LIndex) {
234 LastInsn = DSLastInsn;
235 LIndex = DSI;
236 }
237 }
238 setLastInsn(LastInsn);
Devang Patelaf9e8472009-10-01 20:31:14 +0000239 }
240
Bill Wendling0310d762009-05-15 09:23:25 +0000241#ifndef NDEBUG
242 void dump() const;
243#endif
244};
245
246#ifndef NDEBUG
247void DbgScope::dump() const {
David Greenef83adbc2009-12-24 00:31:35 +0000248 raw_ostream &err = dbgs();
Chris Lattnerc281de12009-08-23 00:51:00 +0000249 err.indent(IndentLevel);
Devang Patel53bb5c92009-11-10 23:06:00 +0000250 MDNode *N = Desc.getNode();
251 N->dump();
Chris Lattnerc281de12009-08-23 00:51:00 +0000252 err << " [" << StartLabelID << ", " << EndLabelID << "]\n";
Devang Patel53bb5c92009-11-10 23:06:00 +0000253 if (AbstractScope)
254 err << "Abstract Scope\n";
Bill Wendling0310d762009-05-15 09:23:25 +0000255
256 IndentLevel += 2;
Devang Patel53bb5c92009-11-10 23:06:00 +0000257 if (!Scopes.empty())
258 err << "Children ...\n";
Bill Wendling0310d762009-05-15 09:23:25 +0000259 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
260 if (Scopes[i] != this)
261 Scopes[i]->dump();
262
263 IndentLevel -= 2;
264}
265#endif
266
Bill Wendling0310d762009-05-15 09:23:25 +0000267DbgScope::~DbgScope() {
268 for (unsigned i = 0, N = Scopes.size(); i < N; ++i)
269 delete Scopes[i];
270 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
271 delete Variables[j];
Bill Wendling0310d762009-05-15 09:23:25 +0000272}
273
274} // end llvm namespace
275
Chris Lattneraf76e592009-08-22 20:48:53 +0000276DwarfDebug::DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T)
Devang Patel1dbc7712009-06-29 20:45:18 +0000277 : Dwarf(OS, A, T, "dbg"), ModuleCU(0),
Bill Wendling0310d762009-05-15 09:23:25 +0000278 AbbreviationsSet(InitAbbreviationsSetSize), Abbreviations(),
Devang Patel2c4ceb12009-11-21 02:48:08 +0000279 DIEValues(), StringPool(),
Bill Wendling0310d762009-05-15 09:23:25 +0000280 SectionSourceLines(), didInitial(false), shouldEmit(false),
Devang Patel53bb5c92009-11-10 23:06:00 +0000281 CurrentFnDbgScope(0), DebugTimer(0) {
Bill Wendling0310d762009-05-15 09:23:25 +0000282 if (TimePassesIsEnabled)
Chris Lattner0b86a6f2009-12-28 07:41:18 +0000283 DebugTimer = new Timer("Dwarf Debug Writer");
Bill Wendling0310d762009-05-15 09:23:25 +0000284}
285DwarfDebug::~DwarfDebug() {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000286 for (unsigned j = 0, M = DIEValues.size(); j < M; ++j)
287 delete DIEValues[j];
Bill Wendling0310d762009-05-15 09:23:25 +0000288
Bill Wendling0310d762009-05-15 09:23:25 +0000289 delete DebugTimer;
290}
291
Devang Patel2c4ceb12009-11-21 02:48:08 +0000292/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling0310d762009-05-15 09:23:25 +0000293///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000294void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling0310d762009-05-15 09:23:25 +0000295 // Profile the node so that we can make it unique.
296 FoldingSetNodeID ID;
297 Abbrev.Profile(ID);
298
299 // Check the set for priors.
300 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
301
302 // If it's newly added.
303 if (InSet == &Abbrev) {
304 // Add to abbreviation list.
305 Abbreviations.push_back(&Abbrev);
306
307 // Assign the vector position + 1 as its number.
308 Abbrev.setNumber(Abbreviations.size());
309 } else {
310 // Assign existing abbreviation number.
311 Abbrev.setNumber(InSet->getNumber());
312 }
313}
314
Devang Patel2c4ceb12009-11-21 02:48:08 +0000315/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendling995f80a2009-05-20 23:24:48 +0000316/// information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000317DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000318 DIEEntry *Value = new DIEEntry(Entry);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000319 DIEValues.push_back(Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000320 return Value;
321}
322
Devang Patel2c4ceb12009-11-21 02:48:08 +0000323/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000324///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000325void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000326 unsigned Form, uint64_t Integer) {
327 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Devang Patel6f01d9c2009-11-21 00:31:03 +0000328 DIEValue *Value = new DIEInteger(Integer);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000329 DIEValues.push_back(Value);
330 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000331}
332
Devang Patel2c4ceb12009-11-21 02:48:08 +0000333/// addSInt - Add an signed integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000334///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000335void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000336 unsigned Form, int64_t Integer) {
337 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Devang Patel6f01d9c2009-11-21 00:31:03 +0000338 DIEValue *Value = new DIEInteger(Integer);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000339 DIEValues.push_back(Value);
340 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000341}
342
Devang Patel69f57b12009-12-02 15:25:16 +0000343/// addString - Add a string attribute data and value. DIEString only
344/// keeps string reference.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000345void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Devang Patele9a05972009-11-24 19:42:17 +0000346 const StringRef String) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000347 DIEValue *Value = new DIEString(String);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000348 DIEValues.push_back(Value);
349 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000350}
351
Devang Patel2c4ceb12009-11-21 02:48:08 +0000352/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000353///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000354void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000355 const DWLabel &Label) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000356 DIEValue *Value = new DIEDwarfLabel(Label);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000357 DIEValues.push_back(Value);
358 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000359}
360
Devang Patel2c4ceb12009-11-21 02:48:08 +0000361/// addObjectLabel - Add an non-Dwarf label attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000362///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000363void DwarfDebug::addObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattner858431d2010-01-16 18:50:28 +0000364 const MCSymbol *Sym) {
365 DIEValue *Value = new DIEObjectLabel(Sym);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000366 DIEValues.push_back(Value);
367 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000368}
369
Devang Patel2c4ceb12009-11-21 02:48:08 +0000370/// addSectionOffset - Add a section offset label attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000371///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000372void DwarfDebug::addSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000373 const DWLabel &Label, const DWLabel &Section,
374 bool isEH, bool useSet) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000375 DIEValue *Value = new DIESectionOffset(Label, Section, isEH, useSet);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000376 DIEValues.push_back(Value);
377 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000378}
379
Devang Patel2c4ceb12009-11-21 02:48:08 +0000380/// addDelta - Add a label delta attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000381///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000382void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000383 const DWLabel &Hi, const DWLabel &Lo) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000384 DIEValue *Value = new DIEDelta(Hi, Lo);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000385 DIEValues.push_back(Value);
386 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000387}
388
Devang Patel2c4ceb12009-11-21 02:48:08 +0000389/// addBlock - Add block data.
Bill Wendling0310d762009-05-15 09:23:25 +0000390///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000391void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000392 DIEBlock *Block) {
393 Block->ComputeSize(TD);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000394 DIEValues.push_back(Block);
395 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000396}
397
Devang Patel2c4ceb12009-11-21 02:48:08 +0000398/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000399/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000400void DwarfDebug::addSourceLine(DIE *Die, const DIVariable *V) {
Bill Wendling0310d762009-05-15 09:23:25 +0000401 // If there is no compile unit specified, don't add a line #.
402 if (V->getCompileUnit().isNull())
403 return;
404
405 unsigned Line = V->getLineNumber();
Devang Pateld037d7a2009-12-11 21:37:07 +0000406 unsigned FileID = findCompileUnit(V->getCompileUnit())->getID();
Bill Wendling0310d762009-05-15 09:23:25 +0000407 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000408 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
409 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000410}
411
Devang Patel2c4ceb12009-11-21 02:48:08 +0000412/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000413/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000414void DwarfDebug::addSourceLine(DIE *Die, const DIGlobal *G) {
Bill Wendling0310d762009-05-15 09:23:25 +0000415 // If there is no compile unit specified, don't add a line #.
416 if (G->getCompileUnit().isNull())
417 return;
418
419 unsigned Line = G->getLineNumber();
Devang Pateld037d7a2009-12-11 21:37:07 +0000420 unsigned FileID = findCompileUnit(G->getCompileUnit())->getID();
Bill Wendling0310d762009-05-15 09:23:25 +0000421 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000422 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
423 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000424}
Devang Patel82dfc0c2009-08-31 22:47:13 +0000425
Devang Patel2c4ceb12009-11-21 02:48:08 +0000426/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000427/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000428void DwarfDebug::addSourceLine(DIE *Die, const DISubprogram *SP) {
Devang Patel82dfc0c2009-08-31 22:47:13 +0000429 // If there is no compile unit specified, don't add a line #.
430 if (SP->getCompileUnit().isNull())
431 return;
Caroline Ticec6f9d622009-09-11 18:25:54 +0000432 // If the line number is 0, don't add it.
433 if (SP->getLineNumber() == 0)
434 return;
435
Devang Patel82dfc0c2009-08-31 22:47:13 +0000436
437 unsigned Line = SP->getLineNumber();
Devang Pateld037d7a2009-12-11 21:37:07 +0000438 unsigned FileID = findCompileUnit(SP->getCompileUnit())->getID();
Devang Patel82dfc0c2009-08-31 22:47:13 +0000439 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000440 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
441 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patel82dfc0c2009-08-31 22:47:13 +0000442}
443
Devang Patel2c4ceb12009-11-21 02:48:08 +0000444/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000445/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000446void DwarfDebug::addSourceLine(DIE *Die, const DIType *Ty) {
Bill Wendling0310d762009-05-15 09:23:25 +0000447 // If there is no compile unit specified, don't add a line #.
448 DICompileUnit CU = Ty->getCompileUnit();
449 if (CU.isNull())
450 return;
451
452 unsigned Line = Ty->getLineNumber();
Devang Pateld037d7a2009-12-11 21:37:07 +0000453 unsigned FileID = findCompileUnit(CU)->getID();
Bill Wendling0310d762009-05-15 09:23:25 +0000454 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000455 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
456 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000457}
458
Devang Patel6404e4e2009-12-15 19:16:48 +0000459/// addSourceLine - Add location information to specified debug information
460/// entry.
461void DwarfDebug::addSourceLine(DIE *Die, const DINameSpace *NS) {
462 // If there is no compile unit specified, don't add a line #.
463 if (NS->getCompileUnit().isNull())
464 return;
465
466 unsigned Line = NS->getLineNumber();
467 StringRef FN = NS->getFilename();
468 StringRef Dir = NS->getDirectory();
469
470 unsigned FileID = GetOrCreateSourceID(Dir, FN);
471 assert(FileID && "Invalid file id");
472 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
473 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
474}
475
Caroline Ticedc8f6042009-08-31 21:19:37 +0000476/* Byref variables, in Blocks, are declared by the programmer as
477 "SomeType VarName;", but the compiler creates a
478 __Block_byref_x_VarName struct, and gives the variable VarName
479 either the struct, or a pointer to the struct, as its type. This
480 is necessary for various behind-the-scenes things the compiler
481 needs to do with by-reference variables in blocks.
482
483 However, as far as the original *programmer* is concerned, the
484 variable should still have type 'SomeType', as originally declared.
485
486 The following function dives into the __Block_byref_x_VarName
487 struct to find the original type of the variable. This will be
488 passed back to the code generating the type for the Debug
489 Information Entry for the variable 'VarName'. 'VarName' will then
490 have the original type 'SomeType' in its debug information.
491
492 The original type 'SomeType' will be the type of the field named
493 'VarName' inside the __Block_byref_x_VarName struct.
494
495 NOTE: In order for this to not completely fail on the debugger
496 side, the Debug Information Entry for the variable VarName needs to
497 have a DW_AT_location that tells the debugger how to unwind through
498 the pointers and __Block_byref_x_VarName struct to find the actual
Devang Patel2c4ceb12009-11-21 02:48:08 +0000499 value of the variable. The function addBlockByrefType does this. */
Caroline Ticedc8f6042009-08-31 21:19:37 +0000500
501/// Find the type the programmer originally declared the variable to be
502/// and return that type.
503///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000504DIType DwarfDebug::getBlockByrefType(DIType Ty, std::string Name) {
Caroline Ticedc8f6042009-08-31 21:19:37 +0000505
506 DIType subType = Ty;
507 unsigned tag = Ty.getTag();
508
509 if (tag == dwarf::DW_TAG_pointer_type) {
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000510 DIDerivedType DTy = DIDerivedType(Ty.getNode());
Caroline Ticedc8f6042009-08-31 21:19:37 +0000511 subType = DTy.getTypeDerivedFrom();
512 }
513
514 DICompositeType blockStruct = DICompositeType(subType.getNode());
515
516 DIArray Elements = blockStruct.getTypeArray();
517
518 if (Elements.isNull())
519 return Ty;
520
521 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
522 DIDescriptor Element = Elements.getElement(i);
523 DIDerivedType DT = DIDerivedType(Element.getNode());
Devang Patel65dbc902009-11-25 17:36:49 +0000524 if (Name == DT.getName())
Caroline Ticedc8f6042009-08-31 21:19:37 +0000525 return (DT.getTypeDerivedFrom());
526 }
527
528 return Ty;
529}
530
Devang Patel2c4ceb12009-11-21 02:48:08 +0000531/// addComplexAddress - Start with the address based on the location provided,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000532/// and generate the DWARF information necessary to find the actual variable
533/// given the extra address information encoded in the DIVariable, starting from
534/// the starting location. Add the DWARF information to the die.
535///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000536void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000537 unsigned Attribute,
538 const MachineLocation &Location) {
539 const DIVariable &VD = DV->getVariable();
540 DIType Ty = VD.getType();
541
542 // Decode the original location, and use that as the start of the byref
543 // variable's location.
544 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
545 DIEBlock *Block = new DIEBlock();
546
547 if (Location.isReg()) {
548 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000549 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000550 } else {
551 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000552 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
553 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000554 }
555 } else {
556 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000557 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000558 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000559 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
560 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000561 }
562
Devang Patel2c4ceb12009-11-21 02:48:08 +0000563 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000564 }
565
566 for (unsigned i = 0, N = VD.getNumAddrElements(); i < N; ++i) {
567 uint64_t Element = VD.getAddrElement(i);
568
569 if (Element == DIFactory::OpPlus) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000570 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
571 addUInt(Block, 0, dwarf::DW_FORM_udata, VD.getAddrElement(++i));
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000572 } else if (Element == DIFactory::OpDeref) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000573 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000574 } else llvm_unreachable("unknown DIFactory Opcode");
575 }
576
577 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000578 addBlock(Die, Attribute, 0, Block);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000579}
580
Caroline Ticedc8f6042009-08-31 21:19:37 +0000581/* Byref variables, in Blocks, are declared by the programmer as "SomeType
582 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
583 gives the variable VarName either the struct, or a pointer to the struct, as
584 its type. This is necessary for various behind-the-scenes things the
585 compiler needs to do with by-reference variables in Blocks.
586
587 However, as far as the original *programmer* is concerned, the variable
588 should still have type 'SomeType', as originally declared.
589
Devang Patel2c4ceb12009-11-21 02:48:08 +0000590 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000591 struct to find the original type of the variable, which is then assigned to
592 the variable's Debug Information Entry as its real type. So far, so good.
593 However now the debugger will expect the variable VarName to have the type
594 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000595 expression that explains to the debugger how to navigate through the
Caroline Ticedc8f6042009-08-31 21:19:37 +0000596 pointers and struct to find the actual variable of type SomeType.
597
598 The following function does just that. We start by getting
599 the "normal" location for the variable. This will be the location
600 of either the struct __Block_byref_x_VarName or the pointer to the
601 struct __Block_byref_x_VarName.
602
603 The struct will look something like:
604
605 struct __Block_byref_x_VarName {
606 ... <various fields>
607 struct __Block_byref_x_VarName *forwarding;
608 ... <various other fields>
609 SomeType VarName;
610 ... <maybe more fields>
611 };
612
613 If we are given the struct directly (as our starting point) we
614 need to tell the debugger to:
615
616 1). Add the offset of the forwarding field.
617
618 2). Follow that pointer to get the the real __Block_byref_x_VarName
619 struct to use (the real one may have been copied onto the heap).
620
621 3). Add the offset for the field VarName, to find the actual variable.
622
623 If we started with a pointer to the struct, then we need to
624 dereference that pointer first, before the other steps.
625 Translating this into DWARF ops, we will need to append the following
626 to the current location description for the variable:
627
628 DW_OP_deref -- optional, if we start with a pointer
629 DW_OP_plus_uconst <forward_fld_offset>
630 DW_OP_deref
631 DW_OP_plus_uconst <varName_fld_offset>
632
633 That is what this function does. */
634
Devang Patel2c4ceb12009-11-21 02:48:08 +0000635/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticedc8f6042009-08-31 21:19:37 +0000636/// provided, and generate the DWARF information necessary to find the
637/// actual Block variable (navigating the Block struct) based on the
638/// starting location. Add the DWARF information to the die. For
639/// more information, read large comment just above here.
640///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000641void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbar00564992009-09-19 20:40:14 +0000642 unsigned Attribute,
643 const MachineLocation &Location) {
Caroline Ticedc8f6042009-08-31 21:19:37 +0000644 const DIVariable &VD = DV->getVariable();
645 DIType Ty = VD.getType();
646 DIType TmpTy = Ty;
647 unsigned Tag = Ty.getTag();
648 bool isPointer = false;
649
Devang Patel65dbc902009-11-25 17:36:49 +0000650 StringRef varName = VD.getName();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000651
652 if (Tag == dwarf::DW_TAG_pointer_type) {
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000653 DIDerivedType DTy = DIDerivedType(Ty.getNode());
Caroline Ticedc8f6042009-08-31 21:19:37 +0000654 TmpTy = DTy.getTypeDerivedFrom();
655 isPointer = true;
656 }
657
658 DICompositeType blockStruct = DICompositeType(TmpTy.getNode());
659
Daniel Dunbar00564992009-09-19 20:40:14 +0000660 // Find the __forwarding field and the variable field in the __Block_byref
661 // struct.
Daniel Dunbar00564992009-09-19 20:40:14 +0000662 DIArray Fields = blockStruct.getTypeArray();
663 DIDescriptor varField = DIDescriptor();
664 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000665
666
Daniel Dunbar00564992009-09-19 20:40:14 +0000667 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
668 DIDescriptor Element = Fields.getElement(i);
669 DIDerivedType DT = DIDerivedType(Element.getNode());
Devang Patel65dbc902009-11-25 17:36:49 +0000670 StringRef fieldName = DT.getName();
671 if (fieldName == "__forwarding")
Daniel Dunbar00564992009-09-19 20:40:14 +0000672 forwardingField = Element;
Devang Patel65dbc902009-11-25 17:36:49 +0000673 else if (fieldName == varName)
Daniel Dunbar00564992009-09-19 20:40:14 +0000674 varField = Element;
675 }
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000676
Mike Stump7e3720d2009-09-24 23:21:26 +0000677 assert(!varField.isNull() && "Can't find byref variable in Block struct");
678 assert(!forwardingField.isNull()
679 && "Can't find forwarding field in Block struct");
Caroline Ticedc8f6042009-08-31 21:19:37 +0000680
Daniel Dunbar00564992009-09-19 20:40:14 +0000681 // Get the offsets for the forwarding field and the variable field.
Daniel Dunbar00564992009-09-19 20:40:14 +0000682 unsigned int forwardingFieldOffset =
683 DIDerivedType(forwardingField.getNode()).getOffsetInBits() >> 3;
684 unsigned int varFieldOffset =
685 DIDerivedType(varField.getNode()).getOffsetInBits() >> 3;
Caroline Ticedc8f6042009-08-31 21:19:37 +0000686
Mike Stump7e3720d2009-09-24 23:21:26 +0000687 // Decode the original location, and use that as the start of the byref
688 // variable's location.
Daniel Dunbar00564992009-09-19 20:40:14 +0000689 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
690 DIEBlock *Block = new DIEBlock();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000691
Daniel Dunbar00564992009-09-19 20:40:14 +0000692 if (Location.isReg()) {
693 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000694 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000695 else {
696 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000697 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
698 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000699 }
700 } else {
701 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000702 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000703 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000704 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
705 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000706 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000707
Devang Patel2c4ceb12009-11-21 02:48:08 +0000708 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbar00564992009-09-19 20:40:14 +0000709 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000710
Mike Stump7e3720d2009-09-24 23:21:26 +0000711 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbar00564992009-09-19 20:40:14 +0000712 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbar00564992009-09-19 20:40:14 +0000713 if (isPointer)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000714 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000715
Daniel Dunbar00564992009-09-19 20:40:14 +0000716 // Next add the offset for the '__forwarding' field:
717 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
718 // adding the offset if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000719 if (forwardingFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000720 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
721 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000722 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000723
Daniel Dunbar00564992009-09-19 20:40:14 +0000724 // Now dereference the __forwarding field to get to the real __Block_byref
725 // struct: DW_OP_deref.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000726 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000727
Daniel Dunbar00564992009-09-19 20:40:14 +0000728 // Now that we've got the real __Block_byref... struct, add the offset
729 // for the variable's field to get to the location of the actual variable:
730 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000731 if (varFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000732 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
733 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000734 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000735
Daniel Dunbar00564992009-09-19 20:40:14 +0000736 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000737 addBlock(Die, Attribute, 0, Block);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000738}
739
Devang Patel2c4ceb12009-11-21 02:48:08 +0000740/// addAddress - Add an address attribute to a die based on the location
Bill Wendling0310d762009-05-15 09:23:25 +0000741/// provided.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000742void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000743 const MachineLocation &Location) {
744 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
745 DIEBlock *Block = new DIEBlock();
746
747 if (Location.isReg()) {
748 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000749 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000750 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000751 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
752 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000753 }
754 } else {
755 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000756 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000757 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000758 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
759 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000760 }
761
Devang Patel2c4ceb12009-11-21 02:48:08 +0000762 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling0310d762009-05-15 09:23:25 +0000763 }
764
Devang Patel2c4ceb12009-11-21 02:48:08 +0000765 addBlock(Die, Attribute, 0, Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000766}
767
Devang Patelc366f832009-12-10 19:14:49 +0000768/// addToContextOwner - Add Die into the list of its context owner's children.
769void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
770 if (Context.isNull())
771 ModuleCU->addDie(Die);
772 else if (Context.isType()) {
773 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context.getNode()));
774 ContextDIE->addChild(Die);
Devang Patel6404e4e2009-12-15 19:16:48 +0000775 } else if (Context.isNameSpace()) {
776 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context.getNode()));
777 ContextDIE->addChild(Die);
Devang Patelc366f832009-12-10 19:14:49 +0000778 } else if (DIE *ContextDIE = ModuleCU->getDIE(Context.getNode()))
779 ContextDIE->addChild(Die);
780 else
781 ModuleCU->addDie(Die);
782}
783
Devang Patel16ced732009-12-10 18:05:33 +0000784/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
785/// given DIType.
786DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
787 DIE *TyDIE = ModuleCU->getDIE(Ty.getNode());
788 if (TyDIE)
789 return TyDIE;
790
791 // Create new type.
792 TyDIE = new DIE(dwarf::DW_TAG_base_type);
793 ModuleCU->insertDIE(Ty.getNode(), TyDIE);
794 if (Ty.isBasicType())
795 constructTypeDIE(*TyDIE, DIBasicType(Ty.getNode()));
796 else if (Ty.isCompositeType())
797 constructTypeDIE(*TyDIE, DICompositeType(Ty.getNode()));
798 else {
799 assert(Ty.isDerivedType() && "Unknown kind of DIType");
800 constructTypeDIE(*TyDIE, DIDerivedType(Ty.getNode()));
801 }
802
Devang Patelc366f832009-12-10 19:14:49 +0000803 addToContextOwner(TyDIE, Ty.getContext());
Devang Patel16ced732009-12-10 18:05:33 +0000804 return TyDIE;
805}
806
Devang Patel2c4ceb12009-11-21 02:48:08 +0000807/// addType - Add a new type attribute to the specified entity.
Devang Patel8a241142009-12-09 18:24:21 +0000808void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Bill Wendling0310d762009-05-15 09:23:25 +0000809 if (Ty.isNull())
810 return;
811
812 // Check for pre-existence.
Devang Patel8a241142009-12-09 18:24:21 +0000813 DIEEntry *Entry = ModuleCU->getDIEEntry(Ty.getNode());
Bill Wendling0310d762009-05-15 09:23:25 +0000814 // If it exists then use the existing value.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000815 if (Entry) {
816 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000817 return;
818 }
819
820 // Set up proxy.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000821 Entry = createDIEEntry();
Devang Patel8a241142009-12-09 18:24:21 +0000822 ModuleCU->insertDIEEntry(Ty.getNode(), Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000823
824 // Construct type.
Devang Patel16ced732009-12-10 18:05:33 +0000825 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000826
Devang Patel2c4ceb12009-11-21 02:48:08 +0000827 Entry->setEntry(Buffer);
828 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000829}
830
Devang Patel2c4ceb12009-11-21 02:48:08 +0000831/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel8a241142009-12-09 18:24:21 +0000832void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000833 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000834 StringRef Name = BTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000835 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000836 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling0310d762009-05-15 09:23:25 +0000837 BTy.getEncoding());
838
839 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +0000840 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000841 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000842 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000843 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000844}
845
Devang Patel2c4ceb12009-11-21 02:48:08 +0000846/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel8a241142009-12-09 18:24:21 +0000847void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000848 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000849 StringRef Name = DTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000850 uint64_t Size = DTy.getSizeInBits() >> 3;
851 unsigned Tag = DTy.getTag();
852
853 // FIXME - Workaround for templates.
854 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
855
856 Buffer.setTag(Tag);
857
858 // Map to main type, void will not have a type.
859 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel8a241142009-12-09 18:24:21 +0000860 addType(&Buffer, FromTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000861
862 // Add name if not anonymous or intermediate type.
Devang Pateldeea5642009-11-30 23:56:56 +0000863 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000864 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000865
866 // Add size if non-zero (derived types might be zero-sized.)
867 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000868 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000869
870 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patel05f6fa82009-11-23 18:43:37 +0000871 if (!DTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000872 addSourceLine(&Buffer, &DTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000873}
874
Devang Patel2c4ceb12009-11-21 02:48:08 +0000875/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +0000876void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000877 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000878 StringRef Name = CTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000879
880 uint64_t Size = CTy.getSizeInBits() >> 3;
881 unsigned Tag = CTy.getTag();
882 Buffer.setTag(Tag);
883
884 switch (Tag) {
885 case dwarf::DW_TAG_vector_type:
886 case dwarf::DW_TAG_array_type:
Devang Patel8a241142009-12-09 18:24:21 +0000887 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000888 break;
889 case dwarf::DW_TAG_enumeration_type: {
890 DIArray Elements = CTy.getTypeArray();
891
892 // Add enumerators to enumeration type.
893 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
894 DIE *ElemDie = NULL;
Devang Patele4b27562009-08-28 23:24:31 +0000895 DIEnumerator Enum(Elements.getElement(i).getNode());
Devang Patelc5254722009-10-09 17:51:49 +0000896 if (!Enum.isNull()) {
Devang Patel8a241142009-12-09 18:24:21 +0000897 ElemDie = constructEnumTypeDIE(&Enum);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000898 Buffer.addChild(ElemDie);
Devang Patelc5254722009-10-09 17:51:49 +0000899 }
Bill Wendling0310d762009-05-15 09:23:25 +0000900 }
901 }
902 break;
903 case dwarf::DW_TAG_subroutine_type: {
904 // Add return type.
905 DIArray Elements = CTy.getTypeArray();
906 DIDescriptor RTy = Elements.getElement(0);
Devang Patel8a241142009-12-09 18:24:21 +0000907 addType(&Buffer, DIType(RTy.getNode()));
Bill Wendling0310d762009-05-15 09:23:25 +0000908
909 // Add prototype flag.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000910 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +0000911
912 // Add arguments.
913 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
914 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
915 DIDescriptor Ty = Elements.getElement(i);
Devang Patel8a241142009-12-09 18:24:21 +0000916 addType(Arg, DIType(Ty.getNode()));
Devang Patel2c4ceb12009-11-21 02:48:08 +0000917 Buffer.addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +0000918 }
919 }
920 break;
921 case dwarf::DW_TAG_structure_type:
922 case dwarf::DW_TAG_union_type:
923 case dwarf::DW_TAG_class_type: {
924 // Add elements to structure type.
925 DIArray Elements = CTy.getTypeArray();
926
927 // A forward struct declared type may not have elements available.
928 if (Elements.isNull())
929 break;
930
931 // Add elements to structure type.
932 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
933 DIDescriptor Element = Elements.getElement(i);
Devang Patele4b27562009-08-28 23:24:31 +0000934 if (Element.isNull())
935 continue;
Bill Wendling0310d762009-05-15 09:23:25 +0000936 DIE *ElemDie = NULL;
937 if (Element.getTag() == dwarf::DW_TAG_subprogram)
Devang Patelffe966c2009-12-14 16:18:45 +0000938 ElemDie = createSubprogramDIE(DISubprogram(Element.getNode()));
Bill Wendling0310d762009-05-15 09:23:25 +0000939 else
Devang Patel8a241142009-12-09 18:24:21 +0000940 ElemDie = createMemberDIE(DIDerivedType(Element.getNode()));
Devang Patel2c4ceb12009-11-21 02:48:08 +0000941 Buffer.addChild(ElemDie);
Bill Wendling0310d762009-05-15 09:23:25 +0000942 }
943
Devang Patela1ba2692009-08-27 23:51:51 +0000944 if (CTy.isAppleBlockExtension())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000945 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +0000946
947 unsigned RLang = CTy.getRunTimeLang();
948 if (RLang)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000949 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling0310d762009-05-15 09:23:25 +0000950 dwarf::DW_FORM_data1, RLang);
951 break;
952 }
953 default:
954 break;
955 }
956
957 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +0000958 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000959 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000960
961 if (Tag == dwarf::DW_TAG_enumeration_type ||
962 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type) {
963 // Add size if non-zero (derived types might be zero-sized.)
964 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000965 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000966 else {
967 // Add zero size if it is not a forward declaration.
968 if (CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000969 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +0000970 else
Devang Patel2c4ceb12009-11-21 02:48:08 +0000971 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling0310d762009-05-15 09:23:25 +0000972 }
973
974 // Add source line info if available.
975 if (!CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000976 addSourceLine(&Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000977 }
978}
979
Devang Patel2c4ceb12009-11-21 02:48:08 +0000980/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
981void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling0310d762009-05-15 09:23:25 +0000982 int64_t L = SR.getLo();
983 int64_t H = SR.getHi();
984 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
985
Devang Patel2c4ceb12009-11-21 02:48:08 +0000986 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patel6325a532009-08-14 20:59:16 +0000987 if (L)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000988 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Pateld55224c2009-12-04 23:10:24 +0000989 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling0310d762009-05-15 09:23:25 +0000990
Devang Patel2c4ceb12009-11-21 02:48:08 +0000991 Buffer.addChild(DW_Subrange);
Bill Wendling0310d762009-05-15 09:23:25 +0000992}
993
Devang Patel2c4ceb12009-11-21 02:48:08 +0000994/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +0000995void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling0310d762009-05-15 09:23:25 +0000996 DICompositeType *CTy) {
997 Buffer.setTag(dwarf::DW_TAG_array_type);
998 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000999 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001000
1001 // Emit derived type.
Devang Patel8a241142009-12-09 18:24:21 +00001002 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001003 DIArray Elements = CTy->getTypeArray();
1004
Devang Patel6f01d9c2009-11-21 00:31:03 +00001005 // Get an anonymous type for index type.
Devang Patel8a241142009-12-09 18:24:21 +00001006 DIE *IdxTy = ModuleCU->getIndexTyDie();
Devang Patel6f01d9c2009-11-21 00:31:03 +00001007 if (!IdxTy) {
1008 // Construct an anonymous type for index type.
1009 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001010 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1011 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel6f01d9c2009-11-21 00:31:03 +00001012 dwarf::DW_ATE_signed);
Devang Patel8a241142009-12-09 18:24:21 +00001013 ModuleCU->addDie(IdxTy);
1014 ModuleCU->setIndexTyDie(IdxTy);
Devang Patel6f01d9c2009-11-21 00:31:03 +00001015 }
Bill Wendling0310d762009-05-15 09:23:25 +00001016
1017 // Add subranges to array type.
1018 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1019 DIDescriptor Element = Elements.getElement(i);
1020 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001021 constructSubrangeDIE(Buffer, DISubrange(Element.getNode()), IdxTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001022 }
1023}
1024
Devang Patel2c4ceb12009-11-21 02:48:08 +00001025/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel8a241142009-12-09 18:24:21 +00001026DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator *ETy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001027 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel65dbc902009-11-25 17:36:49 +00001028 StringRef Name = ETy->getName();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001029 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001030 int64_t Value = ETy->getEnumValue();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001031 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling0310d762009-05-15 09:23:25 +00001032 return Enumerator;
1033}
1034
Devang Patel351ca332010-01-05 01:46:14 +00001035/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
1036/// printer to not emit usual symbol prefix before the symbol name is used then
1037/// return linkage name after skipping this special LLVM prefix.
1038static StringRef getRealLinkageName(StringRef LinkageName) {
1039 char One = '\1';
1040 if (LinkageName.startswith(StringRef(&One, 1)))
1041 return LinkageName.substr(1);
1042 return LinkageName;
1043}
1044
Devang Patel2c4ceb12009-11-21 02:48:08 +00001045/// createGlobalVariableDIE - Create new DIE using GV.
Devang Patel8a241142009-12-09 18:24:21 +00001046DIE *DwarfDebug::createGlobalVariableDIE(const DIGlobalVariable &GV) {
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001047 // If the global variable was optmized out then no need to create debug info
1048 // entry.
Devang Patel84c73e92009-11-06 17:58:12 +00001049 if (!GV.getGlobal()) return NULL;
Devang Patel65dbc902009-11-25 17:36:49 +00001050 if (GV.getDisplayName().empty()) return NULL;
Devang Patel465c3be2009-11-06 01:30:04 +00001051
Bill Wendling0310d762009-05-15 09:23:25 +00001052 DIE *GVDie = new DIE(dwarf::DW_TAG_variable);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001053 addString(GVDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001054 GV.getDisplayName());
1055
Devang Patel65dbc902009-11-25 17:36:49 +00001056 StringRef LinkageName = GV.getLinkageName();
Devang Patel351ca332010-01-05 01:46:14 +00001057 if (!LinkageName.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001058 addString(GVDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel351ca332010-01-05 01:46:14 +00001059 getRealLinkageName(LinkageName));
1060
Devang Patel8a241142009-12-09 18:24:21 +00001061 addType(GVDie, GV.getType());
Bill Wendling0310d762009-05-15 09:23:25 +00001062 if (!GV.isLocalToUnit())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001063 addUInt(GVDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1064 addSourceLine(GVDie, &GV);
Devang Patelb71a16d2009-10-05 23:22:08 +00001065
Bill Wendling0310d762009-05-15 09:23:25 +00001066 return GVDie;
1067}
1068
Devang Patel2c4ceb12009-11-21 02:48:08 +00001069/// createMemberDIE - Create new member DIE.
Devang Patel8a241142009-12-09 18:24:21 +00001070DIE *DwarfDebug::createMemberDIE(const DIDerivedType &DT) {
Bill Wendling0310d762009-05-15 09:23:25 +00001071 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel65dbc902009-11-25 17:36:49 +00001072 StringRef Name = DT.getName();
1073 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001074 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel65dbc902009-11-25 17:36:49 +00001075
Devang Patel8a241142009-12-09 18:24:21 +00001076 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001077
Devang Patel2c4ceb12009-11-21 02:48:08 +00001078 addSourceLine(MemberDie, &DT);
Bill Wendling0310d762009-05-15 09:23:25 +00001079
Devang Patel33db5082009-11-04 22:06:12 +00001080 DIEBlock *MemLocationDie = new DIEBlock();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001081 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel33db5082009-11-04 22:06:12 +00001082
Bill Wendling0310d762009-05-15 09:23:25 +00001083 uint64_t Size = DT.getSizeInBits();
Devang Patel61ecbd12009-11-04 23:48:00 +00001084 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling0310d762009-05-15 09:23:25 +00001085
1086 if (Size != FieldSize) {
1087 // Handle bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001088 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1089 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling0310d762009-05-15 09:23:25 +00001090
1091 uint64_t Offset = DT.getOffsetInBits();
Bill Wendling0310d762009-05-15 09:23:25 +00001092 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1093 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer3d594fd2010-01-07 17:50:57 +00001094 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendling0310d762009-05-15 09:23:25 +00001095 Offset -= FieldOffset;
1096
1097 // Maybe we need to work from the other end.
1098 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001099 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling0310d762009-05-15 09:23:25 +00001100
Devang Patel33db5082009-11-04 22:06:12 +00001101 // Here WD_AT_data_member_location points to the anonymous
1102 // field that includes this bit field.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001103 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001104
1105 } else
1106 // This is not a bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001107 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001108
Devang Patel2c4ceb12009-11-21 02:48:08 +00001109 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001110
1111 if (DT.isProtected())
Devang Patel5d11eb02009-12-03 19:11:07 +00001112 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001113 dwarf::DW_ACCESS_protected);
1114 else if (DT.isPrivate())
Devang Patel5d11eb02009-12-03 19:11:07 +00001115 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001116 dwarf::DW_ACCESS_private);
Devang Patel5d11eb02009-12-03 19:11:07 +00001117 else if (DT.getTag() == dwarf::DW_TAG_inheritance)
1118 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1119 dwarf::DW_ACCESS_public);
1120 if (DT.isVirtual())
1121 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1122 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling0310d762009-05-15 09:23:25 +00001123 return MemberDie;
1124}
1125
Devang Patelffe966c2009-12-14 16:18:45 +00001126/// createSubprogramDIE - Create new DIE using SP.
1127DIE *DwarfDebug::createSubprogramDIE(const DISubprogram &SP, bool MakeDecl) {
1128 DIE *SPDie = ModuleCU->getDIE(SP.getNode());
1129 if (SPDie)
1130 return SPDie;
1131
1132 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel65dbc902009-11-25 17:36:49 +00001133 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling0310d762009-05-15 09:23:25 +00001134
Devang Patel65dbc902009-11-25 17:36:49 +00001135 StringRef LinkageName = SP.getLinkageName();
Devang Patel351ca332010-01-05 01:46:14 +00001136 if (!LinkageName.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001137 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel351ca332010-01-05 01:46:14 +00001138 getRealLinkageName(LinkageName));
1139
Devang Patel2c4ceb12009-11-21 02:48:08 +00001140 addSourceLine(SPDie, &SP);
Bill Wendling0310d762009-05-15 09:23:25 +00001141
Bill Wendling0310d762009-05-15 09:23:25 +00001142 // Add prototyped tag, if C or ObjC.
1143 unsigned Lang = SP.getCompileUnit().getLanguage();
1144 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1145 Lang == dwarf::DW_LANG_ObjC)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001146 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001147
1148 // Add Return Type.
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001149 DICompositeType SPTy = SP.getType();
1150 DIArray Args = SPTy.getTypeArray();
Bill Wendling0310d762009-05-15 09:23:25 +00001151 unsigned SPTag = SPTy.getTag();
Devang Patel5d11eb02009-12-03 19:11:07 +00001152
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001153 if (Args.isNull() || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel8a241142009-12-09 18:24:21 +00001154 addType(SPDie, SPTy);
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001155 else
Devang Patel8a241142009-12-09 18:24:21 +00001156 addType(SPDie, DIType(Args.getElement(0).getNode()));
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001157
Devang Patel5d11eb02009-12-03 19:11:07 +00001158 unsigned VK = SP.getVirtuality();
1159 if (VK) {
1160 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
1161 DIEBlock *Block = new DIEBlock();
1162 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1163 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1164 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
1165 ContainingTypeMap.insert(std::make_pair(SPDie, WeakVH(SP.getContainingType().getNode())));
1166 }
1167
Devang Patelffe966c2009-12-14 16:18:45 +00001168 if (MakeDecl || !SP.isDefinition()) {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001169 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001170
1171 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001172 // be handled while processing variables.
1173 DICompositeType SPTy = SP.getType();
1174 DIArray Args = SPTy.getTypeArray();
1175 unsigned SPTag = SPTy.getTag();
1176
Bill Wendling0310d762009-05-15 09:23:25 +00001177 if (SPTag == dwarf::DW_TAG_subroutine_type)
1178 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1179 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel8a241142009-12-09 18:24:21 +00001180 addType(Arg, DIType(Args.getElement(i).getNode()));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001181 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1); // ??
1182 SPDie->addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001183 }
1184 }
1185
Bill Wendling0310d762009-05-15 09:23:25 +00001186 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel8a241142009-12-09 18:24:21 +00001187 ModuleCU->insertDIE(SP.getNode(), SPDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001188 return SPDie;
1189}
1190
Devang Patel2c4ceb12009-11-21 02:48:08 +00001191/// findCompileUnit - Get the compile unit for the given descriptor.
Bill Wendling0310d762009-05-15 09:23:25 +00001192///
Devang Pateld037d7a2009-12-11 21:37:07 +00001193CompileUnit *DwarfDebug::findCompileUnit(DICompileUnit Unit) {
Bill Wendling0310d762009-05-15 09:23:25 +00001194 DenseMap<Value *, CompileUnit *>::const_iterator I =
Devang Patele4b27562009-08-28 23:24:31 +00001195 CompileUnitMap.find(Unit.getNode());
Devang Pateld037d7a2009-12-11 21:37:07 +00001196 if (I == CompileUnitMap.end())
1197 return constructCompileUnit(Unit.getNode());
1198 return I->second;
Bill Wendling0310d762009-05-15 09:23:25 +00001199}
1200
Devang Patel53bb5c92009-11-10 23:06:00 +00001201/// getUpdatedDbgScope - Find or create DbgScope assicated with the instruction.
1202/// Initialize scope and update scope hierarchy.
1203DbgScope *DwarfDebug::getUpdatedDbgScope(MDNode *N, const MachineInstr *MI,
1204 MDNode *InlinedAt) {
1205 assert (N && "Invalid Scope encoding!");
1206 assert (MI && "Missing machine instruction!");
1207 bool GetConcreteScope = (MI && InlinedAt);
1208
1209 DbgScope *NScope = NULL;
1210
1211 if (InlinedAt)
1212 NScope = DbgScopeMap.lookup(InlinedAt);
1213 else
1214 NScope = DbgScopeMap.lookup(N);
1215 assert (NScope && "Unable to find working scope!");
1216
1217 if (NScope->getFirstInsn())
1218 return NScope;
Devang Patelaf9e8472009-10-01 20:31:14 +00001219
1220 DbgScope *Parent = NULL;
Devang Patel53bb5c92009-11-10 23:06:00 +00001221 if (GetConcreteScope) {
Devang Patelc90aefe2009-10-14 21:08:09 +00001222 DILocation IL(InlinedAt);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001223 Parent = getUpdatedDbgScope(IL.getScope().getNode(), MI,
Devang Patel53bb5c92009-11-10 23:06:00 +00001224 IL.getOrigLocation().getNode());
1225 assert (Parent && "Unable to find Parent scope!");
1226 NScope->setParent(Parent);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001227 Parent->addScope(NScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001228 } else if (DIDescriptor(N).isLexicalBlock()) {
1229 DILexicalBlock DB(N);
1230 if (!DB.getContext().isNull()) {
1231 Parent = getUpdatedDbgScope(DB.getContext().getNode(), MI, InlinedAt);
1232 NScope->setParent(Parent);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001233 Parent->addScope(NScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001234 }
Devang Patelc90aefe2009-10-14 21:08:09 +00001235 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001236
Devang Patelbdf45cb2009-10-27 20:47:17 +00001237 NScope->setFirstInsn(MI);
Devang Patelaf9e8472009-10-01 20:31:14 +00001238
Devang Patel53bb5c92009-11-10 23:06:00 +00001239 if (!Parent && !InlinedAt) {
Devang Patel39ae3ff2009-11-11 00:31:36 +00001240 StringRef SPName = DISubprogram(N).getLinkageName();
1241 if (SPName == MF->getFunction()->getName())
1242 CurrentFnDbgScope = NScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00001243 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001244
Devang Patel53bb5c92009-11-10 23:06:00 +00001245 if (GetConcreteScope) {
1246 ConcreteScopes[InlinedAt] = NScope;
1247 getOrCreateAbstractScope(N);
1248 }
1249
Devang Patelbdf45cb2009-10-27 20:47:17 +00001250 return NScope;
Devang Patelaf9e8472009-10-01 20:31:14 +00001251}
1252
Devang Patel53bb5c92009-11-10 23:06:00 +00001253DbgScope *DwarfDebug::getOrCreateAbstractScope(MDNode *N) {
1254 assert (N && "Invalid Scope encoding!");
1255
1256 DbgScope *AScope = AbstractScopes.lookup(N);
1257 if (AScope)
1258 return AScope;
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001259
Devang Patel53bb5c92009-11-10 23:06:00 +00001260 DbgScope *Parent = NULL;
1261
1262 DIDescriptor Scope(N);
1263 if (Scope.isLexicalBlock()) {
1264 DILexicalBlock DB(N);
1265 DIDescriptor ParentDesc = DB.getContext();
1266 if (!ParentDesc.isNull())
1267 Parent = getOrCreateAbstractScope(ParentDesc.getNode());
1268 }
1269
1270 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1271
1272 if (Parent)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001273 Parent->addScope(AScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001274 AScope->setAbstractScope();
1275 AbstractScopes[N] = AScope;
1276 if (DIDescriptor(N).isSubprogram())
1277 AbstractScopesList.push_back(AScope);
1278 return AScope;
1279}
Devang Patelaf9e8472009-10-01 20:31:14 +00001280
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001281/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel2c4ceb12009-11-21 02:48:08 +00001282/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1283/// If there are global variables in this scope then create and insert
1284/// DIEs for these variables.
1285DIE *DwarfDebug::updateSubprogramScopeDIE(MDNode *SPNode) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001286
Devang Patel017d1212009-11-20 21:37:22 +00001287 DIE *SPDie = ModuleCU->getDIE(SPNode);
Devang Patel53bb5c92009-11-10 23:06:00 +00001288 assert (SPDie && "Unable to find subprogram DIE!");
Devang Patelffe966c2009-12-14 16:18:45 +00001289 DISubprogram SP(SPNode);
1290 if (SP.isDefinition() && !SP.getContext().isCompileUnit()) {
1291 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1292 // Add arguments.
1293 DICompositeType SPTy = SP.getType();
1294 DIArray Args = SPTy.getTypeArray();
1295 unsigned SPTag = SPTy.getTag();
1296 if (SPTag == dwarf::DW_TAG_subroutine_type)
1297 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1298 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1299 addType(Arg, DIType(Args.getElement(i).getNode()));
1300 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1); // ??
1301 SPDie->addChild(Arg);
1302 }
1303 DIE *SPDeclDie = SPDie;
1304 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1305 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
1306 SPDeclDie);
Devang Patelffe966c2009-12-14 16:18:45 +00001307 ModuleCU->addDie(SPDie);
1308 }
1309
Devang Patel2c4ceb12009-11-21 02:48:08 +00001310 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Devang Patel53bb5c92009-11-10 23:06:00 +00001311 DWLabel("func_begin", SubprogramCount));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001312 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Devang Patel53bb5c92009-11-10 23:06:00 +00001313 DWLabel("func_end", SubprogramCount));
1314 MachineLocation Location(RI->getFrameRegister(*MF));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001315 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001316
Devang Patel53bb5c92009-11-10 23:06:00 +00001317 if (!DISubprogram(SPNode).isLocalToUnit())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001318 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patel53bb5c92009-11-10 23:06:00 +00001319
Devang Patel53bb5c92009-11-10 23:06:00 +00001320 return SPDie;
1321}
1322
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001323/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel2c4ceb12009-11-21 02:48:08 +00001324/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1325DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001326 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1327 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1328
1329 // Ignore empty scopes.
1330 if (StartID == EndID && StartID != 0)
1331 return NULL;
1332
1333 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1334 if (Scope->isAbstractScope())
1335 return ScopeDIE;
1336
Devang Patel2c4ceb12009-11-21 02:48:08 +00001337 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001338 StartID ?
1339 DWLabel("label", StartID)
Devang Patel53bb5c92009-11-10 23:06:00 +00001340 : DWLabel("func_begin", SubprogramCount));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001341 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001342 EndID ?
1343 DWLabel("label", EndID)
Devang Patel53bb5c92009-11-10 23:06:00 +00001344 : DWLabel("func_end", SubprogramCount));
1345
1346
1347
1348 return ScopeDIE;
1349}
1350
Devang Patel2c4ceb12009-11-21 02:48:08 +00001351/// constructInlinedScopeDIE - This scope represents inlined body of
1352/// a function. Construct DIE to represent this concrete inlined copy
1353/// of the function.
1354DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001355 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1356 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1357 assert (StartID && "Invalid starting label for an inlined scope!");
1358 assert (EndID && "Invalid end label for an inlined scope!");
1359 // Ignore empty scopes.
1360 if (StartID == EndID && StartID != 0)
1361 return NULL;
1362
1363 DIScope DS(Scope->getScopeNode());
1364 if (DS.isNull())
1365 return NULL;
1366 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1367
1368 DISubprogram InlinedSP = getDISubprogram(DS.getNode());
Devang Patel017d1212009-11-20 21:37:22 +00001369 DIE *OriginDIE = ModuleCU->getDIE(InlinedSP.getNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00001370 assert (OriginDIE && "Unable to find Origin DIE!");
Devang Patel2c4ceb12009-11-21 02:48:08 +00001371 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001372 dwarf::DW_FORM_ref4, OriginDIE);
1373
Devang Patel2c4ceb12009-11-21 02:48:08 +00001374 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Devang Patel53bb5c92009-11-10 23:06:00 +00001375 DWLabel("label", StartID));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001376 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Devang Patel53bb5c92009-11-10 23:06:00 +00001377 DWLabel("label", EndID));
1378
1379 InlinedSubprogramDIEs.insert(OriginDIE);
1380
1381 // Track the start label for this inlined function.
1382 ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
1383 I = InlineInfo.find(InlinedSP.getNode());
1384
1385 if (I == InlineInfo.end()) {
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001386 InlineInfo[InlinedSP.getNode()].push_back(std::make_pair(StartID,
1387 ScopeDIE));
Devang Patel53bb5c92009-11-10 23:06:00 +00001388 InlinedSPNodes.push_back(InlinedSP.getNode());
1389 } else
1390 I->second.push_back(std::make_pair(StartID, ScopeDIE));
1391
1392 StringPool.insert(InlinedSP.getName());
Devang Patel351ca332010-01-05 01:46:14 +00001393 StringPool.insert(getRealLinkageName(InlinedSP.getLinkageName()));
1394
Devang Patel53bb5c92009-11-10 23:06:00 +00001395 DILocation DL(Scope->getInlinedAt());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001396 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, ModuleCU->getID());
1397 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +00001398
1399 return ScopeDIE;
1400}
1401
Devang Patel2c4ceb12009-11-21 02:48:08 +00001402
1403/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel8a241142009-12-09 18:24:21 +00001404DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001405 // Get the descriptor.
1406 const DIVariable &VD = DV->getVariable();
Devang Patel65dbc902009-11-25 17:36:49 +00001407 StringRef Name = VD.getName();
1408 if (Name.empty())
Devang Patel3fb6bd62009-11-13 02:25:26 +00001409 return NULL;
Devang Patel53bb5c92009-11-10 23:06:00 +00001410
1411 // Translate tag to proper Dwarf tag. The result variable is dropped for
1412 // now.
1413 unsigned Tag;
1414 switch (VD.getTag()) {
1415 case dwarf::DW_TAG_return_variable:
1416 return NULL;
1417 case dwarf::DW_TAG_arg_variable:
1418 Tag = dwarf::DW_TAG_formal_parameter;
1419 break;
1420 case dwarf::DW_TAG_auto_variable: // fall thru
1421 default:
1422 Tag = dwarf::DW_TAG_variable;
1423 break;
1424 }
1425
1426 // Define variable debug information entry.
1427 DIE *VariableDie = new DIE(Tag);
1428
1429
1430 DIE *AbsDIE = NULL;
1431 if (DbgVariable *AV = DV->getAbstractVariable())
1432 AbsDIE = AV->getDIE();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001433
Devang Patel53bb5c92009-11-10 23:06:00 +00001434 if (AbsDIE) {
1435 DIScope DS(Scope->getScopeNode());
1436 DISubprogram InlinedSP = getDISubprogram(DS.getNode());
Devang Patel017d1212009-11-20 21:37:22 +00001437 DIE *OriginSPDIE = ModuleCU->getDIE(InlinedSP.getNode());
Daniel Dunbarc0326792009-11-11 03:09:50 +00001438 (void) OriginSPDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +00001439 assert (OriginSPDIE && "Unable to find Origin DIE for the SP!");
1440 DIE *AbsDIE = DV->getAbstractVariable()->getDIE();
1441 assert (AbsDIE && "Unable to find Origin DIE for the Variable!");
Devang Patel2c4ceb12009-11-21 02:48:08 +00001442 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001443 dwarf::DW_FORM_ref4, AbsDIE);
1444 }
1445 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001446 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
1447 addSourceLine(VariableDie, &VD);
Devang Patel53bb5c92009-11-10 23:06:00 +00001448
1449 // Add variable type.
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001450 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
Devang Patel53bb5c92009-11-10 23:06:00 +00001451 // addresses instead.
1452 if (VD.isBlockByrefVariable())
Devang Patel8a241142009-12-09 18:24:21 +00001453 addType(VariableDie, getBlockByrefType(VD.getType(), Name));
Devang Patel53bb5c92009-11-10 23:06:00 +00001454 else
Devang Patel8a241142009-12-09 18:24:21 +00001455 addType(VariableDie, VD.getType());
Devang Patel53bb5c92009-11-10 23:06:00 +00001456 }
1457
1458 // Add variable address.
1459 if (!Scope->isAbstractScope()) {
1460 MachineLocation Location;
Jim Grosbacha2f20b22009-11-22 20:14:00 +00001461 unsigned FrameReg;
1462 int Offset = RI->getFrameIndexReference(*MF, DV->getFrameIndex(), FrameReg);
1463 Location.set(FrameReg, Offset);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001464
Devang Patel53bb5c92009-11-10 23:06:00 +00001465 if (VD.hasComplexAddress())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001466 addComplexAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
Devang Patel53bb5c92009-11-10 23:06:00 +00001467 else if (VD.isBlockByrefVariable())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001468 addBlockByrefAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
Devang Patel53bb5c92009-11-10 23:06:00 +00001469 else
Devang Patel2c4ceb12009-11-21 02:48:08 +00001470 addAddress(VariableDie, dwarf::DW_AT_location, Location);
Devang Patel53bb5c92009-11-10 23:06:00 +00001471 }
1472 DV->setDIE(VariableDie);
1473 return VariableDie;
1474
1475}
Devang Patel2c4ceb12009-11-21 02:48:08 +00001476
Devang Patel193f7202009-11-24 01:14:22 +00001477void DwarfDebug::addPubTypes(DISubprogram SP) {
1478 DICompositeType SPTy = SP.getType();
1479 unsigned SPTag = SPTy.getTag();
1480 if (SPTag != dwarf::DW_TAG_subroutine_type)
1481 return;
1482
1483 DIArray Args = SPTy.getTypeArray();
1484 if (Args.isNull())
1485 return;
1486
1487 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
1488 DIType ATy(Args.getElement(i).getNode());
1489 if (ATy.isNull())
1490 continue;
1491 DICompositeType CATy = getDICompositeType(ATy);
Devang Patel65dbc902009-11-25 17:36:49 +00001492 if (!CATy.isNull() && !CATy.getName().empty()) {
Devang Patel193f7202009-11-24 01:14:22 +00001493 if (DIEEntry *Entry = ModuleCU->getDIEEntry(CATy.getNode()))
1494 ModuleCU->addGlobalType(CATy.getName(), Entry->getEntry());
1495 }
1496 }
1497}
1498
Devang Patel2c4ceb12009-11-21 02:48:08 +00001499/// constructScopeDIE - Construct a DIE for this scope.
1500DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001501 if (!Scope)
1502 return NULL;
1503 DIScope DS(Scope->getScopeNode());
1504 if (DS.isNull())
1505 return NULL;
1506
1507 DIE *ScopeDIE = NULL;
1508 if (Scope->getInlinedAt())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001509 ScopeDIE = constructInlinedScopeDIE(Scope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001510 else if (DS.isSubprogram()) {
1511 if (Scope->isAbstractScope())
Devang Patel017d1212009-11-20 21:37:22 +00001512 ScopeDIE = ModuleCU->getDIE(DS.getNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00001513 else
Devang Patel2c4ceb12009-11-21 02:48:08 +00001514 ScopeDIE = updateSubprogramScopeDIE(DS.getNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00001515 }
1516 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001517 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001518 if (!ScopeDIE) return NULL;
1519 }
1520
1521 // Add variables to scope.
1522 SmallVector<DbgVariable *, 8> &Variables = Scope->getVariables();
1523 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel8a241142009-12-09 18:24:21 +00001524 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001525 if (VariableDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001526 ScopeDIE->addChild(VariableDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001527 }
1528
1529 // Add nested scopes.
1530 SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
1531 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1532 // Define the Scope debug information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001533 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001534 if (NestedDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001535 ScopeDIE->addChild(NestedDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001536 }
Devang Patel193f7202009-11-24 01:14:22 +00001537
1538 if (DS.isSubprogram())
1539 addPubTypes(DISubprogram(DS.getNode()));
1540
1541 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +00001542}
1543
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001544/// GetOrCreateSourceID - Look up the source id with the given directory and
1545/// source file names. If none currently exists, create a new id and insert it
1546/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1547/// maps as well.
Devang Patel65dbc902009-11-25 17:36:49 +00001548unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001549 unsigned DId;
1550 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1551 if (DI != DirectoryIdMap.end()) {
1552 DId = DI->getValue();
1553 } else {
1554 DId = DirectoryNames.size() + 1;
1555 DirectoryIdMap[DirName] = DId;
1556 DirectoryNames.push_back(DirName);
1557 }
1558
1559 unsigned FId;
1560 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1561 if (FI != SourceFileIdMap.end()) {
1562 FId = FI->getValue();
1563 } else {
1564 FId = SourceFileNames.size() + 1;
1565 SourceFileIdMap[FileName] = FId;
1566 SourceFileNames.push_back(FileName);
1567 }
1568
1569 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1570 SourceIdMap.find(std::make_pair(DId, FId));
1571 if (SI != SourceIdMap.end())
1572 return SI->second;
1573
1574 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1575 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1576 SourceIds.push_back(std::make_pair(DId, FId));
1577
1578 return SrcId;
1579}
1580
Devang Patel6404e4e2009-12-15 19:16:48 +00001581/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1582DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
1583 DIE *NDie = ModuleCU->getDIE(NS.getNode());
1584 if (NDie)
1585 return NDie;
1586 NDie = new DIE(dwarf::DW_TAG_namespace);
1587 ModuleCU->insertDIE(NS.getNode(), NDie);
1588 if (!NS.getName().empty())
1589 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
1590 addSourceLine(NDie, &NS);
1591 addToContextOwner(NDie, NS.getContext());
1592 return NDie;
1593}
1594
Devang Pateld037d7a2009-12-11 21:37:07 +00001595CompileUnit *DwarfDebug::constructCompileUnit(MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001596 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +00001597 StringRef FN = DIUnit.getFilename();
1598 StringRef Dir = DIUnit.getDirectory();
Devang Patel5ccdd102009-09-29 18:40:58 +00001599 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001600
1601 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001602 addSectionOffset(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001603 DWLabel("section_line", 0), DWLabel("section_line", 0),
1604 false);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001605 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001606 DIUnit.getProducer());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001607 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001608 DIUnit.getLanguage());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001609 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001610
Devang Patel65dbc902009-11-25 17:36:49 +00001611 if (!Dir.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001612 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001613 if (DIUnit.isOptimized())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001614 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001615
Devang Patel65dbc902009-11-25 17:36:49 +00001616 StringRef Flags = DIUnit.getFlags();
1617 if (!Flags.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001618 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001619
1620 unsigned RVer = DIUnit.getRunTimeVersion();
1621 if (RVer)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001622 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001623 dwarf::DW_FORM_data1, RVer);
1624
1625 CompileUnit *Unit = new CompileUnit(ID, Die);
Devang Patel1dbc7712009-06-29 20:45:18 +00001626 if (!ModuleCU && DIUnit.isMain()) {
Devang Patel70f44262009-06-29 20:38:13 +00001627 // Use first compile unit marked as isMain as the compile unit
1628 // for this module.
Devang Patel1dbc7712009-06-29 20:45:18 +00001629 ModuleCU = Unit;
Devang Patel70f44262009-06-29 20:38:13 +00001630 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001631
Devang Patele4b27562009-08-28 23:24:31 +00001632 CompileUnitMap[DIUnit.getNode()] = Unit;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001633 CompileUnits.push_back(Unit);
Devang Pateld037d7a2009-12-11 21:37:07 +00001634 return Unit;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001635}
1636
Devang Patel2c4ceb12009-11-21 02:48:08 +00001637void DwarfDebug::constructGlobalVariableDIE(MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001638 DIGlobalVariable DI_GV(N);
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001639
Devang Patel905cf5e2009-09-04 23:59:07 +00001640 // If debug information is malformed then ignore it.
1641 if (DI_GV.Verify() == false)
1642 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001643
1644 // Check for pre-existence.
Devang Patel017d1212009-11-20 21:37:22 +00001645 if (ModuleCU->getDIE(DI_GV.getNode()))
Devang Patel13e16b62009-06-26 01:49:18 +00001646 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001647
Devang Patel8a241142009-12-09 18:24:21 +00001648 DIE *VariableDie = createGlobalVariableDIE(DI_GV);
Devang Pateledb45632009-12-10 23:25:41 +00001649 if (!VariableDie)
1650 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001651
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001652 // Add to map.
Devang Patel017d1212009-11-20 21:37:22 +00001653 ModuleCU->insertDIE(N, VariableDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001654
1655 // Add to context owner.
Devang Patelc9b16cc2010-01-15 01:12:22 +00001656 DIDescriptor GVContext = DI_GV.getContext();
1657 // Do not create specification DIE if context is either compile unit
1658 // or a subprogram.
1659 if (DI_GV.isDefinition() && !GVContext.isCompileUnit()
1660 && !GVContext.isSubprogram()) {
Devang Patel6404e4e2009-12-15 19:16:48 +00001661 // Create specification DIE.
1662 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1663 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1664 dwarf::DW_FORM_ref4, VariableDie);
1665 DIEBlock *Block = new DIEBlock();
1666 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1667 addObjectLabel(Block, 0, dwarf::DW_FORM_udata,
Chris Lattner858431d2010-01-16 18:50:28 +00001668 Asm->GetGlobalValueSymbol(DI_GV.getGlobal()));
Devang Patel6404e4e2009-12-15 19:16:48 +00001669 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1670 ModuleCU->addDie(VariableSpecDIE);
1671 } else {
1672 DIEBlock *Block = new DIEBlock();
1673 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1674 addObjectLabel(Block, 0, dwarf::DW_FORM_udata,
Chris Lattner858431d2010-01-16 18:50:28 +00001675 Asm->GetGlobalValueSymbol(DI_GV.getGlobal()));
Devang Patel6404e4e2009-12-15 19:16:48 +00001676 addBlock(VariableDie, dwarf::DW_AT_location, 0, Block);
1677 }
Devang Patelc9b16cc2010-01-15 01:12:22 +00001678 addToContextOwner(VariableDie, GVContext);
Devang Patelc366f832009-12-10 19:14:49 +00001679
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001680 // Expose as global. FIXME - need to check external flag.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001681 ModuleCU->addGlobal(DI_GV.getName(), VariableDie);
Devang Patel193f7202009-11-24 01:14:22 +00001682
1683 DIType GTy = DI_GV.getType();
Devang Patel65dbc902009-11-25 17:36:49 +00001684 if (GTy.isCompositeType() && !GTy.getName().empty()) {
Devang Patel193f7202009-11-24 01:14:22 +00001685 DIEEntry *Entry = ModuleCU->getDIEEntry(GTy.getNode());
1686 assert (Entry && "Missing global type!");
1687 ModuleCU->addGlobalType(GTy.getName(), Entry->getEntry());
1688 }
Devang Patel13e16b62009-06-26 01:49:18 +00001689 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001690}
1691
Devang Patel2c4ceb12009-11-21 02:48:08 +00001692void DwarfDebug::constructSubprogramDIE(MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001693 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001694
1695 // Check for pre-existence.
Devang Patel017d1212009-11-20 21:37:22 +00001696 if (ModuleCU->getDIE(N))
Devang Patel13e16b62009-06-26 01:49:18 +00001697 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001698
1699 if (!SP.isDefinition())
1700 // This is a method declaration which will be handled while constructing
1701 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +00001702 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001703
Devang Patel8a241142009-12-09 18:24:21 +00001704 DIE *SubprogramDie = createSubprogramDIE(SP);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001705
1706 // Add to map.
Devang Patel017d1212009-11-20 21:37:22 +00001707 ModuleCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001708
1709 // Add to context owner.
Devang Patel6404e4e2009-12-15 19:16:48 +00001710 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +00001711
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001712 // Expose as global.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001713 ModuleCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel193f7202009-11-24 01:14:22 +00001714
Devang Patel13e16b62009-06-26 01:49:18 +00001715 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001716}
1717
Devang Patel2c4ceb12009-11-21 02:48:08 +00001718/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbar00564992009-09-19 20:40:14 +00001719/// content. Create global DIEs and emit initial debug info sections.
1720/// This is inovked by the target AsmPrinter.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001721void DwarfDebug::beginModule(Module *M, MachineModuleInfo *mmi) {
Devang Patel208622d2009-06-25 22:36:02 +00001722 this->M = M;
1723
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001724 if (TimePassesIsEnabled)
1725 DebugTimer->startTimer();
1726
Devang Patel3380cc52009-11-11 19:55:08 +00001727 if (!MAI->doesSupportDebugInformation())
1728 return;
1729
Devang Patel78ab9e22009-07-30 18:56:46 +00001730 DebugInfoFinder DbgFinder;
1731 DbgFinder.processModule(*M);
Devang Patel13e16b62009-06-26 01:49:18 +00001732
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001733 // Create all the compile unit DIEs.
Devang Patel78ab9e22009-07-30 18:56:46 +00001734 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1735 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001736 constructCompileUnit(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001737
1738 if (CompileUnits.empty()) {
1739 if (TimePassesIsEnabled)
1740 DebugTimer->stopTimer();
1741
1742 return;
1743 }
1744
Devang Patel70f44262009-06-29 20:38:13 +00001745 // If main compile unit for this module is not seen than randomly
1746 // select first compile unit.
Devang Patel1dbc7712009-06-29 20:45:18 +00001747 if (!ModuleCU)
1748 ModuleCU = CompileUnits[0];
Devang Patel70f44262009-06-29 20:38:13 +00001749
Devang Patel53bb5c92009-11-10 23:06:00 +00001750 // Create DIEs for each subprogram.
Devang Patel78ab9e22009-07-30 18:56:46 +00001751 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
1752 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001753 constructSubprogramDIE(*I);
Devang Patel13e16b62009-06-26 01:49:18 +00001754
Devang Patelc366f832009-12-10 19:14:49 +00001755 // Create DIEs for each global variable.
1756 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
1757 E = DbgFinder.global_variable_end(); I != E; ++I)
1758 constructGlobalVariableDIE(*I);
1759
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001760 MMI = mmi;
1761 shouldEmit = true;
1762 MMI->setDebugInfoAvailability(true);
1763
1764 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +00001765 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001766
1767 // Print out .file directives to specify files for .loc directives. These are
1768 // printed out early so that they precede any .loc directives.
Chris Lattner33adcfb2009-08-22 21:43:10 +00001769 if (MAI->hasDotLocAndDotFile()) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001770 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
1771 // Remember source id starts at 1.
1772 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
1773 sys::Path FullPath(getSourceDirectoryName(Id.first));
1774 bool AppendOk =
1775 FullPath.appendComponent(getSourceFileName(Id.second));
1776 assert(AppendOk && "Could not append filename to directory!");
1777 AppendOk = false;
Chris Lattner74382b72009-08-23 22:45:37 +00001778 Asm->EmitFile(i, FullPath.str());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001779 Asm->EOL();
1780 }
1781 }
1782
1783 // Emit initial sections
Devang Patel2c4ceb12009-11-21 02:48:08 +00001784 emitInitial();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001785
1786 if (TimePassesIsEnabled)
1787 DebugTimer->stopTimer();
1788}
1789
Devang Patel2c4ceb12009-11-21 02:48:08 +00001790/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001791///
Devang Patel2c4ceb12009-11-21 02:48:08 +00001792void DwarfDebug::endModule() {
Devang Patel6f3dc922009-10-06 00:03:14 +00001793 if (!ModuleCU)
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001794 return;
1795
1796 if (TimePassesIsEnabled)
1797 DebugTimer->startTimer();
1798
Devang Patel53bb5c92009-11-10 23:06:00 +00001799 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1800 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
1801 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
1802 DIE *ISP = *AI;
Devang Patel2c4ceb12009-11-21 02:48:08 +00001803 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +00001804 }
1805
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001806 // Insert top level DIEs.
1807 for (SmallVector<DIE *, 4>::iterator TI = TopLevelDIEsVector.begin(),
1808 TE = TopLevelDIEsVector.end(); TI != TE; ++TI)
1809 ModuleCU->getCUDie()->addChild(*TI);
1810
Devang Patel5d11eb02009-12-03 19:11:07 +00001811 for (DenseMap<DIE *, WeakVH>::iterator CI = ContainingTypeMap.begin(),
1812 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
1813 DIE *SPDie = CI->first;
1814 MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
1815 if (!N) continue;
1816 DIE *NDie = ModuleCU->getDIE(N);
1817 if (!NDie) continue;
1818 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patelf8b72ca2010-01-15 00:26:31 +00001819 // FIXME - This is not the correct approach.
1820 // addDIEEntry(NDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patel5d11eb02009-12-03 19:11:07 +00001821 }
1822
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001823 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001824 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001825 EmitLabel("text_end", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001826 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001827 EmitLabel("data_end", 0);
1828
1829 // End text sections.
1830 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001831 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001832 EmitLabel("section_end", i);
1833 }
1834
1835 // Emit common frame information.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001836 emitCommonDebugFrame();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001837
1838 // Emit function debug frame information
1839 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
1840 E = DebugFrames.end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001841 emitFunctionDebugFrame(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001842
1843 // Compute DIE offsets and sizes.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001844 computeSizeAndOffsets();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001845
1846 // Emit all the DIEs into a debug info section
Devang Patel2c4ceb12009-11-21 02:48:08 +00001847 emitDebugInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001848
1849 // Corresponding abbreviations into a abbrev section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001850 emitAbbreviations();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001851
1852 // Emit source line correspondence into a debug line section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001853 emitDebugLines();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001854
1855 // Emit info into a debug pubnames section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001856 emitDebugPubNames();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001857
Devang Patel193f7202009-11-24 01:14:22 +00001858 // Emit info into a debug pubtypes section.
1859 emitDebugPubTypes();
1860
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001861 // Emit info into a debug str section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001862 emitDebugStr();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001863
1864 // Emit info into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001865 emitDebugLoc();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001866
1867 // Emit info into a debug aranges section.
1868 EmitDebugARanges();
1869
1870 // Emit info into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001871 emitDebugRanges();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001872
1873 // Emit info into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001874 emitDebugMacInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001875
1876 // Emit inline info.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001877 emitDebugInlineInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001878
1879 if (TimePassesIsEnabled)
1880 DebugTimer->stopTimer();
1881}
1882
Devang Patel53bb5c92009-11-10 23:06:00 +00001883/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001884DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
1885 unsigned FrameIdx,
Devang Patel53bb5c92009-11-10 23:06:00 +00001886 DILocation &ScopeLoc) {
1887
1888 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var.getNode());
1889 if (AbsDbgVariable)
1890 return AbsDbgVariable;
1891
1892 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope().getNode());
1893 if (!Scope)
1894 return NULL;
1895
1896 AbsDbgVariable = new DbgVariable(Var, FrameIdx);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001897 Scope->addVariable(AbsDbgVariable);
Devang Patel53bb5c92009-11-10 23:06:00 +00001898 AbstractVariables[Var.getNode()] = AbsDbgVariable;
1899 return AbsDbgVariable;
1900}
1901
Devang Patel2c4ceb12009-11-21 02:48:08 +00001902/// collectVariableInfo - Populate DbgScope entries with variables' info.
1903void DwarfDebug::collectVariableInfo() {
Devang Patelac1ceb32009-10-09 22:42:28 +00001904 if (!MMI) return;
Devang Patel53bb5c92009-11-10 23:06:00 +00001905
Devang Patele717faa2009-10-06 01:26:37 +00001906 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1907 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1908 VE = VMap.end(); VI != VE; ++VI) {
Devang Patelac1ceb32009-10-09 22:42:28 +00001909 MetadataBase *MB = VI->first;
1910 MDNode *Var = dyn_cast_or_null<MDNode>(MB);
Devang Patel53bb5c92009-11-10 23:06:00 +00001911 if (!Var) continue;
Devang Pateleda31212009-10-08 18:48:03 +00001912 DIVariable DV (Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00001913 std::pair< unsigned, MDNode *> VP = VI->second;
1914 DILocation ScopeLoc(VP.second);
1915
1916 DbgScope *Scope =
1917 ConcreteScopes.lookup(ScopeLoc.getOrigLocation().getNode());
1918 if (!Scope)
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001919 Scope = DbgScopeMap.lookup(ScopeLoc.getScope().getNode());
Devang Patelfb0ee432009-11-10 23:20:04 +00001920 // If variable scope is not found then skip this variable.
1921 if (!Scope)
1922 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00001923
1924 DbgVariable *RegVar = new DbgVariable(DV, VP.first);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001925 Scope->addVariable(RegVar);
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001926 if (DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.first,
1927 ScopeLoc))
Devang Patel53bb5c92009-11-10 23:06:00 +00001928 RegVar->setAbstractVariable(AbsDbgVariable);
Devang Patele717faa2009-10-06 01:26:37 +00001929 }
1930}
1931
Devang Patel2c4ceb12009-11-21 02:48:08 +00001932/// beginScope - Process beginning of a scope starting at Label.
1933void DwarfDebug::beginScope(const MachineInstr *MI, unsigned Label) {
Devang Patel0d20ac82009-10-06 01:50:42 +00001934 InsnToDbgScopeMapTy::iterator I = DbgScopeBeginMap.find(MI);
1935 if (I == DbgScopeBeginMap.end())
1936 return;
Dan Gohman277207e2009-11-23 21:30:55 +00001937 ScopeVector &SD = I->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00001938 for (ScopeVector::iterator SDI = SD.begin(), SDE = SD.end();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001939 SDI != SDE; ++SDI)
Devang Patel0d20ac82009-10-06 01:50:42 +00001940 (*SDI)->setStartLabelID(Label);
1941}
1942
Devang Patel2c4ceb12009-11-21 02:48:08 +00001943/// endScope - Process end of a scope.
1944void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel0d20ac82009-10-06 01:50:42 +00001945 InsnToDbgScopeMapTy::iterator I = DbgScopeEndMap.find(MI);
Devang Patel8a4087d2009-10-06 03:15:38 +00001946 if (I == DbgScopeEndMap.end())
Devang Patel0d20ac82009-10-06 01:50:42 +00001947 return;
Devang Patel53bb5c92009-11-10 23:06:00 +00001948
1949 unsigned Label = MMI->NextLabelID();
1950 Asm->printLabel(Label);
Dan Gohmaneecb9912009-12-05 01:42:34 +00001951 O << '\n';
Devang Patel53bb5c92009-11-10 23:06:00 +00001952
Devang Patel0d20ac82009-10-06 01:50:42 +00001953 SmallVector<DbgScope *, 2> &SD = I->second;
1954 for (SmallVector<DbgScope *, 2>::iterator SDI = SD.begin(), SDE = SD.end();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001955 SDI != SDE; ++SDI)
Devang Patel0d20ac82009-10-06 01:50:42 +00001956 (*SDI)->setEndLabelID(Label);
Devang Patel53bb5c92009-11-10 23:06:00 +00001957 return;
1958}
1959
1960/// createDbgScope - Create DbgScope for the scope.
1961void DwarfDebug::createDbgScope(MDNode *Scope, MDNode *InlinedAt) {
1962
1963 if (!InlinedAt) {
1964 DbgScope *WScope = DbgScopeMap.lookup(Scope);
1965 if (WScope)
1966 return;
1967 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
1968 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001969 if (DIDescriptor(Scope).isLexicalBlock())
Devang Patel2f105c62009-11-11 00:18:40 +00001970 createDbgScope(DILexicalBlock(Scope).getContext().getNode(), NULL);
Devang Patel53bb5c92009-11-10 23:06:00 +00001971 return;
1972 }
1973
1974 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
1975 if (WScope)
1976 return;
1977
1978 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
1979 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
1980 DILocation DL(InlinedAt);
1981 createDbgScope(DL.getScope().getNode(), DL.getOrigLocation().getNode());
Devang Patel0d20ac82009-10-06 01:50:42 +00001982}
1983
Devang Patel2c4ceb12009-11-21 02:48:08 +00001984/// extractScopeInformation - Scan machine instructions in this function
Devang Patelaf9e8472009-10-01 20:31:14 +00001985/// and collect DbgScopes. Return true, if atleast one scope was found.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001986bool DwarfDebug::extractScopeInformation(MachineFunction *MF) {
Devang Patelaf9e8472009-10-01 20:31:14 +00001987 // If scope information was extracted using .dbg intrinsics then there is not
1988 // any need to extract these information by scanning each instruction.
1989 if (!DbgScopeMap.empty())
1990 return false;
1991
Devang Patel344130e2010-01-04 20:44:00 +00001992 DenseMap<const MachineInstr *, unsigned> MIIndexMap;
1993 unsigned MIIndex = 0;
Devang Patel53bb5c92009-11-10 23:06:00 +00001994 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patelaf9e8472009-10-01 20:31:14 +00001995 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
1996 I != E; ++I) {
1997 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1998 II != IE; ++II) {
1999 const MachineInstr *MInsn = II;
Devang Patel344130e2010-01-04 20:44:00 +00002000 MIIndexMap[MInsn] = MIIndex++;
Devang Patelaf9e8472009-10-01 20:31:14 +00002001 DebugLoc DL = MInsn->getDebugLoc();
Devang Patel53bb5c92009-11-10 23:06:00 +00002002 if (DL.isUnknown()) continue;
Devang Patel6b61f582010-01-16 06:09:35 +00002003 DILocation DLT = MF->getDILocation(DL);
2004 DIScope DLTScope = DLT.getScope();
2005 if (DLTScope.isNull()) continue;
Devang Patelaf9e8472009-10-01 20:31:14 +00002006 // There is no need to create another DIE for compile unit. For all
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002007 // other scopes, create one DbgScope now. This will be translated
Devang Patelaf9e8472009-10-01 20:31:14 +00002008 // into a scope DIE at the end.
Devang Patel6b61f582010-01-16 06:09:35 +00002009 if (DLTScope.isCompileUnit()) continue;
2010 createDbgScope(DLTScope.getNode(), DLT.getOrigLocation().getNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00002011 }
2012 }
2013
2014
2015 // Build scope hierarchy using working set of scopes.
2016 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2017 I != E; ++I) {
2018 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2019 II != IE; ++II) {
2020 const MachineInstr *MInsn = II;
2021 DebugLoc DL = MInsn->getDebugLoc();
2022 if (DL.isUnknown()) continue;
Devang Patel6b61f582010-01-16 06:09:35 +00002023 DILocation DLT = MF->getDILocation(DL);
2024 DIScope DLTScope = DLT.getScope();
2025 if (DLTScope.isNull()) continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00002026 // There is no need to create another DIE for compile unit. For all
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002027 // other scopes, create one DbgScope now. This will be translated
Devang Patel53bb5c92009-11-10 23:06:00 +00002028 // into a scope DIE at the end.
Devang Patel6b61f582010-01-16 06:09:35 +00002029 if (DLTScope.isCompileUnit()) continue;
2030 DbgScope *Scope = getUpdatedDbgScope(DLTScope.getNode(), MInsn,
2031 DLT.getOrigLocation().getNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00002032 Scope->setLastInsn(MInsn);
Devang Patelaf9e8472009-10-01 20:31:14 +00002033 }
2034 }
2035
Devang Patel344130e2010-01-04 20:44:00 +00002036 if (!CurrentFnDbgScope)
2037 return false;
2038
2039 CurrentFnDbgScope->fixInstructionMarkers(MIIndexMap);
Devang Patelaf9e8472009-10-01 20:31:14 +00002040
2041 // Each scope has first instruction and last instruction to mark beginning
2042 // and end of a scope respectively. Create an inverse map that list scopes
2043 // starts (and ends) with an instruction. One instruction may start (or end)
2044 // multiple scopes.
Devang Patelbdf45cb2009-10-27 20:47:17 +00002045 for (ValueMap<MDNode *, DbgScope *>::iterator DI = DbgScopeMap.begin(),
Devang Patelaf9e8472009-10-01 20:31:14 +00002046 DE = DbgScopeMap.end(); DI != DE; ++DI) {
2047 DbgScope *S = DI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00002048 if (S->isAbstractScope())
2049 continue;
Devang Patelaf9e8472009-10-01 20:31:14 +00002050 const MachineInstr *MI = S->getFirstInsn();
2051 assert (MI && "DbgScope does not have first instruction!");
2052
2053 InsnToDbgScopeMapTy::iterator IDI = DbgScopeBeginMap.find(MI);
2054 if (IDI != DbgScopeBeginMap.end())
2055 IDI->second.push_back(S);
2056 else
Devang Patel53bb5c92009-11-10 23:06:00 +00002057 DbgScopeBeginMap[MI].push_back(S);
Devang Patelaf9e8472009-10-01 20:31:14 +00002058
2059 MI = S->getLastInsn();
2060 assert (MI && "DbgScope does not have last instruction!");
2061 IDI = DbgScopeEndMap.find(MI);
2062 if (IDI != DbgScopeEndMap.end())
2063 IDI->second.push_back(S);
2064 else
Devang Patel53bb5c92009-11-10 23:06:00 +00002065 DbgScopeEndMap[MI].push_back(S);
Devang Patelaf9e8472009-10-01 20:31:14 +00002066 }
2067
2068 return !DbgScopeMap.empty();
2069}
2070
Devang Patel2c4ceb12009-11-21 02:48:08 +00002071/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002072/// emitted immediately after the function entry point.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002073void DwarfDebug::beginFunction(MachineFunction *MF) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002074 this->MF = MF;
2075
2076 if (!ShouldEmitDwarfDebug()) return;
2077
2078 if (TimePassesIsEnabled)
2079 DebugTimer->startTimer();
2080
Devang Patel2c4ceb12009-11-21 02:48:08 +00002081 if (!extractScopeInformation(MF))
Devang Patel60b35bd2009-10-06 18:37:31 +00002082 return;
Devang Patel2c4ceb12009-11-21 02:48:08 +00002083
2084 collectVariableInfo();
Devang Patel60b35bd2009-10-06 18:37:31 +00002085
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002086 // Begin accumulating function debug information.
2087 MMI->BeginFunction(MF);
2088
2089 // Assumes in correct section after the entry point.
2090 EmitLabel("func_begin", ++SubprogramCount);
2091
2092 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2093 // function.
Devang Patelac1ceb32009-10-09 22:42:28 +00002094 DebugLoc FDL = MF->getDefaultDebugLoc();
2095 if (!FDL.isUnknown()) {
Devang Patel6b61f582010-01-16 06:09:35 +00002096 DILocation DLT = MF->getDILocation(FDL);
Devang Patelac1ceb32009-10-09 22:42:28 +00002097 unsigned LabelID = 0;
Devang Patel6b61f582010-01-16 06:09:35 +00002098 DISubprogram SP = getDISubprogram(DLT.getScope().getNode());
Devang Patelac1ceb32009-10-09 22:42:28 +00002099 if (!SP.isNull())
Devang Patel6b61f582010-01-16 06:09:35 +00002100 LabelID = recordSourceLine(SP.getLineNumber(), 0,
2101 DLT.getScope().getNode());
Devang Patelac1ceb32009-10-09 22:42:28 +00002102 else
Devang Patel6b61f582010-01-16 06:09:35 +00002103 LabelID = recordSourceLine(DLT.getLineNumber(),
2104 DLT.getColumnNumber(),
2105 DLT.getScope().getNode());
Devang Patelac1ceb32009-10-09 22:42:28 +00002106 Asm->printLabel(LabelID);
2107 O << '\n';
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002108 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002109 if (TimePassesIsEnabled)
2110 DebugTimer->stopTimer();
2111}
2112
Devang Patel2c4ceb12009-11-21 02:48:08 +00002113/// endFunction - Gather and emit post-function debug information.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002114///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002115void DwarfDebug::endFunction(MachineFunction *MF) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002116 if (!ShouldEmitDwarfDebug()) return;
2117
2118 if (TimePassesIsEnabled)
2119 DebugTimer->startTimer();
2120
Devang Patelac1ceb32009-10-09 22:42:28 +00002121 if (DbgScopeMap.empty())
2122 return;
Devang Patel70d75ca2009-11-12 19:02:56 +00002123
Devang Patel344130e2010-01-04 20:44:00 +00002124 if (CurrentFnDbgScope) {
2125 // Define end label for subprogram.
2126 EmitLabel("func_end", SubprogramCount);
2127
2128 // Get function line info.
2129 if (!Lines.empty()) {
2130 // Get section line info.
2131 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2132 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2133 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2134 // Append the function info to section info.
2135 SectionLineInfos.insert(SectionLineInfos.end(),
2136 Lines.begin(), Lines.end());
2137 }
2138
2139 // Construct abstract scopes.
2140 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
2141 AE = AbstractScopesList.end(); AI != AE; ++AI)
2142 constructScopeDIE(*AI);
2143
2144 constructScopeDIE(CurrentFnDbgScope);
2145
2146 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
2147 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002148 }
2149
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002150 // Clear debug info
Devang Patel23598502010-01-11 18:52:33 +00002151 if (CurrentFnDbgScope) {
2152 CurrentFnDbgScope = NULL;
2153 DbgScopeMap.clear();
2154 DbgScopeBeginMap.clear();
2155 DbgScopeEndMap.clear();
2156 ConcreteScopes.clear();
2157 AbstractScopesList.clear();
2158 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002159 Lines.clear();
Devang Patelc09ddc12009-12-01 18:13:48 +00002160
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002161 if (TimePassesIsEnabled)
2162 DebugTimer->stopTimer();
2163}
2164
Devang Patel2c4ceb12009-11-21 02:48:08 +00002165/// recordSourceLine - Records location information and associates it with a
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002166/// label. Returns a unique label ID used to generate a label and provide
2167/// correspondence to the source line list.
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002168unsigned DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patelf84548d2009-10-05 18:03:19 +00002169 MDNode *S) {
Devang Patele4b27562009-08-28 23:24:31 +00002170 if (!MMI)
2171 return 0;
2172
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002173 if (TimePassesIsEnabled)
2174 DebugTimer->startTimer();
2175
Devang Patel65dbc902009-11-25 17:36:49 +00002176 StringRef Dir;
2177 StringRef Fn;
Devang Patelf84548d2009-10-05 18:03:19 +00002178
2179 DIDescriptor Scope(S);
2180 if (Scope.isCompileUnit()) {
2181 DICompileUnit CU(S);
2182 Dir = CU.getDirectory();
2183 Fn = CU.getFilename();
2184 } else if (Scope.isSubprogram()) {
2185 DISubprogram SP(S);
2186 Dir = SP.getDirectory();
2187 Fn = SP.getFilename();
2188 } else if (Scope.isLexicalBlock()) {
2189 DILexicalBlock DB(S);
2190 Dir = DB.getDirectory();
2191 Fn = DB.getFilename();
2192 } else
2193 assert (0 && "Unexpected scope info");
2194
2195 unsigned Src = GetOrCreateSourceID(Dir, Fn);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002196 unsigned ID = MMI->NextLabelID();
2197 Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
2198
2199 if (TimePassesIsEnabled)
2200 DebugTimer->stopTimer();
2201
2202 return ID;
2203}
2204
2205/// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
2206/// timed. Look up the source id with the given directory and source file
2207/// names. If none currently exists, create a new id and insert it in the
2208/// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
2209/// well.
2210unsigned DwarfDebug::getOrCreateSourceID(const std::string &DirName,
2211 const std::string &FileName) {
2212 if (TimePassesIsEnabled)
2213 DebugTimer->startTimer();
2214
Devang Patel5ccdd102009-09-29 18:40:58 +00002215 unsigned SrcId = GetOrCreateSourceID(DirName.c_str(), FileName.c_str());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002216
2217 if (TimePassesIsEnabled)
2218 DebugTimer->stopTimer();
2219
2220 return SrcId;
2221}
2222
Bill Wendling829e67b2009-05-20 23:22:40 +00002223//===----------------------------------------------------------------------===//
2224// Emit Methods
2225//===----------------------------------------------------------------------===//
2226
Devang Patel2c4ceb12009-11-21 02:48:08 +00002227/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling94d04b82009-05-20 23:21:38 +00002228///
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002229unsigned
2230DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002231 // Get the children.
2232 const std::vector<DIE *> &Children = Die->getChildren();
2233
2234 // If not last sibling and has children then add sibling offset attribute.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002235 if (!Last && !Children.empty()) Die->addSiblingOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00002236
2237 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002238 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00002239
2240 // Get the abbreviation for this DIE.
2241 unsigned AbbrevNumber = Die->getAbbrevNumber();
2242 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2243
2244 // Set DIE offset
2245 Die->setOffset(Offset);
2246
2247 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00002248 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00002249
2250 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2251 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2252
2253 // Size the DIE attribute values.
2254 for (unsigned i = 0, N = Values.size(); i < N; ++i)
2255 // Size attribute value.
2256 Offset += Values[i]->SizeOf(TD, AbbrevData[i].getForm());
2257
2258 // Size the DIE children if any.
2259 if (!Children.empty()) {
2260 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
2261 "Children flag not set");
2262
2263 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002264 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling94d04b82009-05-20 23:21:38 +00002265
2266 // End of children marker.
2267 Offset += sizeof(int8_t);
2268 }
2269
2270 Die->setSize(Offset - Die->getOffset());
2271 return Offset;
2272}
2273
Devang Patel2c4ceb12009-11-21 02:48:08 +00002274/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling94d04b82009-05-20 23:21:38 +00002275///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002276void DwarfDebug::computeSizeAndOffsets() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002277 // Compute size of compile unit header.
2278 static unsigned Offset =
2279 sizeof(int32_t) + // Length of Compilation Unit Info
2280 sizeof(int16_t) + // DWARF version number
2281 sizeof(int32_t) + // Offset Into Abbrev. Section
2282 sizeof(int8_t); // Pointer Size (in bytes)
2283
Devang Patel2c4ceb12009-11-21 02:48:08 +00002284 computeSizeAndOffset(ModuleCU->getCUDie(), Offset, true);
Devang Patel1dbc7712009-06-29 20:45:18 +00002285 CompileUnitOffsets[ModuleCU] = 0;
Bill Wendling94d04b82009-05-20 23:21:38 +00002286}
2287
Devang Patel2c4ceb12009-11-21 02:48:08 +00002288/// emitInitial - Emit initial Dwarf declarations. This is necessary for cc
Bill Wendling94d04b82009-05-20 23:21:38 +00002289/// tools to recognize the object file contains Dwarf information.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002290void DwarfDebug::emitInitial() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002291 // Check to see if we already emitted intial headers.
2292 if (didInitial) return;
2293 didInitial = true;
2294
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002295 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002296
Bill Wendling94d04b82009-05-20 23:21:38 +00002297 // Dwarf sections base addresses.
Chris Lattner33adcfb2009-08-22 21:43:10 +00002298 if (MAI->doesDwarfRequireFrameSection()) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002299 Asm->OutStreamer.SwitchSection(TLOF.getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002300 EmitLabel("section_debug_frame", 0);
2301 }
2302
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002303 Asm->OutStreamer.SwitchSection(TLOF.getDwarfInfoSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002304 EmitLabel("section_info", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002305 Asm->OutStreamer.SwitchSection(TLOF.getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002306 EmitLabel("section_abbrev", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002307 Asm->OutStreamer.SwitchSection(TLOF.getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002308 EmitLabel("section_aranges", 0);
2309
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002310 if (const MCSection *LineInfoDirective = TLOF.getDwarfMacroInfoSection()) {
2311 Asm->OutStreamer.SwitchSection(LineInfoDirective);
Bill Wendling94d04b82009-05-20 23:21:38 +00002312 EmitLabel("section_macinfo", 0);
2313 }
2314
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002315 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002316 EmitLabel("section_line", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002317 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLocSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002318 EmitLabel("section_loc", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002319 Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubNamesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002320 EmitLabel("section_pubnames", 0);
Devang Patel193f7202009-11-24 01:14:22 +00002321 Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubTypesSection());
2322 EmitLabel("section_pubtypes", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002323 Asm->OutStreamer.SwitchSection(TLOF.getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002324 EmitLabel("section_str", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002325 Asm->OutStreamer.SwitchSection(TLOF.getDwarfRangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002326 EmitLabel("section_ranges", 0);
2327
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002328 Asm->OutStreamer.SwitchSection(TLOF.getTextSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002329 EmitLabel("text_begin", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002330 Asm->OutStreamer.SwitchSection(TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002331 EmitLabel("data_begin", 0);
2332}
2333
Devang Patel2c4ceb12009-11-21 02:48:08 +00002334/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling94d04b82009-05-20 23:21:38 +00002335///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002336void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002337 // Get the abbreviation for this DIE.
2338 unsigned AbbrevNumber = Die->getAbbrevNumber();
2339 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2340
2341 Asm->EOL();
2342
2343 // Emit the code (index) for the abbreviation.
2344 Asm->EmitULEB128Bytes(AbbrevNumber);
2345
Benjamin Kramer1efd4fd52010-01-17 07:46:39 +00002346 Asm->EOL("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2347 Twine::utohexstr(Die->getOffset()) + ":0x" +
2348 Twine::utohexstr(Die->getSize()) + " " +
2349 dwarf::TagString(Abbrev->getTag()));
Bill Wendling94d04b82009-05-20 23:21:38 +00002350
2351 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2352 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2353
2354 // Emit the DIE attribute values.
2355 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2356 unsigned Attr = AbbrevData[i].getAttribute();
2357 unsigned Form = AbbrevData[i].getForm();
2358 assert(Form && "Too many attributes for DIE (check abbreviation)");
2359
2360 switch (Attr) {
2361 case dwarf::DW_AT_sibling:
Devang Patel2c4ceb12009-11-21 02:48:08 +00002362 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00002363 break;
2364 case dwarf::DW_AT_abstract_origin: {
2365 DIEEntry *E = cast<DIEEntry>(Values[i]);
2366 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00002367 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00002368 Asm->EmitInt32(Addr);
2369 break;
2370 }
2371 default:
2372 // Emit an attribute using the defined form.
2373 Values[i]->EmitValue(this, Form);
2374 break;
2375 }
2376
2377 Asm->EOL(dwarf::AttributeString(Attr));
2378 }
2379
2380 // Emit the DIE children if any.
2381 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2382 const std::vector<DIE *> &Children = Die->getChildren();
2383
2384 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002385 emitDIE(Children[j]);
Bill Wendling94d04b82009-05-20 23:21:38 +00002386
2387 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2388 }
2389}
2390
Devang Patel8a241142009-12-09 18:24:21 +00002391/// emitDebugInfo - Emit the debug info section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002392///
Devang Patel8a241142009-12-09 18:24:21 +00002393void DwarfDebug::emitDebugInfo() {
2394 // Start debug info section.
2395 Asm->OutStreamer.SwitchSection(
2396 Asm->getObjFileLowering().getDwarfInfoSection());
2397 DIE *Die = ModuleCU->getCUDie();
Bill Wendling94d04b82009-05-20 23:21:38 +00002398
2399 // Emit the compile units header.
Devang Patel8a241142009-12-09 18:24:21 +00002400 EmitLabel("info_begin", ModuleCU->getID());
Bill Wendling94d04b82009-05-20 23:21:38 +00002401
2402 // Emit size of content not including length itself
2403 unsigned ContentSize = Die->getSize() +
2404 sizeof(int16_t) + // DWARF version number
2405 sizeof(int32_t) + // Offset Into Abbrev. Section
2406 sizeof(int8_t) + // Pointer Size (in bytes)
2407 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2408
2409 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2410 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2411 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2412 Asm->EOL("Offset Into Abbrev. Section");
2413 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2414
Devang Patel2c4ceb12009-11-21 02:48:08 +00002415 emitDIE(Die);
Bill Wendling94d04b82009-05-20 23:21:38 +00002416 // FIXME - extra padding for gdb bug.
2417 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2418 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2419 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2420 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
Devang Patel8a241142009-12-09 18:24:21 +00002421 EmitLabel("info_end", ModuleCU->getID());
Bill Wendling94d04b82009-05-20 23:21:38 +00002422
2423 Asm->EOL();
Bill Wendling94d04b82009-05-20 23:21:38 +00002424}
2425
Devang Patel2c4ceb12009-11-21 02:48:08 +00002426/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002427///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002428void DwarfDebug::emitAbbreviations() const {
Bill Wendling94d04b82009-05-20 23:21:38 +00002429 // Check to see if it is worth the effort.
2430 if (!Abbreviations.empty()) {
2431 // Start the debug abbrev section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002432 Asm->OutStreamer.SwitchSection(
2433 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002434
2435 EmitLabel("abbrev_begin", 0);
2436
2437 // For each abbrevation.
2438 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2439 // Get abbreviation data
2440 const DIEAbbrev *Abbrev = Abbreviations[i];
2441
2442 // Emit the abbrevations code (base 1 index.)
2443 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2444 Asm->EOL("Abbreviation Code");
2445
2446 // Emit the abbreviations data.
2447 Abbrev->Emit(Asm);
2448
2449 Asm->EOL();
2450 }
2451
2452 // Mark end of abbreviations.
2453 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2454
2455 EmitLabel("abbrev_end", 0);
2456 Asm->EOL();
2457 }
2458}
2459
Devang Patel2c4ceb12009-11-21 02:48:08 +00002460/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling94d04b82009-05-20 23:21:38 +00002461/// the line matrix.
2462///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002463void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002464 // Define last address of section.
2465 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2466 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2467 Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2468 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2469
2470 // Mark end of matrix.
2471 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2472 Asm->EmitULEB128Bytes(1); Asm->EOL();
2473 Asm->EmitInt8(1); Asm->EOL();
2474}
2475
Devang Patel2c4ceb12009-11-21 02:48:08 +00002476/// emitDebugLines - Emit source line information.
Bill Wendling94d04b82009-05-20 23:21:38 +00002477///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002478void DwarfDebug::emitDebugLines() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002479 // If the target is using .loc/.file, the assembler will be emitting the
2480 // .debug_line table automatically.
Chris Lattner33adcfb2009-08-22 21:43:10 +00002481 if (MAI->hasDotLocAndDotFile())
Bill Wendling94d04b82009-05-20 23:21:38 +00002482 return;
2483
2484 // Minimum line delta, thus ranging from -10..(255-10).
2485 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
2486 // Maximum line delta, thus ranging from -10..(255-10).
2487 const int MaxLineDelta = 255 + MinLineDelta;
2488
2489 // Start the dwarf line section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002490 Asm->OutStreamer.SwitchSection(
2491 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002492
2493 // Construct the section header.
2494 EmitDifference("line_end", 0, "line_begin", 0, true);
2495 Asm->EOL("Length of Source Line Info");
2496 EmitLabel("line_begin", 0);
2497
2498 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2499
2500 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2501 Asm->EOL("Prolog Length");
2502 EmitLabel("line_prolog_begin", 0);
2503
2504 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2505
2506 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2507
2508 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2509
2510 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2511
2512 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2513
2514 // Line number standard opcode encodings argument count
2515 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2516 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2517 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2518 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2519 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2520 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2521 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2522 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2523 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2524
2525 // Emit directories.
2526 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
2527 Asm->EmitString(getSourceDirectoryName(DI));
2528 Asm->EOL("Directory");
2529 }
2530
2531 Asm->EmitInt8(0); Asm->EOL("End of directories");
2532
2533 // Emit files.
2534 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
2535 // Remember source id starts at 1.
2536 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
2537 Asm->EmitString(getSourceFileName(Id.second));
2538 Asm->EOL("Source");
2539 Asm->EmitULEB128Bytes(Id.first);
2540 Asm->EOL("Directory #");
2541 Asm->EmitULEB128Bytes(0);
2542 Asm->EOL("Mod date");
2543 Asm->EmitULEB128Bytes(0);
2544 Asm->EOL("File size");
2545 }
2546
2547 Asm->EmitInt8(0); Asm->EOL("End of files");
2548
2549 EmitLabel("line_prolog_end", 0);
2550
2551 // A sequence for each text section.
2552 unsigned SecSrcLinesSize = SectionSourceLines.size();
2553
2554 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2555 // Isolate current sections line info.
2556 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2557
Chris Lattner93b6db32009-08-08 23:39:42 +00002558 /*if (Asm->isVerbose()) {
Chris Lattnera87dea42009-07-31 18:48:30 +00002559 const MCSection *S = SectionMap[j + 1];
Chris Lattner33adcfb2009-08-22 21:43:10 +00002560 O << '\t' << MAI->getCommentString() << " Section"
Bill Wendling94d04b82009-05-20 23:21:38 +00002561 << S->getName() << '\n';
Chris Lattner93b6db32009-08-08 23:39:42 +00002562 }*/
2563 Asm->EOL();
Bill Wendling94d04b82009-05-20 23:21:38 +00002564
2565 // Dwarf assumes we start with first line of first source file.
2566 unsigned Source = 1;
2567 unsigned Line = 1;
2568
2569 // Construct rows of the address, source, line, column matrix.
2570 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2571 const SrcLineInfo &LineInfo = LineInfos[i];
2572 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2573 if (!LabelID) continue;
2574
Caroline Ticec6f9d622009-09-11 18:25:54 +00002575 if (LineInfo.getLine() == 0) continue;
2576
Bill Wendling94d04b82009-05-20 23:21:38 +00002577 if (!Asm->isVerbose())
2578 Asm->EOL();
2579 else {
2580 std::pair<unsigned, unsigned> SourceID =
2581 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner33adcfb2009-08-22 21:43:10 +00002582 O << '\t' << MAI->getCommentString() << ' '
Dan Gohmanb3b98212009-12-05 02:00:34 +00002583 << getSourceDirectoryName(SourceID.first) << '/'
Bill Wendling94d04b82009-05-20 23:21:38 +00002584 << getSourceFileName(SourceID.second)
Dan Gohmanb3b98212009-12-05 02:00:34 +00002585 << ':' << utostr_32(LineInfo.getLine()) << '\n';
Bill Wendling94d04b82009-05-20 23:21:38 +00002586 }
2587
2588 // Define the line address.
2589 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2590 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2591 Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2592 EmitReference("label", LabelID); Asm->EOL("Location label");
2593
2594 // If change of source, then switch to the new source.
2595 if (Source != LineInfo.getSourceID()) {
2596 Source = LineInfo.getSourceID();
2597 Asm->EmitInt8(dwarf::DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2598 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2599 }
2600
2601 // If change of line.
2602 if (Line != LineInfo.getLine()) {
2603 // Determine offset.
2604 int Offset = LineInfo.getLine() - Line;
2605 int Delta = Offset - MinLineDelta;
2606
2607 // Update line.
2608 Line = LineInfo.getLine();
2609
2610 // If delta is small enough and in range...
2611 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2612 // ... then use fast opcode.
2613 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2614 } else {
2615 // ... otherwise use long hand.
2616 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
2617 Asm->EOL("DW_LNS_advance_line");
2618 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2619 Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2620 }
2621 } else {
2622 // Copy the previous row (different address or source)
2623 Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2624 }
2625 }
2626
Devang Patel2c4ceb12009-11-21 02:48:08 +00002627 emitEndOfLineMatrix(j + 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00002628 }
2629
2630 if (SecSrcLinesSize == 0)
2631 // Because we're emitting a debug_line section, we still need a line
2632 // table. The linker and friends expect it to exist. If there's nothing to
2633 // put into it, emit an empty table.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002634 emitEndOfLineMatrix(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00002635
2636 EmitLabel("line_end", 0);
2637 Asm->EOL();
2638}
2639
Devang Patel2c4ceb12009-11-21 02:48:08 +00002640/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002641///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002642void DwarfDebug::emitCommonDebugFrame() {
Chris Lattner33adcfb2009-08-22 21:43:10 +00002643 if (!MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002644 return;
2645
2646 int stackGrowth =
2647 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2648 TargetFrameInfo::StackGrowsUp ?
2649 TD->getPointerSize() : -TD->getPointerSize();
2650
2651 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002652 Asm->OutStreamer.SwitchSection(
2653 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002654
2655 EmitLabel("debug_frame_common", 0);
2656 EmitDifference("debug_frame_common_end", 0,
2657 "debug_frame_common_begin", 0, true);
2658 Asm->EOL("Length of Common Information Entry");
2659
2660 EmitLabel("debug_frame_common_begin", 0);
2661 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
2662 Asm->EOL("CIE Identifier Tag");
2663 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
2664 Asm->EOL("CIE Version");
2665 Asm->EmitString("");
2666 Asm->EOL("CIE Augmentation");
2667 Asm->EmitULEB128Bytes(1);
2668 Asm->EOL("CIE Code Alignment Factor");
2669 Asm->EmitSLEB128Bytes(stackGrowth);
2670 Asm->EOL("CIE Data Alignment Factor");
2671 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2672 Asm->EOL("CIE RA Column");
2673
2674 std::vector<MachineMove> Moves;
2675 RI->getInitialFrameState(Moves);
2676
2677 EmitFrameMoves(NULL, 0, Moves, false);
2678
2679 Asm->EmitAlignment(2, 0, 0, false);
2680 EmitLabel("debug_frame_common_end", 0);
2681
2682 Asm->EOL();
2683}
2684
Devang Patel2c4ceb12009-11-21 02:48:08 +00002685/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling94d04b82009-05-20 23:21:38 +00002686/// section.
2687void
Devang Patel2c4ceb12009-11-21 02:48:08 +00002688DwarfDebug::emitFunctionDebugFrame(const FunctionDebugFrameInfo&DebugFrameInfo){
Chris Lattner33adcfb2009-08-22 21:43:10 +00002689 if (!MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002690 return;
2691
2692 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002693 Asm->OutStreamer.SwitchSection(
2694 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002695
2696 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2697 "debug_frame_begin", DebugFrameInfo.Number, true);
2698 Asm->EOL("Length of Frame Information Entry");
2699
2700 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2701
2702 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2703 0, 0, true, false);
2704 Asm->EOL("FDE CIE offset");
2705
2706 EmitReference("func_begin", DebugFrameInfo.Number);
2707 Asm->EOL("FDE initial location");
2708 EmitDifference("func_end", DebugFrameInfo.Number,
2709 "func_begin", DebugFrameInfo.Number);
2710 Asm->EOL("FDE address range");
2711
2712 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
2713 false);
2714
2715 Asm->EmitAlignment(2, 0, 0, false);
2716 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2717
2718 Asm->EOL();
2719}
2720
Devang Patel8a241142009-12-09 18:24:21 +00002721/// emitDebugPubNames - Emit visible names into a debug pubnames section.
2722///
2723void DwarfDebug::emitDebugPubNames() {
2724 // Start the dwarf pubnames section.
2725 Asm->OutStreamer.SwitchSection(
2726 Asm->getObjFileLowering().getDwarfPubNamesSection());
2727
2728 EmitDifference("pubnames_end", ModuleCU->getID(),
2729 "pubnames_begin", ModuleCU->getID(), true);
Bill Wendling94d04b82009-05-20 23:21:38 +00002730 Asm->EOL("Length of Public Names Info");
2731
Devang Patel8a241142009-12-09 18:24:21 +00002732 EmitLabel("pubnames_begin", ModuleCU->getID());
Bill Wendling94d04b82009-05-20 23:21:38 +00002733
2734 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF Version");
2735
2736 EmitSectionOffset("info_begin", "section_info",
Devang Patel8a241142009-12-09 18:24:21 +00002737 ModuleCU->getID(), 0, true, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00002738 Asm->EOL("Offset of Compilation Unit Info");
2739
Devang Patel8a241142009-12-09 18:24:21 +00002740 EmitDifference("info_end", ModuleCU->getID(), "info_begin", ModuleCU->getID(),
Bill Wendling94d04b82009-05-20 23:21:38 +00002741 true);
2742 Asm->EOL("Compilation Unit Length");
2743
Devang Patel8a241142009-12-09 18:24:21 +00002744 const StringMap<DIE*> &Globals = ModuleCU->getGlobals();
Bill Wendling94d04b82009-05-20 23:21:38 +00002745 for (StringMap<DIE*>::const_iterator
2746 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2747 const char *Name = GI->getKeyData();
2748 DIE * Entity = GI->second;
2749
2750 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2751 Asm->EmitString(Name, strlen(Name)); Asm->EOL("External Name");
2752 }
2753
2754 Asm->EmitInt32(0); Asm->EOL("End Mark");
Devang Patel8a241142009-12-09 18:24:21 +00002755 EmitLabel("pubnames_end", ModuleCU->getID());
Bill Wendling94d04b82009-05-20 23:21:38 +00002756
2757 Asm->EOL();
2758}
2759
Devang Patel193f7202009-11-24 01:14:22 +00002760void DwarfDebug::emitDebugPubTypes() {
Devang Patelf3a03762009-11-24 19:18:41 +00002761 // Start the dwarf pubnames section.
2762 Asm->OutStreamer.SwitchSection(
2763 Asm->getObjFileLowering().getDwarfPubTypesSection());
Devang Patel193f7202009-11-24 01:14:22 +00002764 EmitDifference("pubtypes_end", ModuleCU->getID(),
2765 "pubtypes_begin", ModuleCU->getID(), true);
2766 Asm->EOL("Length of Public Types Info");
2767
2768 EmitLabel("pubtypes_begin", ModuleCU->getID());
2769
2770 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF Version");
2771
2772 EmitSectionOffset("info_begin", "section_info",
2773 ModuleCU->getID(), 0, true, false);
2774 Asm->EOL("Offset of Compilation ModuleCU Info");
2775
2776 EmitDifference("info_end", ModuleCU->getID(), "info_begin", ModuleCU->getID(),
2777 true);
2778 Asm->EOL("Compilation ModuleCU Length");
2779
2780 const StringMap<DIE*> &Globals = ModuleCU->getGlobalTypes();
2781 for (StringMap<DIE*>::const_iterator
2782 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2783 const char *Name = GI->getKeyData();
2784 DIE * Entity = GI->second;
2785
2786 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2787 Asm->EmitString(Name, strlen(Name)); Asm->EOL("External Name");
2788 }
2789
2790 Asm->EmitInt32(0); Asm->EOL("End Mark");
2791 EmitLabel("pubtypes_end", ModuleCU->getID());
2792
2793 Asm->EOL();
2794}
2795
Devang Patel2c4ceb12009-11-21 02:48:08 +00002796/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002797///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002798void DwarfDebug::emitDebugStr() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002799 // Check to see if it is worth the effort.
2800 if (!StringPool.empty()) {
2801 // Start the dwarf str section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002802 Asm->OutStreamer.SwitchSection(
2803 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002804
2805 // For each of strings in the string pool.
2806 for (unsigned StringID = 1, N = StringPool.size();
2807 StringID <= N; ++StringID) {
2808 // Emit a label for reference from debug information entries.
2809 EmitLabel("string", StringID);
2810
2811 // Emit the string itself.
2812 const std::string &String = StringPool[StringID];
2813 Asm->EmitString(String); Asm->EOL();
2814 }
2815
2816 Asm->EOL();
2817 }
2818}
2819
Devang Patel2c4ceb12009-11-21 02:48:08 +00002820/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002821///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002822void DwarfDebug::emitDebugLoc() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002823 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002824 Asm->OutStreamer.SwitchSection(
2825 Asm->getObjFileLowering().getDwarfLocSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002826 Asm->EOL();
2827}
2828
2829/// EmitDebugARanges - Emit visible names into a debug aranges section.
2830///
2831void DwarfDebug::EmitDebugARanges() {
2832 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002833 Asm->OutStreamer.SwitchSection(
2834 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002835
2836 // FIXME - Mock up
2837#if 0
2838 CompileUnit *Unit = GetBaseCompileUnit();
2839
2840 // Don't include size of length
2841 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2842
2843 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
2844
2845 EmitReference("info_begin", Unit->getID());
2846 Asm->EOL("Offset of Compilation Unit Info");
2847
2848 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2849
2850 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2851
2852 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2853 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
2854
2855 // Range 1
2856 EmitReference("text_begin", 0); Asm->EOL("Address");
2857 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2858
2859 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2860 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2861#endif
2862
2863 Asm->EOL();
2864}
2865
Devang Patel2c4ceb12009-11-21 02:48:08 +00002866/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002867///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002868void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002869 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002870 Asm->OutStreamer.SwitchSection(
2871 Asm->getObjFileLowering().getDwarfRangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002872 Asm->EOL();
2873}
2874
Devang Patel2c4ceb12009-11-21 02:48:08 +00002875/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002876///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002877void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002878 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00002879 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002880 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002881 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002882 Asm->EOL();
2883 }
2884}
2885
Devang Patel2c4ceb12009-11-21 02:48:08 +00002886/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling94d04b82009-05-20 23:21:38 +00002887/// Section Header:
2888/// 1. length of section
2889/// 2. Dwarf version number
2890/// 3. address size.
2891///
2892/// Entries (one "entry" for each function that was inlined):
2893///
2894/// 1. offset into __debug_str section for MIPS linkage name, if exists;
2895/// otherwise offset into __debug_str for regular function name.
2896/// 2. offset into __debug_str section for regular function name.
2897/// 3. an unsigned LEB128 number indicating the number of distinct inlining
2898/// instances for the function.
2899///
2900/// The rest of the entry consists of a {die_offset, low_pc} pair for each
2901/// inlined instance; the die_offset points to the inlined_subroutine die in the
2902/// __debug_info section, and the low_pc is the starting address for the
2903/// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002904void DwarfDebug::emitDebugInlineInfo() {
Chris Lattner33adcfb2009-08-22 21:43:10 +00002905 if (!MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002906 return;
2907
Devang Patel1dbc7712009-06-29 20:45:18 +00002908 if (!ModuleCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00002909 return;
2910
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002911 Asm->OutStreamer.SwitchSection(
2912 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002913 Asm->EOL();
2914 EmitDifference("debug_inlined_end", 1,
2915 "debug_inlined_begin", 1, true);
2916 Asm->EOL("Length of Debug Inlined Information Entry");
2917
2918 EmitLabel("debug_inlined_begin", 1);
2919
2920 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
2921 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2922
Devang Patel53bb5c92009-11-10 23:06:00 +00002923 for (SmallVector<MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
2924 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002925
Devang Patel53bb5c92009-11-10 23:06:00 +00002926 MDNode *Node = *I;
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002927 ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
2928 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00002929 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00002930 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00002931 StringRef LName = SP.getLinkageName();
2932 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00002933
Devang Patel65dbc902009-11-25 17:36:49 +00002934 if (LName.empty())
Devang Patel53cb17d2009-07-16 01:01:22 +00002935 Asm->EmitString(Name);
Devang Patel351ca332010-01-05 01:46:14 +00002936 else
Devang Patel53bb5c92009-11-10 23:06:00 +00002937 EmitSectionOffset("string", "section_str",
Devang Patel351ca332010-01-05 01:46:14 +00002938 StringPool.idFor(getRealLinkageName(LName)), false, true);
Devang Patel53bb5c92009-11-10 23:06:00 +00002939
Bill Wendling94d04b82009-05-20 23:21:38 +00002940 Asm->EOL("MIPS linkage name");
Devang Patel53bb5c92009-11-10 23:06:00 +00002941 EmitSectionOffset("string", "section_str",
2942 StringPool.idFor(Name), false, true);
2943 Asm->EOL("Function name");
Bill Wendling94d04b82009-05-20 23:21:38 +00002944 Asm->EmitULEB128Bytes(Labels.size()); Asm->EOL("Inline count");
2945
Devang Patel53bb5c92009-11-10 23:06:00 +00002946 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00002947 LE = Labels.end(); LI != LE; ++LI) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002948 DIE *SP = LI->second;
Bill Wendling94d04b82009-05-20 23:21:38 +00002949 Asm->EmitInt32(SP->getOffset()); Asm->EOL("DIE offset");
2950
2951 if (TD->getPointerSize() == sizeof(int32_t))
Chris Lattner33adcfb2009-08-22 21:43:10 +00002952 O << MAI->getData32bitsDirective();
Bill Wendling94d04b82009-05-20 23:21:38 +00002953 else
Chris Lattner33adcfb2009-08-22 21:43:10 +00002954 O << MAI->getData64bitsDirective();
Bill Wendling94d04b82009-05-20 23:21:38 +00002955
Devang Patel53bb5c92009-11-10 23:06:00 +00002956 PrintLabelName("label", LI->first); Asm->EOL("low_pc");
Bill Wendling94d04b82009-05-20 23:21:38 +00002957 }
2958 }
2959
2960 EmitLabel("debug_inlined_end", 1);
2961 Asm->EOL();
2962}