blob: 61536d5d32fa9370dab9740caf1ca6c15cc1fd45 [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
Bill Wendling0310d762009-05-15 09:23:25 +000033//===----------------------------------------------------------------------===//
34
35/// Configuration values for initial hash set sizes (log2).
36///
Bill Wendling0310d762009-05-15 09:23:25 +000037static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling0310d762009-05-15 09:23:25 +000038
39namespace llvm {
40
41//===----------------------------------------------------------------------===//
42/// CompileUnit - This dwarf writer support class manages information associate
43/// with a source file.
Nick Lewycky5f9843f2009-11-17 08:11:44 +000044class CompileUnit {
Bill Wendling0310d762009-05-15 09:23:25 +000045 /// ID - File identifier for source.
46 ///
47 unsigned ID;
48
49 /// Die - Compile unit debug information entry.
50 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +000051 DIE *CUDie;
Bill Wendling0310d762009-05-15 09:23:25 +000052
Devang Patel6f01d9c2009-11-21 00:31:03 +000053 /// IndexTyDie - An anonymous type for index type.
54 DIE *IndexTyDie;
55
Bill Wendling0310d762009-05-15 09:23:25 +000056 /// GVToDieMap - Tracks the mapping of unit level debug informaton
57 /// variables to debug information entries.
Devang Patele4b27562009-08-28 23:24:31 +000058 /// FIXME : Rename GVToDieMap -> NodeToDieMap
Devang Patel017d1212009-11-20 21:37:22 +000059 ValueMap<MDNode *, DIE *> GVToDieMap;
Bill Wendling0310d762009-05-15 09:23:25 +000060
61 /// GVToDIEEntryMap - Tracks the mapping of unit level debug informaton
62 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patele4b27562009-08-28 23:24:31 +000063 /// FIXME : Rename
Devang Patel017d1212009-11-20 21:37:22 +000064 ValueMap<MDNode *, DIEEntry *> GVToDIEEntryMap;
Bill Wendling0310d762009-05-15 09:23:25 +000065
66 /// Globals - A map of globally visible named entities for this unit.
67 ///
68 StringMap<DIE*> Globals;
69
Devang Patel193f7202009-11-24 01:14:22 +000070 /// GlobalTypes - A map of globally visible types for this unit.
71 ///
72 StringMap<DIE*> GlobalTypes;
73
Bill Wendling0310d762009-05-15 09:23:25 +000074public:
75 CompileUnit(unsigned I, DIE *D)
Devang Patel2c4ceb12009-11-21 02:48:08 +000076 : ID(I), CUDie(D), IndexTyDie(0) {}
77 ~CompileUnit() { delete CUDie; delete IndexTyDie; }
Bill Wendling0310d762009-05-15 09:23:25 +000078
79 // Accessors.
Devang Patel193f7202009-11-24 01:14:22 +000080 unsigned getID() const { return ID; }
81 DIE* getCUDie() const { return CUDie; }
82 const StringMap<DIE*> &getGlobals() const { return Globals; }
83 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
Bill Wendling0310d762009-05-15 09:23:25 +000084
85 /// hasContent - Return true if this compile unit has something to write out.
86 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +000087 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendling0310d762009-05-15 09:23:25 +000088
Devang Patel2c4ceb12009-11-21 02:48:08 +000089 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendling0310d762009-05-15 09:23:25 +000090 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +000091 void addGlobal(const std::string &Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling0310d762009-05-15 09:23:25 +000092
Devang Patel193f7202009-11-24 01:14:22 +000093 /// addGlobalType - Add a new global type to the compile unit.
94 ///
95 void addGlobalType(const std::string &Name, DIE *Die) {
96 GlobalTypes[Name] = Die;
97 }
98
Devang Patel017d1212009-11-20 21:37:22 +000099 /// getDIE - Returns the debug information entry map slot for the
Bill Wendling0310d762009-05-15 09:23:25 +0000100 /// specified debug variable.
Devang Patel017d1212009-11-20 21:37:22 +0000101 DIE *getDIE(MDNode *N) { return GVToDieMap.lookup(N); }
Jim Grosbach31ef40e2009-11-21 23:12:12 +0000102
Devang Patel017d1212009-11-20 21:37:22 +0000103 /// insertDIE - Insert DIE into the map.
104 void insertDIE(MDNode *N, DIE *D) {
105 GVToDieMap.insert(std::make_pair(N, D));
106 }
Bill Wendling0310d762009-05-15 09:23:25 +0000107
Devang Patel017d1212009-11-20 21:37:22 +0000108 /// getDIEEntry - Returns the debug information entry for the speciefied
109 /// debug variable.
Devang Patel6404e4e2009-12-15 19:16:48 +0000110 DIEEntry *getDIEEntry(MDNode *N) {
111 ValueMap<MDNode *, DIEEntry *>::iterator I = GVToDIEEntryMap.find(N);
112 if (I == GVToDIEEntryMap.end())
113 return NULL;
114 return I->second;
115 }
Devang Patel017d1212009-11-20 21:37:22 +0000116
117 /// insertDIEEntry - Insert debug information entry into the map.
118 void insertDIEEntry(MDNode *N, DIEEntry *E) {
119 GVToDIEEntryMap.insert(std::make_pair(N, E));
Bill Wendling0310d762009-05-15 09:23:25 +0000120 }
121
Devang Patel2c4ceb12009-11-21 02:48:08 +0000122 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendling0310d762009-05-15 09:23:25 +0000123 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000124 void addDie(DIE *Buffer) {
125 this->CUDie->addChild(Buffer);
Bill Wendling0310d762009-05-15 09:23:25 +0000126 }
Devang Patel6f01d9c2009-11-21 00:31:03 +0000127
128 // getIndexTyDie - Get an anonymous type for index type.
129 DIE *getIndexTyDie() {
130 return IndexTyDie;
131 }
132
Jim Grosbach7ab38df2009-11-22 19:20:36 +0000133 // setIndexTyDie - Set D as anonymous type for index which can be reused
134 // later.
Devang Patel6f01d9c2009-11-21 00:31:03 +0000135 void setIndexTyDie(DIE *D) {
136 IndexTyDie = D;
137 }
138
Bill Wendling0310d762009-05-15 09:23:25 +0000139};
140
141//===----------------------------------------------------------------------===//
142/// DbgVariable - This class is used to track local variable information.
143///
Devang Patelf76a3d62009-11-16 21:53:40 +0000144class DbgVariable {
Bill Wendling0310d762009-05-15 09:23:25 +0000145 DIVariable Var; // Variable Descriptor.
146 unsigned FrameIndex; // Variable frame index.
Devang Patel53bb5c92009-11-10 23:06:00 +0000147 DbgVariable *AbstractVar; // Abstract variable for this variable.
148 DIE *TheDIE;
Bill Wendling0310d762009-05-15 09:23:25 +0000149public:
Devang Patel53bb5c92009-11-10 23:06:00 +0000150 DbgVariable(DIVariable V, unsigned I)
151 : Var(V), FrameIndex(I), AbstractVar(0), TheDIE(0) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000152
153 // Accessors.
Devang Patel53bb5c92009-11-10 23:06:00 +0000154 DIVariable getVariable() const { return Var; }
155 unsigned getFrameIndex() const { return FrameIndex; }
156 void setAbstractVariable(DbgVariable *V) { AbstractVar = V; }
157 DbgVariable *getAbstractVariable() const { return AbstractVar; }
158 void setDIE(DIE *D) { TheDIE = D; }
159 DIE *getDIE() const { return TheDIE; }
Bill Wendling0310d762009-05-15 09:23:25 +0000160};
161
162//===----------------------------------------------------------------------===//
163/// DbgScope - This class is used to track scope information.
164///
Devang Patelf76a3d62009-11-16 21:53:40 +0000165class DbgScope {
Bill Wendling0310d762009-05-15 09:23:25 +0000166 DbgScope *Parent; // Parent to this scope.
Jim Grosbach31ef40e2009-11-21 23:12:12 +0000167 DIDescriptor Desc; // Debug info descriptor for scope.
Devang 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 Patel344130e2010-01-04 20:44:00 +0000215 void fixInstructionMarkers(DenseMap<const MachineInstr *,
216 unsigned> &MIIndexMap) {
Devang Patelaf9e8472009-10-01 20:31:14 +0000217 assert (getFirstInsn() && "First instruction is missing!");
Devang Patel344130e2010-01-04 20:44:00 +0000218
219 // Use the end of last child scope as end of this scope.
Devang Patelaf9e8472009-10-01 20:31:14 +0000220 SmallVector<DbgScope *, 4> &Scopes = getScopes();
Devang Patel344130e2010-01-04 20:44:00 +0000221 const MachineInstr *LastInsn = NULL;
222 unsigned LIndex = 0;
223 if (Scopes.empty()) {
224 assert (getLastInsn() && "Inner most scope does not have last insn!");
225 return;
226 }
227 for (SmallVector<DbgScope *, 4>::iterator SI = Scopes.begin(),
228 SE = Scopes.end(); SI != SE; ++SI) {
229 DbgScope *DS = *SI;
230 DS->fixInstructionMarkers(MIIndexMap);
231 const MachineInstr *DSLastInsn = DS->getLastInsn();
232 unsigned DSI = MIIndexMap[DSLastInsn];
233 if (DSI > LIndex) {
234 LastInsn = DSLastInsn;
235 LIndex = DSI;
236 }
237 }
238 setLastInsn(LastInsn);
Devang Patelaf9e8472009-10-01 20:31:14 +0000239 }
240
Bill Wendling0310d762009-05-15 09:23:25 +0000241#ifndef NDEBUG
242 void dump() const;
243#endif
244};
245
246#ifndef NDEBUG
247void DbgScope::dump() const {
David Greenef83adbc2009-12-24 00:31:35 +0000248 raw_ostream &err = dbgs();
Chris Lattnerc281de12009-08-23 00:51:00 +0000249 err.indent(IndentLevel);
Devang Patel53bb5c92009-11-10 23:06:00 +0000250 MDNode *N = Desc.getNode();
251 N->dump();
Chris Lattnerc281de12009-08-23 00:51:00 +0000252 err << " [" << StartLabelID << ", " << EndLabelID << "]\n";
Devang Patel53bb5c92009-11-10 23:06:00 +0000253 if (AbstractScope)
254 err << "Abstract Scope\n";
Bill Wendling0310d762009-05-15 09:23:25 +0000255
256 IndentLevel += 2;
Devang Patel53bb5c92009-11-10 23:06:00 +0000257 if (!Scopes.empty())
258 err << "Children ...\n";
Bill Wendling0310d762009-05-15 09:23:25 +0000259 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
260 if (Scopes[i] != this)
261 Scopes[i]->dump();
262
263 IndentLevel -= 2;
264}
265#endif
266
Bill Wendling0310d762009-05-15 09:23:25 +0000267DbgScope::~DbgScope() {
268 for (unsigned i = 0, N = Scopes.size(); i < N; ++i)
269 delete Scopes[i];
270 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
271 delete Variables[j];
Bill Wendling0310d762009-05-15 09:23:25 +0000272}
273
274} // end llvm namespace
275
Chris Lattneraf76e592009-08-22 20:48:53 +0000276DwarfDebug::DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T)
Devang Patel1dbc7712009-06-29 20:45:18 +0000277 : Dwarf(OS, A, T, "dbg"), ModuleCU(0),
Bill Wendling0310d762009-05-15 09:23:25 +0000278 AbbreviationsSet(InitAbbreviationsSetSize), Abbreviations(),
Devang Patel2c4ceb12009-11-21 02:48:08 +0000279 DIEValues(), StringPool(),
Bill Wendling0310d762009-05-15 09:23:25 +0000280 SectionSourceLines(), didInitial(false), shouldEmit(false),
Devang Patel53bb5c92009-11-10 23:06:00 +0000281 CurrentFnDbgScope(0), DebugTimer(0) {
Bill Wendling0310d762009-05-15 09:23:25 +0000282 if (TimePassesIsEnabled)
Chris Lattner0b86a6f2009-12-28 07:41:18 +0000283 DebugTimer = new Timer("Dwarf Debug Writer");
Bill Wendling0310d762009-05-15 09:23:25 +0000284}
285DwarfDebug::~DwarfDebug() {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000286 for (unsigned j = 0, M = DIEValues.size(); j < M; ++j)
287 delete DIEValues[j];
Bill Wendling0310d762009-05-15 09:23:25 +0000288
Bill Wendling0310d762009-05-15 09:23:25 +0000289 delete DebugTimer;
290}
291
Devang Patel2c4ceb12009-11-21 02:48:08 +0000292/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling0310d762009-05-15 09:23:25 +0000293///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000294void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling0310d762009-05-15 09:23:25 +0000295 // Profile the node so that we can make it unique.
296 FoldingSetNodeID ID;
297 Abbrev.Profile(ID);
298
299 // Check the set for priors.
300 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
301
302 // If it's newly added.
303 if (InSet == &Abbrev) {
304 // Add to abbreviation list.
305 Abbreviations.push_back(&Abbrev);
306
307 // Assign the vector position + 1 as its number.
308 Abbrev.setNumber(Abbreviations.size());
309 } else {
310 // Assign existing abbreviation number.
311 Abbrev.setNumber(InSet->getNumber());
312 }
313}
314
Devang Patel2c4ceb12009-11-21 02:48:08 +0000315/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendling995f80a2009-05-20 23:24:48 +0000316/// information entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000317DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000318 DIEEntry *Value = new DIEEntry(Entry);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000319 DIEValues.push_back(Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000320 return Value;
321}
322
Devang Patel2c4ceb12009-11-21 02:48:08 +0000323/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000324///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000325void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000326 unsigned Form, uint64_t Integer) {
327 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Devang Patel6f01d9c2009-11-21 00:31:03 +0000328 DIEValue *Value = new DIEInteger(Integer);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000329 DIEValues.push_back(Value);
330 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000331}
332
Devang Patel2c4ceb12009-11-21 02:48:08 +0000333/// addSInt - Add an signed integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000334///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000335void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000336 unsigned Form, int64_t Integer) {
337 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Devang Patel6f01d9c2009-11-21 00:31:03 +0000338 DIEValue *Value = new DIEInteger(Integer);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000339 DIEValues.push_back(Value);
340 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000341}
342
Devang Patel69f57b12009-12-02 15:25:16 +0000343/// addString - Add a string attribute data and value. DIEString only
344/// keeps string reference.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000345void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Devang Patele9a05972009-11-24 19:42:17 +0000346 const StringRef String) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000347 DIEValue *Value = new DIEString(String);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000348 DIEValues.push_back(Value);
349 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000350}
351
Devang Patel2c4ceb12009-11-21 02:48:08 +0000352/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000353///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000354void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000355 const DWLabel &Label) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000356 DIEValue *Value = new DIEDwarfLabel(Label);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000357 DIEValues.push_back(Value);
358 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000359}
360
Devang Patel2c4ceb12009-11-21 02:48:08 +0000361/// addObjectLabel - Add an non-Dwarf label attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000362///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000363void DwarfDebug::addObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000364 const std::string &Label) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000365 DIEValue *Value = new DIEObjectLabel(Label);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000366 DIEValues.push_back(Value);
367 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000368}
369
Devang Patel2c4ceb12009-11-21 02:48:08 +0000370/// addSectionOffset - Add a section offset label attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000371///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000372void DwarfDebug::addSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000373 const DWLabel &Label, const DWLabel &Section,
374 bool isEH, bool useSet) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000375 DIEValue *Value = new DIESectionOffset(Label, Section, isEH, useSet);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000376 DIEValues.push_back(Value);
377 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000378}
379
Devang Patel2c4ceb12009-11-21 02:48:08 +0000380/// addDelta - Add a label delta attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000381///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000382void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000383 const DWLabel &Hi, const DWLabel &Lo) {
Devang Patel6f01d9c2009-11-21 00:31:03 +0000384 DIEValue *Value = new DIEDelta(Hi, Lo);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000385 DIEValues.push_back(Value);
386 Die->addValue(Attribute, Form, Value);
Bill Wendling0310d762009-05-15 09:23:25 +0000387}
388
Devang Patel2c4ceb12009-11-21 02:48:08 +0000389/// addBlock - Add block data.
Bill Wendling0310d762009-05-15 09:23:25 +0000390///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000391void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling0310d762009-05-15 09:23:25 +0000392 DIEBlock *Block) {
393 Block->ComputeSize(TD);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000394 DIEValues.push_back(Block);
395 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000396}
397
Devang Patel2c4ceb12009-11-21 02:48:08 +0000398/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000399/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000400void DwarfDebug::addSourceLine(DIE *Die, const DIVariable *V) {
Bill Wendling0310d762009-05-15 09:23:25 +0000401 // If there is no compile unit specified, don't add a line #.
402 if (V->getCompileUnit().isNull())
403 return;
404
405 unsigned Line = V->getLineNumber();
Devang Pateld037d7a2009-12-11 21:37:07 +0000406 unsigned FileID = findCompileUnit(V->getCompileUnit())->getID();
Bill Wendling0310d762009-05-15 09:23:25 +0000407 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000408 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
409 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000410}
411
Devang Patel2c4ceb12009-11-21 02:48:08 +0000412/// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000413/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000414void DwarfDebug::addSourceLine(DIE *Die, const DIGlobal *G) {
Bill Wendling0310d762009-05-15 09:23:25 +0000415 // If there is no compile unit specified, don't add a line #.
416 if (G->getCompileUnit().isNull())
417 return;
418
419 unsigned Line = G->getLineNumber();
Devang Pateld037d7a2009-12-11 21:37:07 +0000420 unsigned FileID = findCompileUnit(G->getCompileUnit())->getID();
Bill Wendling0310d762009-05-15 09:23:25 +0000421 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000422 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
423 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000424}
Devang Patel82dfc0c2009-08-31 22:47:13 +0000425
Devang Patel2c4ceb12009-11-21 02:48:08 +0000426/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000427/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000428void DwarfDebug::addSourceLine(DIE *Die, const DISubprogram *SP) {
Devang Patel82dfc0c2009-08-31 22:47:13 +0000429 // If there is no compile unit specified, don't add a line #.
430 if (SP->getCompileUnit().isNull())
431 return;
Caroline Ticec6f9d622009-09-11 18:25:54 +0000432 // If the line number is 0, don't add it.
433 if (SP->getLineNumber() == 0)
434 return;
435
Devang Patel82dfc0c2009-08-31 22:47:13 +0000436
437 unsigned Line = SP->getLineNumber();
Devang Pateld037d7a2009-12-11 21:37:07 +0000438 unsigned FileID = findCompileUnit(SP->getCompileUnit())->getID();
Devang Patel82dfc0c2009-08-31 22:47:13 +0000439 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000440 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
441 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patel82dfc0c2009-08-31 22:47:13 +0000442}
443
Devang Patel2c4ceb12009-11-21 02:48:08 +0000444/// addSourceLine - Add location information to specified debug information
Devang Patel82dfc0c2009-08-31 22:47:13 +0000445/// entry.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000446void DwarfDebug::addSourceLine(DIE *Die, const DIType *Ty) {
Bill Wendling0310d762009-05-15 09:23:25 +0000447 // If there is no compile unit specified, don't add a line #.
448 DICompileUnit CU = Ty->getCompileUnit();
449 if (CU.isNull())
450 return;
451
452 unsigned Line = Ty->getLineNumber();
Devang Pateld037d7a2009-12-11 21:37:07 +0000453 unsigned FileID = findCompileUnit(CU)->getID();
Bill Wendling0310d762009-05-15 09:23:25 +0000454 assert(FileID && "Invalid file id");
Devang Patel2c4ceb12009-11-21 02:48:08 +0000455 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
456 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendling0310d762009-05-15 09:23:25 +0000457}
458
Devang Patel6404e4e2009-12-15 19:16:48 +0000459/// addSourceLine - Add location information to specified debug information
460/// entry.
461void DwarfDebug::addSourceLine(DIE *Die, const DINameSpace *NS) {
462 // If there is no compile unit specified, don't add a line #.
463 if (NS->getCompileUnit().isNull())
464 return;
465
466 unsigned Line = NS->getLineNumber();
467 StringRef FN = NS->getFilename();
468 StringRef Dir = NS->getDirectory();
469
470 unsigned FileID = GetOrCreateSourceID(Dir, FN);
471 assert(FileID && "Invalid file id");
472 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
473 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
474}
475
Caroline Ticedc8f6042009-08-31 21:19:37 +0000476/* Byref variables, in Blocks, are declared by the programmer as
477 "SomeType VarName;", but the compiler creates a
478 __Block_byref_x_VarName struct, and gives the variable VarName
479 either the struct, or a pointer to the struct, as its type. This
480 is necessary for various behind-the-scenes things the compiler
481 needs to do with by-reference variables in blocks.
482
483 However, as far as the original *programmer* is concerned, the
484 variable should still have type 'SomeType', as originally declared.
485
486 The following function dives into the __Block_byref_x_VarName
487 struct to find the original type of the variable. This will be
488 passed back to the code generating the type for the Debug
489 Information Entry for the variable 'VarName'. 'VarName' will then
490 have the original type 'SomeType' in its debug information.
491
492 The original type 'SomeType' will be the type of the field named
493 'VarName' inside the __Block_byref_x_VarName struct.
494
495 NOTE: In order for this to not completely fail on the debugger
496 side, the Debug Information Entry for the variable VarName needs to
497 have a DW_AT_location that tells the debugger how to unwind through
498 the pointers and __Block_byref_x_VarName struct to find the actual
Devang Patel2c4ceb12009-11-21 02:48:08 +0000499 value of the variable. The function addBlockByrefType does this. */
Caroline Ticedc8f6042009-08-31 21:19:37 +0000500
501/// Find the type the programmer originally declared the variable to be
502/// and return that type.
503///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000504DIType DwarfDebug::getBlockByrefType(DIType Ty, std::string Name) {
Caroline Ticedc8f6042009-08-31 21:19:37 +0000505
506 DIType subType = Ty;
507 unsigned tag = Ty.getTag();
508
509 if (tag == dwarf::DW_TAG_pointer_type) {
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000510 DIDerivedType DTy = DIDerivedType(Ty.getNode());
Caroline Ticedc8f6042009-08-31 21:19:37 +0000511 subType = DTy.getTypeDerivedFrom();
512 }
513
514 DICompositeType blockStruct = DICompositeType(subType.getNode());
515
516 DIArray Elements = blockStruct.getTypeArray();
517
518 if (Elements.isNull())
519 return Ty;
520
521 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
522 DIDescriptor Element = Elements.getElement(i);
523 DIDerivedType DT = DIDerivedType(Element.getNode());
Devang Patel65dbc902009-11-25 17:36:49 +0000524 if (Name == DT.getName())
Caroline Ticedc8f6042009-08-31 21:19:37 +0000525 return (DT.getTypeDerivedFrom());
526 }
527
528 return Ty;
529}
530
Devang Patel2c4ceb12009-11-21 02:48:08 +0000531/// addComplexAddress - Start with the address based on the location provided,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000532/// and generate the DWARF information necessary to find the actual variable
533/// given the extra address information encoded in the DIVariable, starting from
534/// the starting location. Add the DWARF information to the die.
535///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000536void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000537 unsigned Attribute,
538 const MachineLocation &Location) {
539 const DIVariable &VD = DV->getVariable();
540 DIType Ty = VD.getType();
541
542 // Decode the original location, and use that as the start of the byref
543 // variable's location.
544 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
545 DIEBlock *Block = new DIEBlock();
546
547 if (Location.isReg()) {
548 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000549 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000550 } else {
551 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000552 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
553 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000554 }
555 } else {
556 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000557 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000558 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000559 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
560 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000561 }
562
Devang Patel2c4ceb12009-11-21 02:48:08 +0000563 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000564 }
565
566 for (unsigned i = 0, N = VD.getNumAddrElements(); i < N; ++i) {
567 uint64_t Element = VD.getAddrElement(i);
568
569 if (Element == DIFactory::OpPlus) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000570 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
571 addUInt(Block, 0, dwarf::DW_FORM_udata, VD.getAddrElement(++i));
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000572 } else if (Element == DIFactory::OpDeref) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000573 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000574 } else llvm_unreachable("unknown DIFactory Opcode");
575 }
576
577 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000578 addBlock(Die, Attribute, 0, Block);
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000579}
580
Caroline Ticedc8f6042009-08-31 21:19:37 +0000581/* Byref variables, in Blocks, are declared by the programmer as "SomeType
582 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
583 gives the variable VarName either the struct, or a pointer to the struct, as
584 its type. This is necessary for various behind-the-scenes things the
585 compiler needs to do with by-reference variables in Blocks.
586
587 However, as far as the original *programmer* is concerned, the variable
588 should still have type 'SomeType', as originally declared.
589
Devang Patel2c4ceb12009-11-21 02:48:08 +0000590 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticedc8f6042009-08-31 21:19:37 +0000591 struct to find the original type of the variable, which is then assigned to
592 the variable's Debug Information Entry as its real type. So far, so good.
593 However now the debugger will expect the variable VarName to have the type
594 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000595 expression that explains to the debugger how to navigate through the
Caroline Ticedc8f6042009-08-31 21:19:37 +0000596 pointers and struct to find the actual variable of type SomeType.
597
598 The following function does just that. We start by getting
599 the "normal" location for the variable. This will be the location
600 of either the struct __Block_byref_x_VarName or the pointer to the
601 struct __Block_byref_x_VarName.
602
603 The struct will look something like:
604
605 struct __Block_byref_x_VarName {
606 ... <various fields>
607 struct __Block_byref_x_VarName *forwarding;
608 ... <various other fields>
609 SomeType VarName;
610 ... <maybe more fields>
611 };
612
613 If we are given the struct directly (as our starting point) we
614 need to tell the debugger to:
615
616 1). Add the offset of the forwarding field.
617
618 2). Follow that pointer to get the the real __Block_byref_x_VarName
619 struct to use (the real one may have been copied onto the heap).
620
621 3). Add the offset for the field VarName, to find the actual variable.
622
623 If we started with a pointer to the struct, then we need to
624 dereference that pointer first, before the other steps.
625 Translating this into DWARF ops, we will need to append the following
626 to the current location description for the variable:
627
628 DW_OP_deref -- optional, if we start with a pointer
629 DW_OP_plus_uconst <forward_fld_offset>
630 DW_OP_deref
631 DW_OP_plus_uconst <varName_fld_offset>
632
633 That is what this function does. */
634
Devang Patel2c4ceb12009-11-21 02:48:08 +0000635/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticedc8f6042009-08-31 21:19:37 +0000636/// provided, and generate the DWARF information necessary to find the
637/// actual Block variable (navigating the Block struct) based on the
638/// starting location. Add the DWARF information to the die. For
639/// more information, read large comment just above here.
640///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000641void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbar00564992009-09-19 20:40:14 +0000642 unsigned Attribute,
643 const MachineLocation &Location) {
Caroline Ticedc8f6042009-08-31 21:19:37 +0000644 const DIVariable &VD = DV->getVariable();
645 DIType Ty = VD.getType();
646 DIType TmpTy = Ty;
647 unsigned Tag = Ty.getTag();
648 bool isPointer = false;
649
Devang Patel65dbc902009-11-25 17:36:49 +0000650 StringRef varName = VD.getName();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000651
652 if (Tag == dwarf::DW_TAG_pointer_type) {
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000653 DIDerivedType DTy = DIDerivedType(Ty.getNode());
Caroline Ticedc8f6042009-08-31 21:19:37 +0000654 TmpTy = DTy.getTypeDerivedFrom();
655 isPointer = true;
656 }
657
658 DICompositeType blockStruct = DICompositeType(TmpTy.getNode());
659
Daniel Dunbar00564992009-09-19 20:40:14 +0000660 // Find the __forwarding field and the variable field in the __Block_byref
661 // struct.
Daniel Dunbar00564992009-09-19 20:40:14 +0000662 DIArray Fields = blockStruct.getTypeArray();
663 DIDescriptor varField = DIDescriptor();
664 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000665
666
Daniel Dunbar00564992009-09-19 20:40:14 +0000667 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
668 DIDescriptor Element = Fields.getElement(i);
669 DIDerivedType DT = DIDerivedType(Element.getNode());
Devang Patel65dbc902009-11-25 17:36:49 +0000670 StringRef fieldName = DT.getName();
671 if (fieldName == "__forwarding")
Daniel Dunbar00564992009-09-19 20:40:14 +0000672 forwardingField = Element;
Devang Patel65dbc902009-11-25 17:36:49 +0000673 else if (fieldName == varName)
Daniel Dunbar00564992009-09-19 20:40:14 +0000674 varField = Element;
675 }
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000676
Mike Stump7e3720d2009-09-24 23:21:26 +0000677 assert(!varField.isNull() && "Can't find byref variable in Block struct");
678 assert(!forwardingField.isNull()
679 && "Can't find forwarding field in Block struct");
Caroline Ticedc8f6042009-08-31 21:19:37 +0000680
Daniel Dunbar00564992009-09-19 20:40:14 +0000681 // Get the offsets for the forwarding field and the variable field.
Daniel Dunbar00564992009-09-19 20:40:14 +0000682 unsigned int forwardingFieldOffset =
683 DIDerivedType(forwardingField.getNode()).getOffsetInBits() >> 3;
684 unsigned int varFieldOffset =
685 DIDerivedType(varField.getNode()).getOffsetInBits() >> 3;
Caroline Ticedc8f6042009-08-31 21:19:37 +0000686
Mike Stump7e3720d2009-09-24 23:21:26 +0000687 // Decode the original location, and use that as the start of the byref
688 // variable's location.
Daniel Dunbar00564992009-09-19 20:40:14 +0000689 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
690 DIEBlock *Block = new DIEBlock();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000691
Daniel Dunbar00564992009-09-19 20:40:14 +0000692 if (Location.isReg()) {
693 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000694 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000695 else {
696 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000697 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
698 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000699 }
700 } else {
701 if (Reg < 32)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000702 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000703 else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000704 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
705 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar00564992009-09-19 20:40:14 +0000706 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000707
Devang Patel2c4ceb12009-11-21 02:48:08 +0000708 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbar00564992009-09-19 20:40:14 +0000709 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000710
Mike Stump7e3720d2009-09-24 23:21:26 +0000711 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbar00564992009-09-19 20:40:14 +0000712 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbar00564992009-09-19 20:40:14 +0000713 if (isPointer)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000714 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000715
Daniel Dunbar00564992009-09-19 20:40:14 +0000716 // Next add the offset for the '__forwarding' field:
717 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
718 // adding the offset if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000719 if (forwardingFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000720 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
721 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000722 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000723
Daniel Dunbar00564992009-09-19 20:40:14 +0000724 // Now dereference the __forwarding field to get to the real __Block_byref
725 // struct: DW_OP_deref.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000726 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000727
Daniel Dunbar00564992009-09-19 20:40:14 +0000728 // Now that we've got the real __Block_byref... struct, add the offset
729 // for the variable's field to get to the location of the actual variable:
730 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000731 if (varFieldOffset > 0) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000732 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
733 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbar00564992009-09-19 20:40:14 +0000734 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000735
Daniel Dunbar00564992009-09-19 20:40:14 +0000736 // Now attach the location information to the DIE.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000737 addBlock(Die, Attribute, 0, Block);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000738}
739
Devang Patel2c4ceb12009-11-21 02:48:08 +0000740/// addAddress - Add an address attribute to a die based on the location
Bill Wendling0310d762009-05-15 09:23:25 +0000741/// provided.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000742void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000743 const MachineLocation &Location) {
744 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
745 DIEBlock *Block = new DIEBlock();
746
747 if (Location.isReg()) {
748 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000749 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000750 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000751 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
752 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000753 }
754 } else {
755 if (Reg < 32) {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000756 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000757 } else {
Devang Patel2c4ceb12009-11-21 02:48:08 +0000758 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
759 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendling0310d762009-05-15 09:23:25 +0000760 }
761
Devang Patel2c4ceb12009-11-21 02:48:08 +0000762 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling0310d762009-05-15 09:23:25 +0000763 }
764
Devang Patel2c4ceb12009-11-21 02:48:08 +0000765 addBlock(Die, Attribute, 0, Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000766}
767
Devang Patelc366f832009-12-10 19:14:49 +0000768/// addToContextOwner - Add Die into the list of its context owner's children.
769void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
770 if (Context.isNull())
771 ModuleCU->addDie(Die);
772 else if (Context.isType()) {
773 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context.getNode()));
774 ContextDIE->addChild(Die);
Devang Patel6404e4e2009-12-15 19:16:48 +0000775 } else if (Context.isNameSpace()) {
776 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context.getNode()));
777 ContextDIE->addChild(Die);
Devang Patelc366f832009-12-10 19:14:49 +0000778 } else if (DIE *ContextDIE = ModuleCU->getDIE(Context.getNode()))
779 ContextDIE->addChild(Die);
780 else
781 ModuleCU->addDie(Die);
782}
783
Devang Patel16ced732009-12-10 18:05:33 +0000784/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
785/// given DIType.
786DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
787 DIE *TyDIE = ModuleCU->getDIE(Ty.getNode());
788 if (TyDIE)
789 return TyDIE;
790
791 // Create new type.
792 TyDIE = new DIE(dwarf::DW_TAG_base_type);
793 ModuleCU->insertDIE(Ty.getNode(), TyDIE);
794 if (Ty.isBasicType())
795 constructTypeDIE(*TyDIE, DIBasicType(Ty.getNode()));
796 else if (Ty.isCompositeType())
797 constructTypeDIE(*TyDIE, DICompositeType(Ty.getNode()));
798 else {
799 assert(Ty.isDerivedType() && "Unknown kind of DIType");
800 constructTypeDIE(*TyDIE, DIDerivedType(Ty.getNode()));
801 }
802
Devang Patelc366f832009-12-10 19:14:49 +0000803 addToContextOwner(TyDIE, Ty.getContext());
Devang Patel16ced732009-12-10 18:05:33 +0000804 return TyDIE;
805}
806
Devang Patel2c4ceb12009-11-21 02:48:08 +0000807/// addType - Add a new type attribute to the specified entity.
Devang Patel8a241142009-12-09 18:24:21 +0000808void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Bill Wendling0310d762009-05-15 09:23:25 +0000809 if (Ty.isNull())
810 return;
811
812 // Check for pre-existence.
Devang Patel8a241142009-12-09 18:24:21 +0000813 DIEEntry *Entry = ModuleCU->getDIEEntry(Ty.getNode());
Bill Wendling0310d762009-05-15 09:23:25 +0000814 // If it exists then use the existing value.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000815 if (Entry) {
816 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000817 return;
818 }
819
820 // Set up proxy.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000821 Entry = createDIEEntry();
Devang Patel8a241142009-12-09 18:24:21 +0000822 ModuleCU->insertDIEEntry(Ty.getNode(), Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000823
824 // Construct type.
Devang Patel16ced732009-12-10 18:05:33 +0000825 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000826
Devang Patel2c4ceb12009-11-21 02:48:08 +0000827 Entry->setEntry(Buffer);
828 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000829}
830
Devang Patel2c4ceb12009-11-21 02:48:08 +0000831/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel8a241142009-12-09 18:24:21 +0000832void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000833 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000834 StringRef Name = BTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000835 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000836 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling0310d762009-05-15 09:23:25 +0000837 BTy.getEncoding());
838
839 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +0000840 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000841 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000842 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel2c4ceb12009-11-21 02:48:08 +0000843 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000844}
845
Devang Patel2c4ceb12009-11-21 02:48:08 +0000846/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel8a241142009-12-09 18:24:21 +0000847void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000848 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000849 StringRef Name = DTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000850 uint64_t Size = DTy.getSizeInBits() >> 3;
851 unsigned Tag = DTy.getTag();
852
853 // FIXME - Workaround for templates.
854 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
855
856 Buffer.setTag(Tag);
857
858 // Map to main type, void will not have a type.
859 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel8a241142009-12-09 18:24:21 +0000860 addType(&Buffer, FromTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000861
862 // Add name if not anonymous or intermediate type.
Devang Pateldeea5642009-11-30 23:56:56 +0000863 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000864 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000865
866 // Add size if non-zero (derived types might be zero-sized.)
867 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000868 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000869
870 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patel05f6fa82009-11-23 18:43:37 +0000871 if (!DTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000872 addSourceLine(&Buffer, &DTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000873}
874
Devang Patel2c4ceb12009-11-21 02:48:08 +0000875/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +0000876void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling0310d762009-05-15 09:23:25 +0000877 // Get core information.
Devang Patel65dbc902009-11-25 17:36:49 +0000878 StringRef Name = CTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000879
880 uint64_t Size = CTy.getSizeInBits() >> 3;
881 unsigned Tag = CTy.getTag();
882 Buffer.setTag(Tag);
883
884 switch (Tag) {
885 case dwarf::DW_TAG_vector_type:
886 case dwarf::DW_TAG_array_type:
Devang Patel8a241142009-12-09 18:24:21 +0000887 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000888 break;
889 case dwarf::DW_TAG_enumeration_type: {
890 DIArray Elements = CTy.getTypeArray();
891
892 // Add enumerators to enumeration type.
893 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
894 DIE *ElemDie = NULL;
Devang Patele4b27562009-08-28 23:24:31 +0000895 DIEnumerator Enum(Elements.getElement(i).getNode());
Devang Patelc5254722009-10-09 17:51:49 +0000896 if (!Enum.isNull()) {
Devang Patel8a241142009-12-09 18:24:21 +0000897 ElemDie = constructEnumTypeDIE(&Enum);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000898 Buffer.addChild(ElemDie);
Devang Patelc5254722009-10-09 17:51:49 +0000899 }
Bill Wendling0310d762009-05-15 09:23:25 +0000900 }
901 }
902 break;
903 case dwarf::DW_TAG_subroutine_type: {
904 // Add return type.
905 DIArray Elements = CTy.getTypeArray();
906 DIDescriptor RTy = Elements.getElement(0);
Devang Patel8a241142009-12-09 18:24:21 +0000907 addType(&Buffer, DIType(RTy.getNode()));
Bill Wendling0310d762009-05-15 09:23:25 +0000908
909 // Add prototype flag.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000910 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +0000911
912 // Add arguments.
913 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
914 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
915 DIDescriptor Ty = Elements.getElement(i);
Devang Patel8a241142009-12-09 18:24:21 +0000916 addType(Arg, DIType(Ty.getNode()));
Devang Patel2c4ceb12009-11-21 02:48:08 +0000917 Buffer.addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +0000918 }
919 }
920 break;
921 case dwarf::DW_TAG_structure_type:
922 case dwarf::DW_TAG_union_type:
923 case dwarf::DW_TAG_class_type: {
924 // Add elements to structure type.
925 DIArray Elements = CTy.getTypeArray();
926
927 // A forward struct declared type may not have elements available.
928 if (Elements.isNull())
929 break;
930
931 // Add elements to structure type.
932 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
933 DIDescriptor Element = Elements.getElement(i);
Devang Patele4b27562009-08-28 23:24:31 +0000934 if (Element.isNull())
935 continue;
Bill Wendling0310d762009-05-15 09:23:25 +0000936 DIE *ElemDie = NULL;
937 if (Element.getTag() == dwarf::DW_TAG_subprogram)
Devang Patelffe966c2009-12-14 16:18:45 +0000938 ElemDie = createSubprogramDIE(DISubprogram(Element.getNode()));
Bill Wendling0310d762009-05-15 09:23:25 +0000939 else
Devang Patel8a241142009-12-09 18:24:21 +0000940 ElemDie = createMemberDIE(DIDerivedType(Element.getNode()));
Devang Patel2c4ceb12009-11-21 02:48:08 +0000941 Buffer.addChild(ElemDie);
Bill Wendling0310d762009-05-15 09:23:25 +0000942 }
943
Devang Patela1ba2692009-08-27 23:51:51 +0000944 if (CTy.isAppleBlockExtension())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000945 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +0000946
947 unsigned RLang = CTy.getRunTimeLang();
948 if (RLang)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000949 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling0310d762009-05-15 09:23:25 +0000950 dwarf::DW_FORM_data1, RLang);
951 break;
952 }
953 default:
954 break;
955 }
956
957 // Add name if not anonymous or intermediate type.
Devang Patel65dbc902009-11-25 17:36:49 +0000958 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000959 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +0000960
961 if (Tag == dwarf::DW_TAG_enumeration_type ||
962 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type) {
963 // Add size if non-zero (derived types might be zero-sized.)
964 if (Size)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000965 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling0310d762009-05-15 09:23:25 +0000966 else {
967 // Add zero size if it is not a forward declaration.
968 if (CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000969 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +0000970 else
Devang Patel2c4ceb12009-11-21 02:48:08 +0000971 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling0310d762009-05-15 09:23:25 +0000972 }
973
974 // Add source line info if available.
975 if (!CTy.isForwardDecl())
Devang Patel2c4ceb12009-11-21 02:48:08 +0000976 addSourceLine(&Buffer, &CTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000977 }
978}
979
Devang Patel2c4ceb12009-11-21 02:48:08 +0000980/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
981void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling0310d762009-05-15 09:23:25 +0000982 int64_t L = SR.getLo();
983 int64_t H = SR.getHi();
984 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
985
Devang Patel2c4ceb12009-11-21 02:48:08 +0000986 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patel6325a532009-08-14 20:59:16 +0000987 if (L)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000988 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Pateld55224c2009-12-04 23:10:24 +0000989 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling0310d762009-05-15 09:23:25 +0000990
Devang Patel2c4ceb12009-11-21 02:48:08 +0000991 Buffer.addChild(DW_Subrange);
Bill Wendling0310d762009-05-15 09:23:25 +0000992}
993
Devang Patel2c4ceb12009-11-21 02:48:08 +0000994/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +0000995void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling0310d762009-05-15 09:23:25 +0000996 DICompositeType *CTy) {
997 Buffer.setTag(dwarf::DW_TAG_array_type);
998 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patel2c4ceb12009-11-21 02:48:08 +0000999 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001000
1001 // Emit derived type.
Devang Patel8a241142009-12-09 18:24:21 +00001002 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001003 DIArray Elements = CTy->getTypeArray();
1004
Devang Patel6f01d9c2009-11-21 00:31:03 +00001005 // Get an anonymous type for index type.
Devang Patel8a241142009-12-09 18:24:21 +00001006 DIE *IdxTy = ModuleCU->getIndexTyDie();
Devang Patel6f01d9c2009-11-21 00:31:03 +00001007 if (!IdxTy) {
1008 // Construct an anonymous type for index type.
1009 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001010 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1011 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel6f01d9c2009-11-21 00:31:03 +00001012 dwarf::DW_ATE_signed);
Devang Patel8a241142009-12-09 18:24:21 +00001013 ModuleCU->addDie(IdxTy);
1014 ModuleCU->setIndexTyDie(IdxTy);
Devang Patel6f01d9c2009-11-21 00:31:03 +00001015 }
Bill Wendling0310d762009-05-15 09:23:25 +00001016
1017 // Add subranges to array type.
1018 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1019 DIDescriptor Element = Elements.getElement(i);
1020 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001021 constructSubrangeDIE(Buffer, DISubrange(Element.getNode()), IdxTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001022 }
1023}
1024
Devang Patel2c4ceb12009-11-21 02:48:08 +00001025/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel8a241142009-12-09 18:24:21 +00001026DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator *ETy) {
Bill Wendling0310d762009-05-15 09:23:25 +00001027 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel65dbc902009-11-25 17:36:49 +00001028 StringRef Name = ETy->getName();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001029 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling0310d762009-05-15 09:23:25 +00001030 int64_t Value = ETy->getEnumValue();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001031 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling0310d762009-05-15 09:23:25 +00001032 return Enumerator;
1033}
1034
Devang Patel351ca332010-01-05 01:46:14 +00001035/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
1036/// printer to not emit usual symbol prefix before the symbol name is used then
1037/// return linkage name after skipping this special LLVM prefix.
1038static StringRef getRealLinkageName(StringRef LinkageName) {
1039 char One = '\1';
1040 if (LinkageName.startswith(StringRef(&One, 1)))
1041 return LinkageName.substr(1);
1042 return LinkageName;
1043}
1044
Devang Patel2c4ceb12009-11-21 02:48:08 +00001045/// createGlobalVariableDIE - Create new DIE using GV.
Devang Patel8a241142009-12-09 18:24:21 +00001046DIE *DwarfDebug::createGlobalVariableDIE(const DIGlobalVariable &GV) {
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001047 // If the global variable was optmized out then no need to create debug info
1048 // entry.
Devang Patel84c73e92009-11-06 17:58:12 +00001049 if (!GV.getGlobal()) return NULL;
Devang Patel65dbc902009-11-25 17:36:49 +00001050 if (GV.getDisplayName().empty()) return NULL;
Devang Patel465c3be2009-11-06 01:30:04 +00001051
Bill Wendling0310d762009-05-15 09:23:25 +00001052 DIE *GVDie = new DIE(dwarf::DW_TAG_variable);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001053 addString(GVDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001054 GV.getDisplayName());
1055
Devang Patel65dbc902009-11-25 17:36:49 +00001056 StringRef LinkageName = GV.getLinkageName();
Devang Patel351ca332010-01-05 01:46:14 +00001057 if (!LinkageName.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001058 addString(GVDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel351ca332010-01-05 01:46:14 +00001059 getRealLinkageName(LinkageName));
1060
Devang Patel8a241142009-12-09 18:24:21 +00001061 addType(GVDie, GV.getType());
Bill Wendling0310d762009-05-15 09:23:25 +00001062 if (!GV.isLocalToUnit())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001063 addUInt(GVDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1064 addSourceLine(GVDie, &GV);
Devang Patelb71a16d2009-10-05 23:22:08 +00001065
Bill Wendling0310d762009-05-15 09:23:25 +00001066 return GVDie;
1067}
1068
Devang Patel2c4ceb12009-11-21 02:48:08 +00001069/// createMemberDIE - Create new member DIE.
Devang Patel8a241142009-12-09 18:24:21 +00001070DIE *DwarfDebug::createMemberDIE(const DIDerivedType &DT) {
Bill Wendling0310d762009-05-15 09:23:25 +00001071 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel65dbc902009-11-25 17:36:49 +00001072 StringRef Name = DT.getName();
1073 if (!Name.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001074 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel65dbc902009-11-25 17:36:49 +00001075
Devang Patel8a241142009-12-09 18:24:21 +00001076 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling0310d762009-05-15 09:23:25 +00001077
Devang Patel2c4ceb12009-11-21 02:48:08 +00001078 addSourceLine(MemberDie, &DT);
Bill Wendling0310d762009-05-15 09:23:25 +00001079
Devang Patel33db5082009-11-04 22:06:12 +00001080 DIEBlock *MemLocationDie = new DIEBlock();
Devang Patel2c4ceb12009-11-21 02:48:08 +00001081 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel33db5082009-11-04 22:06:12 +00001082
Bill Wendling0310d762009-05-15 09:23:25 +00001083 uint64_t Size = DT.getSizeInBits();
Devang Patel61ecbd12009-11-04 23:48:00 +00001084 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling0310d762009-05-15 09:23:25 +00001085
1086 if (Size != FieldSize) {
1087 // Handle bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001088 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1089 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling0310d762009-05-15 09:23:25 +00001090
1091 uint64_t Offset = DT.getOffsetInBits();
1092 uint64_t FieldOffset = Offset;
1093 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1094 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1095 FieldOffset = (HiMark - FieldSize);
1096 Offset -= FieldOffset;
1097
1098 // Maybe we need to work from the other end.
1099 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001100 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling0310d762009-05-15 09:23:25 +00001101
Devang Patel33db5082009-11-04 22:06:12 +00001102 // Here WD_AT_data_member_location points to the anonymous
1103 // field that includes this bit field.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001104 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001105
1106 } else
1107 // This is not a bitfield.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001108 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel33db5082009-11-04 22:06:12 +00001109
Devang Patel2c4ceb12009-11-21 02:48:08 +00001110 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001111
1112 if (DT.isProtected())
Devang Patel5d11eb02009-12-03 19:11:07 +00001113 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001114 dwarf::DW_ACCESS_protected);
1115 else if (DT.isPrivate())
Devang Patel5d11eb02009-12-03 19:11:07 +00001116 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling0310d762009-05-15 09:23:25 +00001117 dwarf::DW_ACCESS_private);
Devang Patel5d11eb02009-12-03 19:11:07 +00001118 else if (DT.getTag() == dwarf::DW_TAG_inheritance)
1119 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1120 dwarf::DW_ACCESS_public);
1121 if (DT.isVirtual())
1122 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1123 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling0310d762009-05-15 09:23:25 +00001124 return MemberDie;
1125}
1126
Devang Patelffe966c2009-12-14 16:18:45 +00001127/// createSubprogramDIE - Create new DIE using SP.
1128DIE *DwarfDebug::createSubprogramDIE(const DISubprogram &SP, bool MakeDecl) {
1129 DIE *SPDie = ModuleCU->getDIE(SP.getNode());
1130 if (SPDie)
1131 return SPDie;
1132
1133 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel65dbc902009-11-25 17:36:49 +00001134 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling0310d762009-05-15 09:23:25 +00001135
Devang Patel65dbc902009-11-25 17:36:49 +00001136 StringRef LinkageName = SP.getLinkageName();
Devang Patel351ca332010-01-05 01:46:14 +00001137 if (!LinkageName.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001138 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel351ca332010-01-05 01:46:14 +00001139 getRealLinkageName(LinkageName));
1140
Devang Patel2c4ceb12009-11-21 02:48:08 +00001141 addSourceLine(SPDie, &SP);
Bill Wendling0310d762009-05-15 09:23:25 +00001142
Bill Wendling0310d762009-05-15 09:23:25 +00001143 // Add prototyped tag, if C or ObjC.
1144 unsigned Lang = SP.getCompileUnit().getLanguage();
1145 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1146 Lang == dwarf::DW_LANG_ObjC)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001147 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001148
1149 // Add Return Type.
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001150 DICompositeType SPTy = SP.getType();
1151 DIArray Args = SPTy.getTypeArray();
Bill Wendling0310d762009-05-15 09:23:25 +00001152 unsigned SPTag = SPTy.getTag();
Devang Patel5d11eb02009-12-03 19:11:07 +00001153
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001154 if (Args.isNull() || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel8a241142009-12-09 18:24:21 +00001155 addType(SPDie, SPTy);
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001156 else
Devang Patel8a241142009-12-09 18:24:21 +00001157 addType(SPDie, DIType(Args.getElement(0).getNode()));
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001158
Devang Patel5d11eb02009-12-03 19:11:07 +00001159 unsigned VK = SP.getVirtuality();
1160 if (VK) {
1161 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
1162 DIEBlock *Block = new DIEBlock();
1163 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1164 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1165 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
1166 ContainingTypeMap.insert(std::make_pair(SPDie, WeakVH(SP.getContainingType().getNode())));
1167 }
1168
Devang Patelffe966c2009-12-14 16:18:45 +00001169 if (MakeDecl || !SP.isDefinition()) {
Devang Patel2c4ceb12009-11-21 02:48:08 +00001170 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling0310d762009-05-15 09:23:25 +00001171
1172 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001173 // be handled while processing variables.
1174 DICompositeType SPTy = SP.getType();
1175 DIArray Args = SPTy.getTypeArray();
1176 unsigned SPTag = SPTy.getTag();
1177
Bill Wendling0310d762009-05-15 09:23:25 +00001178 if (SPTag == dwarf::DW_TAG_subroutine_type)
1179 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1180 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel8a241142009-12-09 18:24:21 +00001181 addType(Arg, DIType(Args.getElement(i).getNode()));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001182 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1); // ??
1183 SPDie->addChild(Arg);
Bill Wendling0310d762009-05-15 09:23:25 +00001184 }
1185 }
1186
Bill Wendling0310d762009-05-15 09:23:25 +00001187 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel8a241142009-12-09 18:24:21 +00001188 ModuleCU->insertDIE(SP.getNode(), SPDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001189 return SPDie;
1190}
1191
Devang Patel2c4ceb12009-11-21 02:48:08 +00001192/// findCompileUnit - Get the compile unit for the given descriptor.
Bill Wendling0310d762009-05-15 09:23:25 +00001193///
Devang Pateld037d7a2009-12-11 21:37:07 +00001194CompileUnit *DwarfDebug::findCompileUnit(DICompileUnit Unit) {
Bill Wendling0310d762009-05-15 09:23:25 +00001195 DenseMap<Value *, CompileUnit *>::const_iterator I =
Devang Patele4b27562009-08-28 23:24:31 +00001196 CompileUnitMap.find(Unit.getNode());
Devang Pateld037d7a2009-12-11 21:37:07 +00001197 if (I == CompileUnitMap.end())
1198 return constructCompileUnit(Unit.getNode());
1199 return I->second;
Bill Wendling0310d762009-05-15 09:23:25 +00001200}
1201
Devang Patel53bb5c92009-11-10 23:06:00 +00001202/// getUpdatedDbgScope - Find or create DbgScope assicated with the instruction.
1203/// Initialize scope and update scope hierarchy.
1204DbgScope *DwarfDebug::getUpdatedDbgScope(MDNode *N, const MachineInstr *MI,
1205 MDNode *InlinedAt) {
1206 assert (N && "Invalid Scope encoding!");
1207 assert (MI && "Missing machine instruction!");
1208 bool GetConcreteScope = (MI && InlinedAt);
1209
1210 DbgScope *NScope = NULL;
1211
1212 if (InlinedAt)
1213 NScope = DbgScopeMap.lookup(InlinedAt);
1214 else
1215 NScope = DbgScopeMap.lookup(N);
1216 assert (NScope && "Unable to find working scope!");
1217
1218 if (NScope->getFirstInsn())
1219 return NScope;
Devang Patelaf9e8472009-10-01 20:31:14 +00001220
1221 DbgScope *Parent = NULL;
Devang Patel53bb5c92009-11-10 23:06:00 +00001222 if (GetConcreteScope) {
Devang Patelc90aefe2009-10-14 21:08:09 +00001223 DILocation IL(InlinedAt);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001224 Parent = getUpdatedDbgScope(IL.getScope().getNode(), MI,
Devang Patel53bb5c92009-11-10 23:06:00 +00001225 IL.getOrigLocation().getNode());
1226 assert (Parent && "Unable to find Parent scope!");
1227 NScope->setParent(Parent);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001228 Parent->addScope(NScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001229 } else if (DIDescriptor(N).isLexicalBlock()) {
1230 DILexicalBlock DB(N);
1231 if (!DB.getContext().isNull()) {
1232 Parent = getUpdatedDbgScope(DB.getContext().getNode(), MI, InlinedAt);
1233 NScope->setParent(Parent);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001234 Parent->addScope(NScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001235 }
Devang Patelc90aefe2009-10-14 21:08:09 +00001236 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001237
Devang Patelbdf45cb2009-10-27 20:47:17 +00001238 NScope->setFirstInsn(MI);
Devang Patelaf9e8472009-10-01 20:31:14 +00001239
Devang Patel53bb5c92009-11-10 23:06:00 +00001240 if (!Parent && !InlinedAt) {
Devang Patel39ae3ff2009-11-11 00:31:36 +00001241 StringRef SPName = DISubprogram(N).getLinkageName();
1242 if (SPName == MF->getFunction()->getName())
1243 CurrentFnDbgScope = NScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00001244 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001245
Devang Patel53bb5c92009-11-10 23:06:00 +00001246 if (GetConcreteScope) {
1247 ConcreteScopes[InlinedAt] = NScope;
1248 getOrCreateAbstractScope(N);
1249 }
1250
Devang Patelbdf45cb2009-10-27 20:47:17 +00001251 return NScope;
Devang Patelaf9e8472009-10-01 20:31:14 +00001252}
1253
Devang Patel53bb5c92009-11-10 23:06:00 +00001254DbgScope *DwarfDebug::getOrCreateAbstractScope(MDNode *N) {
1255 assert (N && "Invalid Scope encoding!");
1256
1257 DbgScope *AScope = AbstractScopes.lookup(N);
1258 if (AScope)
1259 return AScope;
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001260
Devang Patel53bb5c92009-11-10 23:06:00 +00001261 DbgScope *Parent = NULL;
1262
1263 DIDescriptor Scope(N);
1264 if (Scope.isLexicalBlock()) {
1265 DILexicalBlock DB(N);
1266 DIDescriptor ParentDesc = DB.getContext();
1267 if (!ParentDesc.isNull())
1268 Parent = getOrCreateAbstractScope(ParentDesc.getNode());
1269 }
1270
1271 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1272
1273 if (Parent)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001274 Parent->addScope(AScope);
Devang Patel53bb5c92009-11-10 23:06:00 +00001275 AScope->setAbstractScope();
1276 AbstractScopes[N] = AScope;
1277 if (DIDescriptor(N).isSubprogram())
1278 AbstractScopesList.push_back(AScope);
1279 return AScope;
1280}
Devang Patelaf9e8472009-10-01 20:31:14 +00001281
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001282/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel2c4ceb12009-11-21 02:48:08 +00001283/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1284/// If there are global variables in this scope then create and insert
1285/// DIEs for these variables.
1286DIE *DwarfDebug::updateSubprogramScopeDIE(MDNode *SPNode) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001287
Devang Patel017d1212009-11-20 21:37:22 +00001288 DIE *SPDie = ModuleCU->getDIE(SPNode);
Devang Patel53bb5c92009-11-10 23:06:00 +00001289 assert (SPDie && "Unable to find subprogram DIE!");
Devang Patelffe966c2009-12-14 16:18:45 +00001290 DISubprogram SP(SPNode);
1291 if (SP.isDefinition() && !SP.getContext().isCompileUnit()) {
1292 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1293 // Add arguments.
1294 DICompositeType SPTy = SP.getType();
1295 DIArray Args = SPTy.getTypeArray();
1296 unsigned SPTag = SPTy.getTag();
1297 if (SPTag == dwarf::DW_TAG_subroutine_type)
1298 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1299 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1300 addType(Arg, DIType(Args.getElement(i).getNode()));
1301 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1); // ??
1302 SPDie->addChild(Arg);
1303 }
1304 DIE *SPDeclDie = SPDie;
1305 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1306 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
1307 SPDeclDie);
Devang Patelffe966c2009-12-14 16:18:45 +00001308 ModuleCU->addDie(SPDie);
1309 }
1310
Devang Patel2c4ceb12009-11-21 02:48:08 +00001311 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Devang Patel53bb5c92009-11-10 23:06:00 +00001312 DWLabel("func_begin", SubprogramCount));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001313 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Devang Patel53bb5c92009-11-10 23:06:00 +00001314 DWLabel("func_end", SubprogramCount));
1315 MachineLocation Location(RI->getFrameRegister(*MF));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001316 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001317
Devang Patel53bb5c92009-11-10 23:06:00 +00001318 if (!DISubprogram(SPNode).isLocalToUnit())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001319 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patel53bb5c92009-11-10 23:06:00 +00001320
Devang Patel53bb5c92009-11-10 23:06:00 +00001321 return SPDie;
1322}
1323
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001324/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel2c4ceb12009-11-21 02:48:08 +00001325/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1326DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001327 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1328 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1329
1330 // Ignore empty scopes.
1331 if (StartID == EndID && StartID != 0)
1332 return NULL;
1333
1334 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1335 if (Scope->isAbstractScope())
1336 return ScopeDIE;
1337
Devang Patel2c4ceb12009-11-21 02:48:08 +00001338 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001339 StartID ?
1340 DWLabel("label", StartID)
Devang Patel53bb5c92009-11-10 23:06:00 +00001341 : DWLabel("func_begin", SubprogramCount));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001342 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001343 EndID ?
1344 DWLabel("label", EndID)
Devang Patel53bb5c92009-11-10 23:06:00 +00001345 : DWLabel("func_end", SubprogramCount));
1346
1347
1348
1349 return ScopeDIE;
1350}
1351
Devang Patel2c4ceb12009-11-21 02:48:08 +00001352/// constructInlinedScopeDIE - This scope represents inlined body of
1353/// a function. Construct DIE to represent this concrete inlined copy
1354/// of the function.
1355DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patel53bb5c92009-11-10 23:06:00 +00001356 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1357 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1358 assert (StartID && "Invalid starting label for an inlined scope!");
1359 assert (EndID && "Invalid end label for an inlined scope!");
1360 // Ignore empty scopes.
1361 if (StartID == EndID && StartID != 0)
1362 return NULL;
1363
1364 DIScope DS(Scope->getScopeNode());
1365 if (DS.isNull())
1366 return NULL;
1367 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1368
1369 DISubprogram InlinedSP = getDISubprogram(DS.getNode());
Devang Patel017d1212009-11-20 21:37:22 +00001370 DIE *OriginDIE = ModuleCU->getDIE(InlinedSP.getNode());
Devang Patel53bb5c92009-11-10 23:06:00 +00001371 assert (OriginDIE && "Unable to find Origin DIE!");
Devang Patel2c4ceb12009-11-21 02:48:08 +00001372 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patel53bb5c92009-11-10 23:06:00 +00001373 dwarf::DW_FORM_ref4, OriginDIE);
1374
Devang Patel2c4ceb12009-11-21 02:48:08 +00001375 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Devang Patel53bb5c92009-11-10 23:06:00 +00001376 DWLabel("label", StartID));
Devang Patel2c4ceb12009-11-21 02:48:08 +00001377 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Devang Patel53bb5c92009-11-10 23:06:00 +00001378 DWLabel("label", EndID));
1379
1380 InlinedSubprogramDIEs.insert(OriginDIE);
1381
1382 // Track the start label for this inlined function.
1383 ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
1384 I = InlineInfo.find(InlinedSP.getNode());
1385
1386 if (I == InlineInfo.end()) {
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001387 InlineInfo[InlinedSP.getNode()].push_back(std::make_pair(StartID,
1388 ScopeDIE));
Devang Patel53bb5c92009-11-10 23:06:00 +00001389 InlinedSPNodes.push_back(InlinedSP.getNode());
1390 } else
1391 I->second.push_back(std::make_pair(StartID, ScopeDIE));
1392
1393 StringPool.insert(InlinedSP.getName());
Devang Patel351ca332010-01-05 01:46:14 +00001394 StringPool.insert(getRealLinkageName(InlinedSP.getLinkageName()));
1395
Devang Patel53bb5c92009-11-10 23:06:00 +00001396 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 Patel6404e4e2009-12-15 19:16:48 +00001582/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1583DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
1584 DIE *NDie = ModuleCU->getDIE(NS.getNode());
1585 if (NDie)
1586 return NDie;
1587 NDie = new DIE(dwarf::DW_TAG_namespace);
1588 ModuleCU->insertDIE(NS.getNode(), NDie);
1589 if (!NS.getName().empty())
1590 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
1591 addSourceLine(NDie, &NS);
1592 addToContextOwner(NDie, NS.getContext());
1593 return NDie;
1594}
1595
Devang Pateld037d7a2009-12-11 21:37:07 +00001596CompileUnit *DwarfDebug::constructCompileUnit(MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001597 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +00001598 StringRef FN = DIUnit.getFilename();
1599 StringRef Dir = DIUnit.getDirectory();
Devang Patel5ccdd102009-09-29 18:40:58 +00001600 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001601
1602 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001603 addSectionOffset(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001604 DWLabel("section_line", 0), DWLabel("section_line", 0),
1605 false);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001606 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001607 DIUnit.getProducer());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001608 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001609 DIUnit.getLanguage());
Devang Patel2c4ceb12009-11-21 02:48:08 +00001610 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001611
Devang Patel65dbc902009-11-25 17:36:49 +00001612 if (!Dir.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001613 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001614 if (DIUnit.isOptimized())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001615 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001616
Devang Patel65dbc902009-11-25 17:36:49 +00001617 StringRef Flags = DIUnit.getFlags();
1618 if (!Flags.empty())
Devang Patel2c4ceb12009-11-21 02:48:08 +00001619 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001620
1621 unsigned RVer = DIUnit.getRunTimeVersion();
1622 if (RVer)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001623 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001624 dwarf::DW_FORM_data1, RVer);
1625
1626 CompileUnit *Unit = new CompileUnit(ID, Die);
Devang Patel1dbc7712009-06-29 20:45:18 +00001627 if (!ModuleCU && DIUnit.isMain()) {
Devang Patel70f44262009-06-29 20:38:13 +00001628 // Use first compile unit marked as isMain as the compile unit
1629 // for this module.
Devang Patel1dbc7712009-06-29 20:45:18 +00001630 ModuleCU = Unit;
Devang Patel70f44262009-06-29 20:38:13 +00001631 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001632
Devang Patele4b27562009-08-28 23:24:31 +00001633 CompileUnitMap[DIUnit.getNode()] = Unit;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001634 CompileUnits.push_back(Unit);
Devang Pateld037d7a2009-12-11 21:37:07 +00001635 return Unit;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001636}
1637
Devang Patel2c4ceb12009-11-21 02:48:08 +00001638void DwarfDebug::constructGlobalVariableDIE(MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001639 DIGlobalVariable DI_GV(N);
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001640
Devang Patel905cf5e2009-09-04 23:59:07 +00001641 // If debug information is malformed then ignore it.
1642 if (DI_GV.Verify() == false)
1643 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001644
1645 // Check for pre-existence.
Devang Patel017d1212009-11-20 21:37:22 +00001646 if (ModuleCU->getDIE(DI_GV.getNode()))
Devang Patel13e16b62009-06-26 01:49:18 +00001647 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001648
Devang Patel8a241142009-12-09 18:24:21 +00001649 DIE *VariableDie = createGlobalVariableDIE(DI_GV);
Devang Pateledb45632009-12-10 23:25:41 +00001650 if (!VariableDie)
1651 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001652
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001653 // Add to map.
Devang Patel017d1212009-11-20 21:37:22 +00001654 ModuleCU->insertDIE(N, VariableDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001655
1656 // Add to context owner.
Devang Patel6404e4e2009-12-15 19:16:48 +00001657 if (DI_GV.isDefinition()
1658 && !DI_GV.getContext().isCompileUnit()) {
1659 // Create specification DIE.
1660 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1661 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1662 dwarf::DW_FORM_ref4, VariableDie);
1663 DIEBlock *Block = new DIEBlock();
1664 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1665 addObjectLabel(Block, 0, dwarf::DW_FORM_udata,
1666 Asm->Mang->getMangledName(DI_GV.getGlobal()));
1667 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1668 ModuleCU->addDie(VariableSpecDIE);
1669 } else {
1670 DIEBlock *Block = new DIEBlock();
1671 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1672 addObjectLabel(Block, 0, dwarf::DW_FORM_udata,
1673 Asm->Mang->getMangledName(DI_GV.getGlobal()));
1674 addBlock(VariableDie, dwarf::DW_AT_location, 0, Block);
1675 }
Devang Patelc366f832009-12-10 19:14:49 +00001676 addToContextOwner(VariableDie, DI_GV.getContext());
1677
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001678 // Expose as global. FIXME - need to check external flag.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001679 ModuleCU->addGlobal(DI_GV.getName(), VariableDie);
Devang Patel193f7202009-11-24 01:14:22 +00001680
1681 DIType GTy = DI_GV.getType();
Devang Patel65dbc902009-11-25 17:36:49 +00001682 if (GTy.isCompositeType() && !GTy.getName().empty()) {
Devang Patel193f7202009-11-24 01:14:22 +00001683 DIEEntry *Entry = ModuleCU->getDIEEntry(GTy.getNode());
1684 assert (Entry && "Missing global type!");
1685 ModuleCU->addGlobalType(GTy.getName(), Entry->getEntry());
1686 }
Devang Patel13e16b62009-06-26 01:49:18 +00001687 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001688}
1689
Devang Patel2c4ceb12009-11-21 02:48:08 +00001690void DwarfDebug::constructSubprogramDIE(MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +00001691 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001692
1693 // Check for pre-existence.
Devang Patel017d1212009-11-20 21:37:22 +00001694 if (ModuleCU->getDIE(N))
Devang Patel13e16b62009-06-26 01:49:18 +00001695 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001696
1697 if (!SP.isDefinition())
1698 // This is a method declaration which will be handled while constructing
1699 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +00001700 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001701
Devang Patel8a241142009-12-09 18:24:21 +00001702 DIE *SubprogramDie = createSubprogramDIE(SP);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001703
1704 // Add to map.
Devang Patel017d1212009-11-20 21:37:22 +00001705 ModuleCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001706
1707 // Add to context owner.
Devang Patel6404e4e2009-12-15 19:16:48 +00001708 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +00001709
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001710 // Expose as global.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001711 ModuleCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel193f7202009-11-24 01:14:22 +00001712
Devang Patel13e16b62009-06-26 01:49:18 +00001713 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001714}
1715
Devang Patel2c4ceb12009-11-21 02:48:08 +00001716/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbar00564992009-09-19 20:40:14 +00001717/// content. Create global DIEs and emit initial debug info sections.
1718/// This is inovked by the target AsmPrinter.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001719void DwarfDebug::beginModule(Module *M, MachineModuleInfo *mmi) {
Devang Patel208622d2009-06-25 22:36:02 +00001720 this->M = M;
1721
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001722 if (TimePassesIsEnabled)
1723 DebugTimer->startTimer();
1724
Devang Patel3380cc52009-11-11 19:55:08 +00001725 if (!MAI->doesSupportDebugInformation())
1726 return;
1727
Devang Patel78ab9e22009-07-30 18:56:46 +00001728 DebugInfoFinder DbgFinder;
1729 DbgFinder.processModule(*M);
Devang Patel13e16b62009-06-26 01:49:18 +00001730
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001731 // Create all the compile unit DIEs.
Devang Patel78ab9e22009-07-30 18:56:46 +00001732 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1733 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001734 constructCompileUnit(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001735
1736 if (CompileUnits.empty()) {
1737 if (TimePassesIsEnabled)
1738 DebugTimer->stopTimer();
1739
1740 return;
1741 }
1742
Devang Patel70f44262009-06-29 20:38:13 +00001743 // If main compile unit for this module is not seen than randomly
1744 // select first compile unit.
Devang Patel1dbc7712009-06-29 20:45:18 +00001745 if (!ModuleCU)
1746 ModuleCU = CompileUnits[0];
Devang Patel70f44262009-06-29 20:38:13 +00001747
Devang Patel53bb5c92009-11-10 23:06:00 +00001748 // Create DIEs for each subprogram.
Devang Patel78ab9e22009-07-30 18:56:46 +00001749 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
1750 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001751 constructSubprogramDIE(*I);
Devang Patel13e16b62009-06-26 01:49:18 +00001752
Devang Patelc366f832009-12-10 19:14:49 +00001753 // Create DIEs for each global variable.
1754 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
1755 E = DbgFinder.global_variable_end(); I != E; ++I)
1756 constructGlobalVariableDIE(*I);
1757
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001758 MMI = mmi;
1759 shouldEmit = true;
1760 MMI->setDebugInfoAvailability(true);
1761
1762 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +00001763 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001764
1765 // Print out .file directives to specify files for .loc directives. These are
1766 // printed out early so that they precede any .loc directives.
Chris Lattner33adcfb2009-08-22 21:43:10 +00001767 if (MAI->hasDotLocAndDotFile()) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001768 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
1769 // Remember source id starts at 1.
1770 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
1771 sys::Path FullPath(getSourceDirectoryName(Id.first));
1772 bool AppendOk =
1773 FullPath.appendComponent(getSourceFileName(Id.second));
1774 assert(AppendOk && "Could not append filename to directory!");
1775 AppendOk = false;
Chris Lattner74382b72009-08-23 22:45:37 +00001776 Asm->EmitFile(i, FullPath.str());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001777 Asm->EOL();
1778 }
1779 }
1780
1781 // Emit initial sections
Devang Patel2c4ceb12009-11-21 02:48:08 +00001782 emitInitial();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001783
1784 if (TimePassesIsEnabled)
1785 DebugTimer->stopTimer();
1786}
1787
Devang Patel2c4ceb12009-11-21 02:48:08 +00001788/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001789///
Devang Patel2c4ceb12009-11-21 02:48:08 +00001790void DwarfDebug::endModule() {
Devang Patel6f3dc922009-10-06 00:03:14 +00001791 if (!ModuleCU)
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001792 return;
1793
1794 if (TimePassesIsEnabled)
1795 DebugTimer->startTimer();
1796
Devang Patel53bb5c92009-11-10 23:06:00 +00001797 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1798 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
1799 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
1800 DIE *ISP = *AI;
Devang Patel2c4ceb12009-11-21 02:48:08 +00001801 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +00001802 }
1803
Devang Patel1d5cc1d2009-12-03 01:25:38 +00001804 // Insert top level DIEs.
1805 for (SmallVector<DIE *, 4>::iterator TI = TopLevelDIEsVector.begin(),
1806 TE = TopLevelDIEsVector.end(); TI != TE; ++TI)
1807 ModuleCU->getCUDie()->addChild(*TI);
1808
Devang Patel5d11eb02009-12-03 19:11:07 +00001809 for (DenseMap<DIE *, WeakVH>::iterator CI = ContainingTypeMap.begin(),
1810 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
1811 DIE *SPDie = CI->first;
1812 MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
1813 if (!N) continue;
1814 DIE *NDie = ModuleCU->getDIE(N);
1815 if (!NDie) continue;
1816 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
1817 addDIEEntry(NDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
1818 }
1819
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001820 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001821 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001822 EmitLabel("text_end", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001823 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001824 EmitLabel("data_end", 0);
1825
1826 // End text sections.
1827 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001828 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001829 EmitLabel("section_end", i);
1830 }
1831
1832 // Emit common frame information.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001833 emitCommonDebugFrame();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001834
1835 // Emit function debug frame information
1836 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
1837 E = DebugFrames.end(); I != E; ++I)
Devang Patel2c4ceb12009-11-21 02:48:08 +00001838 emitFunctionDebugFrame(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001839
1840 // Compute DIE offsets and sizes.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001841 computeSizeAndOffsets();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001842
1843 // Emit all the DIEs into a debug info section
Devang Patel2c4ceb12009-11-21 02:48:08 +00001844 emitDebugInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001845
1846 // Corresponding abbreviations into a abbrev section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001847 emitAbbreviations();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001848
1849 // Emit source line correspondence into a debug line section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001850 emitDebugLines();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001851
1852 // Emit info into a debug pubnames section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001853 emitDebugPubNames();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001854
Devang Patel193f7202009-11-24 01:14:22 +00001855 // Emit info into a debug pubtypes section.
1856 emitDebugPubTypes();
1857
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001858 // Emit info into a debug str section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001859 emitDebugStr();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001860
1861 // Emit info into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001862 emitDebugLoc();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001863
1864 // Emit info into a debug aranges section.
1865 EmitDebugARanges();
1866
1867 // Emit info into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001868 emitDebugRanges();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001869
1870 // Emit info into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001871 emitDebugMacInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001872
1873 // Emit inline info.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001874 emitDebugInlineInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001875
1876 if (TimePassesIsEnabled)
1877 DebugTimer->stopTimer();
1878}
1879
Devang Patel53bb5c92009-11-10 23:06:00 +00001880/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001881DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
1882 unsigned FrameIdx,
Devang Patel53bb5c92009-11-10 23:06:00 +00001883 DILocation &ScopeLoc) {
1884
1885 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var.getNode());
1886 if (AbsDbgVariable)
1887 return AbsDbgVariable;
1888
1889 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope().getNode());
1890 if (!Scope)
1891 return NULL;
1892
1893 AbsDbgVariable = new DbgVariable(Var, FrameIdx);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001894 Scope->addVariable(AbsDbgVariable);
Devang Patel53bb5c92009-11-10 23:06:00 +00001895 AbstractVariables[Var.getNode()] = AbsDbgVariable;
1896 return AbsDbgVariable;
1897}
1898
Devang Patel2c4ceb12009-11-21 02:48:08 +00001899/// collectVariableInfo - Populate DbgScope entries with variables' info.
1900void DwarfDebug::collectVariableInfo() {
Devang Patelac1ceb32009-10-09 22:42:28 +00001901 if (!MMI) return;
Devang Patel53bb5c92009-11-10 23:06:00 +00001902
Devang Patele717faa2009-10-06 01:26:37 +00001903 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1904 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1905 VE = VMap.end(); VI != VE; ++VI) {
Devang Patelac1ceb32009-10-09 22:42:28 +00001906 MetadataBase *MB = VI->first;
1907 MDNode *Var = dyn_cast_or_null<MDNode>(MB);
Devang Patel53bb5c92009-11-10 23:06:00 +00001908 if (!Var) continue;
Devang Pateleda31212009-10-08 18:48:03 +00001909 DIVariable DV (Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00001910 std::pair< unsigned, MDNode *> VP = VI->second;
1911 DILocation ScopeLoc(VP.second);
1912
1913 DbgScope *Scope =
1914 ConcreteScopes.lookup(ScopeLoc.getOrigLocation().getNode());
1915 if (!Scope)
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001916 Scope = DbgScopeMap.lookup(ScopeLoc.getScope().getNode());
Devang Patelfb0ee432009-11-10 23:20:04 +00001917 // If variable scope is not found then skip this variable.
1918 if (!Scope)
1919 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00001920
1921 DbgVariable *RegVar = new DbgVariable(DV, VP.first);
Devang Patel2c4ceb12009-11-21 02:48:08 +00001922 Scope->addVariable(RegVar);
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001923 if (DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.first,
1924 ScopeLoc))
Devang Patel53bb5c92009-11-10 23:06:00 +00001925 RegVar->setAbstractVariable(AbsDbgVariable);
Devang Patele717faa2009-10-06 01:26:37 +00001926 }
1927}
1928
Devang Patel2c4ceb12009-11-21 02:48:08 +00001929/// beginScope - Process beginning of a scope starting at Label.
1930void DwarfDebug::beginScope(const MachineInstr *MI, unsigned Label) {
Devang Patel0d20ac82009-10-06 01:50:42 +00001931 InsnToDbgScopeMapTy::iterator I = DbgScopeBeginMap.find(MI);
1932 if (I == DbgScopeBeginMap.end())
1933 return;
Dan Gohman277207e2009-11-23 21:30:55 +00001934 ScopeVector &SD = I->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00001935 for (ScopeVector::iterator SDI = SD.begin(), SDE = SD.end();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001936 SDI != SDE; ++SDI)
Devang Patel0d20ac82009-10-06 01:50:42 +00001937 (*SDI)->setStartLabelID(Label);
1938}
1939
Devang Patel2c4ceb12009-11-21 02:48:08 +00001940/// endScope - Process end of a scope.
1941void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel0d20ac82009-10-06 01:50:42 +00001942 InsnToDbgScopeMapTy::iterator I = DbgScopeEndMap.find(MI);
Devang Patel8a4087d2009-10-06 03:15:38 +00001943 if (I == DbgScopeEndMap.end())
Devang Patel0d20ac82009-10-06 01:50:42 +00001944 return;
Devang Patel53bb5c92009-11-10 23:06:00 +00001945
1946 unsigned Label = MMI->NextLabelID();
1947 Asm->printLabel(Label);
Dan Gohmaneecb9912009-12-05 01:42:34 +00001948 O << '\n';
Devang Patel53bb5c92009-11-10 23:06:00 +00001949
Devang Patel0d20ac82009-10-06 01:50:42 +00001950 SmallVector<DbgScope *, 2> &SD = I->second;
1951 for (SmallVector<DbgScope *, 2>::iterator SDI = SD.begin(), SDE = SD.end();
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001952 SDI != SDE; ++SDI)
Devang Patel0d20ac82009-10-06 01:50:42 +00001953 (*SDI)->setEndLabelID(Label);
Devang Patel53bb5c92009-11-10 23:06:00 +00001954 return;
1955}
1956
1957/// createDbgScope - Create DbgScope for the scope.
1958void DwarfDebug::createDbgScope(MDNode *Scope, MDNode *InlinedAt) {
1959
1960 if (!InlinedAt) {
1961 DbgScope *WScope = DbgScopeMap.lookup(Scope);
1962 if (WScope)
1963 return;
1964 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
1965 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Jim Grosbach31ef40e2009-11-21 23:12:12 +00001966 if (DIDescriptor(Scope).isLexicalBlock())
Devang Patel2f105c62009-11-11 00:18:40 +00001967 createDbgScope(DILexicalBlock(Scope).getContext().getNode(), NULL);
Devang Patel53bb5c92009-11-10 23:06:00 +00001968 return;
1969 }
1970
1971 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
1972 if (WScope)
1973 return;
1974
1975 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
1976 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
1977 DILocation DL(InlinedAt);
1978 createDbgScope(DL.getScope().getNode(), DL.getOrigLocation().getNode());
Devang Patel0d20ac82009-10-06 01:50:42 +00001979}
1980
Devang Patel2c4ceb12009-11-21 02:48:08 +00001981/// extractScopeInformation - Scan machine instructions in this function
Devang Patelaf9e8472009-10-01 20:31:14 +00001982/// and collect DbgScopes. Return true, if atleast one scope was found.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001983bool DwarfDebug::extractScopeInformation(MachineFunction *MF) {
Devang Patelaf9e8472009-10-01 20:31:14 +00001984 // If scope information was extracted using .dbg intrinsics then there is not
1985 // any need to extract these information by scanning each instruction.
1986 if (!DbgScopeMap.empty())
1987 return false;
1988
Devang Patel344130e2010-01-04 20:44:00 +00001989 DenseMap<const MachineInstr *, unsigned> MIIndexMap;
1990 unsigned MIIndex = 0;
Devang Patel53bb5c92009-11-10 23:06:00 +00001991 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patelaf9e8472009-10-01 20:31:14 +00001992 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
1993 I != E; ++I) {
1994 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1995 II != IE; ++II) {
1996 const MachineInstr *MInsn = II;
Devang Patel344130e2010-01-04 20:44:00 +00001997 MIIndexMap[MInsn] = MIIndex++;
Devang Patelaf9e8472009-10-01 20:31:14 +00001998 DebugLoc DL = MInsn->getDebugLoc();
Devang Patel53bb5c92009-11-10 23:06:00 +00001999 if (DL.isUnknown()) continue;
Devang Patelaf9e8472009-10-01 20:31:14 +00002000 DebugLocTuple DLT = MF->getDebugLocTuple(DL);
Devang Patel53bb5c92009-11-10 23:06:00 +00002001 if (!DLT.Scope) continue;
Devang Patelaf9e8472009-10-01 20:31:14 +00002002 // There is no need to create another DIE for compile unit. For all
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002003 // other scopes, create one DbgScope now. This will be translated
Devang Patelaf9e8472009-10-01 20:31:14 +00002004 // into a scope DIE at the end.
Devang Patel53bb5c92009-11-10 23:06:00 +00002005 if (DIDescriptor(DLT.Scope).isCompileUnit()) continue;
2006 createDbgScope(DLT.Scope, DLT.InlinedAtLoc);
2007 }
2008 }
2009
2010
2011 // Build scope hierarchy using working set of scopes.
2012 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2013 I != E; ++I) {
2014 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2015 II != IE; ++II) {
2016 const MachineInstr *MInsn = II;
2017 DebugLoc DL = MInsn->getDebugLoc();
2018 if (DL.isUnknown()) continue;
2019 DebugLocTuple DLT = MF->getDebugLocTuple(DL);
2020 if (!DLT.Scope) continue;
2021 // There is no need to create another DIE for compile unit. For all
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002022 // other scopes, create one DbgScope now. This will be translated
Devang Patel53bb5c92009-11-10 23:06:00 +00002023 // into a scope DIE at the end.
2024 if (DIDescriptor(DLT.Scope).isCompileUnit()) continue;
2025 DbgScope *Scope = getUpdatedDbgScope(DLT.Scope, MInsn, DLT.InlinedAtLoc);
2026 Scope->setLastInsn(MInsn);
Devang Patelaf9e8472009-10-01 20:31:14 +00002027 }
2028 }
2029
Devang Patel344130e2010-01-04 20:44:00 +00002030 if (!CurrentFnDbgScope)
2031 return false;
2032
2033 CurrentFnDbgScope->fixInstructionMarkers(MIIndexMap);
Devang Patelaf9e8472009-10-01 20:31:14 +00002034
2035 // Each scope has first instruction and last instruction to mark beginning
2036 // and end of a scope respectively. Create an inverse map that list scopes
2037 // starts (and ends) with an instruction. One instruction may start (or end)
2038 // multiple scopes.
Devang Patelbdf45cb2009-10-27 20:47:17 +00002039 for (ValueMap<MDNode *, DbgScope *>::iterator DI = DbgScopeMap.begin(),
Devang Patelaf9e8472009-10-01 20:31:14 +00002040 DE = DbgScopeMap.end(); DI != DE; ++DI) {
2041 DbgScope *S = DI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00002042 if (S->isAbstractScope())
2043 continue;
Devang Patelaf9e8472009-10-01 20:31:14 +00002044 const MachineInstr *MI = S->getFirstInsn();
2045 assert (MI && "DbgScope does not have first instruction!");
2046
2047 InsnToDbgScopeMapTy::iterator IDI = DbgScopeBeginMap.find(MI);
2048 if (IDI != DbgScopeBeginMap.end())
2049 IDI->second.push_back(S);
2050 else
Devang Patel53bb5c92009-11-10 23:06:00 +00002051 DbgScopeBeginMap[MI].push_back(S);
Devang Patelaf9e8472009-10-01 20:31:14 +00002052
2053 MI = S->getLastInsn();
2054 assert (MI && "DbgScope does not have last instruction!");
2055 IDI = DbgScopeEndMap.find(MI);
2056 if (IDI != DbgScopeEndMap.end())
2057 IDI->second.push_back(S);
2058 else
Devang Patel53bb5c92009-11-10 23:06:00 +00002059 DbgScopeEndMap[MI].push_back(S);
Devang Patelaf9e8472009-10-01 20:31:14 +00002060 }
2061
2062 return !DbgScopeMap.empty();
2063}
2064
Devang Patel2c4ceb12009-11-21 02:48:08 +00002065/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002066/// emitted immediately after the function entry point.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002067void DwarfDebug::beginFunction(MachineFunction *MF) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002068 this->MF = MF;
2069
2070 if (!ShouldEmitDwarfDebug()) return;
2071
2072 if (TimePassesIsEnabled)
2073 DebugTimer->startTimer();
2074
Devang Patel2c4ceb12009-11-21 02:48:08 +00002075 if (!extractScopeInformation(MF))
Devang Patel60b35bd2009-10-06 18:37:31 +00002076 return;
Devang Patel2c4ceb12009-11-21 02:48:08 +00002077
2078 collectVariableInfo();
Devang Patel60b35bd2009-10-06 18:37:31 +00002079
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002080 // Begin accumulating function debug information.
2081 MMI->BeginFunction(MF);
2082
2083 // Assumes in correct section after the entry point.
2084 EmitLabel("func_begin", ++SubprogramCount);
2085
2086 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2087 // function.
Devang Patelac1ceb32009-10-09 22:42:28 +00002088 DebugLoc FDL = MF->getDefaultDebugLoc();
2089 if (!FDL.isUnknown()) {
2090 DebugLocTuple DLT = MF->getDebugLocTuple(FDL);
2091 unsigned LabelID = 0;
Devang Patel1619dc32009-10-13 23:28:53 +00002092 DISubprogram SP = getDISubprogram(DLT.Scope);
Devang Patelac1ceb32009-10-09 22:42:28 +00002093 if (!SP.isNull())
Devang Patel2c4ceb12009-11-21 02:48:08 +00002094 LabelID = recordSourceLine(SP.getLineNumber(), 0, DLT.Scope);
Devang Patelac1ceb32009-10-09 22:42:28 +00002095 else
Devang Patel2c4ceb12009-11-21 02:48:08 +00002096 LabelID = recordSourceLine(DLT.Line, DLT.Col, DLT.Scope);
Devang Patelac1ceb32009-10-09 22:42:28 +00002097 Asm->printLabel(LabelID);
2098 O << '\n';
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002099 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002100 if (TimePassesIsEnabled)
2101 DebugTimer->stopTimer();
2102}
2103
Devang Patel2c4ceb12009-11-21 02:48:08 +00002104/// endFunction - Gather and emit post-function debug information.
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002105///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002106void DwarfDebug::endFunction(MachineFunction *MF) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002107 if (!ShouldEmitDwarfDebug()) return;
2108
2109 if (TimePassesIsEnabled)
2110 DebugTimer->startTimer();
2111
Devang Patelac1ceb32009-10-09 22:42:28 +00002112 if (DbgScopeMap.empty())
2113 return;
Devang Patel70d75ca2009-11-12 19:02:56 +00002114
Devang Patel344130e2010-01-04 20:44:00 +00002115 if (CurrentFnDbgScope) {
2116 // Define end label for subprogram.
2117 EmitLabel("func_end", SubprogramCount);
2118
2119 // Get function line info.
2120 if (!Lines.empty()) {
2121 // Get section line info.
2122 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2123 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2124 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2125 // Append the function info to section info.
2126 SectionLineInfos.insert(SectionLineInfos.end(),
2127 Lines.begin(), Lines.end());
2128 }
2129
2130 // Construct abstract scopes.
2131 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
2132 AE = AbstractScopesList.end(); AI != AE; ++AI)
2133 constructScopeDIE(*AI);
2134
2135 constructScopeDIE(CurrentFnDbgScope);
2136
2137 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
2138 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002139 }
2140
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002141 // Clear debug info
Devang Patelc09ddc12009-12-01 18:13:48 +00002142 CurrentFnDbgScope = NULL;
2143 DbgScopeMap.clear();
2144 DbgScopeBeginMap.clear();
2145 DbgScopeEndMap.clear();
2146 ConcreteScopes.clear();
2147 AbstractScopesList.clear();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002148
2149 Lines.clear();
Devang Patelc09ddc12009-12-01 18:13:48 +00002150
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002151 if (TimePassesIsEnabled)
2152 DebugTimer->stopTimer();
2153}
2154
Devang Patel2c4ceb12009-11-21 02:48:08 +00002155/// recordSourceLine - Records location information and associates it with a
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002156/// label. Returns a unique label ID used to generate a label and provide
2157/// correspondence to the source line list.
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002158unsigned DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patelf84548d2009-10-05 18:03:19 +00002159 MDNode *S) {
Devang Patele4b27562009-08-28 23:24:31 +00002160 if (!MMI)
2161 return 0;
2162
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002163 if (TimePassesIsEnabled)
2164 DebugTimer->startTimer();
2165
Devang Patel65dbc902009-11-25 17:36:49 +00002166 StringRef Dir;
2167 StringRef Fn;
Devang Patelf84548d2009-10-05 18:03:19 +00002168
2169 DIDescriptor Scope(S);
2170 if (Scope.isCompileUnit()) {
2171 DICompileUnit CU(S);
2172 Dir = CU.getDirectory();
2173 Fn = CU.getFilename();
2174 } else if (Scope.isSubprogram()) {
2175 DISubprogram SP(S);
2176 Dir = SP.getDirectory();
2177 Fn = SP.getFilename();
2178 } else if (Scope.isLexicalBlock()) {
2179 DILexicalBlock DB(S);
2180 Dir = DB.getDirectory();
2181 Fn = DB.getFilename();
2182 } else
2183 assert (0 && "Unexpected scope info");
2184
2185 unsigned Src = GetOrCreateSourceID(Dir, Fn);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002186 unsigned ID = MMI->NextLabelID();
2187 Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
2188
2189 if (TimePassesIsEnabled)
2190 DebugTimer->stopTimer();
2191
2192 return ID;
2193}
2194
2195/// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
2196/// timed. Look up the source id with the given directory and source file
2197/// names. If none currently exists, create a new id and insert it in the
2198/// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
2199/// well.
2200unsigned DwarfDebug::getOrCreateSourceID(const std::string &DirName,
2201 const std::string &FileName) {
2202 if (TimePassesIsEnabled)
2203 DebugTimer->startTimer();
2204
Devang Patel5ccdd102009-09-29 18:40:58 +00002205 unsigned SrcId = GetOrCreateSourceID(DirName.c_str(), FileName.c_str());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002206
2207 if (TimePassesIsEnabled)
2208 DebugTimer->stopTimer();
2209
2210 return SrcId;
2211}
2212
Bill Wendling829e67b2009-05-20 23:22:40 +00002213//===----------------------------------------------------------------------===//
2214// Emit Methods
2215//===----------------------------------------------------------------------===//
2216
Devang Patel2c4ceb12009-11-21 02:48:08 +00002217/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling94d04b82009-05-20 23:21:38 +00002218///
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002219unsigned
2220DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002221 // Get the children.
2222 const std::vector<DIE *> &Children = Die->getChildren();
2223
2224 // If not last sibling and has children then add sibling offset attribute.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002225 if (!Last && !Children.empty()) Die->addSiblingOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00002226
2227 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002228 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00002229
2230 // Get the abbreviation for this DIE.
2231 unsigned AbbrevNumber = Die->getAbbrevNumber();
2232 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2233
2234 // Set DIE offset
2235 Die->setOffset(Offset);
2236
2237 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00002238 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00002239
2240 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2241 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2242
2243 // Size the DIE attribute values.
2244 for (unsigned i = 0, N = Values.size(); i < N; ++i)
2245 // Size attribute value.
2246 Offset += Values[i]->SizeOf(TD, AbbrevData[i].getForm());
2247
2248 // Size the DIE children if any.
2249 if (!Children.empty()) {
2250 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
2251 "Children flag not set");
2252
2253 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002254 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling94d04b82009-05-20 23:21:38 +00002255
2256 // End of children marker.
2257 Offset += sizeof(int8_t);
2258 }
2259
2260 Die->setSize(Offset - Die->getOffset());
2261 return Offset;
2262}
2263
Devang Patel2c4ceb12009-11-21 02:48:08 +00002264/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling94d04b82009-05-20 23:21:38 +00002265///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002266void DwarfDebug::computeSizeAndOffsets() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002267 // Compute size of compile unit header.
2268 static unsigned Offset =
2269 sizeof(int32_t) + // Length of Compilation Unit Info
2270 sizeof(int16_t) + // DWARF version number
2271 sizeof(int32_t) + // Offset Into Abbrev. Section
2272 sizeof(int8_t); // Pointer Size (in bytes)
2273
Devang Patel2c4ceb12009-11-21 02:48:08 +00002274 computeSizeAndOffset(ModuleCU->getCUDie(), Offset, true);
Devang Patel1dbc7712009-06-29 20:45:18 +00002275 CompileUnitOffsets[ModuleCU] = 0;
Bill Wendling94d04b82009-05-20 23:21:38 +00002276}
2277
Devang Patel2c4ceb12009-11-21 02:48:08 +00002278/// emitInitial - Emit initial Dwarf declarations. This is necessary for cc
Bill Wendling94d04b82009-05-20 23:21:38 +00002279/// tools to recognize the object file contains Dwarf information.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002280void DwarfDebug::emitInitial() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002281 // Check to see if we already emitted intial headers.
2282 if (didInitial) return;
2283 didInitial = true;
2284
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002285 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002286
Bill Wendling94d04b82009-05-20 23:21:38 +00002287 // Dwarf sections base addresses.
Chris Lattner33adcfb2009-08-22 21:43:10 +00002288 if (MAI->doesDwarfRequireFrameSection()) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002289 Asm->OutStreamer.SwitchSection(TLOF.getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002290 EmitLabel("section_debug_frame", 0);
2291 }
2292
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002293 Asm->OutStreamer.SwitchSection(TLOF.getDwarfInfoSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002294 EmitLabel("section_info", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002295 Asm->OutStreamer.SwitchSection(TLOF.getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002296 EmitLabel("section_abbrev", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002297 Asm->OutStreamer.SwitchSection(TLOF.getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002298 EmitLabel("section_aranges", 0);
2299
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002300 if (const MCSection *LineInfoDirective = TLOF.getDwarfMacroInfoSection()) {
2301 Asm->OutStreamer.SwitchSection(LineInfoDirective);
Bill Wendling94d04b82009-05-20 23:21:38 +00002302 EmitLabel("section_macinfo", 0);
2303 }
2304
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002305 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002306 EmitLabel("section_line", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002307 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLocSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002308 EmitLabel("section_loc", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002309 Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubNamesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002310 EmitLabel("section_pubnames", 0);
Devang Patel193f7202009-11-24 01:14:22 +00002311 Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubTypesSection());
2312 EmitLabel("section_pubtypes", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002313 Asm->OutStreamer.SwitchSection(TLOF.getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002314 EmitLabel("section_str", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002315 Asm->OutStreamer.SwitchSection(TLOF.getDwarfRangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002316 EmitLabel("section_ranges", 0);
2317
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002318 Asm->OutStreamer.SwitchSection(TLOF.getTextSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002319 EmitLabel("text_begin", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002320 Asm->OutStreamer.SwitchSection(TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002321 EmitLabel("data_begin", 0);
2322}
2323
Devang Patel2c4ceb12009-11-21 02:48:08 +00002324/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling94d04b82009-05-20 23:21:38 +00002325///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002326void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002327 // Get the abbreviation for this DIE.
2328 unsigned AbbrevNumber = Die->getAbbrevNumber();
2329 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2330
2331 Asm->EOL();
2332
2333 // Emit the code (index) for the abbreviation.
2334 Asm->EmitULEB128Bytes(AbbrevNumber);
2335
2336 if (Asm->isVerbose())
2337 Asm->EOL(std::string("Abbrev [" +
2338 utostr(AbbrevNumber) +
2339 "] 0x" + utohexstr(Die->getOffset()) +
2340 ":0x" + utohexstr(Die->getSize()) + " " +
2341 dwarf::TagString(Abbrev->getTag())));
2342 else
2343 Asm->EOL();
2344
2345 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2346 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2347
2348 // Emit the DIE attribute values.
2349 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2350 unsigned Attr = AbbrevData[i].getAttribute();
2351 unsigned Form = AbbrevData[i].getForm();
2352 assert(Form && "Too many attributes for DIE (check abbreviation)");
2353
2354 switch (Attr) {
2355 case dwarf::DW_AT_sibling:
Devang Patel2c4ceb12009-11-21 02:48:08 +00002356 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00002357 break;
2358 case dwarf::DW_AT_abstract_origin: {
2359 DIEEntry *E = cast<DIEEntry>(Values[i]);
2360 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00002361 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00002362 Asm->EmitInt32(Addr);
2363 break;
2364 }
2365 default:
2366 // Emit an attribute using the defined form.
2367 Values[i]->EmitValue(this, Form);
2368 break;
2369 }
2370
2371 Asm->EOL(dwarf::AttributeString(Attr));
2372 }
2373
2374 // Emit the DIE children if any.
2375 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2376 const std::vector<DIE *> &Children = Die->getChildren();
2377
2378 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel2c4ceb12009-11-21 02:48:08 +00002379 emitDIE(Children[j]);
Bill Wendling94d04b82009-05-20 23:21:38 +00002380
2381 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2382 }
2383}
2384
Devang Patel8a241142009-12-09 18:24:21 +00002385/// emitDebugInfo - Emit the debug info section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002386///
Devang Patel8a241142009-12-09 18:24:21 +00002387void DwarfDebug::emitDebugInfo() {
2388 // Start debug info section.
2389 Asm->OutStreamer.SwitchSection(
2390 Asm->getObjFileLowering().getDwarfInfoSection());
2391 DIE *Die = ModuleCU->getCUDie();
Bill Wendling94d04b82009-05-20 23:21:38 +00002392
2393 // Emit the compile units header.
Devang Patel8a241142009-12-09 18:24:21 +00002394 EmitLabel("info_begin", ModuleCU->getID());
Bill Wendling94d04b82009-05-20 23:21:38 +00002395
2396 // Emit size of content not including length itself
2397 unsigned ContentSize = Die->getSize() +
2398 sizeof(int16_t) + // DWARF version number
2399 sizeof(int32_t) + // Offset Into Abbrev. Section
2400 sizeof(int8_t) + // Pointer Size (in bytes)
2401 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2402
2403 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2404 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2405 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2406 Asm->EOL("Offset Into Abbrev. Section");
2407 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2408
Devang Patel2c4ceb12009-11-21 02:48:08 +00002409 emitDIE(Die);
Bill Wendling94d04b82009-05-20 23:21:38 +00002410 // FIXME - extra padding for gdb bug.
2411 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2412 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2413 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2414 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
Devang Patel8a241142009-12-09 18:24:21 +00002415 EmitLabel("info_end", ModuleCU->getID());
Bill Wendling94d04b82009-05-20 23:21:38 +00002416
2417 Asm->EOL();
Bill Wendling94d04b82009-05-20 23:21:38 +00002418}
2419
Devang Patel2c4ceb12009-11-21 02:48:08 +00002420/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002421///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002422void DwarfDebug::emitAbbreviations() const {
Bill Wendling94d04b82009-05-20 23:21:38 +00002423 // Check to see if it is worth the effort.
2424 if (!Abbreviations.empty()) {
2425 // Start the debug abbrev section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002426 Asm->OutStreamer.SwitchSection(
2427 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002428
2429 EmitLabel("abbrev_begin", 0);
2430
2431 // For each abbrevation.
2432 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2433 // Get abbreviation data
2434 const DIEAbbrev *Abbrev = Abbreviations[i];
2435
2436 // Emit the abbrevations code (base 1 index.)
2437 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2438 Asm->EOL("Abbreviation Code");
2439
2440 // Emit the abbreviations data.
2441 Abbrev->Emit(Asm);
2442
2443 Asm->EOL();
2444 }
2445
2446 // Mark end of abbreviations.
2447 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2448
2449 EmitLabel("abbrev_end", 0);
2450 Asm->EOL();
2451 }
2452}
2453
Devang Patel2c4ceb12009-11-21 02:48:08 +00002454/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling94d04b82009-05-20 23:21:38 +00002455/// the line matrix.
2456///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002457void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002458 // Define last address of section.
2459 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2460 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2461 Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2462 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2463
2464 // Mark end of matrix.
2465 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2466 Asm->EmitULEB128Bytes(1); Asm->EOL();
2467 Asm->EmitInt8(1); Asm->EOL();
2468}
2469
Devang Patel2c4ceb12009-11-21 02:48:08 +00002470/// emitDebugLines - Emit source line information.
Bill Wendling94d04b82009-05-20 23:21:38 +00002471///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002472void DwarfDebug::emitDebugLines() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002473 // If the target is using .loc/.file, the assembler will be emitting the
2474 // .debug_line table automatically.
Chris Lattner33adcfb2009-08-22 21:43:10 +00002475 if (MAI->hasDotLocAndDotFile())
Bill Wendling94d04b82009-05-20 23:21:38 +00002476 return;
2477
2478 // Minimum line delta, thus ranging from -10..(255-10).
2479 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
2480 // Maximum line delta, thus ranging from -10..(255-10).
2481 const int MaxLineDelta = 255 + MinLineDelta;
2482
2483 // Start the dwarf line section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002484 Asm->OutStreamer.SwitchSection(
2485 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002486
2487 // Construct the section header.
2488 EmitDifference("line_end", 0, "line_begin", 0, true);
2489 Asm->EOL("Length of Source Line Info");
2490 EmitLabel("line_begin", 0);
2491
2492 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2493
2494 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2495 Asm->EOL("Prolog Length");
2496 EmitLabel("line_prolog_begin", 0);
2497
2498 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2499
2500 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2501
2502 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2503
2504 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2505
2506 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2507
2508 // Line number standard opcode encodings argument count
2509 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2510 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2511 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2512 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2513 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2514 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2515 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2516 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2517 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2518
2519 // Emit directories.
2520 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
2521 Asm->EmitString(getSourceDirectoryName(DI));
2522 Asm->EOL("Directory");
2523 }
2524
2525 Asm->EmitInt8(0); Asm->EOL("End of directories");
2526
2527 // Emit files.
2528 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
2529 // Remember source id starts at 1.
2530 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
2531 Asm->EmitString(getSourceFileName(Id.second));
2532 Asm->EOL("Source");
2533 Asm->EmitULEB128Bytes(Id.first);
2534 Asm->EOL("Directory #");
2535 Asm->EmitULEB128Bytes(0);
2536 Asm->EOL("Mod date");
2537 Asm->EmitULEB128Bytes(0);
2538 Asm->EOL("File size");
2539 }
2540
2541 Asm->EmitInt8(0); Asm->EOL("End of files");
2542
2543 EmitLabel("line_prolog_end", 0);
2544
2545 // A sequence for each text section.
2546 unsigned SecSrcLinesSize = SectionSourceLines.size();
2547
2548 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2549 // Isolate current sections line info.
2550 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2551
Chris Lattner93b6db32009-08-08 23:39:42 +00002552 /*if (Asm->isVerbose()) {
Chris Lattnera87dea42009-07-31 18:48:30 +00002553 const MCSection *S = SectionMap[j + 1];
Chris Lattner33adcfb2009-08-22 21:43:10 +00002554 O << '\t' << MAI->getCommentString() << " Section"
Bill Wendling94d04b82009-05-20 23:21:38 +00002555 << S->getName() << '\n';
Chris Lattner93b6db32009-08-08 23:39:42 +00002556 }*/
2557 Asm->EOL();
Bill Wendling94d04b82009-05-20 23:21:38 +00002558
2559 // Dwarf assumes we start with first line of first source file.
2560 unsigned Source = 1;
2561 unsigned Line = 1;
2562
2563 // Construct rows of the address, source, line, column matrix.
2564 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2565 const SrcLineInfo &LineInfo = LineInfos[i];
2566 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2567 if (!LabelID) continue;
2568
Caroline Ticec6f9d622009-09-11 18:25:54 +00002569 if (LineInfo.getLine() == 0) continue;
2570
Bill Wendling94d04b82009-05-20 23:21:38 +00002571 if (!Asm->isVerbose())
2572 Asm->EOL();
2573 else {
2574 std::pair<unsigned, unsigned> SourceID =
2575 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner33adcfb2009-08-22 21:43:10 +00002576 O << '\t' << MAI->getCommentString() << ' '
Dan Gohmanb3b98212009-12-05 02:00:34 +00002577 << getSourceDirectoryName(SourceID.first) << '/'
Bill Wendling94d04b82009-05-20 23:21:38 +00002578 << getSourceFileName(SourceID.second)
Dan Gohmanb3b98212009-12-05 02:00:34 +00002579 << ':' << utostr_32(LineInfo.getLine()) << '\n';
Bill Wendling94d04b82009-05-20 23:21:38 +00002580 }
2581
2582 // Define the line address.
2583 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2584 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2585 Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2586 EmitReference("label", LabelID); Asm->EOL("Location label");
2587
2588 // If change of source, then switch to the new source.
2589 if (Source != LineInfo.getSourceID()) {
2590 Source = LineInfo.getSourceID();
2591 Asm->EmitInt8(dwarf::DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2592 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2593 }
2594
2595 // If change of line.
2596 if (Line != LineInfo.getLine()) {
2597 // Determine offset.
2598 int Offset = LineInfo.getLine() - Line;
2599 int Delta = Offset - MinLineDelta;
2600
2601 // Update line.
2602 Line = LineInfo.getLine();
2603
2604 // If delta is small enough and in range...
2605 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2606 // ... then use fast opcode.
2607 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2608 } else {
2609 // ... otherwise use long hand.
2610 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
2611 Asm->EOL("DW_LNS_advance_line");
2612 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2613 Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2614 }
2615 } else {
2616 // Copy the previous row (different address or source)
2617 Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2618 }
2619 }
2620
Devang Patel2c4ceb12009-11-21 02:48:08 +00002621 emitEndOfLineMatrix(j + 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00002622 }
2623
2624 if (SecSrcLinesSize == 0)
2625 // Because we're emitting a debug_line section, we still need a line
2626 // table. The linker and friends expect it to exist. If there's nothing to
2627 // put into it, emit an empty table.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002628 emitEndOfLineMatrix(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00002629
2630 EmitLabel("line_end", 0);
2631 Asm->EOL();
2632}
2633
Devang Patel2c4ceb12009-11-21 02:48:08 +00002634/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002635///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002636void DwarfDebug::emitCommonDebugFrame() {
Chris Lattner33adcfb2009-08-22 21:43:10 +00002637 if (!MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002638 return;
2639
2640 int stackGrowth =
2641 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2642 TargetFrameInfo::StackGrowsUp ?
2643 TD->getPointerSize() : -TD->getPointerSize();
2644
2645 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002646 Asm->OutStreamer.SwitchSection(
2647 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002648
2649 EmitLabel("debug_frame_common", 0);
2650 EmitDifference("debug_frame_common_end", 0,
2651 "debug_frame_common_begin", 0, true);
2652 Asm->EOL("Length of Common Information Entry");
2653
2654 EmitLabel("debug_frame_common_begin", 0);
2655 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
2656 Asm->EOL("CIE Identifier Tag");
2657 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
2658 Asm->EOL("CIE Version");
2659 Asm->EmitString("");
2660 Asm->EOL("CIE Augmentation");
2661 Asm->EmitULEB128Bytes(1);
2662 Asm->EOL("CIE Code Alignment Factor");
2663 Asm->EmitSLEB128Bytes(stackGrowth);
2664 Asm->EOL("CIE Data Alignment Factor");
2665 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2666 Asm->EOL("CIE RA Column");
2667
2668 std::vector<MachineMove> Moves;
2669 RI->getInitialFrameState(Moves);
2670
2671 EmitFrameMoves(NULL, 0, Moves, false);
2672
2673 Asm->EmitAlignment(2, 0, 0, false);
2674 EmitLabel("debug_frame_common_end", 0);
2675
2676 Asm->EOL();
2677}
2678
Devang Patel2c4ceb12009-11-21 02:48:08 +00002679/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling94d04b82009-05-20 23:21:38 +00002680/// section.
2681void
Devang Patel2c4ceb12009-11-21 02:48:08 +00002682DwarfDebug::emitFunctionDebugFrame(const FunctionDebugFrameInfo&DebugFrameInfo){
Chris Lattner33adcfb2009-08-22 21:43:10 +00002683 if (!MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002684 return;
2685
2686 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002687 Asm->OutStreamer.SwitchSection(
2688 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002689
2690 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2691 "debug_frame_begin", DebugFrameInfo.Number, true);
2692 Asm->EOL("Length of Frame Information Entry");
2693
2694 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2695
2696 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2697 0, 0, true, false);
2698 Asm->EOL("FDE CIE offset");
2699
2700 EmitReference("func_begin", DebugFrameInfo.Number);
2701 Asm->EOL("FDE initial location");
2702 EmitDifference("func_end", DebugFrameInfo.Number,
2703 "func_begin", DebugFrameInfo.Number);
2704 Asm->EOL("FDE address range");
2705
2706 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
2707 false);
2708
2709 Asm->EmitAlignment(2, 0, 0, false);
2710 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2711
2712 Asm->EOL();
2713}
2714
Devang Patel8a241142009-12-09 18:24:21 +00002715/// emitDebugPubNames - Emit visible names into a debug pubnames section.
2716///
2717void DwarfDebug::emitDebugPubNames() {
2718 // Start the dwarf pubnames section.
2719 Asm->OutStreamer.SwitchSection(
2720 Asm->getObjFileLowering().getDwarfPubNamesSection());
2721
2722 EmitDifference("pubnames_end", ModuleCU->getID(),
2723 "pubnames_begin", ModuleCU->getID(), true);
Bill Wendling94d04b82009-05-20 23:21:38 +00002724 Asm->EOL("Length of Public Names Info");
2725
Devang Patel8a241142009-12-09 18:24:21 +00002726 EmitLabel("pubnames_begin", ModuleCU->getID());
Bill Wendling94d04b82009-05-20 23:21:38 +00002727
2728 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF Version");
2729
2730 EmitSectionOffset("info_begin", "section_info",
Devang Patel8a241142009-12-09 18:24:21 +00002731 ModuleCU->getID(), 0, true, false);
Bill Wendling94d04b82009-05-20 23:21:38 +00002732 Asm->EOL("Offset of Compilation Unit Info");
2733
Devang Patel8a241142009-12-09 18:24:21 +00002734 EmitDifference("info_end", ModuleCU->getID(), "info_begin", ModuleCU->getID(),
Bill Wendling94d04b82009-05-20 23:21:38 +00002735 true);
2736 Asm->EOL("Compilation Unit Length");
2737
Devang Patel8a241142009-12-09 18:24:21 +00002738 const StringMap<DIE*> &Globals = ModuleCU->getGlobals();
Bill Wendling94d04b82009-05-20 23:21:38 +00002739 for (StringMap<DIE*>::const_iterator
2740 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2741 const char *Name = GI->getKeyData();
2742 DIE * Entity = GI->second;
2743
2744 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2745 Asm->EmitString(Name, strlen(Name)); Asm->EOL("External Name");
2746 }
2747
2748 Asm->EmitInt32(0); Asm->EOL("End Mark");
Devang Patel8a241142009-12-09 18:24:21 +00002749 EmitLabel("pubnames_end", ModuleCU->getID());
Bill Wendling94d04b82009-05-20 23:21:38 +00002750
2751 Asm->EOL();
2752}
2753
Devang Patel193f7202009-11-24 01:14:22 +00002754void DwarfDebug::emitDebugPubTypes() {
Devang Patelf3a03762009-11-24 19:18:41 +00002755 // Start the dwarf pubnames section.
2756 Asm->OutStreamer.SwitchSection(
2757 Asm->getObjFileLowering().getDwarfPubTypesSection());
Devang Patel193f7202009-11-24 01:14:22 +00002758 EmitDifference("pubtypes_end", ModuleCU->getID(),
2759 "pubtypes_begin", ModuleCU->getID(), true);
2760 Asm->EOL("Length of Public Types Info");
2761
2762 EmitLabel("pubtypes_begin", ModuleCU->getID());
2763
2764 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF Version");
2765
2766 EmitSectionOffset("info_begin", "section_info",
2767 ModuleCU->getID(), 0, true, false);
2768 Asm->EOL("Offset of Compilation ModuleCU Info");
2769
2770 EmitDifference("info_end", ModuleCU->getID(), "info_begin", ModuleCU->getID(),
2771 true);
2772 Asm->EOL("Compilation ModuleCU Length");
2773
2774 const StringMap<DIE*> &Globals = ModuleCU->getGlobalTypes();
2775 for (StringMap<DIE*>::const_iterator
2776 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2777 const char *Name = GI->getKeyData();
2778 DIE * Entity = GI->second;
2779
2780 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2781 Asm->EmitString(Name, strlen(Name)); Asm->EOL("External Name");
2782 }
2783
2784 Asm->EmitInt32(0); Asm->EOL("End Mark");
2785 EmitLabel("pubtypes_end", ModuleCU->getID());
2786
2787 Asm->EOL();
2788}
2789
Devang Patel2c4ceb12009-11-21 02:48:08 +00002790/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002791///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002792void DwarfDebug::emitDebugStr() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002793 // Check to see if it is worth the effort.
2794 if (!StringPool.empty()) {
2795 // Start the dwarf str section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002796 Asm->OutStreamer.SwitchSection(
2797 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002798
2799 // For each of strings in the string pool.
2800 for (unsigned StringID = 1, N = StringPool.size();
2801 StringID <= N; ++StringID) {
2802 // Emit a label for reference from debug information entries.
2803 EmitLabel("string", StringID);
2804
2805 // Emit the string itself.
2806 const std::string &String = StringPool[StringID];
2807 Asm->EmitString(String); Asm->EOL();
2808 }
2809
2810 Asm->EOL();
2811 }
2812}
2813
Devang Patel2c4ceb12009-11-21 02:48:08 +00002814/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002815///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002816void DwarfDebug::emitDebugLoc() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002817 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002818 Asm->OutStreamer.SwitchSection(
2819 Asm->getObjFileLowering().getDwarfLocSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002820 Asm->EOL();
2821}
2822
2823/// EmitDebugARanges - Emit visible names into a debug aranges section.
2824///
2825void DwarfDebug::EmitDebugARanges() {
2826 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002827 Asm->OutStreamer.SwitchSection(
2828 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002829
2830 // FIXME - Mock up
2831#if 0
2832 CompileUnit *Unit = GetBaseCompileUnit();
2833
2834 // Don't include size of length
2835 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2836
2837 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
2838
2839 EmitReference("info_begin", Unit->getID());
2840 Asm->EOL("Offset of Compilation Unit Info");
2841
2842 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2843
2844 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2845
2846 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2847 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
2848
2849 // Range 1
2850 EmitReference("text_begin", 0); Asm->EOL("Address");
2851 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2852
2853 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2854 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2855#endif
2856
2857 Asm->EOL();
2858}
2859
Devang Patel2c4ceb12009-11-21 02:48:08 +00002860/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002861///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002862void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002863 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002864 Asm->OutStreamer.SwitchSection(
2865 Asm->getObjFileLowering().getDwarfRangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002866 Asm->EOL();
2867}
2868
Devang Patel2c4ceb12009-11-21 02:48:08 +00002869/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling94d04b82009-05-20 23:21:38 +00002870///
Devang Patel2c4ceb12009-11-21 02:48:08 +00002871void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002872 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00002873 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002874 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002875 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002876 Asm->EOL();
2877 }
2878}
2879
Devang Patel2c4ceb12009-11-21 02:48:08 +00002880/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling94d04b82009-05-20 23:21:38 +00002881/// Section Header:
2882/// 1. length of section
2883/// 2. Dwarf version number
2884/// 3. address size.
2885///
2886/// Entries (one "entry" for each function that was inlined):
2887///
2888/// 1. offset into __debug_str section for MIPS linkage name, if exists;
2889/// otherwise offset into __debug_str for regular function name.
2890/// 2. offset into __debug_str section for regular function name.
2891/// 3. an unsigned LEB128 number indicating the number of distinct inlining
2892/// instances for the function.
2893///
2894/// The rest of the entry consists of a {die_offset, low_pc} pair for each
2895/// inlined instance; the die_offset points to the inlined_subroutine die in the
2896/// __debug_info section, and the low_pc is the starting address for the
2897/// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002898void DwarfDebug::emitDebugInlineInfo() {
Chris Lattner33adcfb2009-08-22 21:43:10 +00002899 if (!MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002900 return;
2901
Devang Patel1dbc7712009-06-29 20:45:18 +00002902 if (!ModuleCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00002903 return;
2904
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002905 Asm->OutStreamer.SwitchSection(
2906 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002907 Asm->EOL();
2908 EmitDifference("debug_inlined_end", 1,
2909 "debug_inlined_begin", 1, true);
2910 Asm->EOL("Length of Debug Inlined Information Entry");
2911
2912 EmitLabel("debug_inlined_begin", 1);
2913
2914 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
2915 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2916
Devang Patel53bb5c92009-11-10 23:06:00 +00002917 for (SmallVector<MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
2918 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002919
Devang Patel53bb5c92009-11-10 23:06:00 +00002920 MDNode *Node = *I;
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002921 ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
2922 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00002923 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00002924 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00002925 StringRef LName = SP.getLinkageName();
2926 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00002927
Devang Patel65dbc902009-11-25 17:36:49 +00002928 if (LName.empty())
Devang Patel53cb17d2009-07-16 01:01:22 +00002929 Asm->EmitString(Name);
Devang Patel351ca332010-01-05 01:46:14 +00002930 else
Devang Patel53bb5c92009-11-10 23:06:00 +00002931 EmitSectionOffset("string", "section_str",
Devang Patel351ca332010-01-05 01:46:14 +00002932 StringPool.idFor(getRealLinkageName(LName)), false, true);
Devang Patel53bb5c92009-11-10 23:06:00 +00002933
Bill Wendling94d04b82009-05-20 23:21:38 +00002934 Asm->EOL("MIPS linkage name");
Devang Patel53bb5c92009-11-10 23:06:00 +00002935 EmitSectionOffset("string", "section_str",
2936 StringPool.idFor(Name), false, true);
2937 Asm->EOL("Function name");
Bill Wendling94d04b82009-05-20 23:21:38 +00002938 Asm->EmitULEB128Bytes(Labels.size()); Asm->EOL("Inline count");
2939
Devang Patel53bb5c92009-11-10 23:06:00 +00002940 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00002941 LE = Labels.end(); LI != LE; ++LI) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002942 DIE *SP = LI->second;
Bill Wendling94d04b82009-05-20 23:21:38 +00002943 Asm->EmitInt32(SP->getOffset()); Asm->EOL("DIE offset");
2944
2945 if (TD->getPointerSize() == sizeof(int32_t))
Chris Lattner33adcfb2009-08-22 21:43:10 +00002946 O << MAI->getData32bitsDirective();
Bill Wendling94d04b82009-05-20 23:21:38 +00002947 else
Chris Lattner33adcfb2009-08-22 21:43:10 +00002948 O << MAI->getData64bitsDirective();
Bill Wendling94d04b82009-05-20 23:21:38 +00002949
Devang Patel53bb5c92009-11-10 23:06:00 +00002950 PrintLabelName("label", LI->first); Asm->EOL("low_pc");
Bill Wendling94d04b82009-05-20 23:21:38 +00002951 }
2952 }
2953
2954 EmitLabel("debug_inlined_end", 1);
2955 Asm->EOL();
2956}