blob: c7b3cfed87184125958cf3057ebf773fe668d45d [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"
Bill Wendling0310d762009-05-15 09:23:25 +000021#include "llvm/Target/TargetData.h"
22#include "llvm/Target/TargetFrameInfo.h"
Chris Lattnerf0144122009-07-28 03:13:23 +000023#include "llvm/Target/TargetLoweringObjectFile.h"
24#include "llvm/Target/TargetRegisterInfo.h"
Chris Lattner23132b12009-08-24 03:52:50 +000025#include "llvm/ADT/StringExtras.h"
Daniel Dunbar6e4bdfc2009-10-13 06:47:08 +000026#include "llvm/Support/Debug.h"
27#include "llvm/Support/ErrorHandling.h"
Chris Lattner334fd1f2009-09-16 00:08:41 +000028#include "llvm/Support/Mangler.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
33static TimerGroup &getDwarfTimerGroup() {
34 static TimerGroup DwarfTimerGroup("Dwarf Debugging");
35 return DwarfTimerGroup;
36}
37
38//===----------------------------------------------------------------------===//
39
40/// Configuration values for initial hash set sizes (log2).
41///
Bill Wendling0310d762009-05-15 09:23:25 +000042static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling0310d762009-05-15 09:23:25 +000043
44namespace llvm {
45
46//===----------------------------------------------------------------------===//
47/// CompileUnit - This dwarf writer support class manages information associate
48/// with a source file.
Nick Lewycky5f9843f2009-11-17 08:11:44 +000049class CompileUnit {
Bill Wendling0310d762009-05-15 09:23:25 +000050 /// ID - File identifier for source.
51 ///
52 unsigned ID;
53
54 /// Die - Compile unit debug information entry.
55 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +000056 DIE *CUDie;
Bill Wendling0310d762009-05-15 09:23:25 +000057
Devang Patel6f01d9c2009-11-21 00:31:03 +000058 /// IndexTyDie - An anonymous type for index type.
59 DIE *IndexTyDie;
60
Bill Wendling0310d762009-05-15 09:23:25 +000061 /// GVToDieMap - Tracks the mapping of unit level debug informaton
62 /// variables to debug information entries.
Devang Patele4b27562009-08-28 23:24:31 +000063 /// FIXME : Rename GVToDieMap -> NodeToDieMap
Devang Patel017d1212009-11-20 21:37:22 +000064 ValueMap<MDNode *, DIE *> GVToDieMap;
Bill Wendling0310d762009-05-15 09:23:25 +000065
66 /// GVToDIEEntryMap - Tracks the mapping of unit level debug informaton
67 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patele4b27562009-08-28 23:24:31 +000068 /// FIXME : Rename
Devang Patel017d1212009-11-20 21:37:22 +000069 ValueMap<MDNode *, DIEEntry *> GVToDIEEntryMap;
Bill Wendling0310d762009-05-15 09:23:25 +000070
71 /// Globals - A map of globally visible named entities for this unit.
72 ///
73 StringMap<DIE*> Globals;
74
Devang Patel193f7202009-11-24 01:14:22 +000075 /// GlobalTypes - A map of globally visible types for this unit.
76 ///
77 StringMap<DIE*> GlobalTypes;
78
Bill Wendling0310d762009-05-15 09:23:25 +000079public:
80 CompileUnit(unsigned I, DIE *D)
Devang Patel2c4ceb12009-11-21 02:48:08 +000081 : ID(I), CUDie(D), IndexTyDie(0) {}
82 ~CompileUnit() { delete CUDie; delete IndexTyDie; }
Bill Wendling0310d762009-05-15 09:23:25 +000083
84 // Accessors.
Devang Patel193f7202009-11-24 01:14:22 +000085 unsigned getID() const { return ID; }
86 DIE* getCUDie() const { return CUDie; }
87 const StringMap<DIE*> &getGlobals() const { return Globals; }
88 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
Bill Wendling0310d762009-05-15 09:23:25 +000089
90 /// hasContent - Return true if this compile unit has something to write out.
91 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +000092 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendling0310d762009-05-15 09:23:25 +000093
Devang Patel2c4ceb12009-11-21 02:48:08 +000094 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendling0310d762009-05-15 09:23:25 +000095 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +000096 void addGlobal(const std::string &Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling0310d762009-05-15 09:23:25 +000097
Devang Patel193f7202009-11-24 01:14:22 +000098 /// addGlobalType - Add a new global type to the compile unit.
99 ///
100 void addGlobalType(const std::string &Name, DIE *Die) {
101 GlobalTypes[Name] = Die;
102 }
103
Devang Patel017d1212009-11-20 21:37:22 +0000104 /// getDIE - Returns the debug information entry map slot for the
Bill Wendling0310d762009-05-15 09:23:25 +0000105 /// specified debug variable.
Devang Patel017d1212009-11-20 21:37:22 +0000106 DIE *getDIE(MDNode *N) { return GVToDieMap.lookup(N); }
Jim Grosbach31ef40e2009-11-21 23:12:12 +0000107
Devang Patel017d1212009-11-20 21:37:22 +0000108 /// insertDIE - Insert DIE into the map.
109 void insertDIE(MDNode *N, DIE *D) {
110 GVToDieMap.insert(std::make_pair(N, D));
111 }
Bill Wendling0310d762009-05-15 09:23:25 +0000112
Devang Patel017d1212009-11-20 21:37:22 +0000113 /// getDIEEntry - Returns the debug information entry for the speciefied
114 /// debug variable.
115 DIEEntry *getDIEEntry(MDNode *N) { return GVToDIEEntryMap.lookup(N); }
116
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 Patel53bb5c92009-11-10 23:06:00 +0000168 WeakVH InlinedAtLocation; // Location at which scope is inlined.
169 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 Patel2c4ceb12009-11-21 02:48:08 +0000215 void fixInstructionMarkers() {
Devang Patelaf9e8472009-10-01 20:31:14 +0000216 assert (getFirstInsn() && "First instruction is missing!");
217 if (getLastInsn())
218 return;
Jim Grosbach31ef40e2009-11-21 23:12:12 +0000219
Devang Patelaf9e8472009-10-01 20:31:14 +0000220 // If a scope does not have an instruction to mark an end then use
221 // the end of last child scope.
222 SmallVector<DbgScope *, 4> &Scopes = getScopes();
223 assert (!Scopes.empty() && "Inner most scope does not have last insn!");
224 DbgScope *L = Scopes.back();
225 if (!L->getLastInsn())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000226 L->fixInstructionMarkers();
Devang Patelaf9e8472009-10-01 20:31:14 +0000227 setLastInsn(L->getLastInsn());
228 }
229
Bill Wendling0310d762009-05-15 09:23:25 +0000230#ifndef NDEBUG
231 void dump() const;
232#endif
233};
234
235#ifndef NDEBUG
236void DbgScope::dump() const {
Chris Lattnerc281de12009-08-23 00:51:00 +0000237 raw_ostream &err = errs();
238 err.indent(IndentLevel);
Devang Patel53bb5c92009-11-10 23:06:00 +0000239 MDNode *N = Desc.getNode();
240 N->dump();
Chris Lattnerc281de12009-08-23 00:51:00 +0000241 err << " [" << StartLabelID << ", " << EndLabelID << "]\n";
Devang Patel53bb5c92009-11-10 23:06:00 +0000242 if (AbstractScope)
243 err << "Abstract Scope\n";
Bill Wendling0310d762009-05-15 09:23:25 +0000244
245 IndentLevel += 2;
Devang Patel53bb5c92009-11-10 23:06:00 +0000246 if (!Scopes.empty())
247 err << "Children ...\n";
Bill Wendling0310d762009-05-15 09:23:25 +0000248 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
249 if (Scopes[i] != this)
250 Scopes[i]->dump();
251
252 IndentLevel -= 2;
253}
254#endif
255
Bill Wendling0310d762009-05-15 09:23:25 +0000256DbgScope::~DbgScope() {
257 for (unsigned i = 0, N = Scopes.size(); i < N; ++i)
258 delete Scopes[i];
259 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
260 delete Variables[j];
Bill Wendling0310d762009-05-15 09:23:25 +0000261}
262
263} // end llvm namespace
264
Chris Lattneraf76e592009-08-22 20:48:53 +0000265DwarfDebug::DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T)
Devang Patel1dbc7712009-06-29 20:45:18 +0000266 : Dwarf(OS, A, T, "dbg"), ModuleCU(0),
Bill Wendling0310d762009-05-15 09:23:25 +0000267 AbbreviationsSet(InitAbbreviationsSetSize), Abbreviations(),
Devang Patel2c4ceb12009-11-21 02:48:08 +0000268 DIEValues(), StringPool(),
Bill Wendling0310d762009-05-15 09:23:25 +0000269 SectionSourceLines(), didInitial(false), shouldEmit(false),
Devang Patel53bb5c92009-11-10 23:06:00 +0000270 CurrentFnDbgScope(0), DebugTimer(0) {
Bill Wendling0310d762009-05-15 09:23:25 +0000271 if (TimePassesIsEnabled)
272 DebugTimer = new Timer("Dwarf Debug Writer",
273 getDwarfTimerGroup());
274}
275DwarfDebug::~DwarfDebug() {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000276 for (unsigned j = 0, M = DIEValues.size(); j < M; ++j)
277 delete DIEValues[j];
Bill Wendling0310d762009-05-15 09:23:25 +0000278
Bill Wendling0310d762009-05-15 09:23:25 +0000279 delete DebugTimer;
280}
281
Devang Patel2c4ceb12009-11-21 02:48:08 +0000282/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling0310d762009-05-15 09:23:25 +0000283///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000284void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling0310d762009-05-15 09:23:25 +0000285 // Profile the node so that we can make it unique.
286 FoldingSetNodeID ID;
287 Abbrev.Profile(ID);
288
289 // Check the set for priors.
290 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
291
292 // If it's newly added.
293 if (InSet == &Abbrev) {
294 // Add to abbreviation list.
295 Abbreviations.push_back(&Abbrev);
296
297 // Assign the vector position + 1 as its number.
298 Abbrev.setNumber(Abbreviations.size());
299 } else {
300 // Assign existing abbreviation number.
301 Abbrev.setNumber(InSet->getNumber());
302 }
303}
304
Devang Patel2c4ceb12009-11-21 02:48:08 +0000305/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendling995f80a2009-05-20 23:24:48 +0000306/// information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000307DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000308 DIEEntry *Value = new DIEEntry(Entry);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000309 DIEValues.push_back(Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000310 return Value;
311}
312
Devang Patel2c4ceb12009-11-21 02:48:08 +0000313/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000314///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000315void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000316 unsigned Form, uint64_t Integer) {
317 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Devang Patel6f01d9c2009-11-21 00:31:03 +0000318 DIEValue *Value = new DIEInteger(Integer);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000319 DIEValues.push_back(Value);
320 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000321}
322
Devang Patel2c4ceb12009-11-21 02:48:08 +0000323/// addSInt - Add an signed integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000324///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000325void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000326 unsigned Form, int64_t Integer) {
327 if (!Form) Form = DIEInteger::BestForm(true, 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 Patel69f57b12009-12-02 15:25:16 +0000333/// addString - Add a string attribute data and value. DIEString only
334/// keeps string reference.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000335void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Devang Patele9a05972009-11-24 19:42:17 +0000336 const StringRef String) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000337 DIEValue *Value = new DIEString(String);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000338 DIEValues.push_back(Value);
339 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000340}
341
Devang Patel2c4ceb12009-11-21 02:48:08 +0000342/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000343///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000344void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000345 const DWLabel &Label) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000346 DIEValue *Value = new DIEDwarfLabel(Label);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000347 DIEValues.push_back(Value);
348 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000349}
350
Devang Patel2c4ceb12009-11-21 02:48:08 +0000351/// addObjectLabel - Add an non-Dwarf label attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000352///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000353void DwarfDebug::addObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000354 const std::string &Label) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000355 DIEValue *Value = new DIEObjectLabel(Label);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000356 DIEValues.push_back(Value);
357 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000358}
359
Devang Patel2c4ceb12009-11-21 02:48:08 +0000360/// addSectionOffset - Add a section offset label attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000361///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000362void DwarfDebug::addSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000363 const DWLabel &Label, const DWLabel &Section,
364 bool isEH, bool useSet) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000365 DIEValue *Value = new DIESectionOffset(Label, Section, isEH, useSet);
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/// addDelta - Add a label delta attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000371///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000372void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000373 const DWLabel &Hi, const DWLabel &Lo) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000374 DIEValue *Value = new DIEDelta(Hi, Lo);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000375 DIEValues.push_back(Value);
376 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000377}
378
Devang Patel2c4ceb12009-11-21 02:48:08 +0000379/// addBlock - Add block data.
Bill Wendling0310d762009-05-15 09:23:25 +0000380///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000381void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000382 DIEBlock *Block) {
383 Block->ComputeSize(TD);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000384 DIEValues.push_back(Block);
385 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000386}
387
Devang Patel2c4ceb12009-11-21 02:48:08 +0000388/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000389/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000390void DwarfDebug::addSourceLine(DIE *Die, const DIVariable *V) {
Bill Wendling0310d762009-05-15 09:23:25 +0000391 // If there is no compile unit specified, don't add a line #.
392 if (V->getCompileUnit().isNull())
393 return;
394
395 unsigned Line = V->getLineNumber();
Devang Patel2c4ceb12009-11-21 02:48:08 +0000396 unsigned FileID = findCompileUnit(V->getCompileUnit()).getID();
Bill Wendling0310d762009-05-15 09:23:25 +0000397 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000398 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
399 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000400}
401
Devang Patel2c4ceb12009-11-21 02:48:08 +0000402/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000403/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000404void DwarfDebug::addSourceLine(DIE *Die, const DIGlobal *G) {
Bill Wendling0310d762009-05-15 09:23:25 +0000405 // If there is no compile unit specified, don't add a line #.
406 if (G->getCompileUnit().isNull())
407 return;
408
409 unsigned Line = G->getLineNumber();
Devang Patel2c4ceb12009-11-21 02:48:08 +0000410 unsigned FileID = findCompileUnit(G->getCompileUnit()).getID();
Bill Wendling0310d762009-05-15 09:23:25 +0000411 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000412 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
413 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000414}
Devang Patel82dfc0c2009-08-31 22:47:13 +0000415
Devang Patel2c4ceb12009-11-21 02:48:08 +0000416/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000417/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000418void DwarfDebug::addSourceLine(DIE *Die, const DISubprogram *SP) {
Devang Patel82dfc0c2009-08-31 22:47:13 +0000419 // If there is no compile unit specified, don't add a line #.
420 if (SP->getCompileUnit().isNull())
421 return;
Caroline Ticec6f9d622009-09-11 18:25:54 +0000422 // If the line number is 0, don't add it.
423 if (SP->getLineNumber() == 0)
424 return;
425
Devang Patel82dfc0c2009-08-31 22:47:13 +0000426
427 unsigned Line = SP->getLineNumber();
Devang Patel2c4ceb12009-11-21 02:48:08 +0000428 unsigned FileID = findCompileUnit(SP->getCompileUnit()).getID();
Devang Patel82dfc0c2009-08-31 22:47:13 +0000429 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000430 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
431 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patel82dfc0c2009-08-31 22:47:13 +0000432}
433
Devang Patel2c4ceb12009-11-21 02:48:08 +0000434/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000435/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000436void DwarfDebug::addSourceLine(DIE *Die, const DIType *Ty) {
Bill Wendling0310d762009-05-15 09:23:25 +0000437 // If there is no compile unit specified, don't add a line #.
438 DICompileUnit CU = Ty->getCompileUnit();
439 if (CU.isNull())
440 return;
441
442 unsigned Line = Ty->getLineNumber();
Devang Patel2c4ceb12009-11-21 02:48:08 +0000443 unsigned FileID = findCompileUnit(CU).getID();
Bill Wendling0310d762009-05-15 09:23:25 +0000444 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000445 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
446 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000447}
448
Caroline Ticedc8f6042009-08-31 21:19:37 +0000449/* Byref variables, in Blocks, are declared by the programmer as
450 "SomeType VarName;", but the compiler creates a
451 __Block_byref_x_VarName struct, and gives the variable VarName
452 either the struct, or a pointer to the struct, as its type. This
453 is necessary for various behind-the-scenes things the compiler
454 needs to do with by-reference variables in blocks.
455
456 However, as far as the original *programmer* is concerned, the
457 variable should still have type 'SomeType', as originally declared.
458
459 The following function dives into the __Block_byref_x_VarName
460 struct to find the original type of the variable. This will be
461 passed back to the code generating the type for the Debug
462 Information Entry for the variable 'VarName'. 'VarName' will then
463 have the original type 'SomeType' in its debug information.
464
465 The original type 'SomeType' will be the type of the field named
466 'VarName' inside the __Block_byref_x_VarName struct.
467
468 NOTE: In order for this to not completely fail on the debugger
469 side, the Debug Information Entry for the variable VarName needs to
470 have a DW_AT_location that tells the debugger how to unwind through
471 the pointers and __Block_byref_x_VarName struct to find the actual
Devang Patel2c4ceb12009-11-21 02:48:08 +0000472 value of the variable. The function addBlockByrefType does this. */
Caroline Ticedc8f6042009-08-31 21:19:37 +0000473
474/// Find the type the programmer originally declared the variable to be
475/// and return that type.
476///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000477DIType DwarfDebug::getBlockByrefType(DIType Ty, std::string Name) {
Caroline Ticedc8f6042009-08-31 21:19:37 +0000478
479 DIType subType = Ty;
480 unsigned tag = Ty.getTag();
481
482 if (tag == dwarf::DW_TAG_pointer_type) {
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000483 DIDerivedType DTy = DIDerivedType(Ty.getNode());
Caroline Ticedc8f6042009-08-31 21:19:37 +0000484 subType = DTy.getTypeDerivedFrom();
485 }
486
487 DICompositeType blockStruct = DICompositeType(subType.getNode());
488
489 DIArray Elements = blockStruct.getTypeArray();
490
491 if (Elements.isNull())
492 return Ty;
493
494 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
495 DIDescriptor Element = Elements.getElement(i);
496 DIDerivedType DT = DIDerivedType(Element.getNode());
Devang Patel65dbc902009-11-25 17:36:49 +0000497 if (Name == DT.getName())
Caroline Ticedc8f6042009-08-31 21:19:37 +0000498 return (DT.getTypeDerivedFrom());
499 }
500
501 return Ty;
502}
503
Devang Patel2c4ceb12009-11-21 02:48:08 +0000504/// addComplexAddress - Start with the address based on the location provided,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000505/// and generate the DWARF information necessary to find the actual variable
506/// given the extra address information encoded in the DIVariable, starting from
507/// the starting location. Add the DWARF information to the die.
508///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000509void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000510 unsigned Attribute,
511 const MachineLocation &Location) {
512 const DIVariable &VD = DV->getVariable();
513 DIType Ty = VD.getType();
514
515 // Decode the original location, and use that as the start of the byref
516 // variable's location.
517 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
518 DIEBlock *Block = new DIEBlock();
519
520 if (Location.isReg()) {
521 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000522 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000523 } else {
524 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000525 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
526 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000527 }
528 } else {
529 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000530 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000531 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000532 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
533 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000534 }
535
Devang Patel2c4ceb12009-11-21 02:48:08 +0000536 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000537 }
538
539 for (unsigned i = 0, N = VD.getNumAddrElements(); i < N; ++i) {
540 uint64_t Element = VD.getAddrElement(i);
541
542 if (Element == DIFactory::OpPlus) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000543 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
544 addUInt(Block, 0, dwarf::DW_FORM_udata, VD.getAddrElement(++i));
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000545 } else if (Element == DIFactory::OpDeref) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000546 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000547 } else llvm_unreachable("unknown DIFactory Opcode");
548 }
549
550 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000551 addBlock(Die, Attribute, 0, Block);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000552}
553
Caroline Ticedc8f6042009-08-31 21:19:37 +0000554/* Byref variables, in Blocks, are declared by the programmer as "SomeType
555 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
556 gives the variable VarName either the struct, or a pointer to the struct, as
557 its type. This is necessary for various behind-the-scenes things the
558 compiler needs to do with by-reference variables in Blocks.
559
560 However, as far as the original *programmer* is concerned, the variable
561 should still have type 'SomeType', as originally declared.
562
Devang Patel2c4ceb12009-11-21 02:48:08 +0000563 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000564 struct to find the original type of the variable, which is then assigned to
565 the variable's Debug Information Entry as its real type. So far, so good.
566 However now the debugger will expect the variable VarName to have the type
567 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000568 expression that explains to the debugger how to navigate through the
Caroline Ticedc8f6042009-08-31 21:19:37 +0000569 pointers and struct to find the actual variable of type SomeType.
570
571 The following function does just that. We start by getting
572 the "normal" location for the variable. This will be the location
573 of either the struct __Block_byref_x_VarName or the pointer to the
574 struct __Block_byref_x_VarName.
575
576 The struct will look something like:
577
578 struct __Block_byref_x_VarName {
579 ... <various fields>
580 struct __Block_byref_x_VarName *forwarding;
581 ... <various other fields>
582 SomeType VarName;
583 ... <maybe more fields>
584 };
585
586 If we are given the struct directly (as our starting point) we
587 need to tell the debugger to:
588
589 1). Add the offset of the forwarding field.
590
591 2). Follow that pointer to get the the real __Block_byref_x_VarName
592 struct to use (the real one may have been copied onto the heap).
593
594 3). Add the offset for the field VarName, to find the actual variable.
595
596 If we started with a pointer to the struct, then we need to
597 dereference that pointer first, before the other steps.
598 Translating this into DWARF ops, we will need to append the following
599 to the current location description for the variable:
600
601 DW_OP_deref -- optional, if we start with a pointer
602 DW_OP_plus_uconst <forward_fld_offset>
603 DW_OP_deref
604 DW_OP_plus_uconst <varName_fld_offset>
605
606 That is what this function does. */
607
Devang Patel2c4ceb12009-11-21 02:48:08 +0000608/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticedc8f6042009-08-31 21:19:37 +0000609/// provided, and generate the DWARF information necessary to find the
610/// actual Block variable (navigating the Block struct) based on the
611/// starting location. Add the DWARF information to the die. For
612/// more information, read large comment just above here.
613///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000614void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbar00564992009-09-19 20:40:14 +0000615 unsigned Attribute,
616 const MachineLocation &Location) {
Caroline Ticedc8f6042009-08-31 21:19:37 +0000617 const DIVariable &VD = DV->getVariable();
618 DIType Ty = VD.getType();
619 DIType TmpTy = Ty;
620 unsigned Tag = Ty.getTag();
621 bool isPointer = false;
622
Devang Patel65dbc902009-11-25 17:36:49 +0000623 StringRef varName = VD.getName();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000624
625 if (Tag == dwarf::DW_TAG_pointer_type) {
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000626 DIDerivedType DTy = DIDerivedType(Ty.getNode());
Caroline Ticedc8f6042009-08-31 21:19:37 +0000627 TmpTy = DTy.getTypeDerivedFrom();
628 isPointer = true;
629 }
630
631 DICompositeType blockStruct = DICompositeType(TmpTy.getNode());
632
Daniel Dunbar00564992009-09-19 20:40:14 +0000633 // Find the __forwarding field and the variable field in the __Block_byref
634 // struct.
Daniel Dunbar00564992009-09-19 20:40:14 +0000635 DIArray Fields = blockStruct.getTypeArray();
636 DIDescriptor varField = DIDescriptor();
637 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000638
639
Daniel Dunbar00564992009-09-19 20:40:14 +0000640 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
641 DIDescriptor Element = Fields.getElement(i);
642 DIDerivedType DT = DIDerivedType(Element.getNode());
Devang Patel65dbc902009-11-25 17:36:49 +0000643 StringRef fieldName = DT.getName();
644 if (fieldName == "__forwarding")
Daniel Dunbar00564992009-09-19 20:40:14 +0000645 forwardingField = Element;
Devang Patel65dbc902009-11-25 17:36:49 +0000646 else if (fieldName == varName)
Daniel Dunbar00564992009-09-19 20:40:14 +0000647 varField = Element;
648 }
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000649
Mike Stump7e3720d2009-09-24 23:21:26 +0000650 assert(!varField.isNull() && "Can't find byref variable in Block struct");
651 assert(!forwardingField.isNull()
652 && "Can't find forwarding field in Block struct");
Caroline Ticedc8f6042009-08-31 21:19:37 +0000653
Daniel Dunbar00564992009-09-19 20:40:14 +0000654 // Get the offsets for the forwarding field and the variable field.
Daniel Dunbar00564992009-09-19 20:40:14 +0000655 unsigned int forwardingFieldOffset =
656 DIDerivedType(forwardingField.getNode()).getOffsetInBits() >> 3;
657 unsigned int varFieldOffset =
658 DIDerivedType(varField.getNode()).getOffsetInBits() >> 3;
Caroline Ticedc8f6042009-08-31 21:19:37 +0000659
Mike Stump7e3720d2009-09-24 23:21:26 +0000660 // Decode the original location, and use that as the start of the byref
661 // variable's location.
Daniel Dunbar00564992009-09-19 20:40:14 +0000662 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
663 DIEBlock *Block = new DIEBlock();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000664
Daniel Dunbar00564992009-09-19 20:40:14 +0000665 if (Location.isReg()) {
666 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000667 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000668 else {
669 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000670 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
671 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000672 }
673 } else {
674 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000675 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000676 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000677 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
678 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000679 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000680
Devang Patel2c4ceb12009-11-21 02:48:08 +0000681 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbar00564992009-09-19 20:40:14 +0000682 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000683
Mike Stump7e3720d2009-09-24 23:21:26 +0000684 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbar00564992009-09-19 20:40:14 +0000685 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbar00564992009-09-19 20:40:14 +0000686 if (isPointer)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000687 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000688
Daniel Dunbar00564992009-09-19 20:40:14 +0000689 // Next add the offset for the '__forwarding' field:
690 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
691 // adding the offset if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000692 if (forwardingFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000693 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
694 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000695 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000696
Daniel Dunbar00564992009-09-19 20:40:14 +0000697 // Now dereference the __forwarding field to get to the real __Block_byref
698 // struct: DW_OP_deref.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000699 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000700
Daniel Dunbar00564992009-09-19 20:40:14 +0000701 // Now that we've got the real __Block_byref... struct, add the offset
702 // for the variable's field to get to the location of the actual variable:
703 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000704 if (varFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000705 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
706 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000707 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000708
Daniel Dunbar00564992009-09-19 20:40:14 +0000709 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000710 addBlock(Die, Attribute, 0, Block);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000711}
712
Devang Patel2c4ceb12009-11-21 02:48:08 +0000713/// addAddress - Add an address attribute to a die based on the location
Bill Wendling0310d762009-05-15 09:23:25 +0000714/// provided.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000715void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000716 const MachineLocation &Location) {
717 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
718 DIEBlock *Block = new DIEBlock();
719
720 if (Location.isReg()) {
721 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000722 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000723 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000724 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
725 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000726 }
727 } else {
728 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000729 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000730 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000731 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
732 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000733 }
734
Devang Patel2c4ceb12009-11-21 02:48:08 +0000735 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling0310d762009-05-15 09:23:25 +0000736 }
737
Devang Patel2c4ceb12009-11-21 02:48:08 +0000738 addBlock(Die, Attribute, 0, Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000739}
740
Devang Patelc366f832009-12-10 19:14:49 +0000741/// addToContextOwner - Add Die into the list of its context owner's children.
742void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
743 if (Context.isNull())
744 ModuleCU->addDie(Die);
745 else if (Context.isType()) {
746 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context.getNode()));
747 ContextDIE->addChild(Die);
748 } else if (DIE *ContextDIE = ModuleCU->getDIE(Context.getNode()))
749 ContextDIE->addChild(Die);
750 else
751 ModuleCU->addDie(Die);
752}
753
Devang Patel16ced732009-12-10 18:05:33 +0000754/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
755/// given DIType.
756DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
757 DIE *TyDIE = ModuleCU->getDIE(Ty.getNode());
758 if (TyDIE)
759 return TyDIE;
760
761 // Create new type.
762 TyDIE = new DIE(dwarf::DW_TAG_base_type);
763 ModuleCU->insertDIE(Ty.getNode(), TyDIE);
764 if (Ty.isBasicType())
765 constructTypeDIE(*TyDIE, DIBasicType(Ty.getNode()));
766 else if (Ty.isCompositeType())
767 constructTypeDIE(*TyDIE, DICompositeType(Ty.getNode()));
768 else {
769 assert(Ty.isDerivedType() && "Unknown kind of DIType");
770 constructTypeDIE(*TyDIE, DIDerivedType(Ty.getNode()));
771 }
772
Devang Patelc366f832009-12-10 19:14:49 +0000773 addToContextOwner(TyDIE, Ty.getContext());
Devang Patel16ced732009-12-10 18:05:33 +0000774 return TyDIE;
775}
776
Devang Patel2c4ceb12009-11-21 02:48:08 +0000777/// addType - Add a new type attribute to the specified entity.
Devang Patel8a241142009-12-09 18:24:21 +0000778void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Bill Wendling0310d762009-05-15 09:23:25 +0000779 if (Ty.isNull())
780 return;
781
782 // Check for pre-existence.
Devang Patel8a241142009-12-09 18:24:21 +0000783 DIEEntry *Entry = ModuleCU->getDIEEntry(Ty.getNode());
Bill Wendling0310d762009-05-15 09:23:25 +0000784
785 // If it exists then use the existing value.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000786 if (Entry) {
787 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000788 return;
789 }
790
791 // Set up proxy.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000792 Entry = createDIEEntry();
Devang Patel8a241142009-12-09 18:24:21 +0000793 ModuleCU->insertDIEEntry(Ty.getNode(), Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000794
795 // Construct type.
Devang Patel16ced732009-12-10 18:05:33 +0000796 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000797
Devang Patel2c4ceb12009-11-21 02:48:08 +0000798 Entry->setEntry(Buffer);
799 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000800}
801
Devang Patel2c4ceb12009-11-21 02:48:08 +0000802/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel8a241142009-12-09 18:24:21 +0000803void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000804 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000805 StringRef Name = BTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000806 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000807 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling0310d762009-05-15 09:23:25 +0000808 BTy.getEncoding());
809
810 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +0000811 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000812 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000813 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000814 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000815}
816
Devang Patel2c4ceb12009-11-21 02:48:08 +0000817/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel8a241142009-12-09 18:24:21 +0000818void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000819 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000820 StringRef Name = DTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000821 uint64_t Size = DTy.getSizeInBits() >> 3;
822 unsigned Tag = DTy.getTag();
823
824 // FIXME - Workaround for templates.
825 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
826
827 Buffer.setTag(Tag);
828
829 // Map to main type, void will not have a type.
830 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel8a241142009-12-09 18:24:21 +0000831 addType(&Buffer, FromTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000832
833 // Add name if not anonymous or intermediate type.
Devang Pateldeea5642009-11-30 23:56:56 +0000834 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000835 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000836
837 // Add size if non-zero (derived types might be zero-sized.)
838 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000839 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000840
841 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patel05f6fa82009-11-23 18:43:37 +0000842 if (!DTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000843 addSourceLine(&Buffer, &DTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000844}
845
Devang Patel2c4ceb12009-11-21 02:48:08 +0000846/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +0000847void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000848 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000849 StringRef Name = CTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000850
851 uint64_t Size = CTy.getSizeInBits() >> 3;
852 unsigned Tag = CTy.getTag();
853 Buffer.setTag(Tag);
854
855 switch (Tag) {
856 case dwarf::DW_TAG_vector_type:
857 case dwarf::DW_TAG_array_type:
Devang Patel8a241142009-12-09 18:24:21 +0000858 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000859 break;
860 case dwarf::DW_TAG_enumeration_type: {
861 DIArray Elements = CTy.getTypeArray();
862
863 // Add enumerators to enumeration type.
864 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
865 DIE *ElemDie = NULL;
Devang Patele4b27562009-08-28 23:24:31 +0000866 DIEnumerator Enum(Elements.getElement(i).getNode());
Devang Patelc5254722009-10-09 17:51:49 +0000867 if (!Enum.isNull()) {
Devang Patel8a241142009-12-09 18:24:21 +0000868 ElemDie = constructEnumTypeDIE(&Enum);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000869 Buffer.addChild(ElemDie);
Devang Patelc5254722009-10-09 17:51:49 +0000870 }
Bill Wendling0310d762009-05-15 09:23:25 +0000871 }
872 }
873 break;
874 case dwarf::DW_TAG_subroutine_type: {
875 // Add return type.
876 DIArray Elements = CTy.getTypeArray();
877 DIDescriptor RTy = Elements.getElement(0);
Devang Patel8a241142009-12-09 18:24:21 +0000878 addType(&Buffer, DIType(RTy.getNode()));
Bill Wendling0310d762009-05-15 09:23:25 +0000879
880 // Add prototype flag.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000881 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +0000882
883 // Add arguments.
884 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
885 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
886 DIDescriptor Ty = Elements.getElement(i);
Devang Patel8a241142009-12-09 18:24:21 +0000887 addType(Arg, DIType(Ty.getNode()));
Devang Patel2c4ceb12009-11-21 02:48:08 +0000888 Buffer.addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +0000889 }
890 }
891 break;
892 case dwarf::DW_TAG_structure_type:
893 case dwarf::DW_TAG_union_type:
894 case dwarf::DW_TAG_class_type: {
895 // Add elements to structure type.
896 DIArray Elements = CTy.getTypeArray();
897
898 // A forward struct declared type may not have elements available.
899 if (Elements.isNull())
900 break;
901
902 // Add elements to structure type.
903 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
904 DIDescriptor Element = Elements.getElement(i);
Devang Patele4b27562009-08-28 23:24:31 +0000905 if (Element.isNull())
906 continue;
Bill Wendling0310d762009-05-15 09:23:25 +0000907 DIE *ElemDie = NULL;
908 if (Element.getTag() == dwarf::DW_TAG_subprogram)
Devang Patel8a241142009-12-09 18:24:21 +0000909 ElemDie = createMemberSubprogramDIE(DISubprogram(Element.getNode()));
Bill Wendling0310d762009-05-15 09:23:25 +0000910 else
Devang Patel8a241142009-12-09 18:24:21 +0000911 ElemDie = createMemberDIE(DIDerivedType(Element.getNode()));
Devang Patel2c4ceb12009-11-21 02:48:08 +0000912 Buffer.addChild(ElemDie);
Bill Wendling0310d762009-05-15 09:23:25 +0000913 }
914
Devang Patela1ba2692009-08-27 23:51:51 +0000915 if (CTy.isAppleBlockExtension())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000916 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +0000917
918 unsigned RLang = CTy.getRunTimeLang();
919 if (RLang)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000920 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling0310d762009-05-15 09:23:25 +0000921 dwarf::DW_FORM_data1, RLang);
922 break;
923 }
924 default:
925 break;
926 }
927
928 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +0000929 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000930 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000931
932 if (Tag == dwarf::DW_TAG_enumeration_type ||
933 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type) {
934 // Add size if non-zero (derived types might be zero-sized.)
935 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000936 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000937 else {
938 // Add zero size if it is not a forward declaration.
939 if (CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000940 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +0000941 else
Devang Patel2c4ceb12009-11-21 02:48:08 +0000942 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling0310d762009-05-15 09:23:25 +0000943 }
944
945 // Add source line info if available.
946 if (!CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000947 addSourceLine(&Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000948 }
949}
950
Devang Patel2c4ceb12009-11-21 02:48:08 +0000951/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
952void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling0310d762009-05-15 09:23:25 +0000953 int64_t L = SR.getLo();
954 int64_t H = SR.getHi();
955 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
956
Devang Patel2c4ceb12009-11-21 02:48:08 +0000957 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patel6325a532009-08-14 20:59:16 +0000958 if (L)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000959 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Pateld55224c2009-12-04 23:10:24 +0000960 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling0310d762009-05-15 09:23:25 +0000961
Devang Patel2c4ceb12009-11-21 02:48:08 +0000962 Buffer.addChild(DW_Subrange);
Bill Wendling0310d762009-05-15 09:23:25 +0000963}
964
Devang Patel2c4ceb12009-11-21 02:48:08 +0000965/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +0000966void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling0310d762009-05-15 09:23:25 +0000967 DICompositeType *CTy) {
968 Buffer.setTag(dwarf::DW_TAG_array_type);
969 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000970 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +0000971
972 // Emit derived type.
Devang Patel8a241142009-12-09 18:24:21 +0000973 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +0000974 DIArray Elements = CTy->getTypeArray();
975
Devang Patel6f01d9c2009-11-21 00:31:03 +0000976 // Get an anonymous type for index type.
Devang Patel8a241142009-12-09 18:24:21 +0000977 DIE *IdxTy = ModuleCU->getIndexTyDie();
Devang Patel6f01d9c2009-11-21 00:31:03 +0000978 if (!IdxTy) {
979 // Construct an anonymous type for index type.
980 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000981 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
982 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel6f01d9c2009-11-21 00:31:03 +0000983 dwarf::DW_ATE_signed);
Devang Patel8a241142009-12-09 18:24:21 +0000984 ModuleCU->addDie(IdxTy);
985 ModuleCU->setIndexTyDie(IdxTy);
Devang Patel6f01d9c2009-11-21 00:31:03 +0000986 }
Bill Wendling0310d762009-05-15 09:23:25 +0000987
988 // Add subranges to array type.
989 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
990 DIDescriptor Element = Elements.getElement(i);
991 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000992 constructSubrangeDIE(Buffer, DISubrange(Element.getNode()), IdxTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000993 }
994}
995
Devang Patel2c4ceb12009-11-21 02:48:08 +0000996/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel8a241142009-12-09 18:24:21 +0000997DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator *ETy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000998 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel65dbc902009-11-25 17:36:49 +0000999 StringRef Name = ETy->getName();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001000 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001001 int64_t Value = ETy->getEnumValue();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001002 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling0310d762009-05-15 09:23:25 +00001003 return Enumerator;
1004}
1005
Devang Patel2c4ceb12009-11-21 02:48:08 +00001006/// createGlobalVariableDIE - Create new DIE using GV.
Devang Patel8a241142009-12-09 18:24:21 +00001007DIE *DwarfDebug::createGlobalVariableDIE(const DIGlobalVariable &GV) {
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001008 // If the global variable was optmized out then no need to create debug info
1009 // entry.
Devang Patel84c73e92009-11-06 17:58:12 +00001010 if (!GV.getGlobal()) return NULL;
Devang Patel65dbc902009-11-25 17:36:49 +00001011 if (GV.getDisplayName().empty()) return NULL;
Devang Patel465c3be2009-11-06 01:30:04 +00001012
Bill Wendling0310d762009-05-15 09:23:25 +00001013 DIE *GVDie = new DIE(dwarf::DW_TAG_variable);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001014 addString(GVDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001015 GV.getDisplayName());
1016
Devang Patel65dbc902009-11-25 17:36:49 +00001017 StringRef LinkageName = GV.getLinkageName();
1018 if (!LinkageName.empty()) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001019 // Skip special LLVM prefix that is used to inform the asm printer to not
1020 // emit usual symbol prefix before the symbol name. This happens for
1021 // Objective-C symbol names and symbol whose name is replaced using GCC's
1022 // __asm__ attribute.
Devang Patel53cb17d2009-07-16 01:01:22 +00001023 if (LinkageName[0] == 1)
Benjamin Kramer1c3451f2009-11-25 18:26:09 +00001024 LinkageName = LinkageName.substr(1);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001025 addString(GVDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel1a8d2d22009-07-14 00:55:28 +00001026 LinkageName);
Devang Patel53cb17d2009-07-16 01:01:22 +00001027 }
Devang Patel8a241142009-12-09 18:24:21 +00001028 addType(GVDie, GV.getType());
Bill Wendling0310d762009-05-15 09:23:25 +00001029 if (!GV.isLocalToUnit())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001030 addUInt(GVDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1031 addSourceLine(GVDie, &GV);
Devang Patelb71a16d2009-10-05 23:22:08 +00001032
1033 // Add address.
1034 DIEBlock *Block = new DIEBlock();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001035 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1036 addObjectLabel(Block, 0, dwarf::DW_FORM_udata,
Devang Patelb71a16d2009-10-05 23:22:08 +00001037 Asm->Mang->getMangledName(GV.getGlobal()));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001038 addBlock(GVDie, dwarf::DW_AT_location, 0, Block);
Devang Patelb71a16d2009-10-05 23:22:08 +00001039
Bill Wendling0310d762009-05-15 09:23:25 +00001040 return GVDie;
1041}
1042
Devang Patel2c4ceb12009-11-21 02:48:08 +00001043/// createMemberDIE - Create new member DIE.
Devang Patel8a241142009-12-09 18:24:21 +00001044DIE *DwarfDebug::createMemberDIE(const DIDerivedType &DT) {
Bill Wendling0310d762009-05-15 09:23:25 +00001045 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel65dbc902009-11-25 17:36:49 +00001046 StringRef Name = DT.getName();
1047 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001048 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel65dbc902009-11-25 17:36:49 +00001049
Devang Patel8a241142009-12-09 18:24:21 +00001050 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001051
Devang Patel2c4ceb12009-11-21 02:48:08 +00001052 addSourceLine(MemberDie, &DT);
Bill Wendling0310d762009-05-15 09:23:25 +00001053
Devang Patel33db5082009-11-04 22:06:12 +00001054 DIEBlock *MemLocationDie = new DIEBlock();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001055 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel33db5082009-11-04 22:06:12 +00001056
Bill Wendling0310d762009-05-15 09:23:25 +00001057 uint64_t Size = DT.getSizeInBits();
Devang Patel61ecbd12009-11-04 23:48:00 +00001058 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling0310d762009-05-15 09:23:25 +00001059
1060 if (Size != FieldSize) {
1061 // Handle bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001062 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1063 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling0310d762009-05-15 09:23:25 +00001064
1065 uint64_t Offset = DT.getOffsetInBits();
1066 uint64_t FieldOffset = Offset;
1067 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1068 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1069 FieldOffset = (HiMark - FieldSize);
1070 Offset -= FieldOffset;
1071
1072 // Maybe we need to work from the other end.
1073 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001074 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling0310d762009-05-15 09:23:25 +00001075
Devang Patel33db5082009-11-04 22:06:12 +00001076 // Here WD_AT_data_member_location points to the anonymous
1077 // field that includes this bit field.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001078 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001079
1080 } else
1081 // This is not a bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001082 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001083
Devang Patel2c4ceb12009-11-21 02:48:08 +00001084 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001085
1086 if (DT.isProtected())
Devang Patel5d11eb02009-12-03 19:11:07 +00001087 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001088 dwarf::DW_ACCESS_protected);
1089 else if (DT.isPrivate())
Devang Patel5d11eb02009-12-03 19:11:07 +00001090 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001091 dwarf::DW_ACCESS_private);
Devang Patel5d11eb02009-12-03 19:11:07 +00001092 else if (DT.getTag() == dwarf::DW_TAG_inheritance)
1093 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1094 dwarf::DW_ACCESS_public);
1095 if (DT.isVirtual())
1096 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1097 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling0310d762009-05-15 09:23:25 +00001098 return MemberDie;
1099}
1100
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001101/// createRawSubprogramDIE - Create new partially incomplete DIE. This is
1102/// a helper routine used by createMemberSubprogramDIE and
1103/// createSubprogramDIE.
Devang Patel8a241142009-12-09 18:24:21 +00001104DIE *DwarfDebug::createRawSubprogramDIE(const DISubprogram &SP) {
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001105 DIE *SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel65dbc902009-11-25 17:36:49 +00001106 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling0310d762009-05-15 09:23:25 +00001107
Devang Patel65dbc902009-11-25 17:36:49 +00001108 StringRef LinkageName = SP.getLinkageName();
1109 if (!LinkageName.empty()) {
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001110 // Skip special LLVM prefix that is used to inform the asm printer to not
1111 // emit usual symbol prefix before the symbol name. This happens for
1112 // Objective-C symbol names and symbol whose name is replaced using GCC's
1113 // __asm__ attribute.
Devang Patel53cb17d2009-07-16 01:01:22 +00001114 if (LinkageName[0] == 1)
Benjamin Kramer1c3451f2009-11-25 18:26:09 +00001115 LinkageName = LinkageName.substr(1);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001116 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel1a8d2d22009-07-14 00:55:28 +00001117 LinkageName);
Devang Patel53cb17d2009-07-16 01:01:22 +00001118 }
Devang Patel2c4ceb12009-11-21 02:48:08 +00001119 addSourceLine(SPDie, &SP);
Bill Wendling0310d762009-05-15 09:23:25 +00001120
Bill Wendling0310d762009-05-15 09:23:25 +00001121 // Add prototyped tag, if C or ObjC.
1122 unsigned Lang = SP.getCompileUnit().getLanguage();
1123 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1124 Lang == dwarf::DW_LANG_ObjC)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001125 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001126
1127 // Add Return Type.
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001128 DICompositeType SPTy = SP.getType();
1129 DIArray Args = SPTy.getTypeArray();
Bill Wendling0310d762009-05-15 09:23:25 +00001130 unsigned SPTag = SPTy.getTag();
Devang Patel5d11eb02009-12-03 19:11:07 +00001131
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001132 if (Args.isNull() || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel8a241142009-12-09 18:24:21 +00001133 addType(SPDie, SPTy);
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001134 else
Devang Patel8a241142009-12-09 18:24:21 +00001135 addType(SPDie, DIType(Args.getElement(0).getNode()));
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001136
Devang Patel5d11eb02009-12-03 19:11:07 +00001137 unsigned VK = SP.getVirtuality();
1138 if (VK) {
1139 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
1140 DIEBlock *Block = new DIEBlock();
1141 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1142 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1143 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
1144 ContainingTypeMap.insert(std::make_pair(SPDie, WeakVH(SP.getContainingType().getNode())));
1145 }
1146
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001147 return SPDie;
1148}
1149
1150/// createMemberSubprogramDIE - Create new member DIE using SP. This routine
1151/// always returns a die with DW_AT_declaration attribute.
Devang Patel8a241142009-12-09 18:24:21 +00001152DIE *DwarfDebug::createMemberSubprogramDIE(const DISubprogram &SP) {
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001153 DIE *SPDie = ModuleCU->getDIE(SP.getNode());
1154 if (!SPDie)
Devang Patel8a241142009-12-09 18:24:21 +00001155 SPDie = createSubprogramDIE(SP);
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001156
1157 // If SPDie has DW_AT_declaration then reuse it.
1158 if (!SP.isDefinition())
1159 return SPDie;
1160
1161 // Otherwise create new DIE for the declaration. First push definition
1162 // DIE at the top level.
1163 if (TopLevelDIEs.insert(SPDie))
1164 TopLevelDIEsVector.push_back(SPDie);
1165
Devang Patel8a241142009-12-09 18:24:21 +00001166 SPDie = createRawSubprogramDIE(SP);
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001167
1168 // Add arguments.
1169 DICompositeType SPTy = SP.getType();
1170 DIArray Args = SPTy.getTypeArray();
1171 unsigned SPTag = SPTy.getTag();
1172 if (SPTag == dwarf::DW_TAG_subroutine_type)
1173 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1174 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel8a241142009-12-09 18:24:21 +00001175 addType(Arg, DIType(Args.getElement(i).getNode()));
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001176 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1); // ??
1177 SPDie->addChild(Arg);
1178 }
1179
1180 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1181 return SPDie;
1182}
1183
1184/// createSubprogramDIE - Create new DIE using SP.
Devang Patel8a241142009-12-09 18:24:21 +00001185DIE *DwarfDebug::createSubprogramDIE(const DISubprogram &SP) {
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001186 DIE *SPDie = ModuleCU->getDIE(SP.getNode());
1187 if (SPDie)
1188 return SPDie;
1189
Devang Patel8a241142009-12-09 18:24:21 +00001190 SPDie = createRawSubprogramDIE(SP);
Bill Wendling0310d762009-05-15 09:23:25 +00001191
1192 if (!SP.isDefinition()) {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001193 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001194
1195 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001196 // be handled while processing variables.
1197 DICompositeType SPTy = SP.getType();
1198 DIArray Args = SPTy.getTypeArray();
1199 unsigned SPTag = SPTy.getTag();
1200
Bill Wendling0310d762009-05-15 09:23:25 +00001201 if (SPTag == dwarf::DW_TAG_subroutine_type)
1202 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1203 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel8a241142009-12-09 18:24:21 +00001204 addType(Arg, DIType(Args.getElement(i).getNode()));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001205 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1); // ??
1206 SPDie->addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001207 }
1208 }
1209
Bill Wendling0310d762009-05-15 09:23:25 +00001210 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel8a241142009-12-09 18:24:21 +00001211 ModuleCU->insertDIE(SP.getNode(), SPDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001212 return SPDie;
1213}
1214
Devang Patel2c4ceb12009-11-21 02:48:08 +00001215/// findCompileUnit - Get the compile unit for the given descriptor.
Bill Wendling0310d762009-05-15 09:23:25 +00001216///
Devang Patel2c4ceb12009-11-21 02:48:08 +00001217CompileUnit &DwarfDebug::findCompileUnit(DICompileUnit Unit) const {
Bill Wendling0310d762009-05-15 09:23:25 +00001218 DenseMap<Value *, CompileUnit *>::const_iterator I =
Devang Patele4b27562009-08-28 23:24:31 +00001219 CompileUnitMap.find(Unit.getNode());
Bill Wendling0310d762009-05-15 09:23:25 +00001220 assert(I != CompileUnitMap.end() && "Missing compile unit.");
1221 return *I->second;
1222}
1223
Devang Patel53bb5c92009-11-10 23:06:00 +00001224/// getUpdatedDbgScope - Find or create DbgScope assicated with the instruction.
1225/// Initialize scope and update scope hierarchy.
1226DbgScope *DwarfDebug::getUpdatedDbgScope(MDNode *N, const MachineInstr *MI,
1227 MDNode *InlinedAt) {
1228 assert (N && "Invalid Scope encoding!");
1229 assert (MI && "Missing machine instruction!");
1230 bool GetConcreteScope = (MI && InlinedAt);
1231
1232 DbgScope *NScope = NULL;
1233
1234 if (InlinedAt)
1235 NScope = DbgScopeMap.lookup(InlinedAt);
1236 else
1237 NScope = DbgScopeMap.lookup(N);
1238 assert (NScope && "Unable to find working scope!");
1239
1240 if (NScope->getFirstInsn())
1241 return NScope;
Devang Patelaf9e8472009-10-01 20:31:14 +00001242
1243 DbgScope *Parent = NULL;
Devang Patel53bb5c92009-11-10 23:06:00 +00001244 if (GetConcreteScope) {
Devang Patelc90aefe2009-10-14 21:08:09 +00001245 DILocation IL(InlinedAt);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001246 Parent = getUpdatedDbgScope(IL.getScope().getNode(), MI,
Devang Patel53bb5c92009-11-10 23:06:00 +00001247 IL.getOrigLocation().getNode());
1248 assert (Parent && "Unable to find Parent scope!");
1249 NScope->setParent(Parent);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001250 Parent->addScope(NScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001251 } else if (DIDescriptor(N).isLexicalBlock()) {
1252 DILexicalBlock DB(N);
1253 if (!DB.getContext().isNull()) {
1254 Parent = getUpdatedDbgScope(DB.getContext().getNode(), MI, InlinedAt);
1255 NScope->setParent(Parent);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001256 Parent->addScope(NScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001257 }
Devang Patelc90aefe2009-10-14 21:08:09 +00001258 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001259
Devang Patelbdf45cb2009-10-27 20:47:17 +00001260 NScope->setFirstInsn(MI);
Devang Patelaf9e8472009-10-01 20:31:14 +00001261
Devang Patel53bb5c92009-11-10 23:06:00 +00001262 if (!Parent && !InlinedAt) {
Devang Patel39ae3ff2009-11-11 00:31:36 +00001263 StringRef SPName = DISubprogram(N).getLinkageName();
1264 if (SPName == MF->getFunction()->getName())
1265 CurrentFnDbgScope = NScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00001266 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001267
Devang Patel53bb5c92009-11-10 23:06:00 +00001268 if (GetConcreteScope) {
1269 ConcreteScopes[InlinedAt] = NScope;
1270 getOrCreateAbstractScope(N);
1271 }
1272
Devang Patelbdf45cb2009-10-27 20:47:17 +00001273 return NScope;
Devang Patelaf9e8472009-10-01 20:31:14 +00001274}
1275
Devang Patel53bb5c92009-11-10 23:06:00 +00001276DbgScope *DwarfDebug::getOrCreateAbstractScope(MDNode *N) {
1277 assert (N && "Invalid Scope encoding!");
1278
1279 DbgScope *AScope = AbstractScopes.lookup(N);
1280 if (AScope)
1281 return AScope;
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001282
Devang Patel53bb5c92009-11-10 23:06:00 +00001283 DbgScope *Parent = NULL;
1284
1285 DIDescriptor Scope(N);
1286 if (Scope.isLexicalBlock()) {
1287 DILexicalBlock DB(N);
1288 DIDescriptor ParentDesc = DB.getContext();
1289 if (!ParentDesc.isNull())
1290 Parent = getOrCreateAbstractScope(ParentDesc.getNode());
1291 }
1292
1293 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1294
1295 if (Parent)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001296 Parent->addScope(AScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001297 AScope->setAbstractScope();
1298 AbstractScopes[N] = AScope;
1299 if (DIDescriptor(N).isSubprogram())
1300 AbstractScopesList.push_back(AScope);
1301 return AScope;
1302}
Devang Patelaf9e8472009-10-01 20:31:14 +00001303
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001304/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel2c4ceb12009-11-21 02:48:08 +00001305/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1306/// If there are global variables in this scope then create and insert
1307/// DIEs for these variables.
1308DIE *DwarfDebug::updateSubprogramScopeDIE(MDNode *SPNode) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001309
Devang Patel017d1212009-11-20 21:37:22 +00001310 DIE *SPDie = ModuleCU->getDIE(SPNode);
Devang Patel53bb5c92009-11-10 23:06:00 +00001311 assert (SPDie && "Unable to find subprogram DIE!");
Devang Patel2c4ceb12009-11-21 02:48:08 +00001312 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Devang Patel53bb5c92009-11-10 23:06:00 +00001313 DWLabel("func_begin", SubprogramCount));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001314 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Devang Patel53bb5c92009-11-10 23:06:00 +00001315 DWLabel("func_end", SubprogramCount));
1316 MachineLocation Location(RI->getFrameRegister(*MF));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001317 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001318
Devang Patel53bb5c92009-11-10 23:06:00 +00001319 if (!DISubprogram(SPNode).isLocalToUnit())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001320 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patel53bb5c92009-11-10 23:06:00 +00001321
Devang Patel53bb5c92009-11-10 23:06:00 +00001322 return SPDie;
1323}
1324
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001325/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel2c4ceb12009-11-21 02:48:08 +00001326/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1327DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001328 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1329 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1330
1331 // Ignore empty scopes.
1332 if (StartID == EndID && StartID != 0)
1333 return NULL;
1334
1335 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1336 if (Scope->isAbstractScope())
1337 return ScopeDIE;
1338
Devang Patel2c4ceb12009-11-21 02:48:08 +00001339 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001340 StartID ?
1341 DWLabel("label", StartID)
Devang Patel53bb5c92009-11-10 23:06:00 +00001342 : DWLabel("func_begin", SubprogramCount));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001343 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001344 EndID ?
1345 DWLabel("label", EndID)
Devang Patel53bb5c92009-11-10 23:06:00 +00001346 : DWLabel("func_end", SubprogramCount));
1347
1348
1349
1350 return ScopeDIE;
1351}
1352
Devang Patel2c4ceb12009-11-21 02:48:08 +00001353/// constructInlinedScopeDIE - This scope represents inlined body of
1354/// a function. Construct DIE to represent this concrete inlined copy
1355/// of the function.
1356DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001357 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1358 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1359 assert (StartID && "Invalid starting label for an inlined scope!");
1360 assert (EndID && "Invalid end label for an inlined scope!");
1361 // Ignore empty scopes.
1362 if (StartID == EndID && StartID != 0)
1363 return NULL;
1364
1365 DIScope DS(Scope->getScopeNode());
1366 if (DS.isNull())
1367 return NULL;
1368 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1369
1370 DISubprogram InlinedSP = getDISubprogram(DS.getNode());
Devang Patel017d1212009-11-20 21:37:22 +00001371 DIE *OriginDIE = ModuleCU->getDIE(InlinedSP.getNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00001372 assert (OriginDIE && "Unable to find Origin DIE!");
Devang Patel2c4ceb12009-11-21 02:48:08 +00001373 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001374 dwarf::DW_FORM_ref4, OriginDIE);
1375
Devang Patel2c4ceb12009-11-21 02:48:08 +00001376 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Devang Patel53bb5c92009-11-10 23:06:00 +00001377 DWLabel("label", StartID));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001378 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Devang Patel53bb5c92009-11-10 23:06:00 +00001379 DWLabel("label", EndID));
1380
1381 InlinedSubprogramDIEs.insert(OriginDIE);
1382
1383 // Track the start label for this inlined function.
1384 ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
1385 I = InlineInfo.find(InlinedSP.getNode());
1386
1387 if (I == InlineInfo.end()) {
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001388 InlineInfo[InlinedSP.getNode()].push_back(std::make_pair(StartID,
1389 ScopeDIE));
Devang Patel53bb5c92009-11-10 23:06:00 +00001390 InlinedSPNodes.push_back(InlinedSP.getNode());
1391 } else
1392 I->second.push_back(std::make_pair(StartID, ScopeDIE));
1393
1394 StringPool.insert(InlinedSP.getName());
1395 StringPool.insert(InlinedSP.getLinkageName());
1396 DILocation DL(Scope->getInlinedAt());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001397 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, ModuleCU->getID());
1398 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +00001399
1400 return ScopeDIE;
1401}
1402
Devang Patel2c4ceb12009-11-21 02:48:08 +00001403
1404/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel8a241142009-12-09 18:24:21 +00001405DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001406 // Get the descriptor.
1407 const DIVariable &VD = DV->getVariable();
Devang Patel65dbc902009-11-25 17:36:49 +00001408 StringRef Name = VD.getName();
1409 if (Name.empty())
Devang Patel3fb6bd62009-11-13 02:25:26 +00001410 return NULL;
Devang Patel53bb5c92009-11-10 23:06:00 +00001411
1412 // Translate tag to proper Dwarf tag. The result variable is dropped for
1413 // now.
1414 unsigned Tag;
1415 switch (VD.getTag()) {
1416 case dwarf::DW_TAG_return_variable:
1417 return NULL;
1418 case dwarf::DW_TAG_arg_variable:
1419 Tag = dwarf::DW_TAG_formal_parameter;
1420 break;
1421 case dwarf::DW_TAG_auto_variable: // fall thru
1422 default:
1423 Tag = dwarf::DW_TAG_variable;
1424 break;
1425 }
1426
1427 // Define variable debug information entry.
1428 DIE *VariableDie = new DIE(Tag);
1429
1430
1431 DIE *AbsDIE = NULL;
1432 if (DbgVariable *AV = DV->getAbstractVariable())
1433 AbsDIE = AV->getDIE();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001434
Devang Patel53bb5c92009-11-10 23:06:00 +00001435 if (AbsDIE) {
1436 DIScope DS(Scope->getScopeNode());
1437 DISubprogram InlinedSP = getDISubprogram(DS.getNode());
Devang Patel017d1212009-11-20 21:37:22 +00001438 DIE *OriginSPDIE = ModuleCU->getDIE(InlinedSP.getNode());
Daniel Dunbarc0326792009-11-11 03:09:50 +00001439 (void) OriginSPDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +00001440 assert (OriginSPDIE && "Unable to find Origin DIE for the SP!");
1441 DIE *AbsDIE = DV->getAbstractVariable()->getDIE();
1442 assert (AbsDIE && "Unable to find Origin DIE for the Variable!");
Devang Patel2c4ceb12009-11-21 02:48:08 +00001443 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001444 dwarf::DW_FORM_ref4, AbsDIE);
1445 }
1446 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001447 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
1448 addSourceLine(VariableDie, &VD);
Devang Patel53bb5c92009-11-10 23:06:00 +00001449
1450 // Add variable type.
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001451 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
Devang Patel53bb5c92009-11-10 23:06:00 +00001452 // addresses instead.
1453 if (VD.isBlockByrefVariable())
Devang Patel8a241142009-12-09 18:24:21 +00001454 addType(VariableDie, getBlockByrefType(VD.getType(), Name));
Devang Patel53bb5c92009-11-10 23:06:00 +00001455 else
Devang Patel8a241142009-12-09 18:24:21 +00001456 addType(VariableDie, VD.getType());
Devang Patel53bb5c92009-11-10 23:06:00 +00001457 }
1458
1459 // Add variable address.
1460 if (!Scope->isAbstractScope()) {
1461 MachineLocation Location;
Jim Grosbacha2f20b22009-11-22 20:14:00 +00001462 unsigned FrameReg;
1463 int Offset = RI->getFrameIndexReference(*MF, DV->getFrameIndex(), FrameReg);
1464 Location.set(FrameReg, Offset);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001465
Devang Patel53bb5c92009-11-10 23:06:00 +00001466 if (VD.hasComplexAddress())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001467 addComplexAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
Devang Patel53bb5c92009-11-10 23:06:00 +00001468 else if (VD.isBlockByrefVariable())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001469 addBlockByrefAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
Devang Patel53bb5c92009-11-10 23:06:00 +00001470 else
Devang Patel2c4ceb12009-11-21 02:48:08 +00001471 addAddress(VariableDie, dwarf::DW_AT_location, Location);
Devang Patel53bb5c92009-11-10 23:06:00 +00001472 }
1473 DV->setDIE(VariableDie);
1474 return VariableDie;
1475
1476}
Devang Patel2c4ceb12009-11-21 02:48:08 +00001477
Devang Patel193f7202009-11-24 01:14:22 +00001478void DwarfDebug::addPubTypes(DISubprogram SP) {
1479 DICompositeType SPTy = SP.getType();
1480 unsigned SPTag = SPTy.getTag();
1481 if (SPTag != dwarf::DW_TAG_subroutine_type)
1482 return;
1483
1484 DIArray Args = SPTy.getTypeArray();
1485 if (Args.isNull())
1486 return;
1487
1488 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
1489 DIType ATy(Args.getElement(i).getNode());
1490 if (ATy.isNull())
1491 continue;
1492 DICompositeType CATy = getDICompositeType(ATy);
Devang Patel65dbc902009-11-25 17:36:49 +00001493 if (!CATy.isNull() && !CATy.getName().empty()) {
Devang Patel193f7202009-11-24 01:14:22 +00001494 if (DIEEntry *Entry = ModuleCU->getDIEEntry(CATy.getNode()))
1495 ModuleCU->addGlobalType(CATy.getName(), Entry->getEntry());
1496 }
1497 }
1498}
1499
Devang Patel2c4ceb12009-11-21 02:48:08 +00001500/// constructScopeDIE - Construct a DIE for this scope.
1501DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001502 if (!Scope)
1503 return NULL;
1504 DIScope DS(Scope->getScopeNode());
1505 if (DS.isNull())
1506 return NULL;
1507
1508 DIE *ScopeDIE = NULL;
1509 if (Scope->getInlinedAt())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001510 ScopeDIE = constructInlinedScopeDIE(Scope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001511 else if (DS.isSubprogram()) {
1512 if (Scope->isAbstractScope())
Devang Patel017d1212009-11-20 21:37:22 +00001513 ScopeDIE = ModuleCU->getDIE(DS.getNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00001514 else
Devang Patel2c4ceb12009-11-21 02:48:08 +00001515 ScopeDIE = updateSubprogramScopeDIE(DS.getNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00001516 }
1517 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001518 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001519 if (!ScopeDIE) return NULL;
1520 }
1521
1522 // Add variables to scope.
1523 SmallVector<DbgVariable *, 8> &Variables = Scope->getVariables();
1524 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel8a241142009-12-09 18:24:21 +00001525 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001526 if (VariableDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001527 ScopeDIE->addChild(VariableDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001528 }
1529
1530 // Add nested scopes.
1531 SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
1532 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1533 // Define the Scope debug information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001534 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001535 if (NestedDIE)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001536 ScopeDIE->addChild(NestedDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +00001537 }
Devang Patel193f7202009-11-24 01:14:22 +00001538
1539 if (DS.isSubprogram())
1540 addPubTypes(DISubprogram(DS.getNode()));
1541
1542 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +00001543}
1544
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001545/// GetOrCreateSourceID - Look up the source id with the given directory and
1546/// source file names. If none currently exists, create a new id and insert it
1547/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1548/// maps as well.
Devang Patel65dbc902009-11-25 17:36:49 +00001549unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001550 unsigned DId;
1551 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1552 if (DI != DirectoryIdMap.end()) {
1553 DId = DI->getValue();
1554 } else {
1555 DId = DirectoryNames.size() + 1;
1556 DirectoryIdMap[DirName] = DId;
1557 DirectoryNames.push_back(DirName);
1558 }
1559
1560 unsigned FId;
1561 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1562 if (FI != SourceFileIdMap.end()) {
1563 FId = FI->getValue();
1564 } else {
1565 FId = SourceFileNames.size() + 1;
1566 SourceFileIdMap[FileName] = FId;
1567 SourceFileNames.push_back(FileName);
1568 }
1569
1570 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1571 SourceIdMap.find(std::make_pair(DId, FId));
1572 if (SI != SourceIdMap.end())
1573 return SI->second;
1574
1575 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1576 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1577 SourceIds.push_back(std::make_pair(DId, FId));
1578
1579 return SrcId;
1580}
1581
Devang Patel2c4ceb12009-11-21 02:48:08 +00001582void DwarfDebug::constructCompileUnit(MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001583 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +00001584 StringRef FN = DIUnit.getFilename();
1585 StringRef Dir = DIUnit.getDirectory();
Devang Patel5ccdd102009-09-29 18:40:58 +00001586 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001587
1588 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001589 addSectionOffset(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001590 DWLabel("section_line", 0), DWLabel("section_line", 0),
1591 false);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001592 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001593 DIUnit.getProducer());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001594 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001595 DIUnit.getLanguage());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001596 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001597
Devang Patel65dbc902009-11-25 17:36:49 +00001598 if (!Dir.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001599 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001600 if (DIUnit.isOptimized())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001601 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001602
Devang Patel65dbc902009-11-25 17:36:49 +00001603 StringRef Flags = DIUnit.getFlags();
1604 if (!Flags.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001605 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001606
1607 unsigned RVer = DIUnit.getRunTimeVersion();
1608 if (RVer)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001609 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001610 dwarf::DW_FORM_data1, RVer);
1611
1612 CompileUnit *Unit = new CompileUnit(ID, Die);
Devang Patel1dbc7712009-06-29 20:45:18 +00001613 if (!ModuleCU && DIUnit.isMain()) {
Devang Patel70f44262009-06-29 20:38:13 +00001614 // Use first compile unit marked as isMain as the compile unit
1615 // for this module.
Devang Patel1dbc7712009-06-29 20:45:18 +00001616 ModuleCU = Unit;
Devang Patel70f44262009-06-29 20:38:13 +00001617 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001618
Devang Patele4b27562009-08-28 23:24:31 +00001619 CompileUnitMap[DIUnit.getNode()] = Unit;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001620 CompileUnits.push_back(Unit);
1621}
1622
Devang Patel2c4ceb12009-11-21 02:48:08 +00001623void DwarfDebug::constructGlobalVariableDIE(MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001624 DIGlobalVariable DI_GV(N);
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001625
Devang Patel905cf5e2009-09-04 23:59:07 +00001626 // If debug information is malformed then ignore it.
1627 if (DI_GV.Verify() == false)
1628 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001629
1630 // Check for pre-existence.
Devang Patel017d1212009-11-20 21:37:22 +00001631 if (ModuleCU->getDIE(DI_GV.getNode()))
Devang Patel13e16b62009-06-26 01:49:18 +00001632 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001633
Devang Patel8a241142009-12-09 18:24:21 +00001634 DIE *VariableDie = createGlobalVariableDIE(DI_GV);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001635
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001636 // Add to map.
Devang Patel017d1212009-11-20 21:37:22 +00001637 ModuleCU->insertDIE(N, VariableDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001638
1639 // Add to context owner.
Devang Patelc366f832009-12-10 19:14:49 +00001640 addToContextOwner(VariableDie, DI_GV.getContext());
1641
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001642 // Expose as global. FIXME - need to check external flag.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001643 ModuleCU->addGlobal(DI_GV.getName(), VariableDie);
Devang Patel193f7202009-11-24 01:14:22 +00001644
1645 DIType GTy = DI_GV.getType();
Devang Patel65dbc902009-11-25 17:36:49 +00001646 if (GTy.isCompositeType() && !GTy.getName().empty()) {
Devang Patel193f7202009-11-24 01:14:22 +00001647 DIEEntry *Entry = ModuleCU->getDIEEntry(GTy.getNode());
1648 assert (Entry && "Missing global type!");
1649 ModuleCU->addGlobalType(GTy.getName(), Entry->getEntry());
1650 }
Devang Patel13e16b62009-06-26 01:49:18 +00001651 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001652}
1653
Devang Patel2c4ceb12009-11-21 02:48:08 +00001654void DwarfDebug::constructSubprogramDIE(MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001655 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001656
1657 // Check for pre-existence.
Devang Patel017d1212009-11-20 21:37:22 +00001658 if (ModuleCU->getDIE(N))
Devang Patel13e16b62009-06-26 01:49:18 +00001659 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001660
1661 if (!SP.isDefinition())
1662 // This is a method declaration which will be handled while constructing
1663 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +00001664 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001665
Devang Patel8a241142009-12-09 18:24:21 +00001666 DIE *SubprogramDie = createSubprogramDIE(SP);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001667
1668 // Add to map.
Devang Patel017d1212009-11-20 21:37:22 +00001669 ModuleCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001670
1671 // Add to context owner.
Devang Patel0000fad2009-12-08 23:21:45 +00001672 if (SP.getContext().getNode() == SP.getCompileUnit().getNode())
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001673 if (TopLevelDIEs.insert(SubprogramDie))
1674 TopLevelDIEsVector.push_back(SubprogramDie);
Devang Patel0000fad2009-12-08 23:21:45 +00001675
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001676 // Expose as global.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001677 ModuleCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel193f7202009-11-24 01:14:22 +00001678
Devang Patel13e16b62009-06-26 01:49:18 +00001679 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001680}
1681
Devang Patel2c4ceb12009-11-21 02:48:08 +00001682/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbar00564992009-09-19 20:40:14 +00001683/// content. Create global DIEs and emit initial debug info sections.
1684/// This is inovked by the target AsmPrinter.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001685void DwarfDebug::beginModule(Module *M, MachineModuleInfo *mmi) {
Devang Patel208622d2009-06-25 22:36:02 +00001686 this->M = M;
1687
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001688 if (TimePassesIsEnabled)
1689 DebugTimer->startTimer();
1690
Devang Patel3380cc52009-11-11 19:55:08 +00001691 if (!MAI->doesSupportDebugInformation())
1692 return;
1693
Devang Patel78ab9e22009-07-30 18:56:46 +00001694 DebugInfoFinder DbgFinder;
1695 DbgFinder.processModule(*M);
Devang Patel13e16b62009-06-26 01:49:18 +00001696
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001697 // Create all the compile unit DIEs.
Devang Patel78ab9e22009-07-30 18:56:46 +00001698 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1699 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001700 constructCompileUnit(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001701
1702 if (CompileUnits.empty()) {
1703 if (TimePassesIsEnabled)
1704 DebugTimer->stopTimer();
1705
1706 return;
1707 }
1708
Devang Patel70f44262009-06-29 20:38:13 +00001709 // If main compile unit for this module is not seen than randomly
1710 // select first compile unit.
Devang Patel1dbc7712009-06-29 20:45:18 +00001711 if (!ModuleCU)
1712 ModuleCU = CompileUnits[0];
Devang Patel70f44262009-06-29 20:38:13 +00001713
Devang Patel53bb5c92009-11-10 23:06:00 +00001714 // Create DIEs for each subprogram.
Devang Patel78ab9e22009-07-30 18:56:46 +00001715 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
1716 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001717 constructSubprogramDIE(*I);
Devang Patel13e16b62009-06-26 01:49:18 +00001718
Devang Patelc366f832009-12-10 19:14:49 +00001719 // Create DIEs for each global variable.
1720 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
1721 E = DbgFinder.global_variable_end(); I != E; ++I)
1722 constructGlobalVariableDIE(*I);
1723
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001724 MMI = mmi;
1725 shouldEmit = true;
1726 MMI->setDebugInfoAvailability(true);
1727
1728 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +00001729 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001730
1731 // Print out .file directives to specify files for .loc directives. These are
1732 // printed out early so that they precede any .loc directives.
Chris Lattner33adcfb2009-08-22 21:43:10 +00001733 if (MAI->hasDotLocAndDotFile()) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001734 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
1735 // Remember source id starts at 1.
1736 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
1737 sys::Path FullPath(getSourceDirectoryName(Id.first));
1738 bool AppendOk =
1739 FullPath.appendComponent(getSourceFileName(Id.second));
1740 assert(AppendOk && "Could not append filename to directory!");
1741 AppendOk = false;
Chris Lattner74382b72009-08-23 22:45:37 +00001742 Asm->EmitFile(i, FullPath.str());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001743 Asm->EOL();
1744 }
1745 }
1746
1747 // Emit initial sections
Devang Patel2c4ceb12009-11-21 02:48:08 +00001748 emitInitial();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001749
1750 if (TimePassesIsEnabled)
1751 DebugTimer->stopTimer();
1752}
1753
Devang Patel2c4ceb12009-11-21 02:48:08 +00001754/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001755///
Devang Patel2c4ceb12009-11-21 02:48:08 +00001756void DwarfDebug::endModule() {
Devang Patel6f3dc922009-10-06 00:03:14 +00001757 if (!ModuleCU)
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001758 return;
1759
1760 if (TimePassesIsEnabled)
1761 DebugTimer->startTimer();
1762
Devang Patel53bb5c92009-11-10 23:06:00 +00001763 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1764 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
1765 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
1766 DIE *ISP = *AI;
Devang Patel2c4ceb12009-11-21 02:48:08 +00001767 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +00001768 }
1769
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001770 // Insert top level DIEs.
1771 for (SmallVector<DIE *, 4>::iterator TI = TopLevelDIEsVector.begin(),
1772 TE = TopLevelDIEsVector.end(); TI != TE; ++TI)
1773 ModuleCU->getCUDie()->addChild(*TI);
1774
Devang Patel5d11eb02009-12-03 19:11:07 +00001775 for (DenseMap<DIE *, WeakVH>::iterator CI = ContainingTypeMap.begin(),
1776 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
1777 DIE *SPDie = CI->first;
1778 MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
1779 if (!N) continue;
1780 DIE *NDie = ModuleCU->getDIE(N);
1781 if (!NDie) continue;
1782 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
1783 addDIEEntry(NDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
1784 }
1785
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001786 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001787 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001788 EmitLabel("text_end", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001789 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001790 EmitLabel("data_end", 0);
1791
1792 // End text sections.
1793 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001794 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001795 EmitLabel("section_end", i);
1796 }
1797
1798 // Emit common frame information.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001799 emitCommonDebugFrame();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001800
1801 // Emit function debug frame information
1802 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
1803 E = DebugFrames.end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001804 emitFunctionDebugFrame(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001805
1806 // Compute DIE offsets and sizes.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001807 computeSizeAndOffsets();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001808
1809 // Emit all the DIEs into a debug info section
Devang Patel2c4ceb12009-11-21 02:48:08 +00001810 emitDebugInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001811
1812 // Corresponding abbreviations into a abbrev section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001813 emitAbbreviations();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001814
1815 // Emit source line correspondence into a debug line section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001816 emitDebugLines();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001817
1818 // Emit info into a debug pubnames section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001819 emitDebugPubNames();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001820
Devang Patel193f7202009-11-24 01:14:22 +00001821 // Emit info into a debug pubtypes section.
1822 emitDebugPubTypes();
1823
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001824 // Emit info into a debug str section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001825 emitDebugStr();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001826
1827 // Emit info into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001828 emitDebugLoc();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001829
1830 // Emit info into a debug aranges section.
1831 EmitDebugARanges();
1832
1833 // Emit info into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001834 emitDebugRanges();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001835
1836 // Emit info into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001837 emitDebugMacInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001838
1839 // Emit inline info.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001840 emitDebugInlineInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001841
1842 if (TimePassesIsEnabled)
1843 DebugTimer->stopTimer();
1844}
1845
Devang Patel53bb5c92009-11-10 23:06:00 +00001846/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001847DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
1848 unsigned FrameIdx,
Devang Patel53bb5c92009-11-10 23:06:00 +00001849 DILocation &ScopeLoc) {
1850
1851 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var.getNode());
1852 if (AbsDbgVariable)
1853 return AbsDbgVariable;
1854
1855 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope().getNode());
1856 if (!Scope)
1857 return NULL;
1858
1859 AbsDbgVariable = new DbgVariable(Var, FrameIdx);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001860 Scope->addVariable(AbsDbgVariable);
Devang Patel53bb5c92009-11-10 23:06:00 +00001861 AbstractVariables[Var.getNode()] = AbsDbgVariable;
1862 return AbsDbgVariable;
1863}
1864
Devang Patel2c4ceb12009-11-21 02:48:08 +00001865/// collectVariableInfo - Populate DbgScope entries with variables' info.
1866void DwarfDebug::collectVariableInfo() {
Devang Patelac1ceb32009-10-09 22:42:28 +00001867 if (!MMI) return;
Devang Patel53bb5c92009-11-10 23:06:00 +00001868
Devang Patele717faa2009-10-06 01:26:37 +00001869 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1870 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1871 VE = VMap.end(); VI != VE; ++VI) {
Devang Patelac1ceb32009-10-09 22:42:28 +00001872 MetadataBase *MB = VI->first;
1873 MDNode *Var = dyn_cast_or_null<MDNode>(MB);
Devang Patel53bb5c92009-11-10 23:06:00 +00001874 if (!Var) continue;
Devang Pateleda31212009-10-08 18:48:03 +00001875 DIVariable DV (Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00001876 std::pair< unsigned, MDNode *> VP = VI->second;
1877 DILocation ScopeLoc(VP.second);
1878
1879 DbgScope *Scope =
1880 ConcreteScopes.lookup(ScopeLoc.getOrigLocation().getNode());
1881 if (!Scope)
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001882 Scope = DbgScopeMap.lookup(ScopeLoc.getScope().getNode());
Devang Patelfb0ee432009-11-10 23:20:04 +00001883 // If variable scope is not found then skip this variable.
1884 if (!Scope)
1885 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00001886
1887 DbgVariable *RegVar = new DbgVariable(DV, VP.first);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001888 Scope->addVariable(RegVar);
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001889 if (DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.first,
1890 ScopeLoc))
Devang Patel53bb5c92009-11-10 23:06:00 +00001891 RegVar->setAbstractVariable(AbsDbgVariable);
Devang Patele717faa2009-10-06 01:26:37 +00001892 }
1893}
1894
Devang Patel2c4ceb12009-11-21 02:48:08 +00001895/// beginScope - Process beginning of a scope starting at Label.
1896void DwarfDebug::beginScope(const MachineInstr *MI, unsigned Label) {
Devang Patel0d20ac82009-10-06 01:50:42 +00001897 InsnToDbgScopeMapTy::iterator I = DbgScopeBeginMap.find(MI);
1898 if (I == DbgScopeBeginMap.end())
1899 return;
Dan Gohman277207e2009-11-23 21:30:55 +00001900 ScopeVector &SD = I->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00001901 for (ScopeVector::iterator SDI = SD.begin(), SDE = SD.end();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001902 SDI != SDE; ++SDI)
Devang Patel0d20ac82009-10-06 01:50:42 +00001903 (*SDI)->setStartLabelID(Label);
1904}
1905
Devang Patel2c4ceb12009-11-21 02:48:08 +00001906/// endScope - Process end of a scope.
1907void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel0d20ac82009-10-06 01:50:42 +00001908 InsnToDbgScopeMapTy::iterator I = DbgScopeEndMap.find(MI);
Devang Patel8a4087d2009-10-06 03:15:38 +00001909 if (I == DbgScopeEndMap.end())
Devang Patel0d20ac82009-10-06 01:50:42 +00001910 return;
Devang Patel53bb5c92009-11-10 23:06:00 +00001911
1912 unsigned Label = MMI->NextLabelID();
1913 Asm->printLabel(Label);
Dan Gohmaneecb9912009-12-05 01:42:34 +00001914 O << '\n';
Devang Patel53bb5c92009-11-10 23:06:00 +00001915
Devang Patel0d20ac82009-10-06 01:50:42 +00001916 SmallVector<DbgScope *, 2> &SD = I->second;
1917 for (SmallVector<DbgScope *, 2>::iterator SDI = SD.begin(), SDE = SD.end();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001918 SDI != SDE; ++SDI)
Devang Patel0d20ac82009-10-06 01:50:42 +00001919 (*SDI)->setEndLabelID(Label);
Devang Patel53bb5c92009-11-10 23:06:00 +00001920 return;
1921}
1922
1923/// createDbgScope - Create DbgScope for the scope.
1924void DwarfDebug::createDbgScope(MDNode *Scope, MDNode *InlinedAt) {
1925
1926 if (!InlinedAt) {
1927 DbgScope *WScope = DbgScopeMap.lookup(Scope);
1928 if (WScope)
1929 return;
1930 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
1931 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001932 if (DIDescriptor(Scope).isLexicalBlock())
Devang Patel2f105c62009-11-11 00:18:40 +00001933 createDbgScope(DILexicalBlock(Scope).getContext().getNode(), NULL);
Devang Patel53bb5c92009-11-10 23:06:00 +00001934 return;
1935 }
1936
1937 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
1938 if (WScope)
1939 return;
1940
1941 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
1942 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
1943 DILocation DL(InlinedAt);
1944 createDbgScope(DL.getScope().getNode(), DL.getOrigLocation().getNode());
Devang Patel0d20ac82009-10-06 01:50:42 +00001945}
1946
Devang Patel2c4ceb12009-11-21 02:48:08 +00001947/// extractScopeInformation - Scan machine instructions in this function
Devang Patelaf9e8472009-10-01 20:31:14 +00001948/// and collect DbgScopes. Return true, if atleast one scope was found.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001949bool DwarfDebug::extractScopeInformation(MachineFunction *MF) {
Devang Patelaf9e8472009-10-01 20:31:14 +00001950 // If scope information was extracted using .dbg intrinsics then there is not
1951 // any need to extract these information by scanning each instruction.
1952 if (!DbgScopeMap.empty())
1953 return false;
1954
Devang Patel53bb5c92009-11-10 23:06:00 +00001955 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patelaf9e8472009-10-01 20:31:14 +00001956 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
1957 I != E; ++I) {
1958 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1959 II != IE; ++II) {
1960 const MachineInstr *MInsn = II;
1961 DebugLoc DL = MInsn->getDebugLoc();
Devang Patel53bb5c92009-11-10 23:06:00 +00001962 if (DL.isUnknown()) continue;
Devang Patelaf9e8472009-10-01 20:31:14 +00001963 DebugLocTuple DLT = MF->getDebugLocTuple(DL);
Devang Patel53bb5c92009-11-10 23:06:00 +00001964 if (!DLT.Scope) continue;
Devang Patelaf9e8472009-10-01 20:31:14 +00001965 // There is no need to create another DIE for compile unit. For all
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001966 // other scopes, create one DbgScope now. This will be translated
Devang Patelaf9e8472009-10-01 20:31:14 +00001967 // into a scope DIE at the end.
Devang Patel53bb5c92009-11-10 23:06:00 +00001968 if (DIDescriptor(DLT.Scope).isCompileUnit()) continue;
1969 createDbgScope(DLT.Scope, DLT.InlinedAtLoc);
1970 }
1971 }
1972
1973
1974 // Build scope hierarchy using working set of scopes.
1975 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
1976 I != E; ++I) {
1977 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1978 II != IE; ++II) {
1979 const MachineInstr *MInsn = II;
1980 DebugLoc DL = MInsn->getDebugLoc();
1981 if (DL.isUnknown()) continue;
1982 DebugLocTuple DLT = MF->getDebugLocTuple(DL);
1983 if (!DLT.Scope) continue;
1984 // There is no need to create another DIE for compile unit. For all
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001985 // other scopes, create one DbgScope now. This will be translated
Devang Patel53bb5c92009-11-10 23:06:00 +00001986 // into a scope DIE at the end.
1987 if (DIDescriptor(DLT.Scope).isCompileUnit()) continue;
1988 DbgScope *Scope = getUpdatedDbgScope(DLT.Scope, MInsn, DLT.InlinedAtLoc);
1989 Scope->setLastInsn(MInsn);
Devang Patelaf9e8472009-10-01 20:31:14 +00001990 }
1991 }
1992
1993 // If a scope's last instruction is not set then use its child scope's
1994 // last instruction as this scope's last instrunction.
Devang Patelbdf45cb2009-10-27 20:47:17 +00001995 for (ValueMap<MDNode *, DbgScope *>::iterator DI = DbgScopeMap.begin(),
Devang Patelaf9e8472009-10-01 20:31:14 +00001996 DE = DbgScopeMap.end(); DI != DE; ++DI) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001997 if (DI->second->isAbstractScope())
1998 continue;
Devang Patelaf9e8472009-10-01 20:31:14 +00001999 assert (DI->second->getFirstInsn() && "Invalid first instruction!");
Devang Patel2c4ceb12009-11-21 02:48:08 +00002000 DI->second->fixInstructionMarkers();
Devang Patelaf9e8472009-10-01 20:31:14 +00002001 assert (DI->second->getLastInsn() && "Invalid last instruction!");
2002 }
2003
2004 // Each scope has first instruction and last instruction to mark beginning
2005 // and end of a scope respectively. Create an inverse map that list scopes
2006 // starts (and ends) with an instruction. One instruction may start (or end)
2007 // multiple scopes.
Devang Patelbdf45cb2009-10-27 20:47:17 +00002008 for (ValueMap<MDNode *, DbgScope *>::iterator DI = DbgScopeMap.begin(),
Devang Patelaf9e8472009-10-01 20:31:14 +00002009 DE = DbgScopeMap.end(); DI != DE; ++DI) {
2010 DbgScope *S = DI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00002011 if (S->isAbstractScope())
2012 continue;
Devang Patelaf9e8472009-10-01 20:31:14 +00002013 const MachineInstr *MI = S->getFirstInsn();
2014 assert (MI && "DbgScope does not have first instruction!");
2015
2016 InsnToDbgScopeMapTy::iterator IDI = DbgScopeBeginMap.find(MI);
2017 if (IDI != DbgScopeBeginMap.end())
2018 IDI->second.push_back(S);
2019 else
Devang Patel53bb5c92009-11-10 23:06:00 +00002020 DbgScopeBeginMap[MI].push_back(S);
Devang Patelaf9e8472009-10-01 20:31:14 +00002021
2022 MI = S->getLastInsn();
2023 assert (MI && "DbgScope does not have last instruction!");
2024 IDI = DbgScopeEndMap.find(MI);
2025 if (IDI != DbgScopeEndMap.end())
2026 IDI->second.push_back(S);
2027 else
Devang Patel53bb5c92009-11-10 23:06:00 +00002028 DbgScopeEndMap[MI].push_back(S);
Devang Patelaf9e8472009-10-01 20:31:14 +00002029 }
2030
2031 return !DbgScopeMap.empty();
2032}
2033
Devang Patel2c4ceb12009-11-21 02:48:08 +00002034/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002035/// emitted immediately after the function entry point.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002036void DwarfDebug::beginFunction(MachineFunction *MF) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002037 this->MF = MF;
2038
2039 if (!ShouldEmitDwarfDebug()) return;
2040
2041 if (TimePassesIsEnabled)
2042 DebugTimer->startTimer();
2043
Devang Patel2c4ceb12009-11-21 02:48:08 +00002044 if (!extractScopeInformation(MF))
Devang Patel60b35bd2009-10-06 18:37:31 +00002045 return;
Devang Patel2c4ceb12009-11-21 02:48:08 +00002046
2047 collectVariableInfo();
Devang Patel60b35bd2009-10-06 18:37:31 +00002048
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002049 // Begin accumulating function debug information.
2050 MMI->BeginFunction(MF);
2051
2052 // Assumes in correct section after the entry point.
2053 EmitLabel("func_begin", ++SubprogramCount);
2054
2055 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2056 // function.
Devang Patelac1ceb32009-10-09 22:42:28 +00002057 DebugLoc FDL = MF->getDefaultDebugLoc();
2058 if (!FDL.isUnknown()) {
2059 DebugLocTuple DLT = MF->getDebugLocTuple(FDL);
2060 unsigned LabelID = 0;
Devang Patel1619dc32009-10-13 23:28:53 +00002061 DISubprogram SP = getDISubprogram(DLT.Scope);
Devang Patelac1ceb32009-10-09 22:42:28 +00002062 if (!SP.isNull())
Devang Patel2c4ceb12009-11-21 02:48:08 +00002063 LabelID = recordSourceLine(SP.getLineNumber(), 0, DLT.Scope);
Devang Patelac1ceb32009-10-09 22:42:28 +00002064 else
Devang Patel2c4ceb12009-11-21 02:48:08 +00002065 LabelID = recordSourceLine(DLT.Line, DLT.Col, DLT.Scope);
Devang Patelac1ceb32009-10-09 22:42:28 +00002066 Asm->printLabel(LabelID);
2067 O << '\n';
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002068 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002069 if (TimePassesIsEnabled)
2070 DebugTimer->stopTimer();
2071}
2072
Devang Patel2c4ceb12009-11-21 02:48:08 +00002073/// endFunction - Gather and emit post-function debug information.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002074///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002075void DwarfDebug::endFunction(MachineFunction *MF) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002076 if (!ShouldEmitDwarfDebug()) return;
2077
2078 if (TimePassesIsEnabled)
2079 DebugTimer->startTimer();
2080
Devang Patelac1ceb32009-10-09 22:42:28 +00002081 if (DbgScopeMap.empty())
2082 return;
Devang Patel70d75ca2009-11-12 19:02:56 +00002083
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002084 // Define end label for subprogram.
2085 EmitLabel("func_end", SubprogramCount);
2086
2087 // Get function line info.
2088 if (!Lines.empty()) {
2089 // Get section line info.
Chris Lattner290c2f52009-08-03 23:20:21 +00002090 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002091 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2092 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2093 // Append the function info to section info.
2094 SectionLineInfos.insert(SectionLineInfos.end(),
2095 Lines.begin(), Lines.end());
2096 }
2097
Devang Patel53bb5c92009-11-10 23:06:00 +00002098 // Construct abstract scopes.
2099 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002100 AE = AbstractScopesList.end(); AI != AE; ++AI)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002101 constructScopeDIE(*AI);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002102
Devang Patel2c4ceb12009-11-21 02:48:08 +00002103 constructScopeDIE(CurrentFnDbgScope);
Devang Patel70d75ca2009-11-12 19:02:56 +00002104
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002105 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
2106 MMI->getFrameMoves()));
2107
2108 // Clear debug info
Devang Patelc09ddc12009-12-01 18:13:48 +00002109 CurrentFnDbgScope = NULL;
2110 DbgScopeMap.clear();
2111 DbgScopeBeginMap.clear();
2112 DbgScopeEndMap.clear();
2113 ConcreteScopes.clear();
2114 AbstractScopesList.clear();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002115
2116 Lines.clear();
Devang Patelc09ddc12009-12-01 18:13:48 +00002117
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002118 if (TimePassesIsEnabled)
2119 DebugTimer->stopTimer();
2120}
2121
Devang Patel2c4ceb12009-11-21 02:48:08 +00002122/// recordSourceLine - Records location information and associates it with a
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002123/// label. Returns a unique label ID used to generate a label and provide
2124/// correspondence to the source line list.
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002125unsigned DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patelf84548d2009-10-05 18:03:19 +00002126 MDNode *S) {
Devang Patele4b27562009-08-28 23:24:31 +00002127 if (!MMI)
2128 return 0;
2129
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002130 if (TimePassesIsEnabled)
2131 DebugTimer->startTimer();
2132
Devang Patel65dbc902009-11-25 17:36:49 +00002133 StringRef Dir;
2134 StringRef Fn;
Devang Patelf84548d2009-10-05 18:03:19 +00002135
2136 DIDescriptor Scope(S);
2137 if (Scope.isCompileUnit()) {
2138 DICompileUnit CU(S);
2139 Dir = CU.getDirectory();
2140 Fn = CU.getFilename();
2141 } else if (Scope.isSubprogram()) {
2142 DISubprogram SP(S);
2143 Dir = SP.getDirectory();
2144 Fn = SP.getFilename();
2145 } else if (Scope.isLexicalBlock()) {
2146 DILexicalBlock DB(S);
2147 Dir = DB.getDirectory();
2148 Fn = DB.getFilename();
2149 } else
2150 assert (0 && "Unexpected scope info");
2151
2152 unsigned Src = GetOrCreateSourceID(Dir, Fn);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002153 unsigned ID = MMI->NextLabelID();
2154 Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
2155
2156 if (TimePassesIsEnabled)
2157 DebugTimer->stopTimer();
2158
2159 return ID;
2160}
2161
2162/// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
2163/// timed. Look up the source id with the given directory and source file
2164/// names. If none currently exists, create a new id and insert it in the
2165/// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
2166/// well.
2167unsigned DwarfDebug::getOrCreateSourceID(const std::string &DirName,
2168 const std::string &FileName) {
2169 if (TimePassesIsEnabled)
2170 DebugTimer->startTimer();
2171
Devang Patel5ccdd102009-09-29 18:40:58 +00002172 unsigned SrcId = GetOrCreateSourceID(DirName.c_str(), FileName.c_str());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002173
2174 if (TimePassesIsEnabled)
2175 DebugTimer->stopTimer();
2176
2177 return SrcId;
2178}
2179
Bill Wendling829e67b2009-05-20 23:22:40 +00002180//===----------------------------------------------------------------------===//
2181// Emit Methods
2182//===----------------------------------------------------------------------===//
2183
Devang Patel2c4ceb12009-11-21 02:48:08 +00002184/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling94d04b82009-05-20 23:21:38 +00002185///
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002186unsigned
2187DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002188 // Get the children.
2189 const std::vector<DIE *> &Children = Die->getChildren();
2190
2191 // If not last sibling and has children then add sibling offset attribute.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002192 if (!Last && !Children.empty()) Die->addSiblingOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00002193
2194 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002195 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00002196
2197 // Get the abbreviation for this DIE.
2198 unsigned AbbrevNumber = Die->getAbbrevNumber();
2199 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2200
2201 // Set DIE offset
2202 Die->setOffset(Offset);
2203
2204 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00002205 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00002206
2207 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2208 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2209
2210 // Size the DIE attribute values.
2211 for (unsigned i = 0, N = Values.size(); i < N; ++i)
2212 // Size attribute value.
2213 Offset += Values[i]->SizeOf(TD, AbbrevData[i].getForm());
2214
2215 // Size the DIE children if any.
2216 if (!Children.empty()) {
2217 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
2218 "Children flag not set");
2219
2220 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002221 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling94d04b82009-05-20 23:21:38 +00002222
2223 // End of children marker.
2224 Offset += sizeof(int8_t);
2225 }
2226
2227 Die->setSize(Offset - Die->getOffset());
2228 return Offset;
2229}
2230
Devang Patel2c4ceb12009-11-21 02:48:08 +00002231/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling94d04b82009-05-20 23:21:38 +00002232///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002233void DwarfDebug::computeSizeAndOffsets() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002234 // Compute size of compile unit header.
2235 static unsigned Offset =
2236 sizeof(int32_t) + // Length of Compilation Unit Info
2237 sizeof(int16_t) + // DWARF version number
2238 sizeof(int32_t) + // Offset Into Abbrev. Section
2239 sizeof(int8_t); // Pointer Size (in bytes)
2240
Devang Patel2c4ceb12009-11-21 02:48:08 +00002241 computeSizeAndOffset(ModuleCU->getCUDie(), Offset, true);
Devang Patel1dbc7712009-06-29 20:45:18 +00002242 CompileUnitOffsets[ModuleCU] = 0;
Bill Wendling94d04b82009-05-20 23:21:38 +00002243}
2244
Devang Patel2c4ceb12009-11-21 02:48:08 +00002245/// emitInitial - Emit initial Dwarf declarations. This is necessary for cc
Bill Wendling94d04b82009-05-20 23:21:38 +00002246/// tools to recognize the object file contains Dwarf information.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002247void DwarfDebug::emitInitial() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002248 // Check to see if we already emitted intial headers.
2249 if (didInitial) return;
2250 didInitial = true;
2251
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002252 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002253
Bill Wendling94d04b82009-05-20 23:21:38 +00002254 // Dwarf sections base addresses.
Chris Lattner33adcfb2009-08-22 21:43:10 +00002255 if (MAI->doesDwarfRequireFrameSection()) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002256 Asm->OutStreamer.SwitchSection(TLOF.getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002257 EmitLabel("section_debug_frame", 0);
2258 }
2259
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002260 Asm->OutStreamer.SwitchSection(TLOF.getDwarfInfoSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002261 EmitLabel("section_info", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002262 Asm->OutStreamer.SwitchSection(TLOF.getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002263 EmitLabel("section_abbrev", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002264 Asm->OutStreamer.SwitchSection(TLOF.getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002265 EmitLabel("section_aranges", 0);
2266
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002267 if (const MCSection *LineInfoDirective = TLOF.getDwarfMacroInfoSection()) {
2268 Asm->OutStreamer.SwitchSection(LineInfoDirective);
Bill Wendling94d04b82009-05-20 23:21:38 +00002269 EmitLabel("section_macinfo", 0);
2270 }
2271
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002272 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002273 EmitLabel("section_line", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002274 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLocSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002275 EmitLabel("section_loc", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002276 Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubNamesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002277 EmitLabel("section_pubnames", 0);
Devang Patel193f7202009-11-24 01:14:22 +00002278 Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubTypesSection());
2279 EmitLabel("section_pubtypes", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002280 Asm->OutStreamer.SwitchSection(TLOF.getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002281 EmitLabel("section_str", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002282 Asm->OutStreamer.SwitchSection(TLOF.getDwarfRangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002283 EmitLabel("section_ranges", 0);
2284
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002285 Asm->OutStreamer.SwitchSection(TLOF.getTextSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002286 EmitLabel("text_begin", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002287 Asm->OutStreamer.SwitchSection(TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002288 EmitLabel("data_begin", 0);
2289}
2290
Devang Patel2c4ceb12009-11-21 02:48:08 +00002291/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling94d04b82009-05-20 23:21:38 +00002292///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002293void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002294 // Get the abbreviation for this DIE.
2295 unsigned AbbrevNumber = Die->getAbbrevNumber();
2296 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2297
2298 Asm->EOL();
2299
2300 // Emit the code (index) for the abbreviation.
2301 Asm->EmitULEB128Bytes(AbbrevNumber);
2302
2303 if (Asm->isVerbose())
2304 Asm->EOL(std::string("Abbrev [" +
2305 utostr(AbbrevNumber) +
2306 "] 0x" + utohexstr(Die->getOffset()) +
2307 ":0x" + utohexstr(Die->getSize()) + " " +
2308 dwarf::TagString(Abbrev->getTag())));
2309 else
2310 Asm->EOL();
2311
2312 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2313 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2314
2315 // Emit the DIE attribute values.
2316 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2317 unsigned Attr = AbbrevData[i].getAttribute();
2318 unsigned Form = AbbrevData[i].getForm();
2319 assert(Form && "Too many attributes for DIE (check abbreviation)");
2320
2321 switch (Attr) {
2322 case dwarf::DW_AT_sibling:
Devang Patel2c4ceb12009-11-21 02:48:08 +00002323 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00002324 break;
2325 case dwarf::DW_AT_abstract_origin: {
2326 DIEEntry *E = cast<DIEEntry>(Values[i]);
2327 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00002328 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00002329 Asm->EmitInt32(Addr);
2330 break;
2331 }
2332 default:
2333 // Emit an attribute using the defined form.
2334 Values[i]->EmitValue(this, Form);
2335 break;
2336 }
2337
2338 Asm->EOL(dwarf::AttributeString(Attr));
2339 }
2340
2341 // Emit the DIE children if any.
2342 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2343 const std::vector<DIE *> &Children = Die->getChildren();
2344
2345 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002346 emitDIE(Children[j]);
Bill Wendling94d04b82009-05-20 23:21:38 +00002347
2348 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2349 }
2350}
2351
Devang Patel8a241142009-12-09 18:24:21 +00002352/// emitDebugInfo - Emit the debug info section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002353///
Devang Patel8a241142009-12-09 18:24:21 +00002354void DwarfDebug::emitDebugInfo() {
2355 // Start debug info section.
2356 Asm->OutStreamer.SwitchSection(
2357 Asm->getObjFileLowering().getDwarfInfoSection());
2358 DIE *Die = ModuleCU->getCUDie();
Bill Wendling94d04b82009-05-20 23:21:38 +00002359
2360 // Emit the compile units header.
Devang Patel8a241142009-12-09 18:24:21 +00002361 EmitLabel("info_begin", ModuleCU->getID());
Bill Wendling94d04b82009-05-20 23:21:38 +00002362
2363 // Emit size of content not including length itself
2364 unsigned ContentSize = Die->getSize() +
2365 sizeof(int16_t) + // DWARF version number
2366 sizeof(int32_t) + // Offset Into Abbrev. Section
2367 sizeof(int8_t) + // Pointer Size (in bytes)
2368 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2369
2370 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2371 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2372 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2373 Asm->EOL("Offset Into Abbrev. Section");
2374 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2375
Devang Patel2c4ceb12009-11-21 02:48:08 +00002376 emitDIE(Die);
Bill Wendling94d04b82009-05-20 23:21:38 +00002377 // FIXME - extra padding for gdb bug.
2378 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2379 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2380 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2381 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
Devang Patel8a241142009-12-09 18:24:21 +00002382 EmitLabel("info_end", ModuleCU->getID());
Bill Wendling94d04b82009-05-20 23:21:38 +00002383
2384 Asm->EOL();
Bill Wendling94d04b82009-05-20 23:21:38 +00002385
Bill Wendling94d04b82009-05-20 23:21:38 +00002386}
2387
Devang Patel2c4ceb12009-11-21 02:48:08 +00002388/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002389///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002390void DwarfDebug::emitAbbreviations() const {
Bill Wendling94d04b82009-05-20 23:21:38 +00002391 // Check to see if it is worth the effort.
2392 if (!Abbreviations.empty()) {
2393 // Start the debug abbrev section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002394 Asm->OutStreamer.SwitchSection(
2395 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002396
2397 EmitLabel("abbrev_begin", 0);
2398
2399 // For each abbrevation.
2400 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2401 // Get abbreviation data
2402 const DIEAbbrev *Abbrev = Abbreviations[i];
2403
2404 // Emit the abbrevations code (base 1 index.)
2405 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2406 Asm->EOL("Abbreviation Code");
2407
2408 // Emit the abbreviations data.
2409 Abbrev->Emit(Asm);
2410
2411 Asm->EOL();
2412 }
2413
2414 // Mark end of abbreviations.
2415 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2416
2417 EmitLabel("abbrev_end", 0);
2418 Asm->EOL();
2419 }
2420}
2421
Devang Patel2c4ceb12009-11-21 02:48:08 +00002422/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling94d04b82009-05-20 23:21:38 +00002423/// the line matrix.
2424///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002425void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002426 // Define last address of section.
2427 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2428 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2429 Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2430 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2431
2432 // Mark end of matrix.
2433 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2434 Asm->EmitULEB128Bytes(1); Asm->EOL();
2435 Asm->EmitInt8(1); Asm->EOL();
2436}
2437
Devang Patel2c4ceb12009-11-21 02:48:08 +00002438/// emitDebugLines - Emit source line information.
Bill Wendling94d04b82009-05-20 23:21:38 +00002439///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002440void DwarfDebug::emitDebugLines() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002441 // If the target is using .loc/.file, the assembler will be emitting the
2442 // .debug_line table automatically.
Chris Lattner33adcfb2009-08-22 21:43:10 +00002443 if (MAI->hasDotLocAndDotFile())
Bill Wendling94d04b82009-05-20 23:21:38 +00002444 return;
2445
2446 // Minimum line delta, thus ranging from -10..(255-10).
2447 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
2448 // Maximum line delta, thus ranging from -10..(255-10).
2449 const int MaxLineDelta = 255 + MinLineDelta;
2450
2451 // Start the dwarf line section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002452 Asm->OutStreamer.SwitchSection(
2453 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002454
2455 // Construct the section header.
2456 EmitDifference("line_end", 0, "line_begin", 0, true);
2457 Asm->EOL("Length of Source Line Info");
2458 EmitLabel("line_begin", 0);
2459
2460 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2461
2462 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2463 Asm->EOL("Prolog Length");
2464 EmitLabel("line_prolog_begin", 0);
2465
2466 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2467
2468 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2469
2470 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2471
2472 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2473
2474 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2475
2476 // Line number standard opcode encodings argument count
2477 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2478 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2479 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2480 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2481 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2482 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2483 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2484 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2485 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2486
2487 // Emit directories.
2488 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
2489 Asm->EmitString(getSourceDirectoryName(DI));
2490 Asm->EOL("Directory");
2491 }
2492
2493 Asm->EmitInt8(0); Asm->EOL("End of directories");
2494
2495 // Emit files.
2496 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
2497 // Remember source id starts at 1.
2498 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
2499 Asm->EmitString(getSourceFileName(Id.second));
2500 Asm->EOL("Source");
2501 Asm->EmitULEB128Bytes(Id.first);
2502 Asm->EOL("Directory #");
2503 Asm->EmitULEB128Bytes(0);
2504 Asm->EOL("Mod date");
2505 Asm->EmitULEB128Bytes(0);
2506 Asm->EOL("File size");
2507 }
2508
2509 Asm->EmitInt8(0); Asm->EOL("End of files");
2510
2511 EmitLabel("line_prolog_end", 0);
2512
2513 // A sequence for each text section.
2514 unsigned SecSrcLinesSize = SectionSourceLines.size();
2515
2516 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2517 // Isolate current sections line info.
2518 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2519
Chris Lattner93b6db32009-08-08 23:39:42 +00002520 /*if (Asm->isVerbose()) {
Chris Lattnera87dea42009-07-31 18:48:30 +00002521 const MCSection *S = SectionMap[j + 1];
Chris Lattner33adcfb2009-08-22 21:43:10 +00002522 O << '\t' << MAI->getCommentString() << " Section"
Bill Wendling94d04b82009-05-20 23:21:38 +00002523 << S->getName() << '\n';
Chris Lattner93b6db32009-08-08 23:39:42 +00002524 }*/
2525 Asm->EOL();
Bill Wendling94d04b82009-05-20 23:21:38 +00002526
2527 // Dwarf assumes we start with first line of first source file.
2528 unsigned Source = 1;
2529 unsigned Line = 1;
2530
2531 // Construct rows of the address, source, line, column matrix.
2532 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2533 const SrcLineInfo &LineInfo = LineInfos[i];
2534 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2535 if (!LabelID) continue;
2536
Caroline Ticec6f9d622009-09-11 18:25:54 +00002537 if (LineInfo.getLine() == 0) continue;
2538
Bill Wendling94d04b82009-05-20 23:21:38 +00002539 if (!Asm->isVerbose())
2540 Asm->EOL();
2541 else {
2542 std::pair<unsigned, unsigned> SourceID =
2543 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner33adcfb2009-08-22 21:43:10 +00002544 O << '\t' << MAI->getCommentString() << ' '
Dan Gohmanb3b98212009-12-05 02:00:34 +00002545 << getSourceDirectoryName(SourceID.first) << '/'
Bill Wendling94d04b82009-05-20 23:21:38 +00002546 << getSourceFileName(SourceID.second)
Dan Gohmanb3b98212009-12-05 02:00:34 +00002547 << ':' << utostr_32(LineInfo.getLine()) << '\n';
Bill Wendling94d04b82009-05-20 23:21:38 +00002548 }
2549
2550 // Define the line address.
2551 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2552 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2553 Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2554 EmitReference("label", LabelID); Asm->EOL("Location label");
2555
2556 // If change of source, then switch to the new source.
2557 if (Source != LineInfo.getSourceID()) {
2558 Source = LineInfo.getSourceID();
2559 Asm->EmitInt8(dwarf::DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2560 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2561 }
2562
2563 // If change of line.
2564 if (Line != LineInfo.getLine()) {
2565 // Determine offset.
2566 int Offset = LineInfo.getLine() - Line;
2567 int Delta = Offset - MinLineDelta;
2568
2569 // Update line.
2570 Line = LineInfo.getLine();
2571
2572 // If delta is small enough and in range...
2573 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2574 // ... then use fast opcode.
2575 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2576 } else {
2577 // ... otherwise use long hand.
2578 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
2579 Asm->EOL("DW_LNS_advance_line");
2580 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2581 Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2582 }
2583 } else {
2584 // Copy the previous row (different address or source)
2585 Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2586 }
2587 }
2588
Devang Patel2c4ceb12009-11-21 02:48:08 +00002589 emitEndOfLineMatrix(j + 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00002590 }
2591
2592 if (SecSrcLinesSize == 0)
2593 // Because we're emitting a debug_line section, we still need a line
2594 // table. The linker and friends expect it to exist. If there's nothing to
2595 // put into it, emit an empty table.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002596 emitEndOfLineMatrix(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00002597
2598 EmitLabel("line_end", 0);
2599 Asm->EOL();
2600}
2601
Devang Patel2c4ceb12009-11-21 02:48:08 +00002602/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002603///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002604void DwarfDebug::emitCommonDebugFrame() {
Chris Lattner33adcfb2009-08-22 21:43:10 +00002605 if (!MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002606 return;
2607
2608 int stackGrowth =
2609 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2610 TargetFrameInfo::StackGrowsUp ?
2611 TD->getPointerSize() : -TD->getPointerSize();
2612
2613 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002614 Asm->OutStreamer.SwitchSection(
2615 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002616
2617 EmitLabel("debug_frame_common", 0);
2618 EmitDifference("debug_frame_common_end", 0,
2619 "debug_frame_common_begin", 0, true);
2620 Asm->EOL("Length of Common Information Entry");
2621
2622 EmitLabel("debug_frame_common_begin", 0);
2623 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
2624 Asm->EOL("CIE Identifier Tag");
2625 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
2626 Asm->EOL("CIE Version");
2627 Asm->EmitString("");
2628 Asm->EOL("CIE Augmentation");
2629 Asm->EmitULEB128Bytes(1);
2630 Asm->EOL("CIE Code Alignment Factor");
2631 Asm->EmitSLEB128Bytes(stackGrowth);
2632 Asm->EOL("CIE Data Alignment Factor");
2633 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2634 Asm->EOL("CIE RA Column");
2635
2636 std::vector<MachineMove> Moves;
2637 RI->getInitialFrameState(Moves);
2638
2639 EmitFrameMoves(NULL, 0, Moves, false);
2640
2641 Asm->EmitAlignment(2, 0, 0, false);
2642 EmitLabel("debug_frame_common_end", 0);
2643
2644 Asm->EOL();
2645}
2646
Devang Patel2c4ceb12009-11-21 02:48:08 +00002647/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling94d04b82009-05-20 23:21:38 +00002648/// section.
2649void
Devang Patel2c4ceb12009-11-21 02:48:08 +00002650DwarfDebug::emitFunctionDebugFrame(const FunctionDebugFrameInfo&DebugFrameInfo){
Chris Lattner33adcfb2009-08-22 21:43:10 +00002651 if (!MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002652 return;
2653
2654 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002655 Asm->OutStreamer.SwitchSection(
2656 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002657
2658 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2659 "debug_frame_begin", DebugFrameInfo.Number, true);
2660 Asm->EOL("Length of Frame Information Entry");
2661
2662 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2663
2664 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2665 0, 0, true, false);
2666 Asm->EOL("FDE CIE offset");
2667
2668 EmitReference("func_begin", DebugFrameInfo.Number);
2669 Asm->EOL("FDE initial location");
2670 EmitDifference("func_end", DebugFrameInfo.Number,
2671 "func_begin", DebugFrameInfo.Number);
2672 Asm->EOL("FDE address range");
2673
2674 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
2675 false);
2676
2677 Asm->EmitAlignment(2, 0, 0, false);
2678 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2679
2680 Asm->EOL();
2681}
2682
Devang Patel8a241142009-12-09 18:24:21 +00002683/// emitDebugPubNames - Emit visible names into a debug pubnames section.
2684///
2685void DwarfDebug::emitDebugPubNames() {
2686 // Start the dwarf pubnames section.
2687 Asm->OutStreamer.SwitchSection(
2688 Asm->getObjFileLowering().getDwarfPubNamesSection());
2689
2690 EmitDifference("pubnames_end", ModuleCU->getID(),
2691 "pubnames_begin", ModuleCU->getID(), true);
Bill Wendling94d04b82009-05-20 23:21:38 +00002692 Asm->EOL("Length of Public Names Info");
2693
Devang Patel8a241142009-12-09 18:24:21 +00002694 EmitLabel("pubnames_begin", ModuleCU->getID());
Bill Wendling94d04b82009-05-20 23:21:38 +00002695
2696 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF Version");
2697
2698 EmitSectionOffset("info_begin", "section_info",
Devang Patel8a241142009-12-09 18:24:21 +00002699 ModuleCU->getID(), 0, true, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00002700 Asm->EOL("Offset of Compilation Unit Info");
2701
Devang Patel8a241142009-12-09 18:24:21 +00002702 EmitDifference("info_end", ModuleCU->getID(), "info_begin", ModuleCU->getID(),
Bill Wendling94d04b82009-05-20 23:21:38 +00002703 true);
2704 Asm->EOL("Compilation Unit Length");
2705
Devang Patel8a241142009-12-09 18:24:21 +00002706 const StringMap<DIE*> &Globals = ModuleCU->getGlobals();
Bill Wendling94d04b82009-05-20 23:21:38 +00002707 for (StringMap<DIE*>::const_iterator
2708 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2709 const char *Name = GI->getKeyData();
2710 DIE * Entity = GI->second;
2711
2712 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2713 Asm->EmitString(Name, strlen(Name)); Asm->EOL("External Name");
2714 }
2715
2716 Asm->EmitInt32(0); Asm->EOL("End Mark");
Devang Patel8a241142009-12-09 18:24:21 +00002717 EmitLabel("pubnames_end", ModuleCU->getID());
Bill Wendling94d04b82009-05-20 23:21:38 +00002718
2719 Asm->EOL();
2720}
2721
Devang Patel193f7202009-11-24 01:14:22 +00002722void DwarfDebug::emitDebugPubTypes() {
Devang Patelf3a03762009-11-24 19:18:41 +00002723 // Start the dwarf pubnames section.
2724 Asm->OutStreamer.SwitchSection(
2725 Asm->getObjFileLowering().getDwarfPubTypesSection());
Devang Patel193f7202009-11-24 01:14:22 +00002726 EmitDifference("pubtypes_end", ModuleCU->getID(),
2727 "pubtypes_begin", ModuleCU->getID(), true);
2728 Asm->EOL("Length of Public Types Info");
2729
2730 EmitLabel("pubtypes_begin", ModuleCU->getID());
2731
2732 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF Version");
2733
2734 EmitSectionOffset("info_begin", "section_info",
2735 ModuleCU->getID(), 0, true, false);
2736 Asm->EOL("Offset of Compilation ModuleCU Info");
2737
2738 EmitDifference("info_end", ModuleCU->getID(), "info_begin", ModuleCU->getID(),
2739 true);
2740 Asm->EOL("Compilation ModuleCU Length");
2741
2742 const StringMap<DIE*> &Globals = ModuleCU->getGlobalTypes();
2743 for (StringMap<DIE*>::const_iterator
2744 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2745 const char *Name = GI->getKeyData();
2746 DIE * Entity = GI->second;
2747
2748 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2749 Asm->EmitString(Name, strlen(Name)); Asm->EOL("External Name");
2750 }
2751
2752 Asm->EmitInt32(0); Asm->EOL("End Mark");
2753 EmitLabel("pubtypes_end", ModuleCU->getID());
2754
2755 Asm->EOL();
2756}
2757
Devang Patel2c4ceb12009-11-21 02:48:08 +00002758/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002759///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002760void DwarfDebug::emitDebugStr() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002761 // Check to see if it is worth the effort.
2762 if (!StringPool.empty()) {
2763 // Start the dwarf str section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002764 Asm->OutStreamer.SwitchSection(
2765 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002766
2767 // For each of strings in the string pool.
2768 for (unsigned StringID = 1, N = StringPool.size();
2769 StringID <= N; ++StringID) {
2770 // Emit a label for reference from debug information entries.
2771 EmitLabel("string", StringID);
2772
2773 // Emit the string itself.
2774 const std::string &String = StringPool[StringID];
2775 Asm->EmitString(String); Asm->EOL();
2776 }
2777
2778 Asm->EOL();
2779 }
2780}
2781
Devang Patel2c4ceb12009-11-21 02:48:08 +00002782/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002783///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002784void DwarfDebug::emitDebugLoc() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002785 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002786 Asm->OutStreamer.SwitchSection(
2787 Asm->getObjFileLowering().getDwarfLocSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002788 Asm->EOL();
2789}
2790
2791/// EmitDebugARanges - Emit visible names into a debug aranges section.
2792///
2793void DwarfDebug::EmitDebugARanges() {
2794 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002795 Asm->OutStreamer.SwitchSection(
2796 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002797
2798 // FIXME - Mock up
2799#if 0
2800 CompileUnit *Unit = GetBaseCompileUnit();
2801
2802 // Don't include size of length
2803 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2804
2805 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
2806
2807 EmitReference("info_begin", Unit->getID());
2808 Asm->EOL("Offset of Compilation Unit Info");
2809
2810 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2811
2812 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2813
2814 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2815 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
2816
2817 // Range 1
2818 EmitReference("text_begin", 0); Asm->EOL("Address");
2819 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2820
2821 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2822 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2823#endif
2824
2825 Asm->EOL();
2826}
2827
Devang Patel2c4ceb12009-11-21 02:48:08 +00002828/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002829///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002830void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002831 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002832 Asm->OutStreamer.SwitchSection(
2833 Asm->getObjFileLowering().getDwarfRangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002834 Asm->EOL();
2835}
2836
Devang Patel2c4ceb12009-11-21 02:48:08 +00002837/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002838///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002839void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002840 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00002841 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002842 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002843 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002844 Asm->EOL();
2845 }
2846}
2847
Devang Patel2c4ceb12009-11-21 02:48:08 +00002848/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling94d04b82009-05-20 23:21:38 +00002849/// Section Header:
2850/// 1. length of section
2851/// 2. Dwarf version number
2852/// 3. address size.
2853///
2854/// Entries (one "entry" for each function that was inlined):
2855///
2856/// 1. offset into __debug_str section for MIPS linkage name, if exists;
2857/// otherwise offset into __debug_str for regular function name.
2858/// 2. offset into __debug_str section for regular function name.
2859/// 3. an unsigned LEB128 number indicating the number of distinct inlining
2860/// instances for the function.
2861///
2862/// The rest of the entry consists of a {die_offset, low_pc} pair for each
2863/// inlined instance; the die_offset points to the inlined_subroutine die in the
2864/// __debug_info section, and the low_pc is the starting address for the
2865/// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002866void DwarfDebug::emitDebugInlineInfo() {
Chris Lattner33adcfb2009-08-22 21:43:10 +00002867 if (!MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002868 return;
2869
Devang Patel1dbc7712009-06-29 20:45:18 +00002870 if (!ModuleCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00002871 return;
2872
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002873 Asm->OutStreamer.SwitchSection(
2874 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002875 Asm->EOL();
2876 EmitDifference("debug_inlined_end", 1,
2877 "debug_inlined_begin", 1, true);
2878 Asm->EOL("Length of Debug Inlined Information Entry");
2879
2880 EmitLabel("debug_inlined_begin", 1);
2881
2882 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
2883 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2884
Devang Patel53bb5c92009-11-10 23:06:00 +00002885 for (SmallVector<MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
2886 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002887
Devang Patel53bb5c92009-11-10 23:06:00 +00002888// for (ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
2889 // I = InlineInfo.begin(), E = InlineInfo.end(); I != E; ++I) {
2890 MDNode *Node = *I;
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002891 ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
2892 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00002893 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00002894 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00002895 StringRef LName = SP.getLinkageName();
2896 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00002897
Devang Patel65dbc902009-11-25 17:36:49 +00002898 if (LName.empty())
Devang Patel53cb17d2009-07-16 01:01:22 +00002899 Asm->EmitString(Name);
2900 else {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002901 // Skip special LLVM prefix that is used to inform the asm printer to not
2902 // emit usual symbol prefix before the symbol name. This happens for
2903 // Objective-C symbol names and symbol whose name is replaced using GCC's
2904 // __asm__ attribute.
Devang Patel53cb17d2009-07-16 01:01:22 +00002905 if (LName[0] == 1)
Benjamin Kramer1c3451f2009-11-25 18:26:09 +00002906 LName = LName.substr(1);
Devang Patel53bb5c92009-11-10 23:06:00 +00002907// Asm->EmitString(LName);
2908 EmitSectionOffset("string", "section_str",
2909 StringPool.idFor(LName), false, true);
2910
Devang Patel53cb17d2009-07-16 01:01:22 +00002911 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002912 Asm->EOL("MIPS linkage name");
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002913// Asm->EmitString(Name);
Devang Patel53bb5c92009-11-10 23:06:00 +00002914 EmitSectionOffset("string", "section_str",
2915 StringPool.idFor(Name), false, true);
2916 Asm->EOL("Function name");
Bill Wendling94d04b82009-05-20 23:21:38 +00002917 Asm->EmitULEB128Bytes(Labels.size()); Asm->EOL("Inline count");
2918
Devang Patel53bb5c92009-11-10 23:06:00 +00002919 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00002920 LE = Labels.end(); LI != LE; ++LI) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002921 DIE *SP = LI->second;
Bill Wendling94d04b82009-05-20 23:21:38 +00002922 Asm->EmitInt32(SP->getOffset()); Asm->EOL("DIE offset");
2923
2924 if (TD->getPointerSize() == sizeof(int32_t))
Chris Lattner33adcfb2009-08-22 21:43:10 +00002925 O << MAI->getData32bitsDirective();
Bill Wendling94d04b82009-05-20 23:21:38 +00002926 else
Chris Lattner33adcfb2009-08-22 21:43:10 +00002927 O << MAI->getData64bitsDirective();
Bill Wendling94d04b82009-05-20 23:21:38 +00002928
Devang Patel53bb5c92009-11-10 23:06:00 +00002929 PrintLabelName("label", LI->first); Asm->EOL("low_pc");
Bill Wendling94d04b82009-05-20 23:21:38 +00002930 }
2931 }
2932
2933 EmitLabel("debug_inlined_end", 1);
2934 Asm->EOL();
2935}