blob: a65a385f4405318dbcffa116d17fc37fdc266696 [file] [log] [blame]
Bill Wendling2f921f82009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Devang Patel80ae3492009-08-28 23:24:31 +000013#define DEBUG_TYPE "dwarfdebug"
Bill Wendling2f921f82009-05-15 09:23:25 +000014#include "DwarfDebug.h"
15#include "llvm/Module.h"
David Greene829b3e82009-08-19 21:52:55 +000016#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000017#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000018#include "llvm/MC/MCSection.h"
Chris Lattner4b7dadb2009-08-19 05:49:37 +000019#include "llvm/MC/MCStreamer.h"
Chris Lattner7b26fce2009-08-22 20:48:53 +000020#include "llvm/MC/MCAsmInfo.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000021#include "llvm/Target/TargetData.h"
22#include "llvm/Target/TargetFrameInfo.h"
Chris Lattner5e693ed2009-07-28 03:13:23 +000023#include "llvm/Target/TargetLoweringObjectFile.h"
24#include "llvm/Target/TargetRegisterInfo.h"
Chris Lattner06fa1762009-08-24 03:52:50 +000025#include "llvm/ADT/StringExtras.h"
Daniel Dunbarcdf01b52009-10-13 06:47:08 +000026#include "llvm/Support/Debug.h"
27#include "llvm/Support/ErrorHandling.h"
Chris Lattnerdd5a9892009-09-16 00:08:41 +000028#include "llvm/Support/Mangler.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000029#include "llvm/Support/Timer.h"
30#include "llvm/System/Path.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000031using namespace llvm;
32
Bill Wendling2f921f82009-05-15 09:23:25 +000033//===----------------------------------------------------------------------===//
34
35/// Configuration values for initial hash set sizes (log2).
36///
Bill Wendling2f921f82009-05-15 09:23:25 +000037static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling2f921f82009-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 Lewyckyb7993d62009-11-17 08:11:44 +000044class CompileUnit {
Bill Wendling2f921f82009-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 Patel930143b2009-11-21 02:48:08 +000051 DIE *CUDie;
Bill Wendling2f921f82009-05-15 09:23:25 +000052
Devang Patel92e8c652009-11-21 00:31:03 +000053 /// IndexTyDie - An anonymous type for index type.
54 DIE *IndexTyDie;
55
Bill Wendling2f921f82009-05-15 09:23:25 +000056 /// GVToDieMap - Tracks the mapping of unit level debug informaton
57 /// variables to debug information entries.
Devang Patel80ae3492009-08-28 23:24:31 +000058 /// FIXME : Rename GVToDieMap -> NodeToDieMap
Devang Patele064ad42009-11-20 21:37:22 +000059 ValueMap<MDNode *, DIE *> GVToDieMap;
Bill Wendling2f921f82009-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 Patel80ae3492009-08-28 23:24:31 +000063 /// FIXME : Rename
Devang Patele064ad42009-11-20 21:37:22 +000064 ValueMap<MDNode *, DIEEntry *> GVToDIEEntryMap;
Bill Wendling2f921f82009-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 Patel04d2f2d2009-11-24 01:14:22 +000070 /// GlobalTypes - A map of globally visible types for this unit.
71 ///
72 StringMap<DIE*> GlobalTypes;
73
Bill Wendling2f921f82009-05-15 09:23:25 +000074public:
75 CompileUnit(unsigned I, DIE *D)
Devang Patel930143b2009-11-21 02:48:08 +000076 : ID(I), CUDie(D), IndexTyDie(0) {}
77 ~CompileUnit() { delete CUDie; delete IndexTyDie; }
Bill Wendling2f921f82009-05-15 09:23:25 +000078
79 // Accessors.
Devang Patel04d2f2d2009-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 Wendling2f921f82009-05-15 09:23:25 +000084
85 /// hasContent - Return true if this compile unit has something to write out.
86 ///
Devang Patel930143b2009-11-21 02:48:08 +000087 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendling2f921f82009-05-15 09:23:25 +000088
Devang Patel930143b2009-11-21 02:48:08 +000089 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +000090 ///
Devang Patel930143b2009-11-21 02:48:08 +000091 void addGlobal(const std::string &Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling2f921f82009-05-15 09:23:25 +000092
Devang Patel04d2f2d2009-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 Patele064ad42009-11-20 21:37:22 +000099 /// getDIE - Returns the debug information entry map slot for the
Bill Wendling2f921f82009-05-15 09:23:25 +0000100 /// specified debug variable.
Devang Patele064ad42009-11-20 21:37:22 +0000101 DIE *getDIE(MDNode *N) { return GVToDieMap.lookup(N); }
Jim Grosbach042483e2009-11-21 23:12:12 +0000102
Devang Patele064ad42009-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 Wendling2f921f82009-05-15 09:23:25 +0000107
Devang Patele064ad42009-11-20 21:37:22 +0000108 /// getDIEEntry - Returns the debug information entry for the speciefied
109 /// debug variable.
Devang Patel1f4690c2009-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 Patele064ad42009-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 Wendling2f921f82009-05-15 09:23:25 +0000120 }
121
Devang Patel930143b2009-11-21 02:48:08 +0000122 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendling2f921f82009-05-15 09:23:25 +0000123 ///
Devang Patel930143b2009-11-21 02:48:08 +0000124 void addDie(DIE *Buffer) {
125 this->CUDie->addChild(Buffer);
Bill Wendling2f921f82009-05-15 09:23:25 +0000126 }
Devang Patel92e8c652009-11-21 00:31:03 +0000127
128 // getIndexTyDie - Get an anonymous type for index type.
129 DIE *getIndexTyDie() {
130 return IndexTyDie;
131 }
132
Jim Grosbach00e9c612009-11-22 19:20:36 +0000133 // setIndexTyDie - Set D as anonymous type for index which can be reused
134 // later.
Devang Patel92e8c652009-11-21 00:31:03 +0000135 void setIndexTyDie(DIE *D) {
136 IndexTyDie = D;
137 }
138
Bill Wendling2f921f82009-05-15 09:23:25 +0000139};
140
141//===----------------------------------------------------------------------===//
142/// DbgVariable - This class is used to track local variable information.
143///
Devang Patelf3d7c082009-11-16 21:53:40 +0000144class DbgVariable {
Bill Wendling2f921f82009-05-15 09:23:25 +0000145 DIVariable Var; // Variable Descriptor.
146 unsigned FrameIndex; // Variable frame index.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000147 DbgVariable *AbstractVar; // Abstract variable for this variable.
148 DIE *TheDIE;
Bill Wendling2f921f82009-05-15 09:23:25 +0000149public:
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000150 DbgVariable(DIVariable V, unsigned I)
151 : Var(V), FrameIndex(I), AbstractVar(0), TheDIE(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000152
153 // Accessors.
Devang Patelf6eeaeb2009-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 Wendling2f921f82009-05-15 09:23:25 +0000160};
161
162//===----------------------------------------------------------------------===//
163/// DbgScope - This class is used to track scope information.
164///
Devang Patelf3d7c082009-11-16 21:53:40 +0000165class DbgScope {
Bill Wendling2f921f82009-05-15 09:23:25 +0000166 DbgScope *Parent; // Parent to this scope.
Jim Grosbach042483e2009-11-21 23:12:12 +0000167 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000168 WeakVH InlinedAtLocation; // Location at which scope is inlined.
169 bool AbstractScope; // Abstract Scope
Bill Wendling2f921f82009-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 Patel787f94c2009-10-01 18:25:23 +0000172 const MachineInstr *LastInsn; // Last instruction of this scope.
173 const MachineInstr *FirstInsn; // First instruction of this scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000174 SmallVector<DbgScope *, 4> Scopes; // Scopes defined in scope.
175 SmallVector<DbgVariable *, 8> Variables;// Variables declared in scope.
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000176
Owen Anderson9becc182009-06-24 22:53:20 +0000177 // Private state for dump()
178 mutable unsigned IndentLevel;
Bill Wendling2f921f82009-05-15 09:23:25 +0000179public:
Devang Patel6875c5eb2009-10-14 21:08:09 +0000180 DbgScope(DbgScope *P, DIDescriptor D, MDNode *I = 0)
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000181 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Jim Grosbach042483e2009-11-21 23:12:12 +0000182 StartLabelID(0), EndLabelID(0),
Devang Patel6875c5eb2009-10-14 21:08:09 +0000183 LastInsn(0), FirstInsn(0), IndentLevel(0) {}
Bill Wendling2f921f82009-05-15 09:23:25 +0000184 virtual ~DbgScope();
185
186 // Accessors.
187 DbgScope *getParent() const { return Parent; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000188 void setParent(DbgScope *P) { Parent = P; }
Bill Wendling2f921f82009-05-15 09:23:25 +0000189 DIDescriptor getDesc() const { return Desc; }
Jim Grosbach042483e2009-11-21 23:12:12 +0000190 MDNode *getInlinedAt() const {
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000191 return dyn_cast_or_null<MDNode>(InlinedAtLocation);
Devang Patel6875c5eb2009-10-14 21:08:09 +0000192 }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000193 MDNode *getScopeNode() const { return Desc.getNode(); }
Bill Wendling2f921f82009-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 Wendling2f921f82009-05-15 09:23:25 +0000198 void setStartLabelID(unsigned S) { StartLabelID = S; }
199 void setEndLabelID(unsigned E) { EndLabelID = E; }
Devang Patel787f94c2009-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 Patelf6eeaeb2009-11-10 23:06:00 +0000203 void setAbstractScope() { AbstractScope = true; }
204 bool isAbstractScope() const { return AbstractScope; }
Devang Patel787f94c2009-10-01 18:25:23 +0000205 const MachineInstr *getFirstInsn() { return FirstInsn; }
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000206
Devang Patel930143b2009-11-21 02:48:08 +0000207 /// addScope - Add a scope to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000208 ///
Devang Patel930143b2009-11-21 02:48:08 +0000209 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000210
Devang Patel930143b2009-11-21 02:48:08 +0000211 /// addVariable - Add a variable to the scope.
Bill Wendling2f921f82009-05-15 09:23:25 +0000212 ///
Devang Patel930143b2009-11-21 02:48:08 +0000213 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendling2f921f82009-05-15 09:23:25 +0000214
Devang Patel530a0752010-01-04 20:44:00 +0000215 void fixInstructionMarkers(DenseMap<const MachineInstr *,
216 unsigned> &MIIndexMap) {
Devang Patel75cc16c2009-10-01 20:31:14 +0000217 assert (getFirstInsn() && "First instruction is missing!");
Devang Patel530a0752010-01-04 20:44:00 +0000218
219 // Use the end of last child scope as end of this scope.
Devang Patel75cc16c2009-10-01 20:31:14 +0000220 SmallVector<DbgScope *, 4> &Scopes = getScopes();
Devang Patel530a0752010-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 Patel75cc16c2009-10-01 20:31:14 +0000239 }
240
Bill Wendling2f921f82009-05-15 09:23:25 +0000241#ifndef NDEBUG
242 void dump() const;
243#endif
244};
245
246#ifndef NDEBUG
247void DbgScope::dump() const {
David Greenec230cb92009-12-24 00:31:35 +0000248 raw_ostream &err = dbgs();
Chris Lattner81e8e022009-08-23 00:51:00 +0000249 err.indent(IndentLevel);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000250 MDNode *N = Desc.getNode();
251 N->dump();
Chris Lattner81e8e022009-08-23 00:51:00 +0000252 err << " [" << StartLabelID << ", " << EndLabelID << "]\n";
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000253 if (AbstractScope)
254 err << "Abstract Scope\n";
Bill Wendling2f921f82009-05-15 09:23:25 +0000255
256 IndentLevel += 2;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000257 if (!Scopes.empty())
258 err << "Children ...\n";
Bill Wendling2f921f82009-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 Wendling2f921f82009-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 Wendling2f921f82009-05-15 09:23:25 +0000272}
273
274} // end llvm namespace
275
Chris Lattner7b26fce2009-08-22 20:48:53 +0000276DwarfDebug::DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T)
Devang Patel40d78412009-06-29 20:45:18 +0000277 : Dwarf(OS, A, T, "dbg"), ModuleCU(0),
Bill Wendling2f921f82009-05-15 09:23:25 +0000278 AbbreviationsSet(InitAbbreviationsSetSize), Abbreviations(),
Devang Patel930143b2009-11-21 02:48:08 +0000279 DIEValues(), StringPool(),
Bill Wendling2f921f82009-05-15 09:23:25 +0000280 SectionSourceLines(), didInitial(false), shouldEmit(false),
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000281 CurrentFnDbgScope(0), DebugTimer(0) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000282 if (TimePassesIsEnabled)
Chris Lattnerf81add32009-12-28 07:41:18 +0000283 DebugTimer = new Timer("Dwarf Debug Writer");
Bill Wendling2f921f82009-05-15 09:23:25 +0000284}
285DwarfDebug::~DwarfDebug() {
Devang Patel930143b2009-11-21 02:48:08 +0000286 for (unsigned j = 0, M = DIEValues.size(); j < M; ++j)
287 delete DIEValues[j];
Bill Wendling2f921f82009-05-15 09:23:25 +0000288
Bill Wendling2f921f82009-05-15 09:23:25 +0000289 delete DebugTimer;
290}
291
Devang Patel930143b2009-11-21 02:48:08 +0000292/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling2f921f82009-05-15 09:23:25 +0000293///
Devang Patel930143b2009-11-21 02:48:08 +0000294void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling2f921f82009-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 Patel930143b2009-11-21 02:48:08 +0000315/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendlingbcad77a2009-05-20 23:24:48 +0000316/// information entry.
Devang Patel930143b2009-11-21 02:48:08 +0000317DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Devang Patel92e8c652009-11-21 00:31:03 +0000318 DIEEntry *Value = new DIEEntry(Entry);
Devang Patel930143b2009-11-21 02:48:08 +0000319 DIEValues.push_back(Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000320 return Value;
321}
322
Devang Patel930143b2009-11-21 02:48:08 +0000323/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000324///
Devang Patel930143b2009-11-21 02:48:08 +0000325void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000326 unsigned Form, uint64_t Integer) {
327 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Devang Patel92e8c652009-11-21 00:31:03 +0000328 DIEValue *Value = new DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000329 DIEValues.push_back(Value);
330 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000331}
332
Devang Patel930143b2009-11-21 02:48:08 +0000333/// addSInt - Add an signed integer attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000334///
Devang Patel930143b2009-11-21 02:48:08 +0000335void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-05-15 09:23:25 +0000336 unsigned Form, int64_t Integer) {
337 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Devang Patel92e8c652009-11-21 00:31:03 +0000338 DIEValue *Value = new DIEInteger(Integer);
Devang Patel930143b2009-11-21 02:48:08 +0000339 DIEValues.push_back(Value);
340 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000341}
342
Devang Patel8c339592009-12-02 15:25:16 +0000343/// addString - Add a string attribute data and value. DIEString only
344/// keeps string reference.
Devang Patel930143b2009-11-21 02:48:08 +0000345void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Devang Patelb3e01682009-11-24 19:42:17 +0000346 const StringRef String) {
Devang Patel92e8c652009-11-21 00:31:03 +0000347 DIEValue *Value = new DIEString(String);
Devang Patel930143b2009-11-21 02:48:08 +0000348 DIEValues.push_back(Value);
349 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000350}
351
Devang Patel930143b2009-11-21 02:48:08 +0000352/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000353///
Devang Patel930143b2009-11-21 02:48:08 +0000354void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling2f921f82009-05-15 09:23:25 +0000355 const DWLabel &Label) {
Devang Patel92e8c652009-11-21 00:31:03 +0000356 DIEValue *Value = new DIEDwarfLabel(Label);
Devang Patel930143b2009-11-21 02:48:08 +0000357 DIEValues.push_back(Value);
358 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000359}
360
Devang Patel930143b2009-11-21 02:48:08 +0000361/// addObjectLabel - Add an non-Dwarf label attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000362///
Devang Patel930143b2009-11-21 02:48:08 +0000363void DwarfDebug::addObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling2f921f82009-05-15 09:23:25 +0000364 const std::string &Label) {
Devang Patel92e8c652009-11-21 00:31:03 +0000365 DIEValue *Value = new DIEObjectLabel(Label);
Devang Patel930143b2009-11-21 02:48:08 +0000366 DIEValues.push_back(Value);
367 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000368}
369
Devang Patel930143b2009-11-21 02:48:08 +0000370/// addSectionOffset - Add a section offset label attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000371///
Devang Patel930143b2009-11-21 02:48:08 +0000372void DwarfDebug::addSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling2f921f82009-05-15 09:23:25 +0000373 const DWLabel &Label, const DWLabel &Section,
374 bool isEH, bool useSet) {
Devang Patel92e8c652009-11-21 00:31:03 +0000375 DIEValue *Value = new DIESectionOffset(Label, Section, isEH, useSet);
Devang Patel930143b2009-11-21 02:48:08 +0000376 DIEValues.push_back(Value);
377 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000378}
379
Devang Patel930143b2009-11-21 02:48:08 +0000380/// addDelta - Add a label delta attribute data and value.
Bill Wendling2f921f82009-05-15 09:23:25 +0000381///
Devang Patel930143b2009-11-21 02:48:08 +0000382void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling2f921f82009-05-15 09:23:25 +0000383 const DWLabel &Hi, const DWLabel &Lo) {
Devang Patel92e8c652009-11-21 00:31:03 +0000384 DIEValue *Value = new DIEDelta(Hi, Lo);
Devang Patel930143b2009-11-21 02:48:08 +0000385 DIEValues.push_back(Value);
386 Die->addValue(Attribute, Form, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +0000387}
388
Devang Patel930143b2009-11-21 02:48:08 +0000389/// addBlock - Add block data.
Bill Wendling2f921f82009-05-15 09:23:25 +0000390///
Devang Patel930143b2009-11-21 02:48:08 +0000391void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendling2f921f82009-05-15 09:23:25 +0000392 DIEBlock *Block) {
393 Block->ComputeSize(TD);
Devang Patel930143b2009-11-21 02:48:08 +0000394 DIEValues.push_back(Block);
395 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000396}
397
Devang Patel930143b2009-11-21 02:48:08 +0000398/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000399/// entry.
Devang Patel930143b2009-11-21 02:48:08 +0000400void DwarfDebug::addSourceLine(DIE *Die, const DIVariable *V) {
Bill Wendling2f921f82009-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 Patelb314bd62009-12-11 21:37:07 +0000406 unsigned FileID = findCompileUnit(V->getCompileUnit())->getID();
Bill Wendling2f921f82009-05-15 09:23:25 +0000407 assert(FileID && "Invalid file id");
Devang Patel930143b2009-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 Wendling2f921f82009-05-15 09:23:25 +0000410}
411
Devang Patel930143b2009-11-21 02:48:08 +0000412/// addSourceLine - Add location information to specified debug information
Bill Wendling2f921f82009-05-15 09:23:25 +0000413/// entry.
Devang Patel930143b2009-11-21 02:48:08 +0000414void DwarfDebug::addSourceLine(DIE *Die, const DIGlobal *G) {
Bill Wendling2f921f82009-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 Patelb314bd62009-12-11 21:37:07 +0000420 unsigned FileID = findCompileUnit(G->getCompileUnit())->getID();
Bill Wendling2f921f82009-05-15 09:23:25 +0000421 assert(FileID && "Invalid file id");
Devang Patel930143b2009-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 Wendling2f921f82009-05-15 09:23:25 +0000424}
Devang Patelb2de5fa2009-08-31 22:47:13 +0000425
Devang Patel930143b2009-11-21 02:48:08 +0000426/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000427/// entry.
Devang Patel930143b2009-11-21 02:48:08 +0000428void DwarfDebug::addSourceLine(DIE *Die, const DISubprogram *SP) {
Devang Patelb2de5fa2009-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 Tice183a5192009-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 Patelb2de5fa2009-08-31 22:47:13 +0000436
437 unsigned Line = SP->getLineNumber();
Devang Patelb314bd62009-12-11 21:37:07 +0000438 unsigned FileID = findCompileUnit(SP->getCompileUnit())->getID();
Devang Patelb2de5fa2009-08-31 22:47:13 +0000439 assert(FileID && "Invalid file id");
Devang Patel930143b2009-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 Patelb2de5fa2009-08-31 22:47:13 +0000442}
443
Devang Patel930143b2009-11-21 02:48:08 +0000444/// addSourceLine - Add location information to specified debug information
Devang Patelb2de5fa2009-08-31 22:47:13 +0000445/// entry.
Devang Patel930143b2009-11-21 02:48:08 +0000446void DwarfDebug::addSourceLine(DIE *Die, const DIType *Ty) {
Bill Wendling2f921f82009-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 Patelb314bd62009-12-11 21:37:07 +0000453 unsigned FileID = findCompileUnit(CU)->getID();
Bill Wendling2f921f82009-05-15 09:23:25 +0000454 assert(FileID && "Invalid file id");
Devang Patel930143b2009-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 Wendling2f921f82009-05-15 09:23:25 +0000457}
458
Devang Patel1f4690c2009-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 Ticec87c1e22009-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 Patel930143b2009-11-21 02:48:08 +0000499 value of the variable. The function addBlockByrefType does this. */
Caroline Ticec87c1e22009-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 Patel930143b2009-11-21 02:48:08 +0000504DIType DwarfDebug::getBlockByrefType(DIType Ty, std::string Name) {
Caroline Ticec87c1e22009-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 Stump14cf8ec2009-09-30 00:08:22 +0000510 DIDerivedType DTy = DIDerivedType(Ty.getNode());
Caroline Ticec87c1e22009-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 Patel2d9caf92009-11-25 17:36:49 +0000524 if (Name == DT.getName())
Caroline Ticec87c1e22009-08-31 21:19:37 +0000525 return (DT.getTypeDerivedFrom());
526 }
527
528 return Ty;
529}
530
Devang Patel930143b2009-11-21 02:48:08 +0000531/// addComplexAddress - Start with the address based on the location provided,
Mike Stump14cf8ec2009-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 Patel930143b2009-11-21 02:48:08 +0000536void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stump14cf8ec2009-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 Patel930143b2009-11-21 02:48:08 +0000549 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000550 } else {
551 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel930143b2009-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 Stump14cf8ec2009-09-30 00:08:22 +0000554 }
555 } else {
556 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000557 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000558 else {
Devang Patel930143b2009-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 Stump14cf8ec2009-09-30 00:08:22 +0000561 }
562
Devang Patel930143b2009-11-21 02:48:08 +0000563 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stump14cf8ec2009-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 Patel930143b2009-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 Stump14cf8ec2009-09-30 00:08:22 +0000572 } else if (Element == DIFactory::OpDeref) {
Devang Patel930143b2009-11-21 02:48:08 +0000573 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000574 } else llvm_unreachable("unknown DIFactory Opcode");
575 }
576
577 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000578 addBlock(Die, Attribute, 0, Block);
Mike Stump14cf8ec2009-09-30 00:08:22 +0000579}
580
Caroline Ticec87c1e22009-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 Patel930143b2009-11-21 02:48:08 +0000590 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Ticec87c1e22009-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 Dunbarc418d6b2009-09-19 20:40:05 +0000595 expression that explains to the debugger how to navigate through the
Caroline Ticec87c1e22009-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 Patel930143b2009-11-21 02:48:08 +0000635/// addBlockByrefAddress - Start with the address based on the location
Caroline Ticec87c1e22009-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 Patel930143b2009-11-21 02:48:08 +0000641void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000642 unsigned Attribute,
643 const MachineLocation &Location) {
Caroline Ticec87c1e22009-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 Patel2d9caf92009-11-25 17:36:49 +0000650 StringRef varName = VD.getName();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000651
652 if (Tag == dwarf::DW_TAG_pointer_type) {
Mike Stump14cf8ec2009-09-30 00:08:22 +0000653 DIDerivedType DTy = DIDerivedType(Ty.getNode());
Caroline Ticec87c1e22009-08-31 21:19:37 +0000654 TmpTy = DTy.getTypeDerivedFrom();
655 isPointer = true;
656 }
657
658 DICompositeType blockStruct = DICompositeType(TmpTy.getNode());
659
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000660 // Find the __forwarding field and the variable field in the __Block_byref
661 // struct.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000662 DIArray Fields = blockStruct.getTypeArray();
663 DIDescriptor varField = DIDescriptor();
664 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000665
666
Daniel Dunbarbe22ec42009-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 Patel2d9caf92009-11-25 17:36:49 +0000670 StringRef fieldName = DT.getName();
671 if (fieldName == "__forwarding")
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000672 forwardingField = Element;
Devang Patel2d9caf92009-11-25 17:36:49 +0000673 else if (fieldName == varName)
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000674 varField = Element;
675 }
Daniel Dunbarc418d6b2009-09-19 20:40:05 +0000676
Mike Stump944fa252009-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 Ticec87c1e22009-08-31 21:19:37 +0000680
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000681 // Get the offsets for the forwarding field and the variable field.
Daniel Dunbarbe22ec42009-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 Ticec87c1e22009-08-31 21:19:37 +0000686
Mike Stump944fa252009-09-24 23:21:26 +0000687 // Decode the original location, and use that as the start of the byref
688 // variable's location.
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000689 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
690 DIEBlock *Block = new DIEBlock();
Caroline Ticec87c1e22009-08-31 21:19:37 +0000691
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000692 if (Location.isReg()) {
693 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000694 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000695 else {
696 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patel930143b2009-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 Dunbarbe22ec42009-09-19 20:40:14 +0000699 }
700 } else {
701 if (Reg < 32)
Devang Patel930143b2009-11-21 02:48:08 +0000702 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000703 else {
Devang Patel930143b2009-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 Dunbarbe22ec42009-09-19 20:40:14 +0000706 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000707
Devang Patel930143b2009-11-21 02:48:08 +0000708 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000709 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000710
Mike Stump944fa252009-09-24 23:21:26 +0000711 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000712 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000713 if (isPointer)
Devang Patel930143b2009-11-21 02:48:08 +0000714 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000715
Daniel Dunbarbe22ec42009-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 Dunbarbe22ec42009-09-19 20:40:14 +0000719 if (forwardingFieldOffset > 0) {
Devang Patel930143b2009-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 Dunbarbe22ec42009-09-19 20:40:14 +0000722 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000723
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000724 // Now dereference the __forwarding field to get to the real __Block_byref
725 // struct: DW_OP_deref.
Devang Patel930143b2009-11-21 02:48:08 +0000726 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000727
Daniel Dunbarbe22ec42009-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 Dunbarbe22ec42009-09-19 20:40:14 +0000731 if (varFieldOffset > 0) {
Devang Patel930143b2009-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 Dunbarbe22ec42009-09-19 20:40:14 +0000734 }
Caroline Ticec87c1e22009-08-31 21:19:37 +0000735
Daniel Dunbarbe22ec42009-09-19 20:40:14 +0000736 // Now attach the location information to the DIE.
Devang Patel930143b2009-11-21 02:48:08 +0000737 addBlock(Die, Attribute, 0, Block);
Caroline Ticec87c1e22009-08-31 21:19:37 +0000738}
739
Devang Patel930143b2009-11-21 02:48:08 +0000740/// addAddress - Add an address attribute to a die based on the location
Bill Wendling2f921f82009-05-15 09:23:25 +0000741/// provided.
Devang Patel930143b2009-11-21 02:48:08 +0000742void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendling2f921f82009-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 Patel930143b2009-11-21 02:48:08 +0000749 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000750 } else {
Devang Patel930143b2009-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 Wendling2f921f82009-05-15 09:23:25 +0000753 }
754 } else {
755 if (Reg < 32) {
Devang Patel930143b2009-11-21 02:48:08 +0000756 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendling2f921f82009-05-15 09:23:25 +0000757 } else {
Devang Patel930143b2009-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 Wendling2f921f82009-05-15 09:23:25 +0000760 }
761
Devang Patel930143b2009-11-21 02:48:08 +0000762 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendling2f921f82009-05-15 09:23:25 +0000763 }
764
Devang Patel930143b2009-11-21 02:48:08 +0000765 addBlock(Die, Attribute, 0, Block);
Bill Wendling2f921f82009-05-15 09:23:25 +0000766}
767
Devang Patel2b75ed22009-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 Patel1f4690c2009-12-15 19:16:48 +0000775 } else if (Context.isNameSpace()) {
776 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context.getNode()));
777 ContextDIE->addChild(Die);
Devang Patel2b75ed22009-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 Patelb5b60ea2009-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 Patel2b75ed22009-12-10 19:14:49 +0000803 addToContextOwner(TyDIE, Ty.getContext());
Devang Patelb5b60ea2009-12-10 18:05:33 +0000804 return TyDIE;
805}
806
Devang Patel930143b2009-11-21 02:48:08 +0000807/// addType - Add a new type attribute to the specified entity.
Devang Patel9ccfb642009-12-09 18:24:21 +0000808void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000809 if (Ty.isNull())
810 return;
811
812 // Check for pre-existence.
Devang Patel9ccfb642009-12-09 18:24:21 +0000813 DIEEntry *Entry = ModuleCU->getDIEEntry(Ty.getNode());
Bill Wendling2f921f82009-05-15 09:23:25 +0000814 // If it exists then use the existing value.
Devang Patel930143b2009-11-21 02:48:08 +0000815 if (Entry) {
816 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000817 return;
818 }
819
820 // Set up proxy.
Devang Patel930143b2009-11-21 02:48:08 +0000821 Entry = createDIEEntry();
Devang Patel9ccfb642009-12-09 18:24:21 +0000822 ModuleCU->insertDIEEntry(Ty.getNode(), Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000823
824 // Construct type.
Devang Patelb5b60ea2009-12-10 18:05:33 +0000825 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendling2f921f82009-05-15 09:23:25 +0000826
Devang Patel930143b2009-11-21 02:48:08 +0000827 Entry->setEntry(Buffer);
828 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendling2f921f82009-05-15 09:23:25 +0000829}
830
Devang Patel930143b2009-11-21 02:48:08 +0000831/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000832void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000833 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000834 StringRef Name = BTy.getName();
Bill Wendling2f921f82009-05-15 09:23:25 +0000835 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patel930143b2009-11-21 02:48:08 +0000836 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendling2f921f82009-05-15 09:23:25 +0000837 BTy.getEncoding());
838
839 // Add name if not anonymous or intermediate type.
Devang Patel2d9caf92009-11-25 17:36:49 +0000840 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +0000841 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +0000842 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel930143b2009-11-21 02:48:08 +0000843 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +0000844}
845
Devang Patel930143b2009-11-21 02:48:08 +0000846/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000847void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000848 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000849 StringRef Name = DTy.getName();
Bill Wendling2f921f82009-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 Patel9ccfb642009-12-09 18:24:21 +0000860 addType(&Buffer, FromTy);
Bill Wendling2f921f82009-05-15 09:23:25 +0000861
862 // Add name if not anonymous or intermediate type.
Devang Patelae466ef2009-11-30 23:56:56 +0000863 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +0000864 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +0000865
866 // Add size if non-zero (derived types might be zero-sized.)
867 if (Size)
Devang Patel930143b2009-11-21 02:48:08 +0000868 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +0000869
870 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patelb5b51592009-11-23 18:43:37 +0000871 if (!DTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +0000872 addSourceLine(&Buffer, &DTy);
Bill Wendling2f921f82009-05-15 09:23:25 +0000873}
874
Devang Patel930143b2009-11-21 02:48:08 +0000875/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000876void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendling2f921f82009-05-15 09:23:25 +0000877 // Get core information.
Devang Patel2d9caf92009-11-25 17:36:49 +0000878 StringRef Name = CTy.getName();
Bill Wendling2f921f82009-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 Patel9ccfb642009-12-09 18:24:21 +0000887 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendling2f921f82009-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 Patel80ae3492009-08-28 23:24:31 +0000895 DIEnumerator Enum(Elements.getElement(i).getNode());
Devang Patelfafa1fe2009-10-09 17:51:49 +0000896 if (!Enum.isNull()) {
Devang Patel9ccfb642009-12-09 18:24:21 +0000897 ElemDie = constructEnumTypeDIE(&Enum);
Devang Patel930143b2009-11-21 02:48:08 +0000898 Buffer.addChild(ElemDie);
Devang Patelfafa1fe2009-10-09 17:51:49 +0000899 }
Bill Wendling2f921f82009-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 Patel9ccfb642009-12-09 18:24:21 +0000907 addType(&Buffer, DIType(RTy.getNode()));
Bill Wendling2f921f82009-05-15 09:23:25 +0000908
909 // Add prototype flag.
Devang Patel930143b2009-11-21 02:48:08 +0000910 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-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 Patel9ccfb642009-12-09 18:24:21 +0000916 addType(Arg, DIType(Ty.getNode()));
Devang Patel930143b2009-11-21 02:48:08 +0000917 Buffer.addChild(Arg);
Bill Wendling2f921f82009-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 Patel80ae3492009-08-28 23:24:31 +0000934 if (Element.isNull())
935 continue;
Bill Wendling2f921f82009-05-15 09:23:25 +0000936 DIE *ElemDie = NULL;
937 if (Element.getTag() == dwarf::DW_TAG_subprogram)
Devang Patel525dda02009-12-14 16:18:45 +0000938 ElemDie = createSubprogramDIE(DISubprogram(Element.getNode()));
Bill Wendling2f921f82009-05-15 09:23:25 +0000939 else
Devang Patel9ccfb642009-12-09 18:24:21 +0000940 ElemDie = createMemberDIE(DIDerivedType(Element.getNode()));
Devang Patel930143b2009-11-21 02:48:08 +0000941 Buffer.addChild(ElemDie);
Bill Wendling2f921f82009-05-15 09:23:25 +0000942 }
943
Devang Patel3082c012009-08-27 23:51:51 +0000944 if (CTy.isAppleBlockExtension())
Devang Patel930143b2009-11-21 02:48:08 +0000945 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +0000946
947 unsigned RLang = CTy.getRunTimeLang();
948 if (RLang)
Devang Patel930143b2009-11-21 02:48:08 +0000949 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendling2f921f82009-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 Patel2d9caf92009-11-25 17:36:49 +0000958 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +0000959 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-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 Patel930143b2009-11-21 02:48:08 +0000965 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendling2f921f82009-05-15 09:23:25 +0000966 else {
967 // Add zero size if it is not a forward declaration.
968 if (CTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +0000969 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +0000970 else
Devang Patel930143b2009-11-21 02:48:08 +0000971 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendling2f921f82009-05-15 09:23:25 +0000972 }
973
974 // Add source line info if available.
975 if (!CTy.isForwardDecl())
Devang Patel930143b2009-11-21 02:48:08 +0000976 addSourceLine(&Buffer, &CTy);
Bill Wendling2f921f82009-05-15 09:23:25 +0000977 }
978}
979
Devang Patel930143b2009-11-21 02:48:08 +0000980/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
981void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendling2f921f82009-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 Patel930143b2009-11-21 02:48:08 +0000986 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patelf691df32009-08-14 20:59:16 +0000987 if (L)
Devang Patel930143b2009-11-21 02:48:08 +0000988 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Patel8f046022009-12-04 23:10:24 +0000989 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling2f921f82009-05-15 09:23:25 +0000990
Devang Patel930143b2009-11-21 02:48:08 +0000991 Buffer.addChild(DW_Subrange);
Bill Wendling2f921f82009-05-15 09:23:25 +0000992}
993
Devang Patel930143b2009-11-21 02:48:08 +0000994/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel9ccfb642009-12-09 18:24:21 +0000995void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendling2f921f82009-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 Patel930143b2009-11-21 02:48:08 +0000999 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001000
1001 // Emit derived type.
Devang Patel9ccfb642009-12-09 18:24:21 +00001002 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001003 DIArray Elements = CTy->getTypeArray();
1004
Devang Patel92e8c652009-11-21 00:31:03 +00001005 // Get an anonymous type for index type.
Devang Patel9ccfb642009-12-09 18:24:21 +00001006 DIE *IdxTy = ModuleCU->getIndexTyDie();
Devang Patel92e8c652009-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 Patel930143b2009-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 Patel92e8c652009-11-21 00:31:03 +00001012 dwarf::DW_ATE_signed);
Devang Patel9ccfb642009-12-09 18:24:21 +00001013 ModuleCU->addDie(IdxTy);
1014 ModuleCU->setIndexTyDie(IdxTy);
Devang Patel92e8c652009-11-21 00:31:03 +00001015 }
Bill Wendling2f921f82009-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 Patel930143b2009-11-21 02:48:08 +00001021 constructSubrangeDIE(Buffer, DISubrange(Element.getNode()), IdxTy);
Bill Wendling2f921f82009-05-15 09:23:25 +00001022 }
1023}
1024
Devang Patel930143b2009-11-21 02:48:08 +00001025/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel9ccfb642009-12-09 18:24:21 +00001026DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator *ETy) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001027 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel2d9caf92009-11-25 17:36:49 +00001028 StringRef Name = ETy->getName();
Devang Patel930143b2009-11-21 02:48:08 +00001029 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendling2f921f82009-05-15 09:23:25 +00001030 int64_t Value = ETy->getEnumValue();
Devang Patel930143b2009-11-21 02:48:08 +00001031 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendling2f921f82009-05-15 09:23:25 +00001032 return Enumerator;
1033}
1034
Devang Patel930143b2009-11-21 02:48:08 +00001035/// createGlobalVariableDIE - Create new DIE using GV.
Devang Patel9ccfb642009-12-09 18:24:21 +00001036DIE *DwarfDebug::createGlobalVariableDIE(const DIGlobalVariable &GV) {
Jim Grosbach00e9c612009-11-22 19:20:36 +00001037 // If the global variable was optmized out then no need to create debug info
1038 // entry.
Devang Patelcc11371b2009-11-06 17:58:12 +00001039 if (!GV.getGlobal()) return NULL;
Devang Patel2d9caf92009-11-25 17:36:49 +00001040 if (GV.getDisplayName().empty()) return NULL;
Devang Patel06ce6502009-11-06 01:30:04 +00001041
Bill Wendling2f921f82009-05-15 09:23:25 +00001042 DIE *GVDie = new DIE(dwarf::DW_TAG_variable);
Jim Grosbach042483e2009-11-21 23:12:12 +00001043 addString(GVDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
Devang Patelb2969422009-09-29 18:40:58 +00001044 GV.getDisplayName());
1045
Devang Patel2d9caf92009-11-25 17:36:49 +00001046 StringRef LinkageName = GV.getLinkageName();
1047 if (!LinkageName.empty()) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001048 // Skip special LLVM prefix that is used to inform the asm printer to not
1049 // emit usual symbol prefix before the symbol name. This happens for
1050 // Objective-C symbol names and symbol whose name is replaced using GCC's
1051 // __asm__ attribute.
Devang Patelf281bf82009-07-16 01:01:22 +00001052 if (LinkageName[0] == 1)
Benjamin Kramer4cd30812009-11-25 18:26:09 +00001053 LinkageName = LinkageName.substr(1);
Devang Patel930143b2009-11-21 02:48:08 +00001054 addString(GVDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patelcdfc8582009-07-14 00:55:28 +00001055 LinkageName);
Devang Patelf281bf82009-07-16 01:01:22 +00001056 }
Devang Patel9ccfb642009-12-09 18:24:21 +00001057 addType(GVDie, GV.getType());
Bill Wendling2f921f82009-05-15 09:23:25 +00001058 if (!GV.isLocalToUnit())
Devang Patel930143b2009-11-21 02:48:08 +00001059 addUInt(GVDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1060 addSourceLine(GVDie, &GV);
Devang Patel4144a822009-10-05 23:22:08 +00001061
Bill Wendling2f921f82009-05-15 09:23:25 +00001062 return GVDie;
1063}
1064
Devang Patel930143b2009-11-21 02:48:08 +00001065/// createMemberDIE - Create new member DIE.
Devang Patel9ccfb642009-12-09 18:24:21 +00001066DIE *DwarfDebug::createMemberDIE(const DIDerivedType &DT) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001067 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel2d9caf92009-11-25 17:36:49 +00001068 StringRef Name = DT.getName();
1069 if (!Name.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001070 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel2d9caf92009-11-25 17:36:49 +00001071
Devang Patel9ccfb642009-12-09 18:24:21 +00001072 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendling2f921f82009-05-15 09:23:25 +00001073
Devang Patel930143b2009-11-21 02:48:08 +00001074 addSourceLine(MemberDie, &DT);
Bill Wendling2f921f82009-05-15 09:23:25 +00001075
Devang Patel67f56f02009-11-04 22:06:12 +00001076 DIEBlock *MemLocationDie = new DIEBlock();
Devang Patel930143b2009-11-21 02:48:08 +00001077 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel67f56f02009-11-04 22:06:12 +00001078
Bill Wendling2f921f82009-05-15 09:23:25 +00001079 uint64_t Size = DT.getSizeInBits();
Devang Patelf05d5722009-11-04 23:48:00 +00001080 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling2f921f82009-05-15 09:23:25 +00001081
1082 if (Size != FieldSize) {
1083 // Handle bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001084 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1085 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendling2f921f82009-05-15 09:23:25 +00001086
1087 uint64_t Offset = DT.getOffsetInBits();
1088 uint64_t FieldOffset = Offset;
1089 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1090 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1091 FieldOffset = (HiMark - FieldSize);
1092 Offset -= FieldOffset;
1093
1094 // Maybe we need to work from the other end.
1095 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
Devang Patel930143b2009-11-21 02:48:08 +00001096 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling2f921f82009-05-15 09:23:25 +00001097
Devang Patel67f56f02009-11-04 22:06:12 +00001098 // Here WD_AT_data_member_location points to the anonymous
1099 // field that includes this bit field.
Devang Patel930143b2009-11-21 02:48:08 +00001100 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001101
1102 } else
1103 // This is not a bitfield.
Devang Patel930143b2009-11-21 02:48:08 +00001104 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel67f56f02009-11-04 22:06:12 +00001105
Devang Patel930143b2009-11-21 02:48:08 +00001106 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001107
1108 if (DT.isProtected())
Devang Pateleb57c592009-12-03 19:11:07 +00001109 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001110 dwarf::DW_ACCESS_protected);
1111 else if (DT.isPrivate())
Devang Pateleb57c592009-12-03 19:11:07 +00001112 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendling2f921f82009-05-15 09:23:25 +00001113 dwarf::DW_ACCESS_private);
Devang Pateleb57c592009-12-03 19:11:07 +00001114 else if (DT.getTag() == dwarf::DW_TAG_inheritance)
1115 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1116 dwarf::DW_ACCESS_public);
1117 if (DT.isVirtual())
1118 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1119 dwarf::DW_VIRTUALITY_virtual);
Bill Wendling2f921f82009-05-15 09:23:25 +00001120 return MemberDie;
1121}
1122
Devang Patel525dda02009-12-14 16:18:45 +00001123/// createSubprogramDIE - Create new DIE using SP.
1124DIE *DwarfDebug::createSubprogramDIE(const DISubprogram &SP, bool MakeDecl) {
1125 DIE *SPDie = ModuleCU->getDIE(SP.getNode());
1126 if (SPDie)
1127 return SPDie;
1128
1129 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel2d9caf92009-11-25 17:36:49 +00001130 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendling2f921f82009-05-15 09:23:25 +00001131
Devang Patel2d9caf92009-11-25 17:36:49 +00001132 StringRef LinkageName = SP.getLinkageName();
1133 if (!LinkageName.empty()) {
Jim Grosbach00e9c612009-11-22 19:20:36 +00001134 // Skip special LLVM prefix that is used to inform the asm printer to not
1135 // emit usual symbol prefix before the symbol name. This happens for
1136 // Objective-C symbol names and symbol whose name is replaced using GCC's
1137 // __asm__ attribute.
Devang Patelf281bf82009-07-16 01:01:22 +00001138 if (LinkageName[0] == 1)
Benjamin Kramer4cd30812009-11-25 18:26:09 +00001139 LinkageName = LinkageName.substr(1);
Devang Patel930143b2009-11-21 02:48:08 +00001140 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patelcdfc8582009-07-14 00:55:28 +00001141 LinkageName);
Devang Patelf281bf82009-07-16 01:01:22 +00001142 }
Devang Patel930143b2009-11-21 02:48:08 +00001143 addSourceLine(SPDie, &SP);
Bill Wendling2f921f82009-05-15 09:23:25 +00001144
Bill Wendling2f921f82009-05-15 09:23:25 +00001145 // Add prototyped tag, if C or ObjC.
1146 unsigned Lang = SP.getCompileUnit().getLanguage();
1147 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1148 Lang == dwarf::DW_LANG_ObjC)
Devang Patel930143b2009-11-21 02:48:08 +00001149 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001150
1151 // Add Return Type.
Devang Patel236526d2009-12-03 01:25:38 +00001152 DICompositeType SPTy = SP.getType();
1153 DIArray Args = SPTy.getTypeArray();
Bill Wendling2f921f82009-05-15 09:23:25 +00001154 unsigned SPTag = SPTy.getTag();
Devang Pateleb57c592009-12-03 19:11:07 +00001155
Devang Patel236526d2009-12-03 01:25:38 +00001156 if (Args.isNull() || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patel9ccfb642009-12-09 18:24:21 +00001157 addType(SPDie, SPTy);
Devang Patel236526d2009-12-03 01:25:38 +00001158 else
Devang Patel9ccfb642009-12-09 18:24:21 +00001159 addType(SPDie, DIType(Args.getElement(0).getNode()));
Devang Patel236526d2009-12-03 01:25:38 +00001160
Devang Pateleb57c592009-12-03 19:11:07 +00001161 unsigned VK = SP.getVirtuality();
1162 if (VK) {
1163 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
1164 DIEBlock *Block = new DIEBlock();
1165 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1166 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1167 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
1168 ContainingTypeMap.insert(std::make_pair(SPDie, WeakVH(SP.getContainingType().getNode())));
1169 }
1170
Devang Patel525dda02009-12-14 16:18:45 +00001171 if (MakeDecl || !SP.isDefinition()) {
Devang Patel930143b2009-11-21 02:48:08 +00001172 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendling2f921f82009-05-15 09:23:25 +00001173
1174 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patel236526d2009-12-03 01:25:38 +00001175 // be handled while processing variables.
1176 DICompositeType SPTy = SP.getType();
1177 DIArray Args = SPTy.getTypeArray();
1178 unsigned SPTag = SPTy.getTag();
1179
Bill Wendling2f921f82009-05-15 09:23:25 +00001180 if (SPTag == dwarf::DW_TAG_subroutine_type)
1181 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1182 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patel9ccfb642009-12-09 18:24:21 +00001183 addType(Arg, DIType(Args.getElement(i).getNode()));
Devang Patel930143b2009-11-21 02:48:08 +00001184 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1); // ??
1185 SPDie->addChild(Arg);
Bill Wendling2f921f82009-05-15 09:23:25 +00001186 }
1187 }
1188
Bill Wendling2f921f82009-05-15 09:23:25 +00001189 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patel9ccfb642009-12-09 18:24:21 +00001190 ModuleCU->insertDIE(SP.getNode(), SPDie);
Bill Wendling2f921f82009-05-15 09:23:25 +00001191 return SPDie;
1192}
1193
Devang Patel930143b2009-11-21 02:48:08 +00001194/// findCompileUnit - Get the compile unit for the given descriptor.
Bill Wendling2f921f82009-05-15 09:23:25 +00001195///
Devang Patelb314bd62009-12-11 21:37:07 +00001196CompileUnit *DwarfDebug::findCompileUnit(DICompileUnit Unit) {
Bill Wendling2f921f82009-05-15 09:23:25 +00001197 DenseMap<Value *, CompileUnit *>::const_iterator I =
Devang Patel80ae3492009-08-28 23:24:31 +00001198 CompileUnitMap.find(Unit.getNode());
Devang Patelb314bd62009-12-11 21:37:07 +00001199 if (I == CompileUnitMap.end())
1200 return constructCompileUnit(Unit.getNode());
1201 return I->second;
Bill Wendling2f921f82009-05-15 09:23:25 +00001202}
1203
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001204/// getUpdatedDbgScope - Find or create DbgScope assicated with the instruction.
1205/// Initialize scope and update scope hierarchy.
1206DbgScope *DwarfDebug::getUpdatedDbgScope(MDNode *N, const MachineInstr *MI,
1207 MDNode *InlinedAt) {
1208 assert (N && "Invalid Scope encoding!");
1209 assert (MI && "Missing machine instruction!");
1210 bool GetConcreteScope = (MI && InlinedAt);
1211
1212 DbgScope *NScope = NULL;
1213
1214 if (InlinedAt)
1215 NScope = DbgScopeMap.lookup(InlinedAt);
1216 else
1217 NScope = DbgScopeMap.lookup(N);
1218 assert (NScope && "Unable to find working scope!");
1219
1220 if (NScope->getFirstInsn())
1221 return NScope;
Devang Patel75cc16c2009-10-01 20:31:14 +00001222
1223 DbgScope *Parent = NULL;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001224 if (GetConcreteScope) {
Devang Patel6875c5eb2009-10-14 21:08:09 +00001225 DILocation IL(InlinedAt);
Jim Grosbach042483e2009-11-21 23:12:12 +00001226 Parent = getUpdatedDbgScope(IL.getScope().getNode(), MI,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001227 IL.getOrigLocation().getNode());
1228 assert (Parent && "Unable to find Parent scope!");
1229 NScope->setParent(Parent);
Devang Patel930143b2009-11-21 02:48:08 +00001230 Parent->addScope(NScope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001231 } else if (DIDescriptor(N).isLexicalBlock()) {
1232 DILexicalBlock DB(N);
1233 if (!DB.getContext().isNull()) {
1234 Parent = getUpdatedDbgScope(DB.getContext().getNode(), MI, InlinedAt);
1235 NScope->setParent(Parent);
Devang Patel930143b2009-11-21 02:48:08 +00001236 Parent->addScope(NScope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001237 }
Devang Patel6875c5eb2009-10-14 21:08:09 +00001238 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001239
Devang Patelcfeaa482009-10-27 20:47:17 +00001240 NScope->setFirstInsn(MI);
Devang Patel75cc16c2009-10-01 20:31:14 +00001241
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001242 if (!Parent && !InlinedAt) {
Devang Patel78319c62009-11-11 00:31:36 +00001243 StringRef SPName = DISubprogram(N).getLinkageName();
1244 if (SPName == MF->getFunction()->getName())
1245 CurrentFnDbgScope = NScope;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001246 }
Devang Patel75cc16c2009-10-01 20:31:14 +00001247
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001248 if (GetConcreteScope) {
1249 ConcreteScopes[InlinedAt] = NScope;
1250 getOrCreateAbstractScope(N);
1251 }
1252
Devang Patelcfeaa482009-10-27 20:47:17 +00001253 return NScope;
Devang Patel75cc16c2009-10-01 20:31:14 +00001254}
1255
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001256DbgScope *DwarfDebug::getOrCreateAbstractScope(MDNode *N) {
1257 assert (N && "Invalid Scope encoding!");
1258
1259 DbgScope *AScope = AbstractScopes.lookup(N);
1260 if (AScope)
1261 return AScope;
Jim Grosbach042483e2009-11-21 23:12:12 +00001262
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001263 DbgScope *Parent = NULL;
1264
1265 DIDescriptor Scope(N);
1266 if (Scope.isLexicalBlock()) {
1267 DILexicalBlock DB(N);
1268 DIDescriptor ParentDesc = DB.getContext();
1269 if (!ParentDesc.isNull())
1270 Parent = getOrCreateAbstractScope(ParentDesc.getNode());
1271 }
1272
1273 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1274
1275 if (Parent)
Devang Patel930143b2009-11-21 02:48:08 +00001276 Parent->addScope(AScope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001277 AScope->setAbstractScope();
1278 AbstractScopes[N] = AScope;
1279 if (DIDescriptor(N).isSubprogram())
1280 AbstractScopesList.push_back(AScope);
1281 return AScope;
1282}
Devang Patel75cc16c2009-10-01 20:31:14 +00001283
Jim Grosbach042483e2009-11-21 23:12:12 +00001284/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patel930143b2009-11-21 02:48:08 +00001285/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1286/// If there are global variables in this scope then create and insert
1287/// DIEs for these variables.
1288DIE *DwarfDebug::updateSubprogramScopeDIE(MDNode *SPNode) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001289
Devang Patele064ad42009-11-20 21:37:22 +00001290 DIE *SPDie = ModuleCU->getDIE(SPNode);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001291 assert (SPDie && "Unable to find subprogram DIE!");
Devang Patel525dda02009-12-14 16:18:45 +00001292 DISubprogram SP(SPNode);
1293 if (SP.isDefinition() && !SP.getContext().isCompileUnit()) {
1294 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1295 // Add arguments.
1296 DICompositeType SPTy = SP.getType();
1297 DIArray Args = SPTy.getTypeArray();
1298 unsigned SPTag = SPTy.getTag();
1299 if (SPTag == dwarf::DW_TAG_subroutine_type)
1300 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1301 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1302 addType(Arg, DIType(Args.getElement(i).getNode()));
1303 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1); // ??
1304 SPDie->addChild(Arg);
1305 }
1306 DIE *SPDeclDie = SPDie;
1307 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1308 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
1309 SPDeclDie);
Devang Patel525dda02009-12-14 16:18:45 +00001310 ModuleCU->addDie(SPDie);
1311 }
1312
Devang Patel930143b2009-11-21 02:48:08 +00001313 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001314 DWLabel("func_begin", SubprogramCount));
Devang Patel930143b2009-11-21 02:48:08 +00001315 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001316 DWLabel("func_end", SubprogramCount));
1317 MachineLocation Location(RI->getFrameRegister(*MF));
Devang Patel930143b2009-11-21 02:48:08 +00001318 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Jim Grosbach042483e2009-11-21 23:12:12 +00001319
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001320 if (!DISubprogram(SPNode).isLocalToUnit())
Devang Patel930143b2009-11-21 02:48:08 +00001321 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001322
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001323 return SPDie;
1324}
1325
Jim Grosbach042483e2009-11-21 23:12:12 +00001326/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patel930143b2009-11-21 02:48:08 +00001327/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1328DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001329 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1330 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1331
1332 // Ignore empty scopes.
1333 if (StartID == EndID && StartID != 0)
1334 return NULL;
1335
1336 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1337 if (Scope->isAbstractScope())
1338 return ScopeDIE;
1339
Devang Patel930143b2009-11-21 02:48:08 +00001340 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Jim Grosbach042483e2009-11-21 23:12:12 +00001341 StartID ?
1342 DWLabel("label", StartID)
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001343 : DWLabel("func_begin", SubprogramCount));
Devang Patel930143b2009-11-21 02:48:08 +00001344 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Jim Grosbach042483e2009-11-21 23:12:12 +00001345 EndID ?
1346 DWLabel("label", EndID)
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001347 : DWLabel("func_end", SubprogramCount));
1348
1349
1350
1351 return ScopeDIE;
1352}
1353
Devang Patel930143b2009-11-21 02:48:08 +00001354/// constructInlinedScopeDIE - This scope represents inlined body of
1355/// a function. Construct DIE to represent this concrete inlined copy
1356/// of the function.
1357DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001358 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1359 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1360 assert (StartID && "Invalid starting label for an inlined scope!");
1361 assert (EndID && "Invalid end label for an inlined scope!");
1362 // Ignore empty scopes.
1363 if (StartID == EndID && StartID != 0)
1364 return NULL;
1365
1366 DIScope DS(Scope->getScopeNode());
1367 if (DS.isNull())
1368 return NULL;
1369 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1370
1371 DISubprogram InlinedSP = getDISubprogram(DS.getNode());
Devang Patele064ad42009-11-20 21:37:22 +00001372 DIE *OriginDIE = ModuleCU->getDIE(InlinedSP.getNode());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001373 assert (OriginDIE && "Unable to find Origin DIE!");
Devang Patel930143b2009-11-21 02:48:08 +00001374 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001375 dwarf::DW_FORM_ref4, OriginDIE);
1376
Devang Patel930143b2009-11-21 02:48:08 +00001377 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001378 DWLabel("label", StartID));
Devang Patel930143b2009-11-21 02:48:08 +00001379 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001380 DWLabel("label", EndID));
1381
1382 InlinedSubprogramDIEs.insert(OriginDIE);
1383
1384 // Track the start label for this inlined function.
1385 ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
1386 I = InlineInfo.find(InlinedSP.getNode());
1387
1388 if (I == InlineInfo.end()) {
Jim Grosbach00e9c612009-11-22 19:20:36 +00001389 InlineInfo[InlinedSP.getNode()].push_back(std::make_pair(StartID,
1390 ScopeDIE));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001391 InlinedSPNodes.push_back(InlinedSP.getNode());
1392 } else
1393 I->second.push_back(std::make_pair(StartID, ScopeDIE));
1394
1395 StringPool.insert(InlinedSP.getName());
Devang Patele6433fa2010-01-04 23:04:36 +00001396 StringRef LinkageName = InlinedSP.getLinkageName();
1397 if (!LinkageName.empty()) {
1398 // Skip special LLVM prefix that is used to inform the asm printer to not
1399 // emit usual symbol prefix before the symbol name. This happens for
1400 // Objective-C symbol names and symbol whose name is replaced using GCC's
1401 // __asm__ attribute.
1402 if (LinkageName[0] == 1)
1403 LinkageName = LinkageName.substr(1);
1404 }
1405 StringPool.insert(LinkageName);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001406 DILocation DL(Scope->getInlinedAt());
Devang Patel930143b2009-11-21 02:48:08 +00001407 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, ModuleCU->getID());
1408 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001409
1410 return ScopeDIE;
1411}
1412
Devang Patel930143b2009-11-21 02:48:08 +00001413
1414/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel9ccfb642009-12-09 18:24:21 +00001415DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001416 // Get the descriptor.
1417 const DIVariable &VD = DV->getVariable();
Devang Patel2d9caf92009-11-25 17:36:49 +00001418 StringRef Name = VD.getName();
1419 if (Name.empty())
Devang Patel97f99fa2009-11-13 02:25:26 +00001420 return NULL;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001421
1422 // Translate tag to proper Dwarf tag. The result variable is dropped for
1423 // now.
1424 unsigned Tag;
1425 switch (VD.getTag()) {
1426 case dwarf::DW_TAG_return_variable:
1427 return NULL;
1428 case dwarf::DW_TAG_arg_variable:
1429 Tag = dwarf::DW_TAG_formal_parameter;
1430 break;
1431 case dwarf::DW_TAG_auto_variable: // fall thru
1432 default:
1433 Tag = dwarf::DW_TAG_variable;
1434 break;
1435 }
1436
1437 // Define variable debug information entry.
1438 DIE *VariableDie = new DIE(Tag);
1439
1440
1441 DIE *AbsDIE = NULL;
1442 if (DbgVariable *AV = DV->getAbstractVariable())
1443 AbsDIE = AV->getDIE();
Jim Grosbach042483e2009-11-21 23:12:12 +00001444
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001445 if (AbsDIE) {
1446 DIScope DS(Scope->getScopeNode());
1447 DISubprogram InlinedSP = getDISubprogram(DS.getNode());
Devang Patele064ad42009-11-20 21:37:22 +00001448 DIE *OriginSPDIE = ModuleCU->getDIE(InlinedSP.getNode());
Daniel Dunbar75b4d352009-11-11 03:09:50 +00001449 (void) OriginSPDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001450 assert (OriginSPDIE && "Unable to find Origin DIE for the SP!");
1451 DIE *AbsDIE = DV->getAbstractVariable()->getDIE();
1452 assert (AbsDIE && "Unable to find Origin DIE for the Variable!");
Devang Patel930143b2009-11-21 02:48:08 +00001453 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001454 dwarf::DW_FORM_ref4, AbsDIE);
1455 }
1456 else {
Devang Patel930143b2009-11-21 02:48:08 +00001457 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
1458 addSourceLine(VariableDie, &VD);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001459
1460 // Add variable type.
Jim Grosbach042483e2009-11-21 23:12:12 +00001461 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001462 // addresses instead.
1463 if (VD.isBlockByrefVariable())
Devang Patel9ccfb642009-12-09 18:24:21 +00001464 addType(VariableDie, getBlockByrefType(VD.getType(), Name));
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001465 else
Devang Patel9ccfb642009-12-09 18:24:21 +00001466 addType(VariableDie, VD.getType());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001467 }
1468
1469 // Add variable address.
1470 if (!Scope->isAbstractScope()) {
1471 MachineLocation Location;
Jim Grosbachbf6d3582009-11-22 20:14:00 +00001472 unsigned FrameReg;
1473 int Offset = RI->getFrameIndexReference(*MF, DV->getFrameIndex(), FrameReg);
1474 Location.set(FrameReg, Offset);
Jim Grosbach042483e2009-11-21 23:12:12 +00001475
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001476 if (VD.hasComplexAddress())
Devang Patel930143b2009-11-21 02:48:08 +00001477 addComplexAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001478 else if (VD.isBlockByrefVariable())
Devang Patel930143b2009-11-21 02:48:08 +00001479 addBlockByrefAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001480 else
Devang Patel930143b2009-11-21 02:48:08 +00001481 addAddress(VariableDie, dwarf::DW_AT_location, Location);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001482 }
1483 DV->setDIE(VariableDie);
1484 return VariableDie;
1485
1486}
Devang Patel930143b2009-11-21 02:48:08 +00001487
Devang Patel04d2f2d2009-11-24 01:14:22 +00001488void DwarfDebug::addPubTypes(DISubprogram SP) {
1489 DICompositeType SPTy = SP.getType();
1490 unsigned SPTag = SPTy.getTag();
1491 if (SPTag != dwarf::DW_TAG_subroutine_type)
1492 return;
1493
1494 DIArray Args = SPTy.getTypeArray();
1495 if (Args.isNull())
1496 return;
1497
1498 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
1499 DIType ATy(Args.getElement(i).getNode());
1500 if (ATy.isNull())
1501 continue;
1502 DICompositeType CATy = getDICompositeType(ATy);
Devang Patel2d9caf92009-11-25 17:36:49 +00001503 if (!CATy.isNull() && !CATy.getName().empty()) {
Devang Patel04d2f2d2009-11-24 01:14:22 +00001504 if (DIEEntry *Entry = ModuleCU->getDIEEntry(CATy.getNode()))
1505 ModuleCU->addGlobalType(CATy.getName(), Entry->getEntry());
1506 }
1507 }
1508}
1509
Devang Patel930143b2009-11-21 02:48:08 +00001510/// constructScopeDIE - Construct a DIE for this scope.
1511DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001512 if (!Scope)
1513 return NULL;
1514 DIScope DS(Scope->getScopeNode());
1515 if (DS.isNull())
1516 return NULL;
1517
1518 DIE *ScopeDIE = NULL;
1519 if (Scope->getInlinedAt())
Devang Patel930143b2009-11-21 02:48:08 +00001520 ScopeDIE = constructInlinedScopeDIE(Scope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001521 else if (DS.isSubprogram()) {
1522 if (Scope->isAbstractScope())
Devang Patele064ad42009-11-20 21:37:22 +00001523 ScopeDIE = ModuleCU->getDIE(DS.getNode());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001524 else
Devang Patel930143b2009-11-21 02:48:08 +00001525 ScopeDIE = updateSubprogramScopeDIE(DS.getNode());
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001526 }
1527 else {
Devang Patel930143b2009-11-21 02:48:08 +00001528 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001529 if (!ScopeDIE) return NULL;
1530 }
1531
1532 // Add variables to scope.
1533 SmallVector<DbgVariable *, 8> &Variables = Scope->getVariables();
1534 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patel9ccfb642009-12-09 18:24:21 +00001535 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach042483e2009-11-21 23:12:12 +00001536 if (VariableDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001537 ScopeDIE->addChild(VariableDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001538 }
1539
1540 // Add nested scopes.
1541 SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
1542 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1543 // Define the Scope debug information entry.
Devang Patel930143b2009-11-21 02:48:08 +00001544 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach042483e2009-11-21 23:12:12 +00001545 if (NestedDIE)
Devang Patel930143b2009-11-21 02:48:08 +00001546 ScopeDIE->addChild(NestedDIE);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001547 }
Devang Patel04d2f2d2009-11-24 01:14:22 +00001548
1549 if (DS.isSubprogram())
1550 addPubTypes(DISubprogram(DS.getNode()));
1551
1552 return ScopeDIE;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001553}
1554
Bill Wendling2b128d72009-05-20 23:19:06 +00001555/// GetOrCreateSourceID - Look up the source id with the given directory and
1556/// source file names. If none currently exists, create a new id and insert it
1557/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1558/// maps as well.
Devang Patel2d9caf92009-11-25 17:36:49 +00001559unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName) {
Bill Wendling2b128d72009-05-20 23:19:06 +00001560 unsigned DId;
1561 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1562 if (DI != DirectoryIdMap.end()) {
1563 DId = DI->getValue();
1564 } else {
1565 DId = DirectoryNames.size() + 1;
1566 DirectoryIdMap[DirName] = DId;
1567 DirectoryNames.push_back(DirName);
1568 }
1569
1570 unsigned FId;
1571 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1572 if (FI != SourceFileIdMap.end()) {
1573 FId = FI->getValue();
1574 } else {
1575 FId = SourceFileNames.size() + 1;
1576 SourceFileIdMap[FileName] = FId;
1577 SourceFileNames.push_back(FileName);
1578 }
1579
1580 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1581 SourceIdMap.find(std::make_pair(DId, FId));
1582 if (SI != SourceIdMap.end())
1583 return SI->second;
1584
1585 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1586 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1587 SourceIds.push_back(std::make_pair(DId, FId));
1588
1589 return SrcId;
1590}
1591
Devang Patel1f4690c2009-12-15 19:16:48 +00001592/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1593DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
1594 DIE *NDie = ModuleCU->getDIE(NS.getNode());
1595 if (NDie)
1596 return NDie;
1597 NDie = new DIE(dwarf::DW_TAG_namespace);
1598 ModuleCU->insertDIE(NS.getNode(), NDie);
1599 if (!NS.getName().empty())
1600 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
1601 addSourceLine(NDie, &NS);
1602 addToContextOwner(NDie, NS.getContext());
1603 return NDie;
1604}
1605
Devang Patelb314bd62009-12-11 21:37:07 +00001606CompileUnit *DwarfDebug::constructCompileUnit(MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001607 DICompileUnit DIUnit(N);
Devang Patel2d9caf92009-11-25 17:36:49 +00001608 StringRef FN = DIUnit.getFilename();
1609 StringRef Dir = DIUnit.getDirectory();
Devang Patelb2969422009-09-29 18:40:58 +00001610 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendling2b128d72009-05-20 23:19:06 +00001611
1612 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patel930143b2009-11-21 02:48:08 +00001613 addSectionOffset(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Bill Wendling2b128d72009-05-20 23:19:06 +00001614 DWLabel("section_line", 0), DWLabel("section_line", 0),
1615 false);
Devang Patel930143b2009-11-21 02:48:08 +00001616 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patelb2969422009-09-29 18:40:58 +00001617 DIUnit.getProducer());
Devang Patel930143b2009-11-21 02:48:08 +00001618 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendling2b128d72009-05-20 23:19:06 +00001619 DIUnit.getLanguage());
Devang Patel930143b2009-11-21 02:48:08 +00001620 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Bill Wendling2b128d72009-05-20 23:19:06 +00001621
Devang Patel2d9caf92009-11-25 17:36:49 +00001622 if (!Dir.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001623 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendling2b128d72009-05-20 23:19:06 +00001624 if (DIUnit.isOptimized())
Devang Patel930143b2009-11-21 02:48:08 +00001625 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendling2b128d72009-05-20 23:19:06 +00001626
Devang Patel2d9caf92009-11-25 17:36:49 +00001627 StringRef Flags = DIUnit.getFlags();
1628 if (!Flags.empty())
Devang Patel930143b2009-11-21 02:48:08 +00001629 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendling2b128d72009-05-20 23:19:06 +00001630
1631 unsigned RVer = DIUnit.getRunTimeVersion();
1632 if (RVer)
Devang Patel930143b2009-11-21 02:48:08 +00001633 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendling2b128d72009-05-20 23:19:06 +00001634 dwarf::DW_FORM_data1, RVer);
1635
1636 CompileUnit *Unit = new CompileUnit(ID, Die);
Devang Patel40d78412009-06-29 20:45:18 +00001637 if (!ModuleCU && DIUnit.isMain()) {
Devang Patel86353452009-06-29 20:38:13 +00001638 // Use first compile unit marked as isMain as the compile unit
1639 // for this module.
Devang Patel40d78412009-06-29 20:45:18 +00001640 ModuleCU = Unit;
Devang Patel86353452009-06-29 20:38:13 +00001641 }
Bill Wendling2b128d72009-05-20 23:19:06 +00001642
Devang Patel80ae3492009-08-28 23:24:31 +00001643 CompileUnitMap[DIUnit.getNode()] = Unit;
Bill Wendling2b128d72009-05-20 23:19:06 +00001644 CompileUnits.push_back(Unit);
Devang Patelb314bd62009-12-11 21:37:07 +00001645 return Unit;
Bill Wendling2b128d72009-05-20 23:19:06 +00001646}
1647
Devang Patel930143b2009-11-21 02:48:08 +00001648void DwarfDebug::constructGlobalVariableDIE(MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001649 DIGlobalVariable DI_GV(N);
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00001650
Devang Patelf5d53602009-09-04 23:59:07 +00001651 // If debug information is malformed then ignore it.
1652 if (DI_GV.Verify() == false)
1653 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001654
1655 // Check for pre-existence.
Devang Patele064ad42009-11-20 21:37:22 +00001656 if (ModuleCU->getDIE(DI_GV.getNode()))
Devang Patel0751a282009-06-26 01:49:18 +00001657 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001658
Devang Patel9ccfb642009-12-09 18:24:21 +00001659 DIE *VariableDie = createGlobalVariableDIE(DI_GV);
Devang Patel2eec32d2009-12-10 23:25:41 +00001660 if (!VariableDie)
1661 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001662
Bill Wendling2b128d72009-05-20 23:19:06 +00001663 // Add to map.
Devang Patele064ad42009-11-20 21:37:22 +00001664 ModuleCU->insertDIE(N, VariableDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00001665
1666 // Add to context owner.
Devang Patel1f4690c2009-12-15 19:16:48 +00001667 if (DI_GV.isDefinition()
1668 && !DI_GV.getContext().isCompileUnit()) {
1669 // Create specification DIE.
1670 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1671 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1672 dwarf::DW_FORM_ref4, VariableDie);
1673 DIEBlock *Block = new DIEBlock();
1674 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1675 addObjectLabel(Block, 0, dwarf::DW_FORM_udata,
1676 Asm->Mang->getMangledName(DI_GV.getGlobal()));
1677 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1678 ModuleCU->addDie(VariableSpecDIE);
1679 } else {
1680 DIEBlock *Block = new DIEBlock();
1681 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1682 addObjectLabel(Block, 0, dwarf::DW_FORM_udata,
1683 Asm->Mang->getMangledName(DI_GV.getGlobal()));
1684 addBlock(VariableDie, dwarf::DW_AT_location, 0, Block);
1685 }
Devang Patel2b75ed22009-12-10 19:14:49 +00001686 addToContextOwner(VariableDie, DI_GV.getContext());
1687
Bill Wendling2b128d72009-05-20 23:19:06 +00001688 // Expose as global. FIXME - need to check external flag.
Devang Patel930143b2009-11-21 02:48:08 +00001689 ModuleCU->addGlobal(DI_GV.getName(), VariableDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00001690
1691 DIType GTy = DI_GV.getType();
Devang Patel2d9caf92009-11-25 17:36:49 +00001692 if (GTy.isCompositeType() && !GTy.getName().empty()) {
Devang Patel04d2f2d2009-11-24 01:14:22 +00001693 DIEEntry *Entry = ModuleCU->getDIEEntry(GTy.getNode());
1694 assert (Entry && "Missing global type!");
1695 ModuleCU->addGlobalType(GTy.getName(), Entry->getEntry());
1696 }
Devang Patel0751a282009-06-26 01:49:18 +00001697 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001698}
1699
Devang Patel930143b2009-11-21 02:48:08 +00001700void DwarfDebug::constructSubprogramDIE(MDNode *N) {
Devang Patel80ae3492009-08-28 23:24:31 +00001701 DISubprogram SP(N);
Bill Wendling2b128d72009-05-20 23:19:06 +00001702
1703 // Check for pre-existence.
Devang Patele064ad42009-11-20 21:37:22 +00001704 if (ModuleCU->getDIE(N))
Devang Patel0751a282009-06-26 01:49:18 +00001705 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001706
1707 if (!SP.isDefinition())
1708 // This is a method declaration which will be handled while constructing
1709 // class type.
Devang Patel0751a282009-06-26 01:49:18 +00001710 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001711
Devang Patel9ccfb642009-12-09 18:24:21 +00001712 DIE *SubprogramDie = createSubprogramDIE(SP);
Bill Wendling2b128d72009-05-20 23:19:06 +00001713
1714 // Add to map.
Devang Patele064ad42009-11-20 21:37:22 +00001715 ModuleCU->insertDIE(N, SubprogramDie);
Bill Wendling2b128d72009-05-20 23:19:06 +00001716
1717 // Add to context owner.
Devang Patel1f4690c2009-12-15 19:16:48 +00001718 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel512001a2009-12-08 23:21:45 +00001719
Bill Wendling2b128d72009-05-20 23:19:06 +00001720 // Expose as global.
Devang Patel930143b2009-11-21 02:48:08 +00001721 ModuleCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patel04d2f2d2009-11-24 01:14:22 +00001722
Devang Patel0751a282009-06-26 01:49:18 +00001723 return;
Bill Wendling2b128d72009-05-20 23:19:06 +00001724}
1725
Devang Patel930143b2009-11-21 02:48:08 +00001726/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbarbe22ec42009-09-19 20:40:14 +00001727/// content. Create global DIEs and emit initial debug info sections.
1728/// This is inovked by the target AsmPrinter.
Devang Patel930143b2009-11-21 02:48:08 +00001729void DwarfDebug::beginModule(Module *M, MachineModuleInfo *mmi) {
Devang Patel0c044ec2009-06-25 22:36:02 +00001730 this->M = M;
1731
Bill Wendling2b128d72009-05-20 23:19:06 +00001732 if (TimePassesIsEnabled)
1733 DebugTimer->startTimer();
1734
Devang Pateld41f1192009-11-11 19:55:08 +00001735 if (!MAI->doesSupportDebugInformation())
1736 return;
1737
Devang Patel63524442009-07-30 18:56:46 +00001738 DebugInfoFinder DbgFinder;
1739 DbgFinder.processModule(*M);
Devang Patel0751a282009-06-26 01:49:18 +00001740
Bill Wendling2b128d72009-05-20 23:19:06 +00001741 // Create all the compile unit DIEs.
Devang Patel63524442009-07-30 18:56:46 +00001742 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1743 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00001744 constructCompileUnit(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00001745
1746 if (CompileUnits.empty()) {
1747 if (TimePassesIsEnabled)
1748 DebugTimer->stopTimer();
1749
1750 return;
1751 }
1752
Devang Patel86353452009-06-29 20:38:13 +00001753 // If main compile unit for this module is not seen than randomly
1754 // select first compile unit.
Devang Patel40d78412009-06-29 20:45:18 +00001755 if (!ModuleCU)
1756 ModuleCU = CompileUnits[0];
Devang Patel86353452009-06-29 20:38:13 +00001757
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001758 // Create DIEs for each subprogram.
Devang Patel63524442009-07-30 18:56:46 +00001759 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
1760 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00001761 constructSubprogramDIE(*I);
Devang Patel0751a282009-06-26 01:49:18 +00001762
Devang Patel2b75ed22009-12-10 19:14:49 +00001763 // Create DIEs for each global variable.
1764 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
1765 E = DbgFinder.global_variable_end(); I != E; ++I)
1766 constructGlobalVariableDIE(*I);
1767
Bill Wendling2b128d72009-05-20 23:19:06 +00001768 MMI = mmi;
1769 shouldEmit = true;
1770 MMI->setDebugInfoAvailability(true);
1771
1772 // Prime section data.
Chris Lattner5e693ed2009-07-28 03:13:23 +00001773 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +00001774
1775 // Print out .file directives to specify files for .loc directives. These are
1776 // printed out early so that they precede any .loc directives.
Chris Lattnere9a75a62009-08-22 21:43:10 +00001777 if (MAI->hasDotLocAndDotFile()) {
Bill Wendling2b128d72009-05-20 23:19:06 +00001778 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
1779 // Remember source id starts at 1.
1780 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
1781 sys::Path FullPath(getSourceDirectoryName(Id.first));
1782 bool AppendOk =
1783 FullPath.appendComponent(getSourceFileName(Id.second));
1784 assert(AppendOk && "Could not append filename to directory!");
1785 AppendOk = false;
Chris Lattnerc521f542009-08-23 22:45:37 +00001786 Asm->EmitFile(i, FullPath.str());
Bill Wendling2b128d72009-05-20 23:19:06 +00001787 Asm->EOL();
1788 }
1789 }
1790
1791 // Emit initial sections
Devang Patel930143b2009-11-21 02:48:08 +00001792 emitInitial();
Bill Wendling2b128d72009-05-20 23:19:06 +00001793
1794 if (TimePassesIsEnabled)
1795 DebugTimer->stopTimer();
1796}
1797
Devang Patel930143b2009-11-21 02:48:08 +00001798/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendling2b128d72009-05-20 23:19:06 +00001799///
Devang Patel930143b2009-11-21 02:48:08 +00001800void DwarfDebug::endModule() {
Devang Pateld859d862009-10-06 00:03:14 +00001801 if (!ModuleCU)
Bill Wendling2b128d72009-05-20 23:19:06 +00001802 return;
1803
1804 if (TimePassesIsEnabled)
1805 DebugTimer->startTimer();
1806
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001807 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1808 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
1809 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
1810 DIE *ISP = *AI;
Devang Patel930143b2009-11-21 02:48:08 +00001811 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001812 }
1813
Devang Patel236526d2009-12-03 01:25:38 +00001814 // Insert top level DIEs.
1815 for (SmallVector<DIE *, 4>::iterator TI = TopLevelDIEsVector.begin(),
1816 TE = TopLevelDIEsVector.end(); TI != TE; ++TI)
1817 ModuleCU->getCUDie()->addChild(*TI);
1818
Devang Pateleb57c592009-12-03 19:11:07 +00001819 for (DenseMap<DIE *, WeakVH>::iterator CI = ContainingTypeMap.begin(),
1820 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
1821 DIE *SPDie = CI->first;
1822 MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
1823 if (!N) continue;
1824 DIE *NDie = ModuleCU->getDIE(N);
1825 if (!NDie) continue;
1826 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
1827 addDIEEntry(NDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
1828 }
1829
Bill Wendling2b128d72009-05-20 23:19:06 +00001830 // Standard sections final addresses.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001831 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Bill Wendling2b128d72009-05-20 23:19:06 +00001832 EmitLabel("text_end", 0);
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001833 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Bill Wendling2b128d72009-05-20 23:19:06 +00001834 EmitLabel("data_end", 0);
1835
1836 // End text sections.
1837 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00001838 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Bill Wendling2b128d72009-05-20 23:19:06 +00001839 EmitLabel("section_end", i);
1840 }
1841
1842 // Emit common frame information.
Devang Patel930143b2009-11-21 02:48:08 +00001843 emitCommonDebugFrame();
Bill Wendling2b128d72009-05-20 23:19:06 +00001844
1845 // Emit function debug frame information
1846 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
1847 E = DebugFrames.end(); I != E; ++I)
Devang Patel930143b2009-11-21 02:48:08 +00001848 emitFunctionDebugFrame(*I);
Bill Wendling2b128d72009-05-20 23:19:06 +00001849
1850 // Compute DIE offsets and sizes.
Devang Patel930143b2009-11-21 02:48:08 +00001851 computeSizeAndOffsets();
Bill Wendling2b128d72009-05-20 23:19:06 +00001852
1853 // Emit all the DIEs into a debug info section
Devang Patel930143b2009-11-21 02:48:08 +00001854 emitDebugInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001855
1856 // Corresponding abbreviations into a abbrev section.
Devang Patel930143b2009-11-21 02:48:08 +00001857 emitAbbreviations();
Bill Wendling2b128d72009-05-20 23:19:06 +00001858
1859 // Emit source line correspondence into a debug line section.
Devang Patel930143b2009-11-21 02:48:08 +00001860 emitDebugLines();
Bill Wendling2b128d72009-05-20 23:19:06 +00001861
1862 // Emit info into a debug pubnames section.
Devang Patel930143b2009-11-21 02:48:08 +00001863 emitDebugPubNames();
Bill Wendling2b128d72009-05-20 23:19:06 +00001864
Devang Patel04d2f2d2009-11-24 01:14:22 +00001865 // Emit info into a debug pubtypes section.
1866 emitDebugPubTypes();
1867
Bill Wendling2b128d72009-05-20 23:19:06 +00001868 // Emit info into a debug str section.
Devang Patel930143b2009-11-21 02:48:08 +00001869 emitDebugStr();
Bill Wendling2b128d72009-05-20 23:19:06 +00001870
1871 // Emit info into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +00001872 emitDebugLoc();
Bill Wendling2b128d72009-05-20 23:19:06 +00001873
1874 // Emit info into a debug aranges section.
1875 EmitDebugARanges();
1876
1877 // Emit info into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +00001878 emitDebugRanges();
Bill Wendling2b128d72009-05-20 23:19:06 +00001879
1880 // Emit info into a debug macinfo section.
Devang Patel930143b2009-11-21 02:48:08 +00001881 emitDebugMacInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001882
1883 // Emit inline info.
Devang Patel930143b2009-11-21 02:48:08 +00001884 emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +00001885
1886 if (TimePassesIsEnabled)
1887 DebugTimer->stopTimer();
1888}
1889
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001890/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbach00e9c612009-11-22 19:20:36 +00001891DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
1892 unsigned FrameIdx,
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001893 DILocation &ScopeLoc) {
1894
1895 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var.getNode());
1896 if (AbsDbgVariable)
1897 return AbsDbgVariable;
1898
1899 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope().getNode());
1900 if (!Scope)
1901 return NULL;
1902
1903 AbsDbgVariable = new DbgVariable(Var, FrameIdx);
Devang Patel930143b2009-11-21 02:48:08 +00001904 Scope->addVariable(AbsDbgVariable);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001905 AbstractVariables[Var.getNode()] = AbsDbgVariable;
1906 return AbsDbgVariable;
1907}
1908
Devang Patel930143b2009-11-21 02:48:08 +00001909/// collectVariableInfo - Populate DbgScope entries with variables' info.
1910void DwarfDebug::collectVariableInfo() {
Devang Pateldf45c7f2009-10-09 22:42:28 +00001911 if (!MMI) return;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001912
Devang Patel475d32a2009-10-06 01:26:37 +00001913 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1914 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1915 VE = VMap.end(); VI != VE; ++VI) {
Devang Pateldf45c7f2009-10-09 22:42:28 +00001916 MetadataBase *MB = VI->first;
1917 MDNode *Var = dyn_cast_or_null<MDNode>(MB);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001918 if (!Var) continue;
Devang Patel20b2a772009-10-08 18:48:03 +00001919 DIVariable DV (Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001920 std::pair< unsigned, MDNode *> VP = VI->second;
1921 DILocation ScopeLoc(VP.second);
1922
1923 DbgScope *Scope =
1924 ConcreteScopes.lookup(ScopeLoc.getOrigLocation().getNode());
1925 if (!Scope)
Jim Grosbach042483e2009-11-21 23:12:12 +00001926 Scope = DbgScopeMap.lookup(ScopeLoc.getScope().getNode());
Devang Patelcdb7d442009-11-10 23:20:04 +00001927 // If variable scope is not found then skip this variable.
1928 if (!Scope)
1929 continue;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001930
1931 DbgVariable *RegVar = new DbgVariable(DV, VP.first);
Devang Patel930143b2009-11-21 02:48:08 +00001932 Scope->addVariable(RegVar);
Jim Grosbach00e9c612009-11-22 19:20:36 +00001933 if (DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.first,
1934 ScopeLoc))
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001935 RegVar->setAbstractVariable(AbsDbgVariable);
Devang Patel475d32a2009-10-06 01:26:37 +00001936 }
1937}
1938
Devang Patel930143b2009-11-21 02:48:08 +00001939/// beginScope - Process beginning of a scope starting at Label.
1940void DwarfDebug::beginScope(const MachineInstr *MI, unsigned Label) {
Devang Patel8db360d2009-10-06 01:50:42 +00001941 InsnToDbgScopeMapTy::iterator I = DbgScopeBeginMap.find(MI);
1942 if (I == DbgScopeBeginMap.end())
1943 return;
Dan Gohman3650f4e2009-11-23 21:30:55 +00001944 ScopeVector &SD = I->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001945 for (ScopeVector::iterator SDI = SD.begin(), SDE = SD.end();
Jim Grosbach042483e2009-11-21 23:12:12 +00001946 SDI != SDE; ++SDI)
Devang Patel8db360d2009-10-06 01:50:42 +00001947 (*SDI)->setStartLabelID(Label);
1948}
1949
Devang Patel930143b2009-11-21 02:48:08 +00001950/// endScope - Process end of a scope.
1951void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel8db360d2009-10-06 01:50:42 +00001952 InsnToDbgScopeMapTy::iterator I = DbgScopeEndMap.find(MI);
Devang Patel7d838bb2009-10-06 03:15:38 +00001953 if (I == DbgScopeEndMap.end())
Devang Patel8db360d2009-10-06 01:50:42 +00001954 return;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001955
1956 unsigned Label = MMI->NextLabelID();
1957 Asm->printLabel(Label);
Dan Gohman3a6164e2009-12-05 01:42:34 +00001958 O << '\n';
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001959
Devang Patel8db360d2009-10-06 01:50:42 +00001960 SmallVector<DbgScope *, 2> &SD = I->second;
1961 for (SmallVector<DbgScope *, 2>::iterator SDI = SD.begin(), SDE = SD.end();
Jim Grosbach042483e2009-11-21 23:12:12 +00001962 SDI != SDE; ++SDI)
Devang Patel8db360d2009-10-06 01:50:42 +00001963 (*SDI)->setEndLabelID(Label);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001964 return;
1965}
1966
1967/// createDbgScope - Create DbgScope for the scope.
1968void DwarfDebug::createDbgScope(MDNode *Scope, MDNode *InlinedAt) {
1969
1970 if (!InlinedAt) {
1971 DbgScope *WScope = DbgScopeMap.lookup(Scope);
1972 if (WScope)
1973 return;
1974 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
1975 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Jim Grosbach042483e2009-11-21 23:12:12 +00001976 if (DIDescriptor(Scope).isLexicalBlock())
Devang Patel4450f262009-11-11 00:18:40 +00001977 createDbgScope(DILexicalBlock(Scope).getContext().getNode(), NULL);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00001978 return;
1979 }
1980
1981 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
1982 if (WScope)
1983 return;
1984
1985 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
1986 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
1987 DILocation DL(InlinedAt);
1988 createDbgScope(DL.getScope().getNode(), DL.getOrigLocation().getNode());
Devang Patel8db360d2009-10-06 01:50:42 +00001989}
1990
Devang Patel930143b2009-11-21 02:48:08 +00001991/// extractScopeInformation - Scan machine instructions in this function
Devang Patel75cc16c2009-10-01 20:31:14 +00001992/// and collect DbgScopes. Return true, if atleast one scope was found.
Devang Patel930143b2009-11-21 02:48:08 +00001993bool DwarfDebug::extractScopeInformation(MachineFunction *MF) {
Devang Patel75cc16c2009-10-01 20:31:14 +00001994 // If scope information was extracted using .dbg intrinsics then there is not
1995 // any need to extract these information by scanning each instruction.
1996 if (!DbgScopeMap.empty())
1997 return false;
1998
Devang Patel530a0752010-01-04 20:44:00 +00001999 DenseMap<const MachineInstr *, unsigned> MIIndexMap;
2000 unsigned MIIndex = 0;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002001 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patel75cc16c2009-10-01 20:31:14 +00002002 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2003 I != E; ++I) {
2004 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2005 II != IE; ++II) {
2006 const MachineInstr *MInsn = II;
Devang Patel530a0752010-01-04 20:44:00 +00002007 MIIndexMap[MInsn] = MIIndex++;
Devang Patel75cc16c2009-10-01 20:31:14 +00002008 DebugLoc DL = MInsn->getDebugLoc();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002009 if (DL.isUnknown()) continue;
Devang Patel75cc16c2009-10-01 20:31:14 +00002010 DebugLocTuple DLT = MF->getDebugLocTuple(DL);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002011 if (!DLT.Scope) continue;
Devang Patel75cc16c2009-10-01 20:31:14 +00002012 // There is no need to create another DIE for compile unit. For all
Jim Grosbach042483e2009-11-21 23:12:12 +00002013 // other scopes, create one DbgScope now. This will be translated
Devang Patel75cc16c2009-10-01 20:31:14 +00002014 // into a scope DIE at the end.
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002015 if (DIDescriptor(DLT.Scope).isCompileUnit()) continue;
2016 createDbgScope(DLT.Scope, DLT.InlinedAtLoc);
2017 }
2018 }
2019
2020
2021 // Build scope hierarchy using working set of scopes.
2022 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2023 I != E; ++I) {
2024 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2025 II != IE; ++II) {
2026 const MachineInstr *MInsn = II;
2027 DebugLoc DL = MInsn->getDebugLoc();
2028 if (DL.isUnknown()) continue;
2029 DebugLocTuple DLT = MF->getDebugLocTuple(DL);
2030 if (!DLT.Scope) continue;
2031 // There is no need to create another DIE for compile unit. For all
Jim Grosbach042483e2009-11-21 23:12:12 +00002032 // other scopes, create one DbgScope now. This will be translated
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002033 // into a scope DIE at the end.
2034 if (DIDescriptor(DLT.Scope).isCompileUnit()) continue;
2035 DbgScope *Scope = getUpdatedDbgScope(DLT.Scope, MInsn, DLT.InlinedAtLoc);
2036 Scope->setLastInsn(MInsn);
Devang Patel75cc16c2009-10-01 20:31:14 +00002037 }
2038 }
2039
Devang Patel530a0752010-01-04 20:44:00 +00002040 if (!CurrentFnDbgScope)
2041 return false;
2042
2043 CurrentFnDbgScope->fixInstructionMarkers(MIIndexMap);
Devang Patel75cc16c2009-10-01 20:31:14 +00002044
2045 // Each scope has first instruction and last instruction to mark beginning
2046 // and end of a scope respectively. Create an inverse map that list scopes
2047 // starts (and ends) with an instruction. One instruction may start (or end)
2048 // multiple scopes.
Devang Patelcfeaa482009-10-27 20:47:17 +00002049 for (ValueMap<MDNode *, DbgScope *>::iterator DI = DbgScopeMap.begin(),
Devang Patel75cc16c2009-10-01 20:31:14 +00002050 DE = DbgScopeMap.end(); DI != DE; ++DI) {
2051 DbgScope *S = DI->second;
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002052 if (S->isAbstractScope())
2053 continue;
Devang Patel75cc16c2009-10-01 20:31:14 +00002054 const MachineInstr *MI = S->getFirstInsn();
2055 assert (MI && "DbgScope does not have first instruction!");
2056
2057 InsnToDbgScopeMapTy::iterator IDI = DbgScopeBeginMap.find(MI);
2058 if (IDI != DbgScopeBeginMap.end())
2059 IDI->second.push_back(S);
2060 else
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002061 DbgScopeBeginMap[MI].push_back(S);
Devang Patel75cc16c2009-10-01 20:31:14 +00002062
2063 MI = S->getLastInsn();
2064 assert (MI && "DbgScope does not have last instruction!");
2065 IDI = DbgScopeEndMap.find(MI);
2066 if (IDI != DbgScopeEndMap.end())
2067 IDI->second.push_back(S);
2068 else
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002069 DbgScopeEndMap[MI].push_back(S);
Devang Patel75cc16c2009-10-01 20:31:14 +00002070 }
2071
2072 return !DbgScopeMap.empty();
2073}
2074
Devang Patel930143b2009-11-21 02:48:08 +00002075/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendling2b128d72009-05-20 23:19:06 +00002076/// emitted immediately after the function entry point.
Devang Patel930143b2009-11-21 02:48:08 +00002077void DwarfDebug::beginFunction(MachineFunction *MF) {
Bill Wendling2b128d72009-05-20 23:19:06 +00002078 this->MF = MF;
2079
2080 if (!ShouldEmitDwarfDebug()) return;
2081
2082 if (TimePassesIsEnabled)
2083 DebugTimer->startTimer();
2084
Devang Patel930143b2009-11-21 02:48:08 +00002085 if (!extractScopeInformation(MF))
Devang Patel4598eb62009-10-06 18:37:31 +00002086 return;
Devang Patel930143b2009-11-21 02:48:08 +00002087
2088 collectVariableInfo();
Devang Patel4598eb62009-10-06 18:37:31 +00002089
Bill Wendling2b128d72009-05-20 23:19:06 +00002090 // Begin accumulating function debug information.
2091 MMI->BeginFunction(MF);
2092
2093 // Assumes in correct section after the entry point.
2094 EmitLabel("func_begin", ++SubprogramCount);
2095
2096 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2097 // function.
Devang Pateldf45c7f2009-10-09 22:42:28 +00002098 DebugLoc FDL = MF->getDefaultDebugLoc();
2099 if (!FDL.isUnknown()) {
2100 DebugLocTuple DLT = MF->getDebugLocTuple(FDL);
2101 unsigned LabelID = 0;
Devang Pateld7ebfe32009-10-13 23:28:53 +00002102 DISubprogram SP = getDISubprogram(DLT.Scope);
Devang Pateldf45c7f2009-10-09 22:42:28 +00002103 if (!SP.isNull())
Devang Patel930143b2009-11-21 02:48:08 +00002104 LabelID = recordSourceLine(SP.getLineNumber(), 0, DLT.Scope);
Devang Pateldf45c7f2009-10-09 22:42:28 +00002105 else
Devang Patel930143b2009-11-21 02:48:08 +00002106 LabelID = recordSourceLine(DLT.Line, DLT.Col, DLT.Scope);
Devang Pateldf45c7f2009-10-09 22:42:28 +00002107 Asm->printLabel(LabelID);
2108 O << '\n';
Bill Wendling2b128d72009-05-20 23:19:06 +00002109 }
Bill Wendling2b128d72009-05-20 23:19:06 +00002110 if (TimePassesIsEnabled)
2111 DebugTimer->stopTimer();
2112}
2113
Devang Patel930143b2009-11-21 02:48:08 +00002114/// endFunction - Gather and emit post-function debug information.
Bill Wendling2b128d72009-05-20 23:19:06 +00002115///
Devang Patel930143b2009-11-21 02:48:08 +00002116void DwarfDebug::endFunction(MachineFunction *MF) {
Bill Wendling2b128d72009-05-20 23:19:06 +00002117 if (!ShouldEmitDwarfDebug()) return;
2118
2119 if (TimePassesIsEnabled)
2120 DebugTimer->startTimer();
2121
Devang Pateldf45c7f2009-10-09 22:42:28 +00002122 if (DbgScopeMap.empty())
2123 return;
Devang Patel2904aa92009-11-12 19:02:56 +00002124
Devang Patel530a0752010-01-04 20:44:00 +00002125 if (CurrentFnDbgScope) {
2126 // Define end label for subprogram.
2127 EmitLabel("func_end", SubprogramCount);
2128
2129 // Get function line info.
2130 if (!Lines.empty()) {
2131 // Get section line info.
2132 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2133 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2134 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2135 // Append the function info to section info.
2136 SectionLineInfos.insert(SectionLineInfos.end(),
2137 Lines.begin(), Lines.end());
2138 }
2139
2140 // Construct abstract scopes.
2141 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
2142 AE = AbstractScopesList.end(); AI != AE; ++AI)
2143 constructScopeDIE(*AI);
2144
2145 constructScopeDIE(CurrentFnDbgScope);
2146
2147 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
2148 MMI->getFrameMoves()));
Bill Wendling2b128d72009-05-20 23:19:06 +00002149 }
2150
Bill Wendling2b128d72009-05-20 23:19:06 +00002151 // Clear debug info
Devang Patel0a2c0bc2009-12-01 18:13:48 +00002152 CurrentFnDbgScope = NULL;
2153 DbgScopeMap.clear();
2154 DbgScopeBeginMap.clear();
2155 DbgScopeEndMap.clear();
2156 ConcreteScopes.clear();
2157 AbstractScopesList.clear();
Bill Wendling2b128d72009-05-20 23:19:06 +00002158
2159 Lines.clear();
Devang Patel0a2c0bc2009-12-01 18:13:48 +00002160
Bill Wendling2b128d72009-05-20 23:19:06 +00002161 if (TimePassesIsEnabled)
2162 DebugTimer->stopTimer();
2163}
2164
Devang Patel930143b2009-11-21 02:48:08 +00002165/// recordSourceLine - Records location information and associates it with a
Bill Wendling2b128d72009-05-20 23:19:06 +00002166/// label. Returns a unique label ID used to generate a label and provide
2167/// correspondence to the source line list.
Jim Grosbach042483e2009-11-21 23:12:12 +00002168unsigned DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel2089d162009-10-05 18:03:19 +00002169 MDNode *S) {
Devang Patel80ae3492009-08-28 23:24:31 +00002170 if (!MMI)
2171 return 0;
2172
Bill Wendling2b128d72009-05-20 23:19:06 +00002173 if (TimePassesIsEnabled)
2174 DebugTimer->startTimer();
2175
Devang Patel2d9caf92009-11-25 17:36:49 +00002176 StringRef Dir;
2177 StringRef Fn;
Devang Patel2089d162009-10-05 18:03:19 +00002178
2179 DIDescriptor Scope(S);
2180 if (Scope.isCompileUnit()) {
2181 DICompileUnit CU(S);
2182 Dir = CU.getDirectory();
2183 Fn = CU.getFilename();
2184 } else if (Scope.isSubprogram()) {
2185 DISubprogram SP(S);
2186 Dir = SP.getDirectory();
2187 Fn = SP.getFilename();
2188 } else if (Scope.isLexicalBlock()) {
2189 DILexicalBlock DB(S);
2190 Dir = DB.getDirectory();
2191 Fn = DB.getFilename();
2192 } else
2193 assert (0 && "Unexpected scope info");
2194
2195 unsigned Src = GetOrCreateSourceID(Dir, Fn);
Bill Wendling2b128d72009-05-20 23:19:06 +00002196 unsigned ID = MMI->NextLabelID();
2197 Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
2198
2199 if (TimePassesIsEnabled)
2200 DebugTimer->stopTimer();
2201
2202 return ID;
2203}
2204
2205/// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
2206/// timed. Look up the source id with the given directory and source file
2207/// names. If none currently exists, create a new id and insert it in the
2208/// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
2209/// well.
2210unsigned DwarfDebug::getOrCreateSourceID(const std::string &DirName,
2211 const std::string &FileName) {
2212 if (TimePassesIsEnabled)
2213 DebugTimer->startTimer();
2214
Devang Patelb2969422009-09-29 18:40:58 +00002215 unsigned SrcId = GetOrCreateSourceID(DirName.c_str(), FileName.c_str());
Bill Wendling2b128d72009-05-20 23:19:06 +00002216
2217 if (TimePassesIsEnabled)
2218 DebugTimer->stopTimer();
2219
2220 return SrcId;
2221}
2222
Bill Wendling806535f2009-05-20 23:22:40 +00002223//===----------------------------------------------------------------------===//
2224// Emit Methods
2225//===----------------------------------------------------------------------===//
2226
Devang Patel930143b2009-11-21 02:48:08 +00002227/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling480ff322009-05-20 23:21:38 +00002228///
Jim Grosbach00e9c612009-11-22 19:20:36 +00002229unsigned
2230DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling480ff322009-05-20 23:21:38 +00002231 // Get the children.
2232 const std::vector<DIE *> &Children = Die->getChildren();
2233
2234 // If not last sibling and has children then add sibling offset attribute.
Devang Patel930143b2009-11-21 02:48:08 +00002235 if (!Last && !Children.empty()) Die->addSiblingOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00002236
2237 // Record the abbreviation.
Devang Patel930143b2009-11-21 02:48:08 +00002238 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling480ff322009-05-20 23:21:38 +00002239
2240 // Get the abbreviation for this DIE.
2241 unsigned AbbrevNumber = Die->getAbbrevNumber();
2242 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2243
2244 // Set DIE offset
2245 Die->setOffset(Offset);
2246
2247 // Start the size with the size of abbreviation code.
Chris Lattner7b26fce2009-08-22 20:48:53 +00002248 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling480ff322009-05-20 23:21:38 +00002249
2250 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2251 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2252
2253 // Size the DIE attribute values.
2254 for (unsigned i = 0, N = Values.size(); i < N; ++i)
2255 // Size attribute value.
2256 Offset += Values[i]->SizeOf(TD, AbbrevData[i].getForm());
2257
2258 // Size the DIE children if any.
2259 if (!Children.empty()) {
2260 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
2261 "Children flag not set");
2262
2263 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00002264 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling480ff322009-05-20 23:21:38 +00002265
2266 // End of children marker.
2267 Offset += sizeof(int8_t);
2268 }
2269
2270 Die->setSize(Offset - Die->getOffset());
2271 return Offset;
2272}
2273
Devang Patel930143b2009-11-21 02:48:08 +00002274/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling480ff322009-05-20 23:21:38 +00002275///
Devang Patel930143b2009-11-21 02:48:08 +00002276void DwarfDebug::computeSizeAndOffsets() {
Bill Wendling480ff322009-05-20 23:21:38 +00002277 // Compute size of compile unit header.
2278 static unsigned Offset =
2279 sizeof(int32_t) + // Length of Compilation Unit Info
2280 sizeof(int16_t) + // DWARF version number
2281 sizeof(int32_t) + // Offset Into Abbrev. Section
2282 sizeof(int8_t); // Pointer Size (in bytes)
2283
Devang Patel930143b2009-11-21 02:48:08 +00002284 computeSizeAndOffset(ModuleCU->getCUDie(), Offset, true);
Devang Patel40d78412009-06-29 20:45:18 +00002285 CompileUnitOffsets[ModuleCU] = 0;
Bill Wendling480ff322009-05-20 23:21:38 +00002286}
2287
Devang Patel930143b2009-11-21 02:48:08 +00002288/// emitInitial - Emit initial Dwarf declarations. This is necessary for cc
Bill Wendling480ff322009-05-20 23:21:38 +00002289/// tools to recognize the object file contains Dwarf information.
Devang Patel930143b2009-11-21 02:48:08 +00002290void DwarfDebug::emitInitial() {
Bill Wendling480ff322009-05-20 23:21:38 +00002291 // Check to see if we already emitted intial headers.
2292 if (didInitial) return;
2293 didInitial = true;
2294
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002295 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002296
Bill Wendling480ff322009-05-20 23:21:38 +00002297 // Dwarf sections base addresses.
Chris Lattnere9a75a62009-08-22 21:43:10 +00002298 if (MAI->doesDwarfRequireFrameSection()) {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002299 Asm->OutStreamer.SwitchSection(TLOF.getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002300 EmitLabel("section_debug_frame", 0);
2301 }
2302
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002303 Asm->OutStreamer.SwitchSection(TLOF.getDwarfInfoSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002304 EmitLabel("section_info", 0);
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002305 Asm->OutStreamer.SwitchSection(TLOF.getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002306 EmitLabel("section_abbrev", 0);
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002307 Asm->OutStreamer.SwitchSection(TLOF.getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002308 EmitLabel("section_aranges", 0);
2309
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002310 if (const MCSection *LineInfoDirective = TLOF.getDwarfMacroInfoSection()) {
2311 Asm->OutStreamer.SwitchSection(LineInfoDirective);
Bill Wendling480ff322009-05-20 23:21:38 +00002312 EmitLabel("section_macinfo", 0);
2313 }
2314
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002315 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLineSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002316 EmitLabel("section_line", 0);
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002317 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLocSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002318 EmitLabel("section_loc", 0);
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002319 Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubNamesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002320 EmitLabel("section_pubnames", 0);
Devang Patel04d2f2d2009-11-24 01:14:22 +00002321 Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubTypesSection());
2322 EmitLabel("section_pubtypes", 0);
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002323 Asm->OutStreamer.SwitchSection(TLOF.getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002324 EmitLabel("section_str", 0);
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002325 Asm->OutStreamer.SwitchSection(TLOF.getDwarfRangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002326 EmitLabel("section_ranges", 0);
2327
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002328 Asm->OutStreamer.SwitchSection(TLOF.getTextSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002329 EmitLabel("text_begin", 0);
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002330 Asm->OutStreamer.SwitchSection(TLOF.getDataSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002331 EmitLabel("data_begin", 0);
2332}
2333
Devang Patel930143b2009-11-21 02:48:08 +00002334/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling480ff322009-05-20 23:21:38 +00002335///
Devang Patel930143b2009-11-21 02:48:08 +00002336void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling480ff322009-05-20 23:21:38 +00002337 // Get the abbreviation for this DIE.
2338 unsigned AbbrevNumber = Die->getAbbrevNumber();
2339 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2340
2341 Asm->EOL();
2342
2343 // Emit the code (index) for the abbreviation.
2344 Asm->EmitULEB128Bytes(AbbrevNumber);
2345
2346 if (Asm->isVerbose())
2347 Asm->EOL(std::string("Abbrev [" +
2348 utostr(AbbrevNumber) +
2349 "] 0x" + utohexstr(Die->getOffset()) +
2350 ":0x" + utohexstr(Die->getSize()) + " " +
2351 dwarf::TagString(Abbrev->getTag())));
2352 else
2353 Asm->EOL();
2354
2355 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2356 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2357
2358 // Emit the DIE attribute values.
2359 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2360 unsigned Attr = AbbrevData[i].getAttribute();
2361 unsigned Form = AbbrevData[i].getForm();
2362 assert(Form && "Too many attributes for DIE (check abbreviation)");
2363
2364 switch (Attr) {
2365 case dwarf::DW_AT_sibling:
Devang Patel930143b2009-11-21 02:48:08 +00002366 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling480ff322009-05-20 23:21:38 +00002367 break;
2368 case dwarf::DW_AT_abstract_origin: {
2369 DIEEntry *E = cast<DIEEntry>(Values[i]);
2370 DIE *Origin = E->getEntry();
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002371 unsigned Addr = Origin->getOffset();
Bill Wendling480ff322009-05-20 23:21:38 +00002372 Asm->EmitInt32(Addr);
2373 break;
2374 }
2375 default:
2376 // Emit an attribute using the defined form.
2377 Values[i]->EmitValue(this, Form);
2378 break;
2379 }
2380
2381 Asm->EOL(dwarf::AttributeString(Attr));
2382 }
2383
2384 // Emit the DIE children if any.
2385 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2386 const std::vector<DIE *> &Children = Die->getChildren();
2387
2388 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patel930143b2009-11-21 02:48:08 +00002389 emitDIE(Children[j]);
Bill Wendling480ff322009-05-20 23:21:38 +00002390
2391 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2392 }
2393}
2394
Devang Patel9ccfb642009-12-09 18:24:21 +00002395/// emitDebugInfo - Emit the debug info section.
Bill Wendling480ff322009-05-20 23:21:38 +00002396///
Devang Patel9ccfb642009-12-09 18:24:21 +00002397void DwarfDebug::emitDebugInfo() {
2398 // Start debug info section.
2399 Asm->OutStreamer.SwitchSection(
2400 Asm->getObjFileLowering().getDwarfInfoSection());
2401 DIE *Die = ModuleCU->getCUDie();
Bill Wendling480ff322009-05-20 23:21:38 +00002402
2403 // Emit the compile units header.
Devang Patel9ccfb642009-12-09 18:24:21 +00002404 EmitLabel("info_begin", ModuleCU->getID());
Bill Wendling480ff322009-05-20 23:21:38 +00002405
2406 // Emit size of content not including length itself
2407 unsigned ContentSize = Die->getSize() +
2408 sizeof(int16_t) + // DWARF version number
2409 sizeof(int32_t) + // Offset Into Abbrev. Section
2410 sizeof(int8_t) + // Pointer Size (in bytes)
2411 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2412
2413 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2414 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2415 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2416 Asm->EOL("Offset Into Abbrev. Section");
2417 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2418
Devang Patel930143b2009-11-21 02:48:08 +00002419 emitDIE(Die);
Bill Wendling480ff322009-05-20 23:21:38 +00002420 // FIXME - extra padding for gdb bug.
2421 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2422 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2423 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2424 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
Devang Patel9ccfb642009-12-09 18:24:21 +00002425 EmitLabel("info_end", ModuleCU->getID());
Bill Wendling480ff322009-05-20 23:21:38 +00002426
2427 Asm->EOL();
Bill Wendling480ff322009-05-20 23:21:38 +00002428}
2429
Devang Patel930143b2009-11-21 02:48:08 +00002430/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling480ff322009-05-20 23:21:38 +00002431///
Devang Patel930143b2009-11-21 02:48:08 +00002432void DwarfDebug::emitAbbreviations() const {
Bill Wendling480ff322009-05-20 23:21:38 +00002433 // Check to see if it is worth the effort.
2434 if (!Abbreviations.empty()) {
2435 // Start the debug abbrev section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002436 Asm->OutStreamer.SwitchSection(
2437 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002438
2439 EmitLabel("abbrev_begin", 0);
2440
2441 // For each abbrevation.
2442 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2443 // Get abbreviation data
2444 const DIEAbbrev *Abbrev = Abbreviations[i];
2445
2446 // Emit the abbrevations code (base 1 index.)
2447 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2448 Asm->EOL("Abbreviation Code");
2449
2450 // Emit the abbreviations data.
2451 Abbrev->Emit(Asm);
2452
2453 Asm->EOL();
2454 }
2455
2456 // Mark end of abbreviations.
2457 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2458
2459 EmitLabel("abbrev_end", 0);
2460 Asm->EOL();
2461 }
2462}
2463
Devang Patel930143b2009-11-21 02:48:08 +00002464/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling480ff322009-05-20 23:21:38 +00002465/// the line matrix.
2466///
Devang Patel930143b2009-11-21 02:48:08 +00002467void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling480ff322009-05-20 23:21:38 +00002468 // Define last address of section.
2469 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2470 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2471 Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2472 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2473
2474 // Mark end of matrix.
2475 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2476 Asm->EmitULEB128Bytes(1); Asm->EOL();
2477 Asm->EmitInt8(1); Asm->EOL();
2478}
2479
Devang Patel930143b2009-11-21 02:48:08 +00002480/// emitDebugLines - Emit source line information.
Bill Wendling480ff322009-05-20 23:21:38 +00002481///
Devang Patel930143b2009-11-21 02:48:08 +00002482void DwarfDebug::emitDebugLines() {
Bill Wendling480ff322009-05-20 23:21:38 +00002483 // If the target is using .loc/.file, the assembler will be emitting the
2484 // .debug_line table automatically.
Chris Lattnere9a75a62009-08-22 21:43:10 +00002485 if (MAI->hasDotLocAndDotFile())
Bill Wendling480ff322009-05-20 23:21:38 +00002486 return;
2487
2488 // Minimum line delta, thus ranging from -10..(255-10).
2489 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
2490 // Maximum line delta, thus ranging from -10..(255-10).
2491 const int MaxLineDelta = 255 + MinLineDelta;
2492
2493 // Start the dwarf line section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002494 Asm->OutStreamer.SwitchSection(
2495 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002496
2497 // Construct the section header.
2498 EmitDifference("line_end", 0, "line_begin", 0, true);
2499 Asm->EOL("Length of Source Line Info");
2500 EmitLabel("line_begin", 0);
2501
2502 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2503
2504 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2505 Asm->EOL("Prolog Length");
2506 EmitLabel("line_prolog_begin", 0);
2507
2508 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2509
2510 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2511
2512 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2513
2514 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2515
2516 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2517
2518 // Line number standard opcode encodings argument count
2519 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2520 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2521 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2522 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2523 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2524 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2525 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2526 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2527 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2528
2529 // Emit directories.
2530 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
2531 Asm->EmitString(getSourceDirectoryName(DI));
2532 Asm->EOL("Directory");
2533 }
2534
2535 Asm->EmitInt8(0); Asm->EOL("End of directories");
2536
2537 // Emit files.
2538 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
2539 // Remember source id starts at 1.
2540 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
2541 Asm->EmitString(getSourceFileName(Id.second));
2542 Asm->EOL("Source");
2543 Asm->EmitULEB128Bytes(Id.first);
2544 Asm->EOL("Directory #");
2545 Asm->EmitULEB128Bytes(0);
2546 Asm->EOL("Mod date");
2547 Asm->EmitULEB128Bytes(0);
2548 Asm->EOL("File size");
2549 }
2550
2551 Asm->EmitInt8(0); Asm->EOL("End of files");
2552
2553 EmitLabel("line_prolog_end", 0);
2554
2555 // A sequence for each text section.
2556 unsigned SecSrcLinesSize = SectionSourceLines.size();
2557
2558 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2559 // Isolate current sections line info.
2560 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2561
Chris Lattner591105c2009-08-08 23:39:42 +00002562 /*if (Asm->isVerbose()) {
Chris Lattner4d2c0f92009-07-31 18:48:30 +00002563 const MCSection *S = SectionMap[j + 1];
Chris Lattnere9a75a62009-08-22 21:43:10 +00002564 O << '\t' << MAI->getCommentString() << " Section"
Bill Wendling480ff322009-05-20 23:21:38 +00002565 << S->getName() << '\n';
Chris Lattner591105c2009-08-08 23:39:42 +00002566 }*/
2567 Asm->EOL();
Bill Wendling480ff322009-05-20 23:21:38 +00002568
2569 // Dwarf assumes we start with first line of first source file.
2570 unsigned Source = 1;
2571 unsigned Line = 1;
2572
2573 // Construct rows of the address, source, line, column matrix.
2574 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2575 const SrcLineInfo &LineInfo = LineInfos[i];
2576 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2577 if (!LabelID) continue;
2578
Caroline Tice183a5192009-09-11 18:25:54 +00002579 if (LineInfo.getLine() == 0) continue;
2580
Bill Wendling480ff322009-05-20 23:21:38 +00002581 if (!Asm->isVerbose())
2582 Asm->EOL();
2583 else {
2584 std::pair<unsigned, unsigned> SourceID =
2585 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattnere9a75a62009-08-22 21:43:10 +00002586 O << '\t' << MAI->getCommentString() << ' '
Dan Gohman0891d752009-12-05 02:00:34 +00002587 << getSourceDirectoryName(SourceID.first) << '/'
Bill Wendling480ff322009-05-20 23:21:38 +00002588 << getSourceFileName(SourceID.second)
Dan Gohman0891d752009-12-05 02:00:34 +00002589 << ':' << utostr_32(LineInfo.getLine()) << '\n';
Bill Wendling480ff322009-05-20 23:21:38 +00002590 }
2591
2592 // Define the line address.
2593 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2594 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2595 Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2596 EmitReference("label", LabelID); Asm->EOL("Location label");
2597
2598 // If change of source, then switch to the new source.
2599 if (Source != LineInfo.getSourceID()) {
2600 Source = LineInfo.getSourceID();
2601 Asm->EmitInt8(dwarf::DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2602 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2603 }
2604
2605 // If change of line.
2606 if (Line != LineInfo.getLine()) {
2607 // Determine offset.
2608 int Offset = LineInfo.getLine() - Line;
2609 int Delta = Offset - MinLineDelta;
2610
2611 // Update line.
2612 Line = LineInfo.getLine();
2613
2614 // If delta is small enough and in range...
2615 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2616 // ... then use fast opcode.
2617 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2618 } else {
2619 // ... otherwise use long hand.
2620 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
2621 Asm->EOL("DW_LNS_advance_line");
2622 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2623 Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2624 }
2625 } else {
2626 // Copy the previous row (different address or source)
2627 Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2628 }
2629 }
2630
Devang Patel930143b2009-11-21 02:48:08 +00002631 emitEndOfLineMatrix(j + 1);
Bill Wendling480ff322009-05-20 23:21:38 +00002632 }
2633
2634 if (SecSrcLinesSize == 0)
2635 // Because we're emitting a debug_line section, we still need a line
2636 // table. The linker and friends expect it to exist. If there's nothing to
2637 // put into it, emit an empty table.
Devang Patel930143b2009-11-21 02:48:08 +00002638 emitEndOfLineMatrix(1);
Bill Wendling480ff322009-05-20 23:21:38 +00002639
2640 EmitLabel("line_end", 0);
2641 Asm->EOL();
2642}
2643
Devang Patel930143b2009-11-21 02:48:08 +00002644/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling480ff322009-05-20 23:21:38 +00002645///
Devang Patel930143b2009-11-21 02:48:08 +00002646void DwarfDebug::emitCommonDebugFrame() {
Chris Lattnere9a75a62009-08-22 21:43:10 +00002647 if (!MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00002648 return;
2649
2650 int stackGrowth =
2651 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2652 TargetFrameInfo::StackGrowsUp ?
2653 TD->getPointerSize() : -TD->getPointerSize();
2654
2655 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002656 Asm->OutStreamer.SwitchSection(
2657 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002658
2659 EmitLabel("debug_frame_common", 0);
2660 EmitDifference("debug_frame_common_end", 0,
2661 "debug_frame_common_begin", 0, true);
2662 Asm->EOL("Length of Common Information Entry");
2663
2664 EmitLabel("debug_frame_common_begin", 0);
2665 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
2666 Asm->EOL("CIE Identifier Tag");
2667 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
2668 Asm->EOL("CIE Version");
2669 Asm->EmitString("");
2670 Asm->EOL("CIE Augmentation");
2671 Asm->EmitULEB128Bytes(1);
2672 Asm->EOL("CIE Code Alignment Factor");
2673 Asm->EmitSLEB128Bytes(stackGrowth);
2674 Asm->EOL("CIE Data Alignment Factor");
2675 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2676 Asm->EOL("CIE RA Column");
2677
2678 std::vector<MachineMove> Moves;
2679 RI->getInitialFrameState(Moves);
2680
2681 EmitFrameMoves(NULL, 0, Moves, false);
2682
2683 Asm->EmitAlignment(2, 0, 0, false);
2684 EmitLabel("debug_frame_common_end", 0);
2685
2686 Asm->EOL();
2687}
2688
Devang Patel930143b2009-11-21 02:48:08 +00002689/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling480ff322009-05-20 23:21:38 +00002690/// section.
2691void
Devang Patel930143b2009-11-21 02:48:08 +00002692DwarfDebug::emitFunctionDebugFrame(const FunctionDebugFrameInfo&DebugFrameInfo){
Chris Lattnere9a75a62009-08-22 21:43:10 +00002693 if (!MAI->doesDwarfRequireFrameSection())
Bill Wendling480ff322009-05-20 23:21:38 +00002694 return;
2695
2696 // Start the dwarf frame section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002697 Asm->OutStreamer.SwitchSection(
2698 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002699
2700 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2701 "debug_frame_begin", DebugFrameInfo.Number, true);
2702 Asm->EOL("Length of Frame Information Entry");
2703
2704 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2705
2706 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2707 0, 0, true, false);
2708 Asm->EOL("FDE CIE offset");
2709
2710 EmitReference("func_begin", DebugFrameInfo.Number);
2711 Asm->EOL("FDE initial location");
2712 EmitDifference("func_end", DebugFrameInfo.Number,
2713 "func_begin", DebugFrameInfo.Number);
2714 Asm->EOL("FDE address range");
2715
2716 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
2717 false);
2718
2719 Asm->EmitAlignment(2, 0, 0, false);
2720 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2721
2722 Asm->EOL();
2723}
2724
Devang Patel9ccfb642009-12-09 18:24:21 +00002725/// emitDebugPubNames - Emit visible names into a debug pubnames section.
2726///
2727void DwarfDebug::emitDebugPubNames() {
2728 // Start the dwarf pubnames section.
2729 Asm->OutStreamer.SwitchSection(
2730 Asm->getObjFileLowering().getDwarfPubNamesSection());
2731
2732 EmitDifference("pubnames_end", ModuleCU->getID(),
2733 "pubnames_begin", ModuleCU->getID(), true);
Bill Wendling480ff322009-05-20 23:21:38 +00002734 Asm->EOL("Length of Public Names Info");
2735
Devang Patel9ccfb642009-12-09 18:24:21 +00002736 EmitLabel("pubnames_begin", ModuleCU->getID());
Bill Wendling480ff322009-05-20 23:21:38 +00002737
2738 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF Version");
2739
2740 EmitSectionOffset("info_begin", "section_info",
Devang Patel9ccfb642009-12-09 18:24:21 +00002741 ModuleCU->getID(), 0, true, false);
Bill Wendling480ff322009-05-20 23:21:38 +00002742 Asm->EOL("Offset of Compilation Unit Info");
2743
Devang Patel9ccfb642009-12-09 18:24:21 +00002744 EmitDifference("info_end", ModuleCU->getID(), "info_begin", ModuleCU->getID(),
Bill Wendling480ff322009-05-20 23:21:38 +00002745 true);
2746 Asm->EOL("Compilation Unit Length");
2747
Devang Patel9ccfb642009-12-09 18:24:21 +00002748 const StringMap<DIE*> &Globals = ModuleCU->getGlobals();
Bill Wendling480ff322009-05-20 23:21:38 +00002749 for (StringMap<DIE*>::const_iterator
2750 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2751 const char *Name = GI->getKeyData();
2752 DIE * Entity = GI->second;
2753
2754 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2755 Asm->EmitString(Name, strlen(Name)); Asm->EOL("External Name");
2756 }
2757
2758 Asm->EmitInt32(0); Asm->EOL("End Mark");
Devang Patel9ccfb642009-12-09 18:24:21 +00002759 EmitLabel("pubnames_end", ModuleCU->getID());
Bill Wendling480ff322009-05-20 23:21:38 +00002760
2761 Asm->EOL();
2762}
2763
Devang Patel04d2f2d2009-11-24 01:14:22 +00002764void DwarfDebug::emitDebugPubTypes() {
Devang Patelc8654eb2009-11-24 19:18:41 +00002765 // Start the dwarf pubnames section.
2766 Asm->OutStreamer.SwitchSection(
2767 Asm->getObjFileLowering().getDwarfPubTypesSection());
Devang Patel04d2f2d2009-11-24 01:14:22 +00002768 EmitDifference("pubtypes_end", ModuleCU->getID(),
2769 "pubtypes_begin", ModuleCU->getID(), true);
2770 Asm->EOL("Length of Public Types Info");
2771
2772 EmitLabel("pubtypes_begin", ModuleCU->getID());
2773
2774 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF Version");
2775
2776 EmitSectionOffset("info_begin", "section_info",
2777 ModuleCU->getID(), 0, true, false);
2778 Asm->EOL("Offset of Compilation ModuleCU Info");
2779
2780 EmitDifference("info_end", ModuleCU->getID(), "info_begin", ModuleCU->getID(),
2781 true);
2782 Asm->EOL("Compilation ModuleCU Length");
2783
2784 const StringMap<DIE*> &Globals = ModuleCU->getGlobalTypes();
2785 for (StringMap<DIE*>::const_iterator
2786 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2787 const char *Name = GI->getKeyData();
2788 DIE * Entity = GI->second;
2789
2790 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2791 Asm->EmitString(Name, strlen(Name)); Asm->EOL("External Name");
2792 }
2793
2794 Asm->EmitInt32(0); Asm->EOL("End Mark");
2795 EmitLabel("pubtypes_end", ModuleCU->getID());
2796
2797 Asm->EOL();
2798}
2799
Devang Patel930143b2009-11-21 02:48:08 +00002800/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling480ff322009-05-20 23:21:38 +00002801///
Devang Patel930143b2009-11-21 02:48:08 +00002802void DwarfDebug::emitDebugStr() {
Bill Wendling480ff322009-05-20 23:21:38 +00002803 // Check to see if it is worth the effort.
2804 if (!StringPool.empty()) {
2805 // Start the dwarf str section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002806 Asm->OutStreamer.SwitchSection(
2807 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002808
2809 // For each of strings in the string pool.
2810 for (unsigned StringID = 1, N = StringPool.size();
2811 StringID <= N; ++StringID) {
2812 // Emit a label for reference from debug information entries.
2813 EmitLabel("string", StringID);
2814
2815 // Emit the string itself.
2816 const std::string &String = StringPool[StringID];
2817 Asm->EmitString(String); Asm->EOL();
2818 }
2819
2820 Asm->EOL();
2821 }
2822}
2823
Devang Patel930143b2009-11-21 02:48:08 +00002824/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling480ff322009-05-20 23:21:38 +00002825///
Devang Patel930143b2009-11-21 02:48:08 +00002826void DwarfDebug::emitDebugLoc() {
Bill Wendling480ff322009-05-20 23:21:38 +00002827 // Start the dwarf loc section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002828 Asm->OutStreamer.SwitchSection(
2829 Asm->getObjFileLowering().getDwarfLocSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002830 Asm->EOL();
2831}
2832
2833/// EmitDebugARanges - Emit visible names into a debug aranges section.
2834///
2835void DwarfDebug::EmitDebugARanges() {
2836 // Start the dwarf aranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002837 Asm->OutStreamer.SwitchSection(
2838 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002839
2840 // FIXME - Mock up
2841#if 0
2842 CompileUnit *Unit = GetBaseCompileUnit();
2843
2844 // Don't include size of length
2845 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2846
2847 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
2848
2849 EmitReference("info_begin", Unit->getID());
2850 Asm->EOL("Offset of Compilation Unit Info");
2851
2852 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2853
2854 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2855
2856 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2857 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
2858
2859 // Range 1
2860 EmitReference("text_begin", 0); Asm->EOL("Address");
2861 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2862
2863 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2864 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2865#endif
2866
2867 Asm->EOL();
2868}
2869
Devang Patel930143b2009-11-21 02:48:08 +00002870/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling480ff322009-05-20 23:21:38 +00002871///
Devang Patel930143b2009-11-21 02:48:08 +00002872void DwarfDebug::emitDebugRanges() {
Bill Wendling480ff322009-05-20 23:21:38 +00002873 // Start the dwarf ranges section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002874 Asm->OutStreamer.SwitchSection(
2875 Asm->getObjFileLowering().getDwarfRangesSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002876 Asm->EOL();
2877}
2878
Devang Patel930143b2009-11-21 02:48:08 +00002879/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling480ff322009-05-20 23:21:38 +00002880///
Devang Patel930143b2009-11-21 02:48:08 +00002881void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarc418d6b2009-09-19 20:40:05 +00002882 if (const MCSection *LineInfo =
Chris Lattner1472cf52009-08-02 07:24:22 +00002883 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling480ff322009-05-20 23:21:38 +00002884 // Start the dwarf macinfo section.
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002885 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling480ff322009-05-20 23:21:38 +00002886 Asm->EOL();
2887 }
2888}
2889
Devang Patel930143b2009-11-21 02:48:08 +00002890/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling480ff322009-05-20 23:21:38 +00002891/// Section Header:
2892/// 1. length of section
2893/// 2. Dwarf version number
2894/// 3. address size.
2895///
2896/// Entries (one "entry" for each function that was inlined):
2897///
2898/// 1. offset into __debug_str section for MIPS linkage name, if exists;
2899/// otherwise offset into __debug_str for regular function name.
2900/// 2. offset into __debug_str section for regular function name.
2901/// 3. an unsigned LEB128 number indicating the number of distinct inlining
2902/// instances for the function.
2903///
2904/// The rest of the entry consists of a {die_offset, low_pc} pair for each
2905/// inlined instance; the die_offset points to the inlined_subroutine die in the
2906/// __debug_info section, and the low_pc is the starting address for the
2907/// inlining instance.
Devang Patel930143b2009-11-21 02:48:08 +00002908void DwarfDebug::emitDebugInlineInfo() {
Chris Lattnere9a75a62009-08-22 21:43:10 +00002909 if (!MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling480ff322009-05-20 23:21:38 +00002910 return;
2911
Devang Patel40d78412009-06-29 20:45:18 +00002912 if (!ModuleCU)
Bill Wendling480ff322009-05-20 23:21:38 +00002913 return;
2914
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002915 Asm->OutStreamer.SwitchSection(
2916 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Bill Wendling480ff322009-05-20 23:21:38 +00002917 Asm->EOL();
2918 EmitDifference("debug_inlined_end", 1,
2919 "debug_inlined_begin", 1, true);
2920 Asm->EOL("Length of Debug Inlined Information Entry");
2921
2922 EmitLabel("debug_inlined_begin", 1);
2923
2924 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
2925 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2926
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002927 for (SmallVector<MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
2928 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach042483e2009-11-21 23:12:12 +00002929
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002930 MDNode *Node = *I;
Jim Grosbach00e9c612009-11-22 19:20:36 +00002931 ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
2932 = InlineInfo.find(Node);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002933 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel80ae3492009-08-28 23:24:31 +00002934 DISubprogram SP(Node);
Devang Patel2d9caf92009-11-25 17:36:49 +00002935 StringRef LName = SP.getLinkageName();
2936 StringRef Name = SP.getName();
Bill Wendling480ff322009-05-20 23:21:38 +00002937
Devang Patel2d9caf92009-11-25 17:36:49 +00002938 if (LName.empty())
Devang Patelf281bf82009-07-16 01:01:22 +00002939 Asm->EmitString(Name);
2940 else {
Chris Lattner4b7dadb2009-08-19 05:49:37 +00002941 // Skip special LLVM prefix that is used to inform the asm printer to not
2942 // emit usual symbol prefix before the symbol name. This happens for
2943 // Objective-C symbol names and symbol whose name is replaced using GCC's
2944 // __asm__ attribute.
Devang Patelf281bf82009-07-16 01:01:22 +00002945 if (LName[0] == 1)
Benjamin Kramer4cd30812009-11-25 18:26:09 +00002946 LName = LName.substr(1);
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002947 EmitSectionOffset("string", "section_str",
2948 StringPool.idFor(LName), false, true);
2949
Devang Patelf281bf82009-07-16 01:01:22 +00002950 }
Bill Wendling480ff322009-05-20 23:21:38 +00002951 Asm->EOL("MIPS linkage name");
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002952 EmitSectionOffset("string", "section_str",
2953 StringPool.idFor(Name), false, true);
2954 Asm->EOL("Function name");
Bill Wendling480ff322009-05-20 23:21:38 +00002955 Asm->EmitULEB128Bytes(Labels.size()); Asm->EOL("Inline count");
2956
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002957 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling480ff322009-05-20 23:21:38 +00002958 LE = Labels.end(); LI != LE; ++LI) {
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002959 DIE *SP = LI->second;
Bill Wendling480ff322009-05-20 23:21:38 +00002960 Asm->EmitInt32(SP->getOffset()); Asm->EOL("DIE offset");
2961
2962 if (TD->getPointerSize() == sizeof(int32_t))
Chris Lattnere9a75a62009-08-22 21:43:10 +00002963 O << MAI->getData32bitsDirective();
Bill Wendling480ff322009-05-20 23:21:38 +00002964 else
Chris Lattnere9a75a62009-08-22 21:43:10 +00002965 O << MAI->getData64bitsDirective();
Bill Wendling480ff322009-05-20 23:21:38 +00002966
Devang Patelf6eeaeb2009-11-10 23:06:00 +00002967 PrintLabelName("label", LI->first); Asm->EOL("low_pc");
Bill Wendling480ff322009-05-20 23:21:38 +00002968 }
2969 }
2970
2971 EmitLabel("debug_inlined_end", 1);
2972 Asm->EOL();
2973}